ably-rest 1.2.5 → 1.2.7

data/lib/submodules/ably-ruby/lib/ably/realtime/push.rb

@@ -20,33 +20,6 @@ module Ably
       def admin
         @admin ||= Admin.new(self)
       end
-
-      # Activates the device for push notifications with FCM or APNS, obtaining a unique identifier from them.
-      # Subsequently registers the device with Ably and stores the deviceIdentityToken in local storage.
-      #
-      # @spec RSH2a
-      #
-      # @note This is unsupported in the Ruby library
-      #
-      def activate(*arg)
-        raise_unsupported
-      end
-
-      # Deactivates the device from receiving push notifications with Ably and FCM or APNS.
-      #
-      # @spec RSH2b
-      #
-      # @note This is unsupported in the Ruby library
-      #
-      def deactivate(*arg)
-        raise_unsupported
-      end
-
-      private
-
-      def raise_unsupported
-        raise Ably::Exceptions::PushNotificationsNotSupported, 'This device does not support receiving or subscribing to push notifications. All PushChannel methods are unavailable'
-      end
     end
   end
 end

data/lib/submodules/ably-ruby/lib/ably/realtime/recovery_key_context.rb

@@ -0,0 +1,36 @@
+require 'json'
+# frozen_string_literal: true
+
+module Ably
+  module Realtime
+    class RecoveryKeyContext
+      attr_reader :connection_key
+      attr_reader :msg_serial
+      attr_reader :channel_serials
+
+      def initialize(connection_key, msg_serial, channel_serials)
+        @connection_key = connection_key
+        @msg_serial = msg_serial
+        @channel_serials = channel_serials
+        if @channel_serials.nil?
+          @channel_serials = {}
+        end
+      end
+
+      def to_json
+        { 'connection_key' => @connection_key, 'msg_serial' => @msg_serial, 'channel_serials' => @channel_serials }.to_json
+      end
+
+      def self.from_json(obj, logger = nil)
+        begin
+          data = JSON.load obj
+          self.new data['connection_key'], data['msg_serial'], data['channel_serials']
+        rescue => e
+          logger.warn "unable to decode recovery key, found error #{e}" unless logger.nil?
+          return nil
+        end
+      end
+
+    end
+  end
+end

data/lib/submodules/ably-ruby/lib/ably/rest/client.rb

@@ -16,6 +16,7 @@ module Ably
       include Ably::Modules::Conversions
       include Ably::Modules::HttpHelpers
       extend Forwardable
+      using Ably::Util::AblyExtensions
 
       # Default Ably domain for REST
       DOMAIN = 'rest.ably.io'
@@ -186,7 +187,7 @@ module Ably
 
         @agent               = options.delete(:agent) || Ably::AGENT
         @realtime_client     = options.delete(:realtime_client)
-        @tls                 = options.delete(:tls) == false ? false : true
+        @tls                 = options.delete_with_default(:tls, true)
         @environment         = options.delete(:environment) # nil is production
         @environment         = nil if [:production, 'production'].include?(@environment)
         @protocol            = options.delete(:protocol) || :msgpack
@@ -200,10 +201,7 @@ module Ably
         @log_retries_as_info = options.delete(:log_retries_as_info)
         @max_message_size    = options.delete(:max_message_size) || MAX_MESSAGE_SIZE
         @max_frame_size      = options.delete(:max_frame_size) || MAX_FRAME_SIZE
-
-        if (@idempotent_rest_publishing = options.delete(:idempotent_rest_publishing)).nil?
-          @idempotent_rest_publishing = Ably::PROTOCOL_VERSION.to_f > 1.1
-        end
+        @idempotent_rest_publishing = options.delete_with_default(:idempotent_rest_publishing, true)
 
         if options[:fallback_hosts_use_default] && options[:fallback_hosts]
           raise ArgumentError, "fallback_hosts_use_default cannot be set to try when fallback_hosts is also provided"
@@ -599,7 +597,7 @@ module Ably
             end
             unless options[:send_auth_header] == false
               request.headers[:authorization] = auth.auth_header
-
+              # RSA7e2
               options[:headers].to_h.merge(auth.extra_auth_headers).map do |key, val|
                 request.headers[key] = val
               end

data/lib/submodules/ably-ruby/lib/ably/rest/push/admin.rb

@@ -21,7 +21,7 @@ module Ably::Rest
 
       # Publish a push message directly to a single recipient
       #
-      # @param recipient [Hash] A recipient device, client_id or raw APNS/GCM target. Refer to push documentation
+      # @param recipient [Hash] A recipient device, client_id or raw APNS/FCM/web target. Refer to push documentation
       # @param data      [Hash] The notification payload data and fields. Refer to push documentation
       #
       # @return [void]

data/lib/submodules/ably-ruby/lib/ably/rest/push.rb

@@ -20,25 +20,6 @@ module Ably
       def admin
         @admin ||= Admin.new(self)
       end
-
-      # Activate this device for push notifications by registering with the push transport such as GCM/APNS
-      #
-      # @note This is unsupported in the Ruby library
-      def activate(*arg)
-        raise_unsupported
-      end
-
-      # Deactivate this device for push notifications by removing the registration with the push transport such as GCM/APNS
-      #
-      # @note This is unsupported in the Ruby library
-      def deactivate(*arg)
-        raise_unsupported
-      end
-
-      private
-      def raise_unsupported
-        raise Ably::Exceptions::PushNotificationsNotSupported, 'This device does not support receiving or subscribing to push notifications. All PushChannel methods are unavailable'
-      end
     end
   end
 end

data/lib/submodules/ably-ruby/lib/ably/util/ably_extensions.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Ably::Util
+  module AblyExtensions
+    refine Object do
+      def nil_or_empty?
+        self.nil? || self.empty?
+      end
+    end
+
+    refine Hash do
+      def fetch_with_default(key, default)
+        value = self.fetch(key, default)
+        if value.nil?
+          return default
+        end
+        return value
+      end
+
+      def delete_with_default(key, default)
+        value = self.delete(key)
+        if value.nil?
+          return default
+        end
+        return value
+      end
+    end
+  end
+end

data/lib/submodules/ably-ruby/lib/ably/util/crypto.rb

@@ -83,8 +83,8 @@ module Ably::Util
       cipher.key = key
       iv = encrypt_options[:iv] || fixed_iv || cipher.random_iv
       cipher.iv = iv
-
-      iv << cipher.update(payload) << cipher.final
+      iv << cipher.update(payload) unless payload.empty?
+      iv << cipher.final
     end
 
     # Decrypt payload using configured Cipher

data/lib/submodules/ably-ruby/lib/ably/util/safe_deferrable.rb

@@ -1,6 +1,6 @@
 module Ably::Util
   # SafeDeferrable class provides a Deferrable that is safe to use for for public interfaces
-  # of this client library.  Any exceptions raised in the success or failure callbacks are
+  # of this client library. Any exceptions raised in the success or failure callbacks are
   # caught and logged to the provided logger.
   #
   # An exception in a callback provided by a developer should not break this client library

data/lib/submodules/ably-ruby/lib/ably/version.rb

@@ -1,9 +1,7 @@
 module Ably
-  VERSION = '1.2.5'
-  PROTOCOL_VERSION = '1.2'
-
-  # @api private
-  def self.major_minor_version_numeric
-    VERSION.gsub(/\.\d+$/, '').to_f
-  end
+  VERSION = '1.2.7'
+  # The level of compatibility with the Ably service that this SDK supports.
+  # Also referred to as the 'wire protocol version'.
+  # spec : CSV2
+  PROTOCOL_VERSION = '2'
 end

data/lib/submodules/ably-ruby/spec/acceptance/realtime/auth_spec.rb

@@ -617,7 +617,6 @@ describe Ably::Realtime::Auth, :event_machine do
                   deferrable.errback do |error|
                     EventMachine.add_timer(0.2) do
                       expect(connection_failed).to eql(true)
-                      expect(error.message).to match(/invalid.*accessToken/i)
                       expect(error.code).to eql(40005)
                       stop_reactor
                     end
@@ -627,7 +626,6 @@ describe Ably::Realtime::Auth, :event_machine do
               end
 
               client.connection.once(:failed) do
-                expect(client.connection.error_reason.message).to match(/invalid.*accessToken/i)
                 expect(client.connection.error_reason.code).to eql(40005)
                 connection_failed = true
               end
@@ -664,7 +662,6 @@ describe Ably::Realtime::Auth, :event_machine do
                 channel.attach do
                   channel.publish('not-allowed').errback do |error|
                     expect(error.code).to eql(40160)
-                    expect(error.message).to match(/permission denied/)
 
                     client.auth.authorize(nil, auth_callback: upgraded_token_cb)
                     client.connection.once(:update) do
@@ -1058,7 +1055,6 @@ describe Ably::Realtime::Auth, :event_machine do
 
           it 'disconnected includes and invalid signature message' do
             client.connection.once(:disconnected) do |state_change|
-              expect(state_change.reason.message.match(/signature verification failed/i)).to_not be_nil
               expect(state_change.reason.code).to eql(40144)
               stop_reactor
             end
@@ -1111,7 +1107,6 @@ describe Ably::Realtime::Auth, :event_machine do
 
           it 'authentication fails and reason for disconnection is invalid signature' do
             client.connection.once(:disconnected) do |state_change|
-              expect(state_change.reason.message.match(/signature verification failed/i)).to_not be_nil
               expect(state_change.reason.code).to eql(40144)
               stop_reactor
             end
@@ -1143,7 +1138,6 @@ describe Ably::Realtime::Auth, :event_machine do
 
           it 'fails with an invalid signature error' do
             client.connection.once(:disconnected) do |state_change|
-              expect(state_change.reason.message.match(/signature verification failed/i)).to_not be_nil
               expect(state_change.reason.code).to eql(40144)
               stop_reactor
             end
@@ -1248,7 +1242,6 @@ describe Ably::Realtime::Auth, :event_machine do
             allowed_channel = client.channels.get(channel_with_publish_permissions)
             forbidden_channel.publish('not-allowed').errback do |error|
               expect(error.code).to eql(40160)
-              expect(error.message).to match(/permission denied/)
 
               allowed_channel.publish(message_name) do |message|
                 expect(message.name).to eql(message_name)

data/lib/submodules/ably-ruby/spec/acceptance/realtime/channel_history_spec.rb

@@ -184,26 +184,22 @@ describe Ably::Realtime::Channel, '#history', :event_machine do
       end
 
       context 'when channel receives update event after an attachment' do
+        old_attach_serial = ""
+        new_attach_serial = "xxxx-xxxx-1"
         before do
           channel.on(:attached) do
-            channel.publish(event, message_after_attach) do
-              subsequent_serial = channel.properties.attach_serial.dup.tap { |serial| serial[-1] = '1' }
-              attached_message = Ably::Models::ProtocolMessage.new(action: 11, channel: channel_name, flags: 0, channel_serial: subsequent_serial)
-              client.connection.__incoming_protocol_msgbus__.publish :protocol_message, attached_message
-            end
+            old_attach_serial = channel.properties.attach_serial
+            attached_message = Ably::Models::ProtocolMessage.new(action: 11, channel: channel_name, flags: 0, channel_serial: new_attach_serial)
+            client.connection.__incoming_protocol_msgbus__.publish :protocol_message, attached_message
           end
         end
 
         it 'updates attach_serial' do
-          rest_channel.publish event, message_before_attach
-
           channel.on(:update) do
-            channel.history(until_attach: true) do |messages|
-              expect(messages.items.count).to eql(2)
-              stop_reactor
-            end
+            expect(channel.properties.attach_serial).not_to eq(old_attach_serial)
+            expect(channel.properties.attach_serial).to eq(new_attach_serial)
+            stop_reactor
           end
-
           channel.attach
         end
       end