dhc 1.0.0

data/lib/dhc/response.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require 'active_support/core_ext/module'
+
+# The response contains the raw response (typhoeus)
+# and provides functionality to access response data.
+class DHC::Response
+  autoload :Data, 'dhc/response/data'
+
+  attr_accessor :request, :body_replacement
+  attr_reader :from_cache
+
+  delegate :effective_url, :code, :headers, :options, :mock, :success?, to: :raw
+  delegate :error_ignored?, to: :request
+  alias from_cache? from_cache
+
+  # A response is initalized with the underlying raw response (typhoeus in our case)
+  # and the associated request.
+  def initialize(raw, request, from_cache: false)
+    self.request = request
+    self.raw = raw
+    @from_cache = from_cache
+  end
+
+  def data
+    @data ||= body.present? ? DHC::Response::Data.new(self) : nil
+  end
+
+  def [](key)
+    data[key]
+  end
+
+  def body
+    body_replacement || raw.body.presence
+  end
+
+  # Provides response time in seconds
+  def time
+    raw.time || 0
+  end
+
+  # Provides response time in milliseconds
+  def time_ms
+    time * 1000
+  end
+
+  def timeout?
+    raw.timed_out?
+  end
+
+  def format
+    return DHC::Formats::JSON.new if request.nil?
+    request.format
+  end
+
+  private
+
+  attr_accessor :raw
+
+end

data/lib/dhc/response/data.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+class DHC::Response::Data
+  autoload :Base, 'dhc/response/data/base'
+  autoload :Item, 'dhc/response/data/item'
+  autoload :Collection, 'dhc/response/data/collection'
+
+  include DHC::Response::Data::Base
+
+  def initialize(response, data: nil)
+    @response = response
+    @data = data
+
+    if as_json.is_a?(Hash)
+      @base = DHC::Response::Data::Item.new(@response, data: data)
+    elsif as_json.is_a?(Array)
+      @base = DHC::Response::Data::Collection.new(@response, data: data)
+    end
+  end
+
+  def method_missing(method, *args, &block)
+    @base.send(method, *args, &block)
+  end
+
+  def respond_to_missing?(method_name, include_private = false)
+    @base.respond_to?(method_name, include_private) || super
+  end
+end

data/lib/dhc/response/data/base.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+# Response data is data provided through the response body
+# but made accssible in the ruby world
+module DHC::Response::Data::Base
+  def as_json
+    @json ||= (@data || @response.format.as_json(@response.body))
+  end
+
+  def as_open_struct
+    @open_struct ||=
+      if @data
+        JSON.parse(@data.to_json, object_class: OpenStruct)
+      else
+        @response.format.as_open_struct(@response.body)
+      end
+  end
+end

data/lib/dhc/response/data/collection.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+class DHC::Response::Data::Collection < Array
+  include DHC::Response::Data::Base
+
+  def initialize(response, data: nil)
+    @response = response
+    @data = data
+
+    super(
+      as_json.map do |i|
+        DHC::Response::Data.new(response, data: i)
+      end
+    )
+  end
+end

data/lib/dhc/response/data/item.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+class DHC::Response::Data::Item < OpenStruct
+  include DHC::Response::Data::Base
+
+  def initialize(response, data: nil)
+    @response = response
+    @data = data
+
+    set_dynamic_accessor_methods
+
+    super(as_json)
+  end
+
+  def [](key)
+    @hash ||= as_json.with_indifferent_access
+    @hash[key]
+  end
+
+  private
+
+  def set_dynamic_accessor_methods
+    as_json.keys.each do |key|
+      define_singleton_method key do |*args|
+        as_open_struct.send key, *args
+      end
+    end
+  end
+end

data/lib/dhc/rspec.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'dhc'
+
+RSpec.configure do |config|
+  config.before(:each) do
+    DHC::Caching.cache = ActiveSupport::Cache::MemoryStore.new
+    DHC::Caching.cache.clear
+    DHC::Throttle.track = nil
+  end
+end

data/lib/dhc/test/cache_helper.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+warn("[WARNING] require 'dhc/test/cache_helper.rb' is not needed any more! Just require 'dhc/rspec' in your spec helper instead.")

data/lib/dhc/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module DHC
+  VERSION ||= '1.0.0'
+end

data/script/ci/build.sh

@@ -0,0 +1,19 @@
+#!/bin/bash -e
+
+# custom vars
+# RUBY = ruby-1.9.3-p125
+# GEMSET = location-app-${GitHub pull request id|branch name}
+# standard vars
+
+if [ -z "$SKIP_RVM" ]; then
+  [[ -s "/usr/local/rvm/scripts/rvm" ]] && . "/usr/local/rvm/scripts/rvm"
+  RUBY=${RUBY:-ruby-2.1.2}
+  GEMSET=${GEMSET:-DHC}
+  rvm use ${RUBY}@${GEMSET} --create
+  gem install bundler --no-rdoc --no-ri
+fi
+
+bundle install --local --quiet || bundle install --quiet
+RAILS_ENV=test bundle exec rspec
+bundle exec rspec non_rails_spec
+rvm --force gemset delete ${RUBY}@${GEMSET}

data/spec/basic_methods/delete_spec.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+describe DHC do
+  context 'delete' do
+    let(:feedback) do
+      {
+        recommended: true,
+        source_id: 'aaa',
+        content_ad_id: '1z-5r1fkaj'
+      }
+    end
+
+    before(:each) do
+      stub_request(:delete, 'http://datastore/v2/feedbacks/12121')
+        .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
+      DHC.delete('http://datastore/v2/feedbacks/12121')
+    end
+
+    it 'makes response data available in a rails way' do
+      response = DHC.delete('http://datastore/v2/feedbacks/12121')
+      expect(response.data.recommended).to eq true
+    end
+
+    it 'provides response headers' do
+      response = DHC.delete('http://datastore/v2/feedbacks/12121')
+      expect(response.headers).to be_present
+    end
+  end
+end

data/spec/basic_methods/get_spec.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+describe DHC 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' })
+    end
+
+    let(:parameters) do
+      { has_reviews: true }
+    end
+
+    it 'does a get request when providing a complete url' do
+      DHC.get('http://datastore/v2/feedbacks', params: parameters)
+    end
+
+    it 'does a get request when providing the name of a configured endpoint' do
+      url = 'http://{+datastore}/v2/feedbacks'
+      options = { params: { datastore: 'datastore' } }
+      DHC.configure { |c| c.endpoint(:feedbacks, url, options) }
+      DHC.get(:feedbacks, params: parameters)
+    end
+
+    it 'makes response data available in a rails way' do
+      response = DHC.get('http://datastore/v2/feedbacks', params: parameters)
+      expect(response.data.total).to eq 99
+    end
+
+    it 'provides response headers' do
+      response = DHC.get('http://datastore/v2/feedbacks', params: parameters)
+      expect(response.headers).to be_present
+    end
+  end
+
+  context 'get json' do
+    before(:each) do
+      stub_request(:get, 'http://datastore/v2/feedbacks').with(headers: { 'Content-Type' => 'application/json; charset=utf-8' })
+        .to_return(body: { some: 'json' }.to_json)
+    end
+
+    it 'requests json and parses response body' do
+      data = DHC.json.get('http://datastore/v2/feedbacks').data
+      expect(data.some).to eq 'json'
+    end
+  end
+end

data/spec/basic_methods/post_spec.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+describe DHC do
+  context 'post' do
+    let(:feedback) do
+      {
+        recommended: true,
+        source_id: 'aaa',
+        content_ad_id: '1z-5r1fkaj'
+      }
+    end
+
+    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' })
+    end
+
+    it 'does a post request when providing a complete url' do
+      DHC.post('http://datastore/v2/feedbacks', body: feedback)
+    end
+
+    it 'does a post request when providing the name of a configured endpoint' do
+      url = 'http://{+datastore}/v2/feedbacks'
+      options = { params: { datastore: 'datastore' } }
+      DHC.configure { |c| c.endpoint(:feedbacks, url, options) }
+      DHC.post(:feedbacks, body: feedback)
+    end
+
+    it 'makes response data available in a rails way' do
+      response = DHC.post('http://datastore/v2/feedbacks', body: feedback)
+      expect(response.data.source_id).to eq 'aaa'
+    end
+
+    it 'provides response headers' do
+      response = DHC.post('http://datastore/v2/feedbacks', body: feedback)
+      expect(response.headers).to be_present
+    end
+  end
+end

data/spec/basic_methods/put_spec.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+describe DHC do
+  context 'post' do
+    let(:feedback) do
+      {
+        recommended: false,
+        source_id: 'aaa',
+        content_ad_id: '1z-5r1fkaj'
+      }
+    end
+
+    let(:change) do
+      {
+        recommended: false
+      }
+    end
+
+    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' })
+    end
+
+    it 'does a post request when providing a complete url' do
+      DHC.put('http://datastore/v2/feedbacks', body: change)
+    end
+
+    it 'does a post request when providing the name of a configured endpoint' do
+      url = 'http://{+datastore}/v2/feedbacks'
+      options = { params: { datastore: 'datastore' } }
+      DHC.configure { |c| c.endpoint(:feedbacks, url, options) }
+      DHC.put(:feedbacks, body: change)
+    end
+
+    it 'makes response data available in a rails way' do
+      response = DHC.put('http://datastore/v2/feedbacks', body: change)
+      expect(response.data.recommended).to eq false
+    end
+
+    it 'provides response headers' do
+      response = DHC.put('http://datastore/v2/feedbacks', body: change)
+      expect(response.headers).to be_present
+    end
+  end
+end

data/spec/basic_methods/request_spec.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+describe DHC 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' })
+    end
+
+    it 'does a request returning a response' do
+      response = DHC.request(url: 'http://datastore/v2/feedbacks', params: { has_reviews: true }, method: :get)
+      expect(response.data.total).to eq total
+    end
+  end
+end

data/spec/basic_methods/request_without_rails_spec.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe DHC do
+  context 'GET' do
+    before do
+      stub_request(:get, 'http://datastore/v2/feedbacks').to_return(status: 200, body: '{}')
+    end
+    it "is able to call .request without DHC raising NoMethodError: undefined method `blank?' for nil:NilClass when calling it outside of the rails context" do
+      expect { DHC.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 DHC raising NoMethodError: undefined method `deep_symbolize_keys' for {}:Hash" do
+      options = {
+        url: 'http://datastore/v2/feedbacks',
+        method: :post,
+        body: {}
+      }
+      expect { DHC.request(options) }.not_to raise_error
+    end
+  end
+end

data/spec/config/endpoints_spec.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+describe DHC do
+  context 'configured endpoints' do
+    let(:url) { 'http://analytics/track/{entity_id}/w/{type}' }
+
+    let(:options) do
+      {
+        params: { env: 'PROD' },
+        followlocation: false
+      }
+    end
+
+    before(:each) do
+      DHC.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(DHC.config.endpoints[:kpi_tracker].url).to eq url
+      expect(DHC.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 = DHC.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')
+      DHC.get(:kpi_tracker, params: { entity_id: 123, type: 'request', env: 'STG' })
+    end
+
+    it 'raises in case of claching endpoint names' do
+      expect(lambda {
+        DHC.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
+      DHC.configure { |c| c.endpoint('datastore', 'http://datastore') }
+      expect(DHC.config.endpoints[:datastore].url).to eq 'http://datastore'
+    end
+  end
+
+  context 'configured enpoints with default params' do
+    before(:each) do
+      DHC.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
+      DHC.get(:telemarketers)
+      DHC.get(:telemarketers)
+      DHC.get(:telemarketers)
+    end
+  end
+end