ably-pubsub-server 0.0.1.pre

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ad6b933bae9be99149ec75b5a4925fb23b3da6376ac216d04201d138238dfeea
+  data.tar.gz: d5c972097fc66b5433a8439de8f8489b2fbb56a42930cd7cc9b56aaf7e657c91
+SHA512:
+  metadata.gz: e608ed19fb0ca50835a40b5dbdff61a61b367d2026853ccb4026c390f8b0017f152a6affba33efa2c06252616e5c37b4c029ade7494ad803d5d0715260ee5a44
+  data.tar.gz: a575114f1cd9570ec969eea1a52a829771cb3d4625efd0453006d67e0b701613938f3f10a6711b26ebe7ec72c1a9288cf79f72a515a8325d3980246df13a2039

data/README.md

@@ -0,0 +1,33 @@
+# ably-pubsub-server
+
+Ably Pub/Sub client for servers: backend services and other trusted runtimes.
+
+Installing this package declares that its traffic originates from the server side —
+[MAU classification](https://ably.com/pricing) is a side effect of the install decision.
+
+## Installation
+
+```ruby
+gem 'ably-pubsub-server'
+```
+
+## Usage
+
+The factory functions are the only recommended entry points:
+
+```ruby
+require 'ably/pubsub/server'
+
+# Stateless HTTP client: publish, history, presence reads, token issuance
+http_client = Ably::PubSub::Server.create_http_client('your-api-key')
+http_client.channels.get('example').publish('event', 'payload')
+
+# Stateful realtime client: a persistent, live connection (EventMachine-based)
+realtime_client = Ably::PubSub::Server.create_realtime_client('your-api-key')
+```
+
+Both factories accept everything the underlying constructors accept: an options `Hash`,
+an API key `String`, or a token `String`.
+
+This gem is built on `ably-pubsub-core`, an internal implementation package. Depend on
+this gem, not on the core.

data/lib/ably/pubsub/server/version.rb

@@ -0,0 +1,9 @@
+module Ably
+  module PubSub
+    module Server
+      # Must match Ably::VERSION in ably-pubsub-core: core and server are released in
+      # lockstep at the same version (PDR-091b). The release workflow and a spec assert this.
+      VERSION = '0.0.1.pre'
+    end
+  end
+end

data/lib/ably/pubsub/server.rb

@@ -0,0 +1,76 @@
+require 'ably'
+require 'ably/pubsub/server/version'
+
+module Ably
+  module PubSub
+    # The Ably Pub/Sub SDK for servers. The factory functions here are the only
+    # recommended entry points of the +ably-pubsub-server+ gem.
+    module Server
+      # The agent identifier declaring the server side.
+      #
+      # The `-server` suffix is load-bearing, not cosmetic. On API-key auth the realtime
+      # system grants the MAU server exemption by matching an agent entry ending in
+      # `-server`, and an identifier that is not yet in the ably-common registry is
+      # classified by that suffix alone. Renaming it without preserving the suffix
+      # silently reclassifies every client this package constructs.
+      #
+      # The entry is stamped WITHOUT a version, matching its registration in the
+      # ably-common agents registry (a pure flag, like `browser`): under lockstep
+      # versioning a version here always duplicates the ably-pubsub-ruby entry beside it,
+      # which keeps carrying identity, version and support status. Wire shape:
+      #   ably-pubsub-ruby/2.0.0 ruby/3.3.0 ably-pubsub-server
+      SERVER_AGENT_IDENTIFIER = 'ably-pubsub-server'
+
+      class << self
+        # Creates a stateless HTTP (REST) client declaring the server side.
+        #
+        # Accepts everything {Ably::Rest::Client#initialize} accepts: an options Hash,
+        # an API key String, or a token String.
+        #
+        # @return [Ably::Rest::Client]
+        def create_http_client(options)
+          Ably::Rest::Client.new(options_with_side_agent(options))
+        end
+
+        # Creates a stateful realtime client declaring the server side.
+        #
+        # Accepts everything {Ably::Realtime::Client#initialize} accepts: an options Hash,
+        # an API key String, or a token String.
+        #
+        # @return [Ably::Realtime::Client]
+        def create_realtime_client(options)
+          Ably::Realtime::Client.new(options_with_side_agent(options))
+        end
+
+        private
+
+        # Returns a copy of the caller's options carrying the agent entry that declares
+        # this package's side.
+        #
+        # The caller's own +:agents+ entries are preserved, so an SDK layered on top of
+        # this package keeps its attribution. The side entry is merged last and so wins a
+        # collision on its own identifier: which side the package declares is the
+        # package's to state, not the caller's to redefine.
+        #
+        # A nil argument passes through unchanged so the caller gets the core
+        # constructor's own initialization error rather than a vaguer failure later.
+        def options_with_side_agent(options)
+          return options if options.nil?
+
+          options = if options.kind_of?(String)
+            if options.match(Ably::Auth::API_KEY_REGEX)
+              { key: options }
+            else
+              { token: options }
+            end
+          else
+            options.clone
+          end
+
+          agents = options[:agents].to_h.merge(SERVER_AGENT_IDENTIFIER => nil)
+          options.merge(agents: agents)
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification
+name: ably-pubsub-server
+version: !ruby/object:Gem::Version
+  version: 0.0.1.pre
+platform: ruby
+authors:
+- Ably
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2026-09-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ably-pubsub-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.0.1.pre
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.0.1.pre
+description: 'Ably Pub/Sub client for servers: backend services and other trusted
+  runtimes. Construct clients with Ably::PubSub::Server.create_http_client or Ably::PubSub::Server.create_realtime_client.'
+email:
+- support@ably.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/ably/pubsub/server.rb
+- lib/ably/pubsub/server/version.rb
+homepage: https://github.com/ably/ably-pubsub-ruby
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.22
+signing_key:
+specification_version: 4
+summary: Ably Pub/Sub client for servers
+test_files: []