arrow_payments 0.1.1

data/lib/arrow_payments/transaction.rb

@@ -0,0 +1,74 @@
+require 'time'
+
+module ArrowPayments
+  class Transaction < Entity
+    # Indicates status of transaction
+    STATUSES = [
+      'NotSettled',
+      'Settled',
+      'Voided',
+      'Failed'
+    ]
+
+    # Indicates how the transation was entered
+    SOURCES = [
+      'VirtualTerminal',
+      'LinkedTerminal',
+      'API',
+      'Subscription',
+      'InvoicePayment',
+      'Mobile'
+    ]
+
+    property :id,                    :from => 'ID'
+    property :account,               :from => 'Account'
+    property :transaction_type,      :from => 'TransactionType'
+    property :created_at,            :from => 'TransactionTime'
+    property :level,                 :from => 'Level'
+    property :total_amount,          :from => 'TotalAmount'
+    property :description,           :from => 'Description'
+    property :transaction_source,    :from => 'TransactionSource'
+    property :status,                :from => 'Status'
+    property :capture_amount,        :from => 'CaptureAmount'
+    property :authorization_code,    :from => 'AuthorizationCode'
+    property :payment_method_id,     :from => 'PaymentMethodID'
+    property :cardholder_first_name, :from => 'CardholderFirstName'
+    property :cardholder_last_name,  :from => 'CardholderLastName'
+    property :card_type,             :from => 'CardType'
+    property :card_last_digits,      :from => 'CardLast4'
+    property :customer_po_number,    :from => 'CustomerPONumber'
+    property :tax_amount,            :from => 'TaxAmount'
+    property :shipping_amount,       :from => 'ShippingAmount'
+    property :shipping_address_id,   :from => 'ShippingAddressID'
+    property :shipping_address,      :from => 'Shipping'
+    property :customer_id,           :from => 'CustomerID'
+    property :customer_name,         :from => 'CustomerName'
+    property :line_items,            :from => 'LineItems'
+    property :billing_address,       :from => 'Billing'
+
+    def Billing=(data)
+      if data.kind_of?(Hash)
+        self.billing_address = ArrowPayments::Address.new(data)
+      end
+    end
+
+    def Shipping=(data)
+      if data.kind_of?(Hash)
+        self.shipping_address = ArrowPayments::Address.new(data)
+      end
+    end
+
+    def LineItems=(data)
+      if data.kind_of?(Array)
+        self.line_items = data.map { |hash| ArrowPayments::LineItem.new(hash) }
+      end
+    end
+
+    def TransactionTime=(data)
+      if data =~ /^\/Date\(([\d]+)\)\/$/
+        epoch = Integer($1[0..9])
+        self.created_at = Time.at(epoch)
+      end
+    end
+  end
+end

data/lib/arrow_payments/version.rb

@@ -0,0 +1,3 @@
+module ArrowPayments
+  VERSION = '0.1.1'
+end

data/spec/arrow_payments_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+
+describe ArrowPayments do
+  describe '#client' do
+    it 'returns client instance for options' do
+      client = ArrowPayments.client(
+        :api_key => 'foo', 
+        :mode => 'production',
+        :merchant_id => 12345
+      )
+
+      client.should be_a ArrowPayments::Client
+      client.api_key.should eq('foo')
+      client.mode.should eq('production')
+      client.merchant_id.should eq(12345)
+      client.debug.should eq(false)
+    end
+
+    context 'when preconfigured' do
+      before do
+        ArrowPayments::Configuration.api_key = 'bar'
+        ArrowPayments::Configuration.mode = 'sandbox'
+        ArrowPayments::Configuration.merchant_id = 12345
+      end
+
+      after do
+        ArrowPayments::Configuration.api_key = nil
+        ArrowPayments::Configuration.mode = nil
+        ArrowPayments::Configuration.merchant_id = nil
+      end
+      
+      it 'returns preconfigured client instance' do
+        client = ArrowPayments.client
+        client.api_key.should eq('bar')
+        client.mode.should eq('sandbox')
+        client.merchant_id.should eq(12345)
+      end
+    end
+  end
+end

data/spec/client_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+
+describe ArrowPayments::Client do
+  describe '#initialize' do
+    it 'requires an api key' do
+      expect { ArrowPayments::Client.new }.to raise_error "API key required"
+    end
+
+    it 'requires a merchant id' do
+      expect { ArrowPayments::Client.new(:api_key => 'foobar') }.
+        to raise_error "Merchant ID required"
+    end
+
+    it 'validates api mode' do
+      expect { ArrowPayments::Client.new(:api_key => 'foobar', :merchant_id => 'foobar', :mode => 'foobar') }.
+        to raise_error "Invalid mode: foobar"
+    end
+
+    it 'sets production mode by default' do
+      client = ArrowPayments::Client.new(:api_key => 'foobar', :merchant_id => 'foobar')
+      client.mode.should eq('production')
+    end
+  end
+
+  describe '#sanbox?' do
+    it 'returns true if sandbox mode' do
+      client = ArrowPayments::Client.new(:api_key => 'foobar', :merchant_id => 'foobar', :mode => 'sandbox')
+
+      client.sandbox?.should be_true
+      client.production?.should_not be_true
+    end
+  end
+
+  describe '#production?' do
+    it 'returns true if production mode' do
+      client = ArrowPayments::Client.new(:api_key => 'foobar', :merchant_id => 'foobar', :mode => 'production')
+
+      client.sandbox?.should be_false
+      client.production?.should be_true
+    end
+  end
+end

data/spec/configuration_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe ArrowPayments::Configuration do
+  describe '#api_key=' do
+    it 'sets gateway api key' do
+      ArrowPayments::Configuration.api_key = 'foobar'
+      ArrowPayments::Configuration.api_key.should eq('foobar')
+    end
+  end
+
+  describe '#mode=' do
+    it 'sets gateway mode' do
+      ArrowPayments::Configuration.mode = 'production'
+      ArrowPayments::Configuration.mode.should eq('production')
+    end
+  end
+
+  describe '#merchant_id=' do
+    it 'sets merchant ID' do
+      ArrowPayments::Configuration.merchant_id = 12345
+      ArrowPayments::Configuration.merchant_id.should eq(12345)
+    end
+  end
+end

data/spec/customer_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper' 
+
+describe ArrowPayments::Customer do
+  it { should respond_to :id }
+  it { should respond_to :name }
+  it { should respond_to :code }
+  it { should respond_to :contact }
+  it { should respond_to :phone }
+  it { should respond_to :email }
+  it { should respond_to :recurring_billings }
+  it { should respond_to :payment_methods }
+
+  describe '#new' do
+    let(:customer_data) { json_fixture('customer.json') }
+
+    it 'properly assigns attributes' do
+      customer = ArrowPayments::Customer.new(customer_data)
+
+      customer.id.should eq(10162)
+      customer.name.should eq('First Supplies')
+      customer.code.should eq('First Supplies')
+      customer.contact.should eq('John Peoples')
+      customer.phone.should eq('8325539616')
+      customer.email.should eq('John.Peoples@arrow-test.com')
+      customer.recurring_billings.should be_empty
+      customer.payment_methods.should_not be_empty
+    end
+  end
+end

data/spec/customers_spec.rb

@@ -0,0 +1,160 @@
+require 'spec_helper'
+
+describe ArrowPayments::Customers do
+  let(:client) { ArrowPayments.client }
+
+  before :all do
+    ArrowPayments::Configuration.api_key = 'foobar'
+    ArrowPayments::Configuration.merchant_id = 'foo'
+    ArrowPayments::Configuration.mode = 'sandbox'
+  end
+
+  describe '#customers' do
+    before do
+      stub_request(:get, "http://demo.arrowpayments.com/api/foobar/customers").
+        to_return(:status => 200, :body => fixture('customers.json'))
+    end
+
+    it 'returns an array of existing customers' do
+      customers = client.customers
+      customers.should be_an Array
+      customers.size.should eq(12)
+    end
+  end
+
+  describe '#customer' do
+    it 'returns an existing customer by ID' do
+      stub_request(:get, "http://demo.arrowpayments.com/api/foobar/customer/10162").
+        to_return(:status => 200, :body => fixture('customer.json'))
+
+      customer = client.customer(10162)
+      customer.should_not be_nil
+      customer.id.should eq(10162)
+      customer.name.should eq('First Supplies')
+    end
+
+    it 'returns nil if customer does not exist' do
+      stub_request(:get, "http://demo.arrowpayments.com/api/foobar/customer/12345").
+        to_return(:status => 404, :body => "", :headers => {:error => "Customer Not Found"})
+
+      customer = client.customer(12345)
+      customer.should be_nil
+    end
+  end
+
+  describe '#create_customer' do
+    let(:customer) do
+      ArrowPayments::Customer.new(
+        :name    => 'First Supplies',
+        :code    => 'First Supplies',
+        :contact => 'John Peoples',
+        :email   => 'John.Peoples@arrow-test.com',
+        :phone   => '8325539616'
+      )
+    end
+
+    it 'creates and returns a new customer' do
+      stub_request(:post, "http://demo.arrowpayments.com/api/customer/add").
+        with(
+          :body => "{\"Name\":\"First Supplies\",\"Code\":\"First Supplies\",\"PrimaryContact\":\"John Peoples\",\"PrimaryContactPhone\":\"8325539616\",\"PrimaryContactEmailAddress\":\"John.Peoples@arrow-test.com\",\"PaymentMethods\":[],\"ApiKey\":\"foobar\",\"MID\":\"foo\"}",
+          :headers => {'Accept'=>'application/json', 'Content-Type'=>'application/json', 'User-Agent'=>'Ruby'}
+        ).
+        to_return(:status => 200, :body => fixture('customer.json'), :headers => {})
+
+      new_customer = client.create_customer(customer)
+      new_customer.id.should eq(10162)
+    end
+
+    it 'raises error when unable to create' do
+      stub_request(:post, "http://demo.arrowpayments.com/api/customer/add").
+        with(
+          :body => "{\"Name\":\"First Supplies\",\"Code\":\"First Supplies\",\"PrimaryContact\":\"John Peoples\",\"PrimaryContactPhone\":\"8325539616\",\"PrimaryContactEmailAddress\":\"John.Peoples@arrow-test.com\",\"PaymentMethods\":[],\"ApiKey\":\"foobar\",\"MID\":\"foo\"}",
+          :headers => {'Accept'=>'application/json', 'Content-Type'=>'application/json', 'User-Agent'=>'Ruby'}
+        ).
+        to_return(:status => 500, :body => "", :headers => {:error => "Customer with Name First Supplies already exists for merchant"})
+
+      expect { client.create_customer(customer) }.to raise_error ArrowPayments::Error, 'Customer with Name First Supplies already exists for merchant'
+    end
+  end
+
+  describe '#update_customer' do
+    it 'raises error if customer does not exist' do
+      stub_request(:get, "http://demo.arrowpayments.com/api/foobar/customer/10162").
+        to_return(:status => 200, :body => fixture('customer.json'))
+
+      stub_request(:post, "http://demo.arrowpayments.com/api/customer/update").
+        with(
+          :body => "{\"ID\":\"10163\",\"Name\":\"Foobar\",\"Code\":\"First Supplies\",\"PrimaryContact\":\"John Peoples\",\"PrimaryContactPhone\":\"8325539616\",\"PrimaryContactEmailAddress\":\"John.Peoples@arrow-test.com\",\"RecurrentBilling\":[],\"PaymentMethods\":[{\"ID\":12436,\"CardType\":\"Visa\",\"Last4\":\"1111\",\"CardholderFirstName\":\"Paola\",\"CardholderLastName\":\"Chen\",\"ExpirationMonth\":6,\"ExpirationYear\":2015,\"BillingStreet1\":\"7495 Center St.\",\"BillingCity\":\"Chicago\",\"BillingState\":\"IL\",\"BillingZip\":\"60601\"}],\"CustomerID\":\"10163\",\"ApiKey\":\"foobar\",\"MID\":\"foo\"}",
+          :headers => {'Accept'=>'application/json', 'Content-Type'=>'application/json', 'User-Agent'=>'Ruby'}
+        ).
+        to_return(:status => 404, :body => "", :headers => {:error => "Customer Not Found"})
+
+      customer = client.customer('10162')
+      customer.id = '10163'
+      customer.name = 'Foobar'
+
+      expect { client.update_customer(customer) }.
+        to raise_error ArrowPayments::NotFound, 'Customer Not Found'
+    end
+
+    it 'raises error if customer is not valid' do
+      stub_request(:get, "http://demo.arrowpayments.com/api/foobar/customer/10162").
+        to_return(:status => 200, :body => fixture('customer.json'))
+
+      stub_request(:post, "http://demo.arrowpayments.com/api/customer/update").
+        with(
+          :body => "{\"ID\":10162,\"Name\":\"Foobar\",\"Code\":\"First Supplies\",\"PrimaryContact\":\"John Peoples\",\"PrimaryContactPhone\":\"8325539616\",\"PrimaryContactEmailAddress\":\"John.Peoples@arrow-test.com\",\"RecurrentBilling\":[],\"PaymentMethods\":[{\"ID\":12436,\"CardType\":\"Visa\",\"Last4\":\"1111\",\"CardholderFirstName\":\"Paola\",\"CardholderLastName\":\"Chen\",\"ExpirationMonth\":6,\"ExpirationYear\":2015,\"BillingStreet1\":\"7495 Center St.\",\"BillingCity\":\"Chicago\",\"BillingState\":\"IL\",\"BillingZip\":\"60601\"}],\"CustomerID\":10162,\"ApiKey\":\"foobar\",\"MID\":\"foo\"}",
+          :headers => {'Accept'=>'application/json', 'Content-Type'=>'application/json', 'User-Agent'=>'Ruby'}
+        ).
+        to_return(:status => 500, :body => "", :headers => {:error => "Customer with Name Foobar already exists for merchant"})
+
+      customer = client.customer('10162')
+      customer.name = 'Foobar'
+
+      expect { client.update_customer(customer) }.
+        to raise_error ArrowPayments::Error, 'Customer with Name Foobar already exists for merchant'
+    end
+
+    it 'returns true if customer was updated' do
+      stub_request(:get, "http://demo.arrowpayments.com/api/foobar/customer/10162").
+        to_return(:status => 200, :body => fixture('customer.json'))
+
+      stub_request(:post, "http://demo.arrowpayments.com/api/customer/update").
+        with(
+          :body => "{\"ID\":10162,\"Name\":\"Foobar\",\"Code\":\"First Supplies\",\"PrimaryContact\":\"John Peoples\",\"PrimaryContactPhone\":\"8325539616\",\"PrimaryContactEmailAddress\":\"John.Peoples@arrow-test.com\",\"RecurrentBilling\":[],\"PaymentMethods\":[{\"ID\":12436,\"CardType\":\"Visa\",\"Last4\":\"1111\",\"CardholderFirstName\":\"Paola\",\"CardholderLastName\":\"Chen\",\"ExpirationMonth\":6,\"ExpirationYear\":2015,\"BillingStreet1\":\"7495 Center St.\",\"BillingCity\":\"Chicago\",\"BillingState\":\"IL\",\"BillingZip\":\"60601\"}],\"CustomerID\":10162,\"ApiKey\":\"foobar\",\"MID\":\"foo\"}",
+          :headers => {'Accept'=>'application/json', 'Content-Type'=>'application/json', 'User-Agent'=>'Ruby'}
+        ).
+        to_return(:status => 200, :body => {'Success' => true}.to_json)
+
+      customer = client.customer('10162')
+      customer.name = 'Foobar'
+
+      client.update_customer(customer).should be_true
+    end
+  end
+
+  describe '#delete_customer' do
+    it 'raises error if customer does not exist' do
+      stub_request(:post, "http://demo.arrowpayments.com/api/customer/delete").
+        with(
+          :body => "{\"CustomerID\":10162,\"ApiKey\":\"foobar\",\"MID\":\"foo\"}",
+          :headers => {'Accept'=>'application/json', 'Content-Type'=>'application/json', 'User-Agent'=>'Ruby'}
+        ).
+        to_return(:status => 404, :body => "", :headers => {:error => "Customer Not Found"})
+
+      expect { client.delete_customer(10162) }.
+        to raise_error ArrowPayments::NotFound, 'Customer Not Found'
+    end
+
+    it 'returns true if customer was deleted' do
+      stub_request(:post, "http://demo.arrowpayments.com/api/customer/delete").
+        with(
+          :body => "{\"CustomerID\":10162,\"ApiKey\":\"foobar\",\"MID\":\"foo\"}",
+          :headers => {'Accept'=>'application/json', 'Content-Type'=>'application/json', 'User-Agent'=>'Ruby'}
+        ).
+        to_return(:status => 200, :body => {'Success' => true}.to_json)
+
+      client.delete_customer(10162).should be_true
+    end
+  end
+end

data/spec/entity_spec.rb

@@ -0,0 +1,55 @@
+require 'spec_helper'
+
+class EntityTester < ArrowPayments::Entity
+  property :foo,     :from => 'Foo'
+  property :foobar,  :from => 'Foobar'
+  property :foo_bar, :from => 'FooBar'
+end
+
+describe ArrowPayments::Entity do
+  let(:attributes) do
+    {'Foo' => 'a', 'Foobar' => 'b', 'FooBar' => 'c'}
+  end
+
+  describe '#new' do
+    it 'assigns properties' do
+      entity = EntityTester.new(attributes)
+
+      entity.foo.should eq('a')
+      entity.foobar.should eq('b')
+      entity.foo_bar.should eq('c')
+    end
+
+    it 'ignores undefined attributes' do
+      entity = EntityTester.new(attributes.merge('Bro' => 'Sup?'))
+
+      expect { entity.foo }.not_to raise_error
+      expect { entity['Bro'] }.to raise_error NoMethodError
+    end
+  end
+
+  describe '#properties_map' do
+    it 'returns hash with property mappings' do
+      map = EntityTester.properties_map
+
+      map.should be_a Hash
+      map.should_not be_empty
+      map.keys.should include(:foo, :foobar, :foo_bar)
+      map[:foo].should eq('Foo')
+      map[:foobar].should eq('Foobar')
+      map[:foo_bar].should eq('FooBar')
+    end
+  end
+
+  describe '#to_source_hash' do
+    it 'returns hash as source format' do
+      entity = EntityTester.new(attributes)
+      hash = entity.to_source_hash
+
+      hash.size.should eq(3)
+      hash['Foo'].should eq('a')
+      hash['Foobar'].should eq('b')
+      hash['FooBar'].should eq('c')
+    end
+  end
+end

data/spec/fixtures/complete_payment_method.json

@@ -0,0 +1,37 @@
+{
+  "Account": null,
+  "TransactionType": null,
+  "TransactionTime": null,
+  "Level": 0,
+  "TotalAmount": 0,
+  "Description": null,
+  "TransactionSource": null,
+  "Status": null,
+  "CaptureAmount": 0,
+  "AuthorizationCode": null,
+  "PaymentMethodID": 14240,
+  "CardholderFirstName": "John",
+  "CardholderLastName": "Doe",
+  "CardType": null,
+  "CardLast4": "1111",
+  "CustomerPONumber": null,
+  "TaxAmount": 0,
+  "ShippingAmount": 0,
+  "Billing": {
+    "Address1": "3128 N Broadway",
+    "Address2": "Upstairs",
+    "City": "Chicago",
+    "State": "IL",
+    "Postal": "60657",
+    "Phone": "123123123",
+    "Tag": "Doe"
+  },
+  "ShippingAddressID": 0,
+  "Shipping": null,
+  "CustomerID": 11843,
+  "CustomerName": "John Doe",
+  "LineItems": null,
+  "ID": 14240,
+  "Success": true,
+  "Message": "Payment Method Added"
+}