sockudo 1.0.0

data/lib/sockudo/resource.rb

@@ -0,0 +1,36 @@
+module Sockudo
+  class Resource
+    def initialize(client, path)
+      @client = client
+      @path = path
+    end
+
+    def get(params)
+      create_request(:get, params).send_sync
+    end
+
+    def get_async(params)
+      create_request(:get, params).send_async
+    end
+
+    def post(params, headers = {})
+      body = MultiJson.encode(params)
+      create_request(:post, {}, body, headers).send_sync
+    end
+
+    def post_async(params, headers = {})
+      body = MultiJson.encode(params)
+      create_request(:post, {}, body, headers).send_async
+    end
+
+    private
+
+    def create_request(verb, params, body = nil, extra_headers = {})
+      Request.new(@client, verb, url, params, body, extra_headers)
+    end
+
+    def url
+      @_url ||= @client.url(@path)
+    end
+  end
+end

data/lib/sockudo/utils.rb

@@ -0,0 +1,34 @@
+module Sockudo
+  module Utils
+    def validate_socket_id(socket_id)
+      unless socket_id && /\A\d+\.\d+\z/.match(socket_id)
+        raise Sockudo::Error, "Invalid socket ID #{socket_id.inspect}"
+      end
+    end
+
+    # Compute authentication string required as part of the user authentication
+    # and subscription authorization endpoints responses.
+    # Generally the authenticate method should be used in preference to this one.
+    #
+    # @param socket_id [String] Each Sockudo socket connection receives a
+    #   unique socket_id. This is sent from sockudo.js to your server when
+    #   channel authentication is required.
+    # @param custom_string [String] Allows signing additional data
+    # @return [String]
+    #
+    # @raise [Sockudo::Error] if socket_id or custom_string invalid
+    #
+    def _authentication_string(socket_id, string_to_sign, token, custom_string = nil)
+      validate_socket_id(socket_id)
+
+      raise Sockudo::Error, 'Custom argument must be a string' unless custom_string.nil? || custom_string.is_a?(String)
+
+      Sockudo.logger.debug "Signing #{string_to_sign}"
+
+      digest = OpenSSL::Digest.new('SHA256')
+      signature = OpenSSL::HMAC.hexdigest(digest, token.secret, string_to_sign)
+
+      "#{token.key}:#{signature}"
+    end
+  end
+end

data/lib/sockudo/version.rb

@@ -0,0 +1,3 @@
+module Sockudo
+  VERSION = '1.0.0'
+end

data/lib/sockudo/webhook.rb

@@ -0,0 +1,110 @@
+require 'multi_json'
+require 'openssl'
+
+module Sockudo
+  # Used to parse and authenticate WebHooks
+  #
+  # @example Sinatra
+  #   post '/webhooks' do
+  #     webhook = Sockudo::WebHook.new(request)
+  #     if webhook.valid?
+  #       webhook.events.each do |event|
+  #         case event["name"]
+  #         when 'channel_occupied'
+  #           puts "Channel occupied: #{event["channel"]}"
+  #         when 'channel_vacated'
+  #           puts "Channel vacated: #{event["channel"]}"
+  #         end
+  #       end
+  #     else
+  #       status 401
+  #     end
+  #     return
+  #   end
+  #
+  class WebHook
+    attr_reader :key, :signature
+
+    # Provide either a Rack::Request or a Hash containing :key, :signature,
+    # :body, and :content_type (optional)
+    #
+    def initialize(request, client = Sockudo)
+      @client = client
+      # For Rack::Request and ActionDispatch::Request
+      if request.respond_to?(:env) && request.respond_to?(:content_type)
+        @key = request.env['HTTP_X_PUSHER_KEY']
+        @signature = request.env["HTTP_X_PUSHER_SIGNATURE"]
+        @content_type = request.content_type
+
+        request.body.rewind
+        @body = request.body.read
+        request.body.rewind
+      else
+        @key, @signature, @body = request.values_at(:key, :signature, :body)
+        @content_type = request[:content_type] || 'application/json'
+      end
+    end
+
+    # Returns whether the WebHook is valid by checking that the signature
+    # matches the configured key & secret. In the case that the webhook is
+    # invalid, the reason is logged
+    #
+    # @param extra_tokens [Hash] If you have extra tokens for your Sockudo app, you can specify them so that they're used to attempt validation.
+    #
+    def valid?(extra_tokens = nil)
+      extra_tokens = [extra_tokens] if extra_tokens.kind_of?(Hash)
+      if @key == @client.key
+        return check_signature(@client.secret)
+      elsif extra_tokens
+        extra_tokens.each do |token|
+          return check_signature(token[:secret]) if @key == token[:key]
+        end
+      end
+      Sockudo.logger.warn "Received webhook with unknown key: #{key}"
+      return false
+    end
+
+    # Array of events (as Hashes) contained inside the webhook
+    #
+    def events
+      data["events"]
+    end
+
+    # The time at which the WebHook was initially triggered by Sockudo, i.e.
+    # when the event occurred
+    #
+    # @return [Time]
+    #
+    def time
+      Time.at(data["time_ms"].to_f/1000)
+    end
+
+    # Access the parsed WebHook body
+    #
+    def data
+      @data ||= begin
+        case @content_type
+        when 'application/json'
+          MultiJson.decode(@body)
+        else
+          raise "Unknown Content-Type (#{@content_type})"
+        end
+      end
+    end
+
+    private
+
+    # Checks signature against secret and returns boolean
+    #
+    def check_signature(secret)
+      digest = OpenSSL::Digest::SHA256.new
+      expected = OpenSSL::HMAC.hexdigest(digest, secret, @body)
+      if @signature == expected
+        return true
+      else
+        Sockudo.logger.warn "Received WebHook with invalid signature: got #{@signature}, expected #{expected}"
+        return false
+      end
+    end
+  end
+end

data/lib/sockudo.rb

@@ -0,0 +1,77 @@
+autoload 'Logger', 'logger'
+require 'securerandom'
+require 'uri'
+require 'forwardable'
+
+require 'sockudo/utils'
+require 'sockudo/client'
+
+# Used for configuring API credentials and creating Channel objects
+#
+module Sockudo
+  # All errors descend from this class so they can be easily rescued
+  #
+  # @example
+  #   begin
+  #     Sockudo.trigger('channel_name', 'event_name, {:some => 'data'})
+  #   rescue Sockudo::Error => e
+  #     # Do something on error
+  #   end
+  class Error < RuntimeError; end
+  class AuthenticationError < Error; end
+  class ConfigurationError < Error
+    def initialize(key)
+      super "missing key `#{key}' in the client configuration"
+    end
+  end
+  class HTTPError < Error; attr_accessor :original_error; end
+
+  class << self
+    extend Forwardable
+
+    def_delegators :default_client, :scheme, :host, :port, :app_id, :key,
+                   :secret, :http_proxy, :encryption_master_key_base64
+    def_delegators :default_client, :scheme=, :host=, :port=, :app_id=, :key=,
+                   :secret=, :http_proxy=, :encryption_master_key_base64=
+
+    def_delegators :default_client, :authentication_token, :url, :cluster
+    def_delegators :default_client, :encrypted=, :url=, :cluster=
+    def_delegators :default_client, :timeout=, :connect_timeout=, :send_timeout=, :receive_timeout=, :keep_alive_timeout=
+
+    def_delegators :default_client, :get, :get_async, :post, :post_async
+    def_delegators :default_client, :channels, :channel_info, :channel_users
+    def_delegators :default_client, :trigger, :trigger_batch, :trigger_async, :trigger_batch_async
+    def_delegators :default_client, :authenticate, :webhook, :channel, :[]
+    def_delegators :default_client, :notify
+
+    # Generate a unique idempotency key (UUID v4) for use with trigger methods.
+    #
+    # @return [String] A UUID string
+    def generate_idempotency_key
+      SecureRandom.uuid
+    end
+
+    attr_writer :logger
+
+    def logger
+      @logger ||= begin
+        log = Logger.new($stdout)
+        log.level = Logger::INFO
+        log
+      end
+    end
+
+    def default_client
+      @default_client ||= begin
+        cli = Sockudo::Client
+        ENV['SOCKUDO_URL'] ? cli.from_env : cli.new
+      end
+    end
+  end
+end
+
+require 'sockudo/version'
+require 'sockudo/channel'
+require 'sockudo/request'
+require 'sockudo/resource'
+require 'sockudo/webhook'

metadata

@@ -0,0 +1,208 @@
+--- !ruby/object:Gem::Specification
+name: sockudo
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Sockudo
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2026-04-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: pusher-signature
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.8
+- !ruby/object:Gem::Dependency
+  name: httpclient
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+- !ruby/object:Gem::Dependency
+  name: em-http-request
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+- !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: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: rbnacl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.1'
+description: Wrapper for Sockudo REST API
+email:
+- support@sockudo.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- lib/sockudo.rb
+- lib/sockudo/channel.rb
+- lib/sockudo/client.rb
+- lib/sockudo/request.rb
+- lib/sockudo/resource.rb
+- lib/sockudo/utils.rb
+- lib/sockudo/version.rb
+- lib/sockudo/webhook.rb
+homepage: http://github.com/sockudo/sockudo-http-ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.6'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.20
+signing_key:
+specification_version: 4
+summary: Sockudo API client
+test_files: []