restool 0.1.1 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 037a0d2760186255d1e6e19aa80307a0cfe00c617df4c15c85eb6148d167b143
-  data.tar.gz: 03f9ab4693211541306a9ef47dc471333e8769b26a60926826e8f3406c9d250d
+  metadata.gz: 939d1069da8b669efb9bc394a55b641ac6ea7a759d0aecf0502d57fb00c26139
+  data.tar.gz: 2638de0068c9129d0aa752a79a94d680f857474f64da8da075c045c77bf245e6
 SHA512:
-  metadata.gz: 9166a80ee4927346fbb2562f2dd6d93115636fa43d42764dc18bb200bf207b16dbe08f94f4cff6f90b3f29f6e27b32ce882dea4fd8c8cbc8cec8f0210a997248
-  data.tar.gz: 3702698b11aa24a5f47f20eee1a1314c155b683c8623a307fdd477eb4ea3e7fa6df08c1beb09548669fdd6a9f5c5bf4544f272f2a1eec234581c25521bd4024d
+  metadata.gz: 76e3401eced2a728940887af09ce40101bd7aaf460e019dc0d4dedc2f36106f6ba807a932fd68956bb62c283904b86919fc1e49c21b60ba8789d1c372b6d2729
+  data.tar.gz: 707282f1b15fda1d97b6a71da5bf429f3eab0969ffffa09a9f94beaa81b0a3d32807161273b9f1ed71cd7753c85d9110101ff8e6874405bdbdb2eecfa7523e27

data/lib/restool.rb

@@ -1,11 +1,12 @@
 require_relative 'restool/settings/loader'
 require_relative 'restool/service/restool_service'
 
+require_relative 'restool/mock/restool'
 
 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/logger/request_logger.rb

@@ -0,0 +1,47 @@
+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
+    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  { format_hash(request.headers) }
+      logger.debug { format_hash(request.params) }
+    end
+
+    def log_response(response)
+      logger.info  { "Restool response (status #{response.code})" }
+      logger.debug { response.body }
+    end
+
+    def format_hash(headers)
+      headers.map { |key, value| "#{key}: #{value}" }.join(", ")
+    end
+  end
+end

data/lib/restool/mock/restool.rb

@@ -0,0 +1,32 @@
+require_relative '../settings/loader'
+
+module Restool
+  module Mock
+    def self.create(service_name, operation_responses)
+      @operation_responses = operation_responses
+      @service_config = Restool::Settings::Loader.load(service_name)
+
+      Service.new(@service_config, operation_responses)
+    end
+
+    private
+
+    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
+
+          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,12 +1,15 @@
 require 'persistent_http'
 
 require_relative 'request_utils'
+require_relative '../logger/request_logger'
 
 module Restool
   module Service
     class RemoteClient
 
-      def initialize(host, verify_ssl, persistent_connection, timeout)
+      def initialize(host, verify_ssl, persistent_connection, timeout, opts)
+        @request_logger = Restool::RequestLogger.new(host, opts)
+
         @connection = if persistent_connection
                         PersistentHTTP.new(
                           pool_size:    persistent_connection.pool_size,
@@ -21,27 +24,25 @@ module Restool
                       else
                         uri               = URI.parse(host)
                         http              = Net::HTTP.new(uri.host, uri.port)
-                        http.use_ssl      = ssl_implied?(uri)
+                        http.use_ssl      = uri.is_a?(URI::HTTPS)
                         http.verify_mode  = verify_ssl?(verify_ssl)
                         http.read_timeout = timeout
                         http.open_timeout = timeout
-                        # http.set_debug_output($stdout)
+                        http.set_debug_output($stdout) if opts[:debug]
                         http
                       end
       end
 
       def make_request(path, method, request_params, headers, basic_auth)
-        request = RequestUtils.build_request(method, path, request_params, headers, basic_auth)
+        operation_request = RequestUtils.build_request(method, path, request_params, headers, basic_auth)
 
-        @connection.request(request)
+        @request_logger.log(operation_request) do
+          @connection.request(operation_request.http_request)
+        end
       end
 
       private
 
-      def ssl_implied?(uri)
-        uri.port == 443 || uri.scheme == 'https'
-      end
-
       def verify_ssl?(verify_ssl_setting)
         verify_ssl_setting ? OpenSSL::SSL::VERIFY_PEER : OpenSSL::SSL::VERIFY_NONE
       end

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.persistent, 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,19 +11,19 @@ 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
         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
@@ -53,7 +53,8 @@ module Restool
           service_config['timeout'] || DEFAULT_TIMEOUT,
           representations,
           basic_auth,
-          service_config['ssl_verify'] || DEFAULT_SSL_VERIFY
+          service_config['ssl_verify'] || DEFAULT_SSL_VERIFY,
+          opts
         )
       end
 
@@ -105,7 +106,7 @@ module Restool
       def self.config
         return @config if @config
 
-        files_to_load = Dir['config/restool/*'] + ['config/restool.yml', 'config/restool.json']
+        files_to_load = Dir['config/restool/*.yml'] + Dir['config/restool/*.yaml'] + ['config/restool.yml', 'config/restool.yaml', 'config/restool.json']
 
         @config = { 'services' => [] }
 
@@ -114,12 +115,12 @@ module Restool
 
           extension = File.extname(file_name)
 
-          content = if extension == '.yml'
-            YAML.load_file(file_name)
-          elsif extension == '.json'
-            json_file = File.read(file_name)
-            JSON.parse(json_file)
-          end
+          content = if extension == '.yml' || extension == '.yaml'
+                      YAML.load_file(file_name)
+                    elsif extension == '.json'
+                      json_file = File.read(file_name)
+                      JSON.parse(json_file)
+                    end
 
           @config['services'] += content['services']
         end
@@ -127,10 +128,6 @@ module Restool
         @config
       end
 
-      def self.validate
-        # TODO: perform validations
-      end
-
     end
   end
 end

data/lib/restool/settings/models.rb

@@ -4,7 +4,7 @@ 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, :persistent, :timeout, :representations, :basic_auth, :verify_ssl, :opts)
       Representation = Struct.new(:name, :fields)
       RepresentationField = Struct.new(:key, :metonym, :type)
       BasicAuthentication = Struct.new(:user, :password)

data/lib/restool/traversal/converter.rb

@@ -19,6 +19,9 @@ module Restool
       def self.convert(request_response, response_representation, representations)
         object = Restool::Traversal::Object.new
 
+        object.class.__send__(:attr_accessor, :_raw)
+        object.__send__("_raw=", request_response)
+
         if request_response.is_a?(Array)
           request_response.map do |element|
             map_response_to_representation(response_representation, element, object, representations)
@@ -32,10 +35,15 @@ module Restool
 
       def self.map_response_to_representation(representation, request_response, object, representations)
         representation.fields.each do |field|
-          value = request_response[field.key]
+          value = request_response[field.key.to_s] || request_response[field.key.to_sym]
 
           object.class.__send__(:attr_accessor, var_name(field))
 
+          if value.nil?
+            set_var(object, field, nil)
+            next
+          end
+
           if Restool::Traversal::TRAVERSAL_TYPES.include?(field.type.to_sym)
             map_primitive_field(value, field, object)
           else
@@ -53,7 +61,7 @@ module Restool
                       parse_value(field.type, value)
                     end
 
-        object.__send__("#{var_name(field)}=", new_value)
+        set_var(object, field, new_value)
       end
 
       def self.map_complex_field(value, field, object, representations)
@@ -65,6 +73,10 @@ module Restool
                       convert(value, operation_representation, representations)
                     end
 
+        set_var(object, field, new_value)
+      end
+
+      def self.set_var(object, field, new_value)
         object.__send__("#{var_name(field)}=", new_value)
       end
 
@@ -75,7 +87,7 @@ module Restool
       def self.parse_value(type, value)
         case type
         when Restool::Traversal::TRAVERSAL_TYPE_STRING
-          value
+          value.to_s
         when Restool::Traversal::TRAVERSAL_TYPE_INTEGER
           Integer(value)
         when Restool::Traversal::TRAVERSAL_TYPE_DECIMAL

data/lib/restool/traversal/object.rb

@@ -1,17 +1,5 @@
 module Restool
   module Traversal
-    class Object
-
-      def to_hash
-        instance_variables
-          .inject({}) do |acum, var|
-            acum[var.to_s.delete('@')] = instance_variable_get(var)
-            acum
-          end
-      end
-
-      alias_method :to_h, :to_hash
-
-    end
+    class Object; end
   end
 end

data/lib/restool/version.rb

@@ -1,3 +1,3 @@
 module Restool
-  VERSION = "0.1.1"
+  VERSION = '0.1.6'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: restool
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.6
 platform: ruby
 authors:
 - Juan Andres Zeni
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-12 00:00:00.000000000 Z
+date: 2020-06-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: persistent_http
@@ -33,7 +33,10 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/restool.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
@@ -56,7 +59,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="