chimera_http_client 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 809d90aabfcf20ff5823e4adfba61a39c377e334ad42821c6f8f89a09decf4c8
-  data.tar.gz: 1c809df7392bd1a353b34641ae810c2f884fc72873ad917792b37455f77303bc
+  metadata.gz: f53a50a92fd82daebeae2cad2156dd5a0eef366d4aec27d2ecb13fffe8f771f3
+  data.tar.gz: ef515b583ba8cbbd76286e626dfbe34cf06662710c04e441f9d4e926577962cb
 SHA512:
-  metadata.gz: 7e4cc3b3ed6e228f8fd1a2efb31bbcc0223e53f1f66839b669dccf6dd0f44b35f1a8e6431ed9a3f831e12f088b012d6f7abd275e820c2ef4096f4d6c7ea74c8b
-  data.tar.gz: 4fffd616c32fb55a098c5044cc7941517eb5c847420ee6d84010750dbf0f56a579a903f0f4ba55afe2f1c57dd8a9f0fd8d4d7706678da2935944981d52536287
+  metadata.gz: fa715d6646f2f924a67bd0049598156eaacee8b60a81d28858cddf86f8a7e42c2ae50097fd7be824d8d7ff91fd0bc1569713cb014b7e3a1859a634bf9c3d4568
+  data.tar.gz: '069987a5e71950ba299b313a93f9cb6533adfe275bbda057a076614aeb8d053fc1e574a7db588d75dfc36a7611d10260c6b0ebde9fac274474e5ef85603fe356'

data/README.markdown

@@ -1,10 +1,10 @@
 # ChimeraHttpClient
 
-When starting to split monolithic apps into smaller services, you need an easy way to access the remote data from the other apps. This chimera_http_client gem should serve as a unified way to access endpoints from other apps. And what works for the internal communication between your own apps, will also work to work with external APIs that do not offer a client for simplified access.
+When starting to split monolithic apps into smaller services, you need an easy way to access the remote data from the other apps. This chimera_http_client gem should serve as a unified way to access endpoints from other apps. 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.
 
 ## 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 (queueing and parallel requests are not implemented in the gem yet).
+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).
 
 It does not have any other runtime dependencies.
 
@@ -25,7 +25,8 @@ response = connection.get!(endpoint, params: params)
 `base_url: 'http://localhost:3000/v1'`.
 
 On this connection object, you can call methods like `#get!` or `#post!` with an endpoint and an options hash as parameters, e.g.  
-`connection.get!("users/#{id}")` or  
+`connection.get!("users/#{id}")`  
+or  
 `connection.get(['users', id], options: { headers: { '	Accept-Charset' => 'utf-8' })`  
 
 Please take note that _the endpoint can be given as a String, a Symbol, or as an Array._  
@@ -33,6 +34,8 @@ While they do no harm, there is _no need to pass leading or trailing `/` in endp
 When passing the endpoint as an Array, _it's elements are converted to Strings and concatenated with `/`._  
 On each request _the http-headers can be amended or overwritten_ completely or partially.
 
+### Basic auth
+
 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' }`
 
@@ -46,6 +49,12 @@ If you want to use a different timeout, you can pass the key `timeout` when init
 
 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.
 
+### Caching responses
+
+To cache all the reponses of a connection, just pass the optional parameter `cache` to its initializer. You can also overwrite the connection's cache configuration by passing the parameter `cache` to any `get` call.
+
+Read more about how to use it: https://github.com/typhoeus/typhoeus#caching
+
 ### 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:
@@ -58,6 +67,8 @@ class Users
     @base_url = base_url
   end
 
+  # GET one user by id and instantiate a User
+  #
   def find(id:)
     response = connection.get!(['users', id])
 
@@ -68,6 +79,8 @@ class Users
     # handle / log / raise error
   end
 
+  # GET a list of users and instantiate an Array of Users
+  #
   def all(filter: nil, page: nil)
     params = {}
     params[:filter] = filter
@@ -82,6 +95,8 @@ class Users
     # handle / log / raise error
   end
 
+  # CREATE a new user by sending attributes in a JSON body and instantiate the new User
+  #
   def create(body:)
     response = connection.post!('users', body: body.to_json) # body.to_json (!!)
 
@@ -120,7 +135,9 @@ Usually it does not have to be used directly. It is the class that executes the
 
 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.
+> Upcoming feature:
+>
+> 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
 
@@ -167,7 +184,7 @@ The error classes and their corresponding http error codes:
 
 Add this line to your application's Gemfile:
 
-    gem 'chimera_http_client', '~> 0.2'
+    gem 'chimera_http_client', '~> 0.3'
 
 And then execute:
 

data/lib/chimera_http_client/connection.rb

@@ -5,7 +5,7 @@ module ChimeraHttpClient
   class Connection
     USER_AGENT = "ChimeraHttpClient (by mediafinger)".freeze
 
-    def initialize(base_url:, logger: nil, timeout: nil, user_agent: USER_AGENT, verbose: false)
+    def initialize(base_url:, logger: nil, timeout: nil, user_agent: USER_AGENT, verbose: false, cache: nil)
       fail(ChimeraHttpClient::ParameterMissingError, "base_url expected, but not given") if base_url.nil?
 
       @base_url = base_url
@@ -17,7 +17,7 @@ module ChimeraHttpClient
       Typhoeus::Config.user_agent = user_agent
       Typhoeus::Config.verbose = verbose
       Typhoeus::Config.memoize = false
-      # Typhoeus::Config.cache
+      Typhoeus::Config.cache = cache
     end
 
     def request

data/lib/chimera_http_client/request.rb

@@ -14,6 +14,7 @@ module ChimeraHttpClient
         headers:         headers,
         timeout:         options[:timeout] || TIMEOUT_SECONDS,
         accept_encoding: "gzip",
+        cache:           options[:cache],
       }
 
       # Basic-auth support:

data/lib/chimera_http_client/version.rb

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

metadata

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