alpha_card 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0e5ac24025977d5cd2c3406cba14ebde613b4f7b
-  data.tar.gz: 7696ce4ea24336d3214c056e612a7e5a068940fc
+  metadata.gz: be339a6f92fcdf01468ecf0da9522e8a6369672c
+  data.tar.gz: 1ccab5e6c73ea8a0d98b18854a05e62c9ba807bb
 SHA512:
-  metadata.gz: 3666ded11769f172c69f8dee353a22a762daa403e850a46fc82174b968fee31339a6b101fd9cf7a0885a4b0c4c667aee8ad748e58e7b6558e9d848b60d823a8a
-  data.tar.gz: 453305dfd596b13e12ce9ea3064cd188806ba429bf9d5d51c9573cf022d646e592c1ebeaf18fce331dd5cd19f7b8330f8a79f6dd16885aa914e3a5c3d8bf1485
+  metadata.gz: 5aea65ee2cf8ac68bba49a46937c60c5d175204ff4d8b64431490a74ee3ef80d2ea0dc536e64c189d190275e22f41d90d8de382847160597e73e0e65b49bae25
+  data.tar.gz: ca8da9382717060a317522d35732ded4a68dc2e174abf2866bcf7e07c81bcecafc91efe405bae37e530c070e6e0d12497fbfbad19895366707b28245edf7583f

data/.travis.yml

@@ -3,12 +3,12 @@ before_install: gem install bundler
 bundler_args: --without yard guard benchmarks
 script: "rake spec"
 rvm:
-  - 2.0.0
-  - 2.1.5
   - 2.2.4
   - 2.3.0
-  - jruby-9.0.0.0
+  - jruby-9.0.5.0
+  - jruby-9.1.5.0
   - ruby-head
+env: JRUBY_OPTS="$JRUBY_OPTS --debug"
 matrix:
   allow_failures:
-    - rvm: ruby-head
+    - rvm: ruby-head

data/CHANGELOG.md

@@ -2,11 +2,29 @@
 
 Reverse Chronological Order:
 
+## `0.4.0` (2016-10-07)
+
+https://github.com/nbulaj/alpha_card/compare/0.3.0...0.4.0
+
+### Breaking changes
+* Dropped support of Ruby <= 2.2.2
+* Removed deprecated methods (a.k.a. old transaction variables names)
+* All transactions now returns `AlphaCard::Response` regardless of the operation result (except HTTP errors)
+* `AlphaCard::Account` now works as global Alpha Card Merchant Account configuration (see docs)
+
+### Other changes
+* New AlphaCard transactions: `Auth`, `Credit`, `Validate`
+* Own Attributes DSL with types, validations and other useful things
+* Dropped `Virtus` dependency
+* Fixed `check` payment (added new transaction variables for this type of operation)
+* Credit Card authorization codes changes (removed dot at the end ot the message, improved `Response` API)
+* Specs and documentation improvements
+
 ## `0.3.0` (2016-09-22)
 
 https://github.com/nbulaj/alpha_card/compare/0.2.6...0.3.0
 
-* Dropped support of Ruby 1.9.3
+* Dropped support of Ruby 1.9.3 and jruby-1.7
 * New AlphaCard transactions: `Void`, `Refund`, `Capture`, `Update`
 * New AlphaCard transactions variables
 * New AlphaCard transactions variables naming (**old is deprecated**)
@@ -44,9 +62,9 @@ https://github.com/nbulaj/alpha_card/compare/0.2.4...0.2.6
 ## `0.1.9` (2014-07-02)
 
 * Errors handling
-* COde refactoring
-* Specs
+* Code refactoring
 * Documentation improvements
+* Specs
 * Fixes
 
 ## `0.1.0` (2014-06-25)

data/Gemfile

@@ -2,8 +2,6 @@ source 'https://rubygems.org'
 
 gemspec
 
-gem 'virtus'
-
 group :test do
   gem 'coveralls', require: false
   gem 'rack-test', require: false

data/Gemfile.lock

@@ -1,40 +1,29 @@
 PATH
   remote: .
   specs:
-    alpha_card (0.3.0)
-      rack (~> 1.2, >= 1.2)
-      virtus (~> 1.0, >= 1.0.5)
+    alpha_card (0.4.0)
+      rack (~> 2.0, >= 2.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    axiom-types (0.1.1)
-      descendants_tracker (~> 0.0.4)
-      ice_nine (~> 0.11.0)
-      thread_safe (~> 0.3, >= 0.3.1)
-    coercible (1.0.0)
-      descendants_tracker (~> 0.0.1)
     coveralls (0.8.15)
       json (>= 1.8, < 3)
       simplecov (~> 0.12.0)
       term-ansicolor (~> 1.3)
       thor (~> 0.19.1)
       tins (>= 1.6.0, < 2)
-    descendants_tracker (0.0.4)
-      thread_safe (~> 0.3, >= 0.3.1)
     diff-lcs (1.2.5)
     docile (1.1.5)
-    equalizer (0.0.11)
-    ice_nine (0.11.2)
     json (2.0.2)
-    rack (1.6.4)
+    rack (2.0.1)
     rack-test (0.6.3)
       rack (>= 1.0)
     rspec (3.5.0)
       rspec-core (~> 3.5.0)
       rspec-expectations (~> 3.5.0)
       rspec-mocks (~> 3.5.0)
-    rspec-core (3.5.3)
+    rspec-core (3.5.4)
       rspec-support (~> 3.5.0)
     rspec-expectations (3.5.0)
       diff-lcs (>= 1.2.0, < 2.0)
@@ -48,16 +37,10 @@ GEM
       json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.0)
-    term-ansicolor (1.3.2)
+    term-ansicolor (1.4.0)
       tins (~> 1.0)
     thor (0.19.1)
-    thread_safe (0.3.5)
     tins (1.12.0)
-    virtus (1.0.5)
-      axiom-types (~> 0.1)
-      coercible (~> 1.0)
-      descendants_tracker (~> 0.0, >= 0.0.3)
-      equalizer (~> 0.0, >= 0.0.9)
 
 PLATFORMS
   ruby
@@ -68,7 +51,6 @@ DEPENDENCIES
   coveralls
   rack-test
   rspec (~> 3.5)
-  virtus
 
 BUNDLED WITH
-   1.12.5
+   1.13.1

data/README.md

@@ -20,7 +20,7 @@ https://secure.alphacardgateway.com/merchants/resources/integration/integration_
 If using bundler, first add 'alpha_card' to your Gemfile:
 
 ```ruby
-gem 'alpha_card', '~> 0.3'
+gem 'alpha_card', '~> 0.4'
 ```
 
 And run:
@@ -32,50 +32,52 @@ bundle install
 Otherwise simply install the gem:
 
 ```sh
-gem install alpha_card
+gem install alpha_card -v '0.4'
 ```
 
 Dependencies required:
 
-*  ruby >= 2.0.0;
+*  ruby >= 2.0.0 or [jruby](https://github.com/jruby/jruby) >= 9.0.5.0;
 
-## Alpha Card Objects & Transactions
+## Configure
 
-Alpha Card operates with next objects:
+In order to use Alpha Card Gateway API you need to have a Merchant account credentials such as `username` and `password`.
 
-*  Account
-*  Order
-    - Billing
-    - Shipping
-*  Sale
-*  Refund
-*  Void
-*  Capture
-*  Update
+If your project will always use only one account, then you can configure gem as follows:
 
-Let us consider each of them.
+```ruby
+# config/initializers/alpha_card.rb - for Rails projects
+AlphaCard::Account.username = 'username'
+AlphaCard::Account.password = 'password'
+```
 
-### Account
+Another way is to pass the credentials as a last argument when creating some transactions or perform operations (it can be useful when you need to operate with multiple Alpha Card accounts):
 
-Account represents credentials data to access Alpha Card Gateway.
-All transactions (`sale`, `refund`, etc) will be created for the specified account.
+```ruby
+void = AlphaCard::Void.new(transaction_id: '312110')
+void.process(username: 'demo', password: 'demo')
+```
 
-_Required fields_:
+## Alpha Card Objects & Transactions
 
-*  username : `String`
-*  password : `String`
+Alpha Card operates with next objects:
 
-_Constructor_:
+*  [Order](#order)
+    - [Billing](#billing)
+    - [Shipping](#shipping)
+*  [Sale](#sale)/[Authorization](#authorization)/[Credit](#credit)/[Validate](#validate)
+*  [Refund](#refund)
+*  [Void](#void)
+*  [Capture](#capture)
+*  [Update](#update)
 
-```ruby
-AlphaCard::Account.new(username, password)
-```
+Let us consider each of them.
 
 ### Order
 
 Order represents itself.
 
-_Optional fields_:
+_Optional attributes_:
 
 *  id : `String`
 *  description : `String`
@@ -88,14 +90,14 @@ _Optional fields_:
 _Constructor_:
 
 ```ruby
-AlphaCard::Order.new(field_name: value, ...)
+AlphaCard::Order.new(property: value, ...)
 ```
 
 ### Billing
 
 Specify Billing information for Order.
 
-_Optional fields_:
+_Optional attributes_:
 
 *  first_name : `String`
 *  last_name : `String`
@@ -114,14 +116,14 @@ _Optional fields_:
 _Constructor_:
 
 ```ruby
-AlphaCard::Billing.new(field_name: value, ...)
+AlphaCard::Billing.new(property: value, ...)
 ```
 
 ### Shipping
 
-Specify Shipping information for Order.
+Contains Shipping information for the Order.
 
-_Optional fields_:
+_Optional attributes_:
 
 *  first_name : `String`
 *  last_name : `String`
@@ -137,122 +139,133 @@ _Optional fields_:
 _Constructor_:
 
 ```ruby
-AlphaCard::Shipping.new(field_name: value, ...)
+AlphaCard::Shipping.new(property: value, ...)
 ```
 
 ### Sale
 
-Sale is the main object of the Alpha Card Services. It processes fees associated with credit cards.
+Sale transaction is the main object of the Alpha Card Services. It is used to processed common payments for orders.
 
-_Required fields_:
+_Required attributes_:
 
 *  card_expiration_date : `String` (format: `MMYY`)
 *  card_number : `String`
 *  amount : `String` (format: `x.xx`)
 
-_Optional fields_:
+_Optional attributes_:
+
 *  cvv : `String`
 *  payment : `String` (default: `'creditcard'`, values: `'creditcard'` or `'check'`)
 *  customer_receipt : `String` (values `'true'` or `'false'`)
+*  check_name : `String`
+*  check_aba : `String`
+*  check_account : `String`
+*  account_holder_type : `String` (values: `'business'` or `'personal'`)
+*  account_type : `String` (values: `'checking'` or `'savings'`)
+*  sec_code : `String` (values: `'PPD'`, `'WEB'`, `'TEL'`, or `'CCD'`)
 
 _Constructor_:
 
 ```ruby
-AlphaCard::Sale.new(field_name: value, ...)
+AlphaCard::Sale.new(property: value, ...)
 ```
 
-To create the payment you must call *create(_alpha_card_order_, _alpha_card_account_)* method:
+To create the payment you must call *create(_alpha_card_order_)* method:
 
 ```ruby
 # ...
 sale = AlphaCard::Sale.new(amount: 10)
-success, alpha_card_response = sale.create(order, account)
+response = sale.process(order)
 
-# => [true, #<AlphaCard::AlphaCardResponse:0x1a0fda ...>]
+# => #<AlphaCard::Response:0x1a0fda ...>
 ```
 
-This method returns _true_ if sale was created successfully and raise an `AlphaCardError` exception if some of the fields is invalid.
-
 ### Refund
 
 Represents refund transaction.
 
-_Required fields_:
+_Required attributes_:
 
-*  transaction_id : `String`
+*  transaction_id : `String` or `Integer`
 
-_Optional fields_:
+_Optional attributes_:
 
 *  amount : `String` (format: `x.xx`)
 
 _Constructor_:
 
 ```ruby
-AlphaCard::Refund.new(field_name: value, ...)
+AlphaCard::Refund.new(property: value, ...)
 ```
 
-To create the refund transaction you must call *create(_alpha_card_account_)* method:
+To create the refund transaction you must call *create* or *process* method:
 
 ```ruby
 # ...
 refund = AlphaCard::Refund.new(transaction_id: '12312312', amount: 10)
-refund.create(account)
+refund.process
 ```
 
 ### Void
 
 Represents void transaction.
 
-_Required fields_:
+_Required attributes_:
 
-*  transaction_id : `String`
+*  transaction_id : `String` or `Integer`
 
 _Constructor_:
 
 ```ruby
-AlphaCard::Void.new(field_name: value, ...)
+AlphaCard::Void.new(property: value, ...)
 ```
 
-To create the void transaction you must call *create(_alpha_card_account_)* method:
+To create the void transaction you must call *create* or *process* method:
 
 ```ruby
 # ...
 void = AlphaCard::Void.new(transaction_id: '12312312')
-void.create(account)
+void.create
 ```
 
 ### Capture
 
 Represents capture transaction.
 
-_Required fields_:
+_Required attributes_:
 
-*  transaction_id : `String`
-*  amount : `String` (format: `x.xx`)
+*  transaction_id : `String` or `Integer`
+*  amount : `String` (format: `xx.xx`)
+
+_Optional attributes_:
+
+*  tracking_number : `String`
+*  shipping_carrier : `String`
+*  order_id : `String`
 
 _Constructor_:
 
 ```ruby
-AlphaCard::Capture.new(field_name: value, ...)
+AlphaCard::Capture.new(property: value, ...)
 ```
 
-To create the capture transaction you must call *create(_alpha_card_account_)* method:
+To create the capture transaction you must call *create* or *process* method:
 
 ```ruby
 # ...
 capture = AlphaCard::Capture.new(transaction_id: '12312312', amount: '5.05')
-capture.create(account)
+capture.create
 ```
 
 ### Update
 
 Represents update transaction.
 
-_Required fields_:
+_Required attributes_:
 
-*  transaction_id : `String`
+*  transaction_id : `String` or `Integer`
 
-_Optional fields_:
+_Optional attributes_:
 *  shipping: `String`
 *  shipping_postal: `String`
 *  ship_from_postal: `String`
@@ -279,17 +292,29 @@ _Optional fields_:
 _Constructor_:
 
 ```ruby
-AlphaCard::Update.new(field_name: value, ...)
+AlphaCard::Update.new(property: value, ...)
 ```
 
-To create update transaction you must call *create(_alpha_card_account_)* method:
+To create update transaction you must call *create* or *process* method:
 
 ```ruby
 # ...
 update = AlphaCard::Update.new(tax: '10.02', shipping_carrier: 'ups', transaction_id: '66928')
-update.create(account)
+update.process
 ```
 
+### Authorization
+
+Has the same attributes and methods as `Sale` transaction.
+
+### Credit
+
+Has the same attributes and methods as `Sale` transaction.
+
+### Validate
+
+Has the same attributes and methods as `Sale` transaction, except `amount` — there is no need in it.
+
 ## Example of usage
 
 Create AlphaCard sale (pay for the order):
@@ -298,7 +323,9 @@ Create AlphaCard sale (pay for the order):
 require 'alpha_card'
 
 def create_payment
-  account = AlphaCard::Account.new('demo', 'password')
+  # Setup merchant account credentials
+  AlphaCard::Account.username = 'demo'
+  AlphaCard::Account.password = 'password'
 
   billing = AlphaCard::Billing.new(email: 'test@example.com', phone: '+801311313111')
   shipping = AlphaCard::Shipping.new(address_1: '33 N str', city: 'New York', state: 'NY', zip_code: '132')
@@ -307,14 +334,17 @@ def create_payment
 
   # Format of amount: "XX.XX" ("%.2f" % Float)
   sale = AlphaCard::Sale.new(card_epiration_date: '0117', card_number: '4111111111111111', amount: '1.50', cvv: '123')
-  success, response = sale.create(order, account)
-  #=> [true, #<AlphaCard::AlphaCardResponse:0x1a0fda ...>]
-  puts "Order payed successfully: transaction ID = #{response.transaction_id} if success
-rescue AlphaCard::AlphaCardError => e
-  puts "Error message: #{e.response.message}"
-  puts "CVV response: #{e.response.cvv_response}"
-  puts "AVS response: #{e.response.avs_response}"
-  false
+  response = sale.create(order)
+  #=> #<AlphaCard::Response:0x1a0fda ...>
+  if response.success?
+    puts "Order payed successfully: transaction ID = #{response.transaction_id}"
+    true
+  else
+    puts "Error message: #{e.response.message}"
+    puts "CVV response: #{e.response.cvv_response}"
+    puts "AVS response: #{e.response.avs_response}"
+    false
+  end
 end
 ```
 
@@ -323,26 +353,16 @@ end
 _Note_: take a look at the `amount` of the Order. It's format must be 'xx.xx'. All the information about variables formats 
 can be found on _Alpha Card Payment Gateway Integration Portal_ -> _Direct Post API_ -> _Documentation_ -> _Transaction Variables_
 
-Naming convention of attributes (such as "ccexp" or "orderid") was saved for compatibility with AlphaCard API.
-
-To raise some exceptions do the next:
+To simulate request that returns an error do the next:
 
 *  to cause a declined message, pass an amount less than 1.00;
 *  to trigger a fatal error message, pass an invalid card number;
 *  to simulate an AVS match, pass 888 in the address1 field, 77777 for zip;
 *  to simulate a CVV match, pass 999 in the cvv field.
 
-Example of exception:
-
-```ruby
-...
-2.1.1 :019 >  sale.create(order, account)
-AlphaCard::AlphaCardError: Invalid Credit Card Number REFID:127145481
-```
-
 ## AlphaCard Response
 
-`AlphaCardResponse` contains all the necessary information about Alpha Card Gateway response. You can use the following API:
+`AlphaCard::Response` contains all the necessary information about Alpha Card Gateway response. You can use the following API:
 
 *  `.text` — textual response of the Alpha Card Gateway;
 *  `.message` — response message be response code;
@@ -354,6 +374,16 @@ AlphaCard::AlphaCardError: Invalid Credit Card Number REFID:127145481
 *  `.cvv_response` — CVV response message;
 *  `.avs_response` — AVS response message.
 
+## Testing
+
+It is recommended to mock Alpha Card gem functionality, but if you want to create a "real" specs, then you can use Alpha Card Services testing account:
+
+```ruby
+AlphaCard::Account.use_demo_credentials!
+```
+
+Or you can pass the next credentials with any request: `{ username: 'demo', password: 'password' }`
+
 ## Contributing
 
 You are very welcome to help improve alpha_card if you have suggestions for features that other people can use.