restool 0.1.5 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b9ce87d4cd969d5298ee7c90baef25ac9f2f2c3b725e4ae241a1b00a1b46114b
-  data.tar.gz: 45766774466195ec86b84048d1aa659302d8cc4b50771a4a73c19246f15d4ec5
+  metadata.gz: 52d0af0915763358b062dd72c4df9de90793681216b52a51614a3584dda6d8cc
+  data.tar.gz: 23abf708d700067eda766e721eec500c2f0a60c6896abffb35cd60df6114d17f
 SHA512:
-  metadata.gz: f62e492a295bd06e4f8699b19f98d895a66f5fabfd286ac8c64bcc3907194bc3ea463eed3206ee96567fd2793221a295bee8af2cffefa6698e98fbf61acd6e76
-  data.tar.gz: 379a2006d01cbc9d35e08030f70e690414f77f9d8ce17fe6dc75a8d97a3493daf3b7153dc1d59cbd6b9a18b749accf5e85238ea2d1763bc2f62e97212e77d3ea
+  metadata.gz: 67d2e71af645cd225f4a1fd2b0995342a346820179a53754a5d2bba7d11542f70ee0621a28c17b2b846720475c32f0515a189382203ebca3d5bb39230be39820
+  data.tar.gz: 34d65335c1f75b306798e8539b92244c067d2fe850335d95c36e4e0c52d7dcb4175ba2b8e31880e0f8d00018cb5b1844daf823d088800567d0ce563dab19df8a

data/lib/restool.rb

@@ -1,11 +1,10 @@
 require_relative 'restool/settings/loader'
 require_relative 'restool/service/restool_service'
 
-
 module Restool
 
-  def self.create(service_name, &response_handler)
-    service_config = Restool::Settings::Loader.load(service_name)
+  def self.create(service_name, opts = {}, &response_handler)
+    service_config = Restool::Settings::Loader.load(service_name, opts)
 
     Restool::Service::RestoolService.new(service_config, response_handler)
   end

data/lib/restool/errors.rb

@@ -0,0 +1,7 @@
+module Restool
+
+  class Error < StandardError
+  end
+
+
+end

data/lib/restool/logger/request_logger.rb

@@ -0,0 +1,55 @@
+module Restool
+  class RequestLogger
+
+    def initialize(host, opts)
+      @host = host
+      @opts = opts
+    end
+
+    def log(request, &http_request)
+      log_request(request) if log?
+      response = http_request.call
+      log_response(response) if log?
+
+      response
+    rescue StandardError => e
+      log_error(e) if log?
+
+      raise
+    end
+
+    def logger
+      @opts[:logger]
+    end
+
+    def log?
+      if @opts[:log] != nil
+        @opts[:log]
+      else
+        @opts[:logger] != nil
+      end
+    end
+
+    private
+
+    def log_request(request)
+      logger.info  { "Restool Service #{@host}" }
+      logger.info  { "#{request.method.upcase} #{request.path}" }
+      logger.info  { "Headers: { #{format_hash(request.headers)} }" }
+      logger.debug { "Params: { #{format_hash(request.params)} }" }
+    end
+
+    def log_response(response)
+      logger.info  { "Restool response (status #{response.code}):" }
+      logger.debug { response.body }
+    end
+
+    def log_error(error)
+      logger.error { "Restool error: #{error}" }
+    end
+
+    def format_hash(headers)
+      headers.map { |key, value| "#{key}: #{value}" }.join(", ")
+    end
+  end
+end

data/lib/restool/mock/restool.rb

@@ -1,25 +1,32 @@
+require_relative '../settings/loader'
+
 module Restool
   module Mock
-    def self.create(service_name, &response_handler)
-      service_config = Restool::Settings::Loader.load(service_name)
-
-      # remote_client = Restool::Service::RemoteClient.new(service_config.host,
-      #                                                    service_config.verify_ssl,
-      #                                                    service_config.persistent,
-      #                                                    service_config.timeout)
+    def self.create(service_name, operation_responses)
+      @operation_responses = operation_responses
+      @service_config = Restool::Settings::Loader.load(service_name)
 
-      class FakeRemoteClient
-        def initialize
-        end
+      Service.new(@service_config, operation_responses)
+    end
 
-        def make_request(path, operation_method, params, headers, basic_auth)
+    private
 
-        end
+    class Service
+      def initialize(service_config, operation_responses)
+        @service_config = service_config
+        @operation_responses = operation_responses
       end
 
+      def method_missing(method, *args, &block)
+        if @service_config.operations.map(&:name).include?(method)
+          operation_response      = @operation_responses[method]
+          response_representation = @service_config.operation.response
+          representations         = @service_config.representations
 
-      remote_client = double(make_request)
-      Restool::Service::RestoolService.new(service_config, response_handler, remote_client)
+          Restool::Traversal::Converter.convert(operation_response, response_representation, representations)
+        end
+      end
     end
+
   end
 end

data/lib/restool/service/operation_request.rb

@@ -0,0 +1,15 @@
+module Restool
+  class OperationRequest
+
+    attr_accessor :http_request, :method, :path, :params, :headers
+
+    def initialize(http_request, method, path, params, headers)
+      @http_request = http_request
+      @method = method
+      @path = path
+      @params = params
+      @headers = headers
+    end
+
+  end
+end

data/lib/restool/service/remote_client.rb

@@ -1,45 +1,43 @@
-require 'persistent_http'
-
+require "net/http"
+require "net/https"
 require_relative 'request_utils'
+require_relative '../logger/request_logger'
 
 module Restool
   module Service
     class RemoteClient
 
-      def initialize(host, verify_ssl, persistent_connection, timeout)
-        @connection = if persistent_connection
-                        PersistentHTTP.new(
-                          pool_size:    persistent_connection.pool_size,
-                          pool_timeout: timeout,
-                          warn_timeout: persistent_connection.warn_timeout,
-                          force_retry:  persistent_connection.force_retry,
-                          url:          host,
-                          read_timeout: timeout,
-                          open_timeout: timeout,
-                          verify_mode: verify_ssl?(verify_ssl)
-                        )
-                      else
-                        uri               = URI.parse(host)
-                        http              = Net::HTTP.new(uri.host, uri.port)
-                        http.use_ssl      = ssl_implied?(uri)
-                        http.verify_mode  = verify_ssl?(verify_ssl)
-                        http.read_timeout = timeout
-                        http.open_timeout = timeout
-                        # http.set_debug_output($stdout)
-                        http
-                      end
+      def initialize(host, verify_ssl, timeout, opts)
+        @request_logger = Restool::RequestLogger.new(host, opts)
+        @connection = build_connection(host, verify_ssl, timeout, opts)
       end
 
       def make_request(path, method, request_params, headers, basic_auth)
-        request = RequestUtils.build_request(method, path, request_params, headers, basic_auth)
-
-        @connection.request(request)
+        operation_request = RequestUtils.build_request(method, path, request_params, headers, basic_auth)
+
+        @request_logger.log(operation_request) do
+          @connection.request(operation_request.http_request)
+        end
+      rescue Errno::ETIMEDOUT => e
+        raise Restool::TimeoutError, e
+      rescue Errno::EADDRNOTAVAIL, Errno::ECONNREFUSED, IOError, SocketError
+        raise Restool::ConnectionFailed, $ERROR_INFO
       end
 
       private
 
-      def ssl_implied?(uri)
-        uri.port == 443 || uri.scheme == 'https'
+      def build_connection(host, verify_ssl, timeout, opts)
+        uri = URI.parse(host)
+
+        connection = Net::HTTP.new(uri.host, uri.port)
+
+        connection.use_ssl      = uri.is_a?(URI::HTTPS)
+        connection.verify_mode  = verify_ssl?(verify_ssl)
+        connection.read_timeout = timeout
+        connection.open_timeout = timeout
+        connection.set_debug_output($stdout) if opts[:debug]
+
+        connection
       end
 
       def verify_ssl?(verify_ssl_setting)

data/lib/restool/service/request_utils.rb

@@ -1,3 +1,5 @@
+require_relative 'operation_request'
+
 module Restool
   module Service
     module RequestUtils
@@ -23,7 +25,7 @@ module Restool
 
         headers.each { |k, v| request[k] = v } if headers
 
-        request
+        OperationRequest.new(request, method, path, params, headers)
       end
 
       def self.build_base_request(method, path)

data/lib/restool/service/restool_service.rb

@@ -11,7 +11,7 @@ module Restool
         @service_config = service_config
         @response_handler = response_handler
         @remote_client = Restool::Service::RemoteClient.new(service_config.host, service_config.verify_ssl,
-                                                            service_config.persistent, service_config.timeout)
+                                                            service_config.timeout, service_config.opts)
 
         define_operations(
           @service_config, method(:make_request), method(:make_request_with_uri_params)

data/lib/restool/settings/loader.rb

@@ -11,37 +11,28 @@ module Restool
       DEFAULT_SSL_VERIFY = false
 
 
-      def self.load(service_name)
+      def self.load(service_name, opts)
         service_config = config['services'].detect do |service|
-          service['name'] == service_name
+          service['name'] == service_name.to_s
         end
 
         raise "Service #{service_name} not found in configuration" unless service_config
 
-        build_service(service_config)
+        build_service(service_config, opts)
       end
 
       private
 
-      def self.build_service(service_config)
+      def self.build_service(service_config, opts)
         representations = if service_config['representations']
                             build_representations(service_config['representations'])
                           else
                             []
                           end
 
-        basic_auth = service_config['basic_auth'] || service_config['basic_authentication']
+        basic_auth = opts['basic_auth'] || opts['basic_authentication'] || service_config['basic_auth'] || service_config['basic_authentication']
         basic_auth = BasicAuthentication.new(basic_auth['user'], basic_auth['password']) if basic_auth
 
-        persistent_connection = service_config['persistent']
-        persistent_connection = if persistent_connection
-                                  PersistentConnection.new(
-                                    persistent_connection['pool_size'],
-                                    persistent_connection['warn_timeout'],
-                                    persistent_connection['force_retry'],
-                                  )
-                                end
-
         # Support host + common path in url config, e.g. api.com/v2/
         paths_prefix_in_host = URI(service_config['url']).path
 
@@ -49,11 +40,11 @@ module Restool
           service_config['name'],
           service_config['url'],
           service_config['operations'].map { |operation| build_operation(operation, paths_prefix_in_host) },
-          persistent_connection,
           service_config['timeout'] || DEFAULT_TIMEOUT,
           representations,
           basic_auth,
-          service_config['ssl_verify'] || DEFAULT_SSL_VERIFY
+          service_config['ssl_verify'] || DEFAULT_SSL_VERIFY,
+          opts
         )
       end
 

data/lib/restool/settings/models.rb

@@ -4,11 +4,10 @@ module Restool
 
       Operation = Struct.new(:name, :path, :method, :uri_params, :response)
       OperationResponse = Struct.new(:fields)
-      Service = Struct.new(:name, :host, :operations, :persistent, :timeout, :representations, :basic_auth, :verify_ssl)
+      Service = Struct.new(:name, :host, :operations, :timeout, :representations, :basic_auth, :verify_ssl, :opts)
       Representation = Struct.new(:name, :fields)
       RepresentationField = Struct.new(:key, :metonym, :type)
       BasicAuthentication = Struct.new(:user, :password)
-      PersistentConnection = Struct.new(:respool_size, :want_timeout, :force_retry)
       OperationResponsField = RepresentationField
 
     end

data/lib/restool/version.rb

@@ -1,3 +1,3 @@
 module Restool
-  VERSION = '0.1.5'
+  VERSION = '1.0.3'
 end

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: restool
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 1.0.3
 platform: ruby
 authors:
 - Juan Andres Zeni
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-05-29 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: persistent_http
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2'
+date: 2020-11-28 00:00:00.000000000 Z
+dependencies: []
 description: Make HTTP requests and handle its responses using simple method calls.
   Restool turns your HTTP API and its responses into Ruby interfaces.
 email:
@@ -33,8 +19,11 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/restool.rb
+- lib/restool/errors.rb
+- lib/restool/logger/request_logger.rb
 - lib/restool/mock/restool.rb
 - lib/restool/service/operation_definer.rb
+- lib/restool/service/operation_request.rb
 - lib/restool/service/remote_client.rb
 - lib/restool/service/remote_connector.rb
 - lib/restool/service/request_utils.rb
@@ -49,7 +38,7 @@ homepage: https://github.com/jzeni/restool
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -64,8 +53,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
-signing_key: 
+rubygems_version: 3.2.0.rc.1
+signing_key:
 specification_version: 4
 summary: Turn your API and its responses into Ruby interfaces.
 test_files: []