ably 1.1.8 → 1.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ba8f2b01b35fceead7297645f54cb854017e14c8a004882d5b414becc450feef
-  data.tar.gz: c116cce13d8ed06a9858e252a81918530d54f15e1a20c4b3ef30e5334408ec1b
+  metadata.gz: 254c6088b3e3ef0d8cd6d2837b4efc73c2c7c04d8b7d4c61d416f023a8933603
+  data.tar.gz: 91d7b17e533b41ede327696aff66dd97ea35d6f7cf2a9fee9fd467fa42e9041e
 SHA512:
-  metadata.gz: e0761591d9f838201f208c3d44d8068ad77c87591e737083cab548e77a104a6d7bd2da2cc360e01ad661c33f3af09220813ad19fe7d93f6759a7a88de82180d9
-  data.tar.gz: ca14639736fc07b1d00323df0073b37e0e2f51d6a2681bf868173708aafd45a89fbc872d4c16c600a41ebea9488c336a5422bdddbf8b80daa912ce9ef231945c
+  metadata.gz: 8d51a067f02691481cf9489f82334f9200ef9ae00d71c2639c26a8d0b8fa62fbd76921fafb114699d4bf0d8e0f0e46f865bb07411a4dc4d6197a7ffeb9ebd6be
+  data.tar.gz: a392f7f5ec08ab445aaad519e45dc841090950402516ef2bafe3863817af77536b85549701acfc52e4a171544b79a190b499b3f8d32552a9a08973bf60831c3d

data/.github/workflows/check.yml

@@ -10,8 +10,9 @@ jobs:
     continue-on-error: true
     strategy:
       matrix:
-        ruby: [ '2.5', '2.6', '2.7', '3.0' ]
+        ruby: [ '2.7', '3.0', '3.1' ]
         protocol: [ 'json', 'msgpack' ]
+        type: [ 'unit', 'acceptance' ]
     steps:
       - uses: actions/checkout@v2
         with:
@@ -20,15 +21,23 @@ jobs:
         with:
           ruby-version: ${{ matrix.ruby }}
           bundler-cache: true
-      - env:
-          RSPEC_RETRY: true
+      - name: 'Run ${{ matrix.type }} tests on ruby ${{ matrix.ruby }} (${{ matrix.protocol }} protocol)'
+        env:
           PARALLEL_TEST_PROCESSORS: 2
+          RSPEC_RETRY: true
           PROTOCOL: ${{ matrix.protocol }}
-        run: ./spec/run_parallel_tests
+        run: bundle exec parallel_rspec --prefix-output-with-test-env-number -- --format documentation --format RspecJunitFormatter --out ${{ matrix.protocol }}-${{ matrix.type }}-ruby-${{ matrix.ruby }}.junit -- spec/${{ matrix.type }}
+      - name: Upload test results
+        if: always()
+        uses: ably-labs/test-observability-action@main
+        with:
+          server-url: 'https://test-observability.herokuapp.com'
+          server-auth: ${{ secrets.TEST_OBSERVABILITY_SERVER_AUTH_KEY }}
+          path: '.'
       - uses: coverallsapp/github-action@1.1.3
         with:
           github-token: ${{ secrets.GITHUB_TOKEN }}
-          flag-name: run-ruby_${{ matrix.ruby }}-${{ matrix.protocol }}_protocol
+          flag-name: ruby-${{ matrix.ruby }}-${{ matrix.protocol }}-${{ matrix.type }}
           parallel: true
   finish:
     needs: check

data/CHANGELOG.md

@@ -1,5 +1,53 @@
 # Change Log
 
+## [v1.2.2](https://github.com/ably/ably-ruby/tree/v1.2.2)
+
+[Full Changelog](https://github.com/ably/ably-ruby/compare/v1.2.1...v1.2.2)
+
+**Implemented enhancements:**
+
+- Add support to get channel lifecycle status [\#362](https://github.com/ably/ably-ruby/issues/362)
+
+## [v1.2.1](https://github.com/ably/ably-ruby/tree/v1.2.1)
+
+[Full Changelog](https://github.com/ably/ably-ruby/compare/v1.2.0...v1.2.1)
+
+**Fixed bugs:**
+
+- Update Ruby version \(and Gemfile.lock dependencies\) [\#253](https://github.com/ably/ably-ruby/issues/253)
+- Error not emitted when failing to connect to an endpoint indefinitely [\#233](https://github.com/ably/ably-ruby/issues/233)
+- Connection errors when there should be warnings [\#198](https://github.com/ably/ably-ruby/issues/198)
+- Implement presence re-entry requirement change for 1.1 [\#185](https://github.com/ably/ably-ruby/issues/185)
+
+**Closed issues:**
+
+- Update urls in readme [\#353](https://github.com/ably/ably-ruby/issues/353)
+- Reconsider required Ruby version [\#344](https://github.com/ably/ably-ruby/issues/344)
+
+## [v1.2.0](https://github.com/ably/ably-ruby/tree/v1.2.0)
+
+[Full Changelog](https://github.com/ably/ably-ruby/compare/v1.1.8...v1.2.0)
+
+This release updates ably-ruby to be compliant with the 1.2 version of the Ably client library feature specification. There are some minor breaking changes, please see [the migration guide](./UPDATING.md) for more information.
+
+**Closed issues:**
+
+- Add Channel.setOptions method [\#291](https://github.com/ably/ably-ruby/issues/291)
+- Add support for channel params [\#288](https://github.com/ably/ably-ruby/issues/288)
+- Use ATTACH_RESUME flag for unclean attaches [\#287](https://github.com/ably/ably-ruby/issues/287)
+- Add ChannelOptions param to Channels.get [\#285](https://github.com/ably/ably-ruby/issues/285)
+- Update library to adhere to new spec for token renewal (see [the spec definition](https://docs.ably.io/client-lib-development-guide/features/#RSA4b) for more info) [\#268](https://github.com/ably/ably-ruby/issues/268)
+
+**Merged pull requests:**
+
+- Add migration guide from 1.1.8 to 1.2.0 [\#348](https://github.com/ably/ably-ruby/pull/348) ([TheSmartnik](https://github.com/TheSmartnik))
+- RTL21 [\#345](https://github.com/ably/ably-ruby/pull/345) ([lukaszsliwa](https://github.com/lukaszsliwa))
+- RTL4j [\#341](https://github.com/ably/ably-ruby/pull/341) ([TheSmartnik](https://github.com/TheSmartnik))
+- RSL1a, RSL1b [\#340](https://github.com/ably/ably-ruby/pull/340) ([lukaszsliwa](https://github.com/lukaszsliwa))
+- Add support for RSA4b, b1, c, RSA16 \(Authentication\) [\#338](https://github.com/ably/ably-ruby/pull/338) ([lukaszsliwa](https://github.com/lukaszsliwa))
+- ChannelOptions related tasks [\#336](https://github.com/ably/ably-ruby/pull/336) ([TheSmartnik](https://github.com/TheSmartnik))
+- Update RSC7 [\#334](https://github.com/ably/ably-ruby/pull/334) ([TheSmartnik](https://github.com/TheSmartnik))
+
 ## [v1.1.8](https://github.com/ably/ably-ruby/tree/v1.1.8)
 
 [Full Changelog](https://github.com/ably/ably-ruby/compare/v1.1.7...v1.1.8)

data/README.md

@@ -5,11 +5,11 @@
 
 _[Ably](https://ably.com) is the platform that powers synchronized digital experiences in realtime. Whether attending an event in a virtual venue, receiving realtime financial information, or monitoring live car performance data – consumers simply expect realtime digital experiences as standard. Ably provides a suite of APIs to build, extend, and deliver powerful digital experiences in realtime for more than 250 million devices across 80 countries each month. Organizations like Bloomberg, HubSpot, Verizon, and Hopin depend on Ably’s platform to offload the growing complexity of business-critical realtime data synchronization at global scale. For more information, see the [Ably documentation](https://ably.com/documentation)._
 
-This is a Ruby client library for Ably. The library currently targets the [Ably 1.1 client library specification](https://ably.com/documentation/client-lib-development-guide/features/). You can see the complete list of features this client library supports in [our client library SDKs feature support matrix](https://ably.com/download/sdk-feature-support-matrix).
+This is a Ruby client library for Ably. The library currently targets the [Ably 1.2 client library specification](https://ably.com/documentation/client-lib-development-guide/features/). You can see the complete list of features this client library supports in [our client library SDKs feature support matrix](https://ably.com/download/sdk-feature-support-matrix).
 
 ## Supported platforms
 
-This SDK supports Ruby 1.9.3+. For eventmachine and Ruby 3.0 note please visit [Ruby 3.0 support](#ruby-30-support) section.
+This SDK supports Ruby 2.7 and 3.x. For eventmachine and Ruby 3.x note please visit [Ruby 3.0 support](#ruby-30-support) section.
 
 As of v1.1.5 this library requires `libcurl` as a system dependency. On most systems this is already installed but in rare cases where it isn't (for example debian-slim Docker images such as ruby-slim) you will need to install it yourself. On debian you can install it with the command `sudo apt-get install libcurl4`.
 

data/UPDATING.md

@@ -0,0 +1,30 @@
+# Upgrade / Migration Guide
+
+## Version 1.1.8 to 1.2.0
+
+### Notable Changes
+This release is all about channel options. Here is the full [changelog](https://github.com/ably/ably-ruby/blob/main/CHANGELOG.md)
+
+* Channel options were extracted into a seperate model [ChannelOptions](https://github.com/ably/ably-ruby/blob/main/lib/ably/models/channel_options.rb). However it's still backward campatible with `Hash` and you don't need to do make any adjustments to your code
+
+* The `ChannelOptions` class now supports `:params`, `:modes` and `:cipher` as options. Previously only `:cipher` was available
+
+* The client `:idempotent_rest_publishing` option is `true` by default. Previously `:idempotent_rest_publishing` was `false` by default.
+
+### Breaking Changes
+
+* Changing channel options with `Channels#get` is now deprecated in favor of explicit options change
+
+  1. If channel state is attached or attaching an exception will be raised
+  2. Otherwise the library will emit a warning
+
+For example, the following code
+```
+  client.channels.get(channel_name, new_channel_options)
+```
+
+Should be changed to:
+```
+  channel = client.channels.get(channel_name)
+  channel.options = new_channel_options
+```

data/ably.gemspec

@@ -20,41 +20,29 @@ Gem::Specification.new do |spec|
 
   spec.add_runtime_dependency 'eventmachine', '~> 1.2.6'
   spec.add_runtime_dependency 'em-http-request', '~> 1.1'
-  spec.add_runtime_dependency 'statesman', '~> 8.0'
-  spec.add_runtime_dependency 'faraday', '~> 1.0'
+  spec.add_runtime_dependency 'statesman', '~> 9.0'
+  spec.add_runtime_dependency 'faraday', '~> 2.2'
+  spec.add_runtime_dependency 'faraday-typhoeus', '~> 0.2.0'
   spec.add_runtime_dependency 'typhoeus', '~> 1.4'
-
-  if RUBY_VERSION.match(/^1\./)
-    spec.add_runtime_dependency 'json', '< 2.0'
-  else
-    spec.add_runtime_dependency 'json'
-  end
+  spec.add_runtime_dependency 'json'
   spec.add_runtime_dependency 'websocket-driver', '~> 0.7'
   spec.add_runtime_dependency 'msgpack', '>= 1.3.0'
   spec.add_runtime_dependency 'addressable', '>= 2.0.0'
 
   spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'redcarpet', '~> 3.3'
-  spec.add_development_dependency 'rspec', '~> 3.10.0'
+  spec.add_development_dependency 'rspec', '~> 3.11.0'
+  spec.add_development_dependency 'rspec_junit_formatter', '~> 0.5.1'
   spec.add_development_dependency 'rspec-retry', '~> 0.6'
   spec.add_development_dependency 'yard', '~> 0.9'
   spec.add_development_dependency 'rspec-instafail', '~> 1.0'
   spec.add_development_dependency 'bundler', '>= 1.3.0'
-
-  if RUBY_VERSION.match(/^1\./)
-    spec.add_development_dependency 'public_suffix', '~> 1.4.6' # Later versions do not support Ruby 1.9
-    spec.add_development_dependency 'webmock', '2.2'
-    spec.add_development_dependency 'parallel_tests', '~> 2.9.0'
-  else
-    spec.add_development_dependency 'webmock', '~> 3.11'
-    spec.add_development_dependency 'simplecov', '~> 0.21.2'
-    spec.add_development_dependency 'simplecov-lcov', '~> 0.8.0'
-    spec.add_development_dependency 'parallel_tests', '~> 3.7'
-    if !RUBY_VERSION.match(/^2\.[0123]/)
-      spec.add_development_dependency 'pry', '~> 0.14.1'
-      spec.add_development_dependency 'pry-byebug', '~> 3.8.0'
-    end
-  end
+  spec.add_development_dependency 'webmock', '~> 3.11'
+  spec.add_development_dependency 'simplecov', '~> 0.21.2'
+  spec.add_development_dependency 'simplecov-lcov', '~> 0.8.0'
+  spec.add_development_dependency 'parallel_tests', '~> 3.8'
+  spec.add_development_dependency 'pry', '~> 0.14.1'
+  spec.add_development_dependency 'pry-byebug', '~> 3.8.0'
 
   if RUBY_VERSION.match(/^3\./)
     spec.add_development_dependency 'webrick', '~> 1.7.0'

data/lib/ably/auth.rb

@@ -5,9 +5,9 @@ require 'securerandom'
 require 'ably/rest/middleware/external_exceptions'
 
 module Ably
-  # Auth is responsible for authentication with {https://www.ably.io Ably} using basic or token authentication
+  # Auth is responsible for authentication with {https://www.ably.com Ably} using basic or token authentication
   #
-  # Find out more about Ably authentication at: https://www.ably.io/documentation/general/authentication/
+  # Find out more about Ably authentication at: https://www.ably.com/docs/general/authentication/
   #
   # @!attribute [r] client_id
   #   @return [String] The provided client ID, used for identifying this client for presence purposes
@@ -35,7 +35,7 @@ module Ably
 
     API_KEY_REGEX = /^[\w-]{2,}\.[\w-]{2,}:[\w-]{2,}$/
 
-    # Supported AuthOption keys, see https://www.ably.io/documentation/realtime/types#auth-options
+    # Supported AuthOption keys, see https://www.ably.com/docs/realtime/types#auth-options
     # TODO: Review client_id usage embedded incorrectly within AuthOptions.
     #       This is legacy code to configure a client with a client_id from the ClientOptions
     # TODO: Review inclusion of use_token_auth, ttl, token_params in auth options
@@ -277,7 +277,7 @@ module Ably
     #
     # @param [Hash] token_params the token params used in the token request
     # @option token_params [String]  :client_id     A client ID to associate with this token. The generated token may be used to authenticate as this +client_id+
-    # @option token_params [Integer] :ttl           validity time in seconds for the requested {Ably::Models::TokenDetails}.  Limits may apply, see {https://www.ably.io/documentation/other/authentication}
+    # @option token_params [Integer] :ttl           validity time in seconds for the requested {Ably::Models::TokenDetails}.  Limits may apply, see {https://www.ably.com/docs/general/authentication}
     # @option token_params [Hash]    :capability    canonicalised representation of the resource paths and associated operations
     # @option token_params [Time]    :timestamp     the time of the request
     # @option token_params [String]  :nonce         an unquoted, unescaped random string of at least 16 characters
@@ -285,7 +285,7 @@ module Ably
     # @param [Hash] auth_options the authentication options for the token request
     # @option auth_options [String]  :key           API key comprising the key name and key secret in a single string
     # @option auth_options [String]  :client_id     client ID identifying this connection to other clients (will use +client_id+ specified when library was instanced if provided)
-    # @option auth_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 auth_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 auth_options [Hash]    :token_params  convenience to pass in +token_params+ within the +auth_options+ argument, especially useful when setting default token_params in the client constructor
     #
     # @return [Models::TokenRequest]
@@ -510,11 +510,11 @@ module Ably
     end
 
     def authorize_when_necessary
-      if current_token_details && !current_token_details.expired?
+      if current_token_details && !current_token_details.expired?(from: current_time)
         return current_token_details
-      else
-        authorize
       end
+
+      authorize
     end
 
     # Returns the current device clock time unless the

data/lib/ably/logger.rb

@@ -7,9 +7,9 @@ module Ably
     extend Forwardable
 
     # @param client        [Ably::Rest::Client,Ably::Realtime::Client] Rest or Realtime Ably client
-    # @param log_level     [Integer] {http://www.ruby-doc.org/stdlib-1.9.3/libdoc/logger/rdoc/Logger.html Ruby Logger} log level
+    # @param log_level     [Integer] {http://www.ruby-doc.org/stdlib-3.1.1/libdoc/logger/rdoc/Logger.html Ruby Logger} log level
     # @param custom_logger [nil,Object] A custom logger can optionally be used instead of the,
-    #                      however it must provide a {http://www.ruby-doc.org/stdlib-1.9.3/libdoc/logger/rdoc/Logger.html Ruby Logger} compatible interface.
+    #                      however it must provide a {http://www.ruby-doc.org/stdlib-3.1.1/libdoc/logger/rdoc/Logger.html Ruby Logger} compatible interface.
     #
     def initialize(client, log_level, custom_logger = nil)
       @client        = client
@@ -24,7 +24,7 @@ module Ably
       @log_mutex = Mutex.new
     end
 
-    # The logger used by this class, defaults to {http://www.ruby-doc.org/stdlib-1.9.3/libdoc/logger/rdoc/Logger.html Ruby Logger}
+    # The logger used by this class, defaults to {http://www.ruby-doc.org/stdlib-3.1.1/libdoc/logger/rdoc/Logger.html Ruby Logger}
     # @return {Object,Logger}
     attr_reader :logger
 
@@ -32,7 +32,7 @@ module Ably
     # @return {nil,Object}
     attr_reader :custom_logger
 
-    # The log level ranging from DEBUG to FATAL, refer to http://www.ruby-doc.org/stdlib-1.9.3/libdoc/logger/rdoc/Logger.html
+    # The log level ranging from DEBUG to FATAL, refer to http://www.ruby-doc.org/stdlib-3.1.1/libdoc/logger/rdoc/Logger.html
     # @return {Integer}
     attr_reader :log_level
 

data/lib/ably/models/channel_details.rb

@@ -0,0 +1,59 @@
+module Ably::Models
+  # Convert token details argument to a {ChannelDetails} object
+  #
+  # @param attributes (see #initialize)
+  #
+  # @return [ChannelDetails]
+  def self.ChannelDetails(attributes)
+    case attributes
+    when ChannelDetails
+      return attributes
+    else
+      ChannelDetails.new(attributes)
+    end
+  end
+
+  # ChannelDetails is a type that represents information for a channel including channelId, name, status and occupancy (CHD1)
+  #
+  class ChannelDetails
+    extend Ably::Modules::Enum
+    extend Forwardable
+    include Ably::Modules::ModelCommon
+
+    # The attributes of ChannelDetails (CHD2)
+    #
+    attr_reader :attributes
+
+    alias_method :to_h, :attributes
+
+    # Initialize a new ChannelDetails
+    #
+    def initialize(attrs)
+      @attributes = IdiomaticRubyWrapper(attrs.clone)
+    end
+
+    # The identifier of the channel (CHD2a)
+    #
+    # @return [String]
+    #
+    def channel_id
+      attributes[:channel_id]
+    end
+
+    # The identifier of the channel (CHD2a)
+    #
+    # @return [String]
+    #
+    def name
+      attributes[:name]
+    end
+
+    # The status of the channel (CHD2b)
+    #
+    # @return [Ably::Models::ChannelStatus, nil]
+    #
+    def status
+      Ably::Models::ChannelStatus(attributes[:status])
+    end
+  end
+end

data/lib/ably/models/channel_metrics.rb

@@ -0,0 +1,84 @@
+module Ably::Models
+  # Convert token details argument to a {ChannelMetrics} object
+  #
+  # @param attributes (see #initialize)
+  #
+  # @return [ChannelMetrics]
+  def self.ChannelMetrics(attributes)
+    case attributes
+    when ChannelMetrics
+      return attributes
+    else
+      ChannelMetrics.new(attributes)
+    end
+  end
+
+  # ChannelMetrics is a type that contains the count of publishers and subscribers, connections and presenceConnections,
+  # presenceMembers and presenceSubscribers (CHM1)
+  #
+  class ChannelMetrics
+    extend Ably::Modules::Enum
+    extend Forwardable
+    include Ably::Modules::ModelCommon
+
+    # The attributes of ChannelMetrics (CHM2)
+    #
+    attr_reader :attributes
+
+    alias_method :to_h, :attributes
+
+    # Initialize a new ChannelMetrics
+    #
+    def initialize(attrs)
+      @attributes = IdiomaticRubyWrapper(attrs.clone)
+    end
+
+    # The total number of connections to the channel (CHM2a)
+    #
+    # @return [Integer]
+    #
+    def connections
+      attributes[:connections]
+    end
+
+    # The total number of presence connections to the channel (CHM2b)
+    #
+    # @return [Integer]
+    #
+    def presence_connections
+      attributes[:presence_connections]
+    end
+
+    # The total number of presence members for the channel (CHM2c)
+    #
+    # @return [Integer]
+    #
+    def presence_members
+      attributes[:presence_members]
+    end
+
+    # The total number of presence subscribers for the channel (CHM2d)
+    #
+    # @return [Integer]
+    #
+    def presence_subscribers
+      attributes[:presence_subscribers]
+    end
+
+    # The total number of publishers to the channel (CHM2e)
+    #
+    # @return [Integer]
+    #
+    def publishers
+      attributes[:publishers]
+    end
+
+    # The total number of subscribers to the channel (CHM2f)
+    #
+    # @return [Integer]
+    #
+    def subscribers
+      attributes[:subscribers]
+    end
+  end
+end

data/lib/ably/models/channel_occupancy.rb

@@ -0,0 +1,43 @@
+module Ably::Models
+  # Convert token details argument to a {ChannelOccupancy} object
+  #
+  # @param attributes (see #initialize)
+  #
+  # @return [ChannelOccupancy]
+  def self.ChannelOccupancy(attributes)
+    case attributes
+    when ChannelOccupancy
+      return attributes
+    else
+      ChannelOccupancy.new(attributes)
+    end
+  end
+
+  # Type that contain channel metrics (CHO1)
+  #
+  class ChannelOccupancy
+    extend Ably::Modules::Enum
+    extend Forwardable
+    include Ably::Modules::ModelCommon
+
+    # The attributes of ChannelOccupancy (CH02)
+    #
+    attr_reader :attributes
+
+    alias_method :to_h, :attributes
+
+    # Initialize a new ChannelOccupancy
+    #
+    def initialize(attrs)
+      @attributes = IdiomaticRubyWrapper(attrs.clone)
+    end
+
+    # Metrics object (CHO2a)
+    #
+    # @return [Ably::Models::ChannelMetrics, nil]
+    #
+    def metrics
+      Ably::Models::ChannelMetrics(attributes[:metrics])
+    end
+  end
+end

data/lib/ably/models/channel_options.rb

@@ -0,0 +1,97 @@
+module Ably::Models
+  # Convert token details argument to a {ChannelOptions} object
+  #
+  # @param attributes (see #initialize)
+  #
+  # @return [ChannelOptions]
+  def self.ChannelOptions(attributes)
+    case attributes
+    when ChannelOptions
+      return attributes
+    else
+      ChannelOptions.new(attributes)
+    end
+  end
+
+  # Represents options of a channel
+  class ChannelOptions
+    extend Ably::Modules::Enum
+    extend Forwardable
+    include Ably::Modules::ModelCommon
+
+    MODES = ruby_enum('MODES',
+      presence: 0,
+      publish: 1,
+      subscribe: 2,
+      presence_subscribe: 3
+    )
+
+    attr_reader :attributes
+
+    alias_method :to_h, :attributes
+
+    def_delegators :attributes, :fetch, :size, :empty?
+    # Initialize a new ChannelOptions
+    #
+    # @option params [Hash] (TB2c) params (for realtime client libraries only) a  of key/value pairs
+    # @option modes [Hash] modes (for realtime client libraries only) an array of ChannelMode
+    # @option cipher [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.
+    #
+    def initialize(attrs)
+      @attributes = IdiomaticRubyWrapper(attrs.clone)
+
+      attributes[:modes] = modes.to_a.map { |mode| Ably::Models::ChannelOptions::MODES[mode] } if modes
+      attributes[:cipher] = Ably::Models::CipherParams(cipher) if cipher
+      attributes.clone
+    end
+
+    # @!attribute cipher
+    #
+    # @return [CipherParams]
+    def cipher
+      attributes[:cipher]
+    end
+
+    # @!attribute params
+    #
+    # @return [Hash]
+    def params
+      attributes[:params].to_h
+    end
+
+    # @!attribute modes
+    #
+    # @return [Array<ChannelOptions::MODES>]
+    def modes
+      attributes[:modes]
+    end
+
+    # Converts modes to a bitfield that coresponds to ProtocolMessage#flags
+    #
+    # @return [Integer]
+    def modes_to_flags
+      modes.map { |mode| Ably::Models::ProtocolMessage::ATTACH_FLAGS_MAPPING[mode.to_sym] }.reduce(:|)
+    end
+
+    # @return [Hash]
+    # @api private
+    def set_params(hash)
+      attributes[:params] = hash
+    end
+
+    # Sets modes from ProtocolMessage#flags
+    #
+    # @return [Array<ChannelOptions::MODES>]
+    # @api private
+    def set_modes_from_flags(flags)
+      return unless flags
+
+      message_modes = MODES.select do |mode|
+        flag = Ably::Models::ProtocolMessage::ATTACH_FLAGS_MAPPING[mode.to_sym]
+        flags & flag == flag
+      end
+
+      attributes[:modes] = message_modes.map { |mode| Ably::Models::ChannelOptions::MODES[mode] }
+    end
+  end
+end

data/lib/ably/models/channel_status.rb

@@ -0,0 +1,53 @@
+module Ably::Models
+  # Convert token details argument to a {ChannelStatus} object
+  #
+  # @param attributes (see #initialize)
+  #
+  # @return [ChannelStatus]
+  def self.ChannelStatus(attributes)
+    case attributes
+    when ChannelStatus
+      return attributes
+    else
+      ChannelStatus.new(attributes)
+    end
+  end
+
+  # ChannelStatus is a type that contains status and occupancy for a channel (CHS1)
+  #
+  class ChannelStatus
+    extend Ably::Modules::Enum
+    extend Forwardable
+    include Ably::Modules::ModelCommon
+
+    # The attributes of ChannelStatus (CHS2)
+    #
+    attr_reader :attributes
+
+    alias_method :to_h, :attributes
+
+    # Initialize a new ChannelStatus
+    #
+    def initialize(attrs)
+      @attributes = IdiomaticRubyWrapper(attrs.clone)
+    end
+
+    # Represents if the channel is active (CHS2a)
+    #
+    # @return [Boolean]
+    #
+    def is_active
+      attributes[:isActive]
+    end
+    alias_method :active?, :is_active
+    alias_method :is_active?, :is_active
+
+    # Occupancy ChannelOccupancy – occupancy is an object containing the metrics for the channel (CHS2b)
+    #
+    # @return [Ably::Models::ChannelOccupancy, nil]
+    #
+    def occupancy
+      Ably::Models::ChannelOccupancy(attributes[:occupancy])
+    end
+  end
+end

data/lib/ably/models/device_details.rb

@@ -27,7 +27,7 @@ module Ably::Models
   # @!attribute [r] form_factor
   #   @return [String] Device form factor such as phone, tablet, watch
   # @!attribute [r] client_id
-  #   @return [String] The authenticated client identifier for this device. See {https://www.ably.io/documentation/general/authentication#identified-clients auth documentation}.
+  #   @return [String] The authenticated client identifier for this device. See {https://www.ably.com/docs/general/authentication#identified-clients auth documentation}.
   # @!attribute [r] metadata
   #   @return [Hash] Arbitrary metadata that can be associated with a device
   # @!attribute [r] device_secret

data/lib/ably/models/idiomatic_ruby_wrapper.rb

@@ -94,6 +94,10 @@ module Ably::Models
       attributes.size
     end
 
+    def empty?
+      attributes.empty?
+    end
+
     def keys
       map { |key, value| key }
     end