pubnub 3.6.10 → 3.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 72ab3a0cc365b65f7d43792c3b48090ca98c8a2f
-  data.tar.gz: a4bfd82d2992245e27b3966f43d4d86c040435fa
+  metadata.gz: bfd5538b26675782f56350179deedd2806381507
+  data.tar.gz: afd697119dafc00c909f3e4ca3e69d83658af633
 SHA512:
-  metadata.gz: 5fece7ee84335eea9608bb4a3a424f2eb96c6820f1f493b9d6430fa4a9b1e235d6e31f16906fec21b4e436d9357ec5179e9e51d8c6c4870bfb19ac0755fcad48
-  data.tar.gz: bdc45b7d2bc1f4c4332fe6698270cbf7d4c0f306371592e707773374de39292516eade4711e45b8656c5b6be96f8f605975c7db6c8ee7d76b9915da73b9701f9
+  metadata.gz: 859506af0ab59f9d66e926a220bee8bb462accba1ec03d9dfbe8bc102694751171621754bd0489180b4a2b63a1888cc04083d86a21efd4838de8cad10258e4cc
+  data.tar.gz: 2d514980a3f04733bac4282ec8d114c47733f100129c0a21c38afbf9fa9def8a38bf5c9f1dea49d63a2f0a55d4f6ab1755aeaf2d4320a3915cca3b563ccffa10

data/CHANGELOG.txt

@@ -1,3 +1,6 @@
+3.7.0 Release
+. Added channel groups features
+
 3.6.10 Release
 . Envelope formatting fix
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    pubnub (3.6.7)
+    pubnub (3.7.0beta0)
       eventmachine (~> 1.0)
       json (~> 1.8)
       net-http-persistent (~> 2.9)

data/README.md

@@ -1,6 +1,6 @@
 # Please direct all Support Questions and Concerns to Support@PubNub.com
 
-## PubNub Gem version 3.6.10
+## PubNub Gem version 3.7.0
 
 ##### YOU MUST HAVE A PUBNUB ACCOUNT TO USE THE API.
 ##### http://www.pubnub.com/account
@@ -17,17 +17,17 @@ We've made the response format compatible across all operations. This may break
 Examples of affected operations can be found [here](3.5_to_3.6_upgrade_notes.md).
 
 ### Upgrading from PubNub 3.3.x and Earlier
-PubNub 3.6.10 is NOT compatible with earlier than 3.4 versions of Pubnub Ruby Client.
+PubNub 3.7.0 is NOT compatible with earlier than 3.4 versions of Pubnub Ruby Client.
 
 ### Upgrading from PubNub 3.4 and higher versions
-PubNub 3.6.10 is compatible with 3.4 version.
+PubNub 3.7.0 is compatible with 3.4 version.
 
 ## Important Notice about Blocking vs Non-Blocking Calls
 
 #### Asynchronous vs Synchronous Requests
-Every operation is by default asyncronous. Asynchronous operations will not block your main thread and will be fired within a new thread.
+Every operation is by default asynchronous. Asynchronous operations will not block your main thread and will be fired within a new thread.
 
-This can cause issues under certain situations, depending on your implementation. To work around this, you can force an operation to run syncronously (block) via the :http_sync option:
+This can cause issues under certain situations, depending on your implementation. To work around this, you can force an operation to run synchronously (block) via the :http_sync option:
 
 ```ruby
 :http_sync => true
@@ -36,7 +36,7 @@ This can cause issues under certain situations, depending on your implementation
 Unless otherwise specified, this option is default implied false (all calls by default will be async).
 
 #### Message Handling: callback, block, return
-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!).
+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. Synchronous events will return array of envelopes (if you passed callback to sychronous event it will be called too!).
 
 ### Code Examples
 
@@ -55,7 +55,6 @@ my_logger = Logger.new(STDOUT)
 pubnub = Pubnub.new(
     :subscribe_key    => 'demo',
     :publish_key      => 'demo',
-    :origin           => origin,
     :error_callback   => lambda { |msg|
       puts "Error callback says: #{msg.inspect}"
     },
@@ -207,7 +206,9 @@ pubnub.subscribe(
 ```
 
 #### Leave
-Unsubscribes from given channel and fires leave event. You need to be subscribed (only async counts) to channel that you want to leave
+Unsubscribes from given channel (`:channel`) or channel group (`:group`) and 
+fires leave event. You need to be subscribed (only async counts) to channel that 
+You want to leave.
 
 ```ruby
 pubnub.subscribe(
@@ -262,8 +263,16 @@ pubnub.presence(
 )
 ```
 
+```ruby
+pubnub.presence(
+    :group    => 'foo:',
+    :callback => @my_callback
+)
+```
+
 #### HereNow
-See who is "here now" in a channel at this very moment.
+See who is "here now" in a channel (:channel) or channel group (:group) at this
+very moment.
 
 ```ruby
 pubnub.here_now(
@@ -272,6 +281,13 @@ pubnub.here_now(
 )
 ```
 
+```ruby
+pubnub.here_now(
+    :group    => channel_group,
+    :callback => @my_callback
+)
+```
+
 #### WhereNow
 See where is client with specific uuid
 
@@ -300,6 +316,95 @@ Get the current PubNub time. This is great to use as a "PubNub Ping"
 pubnub.time("callback" => @my_callback)
 ```
 
+### Channel Groups
+
+Channel grouping is new feature introduced in Pubnub 3.7. It allows to group
+channels into channel-groups and channel-groups into namespaces. For example you
+can add `weather` and `sport` channel to `news` channel group, and `news` and
+`local_ads` to `tv` namespace. Namespaces and channel groups are described as 
+`namespace:channel_group` e.g. `tv:news`. All channel-groups in namespace are 
+described as `namespace:` e.g. `tv:`. Non-namespaced channel groups are
+described as `non-namespaced-channel-group` eg. `global_alerts`.
+
+All channel groups specific operations can be issued with
+`#channel_registration` method.
+
+#### Getting info
+
+##### Getting all namespaces
+
+```ruby
+# Response envelope will hold info as hash in payload attribute. 
+pubnub.channel_registration(action: :list_namespaces, http_sync: true)
+```
+
+##### Getting all non-namespaced channel groups
+
+```ruby
+# Response envelope will hold info as hash in payload attribute.
+pubnub.channel_registration(action: :list_groups, http_sync: true)
+```
+
+##### Getting all channel groups in given namespace
+
+```ruby
+# Response envelope will hold info as hash in payload attribute.
+pubnub.channel_registration(action: :get, group: 'foo:', http_sync: true)
+```
+
+##### Getting all channels in channel group
+
+```ruby
+# Response envelope will hold info as hash in payload attribute.
+pubnub.channel_registration(action: :get, group: 'foo:foo', http_sync: true)
+```
+
+#### Adding
+
+##### Add channel to namespaced channel group
+
+```ruby
+pubnub.channel_registration(action: :add, group: 'foo:new_group', channel: :bot, http_sync: true)
+```
+
+##### Add channel to non-namespaced channel group
+
+```ruby
+pubnub.channel_registration(action: :add, group: 'new_group', channel: :bot, http_sync: true)
+```
+
+#### Removing
+
+##### Remove namespace and all channel groups
+
+```ruby
+pubnub.channel_registration(action: :remove, group: 'foo:', http_sync: true)
+```
+
+##### Remove namespaced channel group
+
+```ruby
+pubnub.channel_registration(action: :remove, group: 'foo:cg', http_sync: true)
+```
+
+##### Remove non-namespaced channel group
+
+```ruby
+pubnub.channel_registration(action: :remove, group: 'cg', http_sync: true)
+```
+
+##### Remove channel from namespaced channel group
+
+```ruby
+pubnub.channel_registration(action: :remove, group: 'foo:cg', channel: :to_remove, http_sync: true)
+```
+
+##### Remove channel from non-namespaced channel group
+
+```ruby
+pubnub.channel_registration(action: :remove, group: 'cg', channel: :to_remove, http_sync: true)
+```
+
 ### PAM
 
 Developers can grant/revoke/audit fine-grained permissions for their real-time apps and data at various levels.
@@ -325,6 +430,15 @@ end
 pubnub.grant(:presence => :demo, :channel => :demo) do |envelope|
   puts envelope.message
 end
+
+# For channel groups, all above work.
+# But channel groups additionally have :manage option.
+
+# Will grant :r, :w and :m permissions to foo:foo
+pubnub.grant(:group => 'foo:foo') do |envelope|
+  puts envelope.message
+end
+
 ```
 
 ##### Audit
@@ -428,10 +542,23 @@ pubnub.subscribe(
 ) do |envelope|
   puts envelope.message['attacker']
   puts envelope.message['defender']
-  puts envelope.message['demage']
+  puts envelope.message['damage']
 end
 ```
 
+###### Channel groups
+You can subscribe to channel group same way as You're subscribing to channels.
+
+```ruby
+pubnub.subscribe(group: 'foo:foo', channel: :ping_3, callback: callback)
+```
+
+Response envelopes will hold channel and channel_group values. So, if You want
+to subscribe to channel group and your callback need to know where are envelopes
+from, You can check it using `envelope.channel_group`. Of course You can
+subscribe to channel group and plain channel at once.
+
+
 ##### History
 History returns :count messages from given channel.
 ```ruby
@@ -565,6 +692,9 @@ pubnub.subscribe(:channel => 'my_channel', :state => {:my_channel => {:key => :v
 # Using event #set_state
 pubnub.set_state(:state => {:key => :value}, :channel => :my_channel, :http_sync => true)
 
+# or with channel groups
+pubnub.set_state(:state => {:key => :value}, :group => 'foo:foo', :http_sync => true)
+
 ```
 
 #### Getting state
@@ -573,6 +703,10 @@ pubnub.set_state(:state => {:key => :value}, :channel => :my_channel, :http_sync
 pubnub.state(:uuid => 'uuid_client_that_i_am_searching_for', :http_sync => true)
 ```
 
+#### State and channel groups
+State works fine with channel groups too! Just pass the `:group` key when
+setting or do it while subscribing.
+
 ### Other
 
 Advanced usage examples can be found also in the examples directory.

data/examples/demo_console.rb

@@ -35,10 +35,11 @@ class DemoConsole
       :'8'  => :WhereNow,
       :'9'  => :State,
       :'10' => :Heartbeat,
-      :'11' => :Time,
-      :'12' => :Audit,
-      :'13' => :Grant,
-      :'14' => :Revoke,
+      :'11' => :ChannelRegistration,
+      :'12' => :Time,
+      :'13' => :Audit,
+      :'14' => :Grant,
+      :'15' => :Revoke,
       :A    => :set_uuid,
       :B    => :set_auth_key,
       :C    => :show_state,
@@ -174,10 +175,11 @@ class DemoConsole
         puts '8.  WhereNow'
         puts '9.  State'
         puts '10. Heartbeat'
-        puts '11. Time'
-        puts '12. Audit'  if @secret_key
-        puts '13. Grant'  if @secret_key
-        puts '14. Revoke' if @secret_key
+        puts '11. ChannelRegistration'
+        puts '12. Time'
+        puts '13. Audit'  if @secret_key
+        puts '14. Grant'  if @secret_key
+        puts '15. Revoke' if @secret_key
         puts "\nPubnub::Client interaction:".green
         puts 'A. Set UUID'
         puts 'B. Set auth_key'
@@ -195,13 +197,13 @@ class DemoConsole
         options = ask_about(:sync, :message, :channel)
         @pubnub.publish(options)
       when :Subscribe
-        options = ask_about(:sync, :channel)
+        options = ask_about(:sync, :channel, :group)
         @pubnub.subscribe(options)
       when :Presence
-        options = ask_about(:sync, :channel)
+        options = ask_about(:sync, :channel, :group)
         @pubnub.presence(options)
       when :Leave
-        options = ask_about(:sync, :channel)
+        options = ask_about(:sync, :channel, :group)
         @pubnub.leave(options)
       when :History
         options = ask_about(:sync, :channel, :reverse, :history_start, :history_end, :count)
@@ -210,7 +212,7 @@ class DemoConsole
         options = ask_about(:sync, :channel, :reverse, :history_start, :history_end, :limit, :page)
         @pubnub.paged_history(options)
       when :HereNow
-        options = ask_about(:sync, :optional_channel)
+        options = ask_about(:sync, :optional_channel, :group)
         @pubnub.here_now(options)
       when :WhereNow
         options = ask_about(:sync, :uuid)
@@ -221,17 +223,20 @@ class DemoConsole
       when :Heartbeat
         options = ask_about(:sync, :heartbeat, :channel)
         @pubnub.heartbeat(options)
+      when :ChannelRegistration
+        options = ask_about(:sync, :action, :group, :channel)
+        @pubnub.channel_registration(options)
       when :Time
         options = ask_about(:sync)
         @pubnub.time(options)
       when :Audit
-        options = ask_about(:sync, :channel, :subscribe_key)
+        options = ask_about(:sync, :channel, :group, :auth_key)
         @pubnub.audit(options)
       when :Grant
-        options = ask_about(:sync, :channel, :subscribe_key, :read, :write)
+        options = ask_about(:sync, :channel, :group, :auth_key, :read, :write, :manage)
         @pubnub.grant(options)
       when :Revoke
-        options = ask_about(:sync, :channel, :subscribe_key, :read, :write)
+        options = ask_about(:sync, :channel, :group, :auth_key, :read, :write, :manage)
         @pubnub.revoke(options)
       when :set_uuid
         print 'Your new uuid: '
@@ -266,6 +271,31 @@ class DemoConsole
         print 'Should event be async? '
         options[:http_sync] = !acceptance
 
+      when :action
+        while options[:action].blank?
+          puts 'Specify action:'
+          puts '1. :list_namespaces'
+          puts '2. :list_groups'
+          puts '3. :get'
+          puts '4. :add'
+          puts '5. :remove'
+          puts 'Action: '
+          case gets.chomp!.to_i
+            when 1
+              options[:action] = :list_namespaces
+            when 2
+              options[:action] = :list_groups
+            when 3
+              options[:action] = :get
+            when 4
+              options[:action] = :add
+            when 5
+              options[:action] = :remove
+            else
+              options[:action] = nil
+          end
+        end
+
       when :message
         while options[:message].blank?
           puts 'Write below message to publish:'
@@ -273,10 +303,12 @@ class DemoConsole
         end
 
       when :channel
-        while options[:channel].blank?
-          print 'Specify channel(s): '
-          options[:channel] = gets.chomp!
-        end
+        print 'Specify channel(s): '
+        options[:channel] = gets.chomp!
+
+        when :group
+          print 'Specify channel group(s): '
+          options[:group] = gets.chomp!
 
       when :optional_channel
           print 'Specify channel(s) or leave blank for all channels (global here now): '
@@ -329,10 +361,10 @@ class DemoConsole
           options[:heartbeat] = gets.chomp!
         end
 
-      when :subscribe_key
-        while options[:subscribe_key].blank?
-          print 'Enter subscribe key: '
-          options[:subscribe_key] = gets.chomp!
+      when :auth_key
+        while options[:auth_key].blank?
+          print 'Enter auth key: '
+          options[:auth_key] = gets.chomp!
         end
 
       when :read
@@ -347,6 +379,12 @@ class DemoConsole
           options[:write] = acceptance
         end
 
+      when :manage
+        while options[:manage].blank? && options[:manage] != false
+          print 'Manage? '
+          options[:manage] = acceptance
+        end
+
       when :limit
         while options[:limit].blank?
           print 'limit: '

data/fixtures/vcr_cassettes/cg/add-c-as-array.yml

@@ -0,0 +1,51 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://pubsub.pubnub.com/v1/channel-registration/sub-key/demo/namespace/foo/channel-group/foo?add=one,two&pnsdk=PubNub-Ruby/3.7.0beta0&uuid=045b8b3d-da8e-4c28-9bb7-10c00b404849
+    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:
+      - Tue, 04 Nov 2014 13:42:22 GMT
+      Content-Type:
+      - text/javascript; charset="UTF-8"
+      Content-Length:
+      - '79'
+      Connection:
+      - keep-alive
+      Cache-Control:
+      - no-cache
+      Access-Control-Allow-Origin:
+      - "*"
+      Access-Control-Allow-Methods:
+      - GET
+      Accept-Ranges:
+      - bytes
+      Age:
+      - '0'
+      Server:
+      - Pubnub
+    body:
+      encoding: UTF-8
+      string: '{"status": 200, "message": "OK", "service": "channel-registry", "error":
+        false}'
+    http_version: 
+  recorded_at: Tue, 04 Nov 2014 13:42:22 GMT
+recorded_with: VCR 2.9.2