puntopagos 0.1.4 → 0.1.5

data/README.textile

@@ -17,12 +17,10 @@ development:
   environment:        "sandbox"
   puntopagos_key:     "YOUR-API-KEY"
   puntopagos_secret:  "YOUR-APP-SECRET"
-
 test:
   environment:        "sandbox"
   puntopagos_key:     "YOUR-API-KEY"
   puntopagos_secret:  "YOUR-APP-SECRET"
-
 production:
   environment:        "production"
   puntopagos_key:     "YOUR-API-KEY"
@@ -31,18 +29,28 @@ production:
 
 h2. Sample Usage
 
-<pre>
-
-  trx_id = 'UNIQUE-TRACKING-ID' # Number as a string
-  amount = '1000.00' # Number as a string with two decimals
-  payment_method = 'some number' # Optional parameter (see PuntoPagos documentation)
+h3. Create a Transaction and Redirect to process url
 
+<pre>
+  trx_id         = 'UNIQUE-TRACKING-ID' # Number as a string
+  amount         = '1000.00'            # Number as a string with two decimals
+  payment_method = 'some number'        # Optional parameter (see PuntoPagos documentation)
   req = PuntoPagos::Request.new()
-
-	resp = req.create(trx_id, amount, payment_method)
+  resp = req.create(trx_id, amount, payment_method)
 	if (resp.success?)
 	  redirect_to resp.payment_process_url
 	end
+</pre>
+
+h3. Verify notification sent by PuntoPagos
+
+<pre>
+  # Action where PuntoPagos it's gonna post
+  def action
+    notification = PuntoPagos::Notification.new
+    # This methods requires the headers as a hash and the params object as a hash
+    notification.valid? headers, params
+  end
 
 </pre>
 

data/lib/puntopagos/authorization.rb

@@ -2,11 +2,18 @@ require 'base64'
 require 'openssl'
 
 module PuntoPagos
+  
+  # Public: This class manage the signing of a message using
+  # the secret and api-key defined in puntopagos.yml
   class Authorization
     def initialize env = nil
       @@config ||= PuntoPagos::Config.new(env)
     end
 
+    # Public: Signs a string using the secret and api-key defined in puntopagos.yml
+    #
+    # string - The String to be signed
+    # Returns the signed String.
     def sign(string)
       encoded_string = Base64.encode64(OpenSSL::HMAC.digest('sha1',@@config.puntopagos_secret, string)).chomp
       "PP "+@@config.puntopagos_key+":"+ encoded_string

data/lib/puntopagos/config.rb

@@ -1,6 +1,8 @@
 require 'yaml'
 
 module PuntoPagos
+  # Public: Manage configurations variables
+  # like production and sandbox URLs and puntopagos.yml config file
   class Config
     PUNTOPAGOS_BASE_URL = {
       :production => "https://www.puntopagos.com/",
@@ -9,6 +11,12 @@ module PuntoPagos
     
     attr_accessor :config_filepath, :puntopagos_base_url, :puntopagos_key, :puntopagos_secret
     
+    # Public: Loads the configuration file puntopagos.yml
+    # If it's a rails application it will take the file from the config/ directory
+    #
+    # env - Environment.
+    #
+    # Returns a Config object.
     def initialize env = nil, config_override = nil
       if env
         # For non-rails apps
@@ -20,6 +28,13 @@ module PuntoPagos
       end
     end
     
+    private 
+
+    # Public: Initialize variables based on puntopagos.yml
+    #
+    # rails_env - Environment.
+    #
+    # Returns nothing.
     def load(rails_env)
       config = YAML.load_file(@config_filepath)[rails_env]
       pp_env = config['environment'].to_sym

data/lib/puntopagos/executioner.rb

@@ -10,9 +10,9 @@ module PuntoPagos
 
     def call_api data, path, method, signature, timestamp
       #hack fix: JSON.unparse doesn't work in Rails 2.3.5; only {}.to_json does..
-      headers = set_headers(signature, timestamp)
+      headers          = set_headers(signature, timestamp)
       api_request_data = JSON.unparse(data) rescue data.to_json
-      resp = RestClient.method(method).call(@@puntopagos_base_url+path, data.to_json, headers)
+      resp             = RestClient.method(method).call(@@puntopagos_base_url+path, data.to_json, headers)
       JSON.parse(resp)
     end
 
@@ -20,12 +20,12 @@ module PuntoPagos
 
     def set_headers signature, timestamp
       headers = {
-        'User-Agent' => "puntopagos-ruby-#{PuntoPagos::VERSION}",
-        'Accept' => 'application/json',
+        'User-Agent'     => "puntopagos-ruby-#{PuntoPagos::VERSION}",
+        'Accept'         => 'application/json',
         'Accept-Charset' => 'utf-8',
-        'Content-Type'  => 'application/json; charset=utf-8',
-        'Fecha'         => timestamp,
-        'Autorizacion'  => signature
+        'Content-Type'   => 'application/json; charset=utf-8',
+        'Fecha'          => timestamp,
+        'Autorizacion'   => signature
       }
     end
   end

data/lib/puntopagos/notification.rb

@@ -1,4 +1,5 @@
 module PuntoPagos
+  # Public: Manages the notification process.
   class Notification
     def initialize env = nil
       @env = env
@@ -6,10 +7,17 @@ module PuntoPagos
       @@function = "transaccion/notificar"
     end
 
+    # Public: Validates the message sent by PuntoPagos in the
+    # notification process.
+    #
+    # headers - The headers of the request as a Hash.
+    # params  - The params Hash.
+    #
+    # Returns true or false.
     def valid? headers, params
       timestamp = get_timestamp headers
 
-      message = create_message params["token"], params["trx_id"], params["monto"], timestamp
+      message = create_message params["token"], params["trx_id"], params["monto"].to_s, timestamp
       authorization = Authorization.new(@env)
       signature = authorization.sign(message)
       signature == pp_signature(headers)
@@ -18,14 +26,33 @@ module PuntoPagos
 
     private
 
+    # Internal: Creates the message to be signed which will be
+    # compared against the one that PuntoPagos sends.
+    #
+    # token     - PuntoPagos transaction unique token.
+    # trx_id    - Your transaction unique id.
+    # amount    - The transaction amount.
+    # timestamp - timestamp
+    #
+    # Returns a message as a String.
     def create_message token, trx_id, amount, timestamp
       @@function + "\n" + token + "\n" + trx_id + "\n" + amount + "\n" + timestamp
     end
 
+    # Internal: Gets the signature out of the Autorizacion HTTP Header.
+    #
+    # headers - request headers as a Hash.
+    #
+    # Returns the Autorizacion HTTP Header value.
     def pp_signature headers
       headers['Autorizacion']
     end
 
+    # Internal: Gets the timestamp out of the Fecha HTTP Header.
+    #
+    # headers - request headers as a Hash.
+    #
+    # Returns the Fecha HTTP Header value.
     def get_timestamp headers
       headers['Fecha']
     end

data/lib/puntopagos/version.rb

@@ -1,3 +1,3 @@
 module PuntoPagos
-  VERSION = "0.1.4"
+  VERSION = "0.1.5"
 end

data/test/unit/create_request_test.rb

@@ -4,20 +4,15 @@ require 'test_helper'
 class CreateRequestTest < Test::Unit::TestCase
 
   def setup
-    @req = PuntoPagos::Request.new('production')
+    @req = PuntoPagos::Request.new('test')
   end
 
   def test_valid_create
     puts "-------"
     puts "webpay valid"
 
-    data = {
-  		"trx_id" 	=> "#{Time.now.to_i}",
-  		"monto"		=> "100.00",
-  		"medio_pago" => "3"
-  		}
-  	resp = @req.create("#{Time.now.to_i}", "100.00")
-    puts "RESP: #{resp.success?}"
+    resp                 = @req.create("#{Time.now.to_i}", "100.00")
+
     assert resp.success? == true, "Pass"
 
 #    payload = YAML.load_file(File.join(File.dirname(__FILE__),"..", "data","webpay_paylaod.yml"))
@@ -26,9 +21,6 @@ class CreateRequestTest < Test::Unit::TestCase
   def test_invalid_webpay_pay
     puts "webpay invalid"
 
-    data = {
-  		'trx_id' 	=> "#{Time.now.to_i}"
-  		}
   	resp = @req.create("#{Time.now.to_i}","10")
 
     assert resp.success? == false
@@ -37,9 +29,9 @@ class CreateRequestTest < Test::Unit::TestCase
 
   def test_notification
     puts "testing notification"
-    notification = PuntoPagos::Notification.new('production')
-    headers = {'Fecha' => 'Thu, 14 Jun 2012 22:52:47 GMT', 'Autorizacion' => 'PP rkdXmAGWLHCKdPyyk6ig:qOSavthLY3ElqsRCtxFEl02lL1s='}
-    params = {'token' => 'M5N1DAE6PALVAF8K', 'monto' => '1000000.00', 'trx_id' => '9787415132'}
+    notification                                = PuntoPagos::Notification.new('test')
+    headers                                     = {'Fecha' => 'Thu, 14 Jun 2012 22:52:47 GMT', 'Autorizacion' => 'PP rkdXmAGWLHCKdPyyk6ig:qOSavthLY3ElqsRCtxFEl02lL1s='}
+    params                                      = {'token' => 'M5N1DAE6PALVAF8K', 'monto' => '1000000.00', 'trx_id' => '9787415132'}
     assert notification.valid?(headers, params) == true
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: puntopagos
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
   prerelease: 
 platform: ruby
 authors:
@@ -10,11 +10,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-15 00:00:00.000000000Z
+date: 2012-07-10 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
-  requirement: &2161561760 !ruby/object:Gem::Requirement
+  requirement: &2157206220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -22,7 +22,7 @@ dependencies:
         version: 1.6.7
   type: :runtime
   prerelease: false
-  version_requirements: *2161561760
+  version_requirements: *2157206220
 description: Ruby wrapper for PuntoPagos Payment API
 email:
 - imella@acid.cl