rest_api_builder 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 96218189bfd186f70de1dbe9a83564193b9eebcd1e8bc1f140b0cf2df7ab547f
-  data.tar.gz: badc7fb88fed02398ed637da3abaefcc18a0d84ae5f7c245dace7afb37e8d2a2
+  metadata.gz: 7044c0a51394cd9997b23d7c1189e32a3342cdc63c5b2d15faff2050857d8114
+  data.tar.gz: 77684c0bc571a4b424f9e5624bbc25eafd45246b954c0ad1b7f2a2ba20535649
 SHA512:
-  metadata.gz: ca89a063999a87c496f0393f8ddc43523a94bdda47046b5ca7c396511f734ec9443dd2ac15fdd6e2df55f06ded04ddca6c84bd3da7acccf11466b3b26a1e0f05
-  data.tar.gz: c3f272966028c03da3354bfe17ee30d93a4b4005d63e7aca7fda8c85708f726b98998d60d4a6de21b835ab8c570e799c04f12593dbdbad14d7d5d09640e0e280
+  metadata.gz: e4efb71298656b1703b9b147dfdb9901cb94ab70bc74c013224439270211d9ad92357d7886d0355491eea22bf9b368e33db1a111096da1e643a6dd7807c067c1
+  data.tar.gz: 5562e548abb6dc0c8798e6fbe238d07110f41a9bcf8953c31286178dc26d3b6170f22fef14140241e1a47ae43d4482765f9b473db6aee1640432ae347ce38908

data/lib/rest_api_builder.rb

@@ -1,32 +1,7 @@
 require 'forwardable'
-require 'rest_api_builder/request_options'
-require 'rest_api_builder/response_handler'
+require 'rest_api_builder/request'
+require 'rest_api_builder/api_client'
 
 module RestAPIBuilder
-  class APIHelpers
-    extend Forwardable
-
-    def initialize
-      @request_options = RequestOptions.new
-      @response_handler = ResponseHandler.new
-    end
-
-    def_delegator :@request_options, :compose, :compose_request_options
-    def_delegator :@request_options, :compose_json, :compose_json_request_options
-
-    def_delegators :@response_handler, :handle_response, :handle_json_response, :handle_response_error
-  end
-
-  extend Forwardable
-
-  def_delegators :rest_api_builder_helpers,
-                 :compose_request_options,
-                 :compose_json_request_options,
-                 :handle_response,
-                 :handle_json_response,
-                 :handle_response_error
-
-  def rest_api_builder_helpers
-    APIHelpers.new
-  end
+  include RestAPIBuilder::Request
 end

data/lib/rest_api_builder/api_client.rb

@@ -0,0 +1,16 @@
+require 'rest_api_builder/helpers/string_helper'
+
+module RestAPIBuilder
+  module APIClient
+    def define_resource_shortcuts(resources, resources_scope:, init_with:)
+      resources.each do |name|
+        class_name = RestAPIBuilder::Helpers::StringHelper.camelize(name.to_s)
+        resource_class = Object.const_get("#{resources_scope}::#{class_name}")
+
+        define_singleton_method(name) do
+          init_with.call(resource_class)
+        end
+      end
+    end
+  end
+end

data/lib/rest_api_builder/helpers/string_helper.rb

@@ -0,0 +1,15 @@
+module RestAPIBuilder
+  module Helpers
+    module StringHelper
+      module_function
+
+      # From https://apidock.com/rails/String/camelize
+      def camelize(string)
+        string
+          .sub(/^[a-z\d]*/, &:capitalize)
+          .gsub(/(?:_|(\/))([a-z\d]*)/) { "#{Regexp.last_match(1)}#{Regexp.last_match(2).capitalize}" }
+          .gsub("/", "::")
+      end
+    end
+  end
+end

data/lib/rest_api_builder/helpers/url_helper.rb

@@ -0,0 +1,15 @@
+module RestAPIBuilder
+  module Helpers
+    module UrlHelper
+      module_function
+
+      def full_url(url, path)
+        if path
+          File.join(url, path)
+        else
+          url
+        end
+      end
+    end
+  end
+end

data/lib/rest_api_builder/request.rb

@@ -0,0 +1,18 @@
+require 'forwardable'
+require 'rest_api_builder/request/request_options'
+require 'rest_api_builder/request/response_handler'
+
+module RestAPIBuilder
+  module Request
+    extend Forwardable
+
+    def_delegators RestAPIBuilder::Request::RequestOptions,
+                   :compose_request_options,
+                   :compose_json_request_options
+
+    def_delegators RestAPIBuilder::Request::ResponseHandler,
+                   :handle_response,
+                   :handle_json_response,
+                   :handle_response_error
+  end
+end

data/lib/rest_api_builder/request/request_options.rb

@@ -0,0 +1,37 @@
+require 'rest_api_builder/helpers/url_helper'
+
+module RestAPIBuilder
+  module Request
+    module RequestOptions
+      extend RestAPIBuilder::Helpers::UrlHelper
+
+      module_function
+
+      def compose_request_options(base_url:, method:, path: nil, body: nil, headers: {}, query: nil)
+        if method == :get && body
+          raise ArgumentError, 'GET requests do not support body'
+        end
+
+        headers = headers.merge(params: query) if query
+
+        {
+          method: method,
+          url: full_url(base_url, path),
+          payload: body,
+          headers: headers
+        }
+      end
+
+      def compose_json_request_options(**options)
+        result = compose_request_options(**options)
+        headers = result[:headers]
+        payload = result[:payload]
+
+        result.merge(
+          headers: headers.merge(content_type: :json),
+          payload: payload && JSON.generate(payload)
+        )
+      end
+    end
+  end
+end

data/lib/rest_api_builder/request/response_handler.rb

@@ -0,0 +1,48 @@
+require 'rest-client'
+
+module RestAPIBuilder
+  module Request
+    module ResponseHandler
+      module_function
+
+      def handle_json_response(**options, &block)
+        result = handle_response(**options, &block)
+        result.merge(body: parse_json(result[:body]))
+      end
+
+      def handle_response(logger: nil, &block)
+        result = parse_response(**handle_response_error(&block))
+        maybe_log_result(result, logger: logger)
+        result
+      end
+
+      def handle_response_error
+        response = yield
+        { raw_response: response, success: true }
+      rescue RestClient::RequestFailed => e
+        raise e unless e.response
+
+        { raw_response: e.response, success: false }
+      end
+
+      def parse_response(raw_response:, success:)
+        {
+          success: success,
+          status: raw_response.code,
+          body: raw_response.body,
+          headers: raw_response.headers
+        }
+      end
+
+      def maybe_log_result(result, logger:)
+        logger && logger << "# => Response: #{result}\n"
+      end
+
+      def parse_json(json)
+        JSON.parse(json)
+      rescue JSON::ParserError
+        json
+      end
+    end
+  end
+end

data/lib/rest_api_builder/webmock_request_expectations.rb

@@ -1,10 +1,10 @@
 require 'webmock'
-require 'rest_api_builder/url_helper'
+require 'rest_api_builder/helpers/url_helper'
 
 module RestAPIBuilder
   class WebMockRequestExpectationsSingleton
     include WebMock::API
-    include RestAPIBuilder::UrlHelper
+    include RestAPIBuilder::Helpers::UrlHelper
 
     def expect_json_execute(response: nil, **options)
       if response && response[:body]

data/rest_api_builder.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = 'rest_api_builder'
-  s.version     = '0.1.2'
+  s.version     = '0.1.3'
   s.summary     = "A simple wrapper for rest-client"
   s.description = "A simple wrapper for rest-client aiming to make creation and testing of API clients easier."
   s.authors     = ["Alexey D"]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rest_api_builder
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Alexey D
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-09-20 00:00:00.000000000 Z
+date: 2020-09-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -62,9 +62,12 @@ files:
 - LICENSE
 - README.md
 - lib/rest_api_builder.rb
-- lib/rest_api_builder/request_options.rb
-- lib/rest_api_builder/response_handler.rb
-- lib/rest_api_builder/url_helper.rb
+- lib/rest_api_builder/api_client.rb
+- lib/rest_api_builder/helpers/string_helper.rb
+- lib/rest_api_builder/helpers/url_helper.rb
+- lib/rest_api_builder/request.rb
+- lib/rest_api_builder/request/request_options.rb
+- lib/rest_api_builder/request/response_handler.rb
 - lib/rest_api_builder/webmock_request_expectations.rb
 - rest_api_builder.gemspec
 homepage: https://github.com/alexeyds/rest_api_builder

data/lib/rest_api_builder/request_options.rb

@@ -1,33 +0,0 @@
-require 'rest_api_builder/url_helper'
-
-module RestAPIBuilder
-  class RequestOptions
-    include RestAPIBuilder::UrlHelper
-
-    def compose(base_url:, method:, path: nil, body: nil, headers: {}, query: nil)
-      if method == :get && body
-        raise ArgumentError, 'GET requests do not support body'
-      end
-
-      headers = headers.merge(params: query) if query
-
-      {
-        method: method,
-        url: full_url(base_url, path),
-        payload: body,
-        headers: headers
-      }
-    end
-
-    def compose_json(**options)
-      result = compose(**options)
-      headers = result[:headers]
-      payload = result[:payload]
-
-      result.merge(
-        headers: headers.merge(content_type: :json),
-        payload: payload && JSON.generate(payload)
-      )
-    end
-  end
-end

data/lib/rest_api_builder/response_handler.rb

@@ -1,46 +0,0 @@
-require 'rest-client'
-
-module RestAPIBuilder
-  class ResponseHandler
-    def handle_json_response(**options, &block)
-      result = handle_response(**options, &block)
-      result.merge(body: parse_json(result[:body]))
-    end
-
-    def handle_response(logger: nil, &block)
-      result = parse_response(**handle_response_error(&block))
-      maybe_log_result(result, logger: logger)
-      result
-    end
-
-    def handle_response_error
-      response = yield
-      { raw_response: response, success: true }
-    rescue RestClient::RequestFailed => e
-      raise e unless e.response
-
-      { raw_response: e.response, success: false }
-    end
-
-    private
-
-    def parse_response(raw_response:, success:)
-      {
-        success: success,
-        status: raw_response.code,
-        body: raw_response.body,
-        headers: raw_response.headers
-      }
-    end
-
-    def maybe_log_result(result, logger:)
-      logger && logger << "# => Response: #{result}\n"
-    end
-
-    def parse_json(json)
-      JSON.parse(json)
-    rescue JSON::ParserError
-      json
-    end
-  end
-end

data/lib/rest_api_builder/url_helper.rb

@@ -1,11 +0,0 @@
-module RestAPIBuilder
-  module UrlHelper
-    def full_url(url, path)
-      if path
-        File.join(url, path)
-      else
-        url
-      end
-    end
-  end
-end