blackevin 0.1.1

data/lib/blackevin/types.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+module Blackevin
+  # A stored message, as +channel.history+ returns it.
+  Message = Struct.new(:channel, :name, :data, :connection_id, :timestamp, keyword_init: true) do
+    def self.from_h(hash)
+      new(
+        channel: hash['channel'],
+        name: hash['name'],
+        data: hash['data'],
+        connection_id: hash['connectionId'],
+        timestamp: hash['timestamp']
+      )
+    end
+
+    # @return [Time, nil]
+    def time = timestamp&.then { Time.at(_1 / 1000.0) }
+  end
+
+  # Someone present on a channel right now.
+  PresenceMember = Struct.new(:client_id, :connection_id, :data, :updated_at, keyword_init: true) do
+    def self.from_h(hash)
+      new(
+        client_id: hash['clientId'],
+        connection_id: hash['connectionId'],
+        data: hash['data'],
+        updated_at: hash['updatedAt']
+      )
+    end
+  end
+
+  # A past enter, leave or update.
+  PresenceEvent = Struct.new(:channel, :action, :client_id, :connection_id, :data, :timestamp, keyword_init: true) do
+    def self.from_h(hash)
+      new(
+        channel: hash['channel'],
+        action: hash['action'],
+        client_id: hash['clientId'],
+        connection_id: hash['connectionId'],
+        data: hash['data'],
+        timestamp: hash['timestamp']
+      )
+    end
+
+    # @return [Time, nil]
+    def time = timestamp&.then { Time.at(_1 / 1000.0) }
+  end
+
+  # An account queue. Addressed by {#id} everywhere; {#name} is immutable and
+  # is what a worker consumes from on the broker.
+  Queue = Struct.new(:id, :account_id, :name, :max_length, :enabled, keyword_init: true) do
+    def self.from_h(hash)
+      new(
+        id: hash['id'],
+        account_id: hash['accountId'],
+        name: hash['name'],
+        max_length: hash['maxLength'],
+        enabled: hash['enabled']
+      )
+    end
+
+    def enabled? = enabled == true
+  end
+
+  # Copies messages from channels matching {#source_pattern} into a queue.
+  QueueRule = Struct.new(:id, :account_id, :queue_name, :source_pattern, :filter, :enabled, keyword_init: true) do
+    def self.from_h(hash)
+      new(
+        id: hash['id'],
+        account_id: hash['accountId'],
+        queue_name: hash['queueName'],
+        source_pattern: hash['sourcePattern'],
+        filter: hash['filter'],
+        enabled: hash['enabled']
+      )
+    end
+  end
+end

data/lib/blackevin/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Blackevin
+  VERSION = '0.1.1'
+end

data/lib/blackevin.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require_relative 'blackevin/version'
+require_relative 'blackevin/errors'
+require_relative 'blackevin/api_key'
+require_relative 'blackevin/endpoints'
+require_relative 'blackevin/token_request'
+require_relative 'blackevin/token_details'
+require_relative 'blackevin/types'
+require_relative 'blackevin/transport'
+require_relative 'blackevin/configuration'
+require_relative 'blackevin/rest'
+require_relative 'blackevin/rest/auth'
+require_relative 'blackevin/rest/channels'
+require_relative 'blackevin/rest/clients'
+require_relative 'blackevin/rest/queues'
+require_relative 'blackevin/token_endpoint'
+
+# Server-side SDK for Blackevin: sign token requests, publish, read history and
+# presence, manage queues. Standard library only.
+#
+#   Blackevin.configure { |config| config.key = ENV.fetch("BLACKEVIN_KEY") }
+#
+#   Blackevin.rest.channels.get("room:42").publish("greeting", {text: "hi"})
+module Blackevin
+  @mutex = Mutex.new
+
+  class << self
+    # @return [Blackevin::Configuration]
+    def configuration
+      @mutex.synchronize { @configuration ||= Configuration.new }
+    end
+
+    # @yieldparam config [Blackevin::Configuration]
+    # @return [Blackevin::Configuration]
+    def configure
+      yield configuration
+
+      @mutex.synchronize { @rest = nil }
+
+      configuration
+    end
+
+    # The process-wide client, built from {configuration} on first use.
+    #
+    # @return [Blackevin::Rest]
+    def rest
+      options = configuration.to_rest_options
+
+      @mutex.synchronize { @rest ||= Rest.new(**options) }
+    end
+
+    # Forgets the configuration and the client. For test suites.
+    def reset!
+      @mutex.synchronize do
+        @configuration = nil
+        @rest = nil
+      end
+    end
+  end
+end
+
+require_relative 'blackevin/railtie' if defined?(Rails::Railtie)

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: blackevin
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Blackevin
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.13'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.13'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: standard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+description: 'Sign token requests, publish, read history and presence, and manage
+  queues on Blackevin. Standard library only: no runtime dependencies. Ruby 3.0 and
+  up. Works in Rails, Sinatra, Hanami or plain Ruby.'
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- blackevin.gemspec
+- lib/blackevin.rb
+- lib/blackevin/api_key.rb
+- lib/blackevin/configuration.rb
+- lib/blackevin/endpoints.rb
+- lib/blackevin/errors.rb
+- lib/blackevin/railtie.rb
+- lib/blackevin/rest.rb
+- lib/blackevin/rest/auth.rb
+- lib/blackevin/rest/channels.rb
+- lib/blackevin/rest/clients.rb
+- lib/blackevin/rest/queues.rb
+- lib/blackevin/token_details.rb
+- lib/blackevin/token_endpoint.rb
+- lib/blackevin/token_request.rb
+- lib/blackevin/transport.rb
+- lib/blackevin/types.rb
+- lib/blackevin/version.rb
+homepage: https://blackevin.com
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+  documentation_uri: https://docs.blackevin.com
+  source_code_uri: https://github.com/thadeu/blackevin-ruby
+  changelog_uri: https://github.com/thadeu/blackevin-ruby/blob/main/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: Blackevin Ruby SDK
+test_files: []