lhc 7.3.3 → 8.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 83dac4c381a05800447892414ec9f5ef164cf92e
-  data.tar.gz: 15135229c079cca688d42d7a6d08f5ae745aa178
+  metadata.gz: 8e896a6247a34efa8fb35b9ba8cdf51ad68b8a00
+  data.tar.gz: f5d30a0736bbb74ea0cb4b62e060c4edeb9cc48e
 SHA512:
-  metadata.gz: bccaf223150d3bafc8ea178ab5a7309eefba5d572a9af7e33582a00c7a7120e22762eab92d99d37f691e1cfb5a759e3033236ac552c6f44b472a5c348904a669
-  data.tar.gz: 691ba40ddcb42c761b1092f97b98ff1e1a3a7110721d1a0c9c15d4c3c5abb3d3fe4daab1725385daa6ad358f08b986f80b0e4cbc28706fecbb5532e933f13782
+  metadata.gz: 06f42cbc9182070e2d89c325a261095ea66665aa27ae3b61f6e3206158b1f960f9939997001b9f8db087c5ff439c89b059548d54eaceb44ae7f106d73ae931a3
+  data.tar.gz: 663cfcbe61d6e9b220dc6073c1c1c9e4c576981984c304f60945fd30d01ca7c2c14e6aa040270439e15134b2178d8deba39d4c9141d65d214979e9382a47d99b

data/README.md

@@ -241,7 +241,7 @@ To monitor and manipulate the http communication done with LHC, you can define i
 ```ruby
   class TrackingIdInterceptor < LHC::Interceptor
 
-    def before_request(request)
+    def before_request
       request.params[:tid] = 123
     end
   end

data/docs/interceptors.md

@@ -6,7 +6,7 @@ Interceptors
 ```ruby
   class TrackingIdInterceptor < LHC::Interceptor
 
-    def before_request(request)
+    def before_request
       request.params[:tid] = 123
     end
   end
@@ -27,15 +27,20 @@ like [Caching](/docs/interceptors/caching.md), [Monitoring](/docs/interceptors/m
 
 ## Callbacks
 
-`before_raw_request(request)` is called before the raw typhoeus request is prepared/created.
+`before_raw_request` is called before the raw typhoeus request is prepared/created.
+
+`before_request` is called when the request is prepared and about to be executed.
+
+`after_request` is called after request was started.
+
+`before_response` is called when response started to arrive.
 
-`before_request(request)` is called when the request is prepared and about to be executed.
+`after_response` is called after the response arrived completely.
 
-`after_request(request)` is called after request was started.
 
-`before_response(request)` is called when response started to arrive.
+## Attributes: Request/Response
 
-`after_response(response)` is called after the response arrived completely.
+Every interceptor can directly access their instance `request` or `response`.
 
 → [Read more about the request object](request.md)
 

data/lib/lhc.rb

@@ -1,6 +1,5 @@
 require 'typhoeus'
 require 'active_support/core_ext/object/blank'
-require 'active_support/core_ext/hash/keys'
 
 module LHC
   autoload :BasicMethodsConcern,
@@ -106,8 +105,8 @@ module LHC
 
   autoload :Interceptor,
     'lhc/interceptor'
-  autoload :InterceptorProcessor,
-    'lhc/interceptor_processor'
+  autoload :Interceptors,
+    'lhc/interceptors'
   autoload :Formats,
     'lhc/formats'
   autoload :Monitoring,

data/lib/lhc/interceptor.rb

@@ -1,14 +1,24 @@
 class LHC::Interceptor
 
-  def before_raw_request(request); end
+  attr_reader :request
 
-  def before_request(request); end
+  def initialize(request)
+    @request = request
+  end
+
+  def response
+    @request.response
+  end
+
+  def before_raw_request; end
+
+  def before_request; end
 
-  def after_request(request); end
+  def after_request; end
 
-  def before_response(request); end
+  def before_response; end
 
-  def after_response(response); end
+  def after_response; end
 
   # Prevent Interceptors from beeing duplicated!
   # Their classes have flag-character.

data/lib/lhc/interceptors.rb

@@ -0,0 +1,24 @@
+# Handles interceptions during the lifecycle of a request
+# Represents all active interceptors for a request/response.
+class LHC::Interceptors
+
+  attr_accessor :all
+
+  # Intitalizes and determines if global or local interceptors are used
+  def initialize(request)
+    self.all = (request.options[:interceptors] || LHC.config.interceptors).map do |interceptor|
+      interceptor.new(request)
+    end
+  end
+
+  # Forwards messages to interceptors and handles provided responses.
+  def intercept(name)
+    all.each do |interceptor|
+      result = interceptor.send(name)
+      if result.is_a? LHC::Response
+        fail 'Response already set from another interceptor' if @response
+        @response = interceptor.request.response = result
+      end
+    end
+  end
+end

data/lib/lhc/interceptors/auth.rb

@@ -1,6 +1,6 @@
 class LHC::Auth < LHC::Interceptor
 
-  def before_request(request)
+  def before_request
     options = request.options[:auth] || {}
     authenticate!(request, options)
   end

data/lib/lhc/interceptors/caching.rb

@@ -8,7 +8,7 @@ class LHC::Caching < LHC::Interceptor
   # Options forwarded to the cache
   FORWARDED_OPTIONS = [:expires_in, :race_condition_ttl]
 
-  def before_request(request)
+  def before_request
     return unless cache?(request)
     deprecation_warning(request.options)
     options = options(request.options)
@@ -19,7 +19,7 @@ class LHC::Caching < LHC::Interceptor
     from_cache(request, response_data)
   end
 
-  def after_response(response)
+  def after_response
     return unless response.success?
     request = response.request
     return unless cache?(request)

data/lib/lhc/interceptors/default_timeout.rb

@@ -6,7 +6,7 @@ class LHC::DefaultTimeout < LHC::Interceptor
   CONNECTTIMEOUT = 2 # seconds
   TIMEOUT = 15 # seconds
 
-  def before_raw_request(request)
+  def before_raw_request
     request_options = (request.options || {})
     request_options[:timeout] ||= timeout || TIMEOUT
     request_options[:connecttimeout] ||= connecttimeout || CONNECTTIMEOUT

data/lib/lhc/interceptors/monitoring.rb

@@ -9,18 +9,18 @@ class LHC::Monitoring < LHC::Interceptor
 
   config_accessor :statsd
 
-  def before_request(request)
+  def before_request
     return unless statsd
     LHC::Monitoring.statsd.count("#{key(request)}.before_request", 1)
   end
 
-  def after_request(request)
+  def after_request
     return unless statsd
     LHC::Monitoring.statsd.count("#{key(request)}.count", 1)
     LHC::Monitoring.statsd.count("#{key(request)}.after_request", 1)
   end
 
-  def after_response(response)
+  def after_response
     return unless statsd
     key = key(response)
     LHC::Monitoring.statsd.timing("#{key}.time", response.time) if response.success?

data/lib/lhc/interceptors/prometheus.rb

@@ -15,14 +15,15 @@ class LHC::Prometheus < LHC::Interceptor
     [LHC::Prometheus.namespace, 'lhc_times'].join('_').to_sym
   end
 
-  def initialize
+  def initialize(request)
+    super(request)
     return if LHC::Prometheus.registered || LHC::Prometheus.client.blank?
     LHC::Prometheus.client.registry.counter(LHC::Prometheus.request_key, 'Counter of all LHC requests.')
     LHC::Prometheus.client.registry.histogram(LHC::Prometheus.times_key, 'Times for all LHC requests.')
     LHC::Prometheus.registered = true
   end
 
-  def after_response(response)
+  def after_response
     return if !LHC::Prometheus.registered || LHC::Prometheus.client.blank?
     LHC::Prometheus.client.registry
       .get(LHC::Prometheus.request_key)

data/lib/lhc/interceptors/retry.rb

@@ -5,7 +5,7 @@ class LHC::Retry < LHC::Interceptor
     attr_accessor :max
   end
 
-  def after_response(response)
+  def after_response
     response.request.options[:retries] ||= 0
     return unless retry?(response.request)
     response.request.options[:retries] += 1

data/lib/lhc/interceptors/rollbar.rb

@@ -1,7 +1,7 @@
 class LHC::Rollbar < LHC::Interceptor
   include ActiveSupport::Configurable
 
-  def after_response(response)
+  def after_response
     return unless Object.const_defined?('Rollbar')
     return if response.success?
     request = response.request

data/lib/lhc/request.rb

@@ -16,11 +16,11 @@ class LHC::Request
     self.error_handler = options.delete :error_handler
     use_configured_endpoint!
     generate_url_from_template!
-    self.iprocessor = LHC::InterceptorProcessor.new(self)
-    iprocessor.intercept(:before_raw_request, self)
+    self.interceptors = LHC::Interceptors.new(self)
+    interceptors.intercept(:before_raw_request)
     self.raw = create_request
     self.format = options.delete('format') || LHC::Formats::JSON.new
-    iprocessor.intercept(:before_request, self)
+    interceptors.intercept(:before_request)
     run! if self_executing && !response
   end
 
@@ -50,7 +50,7 @@ class LHC::Request
 
   private
 
-  attr_accessor :iprocessor
+  attr_accessor :interceptors
 
   def optionally_encoded_url(options)
     return options[:url] unless options.fetch(:url_encoding, true)
@@ -60,8 +60,8 @@ class LHC::Request
   def create_request
     request = Typhoeus::Request.new(optionally_encoded_url(options), typhoeusize(options))
     request.on_headers do
-      iprocessor.intercept(:after_request, self)
-      iprocessor.intercept(:before_response, self)
+      interceptors.intercept(:after_request)
+      interceptors.intercept(:before_response)
     end
     request.on_complete { |response| on_complete(response) }
     request
@@ -111,7 +111,7 @@ class LHC::Request
 
   def on_complete(response)
     self.response = LHC::Response.new(response, self)
-    iprocessor.intercept(:after_response, self.response)
+    interceptors.intercept(:after_response)
     handle_error(self.response) unless self.response.success?
   end
 

data/lib/lhc/version.rb

@@ -1,3 +1,3 @@
 module LHC
-  VERSION ||= '7.3.3'
+  VERSION ||= '8.0.0'
 end

data/spec/basic_methods/request_without_rails_spec.rb

@@ -1,28 +1,9 @@
 require 'spec_helper'
 
 describe LHC do
-  context 'GET' do
-    before do
-      stub_request(:get, "http://datastore/v2/feedbacks").to_return(status: 200, body: "{}")
-    end
+  context 'request' do
     it "is able to call .request without LHC raising NoMethodError: undefined method `blank?' for nil:NilClass when calling it outside of the rails context" do
-      expect { LHC.request(url: "http://datastore/v2/feedbacks", method: :get) }.not_to raise_error
-    end
-  end
-
-  context 'POST' do
-    before do
-      stub_request(:post, "http://datastore/v2/feedbacks").to_return(status: 200, body: "{}")
-    end
-
-    it "is able to call .request without LHC raising NoMethodError: undefined method `deep_symbolize_keys' for {}:Hash" do
-      options = {
-        url: "http://datastore/v2/feedbacks",
-        method: :post,
-        body: "{}",
-        headers: { 'Content-Type' => 'application/json' }
-      }
-      expect { LHC.request(options) }.not_to raise_error
+      expect { LHC.request(url: "http://datastore/v2/feedbacks", method: :get) }.not_to raise_error(NoMethodError)
     end
   end
 end

data/spec/interceptors/after_request_spec.rb

@@ -4,7 +4,7 @@ describe LHC do
   context 'interceptor' do
     before(:each) do
       class SomeInterceptor < LHC::Interceptor
-        def after_request(request); end
+        def after_request; end
       end
       LHC.configure { |c| c.interceptors = [SomeInterceptor] }
     end

data/spec/interceptors/after_response_spec.rb

@@ -11,7 +11,7 @@ describe LHC do
 
     before(:each) do
       class StatsTimingInterceptor < LHC::Interceptor
-        def after_response(response)
+        def after_response
           uri = URI.parse(response.request.url)
           path = [
             'web',

data/spec/interceptors/before_request_spec.rb

@@ -4,7 +4,7 @@ describe LHC do
   context 'interceptor' do
     before(:each) do
       class TrackingIdInterceptor < LHC::Interceptor
-        def before_request(request)
+        def before_request
           request.params[:tid] = 123
         end
       end

data/spec/interceptors/before_response_spec.rb

@@ -4,7 +4,7 @@ describe LHC do
   context 'interceptor' do
     before(:each) do
       class SomeInterceptor < LHC::Interceptor
-        def before_response(request); end
+        def before_response; end
       end
       LHC.configure { |c| c.interceptors = [SomeInterceptor] }
     end

data/spec/interceptors/caching/to_cache_spec.rb

@@ -6,7 +6,7 @@ describe LHC::Caching do
       expect do
         response = Typhoeus::Response.new(headers: { 'Accept' => 'application/json' })
         Marshal.dump(
-          LHC::Caching.new.send(:to_cache, response)
+          LHC::Caching.new(response).send(:to_cache, response)
         )
       end.not_to raise_error
     end

data/spec/interceptors/response_competition_spec.rb

@@ -8,7 +8,7 @@ describe LHC do
         @@cached = false
         cattr_accessor :cached
 
-        def before_request(_request)
+        def before_request
           if @@cached
             return LHC::Response.new(Typhoeus::Response.new(response_body: 'Im served from local cache'), nil)
           end
@@ -18,7 +18,7 @@ describe LHC do
 
       class RemoteCacheInterceptor < LHC::Interceptor
 
-        def before_request(request)
+        def before_request
           if request.response.nil?
             return LHC::Response.new(Typhoeus::Response.new(response_body: 'Im served from remote cache'), nil)
           end

data/spec/interceptors/return_response_spec.rb

@@ -5,7 +5,7 @@ describe LHC do
     before(:each) do
       class CacheInterceptor < LHC::Interceptor
 
-        def before_request(_request)
+        def before_request
           LHC::Response.new(Typhoeus::Response.new(response_body: 'Im served from cache'), nil)
         end
       end
@@ -20,7 +20,7 @@ describe LHC do
     context 'misusage' do
       before(:each) do
         class AnotherInterceptor < LHC::Interceptor
-          def before_request(_request)
+          def before_request
             LHC::Response.new(Typhoeus::Response.new({}), nil)
           end
         end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lhc
 version: !ruby/object:Gem::Version
-  version: 7.3.3
+  version: 8.0.0
 platform: ruby
 authors:
 - https://github.com/local-ch/lhc/contributors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-07 00:00:00.000000000 Z
+date: 2018-03-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -217,7 +217,7 @@ files:
 - lib/lhc/formats.rb
 - lib/lhc/formats/json.rb
 - lib/lhc/interceptor.rb
-- lib/lhc/interceptor_processor.rb
+- lib/lhc/interceptors.rb
 - lib/lhc/interceptors/auth.rb
 - lib/lhc/interceptors/caching.rb
 - lib/lhc/interceptors/default_timeout.rb
@@ -364,7 +364,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements:
 - Ruby >= 2.0.0
 rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
 summary: LocalHttpClient

data/lib/lhc/interceptor_processor.rb

@@ -1,24 +0,0 @@
-# Handles interceptions during the lifecycle of a request
-class LHC::InterceptorProcessor
-
-  attr_accessor :interceptors
-
-  # Intitalizes the processor and determines if global or local interceptors are used
-  def initialize(target)
-    options = target.options if target.is_a? LHC::Request
-    options ||= target.request.options if target.is_a? LHC::Response
-    self.interceptors = (options[:interceptors] || LHC.config.interceptors).map { |i| i.new }
-  end
-
-  # Forwards messages to interceptors and handles provided responses.
-  def intercept(name, target)
-    interceptors.each do |interceptor|
-      result = interceptor.send(name, target)
-      if result.is_a? LHC::Response
-        fail 'Response already set from another interceptor' if @response
-        request = target.is_a?(LHC::Request) ? target : target.request
-        @response = request.response = result
-      end
-    end
-  end
-end