Class: FayeRails::Filter::DSL

Inherits:

Object

• Object
• FayeRails::Filter::DSL

show all

Defined in:

lib/faye-rails/filter.rb

Instance Attribute Summary (collapse)

• - (Object) callback readonly

  A small wrapper class around filter blocks to add some sugar to ease filter (Faye extension) creation.

• - (Object) channel readonly

  A small wrapper class around filter blocks to add some sugar to ease filter (Faye extension) creation.

• - (Object) direction readonly

  A small wrapper class around filter blocks to add some sugar to ease filter (Faye extension) creation.

• - (Object) message readonly

  A small wrapper class around filter blocks to add some sugar to ease filter (Faye extension) creation.

• - (Object) original_message readonly

  A small wrapper class around filter blocks to add some sugar to ease filter (Faye extension) creation.

Instance Method Summary (collapse)

• - (Object) block(reason = "Message blocked by filter")

  Syntactic sugar around callback.call which adds an error message to the message and passes it back to Faye, which will send back a rejection message to the sending client.

• - (Boolean) channel_matches?(glob, test)
• - (Boolean) client_id?(x = nil)
• - (Object) data
• - (Boolean) data?
• - (Object) drop

  Syntactic sugar around callback.call which returns nil to Faye - effectively dropping the message.

• - (Boolean) incoming? (also: #in?)
• - (DSL) initialize(block, message, channel = '/**', callback, direction) constructor

  Called by FayeRails::Filter when Faye passes messages in for evaluation.

• - (Boolean) meta?
• - (Object) modify(new_message)

  Syntactic sugar around callback.call which passes the passed argument back to Faye in place of the original message.

• - (Boolean) outgoing? (also: #out?)
• - (Object) pass

  Syntactic sugar around callback.call which passes back the original message unmodified.

• - (Boolean) service?
• - (Boolean) subscribing?

  Easier than testing message every time.

• - (Boolean) subscription?(channel)
• - (Boolean) unsubscribing?

75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90

# File 'lib/faye-rails/filter.rb', line 75

def initialize(block, message, channel='/**', callback, direction)
  raise ArgumentError, "Block cannot be nil" unless block
  @channel = channel
  @original_message = message.dup
  @message = message
  @callback = callback
  @direction = direction

  if channel_matches?(@channel, @original_message['channel']) ||
    (subscribing? && subscription?(@channel)) ||
    (unsubscribing? && subscription?(@channel))
    instance_eval(&block)
  else
    pass
  end
end

66
67
68

# File 'lib/faye-rails/filter.rb', line 66

def callback
  @callback
end

66
67
68

# File 'lib/faye-rails/filter.rb', line 66

def channel
  @channel
end

66
67
68

# File 'lib/faye-rails/filter.rb', line 66

def direction
  @direction
end

66
67
68

# File 'lib/faye-rails/filter.rb', line 66

def message
  @message
end

66
67
68

# File 'lib/faye-rails/filter.rb', line 66

def original_message
  @original_message
end

164
165
166
167
168

# File 'lib/faye-rails/filter.rb', line 164

def block(reason="Message blocked by filter")
  new_message = message
  new_message['error'] = reason
  callback.call(new_message)
end

135
136
137

# File 'lib/faye-rails/filter.rb', line 135

def channel_matches?(glob,test)
  File.fnmatch? glob, test
end

127
128
129
130
131
132
133

# File 'lib/faye-rails/filter.rb', line 127

def client_id?(x=nil)
  if !!x
    message['client_id'] == x
  else
    !!message['client_id']
  end
end

119
120
121

# File 'lib/faye-rails/filter.rb', line 119

def data
  message['data']
end

123
124
125

# File 'lib/faye-rails/filter.rb', line 123

def data?
  !!data
end

172
173
174

# File 'lib/faye-rails/filter.rb', line 172

def drop
  callback.call(nil)
end

109
110
111

# File 'lib/faye-rails/filter.rb', line 109

def incoming?
  direction == :incoming
end

101
102
103

# File 'lib/faye-rails/filter.rb', line 101

def meta?
  message['channel'][0..5] == '/meta/'
end

154
155
156

# File 'lib/faye-rails/filter.rb', line 154

def modify(new_message)
  callback.call(new_message)
end

114
115
116

# File 'lib/faye-rails/filter.rb', line 114

def outgoing?
  direction == :outgoing
end

145
146
147

# File 'lib/faye-rails/filter.rb', line 145

def pass
  callback.call(original_message)
end

105
106
107

# File 'lib/faye-rails/filter.rb', line 105

def service?
  message['channel'][0..8] == '/service/'
end

93
94
95

# File 'lib/faye-rails/filter.rb', line 93

def subscribing?
  message['channel'] == '/meta/subscribe'
end

139
140
141

# File 'lib/faye-rails/filter.rb', line 139

def subscription?(channel)
  message['subscription'] && channel_matches?(channel, message['subscription'])
end

97
98
99

# File 'lib/faye-rails/filter.rb', line 97

def unsubscribing?
  message['channel'] == '/meta/unsubscribe'
end