alpha_card 0.3.0 → 0.4.0

data/lib/alpha_card/transactions/capture.rb

@@ -0,0 +1,32 @@
+module AlphaCard
+  ##
+  # Implementation of Alpha Card Services Capture transaction.
+  #
+  # @example
+  #   capture = AlphaCard::Capture.new(transaction_id: '981562', amount: '10.05')
+  #   capture.process
+  #
+  #   #=> #<AlphaCard::Response:0x1a0fda ...>
+  #
+  class Capture < Transaction
+    attribute :transaction_id, required: true
+    # Format: xx.xx
+    attribute :amount, required: true
+    attribute :tracking_number
+    attribute :shipping_carrier
+    attribute :order_id
+
+    ##
+    # Transaction type (default is 'capture')
+    #
+    # @attribute [r] type
+    attribute :type, default: 'capture', writeable: false
+
+    ##
+    # Original AlphaCard transaction variables names
+    ORIGIN_TRANSACTION_VARIABLES = {
+      transaction_id: :transactionid,
+      order_id: :orderid
+    }.freeze
+  end
+end

data/lib/alpha_card/transactions/credit.rb

@@ -0,0 +1,18 @@
+module AlphaCard
+  ##
+  # Implementation of Alpha Card Services Credit transaction.
+  #
+  # @example
+  #   credit = AlphaCard::Credit.new(card_expiration_date: '0117', card_number: '4111111111111111', amount: '1.00')
+  #   credit.create(order)
+  #
+  #   #=> #<AlphaCard::Response:0x1a0fda ...>
+  #
+  class Credit < Sale
+    ##
+    # Transaction type (default is 'credit')
+    #
+    # @attribute [r] type
+    attribute :type, default: 'credit', writable: false
+  end
+end

data/lib/alpha_card/{objects → transactions}/refund.rb

@@ -1,15 +1,22 @@
 module AlphaCard
   ##
   # Implementation of Alpha Card Services Refund transaction.
+  #
+  # @example
+  #   refund = AlphaCard::Refund.new(transaction_id: '981562', amount: '1.00')
+  #   refund.create
+  #
+  #   #=> #<AlphaCard::Response:0x1a0fda ...>
+  #
   class Refund < Void
     # Format: xx.xx
-    attribute :amount, String
+    attribute :amount
 
     ##
     # Transaction type (default is 'refund')
     #
     # @attribute [r] type
-    attribute :type, String, default: 'refund', writer: :private
+    attribute :type, default: 'refund', writable: false
 
     ##
     # Original AlphaCard transaction variables names

data/lib/alpha_card/transactions/sale.rb

@@ -0,0 +1,91 @@
+module AlphaCard
+  ##
+  # Implementation of Alpha Card Services Sale transaction.
+  # Contains all the information about Customer Credit Card,
+  # such as CVV, number, expiration date, etc.
+  # Process the Alpha Card Services payment.
+  class Sale < Transaction
+    # Format: MMYY
+    attribute :card_expiration_date, required: true, format: /\A((0[1-9])|(1[0-2]))\/*\d{2}\z/.freeze
+    attribute :card_number, required: true
+    attribute :amount, required: true
+    attribute :cvv
+    # Values: 'true' or 'false'
+    attribute :customer_receipt
+    attribute :check_name
+    attribute :check_aba
+    attribute :check_account
+    # Values: 'business' or 'personal'
+    attribute :account_holder_type, values: %w(business personal).freeze
+    # Values: 'checking' or 'savings'
+    attribute :account_type, values: %w(checking savings).freeze
+    # Values: 'PPD', 'WEB', 'TEL', or 'CCD'
+    attribute :sec_code, values: %w(PPD WEB TEL CCD).freeze
+
+    ##
+    # Payment type.
+    # Values: 'creditcard' or 'check'
+    attribute :payment, default: 'creditcard', values: %w(creditcard check).freeze
+
+    ##
+    # Transaction type (default is 'sale')
+    #
+    # @attribute [r] type
+    attribute :type, default: 'sale', writeable: false
+
+    ##
+    # Original AlphaCard transaction variables names
+    ORIGIN_TRANSACTION_VARIABLES = {
+      card_expiration_date: :ccexp,
+      card_number: :ccnumber,
+      check_name: :checkname,
+      check_aba: :checkaba,
+      check_account: :checkaccount
+    }.freeze
+
+    ##
+    # Creates the sale transaction for the specified <code>AlphaCard::Order</code>.
+    #
+    # @param order [AlphaCard::Order]
+    #    An <code>AlphaCard::Order</code> object.
+    #
+    # @param credentials [Hash]
+    #   Alpha Card merchant account credentials.
+    #
+    # @return [AlphaCard::Response]
+    #   AlphaCard Gateway response with all the information about transaction.
+    #
+    # @raise [AlphaCard::InvalidObjectError]
+    #   Exception if one of required attributes doesn't specified.
+    #
+    # @example
+    #   order = AlphaCard::Order.new(id: 1, description: 'Test order')
+    #   sale = AlphaCard::Sale.new(card_expiration_date: '0117', card_number: '4111111111111111', amount: '5.00' )
+    #   sale.create(order)
+    #
+    #   #=> #<AlphaCard::Response:0x1a0fda ...>
+    def process(order, credentials = Account.credentials)
+      validate_required_attributes!
+
+      AlphaCard.request(params_for_sale(order), credentials)
+    end
+
+    alias_method :create, :process
+
+    private
+
+    ##
+    # Returns all the necessary attributes with it's original
+    # names that must be passed with Sale transaction.
+    #
+    # @param order [AlphaCard::Order]
+    #    An <code>AlphaCard::Order</code> object.
+    #
+    # @return [Hash]
+    #   Params of *self* object merged with params
+    #   of another object (<code>AlphaCard::Order</code>)
+    def params_for_sale(order)
+      attributes_for_request.merge(order.attributes_for_request)
+    end
+  end
+end

data/lib/alpha_card/transactions/update.rb

@@ -0,0 +1,61 @@
+module AlphaCard
+  ##
+  # Implementation of Alpha Card Services Update transaction.
+  # Transaction updates can be used to update previous transactions
+  # with specific order information, such as a tracking number
+  # and shipping carrier.
+  #
+  # @example
+  #   update = AlphaCard::Update.new(card_expiration_date: '0117', card_number: '4111111111111111', amount: '1.00')
+  #   update.process(order)
+  #
+  #   #=> #<AlphaCard::Response:0x1a0fda ...>
+  #
+  class Update < Void
+    # Total shipping amount.
+    # Format: x.xx
+    attribute :shipping, type: String
+    attribute :shipping_postal, type: String
+    attribute :ship_from_postal, type: String
+    attribute :shipping_country, type: String
+    # Values: 'ups', 'fedex', 'dhl', or 'usps'
+    attribute :shipping_carrier, type: String, values: %w(ups fedex dhl usps).freeze
+    # Format: YYYYMMDD
+    attribute :shipping_date, type: String, format: /\A[1-9]\d{3}((0[1-9])|(1[0-2]))((0[1-9])|((1|2)[0-9])|3[0-1])\z/.freeze
+    attribute :order_description, type: String
+    attribute :order_date, type: String
+    # Values: 'true' or 'false'
+    attribute :customer_receipt, type: String
+    attribute :po_number, type: String
+    attribute :summary_commodity_code, type: String
+    # Format: x.xx
+    attribute :duty_amount
+    # Format: x.xx
+    attribute :discount_amount
+    # Format: x.xx
+    attribute :tax
+    # Format: x.xx
+    attribute :national_tax_amount
+    # Format: x.xx
+    attribute :alternate_tax_amount
+    attribute :alternate_tax_id
+    attribute :vat_tax_amount
+    attribute :vat_tax_rate, type: String
+    attribute :vat_invoice_reference_number, type: String
+    attribute :customer_vat_registration, type: String
+    attribute :merchant_vat_registration, type: String
+
+    ##
+    # Transaction type (default is 'update')
+    #
+    # @attribute [r] type
+    attribute :type, default: 'update', writable: false
+
+    ##
+    # Original AlphaCard transaction variables names
+    ORIGIN_TRANSACTION_VARIABLES = {
+      transaction_id: :transactionid,
+      po_number: :ponumber
+    }.freeze
+  end
+end

data/lib/alpha_card/transactions/validate.rb

@@ -0,0 +1,21 @@
+module AlphaCard
+  ##
+  # Implementation of Alpha Card Services Validate transaction.
+  #
+  # @example
+  #   validate = AlphaCard::Validate.new(card_expiration_date: '0117', card_number: '4111111111111111')
+  #   validate.process
+  #
+  #   #=> #<AlphaCard::Response:0x1a0fda ...>
+  #
+  class Validate < Sale
+    ##
+    # Transaction type (default is 'validate')
+    #
+    # @attribute [r] type
+    attribute :type, default: 'validate', writable: false
+
+    # Validate transaction can't have an amount
+    remove_attribute :amount
+  end
+end

data/lib/alpha_card/transactions/void.rb

@@ -0,0 +1,26 @@
+module AlphaCard
+  ##
+  # Implementation of Alpha Card Services Void transaction.
+  #
+  # @example
+  #   void = AlphaCard::Void.new(transaction_id: '981562')
+  #   void.create
+  #
+  #   #=> #<AlphaCard::Response:0x1a0fda ...>
+  #
+  class Void < Transaction
+    attribute :transaction_id, type: [String, Integer], required: true
+
+    ##
+    # Transaction type (default is 'void')
+    #
+    # @attribute [r] type
+    attribute :type, default: 'void', writable: false
+
+    ##
+    # Original AlphaCard transaction variables names
+    ORIGIN_TRANSACTION_VARIABLES = {
+      transaction_id: :transactionid
+    }.freeze
+  end
+end

data/lib/alpha_card/version.rb

@@ -11,7 +11,7 @@ module AlphaCard
     # Major version number
     MAJOR = 0
     # Minor version number
-    MINOR = 3
+    MINOR = 4
     # Smallest version number
     TINY  = 0
 

data/spec/alpha_card/attribute_spec.rb

@@ -0,0 +1,126 @@
+require 'spec_helper'
+
+describe AlphaCard::Attribute do
+  class User
+    include AlphaCard::Attribute
+
+    attribute :name
+    attribute :activated, values: [true, false]
+    attribute :role, default: 'user', writable: false
+  end
+
+  class Moderator < User
+    attribute :id, type: Integer, default: 11
+    attribute :status, default: 'global', writable: false
+    attribute :role, default: 'moderator', writable: false
+  end
+
+  class Admin < Moderator
+    attribute :role, default: 'admin', types: [String, Symbol]
+    attribute :birthday, format: /^\d{2}-\d{2}-\d{4}$/
+
+    attribute :created_at, required: true
+
+    remove_attribute :status
+  end
+
+  context 'User' do
+    it 'must set attributes from arguments on initialization' do
+      user = User.new(name: 'John', activated: true)
+      expect(user.name).to eq('John')
+      expect(user.activated).to be_truthy
+    end
+
+    it 'must ignore non-writable attributes on initialization' do
+      user = User.new(role: 'test')
+      expect(user.role).to eq('user')
+    end
+
+    it 'must set default values' do
+      expect(User.new.role).to eq('user')
+    end
+
+    it 'must not create writers for non-writable attributes' do
+      expect { User.new.role = '111' }.to raise_error(NoMethodError)
+    end
+
+    it 'must raise an error on wrong values' do
+      expect { User.new(activated: 'wrong') }.to raise_error(AlphaCard::InvalidAttributeValue)
+    end
+  end
+
+  context 'Moderator' do
+    it 'must inherit attributes' do
+      moderator = Moderator.new(name: 'John', activated: true)
+      expect(moderator.attributes).to eq(name: 'John', activated: true, id: 11, role: 'moderator', status: 'global')
+    end
+
+    it 'must override attributes default values' do
+      expect(Moderator.new.role).to eq('moderator')
+    end
+
+    it 'must validate typed attributes' do
+      expect { Moderator.new.id = '123' }.to raise_error(AlphaCard::InvalidAttributeType)
+    end
+  end
+
+  context 'Admin' do
+    it 'must inherit superclass attributes' do
+      admin = Admin.new(name: 'John', activated: true)
+      expect(admin.name).to eq('John')
+      expect(admin.id).to eq(11)
+      expect(admin.activated).to be_truthy
+    end
+
+    it 'must override superclass attributes default values' do
+      expect(Admin.new.role).to eq('admin')
+    end
+
+    it 'must override superclass attributes options (make writable)' do
+      admin = Admin.new
+      admin.role = 'something_new'
+      expect(admin.role).to eq('something_new')
+    end
+
+    it 'must override superclass attributes options (make typable)' do
+      expect(Admin.new(role: 'admin').role).to eq('admin')
+      expect(Admin.new(role: :admin).role).to eq(:admin)
+
+      expect { Admin.new(role: 123) }.to raise_error(AlphaCard::InvalidAttributeType)
+    end
+
+    it 'must remove attributes' do
+      expect { Admin.new.status = 'local' }.to raise_error(NoMethodError)
+    end
+
+    it 'must require attributes' do
+      expect(Admin.new.required_attributes?).to be_falsey
+      expect(Admin.new(created_at: Date.today).required_attributes?).to be_truthy
+    end
+
+    it 'must validate attribute format' do
+      error_msg = "'local' does not match the '/^\\d{2}-\\d{2}-\\d{4}$/' format"
+      expect { Admin.new.birthday = 'local' }.to raise_error(AlphaCard::InvalidAttributeFormat, error_msg)
+    end
+
+    it 'must not allow to add invalid attributes' do
+      expect {
+        Admin.class_eval <<-RUBY.strip
+          attribute :some, values: 10
+        RUBY
+      }.to raise_error(ArgumentError)
+
+      expect {
+        Admin.class_eval <<-RUBY.strip
+          attribute :some, values: []
+        RUBY
+      }.to raise_error(ArgumentError)
+
+      expect {
+        Admin.class_eval <<-RUBY.strip
+          attribute :some, format: 10
+        RUBY
+      }.to raise_error(ArgumentError)
+    end
+  end
+end

data/spec/alpha_card/response_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe AlphaCard::AlphaCardResponse do
+describe AlphaCard::Response do
   let(:successful_response_mock) do
     'authcode=083319&avsresponse=&cvvresponse=M&orderid=1&response=1&response_code=100&responsetext=AP&transactionid=2303767426&type=sale'
   end
@@ -14,7 +14,7 @@ describe AlphaCard::AlphaCardResponse do
   end
 
   context 'successful request' do
-    let(:response) { AlphaCard::AlphaCardResponse.new(successful_response_mock) }
+    let(:response) { AlphaCard::Response.new(successful_response_mock) }
 
     it '#success? = true' do
       expect(response.success?).to be_truthy
@@ -47,10 +47,14 @@ describe AlphaCard::AlphaCardResponse do
     it 'returns auth code' do
       expect(response.auth_code).to eq('083319')
     end
+
+    it 'returns credit card authorization message' do
+      expect(response.credit_card_auth_message).to eq('Approved or completed successfully')
+    end
   end
 
   context 'declined request' do
-    let(:response) { AlphaCard::AlphaCardResponse.new(declined_response_mock) }
+    let(:response) { AlphaCard::Response.new(declined_response_mock) }
 
     it '#declined? = true' do
       expect(response.declined?).to be_truthy
@@ -78,7 +82,7 @@ describe AlphaCard::AlphaCardResponse do
   end
 
   context 'error request' do
-    let(:response) { AlphaCard::AlphaCardResponse.new(error_response_mock) }
+    let(:response) { AlphaCard::Response.new(error_response_mock) }
 
     it '#error? = true' do
       expect(response.error?).to be_truthy