ably 1.1.7 → 1.2.1

data/lib/ably/rest/channel.rb

@@ -23,27 +23,25 @@ module Ably
       attr_reader :push
 
       IDEMPOTENT_LIBRARY_GENERATED_ID_LENGTH = 9 # See spec RSL1k1
-      MAX_MESSAGE_SIZE = 65536 # See spec TO3l8
 
       # Initialize a new Channel object
       #
       # @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
       #
@@ -51,45 +49,36 @@ 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]
-        end
+      def publish(name, data = nil, attributes = {})
+        qs_params = nil
+        qs_params = data if name.kind_of?(Enumerable) || name.kind_of?(Ably::Models::Message)
 
-        messages.map! { |message| Ably::Models::Message(message.dup) }
+        messages = build_messages(name, data, attributes) # (RSL1a, RSL1b)
 
-        if messages.sum(&:size) > Ably::Rest::Channel::MAX_MESSAGE_SIZE
-          raise Ably::Exceptions::MaxMessageSizeExceeded.new("Maximum message size exceeded #{Ably::Rest::Channel::MAX_MESSAGE_SIZE}.")
+        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.map do |message|
@@ -164,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

@@ -4,7 +4,7 @@ require 'logger'
 require 'uri'
 
 require 'typhoeus'
-require 'typhoeus/adapters/faraday'
+require 'faraday/typhoeus'
 
 require 'ably/rest/middleware/exceptions'
 
@@ -25,7 +25,8 @@ module Ably
       # Default Ably domain for REST
       DOMAIN = 'rest.ably.io'
 
-      MAX_FRAME_SIZE = 524288
+      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 = {
@@ -54,7 +55,7 @@ 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`
+      # Client agent i.e. `example-gem/1.2.0 ably-ruby/1.1.5 ruby/3.1.1`
       # @return [String]
       attr_reader :agent
 
@@ -118,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
@@ -130,7 +139,7 @@ module Ably
       # @option options [Symbol]                  :protocol            (:msgpack) Protocol used to communicate with Ably, :json and :msgpack currently supported
       # @option options [Boolean]                 :use_binary_protocol (true) When true will use the MessagePack binary protocol, when false it will use JSON encoding. This option will overide :protocol option
       # @option options [Logger::Severity,Symbol] :log_level           (Logger::WARN) Log level for the standard Logger that outputs to STDOUT. Can be set to :fatal (Logger::FATAL), :error (Logger::ERROR), :warn (Logger::WARN), :info (Logger::INFO), :debug (Logger::DEBUG) or :none
-      # @option options [Logger]                  :logger              A custom logger can be used however it must adhere to the Ruby Logger interface, see http://www.ruby-doc.org/stdlib-1.9.3/libdoc/logger/rdoc/Logger.html
+      # @option options [Logger]                  :logger              A custom logger can be used however it must adhere to the Ruby Logger interface, see http://www.ruby-doc.org/stdlib-3.1.1/libdoc/logger/rdoc/Logger.html
       # @option options [String]                  :client_id           client ID identifying this connection to other clients
       # @option options [String]                  :auth_url            a URL to be used to GET or POST a set of token request params, to obtain a signed token request
       # @option options [Hash]                    :auth_headers        a set of application-specific headers to be added to any request made to the +auth_url+
@@ -138,7 +147,7 @@ module Ably
       # @option options [Symbol]                  :auth_method         (:get) HTTP method to use with +auth_url+, must be either +:get+ or +:post+
       # @option options [Proc]                    :auth_callback       when provided, the Proc will be called with the token params hash as the first argument, whenever a new token is required.
       #                                                                The Proc should return a token string, {Ably::Models::TokenDetails} or JSON equivalent, {Ably::Models::TokenRequest} or JSON equivalent
-      # @option options [Boolean]                 :query_time          when true will query the {https://www.ably.io Ably} system for the current time instead of using the local time
+      # @option options [Boolean]                 :query_time          when true will query the {https://www.ably.com Ably} system for the current time instead of using the local time
       # @option options [Hash]                    :default_token_params   convenience to pass in +token_params+ that will be used as a default for all token requests. See {Auth#create_token_request}
       #
       # @option options [Integer]                 :http_open_timeout       (4 seconds) timeout in seconds for opening an HTTP connection for all HTTP requests
@@ -152,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]
       #
@@ -188,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"
@@ -365,8 +380,8 @@ 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.")
+          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 || {}

data/lib/ably/rest/middleware/encoder.rb

@@ -5,7 +5,7 @@ module Ably
   module Rest
     module Middleware
       # Encode the body of the message according to the mime type
-      class Encoder < ::Faraday::Response::Middleware
+      class Encoder < Faraday::Middleware
         CONTENT_TYPE = 'Content-Type'.freeze unless defined? CONTENT_TYPE
 
         def call(env)

data/lib/ably/rest/middleware/exceptions.rb

@@ -6,7 +6,7 @@ module Ably
     module Middleware
       # HTTP exceptions raised by Ably due to an error status code
       # Ably returns JSON/Msgpack error codes and messages so include this if possible in the exception messages
-      class Exceptions < Faraday::Response::Middleware
+      class Exceptions < Faraday::Middleware
         def on_complete(env)
           if env.status >= 400
             error_status_code = env.status

data/lib/ably/rest/middleware/external_exceptions.rb

@@ -5,7 +5,7 @@ module Ably
     module Middleware
       # HTTP exceptions raised due to a status code error on a 3rd party site
       # Used by auth calls
-      class ExternalExceptions < Faraday::Response::Middleware
+      class ExternalExceptions < Faraday::Middleware
         def on_complete(env)
           if env.status >= 400
             error_status_code = env.status

data/lib/ably/rest/middleware/fail_if_unsupported_mime_type.rb

@@ -4,7 +4,7 @@ require 'json'
 module Ably
   module Rest
     module Middleware
-      class FailIfUnsupportedMimeType < Faraday::Response::Middleware
+      class FailIfUnsupportedMimeType < Faraday::Middleware
         def on_complete(env)
           unless env.response_headers['Ably-Middleware-Parsed'] == true
             # Ignore empty body with success status code for no body response

data/lib/ably/rest/middleware/logger.rb

@@ -3,7 +3,7 @@ require 'faraday'
 module Ably
   module Rest
     module Middleware
-      class Logger < Faraday::Response::Middleware
+      class Logger < Faraday::Middleware
         extend Forwardable
 
         def initialize(app, logger = nil)

data/lib/ably/rest/middleware/parse_json.rb

@@ -4,7 +4,7 @@ require 'json'
 module Ably
   module Rest
     module Middleware
-      class ParseJson < Faraday::Response::Middleware
+      class ParseJson < Faraday::Middleware
         def on_complete(env)
           if env.response_headers['Content-Type'] == 'application/json'
             env.body = parse(env.body) unless env.response_headers['Ably-Middleware-Parsed'] == true

data/lib/ably/rest/middleware/parse_message_pack.rb

@@ -4,7 +4,7 @@ require 'msgpack'
 module Ably
   module Rest
     module Middleware
-      class ParseMessagePack < Faraday::Response::Middleware
+      class ParseMessagePack < Faraday::Middleware
         def on_complete(env)
           if env.response_headers['Content-Type'] == 'application/x-msgpack'
             env.body = parse(env.body) unless env.response_headers['Ably-Middleware-Parsed'] == true

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,6 +1,6 @@
 module Ably
-  VERSION = '1.1.7'
-  PROTOCOL_VERSION = '1.1'
+  VERSION = '1.2.1'
+  PROTOCOL_VERSION = '1.2'
 
   # @api private
   def self.major_minor_version_numeric