alpha_card 0.1 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dd70168d46aad0fa4d47e2b3f4ddc456bfe2a3d9
-  data.tar.gz: e6823a997b69246add52d448ab5069b7334d7136
+  metadata.gz: 695a1b4fb47438c189a87716ef13134d85c35854
+  data.tar.gz: 03c59165370cf209278b655d21ba57b72613cece
 SHA512:
-  metadata.gz: d517bc9ab7e41c42eb45df3e430c27b2b235e0f5d388d720229b44e2488ec7d92e795c464321dd9b65cbb5f607d57f02ef00ab2af65669d0ad2c6c9dbf05ef88
-  data.tar.gz: c9038bd884701f52dc6d438217326af53a9a2350c8b5d1f6385d01f62f6d56040cd23da17991e10cfd6d6aba9caf66f501ee4ea6cd5baf973eb2bf06ba9d2f63
+  metadata.gz: 3d3f0ed869a45715977c53e7569493837832df23306cd15d3182f288b2b471595063dfbe6f1b41bdd2397ba9700668b77298c2c9f8f6d4e18037a27c0bd9921f
+  data.tar.gz: 190c4f5d74a67085a3e4cf248a90ee5454b681065f505d95871af554356c004c8dc92d92f029190c7f7741a88751854194d7634804d8fcab8ff5e7e7680bcd65

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'virtus'
+gem 'curb'

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 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
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,199 @@
+# Ruby lib for creating payments with AlphaCard DirectPost API
+[![Gem Version](https://badge.fury.io/rb/alpha_card.png)](http://badge.fury.io/rb/alpha_card)
+
+This gem can help your ruby/rails application to integrate with AlphaCard service.
+
+AlphaCard: 
+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"
+```
+
+And run
+
+```sh
+bundle install
+```
+
+Otherwise simply
+
+```sh
+gem install alpha_card
+```
+
+Dependencies required:
+
+*   ruby >= 1.9.3
+*   curb (for Curl)
+*   virtus (for nice OOP objects of AlphaCard)
+
+## Objects
+
+To create sale with Alpha Card Services you must operate with 5 objects:
+
+*   Account
+*   Order
+    - Billing
+    - Shipping
+*   Sale
+
+### Account
+
+Specify credentials to access Alpha Card Services, Inc.
+
+_Required fields_:
+
+*   username : String
+*   password : String
+
+_Constructor_:
+
+```ruby
+AlphaCard::Account.new(username, password)
+```
+
+### Order
+
+Specify Order.
+
+_Required fields_:
+
+*   orderid : String
+*   orderdescription : String
+
+_Unnecessary fields_:
+
+*   ponumber : String
+*   billing : AlphaCard::Billing
+*   shipping : AlphaCard::Shipping
+
+_Constructor_:
+
+```ruby
+AlphaCard::Order.new({field_name: value, ...})
+```
+
+Set up billing or shipping:
+
+```ruby
+order = AlphaCard::Order.new({})
+order.shipping = AlphaCard::Shipping.new({})
+order.billing = AlphaCard::Billing.new({})
+```
+
+### Billing
+
+Specify Billing information for Order.
+
+_Unnecessary fields_:
+
+*   firstname : String
+*   lastname : String
+*   email : String
+*   phone : String
+*   company : String
+*   address1 : String
+*   address2 : String
+*   city : String
+*   state : String
+*   zip : String
+*   country : String
+*   website : String
+
+_Constructor_:
+
+```ruby
+AlphaCard::Billing.new({field_name: value, ...})
+```
+
+### Shipping
+
+Specify Shipping information for Order.
+
+_Unnecessary fields_:
+
+*   address_1 : String
+*   address_2 : String
+*   city : String
+*   state : String
+*   zip_code : String
+*   email : String
+
+_Constructor_:
+
+```ruby
+AlphaCard::Shipping.new({field_name: value, ...})
+```
+
+### Sale
+
+Specify and process Order payment information.
+
+_Required fields_:
+
+*   ccexp : String
+*   ccnumber : String
+*   amount : String
+
+_Unnecessary fields_:
+*   cvv : String
+
+_Constructor_:
+
+```ruby
+AlphaCard::Sale.new({field_name: value, ...})
+```
+
+To process the sale you must call *create(_alpha_card_order_, _alpha_card_account_)*:
+
+```ruby
+...
+sale = AlphaCard::Sale.new({})
+sale.create(order, account)
+```
+
+Method _create_ returns _true_ if sale was created successfully and raise an AlphaCardError 
+exception if some of the fields is invalid.
+
+## Example of usage
+
+Create AlphaCard sale:
+
+```ruby
+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'})
+
+  order = AlphaCard::Order.new({orderid: 1, orderdescription: 'Test order'})
+  order.billing = billing
+  order.shipping = shipping
+
+  sale = AlphaCard::Sale.new({ccexp: '0117', ccnumber: '4111111111111111', amount: "%.2f" % 1.5 , cvv: '123'})
+  sale.create(order, account)
+rescue AlphaCard::AlphaCardError => e
+  puts e.message
+  false
+end
+```
+
+Billing and shipping is an _optional_ parameters and can be not specified.
+
+Format of parameters 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 due to compatibility with AlphaCard API.
+
+## Copyright
+
+Copyright (c) 2014 Nikita Bulaj (bulajnikita@gmail.com).

data/alpha_card.gemspec

@@ -0,0 +1,14 @@
+Gem::Specification.new do |gem|
+  gem.name = 'alpha_card'
+  gem.version = '0.1.1'
+  gem.date = '2014-06-25'
+  gem.summary = "Alpha Card DirectPost API for Ruby"
+  gem.description = "Gem for creates sales with Alpha Card DirectPost API"
+  gem.authors = ["Nikita Bulaj"]
+  gem.email = 'bulajnikita@gmail.com'
+  gem.require_paths = ["lib"]
+  gem.files = `git ls-files`.split($/)
+  gem.homepage = 'http://github.com/budev/alpha_card'
+  gem.license = 'MIT'
+  gem.required_ruby_version = '>= 1.9.3'
+end

data/lib/alpha_card/billing.rb

@@ -1,6 +1,16 @@
 module AlphaCard
   class Billing < AlphaCardObject
+    attribute :firstname, String
+    attribute :lastname, String
     attribute :email, String
     attribute :phone, String
+    attribute :company, String
+    attribute :address1, String
+    attribute :address2, String
+    attribute :city, String
+    attribute :state, String
+    attribute :zip, String
+    attribute :country, String
+    attribute :website, String
   end
 end

data/lib/alpha_card/order.rb

@@ -2,6 +2,7 @@ module AlphaCard
   class Order < AlphaCardObject
     attribute :orderid, Integer
     attribute :orderdescription, String
+    attribute :ponumber, String
 
     attr_accessor :billing, :shipping
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: alpha_card
 version: !ruby/object:Gem::Version
-  version: '0.1'
+  version: 0.1.1
 platform: ruby
 authors:
 - Nikita Bulaj
@@ -16,6 +16,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- Gemfile
+- LICENSE
+- README.md
+- alpha_card.gemspec
 - lib/alpha_card.rb
 - lib/alpha_card/account.rb
 - lib/alpha_card/alpha_card_error.rb
@@ -39,7 +43,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -50,5 +54,5 @@ rubyforge_project:
 rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: Alpha Card DirectPost API
+summary: Alpha Card DirectPost API for Ruby
 test_files: []