astro_pay 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cc46963e43d93f0c7679d68a55feec74081bc535
-  data.tar.gz: b5d1e2642aefeb66797ffd226801e3fbe52c7abf
+  metadata.gz: 9acac83578a0e07585a44eeabb2010472c83b7c1
+  data.tar.gz: e7d42e5a332a57b4a6c6eff1cf7c670800fd06f9
 SHA512:
-  metadata.gz: 8352474f0b1f8d4d166defd4de9cae74d8e7a9c60b09e9d9dd687715708a062fb17e9fb4297047a56f6fc079b42054555b0ff437dea310b07e80fd91f0760676
-  data.tar.gz: 0b6a75cff9129f90748e93e4bdaa50d7f74d9042b8e1f23ba6dce33724bd8729d20d3faef1585c4c8f7ad52a890b149ca012afff1ac5ba70ed4e95b774929ae1
+  metadata.gz: 5304f7ebf8b1e8816004ed63616122479eaafd8b69d4632783205a618c137ecf147b0359af522905569736b464acd351d3c8c2699964ddd302c9fc54b2dce60f
+  data.tar.gz: 4e13f55415704634e69d00f07bb8f09fcbc3f00ba93f62c01453b797f179bccbac2ca01467adf83bf2801a8fb79d37b0da537995d01d837e77e9525192ec7cc2

data/lib/astro_pay.rb

@@ -23,25 +23,45 @@ module AstroPay
     attr_writer :configuration
   end
 
+  # Gets the configuration attribute.
+  #
+  # @return [AstroPay::Configuration] object.
   def self.configuration
     @configuration ||= Configuration.new
   end
 
+  # Allows to set the configuration passing a block where the values are set.
   def self.configure
     yield(configuration)
   end
 
+  # Gets a new [AstroPay::Direct] instance with the given arguments.
+  #
+  # @param  args [Array] (See AstroPay::Direct#initialize).
+  # @return [AstroPay::Direct] object.
   def self.direct(*args)
     Direct.new(*args)
   end
 
+  # Gets a new [AstroPay::Card] instance with the given arguments.
+  #
+  # @params args [Array] (See AstroPay::Card#initialize).
+  # @return [AstroPay::Card] object.
   def self.card(*args)
     Card.new(*args)
   end
 
-  # Optional:
-  # You can send a Hash containing the following accepted params:
-  # :description, :currency, :cpf, :return_url, :confirmation_url
+  # Gets a new [AstroPay::Direct] instance with the given arguments and some
+  # optional values. See the AstroPay Direct Manual.
+  #
+  # @param  invoice [String] unique transaction ID number at the merchant.
+  # @param  amount [Float] the amount of the payment.
+  # @param  iduser [String] user’s unique ID at the merchant / account number.
+  # @param  country [String] country code.
+  # @param  bank [String] bank code.
+  # @param  sub_code [Int] mandatory parameter for PSPs.
+  # @param  args [Hash] Other arguments.
+  # @return [AstroPay::Direct] object.
   def self.create_direct(invoice, amount, iduser, country, bank='', sub_code=1, args={})
     direct(
       args.merge(
@@ -55,6 +75,19 @@ module AstroPay
     ).create
   end
 
+  # Gets a new [AstroPay::Card] instance with the given arguments and some
+  # optional values. See the AstroPay Card Manual.
+  #
+  # @param  number [String] AstroPay Card number.
+  # @param  ccv [Int] AstroPay Card security code.
+  # @param  exp_date [String] expiration date of AstroPay Card. Format: MM/YYYY
+  # @param  amount [Float] transaction amount.
+  # @param  bank [String] bank code.
+  # @param  unique_id [String] unique, anonymized identifier of users in the
+  #         merchant system.
+  # @param  invoice_num [String] unique identifier of merchant transaction.
+  # @param  additional_params [Hash] other arguments.
+  # @return [AstroPay::Card] object.
   def self.create_card(number, ccv, exp_date, amount, unique_id, invoice_num, additional_params={})
     card(
       number: number,

data/lib/astro_pay/card.rb

@@ -8,11 +8,16 @@ module AstroPay
   class Card < AstroPay::Model
 
     # Input params
-    attr_accessor :approval_code, :number, :ccv, :exp_date
-    attr_accessor :amount, :unique_id, :invoice_num, :transaction_id
-    attr_accessor :additional_params, :type
+    attr_accessor :approval_code, :number, :ccv, :exp_date, :amount, :unique_id
+    attr_accessor :invoice_num, :transaction_id, :additional_params, :type
 
-    def initialize(args={})
+    # Creates a new instance of [AstroPay::Card].
+    #
+    # @param  attributes [Hash] with the following fields: :approval_code,
+    #         :number, :ccv, :exp_date, :amount, :unique_id :invoice_num,
+    #         :transaction_id, :additional_params, :type.
+    # @return [AstroPay::Card] object.
+    def initialize(args = {})
       config = AstroPay.configuration
 
       @x_login = config.card_x_login
@@ -21,12 +26,19 @@ module AstroPay
 
       base_url = "https://#{'sandbox-' if @sandbox}api.astropaycard.com/"
 
-      @x_version = "2.0"            #AstroPay API version (default "2.0")
-      @x_delim_char = "|"           #Field delimit character, the character that separates the fields (default "|")
-      @x_test_request = 'N'         #Change to N for production
-      @x_duplicate_window = 30      #Time window of a transaction with the sames values is taken as duplicated (default 120)
+      # AstroPay API version (default "2.0")
+      @x_version = "2.0"
+      # Field delimiter (default "|")
+      @x_delim_char = "|"
+      # Change to N for production
+      @x_test_request = 'N'
+      # Time window of a transaction with the sames values is taken as
+      # duplicated (default 120)
+      @x_duplicate_window = 30
       @x_method = "CC"
-      @x_response_format = "json"   #Response format: "string", "json", "xml" (default: string) (recommended: json)
+      # Response format:
+      # "string", "json", "xml" (default: string; recommended: json)
+      @x_response_format = "json"
 
       @additional_params = Hash.new
 
@@ -36,16 +48,20 @@ module AstroPay
       @transtatus_url = "#{base_url}verif/transtatus"
     end
 
-    # Authorizes a transaction
+    # Requests AstroPay to AUTHORIZE a transaction.
     #
-    # number AstroPay Card number (16 digits)
-    # ccv AstroPay Card security code (CVV)
-    # exp_date AstroPay Card expiration date
-    # amount Amount of the transaction
-    # unique_id Unique user ID of the merchant
-    # invoice_num Merchant transaction identificator, i.e. the order number
-    # additional_params Array of additional info that you would send to AstroPay for reference purpose.
-    # return json of params returned by AstroPay capture API. Please see section 3.1.3 "Response" of AstroPay Card integration manual for more info
+    # @note   This method sends in the request the following data:
+    #         'number', AstroPay Card number (16 digits);
+    #         'ccv', AstroPay Card security code (CVV);
+    #         'exp_date', AstroPay Card expiration date;
+    #         'amount', Amount of the transaction;
+    #         'unique_id', Unique user ID of the merchant;
+    #         'invoice_num', Merchant transaction identifier, i.e. the order
+    #         number;
+    #         'additional_params', Array of additional info that you would send
+    #         to AstroPay for reference purpose.
+    # @return [Hash] response by AstroPay capture API. Please see section 3.1.3
+    #         "Response" of AstroPay Card integration manual for more info.
     def auth_transaction
       data = full_params.merge(
         'x_unique_id' => unique_id,
@@ -56,17 +72,11 @@ module AstroPay
       astro_curl(@validator_url, data)
     end
 
-    # Caputures previous authorized transaction
+    # Requests AstroPay to CAPTURE the previous authorized transaction.
     #
-    # auth_code The x_auth_code returned by auth_transaction method
-    # number AstroPay Card number (16 digits)
-    # ccv AstroPay Card security code (CVV)
-    # exp_date AstroPay Card expiration date
-    # amount Amount of the transaction
-    # unique_id Unique user ID of the merchant
-    # invoice_num Merchant transaction identificator, i.e. the order number
-    # additional_params Array of additional info that you would send to AstroPay for reference purpose.
-    # return json returned by AstroPay capture API. Please see section 3.1.3 "Response" of AstroPay Card integration manual for more info
+    # @note   (See #auth_transaction) to known the data sent on the request.
+    # @return [Hash] response by AstroPay capture API. Please see section 3.1.3
+    #         "Response" of AstroPay Card integration manual for more info.
     def capture_transaction
       data = full_params.merge(
         'x_unique_id' => unique_id,
@@ -78,16 +88,12 @@ module AstroPay
       astro_curl(@validator_url, data)
     end
 
-    # Authorize and capture a transaction at the same time (if it is possible)
+    # Requests AstroPay to AUTHORIZE and CAPTURE a transaction at the same time
+    # (if it is possible).
     #
-    # number AstroPay Card number (16 digits)
-    # ccv AstroPay Card security code (CVV)
-    # exp_date AstroPay Card expiration date
-    # amount Amount of the transaction
-    # unique_id Unique user ID of the merchant
-    # invoice_num Merchant transaction identificator, i.e. the order number
-    # additional_params Array of additional info that you would send to AstroPay for reference purpose.
-    # return json returned by AstroPay capture API. Please see section 3.1.3 "Response" of AstroPay Card integration manual for more info
+    # @note   (See #auth_transaction) to known the data sent on the request.
+    # @return [Hash] response by AstroPay capture API. Please see section 3.1.3
+    #         "Response" of AstroPay Card integration manual for more info.
     def auth_capture_transaction
       data = full_params.merge(
         'x_unique_id' => unique_id,
@@ -98,15 +104,13 @@ module AstroPay
       astro_curl(@validator_url, data)
     end
 
-    # Refund a transaction
+    # Requests AstroPay to REFUND a transaction.
     #
-    # transaction_id merchant invoice number sent in previus call of capture_transaction or auth_transaction
-    # number AstroPay Card number (16 digits)
-    # ccv AstroPay Card security code (CVV)
-    # exp_date AstroPay Card expiration date
-    # amount Amount of the transaction
-    # additional_params Array of additional info that you would send to AstroPay for reference purpose.
-    # return json returned by AstroPay capture API. Please see section 3.2.2 "Response" of AstroPay Card integration manual for more info
+    # @note   This request includes the transaction_id merchant invoice number
+    #         sent in previous call of capture_transaction or auth_transaction.
+    #         (See #auth_transaction) to known the data sent on the request.
+    # @return [Hash] response by AstroPay capture API. Please see section 3.1.3
+    #         "Response" of AstroPay Card integration manual for more info.
     def refund_transaction
       data = full_params.merge(
         'x_trans_id' => transaction_id,
@@ -116,15 +120,13 @@ module AstroPay
       astro_curl(@validator_url, data)
     end
 
-    # VOID a transaction
+    # Requests AstroPay to VOID a transaction.
     #
-    # transaction_id merchant invoice number sent in previus call of capture_transaction or auth_transaction
-    # number AstroPay Card number (16 digits)
-    # ccv AstroPay Card security code (CVV)
-    # exp_date AstroPay Card expiration date
-    # amount Amount of the transaction
-    # additional_params Array of additional info that you would send to AstroPay for reference purpose.
-    # return json returned by AstroPay capture API. Please see section 3.2.2 "Response" of AstroPay Card integration manual for more info
+    # @note   This request includes the transaction_id merchant invoice number
+    #         sent in previous call of capture_transaction or auth_transaction.
+    #         (See #auth_transaction) to known the data sent on the request.
+    # @return [Hash] response by AstroPay capture API. Please see section 3.1.3
+    #         "Response" of AstroPay Card integration manual for more info.
     def void_transaction
       data = full_params.merge(
         'x_trans_id' => transaction_id,
@@ -134,11 +136,14 @@ module AstroPay
       astro_curl(@validator_url, data)
     end
 
-    # Checks the status of a transaction
+    # Requests AstroPay the status of a transaction.
     #
-    # invoice_num The merchant id sent in the transaction
-    # type 0 for basic info, 1 for detailed info
-    # return json. Please see section 3.2.3 of APC integration manual from more details.
+    # @note  This request includes the basic credentials data and the following
+    #        fields:
+    #        'invoice_num', The merchant id sent in the transaction;
+    #        'type', 0 for basic info, 1 for detailed info.
+    # @return [Hash] response by AstroPay capture API. Please see section 3.1.3
+    #         "Response" of AstroPay Card integration manual for more info.
     def check_transaction_status
       data = basic_credentials.merge(
         'x_trans_key' => @x_trans_key,
@@ -149,16 +154,32 @@ module AstroPay
       astro_curl(@transtatus_url, data)
     end
 
-    def astro_curl(url, params_hash)
-      AstroPay::Curl.post(url, params_hash)
+    # Makes a request to the AstroPay API.
+    #
+    # @param  url [String] endpoint for the AstroPay API.
+    # @param  params [Hash] data and options for the request.
+    # @return [Hash] of the successful response or [String] of the response if
+    #         an error rises.
+    def astro_curl(url, params)
+      AstroPay::Curl.post(url, params)
     end
 
+    # Generates an hexadecimal code intended to be used in the checksum of the
+    # messages received.
+    #
+    # @param  transaction_id [String] merchant's id for the transaction.
+    # @param  amount [Float] of the transaction.
+    # @return [String] of 64 uppercase characters.
     def calculate_control(transaction_id, amount)
-      Digest::MD5.hexdigest("#{@x_login}#{transaction_id}#{amount}");
+      Digest::MD5.hexdigest("#{@x_login}#{transaction_id}#{amount}")
     end
 
     private
 
+    # Sets a collection with the basic credentials for the AstroPay API.
+    #
+    # @return [Hash] Please see section 3.4 of the AstroPay Card integration
+    #                manual for more info.
     def basic_credentials
       {
         'x_login' => @x_login,
@@ -169,6 +190,9 @@ module AstroPay
       }
     end
 
+    # Sets a collection with the complete credentials for the AstroPay API.
+    #
+    # @return [Hash] See the AstroPay Card integration manual for more info.
     def full_credentials
       basic_credentials.merge(
         'x_method' => @x_method,
@@ -177,6 +201,9 @@ module AstroPay
       )
     end
 
+    # Sets a collection with the basic data of an AstroPay card.
+    #
+    # @return [Hash] See the AstroPay Card integration manual for more info.
     def basic_variables
       {
         'x_card_num' => number,
@@ -186,6 +213,11 @@ module AstroPay
       }
     end
 
+    # Sets a collection with the credentials, the card data and additional
+    # parameters to be used on API calls.
+    #
+    # @return [Hash] See #basic_credential, #full_credentials and
+    #         #basic_variables.
     def full_params
       full_credentials.merge(
         additional_params
@@ -194,4 +226,4 @@ module AstroPay
       )
     end
   end
-end
+end

data/lib/astro_pay/configuration.rb

@@ -10,9 +10,13 @@ module AstroPay
     #Optional attributes
     attr_accessor :sandbox, :enable_ssl
 
+    # Creates a new instance of [AstroPay::Configuration].
+    #
+    # @param  attributes [Hash] with the following fields: :error, :message.
+    # @return [AstroPay::Configuration] instance.
     def initialize
       @sandbox = true
       @enable_ssl = true
     end
   end
-end
+end

data/lib/astro_pay/curl.rb

@@ -1,9 +1,20 @@
 module AstroPay
   class Curl
+
+    # Gets the configuration flag for SSL use with Astropay connections.
+    #
+    # @return [Boolean]
     def self.enable_ssl
       AstroPay.configuration.enable_ssl
     end
 
+    # Performs a POST request to the given URL with the given parameters.
+    # @param  url [String] to where the request will be made.
+    # @param  params_hash [Hash] parameters to be sent with the request.
+    # @return [Hash] of the response or, if an error rises, [String] of
+    #         the response content.
+    # @note   When SSL is enabled, no certificate is actually verified due to
+    #         SSLv3 incompatibilities.
     def self.post(url, params_hash)
       uri = URI.parse(url)
       http = Net::HTTP.new(uri.host, uri.port)
@@ -24,4 +35,4 @@ module AstroPay
       end
     end
   end
-end
+end

data/lib/astro_pay/direct.rb

@@ -12,7 +12,13 @@ module AstroPay
     attr_accessor :description, :cpf, :sub_code, :return_url, :confirmation_url
     attr_accessor :response_type
 
-    def initialize(args={})
+    # Creates a new instance of [AstroPay::Direct].
+    #
+    # @param  attributes [Hash] with the following fields: :invoice, :amount,
+    #         :iduser, :bank, :country, :currency, :description, :cpf,
+    #         :sub_code, :return_url, :confirmation_url.
+    # @return [AstroPay::Direct] object.
+    def initialize(args = {})
       config = AstroPay.configuration
 
       @x_login =  config.direct_x_login
@@ -35,6 +41,11 @@ module AstroPay
       }
     end
 
+    # Creates a new transaction.
+    #
+    # @return [Hash] of the response that includes the URL to where an user
+    #         should be redirected to validate and complete the process. If
+    #         there is an error, the [String] response is returned.
     def create
       params_hash = {
         'x_login' => @x_login,
@@ -64,9 +75,13 @@ module AstroPay
       astro_curl(@astro_urls['create'], params_hash)
     end
 
+    # Requests a list of valid banks by country.
+    #
+    # @return [Hash] of the response that includes the list of banks. If there 
+    #         is an error, the [String] response is returned.
     def get_banks_by_country
       params_hash = {
-        #Mandatory
+        # Mandatory
         'x_login' => @x_login,
         'x_trans_key' => @x_trans_key,
         'country_code' => country,
@@ -76,9 +91,13 @@ module AstroPay
       astro_curl(@astro_urls['banks'], params_hash)
     end
 
+    # Requests the status of a transaction.
+    #
+    # @return [Hash] of the response that includes the transaction status. If
+    #         there is an error, the [String] response is returned.
     def get_invoice_status
       params_hash = {
-        #Mandatory
+        # Mandatory
         'x_login' => @x_login_for_webpaystatus,
         'x_trans_key' => @x_trans_key_for_webpaystatus,
         'x_invoice' => invoice,
@@ -88,9 +107,13 @@ module AstroPay
       astro_curl(@astro_urls['status'], params_hash)
     end
 
+    # Requests the exchange rate from USD to the currency of a target country.
+    #
+    # @return [Hash] of the response that includes the exchange rate. If there
+    #         is an error, the [String] response is returned.
     def get_exchange
       params_hash = {
-        #Mandatory
+        # Mandatory
         'x_login' => @x_login_for_webpaystatus,
         'x_trans_key' => @x_trans_key_for_webpaystatus,
         'x_country' => country,
@@ -100,6 +123,12 @@ module AstroPay
       astro_curl(@astro_urls['exchange'], params_hash)
     end
 
+    # Makes a request to the AstroPay API.
+    #
+    # @param  url [String] endpoint for the AstroPay API.
+    # @param  params [Hash] data and options for the request.
+    # @return [Hash] of the successful response or [String] of the response if
+    #         an error rises.
     def astro_curl(url, params_hash)
       AstroPay::Curl.post(url, params_hash)
     end

data/lib/astro_pay/model.rb

@@ -6,10 +6,20 @@ module AstroPay
     include ActiveModel::Conversion
     extend ActiveModel::Naming
 
+    # Creates a new instance of [AstroPay::Model].
+    #
+    # @param  attributes [Hash] with the following fields: :error, :message.
+    # @return [AstroPay::Model] object.
     def initialize(attributes = {})
       self.attributes = attributes
     end
 
+    # Sets a given hash values as attribute values for the class. It will try
+    # to match the keys of the hash to existent attributes that have accessors.
+    #
+    # @param  attributes [Hash]
+    # @note   If raised, [NoMethodError] will be caught and a message will be
+    #         printed to the standard output.
     def attributes=(attributes = {})
       attributes.each do |name, value|
         begin
@@ -20,6 +30,10 @@ module AstroPay
       end
     end
 
+    # Gets the instance attributes.
+    #
+    # @return [Hash] with the attribute name as key, and the attribute value as
+    #         value.
     def attributes
       Hash[instance_variables.map { |name| [name, instance_variable_get(name)] }]
     end

data/lib/astro_pay/version.rb

@@ -1,3 +1,3 @@
 module AstroPay
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: astro_pay
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Luis Galaviz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-14 00:00:00.000000000 Z
+date: 2015-01-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler