alpha_card 0.2.6 → 0.3.0

data/lib/alpha_card/objects/account.rb

@@ -42,7 +42,7 @@ module AlphaCard
     #   #=> false
     def filled?
       attrs = [username, password]
-      !attrs.empty? && attrs.all? { |attr| attr && !attr.strip.empty? }
+      attrs.all? { |attr| attr && !attr.strip.empty? }
     end
   end
 end

data/lib/alpha_card/objects/billing.rb

@@ -3,18 +3,29 @@ module AlphaCard
   # Implementation of Alpha Card Services order billing information.
   # Contains all the billing information (customer name, email, email, etc).
   class Billing < AlphaCardObject
-    attribute :firstname, String
-    attribute :lastname, String
+    attribute :first_name, String
+    attribute :last_name, String
     attribute :email, String
     attribute :phone, String
     attribute :company, String
-    attribute :address1, String
-    attribute :address2, String
+    attribute :address_1, String
+    attribute :address_2, String
     attribute :city, String
     attribute :state, String
     attribute :zip, String
     attribute :country, String
     attribute :fax, String
     attribute :website, String
+
+    ##
+    # Original AlphaCard transaction variables names
+    ORIGIN_TRANSACTION_VARIABLES = {
+      first_name: :firstname,
+      last_name: :lastname,
+      address_1: :address1,
+      address_2: :address2
+    }.freeze
+
+    deprecate_old_variables!
   end
 end

data/lib/alpha_card/objects/capture.rb

@@ -0,0 +1,51 @@
+module AlphaCard
+  ##
+  # Implementation of Alpha Card Services Capture transaction.
+  class Capture < AlphaCardObject
+    attribute :transaction_id, String
+    # Format: xx.xx
+    attribute :amount, String
+    attribute :tracking_number, String
+    attribute :shipping_carrier, String
+    attribute :order_id, String
+
+    ##
+    # Transaction type (default is 'capture')
+    #
+    # @attribute [r] type
+    attribute :type, String, default: 'capture', writer: :private
+
+    ##
+    # Original AlphaCard transaction variables names
+    ORIGIN_TRANSACTION_VARIABLES = {
+      transaction_id: :transactionid,
+      order_id: :orderid
+    }.freeze
+
+    ##
+    # Creates a Capture with the <code>AlphaCard::Account</code> credentials.
+    #
+    # @param [AlphaCard::Account] account
+    #   An <code>AlphaCard::Account</code> object.
+    #
+    # @return [Boolean]
+    #   True if capture was created successfully.
+    #   Raise an AlphaCardError exception if some error occurred.
+    #
+    # @raise [Exception]
+    #   Exception if one of required attributes doesn't specified.
+    #
+    # @example
+    #   account = AlphaCard::Account.new('demo', 'password')
+    #   capture = AlphaCard::Capture.new(transaction_id: '981562', amount: '10.05')
+    #   capture.create(account)
+    #
+    #   #=> [true, #<AlphaCard::AlphaCardResponse:0x1a0fda ...>]
+    def create(account)
+      abort_if_attributes_blank!(:amount, :transaction_id)
+
+      response = AlphaCard.request(account, attributes_for_request)
+      [response.success?, response]
+    end
+  end
+end

data/lib/alpha_card/objects/order.rb

@@ -3,13 +3,50 @@ module AlphaCard
   # Implementation of Alpha Card Services Order object.
   # Contains all the information about order (id, description, etc).
   class Order < AlphaCardObject
-    attribute :orderid, String
-    attribute :orderdescription, String
-    attribute :ponumber, String
+    attribute :id, String
+    attribute :description, String
+    attribute :po_number, String
     attribute :tax, String
-    attribute :ipaddress, String
+    # Format: xxx.xxx.xxx.xxx
+    attribute :ip_address, String
 
     attribute :billing, AlphaCard::Billing
     attribute :shipping, AlphaCard::Shipping
+
+    ##
+    # Original AlphaCard transaction variables names
+    ORIGIN_TRANSACTION_VARIABLES = {
+      id: :orderid,
+      description: :orderdescription,
+      po_number: :ponumber,
+      ip_address: :ipaddress
+    }.freeze
+
+    ##
+    # Overloaded method to return all the attributes from the
+    # sale + billing + shipping objects.
+    #
+    # @return [Hash]
+    #   Filled attributes with the original Alpha Card Services
+    #   transaction variables names.
+    #
+    # @example
+    #   billing = AlphaCard::Billing.new(email: 'test@example.com')
+    #   shipping = AlphaCard::Shipping.new(first_name: 'John', last_name: 'Doe')
+    #   order = AlphaCard::Order.new(id: '1', billing: billing, shipping: shipping)
+    #   order.attributes_for_request
+    #
+    #   #=>  { orderid: '1', email: 'test@example.com', shipping_first_name: 'John', shipping_last_name: 'Doe' }
+    def attributes_for_request(*)
+      attributes = filled_attributes.dup
+
+      billing = attributes.delete(:billing)
+      attributes.merge!(billing.attributes_for_request) if billing
+
+      shipping = attributes.delete(:shipping)
+      attributes.merge!(shipping.attributes_for_request) if shipping
+
+      super(attributes)
+    end
   end
 end

data/lib/alpha_card/objects/refund.rb

@@ -0,0 +1,20 @@
+module AlphaCard
+  ##
+  # Implementation of Alpha Card Services Refund transaction.
+  class Refund < Void
+    # Format: xx.xx
+    attribute :amount, String
+
+    ##
+    # Transaction type (default is 'refund')
+    #
+    # @attribute [r] type
+    attribute :type, String, default: 'refund', writer: :private
+
+    ##
+    # Original AlphaCard transaction variables names
+    ORIGIN_TRANSACTION_VARIABLES = {
+      transaction_id: :transactionid
+    }.freeze
+  end
+end

data/lib/alpha_card/objects/sale.rb

@@ -1,21 +1,38 @@
 module AlphaCard
   ##
-  # Implementation of Alpha Card Services Sale object.
+  # 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 < AlphaCardObject
-    attribute :ccexp, String
-    attribute :ccnumber, String
+    # Format: MMYY
+    attribute :card_expiration_date, String
+    attribute :card_number, String
     attribute :amount, String
     attribute :cvv, String
+    # Values: 'true' or 'false'
+    attribute :customer_receipt, String
 
     ##
-    # Not writable attribute, defines the type of transaction (default is 'sale')
+    # Payment type.
+    # Values: 'creditcard' or 'check'
+    attribute :payment, String, default: 'creditcard'
+
+    ##
+    # Transaction type (default is 'sale')
     #
     # @attribute [r] type
     attribute :type, String, default: 'sale', writer: :private
 
+    ##
+    # Original AlphaCard transaction variables names
+    ORIGIN_TRANSACTION_VARIABLES = {
+      card_expiration_date: :ccexp,
+      card_number: :ccnumber
+    }.freeze
+
+    deprecate_old_variables!
+
     ##
     # Creates the sale for the specified <code>AlphaCard::Order</code>
     # with the <code>AlphaCard::Account</code> credentials.
@@ -29,29 +46,28 @@ module AlphaCard
     #   True if sale was created successfully.
     #   Raise an AlphaCardError exception if some error occurred.
     #
-    # @raise [Exception]
+    # @raise [AlphaCard::InvalidObjectError]
     #   Exception if one of required attributes doesn't specified.
     #
     # @example
     #   account = AlphaCard::Account.new('demo', 'password')
-    #   order = AlphaCard::Order.new({orderid: 1, orderdescription: 'Test order'})
-    #   sale = AlphaCard::Sale.new({ccexp: '0117', ccnumber: '4111111111111111', amount: "5.00" })
+    #   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, account)
     #
-    #   #=> true
+    #   #=> [true, #<AlphaCard::AlphaCardResponse:0x1a0fda ...>]
     def create(order, account)
-      [:ccexp, :ccnumber, :amount].each do |attr|
-        fail ArgumentError, "No #{attr} information provided!" if self[attr].nil? || self[attr].empty?
-      end
+      abort_if_attributes_blank!(:card_expiration_date, :card_number, :amount)
 
-      AlphaCard.request(account, params_with(order)).success?
+      response = AlphaCard.request(account, params_for_sale(order))
+      [response.success?, response]
     end
 
     private
 
     ##
-    # Return params for Alpha Card merged with
-    # params of another object passed through arguments
+    # Returns all the necessary attributes with it's original
+    # names that must be passed with Sale transaction.
     #
     # @param [AlphaCard::Order] order
     #    An <code>AlphaCard::Order</code> object.
@@ -59,14 +75,8 @@ module AlphaCard
     # @return [Hash]
     #   Params of *self* object merged with params
     #   of another object (<code>AlphaCard::Order</code>)
-    def params_with(order)
-      params = filled_attributes || {}
-
-      [order, order.billing, order.shipping].compact.each do |obj|
-        params.merge!(obj ? obj.filled_attributes : {})
-      end
-
-      params
+    def params_for_sale(order)
+      attributes_for_request.merge(order.attributes_for_request)
     end
   end
 end

data/lib/alpha_card/objects/shipping.rb

@@ -3,8 +3,8 @@ module AlphaCard
   # Implementation of Alpha Card Services order shipping information.
   # Contains all the shipping information (address, city, zip, etc).
   class Shipping < AlphaCardObject
-    attribute :firstname, String
-    attribute :lastname, String
+    attribute :first_name, String
+    attribute :last_name, String
     attribute :company, String
     attribute :address_1, String
     attribute :address_2, String
@@ -14,6 +14,17 @@ module AlphaCard
     attribute :country, String
     attribute :email, String
 
+    ##
+    # Original AlphaCard transaction variables names
+    ORIGIN_TRANSACTION_VARIABLES = {
+      first_name: :firstname,
+      last_name: :lastname,
+      address_1: :address1,
+      address_2: :address2
+    }.freeze
+
+    deprecate_old_variables!
+
     ##
     # Overloaded <code>filled_attributes</code> method from
     # <code>AlphaCard::AlphaCardObject</code>. All attribute names of
@@ -24,10 +35,10 @@ module AlphaCard
     #   Only filled attributes of Shipping resource with "shipping_" prefix.
     #
     # @example
-    #   shipping = AlphaCard::Shipping.new({firstname: 'John', state: 'NY'})
+    #   shipping = AlphaCard::Shipping.new(firstname: 'John', state: 'NY')
     #   shipping.filled_attributes
     #
-    #   #=> {shipping_firstname: 'John', shipping_state: 'NY'}
+    #   #=> { shipping_firstname: 'John', shipping_state: 'NY' }
     def filled_attributes
       Hash[super.map { |k, v| ["shipping_#{k}".to_sym, v] }]
     end

data/lib/alpha_card/objects/update.rb

@@ -0,0 +1,54 @@
+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.
+  class Update < Void
+    # Total shipping amount.
+    # Format: x.xx
+    attribute :shipping, String
+    attribute :shipping_postal, String
+    attribute :ship_from_postal, String
+    attribute :shipping_country, String
+    # Values: 'ups', 'fedex', 'dhl', or 'usps'
+    attribute :shipping_carrier, String
+    # Format: YYYYMMDD
+    attribute :shipping_date, String
+    attribute :order_description, String
+    attribute :order_date, String
+    # Values: 'true' or 'false'
+    attribute :customer_receipt, String
+    attribute :po_number, String
+    attribute :summary_commodity_code, String
+    # Format: x.xx
+    attribute :duty_amount, String
+    # Format: x.xx
+    attribute :discount_amount, String
+    # Format: x.xx
+    attribute :tax, String
+    # Format: x.xx
+    attribute :national_tax_amount, String
+    # Format: x.xx
+    attribute :alternate_tax_amount, String
+    attribute :alternate_tax_id, String
+    attribute :vat_tax_amount, String
+    attribute :vat_tax_rate, String
+    attribute :vat_invoice_reference_number, String
+    attribute :customer_vat_registration, String
+    attribute :merchant_vat_registration, String
+
+    ##
+    # Transaction type (default is 'update')
+    #
+    # @attribute [r] type
+    attribute :type, String, default: 'update', writer: :private
+
+    ##
+    # Original AlphaCard transaction variables names
+    ORIGIN_TRANSACTION_VARIABLES = {
+      transaction_id: :transactionid,
+      po_number: :ponumber
+    }.freeze
+  end
+end

data/lib/alpha_card/objects/void.rb

@@ -0,0 +1,45 @@
+module AlphaCard
+  ##
+  # Implementation of Alpha Card Services Void transaction.
+  class Void < AlphaCardObject
+    attribute :transaction_id, String
+
+    ##
+    # Transaction type (default is 'void')
+    #
+    # @attribute [r] type
+    attribute :type, String, default: 'void', writer: :private
+
+    ##
+    # Original AlphaCard transaction variables names
+    ORIGIN_TRANSACTION_VARIABLES = {
+      transaction_id: :transactionid
+    }.freeze
+
+    ##
+    # Creates void transaction with the <code>AlphaCard::Account</code> credentials.
+    #
+    # @param [AlphaCard::Account] account
+    #   An <code>AlphaCard::Account</code> object.
+    #
+    # @return [Boolean]
+    #   True if transaction was created successfully.
+    #   Raise an AlphaCardError exception if some error occurred.
+    #
+    # @raise [AlphaCard::InvalidObjectError]
+    #   Exception if one of required attributes doesn't specified.
+    #
+    # @example
+    #   account = AlphaCard::Account.new('demo', 'password')
+    #   void = AlphaCard::Void.new(transaction_id: '981562')
+    #   void.create(account)
+    #
+    #   #=> [true, #<AlphaCard::AlphaCardResponse:0x1a0fda ...>]
+    def create(account)
+      abort_if_attributes_blank!(:transaction_id)
+
+      response = AlphaCard.request(account, attributes_for_request)
+      [response.success?, response]
+    end
+  end
+end

data/lib/alpha_card/version.rb

@@ -1,5 +1,21 @@
 module AlphaCard
   ##
-  # Version information for AlphaCard gem.
-  VERSION = '0.2.6'.freeze
+  # AlphaCard gem version.
+  def self.gem_version
+    Gem::Version.new VERSION::STRING
+  end
+
+  ##
+  # AlphaCard semantic versioning
+  module VERSION
+    # Major version number
+    MAJOR = 0
+    # Minor version number
+    MINOR = 3
+    # Smallest version number
+    TINY  = 0
+
+    # Full version number
+    STRING = [MAJOR, MINOR, TINY].compact.join('.')
+  end
 end

data/spec/alpha_card/objects/account_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+describe AlphaCard::Account do
+  let(:valid_account) { AlphaCard::Account.new('demo', 'password') }
+  let(:invalid_account) { AlphaCard::Account.new('', '') }
+
+  describe '#filled?' do
+    context 'with filled credentials' do
+      it 'returns true' do
+        expect(valid_account.filled?).to be_truthy
+      end
+    end
+
+    context 'with blank credentials' do
+      it 'returns false' do
+        expect(invalid_account.filled?).to be_falsey
+      end
+    end
+  end
+end