lhc 0.2.1

data/lib/lhc/response.rb

@@ -0,0 +1,52 @@
+require 'typhoeus'
+
+# The response contains the raw response (typhoeus)
+# and provides functionality to access response data.
+class LHC::Response
+
+  attr_accessor :request
+
+  # A response is initalized with the underlying raw response (typhoeus in our case)
+  # and the associated request.
+  def initialize(raw, request)
+    self.request = request
+    self.raw = raw
+  end
+
+  # Access response data.
+  # Cache parsing.
+  def data
+    @data ||= JSON.parse(raw.body, object_class: OpenStruct)
+    @data
+  end
+
+  def body
+    raw.body
+  end
+
+  def code
+    raw.code
+  end
+
+  def headers
+    raw.headers
+  end
+
+  # Provides response time in ms.
+  def time
+    (raw.time || 0) * 1000
+  end
+
+  def timeout?
+    raw.timed_out?
+  end
+
+  def success?
+    raw.success?
+  end
+
+  private
+
+  attr_accessor :raw
+
+end

data/lib/lhc/version.rb

@@ -0,0 +1,3 @@
+module LHC
+  VERSION = "0.2.1"
+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
+# https://jenkins.intra.local.ch/env-vars.html/
+
+if [ -z "$SKIP_RVM" ]; then
+  [[ -s "/usr/local/rvm/scripts/rvm" ]] && . "/usr/local/rvm/scripts/rvm"
+  RUBY=${RUBY:-ruby-2.1.2}
+  GEMSET=${GEMSET:-LHC}
+  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
+rvm --force gemset delete ${RUBY}@${GEMSET}

data/spec/basic_methods/delete_spec.rb

@@ -0,0 +1,34 @@
+require 'rails_helper'
+
+describe LHC 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.lb-service/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
+      LHC.delete('http://datastore.lb-service/v2/feedbacks/12121')
+    end
+
+    it 'it makes response data available in a rails way' do
+      response = LHC.delete('http://datastore.lb-service/v2/feedbacks/12121')
+      expect(response.data.recommended).to eq true
+    end
+
+    it 'provides response headers' do
+      response = LHC.delete('http://datastore.lb-service/v2/feedbacks/12121')
+      expect(response.headers).to be
+    end
+  end
+end

data/spec/basic_methods/get_spec.rb

@@ -0,0 +1,37 @@
+require 'rails_helper'
+
+describe LHC do
+
+  context 'get' do
+
+    before(:each) do
+      stub_request(:get, 'http://datastore.lb-service/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
+      LHC.get('http://datastore.lb-service/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.lb-service' } }
+      LHC.configure { |c| c.endpoint(:feedbacks, url, options) }
+      LHC.get(:feedbacks, params: parameters)
+    end
+
+    it 'it makes response data available in a rails way' do
+      response = LHC.get('http://datastore.lb-service/v2/feedbacks', params: parameters)
+      expect(response.data.total).to eq 99
+    end
+
+    it 'provides response headers' do
+      response = LHC.get('http://datastore.lb-service/v2/feedbacks', params: parameters)
+      expect(response.headers).to be
+    end
+  end
+end

data/spec/basic_methods/post_spec.rb

@@ -0,0 +1,42 @@
+require 'rails_helper'
+
+describe LHC 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.lb-service/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
+      LHC.post('http://datastore.lb-service/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.lb-service' } }
+      LHC.configure { |c| c.endpoint(:feedbacks, url, options) }
+      LHC.post(:feedbacks, body: feedback.to_json)
+    end
+
+    it 'it makes response data available in a rails way' do
+      response = LHC.post('http://datastore.lb-service/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.lb-service/v2/feedbacks', body: feedback.to_json)
+      expect(response.headers).to be
+    end
+  end
+end

data/spec/basic_methods/put_spec.rb

@@ -0,0 +1,48 @@
+require 'rails_helper'
+
+describe LHC 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.lb-service/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
+      LHC.put('http://datastore.lb-service/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.lb-service' } }
+      LHC.configure { |c| c.endpoint(:feedbacks, url, options) }
+      LHC.put(:feedbacks, body: change.to_json)
+    end
+
+    it 'it makes response data available in a rails way' do
+      response = LHC.put('http://datastore.lb-service/v2/feedbacks', body: change.to_json)
+      expect(response.data.recommended).to eq false
+    end
+
+    it 'provides response headers' do
+      response = LHC.put('http://datastore.lb-service/v2/feedbacks', body: change.to_json)
+      expect(response.headers).to be
+    end
+  end
+end

data/spec/basic_methods/request_spec.rb

@@ -0,0 +1,19 @@
+require 'rails_helper'
+
+describe LHC do
+
+  context 'request' do
+
+    let(:total) { 99 }
+
+    before(:each) do
+      stub_request(:get, "http://datastore.lb-service/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 = LHC.request(url: 'http://datastore.lb-service/v2/feedbacks', params: { has_reviews: true }, method: :get)
+      expect(response.data.total).to eq total
+    end
+  end
+end

data/spec/config/endpoints_spec.rb

@@ -0,0 +1,49 @@
+require 'rails_helper'
+
+describe LHC do
+
+  context 'configured endpoints' do
+
+    let(:url) { 'http://analytics.lb-service/track/:entity_id/w/:type' }
+
+    let(:options) do
+      {
+        params: { env: 'PROD' },
+        followlocation: false
+      }
+    end
+
+    before(:each) do
+      LHC.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
+    end
+
+    it 'compile url' do
+      stub_request(:get, 'http://analytics.lb-service/track/123/w/request?env=PROD')
+      response = LHC.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.lb-service/track/123/w/request?env=STG')
+      response = LHC.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.lb-service')
+      }).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.lb-service') }
+      expect(LHC.config.endpoints[:datastore].url).to eq 'http://datastore.lb-service'
+    end
+  end
+end

data/spec/config/placeholders_spec.rb

@@ -0,0 +1,32 @@
+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.lb-service/v2') }
+      stub_request(:get, "http://datastore.lb-service/v2/feedbacks")
+      LHC.get(':datastore/feedbacks')
+    end
+
+    it 'uses explicit values first' do
+      LHC.configure {|c| c.placeholder(:campaign_id, '123') }
+      stub_request(:get, 'http://datastore-stg.lb-service/v2/campaign/456/feedbacks')
+      url = 'http://datastore-stg.lb-service/v2/campaign/:campaign_id/feedbacks'
+      LHC.get(url, params: { campaign_id: '456' })
+    end
+
+    it 'raises in case of claching placeholder name' do
+      LHC.configure { |c| c.placeholder(:datastore, 'http://datastore.lb-service') }
+      expect(->{
+        LHC.config.placeholder(:datastore, 'http://datastore-stg.lb-service')
+      }).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.lb-service') }
+      expect(LHC.config.placeholders[:datatore]).to eq 'http://datastore.lb-service'
+    end
+  end
+end

data/spec/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/spec/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Rails.application.load_tasks

data/spec/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/spec/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/spec/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end

data/spec/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end