pubnub 3.4.1 → 3.5.1

data/lib/pubnub/events/audit.rb

@@ -0,0 +1,38 @@
+module Pubnub
+  class Audit
+    include Pubnub::Event
+    include Pubnub::SingleEvent
+    include Pubnub::Formatter
+    include Pubnub::Validator
+    include Pubnub::PAM
+
+    def initialize(options, app)
+      super
+      @event = 'audit'
+      @allow_multiple_channels = false
+      @timestamp = current_time
+    end
+
+    def validate!
+      raise ArgumentError.new(:object => self, :message => 'publish_key is required by Audit') unless @publish_key
+      raise ArgumentError.new(:object => self, :message => 'Parameter secret_key is required by Audit') if !@secret_key || @secret_key == 0
+
+    end
+
+    private
+
+    def parameters(app, signature = false)
+      { :timestamp => @timestamp }.merge(super(app, signature))
+    end
+
+    def path(app)
+      '/' + [
+          'v1',
+          'auth',
+          'audit',
+          'sub-key',
+          @subscribe_key
+      ].join('/')
+    end
+  end
+end

data/lib/pubnub/events/grant.rb

@@ -0,0 +1,59 @@
+module Pubnub
+  class Grant
+    include Pubnub::Event
+    include Pubnub::SingleEvent
+    include Pubnub::Formatter
+    include Pubnub::Validator
+    include Pubnub::PAM
+
+    def initialize(options, app)
+      super
+      @event = 'grant'
+      @allow_multiple_channels = false
+      @timestamp = current_time
+
+      @write = options[:write]
+      @read  = options[:read]
+      @ttl   = options[:ttl]   || Pubnub::Configuration::DEFAULT_TTL
+    end
+
+    def validate!
+      super
+
+      raise ArgumentError.new(:object => self, :message => 'publish_key is required by Grant') unless @publish_key
+      raise ArgumentError.new(:object => self, :message => 'Parameter secret_key is required by Grant') if !@secret_key || @secret_key == 0
+
+      raise ArgumentError.new(:object => self, :message => 'write parameter accept only one of: 1, "1", 0, "0", true, false values') unless [nil, 1, '1', 0, '0', true, false].include?(@write)
+      raise ArgumentError.new(:object => self, :message => 'read parameter accept only: 1, "1", 0, "0", true, false values') unless [nil, 1, '1', 0, '0', true, false].include?(@read)
+
+      raise ArgumentError.new(:object => self, :message => 'ttl parameter is too big, max value is: 525600') unless @ttl.to_i <= 525600 || @ttl.nil?
+      raise ArgumentError.new(:object => self, :message => 'ttl parameter can\'t be negative')               unless @ttl.to_i >= 0      || @ttl.nil?
+
+    end
+
+    private
+
+    def parameters(app, signature = false)
+      write = [0, '0', false].include?(@write) ? 0 : 1
+      read =  [0, '0', false].include?(@read) ? 0 : 1
+
+      {
+          :timestamp => @timestamp,
+          :w         => write,
+          :r         => read,
+          :ttl       => @ttl
+      }.merge(super(app, signature))
+    end
+
+    def path(app)
+      '/' + [
+          'v1',
+          'auth',
+          'grant',
+          'sub-key',
+          @subscribe_key
+      ].join('/')
+    end
+
+  end
+end

data/lib/pubnub/events/here_now.rb

@@ -0,0 +1,55 @@
+module Pubnub
+  class HereNow
+    include Pubnub::Event
+    include Pubnub::SingleEvent
+    include Pubnub::Formatter
+    include Pubnub::Validator
+
+    def initialize(options, app)
+      super
+      @channel = @channel.first
+      @allow_multiple_channels = false
+      @event = 'here_now'
+    end
+
+    def validate!
+      super
+
+      # check channel
+      raise ArgumentError.new(:object => self, :message => 'History requires :channel argument') unless @channel
+      raise ArgumentError.new(:object => self, :message => 'Invalid channel format! Should be type of: String, Symbol') unless [String, Symbol].include?(@channel.class)
+
+    end
+
+    private
+
+    def path(app)
+      '/' + [
+          'v2',
+          'presence',
+          'sub-key',
+          @subscribe_key,
+          'channel',
+          @channel
+      ].join('/')
+    end
+
+    def format_envelopes(response, app, error)
+      parsed_response = Parser.parse_json(response.body) if Parser.valid_json?(response.body)
+
+      envelopes = Array.new
+      envelopes << Envelope.new(
+          {
+              :message           => parsed_response,
+              :channel           => @channel,
+              :response_message  => parsed_response
+          },
+          app
+      )
+
+      envelopes = add_common_data_to_envelopes(envelopes, response, app, error)
+
+      envelopes
+    end
+  end
+end

data/lib/pubnub/events/history.rb

@@ -0,0 +1,110 @@
+module Pubnub
+  class History
+    include Pubnub::Event
+    include Pubnub::SingleEvent
+    include Pubnub::Formatter
+    include Pubnub::Validator
+
+
+    def initialize(options, app)
+      super
+      @start   = options[:start]
+      @end     = options[:end]
+      @count   = options[:count]
+      @reverse = options[:reverse]
+      @event   = 'history'
+      @allow_multiple_channels = false
+
+    end
+
+    def validate!
+      super
+
+      # check channel
+      raise ArgumentError.new(:object => self, :message => 'History requires :channel argument') unless @channel
+      raise ArgumentError.new(:object => self, :message => 'Invalid channel format! Should be type of: String, Symbol') unless [String, Symbol].include?(@channel.class)
+
+      # check if history parameters are valid
+
+      # start
+      raise ArgumentError.new(:object => self, :message => 'Invalid :start parameter, should be type of Integer, Fixnum or String') unless [String, Fixnum, Integer, NilClass].include?(@start.class)
+      raise ArgumentError.new(:object => self, :message => 'Invalid :start parameter, should be positive integer number') if !@start.to_i.integer? && @start.to_i <= 0
+
+      # end
+      raise ArgumentError.new(:object => self, :message => 'Invalid :end parameter, should be type of Integer, Fixnum or String') unless [String, Fixnum, Integer, NilClass].include?(@end.class)
+      raise ArgumentError.new(:object => self, :message => 'Invalid :end parameter, should be positive integer number') if !@end.to_i.integer? && @end.to_i <= 0
+      raise ArgumentError.new(:object => self, :message => 'Invalid :end parameter, should be bigger than :start parameter. If you want to get messages in reverse order, use :reverse => true at call.') if @start.to_i >= @end.to_i && !@start.nil? && @end.nil?
+      # count
+      raise ArgumentError.new(:object => self, :message => 'Invalid :count parameter, should be type of Integer, Fixnum or String') unless [String, Fixnum, Integer, NilClass].include?(@count.class)
+      raise ArgumentError.new(:object => self, :message => 'Invalid :count parameter, should be positive integer number') if !@count.to_i.integer? && @count.to_i <= 0
+    end
+
+    private
+
+    def path(app)
+      '/' + [
+          'v2',
+          'history',
+          'sub-key',
+          @subscribe_key,
+          'channel',
+          @channel
+      ].join('/')
+    end
+
+    def parameters(app)
+      params = super(app)
+      params.merge!({ :start   => @start }) if @start
+      params.merge!({ :end     => @end   }) if @end
+      params.merge!({ :count   => @count }) if @count
+      params.merge!({ :reverse => 'true' }) if @reverse
+      params
+    end
+
+    def timetoken(parsed_response)
+      parsed_response[2] if parsed_response.is_a? Array
+    end
+
+    def response_message(parsed_response)
+      parsed_response[1] if parsed_response.is_a? Array
+    end
+
+    def format_envelopes(response, app, error)
+
+      parsed_response = Parser.parse_json(response.body) if Parser.valid_json?(response.body)
+
+      envelopes = Array.new
+      if error
+        envelopes << Envelope.new(
+            {
+                :channel           => @channel,
+                :timetoken         => timetoken(parsed_response),
+                :history_start     => @start,
+                :history_end       => @end
+            },
+            app
+        )
+      else
+        parsed_response.first.each do |message|
+          envelopes << Envelope.new(
+              {
+                  :message           => message,
+                  :channel           => @channel.first,
+                  :response_message  => response_message(parsed_response),
+                  :timetoken         => timetoken(parsed_response),
+                  :history_start     => parsed_response[1],
+                  :history_end       => parsed_response[2]
+              },
+              app
+          )
+        end
+      end
+
+
+      envelopes = add_common_data_to_envelopes(envelopes, response, app, error)
+
+      envelopes
+
+    end
+  end
+end

data/lib/pubnub/events/leave.rb

@@ -0,0 +1,73 @@
+module Pubnub
+  class Leave
+    include Pubnub::Event
+    include Pubnub::SingleEvent
+    include Pubnub::Formatter
+    include Pubnub::Validator
+
+
+    def initialize(options, app)
+      super
+      @event = 'leave'
+      @allow_multiple_channels = true
+      @doesnt_require_callback = true
+      @force = options[:force]
+      @skip_remove = options[:skip_remove]
+    end
+
+    def validate!
+      super
+
+      # check channel
+      raise ArgumentError.new(:object => self, :message => 'Leave requires :channel argument') unless @channel
+      raise ArgumentError.new(:object => self, :message => 'Invalid channel format! Should be type of: String, Symbol, or Array of both') unless valid_channel?
+    end
+
+    def fire(app)
+      app.update_timetoken(0)
+      if app.env[:subscriptions][@origin].nil?
+        raise ArgumentError.new(:object => self, :message => 'You cannot leave channel that is not subscribed')
+      elsif app.env[:subscriptions][@origin].get_channels.include?(@channel)
+        raise ArgumentError.new(:object => self, :message => 'You cannot leave channel that is not subscribed')
+      end unless @force
+      @channel.each do |channel|
+        app.env[:subscriptions][@origin].remove_channel(channel, app) if app.env[:subscriptions][@origin]
+      end unless @skip_remove
+      super
+    end
+
+    private
+
+    def path(app)
+      '/' + [
+          'v2',
+          'presence',
+          'sub-key',
+          @subscribe_key,
+          'channel',
+          @channel.join(','),
+          'leave'
+      ].join('/')
+    end
+
+    def format_envelopes(response, app, error)
+
+      parsed_response = Parser.parse_json(response.body) if Parser.valid_json?(response.body)
+
+      envelopes = Array.new
+      envelopes << Envelope.new(
+          {
+              :message           => parsed_response,
+              :response_message  => parsed_response
+          },
+          app
+      )
+
+      envelopes = add_common_data_to_envelopes(envelopes, response, app, error)
+
+      envelopes
+
+    end
+
+  end
+end

data/lib/pubnub/events/presence.rb

@@ -0,0 +1,35 @@
+module Pubnub
+  class Presence
+    include Pubnub::Event
+    include Pubnub::SubscribeEvent
+    include Pubnub::Formatter
+    include Pubnub::Validator
+
+
+    def initialize(options, app)
+      super
+      @channel = @channel.map {|c| c + '-pnpres'}
+      @event = 'presence'
+      @allow_multiple_channels = true
+
+    end
+
+    def fire(app)
+      app.update_timetoken(0)
+      super
+    end
+
+    def validate!
+      super
+
+      # Check channels
+      raise ArgumentError.new(:object => self, :message => 'Presence requires :channel or :channels argument') unless @channel
+      raise ArgumentError.new(:object => self, :message => 'Invalid channel(s) format! Should be type of: String, Symbol, or Array of both') unless valid_channel?
+
+    end
+
+    private
+
+
+  end
+end

data/lib/pubnub/events/publish.rb

@@ -0,0 +1,71 @@
+module Pubnub
+  class Publish
+    include Pubnub::Event
+    include Pubnub::SingleEvent
+    include Pubnub::Formatter
+    include Pubnub::Validator
+
+
+    def initialize(options, app)
+      super
+      @channel = @channel.first
+      @event = 'publish'
+      @allow_multiple_channels = false
+
+    end
+
+    def validate!
+      super
+      # check message
+      raise ArgumentError.new(:object => self, :message => 'Publish requires :message argument') unless @message
+
+      # check channel/channels
+      raise ArgumentError.new(:object => self, :message => 'Publish requires :channel or :channels argument') unless @channel
+      raise ArgumentError.new(:object => self, :message => 'Invalid channel(s) format! Should be type of: String, Symbol, or Array of both') unless valid_channel?
+    end
+
+    private
+
+    def path(app)
+      '/' + [
+          'publish',
+          @publish_key,
+          @subscribe_key,
+          if !@auth_key.blank? then @secret_key else '0' end,
+          @channel,
+          '0',
+          format_message(@message)
+      ].join('/')
+    end
+
+    def timetoken(parsed_response)
+      parsed_response[2] if parsed_response.is_a? Array
+    end
+
+    def response_message(parsed_response)
+      parsed_response[1] if parsed_response.is_a? Array
+    end
+
+    def format_envelopes(response, app, error)
+
+      parsed_response = Parser.parse_json(response.body) if Parser.valid_json?(response.body)
+
+      envelopes = Array.new
+      envelopes << Envelope.new(
+        {
+            :message           => @message,
+            :published_message => @message,
+            :channel           => @channel,
+            :response_message  => response_message(parsed_response),
+            :timetoken         => timetoken(parsed_response)
+        },
+        app
+      )
+
+      envelopes = add_common_data_to_envelopes(envelopes, response, app, error)
+
+      envelopes
+
+    end
+  end
+end