dhc 1.0.0

data/spec/request/option_dup_spec.rb

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

data/spec/request/parallel_requests_spec.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+describe DHC::Request do
+  let(:request_options) do
+    [
+      { url: 'http://www.depay.fi/restaurants' },
+      { url: 'http://www.depay.fi' }
+    ]
+  end
+
+  let(:stub_parallel_requests) do
+    stub_request(:get, 'http://www.depay.fi/restaurants').to_return(status: 200, body: '1')
+    stub_request(:get, 'http://www.depay.fi').to_return(status: 200, body: '2')
+  end
+
+  it 'does parallel requests if you provide an array of requests' do
+    stub_parallel_requests
+    responses = DHC.request(request_options)
+    expect(responses[0].body).to eq '1'
+    expect(responses[1].body).to eq '2'
+  end
+
+  context 'interceptors' do
+    before(:each) do
+      class TestInterceptor < DHC::Interceptor; end
+      DHC.configure { |c| c.interceptors = [TestInterceptor] }
+    end
+
+    it 'calls interceptors also for parallel requests' do
+      stub_parallel_requests
+      @called = 0
+      allow_any_instance_of(TestInterceptor)
+        .to receive(:before_request) { @called += 1 }
+      DHC.request(request_options)
+      expect(@called).to eq 2
+    end
+  end
+
+  context 'webmock disabled' do
+    before do
+      WebMock.disable!
+    end
+
+    after do
+      WebMock.enable!
+    end
+
+    it 'does not memorize parallelization handlers in typhoeus (hydra) in case one request of the parallization fails' do
+      begin
+        DHC.request([{ url: 'https://www.google.com/' }, { url: 'https://nonexisting123' }, { url: 'https://www.google.com/' }, { url: 'https://nonexisting123' }])
+      rescue DHC::UnknownError
+      end
+
+      DHC.request([{ url: 'https://www.google.com' }])
+    end
+  end
+end

data/spec/request/params_encoding_spec.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+describe DHC::Request do
+  context 'without an encoding setting' do
+    it 'encodes array params in default rack format' do
+      stub_request(:get, 'http://datastore/q?a%5B%5D=1&a%5B%5D=2&a%5B%5D=3')
+      DHC.get('http://datastore/q', params: { a: [1, 2, 3] })
+    end
+  end
+
+  context 'with encoding set to :rack' do
+    it 'encodes array params in rack format' do
+      stub_request(:get, 'http://datastore/q?a%5B%5D=1&a%5B%5D=2&a%5B%5D=3')
+      DHC.get('http://datastore/q', params: { a: [1, 2, 3] }, params_encoding: :rack)
+    end
+  end
+
+  context 'with encoding set to :multi' do
+    it 'encodes array params in multi format' do
+      stub_request(:get, 'http://datastore/q?a=1&a=2&a=3')
+      DHC.get('http://datastore/q', params: { a: [1, 2, 3] }, params_encoding: :multi)
+    end
+  end
+end

data/spec/request/request_without_rails_spec.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe DHC::Request do
+  before do
+    allow_any_instance_of(DHC::Request).to receive(:use_configured_endpoint!)
+    allow_any_instance_of(DHC::Request).to receive(:generate_url_from_template!)
+  end
+  context 'request without rails' do
+    it 'does have deep_merge dependency met' do
+      expect { DHC::Request.new({}, false) }.not_to raise_error
+    end
+  end
+end

data/spec/request/url_patterns_spec.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+describe DHC::Request do
+  it 'compiles url in case of configured endpoints' do
+    options = { params: {
+      has_reviews: true
+    } }
+    url = 'http://datastore/v2/campaign/{campaign_id}/feedbacks'
+    DHC.configure { |c| c.endpoint(:feedbacks, url, options) }
+    stub_request(:get, 'http://datastore/v2/campaign/123/feedbacks?has_reviews=true')
+    DHC.get(:feedbacks, params: { campaign_id: 123 })
+  end
+
+  it 'compiles url when doing a request' do
+    stub_request(:get, 'http://datastore:8080/v2/feedbacks/123')
+    DHC.get('http://datastore:8080/v2/feedbacks/{id}', params: { id: 123 })
+  end
+
+  it 'considers body when compiling urls' do
+    stub_request(:post, 'http://datastore:8080/v2/places/123')
+    DHC.json.post('http://datastore:8080/v2/places/{id}', body: { id: 123 })
+  end
+
+  context 'custom data structures that respond to as_json (like LHS data or record)' do
+    before do
+      class CustomStructure
+
+        def initialize(data)
+          @data = data
+        end
+
+        def as_json
+          @data.as_json
+        end
+
+        def to_json
+          as_json.to_json
+        end
+      end
+    end
+
+    let(:data) do
+      CustomStructure.new(id: '12345')
+    end
+
+    it 'compiles url from body params when body object respond_to(:as_json)' do
+      stub_request(:post, 'http://datastore/places/12345')
+        .to_return(status: 200)
+      DHC.post('http://datastore/places/{id}', body: data)
+    end
+  end
+end

data/spec/request/user_agent_spec.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+describe DHC::Request do
+  before do
+    DHC.send(:remove_const, :Request)
+    load('dhc/concerns/dhc/request/user_agent_concern.rb')
+    load('dhc/request.rb')
+  end
+
+  context 'default headers' do
+    context 'agent' do
+      it 'sets header agent information to be DHC' do
+        stub_request(:get, 'http://depay.fi/')
+          .with(
+            headers: {
+              'User-Agent' => "DHC (#{DHC::VERSION}; Dummy) [https://github.com/DePayFi/dhc]"
+            }
+          )
+          .to_return(status: 200)
+        DHC.get('http://depay.fi')
+      end
+    end
+  end
+end

data/spec/request/user_agent_without_rails_spec.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe DHC::Request do
+  before do
+    Object.send(:remove_const, :Rails)
+    DHC.send(:remove_const, :Request)
+    load('dhc/concerns/dhc/request/user_agent_concern.rb')
+    load('dhc/request.rb')
+  end
+
+  context 'default headers' do
+    context 'agent' do
+      it 'sets header agent information to be DHC' do
+        stub_request(:get, 'http://depay.fi/')
+          .with(
+            headers: {
+              'User-Agent' => "DHC (#{DHC::VERSION}) [https://github.com/DePayFi/dhc]"
+            }
+          )
+          .to_return(status: 200)
+        DHC.get('http://depay.fi')
+      end
+    end
+  end
+end

data/spec/response/body_spec.rb

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

data/spec/response/code_spec.rb

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

data/spec/response/data_accessor_spec.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+describe DHC do
+  context 'data accessor (hash with indifferent access)' do
+    before(:each) do
+      stub_request(:get, 'http://depay.fi/')
+        .with(headers: {
+                'Accept' => 'application/json,application/vnd.api+json',
+                'Content-Type' => 'application/json; charset=utf-8',
+                'Accept-Charset' => 'utf-8'
+              })
+        .to_return(body: { 'MyProp' => 'MyValue' }.to_json)
+    end
+
+    it 'makes data accessible with square bracket accessor (string)' do
+      expect(
+        DHC.json.get('http://depay.fi')['MyProp']
+      ).to eq 'MyValue'
+    end
+
+    it 'makes data accessible with square bracket accessor (symbol)' do
+      expect(
+        DHC.json.get('http://depay.fi')[:MyProp]
+      ).to eq 'MyValue'
+    end
+  end
+end

data/spec/response/data_spec.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+describe DHC::Response do
+  context 'data' do
+    let(:value) { 'some_value' }
+
+    let(:raw_response) { OpenStruct.new(body: body.to_json) }
+
+    let(:response) { DHC::Response.new(raw_response, nil) }
+
+    context 'for item' do
+      let(:body) { { some_key: { nested: value } } }
+
+      it 'makes data from response body available' do
+        expect(response.data.some_key.nested).to eq value
+      end
+
+      it 'makes data from response body available with hash bracket notation' do
+        expect(response.data[:some_key][:nested]).to eq value
+      end
+
+      it 'can be converted to json with the as_json method' do
+        expect(response.data.as_json).to eq body.as_json
+      end
+
+      it 'can be converted to an open struct with the as_open_struct method' do
+        expect(response.data.as_open_struct).to eq JSON.parse(response.body, object_class: OpenStruct)
+      end
+
+      it 'returns nil when data is not available' do
+        expect(response.data.something).to be_nil
+      end
+    end
+
+    context 'for collection' do
+      let(:body) { [{ some_key: { nested: value } }] }
+
+      it 'can be converted to json with the as_json method' do
+        expect(response.data.as_json).to eq body.as_json
+      end
+
+      it 'can be converted to an open struct with the as_open_struct method' do
+        expect(response.data.as_open_struct).to eq JSON.parse(response.body, object_class: OpenStruct)
+      end
+
+      it 'is a collection of items' do
+        expect(response.data.size).to eq(1)
+      end
+
+      it 'makes item data from response body available' do
+        expect(response.data.first.some_key.nested).to eq value
+      end
+
+      it 'makes item data from response body available with hash bracket notation' do
+        expect(response.data.first[:some_key][:nested]).to eq value
+      end
+    end
+  end
+
+  context 'response data if responding error data contains a response' do
+    before do
+      stub_request(:get, 'http://listings/')
+        .to_return(status: 404, body: {
+          meta: {
+            errors: [
+              { code: 2000, msg: 'I like to hide error messages (this is meta).' }
+            ]
+          },
+          response: 'why not?'
+        }.to_json)
+    end
+
+    it 'does not throw a stack level to deep issue when accessing data in a rescue context' do
+      begin
+        DHC.get('http://listings')
+      rescue DHC::Error => error
+        expect(
+          error.response.request.response.data.meta.errors.detect { |item| item.code == 2000 }.msg
+        ).to eq 'I like to hide error messages (this is meta).'
+      end
+    end
+  end
+end

data/spec/response/effective_url_spec.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+describe DHC::Response do
+  context 'effective_url' do
+    let(:effective_url) { 'https://www.depay.fi' }
+
+    let(:raw_response) { OpenStruct.new(effective_url: effective_url) }
+
+    it 'provides effective_url' do
+      response = DHC::Response.new(raw_response, nil)
+      expect(response.effective_url).to eq effective_url
+    end
+  end
+end

data/spec/response/headers_spec.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+describe DHC::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 = DHC::Response.new(raw_response, nil)
+      expect(response.headers).to eq headers
+    end
+  end
+end

data/spec/response/options_spec.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+describe DHC::Response do
+  context 'headers' do
+    let(:options) do
+      { 'return_code' => :ok }
+    end
+
+    let(:raw_response) { OpenStruct.new(options: options) }
+
+    it 'provides headers' do
+      response = DHC::Response.new(raw_response, nil)
+      expect(response.options).to eq options
+    end
+  end
+end

data/spec/response/success_spec.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+describe DHC::Response do
+  context 'success?' do
+    let(:response_success) { DHC::Response.new(Typhoeus::Response.new(response_code: 200, mock: true), nil) }
+    let(:response_error) { DHC::Response.new(Typhoeus::Response.new(response_code: 404, mock: true), nil) }
+
+    it { expect(response_success).to be_success }
+    it { expect(response_error).not_to be_success }
+  end
+end