alpha_card 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1ca151fb5ff57a0e885ee58031cc037b36bff410
-  data.tar.gz: a2c4814fd862a98e1cc26b0b0bdac870368e5e15
+  metadata.gz: 8d1b3608b60661b5688717b2f96768ac0e36a83c
+  data.tar.gz: 8d0a9f755a5faa7802d36feac0828bd1d3877cc1
 SHA512:
-  metadata.gz: 5c36aeb545f3ee57bb5477d6bc09669edda527e5335da16e6c3a5ba09a631be81502694c0906d6270e860375ac1228dac145947f42544e54a2a50abb5517af85
-  data.tar.gz: 516c6219c3ca1ad01646f3052f0bcb7b8849f00e77f68a7aefd2931d69b99703a80fce250e2686c3fbbdd10275b069c807c4e36a3f34dceedee8edf9e95660de
+  metadata.gz: c752b3a03ce5299126ae280a3456d7d7507803e63a8c0bd0cca7dd3cffaa2ec34764694da072d962658666d7b876231ba3b026a27d99554edbfb87d075729d9b
+  data.tar.gz: 531987ff7b2dcf6555e29816eccd92394bbf6d1577219064e321020a6a75713d8c37c7037e1a117a8d77ef5c7f184f6ab6a7834108676467419bf1970cdb92b0

data/alpha_card.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |gem|
   gem.name = 'alpha_card'
-  gem.version = '0.1.3'
+  gem.version = '0.1.4'
   gem.date = '2014-06-25'
   gem.summary = 'Alpha Card Services DirectPost API for Ruby'
   gem.description = 'Gem for creating sales with Alpha Card Services DirectPost API'

data/lib/alpha_card.rb

@@ -15,14 +15,24 @@ require 'alpha_card/order'
 require 'alpha_card/sale'
 
 module AlphaCard
+  # DirectPost API URL
   @api_base = 'https://secure.alphacardgateway.com/api/transact.php'
 
+  # Global Payment Systems (NDC) Credit Card Authorization Codes
   CREDIT_CARD_CODES = YAML.load_file(File.expand_path('../alpha_card/data/codes.yml',  __FILE__)) unless defined? CREDIT_CARD_CODES
 
   class << self
     attr_accessor :api_base
   end
 
+  # AlphaCard.request(params, account) -> AlphaCardResponse
+  #
+  # Do the POST request to the AlphaCard Gateway with <i>params</i>
+  # from specified AlphaCard <i>account</i>.
+  #
+  #    account = AlphaCard::Account.new('user', 'pass')
+  #    params = {amount: '10.00'}
+  #    r = AlphaCard.request(params, account) #=> AlphaCardResponse
   def self.request(params = {}, account)
     unless account.filled?
       raise AlphaCardError.new('You must set credentials to create the sale!')
@@ -38,6 +48,14 @@ module AlphaCard
 
   private
 
+  # AlphaCard.handle_errors(response) -> Exception
+  # AlphaCard.handle_errors(response) -> nil
+  #
+  # Raise an exception if AlphaCard Gateway return an error or decline
+  # the request.
+  #
+  #    response = AlphaCard.request(params, account)
+  #    handle_errors(response) #=> nil or Exception
   def self.handle_errors(response)
     code = response.text
     raise AlphaCardError.new(CREDIT_CARD_CODES[code] || code) unless response.success?

data/lib/alpha_card/alpha_card_object.rb

@@ -2,10 +2,15 @@ module AlphaCard
   class AlphaCardObject
     include Virtus.model
 
-    def to_query
-      Rack::Utils.build_query(self.filled_attributes)
-    end
+    # filled_attributes -> Hash
+    #
+    # Returns only filled attributes, not nil ones.
+    #
+    #    order = AlphaCard::Order.new({})
+    #    order.filled_attributes #=> {}
 
+    #    order = AlphaCard::Order.new({orderid: '1'})
+    #    order.filled_attributes #=> {orderid: '1'}
     def filled_attributes
       self.attributes.select { |key, value| value.present? }
     end

data/lib/alpha_card/object.rb

@@ -1,3 +1,8 @@
+# Object class needed to implement some nice
+# active_support features for projects, that
+# doesn't need active_support.
+#
+# Use-case: standalone Ruby scripts
 class Object
   def blank?
     respond_to?(:empty?) ? !!empty? : !self

data/lib/alpha_card/sale.rb

@@ -5,8 +5,20 @@ module AlphaCard
     attribute :amount, String
     attribute :cvv, String
 
+    # Not writable attribute, define the type of transaction (default is 'sale')
     attribute :type, String, default: 'sale', writer: :private
 
+    # create(order, account) -> true
+    # create(order, account) -> false
+    # create(order, account) -> Exception
+    #
+    # Creates the sale for the <i>order</i> with specified
+    # attributes, such as <i>ccexp</i>, <i>ccnumber</i>, <i>amount</i>
+    # and <i>cvv</i>.
+    #
+    #    attrs = {ccexp: '0117', ccnumber: '123', amount: '10.00'}
+    #    sale = AlphaCard::Sale.new(attrs)
+    #    sale.create(order, account) #=> true or false
     def create(order, account)
       [:ccexp, :ccnumber, :amount].each do |attr|
         raise Exception.new("No #{attr.to_s} information provided") if self.send(attr.to_s).blank?

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: alpha_card
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Nikita Bulaj