request-builder 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 457e80f8bbd15d0c31db2b9c22eb0cdad23d220263b046333e7f23233fd39f7c
+  data.tar.gz: b2631a86209e6e280069118793f8610360675ace8cc84841a091389220cb9c78
+SHA512:
+  metadata.gz: fccbcdc8f74870d091a5d660ea44b76b400037570db2bfa1af2516fffa14a4f1ec49625785e65062da585eb36fc8d75bb62b6395f705da6a9fd68c5d06ac93d0
+  data.tar.gz: 8040052bf21eaa5c8693abccc82959d3739684cda46145ab2921d5fc09ed734a69ff57816057126163070d403bff2a9acb9907cf6b918a6ccc0941609225a4f5

data/README.md

@@ -0,0 +1,44 @@
+# 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
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'request-builder'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install request-builder
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/request-builder. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/request-builder/blob/master/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Request::Builder project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/request-builder/blob/master/CODE_OF_CONDUCT.md).

data/lib/request/builder/connection.rb

@@ -0,0 +1,19 @@
+require "faraday"
+require "faraday_middleware"
+
+module Request
+  module Builder
+    module Connection
+      private
+
+      def connection
+        @_connection ||= Faraday.new(url: config.host) do |builder|
+          builder.adapter config.adapter, config.stubs
+          builder.request config.request_middleware
+          builder.response config.response_middleware
+          builder.response(:logger, config.logger, bodies: true) if config.logger
+        end
+      end
+    end
+  end
+end

data/lib/request/builder/dsl.rb

@@ -0,0 +1,26 @@
+module Request
+  module Builder
+    module Dsl
+      def self.included(base)
+        base.extend ClassMethods
+        base.class_eval do
+          def config
+            @config ||= self.class.config
+          end
+        end
+      end
+
+      module ClassMethods
+        def config
+          @config ||= RequestConfig.new
+        end
+
+        def configure(conf = nil, &block)
+          @config = conf.dup if conf
+
+          config.instance_eval(&block) if block
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,37 @@
+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

@@ -0,0 +1,21 @@
+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

@@ -0,0 +1,29 @@
+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

@@ -0,0 +1,17 @@
+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

@@ -0,0 +1,17 @@
+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

data/lib/request/builder/request_config.rb

@@ -0,0 +1,111 @@
+module Request
+  module Builder
+    class RequestConfig
+      include ValueWithContext
+
+      delegate_missing_to :context
+
+      attrs = [: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
+
+      def initialize
+        @host = nil
+        @path = '/'
+        @method = :get
+        @request_middleware = :json
+        @response_middleware = :json
+        @adapter = :net_http
+        @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
+      end
+
+      attrs.each do |attr|
+        define_method attr do |value = nil, &block|
+          if value.nil? && block.nil?
+            value_with_context(instance_variable_get("@#{attr}"))
+          else
+            instance_variable_set("@#{attr}", block || value)
+          end
+        end
+      end
+
+      [:before_validate].each do |name|
+        define_method name do |&block|
+          callbacks.send(name, &block)
+        end
+      end
+
+      def stubs(value = nil, &block)
+        if block_given?
+          @stubs.instance_eval(&block)
+        elsif value
+          @stubs = value
+        else
+          @stubs
+        end
+      end
+
+      def schema(value = nil, &block)
+        if block_given?
+          @response_schema = Dry::Schema.Params(&block)
+        elsif value
+          @response_schema = value
+        else
+          @response_schema
+        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
+      end
+
+      def param(key, value = nil, &block)
+        params_conf.param(key, value, &block)
+      end
+
+      def context=(context)
+        @context = context
+
+        [body_conf, headers_conf, params_conf, callbacks_conf].each { |cnf| cnf.context = context }
+      end
+
+      def [] property
+        instance_variable_get("@#{property}".to_sym)
+      end
+
+      Module.new do
+        singleton_class.send :define_method, :included do |host_class|
+          host_class.extend class_methods
+        end
+      end
+    end
+  end
+end

data/lib/request/builder/result.rb

@@ -0,0 +1,35 @@
+module Request
+  module Builder
+    class Result
+      attr_reader :response, :context, :body
+
+      delegate :headers, :status, to: :response
+      delegate :config, to: :context
+      delegate :schema, to: :config
+      delegate :errors, to: :schema_result
+
+      def initialize(response, context)
+        @response = response
+        @context = context
+        @before_validate = config.callbacks[:before_validate]
+        @body = @before_validate ? @before_validate.call(response.body.to_h) : response.body.to_h
+      end
+
+      def success?
+        status == 200 && schema_result.success?
+      end
+
+      def failure?
+        !success?
+      end
+
+      def schema_result
+        @schema_result ||= schema.call(body)
+      end
+
+      def full_errors
+        errors(full: true).to_h
+      end
+    end
+  end
+end

data/lib/request/builder/value_with_context.rb

@@ -0,0 +1,14 @@
+module Request
+  module Builder
+    module ValueWithContext
+      def value_with_context(obj)
+        return obj unless obj.is_a?(Proc)
+
+        case obj.arity
+        when 1, -1, -2 then instance_exec(@context, &obj)
+        else instance_exec(&obj)
+        end
+      end
+    end
+  end
+end

data/lib/request/builder/version.rb

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

data/lib/request/builder.rb

@@ -0,0 +1,77 @@
+
+require "dry-initializer"
+require "dry-schema"
+require "active_support/hash_with_indifferent_access"
+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"
+
+module Request
+  module Builder
+    def self.included(base)
+      base.extend ClassMethods
+      base.extend Dry::Initializer
+      base.include Request::Builder::Dsl
+      base.include Request::Builder::Connection
+
+      class << base
+        alias_method :__new, :new
+        def new(*args)
+          e = __new(*args)
+          e.send(:set_config_context)
+          e
+        end
+      end
+    end
+
+    module ClassMethods
+      def call(**args)
+        new(**args).call
+      end
+      alias perform call
+    end
+
+    def call
+      do_request
+      result
+    end
+    alias perform call
+
+    private
+
+    attr_reader :response
+
+    def result
+      @result ||= Result.new(response, self)
+    end
+
+    def do_request
+      @response = connection.send(config.method.downcase, config.path) do |req|
+        req.options.timeout = config.timeout
+
+        config.params.each do |key, value|
+          req.params[key] = value
+        end
+
+        config.headers.each do |key, value|
+          req.headers[key] = value
+        end
+
+        req.body = config.body
+      end
+    end
+
+    def set_config_context
+      config.context = self
+    end
+  end
+end

data/lib/request-builder.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative "request/builder"

data/request-builder.gemspec

@@ -0,0 +1,35 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require_relative 'lib/request/builder/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "request-builder"
+  spec.version       = Request::Builder::VERSION.dup
+  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.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.files         = Dir["CHANGELOG.md", "LICENSE", "README.md", "request-builder.gemspec", "lib/**/*"]
+  spec.bindir        = "bin"
+  spec.executables   = []
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "faraday", "~> 1.7.1"
+  spec.add_dependency "faraday_middleware", "~> 1.2.0"
+  spec.add_dependency "dry-schema", "~> 1.9"
+  spec.add_dependency "dry-initializer", "~> 3.0"
+
+  spec.add_runtime_dependency 'activesupport', ">= 5.0.0", "< 7.1.0"
+
+  spec.add_development_dependency "ffaker", "~> 2.21"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,164 @@
+--- !ruby/object:Gem::Specification
+name: request-builder
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Anton Kostyuk
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2022-09-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.7.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.7.1
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+- !ruby/object:Gem::Dependency
+  name: dry-schema
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: dry-initializer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 7.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 7.1.0
+- !ruby/object:Gem::Dependency
+  name: ffaker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.21'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.21'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Request DSL
+email:
+- anton.kostuk.2012@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/request-builder.rb
+- lib/request/builder.rb
+- 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
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/RainbowPonny/request-builder
+  source_code_uri: https://github.com/RainbowPonny/request-builder
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key: 
+specification_version: 4
+summary: Request DSL
+test_files: []