request-builder 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 457e80f8bbd15d0c31db2b9c22eb0cdad23d220263b046333e7f23233fd39f7c
-  data.tar.gz: b2631a86209e6e280069118793f8610360675ace8cc84841a091389220cb9c78
+  metadata.gz: d96e607c780a2bf0f4b9a76576137b973ba71daa719b17838836a9890fece4c4
+  data.tar.gz: 696d365b78f1a133f40d5bc784e96a1e2d86a1a49f8f42eb7ba4f23379bd9473
 SHA512:
-  metadata.gz: fccbcdc8f74870d091a5d660ea44b76b400037570db2bfa1af2516fffa14a4f1ec49625785e65062da585eb36fc8d75bb62b6395f705da6a9fd68c5d06ac93d0
-  data.tar.gz: 8040052bf21eaa5c8693abccc82959d3739684cda46145ab2921d5fc09ed734a69ff57816057126163070d403bff2a9acb9907cf6b918a6ccc0941609225a4f5
+  metadata.gz: bf03752615829aa961327be7a13a8c56662e3796ec0fe4b565495c873ffa8f2eb31229d740475930ef3bbe69e9f345c695c3fa37f31236bef9cfbc4d5cd62856
+  data.tar.gz: 074b41b7a673cb4687f6c6a3331162d33159b5a30cde121b4921f41c7433eb6a9f2bea945188a2830df5281eb7111bc47e19e82aee3a822fe30224538a688198

data/README.md

@@ -1,8 +1,6 @@
 # Request::Builder
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/request/builder`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+Simple DSL wrapper for faraday gem
 
 ## Installation
 
@@ -22,7 +20,75 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Include `Request::Builder` to your client class and describe your request using DSL
+
+```ruby
+class MyApiClient
+  include Request::Builder
+
+  option :my_option
+  option :my_header_value
+
+  configure do
+    adapter :net_http
+    response_middleware :json
+    request_middleware :json
+    method :get
+    logger Logger.new(STDOUT)
+    timeout 10
+
+    host 'http://api.forismatic.com/'
+    path '/api/1.0/'
+
+    params do
+      # you can pass a block or lambda to params
+      # this allows you to use object variables or configuration variables 
+      param 'param1', &:my_option
+      param 'param2', -> { "#{my_option}" }
+      param('param3') { my_option }
+      param 'param4' 'string'
+    end
+  
+    headers do
+      header 'header1', &:my_header_value
+    end
+
+    # in body you can use object variables or configuration variables too
+    body do
+      {
+        'hello' => lang,
+        'path' => config.path
+      }
+    end
+
+    # this callback executes after receiving the response
+    before_validate do |body|
+      body.delete('unnecessary_param')
+      body.deep_symbolize_keys
+      body
+    end
+
+    # you can use dry-schema to validate response
+    schema do
+      required(:status).value(eql?: 'success')
+    end
+  end
+end
+```
+
+After you describe your request class you can use it:
+
+```ruby
+result = MyApiClient.call(my_option: 'some_value', my_header_value: 'header_value')
+
+result.success? # true if status code == 200 and schema is valid 
+result.failure?
+result.status # result code - Integer
+result.headers # hash of headers
+result.body # raw body from request
+result.schema_result # result of dry-schema
+result.full_errors # array of errors from dry-schema
+```
 
 ## Development
 

data/lib/request/builder/dsl.rb

@@ -11,16 +11,16 @@ module Request
       end
 
       module ClassMethods
-        def config
-          @config ||= RequestConfig.new
+        def config(conf=nil)
+          @config ||= conf.deep_dup || RequestConfig.new
         end
 
         def configure(conf = nil, &block)
-          @config = conf.dup if conf
+          config(conf)
 
           config.instance_eval(&block) if block
         end
       end
     end
   end
-end
+end

data/lib/request/builder/request_config.rb

@@ -5,28 +5,24 @@ module Request
 
       delegate_missing_to :context
 
-      attrs = [:host, :path, :method, :request_middleware, :response_middleware, :adapter, :logger, :timeout]
+      attrs = [:params, :callbacks, :headers, :body, :host, :path, :method, :request_middleware, :response_middleware, :adapter, :logger, :timeout]
 
-      attr_reader :context, :body_conf, :headers_conf, :params_conf, :callbacks_conf, :stubs
-      attr_writer *attrs, :stubs
-
-      alias callbacks callbacks_conf
+      attr_reader :context, :stubs
+      attr_writer *attrs, :stubs, :context
 
       def initialize
+        @body = nil
         @host = nil
         @path = '/'
         @method = :get
         @request_middleware = :json
         @response_middleware = :json
-        @adapter = :net_http
+        @adapter = Request::Builder.default_adapter
         @stubs = Faraday::Adapter::Test::Stubs.new
         @logger = nil
         @timeout = 30
-        @body_conf = RequestConfig::Body.new
-        @headers_conf = RequestConfig::Headers.new
-        @params_conf = RequestConfig::Params.new
-        @callbacks_conf = RequestConfig::Callbacks.new
         @response_schema = Dry::Schema.Params
+        @context = nil
       end
 
       attrs.each do |attr|
@@ -41,10 +37,22 @@ module Request
 
       [:before_validate].each do |name|
         define_method name do |&block|
-          callbacks.send(name, &block)
+          callbacks[name] = block
         end
       end
 
+      def headers
+        @headers ||= HashWithIndifferentAccess.new
+      end
+
+      def params
+        @params ||= HashWithIndifferentAccess.new
+      end
+
+      def callbacks
+        @callbacks ||= HashWithIndifferentAccess.new
+      end
+
       def stubs(value = nil, &block)
         if block_given?
           @stubs.instance_eval(&block)
@@ -65,36 +73,32 @@ module Request
         end
       end
 
-      def body(&block)
-        return body_conf.set(&block) if block_given?
-
-        body_conf.to_h
-      end
-
-      def headers(&block)
-        headers_conf.instance_eval(&block) if block_given?
-
-        headers_conf
-      end
-
       def header(key, value = nil, &block)
-        headers_conf.header(key, value, &block)
-      end
-
-      def params(&block)
-        params_conf.instance_eval(&block) if block_given?
-
-        params_conf
+        if value.nil? && block.nil?
+          value_with_context(headers[key])
+        else
+          headers[key] = block || value
+        end
       end
 
       def param(key, value = nil, &block)
-        params_conf.param(key, value, &block)
+        if value.nil? && block.nil?
+          value_with_context(params[key])
+        else
+          params[key] = block || value
+        end
       end
 
-      def context=(context)
-        @context = context
+      def each_header
+        headers.each do |key, value|
+          yield key, value_with_context(value)
+        end
+      end
 
-        [body_conf, headers_conf, params_conf, callbacks_conf].each { |cnf| cnf.context = context }
+      def each_param
+        params.each do |key, value|
+          yield key, value_with_context(value)
+        end
       end
 
       def [] property

data/lib/request/builder/value_with_context.rb

@@ -5,7 +5,7 @@ module Request
         return obj unless obj.is_a?(Proc)
 
         case obj.arity
-        when 1, -1, -2 then instance_exec(@context, &obj)
+        when 1, -1, -2 then instance_exec(self, &obj)
         else instance_exec(&obj)
         end
       end

data/lib/request/builder/version.rb

@@ -1,5 +1,5 @@
 module Request
   module Builder
-    VERSION = "0.1.0"
+    VERSION = "0.1.2"
   end
 end

data/lib/request/builder.rb

@@ -6,11 +6,6 @@ require "active_support/core_ext/module/delegation"
 require_relative "builder/version"
 require_relative "builder/value_with_context"
 require_relative "builder/request_config"
-require_relative "builder/request_config/base"
-require_relative "builder/request_config/body"
-require_relative "builder/request_config/params"
-require_relative "builder/request_config/headers"
-require_relative "builder/request_config/callbacks"
 require_relative "builder/result"
 require_relative "builder/dsl"
 require_relative "builder/connection"
@@ -25,8 +20,8 @@ module Request
 
       class << base
         alias_method :__new, :new
-        def new(*args)
-          e = __new(*args)
+        def new(*args, **kwargs)
+          e = __new(*args, **kwargs)
           e.send(:set_config_context)
           e
         end
@@ -34,12 +29,18 @@ module Request
     end
 
     module ClassMethods
-      def call(**args)
-        new(**args).call
+      def call(*args, **kwargs)
+        new(*args, **kwargs).call
       end
       alias perform call
     end
 
+    def self.default_adapter(adapter = nil)
+      @default_adapter = adapter if adapter
+
+      @default_adapter || :net_http
+    end
+
     def call
       do_request
       result
@@ -58,11 +59,11 @@ module Request
       @response = connection.send(config.method.downcase, config.path) do |req|
         req.options.timeout = config.timeout
 
-        config.params.each do |key, value|
+        config.each_param do |key, value|
           req.params[key] = value
         end
 
-        config.headers.each do |key, value|
+        config.each_header do |key, value|
           req.headers[key] = value
         end
 

data/request-builder.gemspec

@@ -9,14 +9,14 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Anton Kostyuk"]
   spec.email         = ["anton.kostuk.2012@gmail.com"]
 
-  spec.summary       = %q{Request DSL}
-  spec.description   = %q{Request DSL}
-  spec.homepage      = "https://github.com/RainbowPonny/request-builder"
+  spec.summary       = %q{Ruby Request DSL}
+  spec.description   = %q{Simple DSL wrapper for faraday gem}
+  spec.homepage      = "https://github.com/RainbowPonny/ruby-request-builder"
   spec.license       = "MIT"
   spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
 
   spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = "https://github.com/RainbowPonny/request-builder"
+  spec.metadata["source_code_uri"] = "https://github.com/RainbowPonny/ruby-request-builder"
 
   spec.files         = Dir["CHANGELOG.md", "LICENSE", "README.md", "request-builder.gemspec", "lib/**/*"]
   spec.bindir        = "bin"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: request-builder
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Anton Kostyuk
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-09-17 00:00:00.000000000 Z
+date: 2022-12-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -114,7 +114,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-description: Request DSL
+description: Simple DSL wrapper for faraday gem
 email:
 - anton.kostuk.2012@gmail.com
 executables: []
@@ -127,22 +127,17 @@ files:
 - lib/request/builder/connection.rb
 - lib/request/builder/dsl.rb
 - lib/request/builder/request_config.rb
-- lib/request/builder/request_config/base.rb
-- lib/request/builder/request_config/body.rb
-- lib/request/builder/request_config/callbacks.rb
-- lib/request/builder/request_config/headers.rb
-- lib/request/builder/request_config/params.rb
 - lib/request/builder/result.rb
 - lib/request/builder/value_with_context.rb
 - lib/request/builder/version.rb
 - request-builder.gemspec
-homepage: https://github.com/RainbowPonny/request-builder
+homepage: https://github.com/RainbowPonny/ruby-request-builder
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/RainbowPonny/request-builder
-  source_code_uri: https://github.com/RainbowPonny/request-builder
-post_install_message: 
+  homepage_uri: https://github.com/RainbowPonny/ruby-request-builder
+  source_code_uri: https://github.com/RainbowPonny/ruby-request-builder
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -157,8 +152,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key: 
+rubygems_version: 3.3.7
+signing_key:
 specification_version: 4
-summary: Request DSL
+summary: Ruby Request DSL
 test_files: []

data/lib/request/builder/request_config/base.rb

@@ -1,37 +0,0 @@
-module Request
-  module Builder
-    class RequestConfig::Base
-      include ValueWithContext
-
-      attr_accessor :context
-      attr_reader :store
-
-      delegate_missing_to :context
-
-      def initialize(context = nil)
-        @context = context
-      end
-
-      def each(&block)
-        raise NotImplementedError unless store.is_a?(Enumerable)
-
-        store.each do |value|
-          value[1] = value_with_context(value[1])
-          block.call(value)
-        end
-      end
-
-      def [] key
-        raise NotImplementedError unless store.is_a?(Enumerable)
-
-        value_with_context(store[key])
-      end
-
-      private
-
-      def store
-        raise NotImplementedError
-      end
-    end
-  end
-end

data/lib/request/builder/request_config/body.rb

@@ -1,21 +0,0 @@
-module Request
-  module Builder
-    class RequestConfig::Body < Request::Builder::RequestConfig::Base
-      def set(&block)
-        raise ArgumentError, 'You must provide a block' unless block_given?
-
-        @store = block
-      end
-
-      def to_h
-        value_with_context(store)
-      end
-
-      private
-
-      def store
-        @store ||= nil
-      end
-    end
-  end
-end

data/lib/request/builder/request_config/callbacks.rb

@@ -1,29 +0,0 @@
-module Request
-  module Builder
-    class RequestConfig::Callbacks < Request::Builder::RequestConfig::Base
-      [:before_validate].each do |name|
-        define_method name do |&block|
-          raise ArgumentError, 'You must provide a block' unless block
-
-          store[name] = block
-        end
-      end
-
-      def each(&block)
-        store.each do |value|
-          block.call(value)
-        end
-      end
-
-      def [] key
-        store[key]
-      end
-
-      private
-
-      def store
-        @store ||= HashWithIndifferentAccess.new
-      end
-    end
-  end
-end

data/lib/request/builder/request_config/headers.rb

@@ -1,17 +0,0 @@
-module Request
-  module Builder
-    class RequestConfig::Headers < Request::Builder::RequestConfig::Base
-      def header(key, value = nil, &block)
-        raise ArgumentError, 'Must provide a value or block' if !value && !block
-
-        store[key] = block || value
-      end
-
-      private
-
-      def store
-        @store ||= HashWithIndifferentAccess.new
-      end
-    end
-  end
-end

data/lib/request/builder/request_config/params.rb

@@ -1,17 +0,0 @@
-module Request
-  module Builder
-    class RequestConfig::Params < Request::Builder::RequestConfig::Base
-      def param(key, value = nil, &block)
-        raise ArgumentError, 'Must provide a value or block' if !value && !block
-
-        store[key] = block || value
-      end
-
-      private
-
-      def store
-        @store ||= HashWithIndifferentAccess.new
-      end
-    end
-  end
-end