lhc 3.4.0 → 3.5.0

data/lib/lhc/error.rb

@@ -1,6 +1,6 @@
 class LHC::Error < StandardError
 
-  attr_accessor :response
+  attr_accessor :response, :_message
 
   def self.map
     {
@@ -48,6 +48,7 @@ class LHC::Error < StandardError
 
   def initialize(message, response)
     super(message)
+    self._message = message
     self.response = response
   end
 
@@ -58,6 +59,7 @@ class LHC::Error < StandardError
     debug << "Params: #{request.options}"
     debug << "Response Code: #{response.code}"
     debug << response.body
+    debug << _message
     debug.join("\n")
   end
 end

data/lib/lhc/errors/parser_error.rb

@@ -0,0 +1,4 @@
+require File.dirname(__FILE__) + '/../error'
+
+class LHC::ParserError < LHC::Error
+end

data/lib/lhc/formats/json.rb

@@ -1,10 +1,24 @@
-module JsonFormat
-
+class JsonFormat
   include LHC::BasicMethods
 
   def self.request(options)
     options[:headers] ||= {}
     options[:headers]['Content-Type'] = 'application/json'
-    response = super(options)
+    options[:format] = new
+    super(options)
+  end
+
+  def parse(response)
+    JSON.parse(response.body, object_class: OpenStruct)
+  rescue JSON::ParserError => e
+    raise LHC::ParserError.new(e.message, response)
+  end
+
+  def to_s
+    'json'
+  end
+
+  def to_sym
+    to_s.to_sym
   end
-end
+end

data/lib/lhc/interceptor.rb

@@ -1,9 +1,11 @@
 class LHC::Interceptor
 
   def before_request(request); end
+
   def after_request(request); end
 
   def before_response(request); end
+
   def after_response(response); end
 
 end

data/lib/lhc/interceptor_processor.rb

@@ -7,7 +7,7 @@ class LHC::InterceptorProcessor
   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 }
+    self.interceptors = (options[:interceptors] || LHC.config.interceptors).map { |i| i.new }
   end
 
   # Forwards messages to interceptors and handles provided responses.

data/lib/lhc/request.rb

@@ -9,7 +9,7 @@ class LHC::Request
 
   TYPHOEUS_OPTIONS = [:params, :method, :body, :headers, :follow_location]
 
-  attr_accessor :response, :options, :raw
+  attr_accessor :response, :options, :raw, :format
 
   def initialize(options, self_executing = true)
     self.options = options.deep_dup || {}
@@ -17,6 +17,7 @@ class LHC::Request
     generate_url_from_template!
     self.iprocessor = LHC::InterceptorProcessor.new(self)
     self.raw = create_request
+    self.format = options.delete('format') || JsonFormat.new
     iprocessor.intercept(:before_request, self)
     raw.run if self_executing && !response
   end
@@ -60,7 +61,7 @@ class LHC::Request
     options = options.deep_dup
     easy = Ethon::Easy.new
     options.delete(:url)
-    options.each do |key, v|
+    options.each do |key, _v|
       next if TYPHOEUS_OPTIONS.include? key
       method = "#{key}="
       options.delete key unless easy.respond_to?(method)
@@ -71,23 +72,24 @@ class LHC::Request
   # Get configured endpoint and use it for doing the request.
   # Explicit request options are overriding configured options.
   def use_configured_endpoint!
-    endpoint = LHC.config.endpoints[self.options[:url]]
+    endpoint = LHC.config.endpoints[options[:url]]
     return unless endpoint
     # explicit options override endpoint options
-    new_options = endpoint.options.deep_merge(self.options)
+    new_options = endpoint.options.deep_merge(options)
     # set new options
     self.options = new_options
-    self.options[:url] = endpoint.url
+    options[:url] = endpoint.url
   end
 
   # Generates URL from a URL template
   def generate_url_from_template!
     endpoint = LHC::Endpoint.new(options[:url])
-    params = if options[:body] && options[:body].length && (options[:headers] || {}).fetch('Content-Type', nil) == 'application/json'
-      JSON.parse(options[:body]).merge(options[:params] || {}).deep_symbolize_keys
-    else
-      options[:params]
-    end
+    params =
+      if options[:body] && options[:body].length && (options[:headers] || {}).fetch('Content-Type', nil) == 'application/json'
+        JSON.parse(options[:body]).merge(options[:params] || {}).deep_symbolize_keys
+      else
+        options[:params]
+      end
     options[:url] = endpoint.compile(params)
     endpoint.remove_interpolated_params!(options[:params])
   end

data/lib/lhc/response.rb

@@ -16,12 +16,7 @@ class LHC::Response
   # Access response data.
   # Cache parsing.
   def data
-    @data ||= case format
-      when :json
-        JSON.parse(raw.body, object_class: OpenStruct)
-      else # default is json
-        JSON.parse(raw.body, object_class: OpenStruct)
-    end
+    @data ||= format.parse(self)
     @data
   end
 
@@ -63,9 +58,8 @@ class LHC::Response
   attr_accessor :raw
 
   def format
-    headers = {}
-    headers = request.options.fetch(:headers, {}) if request && request.options
-    return :json if headers['Content-Type'] == 'application/json'
+    return JsonFormat.new if request.nil?
+    request.format
   end
 
 end

data/lib/lhc/version.rb

@@ -1,3 +1,3 @@
 module LHC
-  VERSION = "3.4.0"
+  VERSION = "3.5.0"
 end

data/non_rails_spec/request/request_spec.rb

@@ -2,8 +2,8 @@ require 'spec_helper'
 
 describe LHC::Request do
   before do
-    allow_any_instance_of(LHC::Request).to receive(:use_configured_endpoint!)
-    allow_any_instance_of(LHC::Request).to receive(:generate_url_from_template!)
+    allow_any_instance_of(described_class).to receive(:use_configured_endpoint!)
+    allow_any_instance_of(described_class).to receive(:generate_url_from_template!)
   end
   context 'request without rails' do
     it 'does have deep_merge dependency met' do

data/spec/basic_methods/delete_spec.rb

@@ -1,9 +1,7 @@
 require 'rails_helper'
 
 describe LHC do
-
   context 'delete' do
-
     let(:feedback) do
       {
         recommended: true,
@@ -14,20 +12,20 @@ describe LHC do
 
     before(:each) do
       stub_request(:delete, "http://datastore/v2/feedbacks/12121")
-      .to_return(status: 200, body: feedback.to_json, headers: {'Content-Encoding' => 'UTF-8'})
+        .to_return(status: 200, body: feedback.to_json, headers: { 'Content-Encoding' => 'UTF-8' })
     end
 
     it 'does a delete request when providing a complete url' do
-      LHC.delete('http://datastore/v2/feedbacks/12121')
+      described_class.delete('http://datastore/v2/feedbacks/12121')
     end
 
     it 'it makes response data available in a rails way' do
-      response = LHC.delete('http://datastore/v2/feedbacks/12121')
+      response = described_class.delete('http://datastore/v2/feedbacks/12121')
       expect(response.data.recommended).to eq true
     end
 
     it 'provides response headers' do
-      response = LHC.delete('http://datastore/v2/feedbacks/12121')
+      response = described_class.delete('http://datastore/v2/feedbacks/12121')
       expect(response.headers).to be
     end
   end

data/spec/basic_methods/get_spec.rb

@@ -1,12 +1,10 @@
 require 'rails_helper'
 
 describe LHC do
-
   context 'get' do
-
     before(:each) do
       stub_request(:get, 'http://datastore/v2/feedbacks?has_reviews=true')
-        .to_return(status: 200, body: { total: 99 }.to_json, headers: {'Content-Encoding' => 'UTF-8'})
+        .to_return(status: 200, body: { total: 99 }.to_json, headers: { 'Content-Encoding' => 'UTF-8' })
     end
 
     let(:parameters) do
@@ -36,10 +34,9 @@ describe LHC do
   end
 
   context 'get json' do
-
     before(:each) do
-      stub_request(:get, 'http://datastore/v2/feedbacks').with(headers: {'Content-Type' => 'application/json'})
-        .to_return(body: {some: 'json'}.to_json)
+      stub_request(:get, 'http://datastore/v2/feedbacks').with(headers: { 'Content-Type' => 'application/json' })
+        .to_return(body: { some: 'json' }.to_json)
     end
 
     it 'requests json and parses response body' do

data/spec/basic_methods/post_spec.rb

@@ -1,9 +1,7 @@
 require 'rails_helper'
 
 describe LHC do
-
   context 'post' do
-
     let(:feedback) do
       {
         recommended: true,
@@ -14,28 +12,28 @@ describe LHC do
 
     before(:each) do
       stub_request(:post, "http://datastore/v2/feedbacks")
-      .with(body: feedback.to_json)
-      .to_return(status: 200, body: feedback.to_json, headers: {'Content-Encoding' => 'UTF-8'})
+        .with(body: feedback.to_json)
+        .to_return(status: 200, body: feedback.to_json, headers: { 'Content-Encoding' => 'UTF-8' })
     end
 
     it 'does a post request when providing a complete url' do
-      LHC.post('http://datastore/v2/feedbacks', body: feedback.to_json)
+      described_class.post('http://datastore/v2/feedbacks', body: feedback.to_json)
     end
 
     it 'does a post request when providing the name of a configured endpoint' do
       url = 'http://:datastore/v2/feedbacks'
       options = { params: { datastore: 'datastore' } }
-      LHC.configure { |c| c.endpoint(:feedbacks, url, options) }
-      LHC.post(:feedbacks, body: feedback.to_json)
+      described_class.configure { |c| c.endpoint(:feedbacks, url, options) }
+      described_class.post(:feedbacks, body: feedback.to_json)
     end
 
     it 'it makes response data available in a rails way' do
-      response = LHC.post('http://datastore/v2/feedbacks', body: feedback.to_json)
+      response = described_class.post('http://datastore/v2/feedbacks', body: feedback.to_json)
       expect(response.data.source_id).to eq 'aaa'
     end
 
     it 'provides response headers' do
-      response = LHC.post('http://datastore/v2/feedbacks', body: feedback.to_json)
+      response = described_class.post('http://datastore/v2/feedbacks', body: feedback.to_json)
       expect(response.headers).to be
     end
   end

data/spec/basic_methods/put_spec.rb

@@ -1,9 +1,7 @@
 require 'rails_helper'
 
 describe LHC do
-
   context 'post' do
-
     let(:feedback) do
       {
         recommended: false,
@@ -20,28 +18,28 @@ describe LHC do
 
     before(:each) do
       stub_request(:put, "http://datastore/v2/feedbacks")
-      .with(body: change.to_json)
-      .to_return(status: 200, body: feedback.merge(change).to_json, headers: {'Content-Encoding' => 'UTF-8'})
+        .with(body: change.to_json)
+        .to_return(status: 200, body: feedback.merge(change).to_json, headers: { 'Content-Encoding' => 'UTF-8' })
     end
 
     it 'does a post request when providing a complete url' do
-      LHC.put('http://datastore/v2/feedbacks', body: change.to_json)
+      described_class.put('http://datastore/v2/feedbacks', body: change.to_json)
     end
 
     it 'does a post request when providing the name of a configured endpoint' do
       url = 'http://:datastore/v2/feedbacks'
       options = { params: { datastore: 'datastore' } }
-      LHC.configure { |c| c.endpoint(:feedbacks, url, options) }
-      LHC.put(:feedbacks, body: change.to_json)
+      described_class.configure { |c| c.endpoint(:feedbacks, url, options) }
+      described_class.put(:feedbacks, body: change.to_json)
     end
 
     it 'it makes response data available in a rails way' do
-      response = LHC.put('http://datastore/v2/feedbacks', body: change.to_json)
+      response = described_class.put('http://datastore/v2/feedbacks', body: change.to_json)
       expect(response.data.recommended).to eq false
     end
 
     it 'provides response headers' do
-      response = LHC.put('http://datastore/v2/feedbacks', body: change.to_json)
+      response = described_class.put('http://datastore/v2/feedbacks', body: change.to_json)
       expect(response.headers).to be
     end
   end

data/spec/basic_methods/request_spec.rb

@@ -1,18 +1,16 @@
 require 'rails_helper'
 
 describe LHC do
-
   context 'request' do
-
     let(:total) { 99 }
 
     before(:each) do
       stub_request(:get, "http://datastore/v2/feedbacks?has_reviews=true")
-      .to_return(status: 200, body: { total: total }.to_json, headers: {'Content-Encoding' => 'UTF-8'})
+        .to_return(status: 200, body: { total: total }.to_json, headers: { 'Content-Encoding' => 'UTF-8' })
     end
 
     it 'does a request returning a response' do
-      response = LHC.request(url: 'http://datastore/v2/feedbacks', params: { has_reviews: true }, method: :get)
+      response = described_class.request(url: 'http://datastore/v2/feedbacks', params: { has_reviews: true }, method: :get)
       expect(response.data.total).to eq total
     end
   end

data/spec/config/endpoints_spec.rb

@@ -1,9 +1,7 @@
 require 'rails_helper'
 
 describe LHC do
-
   context 'configured endpoints' do
-
     let(:url) { 'http://analytics/track/:entity_id/w/:type' }
 
     let(:options) do
@@ -14,51 +12,50 @@ describe LHC do
     end
 
     before(:each) do
-      LHC.configure do |c|
+      described_class.configure do |c|
         c.endpoint(:kpi_tracker, url, options)
       end
     end
 
     it 'configures urls to be able to access them by name later' do
-      expect(LHC.config.endpoints[:kpi_tracker].url).to eq url
-      expect(LHC.config.endpoints[:kpi_tracker].options).to eq options
+      expect(described_class.config.endpoints[:kpi_tracker].url).to eq url
+      expect(described_class.config.endpoints[:kpi_tracker].options).to eq options
     end
 
     it 'compile url' do
       stub_request(:get, 'http://analytics/track/123/w/request?env=PROD')
-      response = LHC.get(:kpi_tracker, params: { entity_id: 123, type: 'request' })
+      response = described_class.get(:kpi_tracker, params: { entity_id: 123, type: 'request' })
       expect(response.request.options[:followlocation]).to eq false
     end
 
     it 'gets overwritten by explicit request options' do
       stub_request(:get, 'http://analytics/track/123/w/request?env=STG')
-      response = LHC.get(:kpi_tracker, params: { entity_id: 123, type: 'request', env: 'STG' })
+      described_class.get(:kpi_tracker, params: { entity_id: 123, type: 'request', env: 'STG' })
     end
 
     it 'raises in case of claching endpoint names' do
-      expect(->{
-        LHC.config.endpoint(:kpi_tracker, 'http://kpi-tracker')
+      expect(lambda {
+        described_class.config.endpoint(:kpi_tracker, 'http://kpi-tracker')
       }).to raise_error 'Endpoint already exists for that name'
     end
 
     it 'enforces endpoint name to be a symbol' do
-      LHC.configure { |c| c.endpoint('datastore', 'http://datastore') }
-      expect(LHC.config.endpoints[:datastore].url).to eq 'http://datastore'
+      described_class.configure { |c| c.endpoint('datastore', 'http://datastore') }
+      expect(described_class.config.endpoints[:datastore].url).to eq 'http://datastore'
     end
   end
 
   context 'configured enpoints with default params' do
-
     before(:each) do
-      LHC.config.endpoint(:telemarketers, 'http://datastore/v2/spamnumbers?order_by=-user_frequency&swiss_number=true&offset=0&limit=:limit', params: { limit: 200 })
+      described_class.config.endpoint(:telemarketers, 'http://datastore/v2/spamnumbers?order_by=-user_frequency&swiss_number=true&offset=0&limit=:limit', params: { limit: 200 })
       stub_request(:get, 'http://datastore/v2/spamnumbers?limit=200&offset=0&order_by=-user_frequency&swiss_number=true')
         .to_return(status: 200)
     end
 
     it 'is possible to call them multiple times with default params' do
-      LHC.get(:telemarketers)
-      LHC.get(:telemarketers)
-      LHC.get(:telemarketers)
+      described_class.get(:telemarketers)
+      described_class.get(:telemarketers)
+      described_class.get(:telemarketers)
     end
   end
 end

data/spec/config/placeholders_spec.rb

@@ -1,32 +1,30 @@
 require 'rails_helper'
 
 describe LHC do
-
   context 'configuration of placeholders' do
-
     it 'uses values for placeholders defined globally' do
-      LHC.configure { |c| c.placeholder(:datastore, 'http://datastore/v2') }
+      described_class.configure { |c| c.placeholder(:datastore, 'http://datastore/v2') }
       stub_request(:get, "http://datastore/v2/feedbacks")
-      LHC.get(':datastore/feedbacks')
+      described_class.get(':datastore/feedbacks')
     end
 
     it 'uses explicit values first' do
-      LHC.configure {|c| c.placeholder(:campaign_id, '123') }
+      described_class.configure { |c| c.placeholder(:campaign_id, '123') }
       stub_request(:get, 'http://datastore/v2/campaign/456/feedbacks')
       url = 'http://datastore/v2/campaign/:campaign_id/feedbacks'
-      LHC.get(url, params: { campaign_id: '456' })
+      described_class.get(url, params: { campaign_id: '456' })
     end
 
     it 'raises in case of claching placeholder name' do
-      LHC.configure { |c| c.placeholder(:datastore, 'http://datastore') }
-      expect(->{
-        LHC.config.placeholder(:datastore, 'http://datastore')
+      described_class.configure { |c| c.placeholder(:datastore, 'http://datastore') }
+      expect(lambda {
+        described_class.config.placeholder(:datastore, 'http://datastore')
       }).to raise_error 'Placeholder already exists for that name'
     end
 
     it 'enforces placeholder name to be a symbol' do
-      LHC.configure { |c| c.placeholder('datatore', 'http://datastore') }
-      expect(LHC.config.placeholders[:datatore]).to eq 'http://datastore'
+      described_class.configure { |c| c.placeholder('datatore', 'http://datastore') }
+      expect(described_class.config.placeholders[:datatore]).to eq 'http://datastore'
     end
   end
 end