kybus-client 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 780ba9b783a2b37eec363ae19830e75eb244ba3816fcffb273a12234d4d9a15a
+  data.tar.gz: 45252fb2cf4c320df1314003d834fbd62d830bfe09a33dc45e0c86a8e81b138c
+SHA512:
+  metadata.gz: 32969dc8079c3c2f000dbf9e15d2b8606fc22c78464e2a8e90fdf201ccf83fefbb9f533849c5e869894c223551d965ec64dda518fc155ffac17cd7b45bac81a3
+  data.tar.gz: 826255a577bdfe2a6a57f9d44898f591b81053fd7d2266f32ff64265f95acf67958ec51c784e80cf022d49716d684743864597b8994b9f46442204db4ba0a909

data/lib/kybus/client.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require_relative 'client/rest_client'
+require_relative 'client/version'

data/lib/kybus/client/format/format.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require_relative 'json_format'
+require_relative 'url_encoded'
+
+module Kybus
+  module Client
+    # Singleton storing all the formats implemented for http clients.
+    module Format
+      extend Kybus::DRY::ResourceInjector
+      class << self
+        def build(config)
+          resource(:formats, config[:format] || 'json').new
+        end
+
+        def register_format(name, klass)
+          register(:formats, name, klass)
+        end
+      end
+      register_format('json', JSONFormat)
+      register_format('url_encoded', URLEncodedFormat)
+    end
+  end
+end

data/lib/kybus/client/format/json_format.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module Kybus
+  module Client
+    module Format
+      # Implements JSON format for http clients.
+      class JSONFormat
+        def pack(data)
+          {
+            body: data.to_json,
+            headers: { 'Content-type' => 'application/json; charset=UTF-8',
+                       'User-Agent' => 'Ruby Kybus Client' }
+          }
+        end
+
+        def unpack(data)
+          unformat(data)
+        end
+
+        def unformat(msg)
+          JSON.parse(msg, symbolize_names: true)
+        end
+      end
+    end
+  end
+end

data/lib/kybus/client/format/url_encoded.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require_relative 'json_format'
+
+module Kybus
+  module Client
+    module Format
+      # Allows to send data url encoded as a regular http client.
+      class URLEncodedFormat < JSONFormat
+        def pack(data)
+          {
+            body: encode(data),
+            headers: { 'Content-type' =>
+                       'application/x-www-form-urlencoded; charset=UTF-8' }
+          }
+        end
+
+        def encode(data)
+          data.map { |k, v| "#{k}=#{v}" }.join('&')
+        end
+      end
+    end
+  end
+end

data/lib/kybus/client/rest_client.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+require 'httparty'
+require 'kybus/core'
+require 'kybus/logger'
+
+require_relative 'session/base'
+require_relative 'format/format'
+require_relative 'validator'
+
+module Kybus
+  module Client
+    # HTTP client using HTTParty as support. This implementation makes it easier
+    # to integrate with other backends.
+    class RESTClient
+      include Kybus::Logger
+
+      def initialize(configs)
+        @session = Session.build(configs)
+        @config = configs
+        @format = Format.build(configs)
+        @endpoint = configs[:endpoint]
+        @validator = Validator.build(configs)
+      end
+
+      def get(path, data = {})
+        perform_request(:get, path, data)
+      end
+
+      def post(path, data = {})
+        perform_request(:post, path, data)
+      end
+
+      def put(path, data = {})
+        perform_request(:put, path, data)
+      end
+
+      def delete(path, data = {})
+        perform_request(:delete, path, data)
+      end
+
+      def patch(path, data = {})
+        perform_request(:patch, path, data)
+      end
+
+      def raw_get(path, data = {})
+        perform_raw_request(:get, path, data)
+      end
+
+      def raw_post(path, data = {})
+        perform_raw_request(:post, path, data)
+      end
+
+      private
+
+      def perform_raw_request(method, path, data)
+        log_debug('Performing request', method: method, path: path, data: data)
+        init_time = Time.now
+        uri = (path.start_with?('http') ? path : "#{@endpoint}#{path}")
+        result = @session.perform_request(method, uri,
+                                          @format.pack(data))
+        log_info('Request perfomed',
+                 path: path,
+                 server: @endpoint,
+                 verb: method,
+                 processing_time: (Time.now - init_time).to_f * 1000)
+        result
+      end
+
+      def perform_request(method, path, data)
+        result = perform_raw_request(method, path, data).body
+        unpacked = @format.unpack(result)
+        @validator.validate(unpacked)
+      end
+    end
+  end
+end

data/lib/kybus/client/session/base.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require 'httparty'
+require_relative 'basic_auth'
+
+module Kybus
+  module Client
+    # Provides session handling on http requests
+    module Session
+      def self.build(config)
+        Base.new(config)
+      end
+
+      # Used on http clients. It modifies the requests in order to implement
+      # credentials and other mechanism for session.
+      class Base
+        include HTTParty
+        include BasicAuth
+
+        def initialize(config)
+          @config = config
+          register_certificate
+          register_ca
+        end
+
+        # :nocov: #
+        def register_certificate
+          return unless @config[:client_certificate]
+
+          cert = File.read(@config[:client_certificate])
+          self.class.pkcs12(cert, @config[:client_certificate_pass])
+        end
+        # :nocov: #
+
+        # :nocov: #
+        def register_ca
+          return unless @config[:ca_validate]
+
+          self.class.ssl_ca_file(@config[:ca_validate])
+        end
+        # :nocov: #
+
+        def configure_request(request)
+          basic_auth(request, @config[:basic_auth]) if @config[:basic_auth]
+          request[:verify] = @config[:verify] if @config.key?(:verify)
+        end
+
+        def perform_request(method, endpoint, data)
+          configure_request(data)
+          self.class.send(method, endpoint, data)
+        end
+      end
+    end
+  end
+end

data/lib/kybus/client/session/basic_auth.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Kybus
+  module Client
+    module Session
+      # Implements basic auth functionality for http client
+      module BasicAuth
+        def basic_auth(request, user:, password:)
+          request[:basic_auth] ||= { username: user, password: password }
+        end
+      end
+    end
+  end
+end

data/lib/kybus/client/validator.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require_relative 'validator/jsend'
+require_relative 'validator/no_validator'
+
+module Kybus
+  module Client
+    # Allows to validate the responses from another service.
+    # Use it to rise exceptions when you detect there were an error.
+    module Validator
+      extend Kybus::DRY::ResourceInjector
+
+      class << self
+        def build(config)
+          resource(:validators, config[:validator] || 'empty').new
+        end
+
+        def register_validator(name, klass)
+          register(:validators, name, klass)
+        end
+      end
+      register_validator('jsend', JSend)
+      register_validator('empty', NoValidator)
+      register_validator('none', NoValidator)
+    end
+  end
+end

data/lib/kybus/client/validator/jsend.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Kybus
+  module Client
+    module Validator
+      # Implements JSend specification on another backend calls
+      class JSend
+        include Kybus::Exceptions
+        EXCEPTION_LIST = {
+          'fail' => AntFail,
+          'error' => AntError,
+          'fatal' => AntError
+        }.freeze
+
+        def validate(response)
+          case response[:status]
+          when 'success'
+            response[:data]
+          when 'fail', 'error', 'fatal'
+            exception_klass = EXCEPTION_LIST[response[:status]]
+            raise exception_klass.new(response[:message],
+                                      response[:code],
+                                      response[:data])
+          else
+            raise(AntError, 'Unknown Error')
+          end
+        end
+      end
+    end
+  end
+end

data/lib/kybus/client/validator/no_validator.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module Kybus
+  module Client
+    module Validator
+      # Implement the empty validator for http client responses.
+      class NoValidator
+        def validate(response)
+          response
+        end
+      end
+    end
+  end
+end

data/lib/kybus/client/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Kybus
+  module Client
+    VERSION = '0.1.0'
+  end
+end

metadata

@@ -0,0 +1,209 @@
+--- !ruby/object:Gem::Specification
+name: kybus-client
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Gilberto Vargas
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-06-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: kybus-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: kybus-logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.11'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+- !ruby/object:Gem::Dependency
+  name: rack-minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+description: Use this gem with a duo with the kybus-server gem
+email:
+- tachoguitar@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/kybus/client.rb
+- lib/kybus/client/format/format.rb
+- lib/kybus/client/format/json_format.rb
+- lib/kybus/client/format/url_encoded.rb
+- lib/kybus/client/format/xml_format.rb
+- lib/kybus/client/rest_client.rb
+- lib/kybus/client/session/base.rb
+- lib/kybus/client/session/basic_auth.rb
+- lib/kybus/client/validator.rb
+- lib/kybus/client/validator/jsend.rb
+- lib/kybus/client/validator/no_validator.rb
+- lib/kybus/client/version.rb
+homepage: https://github.com/tachomex/kybus-client
+licenses:
+- MIT
+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.1.4
+signing_key: 
+specification_version: 4
+summary: Implements a HTTP Client that can be configured a lot
+test_files: []