alpha_card 0.2.6 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 30d93b58f9dc44c84691c6666bcdc6b0f41a8f6a
-  data.tar.gz: 8b797a6054d6daa1f7314a1e3c23c6d7d3f23918
+  metadata.gz: 0e5ac24025977d5cd2c3406cba14ebde613b4f7b
+  data.tar.gz: 7696ce4ea24336d3214c056e612a7e5a068940fc
 SHA512:
-  metadata.gz: 1385c84b244958cd05e7915a384964d006c1a96c1c0b7fa05f58ff021cdf3454759b1926566dda4d5183f2e8b197b3789a88911bfd3cba078e07e2361344eb73
-  data.tar.gz: 09d4105be24baa504e86e9989ce927f5bc34bc3b74ae00705efa67638d96f1136f5d985fb56c1b44bdb90caeff21fb97b2ad90a7cccbf210e8454871d855335e
+  metadata.gz: 3666ded11769f172c69f8dee353a22a762daa403e850a46fc82174b968fee31339a6b101fd9cf7a0885a4b0c4c667aee8ad748e58e7b6558e9d848b60d823a8a
+  data.tar.gz: 453305dfd596b13e12ce9ea3064cd188806ba429bf9d5d51c9573cf022d646e592c1ebeaf18fce331dd5cd19f7b8330f8a79f6dd16885aa914e3a5c3d8bf1485

data/.gitignore

@@ -0,0 +1,5 @@
+/coverage
+/.yardoc
+/doc
+/.idea
+/*.gem

data/.travis.yml

@@ -3,15 +3,11 @@ before_install: gem install bundler
 bundler_args: --without yard guard benchmarks
 script: "rake spec"
 rvm:
-  - 1.9.3
   - 2.0.0
-  - 2.1.0
-  - 2.1.1
-  - 2.1.2
   - 2.1.5
   - 2.2.4
   - 2.3.0
-  - jruby-19mode
+  - jruby-9.0.0.0
   - ruby-head
 matrix:
   allow_failures:

data/CHANGELOG.md

@@ -0,0 +1,54 @@
+# AlphaCard gem Changelog
+
+Reverse Chronological Order:
+
+## `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
+* New AlphaCard transactions: `Void`, `Refund`, `Capture`, `Update`
+* New AlphaCard transactions variables
+* New AlphaCard transactions variables naming (**old is deprecated**)
+* Improved transactions `.create` method to return response (not only the success indicator)
+* Sale transaction request params fix
+* Code refactoring
+* Specs improvements
+* Documentation improvements
+
+## `0.2.6` (2016-03-24)
+
+https://github.com/nbulaj/alpha_card/compare/0.2.4...0.2.6
+
+* Documentation improvements
+* `rest-client` removed from gem dependencies
+* Code style fixes
+* Code refactoring
+
+## `0.2.4` (2015-07-24)
+
+* Code style fixes
+* New TravisCI tests strategies
+* Dependencies update
+
+## `0.2.2` (2015-07-11)
+
+* New transaction variables
+* `Shipping` object request params fixed
+
+## `0.2.0` (2014-07-09)
+
+* `AlphaCardError`
+* Better errors handling
+
+## `0.1.9` (2014-07-02)
+
+* Errors handling
+* COde refactoring
+* Specs
+* Documentation improvements
+* Fixes
+
+## `0.1.0` (2014-06-25)
+
+* First stable release

data/Gemfile.lock

@@ -1,7 +1,8 @@
 PATH
   remote: .
   specs:
-    alpha_card (0.2.6)
+    alpha_card (0.3.0)
+      rack (~> 1.2, >= 1.2)
       virtus (~> 1.0, >= 1.0.5)
 
 GEM
@@ -13,59 +14,45 @@ GEM
       thread_safe (~> 0.3, >= 0.3.1)
     coercible (1.0.0)
       descendants_tracker (~> 0.0.1)
-    coveralls (0.8.10)
-      json (~> 1.8)
-      rest-client (>= 1.6.8, < 2)
-      simplecov (~> 0.11.0)
+    coveralls (0.8.15)
+      json (>= 1.8, < 3)
+      simplecov (~> 0.12.0)
       term-ansicolor (~> 1.3)
       thor (~> 0.19.1)
-      tins (~> 1.6.0)
+      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)
-    domain_name (0.5.25)
-      unf (>= 0.0.5, < 1.0.0)
     equalizer (0.0.11)
-    http-cookie (1.0.2)
-      domain_name (~> 0.5)
-    ice_nine (0.11.1)
-    json (1.8.3)
-    mime-types (2.99)
-    netrc (0.11.0)
+    ice_nine (0.11.2)
+    json (2.0.2)
     rack (1.6.4)
     rack-test (0.6.3)
       rack (>= 1.0)
-    rest-client (1.8.0)
-      http-cookie (>= 1.0.2, < 2.0)
-      mime-types (>= 1.16, < 3.0)
-      netrc (~> 0.7)
-    rspec (3.4.0)
-      rspec-core (~> 3.4.0)
-      rspec-expectations (~> 3.4.0)
-      rspec-mocks (~> 3.4.0)
-    rspec-core (3.4.1)
-      rspec-support (~> 3.4.0)
-    rspec-expectations (3.4.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-support (~> 3.5.0)
+    rspec-expectations (3.5.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.4.0)
-    rspec-mocks (3.4.1)
+      rspec-support (~> 3.5.0)
+    rspec-mocks (3.5.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.4.0)
-    rspec-support (3.4.1)
-    simplecov (0.11.1)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
+    simplecov (0.12.0)
       docile (~> 1.1.0)
-      json (~> 1.8)
+      json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.0)
     term-ansicolor (1.3.2)
       tins (~> 1.0)
     thor (0.19.1)
     thread_safe (0.3.5)
-    tins (1.6.0)
-    unf (0.1.4)
-      unf_ext
-    unf_ext (0.0.7.1)
+    tins (1.12.0)
     virtus (1.0.5)
       axiom-types (~> 0.1)
       coercible (~> 1.0)
@@ -74,13 +61,14 @@ GEM
 
 PLATFORMS
   ruby
+  x86-mingw32
 
 DEPENDENCIES
   alpha_card!
   coveralls
   rack-test
-  rspec (~> 3)
+  rspec (~> 3.5)
   virtus
 
 BUNDLED WITH
-   1.11.2
+   1.12.5

data/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2014-2015 Nikita Bulaj
+Copyright (c) 2014-2016 Nikita Bulaj
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,12 +1,11 @@
 # Ruby lib for creating payments with Alpha Card Services
 [![Gem Version](https://badge.fury.io/rb/alpha_card.svg)](http://badge.fury.io/rb/alpha_card)
+[![Build Status](https://travis-ci.org/nbulaj/alpha_card.svg?branch=master)](https://travis-ci.org/nbulaj/alpha_card)
 [![Dependency Status](https://gemnasium.com/nbulaj/alpha_card.svg)](https://gemnasium.com/nbulaj/alpha_card)
 [![Code Climate](https://codeclimate.com/github/nbulaj/alpha_card/badges/gpa.svg)](https://codeclimate.com/github/nbulaj/alpha_card)
 [![Coverage Status](https://coveralls.io/repos/nbulaj/alpha_card/badge.svg)](https://coveralls.io/r/nbulaj/alpha_card)
-[![Build Status](https://travis-ci.org/nbulaj/alpha_card.svg?branch=master)](https://travis-ci.org/nbulaj/alpha_card)
 [![Inline docs](http://inch-ci.org/github/nbulaj/alpha_card.png?branch=master)](http://inch-ci.org/github/nbulaj/alpha_card)
 [![License](http://img.shields.io/badge/license-MIT-brightgreen.svg)](#license)
-[![Gem](https://img.shields.io/gem/dt/alpha_card.svg)]()
 
 This gem can help your Ruby or Ruby on Rails application to integrate with Alpha Card Service, Inc.
 
@@ -16,13 +15,12 @@ http://www.alphacardservices.com/
 Payment Gateway Integration Portal:
 https://secure.alphacardgateway.com/merchants/resources/integration/integration_portal.php
 
-
 ## Installation
 
 If using bundler, first add 'alpha_card' to your Gemfile:
 
 ```ruby
-gem "alpha_card"
+gem 'alpha_card', '~> 0.3'
 ```
 
 And run:
@@ -39,30 +37,33 @@ gem install alpha_card
 
 Dependencies required:
 
-*   ruby >= 1.9.3;
+*  ruby >= 2.0.0;
 
+## Alpha Card Objects & Transactions
 
-## Alpha Card Objects
+Alpha Card operates with next objects:
 
-Alpha Card operates with next 5 objects:
-
-*   Account (represent your Alpha Card credentials)
-*   Order
+*  Account
+*  Order
     - Billing
     - Shipping
-*   Sale
+*  Sale
+*  Refund
+*  Void
+*  Capture
+*  Update
 
 Let us consider each of them.
 
 ### Account
 
 Account represents credentials data to access Alpha Card Gateway.
-All sales will be created for the specified account.
+All transactions (`sale`, `refund`, etc) will be created for the specified account.
 
 _Required fields_:
 
-*   username : String
-*   password : String
+*  username : `String`
+*  password : `String`
 
 _Constructor_:
 
@@ -74,15 +75,15 @@ AlphaCard::Account.new(username, password)
 
 Order represents itself.
 
-_Unnecessary fields_:
+_Optional fields_:
 
-*   orderid : String
-*   orderdescription : String
-*   ponumber : String
-*   tax : String
-*   ipaddress : String
-*   billing : AlphaCard::Billing
-*   shipping : AlphaCard::Shipping
+*  id : `String`
+*  description : `String`
+*  po_number : `String`
+*  tax : `String`
+*  ip_address : `String` (format: `xxx.xxx.xxx.xxx`)
+*  billing : `AlphaCard::Billing`
+*  shipping : `AlphaCard::Shipping`
 
 _Constructor_:
 
@@ -94,21 +95,21 @@ AlphaCard::Order.new(field_name: value, ...)
 
 Specify Billing information for Order.
 
-_Unnecessary fields_:
-
-*   firstname : String
-*   lastname : String
-*   email : String
-*   fax : String
-*   phone : String
-*   company : String
-*   address1 : String
-*   address2 : String
-*   city : String
-*   state : String
-*   zip : String
-*   country : String
-*   website : String
+_Optional fields_:
+
+*  first_name : `String`
+*  last_name : `String`
+*  email : `String`
+*  fax : `String`
+*  phone : `String`
+*  company : `String`
+*  address_1 : `String`
+*  address_2 : `String`
+*  city : `String`
+*  state : `String` (format: `CC`)
+*  zip : `String`
+*  country : `String` (format: `CC`. Country codes are as shown in [ISO 3166](https://en.wikipedia.org/wiki/ISO_3166))
+*  website : `String`
 
 _Constructor_:
 
@@ -120,18 +121,18 @@ AlphaCard::Billing.new(field_name: value, ...)
 
 Specify Shipping information for Order.
 
-_Unnecessary fields_:
+_Optional fields_:
 
-*   firstname : String
-*   lastname : String
-*   company : String
-*   address_1 : String
-*   address_2 : String
-*   city : String
-*   state : String
-*   zip_code : String
-*   country : String
-*   email : String
+*  first_name : `String`
+*  last_name : `String`
+*  company : `String`
+*  address_1 : `String`
+*  address_2 : `String`
+*  city : `String`
+*  state : `String` (format: `CC`)
+*  zip_code : `String`
+*  country : `String` (format: `CC`. Country codes are as shown in [ISO 3166](https://en.wikipedia.org/wiki/ISO_3166))
+*  email : `String`
 
 _Constructor_:
 
@@ -145,12 +146,14 @@ Sale is the main object of the Alpha Card Services. It processes fees associated
 
 _Required fields_:
 
-*   ccexp : String
-*   ccnumber : String
-*   amount : String
+*  card_expiration_date : `String` (format: `MMYY`)
+*  card_number : `String`
+*  amount : `String` (format: `x.xx`)
 
-_Unnecessary fields_:
-*   cvv : String
+_Optional fields_:
+*  cvv : `String`
+*  payment : `String` (default: `'creditcard'`, values: `'creditcard'` or `'check'`)
+*  customer_receipt : `String` (values `'true'` or `'false'`)
 
 _Constructor_:
 
@@ -161,16 +164,135 @@ AlphaCard::Sale.new(field_name: value, ...)
 To create the payment you must call *create(_alpha_card_order_, _alpha_card_account_)* method:
 
 ```ruby
-...
+# ...
 sale = AlphaCard::Sale.new(amount: 10)
-sale.create(order, account)
+success, alpha_card_response = sale.create(order, account)
+
+# => [true, #<AlphaCard::AlphaCardResponse: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_:
+
+*  transaction_id : `String`
+
+_Optional fields_:
+
+*  amount : `String` (format: `x.xx`)
+
+_Constructor_:
+
+```ruby
+AlphaCard::Refund.new(field_name: value, ...)
+```
+
+To create the refund transaction you must call *create(_alpha_card_account_)* method:
+
+```ruby
+# ...
+refund = AlphaCard::Refund.new(transaction_id: '12312312', amount: 10)
+refund.create(account)
+```
+
+### Void
+
+Represents void transaction.
+
+_Required fields_:
+
+*  transaction_id : `String`
+
+_Constructor_:
+
+```ruby
+AlphaCard::Void.new(field_name: value, ...)
+```
+
+To create the void transaction you must call *create(_alpha_card_account_)* method:
+
+```ruby
+# ...
+void = AlphaCard::Void.new(transaction_id: '12312312')
+void.create(account)
+```
+
+### Capture
+
+Represents capture transaction.
+
+_Required fields_:
+
+*  transaction_id : `String`
+*  amount : `String` (format: `x.xx`)
+
+_Constructor_:
+
+```ruby
+AlphaCard::Capture.new(field_name: value, ...)
+```
+
+To create the capture transaction you must call *create(_alpha_card_account_)* method:
+
+```ruby
+# ...
+capture = AlphaCard::Capture.new(transaction_id: '12312312', amount: '5.05')
+capture.create(account)
+```
+
+### Update
+
+Represents update transaction.
+
+_Required fields_:
+
+*  transaction_id : `String`
+
+_Optional fields_:
+*  shipping: `String`
+*  shipping_postal: `String`
+*  ship_from_postal: `String`
+*  shipping_country: `String` 
+*  shipping_carrier: `String` (values: `'ups'`, `'fedex'`, `'dhl'` or `'usps'`)
+*  shipping_date: `String` (format: `YYYYMMDD`)
+*  order_description: `String`
+*  order_date: `String`
+*  customer_receipt: `String` (values: `'true'` or `'false'`)
+*  po_number: `String`
+*  summary_commodity_code: `String`
+*  duty_amount: `String` (format: `x.xx`)
+*  discount_amount: `String` (format: `x.xx`)
+*  tax: `String` (format: `x.xx`)
+*  national_tax_amount: `String` (format: `x.xx`)
+*  alternate_tax_amount: `String` (format: `x.xx`)
+*  alternate_tax_id: `String`
+*  vat_tax_amount: `String`
+*  vat_tax_rate: `String`
+*  vat_invoice_reference_number: `String`
+*  customer_vat_registration: `String`
+*  merchant_vat_registration: `String`
+
+_Constructor_:
+
+```ruby
+AlphaCard::Update.new(field_name: value, ...)
+```
+
+To create update transaction you must call *create(_alpha_card_account_)* method:
+
+```ruby
+# ...
+update = AlphaCard::Update.new(tax: '10.02', shipping_carrier: 'ups', transaction_id: '66928')
+update.create(account)
+```
+
 ## Example of usage
 
-Create AlphaCard sale:
+Create AlphaCard sale (pay for the order):
 
 ```ruby
 require 'alpha_card'
@@ -178,33 +300,37 @@ require 'alpha_card'
 def create_payment
   account = AlphaCard::Account.new('demo', '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' })
+  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')
 
-  order = AlphaCard::Order.new({ orderid: 1, orderdescription: 'Test order' })
+  order = AlphaCard::Order.new(id: 1, description: 'Test order', billing: billing, shipping: shipping)
 
   # Format of amount: "XX.XX" ("%.2f" % Float)
-  sale = AlphaCard::Sale.new({ ccexp: '0117', ccnumber: '4111111111111111', amount: "1.50", cvv: '123' })
-  sale.create(order, account)
+  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 e.message
+  puts "Error message: #{e.response.message}"
+  puts "CVV response: #{e.response.cvv_response}"
+  puts "AVS response: #{e.response.avs_response}"
   false
 end
 ```
 
 `Billing` and `Shipping` is an _optional_ parameters and can be not specified.
 
-_Note_: take a look at the `amount` of the Order. It's format must be 'xx.xx'. All information about variables formats 
+_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 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.
+*  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:
 
@@ -214,6 +340,20 @@ Example of exception:
 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:
+
+*  `.text` — textual response of the Alpha Card Gateway;
+*  `.message` — response message be response code;
+*  `.transaction_id` — payment gateway transaction ID;
+*  `.order_id` — original order ID passed in the transaction request;
+*  `.code` — numeric mapping of processor responses;
+*  `.auth_code` — transaction authorization code;
+*  `.success?`, `.error?`, `.declined?` — state of the request;
+*  `.cvv_response` — CVV response message;
+*  `.avs_response` — AVS response message.
+
 ## Contributing
 
 You are very welcome to help improve alpha_card if you have suggestions for features that other people can use.