pensio_api 0.2.1 → 0.2.2

data/lib/pensio_api/responses/refund.rb

@@ -0,0 +1,17 @@
+module PensioAPI
+  module Responses
+    class Refund < Base
+      attr_reader :transaction, :refund_amount, :refund_currency
+
+      def initialize(request)
+        super(request)
+
+        @transaction = PensioAPI::Transaction.new(
+          transactions['Transaction']
+        )
+        @refund_amount = BigDecimal.new(@raw['RefundedAmount'])
+        @refund_currency = @raw['RefundCurrency'].to_i
+      end
+    end
+  end
+end

data/lib/pensio_api/responses/reservation.rb

@@ -0,0 +1,15 @@
+module PensioAPI
+  module Responses
+    class Reservation < Base
+      attr_reader :transaction
+
+      def initialize(request)
+        super(request)
+
+        @transaction = PensioAPI::Transaction.new(
+          transactions['Transaction']
+        )
+      end
+    end
+  end
+end

data/lib/pensio_api/responses/reservation_capture.rb

@@ -0,0 +1,14 @@
+module PensioAPI
+  module Responses
+    class ReservationCapture < Responses::Reservation
+      attr_reader :capture_amount, :capture_currency
+
+      def initialize(request)
+        super(request)
+
+        @capture_amount = BigDecimal.new(@raw['CaptureAmount'])
+        @capture_currency = @raw['CaptureCurrency'].to_i
+      end
+    end
+  end
+end

data/lib/pensio_api/responses/reservation_release.rb

@@ -0,0 +1,6 @@
+module PensioAPI
+  module Responses
+    class ReservationRelease < Responses::Reservation
+    end
+  end
+end

data/lib/pensio_api/responses/subscription_charge.rb

@@ -0,0 +1,21 @@
+module PensioAPI
+  module Responses
+    class SubscriptionCharge < Responses::Transaction
+      extend Forwardable
+
+      def_delegators :new, :captured?
+
+      def each
+        [existing, new].each { |t| yield t }
+      end
+
+      def existing
+        @transactions.first
+      end
+
+      def new
+        @transactions.last
+      end
+    end
+  end
+end

data/lib/pensio_api/responses/subscription_failure_callback.rb

@@ -0,0 +1,21 @@
+module PensioAPI
+  module Responses
+    class SubscriptionFailureCallback < Transaction
+      extend Forwardable
+
+      def_delegators :new, :captured?
+
+      def each
+        [reservation, charge].each { |t| yield t }
+      end
+
+      def reservation
+        @transactions.first
+      end
+
+      def charge
+        @transactions.last
+      end
+    end
+  end
+end

data/lib/pensio_api/responses/success_callback.rb

@@ -0,0 +1,21 @@
+module PensioAPI
+  module Responses
+    class SuccessCallback < Transaction
+      extend Forwardable
+
+      def_delegators :new, :captured?
+
+      def each
+        [reservation, charge].each { |t| yield t }
+      end
+
+      def reservation
+        @transactions.first
+      end
+
+      def charge
+        @transactions.last
+      end
+    end
+  end
+end

data/lib/pensio_api/responses/terminal.rb

@@ -0,0 +1,41 @@
+module PensioAPI
+  module Responses
+    class Terminal < Base
+      include Enumerable
+
+      attr_reader :terminals
+
+      def initialize(request)
+        super(request)
+
+        map_terminals
+      end
+
+      def each
+        @terminals.each { |t| yield t }
+      end
+
+      def last
+        @terminals.last
+      end
+
+      private
+
+      def map_terminals
+        @terminals = if raw_terminals.is_a?(Array)
+          raw_terminals.map { |t| PensioAPI::Terminal.new(t) }
+        else
+          [PensioAPI::Terminal.new(raw_terminals)]
+        end
+      end
+
+      def raw_terminals
+        @raw_terminals ||= if @raw['Terminals']
+          @raw['Terminals']['Terminal']
+        else
+          []
+        end
+      end
+    end
+  end
+end

data/lib/pensio_api/responses/transaction.rb

@@ -0,0 +1,13 @@
+module PensioAPI
+  module Responses
+    class Transaction < Base
+      include Mixins::HasTransactions
+
+      def initialize(request)
+        super(request)
+
+        map_transactions
+      end
+    end
+  end
+end

data/lib/pensio_api/subscription.rb

@@ -0,0 +1,30 @@
+module PensioAPI
+  class Subscription
+    def self.setup(options={})
+      request = Request.new('/merchant/API/setupSubscription', options)
+      if request.response_contains?('Transactions')
+        Transaction.new(request.body['Transactions']['Transaction'])
+      end
+    end
+
+    def initialize(transaction)
+      @transaction = transaction
+    end
+
+    def charge(options={})
+      request = Request.new('/merchant/API/chargeSubscription', options.merge(subscription_options))
+      Responses::SubscriptionCharge.new(request)
+    end
+
+    def reserve_charge(options={})
+      request = Request.new('/merchant/API/reserveSubscriptionCharge', options.merge(subscription_options))
+      Responses::SubscriptionCharge.new(request)
+    end
+
+    private
+
+    def subscription_options
+      { transaction_id: @transaction.id }
+    end
+  end
+end

data/lib/pensio_api/terminal.rb

@@ -0,0 +1,17 @@
+module PensioAPI
+  class Terminal
+    include Mixins::MethodMissing
+
+    attr_reader :title
+
+    def self.all
+      request = Request.new('/merchant/API/getTerminals')
+      Responses::Terminal.new(request)
+    end
+
+    def initialize(terminal_body)
+      @raw = terminal_body
+      @title = @raw['Title']
+    end
+  end
+end

data/lib/pensio_api/transaction.rb

@@ -0,0 +1,84 @@
+module PensioAPI
+  class Transaction
+    include Mixins::ID
+    include Mixins::MethodMissing
+    include Mixins::Timestamps
+
+    attr_reader :status
+    attr_reader :captured_amount
+    attr_reader :reserved_amount
+    attr_reader :refunded_amount
+    attr_reader :recurring_default_amount
+    attr_reader :card_status
+    attr_reader :card_token
+    attr_reader :card_masked_pan
+    attr_reader :order_id
+    attr_reader :merchant_currency
+    attr_reader :card_holder_currency
+
+    # constants for transaction statuses
+    STATUS_RECURRING_CONFIRMED = 'recurring_confirmed'
+    STATUS_RELEASED = 'released'
+    STATUS_CAPTURED = 'captured'
+    STATUS_CAPTURED_FAILED = 'captured_failed'
+    
+    RESERVATION_SUCCESS_STATUSES = [STATUS_RECURRING_CONFIRMED]
+    CHARGE_SUCCESS_STATUSES = [STATUS_CAPTURED]
+    
+    def initialize(transaction_body)
+      @raw = transaction_body
+
+      @status = @raw['TransactionStatus']
+
+      @captured_amount = BigDecimal.new(@raw['CapturedAmount'])
+      @reserved_amount = BigDecimal.new(@raw['ReservedAmount'])
+      @refunded_amount = BigDecimal.new(@raw['RefundedAmount'])
+      @recurring_default_amount = BigDecimal.new(@raw['RecurringDefaultAmount'])
+
+      @card_status = @raw['CardStatus']
+      @card_token = @raw['CreditCardToken']
+      @card_masked_pan = @raw['CreditCardMaskedPan']
+
+      @order_id = @raw['ShopOrderId']
+
+      @merchant_currency = @raw['MerchantCurrency'].to_i
+      @card_holder_currency = @raw['CardHolderCurrency'].to_i
+    end
+
+    def self.find(options={})
+      request = Request.new('/merchant/API/payments', options)
+      Responses::Transaction.new(request)
+    end
+
+    def captured?
+      captured_amount >= reserved_amount && CHARGE_SUCCESS_STATUSES.include?(self.transaction_status)
+    end
+    
+    def reserved?
+      RESERVATION_SUCCESS_STATUSES.include?(self.transaction_status)
+    end
+
+    def to_reservation
+      Reservation.new(self)
+    end
+
+    def to_subscription
+      Subscription.new(self)
+    end
+
+    def refund(options={})
+      request = Request.new('/merchant/API/refundCapturedReservation', options.merge(transaction_id: self.id))
+      Responses::Refund.new(request)
+    end
+
+    def terminal
+      @terminal ||= Terminal.all.find { |t| t.title == @raw['Terminal'] }
+    end
+
+    def billing_address
+      @billing_address ||= if @raw.has_key?('CustomerInfo') && @raw['CustomerInfo'].has_key?('BillingAddress')
+        BillingAddress.new(@raw['CustomerInfo']['BillingAddress'])
+      end
+    end
+  end
+end

data/lib/pensio_api.rb

@@ -0,0 +1,36 @@
+require 'active_support/core_ext/string/inflections'
+
+require 'pensio_api/mixins/id'
+require 'pensio_api/mixins/has_transactions'
+require 'pensio_api/mixins/method_missing'
+require 'pensio_api/mixins/request_defaults'
+require 'pensio_api/mixins/timestamps'
+
+require 'pensio_api/billing_address'
+require 'pensio_api/callback'
+require 'pensio_api/credentials'
+require 'pensio_api/ecommerce'
+require 'pensio_api/funding_list'
+require 'pensio_api/funding_list_request'
+require 'pensio_api/request'
+require 'pensio_api/reservation'
+require 'pensio_api/transaction'
+require 'pensio_api/terminal'
+require 'pensio_api/subscription'
+
+require 'pensio_api/errors/bad_request'
+require 'pensio_api/errors/gateway_error'
+require 'pensio_api/errors/no_credentials'
+
+require 'pensio_api/responses/base'
+require 'pensio_api/responses/funding_list'
+require 'pensio_api/responses/gateway_url'
+require 'pensio_api/responses/terminal'
+require 'pensio_api/responses/transaction'
+require 'pensio_api/responses/refund'
+require 'pensio_api/responses/reservation'
+require 'pensio_api/responses/reservation_capture'
+require 'pensio_api/responses/reservation_release'
+require 'pensio_api/responses/subscription_charge'
+require 'pensio_api/responses/success_callback'
+require 'pensio_api/responses/subscription_failure_callback'

data/pensio_api.gemspec

@@ -0,0 +1,20 @@
+Gem::Specification.new do |s|
+  s.name = 'pensio_api'
+  s.version = '0.2.2'
+  s.license = 'BSD-3-Clause'
+  s.summary = "Provides integration for the Pensio Merchant API"
+  s.authors = ['Michael Sell', 'Rory Sinclair']
+  s.email = 'michael@asw.com'
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- spec/*`.split("\n")
+  s.require_paths = ["lib"]
+  
+  s.add_development_dependency 'rspec', '>= 2.14'
+  s.add_development_dependency 'webmock', '~> 1.16.1'
+  s.add_development_dependency 'guard', '~> 2.2.5'
+  s.add_development_dependency 'guard-rspec', '~> 4.2.4'
+
+  s.add_dependency 'httparty', '>= 0.12.0'
+  s.add_dependency 'activesupport', '>= 3.2'
+  s.add_dependency 'multi_xml', '>= 0.5.2'
+end

data/spec/lib/pensio_api/billing_address_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+
+describe PensioAPI::BillingAddress do
+  before :each do
+    stub_pensio_response('/merchant/API/payments', 'payments')
+  end
+
+  let(:transaction) { PensioAPI::Transaction.find.first }
+  let(:billing_address) { transaction.billing_address }
+
+  describe 'reader attributes' do
+    describe '.first_name' do
+      specify { expect(billing_address.first_name).to eq(transaction.customer_info['BillingAddress']['Firstname']) }
+    end
+
+    describe '.last_name' do
+      specify { expect(billing_address.last_name).to eq(transaction.customer_info['BillingAddress']['Lastname']) }
+    end
+
+    describe '.street_address' do
+      specify { expect(billing_address.street_address).to eq(transaction.customer_info['BillingAddress']['Address']) }
+    end
+
+    describe '.city' do
+      specify { expect(billing_address.city).to eq(transaction.customer_info['BillingAddress']['City']) }
+    end
+
+    describe '.region' do
+      specify { expect(billing_address.region).to eq(transaction.customer_info['BillingAddress']['Region']) }
+    end
+
+    describe '.postal_code' do
+      specify { expect(billing_address.postal_code).to eq(transaction.customer_info['BillingAddress']['PostalCode']) }
+    end
+
+    describe '.country' do
+      specify { expect(billing_address.country).to eq(transaction.customer_info['BillingAddress']['Country']) }
+    end
+  end
+end

data/spec/lib/pensio_api/callback_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+describe PensioAPI::Callback do
+
+  describe ".parse_success" do
+    let(:response) { PensioAPI::Callback.parse_success(file_fixture("success_callback.xml")) }
+    it "should return a SuccessCallback response" do
+      expect(response).to be_an_instance_of(PensioAPI::Responses::SuccessCallback)
+      expect(response.success?).to be_true
+    end
+  end
+  
+  describe ".parse_failure" do 
+    let(:response) { PensioAPI::Callback.parse_failure(file_fixture("subscription_failure_callback.xml")) }
+    it "should return a SubscriptionFailureCallback response" do
+      expect(response).to be_an_instance_of(PensioAPI::Responses::SubscriptionFailureCallback)
+      expect(response.success?).to be_true
+    end
+  end
+end
+

data/spec/lib/pensio_api/ecommerce_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe PensioAPI::Ecommerce do
+  before :each do
+    stub_pensio_response('/merchant/API/createPaymentRequest', 'create_payment_request')
+    stub_pensio_response('/merchant/API/createMultiPaymentRequest', 'create_multi_payment_request')
+  end
+
+  describe '.create_payment_request' do
+    let(:response) { PensioAPI::Ecommerce.create_payment_request(reservation_arguments) }
+    it 'returns an instance of PensioAPI::Responses::GatewayURL' do
+      expect(response).to be_an_instance_of(PensioAPI::Responses::GatewayURL)
+    end
+  end
+
+  describe '.create_multi_payment_request' do
+    let(:response) { PensioAPI::Ecommerce.create_multi_payment_request(reservation_arguments) }
+    it 'returns an instance of PensioAPI::Responses::GatewayURL' do
+      expect(response).to be_an_instance_of(PensioAPI::Responses::GatewayURL)
+    end
+  end
+end

data/spec/lib/pensio_api/errors/bad_request_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+describe PensioAPI::Errors::BadRequest do
+  before :each do
+    stub_pensio_response('/merchant/API/payments', 'bad_request_error')
+  end
+
+  let(:error) do
+    begin
+      PensioAPI::Transaction.find
+    rescue PensioAPI::Errors::BadRequest => e
+    end
+    e
+  end
+
+  specify { expect(error).to be_an_instance_of PensioAPI::Errors::BadRequest }
+
+  describe 'getter attributes' do
+    describe '.request_time' do
+      specify { expect(error.request_time).to be_an_instance_of(Time) }
+    end
+
+    describe '.request_path' do
+      specify { expect(error.request_path).to be_an_instance_of(String) }
+    end
+
+    describe '.error_code' do
+      specify { expect(error.error_code).to be_an_instance_of(Fixnum) }
+    end
+  end
+end

data/spec/lib/pensio_api/errors/gateway_error_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+describe PensioAPI::Errors::GatewayError do
+  before :each do
+    stub_pensio_response('/merchant/API/payments', 'pensio_error')
+  end
+
+  let(:error) do
+    begin
+      PensioAPI::Transaction.find
+    rescue PensioAPI::Errors::GatewayError => e
+    end
+    e
+  end
+
+  specify { expect(error).to be_an_instance_of PensioAPI::Errors::GatewayError }
+
+  describe 'getter attributes' do
+    describe '.request_time' do
+      specify { expect(error.request_time).to be_an_instance_of(Time) }
+    end
+
+    describe '.request_path' do
+      specify { expect(error.request_path).to be_an_instance_of(String) }
+    end
+
+    describe '.error_code' do
+      specify { expect(error.cardholder_message).to be_an_instance_of(String) }
+    end
+  end
+
+  describe 'object mapping' do
+    it 'maps transactions to transaction objects' do
+      expect(error.transactions.all? { |r| r.class == PensioAPI::Transaction }).to be_true
+    end
+  end
+end
+

data/spec/lib/pensio_api/funding_list_request_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+describe PensioAPI::FundingListRequest do
+  before :each do
+    stub_pensio_response('/merchant/API/fundingList', 'funding_list')
+    stub_pensio_response("http://test_user:password@localhost/merchant.php/API/fundingDownload?id=1", 'funding_download', mime_type: 'text/csv', file_ext: 'csv', base_url: '')
+  end
+
+  let(:request) { PensioAPI::FundingListRequest.new(PensioAPI::FundingList.all.first.download_link) }
+
+  describe 'result' do
+    specify { expect(request).to respond_to(:result) }
+    it 'returns a parsed CSV array' do
+      expect(request.result.map(&:class).uniq).to eq([CSV::Row])
+    end
+  end
+end

data/spec/lib/pensio_api/funding_list_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+describe PensioAPI::FundingList do
+  let(:response) { PensioAPI::FundingList.all }
+  let(:funding_list) { PensioAPI::FundingList.all.first }
+
+  before :each do
+    stub_pensio_response('/merchant/API/fundingList', 'funding_list')
+  end
+
+  describe '.all' do
+    it 'returns an instance of PensioAPI::Responses::FundingList' do
+      expect(response).to be_an_instance_of(PensioAPI::Responses::FundingList)
+    end
+  end
+
+  describe 'reader_attributes' do
+    specify { expect(funding_list).to respond_to(:filename) }
+    specify { expect(funding_list).to respond_to(:amount) }
+    specify { expect(funding_list).to respond_to(:acquirer) }
+    specify { expect(funding_list).to respond_to(:funding_date) }
+    specify { expect(funding_list).to respond_to(:created_at) }
+    specify { expect(funding_list).to respond_to(:download_link) }
+
+    specify { expect(funding_list.funding_date).to be_an_instance_of(Date) }
+    specify { expect(funding_list.created_at).to be_an_instance_of(Date) }
+  end
+
+  describe '.download' do
+    before :each do
+      stub_pensio_response("http://test_user:password@localhost/merchant.php/API/fundingDownload?id=1", 'funding_download', mime_type: 'text/csv', file_ext: 'csv', base_url: '')
+    end
+
+    it 'returns an array of parsed CSV' do
+      expect(funding_list.download.map(&:class).uniq).to eq([CSV::Row])
+    end
+  end
+end