chimera_http_client 0.5.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5e2fa666cf4ec3fe21e1f4a8ecfb3932c5dac1cb6d0c7d16762eea73bf76fb44
-  data.tar.gz: df72864e42844dd77dcc9f64bfc23f69d73a66ee66f7589c8ef1e460524b831c
+  metadata.gz: 1a58fb6d4a20a8a2bef43186a46663abc494844ccc30cf6f2e467dd043519861
+  data.tar.gz: '08c871044cb14bfbe9de820547ec7531a2719302f30d84e8aa9d658ed9ebf197'
 SHA512:
-  metadata.gz: 52cd8916ab3bd1956753eac56a54a0c9b6130fdfbb38e9d7f2083b137097e1a585a8d205ad75f6e3b6713ee55cf66c1443b8136c22f7d48c8e0045da397612c5
-  data.tar.gz: 70f7a691115d59909ec1831d48ed1fc02f4aa7ce8057bc35cf015a4254ee1f09318b45a20cf30686548d2b0bd686644ac0df6f5f6e9e9c2303b09b5cedfbb611
+  metadata.gz: 28b48b1d2fe9b723a9b567b30be1dabdd2bdc76313f9392e4ebe30bf3a8568f729a00f7b0dbdc362099196dd5aea62ddfcceb09db15481b67ada604271a75546
+  data.tar.gz: c211bc5978a7623c8f9ddaf1a069bd4f7d0aeb8bd680b2c8e61e6f9e4b32b281768da1b3bfa364b6ef69382763ae2f03324b37fa54d5277b1ae68e1468bc5b73

data/.rubocop.yml

@@ -5,10 +5,13 @@ AllCops:
       - vendor/**/*
       - config.ru
 
+Layout/AlignHash:
+  Enabled: false
+
 # Cop supports --auto-correct.
 # Configuration parameters: EnforcedStyle, SupportedStyles, IndentationWidth.
 # SupportedStyles: special_inside_parentheses, consistent, align_braces
-Layout/IndentHash:
+Layout/IndentFirstHashElement:
   EnforcedStyle: consistent
 
 Metrics/AbcSize:

data/.ruby-version

@@ -1 +1 @@
-2.6.2
+2.6.3

data/.travis.yml

@@ -0,0 +1,26 @@
+language: ruby
+
+rvm:
+  - ruby-head
+  - 2.6
+  - 2.5
+  - 2.4
+  - jruby
+  - truffleruby
+
+matrix:
+  allow_failures:
+    - rvm: jruby
+    - rvm: truffleruby
+  fast_finish: true
+
+before_install:
+  - 'echo ''gem: --no-ri --no-rdoc'' > ~/.gemrc'
+
+bundler_args: --jobs 3 --retry 3
+
+before_script:
+
+# execute rspec tests, rubocop and bundle:audit
+script:
+  bundle exec rake

data/README.markdown

@@ -4,13 +4,17 @@ When starting to split monolithic apps into smaller services, you need an easy w
 
 And what works for the internal communication between your own apps, will also work for external APIs that do not offer a client for simplified access.
 
-It offers an **easy to learn interface** and **nice error handling**. And it enables you to **queue HTTP requests to run them in parallel** for better performance.
+It offers an **easy to learn interface** and **nice error handling**. And it enables you to **queue HTTP requests to run them in parallel** for better performance and simple aggregating of distributed data.
+
+[![Build Status](https://travis-ci.com/mediafinger/chimera_http_client.svg?branch=master)](https://travis-ci.com/mediafinger/chimera_http_client)
 
 ## Dependencies
 
-The `chimera_http_client` gem is using the _libcurl_ wrapper [**Typhoeus**](https://typhoeus.github.io/). This allows for fast requests, for caching, and for queueing requests to run them in parallel (not all features are implemented in the gem yet).
+The `chimera_http_client` gem is wrapping the **libcurl** wrapper [**Typhoeus**](https://typhoeus.github.io/) to have a more convenient interface. This allows for fast requests, for caching responses, and for queueing requests to run them in parallel. Connections are persistent by default, which saves subsequent requests from establishing a connection.
+
+The only other runtime dependency is Ruby's latest code loader [**zeitwerk**](https://github.com/fxn/zeitwerk) which is also part of Rails 6.
 
-It does not have any other runtime dependencies.
+All Ruby versions newer than **2.4** are supported.
 
 ### ENV variables
 
@@ -169,7 +173,13 @@ class Cache
 end
 ```
 
-Or use an adapter for Dalli, Redis, or Rails cache that also support an optional time-to-live `default_ttl` parameter.
+Or use an adapter for Dalli, Redis, or Rails cache that also support an optional time-to-live `default_ttl` parameter. If you use `Rails.cache` with the adapter `:memory_store` or `:mem_cache_store`, the object you would have to pass looks like this:
+
+```ruby
+require "typhoeus/cache/rails"
+
+cache: Typhoeus::Cache::Rails.new(Rails.cache, default_ttl: 600) # 600 seconds
+```
 
 Read more about how to use it: https://github.com/typhoeus/typhoeus#caching
 
@@ -348,7 +358,7 @@ To inspect the requests waiting for execution, call `queue.queued_requests`.
 
 Add this line to your application's Gemfile:
 
-    gem 'chimera_http_client', '~> 0.3'
+    gem 'chimera_http_client', '~> 0.5'
 
 And then execute:
 

data/Rakefile

@@ -1,6 +1,8 @@
+require "bundler/audit/task"
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 
+Bundler::Audit::Task.new
 RSpec::Core::RakeTask.new(:rspec)
 
 desc "Open a console with the ChimeraHttpClient loaded"
@@ -24,4 +26,4 @@ task :rubocopa do
 end
 
 desc "Run all the tests"
-task default: %i[rspec rubocop]
+task default: %i[rspec rubocop bundle:audit]

data/TODO.markdown

@@ -6,75 +6,119 @@ _none known_
 
 ## Features
 
-### HTTP Headers
+### Logger
 
-* make Connection#default_headers configurable
-* allow to set default_headers via ENV vars
-* give example how to use default_headers (e.g. request_id)
-* explain in README how to benefit from this gem in a given setting
+* [x] ~~allow to pass a logger~~
+* [x] ~~add logger.info when starting a http call~~
+* [x] ~~add logger.info when finishing a successful http call~~
+* [x] ~~include the total_time of the requests in the log~~
+* [x] ~~add (example) to README~~
+* [ ] add logger.warn / .error for error cases (?)
 
-### Logger
+### Custom De-serializer
 
-* ~~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 (?)
+* [ ] allow to pass custom deserializer
+* [ ] use custom deserializer in #parsed_body instead of default JSON parsing
+* [ ] add example to README
+
+### Queueing / running in parallel
+
+* [x] ~~allow to queue multiple requests~~
+* [x] ~~execute (up to 200) requests in parallel~~
+* [ ] allow to pass one proc / block (for all requests) to use as on_complete handler for each request
+* [ ] allow to pass one proc / block per requests) to use as on_complete handler
+* [ ] add example to README
+
+### Add server for testing
+
+* [ ] add a simple (Sinatra) server for testing
+* [ ] run (all?) tests against the server (with capybara_discoball?)
+* [ ] make server also available for console testing
+* [ ] add example to README
+
+### Enable more Typhoeus functionality
+
+* [ ] accept_encoding: "gzip"
+* [ ] connecttimeout: 1
+* [ ] cookiefile: "/path/to/file"
+* [ ] cookiejar: "/path/to/file"
+* [ ] followlocation: true
+* [ ] forbid_reuse: true
+* [ ] memoize: false
+* [ ] ssl_verifyhost: 0
+* [ ] ssl_verifypeer: false
+* [ ] verbose: true
+* [ ] Cache adapters
+* [ ] or enable to access the Typhoeos directly through Chimera?
+* [ ] add example to README
 
 ### Custom Serializer
 
-* allow to pass custom serializer
-* use custom serializer instead of expecting a JSON (or other) body
-* set header for the serializer
-* add example to README
+* [ ] allow to pass custom serializer
+* [ ] use custom serializer instead of expecting a JSON (or other) body
+* [ ] set header for the serializer
+* [ ] add example to README
 
-### Custom De-serializer
+### File Uploads
 
-* allow to pass custom deserializer
-* use custom deserializer in #parsed_body instead of default JSON parsing
-* add example to README
+* [ ] add example to README
 
-### Queueing / running in parallel
+### Streaming response bodies
 
-* ~~allow to queue multiple requests~~
-* ~~execute (up to 200) requests in parallel~~
-* allow to pass one proc / block (for all requests) to use as on_complete handler for each request
-* add example to README
+* [ ] enable to pass on_headers, on_body, on_complete procs
+* [ ] add example to README
 
-### Queueing / run requests serialized
+### HTTP Headers
 
-* allow to queue multiple requests
-* execute (up to 5) queued requests
-* allow to pass a proc (per request) to use the response for the next request
-* or just explain how to code that yourself?
-* add example to README
+* [ ] make Connection#default_headers configurable
+* [ ] allow to set default_headers via ENV vars
+* [ ] give example how to use default_headers (e.g. request_id)
+* [ ] explain in README how to benefit from this gem in a given setting
 
-### Caching
+### ~~Caching~~
 
-* ~~optional per connection or call~~
-* ~~add example to README~~
+* [x] ~~optional per connection or call~~
+* [x] ~~add example to README~~
 
-### Timeout
+### ~~Timeout~~
 
-* ~~allow to set custom timeout per connection~~
-* ~~allow to set custom timeout per call~~
-* ~~add (example) to README~~
+* [x] ~~allow to set custom timeout per connection~~
+* [x] ~~allow to set custom timeout per call~~
+* [x] ~~add (example) to README~~
 
 ### Release
 
-* ~~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.4 and newer
-* get feedback
+* [x] ~~rename module to have unique namespace~~
+* [x] ~~release to rubygems to add to the plethora of similar gems~~
+* [x] ~~make repo public~~
+* [x] ~~hook up Travis-CI~~
+* [x] ~~ensure it runs with Ruby 2.4 and newer~~
 
-### File Uploads
+### Retry Requests
 
-* add example to README
+* [ ] either leverage Hydra to retry failed calls
+  * [ ] configure number of retries
+  * [ ] configure delay between retries
+  * [ ] retry idempotent calls GET, PUT, DELETE, HEAD automatically
+* [ ] maybe implement retries with wait and Redis (external dependency!)
+* [ ] or document in README how to build a retry mechanism
+  * [ ] https://gist.github.com/kunalmodi/2939288
 
-### Streaming response bodies
+### Queueing / run requests serialized
 
-* enable to pass on_headers, on_body, on_complete procs
-* add example to README
+* [ ] allow to queue multiple requests
+* [ ] execute (up to 5) queued requests
+* [ ] allow to pass a on_handler proc (per request) that could involve queueing new requests
+* [ ] or just explain how to code that yourself?
+* [ ] add example to README
+
+### Rate limiting
+
+* [ ] implement with different strategies
+  * [ ] max concurrent requests
+  * [ ] max requests in fixed time frame
+  * [ ] max requests in sliding time window
+* [ ] implement counters in Redis (external dependency!)
+* [ ] add metrics / monitoring
+* [ ] don't add throttling?
+* [ ] add example to README

data/chimera_http_client.gemspec

@@ -19,9 +19,11 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_runtime_dependency "typhoeus", "~> 1.1"
+  spec.add_runtime_dependency "zeitwerk", ">= 2.0"
 
   spec.add_development_dependency "awesome_print", "~> 1.8"
-  spec.add_development_dependency "bundler",       "~> 1.13"
+  spec.add_development_dependency "bundler",       ">= 1.0"
+  spec.add_development_dependency "bundler-audit", "~> 0.6"
   spec.add_development_dependency "irb",           "~> 1.0"
   spec.add_development_dependency "rake",          ">= 10.0"
   spec.add_development_dependency "rspec",         "~> 3.0"

data/lib/chimera_http_client/base.rb

@@ -9,10 +9,10 @@ module ChimeraHttpClient
       @logger = logger
       @timeout = timeout
 
+      Typhoeus::Config.cache = cache
+      Typhoeus::Config.memoize = false # hydra setting, prevents a possible memory leak
       Typhoeus::Config.user_agent = user_agent
       Typhoeus::Config.verbose = verbose
-      Typhoeus::Config.memoize = false
-      Typhoeus::Config.cache = cache
     end
 
     private
@@ -27,7 +27,9 @@ module ChimeraHttpClient
     def extract_body(options)
       body = options.delete(:body)
       body_optional = options.delete(:body_optional)
+
       fail(ChimeraHttpClient::ParameterMissingError, "body expected, but not given") if body.nil? && !body_optional
+
       body
     end
 

data/lib/chimera_http_client/connection.rb

@@ -6,6 +6,7 @@ module ChimeraHttpClient
     def initialize(options = {})
       super(options)
 
+      define_http_methods
       define_bang_methods
     end
 
@@ -13,43 +14,41 @@ module ChimeraHttpClient
       @request ||= Request.new(logger: @logger)
     end
 
-    def get(endpoint, options = {})
-      run(:get, endpoint, options.merge(body_optional: true))
-    end
-
-    def post(endpoint, options = {})
-      run(:post, endpoint, options)
-    end
-
-    def put(endpoint, options = {})
-      run(:put, endpoint, options)
-    end
-
-    def patch(endpoint, options = {})
-      run(:patch, endpoint, options)
-    end
-
-    def delete(endpoint, options = {})
-      run(:delete, endpoint, options.merge(body_optional: true))
-    end
-
     private
 
     def run(method, endpoint, options = {})
+      options[:body_optional] = true if %i[get delete head options trace].include?(method)
       body = extract_body(options)
       headers = extract_headers(options, default_headers)
 
       request.run(url: url(endpoint), method: method, body: body, options: augmented_options(options), headers: headers)
     end
 
-    # get! post! put! patch! delete! return an Response when successful, but raise an Error otherwise
+    # Define simple access methods that return a Response object in success case and an Error object otherwise
+    #
+    # def get(endpoint, options = {})
+    #   run(:get, endpoint, options)
+    # end
+    #
+    def define_http_methods
+      %i[get post put patch delete head options trace].each do |method_name|
+        self.class.send(:define_method, method_name) do |endpoint, options = {}|
+          send(:run, method_name, endpoint, options)
+        end
+      end
+    end
+
+    # get! post! put! patch! delete! ... return a Response object when successful, but raise an Error otherwise
     def define_bang_methods
       {
-        get!:    :get,
-        post!:   :post,
-        put!:    :put,
-        patch!:  :patch,
-        delete!: :delete,
+        get!:     :get,
+        post!:    :post,
+        put!:     :put,
+        patch!:   :patch,
+        delete!:  :delete,
+        head!:    :head,
+        options!: :options,
+        trace!:   :trace,
       }.each do |method_name, implemented_method|
         self.class.send(:define_method, method_name) do |endpoint, options = {}|
           result = public_send(implemented_method, endpoint, options)

data/lib/chimera_http_client/error.rb

@@ -29,7 +29,7 @@ module ChimeraHttpClient
       error
     end
 
-    def to_json
+    def to_json(_options = {})
       error = {
         code:        code,
         error_class: self.class.name,

data/lib/chimera_http_client/queue.rb

@@ -2,20 +2,15 @@ module ChimeraHttpClient
   class Queue < Base
     def add(method, endpoint, options = {})
       http_method = method.downcase.to_sym
-      options[:body_optional] = true if %i[get delete].include?(http_method)
+      options[:body_optional] = true if %i[get delete head options trace].include?(http_method)
 
-      body = extract_body(options)
-      headers = extract_headers(options, default_headers)
-
-      req = Request.new(logger: @logger).create(
-        url: url(endpoint),
+      queued_requests << create_request(
         method: http_method,
-        body: body,
-        options: augmented_options(options),
-        headers: headers
+        url: url(endpoint),
+        body: extract_body(options),
+        headers: extract_headers(options, default_headers),
+        options: augmented_options(options)
       )
-
-      queued_requests << req
     end
 
     def execute
@@ -42,6 +37,16 @@ module ChimeraHttpClient
 
     private
 
+    def create_request(method:, url:, body:, headers:, options:)
+      Request.new(logger: @logger).create(
+        method: method,
+        url: url,
+        body: body,
+        headers: headers,
+        options: options
+      )
+    end
+
     def hydra
       @hydra ||= Typhoeus::Hydra.new
     end

data/lib/chimera_http_client/version.rb

@@ -1,3 +1,3 @@
 module ChimeraHttpClient
-  VERSION = "0.5.0".freeze
+  VERSION = "1.0.0".freeze
 end

data/lib/chimera_http_client.rb

@@ -1,8 +1,8 @@
 module ChimeraHttpClient
-  ROOT_PATH = File.expand_path("..", __dir__)
-
   require "json"
   require "typhoeus"
+  require "zeitwerk"
 
-  Dir.glob(ROOT_PATH + "/lib/chimera_http_client/*.rb") { |file| require file }
+  loader = Zeitwerk::Loader.for_gem
+  loader.setup
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: chimera_http_client
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Andreas Finger
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-05-16 00:00:00.000000000 Z
+date: 2019-06-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: awesome_print
   requirement: !ruby/object:Gem::Requirement
@@ -40,18 +54,32 @@ dependencies:
         version: '1.8'
 - !ruby/object:Gem::Dependency
   name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: bundler-audit
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: '0.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: '0.6'
 - !ruby/object:Gem::Dependency
   name: irb
   requirement: !ruby/object:Gem::Requirement
@@ -133,6 +161,7 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".ruby-version"
+- ".travis.yml"
 - Gemfile
 - LICENSE
 - README.markdown