ezclient 0.6.1 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 364e89134c8a1b2d916bf1eed66ef13d5e1bb54bfe6bcbb5e031e3452ba0cb8c
-  data.tar.gz: 5e7c6c004ec2601a2c0ee1ff0a413d12d2e8de8561ede3c34bf34c660d8ca6f6
+  metadata.gz: 0f04c94ba55e1fc20af6d67ffe3e5e811fcd03ede8a16bb5270a5eacd4aa7459
+  data.tar.gz: 67f275910008833ce3b7cc0ac3ebdba937555bb4ea64c3d71d4c4611f9f497d1
 SHA512:
-  metadata.gz: dbcae1b6a8470fe15f2312c118d08729fe121b7a681c5db2fa8b99bc2fca23cf008f2c133c35788829a87d6f54490dbbce940c0c8f79860cee56d998a518c46c
-  data.tar.gz: bae8bfc733d1e567175fb60203e9901d9d13ecc689a264fcdf1441bcdc2596d113b5a18f0d5c68e977aaab0089b15ea43afffffb8cf1f4d145621cd234e480c8
+  metadata.gz: 73c1fe86f62d64d1e34ac69a8299513d451981c834f71099aa48bffabe13d65f123f33dcf9721e46ff0508c165302339337f487bb5899c1e5451bda6e41868e4
+  data.tar.gz: d222c99a6026a2b9e6b470068a7cff3819a3f41a5579a25e113888c15b42aed97fa27e31656e55f9208e452699b7ab222faafb55714ee2c12d5ec27464f6492f

data/README.md

@@ -11,6 +11,31 @@ gem "ezclient"
 gem "http", github: "httprb/http"
 ```
 
+## Usage
+```ruby
+client = EzClient.new(client_options)
+client.perform!(:get, "https://example.com", params: { a: 1 })
+# Performs a GET request to https://example.com/?a=1
+```
+
+Valid client options are:
+- `api_auth` – arguments for `ApiAuth.sign!`
+- `keep_alive` – timeout for persitent connection
+- `max_retries` – max number of retries in case of errors
+- `on_complete` – callback called on request completion
+- `on_error` – callback called on request exception
+- `retry_exceptions` – exception classes to retry
+- `ssl_context` – ssl context for requests
+- `timeout` – timeout for requests
+
+Extra request options are:
+- `params` – becomes `query` for GET and `form` for other requests
+- `query` – hash for uri query
+- `form` – hash for urlencoded body
+- `body` – raw body
+- `json` – data for json
+- `headers` – headers for request
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/umbrellio/ezclient.

data/lib/ezclient/client.rb

@@ -7,7 +7,7 @@ class EzClient::Client
   end
 
   def request(verb, url, **options)
-    options = { **default_options, **options }
+    options = { **default_options, **options } # TODO: raise on unknown options
 
     keep_alive_timeout = options.delete(:keep_alive)
     api_auth = options.delete(:api_auth)
@@ -41,14 +41,18 @@ class EzClient::Client
   end
 
   def default_options
-    {
-      api_auth: options[:api_auth],
-      keep_alive: options[:keep_alive],
-      max_retries: options[:max_retries],
-      on_complete: options[:on_complete],
-      on_error: options[:on_error],
-      retry_exceptions: options[:retry_exceptions],
-      timeout: options[:default_timeout],
-    }
+    keys = %i[
+      api_auth
+      keep_alive
+      max_retries
+      on_complete
+      on_error
+      retry_exceptions
+      ssl_context
+      timeout
+    ]
+
+    # RUBY25: Hash#slice
+    options.select { |key| keys.include?(key) }
   end
 end

data/lib/ezclient/request.rb

@@ -64,15 +64,20 @@ class EzClient::Request
 
   def http_options
     # RUBY25: Hash#slice
-    options.select { |key| [:params, :form, :json, :body, :headers].include?(key) }
+    opts = options.select { |key| [:json, :body, :headers].include?(key) }
+    opts[verb == "GET" ? :params : :form] = options[:params]
+    opts[:params] = options[:query] if options[:query]
+    opts[:form] = options[:form] if options[:form]
+    opts
   end
 
   def perform_request
     retries = 0
+    request_options = http_client.default_options.merge(ssl_context: options[:ssl_context])
 
     begin
       retry_on_connection_error do
-        http_client.perform(http_request, http_client.default_options)
+        http_client.perform(http_request, request_options)
       end
     rescue *retried_exceptions
       if retries < max_retries.to_i

data/lib/ezclient/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module EzClient
-  VERSION = "0.6.1"
+  VERSION = "0.7.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ezclient
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.7.0
 platform: ruby
 authors:
 - Yuri Smirnov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-16 00:00:00.000000000 Z
+date: 2018-02-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http
@@ -178,7 +178,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.4
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: An HTTP gem wrapper for easy persistent connections and more.