chimera_http_client 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 257cb743fce518d09b68b8ee5315a3e6fe47939b88fdbbb6c4b2cdf715058b13
-  data.tar.gz: fdd6dd4ad951507c0add3deed785ea5abef4cff538ad66be11eb2c347304c2fa
+  metadata.gz: 809d90aabfcf20ff5823e4adfba61a39c377e334ad42821c6f8f89a09decf4c8
+  data.tar.gz: 1c809df7392bd1a353b34641ae810c2f884fc72873ad917792b37455f77303bc
 SHA512:
-  metadata.gz: 8dca3db73c0e1bc12998bfc9a88534b9115be48ee6402dfa515feababb40289b75d4bbdd3ddb2f4f57c0149a965e6afa912eb2daa3f5701eb4fe4cf1f92b5b88
-  data.tar.gz: 9d5c8136c35b2459d66da1894d67f9e5cb61622ff2236f2e37de9a1e84b7d833cf0463dd3f93657300eff870dc3088e4e31f83faddf1de9b46e7031c42ff19f2
+  metadata.gz: 7e4cc3b3ed6e228f8fd1a2efb31bbcc0223e53f1f66839b669dccf6dd0f44b35f1a8e6431ed9a3f831e12f088b012d6f7abd275e820c2ef4096f4d6c7ea74c8b
+  data.tar.gz: 4fffd616c32fb55a098c5044cc7941517eb5c847420ee6d84010750dbf0f56a579a903f0f4ba55afe2f1c57dd8a9f0fd8d4d7706678da2935944981d52536287

data/README.markdown

@@ -36,6 +36,16 @@ On each request _the http-headers can be amended or overwritten_ completely or p
 In case you need to use an API that is protected by **basic_auth** just pass the credentials in the options hash:  
 `options: { username: 'admin', password: 'secret' }`
 
+### Timeout duration
+
+The default timeout duration is **3 seconds**.
+
+If you want to use a different timeout, you can pass the key `timeout` when initializing the `Connection`. You can also overwrite it on every call.
+
+### Custom logger
+
+By default no logging is happening. If you need request logging, you can pass your custom Logger to the key `logger` when initializing the `Connection`. It will write to `logger.info` when starting and when completing a request.
+
 ### Example usage
 
 To use the gem, it is recommended to write wrapper classes for the endpoints used. While it would be possible to use the `get, get!, post, post!, put, put!, patch, patch!, delete, delete!` or also the bare `request.run` methods directly, wrapper classes will unify the usage pattern and be very convenient to use by veterans and newcomers to the team. A wrapper class could look like this:
@@ -63,7 +73,7 @@ class Users
     params[:filter] = filter
     params[:page] = page
 
-    response = connection.get!('users', params: params)
+    response = connection.get!('users', params: params, timeout: 10) # set longer timeout
 
     all_users = response.parsed_body
     all_users.map { |user| User.new(id: user['id'], name: user['name'], email: user['email']) }
@@ -73,7 +83,7 @@ class Users
   end
 
   def create(body:)
-    response = connection.post!('users', body: body.to_json) # body.to_json
+    response = connection.post!('users', body: body.to_json) # body.to_json (!!)
 
     user = response.parsed_body
     User.new(id: user['id'], name: user['name'], email: user['email'])
@@ -85,7 +95,9 @@ class Users
   private
 
   def connection
-    @connection ||= ChimeraHttpClient::Connection.new(base_url: @base_url)
+    # base_url is mandatory
+    # logger and timeout are optional
+    @connection ||= ChimeraHttpClient::Connection.new(base_url: @base_url, logger: Logger.new(STDOUT), timeout: 2)
   end
 end
 ```
@@ -106,6 +118,8 @@ To create and fetch a user from a remote service with the `Users` wrapper listed
 
 Usually it does not have to be used directly. It is the class that executes the `Typhoeus::Requests`, raises `Errors` on failing and returns `Response` objects on successful calls.
 
+The `body` which it receives from the `Connection` class has to be in the in the (serialized) form in which the endpoint expects it. Usually this means you have to pass a JSON string to the `body` (it will **not** be serialized automatically).
+
 It will be expanded by a `.queue` method, that will queue (sic) calls and run them in parallel and not run every call directly, like the `.run` method does.
 
 ## The Response class
@@ -169,10 +183,18 @@ After checking out the repo, run `rake` to run the **tests and rubocop**.
 
 You can also run `rake console` to open an irb session with the `ChimeraHttpClient` pre-loaded 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).
+To build and install this gem onto your local machine, run `bundle exec rake install`.
+
+> Maintainers only:
+>
+> 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).
 
 Bug reports and pull requests are welcome on GitHub at <https://github.com/mediafinger/chimera_http_client>
 
+### Roadmap
+
+https://github.com/mediafinger/chimera_http_client/blob/master/TODO.markdown
+
 ## Chimera
 
 Why this name? First of all, I needed a unique namespace. _HttpClient_ is already used too often. And as this gem is based on **Typhoeus** I picked the name of one of his (mythological) children.

data/TODO.markdown

@@ -2,8 +2,7 @@
 
 ## Bugs
 
-* The connection_specs are testing for a Hash in the body instead for serialized JSON content
-* The implementation seems to be buggy, not handling JSON as intended
+_none known_
 
 ## Features
 
@@ -16,12 +15,12 @@
 
 ### Logger
 
-* allow to pass a logger
-* add logger.info when starting a http call
-* add logger.info when finishing a successful http call
-* add logger.warn / .error for error cases
-* include the total_time of the requests in the log
-* add example to README
+* ~allow to pass a logger~
+* ~add logger.info when starting a http call~
+* ~add logger.info when finishing a successful http call~
+* ~include the total_time of the requests in the log~
+* ~add (example) to README~
+* add logger.warn / .error for error cases (?)
 
 ### Custom Serializer
 
@@ -47,10 +46,17 @@
 * optional per connection or call
 * add example to README
 
+### Timeout
+
+* ~allow to set custom timeout per connection~
+* ~allow to set custom timeout per call~
+* ~add (example) to README~
+
 ### Release
 
-* make repo public
+* ~rename module to have unique namespace~
+* ~release to rubygems to add to the plethora of similar gems~
+* ~make repo public~
 * hook up Travis-CI
-* ensure it runs with Ruby 2.5 and newer
+* ensure it runs with Ruby 2.4 and newer
 * get feedback
-* release to rubygems to add to the plethora of similar gems

data/lib/chimera_http_client/connection.rb

@@ -5,9 +5,12 @@ module ChimeraHttpClient
   class Connection
     USER_AGENT = "ChimeraHttpClient (by mediafinger)".freeze
 
-    def initialize(base_url:, user_agent: USER_AGENT, verbose: false)
+    def initialize(base_url:, logger: nil, timeout: nil, user_agent: USER_AGENT, verbose: false)
       fail(ChimeraHttpClient::ParameterMissingError, "base_url expected, but not given") if base_url.nil?
+
       @base_url = base_url
+      @logger = logger
+      @timeout = timeout
 
       define_bang_methods
 
@@ -18,13 +21,13 @@ module ChimeraHttpClient
     end
 
     def request
-      @request ||= Request.new
+      @request ||= Request.new(logger: @logger)
     end
 
     def get(endpoint, options = {})
       headers = extract_headers(options, default_headers)
 
-      request.run(url: url(endpoint), method: :get, options: options, headers: headers)
+      request.run(url: url(endpoint), method: :get, options: augmented_options(options), headers: headers)
     end
 
     def post(endpoint, options = {})
@@ -45,18 +48,27 @@ module ChimeraHttpClient
 
     private
 
+    # Add default values to call options
+    def augmented_options(options)
+      options[:timeout] ||= @timeout
+
+      options
+    end
+
     def run_with_body(method, endpoint, options = {})
       body = extract_body(options)
       headers = extract_headers(options, default_headers)
 
-      request.run(url: url(endpoint), method: method, body: body, options: options, headers: headers)
+      request.run(url: url(endpoint), method: method, body: body, options: augmented_options(options), headers: headers)
     end
 
+    # Build URL out of @base_url and endpoint given as String or Array, while trimming redundant "/"
     def url(endpoint)
       trimmed_endpoint = Array(endpoint).map { |e| trim(e) }
       [@base_url.chomp("/"), trimmed_endpoint].flatten.reject(&:empty?).join("/")
     end
 
+    # Remove leading and trailing "/" from a give part of a String (usually URL or endpoint)
     def trim(element)
       element.to_s.sub(%r{^\/}, "").chomp("/")
     end

data/lib/chimera_http_client/request.rb

@@ -1,14 +1,18 @@
 module ChimeraHttpClient
   class Request
-    TIMEOUT_SECONDS = 5
+    TIMEOUT_SECONDS = 3
+
+    def initialize(logger: nil)
+      @logger = logger
+    end
 
     def run(url:, method:, body: nil, options: {}, headers: {})
       request_params = {
         method:          method,
         body:            body,
-        params:          options.fetch(:params, {}),
+        params:          options[:params] || {},
         headers:         headers,
-        timeout:         options.fetch(:timeout, TIMEOUT_SECONDS),
+        timeout:         options[:timeout] || TIMEOUT_SECONDS,
         accept_encoding: "gzip",
       }
 
@@ -21,9 +25,13 @@ module ChimeraHttpClient
 
       result = nil
       request.on_complete do |response|
+        @logger&.info("Completed HTTP request: #{method.upcase} #{url} " \
+          "in #{response.total_time&.round(3)}sec with status code #{response.code}")
+
         result = on_complete_handler(response)
       end
 
+      @logger&.info("Starting HTTP request: #{method.upcase} #{url}")
       request.run
 
       result

data/lib/chimera_http_client/version.rb

@@ -1,3 +1,3 @@
 module ChimeraHttpClient
-  VERSION = "0.2.1".freeze
+  VERSION = "0.3.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: chimera_http_client
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Andreas Finger
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-04-17 00:00:00.000000000 Z
+date: 2019-04-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus