request-builder 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 457e80f8bbd15d0c31db2b9c22eb0cdad23d220263b046333e7f23233fd39f7c
-  data.tar.gz: b2631a86209e6e280069118793f8610360675ace8cc84841a091389220cb9c78
+  metadata.gz: 7ef65f89b3f06c126d7607aac92943b498c8f039d90f3c08edcd1b7d0487b88a
+  data.tar.gz: d7f48ebb1fff73fe3f80b6bb50ac23a1a744bcbb76078d1afb964f5b33540cf8
 SHA512:
-  metadata.gz: fccbcdc8f74870d091a5d660ea44b76b400037570db2bfa1af2516fffa14a4f1ec49625785e65062da585eb36fc8d75bb62b6395f705da6a9fd68c5d06ac93d0
-  data.tar.gz: 8040052bf21eaa5c8693abccc82959d3739684cda46145ab2921d5fc09ed734a69ff57816057126163070d403bff2a9acb9907cf6b918a6ccc0941609225a4f5
+  metadata.gz: 976ed740ebb730981e5f301e6562d00d54eaa2cb874e384840ee53845699f5871eb4ee3b725d0d5da3213d6ff2a17f6d2d10070e7223920d4a9368c4c3a90c44
+  data.tar.gz: '08423c1ccd725ec0e7069d94cb03cf66f5635f5ee6656204e71c3cbe3a1925e815a786a19293cc9f062159e4b366ce17cbe2ee169c36a993ce5a0aae53c3d8cf'

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/version.rb

@@ -1,5 +1,5 @@
 module Request
   module Builder
-    VERSION = "0.1.0"
+    VERSION = "0.1.1"
   end
 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,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: request-builder
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Anton Kostyuk
@@ -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: []
@@ -136,12 +136,12 @@ files:
 - 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
+  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:
@@ -160,5 +160,5 @@ requirements: []
 rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
-summary: Request DSL
+summary: Ruby Request DSL
 test_files: []