ably 1.1.6 → 1.2.0

data/lib/ably/rest/channel.rb

@@ -28,21 +28,20 @@ module Ably
       #
       # @param client [Ably::Rest::Client]
       # @param name [String] The name of the channel
-      # @param channel_options [Hash] Channel options, currently reserved for Encryption options
-      # @option channel_options [Hash,Ably::Models::CipherParams]   :cipher   A hash of options or a {Ably::Models::CipherParams} to configure the encryption. *:key* is required, all other options are optional.  See {Ably::Util::Crypto#initialize} for a list of +:cipher+ options
+      # @param channel_options [Hash, Ably::Models::ChannelOptions]     A hash of options or a {Ably::Models::ChannelOptions}
       #
       def initialize(client, name, channel_options = {})
         name = (ensure_utf_8 :name, name)
 
-        update_options channel_options
+        @options = Ably::Models::ChannelOptions(channel_options)
         @client  = client
         @name    = name
         @push    = PushChannel.new(self)
       end
 
-      # Publish one or more messages to the channel. Three overloaded forms
+      # Publish one or more messages to the channel. Five overloaded forms
       # @param name [String, Array<Ably::Models::Message|Hash>, Ably::Models::Message, nil]   The event name of the message to publish, or an Array of [Ably::Model::Message] objects or [Hash] objects with +:name+ and +:data+ pairs, or a single Ably::Model::Message object
-      # @param data [String, ByteArray, Hash, nil]   The message payload unless an Array of [Ably::Model::Message] objects passed in the first argument, in which case an optional hash of query parameters
+      # @param data [String, Array, Hash, nil]   The message payload unless an Array of [Ably::Model::Message] objects passed in the first argument, in which case an optional hash of query parameters
       # @param attributes [Hash, nil]   Optional additional message attributes such as :extras, :id, :client_id or :connection_id, applied when name attribute is nil or a string (Deprecated, will be removed in 2.0 in favour of constructing a Message object)
       # @return [Boolean]  true if the message was published, otherwise false
       #
@@ -50,42 +49,39 @@ module Ably
       #   # Publish a single message with (name, data) form
       #   channel.publish 'click', { x: 1, y: 2 }
       #
-      #   # Publish an array of message Hashes
+      #   # Publish a single message with single Hash form
+      #   message = { name: 'click', data: { x: 1, y: 2 } }
+      #   channel.publish message
+      #
+      #   # Publish an array of message Hashes form
       #   messages = [
       #     { name: 'click', data: { x: 1, y: 2 } },
       #     { name: 'click', data: { x: 2, y: 3 } }
       #   ]
       #   channel.publish messages
       #
-      #   # Publish an array of Ably::Models::Message objects
+      #   # Publish an array of Ably::Models::Message objects form
       #   messages = [
-      #     Ably::Models::Message(name: 'click', { x: 1, y: 2 })
-      #     Ably::Models::Message(name: 'click', { x: 2, y: 3 })
+      #     Ably::Models::Message(name: 'click', data: { x: 1, y: 2 })
+      #     Ably::Models::Message(name: 'click', data: { x: 2, y: 3 })
       #   ]
       #   channel.publish messages
       #
-      #   # Publish a single Ably::Models::Message object, with a query params
-      #   # specifying quickAck: true
-      #   message = Ably::Models::Message(name: 'click', { x: 1, y: 2 })
-      #   channel.publish message, quickAck: 'true'
+      #   # Publish a single Ably::Models::Message object form
+      #   message = Ably::Models::Message(name: 'click', data: { x: 1, y: 2 })
+      #   channel.publish message
       #
-      def publish(first, second = nil, third = {})
-        messages, qs_params = if first.kind_of?(Enumerable)
-          # ([Message], qs_params) form
-          [first, second]
-        elsif first.kind_of?(Ably::Models::Message)
-          # (Message, qs_params) form
-          [[first], second]
-        else
-          # (name, data, attributes) form
-          first = ensure_utf_8(:name, first, allow_nil: true)
-          ensure_supported_payload second
-          # RSL1h - attributes as an extra method parameter is extra-spec but need to
-          # keep it for backcompat until version 2
-          [[{ name: first, data: second }.merge(third)], nil]
+      def publish(name, data = nil, attributes = {})
+        qs_params = nil
+        qs_params = data if name.kind_of?(Enumerable) || name.kind_of?(Ably::Models::Message)
+
+        messages = build_messages(name, data, attributes) # (RSL1a, RSL1b)
+
+        if messages.sum(&:size) > (max_message_size = client.max_message_size || Ably::Rest::Client::MAX_MESSAGE_SIZE)
+          raise Ably::Exceptions::MaxMessageSizeExceeded.new("Maximum message size exceeded #{max_message_size} bytes.")
         end
 
-        payload = messages.each_with_index.map do |message, index|
+        payload = messages.map do |message|
           Ably::Models::Message(message.dup).tap do |msg|
             msg.encode client.encoders, options
 
@@ -157,12 +153,16 @@ module Ably
         @presence ||= Presence.new(client, self)
       end
 
-      # @api private
-      def update_options(channel_options)
-        @options = channel_options.clone.freeze
+      # Sets or updates the stored channel options. (#RSL7)
+      # @param channel_options [Hash, Ably::Models::ChannelOptions]  A hash of options or a {Ably::Models::ChannelOptions}
+      # @return [Ably::Models::ChannelOptions]
+      def set_options(channel_options)
+        @options = Ably::Models::ChannelOptions(channel_options)
       end
+      alias options= set_options
 
       private
+
       def base_path
         "/channels/#{URI.encode_www_form_component(name)}"
       end

data/lib/ably/rest/client.rb

@@ -25,6 +25,9 @@ module Ably
       # Default Ably domain for REST
       DOMAIN = 'rest.ably.io'
 
+      MAX_MESSAGE_SIZE = 65536 # See spec TO3l8
+      MAX_FRAME_SIZE = 524288 # See spec TO3l8
+
       # Configuration for HTTP timeouts and HTTP request reattempts to fallback hosts
       HTTP_DEFAULTS = {
         open_timeout:       4,
@@ -52,6 +55,10 @@ module Ably
       # @return [Symbol]
       attr_reader :protocol
 
+      # Client agent i.e. `example-gem/1.2.0 ably-ruby/1.1.5 ruby/1.9.3`
+      # @return [String]
+      attr_reader :agent
+
       # {Ably::Auth} authentication object configured for this connection
       # @return [Ably::Auth]
       attr_reader :auth
@@ -112,6 +119,14 @@ module Ably
       # @return [Boolean]
       attr_reader :idempotent_rest_publishing
 
+      # Max message size (TO2, TO3l8) by default (65536 bytes) 64KiB
+      # @return [Integer]
+      attr_reader :max_message_size
+
+      # Max frame size (TO2, TO3l8) by default (524288 bytes) 512KiB
+      # @return [Integer]
+      attr_reader :max_frame_size
+
       # Creates a {Ably::Rest::Client Rest Client} and configures the {Ably::Auth} object for the connection.
       #
       # @param [Hash,String] options an options Hash used to configure the client and the authentication, or String with an API key or Token ID
@@ -146,6 +161,8 @@ module Ably
       #
       # @option options [Boolean]                 :add_request_ids             (false) When true, adds a unique request_id to each request sent to Ably servers. This is handy when reporting issues, because you can refer to a specific request.
       # @option options [Boolean]                 :idempotent_rest_publishing  (false if ver < 1.2) When true, idempotent publishing is enabled for all messages published via REST
+      # @option options [Integer]                 :max_message_size            (65536 bytes) Maximum size of all messages when publishing via REST publish()
+      # @option options [Integer]                 :max_frame_size              (524288 bytes) Maximum size of frame
       #
       # @return [Ably::Rest::Client]
       #
@@ -168,6 +185,7 @@ module Ably
           end
         end
 
+        @agent               = options.delete(:agent) || Ably::AGENT
         @realtime_client     = options.delete(:realtime_client)
         @tls                 = options.delete(:tls) == false ? false : true
         @environment         = options.delete(:environment) # nil is production
@@ -181,8 +199,12 @@ module Ably
         @custom_tls_port     = options.delete(:tls_port)
         @add_request_ids     = options.delete(:add_request_ids)
         @log_retries_as_info = options.delete(:log_retries_as_info)
-        @idempotent_rest_publishing = options.delete(:idempotent_rest_publishing) || Ably.major_minor_version_numeric > 1.1
+        @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
 
         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"
@@ -358,6 +380,9 @@ module Ably
             send_request(method, path, params, headers: headers)
           end
         when :post, :patch, :put
+          if body.to_json.bytesize > max_frame_size
+            raise Ably::Exceptions::MaxFrameSizeExceeded.new("Maximum frame size exceeded #{max_frame_size} bytes.")
+          end
           path_with_params = Addressable::URI.new
           path_with_params.query_values = params || {}
           query = path_with_params.query
@@ -473,16 +498,6 @@ module Ably
         end
       end
 
-      # Library Ably version user agent
-      # @api private
-      def lib_version_id
-        @lib_version_id ||= [
-          'ruby',
-          Ably.lib_variant,
-          Ably::VERSION
-        ].compact.join('-')
-      end
-
       # Allowable duration for an external auth request
       # For REST client this defaults to request_timeout
       # For Realtime clients this defaults to 250ms less than the realtime_request_timeout
@@ -663,7 +678,7 @@ module Ably
             accept:             mime_type,
             user_agent:         user_agent,
             'X-Ably-Version' => Ably::PROTOCOL_VERSION,
-            'X-Ably-Lib'     => lib_version_id
+            'Ably-Agent'     => agent
           },
           request: {
             open_timeout: http_defaults.fetch(:open_timeout),

data/lib/ably/util/crypto.rb

@@ -30,7 +30,7 @@ module Ably::Util
     #    crypto.decrypt(decrypted) # => 'secret text'
     #
     def initialize(params)
-      @fixed_iv = params.delete(:fixed_iv) if params.kind_of?(Hash)
+      @fixed_iv = params[:fixed_iv]
       @cipher_params = Ably::Models::CipherParams(params)
     end
 

data/lib/ably/version.rb

@@ -1,18 +1,6 @@
 module Ably
-  VERSION = '1.1.6'
-  PROTOCOL_VERSION = '1.1'
-
-  # Allow a variant to be configured for all instances of this client library
-  # such as ruby-rest-[VERSION]
-
-  # @api private
-  def self.lib_variant=(variant)
-    @lib_variant = variant
-  end
-
-  def self.lib_variant
-    @lib_variant
-  end
+  VERSION = '1.2.0'
+  PROTOCOL_VERSION = '1.2'
 
   # @api private
   def self.major_minor_version_numeric

data/lib/ably.rb

@@ -1,6 +1,7 @@
 require 'addressable/uri'
 
 require 'ably/version'
+require 'ably/agent'
 
 %w(modules util).each do |namespace|
   Dir.glob(File.expand_path("ably/#{namespace}/*.rb", File.dirname(__FILE__))).sort.each do |file|

data/spec/acceptance/realtime/auth_spec.rb

@@ -1237,7 +1237,7 @@ describe Ably::Realtime::Auth, :event_machine do
         let(:basic_capability) { JSON.dump(channel_name => ['subscribe'], channel_with_publish_permissions => ['publish']) }
         let(:auth_callback) do
           lambda do |token_params|
-            Faraday.get("#{auth_url}?keyName=#{key_name}&keySecret=#{key_secret}&capability=#{URI.escape(basic_capability)}").body
+            Faraday.get("#{auth_url}?keyName=#{key_name}&keySecret=#{key_secret}&capability=#{URI::Parser.new.escape(basic_capability)}").body
           end
         end
         let(:client_options) { default_options.merge(auth_callback: auth_callback, log_level: :error) }

data/spec/acceptance/realtime/channel_history_spec.rb

@@ -183,6 +183,31 @@ describe Ably::Realtime::Channel, '#history', :event_machine do
         end
       end
 
+      context 'when channel receives update event after an attachment' do
+        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
+          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
+          end
+
+          channel.attach
+        end
+      end
+
       context 'and two pages of messages' do
         it 'retrieves two pages of messages before channel was attached' do
           10.times { rest_channel.publish event, message_before_attach }