wampproto 0.1.0

data/sig/wampproto/message/result.rbs

@@ -0,0 +1,32 @@
+module Wampproto
+  module Message
+    # wamp call message
+    class Result < Base
+      @request_id: Integer
+
+      @details: Hash[Symbol, untyped]
+
+      @args: Array[untyped]
+
+      @kwargs: Hash[Symbol, untyped]
+
+      @payload: Array[untyped]
+
+      attr_reader request_id: Integer
+
+      attr_reader details: Hash[Symbol, untyped]
+
+      attr_reader procedure: String
+
+      attr_reader args: Array[untyped]
+
+      attr_reader kwargs: Hash[Symbol, untyped]
+
+      def initialize: (Integer request_id, Hash[Symbol, untyped] details, *Array[untyped] args, **Hash[Symbol, untyped] kwargs) -> void
+
+      def marshal: () -> Array[untyped]
+
+      def self.parse: (Array[untyped] wamp_message) -> Result
+    end
+  end
+end

data/sig/wampproto/message/subscribe.rbs

@@ -0,0 +1,24 @@
+module Wampproto
+  module Message
+    # abort message
+    class Subscribe < Base
+      @request_id: Integer
+
+      @options: Hash[Symbol, untyped]
+
+      @topic: String
+
+      attr_reader request_id: Integer
+
+      attr_reader options: Hash[Symbol, untyped]
+
+      attr_reader topic: String
+
+      def initialize: (Integer request_id, Hash[Symbol, untyped] options, String topic) -> void
+
+      def marshal: () -> ::Array[untyped]
+
+      def self.parse: (Array[untyped] wamp_message) -> Subscribe
+    end
+  end
+end

data/sig/wampproto/message/subscribed.rbs

@@ -0,0 +1,20 @@
+module Wampproto
+  module Message
+    # abort message
+    class Subscribed
+      @request_id: Integer
+
+      @subscription_id: Integer
+
+      attr_reader request_id: Integer
+
+      attr_reader subscription_id: Integer
+
+      def initialize: (Integer request_id, Integer subscription_id) -> void
+
+      def marshal: () -> ::Array[untyped]
+
+      def self.parse: (Array[untyped] wamp_message) -> Subscribed
+    end
+  end
+end

data/sig/wampproto/message/unregister.rbs

@@ -0,0 +1,20 @@
+module Wampproto
+  module Message
+    # unregister message
+    class Unregister < Base
+      @request_id: Integer
+
+      @registration_id: Integer
+
+      attr_reader request_id: Integer
+
+      attr_reader registration_id: Integer
+
+      def initialize: (Integer request_id, Integer registration_id) -> void
+
+      def marshal: () -> ::Array[untyped]
+
+      def self.parse: (Array[untyped] wamp_message) -> Unregister
+    end
+  end
+end

data/sig/wampproto/message/unregistered.rbs

@@ -0,0 +1,16 @@
+module Wampproto
+  module Message
+    # unregistered message
+    class Unregistered < Base
+      @request_id: Integer
+
+      attr_reader request_id: Integer
+
+      def initialize: (Integer request_id) -> void
+
+      def marshal: () -> ::Array[untyped]
+
+      def self.parse: (Array[untyped] wamp_message) -> Unregistered
+    end
+  end
+end

data/sig/wampproto/message/unsubscribe.rbs

@@ -0,0 +1,20 @@
+module Wampproto
+  module Message
+    # abort message
+    class Unsubscribe < Base
+      @request_id: Integer
+
+      @subscription_id: Integer
+
+      attr_reader request_id: Integer
+
+      attr_reader subscription_id: Integer
+
+      def initialize: (Integer request_id, Integer subscription_id) -> void
+
+      def marshal: () -> ::Array[untyped]
+
+      def self.parse: (Array[untyped] wamp_message) -> Unsubscribe
+    end
+  end
+end

data/sig/wampproto/message/unsubscribed.rbs

@@ -0,0 +1,16 @@
+module Wampproto
+  module Message
+    # Unsubscribed message
+    class Unsubscribed < Base
+      @request_id: Integer
+
+      attr_reader request_id: Integer
+
+      def initialize: (Integer request_id) -> void
+
+      def marshal: () -> ::Array[untyped]
+
+      def self.parse: (Array[untyped] wamp_message) -> Unsubscribed
+    end
+  end
+end

data/sig/wampproto/message/welcome.rbs

@@ -0,0 +1,36 @@
+module Wampproto
+  module Message
+    # welcome message
+    class Welcome < Base
+      @session_id: Integer
+
+      @details: Hash[Symbol, untyped]
+
+      @authrole: String
+
+      @authid: String
+
+      @authmethod: String
+
+      @authextra: Hash[Symbol, untyped]
+
+      attr_reader session_id: Integer
+
+      attr_reader details: Hash[Symbol, untyped]
+
+      def initialize: (Integer session_id, ?::Hash[Symbol, untyped] details) -> void
+
+      def marshal: () -> ::Array[untyped]
+
+      def authrole: () -> String
+
+      def authid: () -> String
+
+      def authmethod: () -> String
+
+      def authextra: () -> (Hash[Symbol, untyped] | nil)
+
+      def self.parse: (Array[untyped] wamp_message) -> Welcome
+    end
+  end
+end

data/sig/wampproto/message/yield.rbs

@@ -0,0 +1,30 @@
+module Wampproto
+  module Message
+    # yield message
+    class Yield < Base
+      @request_id: Integer
+
+      @options: Hash[Symbol, untyped]
+
+      @args: Array[untyped]
+
+      @kwargs: Hash[Symbol, untyped]
+
+      @payload: Array[untyped]
+
+      attr_reader request_id: Integer
+
+      attr_reader options: Hash[Symbol, untyped]
+
+      attr_reader args: Array[untyped]
+
+      attr_reader kwargs: Hash[Symbol, untyped]
+
+      def initialize: (Integer request_id, Hash[Symbol, untyped] options, *Array[untyped] args, **Hash[Symbol, untyped] kwargs) -> void
+
+      def marshal: () -> Array[untyped]
+
+      def self.parse: (Array[untyped] wamp_message) -> Yield
+    end
+  end
+end

data/sig/wampproto/message.rbs

@@ -0,0 +1,59 @@
+module Wampproto
+  # message root
+  module Message
+    module Type
+      HELLO: 1
+
+      WELCOME: 2
+
+      ABORT: 3
+
+      CHALLENGE: 4
+
+      AUTHENTICATE: 5
+
+      GOODBYE: 6
+
+      ERROR: 8
+
+      PUBLISH: 16
+
+      PUBLISHED: 17
+
+      SUBSCRIBE: 32
+
+      SUBSCRIBED: 33
+
+      UNSUBSCRIBE: 34
+
+      UNSUBSCRIBED: 35
+
+      EVENT: 36
+
+      CALL: 48
+
+      CANCEL: 49
+
+      RESULT: 50
+
+      REGISTER: 64
+
+      REGISTERED: 65
+
+      UNREGISTER: 66
+
+      UNREGISTERED: 67
+
+      INVOCATION: 68
+
+      INTERRUPT: 69
+
+      YIELD: 70
+    end
+
+    HANDLER: ::Hash[Integer, singleton(Message::Base)]
+
+    def self.resolve: (Array[untyped] wamp_message) -> Message::Base
+  end
+end
+

data/sig/wampproto/message_with_recipient.rbs

@@ -0,0 +1,15 @@
+module Wampproto
+  # handler class for dealer and broker responses
+  class MessageWithRecipient
+    @message: untyped
+
+    @recipient: Integer
+
+    attr_reader message: untyped
+
+    attr_reader recipient: Integer
+
+    def initialize: (untyped message, Integer recipient) -> void
+  end
+end
+

data/sig/wampproto/serializer/cbor.rbs

@@ -0,0 +1,10 @@
+module Wampproto
+  module Serializer
+    # Add common API for serializer
+    class Cbor
+      def self.serialize: (Message::Base message) -> Array[untyped]
+
+      def self.deserialize: (Array[Integer] message) -> Message::Base
+    end
+  end
+end

data/sig/wampproto/serializer/json.rbs

@@ -0,0 +1,11 @@
+module Wampproto
+  module Serializer
+    # Add common API for serializer
+    class JSON
+      def self.serialize: (Message::Base message) -> String
+
+      def self.deserialize: (String message) -> Message::Base
+    end
+  end
+end
+

data/sig/wampproto/serializer/msgpack.rbs

@@ -0,0 +1,11 @@
+module Wampproto
+  module Serializer
+    # Add common API for serializer
+    class Msgpack
+      def self.serialize: (Message::Base message) -> Array[untyped]
+
+      def self.deserialize: (Array[untyped] message) -> Message::Base
+    end
+  end
+end
+

data/sig/wampproto/session.rbs

@@ -0,0 +1,43 @@
+module Wampproto
+  # Session
+  class Session
+    type serializerTypes = (singleton(Serializer::JSON) | singleton(Serializer::Msgpack) | singleton(Serializer::Cbor))
+
+    @serializer: serializerTypes
+    @call_requests: Hash[Integer, Integer]
+    @register_requests: Hash[Integer, Integer]
+    @registrations: Hash[Integer, Integer]
+    @invocation_requests: Hash[Integer, Integer]
+    @unregister_requests: Hash[Integer, Integer]
+    @publish_requests: Hash[Integer, Integer]
+    @subscribe_requests: Hash[Integer, Integer]
+    @subscriptions: Hash[Integer, Integer]
+    @unsubscribe_requests: Hash[Integer, Integer]
+
+    attr_reader serializer: serializerTypes
+    attr_reader call_requests: Hash[Integer, Integer]
+    attr_reader register_requests: Hash[Integer, Integer]
+    attr_reader registrations: Hash[Integer, Integer]
+    attr_reader invocation_requests: Hash[Integer, Integer]
+    attr_reader unregister_requests: Hash[Integer, Integer]
+    attr_reader publish_requests: Hash[Integer, Integer]
+    attr_reader subscribe_requests: Hash[Integer, Integer]
+    attr_reader subscriptions: Hash[Integer, Integer]
+    attr_reader unsubscribe_requests: Hash[Integer, Integer]
+
+    def initialize: (?serializerTypes serializer) -> void
+
+    ACCESSORS: ::Array[:call_requests | :register_requests | :registrations | :invocation_requests | :unregister_requests | :publish_requests | :subscribe_requests | :subscriptions | :unsubscribe_requests]
+
+    def send_message: (Message::Base msg) -> untyped
+
+    def receive: (untyped data) -> untyped
+
+    def receive_message: (Message::Base msg) -> untyped
+
+    private
+
+    def init_state: () -> untyped
+  end
+end
+

data/sig/wampproto/session_details.rbs

@@ -0,0 +1,25 @@
+module Wampproto
+  # Session Details
+  class SessionDetails
+    @session_id: Integer
+
+    @realm: String
+
+    @authid: String
+
+    @authrole: String
+
+    attr_reader session_id: Integer
+
+    attr_reader realm: String
+
+    attr_reader authid: String
+
+    attr_reader authrole: String
+
+    def initialize: (Integer session_id, String realm, String authid, String authrole) -> void
+
+    def ==: (SessionDetails other) -> bool
+  end
+end
+

data/sig/wampproto/validate.rbs

@@ -0,0 +1,18 @@
+module Wampproto
+  # validation
+  class Validate
+    def self.int!: (String name, Integer value) -> Integer
+
+    def self.string!: (String name, String value) -> String
+
+    def self.hash!: (String name, Hash[Symbol, untyped] value) -> Hash[Symbol, untyped]
+
+    def self.array!: (String name, Array[untyped] value) -> Array[untyped]
+
+    def self.length!: (Array[untyped] array, Integer expected_length) -> Array[untyped]
+
+    def self.greater_than_equal!: (Array[untyped] array, untyped expected_length) -> Array[untyped]
+
+    def self.options!: (Hash[Symbol, untyped] options, Array[Symbol] valid_keys) -> Hash[Symbol, untyped]
+  end
+end

data/sig/wampproto.rbs

@@ -0,0 +1,17 @@
+module Wampproto
+  VERSION: String
+  class Error < StandardError
+  end
+
+  # ProtocolViolation Exception
+  class ProtocolViolation < StandardError
+    @uri: String
+
+    attr_reader uri: String
+
+    def initialize: (?::String msg, ?::String uri) -> void
+  end
+
+  class ValueError < StandardError
+  end
+end

data/wampproto.gemspec

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative "lib/wampproto/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "wampproto"
+  spec.version = Wampproto::VERSION
+  spec.authors = ["Ismail Akram"]
+  spec.email = ["rubyonrails3@gmail.com"]
+
+  spec.summary = "Sans-IO WAMP protocol implementation in Ruby"
+  spec.description = "Sans-IO WAMP protocol implementation in Ruby"
+  spec.homepage = "https://github.com/xconnio/wampproto.rb"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 3.3.0"
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to your gem server 'https://example.com'"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["rubygems_mfa_required"] = "true"
+  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) ||
+        f.start_with?(*%w[bin/ test/ spec/ features/ .git .github appveyor Gemfile])
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "cbor", "~> 0.5.9.8"
+  spec.add_dependency "ed25519", "~> 1.3"
+  spec.add_dependency "msgpack", "~> 1.7.2"
+end

metadata

@@ -0,0 +1,196 @@
+--- !ruby/object:Gem::Specification
+name: wampproto
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ismail Akram
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-05-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: cbor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.9.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.9.8
+- !ruby/object:Gem::Dependency
+  name: ed25519
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: msgpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.7.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.7.2
+description: Sans-IO WAMP protocol implementation in Ruby
+email:
+- rubyonrails3@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE
+- README.md
+- Rakefile
+- Steepfile
+- lib/wampproto.rb
+- lib/wampproto/acceptor.rb
+- lib/wampproto/acceptor/authenticator.rb
+- lib/wampproto/acceptor/request.rb
+- lib/wampproto/acceptor/response.rb
+- lib/wampproto/auth.rb
+- lib/wampproto/auth/anonymous.rb
+- lib/wampproto/auth/base.rb
+- lib/wampproto/auth/cra.rb
+- lib/wampproto/auth/cryptosign.rb
+- lib/wampproto/auth/helpers.rb
+- lib/wampproto/auth/ticket.rb
+- lib/wampproto/broker.rb
+- lib/wampproto/dealer.rb
+- lib/wampproto/id_generator.rb
+- lib/wampproto/joiner.rb
+- lib/wampproto/message.rb
+- lib/wampproto/message/abort.rb
+- lib/wampproto/message/authenticate.rb
+- lib/wampproto/message/base.rb
+- lib/wampproto/message/call.rb
+- lib/wampproto/message/challenge.rb
+- lib/wampproto/message/error.rb
+- lib/wampproto/message/event.rb
+- lib/wampproto/message/goodbye.rb
+- lib/wampproto/message/hello.rb
+- lib/wampproto/message/invocation.rb
+- lib/wampproto/message/publish.rb
+- lib/wampproto/message/published.rb
+- lib/wampproto/message/register.rb
+- lib/wampproto/message/registered.rb
+- lib/wampproto/message/result.rb
+- lib/wampproto/message/subscribe.rb
+- lib/wampproto/message/subscribed.rb
+- lib/wampproto/message/unregister.rb
+- lib/wampproto/message/unregistered.rb
+- lib/wampproto/message/unsubscribe.rb
+- lib/wampproto/message/unsubscribed.rb
+- lib/wampproto/message/welcome.rb
+- lib/wampproto/message/yield.rb
+- lib/wampproto/message_with_recipient.rb
+- lib/wampproto/serializer.rb
+- lib/wampproto/serializer/cbor.rb
+- lib/wampproto/serializer/json.rb
+- lib/wampproto/serializer/msgpack.rb
+- lib/wampproto/session.rb
+- lib/wampproto/session_details.rb
+- lib/wampproto/validate.rb
+- lib/wampproto/version.rb
+- sig/cbor.rbs
+- sig/ed25519/signing_key.rbs
+- sig/ed25519/verify_key.rbs
+- sig/message_pack.rbs
+- sig/wampproto.rbs
+- sig/wampproto/acceptor.rbs
+- sig/wampproto/acceptor/authenticator.rbs
+- sig/wampproto/acceptor/request.rbs
+- sig/wampproto/acceptor/response.rbs
+- sig/wampproto/auth/anonymous.rbs
+- sig/wampproto/auth/base.rbs
+- sig/wampproto/auth/cra.rbs
+- sig/wampproto/auth/cryptosign.rbs
+- sig/wampproto/auth/helpers.rbs
+- sig/wampproto/auth/ticket.rbs
+- sig/wampproto/broker.rbs
+- sig/wampproto/dealer.rbs
+- sig/wampproto/id_generator.rbs
+- sig/wampproto/joiner.rbs
+- sig/wampproto/message.rbs
+- sig/wampproto/message/abort.rbs
+- sig/wampproto/message/authenticate.rbs
+- sig/wampproto/message/base.rbs
+- sig/wampproto/message/call.rbs
+- sig/wampproto/message/challenge.rbs
+- sig/wampproto/message/error.rbs
+- sig/wampproto/message/event.rbs
+- sig/wampproto/message/goodbye.rbs
+- sig/wampproto/message/hello.rbs
+- sig/wampproto/message/invocation.rbs
+- sig/wampproto/message/publish.rbs
+- sig/wampproto/message/published.rbs
+- sig/wampproto/message/register.rbs
+- sig/wampproto/message/registered.rbs
+- sig/wampproto/message/result.rbs
+- sig/wampproto/message/subscribe.rbs
+- sig/wampproto/message/subscribed.rbs
+- sig/wampproto/message/unregister.rbs
+- sig/wampproto/message/unregistered.rbs
+- sig/wampproto/message/unsubscribe.rbs
+- sig/wampproto/message/unsubscribed.rbs
+- sig/wampproto/message/welcome.rbs
+- sig/wampproto/message/yield.rbs
+- sig/wampproto/message_with_recipient.rbs
+- sig/wampproto/serializer/cbor.rbs
+- sig/wampproto/serializer/json.rbs
+- sig/wampproto/serializer/msgpack.rbs
+- sig/wampproto/session.rbs
+- sig/wampproto/session_details.rbs
+- sig/wampproto/validate.rbs
+- wampproto.gemspec
+homepage: https://github.com/xconnio/wampproto.rb
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/xconnio/wampproto.rb
+  source_code_uri: https://github.com/xconnio/wampproto.rb
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.27
+signing_key:
+specification_version: 4
+summary: Sans-IO WAMP protocol implementation in Ruby
+test_files: []