ecommerce-client 0.0.1

data/lib/ecommerce/resources/order_collection.rb

@@ -0,0 +1,62 @@
+module Ecommerce
+  module Resources
+
+    #
+    # A wrapper to Ecommerce orders API. This wrapper represents a collection of orders and it's responsible for processing pagination information as well.
+    #
+
+    class OrderCollection < Base
+
+      PAGE_REGEX = /page=(\d+)/
+
+      attr_reader :response, :orders, :headers
+
+      def initialize(response)
+        @response = response
+        @orders = []
+        @headers = response.headers['Link'].split(',')
+      end
+
+      def self.build(response)
+        self.new(response).build
+      end
+
+      def build
+        build_orders
+        self
+      end
+
+      def next_page
+        page_for(:next)
+      end
+
+      def last_page
+        page_for(:last)
+      end
+
+      def previous_page
+        page_for(:prev)
+      end
+
+      def first_page
+        page_for(:first)
+      end
+
+      private
+
+      def page_for(page_rel)
+        header_link_for(page_rel).match(PAGE_REGEX)[1].to_i rescue nil
+      end
+
+      def header_link_for(rel)
+        headers.select{|n| n =~ /rel=#{rel}/}.first
+      end
+
+      def build_orders
+        Ecommerce::Resources::Base.parsed_body(response).each do |order_attributes|
+          orders.push(Ecommerce::Resources::Order.new(order_attributes))
+        end
+      end
+    end
+  end
+end

data/lib/ecommerce/response.rb

@@ -0,0 +1,34 @@
+require "ecommerce/exception"
+
+module Ecommerce
+  RequestTimeout = Class.new(Exception)
+  RequestError   = Class.new(Exception)
+
+  class Response < SimpleDelegator
+
+    def resolve!(&block)
+      if success?
+        block_given? ? yield(self) : self
+      elsif timed_out?
+        timeout!
+      else
+        error!
+      end
+    end
+
+    private
+
+    def timeout!
+      raise RequestTimeout
+    end
+
+    def error!
+      raise RequestError.new(
+        code:    code,
+        message: status_message,
+        body:    body
+      )
+    end
+
+  end
+end

data/lib/ecommerce/version.rb

@@ -0,0 +1,3 @@
+module Ecommerce
+  VERSION = "0.0.1"
+end

data/spec/ecommerce/attribute_handler_spec.rb

@@ -0,0 +1,54 @@
+require "spec_helper"
+
+describe Ecommerce::AttributeHandler do
+  describe '.handle' do
+    it 'instantiates a new Ecommerce::AttributeHandler' do
+      expect(Ecommerce::AttributeHandler).to receive(:new).and_return(double(handle: ''))
+      Ecommerce::AttributeHandler.handle('')
+    end
+  end
+
+  describe '#handle' do
+    context 'when attribute is a decimal' do
+      subject { Ecommerce::AttributeHandler.new('1366.99') }
+
+      it 'returns a BigDecimal object' do
+        expect(subject.handle).to eq(BigDecimal.new('1366.99'))
+      end
+    end
+
+    context 'when attribute is a date in ISO8601 format' do
+      subject { Ecommerce::AttributeHandler.new('2015-03-26') }
+
+      it 'returns a Date object' do
+        expect(subject.handle).to eq(Date.new(2015, 3, 26))
+      end
+    end
+
+    context 'when attribute is a datetime in ISO8601 format' do
+      context 'when datetime has the format with date and hours separated' do
+        subject { Ecommerce::AttributeHandler.new('2015-03-26 11:11:46') }
+
+        it 'returns a Date object' do
+          expect(subject.handle).to eq(DateTime.new(2015, 3, 26, 11, 11, 46))
+        end
+      end
+
+      context 'when datetime has the format with date and hours separated, in UTC' do
+        subject { Ecommerce::AttributeHandler.new('2015-03-26 11:11:46Z') }
+
+        it 'returns a Date object' do
+          expect(subject.handle).to eq(DateTime.new(2015, 3, 26, 11, 11, 46))
+        end
+      end
+
+      context 'when datetime has the format with date and hours combined, in UTC ' do
+        subject { Ecommerce::AttributeHandler.new('2014-06-01T14:17:56Z') }
+
+        it 'returns a Date object' do
+          expect(subject.handle).to eq(DateTime.new(2014, 6, 1, 14, 17, 56))
+        end
+      end
+    end
+  end
+end

data/spec/ecommerce/client_spec.rb

@@ -0,0 +1,26 @@
+require "spec_helper"
+
+describe Ecommerce::Client do
+
+  describe "#authenticated?" do
+    context "with a valid token" do
+      subject { described_class.new(Ecommerce.configuration.token, Ecommerce.configuration.secret) }
+
+      it "returns true" do
+        VCR.use_cassette("client/authenticated/true") do
+          expect(subject.authenticated?('rexpense-custom-monthly-brl-5250')).to be_truthy
+        end
+      end
+    end
+
+    context "with an invalid token" do
+      subject { described_class.new("FAKE-TOKEN", "FAKE-SECRET") }
+
+      it "returns false" do
+        VCR.use_cassette("client/authenticated/false") do
+          expect(subject.authenticated?('rexpense-custom-monthly-brl-5250')).to be_falsey
+        end
+      end
+    end
+  end
+end

data/spec/ecommerce/configuration_spec.rb

@@ -0,0 +1,21 @@
+require "spec_helper"
+
+describe Ecommerce::Configuration do
+
+  it "uses the production Ecommerce URL by default" do
+    expect(subject.url).to eq "https://ecommerce.myfreecomm.com.br"
+  end
+
+  it "uses a default user agent" do
+    expect(subject.user_agent).to eq "Ecommerce Ruby Client v#{Ecommerce::VERSION}"
+  end
+
+  it "uses ecommerce token as nil by default" do
+    expect(subject.token).to be_nil
+  end
+
+  it "uses ecommerce secret as nil by default" do
+    expect(subject.secret).to be_nil
+  end
+
+end

data/spec/ecommerce/request_spec.rb

@@ -0,0 +1,23 @@
+require "spec_helper"
+
+describe Ecommerce::Request do
+  describe "#run" do
+    subject { described_class.new({ method: 'post', params: {}, url: Ecommerce.configuration.url, user_agent: 'My Test User-Agent', authorization_hash: 'my-auth-hash' }) }
+
+    it "does a request using Typhoeus::Request" do
+      expect(Typhoeus::Request).to receive(:new).with("http://sandbox.ecommerce.myfreecomm.com.br", { method: "post", params: {}, headers: { "Accept" => "application/json", "Content-Type" => "application/json", "User-Agent" => "My Test User-Agent", "Authorization" => "Basic my-auth-hash" }, accept_encoding: "gzip" }).and_return(double(run: true, response: true))
+      subject.run
+    end
+
+    it "invokes Typhoeus::Request#run" do
+      expect_any_instance_of(Typhoeus::Request).to receive(:run)
+      subject.run
+    end
+
+    it "invokes Typhoeus::Request#response" do
+      allow_any_instance_of(Typhoeus::Request).to receive(:run)
+      expect_any_instance_of(Typhoeus::Request).to receive(:response)
+      subject.run
+    end
+  end
+end

data/spec/ecommerce/resources/order_collection_spec.rb

@@ -0,0 +1,82 @@
+require "spec_helper"
+
+describe Ecommerce::Resources::OrderCollection do
+  let(:response) { double(headers: {"Link" => "<http://sandbox.ecommerce.myfreecomm.com.br/api/orders/rexpense-custom-monthly-brl-5250/?page=3>; rel=next, <http://sandbox.ecommerce.myfreecomm.com.br/api/orders/rexpense-custom-monthly-brl-5250/?page=1>; rel=prev, <http://sandbox.ecommerce.myfreecomm.com.br/api/orders/rexpense-custom-monthly-brl-5250/?page=3>; rel=last, <http://sandbox.ecommerce.myfreecomm.com.br/api/orders/rexpense-custom-monthly-brl-5250/?page=1>; rel=first"},
+                          body: "[{\"is_paid\": false, \"address_number\": null, \"plan_change_urls\": {}, \"activation_expired\": false, \"number\": 2608, \"address_state\": null, \"global_account\": \"e5732007-7989-4372-8e72-9ec8cf6ee046\", \"api_url\": \"http://sandbox.ecommerce.myfreecomm.com.br/api/orders/rexpense-custom-monthly-brl-5250/2608/\", \"is_trial\": false, \"document_number\": null, \"checkout_url\": \"http://sandbox.ecommerce.myfreecomm.com.br/rexpense-custom-monthly-brl-5250/2608/checkout/\", \"active_until\": null, \"charge_day\": 25, \"address_quarter\": null, \"activated_at\": null, \"is_active\": false, \"user_code\": \"\", \"address\": null, \"is_recurring\": true, \"address_city\": null, \"plan_slug\": \"rexpense-custom-monthly-brl-5250\", \"address_complement\": null, \"discounts_url\": \"http://sandbox.ecommerce.myfreecomm.com.br/api/orders/rexpense-custom-monthly-brl-5250/2608/discounts/\", \"created_at\": \"2015-03-25 17:54:42\", \"adjustments_url\": \"http://sandbox.ecommerce.myfreecomm.com.br/api/orders/rexpense-custom-monthly-brl-5250/2608/adjustments/\", \"next_payment_at\": null, \"amount\": \"52.50\", \"client_email\": \"jaime.lannister@mailinator.com\", \"zip_code\": null, \"client_name\": \"\", \"invoices_url\": \"http://sandbox.ecommerce.myfreecomm.com.br/api/orders/rexpense-custom-monthly-brl-5250/2608/invoices/\"}, {\"is_paid\": false, \"address_number\": null, \"plan_change_urls\": {}, \"activation_expired\": false, \"number\": 2609, \"address_state\": null, \"global_account\": \"e5732007-7989-4372-8e72-9ec8cf6ee046\", \"api_url\": \"http://sandbox.ecommerce.myfreecomm.com.br/api/orders/rexpense-custom-monthly-brl-5250/2609/\", \"is_trial\": false, \"document_number\": null, \"checkout_url\": \"http://sandbox.ecommerce.myfreecomm.com.br/rexpense-custom-monthly-brl-5250/2609/checkout/\", \"active_until\": null, \"charge_day\": 25, \"address_quarter\": null, \"activated_at\": null, \"is_active\": false, \"user_code\": \"\", \"address\": null, \"is_recurring\": true, \"address_city\": null, \"plan_slug\": \"rexpense-custom-monthly-brl-5250\", \"address_complement\": null, \"discounts_url\": \"http://sandbox.ecommerce.myfreecomm.com.br/api/orders/rexpense-custom-monthly-brl-5250/2609/discounts/\", \"created_at\": \"2015-03-25 17:55:32\", \"adjustments_url\": \"http://sandbox.ecommerce.myfreecomm.com.br/api/orders/rexpense-custom-monthly-brl-5250/2609/adjustments/\", \"next_payment_at\": null, \"amount\": \"52.50\", \"client_email\": \"jaime.lannister@mailinator.com\", \"zip_code\": null, \"client_name\": \"\", \"invoices_url\": \"http://sandbox.ecommerce.myfreecomm.com.br/api/orders/rexpense-custom-monthly-brl-5250/2609/invoices/\"}, {\"is_paid\": false, \"address_number\": null, \"plan_change_urls\": {}, \"activation_expired\": false, \"number\": 2610, \"address_state\": null, \"global_account\": \"e5732007-7989-4372-8e72-9ec8cf6ee046\", \"api_url\": \"http://sandbox.ecommerce.myfreecomm.com.br/api/orders/rexpense-custom-monthly-brl-5250/2610/\", \"is_trial\": false, \"document_number\": null, \"checkout_url\": \"http://sandbox.ecommerce.myfreecomm.com.br/rexpense-custom-monthly-brl-5250/2610/checkout/\", \"active_until\": null, \"charge_day\": 25, \"address_quarter\": null, \"activated_at\": null, \"is_active\": false, \"user_code\": \"\", \"address\": null, \"is_recurring\": true, \"address_city\": null, \"plan_slug\": \"rexpense-custom-monthly-brl-5250\", \"address_complement\": null, \"discounts_url\": \"http://sandbox.ecommerce.myfreecomm.com.br/api/orders/rexpense-custom-monthly-brl-5250/2610/discounts/\", \"created_at\": \"2015-03-25 17:59:15\", \"adjustments_url\": \"http://sandbox.ecommerce.myfreecomm.com.br/api/orders/rexpense-custom-monthly-brl-5250/2610/adjustments/\", \"next_payment_at\": null, \"amount\": \"52.50\", \"client_email\": \"jaime.lannister@mailinator.com\", \"zip_code\": null, \"client_name\": \"\", \"invoices_url\": \"http://sandbox.ecommerce.myfreecomm.com.br/api/orders/rexpense-custom-monthly-brl-5250/2610/invoices/\"}, {\"is_paid\": false, \"address_number\": null, \"plan_change_urls\": {}, \"activation_expired\": false, \"number\": 2611, \"address_state\": null, \"global_account\": \"e5732007-7989-4372-8e72-9ec8cf6ee046\", \"api_url\": \"http://sandbox.ecommerce.myfreecomm.com.br/api/orders/rexpense-custom-monthly-brl-5250/2611/\", \"is_trial\": false, \"document_number\": null, \"checkout_url\": \"http://sandbox.ecommerce.myfreecomm.com.br/rexpense-custom-monthly-brl-5250/2611/checkout/\", \"active_until\": null, \"charge_day\": 25, \"address_quarter\": null, \"activated_at\": null, \"is_active\": false, \"user_code\": \"\", \"address\": null, \"is_recurring\": true, \"address_city\": null, \"plan_slug\": \"rexpense-custom-monthly-brl-5250\", \"address_complement\": null, \"discounts_url\": \"http://sandbox.ecommerce.myfreecomm.com.br/api/orders/rexpense-custom-monthly-brl-5250/2611/discounts/\", \"created_at\": \"2015-03-25 18:03:33\", \"adjustments_url\": \"http://sandbox.ecommerce.myfreecomm.com.br/api/orders/rexpense-custom-monthly-brl-5250/2611/adjustments/\", \"next_payment_at\": null, \"amount\": \"52.50\", \"client_email\": \"jaime.lannister@mailinator.com\", \"zip_code\": null, \"client_name\": \"\", \"invoices_url\": \"http://sandbox.ecommerce.myfreecomm.com.br/api/orders/rexpense-custom-monthly-brl-5250/2611/invoices/\"}]") }
+
+  subject { described_class.new(response) }
+
+  describe '#build' do
+    it 'builds orders' do
+      expect(subject).to receive(:build_orders)
+      subject.build
+    end
+
+    it 'returns Ecommerce::Resources::OrderCollection object' do
+      expect(subject.build.class).to eq(Ecommerce::Resources::OrderCollection)
+    end
+  end
+
+  describe '#build_orders' do
+    it 'builds an array of Ecommerce::Resources::Order' do
+      expect(Ecommerce::Resources::Order).to receive(:new).exactly(4).times
+      subject.build
+    end
+  end
+
+  describe '#next_page' do
+    it 'returns next page (3)' do
+      expect(subject.next_page).to eq(3)
+    end
+
+    context 'when there is no next page' do
+      let(:response) { double(headers: {"Link" => ""}, body: "") }
+
+      it 'returns nil' do
+        expect(subject.next_page).to be_nil
+      end
+    end
+  end
+
+  describe '#last_page' do
+    it 'returns last page (3)' do
+      expect(subject.last_page).to eq(3)
+    end
+
+    context 'when there is no last page' do
+      let(:response) { double(headers: {"Link" => ""}, body: "") }
+
+      it 'returns nil' do
+        expect(subject.last_page).to be_nil
+      end
+    end
+  end
+
+  describe '#previous_page' do
+    it 'returns previous page (3)' do
+      expect(subject.previous_page).to eq(1)
+    end
+
+    context 'when there is no previous page' do
+      let(:response) { double(headers: {"Link" => ""}, body: "") }
+
+      it 'returns nil' do
+        expect(subject.previous_page).to be_nil
+      end
+    end
+  end
+
+  describe '#first_page' do
+    it 'returns first page (3)' do
+      expect(subject.first_page).to eq(1)
+    end
+
+    context 'when there is no first page' do
+      let(:response) { double(headers: {"Link" => ""}, body: "") }
+
+      it 'returns nil' do
+        expect(subject.first_page).to be_nil
+      end
+    end
+  end
+end

data/spec/ecommerce/resources/order_spec.rb

@@ -0,0 +1,155 @@
+require "spec_helper"
+
+describe Ecommerce::Resources::Order do
+  describe '.create', vcr: true do
+    let(:params) { { global_account: 'e5732007-7989-4372-8e72-9ec8cf6ee046',
+                     client_email: 'jaime.lannister@mailinator.com',
+                     identity: '8923199e-6c43-415a-bbd1-2e302fdf8d96' } }
+
+    subject { described_class.create('rexpense-custom-monthly-brl-5250', params) }
+
+    context 'when success' do
+      it 'returns body' do
+        expect(subject.is_paid).to be_falsy
+        expect(subject.address_number).to be_nil
+        expect(subject.plan_change_urls).to eq({})
+        expect(subject.activation_expired).to be_falsy
+        expect(subject.number).to eq(2609)
+        expect(subject.address_state).to be_nil
+        expect(subject.global_account).to eq('e5732007-7989-4372-8e72-9ec8cf6ee046')
+        expect(subject.api_url).to eq("http://sandbox.ecommerce.myfreecomm.com.br/api/orders/rexpense-custom-monthly-brl-5250/2609/")
+        expect(subject.is_trial).to be_falsy
+        expect(subject.document_number).to be_nil
+        expect(subject.checkout_url).to eq("http://sandbox.ecommerce.myfreecomm.com.br/rexpense-custom-monthly-brl-5250/2609/checkout/")
+        expect(subject.active_until).to be_nil
+        expect(subject.charge_day).to eq(25)
+        expect(subject.address_quarter).to be_nil
+        expect(subject.activated_at).to be_nil
+        expect(subject.is_active).to be_falsy
+        expect(subject.user_code).to be_empty
+        expect(subject.address).to be_nil
+        expect(subject.is_recurring).to be_truthy
+        expect(subject.address_city).to be_nil
+        expect(subject.plan_slug).to eq("rexpense-custom-monthly-brl-5250")
+        expect(subject.address_complement).to be_nil
+        expect(subject.discounts_url).to eq("http://sandbox.ecommerce.myfreecomm.com.br/api/orders/rexpense-custom-monthly-brl-5250/2609/discounts/")
+        expect(subject.created_at).to eq(DateTime.new(2015, 3, 25, 17, 55, 32))
+        expect(subject.adjustments_url).to eq("http://sandbox.ecommerce.myfreecomm.com.br/api/orders/rexpense-custom-monthly-brl-5250/2609/adjustments/")
+        expect(subject.next_payment_at).to be_nil
+        expect(subject.amount).to eq(52.5)
+        expect(subject.client_email).to eq("jaime.lannister@mailinator.com")
+        expect(subject.zip_code).to be_nil
+        expect(subject.client_name).to be_empty
+        expect(subject.invoices_url).to eq("http://sandbox.ecommerce.myfreecomm.com.br/api/orders/rexpense-custom-monthly-brl-5250/2609/invoices/")
+      end
+
+      context 'when sending not all required parameters' do
+        before { params.delete(:global_account) }
+
+        it 'raises error BarRequest' do
+          expect{subject}.to raise_error(Ecommerce::RequestError)
+        end
+      end
+    end
+  end
+
+  describe '.find_all', vcr: true do
+    let(:params) { { global_account: 'e5732007-7989-4372-8e72-9ec8cf6ee046',
+                     client_email: 'jaime.lannister@mailinator.com',
+                     identity: '8923199e-6c43-415a-bbd1-2e302fdf8d96' } }
+
+    context 'when success' do
+      subject { described_class.find_all('rexpense-custom-monthly-brl-5250') }
+
+      it 'returns a find_all of orders' do
+        expect(subject.class).to eq(Ecommerce::Resources::OrderCollection)
+        expect(subject.orders.first.plan_slug).to eq("rexpense-custom-monthly-brl-5250")
+        expect(subject.orders.first.class).to eq(Ecommerce::Resources::Order)
+        expect(subject.orders.count).to eq(4)
+      end
+    end
+
+    context 'when not found' do
+      subject { described_class.find_all('wrong-slug') }
+
+      it 'raises NotFound' do
+        expect{ subject }.to raise_error(Ecommerce::RequestError)
+      end
+    end
+  end
+
+  describe '.find', vcr: true do
+    context 'when success' do
+      subject { described_class.find(2609, 'rexpense-custom-monthly-brl-5250') }
+
+      it 'returns order object' do
+        expect(subject.is_paid).to be_falsy
+        expect(subject.address_number).to be_nil
+        expect(subject.plan_change_urls).to eq({})
+        expect(subject.activation_expired).to be_falsy
+        expect(subject.number).to eq(2609)
+        expect(subject.address_state).to be_nil
+        expect(subject.global_account).to eq('e5732007-7989-4372-8e72-9ec8cf6ee046')
+        expect(subject.api_url).to eq("http://sandbox.ecommerce.myfreecomm.com.br/api/orders/rexpense-custom-monthly-brl-5250/2609/")
+        expect(subject.is_trial).to be_falsy
+        expect(subject.document_number).to be_nil
+        expect(subject.checkout_url).to eq("http://sandbox.ecommerce.myfreecomm.com.br/rexpense-custom-monthly-brl-5250/2609/checkout/")
+        expect(subject.active_until).to be_nil
+        expect(subject.charge_day).to eq(25)
+        expect(subject.address_quarter).to be_nil
+        expect(subject.activated_at).to be_nil
+        expect(subject.is_active).to be_falsy
+        expect(subject.user_code).to be_empty
+        expect(subject.address).to be_nil
+        expect(subject.is_recurring).to be_truthy
+        expect(subject.address_city).to be_nil
+        expect(subject.plan_slug).to eq("rexpense-custom-monthly-brl-5250")
+        expect(subject.address_complement).to be_nil
+        expect(subject.discounts_url).to eq("http://sandbox.ecommerce.myfreecomm.com.br/api/orders/rexpense-custom-monthly-brl-5250/2609/discounts/")
+        expect(subject.created_at).to eq(DateTime.new(2015, 3, 25, 17, 55, 32))
+        expect(subject.adjustments_url).to eq("http://sandbox.ecommerce.myfreecomm.com.br/api/orders/rexpense-custom-monthly-brl-5250/2609/adjustments/")
+        expect(subject.next_payment_at).to be_nil
+        expect(subject.amount).to eq(52.5)
+        expect(subject.client_email).to eq("jaime.lannister@mailinator.com")
+        expect(subject.zip_code).to be_nil
+        expect(subject.client_name).to be_empty
+        expect(subject.invoices_url).to eq("http://sandbox.ecommerce.myfreecomm.com.br/api/orders/rexpense-custom-monthly-brl-5250/2609/invoices/")
+      end
+    end
+
+    context 'when not found' do
+      subject { described_class.find(2609, 'wrong-slug') }
+
+      it 'raises NotFound' do
+        expect{ subject }.to raise_error(Ecommerce::RequestError)
+      end
+    end
+  end
+
+  describe '.destroy', vcr: true do
+    context 'when success' do
+      subject { described_class.destroy(2609, 'rexpense-custom-monthly-brl-5250') }
+
+      it 'returns empty body' do
+        expect(subject).to be_empty
+      end
+    end
+
+    context 'when not found' do
+      subject { described_class.destroy(2609, 'wrong-slug') }
+
+      it 'raises NotFound' do
+        expect{ subject }.to raise_error(Ecommerce::RequestError)
+      end
+    end
+  end
+
+  describe '#destroy' do
+    subject { described_class.new({ number: 2609, plan_slug: 'rexpense-custom-monthly-brl-5250' }) }
+
+    it 'invokes Ecommerce::Resources::Order.destroy' do
+      expect(Ecommerce::Resources::Order).to receive(:destroy).with(2609, 'rexpense-custom-monthly-brl-5250')
+      subject.destroy
+    end
+  end
+end