rubycent 0.1.0

data/lib/rubycent/error.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Rubycent
+  # Rubycent::Error
+  #
+  #   Wrapper for all rubycent errors(failures).
+  #
+  class Error < StandardError; end
+end

data/lib/rubycent/errors/network_error.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Rubycent
+  # Rubycent::NetworkError
+  #
+  #   Raised when request to Centrifugo API failed due the network problems.
+  #
+  class NetworkError < Error
+    attr_accessor :original_error
+  end
+end

data/lib/rubycent/errors/request_error.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Rubycent
+  # Rubycent::RequestError
+  #
+  #   Raised when request to Centrifugo API failed in some way.
+  #
+  class RequestError < Error
+    attr_reader :message, :status
+
+    def initialize(message, status)
+      @message = message
+      @status = status
+
+      super(message)
+    end
+  end
+end

data/lib/rubycent/errors/response_error.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Rubycent
+  # Rubycent::ResponseError
+  #
+  #   Raised when response from Centrifugo contains any error as result of API command execution.
+  #
+  class ResponseError < Error
+    attr_reader :message, :code
+
+    def initialize(error_data)
+      @message, @code = error_data.values_at('message', 'code')
+
+      super(@message)
+    end
+  end
+end

data/lib/rubycent/query.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require 'uri'
+
+require 'rubycent/request'
+
+module Rubycent
+  # Rubycent::Query
+  #
+  #   Centrifugo API request configuration and execution
+  #
+  class Query
+    attr_reader :client
+
+    # @param client [Rubycent::Client]
+    #   Rubycent client that contains all the configuration
+    #
+    def initialize(client)
+      @client = client
+    end
+
+    # Perform centrifugo API call
+    #
+    # @param method [String]
+    #   Centrifugo command, represents centrifugo actions such as 'publish', 'broadcast', e.t.c.
+    #
+    # @param data [Hash]
+    #   Any data that will be sent as command parameters
+    #
+    # @return [Hash] Parser request responce
+    #
+    # @raise [Rubycent::Error, Rubycent::NetworkError, Rubycent::RequestError, Rubycent::ResponseError]
+    #
+    def execute(method, data)
+      body = dump_body(method, data)
+
+      params = {
+        timeout: client.timeout,
+        open_timeout: client.open_timeout
+      }
+
+      headers = build_headers(client.api_key)
+      endpoint = build_endpoint(client.host, client.port, client.scheme.to_s)
+
+      Rubycent::Request.new(endpoint, params, body, headers).post
+    end
+
+    private
+
+    def dump_body(method, params)
+      MultiJson.dump(method: method, params: params)
+    end
+
+    def build_endpoint(host, port, scheme)
+      ::URI::Generic.build(scheme: scheme, host: host, port: port, path: '/api').to_s
+    end
+
+    def build_headers(api_key)
+      {
+        'Content-Type' => 'application/json',
+        'Authorization' => "apikey #{api_key}"
+      }
+    end
+  end
+end

data/lib/rubycent/request.rb

@@ -0,0 +1,117 @@
+# frozen_string_literal: true
+
+require 'faraday'
+
+module Rubycent
+  # Rubycent::Request
+  #
+  #   Holds request call and response handling logic
+  #
+  class Request
+    attr_accessor :endpoint, :params, :body, :headers
+
+    # @param endpoint [String] Centrifugo API endpoint
+    #
+    # @param params [Hash] Additional params to configure request.
+    #
+    # @option params [Integer] :timeout
+    #   Number of seconds to wait for the connection to open.
+    #
+    # @option params [Integer] :open_timeout
+    #   Number of seconds to wait for one block to be read.
+    #
+    # @param body [String]
+    #   (default: nil) JSON string representing request parameters.
+    #
+    # @param headers [Hash]
+    #   (default: {}) Additional HTTP headers(such as Content-Type and Authorization).
+    #
+    def initialize(endpoint, params, body = nil, headers = {})
+      @endpoint = endpoint
+      @params = params
+      @body = body
+      @headers = headers
+    end
+
+    # Perform POST request to centrifugo API
+    #
+    # @raise [Rubycent::Error, Rubycent::NetworkError, Rubycent::RequestError, Rubycent::ResponseError]
+    #
+    # @return [Hash] Parsed response body
+    #
+    def post
+      response = rest_client.post(@endpoint) do |request|
+        configure_request(request: request, body: body, headers: headers)
+      end
+
+      handle_response(response)
+    rescue Faraday::ConnectionFailed => e
+      handle_error(e)
+    end
+
+    private
+
+    def rest_client
+      Faraday.new do |faraday|
+        faraday.adapter(Rubycent.request_adapter)
+        faraday.headers = @headers
+      end
+    end
+
+    def configure_request(request: nil, headers: nil, body: nil)
+      return if request.nil?
+
+      request.headers.merge!(headers) if headers
+      request.body = body if body
+
+      request.options.timeout = @params[:timeout]
+      request.options.open_timeout = @params[:open_timeout]
+    end
+
+    def handle_response(response)
+      response.status == 200 ? parse_response(response) : raise_error(response)
+    end
+
+    def parse_response(response)
+      MultiJson.load(response.body).tap do |data|
+        raise ResponseError, data['error'] if data.key?('error')
+      end
+    end
+
+    def raise_error(response)
+      status_code = response.status
+      body = response.body
+
+      message = resolve_error_message(status_code, body)
+
+      case status_code
+      when 400..404
+        raise RequestError.new(message, status_code)
+      else
+        raise Error, message
+      end
+    end
+
+    def resolve_error_message(status, additional_info = nil)
+      error_messages = {
+        400 => "Bad request: #{additional_info}",
+        401 => 'Invalid API key',
+        404 => 'Route not found'
+      }
+
+      error_messages.fetch(status) do
+        "Status: #{status}. Unknown error: #{additional_info}"
+      end
+    end
+
+    def handle_error(error)
+      message = "#{error.message} (#{error.class})"
+
+      wrapper = NetworkError.new(message).tap do |w|
+        w.original_error = error
+      end
+
+      raise wrapper
+    end
+  end
+end

data/lib/rubycent/version.rb

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

data/rubycent.gemspec

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rubycent/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'rubycent'
+  spec.version       = Rubycent::VERSION
+  spec.authors       = ['Warshavski']
+  spec.email         = ['p.warshavski@gmail.com']
+
+  spec.summary       = 'Ruby client to communicate with Centrifugo v2 HTTP API'
+  spec.description   = 'Ruby client to communicate with Centrifugo v2 HTTP API'
+  spec.homepage      = 'https://github.com/Warshavski/rubycent'
+  spec.license       = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['homepage_uri'] = spec.homepage
+    spec.metadata['source_code_uri'] = 'https://github.com/Warshavski/rubycent'
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+      'public gem pushes.'
+  end
+
+  # 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(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'faraday', '~> 0.16.1'
+  spec.add_dependency 'jwt', '~> 2.2.1'
+  spec.add_dependency 'multi_json', '~> 1.13.1'
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'webmock', '~> 3.7.5'
+end

metadata

@@ -0,0 +1,163 @@
+--- !ruby/object:Gem::Specification
+name: rubycent
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Warshavski
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-09-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.1
+- !ruby/object:Gem::Dependency
+  name: jwt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.1
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.13.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.13.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.7.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.7.5
+description: Ruby client to communicate with Centrifugo v2 HTTP API
+email:
+- p.warshavski@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rubycent.rb
+- lib/rubycent/client.rb
+- lib/rubycent/error.rb
+- lib/rubycent/errors/network_error.rb
+- lib/rubycent/errors/request_error.rb
+- lib/rubycent/errors/response_error.rb
+- lib/rubycent/query.rb
+- lib/rubycent/request.rb
+- lib/rubycent/version.rb
+- rubycent.gemspec
+homepage: https://github.com/Warshavski/rubycent
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/Warshavski/rubycent
+  source_code_uri: https://github.com/Warshavski/rubycent
+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: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Ruby client to communicate with Centrifugo v2 HTTP API
+test_files: []