ably 1.2.1 → 1.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6d535fd596cbed132fc9c540fb46997c5fcaafeae4b4531ab6fbe02dba33178f
-  data.tar.gz: 1792b4e4f47d7044d0a937d3b75f9e3b9d9f1d6a436a36bfde2f9e65ae3f2552
+  metadata.gz: 254c6088b3e3ef0d8cd6d2837b4efc73c2c7c04d8b7d4c61d416f023a8933603
+  data.tar.gz: 91d7b17e533b41ede327696aff66dd97ea35d6f7cf2a9fee9fd467fa42e9041e
 SHA512:
-  metadata.gz: fad634a453ebbb3d1b05ad13fa7c3683e794635862267376920aa7d43e93afeab7c5ba06398609e048d7f421f8d10f80f9866828f07468e153be843f6b38a136
-  data.tar.gz: 1d76ae8ffe50a043b82fbb553af787a2a49665909d802f6471644e9614d81677d04c38926cb34890a2daeef2d498cabe7c39817c40fbb8d1be88070d2d103669
+  metadata.gz: 8d51a067f02691481cf9489f82334f9200ef9ae00d71c2639c26a8d0b8fa62fbd76921fafb114699d4bf0d8e0f0e46f865bb07411a4dc4d6197a7ffeb9ebd6be
+  data.tar.gz: a392f7f5ec08ab445aaad519e45dc841090950402516ef2bafe3863817af77536b85549701acfc52e4a171544b79a190b499b3f8d32552a9a08973bf60831c3d

data/.github/workflows/check.yml

@@ -12,6 +12,7 @@ jobs:
       matrix:
         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,13 @@
 # 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)

data/ably.gemspec

@@ -32,6 +32,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'redcarpet', '~> 3.3'
   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'

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_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/rest/channel.rb

@@ -161,6 +161,13 @@ module Ably
       end
       alias options= set_options
 
+      # Makes GET request for channel details (#RSL8, #RSL8a)
+      #
+      # @return [Ably::Models::ChannelDetails]
+      def status
+        Ably::Models::ChannelDetails.new(client.get(base_path).body)
+      end
+
       private
 
       def base_path

data/lib/ably/version.rb

@@ -1,5 +1,5 @@
 module Ably
-  VERSION = '1.2.1'
+  VERSION = '1.2.2'
   PROTOCOL_VERSION = '1.2'
 
   # @api private

data/spec/acceptance/rest/channel_spec.rb

@@ -595,5 +595,23 @@ describe Ably::Rest::Channel do
         expect(channel.presence).to be_a(Ably::Rest::Presence)
       end
     end
+
+    context '#status' do
+      let(:channel_name) { "persisted:#{random_str(4)}" }
+      let(:channel) { client.channel(channel_name) }
+      let(:channel_details) { channel.status }
+
+      it 'should return channel details status (#RSL8, #RSL8a)' do
+        expect(channel_details.channel_id).to eq(channel_name)
+        expect(channel_details.name).to eq(channel_name)
+        expect(channel_details.status).to be_a(Ably::Models::ChannelStatus)
+        expect(channel_details.status.is_active).to eq(true)
+        expect(channel_details.status.occupancy.metrics.publishers).to eq(0)
+        expect(channel_details.status.occupancy.metrics.subscribers).to eq(0)
+        expect(channel_details.status.occupancy.metrics.presence_connections).to eq(0)
+        expect(channel_details.status.occupancy.metrics.presence_members).to eq(0)
+        expect(channel_details.status.occupancy.metrics.presence_subscribers).to eq(0)
+      end
+    end
   end
 end

data/spec/unit/models/channel_details_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+require 'shared/model_behaviour'
+
+describe Ably::Models::ChannelDetails do
+  subject { Ably::Models::ChannelDetails(channel_id: 'channel-id-123-xyz', name: 'name', status: { isActive: 'true', occupancy: { metrics: { connections: 1, presence_connections: 2, presence_members: 2, presence_subscribers: 5, publishers: 7, subscribers: 9 } } }) }
+
+  describe '#channel_id' do
+    it 'should return channel id' do
+      expect(subject.channel_id).to eq('channel-id-123-xyz')
+    end
+  end
+
+  describe '#name' do
+    it 'should return name' do
+      expect(subject.name).to eq('name')
+    end
+  end
+
+  describe '#status' do
+    it 'should return status' do
+      expect(subject.status).to be_a(Ably::Models::ChannelStatus)
+      expect(subject.status.occupancy.metrics.connections).to eq(1)
+      expect(subject.status.occupancy.metrics.presence_connections).to eq(2)
+      expect(subject.status.occupancy.metrics.presence_members).to eq(2)
+      expect(subject.status.occupancy.metrics.presence_subscribers).to eq(5)
+      expect(subject.status.occupancy.metrics.publishers).to eq(7)
+      expect(subject.status.occupancy.metrics.subscribers).to eq(9)
+    end
+  end
+end

data/spec/unit/models/channel_metrics_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+require 'shared/model_behaviour'
+
+describe Ably::Models::ChannelMetrics do
+  subject { Ably::Models::ChannelMetrics(connections: 1, presence_connections: 2, presence_members: 2, presence_subscribers: 5, publishers: 7, subscribers: 9) }
+
+  describe '#connections' do
+    it 'should return integer' do
+      expect(subject.connections).to eq(1)
+    end
+  end
+
+  describe '#presence_connections' do
+    it 'should return integer' do
+      expect(subject.presence_connections).to eq(2)
+    end
+  end
+
+  describe '#presence_members' do
+    it 'should return integer' do
+      expect(subject.presence_members).to eq(2)
+    end
+  end
+
+  describe '#presence_subscribers' do
+    it 'should return integer' do
+      expect(subject.presence_subscribers).to eq(5)
+    end
+  end
+
+  describe '#publishers' do
+    it 'should return integer' do
+      expect(subject.publishers).to eq(7)
+    end
+  end
+
+  describe '#subscribers' do
+    it 'should return integer' do
+      expect(subject.subscribers).to eq(9)
+    end
+  end
+end

data/spec/unit/models/channel_occupancy_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+require 'shared/model_behaviour'
+
+describe Ably::Models::ChannelOccupancy do
+  subject { Ably::Models::ChannelOccupancy({ metrics: { connections: 1, presence_connections: 2, presence_members: 2, presence_subscribers: 5, publishers: 7, subscribers: 9 } }) }
+
+  describe '#metrics' do
+    it 'should return attributes' do
+      expect(subject.metrics.connections).to eq(1)
+      expect(subject.metrics.presence_connections).to eq(2)
+      expect(subject.metrics.presence_members).to eq(2)
+      expect(subject.metrics.presence_subscribers).to eq(5)
+      expect(subject.metrics.publishers).to eq(7)
+      expect(subject.metrics.subscribers).to eq(9)
+    end
+  end
+end

data/spec/unit/models/channel_status_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+require 'shared/model_behaviour'
+
+describe Ably::Models::ChannelStatus do
+  subject { Ably::Models::ChannelStatus({ isActive: 'true', occupancy: { metrics: { connections: 1, presence_connections: 2, presence_members: 2, presence_subscribers: 5, publishers: 7, subscribers: 9 } } }) }
+
+  describe '#is_active' do
+    context 'when occupancy is active' do
+      subject { Ably::Models::ChannelStatus({ isActive: true, occupancy: { metrics: { connections: 1, presence_connections: 2, presence_members: 2, presence_subscribers: 5, publishers: 7, subscribers: 9 } } }) }
+
+      it 'should return true' do
+        expect(subject.is_active).to eq(true)
+      end
+    end
+
+    context 'when occupancy is not active' do
+      subject { Ably::Models::ChannelStatus({ isActive: false, occupancy: { metrics: { connections: 1, presence_connections: 2, presence_members: 2, presence_subscribers: 5, publishers: 7, subscribers: 9 } } }) }
+
+      it 'should return false' do
+        expect(subject.is_active).to eq(false)
+      end
+    end
+  end
+
+  describe '#occupancy' do
+    it 'should return occupancy object' do
+      expect(subject.occupancy).to be_a(Ably::Models::ChannelOccupancy)
+      expect(subject.occupancy.metrics.connections).to eq(1)
+      expect(subject.occupancy.metrics.presence_connections).to eq(2)
+      expect(subject.occupancy.metrics.presence_members).to eq(2)
+      expect(subject.occupancy.metrics.presence_subscribers).to eq(5)
+      expect(subject.occupancy.metrics.publishers).to eq(7)
+      expect(subject.occupancy.metrics.subscribers).to eq(9)
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ably
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.2.2
 platform: ruby
 authors:
 - Lewis Marshall
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-05-19 00:00:00.000000000 Z
+date: 2022-06-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: eventmachine
@@ -193,6 +193,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 3.11.0
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.1
 - !ruby/object:Gem::Dependency
   name: rspec-retry
   requirement: !ruby/object:Gem::Requirement
@@ -376,8 +390,12 @@ files:
 - lib/ably/exceptions.rb
 - lib/ably/logger.rb
 - lib/ably/models/auth_details.rb
+- lib/ably/models/channel_details.rb
+- lib/ably/models/channel_metrics.rb
+- lib/ably/models/channel_occupancy.rb
 - lib/ably/models/channel_options.rb
 - lib/ably/models/channel_state_change.rb
+- lib/ably/models/channel_status.rb
 - lib/ably/models/cipher_params.rb
 - lib/ably/models/connection_details.rb
 - lib/ably/models/connection_state_change.rb
@@ -516,7 +534,11 @@ files:
 - spec/unit/auth_spec.rb
 - spec/unit/logger_spec.rb
 - spec/unit/models/auth_details_spec.rb
+- spec/unit/models/channel_details_spec.rb
+- spec/unit/models/channel_metrics_spec.rb
+- spec/unit/models/channel_occupancy_spec.rb
 - spec/unit/models/channel_state_change_spec.rb
+- spec/unit/models/channel_status_spec.rb
 - spec/unit/models/cipher_params_spec.rb
 - spec/unit/models/connection_details_spec.rb
 - spec/unit/models/connection_state_change_spec.rb
@@ -633,7 +655,11 @@ test_files:
 - spec/unit/auth_spec.rb
 - spec/unit/logger_spec.rb
 - spec/unit/models/auth_details_spec.rb
+- spec/unit/models/channel_details_spec.rb
+- spec/unit/models/channel_metrics_spec.rb
+- spec/unit/models/channel_occupancy_spec.rb
 - spec/unit/models/channel_state_change_spec.rb
+- spec/unit/models/channel_status_spec.rb
 - spec/unit/models/cipher_params_spec.rb
 - spec/unit/models/connection_details_spec.rb
 - spec/unit/models/connection_state_change_spec.rb