lhc-core-interceptors 2.4.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 06055f3a1962c8675da6aa73da1256fbe733e02f
-  data.tar.gz: c504a736602334e94a6f5ddbc6d55e5eee46fc13
+  metadata.gz: 16bce23e32361c1e5c4a8363136c80654bf8aa8b
+  data.tar.gz: 6b3844d8f2aae9522f760007f83ce93221f75118
 SHA512:
-  metadata.gz: b81ad3581b2a80274c96f12b39be97132a38e3ac1ccb0d7bc2c1d85efa51a9bc0e332d6f0226b7cc233267abe26680eee195a0a56461cafdcee0ba800fbac94f
-  data.tar.gz: 9dc9f095a8a3560827fb25607e92e6d071bc5351bed5432d9c27ca1d1a38db3b788101fc0b13b83f0305103b2919380ec81a074000d4ad092746fbf2d6109b25
+  metadata.gz: ccfc9da67e8473de4975c071552c293894c3d9722d10c1623710eb8926c7e111754ff2050dfd5cbc5b874f247752580e87d104208034496b4087ef133ae5d228
+  data.tar.gz: fac37b477195608abc57dfe6609abfcfcebfd4a2132400a72adee3aec735de6c6ca7afcf8fd941e3943fbc5d76009aaa56324e9e7928fdfd54dca67b41fdb803

data/README.md

@@ -1,173 +1,2 @@
-LHC Core Interceptors
-===
-
-The following set of interceptors can be used with [LHC](https://github.com/local-ch/lhc).
-
-## Cache Interceptor
-
-Add the cache interceptor to your basic set of LHC interceptors.
-
-```ruby
-  LHC.config.interceptors = [LHC::Caching]
-```
-
-You can configure your own cache (default Rails.cache) and logger (default Rails.logger):
-
-```ruby
-  LHC::Caching.cache = ActiveSupport::Cache::MemoryStore.new
-  LHC::Caching.logger = Logger.new(STDOUT)
-```
-
-
-Caching is not enabled by default, although you added it to your basic set of interceptors.
-If you want to have requests served/stored and stored in/from cache, you have to enable it by request.
-
-```ruby
-  LHC.get('http://local.ch', cache: true)
-```
-
-You can also enable caching when configuring an endpoint in LHS.
-
-```ruby
-  class Feedbacks < LHS::Service
-    endpoint ':datastore/v2/feedbacks', cache: true
-  end
-```
-
-### Cache Interceptor Options
-
-```ruby
-  LHC.get('http://local.ch', cache: true, cache_expires_in: 1.day, cache_race_condition_ttl: 15.seconds)
-```
-
-`cache_expires_in` lets the cache expires every X seconds.
-
-Set the key that is used for caching by using the `cache_key` option. Every key is prefixed with `LHC_CACHE: `.
-
-Setting `cache_race_condition_ttl` is very useful in situations where a cache entry is used very frequently and is under heavy load.
-If a cache expires and due to heavy load several different processes will try to read data natively and then they all will try to write to cache.
-To avoid that case the first process to find an expired cache entry will bump the cache expiration time by the value set in `cache_race_condition_ttl`.
-
-### Testing
-
-Add to your spec_helper.rb:
-
-```ruby
-  require 'lhc-core-interceptors/test/cache_helper.rb'
-```
-
-This will initialize a MemoryStore cache for LHC::Caching interceptor and resets the cache before every test.
-
-## Monitoring Interceptor
-
-Add the monitoring interceptor to your basic set of LHC interceptors.
-
-```ruby
-  LHC.config.interceptors = [LHC::Monitoring]
-```
-
-You also have to configure statsd in order to have the monitoring interceptor report.
-
-```ruby
-  LHC::Monitoring.statsd = <your-instance-of-statsd>
-```
-
-The monitoring interceptor reports all the HTTP communication done with LHS.
-It reports the trial always.
-
-In case of a successful response it reports the response code with a count and the response time with a gauge value.
-
-```ruby
-  LHC.get('http://local.ch')
-
-  "lhc.<app_name>.<env>.<host>.<http_method>.count", 1
-  "lhc.<app_name>.<env>.<host>.<http_method>.200", 1
-  "lhc.<app_name>.<env>.<host>.<http_method>.time", 43
-```
-
-In case your workers/processes are getting killed due limited time constraints, 
-you are able to detect deltas with relying on "before_request", and "after_request" counts:
-
-```ruby
-  "lhc.<app_name>.<env>.<host>.<http_method>.before_request", 1
-  "lhc.<app_name>.<env>.<host>.<http_method>.after_request", 1
-```
-
-Timeouts are also reported:
-
-```ruby
-  "lhc.<app_name>.<env>.<host>.<http_method>.timeout", 1
-```
-
-All the dots in the host are getting replaced with underscore (_), because dot is the default separator in graphite.
-
-It is also possible to set the key for Monitoring Interceptor on per request basis:
-
-```ruby
-  LHC.get('http://local.ch', monitoring_key: 'local_website')
-
-  "local_website.count", 1
-  "local_website.200", 1
-  "local_website.time", 43
-```
-
-If you use this approach you need to add all namespaces (app, environment etc.) to the key on your own.
-
-
-### Auth Interceptor
-
-Add the auth interceptor to your basic set of LHC interceptors.
-
-```ruby
-  LHC.config.interceptors = [LHC::Auth]
-```
-
-#### Bearer Authentication
-
-```ruby
-  LHC.get('http://local.ch', auth: { bearer: -> { access_token } })
-```
-
-Adds the following header to the request:
-```
-  'Authorization': 'Bearer 123456'
-```
-
-Assuming the method `access_token` responds on runtime of the request with `123456`.
-
-#### Basic Authentication
-
-```ruby
-  LHC.get('http://local.ch', auth: { basic: { username: 'steve', password: 'can' } })
-```
-
-Adds the following header to the request:
-```
-  'Authorization': 'Basic c3RldmU6Y2Fu'
-```
-
-Which is the base64 encoded credentials "username:password".
-
-## Rollbar Interceptor
-
-Forward errors to rollbar when exceptions occur during http requests.
-
-```ruby
-  LHC.config.interceptors = [LHC::Rollbar]
-```
-
-```ruby
-  LHC.get('http://local.ch')
-```
-
-If it raises, it forwards the request and response object to rollbar, which contain all necessary data.
-
-### Forward additional parameters
-
-```ruby
-  LHC.get('http://local.ch', rollbar: { tracking_key: 'this particular request' })
-```
-
-## License
-
-[GNU Affero General Public License Version 3.](https://www.gnu.org/licenses/agpl-3.0.en.html)
+# DEPRECATED
+Merged into lhc: https://github.com/local-ch/lhc/blob/master/docs/interceptors.md

data/lhc-core-interceptors.gemspec

@@ -7,11 +7,11 @@ require "lhc-core-interceptors/version"
 Gem::Specification.new do |s|
   s.name        = "lhc-core-interceptors"
   s.version     = LHCCoreInterceptors::VERSION
-  s.authors     = ['local.ch']
+  s.authors     = ['https://github.com/local-ch/lhc-core-interceptors/graphs/contributors']
   s.email       = ['ws-operations@local.ch']
   s.homepage    = 'https://github.com/local-ch/lhc-core-interceptors'
-  s.summary     = 'A set of interceptors'
-  s.description = 'A set of useful interceptors to use with LHC (like caching, monitoring etc.)'
+  s.summary     = '[DEPRECATED] Merged into lhc: https://github.com/local-ch/lhc/blob/master/docs/interceptors.md'
+  s.description = '[DEPRECATED] Merged into lhc: https://github.com/local-ch/lhc/blob/master/docs/interceptors.md'
 
   s.files        = `git ls-files`.split("\n")
   s.test_files   = `git ls-files -- spec/*`.split("\n")

data/lib/lhc-core-interceptors/version.rb

@@ -1,3 +1,3 @@
 module LHCCoreInterceptors
-  VERSION = '2.4.0'
+  VERSION = '3.0.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lhc-core-interceptors
 version: !ruby/object:Gem::Version
-  version: 2.4.0
+  version: 3.0.0
 platform: ruby
 authors:
-- local.ch
+- https://github.com/local-ch/lhc-core-interceptors/graphs/contributors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-23 00:00:00.000000000 Z
+date: 2017-04-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lhc
@@ -108,8 +108,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: A set of useful interceptors to use with LHC (like caching, monitoring
-  etc.)
+description: "[DEPRECATED] Merged into lhc: https://github.com/local-ch/lhc/blob/master/docs/interceptors.md"
 email:
 - ws-operations@local.ch
 executables: []
@@ -215,7 +214,7 @@ rubyforge_project:
 rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
-summary: A set of interceptors
+summary: "[DEPRECATED] Merged into lhc: https://github.com/local-ch/lhc/blob/master/docs/interceptors.md"
 test_files:
 - spec/auth/basic_auth_spec.rb
 - spec/auth/bearer_spec.rb