lhc 0.2.1

data/spec/interceptors/response_competition_spec.rb

@@ -0,0 +1,40 @@
+require 'rails_helper'
+
+describe LHC do
+
+  context 'interceptor response competition' do
+
+    before(:each) do
+
+      class LocalCacheInterceptor < LHC::Interceptor
+        @@cached = false
+        cattr_accessor :cached
+
+        def before_request(request)
+          if @@cached
+            return LHC::Response.new(Typhoeus::Response.new(response_body: 'Im served from local cache'), nil)
+          end
+        end
+      end
+
+      class RemoteCacheInterceptor < LHC::Interceptor
+
+        def before_request(request)
+          if request.response.nil?
+            return LHC::Response.new(Typhoeus::Response.new(response_body: 'Im served from remote cache'), nil)
+          end
+        end
+      end
+
+      LHC.configure { |c| c.interceptors = [LocalCacheInterceptor, RemoteCacheInterceptor] }
+    end
+
+    it 'can handle multiple interceptors that compete for returning the response' do
+      response = LHC.get('http://local.ch')
+      expect(response.body).to eq 'Im served from remote cache'
+      LocalCacheInterceptor.cached = true
+      response = LHC.get('http://local.ch')
+      expect(response.body).to eq 'Im served from local cache'
+    end
+  end
+end

data/spec/interceptors/return_response_spec.rb

@@ -0,0 +1,39 @@
+require 'rails_helper'
+
+describe LHC do
+
+  context 'interceptor' do
+
+    before(:each) do
+      class CacheInterceptor < LHC::Interceptor
+
+        def before_request(request)
+          return LHC::Response.new(Typhoeus::Response.new(response_body: 'Im served from cache'), nil)
+        end
+      end
+      LHC.configure { |c| c.interceptors = [CacheInterceptor] }
+    end
+
+    it 'can return a response rather then doing a real request' do
+      response = LHC.get('http://local.ch')
+      expect(response.body).to eq 'Im served from cache'
+    end
+
+    context 'misusage' do
+
+      before(:each) do
+        class AnotherInterceptor < LHC::Interceptor
+          def before_request(request)
+            return LHC::Response.new(Typhoeus::Response.new({}), nil)
+          end
+        end
+      end
+
+      it 'raises an exception when two interceptors try to return a response' do
+        expect(->{
+          LHC.get('http://local.ch', interceptors: [CacheInterceptor, AnotherInterceptor])
+        }).to raise_error 'Response already set from another interceptor'
+      end
+    end
+  end
+end

data/spec/rails_helper.rb

@@ -0,0 +1,4 @@
+require 'spec_helper'
+require File.expand_path("../dummy/config/environment", __FILE__)
+
+ENV["RAILS_ENV"] ||= 'test'

data/spec/request/error_handling_spec.rb

@@ -0,0 +1,52 @@
+require 'rails_helper'
+
+describe LHC::Request do
+
+  context 'error handling' do
+
+    def to_fail_with(error)
+      raise_error(error)
+    end
+
+    def expect_status_code(status_code)
+      stub_request(:get, "http://something/#{status_code}").to_return(status: status_code)
+      expect(
+        -> { LHC::Request.new(url: "http://something/#{status_code}") }
+      ).to yield
+    end
+
+    it 'raises errors for anything but 2XX response codes' do
+      expect_status_code(400) { to_fail_with(LHC::BadRequest) }
+      expect_status_code(401) { to_fail_with(LHC::Unauthorized) }
+      expect_status_code(402) { to_fail_with(LHC::PaymentRequired) }
+      expect_status_code(403) { to_fail_with(LHC::Forbidden) }
+      expect_status_code(403) { to_fail_with(LHC::Forbidden) }
+      expect_status_code(404) { to_fail_with(LHC::NotFound) }
+      expect_status_code(405) { to_fail_with(LHC::MethodNotAllowed) }
+      expect_status_code(406) { to_fail_with(LHC::NotAcceptable) }
+      expect_status_code(407) { to_fail_with(LHC::ProxyAuthenticationRequired) }
+      expect_status_code(408) { to_fail_with(LHC::RequestTimeout) }
+      expect_status_code(409) { to_fail_with(LHC::Conflict) }
+      expect_status_code(410) { to_fail_with(LHC::Gone) }
+      expect_status_code(411) { to_fail_with(LHC::LengthRequired) }
+      expect_status_code(412) { to_fail_with(LHC::PreconditionFailed) }
+      expect_status_code(413) { to_fail_with(LHC::RequestEntityTooLarge) }
+      expect_status_code(414) { to_fail_with(LHC::RequestUriToLong) }
+      expect_status_code(415) { to_fail_with(LHC::UnsupportedMediaType) }
+      expect_status_code(416) { to_fail_with(LHC::RequestedRangeNotSatisfiable) }
+      expect_status_code(417) { to_fail_with(LHC::ExpectationFailed) }
+      expect_status_code(422) { to_fail_with(LHC::UnprocessableEntity) }
+      expect_status_code(423) { to_fail_with(LHC::Locked) }
+      expect_status_code(424) { to_fail_with(LHC::FailedDependency) }
+      expect_status_code(426) { to_fail_with(LHC::UpgradeRequired) }
+      expect_status_code(500) { to_fail_with(LHC::InternalServerError) }
+      expect_status_code(501) { to_fail_with(LHC::NotImplemented) }
+      expect_status_code(502) { to_fail_with(LHC::BadGateway) }
+      expect_status_code(503) { to_fail_with(LHC::ServiceUnavailable) }
+      expect_status_code(504) { to_fail_with(LHC::GatewayTimeout) }
+      expect_status_code(505) { to_fail_with(LHC::HttpVersionNotSupported) }
+      expect_status_code(507) { to_fail_with(LHC::InsufficientStorage) }
+      expect_status_code(510) { to_fail_with(LHC::NotExtended) }
+    end
+  end
+end

data/spec/request/headers_spec.rb

@@ -0,0 +1,11 @@
+require 'rails_helper'
+
+describe LHC::Request do
+
+  it 'provides request headers' do
+    stub_request(:get, 'http://local.ch')
+    response = LHC.get('http://local.ch')
+    request = response.request
+    expect(request.headers).to eq({"User-Agent"=>"Typhoeus - https://github.com/typhoeus/typhoeus"})
+  end
+end

data/spec/request/option_dup_spec.rb

@@ -0,0 +1,12 @@
+require 'rails_helper'
+
+describe LHC::Request do
+
+  it 'does not alter the options that where passed' do
+    LHC.configure { |c| c.endpoint(:kpi_tracker, 'http://analytics.lb-service/track/:entity_id/w', { params: { env: 'PROD' } }) }
+    options = { params: { entity_id: '123' } }
+    stub_request(:get, "http://analytics.lb-service/track/123/w?env=PROD")
+    LHC.get(:kpi_tracker, options)
+    expect(options).to eq({ params: { entity_id: '123' } })
+  end
+end

data/spec/request/parallel_requests_spec.rb

@@ -0,0 +1,15 @@
+require 'rails_helper'
+
+describe LHC::Request do
+
+  it 'does parallel requests if you provide an array of requests' do
+    requests = []
+    requests << { url: 'http://www.local.ch/restaurants' }
+    requests << { url: 'http://www.local.ch' }
+    stub_request(:get, "http://www.local.ch/restaurants").to_return(status: 200, body: '1')
+    stub_request(:get, "http://www.local.ch").to_return(status: 200, body: '2')
+    responses = LHC.request(requests)
+    expect(responses[0].body).to eq '1'
+    expect(responses[1].body).to eq '2'
+  end
+end

data/spec/request/url_patterns_spec.rb

@@ -0,0 +1,19 @@
+require 'rails_helper'
+
+describe LHC::Request do
+
+  it 'compiles url in case of configured endpoints' do
+    options = { params: {
+      has_reviews: true
+    }}
+    url = 'http://datastore-stg.lb-service/v2/campaign/:campaign_id/feedbacks'
+    LHC.configure { |c| c.endpoint(:feedbacks, url, options) }
+    stub_request(:get, 'http://datastore-stg.lb-service/v2/campaign/123/feedbacks?has_reviews=true')
+    LHC.get(:feedbacks, params:{campaign_id: 123})
+  end
+
+  it 'compiles url when doing a request' do
+    stub_request(:get, 'http://datastore-stg.lb-service:8080/v2/feedbacks/123')
+    LHC.get('http://datastore-stg.lb-service:8080/v2/feedbacks/:id', params:{id: 123})
+  end
+end

data/spec/response/body_spec.rb

@@ -0,0 +1,16 @@
+require 'rails_helper'
+
+describe LHC::Response do
+
+  context 'body' do
+
+    let(:body) { 'this is a body' }
+
+    let(:raw_response) { OpenStruct.new({ body: body }) }
+
+    it 'provides response body' do
+      response = LHC::Response.new(raw_response, nil)
+      expect(response.body).to eq body
+    end
+  end
+end

data/spec/response/code_spec.rb

@@ -0,0 +1,16 @@
+require 'rails_helper'
+
+describe LHC::Response do
+
+  context 'code' do
+
+    let(:code) { 200 }
+
+    let(:raw_response) { OpenStruct.new({ code: code }) }
+
+    it 'provides response code' do
+      response = LHC::Response.new(raw_response, nil)
+      expect(response.code).to eq code
+    end
+  end
+end

data/spec/response/data_spec.rb

@@ -0,0 +1,18 @@
+require 'rails_helper'
+
+describe LHC::Response do
+
+  context 'data' do
+
+    let(:value) { 'some_value' }
+
+    let(:body) {{ some_key: {nested: value} }}
+
+    let(:raw_response) { OpenStruct.new({ body: body.to_json }) }
+
+    it 'makes data from response body available' do
+      response = LHC::Response.new(raw_response, nil)
+      expect(response.data.some_key.nested).to eq value
+    end
+  end
+end

data/spec/response/headers_spec.rb

@@ -0,0 +1,18 @@
+require 'rails_helper'
+
+describe LHC::Response do
+
+  context 'headers' do
+
+    let(:headers) do
+      { 'Content-Encoding' => 'UTF-8' }
+    end
+
+    let(:raw_response) { OpenStruct.new({ headers: headers }) }
+
+    it 'provides headers' do
+      response = LHC::Response.new(raw_response, nil)
+      expect(response.headers).to eq headers
+    end
+  end
+end

data/spec/response/success_spec.rb

@@ -0,0 +1,12 @@
+require 'rails_helper'
+
+describe LHC::Response do
+
+  context 'success?' do
+    let(:response_success) { LHC::Response.new(Typhoeus::Response.new(response_code: 200, mock: true), nil) }
+    let(:response_error) { LHC::Response.new(Typhoeus::Response.new(response_code: 404, mock: true), nil) }
+
+    it { expect(response_success.success?).to be_truthy }
+    it { expect(response_error.success?).to be_falsy }
+  end
+end

data/spec/response/time_spec.rb

@@ -0,0 +1,16 @@
+require 'rails_helper'
+
+describe LHC::Response do
+
+  context 'time' do
+
+    let(:time) { 1.3 }
+
+    let(:raw_response) { OpenStruct.new({time: time}) }
+
+    it 'provides response time in milliseconds' do
+      response = LHC::Response.new(raw_response, nil)
+      expect(response.time).to eq time*1000
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require 'pry'
+require 'webmock/rspec'
+
+Dir[File.join(__dir__, "support/**/*.rb")].each {|f| require f}

data/spec/support/fixtures/json/feedback.json

@@ -0,0 +1,11 @@
+{
+    "href": "http://datastore-stg.lb-service.sunrise.intra.local.ch/v2/feedbacks/-Sc4_pYNpqfsudzhtivfkA",
+    "campaign": {
+        "href": "http://datastore-stg.lb-service.sunrise.intra.local.ch/v2/content-ads/51dfc5690cf271c375c5a12d"
+    },
+    "source_id": "aaa",
+    "recommended": true,
+    "modified": "2014-09-19T14:03:35.599+02:00",
+    "created_date": "2014-09-19T14:03:35.597+02:00",
+    "comments": []
+}

data/spec/support/fixtures/json/feedbacks.json

@@ -0,0 +1,164 @@
+{
+  "href" : "http://datastore-stg.lb-service.sunrise.intra.local.ch/v2/feedbacks/?exclude_hidden=false&offset=0&limit=10",
+  "items" : [ {
+    "href" : "http://datastore-stg.lb-service.sunrise.intra.local.ch/v2/feedbacks/0sdaetZ-OWVg4oBiBJ-7IQ",
+    "campaign" : {
+      "href" : "http://datastore-stg.lb-service.sunrise.intra.local.ch/v2/content-ads/51dfc5690cf271c375c5a12d"
+    },
+    "source_id" : "aaa",
+    "recommended" : true,
+    "ratings" : {
+      "ambiente" : 4,
+      "service" : 2,
+      "food" : 3
+    },
+    "modified" : "2014-09-18T16:13:32.987+02:00",
+    "created_date" : "2014-09-18T16:13:31.496+02:00",
+    "average_rating" : 3.0,
+    "comments" : [ ]
+  }, {
+    "href" : "http://datastore-stg.lb-service.sunrise.intra.local.ch/v2/feedbacks/QsUOQWNJoB-GFUNsX7z0jg",
+    "campaign" : {
+      "href" : "http://datastore-stg.lb-service.sunrise.intra.local.ch/v2/content-ads/51dfc5690cf271c375c5a11f"
+    },
+    "source_id" : "abcdefghs12345",
+    "name" : "Steve",
+    "recommended" : true,
+    "ratings" : {
+      "ambiente" : 3,
+      "service" : 5,
+      "food" : 2
+    },
+    "modified" : "2014-09-18T15:43:12.134+02:00",
+    "created_date" : "2014-09-18T15:42:57.892+02:00",
+    "review_title" : "GUMMYBEARS GUMMYBEARS GUMMYBEARS",
+    "review" : "GUMMYBEARS! ... WOAH, STEVE! No, we both know how you get when you eat gummybears!",
+    "average_rating" : 3.3333333333333335,
+    "comments" : [ ]
+  }, {
+    "href" : "http://datastore-stg.lb-service.sunrise.intra.local.ch/v2/feedbacks/QynNtmpXlsEGvUJ0ekDKVw",
+    "campaign" : {
+      "href" : "http://datastore-stg.lb-service.sunrise.intra.local.ch/v2/content-ads/51dfc56b0cf271c375c5a14d"
+    },
+    "source_id" : "abcdefghs12345",
+    "name" : "Steve",
+    "recommended" : true,
+    "ratings" : {
+      "ambiente" : 3,
+      "service" : 5,
+      "food" : 2
+    },
+    "modified" : "2014-09-17T11:17:39.660+02:00",
+    "created_date" : "2014-09-17T11:17:34.234+02:00",
+    "review_title" : "GUMMYBEARS GUMMYBEARS GUMMYBEARS",
+    "review" : "GUMMYBEARS! ... WOAH, STEVE! No, we both know how you get when you eat gummybears!",
+    "average_rating" : 3.3333333333333335,
+    "comments" : [ ]
+  }, {
+    "href" : "http://datastore-stg.lb-service.sunrise.intra.local.ch/v2/feedbacks/INmminYWNZwW_qNFx5peJQ",
+    "campaign" : {
+      "href" : "http://datastore-stg.lb-service.sunrise.intra.local.ch/v2/content-ads/51dfc56b0cf271c375c5a153"
+    },
+    "source_id" : "abcdefghs12345",
+    "name" : "Steve",
+    "recommended" : true,
+    "ratings" : {
+      "ambiente" : 3,
+      "service" : 5,
+      "food" : 2
+    },
+    "modified" : "2014-09-16T11:20:32.600+02:00",
+    "created_date" : "2014-09-16T11:20:30.194+02:00",
+    "review_title" : "GUMMYBEARS GUMMYBEARS GUMMYBEARS",
+    "review" : "GUMMYBEARS! ... WOAH, STEVE! No, we both know how you get when you eat gummybears!",
+    "average_rating" : 3.3333333333333335,
+    "comments" : [ ]
+  }, {
+    "href" : "http://datastore-stg.lb-service.sunrise.intra.local.ch/v2/feedbacks/ltgfr0VRYDN2nxyC119wTg",
+    "campaign" : {
+      "href" : "http://datastore-stg.lb-service.sunrise.intra.local.ch/v2/content-ads/51dfc56b0cf271c375c5a14c"
+    },
+    "source_id" : "aaa",
+    "recommended" : false,
+    "ratings" : {
+      "ambiente" : 2,
+      "service" : 1,
+      "food" : 1
+    },
+    "modified" : "2014-09-15T16:23:54.898+02:00",
+    "created_date" : "2014-09-15T16:23:40.355+02:00",
+    "average_rating" : 1.3333333333333333,
+    "comments" : [ ]
+  }, {
+    "href" : "http://datastore-stg.lb-service.sunrise.intra.local.ch/v2/feedbacks/5dUdQP-kZ6sulN8NtpGXTw",
+    "campaign" : {
+      "href" : "http://datastore-stg.lb-service.sunrise.intra.local.ch/v2/content-ads/51dfc56b0cf271c375c5a14c"
+    },
+    "source_id" : "abcdefghs12345",
+    "name" : "Steve",
+    "recommended" : true,
+    "ratings" : {
+      "ambiente" : 3,
+      "service" : 5,
+      "food" : 2
+    },
+    "modified" : "2014-09-12T13:10:51.220+02:00",
+    "created_date" : "2014-09-12T13:10:48.813+02:00",
+    "review_title" : "GUMMYBEARS GUMMYBEARS GUMMYBEARS",
+    "review" : "GUMMYBEARS! ... WOAH, STEVE! No, we both know how you get when you eat gummybears!",
+    "average_rating" : 3.3333333333333335,
+    "comments" : [ ]
+  }, {
+    "href" : "http://datastore-stg.lb-service.sunrise.intra.local.ch/v2/feedbacks/Z3KfWzIEQ3ZVCUj2IdrSNQ",
+    "campaign" : {
+      "href" : "http://datastore-stg.lb-service.sunrise.intra.local.ch/v2/content-ads/51dfc5690cf271c375c5a12e"
+    },
+    "source_id" : "abcdefghs",
+    "recommended" : true,
+    "modified" : "2014-09-10T16:57:36.255+02:00",
+    "created_date" : "2014-09-10T16:57:36.254+02:00",
+    "comments" : [ ]
+  }, {
+    "href" : "http://datastore-stg.lb-service.sunrise.intra.local.ch/v2/feedbacks/ZUUUeiw-Stw5Zb1baHDUzQ",
+    "campaign" : {
+      "href" : "http://datastore-stg.lb-service.sunrise.intra.local.ch/v2/content-ads/51dfc5690cf271c375c5a12d"
+    },
+    "source_id" : "abcdefghs",
+    "recommended" : true,
+    "modified" : "2014-09-10T16:57:32.792+02:00",
+    "created_date" : "2014-09-10T16:57:32.791+02:00",
+    "comments" : [ ]
+  }, {
+    "href" : "http://datastore-stg.lb-service.sunrise.intra.local.ch/v2/feedbacks/GyeWvhEtU4cYN_5T2FX2UA",
+    "campaign" : {
+      "href" : "http://datastore-stg.lb-service.sunrise.intra.local.ch/v2/content-ads/539266ec0cf2cd754583cfa0"
+    },
+    "source_id" : "abcdefghs",
+    "name" : "aa",
+    "recommended" : true,
+    "ratings" : {
+      "ambiente" : 2,
+      "service" : 4,
+      "food" : 3
+    },
+    "modified" : "2014-09-11T09:48:19.096+02:00",
+    "created_date" : "2014-09-10T16:35:39.201+02:00",
+    "review_title" : "bbb",
+    "review" : "fff",
+    "average_rating" : 3.0,
+    "comments" : [ ]
+  }, {
+    "href" : "http://datastore-stg.lb-service.sunrise.intra.local.ch/v2/feedbacks/o-qTRqQGFS3Z_RPJm1f8SA",
+    "campaign" : {
+      "href" : "http://datastore-stg.lb-service.sunrise.intra.local.ch/v2/content-ads/51dfc56c0cf271c375c5a160"
+    },
+    "source_id" : "abcdefghs12345",
+    "recommended" : true,
+    "modified" : "2014-09-10T16:31:52.493+02:00",
+    "created_date" : "2014-09-10T16:31:52.492+02:00",
+    "comments" : [ ]
+  } ],
+  "total" : 98,
+  "offset" : 0,
+  "limit" : 10
+}