pubnub 3.5.3 → 3.5.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 101ccc5365ffa2fba48aa9ae86809cd46252759d
-  data.tar.gz: f497be3f1cc10e368cf3dfa6de728b69765e5ff6
+  metadata.gz: 26b4f23e927cf9a251f0ee9448b7a79989671927
+  data.tar.gz: 7e0bdee56ade94ffad6f9fa31f2c45cabe005031
 SHA512:
-  metadata.gz: 96d73debc55451d3f59f6d6a0d113a7fc61c1d89cb92f40d08e77506494833bcb245393b49c8b55a11b53dfb5be680510156c77157fdae917aeb5bfdac80a423
-  data.tar.gz: bc8d11c4899b877a3013bc1c31340d3438ec6da9fa94d556a01d92827e89759b104312de990b6a4a9363d0e7634a2ae49961948e22a5a9034a7ae5f09cad70e7
+  metadata.gz: 3d5c25706f7167c8f1283a704d33c307c7e6c772b09aff4e50d703b5e7594e48717cd2feb3ff77ef27649c7c999cde13feae1e13c60c790d1b09ecaa70c04f82
+  data.tar.gz: 057dcc61a333dc3bab121fc5412671be742a77a78bc936770db868c87858036d43d66e90ac76562746e983935468b431f9d882e24c7dec16cd2a629b15fa4378

data/README.md

@@ -1,3 +1,5 @@
+# Please direct all Support Questions and Concerns to Support@PubNub.com
+
 ##### YOU MUST HAVE A PUBNUB ACCOUNT TO USE THE API.
 ##### http://www.pubnub.com/account
 
@@ -14,14 +16,14 @@ PubNub 3.5.0 is NOT compatible with earlier than 3.4 versions of Pubnub Ruby Cli
 PubNub 3.5.0 is compatible with 3.4 version.
 
 #### Asynchronous vs Synchronous Responses
-Every event you will fire could be fired asynchronous ro synchonous just by passing 
+Every event you will fire could be fired asynchronous or synchonous just by passing 
 ```ruby
 :http_sync
 ```
 set to true to that event. Asynchronous events will not block your main thread and will be fired withing new thread.
 
 #### Message Handling: callback, block, return
-You could pass to every even callback as callback or just by block that will get envelope with message. Callback will be fired for every message that will event get in response. Synchornous events will return array of envelopes (if you passed callback to sychronous event it will be called too!).
+Results are provided via block, callback, and return, depending on how you structure the call. Callback will be fired for every message that will event get in response. Synchornous events will return array of envelopes (if you passed callback to sychronous event it will be called too!).
 
 ### Code Examples
 
@@ -498,4 +500,6 @@ module Pubnub
 end
 
 Pubnub.start
-```
+```
+
+# Please direct all Support Questions and Concerns to Support@PubNub.com

data/VERSION

@@ -1 +1 @@
-3.5.3
+3.5.5

data/examples/demo_console_new.rb

@@ -0,0 +1,286 @@
+require 'pubnub'
+require 'awesome_print'
+
+class String
+  def black;          "\033[30m#{self}\033[0m" end
+  def red;            "\033[31m#{self}\033[0m" end
+  def green;          "\033[32m#{self}\033[0m" end
+  def brown;         "\033[33m#{self}\033[0m" end
+  def blue;           "\033[34m#{self}\033[0m" end
+  def magenta;        "\033[35m#{self}\033[0m" end
+  def cyan;           "\033[36m#{self}\033[0m" end
+  def gray;           "\033[37m#{self}\033[0m" end
+  def bg_black;       "\033[40m#{self}\0330m"  end
+  def bg_red;         "\033[41m#{self}\033[0m" end
+  def bg_green;       "\033[42m#{self}\033[0m" end
+  def bg_brown;       "\033[43m#{self}\033[0m" end
+  def bg_blue;        "\033[44m#{self}\033[0m" end
+  def bg_magenta;     "\033[45m#{self}\033[0m" end
+  def bg_cyan;        "\033[46m#{self}\033[0m" end
+  def bg_gray;        "\033[47m#{self}\033[0m" end
+  def bold;           "\033[1m#{self}\033[22m" end
+  def reverse_color;  "\033[7m#{self}\033[27m" end
+end
+
+class DemoConsole
+
+  OPTIONS = {
+      :'1'  => :Publish,
+      :'2'  => :Subscribe,
+      :'3'  => :Presence,
+      :'4'  => :Leave,
+      :'5'  => :History,
+      :'6'  => :HereNow,
+      :'7'  => :WhereNow,
+      :'8'  => :State,
+      :'9'  => :Heartbeat,
+      :'10' => :Time,
+      :'11' => :Audit,
+      :'12' => :Grant,
+      :'13' => :Revoke,
+      :A    => :set_uuid,
+      :B    => :set_auth_key,
+      :C    => :show_state,
+      :D    => :set_state,
+      :EXIT => :exit
+  }
+
+  def initialize
+
+    welcome
+    
+    keys_option = select_keys
+
+    case keys_option.to_s
+    when '1'
+      @origin        = 'pubsub.pubnub.com'
+      @subscribe_key = 'demo-36'
+      @publish_key   = 'demo-36'
+      @secret_key    = nil
+
+    when '2'
+      @origin        = 'pubsub.pubnub.com'
+      @subscribe_key = 'sub-c-a478dd2a-c33d-11e2-883f-02ee2ddab7fe'
+      @publish_key   = 'pub-c-a2650a22-deb1-44f5-aa87-1517049411d5'
+      @secret_key    = 'sec-c-YjFmNzYzMGMtYmI3NC00NzJkLTlkYzYtY2MwMzI4YTJhNDVh'
+
+    when '3'
+      puts `clear`
+      print_pubnub
+      puts 'Okey, now you have to provide me your data or accept default:'.green
+      print 'origin [pubsub.pubnub.com]: '.white
+      @origin = gets.chomp!
+      print 'subscribe_key [demo-36]: '.white
+      @subscribe_key = gets.chomp!
+      print 'publish_key [demo-36]: '.white
+      @publish_key = gets.chomp!
+      print 'secret_key (nil by default): '.white
+      @secret_key = gets.chomp!
+
+      @origin        = 'pubsub.pubnub.com' if @origin.blank?
+      @subscribe_key = 'demo-36'           if @subscribe_key.blank?
+      @publish_key   = 'demo-36'           if @publish_key.blank?
+      @secret_key    = nil                 if @secret_key.blank?
+    else
+      @origin        = 'pubsub.pubnub.com'
+      @subscribe_key = 'demo-36'
+      @publish_key   = 'demo-36'
+      @secret_key    = nil
+    end
+
+    set_uuid_and_auth
+
+    @pubnub = Pubnub.new(
+      :subscribe_key  => @subscribe_key,
+      :publish_key    => @publish_key,
+      :secret_key     => @secret_key,
+      :error_callback => method(:error_callback),
+      :auth_key       => @auth_key
+    )
+
+    @pubnub.set_uuid(@uuid) unless @uuid.blank?
+
+    ap @pubnub
+
+    start_console
+
+  end
+
+  def welcome
+    puts `clear`
+    print_pubnub
+    puts 'Hello in interactive PubNub console!'.white
+    puts 'Feel free to play around with it!'.white
+    puts '--'
+    puts '[Hit ENTER to continue]'
+    gets
+    puts `clear`
+  end
+
+  def select_keys
+    print_pubnub
+    puts 'Before we start, you have to select demo app keys or add your own.'.green
+    print "\n"
+    puts '1. Basic demo keys  -- You will be limited to standard events, no PAM features'.white
+    puts '2. PAM supprot keys -- You can check out all pubnub features, including PAM'.white
+    puts '3. Custom keys      -- If you already have your own keys, you can set them here'.white
+    print "\n"
+    print 'Your choice: '.green
+    gets.chomp!
+  end
+
+  def set_uuid_and_auth
+    puts `clear`
+    print_pubnub
+    puts 'You can set up now your uuid and auth_key: '.green
+    print 'uuid [random_default]: '.white
+    @uuid = gets.chomp!
+    print 'auth_key (blank by default): '.white
+    @auth_key = gets.chomp
+  end
+
+  def set_uuid(uuid)
+    @pubnub.set_uuid(uuid)
+  end
+
+  def set_auth_key(auth_key)
+    @pubnub.set_auth_key(auth_key)
+  end
+
+  def start_console
+    puts `clear`
+    print_pubnub
+    puts 'CONSOLE STARTED!'.white.bg_green
+    exit = false
+    choice = false
+    until exit
+      until OPTIONS.keys.include?(choice)
+        puts 'Choose your next operation (type \'exit\' to exit):'.green
+        puts 'Events:'.green
+        puts '1.  Publish'.white
+        puts '2.  Subscribe'.white
+        puts '3.  Presence'.white
+        puts '4.  Leave (unsubscribe)'.white
+        puts '5.  History'.white
+        puts '6.  HereNow'.white
+        puts '7.  WhereNow'.white
+        puts '8.  State'.white
+        puts '9.  Heartbeat'.white
+        puts '10. Time'.white
+        puts '11. Audit'.white  if @secret_key
+        puts '12. Grant'.white  if @secret_key
+        puts '13. Revoke'.white if @secret_key
+        puts "\nPubnub::Client interaction:".green
+        puts 'A. Set UUID'.white
+        puts 'B. Set auth_key'.white
+        puts 'C. Check state'.white
+        puts 'D. Set state'.white
+        print "\nYour choice: ".red
+        choice = gets.chomp!.to_s.upcase.to_sym
+      end
+      choice = OPTIONS[choice]
+
+      case choice
+      when :exit
+        exit = true      
+      when :Publish
+        options = ask_about(:sync, :message, :channel)
+        @pubnub.publish(options)
+      when :Subscribe
+        options = ask_about(:sync, :channel)
+        @pubnub.subscribe(options)
+      when :Presence
+        options = ask_about(:sync, :channel)
+        @pubnub.presence(options)
+      when :Leave
+        options = ask_about(:sync, :channel)
+        @pubnub.leave(options)
+      when :History
+        options = ask_about(:sync, :channel, :reverse, :history_start, :history_end)
+        @pubnub.history(options)
+      when :HereNow
+        options = ask_about(:sync, :channel)
+        @pubnub.here_now(options)
+      when :WhereNow
+        options = ask_about(:sync, :uuid)
+        @pubnub.where_now(options)
+      when :State
+        options = ask_about(:sync, :channel, :uuid)
+        @pubnub.state(options)
+      when :Heartbeat
+        options = ask_about(:sync, :heartbeat)
+        @pubnub.heartbeat(options)
+      when :Time
+        options = ask_about(:sync)
+        @pubnub.time(options)
+      when :Audit
+        options = ask_about(:sync, :channel, :subscribe_key)
+        @pubnub.audit(options)
+      when :Grant
+        options = ask_about(:sync, :channel, :subscribe_key, :read, :write)
+        @pubnub.grant(options)
+      when :Revoke
+        options = ask_about(:sync, :channel, :subscribe_key, :read, :write)
+        @pubnub.revoke(options)
+      end
+      choice = nil
+    end
+  end
+
+  # that adds callback method as :callback in options
+  def ask_about(*things)
+    options = {}
+    things.each do |thing|
+      case thing
+      when :sync
+        print 'Should event be async? '.white
+        options[:http_sync] = !acceptance
+
+      when :message
+        while options[:message].blank?
+          puts 'Write below message to publish:'.white
+          options[:message] = gets.chomp!
+        end
+
+      when :channel
+        while options[:channel].blank?
+          print 'Specify channel(s): '.white
+          options[:channel] = gets.chomp!
+        end
+      end
+    end
+    options.merge({:callback => method(:callback)})
+  end
+
+  def acceptance
+    %w(Y 1).include?(gets.chomp!.to_s.upcase)
+  end
+
+  def print_pubnub
+    puts '
+    __________     ___.     _______       ___.       ________       ________
+    \______   \__ _\_ |__   \      \  __ _\_ |__     \_____  \     /  _____/
+     |     ___/  |  \ __ \  /   |   \|  |  \ __ \      _(__  <    /   __  \ 
+     |    |   |  |  / \_\ \/    |    \  |  / \_\ \    /       \   \  |__\  \
+     |____|   |____/|___  /\____|__  /____/|___  /   /______  / /\ \_____  /
+                        \/         \/          \/           \/  \/       \/ 
+
+                                                   Pubnub 3.6.x Demo Console
+    '.red
+  end
+
+  def callback(envelope)
+    ap envelope
+  end
+
+  def connect_callback(data)
+    puts 'Connection established'.bg_green.white
+  end
+
+  def error_callback(error)
+    puts 'ERROR'.bg_red.white
+    ap error
+  end
+end
+
+DemoConsole.new

data/fixtures/vcr_cassettes/grant-application-level.yml

@@ -0,0 +1,44 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://pubsub.pubnub.com/v1/auth/grant/sub-key/sub-c-53c3d30a-4135-11e3-9970-02ee2ddab7fe?pnsdk=PubNub-Ruby/3.6.3&r=1&signature=kdDh/sFC3rSR%2Bt5AEymIc57d1velIr562V7usa5M4k0=&timestamp=1234567890&ttl=1440&uuid=f0ac67ef-912f-4797-be67-a59745107306&w=1
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - '*/*'
+      User-Agent:
+      - Ruby
+      Connection:
+      - keep-alive
+      Keep-Alive:
+      - 30
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Wed, 04 Jun 2014 19:52:01 GMT
+      Content-Type:
+      - text/javascript; charset=UTF-8
+      Content-Length:
+      - '174'
+      Connection:
+      - keep-alive
+      Cache-Control:
+      - no-cache, no-store, must-revalidate
+      Access-Control-Allow-Origin:
+      - '*'
+      Access-Control-Allow-Methods:
+      - GET
+    body:
+      encoding: UTF-8
+      string: '{"status":200,"service":"Access Manager","message":"Success","payload":{"subscribe_key":"sub-c-53c3d30a-4135-11e3-9970-02ee2ddab7fe","r":1,"ttl":1440,"w":1,"level":"subkey"}}'
+    http_version: 
+  recorded_at: Wed, 04 Jun 2014 19:52:01 GMT
+recorded_with: VCR 2.9.2

data/fixtures/vcr_cassettes/revoke-application-level.yml

@@ -0,0 +1,44 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://pubsub.pubnub.com/v1/auth/grant/sub-key/sub-c-53c3d30a-4135-11e3-9970-02ee2ddab7fe?pnsdk=PubNub-Ruby/3.6.3&r=0&signature=kdDh/sFC3rSR%2Bt5AEymIc57d1velIr562V7usa5M4k0=&timestamp=1234567890&ttl=1440&uuid=f0ac67ef-912f-4797-be67-a59745107306&w=0
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - '*/*'
+      User-Agent:
+      - Ruby
+      Connection:
+      - keep-alive
+      Keep-Alive:
+      - 30
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Wed, 04 Jun 2014 19:52:01 GMT
+      Content-Type:
+      - text/javascript; charset=UTF-8
+      Content-Length:
+      - '174'
+      Connection:
+      - keep-alive
+      Cache-Control:
+      - no-cache, no-store, must-revalidate
+      Access-Control-Allow-Origin:
+      - '*'
+      Access-Control-Allow-Methods:
+      - GET
+    body:
+      encoding: UTF-8
+      string: '{"status":200,"service":"Access Manager","message":"Success","payload":{"subscribe_key":"sub-c-53c3d30a-4135-11e3-9970-02ee2ddab7fe","r":0,"ttl":1440,"w":0,"level":"subkey"}}'
+    http_version: 
+  recorded_at: Wed, 04 Jun 2014 19:52:01 GMT
+recorded_with: VCR 2.9.2

data/lib/pubnub/client.rb

@@ -24,7 +24,7 @@ module Pubnub
     end
 
     EVENTS.each do |event_name|
-      define_method event_name do |params, &block|
+      define_method event_name do |params = {}, &block|
         params[:callback] = block if params[:callback].nil?
         event = Pubnub.const_get(classify_method(event_name)).new(params, self)
         $logger.debug('Pubnub'){'Created event ' + event.class.to_s}

data/lib/pubnub/event.rb

@@ -272,10 +272,19 @@ module Pubnub
                 @channel.delete(channel)
                 $logger.error('Pubnub'){"Already subscribed to channel #{channel}, you have to leave that channel first"}
               end
+            end
+
+            @channel.each do |channel|
               $logger.debug('Pubnub'){'SubscribeEvent#add_channel | Adding channel'}
               app.env[:subscriptions][@origin].add_channel(channel, app)
             end
-            app.start_respirator
+
+            if @channel.empty?
+              false
+            else
+              app.start_respirator
+              true
+            end
           end
 
           if app.env[:subscriptions][@origin].nil?

data/lib/pubnub/events/subscribe.rb

@@ -23,7 +23,7 @@ module Pubnub
       # Check channels
       raise ArgumentError.new(:object => self, :message => 'Subscribe requires :channel or :channels argument') unless @channel
 
-      # check callback
+      # Check callback
       raise ArgumentError.new(:object => self, :message => 'Callback parameter is required while using async subscribe') if !@http_sync && @callback.blank?
 
     end

data/lib/pubnub/pam.rb

@@ -26,7 +26,7 @@ module Pubnub
     def parameters(app, signature = false)
       params = super(app)
       params.merge!({ :timestamp => @timestamp })
-      params.merge!({ :channel   => @channel.first })
+      params.merge!({ :channel   => @channel.first }) unless @channel.first.blank?
       params.merge!({ :signature => signature(app) }) unless signature
       params
     end

data/lib/version.rb

@@ -1,3 +1,3 @@
 module Pubnub
-  VERSION = '3.5.3'
+  VERSION = '3.5.5'
 end

data/pubnub.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = 'pubnub'
-  s.version = '3.5.3'
+  s.version = '3.5.5'
 
   s.required_rubygems_version = Gem::Requirement.new('>= 0') if s.respond_to? :required_rubygems_version=
   s.authors = ['PubNub']
-  s.date = '2014-04-14'
+  s.date = '2014-05-31'
   s.description = 'Ruby anywhere in the world in 250ms with PubNub!'
   s.email = 'support@pubnub.com'
   s.files = `git ls-files`.split("\n")

data/spec/lib/integration/grant_spec.rb

@@ -33,6 +33,17 @@ describe "#grant" do
   end
   context "uses ssl" do
     before(:each) { @ssl = true }
+    it "Generates valid url for application level" do
+      VCR.use_cassette("grant-application-level", :record => :none) do
+        @pn.grant(:http_sync => true, &@callback)
+
+        @after_callback.should eq true
+        @response_output.seek 0
+        @response_output.read.should eq '{"status":200,"service":"Access Manager","message":"Success","payload":{"subscribe_key":"sub-c-53c3d30a-4135-11e3-9970-02ee2ddab7fe","r":1,"ttl":1440,"w":1,"level":"subkey"}}'
+        @message_output.seek 0
+        @message_output.read.should eq 'Success'
+      end
+    end
     context "passess callback as block" do
       context "gets valid json in response" do
         context "gets status 200 in response" do

data/spec/lib/integration/revoke_spec.rb

@@ -33,6 +33,17 @@ describe "#revoke" do
   end
   context "uses ssl" do
     before(:each) { @ssl = true }
+    it "Generates valid url for application level" do
+      VCR.use_cassette("revoke-application-level", :record => :none) do
+        @pn.revoke(:http_sync => true, &@callback)
+
+        @after_callback.should eq true
+        @response_output.seek 0
+        @response_output.read.should eq '{"status":200,"service":"Access Manager","message":"Success","payload":{"subscribe_key":"sub-c-53c3d30a-4135-11e3-9970-02ee2ddab7fe","r":0,"ttl":1440,"w":0,"level":"subkey"}}'
+        @message_output.seek 0
+        @message_output.read.should eq 'Success'
+      end
+    end
     context "passess callback as block" do
       context "gets valid json in response" do
         context "gets status 200 in response" do

data/spec/lib/subscribe_event.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+describe 'Pubnub::SubscribeEvent' do
+  it 'doesnt include same channel to running subscription twice' do
+    @pn = Pubnub.new(:subscribe_key => 'demo-36', :publish_key => 'demo-36')
+
+    VCR.use_cassette("subscribe-event-include-test", :record => :all) do
+      @pn.subscribe(:http_sync => false, :channel => 'demo'){|e| }
+      @pn.subscribe(:http_sync => false, :channel => 'demo'){|e| }
+
+      eventually do
+        @pn.env[:subscriptions]['pubsub.pubnub.com'].get_channels.should eq ['demo']
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pubnub
 version: !ruby/object:Gem::Version
-  version: 3.5.3
+  version: 3.5.5
 platform: ruby
 authors:
 - PubNub
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-14 00:00:00.000000000 Z
+date: 2014-05-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: eventmachine
@@ -65,6 +65,7 @@ files:
 - Rakefile
 - VERSION
 - examples/demo_console.rb
+- examples/demo_console_new.rb
 - examples/error_server.rb
 - examples/pubnub_livestream/.gitignore
 - examples/pubnub_livestream/Gemfile
@@ -223,6 +224,7 @@ files:
 - fixtures/vcr_cassettes/formatting-envelope-subscribe-without-cipherkey-one-channel-integer.yml
 - fixtures/vcr_cassettes/formatting-envelope-subscribe-without-cipherkey-one-channel-mix.yml
 - fixtures/vcr_cassettes/formatting-envelope-subscribe-without-cipherkey-one-channel-string.yml
+- fixtures/vcr_cassettes/grant-application-level.yml
 - fixtures/vcr_cassettes/grant-nonssl-block-invalid-200-async.yml
 - fixtures/vcr_cassettes/grant-nonssl-block-invalid-200-sync.yml
 - fixtures/vcr_cassettes/grant-nonssl-block-invalid-non-200-async.yml
@@ -487,6 +489,7 @@ files:
 - fixtures/vcr_cassettes/publish-ssl-parameter-valid-200-sync.yml
 - fixtures/vcr_cassettes/publish-ssl-parameter-valid-non-200-async.yml
 - fixtures/vcr_cassettes/publish-ssl-parameter-valid-non-200-sync.yml
+- fixtures/vcr_cassettes/revoke-application-level.yml
 - fixtures/vcr_cassettes/revoke-nonssl-block-invalid-200-async.yml
 - fixtures/vcr_cassettes/revoke-nonssl-block-invalid-200-sync.yml
 - fixtures/vcr_cassettes/revoke-nonssl-block-invalid-non-200-async.yml
@@ -664,6 +667,7 @@ files:
 - spec/lib/integration/time_spec.rb
 - spec/lib/integration/v3_presence_spec.rb
 - spec/lib/retry_logic_spec.rb
+- spec/lib/subscribe_event.rb
 - spec/spec_helper.rb
 - spec/tools/pam-test-generator.rb
 - spec/tools/test-generator.rb