pubnub 3.8.2 → 3.8.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 589a06d46675772563abee39dfdb97cf852c1055
-  data.tar.gz: bcf337cd2289ccfa8856da7c5721ae19dacf038d
+  metadata.gz: b740b21f8ca919ebf7f7e9a2ff32bbc837bb286d
+  data.tar.gz: da514132beb2de147a7dd8094e3559f75c79b054
 SHA512:
-  metadata.gz: 8e587fab2eb014182b979d9769d25a7596a1ce17f934deb1ec8b0233aac1801fed3c8f36e582893e35c6dd593897f9b63ae7b2cccca28ceb9c8eba54422022a3
-  data.tar.gz: 1b1a3fd598b818b09c99312b6a5b59163c49d0f6b8dea96fb6dddfc737fe6ad9833485ed01e51829e8a49a9960ba740194f831273eec15ad66cfd460bfa4ca59
+  metadata.gz: 6e9ed5b8d2afea4165cf0b524da6bc998f2bfaea93b4b8f39dcb1aaea5aa1002ebfa4ed11a3f4cb29ee38506f1c26aeae932e62781e95a6a9acf0ade5155a3d5
+  data.tar.gz: e214a9b3eee594176be3e5b82acf0263a55558e6c87b204005cb35f2b09be9ea4ec32c879b09be0be2bf8446c2650c26a9b59aa69ef40410de126047baccc69e

data/.gitignore

@@ -7,4 +7,3 @@ log/*
 *.log
 examples/test.rb
 coverage
-dev_scripts

data/CHANGELOG.md

@@ -1,8 +1,11 @@
+##### 3.8.3
+* Restored auth_key and uuid setters. Important notice: they will be removed in v4 of this library.
+
 ##### 3.8.2
-* Decoding fixed
+* Added :include_token parameter to history call.
 
 ##### 3.8.1
-* Updated celluloid dependency
+* Updated celluloid dependency.
 
 ##### 3.8.0
 * Release of celluloid version of pubnub gem. It's complete rewrite but public API doesn't change.

data/Gemfile

@@ -15,4 +15,4 @@ end
 group :development do
   gem 'pry'
   gem 'awesome_print'
-end
+end

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    pubnub (3.8.2)
+    pubnub (3.8.4)
       celluloid (~> 0.17)
       httpclient (~> 2.6)
       json (~> 1.8)
@@ -45,11 +45,13 @@ GEM
     docile (1.1.5)
     domain_name (0.5.25)
       unf (>= 0.0.5, < 1.0.0)
+    ffi (1.9.10)
     ffi (1.9.10-java)
     hitimes (1.2.4)
+    hitimes (1.2.4-java)
     http-cookie (1.0.2)
       domain_name (~> 0.5)
-    httpclient (2.8.1)
+    httpclient (2.8.3)
     json (1.8.3)
     json (1.8.3-java)
     method_source (0.8.2)
@@ -105,7 +107,7 @@ GEM
     term-ansicolor (1.3.2)
       tins (~> 1.0)
     thor (0.19.1)
-    timers (4.1.1)
+    timers (4.1.2)
       hitimes
     tins (1.6.0)
     unf (0.1.4)
@@ -135,4 +137,4 @@ DEPENDENCIES
   webmock
 
 BUNDLED WITH
-   1.12.5
+   1.14.4

data/README.md

@@ -3,7 +3,7 @@
 
 # Please direct all Support Questions and Concerns to Support@PubNub.com
 
-## PubNub Gem version 3.8.2
+## PubNub Gem version 3.8.3
 
 ##### YOU MUST HAVE A PUBNUB ACCOUNT TO USE THE API.
 ##### http://www.pubnub.com/account

data/VERSION

@@ -1 +1 @@
-3.8.1
+3.8.4

data/fixtures/vcr_cassettes/integration/history/include_token.yml

@@ -0,0 +1,49 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://pubsub.pubnub.com/v2/history/sub-key/demo/channel/bot?auth=demoish_authkey&count=4&include_token=true&pnsdk=PubNub-Ruby/3.8.1&uuid=rubytests
+    body:
+      encoding: UTF-8
+      string: ''
+    headers:
+      User-Agent:
+      - HTTPClient/1.0 (2.7.1, ruby 2.2.2 (2015-04-13))
+      Accept:
+      - "*/*"
+      Date:
+      - Wed, 13 Apr 2016 10:50:10 GMT
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Wed, 13 Apr 2016 10:50:11 GMT
+      Content-Type:
+      - text/javascript; charset="UTF-8"
+      Content-Length:
+      - '387'
+      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: '[[{"message":"******......... 3491 - 2016-04-13 03:50:06","timetoken":14605446066210865},{"message":"*******........
+        3492 - 2016-04-13 03:50:07","timetoken":14605446077902610},{"message":"********.......
+        3493 - 2016-04-13 03:50:08","timetoken":14605446089621213},{"message":"*********......
+        3494 - 2016-04-13 03:50:10","timetoken":14605446101325777}],14605446066210865,14605446101325777]'
+    http_version: 
+  recorded_at: Wed, 13 Apr 2016 10:50:11 GMT
+recorded_with: VCR 2.9.3

data/fixtures/vcr_cassettes/integration/publish/publish-meta.yml

@@ -0,0 +1,40 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://pubsub.pubnub.com/publish/demo/demo/0/ruby_demo_channel/0/%7B%22text%22:%22sometext%22%7D?auth=demoish_authkey&meta=%7B%22region%22:%22west%22%7D&pnsdk=PubNub-Ruby/3.8.0&uuid=tester
+    body:
+      encoding: UTF-8
+      string: ''
+    headers:
+      User-Agent:
+      - HTTPClient/1.0 (2.7.1, ruby 2.2.2 (2015-04-13))
+      Accept:
+      - "*/*"
+      Date:
+      - Wed, 10 Feb 2016 16:49:47 GMT
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Wed, 10 Feb 2016 16:49:47 GMT
+      Content-Type:
+      - text/javascript; charset="UTF-8"
+      Content-Length:
+      - '30'
+      Connection:
+      - keep-alive
+      Cache-Control:
+      - no-cache
+      Access-Control-Allow-Origin:
+      - "*"
+      Access-Control-Allow-Methods:
+      - GET
+    body:
+      encoding: UTF-8
+      string: '[1,"Sent","14551229878229279"]'
+    http_version: 
+  recorded_at: Wed, 10 Feb 2016 16:49:47 GMT
+recorded_with: VCR 2.9.3

data/lib/pubnub/client.rb

@@ -344,6 +344,22 @@ module Pubnub
       totally_empty @env[:state]
     end
 
+    def set_auth_key(key)
+      @env[:auth_key] = key
+    end
+
+    def auth_key=(key)
+      set_auth_key(key)
+    end
+
+    def set_uuid(uuid)
+      @env[:uuid] = uuid
+    end
+
+    def uuid=(uuid)
+      set_uuid(uuid)
+    end
+
     private
 
     def create_state_pools(event)

data/lib/pubnub/crypto.rb

@@ -43,7 +43,7 @@ module Pubnub
       plain_text = decode_cipher.update(undecoded_text)
       plain_text << decode_cipher.final
     rescue => e
-      Pubnub.logger.error('Pubnub') { "DECRYPTION ERROR #{e}" }
+      Pubnub.error('Pubnub') { "DECRYPTION ERROR #{e}" }
       '"DECRYPTION ERROR"'
     end
 

data/lib/pubnub/event.rb

@@ -152,9 +152,8 @@ module Pubnub
                      open_timeout read_timeout idle_timeout heartbeat
                      group action read write manage ttl presence start
                      end count reverse presence_callback store skip_validate
-                     state channel_group compressed)
+                     state channel_group compressed meta include_token)
 
-      # options = options.reduce({}) { |memo, (k, v)| memo[k.to_sym] = v; memo }
       options = options.each_with_object({}) { |option, obj| obj[option.first.to_sym] = option.last }
 
       variables.each { |variable| instance_variable_set('@' + variable, options[variable.to_sym]) unless variable.nil? }

data/lib/pubnub/events/history.rb

@@ -12,10 +12,20 @@ module Pubnub
 
     private
 
-    def timetoken(parsed_response)
-      parsed_response[2]
-    rescue
-      nil
+    def timetoken(message)
+      if @include_token
+        message['timetoken']
+      else
+        nil
+      end
+    end
+
+    def message(message)
+      if @include_token
+        message['message']
+      else
+        message
+      end
     end
 
     def response_message(parsed_response)
@@ -37,10 +47,11 @@ module Pubnub
 
     def parameters
       params = super
-      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.merge!(start:   @start)       if @start
+      params.merge!(end:     @end)         if @end
+      params.merge!(count:   @count)       if @count
+      params.merge!(reverse: 'true')       if @reverse
+      params.merge!(include_token: 'true') if @include_token
       params
     end
 
@@ -59,19 +70,12 @@ module Pubnub
     end
 
     def valid_envelopes(parsed_response)
-
-      crypto = Pubnub::Crypto.new(@app.env[:cipher_key]) if @app.env[:cipher_key]
-
       parsed_response.first.map do |message|
-        if crypto && message
-          message = crypto.decrypt(message)
-        end
-
         Envelope.new(parsed_response:  parsed_response,
-                     message:          message,
+                     message:          message(message),
                      channel:          @channel.first,
                      response_message: response_message(parsed_response),
-                     timetoken:        timetoken(parsed_response),
+                     timetoken:        timetoken(message),
                      history_start:    parsed_response[1],
                      history_end:      parsed_response[2])
       end

data/lib/pubnub/events/publish.rb

@@ -40,7 +40,8 @@ module Pubnub
 
     def parameters
       empty_if_blank = {
-        store: @store
+        store: @store,
+        meta: @meta
       }
 
       empty_if_blank.delete_if { |_k, v| v.blank? }

data/lib/pubnub/formatter.rb

@@ -79,7 +79,12 @@ module Pubnub
       def params_hash_to_url_params(hash)
         params = ''
         hash.each do |key, value|
-          params << "#{key}=#{value}&"
+          if %w(meta).include?(key.to_s)
+            encoded_value = URI.encode_www_form_component(value.to_json).gsub('+', '%20')
+            params << "#{key}=#{encoded_value}&"
+          else
+            params << "#{key}=#{value}&"
+          end
         end
         params.chop! if params[-1] == '&'
       end

data/lib/pubnub/subscribe_event/formatter.rb

@@ -21,10 +21,6 @@ module Pubnub
           group = nil
         end
 
-        if @app.env[:cipher_key] && msg
-          msg = Pubnub::Crypto.new(@app.env[:cipher_key]).decrypt(msg)
-        end
-
         Envelope.new(
           parsed_response: parsed_response,
           message: msg,

data/lib/pubnub/validators/publish.rb

@@ -12,6 +12,7 @@ module Pubnub
         validate_channel!
         validate_message!
         validate_store!
+        validate_meta!
       end
 
       private
@@ -43,6 +44,13 @@ module Pubnub
           ':message is required for publish event.'
         ) if @message.nil?
       end
+
+      def validate_meta!
+        fail(
+            ArgumentError.new,
+            ':meta parameter must me hash.'
+        ) if !@meta.nil? && @meta.class != Hash
+      end
     end
   end
 end

data/lib/pubnub/version.rb

@@ -1,4 +1,4 @@
 # Toplevel Pubnub module.
 module Pubnub
-  VERSION = '3.8.2'
+  VERSION = '3.8.4'
 end

data/pubnub.gemspec

@@ -13,7 +13,7 @@ Gem::Specification.new do |spec|
   spec.homepage        = 'http://github.com/pubnub/ruby'
   spec.license         = 'MIT'
 
-  spec.post_install_message = %Q(-----\nUPGRADE NOTICE: Pubnub 3.8.0 and higher versions are using Celluloid instead of EventMachine for asynchronous processing.\n-----)
+  spec.post_install_message = %(-----\nUPGRADE NOTICE: Pubnub 3.8.0 and higher versions are using Celluloid instead of EventMachine for asynchronous processing.\n-----)
 
   spec.files           = `git ls-files -z`.split("\x0")
   spec.executables     = spec.files.grep(%r{^bin\/}) { |f| File.basename(f) }

data/spec/integration/history_spec.rb

@@ -298,4 +298,24 @@ describe Pubnub::History do
       end
     end
   end
+
+  context 'specific for include_token' do
+    it 'works fine with include_token' do
+      VCR.use_cassette('integration/history/include_token', :record => :once) do
+        enve = @pn.history(http_sync: true, channel: 'bot', count: 4, callback: @callback, include_token: true)
+
+        enve[0].message.should eq '******......... 3491 - 2016-04-13 03:50:06'
+        enve[0].timetoken.should eq 14605446066210865
+
+        enve[1].message.should eq '*******........ 3492 - 2016-04-13 03:50:07'
+        enve[1].timetoken.should eq 14605446077902610
+
+        enve[2].message.should eq '********....... 3493 - 2016-04-13 03:50:08'
+        enve[2].timetoken.should eq 14605446089621213
+
+        enve[3].message.should eq '*********...... 3494 - 2016-04-13 03:50:10'
+        enve[3].timetoken.should eq 14605446101325777
+      end
+    end
+  end
 end

data/spec/integration/publish_spec.rb

@@ -1114,4 +1114,51 @@ describe Pubnub::Publish do
       end
     end
   end
+
+  context ':meta parameter' do
+    before(:each) do
+      @pubnub = Pubnub.new(
+          :max_retries => 0,
+          :subscribe_key => :demo,
+          :publish_key => :demo,
+          :auth_key => :demoish_authkey,
+          :secret_key => 'some_secret_key',
+          :error_callback => @error_callback
+
+      )
+
+      @pubnub.uuid = 'tester'
+    end
+
+    it 'works fine' do
+      VCR.use_cassette('integration/publish/publish-meta', :record => :once) do
+
+        @pubnub.publish(
+            message: { text: 'sometext' },
+            channel: 'ruby_demo_channel',
+            callback: @callback,
+            http_sync: true,
+            meta: { region: :west }
+        )
+
+        @envelopes.size.should eq 1
+        # @envelopes.first.response_message.should eq 'Sent'
+        # @envelopes.first.status.should eq 200
+        # @envelopes.first.channel.should eq 'ruby_demo_channel'
+        # @envelopes.first.message.should eq({:text => 'sometext'})
+        # @envelopes.first.timetoken.should eq '13936818988607190'
+
+      end
+    end
+
+    it 'is validated' do
+      expect{ @pubnub.publish(
+          message: { text: 'sometext' },
+          channel: 'ruby_demo_channel',
+          callback: @callback,
+          http_sync: true,
+          meta: 123
+      ) }.to raise_error(Pubnub::ArgumentError)
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pubnub
 version: !ruby/object:Gem::Version
-  version: 3.8.2
+  version: 3.8.4
 platform: ruby
 authors:
 - PubNub
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-17 00:00:00.000000000 Z
+date: 2017-02-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: celluloid
@@ -362,6 +362,7 @@ files:
 - fixtures/vcr_cassettes/integration/history/history-ssl-parameter-valid-200-sync.yml
 - fixtures/vcr_cassettes/integration/history/history-ssl-parameter-valid-non-200-async.yml
 - fixtures/vcr_cassettes/integration/history/history-ssl-parameter-valid-non-200-sync.yml
+- fixtures/vcr_cassettes/integration/history/include_token.yml
 - fixtures/vcr_cassettes/integration/leave/leave-nonssl-block-invalid-200-async.yml
 - fixtures/vcr_cassettes/integration/leave/leave-nonssl-block-invalid-200-sync.yml
 - fixtures/vcr_cassettes/integration/leave/leave-nonssl-block-invalid-non-200-async.yml
@@ -492,6 +493,7 @@ files:
 - fixtures/vcr_cassettes/integration/publish/publish-https-auth_key-non200-valid.yml
 - fixtures/vcr_cassettes/integration/publish/publish-https-non200-invalid.yml
 - fixtures/vcr_cassettes/integration/publish/publish-https-non200-valid.yml
+- fixtures/vcr_cassettes/integration/publish/publish-meta.yml
 - fixtures/vcr_cassettes/integration/publish/publish-plain-array-of-hashes.yml
 - fixtures/vcr_cassettes/integration/revoke/revoke-application-level.yml
 - fixtures/vcr_cassettes/integration/revoke/revoke-nonssl-block-invalid-200-async.yml
@@ -1849,7 +1851,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: PubNub Official Ruby gem.