pubnub 4.0.13 → 4.0.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e27a1a3cc3c23fe086fb814563abc56137e1001a
-  data.tar.gz: 66617aa9639958a65f77de23e82ecf63fe17091d
+  metadata.gz: 20a17fcca83f683fa37ed4f336f5c4294fda9c22
+  data.tar.gz: 9728fff99ed82ce3d4e5fadd2d1cea9c8684b11e
 SHA512:
-  metadata.gz: cc76fddc1207e98179dcf1d807e720b0a5c9f328686300e8abd25a77ba8a3321b870923bf3a833436e8e46d8846e0aa91238640018a5511942e9d177c59fbb10
-  data.tar.gz: 3f7ac473c136515b891a084e9f6b6212d94f47ae77f4aa8321edb5223a2448c97b417dbcb32f6ce242f20e4c6f7cf98ac78b1fd071863db04329bd52ebe7624c
+  metadata.gz: 276b78f63c539defe5b321ad6e34d487f2319dc12e721a358749a9a848b1c0cbd09c149dad22acd349212d058dfe522f758aeb721442e89d1b7b6b5e1a8781e9
+  data.tar.gz: c7065361f9312f1fd3c1f323a5ee5fafe1733f249ae098e214d70b077cd0c080b018bd28da3f71828229574cba196454392bcfcefc3a043b6cf1030cf4144ed3

data/.pubnub.yml

@@ -1,12 +1,19 @@
 ---
 changelog:
+  -
+    changes:
+      -
+        text: "Added ttl parameter for publish"
+        type: improvement
+    date: ~
+    version: v4.0.14
   -
     changes:
       -
         text: "Changed init message log level to debug"
         type: improvement
     date: ~
-    version: v4.0.12
+    version: v4.0.13
   -
     changes:
       -
@@ -144,6 +151,7 @@ features:
     - PUBLISH-POST
     - PUBLISH-SYNC
     - PUBLISH-ASYNC
+    - PUBLISH-MESSAGE-TTL
   storage:
     - STORAGE-REVERSE
     - STORAGE-INCLUDE-TIMETOKEN
@@ -164,4 +172,4 @@ features:
 name: ruby
 schema: 1
 scm: github.com/pubnub/ruby
-version: "4.0.13"
+version: "4.0.14"

data/.travis.yml

@@ -16,7 +16,7 @@ matrix:
     - rvm: 2.3.1
     - rvm: 2.2.5
     - rvm: 2.1.9
-    - rvm: jruby-9.1.5.0
-      env: JRUBY_OPTS="--server -J-Xms1500m -J-Xmx1500m -J-XX:+UseConcMarkSweepGC -J-XX:-UseGCOverheadLimit -J-XX:+CMSClassUnloadingEnabled"
-      jdk: oraclejdk7
+#    - rvm: jruby-9.1.5.0
+#      env: JRUBY_OPTS="--server -J-Xms1500m -J-Xmx1500m -J-XX:+UseConcMarkSweepGC -J-XX:-UseGCOverheadLimit -J-XX:+CMSClassUnloadingEnabled"
+#      jdk: oraclejdk7
 

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+##### 4.0.14
+* Added ttl parameter for publish
+
 ##### 4.0.13
 * Changed init message log level to debug
 

data/UPGRADE_GUIDE.md

@@ -0,0 +1,51 @@
+### Upgrade Guide 3.8.x to 4.0.x
+
+##### Envelope result
+
+Pubnub Ruby SDK `4.x` version uses new `Envelope` object for response. You can find here how it is structured:
+
+```ruby
+envelope.id            # unique envelope ID for internal usage
+envelope.event         # event key (:publish, :time, :grant etc.)
+envelope.event_options # options given to the event when it was fired
+envelope.status        # status response Hash
+envelope.result        # result response Hash
+envelope.timetoken     # timetoken
+```
+
+Status and result structures for specific events can be found in our [docs](https://www.pubnub.com/docs/ruby/api-reference-sdk-v4).
+
+##### Subscribe changes
+
+Subscribe callbacks has been completly reworked and now uses listeners (`SubscribeCalback`).
+
+For example, let's upgrade old code:
+```
+# Old code
+pubnub.subscribe(channel: :demo){ |envelope| puts "MSG: #{envelope}" }
+pubnub.presence(channel: :demo){ |envelope| puts "PRESENCE #{envelope}" }
+
+# New code
+
+# We're creating listener here
+callbacks = Pubnub::SubscribeCallback.new(
+    # Fired for messages
+    message: ->(envelope) { 
+        puts "MSG: #{envelope.result}" if envelope.result[:data][:message_meta_data]['uuid'] != pubnub.uuid
+    },
+    # Fired for presence events
+    presence: ->(envelope) { 
+        puts "PRESENCE #{envelope.result}"
+    },
+    # Fired for status events (like `connected`)
+    status: ->(envelope) { 
+        puts "STATUS #{envelope.status}"
+    }
+)
+
+# Here it's added to listeners
+pubnub.add_listener(callback: callbacks)
+
+# Finally we're firing subscribe
+pubnub.subscribe(channel: :demo, presence: :demo)
+```

data/VERSION

@@ -1 +1 @@
-4.0.13
+4.0.14

data/fixtures/vcr_cassettes/examples/publish-ttl-works-ignore.yml

@@ -0,0 +1,40 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://pubsub.pubnub.com/publish/pub-c-b42cec2f-f468-4784-8833-dd2b074538c4/sub-c-b7fb805a-1777-11e6-be83-0619f8945a4f/0/demo/0/%22whatever%22?auth=ruby-test-auth-client-one&ortt=%7B%22t%22:14782579046347514%7D&pnsdk=PubNub-Ruby/4.0.13&seqn=1&store=0&uuid=ruby-test-uuid-client-one
+    body:
+      encoding: UTF-8
+      string: ''
+    headers:
+      User-Agent:
+      - HTTPClient/1.0 (2.8.2.4, ruby 2.3.1 (2016-04-26))
+      Accept:
+      - "*/*"
+      Date:
+      - Fri, 04 Nov 2016 11:11:44 GMT
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Fri, 04 Nov 2016 11:11:44 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","14782579047413313"]'
+    http_version: 
+  recorded_at: Fri, 04 Nov 2016 11:11:44 GMT
+recorded_with: VCR 3.0.1

data/fixtures/vcr_cassettes/examples/publish-ttl-works.yml

@@ -0,0 +1,40 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://pubsub.pubnub.com/publish/pub-c-b42cec2f-f468-4784-8833-dd2b074538c4/sub-c-b7fb805a-1777-11e6-be83-0619f8945a4f/0/demo/0/%22whatever%22?auth=ruby-test-auth-client-one&ortt=%7B%22t%22:14782579044932096%7D&pnsdk=PubNub-Ruby/4.0.13&seqn=1&ttl=10&uuid=ruby-test-uuid-client-one
+    body:
+      encoding: UTF-8
+      string: ''
+    headers:
+      User-Agent:
+      - HTTPClient/1.0 (2.8.2.4, ruby 2.3.1 (2016-04-26))
+      Accept:
+      - "*/*"
+      Date:
+      - Fri, 04 Nov 2016 11:11:44 GMT
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Fri, 04 Nov 2016 11:11:44 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","14782579046000962"]'
+    http_version: 
+  recorded_at: Fri, 04 Nov 2016 11:11:44 GMT
+recorded_with: VCR 3.0.1

data/lib/pubnub/events/publish.rb

@@ -10,15 +10,16 @@ module Pubnub
     def initialize(options, app)
       @event = :publish
       super
-      @sequence_number        = sequence_number!
+      @sequence_number = sequence_number!
       @origination_time_token = @app.generate_ortt
 
-      @store = case @store
-               when false
-                 0
-               when true
-                 1
-               end
+      case @store
+        when false
+          @store = 0
+          @ttl = nil
+        when true
+          @store = 1
+      end
     end
 
     def fire
@@ -48,30 +49,31 @@ module Pubnub
       params = super
 
       empty_if_blank = {
-        store: @store,
-        meta: @meta
+          store: @store,
+          meta: @meta,
+          ttl: @ttl
       }
 
-      replication = @replicate == false ? { norep: true } : {}
+      replication = @replicate == false ? {norep: true} : {}
 
       empty_if_blank.delete_if { |_k, v| v.blank? }
 
       params = params.merge(empty_if_blank)
       params = params.merge(replication)
       params = params.merge(seqn: @sequence_number,
-                            ortt: { t: @origination_time_token })
+                            ortt: {t: @origination_time_token})
       params
     end
 
     def path
       rpath = [
-        'publish',
-        @publish_key,
-        @subscribe_key,
-        '0',
-        @channel,
-        '0',
-        Formatter.format_message(@message, @cipher_key)
+          'publish',
+          @publish_key,
+          @subscribe_key,
+          '0',
+          @channel,
+          '0',
+          Formatter.format_message(@message, @cipher_key)
       ]
 
       rpath.pop if @compressed
@@ -97,26 +99,26 @@ module Pubnub
 
     def valid_envelope(_parsed_response, req_res_objects)
       Pubnub::Envelope.new(
-        event: @event,
-        event_options: @given_options,
-        timetoken: nil,
-        status: {
-          code: req_res_objects[:response].code,
-          operation: Pubnub::Constants::OPERATION_PUBLISH,
-          client_request: req_res_objects[:request],
-          server_response: req_res_objects[:response],
-          data: nil,
-          category: Pubnub::Constants::STATUS_ACK,
-          error: false,
-          auto_retried: false,
-
-          current_timetoken: nil,
-          last_timetoken: nil,
-          subscribed_channels: nil,
-          subscribed_channel_groups: nil,
-
-          config: get_config
-        }
+          event: @event,
+          event_options: @given_options,
+          timetoken: nil,
+          status: {
+              code: req_res_objects[:response].code,
+              operation: Pubnub::Constants::OPERATION_PUBLISH,
+              client_request: req_res_objects[:request],
+              server_response: req_res_objects[:response],
+              data: nil,
+              category: Pubnub::Constants::STATUS_ACK,
+              error: false,
+              auto_retried: false,
+
+              current_timetoken: nil,
+              last_timetoken: nil,
+              subscribed_channels: nil,
+              subscribed_channel_groups: nil,
+
+              config: get_config
+          }
       )
     end
   end

data/lib/pubnub/version.rb

@@ -1,4 +1,4 @@
 # Toplevel Pubnub module.
 module Pubnub
-  VERSION = '4.0.13'
+  VERSION = '4.0.14'
 end

data/spec/examples/publish_with_ttl_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+describe Pubnub::Publish do
+  around :each do |example|
+    @pubnub = Pubnub::Client.new(
+        publish_key: 'pub-c-b42cec2f-f468-4784-8833-dd2b074538c4',
+        subscribe_key: 'sub-c-b7fb805a-1777-11e6-be83-0619f8945a4f',
+        uuid: 'ruby-test-uuid-client-one',
+        auth_key: 'ruby-test-auth-client-one'
+    )
+
+    Celluloid.boot
+    example.run
+    Celluloid.shutdown
+  end
+
+  context 'with specified ttl parameter' do
+    it 'adds it to url' do
+      VCR.use_cassette('examples/publish-ttl-works', record: :once) do
+        envelope = @pubnub.publish(channel: :demo, message: :whatever, ttl: 10, http_sync: true)
+
+        expect(envelope.is_a?(Pubnub::Envelope)).to eq true
+        expect(envelope.status).to satisfies_schema Pubnub::Schemas::Envelope::StatusSchema
+      end
+    end
+
+    it 'ignores it when store is false' do
+      VCR.use_cassette('examples/publish-ttl-works-ignore', record: :once) do
+        envelope = @pubnub.publish(channel: :demo, message: :whatever, ttl: 10, store: false, http_sync: true)
+
+        expect(envelope.is_a?(Pubnub::Envelope)).to eq true
+        expect(envelope.status).to satisfies_schema Pubnub::Schemas::Envelope::StatusSchema
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pubnub
 version: !ruby/object:Gem::Version
-  version: 4.0.13
+  version: 4.0.14
 platform: ruby
 authors:
 - PubNub
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-02 00:00:00.000000000 Z
+date: 2016-11-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: celluloid
@@ -105,6 +105,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- UPGRADE_GUIDE.md
 - VERSION
 - docs.md
 - fixtures/vcr_cassettes/client/connection_callbacks_0.yml
@@ -3836,6 +3837,8 @@ files:
 - fixtures/vcr_cassettes/examples/presence/7.yml
 - fixtures/vcr_cassettes/examples/presence/8.yml
 - fixtures/vcr_cassettes/examples/presence/9.yml
+- fixtures/vcr_cassettes/examples/publish-ttl-works-ignore.yml
+- fixtures/vcr_cassettes/examples/publish-ttl-works.yml
 - fixtures/vcr_cassettes/examples/publish/00137969798b5dd71da12968bfd6ebdd311021fd1e29f19921a4aff3111670bc.yml
 - fixtures/vcr_cassettes/examples/publish/001707bf2681b5de81316e8cae525f4fd3156c405b35f880c38d01fa037b8960.yml
 - fixtures/vcr_cassettes/examples/publish/001d69e899ba9eb547a4c21d5aaa61299a3a58bc37aa289bd657f2c8a83fa0ee.yml
@@ -10552,6 +10555,7 @@ files:
 - spec/examples/leave_examples_spec.rb
 - spec/examples/presence_examples_spec.rb
 - spec/examples/publish_examples_spec.rb
+- spec/examples/publish_with_ttl_spec.rb
 - spec/examples/revoke_examples_spec.rb
 - spec/examples/set_state_examples_spec.rb
 - spec/examples/state_examples_spec.rb
@@ -10620,6 +10624,7 @@ test_files:
 - spec/examples/leave_examples_spec.rb
 - spec/examples/presence_examples_spec.rb
 - spec/examples/publish_examples_spec.rb
+- spec/examples/publish_with_ttl_spec.rb
 - spec/examples/revoke_examples_spec.rb
 - spec/examples/set_state_examples_spec.rb
 - spec/examples/state_examples_spec.rb