tco_client_core 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d7c5bf9d3fa6eee0deb165199bb1e61debdbf199
+  data.tar.gz: 2663ecd6223c1db03fdc3cd01ce2462f4de2c6fe
+SHA512:
+  metadata.gz: e6bd1a0af6e74885e5e1843c1a55dc6238d7e54d515452e519e7d059c932384fc32e0820dc3005443f1c4330b86ea0a387d6c6d39cc4f333e2d43898079678ac
+  data.tar.gz: ce36e38bbb5bb1059131aa72faacf6fa6d8fab5e348cbb9195546a0218f17a1cbb539f1a2c32059e3d38edb7ddf0619c7715eb0004c14020ba0ba7b7848e49a3

data/lib/tco_client_core/base_request.rb

@@ -0,0 +1,67 @@
+require File.join(File.expand_path('..', File.dirname(__FILE__)), 'tco_client_core', 'response')
+require "rest_client"
+
+module TcoClientCore
+  class BaseRequest
+    def self.base_uri
+      TcoClientCore.config.base_uri
+    end
+
+    def self.authorization
+      encoded = Base64::encode64("#{TcoClientCore.config.vendor_id}:#{TcoClientCore.config.api_key}")
+      "Basic #{encoded}"
+    end
+
+    def self.request(endpoint, method, payload={})
+      raise "Base URI not set" if base_uri.nil?
+      params = {
+        method: method,
+        url: "#{base_uri}/#{endpoint}",
+        payload: payload.to_json,
+        headers: {
+          accept: :json,
+          content_type: 'application/json',
+          authorization: authorization
+        }
+      }
+
+      response = TcoClientCore::Response.new(RestClient::Request.new(params).execute)
+    end
+
+    def self.get(endpoint, options={})
+      request(endpoint, :get, options)
+    end
+
+    def self.post(endpoint, options={})
+      request(endpoint, :post, options)
+    end
+
+    def self.patch(endpoint, options={})
+      request(endpoint, :patch, options)
+    end
+
+    def self.delete(endpoint, options={})
+      request(endpoint, :delete, options)
+    end
+
+    def request(endpoint, method, options={})
+      self.class.request(endpoint, method, options)
+    end
+
+    def get(endpoint, options={})
+      request(endpoint, :get, options)
+    end
+
+    def post(endpoint, options={})
+      request(endpoint, :post, options)
+    end
+
+    def patch(endpoint, options={})
+      request(endpoint, :patch, options)
+    end
+
+    def delete(endpoint, options={})
+      request(endpoint, :delete, options)
+    end
+  end
+end

data/lib/tco_client_core/response.rb

@@ -0,0 +1,51 @@
+require "ostruct"
+require "json"
+
+module TcoClientCore
+  class Response
+    attr_reader :raw
+
+    def initialize(response)
+      @raw = response
+      errors.each do |key, value|
+        if key == "ActiveRecord::RecordNotFound"
+          raise TcoClientCore::RecordNotFound, value.first
+        end
+      end
+    end
+
+    def as_json
+      JSON.parse(raw)
+    end
+
+    def to_s
+      raw
+    end
+
+    def to_struct(object=nil)
+      object ||= as_json
+      if object.is_a? Array
+        object.map { |v| to_struct(v) }
+      elsif object.is_a? Hash
+        object.each_with_object(OpenStruct.new) do |(key, val), st|
+          st[key] = to_struct(val)
+        end
+      else
+        object
+      end
+    end
+
+    def errors?
+      json = as_json
+      !!(json.is_a?(Hash) && (json.fetch("errors", nil) || json.fetch(:errors, nil)))
+    end
+
+    def errors
+      if errors?
+        as_json["errors"] || as_json[:errors]
+      else
+        {}
+      end
+    end
+  end
+end

data/lib/tco_client_core/version.rb

@@ -0,0 +1,3 @@
+module TcoClientCore
+  VERSION = "0.1.0"
+end

data/lib/tco_client_core.rb

@@ -0,0 +1,19 @@
+require "ostruct"
+require "tco_client_core/version"
+require "tco_client_core/base_request"
+require "tco_client_core/response"
+
+module TcoClientCore
+  class Error < StandardError; end
+  class RecordNotFound < TcoClientCore::Error; end
+
+  def configure
+    yield config
+  end
+
+  def config
+    @@config ||= OpenStruct.new
+  end
+
+  module_function :configure, :config
+end

data/spec/base_request_spec.rb

@@ -0,0 +1,117 @@
+require "spec_helper"
+
+describe TcoClientCore::BaseRequest do
+  before do
+    allow(TcoClientCore.config).to receive(:base_uri) { "base_uri" }
+    allow(TcoClientCore.config).to receive(:vendor_id) { "vendor_id" }
+    allow(TcoClientCore.config).to receive(:api_key) { "api_key" }
+  end
+
+  describe '.authorization' do
+    it 'Base64 encodes the vendor id and api key and prepends "Basic "' do
+      expect(TcoClientCore::BaseRequest.authorization).to eq("Basic #{Base64::encode64("#{TcoClientCore.config.vendor_id}:#{TcoClientCore.config.api_key}")}")
+    end
+  end
+
+  describe ".request" do
+    it "raises an error if no base_uri is set" do
+      allow(TcoClientCore.config).to receive(:base_uri) { nil }
+      expect {
+        subject.request("test", :get)
+      }.to raise_error("Base URI not set")
+    end
+
+    it "makes a rest request with the given endpoint, including the authorization" do
+      allow(TcoClientCore.config).to receive(:base_uri) { "base_uri" }
+      expect(RestClient::Request).to receive(:new).with({
+        method: :get,
+        url: "base_uri/test",
+        payload: "{}",
+        headers: {
+          accept: :json,
+          content_type: 'application/json',
+          authorization: TcoClientCore::BaseRequest.authorization
+        }
+      }).and_return double(execute: "{}")
+      subject.request("test", :get)
+    end
+
+    it "stringifies the json payload" do
+      allow(TcoClientCore.config).to receive(:base_uri) { "base_uri" }
+      payload_data = { foo: "bar" }
+      expect(RestClient::Request).to receive(:new).with({
+        method: :post,
+        url: "base_uri/test",
+        headers: {
+          accept: :json,
+          content_type: "application/json",
+          authorization: TcoClientCore::BaseRequest.authorization
+        },
+        payload: payload_data.to_json
+      }).and_return double(execute: "{}")
+      subject.request("test", :post, payload_data)
+    end
+
+    it "returns a response" do
+      allow_any_instance_of(RestClient::Request).to receive(:execute).and_return({ "test" => "result" }.to_json)
+      response = TcoClientCore::BaseRequest.request("test", :get)
+      expect(response).to be_kind_of(TcoClientCore::Response)
+    end
+  end
+
+  describe ".get" do
+    it "makes a get request" do
+      expect(TcoClientCore::BaseRequest).to receive(:request).with("test", :get, {})
+      TcoClientCore::BaseRequest.get("test")
+    end
+  end
+
+  describe ".post" do
+    it "makes a post request" do
+      expect(TcoClientCore::BaseRequest).to receive(:request).with("test", :post, {})
+      TcoClientCore::BaseRequest.post("test")
+    end
+  end
+
+  describe ".patch" do
+    it "makes a patch request" do
+      expect(TcoClientCore::BaseRequest).to receive(:request).with("test", :patch, {})
+      TcoClientCore::BaseRequest.patch("test")
+    end
+  end
+
+  describe ".delete" do
+    it "makes a delete request" do
+      expect(TcoClientCore::BaseRequest).to receive(:request).with("test", :delete, {})
+      TcoClientCore::BaseRequest.delete("test")
+    end
+  end
+
+  describe "#get" do
+    it "makes a get request" do
+      expect(subject).to receive(:request).with("test", :get, {})
+      subject.get("test")
+    end
+  end
+
+  describe "#post" do
+    it "makes a post request" do
+      expect(subject).to receive(:request).with("test", :post, {})
+      subject.post("test")
+    end
+  end
+
+  describe "#patch" do
+    it "makes a patch request" do
+      expect(subject).to receive(:request).with("test", :patch, {})
+      subject.patch("test")
+    end
+  end
+
+  describe "#delete" do
+    it "makes a delete request" do
+      expect(subject).to receive(:request).with("test", :delete, {})
+      subject.delete("test")
+    end
+  end
+end

data/spec/response_spec.rb

@@ -0,0 +1,95 @@
+require "spec_helper"
+
+describe TcoClientCore::Response do
+  let(:raw_response) { { test: "response" }.to_json }
+  subject { TcoClientCore::Response.new(raw_response) }
+
+  it "saves a reference to the raw response" do
+    expect(subject.raw).to eq(raw_response)
+  end
+
+  describe "#to_s" do
+    it "returns the raw response string" do
+      expect(subject.to_s).to eq(raw_response)
+    end
+  end
+
+  describe "#to_json" do
+    it "returns the response as json" do
+      expect(subject.as_json).to have_key("test")
+    end
+  end
+
+  describe "#to_struct" do
+    context "with a hash" do
+      it "creates an open struct" do
+        ostruct = subject.to_struct
+        expect(ostruct).to be_kind_of(OpenStruct)
+      end
+
+      it "creates a open struct for nested hashes" do
+        ostruct = subject.to_struct({
+          one: 1,
+          two: { three: { four: 4 } }
+        })
+        expect(ostruct[:two]).to be_kind_of(OpenStruct)
+        expect(ostruct.two.three.four).to eq(4)
+      end
+
+      it "creates a open struct for array values with hashes" do
+        ostruct = subject.to_struct({
+          one: 1,
+          two: { three: [{ four: 4 }] }
+        })
+        expect(ostruct.two.three.first).to be_kind_of(OpenStruct)
+      end
+    end
+
+    context "with an array" do
+      it "creates a open struct for every hash property" do
+        array = subject.to_struct([{ one: 1 }, { two: 2 }]);
+        expect(array.first).to be_kind_of(OpenStruct)
+        expect(array.last).to be_kind_of(OpenStruct)
+      end
+
+      it "creates a open struct for nested arrays with hashes" do
+        array = subject.to_struct([
+          { one: 1 },
+          [{ two: 2 }]
+        ])
+        expect(array.last.first).to be_kind_of(OpenStruct)
+      end
+    end
+  end
+
+  describe "#errors?" do
+    context "without errors" do
+      it "returns false" do
+        expect(subject.errors?).to eq(false)
+      end
+    end
+
+    context "with errors" do
+      subject { TcoClientCore::Response.new({ errors: { field: ["error message"] } }.to_json) }
+
+      it "return true" do
+        expect(subject.errors?).to eq(true)
+      end
+    end
+  end
+
+  describe "#errors" do
+    subject { TcoClientCore::Response.new({ errors: { field: ["error message"] } }.to_json) }
+
+    it "returns the errors key" do
+      expect(subject.errors).to have_key("field")
+    end
+  end
+
+  describe "with exceptions" do
+    it "raises a TcoClientCore::RecordNotFound exception if the record was not found" do
+      allow_any_instance_of(RestClient::Request).to receive(:execute).and_return({ "errors" => { "ActiveRecord::RecordNotFound" => ["not found error"] } }.to_json)
+      expect { TcoClientCore::BaseRequest.request("test", :get) }.to raise_error(TcoClientCore::RecordNotFound)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,22 @@
+require "rubygems"
+require "awesome_print"
+require "bundler/setup"
+require "tco_client_core"
+require "vcr"
+require "json"
+
+RSpec.configure do |config|
+  config.order = :rand
+  config.color = true
+end
+
+TcoClientCore.configure do |config|
+  config.base_uri = "localhost:4000/internal"
+end
+
+VCR.configure do |config|
+  config.configure_rspec_metadata!
+  config.allow_http_connections_when_no_cassette = true
+  config.cassette_library_dir = "spec/fixtures/vcr_cassettes"
+  config.hook_into :webmock
+end

data/spec/tco_base_api_spec.rb

@@ -0,0 +1,18 @@
+require "spec_helper"
+
+describe TcoClientCore do
+  describe "#config" do
+    it "is a symbol table" do
+      expect(TcoClientCore.config).to be_an(OpenStruct)
+    end
+  end
+
+  describe "#configure" do
+    it "yields the config to the block" do
+      TcoClientCore.configure do |config|
+        config.test = "test"
+      end
+      expect(TcoClientCore.config.test).to eq("test")
+    end
+  end
+end

metadata

@@ -0,0 +1,294 @@
+--- !ruby/object:Gem::Specification
+name: tco_client_core
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- 2CO Inc
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: fuubar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: pry-awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9.6'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry-coolline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: pry-theme
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.9'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.20'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.20'
+description: Handles communication with 2checkout.com's API
+email:
+- support@2co.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/tco_client_core.rb
+- lib/tco_client_core/base_request.rb
+- lib/tco_client_core/response.rb
+- lib/tco_client_core/version.rb
+- spec/base_request_spec.rb
+- spec/response_spec.rb
+- spec/spec_helper.rb
+- spec/tco_base_api_spec.rb
+homepage: http://2checkout.com
+licenses:
+- All Rights Reserved
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.3
+signing_key: 
+specification_version: 4
+summary: Gem to handle communication with the 2CO API
+test_files:
+- spec/base_request_spec.rb
+- spec/response_spec.rb
+- spec/spec_helper.rb
+- spec/tco_base_api_spec.rb