dinero_mail_ipn 0.0.1 → 1.0.1

data/.gitignore

@@ -1,3 +1,5 @@
 pkg/*
 *.gem
 .bundle
+.yardoc
+doc

data/.rvmrc

@@ -0,0 +1 @@
+rvm use 1.9.2-p180@dm --create

data/.yardopts

@@ -0,0 +1 @@
+-t default --markup markdown --no-private

data/Gemfile

@@ -1,4 +1,3 @@
-source "http://rubygems.org"
+source :rubygems
 
-# Specify your gem's dependencies in dinero_mail_ipn.gemspec
 gemspec

data/Gemfile.lock

@@ -1,19 +1,30 @@
 PATH
   remote: .
   specs:
-    dinero_mail_ipn (0.0.1)
-      httparty (~> 0.7.6)
+    dinero_mail_ipn (1.0.1)
+      httparty (~> 0.8.1)
+      nokogiri (~> 1.5.0)
 
 GEM
   remote: http://rubygems.org/
   specs:
-    crack (0.1.8)
-    httparty (0.7.6)
-      crack (= 0.1.8)
+    fakeweb (1.3.0)
+    httparty (0.8.1)
+      multi_json
+      multi_xml
+    multi_json (1.0.4)
+    multi_xml (0.4.1)
+    nokogiri (1.5.0)
+    redcarpet (2.0.1)
+    shoulda (2.11.3)
+    yard (0.7.4)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   dinero_mail_ipn!
-  httparty (~> 0.7.6)
+  fakeweb (~> 1.3.0)
+  redcarpet (~> 2.0.1)
+  shoulda (~> 2.11.3)
+  yard (~> 0.7.4)

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2011
+Copyright (c) 2012
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the
@@ -17,4 +17,4 @@ 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.
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.markdown

@@ -0,0 +1,74 @@
+# Dinero Mail IPN Gem
+
+Ruby gem para consumir los métodos de IPN 1 y IPN 2.
+
+## Instalación
+
+    gem install dinero_mail_ipn
+
+### Bundler
+
+    gem 'dinero_mail_ipn'
+
+## Uso
+
+    require 'dinero_mail_ipn'
+
+## IPN v1
+
+Consulta de pagos en períodos de una semana. 
+
+    client = DineroMailIpn::Client.new(:email => 'EMAILPRUEBA@gmail.com', :account => '17128254', :pin => 'AYCN7IXDTM')
+    response = client.consulta_pago(Date.today - 7, Date.today)
+    # #<DineroMailIpn::ConsultaPagoResponse:0x5f9600 @hash={"Report"=>{"Email"=>"EMAILPRUEBA@gmail.com",
+    # "Acount"=>"17128254", "Pin"=>nil, "StartDate"=>"20110603", "EndDate"=>"20110703", "XML"=>"1", 
+    # "State"=>"1", "Pays"=>nil, "Collections"=>nil, "Tickets"=>nil, "Receptions"=>nil, "Retreats"=>nil,
+    # "Credits"=>nil, "Debits"=>nil}}>
+    response.ok? 
+    # true
+    response.state_description
+    # "La consulta se realizó correctamente"
+    payment = response.payments.first
+    payment["Trx_Payment"]
+    # "108.98"
+
+### IPN v2
+
+Consulta de reportes para transacciones específicas.
+
+    c = DineroMailIpn::Client.new(:account => '09813581', :password => 'mipassword')
+    reporter = c.consulta_transacciones(["31548", "23123"])
+    report = reporter.reports.first
+    report.id
+    # 1
+    report.amount
+    # 2999
+    report.valid?
+    # true
+
+## Documentación
+
+Ver: [http://rubydoc.info/github/etagwerker/dinero\_mail\_ipn/master/frames](http://rubydoc.info/github/etagwerker/dinero_mail_ipn/master/frames)
+
+Si falta algo, por favor reportarlo como issue.
+
+## Roadmap
+
+* Agregar más tests que testeen las posibles respuestas de Dinero Mail IPN
+* Agregar más documentación y ejemplos
+
+## Patches/Pull Requests
+
+Fork the project.
+
+Make your feature addition or bug fix.
+
+Add tests for it. This is important so I don't break it in a future version unintentionally.
+
+Commit, do not mess with Rakefile, version, or history. (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+
+Send me a pull request. Bonus points for topic branches.
+
+## Licencia
+
+Dinero Mail IPN is released under the MIT license.

data/Rakefile

@@ -1,2 +1,19 @@
+require 'rake'
+require "shoulda/tasks"
+require "rake/testtask"
 require 'bundler'
+
 Bundler::GemHelper.install_tasks
+
+Rake::TestTask.new(:test) do |test|
+  test.ruby_opts = ["-rubygems"] if defined? Gem
+  test.libs << "lib" << "test"
+  test.pattern = "test/**/test_*.rb"
+end
+
+task :default => :test
+
+desc "Open an irb session preloaded with this library"
+task :console do
+  sh "irb -rubygems -I lib -r dinero_mail_ipn.rb"
+end

data/dinero_mail_ipn.gemspec

@@ -14,12 +14,19 @@ Gem::Specification.new do |s|
 
   s.rubyforge_project = "dinero_mail_ipn"
 
-  s.add_dependency 'httparty', '~> 0.7.6'
-  s.add_dependency 'nokogiri', '~> 1.4.4'
-
+  s.add_dependency 'httparty', '~> 0.8.1'
+  s.add_dependency 'nokogiri', '~> 1.5.0'
 
   s.files         = `git ls-files`.split("\n")
-  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.test_files = [
+    "test/helper.rb",
+     "test/test_dinero_mail_ipn.rb"
+  ]
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
+
+  s.add_development_dependency 'shoulda', '~> 2.11.3'
+  s.add_development_dependency 'fakeweb', '~> 1.3.0'
+  s.add_development_dependency 'yard', '~> 0.7.4'
+  s.add_development_dependency 'redcarpet', '~> 2.0.1'
 end

data/lib/dinero_mail_ipn.rb

@@ -1,38 +1,94 @@
+# encoding: utf-8
+
 require 'httparty'
 require 'nokogiri'
 
+Dir[File.join(File.dirname(__FILE__),'dinero_mail_ipn', '*')].each {|file| require file }
+
 module DineroMailIpn
+
+  # # Cliente para Dinero Mail API (v1 y v2)
+  #
+  # Cliente para consumir los métodos de la API IPN v1 y v2.
+  #
+  # ## Cliente para IPN v1
+  #
+  #     DineroMailIpn::Client.new(:email => 'EMAILPRUEBA@gmail.com', :account => '17128254', :pin => 'AYCN7IXDTM')
+  #
+  # ## Cliente para IPN v2
+  #
+  #     DineroMailIpn::Client.new(:email => 'EMAILPRUEBA@gmail.com',
+  #       :account => '17128254', :pin => 'AYCN7IXDTM', :password => 'ipnv2password')
+  #
+  # ## Paises
+  #
+  # Por default el Cliente se crea para una cuenta de Argentina. Para consultar la API de una cuenta en otro país:
+  #
+  #     DineroMailIpn::Client.new(:email => 'EMAILPRUEBA@gmail.com',
+  #       :account => '17128254', :pin => 'AYCN7IXDTM', :pais => 'brasil')
+  #
+  # ### Posibilidades
+  #
+  # * 'argentina'
+  # * 'chile'
+  # * 'brasil'
+  # * 'mexico'
+  #
+  # @see Client#initialize
   class Client
     include HTTParty
     format :xml
     attr_reader :email, :account, :pin, :pais, :password
 
-    DEFAULT_PAIS = 'argentina'
-    
+    # País por default para consultas
+    DEFAULT_COUNTRY = 'argentina'
+
+    # @param [Hash] opts opciones para crear la instancia
+    # @option opts [String] :email Email de la cuenta de Dinero Mail
+    # @option opts [String] :account Número de cuenta de Dinero Mail (sin /)
+    # @option opts [String] :pin PIN de la cuenta de Dinero Mail
+    # @option opts [String] :password Contraseña para consultas de IPN v2
+    # @option opts [String] :pais Pais de la cuenta. Por default: 'argentina'
     def initialize(opts)
       @email = opts[:email]
       @account = opts[:account]
       @pin = opts[:pin]
       @password = opts[:password]
-      @pais = opts[:pais] || DEFAULT_PAIS
+      @pais = opts[:pais] || DEFAULT_COUNTRY
     end
 
-    # devuelve una response
+    # Devuelve una {ConsultaPagoResponse}.
+    #
+    # @param [Date] Comienzo del período
+    # @param [Date] Fin del período
+    # @return [ConsultaPagoResponse] Respuesta
     def consulta_pago(start_date, end_date)
       params = default_params.merge({:StartDate => format_date(start_date), :EndDate => format_date(end_date)})
-      self.class.get("https://#{@pais}.dineromail.com/vender/ConsultaPago.asp", :query => params).parsed_response
+      response = self.class.get("https://#{@pais}.dineromail.com/vender/ConsultaPago.asp", :query => params)
+      ConsultaPagoResponse.new(
+        response.parsed_response)
     end
 
-    def default_params
-      {:XML => 1, :Acount => @account, :Pin => @pin, :Email => @email}
-    end
-    
-    # formatea una date a 20110201
+    # Devuelve un {String} con formato YYYYMMDD. (Por ej.: "20110201")
+    #
+    # @param [Date] Una fecha
+    # @return [String] Fecha en formato Dinero Mail
     def format_date(a_date)
       a_date.strftime("%Y%m%d")
     end
 
-    def consulta_transacciones(*transacciones)
+    # Devuelve un objeto [Reporter] con un array de objetos tipo [Report].
+    #
+    # Los objetos de tipo [Report] están asociados a los ID de transacciones.
+    #
+    # Ejemplo:
+    #
+    #     client.consulta_transacciones([1,2])
+    #
+    # @param [Array] Array de transacciones
+    #
+    # @return [Reporter] Con todos los [Report] correspondientes
+    def consulta_transacciones(transacciones = [])
       xml_builder = Nokogiri::XML::Builder.new do |xml|
         xml.REPORTE {
           xml.NROCTA @account
@@ -41,8 +97,8 @@ module DineroMailIpn
               xml.CLAVE @password
               xml.TIPO 1
               xml.OPERACIONES {
-                transacciones.each do |transaccion|
-                  xml.ID transaccion
+                transacciones.each do |transaction_id|
+                  xml.ID transaction_id
                 end
               }
             }
@@ -53,11 +109,16 @@ module DineroMailIpn
       body.sub!("<?xml version=\"1.0\"?>", "")
       body.gsub!(/\s/, '')
 
-      self.class.post("http://#{@pais}.dineromail.com/Vender/Consulta_IPN.asp", :body => "DATA=#{body}", 
-                       :headers => {"Content-type" => "application/x-www-form-urlencoded", "Content-length" => "#{body.length}" }).parsed_response
+      response = self.class.post("http://#{@pais}.dineromail.com/Vender/Consulta_IPN.asp", :body => "DATA=#{body}",
+                                :headers => {"Content-type" => "application/x-www-form-urlencoded", "Content-length" => "#{body.length}" }).response.body
+      DineroMailIpn::Reporter.new(response)
+    end
+
+    private
+
+    def default_params
+      {:XML => 1, :Acount => @account, :Pin => @pin, :Email => @email}
     end
   end
 
 end
-
-  # DineroMail::Ipn.consulta_ipn()

data/lib/dinero_mail_ipn/consulta_pago_response.rb

@@ -0,0 +1,105 @@
+# encoding: utf-8
+module DineroMailIpn
+
+  # # Respuesta a Consulta IPN v1
+  #
+  # Clase que agrega información de valor para entender la respuesta de Dinero Mail IPN v1.
+  #
+  # Para más información ver:
+  # [https://github.com/etagwerker/dinero_mail_ipn/blob/master/resources/IPN_es.pdf](https://github.com/etagwerker/dinero_mail_ipn/blob/master/resources/IPN_es.pdf)
+  #
+  # ## Ejemplos:
+  #
+  #     response = ConsultaPagoResponse.new({"Report"=>{"Email"=>"ernesto@ombushop.com", "Acount"=>"17128254",
+  #       "Pin"=>nil, "StartDate"=>"20110603", "EndDate"=>"20110703", "XML"=>"1",
+  #       "State"=>"1", "Pays"=>nil, "Collections"=>nil, "Tickets"=>nil, "Receptions"=>nil,
+  #       "Retreats"=>nil, "Credits"=>nil, "Debits"=>nil}})
+  #     response.state
+  #     # 1
+  #     response.ok?
+  #     # true
+  #     response.state_description
+  #     # 'La consulta se realizó correctamente'
+  #
+  # ## Nota
+  #
+  # Por ahora las collections de la consulta solo se pueden consultar por un hash (response.hash)
+  #
+  # ## TODO
+  #
+  # Agregar más métodos de 'negocio' que tengan métodos útiles.
+  class ConsultaPagoResponse
+
+    attr_accessor :hash
+
+    STATE_DESCRIPTIONS = {0 => 'Los parámetros no respetan el formato requerido', 1 => 'La consulta se realizó correctamente', 2 => 'Los valores son incorrectos para realizar la consulta'}
+
+    # Crea una ConsultaPagoResponse usando un hash en base a la respuesta de Dinero Mail.
+    #
+    # Por ejemplo:
+    #
+    #     ConsultaPagoResponse.new({"Report"=>{"Email"=>"ernesto@ombushop.com", "Acount"=>"17128254",
+    #       "Pin"=>nil, "StartDate"=>"20110603", "EndDate"=>"20110703", "XML"=>"1",
+    #       "State"=>"1", "Pays"=>nil, "Collections"=>nil, "Tickets"=>nil, "Receptions"=>nil,
+    #       "Retreats"=>nil, "Credits"=>nil, "Debits"=>nil}})
+    def initialize(_hash)
+      self.hash = _hash
+    end
+
+    # Devuelve true si la respuesta no devolvió error
+    #
+    # @return [Boolean]
+    def ok?
+      state == "1"
+    end
+
+    # Devuelve true si la respuesta devolvió error
+    #
+    # @return [Boolean]
+    def error?
+      !ok?
+    end
+
+    # Devuelve un {Array} de objetos tipo {Payment}
+    #
+    # @return [Array] Objetos de tipo {Payment}
+    def payments
+      return @payments if @payments
+
+      @payments = []
+      begin
+        pays = self.hash["Report"]["Pays"]
+
+        if pays
+          pays.each do |key, payment_hash|
+            @payments << Payment.new(payment_hash)
+          end
+        end
+      rescue Exception => e
+        raise MalformedResponseError.new("Error procesando pagos: #{e.message}")
+      end
+      @payments
+    end
+
+    # Devuelve el código de estado de la respuesta. 
+    #
+    # Posibilidades: "0", "1" o "2".
+    #
+    # @raise [MalformedResponseError] Si la respuesta no tiene /Report/State
+    def state
+      begin
+        self.hash["Report"]["State"]
+      rescue Exception => e
+        raise MalformedResponseError.new("No se encontró /Report/State en el XML de respuesta")
+      end
+    end
+
+    # Devuelve la descripción del código de respuesta
+    # según la documentación
+    def state_description
+      STATE_DESCRIPTIONS[state.to_i]
+    end
+
+  end
+
+end

data/lib/dinero_mail_ipn/item.rb

@@ -0,0 +1,35 @@
+# encoding: utf-8
+
+module DineroMailIpn
+
+  # # Item (IPN v1)
+  #
+  # Cada {Payment} puede estar asociado con uno o muchos items. 
+  #
+  # Para acceder a estos objetos: 
+  #
+  #     payment.items
+  #
+  # Para acceder a los atributos de estos objetos:
+  #
+  #     item["Item_Code"]
+  #     # "SKU123"
+  #     item["Item_Payment"]
+  #     # "68.00"
+  #
+  # @see Payment#items
+  class Item
+
+    # @private
+    def initialize(hash)
+      @hash = hash
+    end
+
+    # Devuelve un {String} o nil
+    # @return [String]
+    def [](key)
+      @hash[key]
+    end
+
+  end
+end

data/lib/dinero_mail_ipn/malformed_response_error.rb

@@ -0,0 +1,6 @@
+module DineroMailIpn
+
+  # La respuesta enviada desde Dinero Mail IPN tiene un formato inesperado.
+  class MalformedResponseError < StandardError; end
+
+end

data/lib/dinero_mail_ipn/payment.rb

@@ -0,0 +1,55 @@
+# encoding: utf-8
+
+module DineroMailIpn
+
+  # # Payment (IPN v1)
+  #
+  # Cada {ConsultaPagoResponse} puede tener 0 o muchos pagos,
+  # dependiendo del período. 
+  #
+  # Un pago puede tener muchos objetos de tipo {Item} describiendo los
+  # artículos pagados.
+  #
+  # Para acceder a estos objetos:
+  #
+  #     response.payments
+  #
+  # Para acceder a los atributos de cada pago: 
+  #
+  #     payment["Trx_Email"]
+  #     # ernesto@ombushop.com
+  #     payment["trx_id"]
+  #     # 12345441
+  #
+  # @see ConsultaPagoResponse#payments
+  class Payment
+
+    # @private
+    def initialize(hash)
+      @hash = hash
+    end
+
+    # Devuelve un {String} o nil
+    # @return [String]
+    def [](key)
+      @hash[key]
+    end
+
+    # Devuelve un {Array} de objetos tipo {Item}
+    # @return [Array]
+    def items
+      return @items if @items
+
+      @items = []
+
+      unless @hash["Items"].nil?
+        @hash["Items"].each do |key, hash|
+          @items << Item.new(hash)
+        end
+      end
+
+      return @items
+    end
+  end
+
+end

data/lib/dinero_mail_ipn/report.rb

@@ -0,0 +1,55 @@
+# encoding: UTF-8
+module DineroMailIpn
+
+  # # Reporte por transacción
+  #
+  # Nos dice el estado de la transacción, el ID y el monto de la misma.
+  #
+  # ## Posibles estados
+  #
+  # * Pendiente (Report::PENDING_STATUS)
+  # * Cancelado (Report::CANCELLED_STATUS)
+  # * Completado (Report::COMPLETED_STATUS)
+  #
+  class Report
+
+    # Posibles estados de transacciones
+    PENDING_STATUS = 1
+    COMPLETED_STATUS = 2
+    CANCELLED_STATUS = 3
+
+    attr_reader :id, :amount
+
+    # @param [Hash] opts opciones para crear la instancia
+    # @option opts [String] :id ID de transacción
+    # @option opts [String] :amount Monto de transacción (Por ej. "12.45")
+    # @option opts [String] :state Uno de los posibles estados
+    def initialize(opts)
+      @id = opts[:id]
+      @amount = opts[:amount]
+      @state = opts[:state]
+    end
+
+    # Devuelve true si la transacción fue completada
+    #
+    # @return [Boolean]
+    def transaction_completed?
+      @state == COMPLETED_STATUS
+    end
+
+    # Devuelve true si la transacción está pendiente
+    #
+    # @return [Boolean]
+    def transaction_pending?
+      @state == PENDING_STATUS
+    end
+
+    # Devuelve true si la transacción fue cancelada
+    #
+    # @return [Boolean]
+    def transaction_cancelled?
+      @state == CANCELLED_STATUS
+    end
+
+  end
+end

data/lib/dinero_mail_ipn/reporter.rb

@@ -0,0 +1,39 @@
+# encoding: UTF-8
+
+module DineroMailIpn
+  class Reporter
+
+    # Report status list
+    VALID_REPORT_STATUS = 1
+    MALFORMED_REPORT_STATUS = 2
+    INVALID_ACCOUNT_NUMBER_REPORT_STATUS = 3
+    INVALID_PASSWORD_REPORT_STATUS = 4
+    INVALID_REQUEST_TYPE_STATUS = 5
+    INVALID_TRANSACTION_ID_REQUEST_STATUS = 6
+    INVALID_PASSWORD_OR_ACCOUNT_NUMBER_REQUEST_STATUS = 7
+    TRANSACTION_NOT_FOUND_REQUEST_STATUS = 8
+
+    attr_reader :reports
+
+    def initialize(xml_response)
+      @doc = Nokogiri::XML(xml_response.downcase)
+      @reports = build_reports
+    end
+
+    def valid?
+      @doc.xpath("//estadoreporte").first.content.to_i == VALID_REPORT_STATUS
+    end
+
+    private
+
+    def build_reports
+      return [] if @doc.xpath("//operacion").empty?
+      @doc.xpath("//operacion").map do |report_xml|
+        DineroMailIpn::Report.new :id => report_xml.xpath("//id").first.content.to_i,
+                                  :amount => report_xml.xpath("//monto").first.content.to_i,
+                                  :state => report_xml.xpath("//estado").first.content.to_i 
+      end
+    end
+
+  end
+end

data/lib/dinero_mail_ipn/version.rb

@@ -1,3 +1,3 @@
 module DineroMailIpn
-  VERSION = "0.0.1"
+  VERSION = "1.0.1"
 end

data/test/fixtures/ConsultaPagoErrorBadCredentials.xml

@@ -0,0 +1,17 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<Report>
+  <Email>ernesto@ombushop.com</Email>
+  <Acount>17128254</Acount>
+  <Pin>AYCN7IXDTM</Pin>
+  <StartDate>20110620</StartDate>
+  <EndDate>20110703</EndDate>
+  <XML>1</XML>
+  <State>2</State>
+  <Pays />
+  <Collections />
+  <Tickets />
+  <Reception />
+  <Retreats />
+  <Credits />
+  <Debits />
+</Report>

data/test/fixtures/ConsultaPagoOkWithPays.xml

@@ -0,0 +1,42 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<Report>
+  <Email>ernesto@ombushop.com</Email>
+  <Acount>17128254</Acount>
+  <Pin>AYCN7IXDTM</Pin>
+  <StartDate>20110620</StartDate>
+  <EndDate>20110703</EndDate>
+  <XML>1</XML>
+  <State>1</State>
+  <Pays>
+    <Pay trx_id="R163000000">
+      <Trx_Date>2011-12-20 05:44:56</Trx_Date>
+      <Trx_NombreComprador>Juan Perez</Trx_NombreComprador>
+      <Trx_Email>juanperez@ombushop.com</Trx_Email> 
+      <Trx_Payment>108.00</Trx_Payment> 
+      <Trx_ShipAddress></Trx_ShipAddress> 
+      <Trx_Comment></Trx_Comment>
+      <Trx_MontoNeto>100.97</Trx_MontoNeto>
+      <Trx_SellerDocumentType>DNI</Trx_SellerDocumentType>
+      <Trx_SellerDocumentNumber>26.000.000</Trx_SellerDocumentNumber>
+      <Trx_Number>12345678</Trx_Number>
+      <Trx_PaymentMethod>Codigo de Barras</Trx_PaymentMethod>
+      <Trx_PaymentMean>Pago Facil</Trx_PaymentMean>
+      <Trx_BuyerDocumentType>DNI</Trx_BuyerDocumentType>
+      <Trx_BuyerDocumentNumber>26000000</Trx_BuyerDocumentNumber>
+      <Trx_BuyerPhone>+540351844232</Trx_BuyerPhone>
+      <Items>
+        <Item Item_Code="SKU123"> 
+          <Item_Quantity>1</Item_Quantity> 
+          <Item_Description>Zapatos de Cuero</Item_Description> 
+          <Item_Payment>68.00</Item_Payment>
+        </Item>
+      </Items>
+    </Pay>
+  </Pays> 
+  <Collections />
+  <Tickets />
+  <Reception />
+  <Retreats />
+  <Credits />
+  <Debits />
+</Report>

data/test/fixtures/ConsultaPagoOkWithoutCollections.xml

@@ -0,0 +1,17 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<Report>
+  <Email>ernesto@ombushop.com</Email>
+  <Acount>17128254</Acount>
+  <Pin>AYCN7IXDTM</Pin>
+  <StartDate>20110620</StartDate>
+  <EndDate>20110703</EndDate>
+  <XML>1</XML>
+  <State>1</State>
+  <Pays />
+  <Collections />
+  <Tickets />
+  <Reception />
+  <Retreats />
+  <Credits />
+  <Debits />
+</Report>

data/test/fixtures/ConsultaTransacciones1-2Success.xml

@@ -0,0 +1,50 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<REPORTE>
+  <ESTADOREPORTE>1</ESTADOREPORTE>
+  <DETALLE>
+    <OPERACIONES>
+      <OPERACION>
+        <ID>1</ID>
+        <FECHA>12/29/2011 7:38:00 PM</FECHA>
+        <ESTADO>2</ESTADO>
+        <COMPRADOR>
+          <EMAIL>email@customer.com</EMAIL>
+          <DIRECCION/>
+          <COMENTARIO/>
+        </COMPRADOR>
+        <MONTO>1010</MONTO>
+        <MONTONETO>510</MONTONETO>
+        <METODOPAGO>3</METODOPAGO>
+        <ITEMS>
+          <ITEM>
+            <DESCRIPCION>Camiseta amarilla</DESCRIPCION>
+            <MONEDA>1</MONEDA>
+            <PRECIOUNITARIO>1010</PRECIOUNITARIO>
+            <CANTIDAD>1</CANTIDAD>
+          </ITEM>
+        </ITEMS>
+      </OPERACION>
+      <OPERACION>
+        <ID>2</ID>
+        <FECHA>12/30/2011 17:38:00 PM</FECHA>
+        <ESTADO>2</ESTADO>
+        <COMPRADOR>
+          <EMAIL>other-email@other-customer.com</EMAIL>
+          <DIRECCION/>
+          <COMENTARIO/>
+        </COMPRADOR>
+        <MONTO>2000</MONTO>
+        <MONTONETO>710</MONTONETO>
+        <METODOPAGO>3</METODOPAGO>
+        <ITEMS>
+          <ITEM>
+            <DESCRIPCION>Sombrero rojo</DESCRIPCION>
+            <MONEDA>1</MONEDA>
+            <PRECIOUNITARIO>1000</PRECIOUNITARIO>
+            <CANTIDAD>2</CANTIDAD>
+          </ITEM>
+        </ITEMS>
+      </OPERACION>
+    </OPERACIONES>
+  </DETALLE>
+</REPORTE>

data/test/fixtures/ConsultaTransacciones1Success.xml

@@ -0,0 +1,29 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<REPORTE>
+  <ESTADOREPORTE>1</ESTADOREPORTE>
+  <DETALLE>
+    <OPERACIONES>
+      <OPERACION>
+        <ID>1</ID>
+        <FECHA>12/29/2011 7:38:00 PM</FECHA>
+        <ESTADO>2</ESTADO>
+        <COMPRADOR>
+          <EMAIL>email@customer.com</EMAIL>
+          <DIRECCION/>
+          <COMENTARIO/>
+        </COMPRADOR>
+        <MONTO>1010</MONTO>
+        <MONTONETO>510</MONTONETO>
+        <METODOPAGO>3</METODOPAGO>
+        <ITEMS>
+          <ITEM>
+            <DESCRIPCION>Camiseta amarilla</DESCRIPCION>
+            <MONEDA>1</MONEDA>
+            <PRECIOUNITARIO>1010</PRECIOUNITARIO>
+            <CANTIDAD>1</CANTIDAD>
+          </ITEM>
+        </ITEMS>
+      </OPERACION>
+    </OPERACIONES>
+  </DETALLE>
+</REPORTE>

data/test/helper.rb

@@ -0,0 +1,31 @@
+require 'test/unit'
+require 'shoulda'
+require 'fakeweb'
+require File.expand_path('../../lib/dinero_mail_ipn', __FILE__)
+
+FakeWeb.allow_net_connect = false
+
+def fixture_file(filename)
+  return '' if filename == ''
+  file_path = File.expand_path(File.dirname(__FILE__) + '/fixtures/' + filename)
+  File.read(file_path)
+end
+
+def dinero_mail_url(path, options = {})
+  options[:https] = true if options[:https].nil?
+  options[:country] ||= 'argentina'
+  protocol = (options[:https] == true) ? 'https' : 'http'
+  "#{protocol}://#{options[:country]}.dineromail.com#{path}"
+end
+
+def stub_get(path, filename, options={})
+  opts = {:body => fixture_file(filename)}.merge(options)
+
+  FakeWeb.register_uri(:get, dinero_mail_url(path), opts)
+end
+
+def stub_post(path, filename, options={})
+  opts = {:body => fixture_file(filename)}.merge(options)
+
+  FakeWeb.register_uri(:post, dinero_mail_url(path, options[:url]), opts)
+end

data/test/test_dinero_mail_ipn.rb

@@ -0,0 +1,83 @@
+# encoding: utf-8
+require File.expand_path('../helper', __FILE__)
+
+class TestDineroMailIpn < Test::Unit::TestCase
+
+  context "when I query the Dinero Mail API via GET" do
+
+    should "return OK for the query with valid Pin and Account parameters" do
+      stub_get("/vender/ConsultaPago.asp?XML=1&Acount=17128254&Pin=AYCN7IXDTM&Email=ernesto%40ombushop.com&StartDate=20110702&EndDate=20110703",
+               "ConsultaPagoOkWithoutCollections.xml")
+      client = DineroMailIpn::Client.new(:email => 'ernesto@ombushop.com',
+                                          :account => '17128254',
+                                          :pin => 'AYCN7IXDTM')
+      response = client.consulta_pago(Date.new(2011,7,2), Date.new(2011,7,3))
+      assert_equal response.state, "1"
+      assert response.ok?
+      assert_equal response.state_description, "La consulta se realizó correctamente"
+    end
+
+    should "return OK with a collection of payments" do
+      stub_get("/vender/ConsultaPago.asp?XML=1&Acount=17128254&Pin=AYCN7IXDTM&Email=ernesto%40ombushop.com&StartDate=20110702&EndDate=20110703",
+         "ConsultaPagoOkWithPays.xml")
+      client = DineroMailIpn::Client.new(:email => 'ernesto@ombushop.com',
+                                          :account => '17128254',
+                                          :pin => 'AYCN7IXDTM')
+      response = client.consulta_pago(Date.new(2011,7,2), Date.new(2011,7,3))
+      assert_equal response.state, "1"
+      assert response.ok?
+      assert_equal response.state_description, "La consulta se realizó correctamente"
+      assert !response.payments.empty?
+      payment = response.payments.first
+      assert_equal payment["Trx_Email"], "juanperez@ombushop.com"
+      assert_equal payment["trx_id"], "R163000000"
+      assert payment["Trx_Numbr"].nil?
+      assert !payment.items.empty?
+      item = payment.items.first
+      assert_equal item["Item_Code"], "SKU123"
+      assert_equal item["Item_Payment"], "68.00"
+      assert item["item_quantity"].nil?
+    end
+
+    should "return Error for the query" do
+      stub_get("/vender/ConsultaPago.asp?XML=1&Acount=123&Pin=UasdM&Email=ernesto%40ombushop.com&StartDate=20110702&EndDate=20110703",
+               "ConsultaPagoErrorBadCredentials.xml")
+      client = DineroMailIpn::Client.new(:email => 'ernesto@ombushop.com',
+                                         :account => '123',
+                                         :pin => 'UasdM')
+      response = client.consulta_pago(Date.new(2011,7,2), Date.new(2011,7,3))
+      assert_equal response.state, "2"
+      assert response.error?
+      assert_equal response.state_description, "Los valores son incorrectos para realizar la consulta"
+    end
+
+  end
+
+  context "when I query for some transactions" do
+
+    should "return a new report object" do
+      stub_post("/Vender/Consulta_IPN.asp", "ConsultaTransacciones1-2Success.xml",
+                  {:url => {:https => false}})
+
+      client = DineroMailIpn::Client.new(:password => 'fuckingipnpasswordinplaintext', :account => '17128254')
+      reporter = client.consulta_transacciones([1,2])
+      assert reporter.kind_of?(DineroMailIpn::Reporter)
+      assert_equal 2, reporter.reports.size
+    end
+
+  end
+
+  context "when I query for a transactions" do
+
+    should "return a new report object" do
+      stub_post("/Vender/Consulta_IPN.asp", "ConsultaTransacciones1Success.xml",
+                  {:url => {:https => false}})
+
+      client = DineroMailIpn::Client.new(:password => 'fuckingipnpasswordinplaintext', :account => '17128254')
+      reporter = client.consulta_transacciones([1])
+      assert reporter.kind_of?(DineroMailIpn::Reporter)
+      assert_equal 1, reporter.reports.size
+    end
+
+  end
+end

data/test/test_report.rb

@@ -0,0 +1,32 @@
+# encoding: utf-8
+
+require File.expand_path('../helper', __FILE__)
+
+class TestDineromailIpnReport < Test::Unit::TestCase
+
+  def test_report_id
+    report = DineroMailIpn::Report.new(:id => 33)
+    assert_equal 33, report.id
+  end
+
+  def test_report_amount
+    report = DineroMailIpn::Report.new(:amount => 3003)
+    assert_equal 3003, report.amount
+  end
+
+  def test_transaction_completed?
+    report = DineroMailIpn::Report.new(:state => 2)
+    assert report.transaction_completed?
+  end
+
+  def test_transaction_pending?
+    report = DineroMailIpn::Report.new(:state => 1)
+    assert report.transaction_pending?
+  end
+
+  def test_transaction_cancelled?
+    report = DineroMailIpn::Report.new(:state => 3)
+    assert report.transaction_cancelled?
+  end
+
+end

data/test/test_reporter.rb

@@ -0,0 +1,56 @@
+# encoding: utf-8
+
+require File.expand_path('../helper', __FILE__)
+
+class TestDineromailIpnReporter < Test::Unit::TestCase
+
+  def test_invalid_report_should_return_invalid
+    xml_response = <<-XML
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<REPORTE>
+  <ESTADOREPORTE>2</ESTADOREPORTE>
+</REPORTE>
+XML
+    reporter = DineroMailIpn::Reporter.new(xml_response)
+    assert !reporter.valid?
+  end
+
+  def test_invalid_report_should_has_no_reports
+    xml_response = <<-XML
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<REPORTE>
+  <ESTADOREPORTE>2</ESTADOREPORTE>
+</REPORTE>
+XML
+    reporter = DineroMailIpn::Reporter.new(xml_response)
+    assert reporter.reports.empty?
+  end
+
+  def test_valid_report_should_be_valid
+    xml_response = <<-XML
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<REPORTE>
+<ESTADOREPORTE>1</ESTADOREPORTE>
+</REPORTE>
+XML
+    reporter = DineroMailIpn::Reporter.new(xml_response)
+    assert reporter.valid?
+  end
+
+  def test_reports_should_be_created_from_multiple_reports_response
+    xml_response = fixture_file("ConsultaTransacciones1-2Success.xml")
+    reporter = DineroMailIpn::Reporter.new(xml_response)
+    assert_equal 2, reporter.reports.size
+    assert reporter.reports.kind_of?(Array)
+    assert reporter.reports.first.kind_of?(DineroMailIpn::Report)
+  end
+
+  def test_reports_should_be_created_from_single_report_response
+    xml_response = fixture_file("ConsultaTransacciones1Success.xml")
+    reporter = DineroMailIpn::Reporter.new(xml_response)
+    assert_equal 1, reporter.reports.size
+    assert reporter.reports.kind_of?(Array)
+    assert reporter.reports.first.kind_of?(DineroMailIpn::Report)
+  end
+
+end

metadata

@@ -1,105 +1,144 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: dinero_mail_ipn
-version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 0
-  - 1
-  version: 0.0.1
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Ernesto Tagwerker
 - Esteban Pastorino
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-04-19 00:00:00 -03:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-01-16 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: httparty
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &2804470 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        - 7
-        - 6
-        version: 0.7.6
+      - !ruby/object:Gem::Version
+        version: 0.8.1
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: nokogiri
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *2804470
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: &2804220 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 1
-        - 4
-        - 4
-        version: 1.4.4
+      - !ruby/object:Gem::Version
+        version: 1.5.0
   type: :runtime
-  version_requirements: *id002
+  prerelease: false
+  version_requirements: *2804220
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: &2819840 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.11.3
+  type: :development
+  prerelease: false
+  version_requirements: *2819840
+- !ruby/object:Gem::Dependency
+  name: fakeweb
+  requirement: &2819610 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+  type: :development
+  prerelease: false
+  version_requirements: *2819610
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: &2819380 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.4
+  type: :development
+  prerelease: false
+  version_requirements: *2819380
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: &2819150 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+  type: :development
+  prerelease: false
+  version_requirements: *2819150
 description: Dinero Mail IPN stub
-email: 
+email:
 - ernesto@etagwerker.com
 - kito@pinggers.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
+- .rvmrc
+- .yardopts
 - Gemfile
 - Gemfile.lock
 - MIT-LICENSE
-- README.rdoc
+- README.markdown
 - Rakefile
 - dinero_mail_ipn.gemspec
 - lib/dinero_mail_ipn.rb
+- lib/dinero_mail_ipn/consulta_pago_response.rb
+- lib/dinero_mail_ipn/item.rb
+- lib/dinero_mail_ipn/malformed_response_error.rb
+- lib/dinero_mail_ipn/payment.rb
+- lib/dinero_mail_ipn/report.rb
+- lib/dinero_mail_ipn/reporter.rb
 - lib/dinero_mail_ipn/version.rb
+- resources/IPN_es.pdf
 - script/console
-has_rdoc: true
-homepage: ""
+- test/fixtures/ConsultaPagoErrorBadCredentials.xml
+- test/fixtures/ConsultaPagoOkWithPays.xml
+- test/fixtures/ConsultaPagoOkWithoutCollections.xml
+- test/fixtures/ConsultaTransacciones1-2Success.xml
+- test/fixtures/ConsultaTransacciones1Success.xml
+- test/helper.rb
+- test/test_dinero_mail_ipn.rb
+- test/test_report.rb
+- test/test_reporter.rb
+homepage: ''
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: dinero_mail_ipn
-rubygems_version: 1.3.7
+rubygems_version: 1.7.2
 signing_key: 
 specification_version: 3
 summary: Dinero Mail IPN gem
-test_files: []
-
+test_files:
+- test/helper.rb
+- test/test_dinero_mail_ipn.rb
+has_rdoc: 

data/README.rdoc

@@ -1,17 +0,0 @@
-= Dinero Mail IPN Gem
-
-Sirve para consumir los metodos de IPN 1 y IPN 2. 
-
-Por ejemplo: 
-
-  #IPN v1
-  c = DineroMailIpn::Client.new(:email => 'EMAILPRUEBA@gmail.com', :account => '09813581', :pin => 'URJYRLU2PP')
-  c.consulta_pago(before,now) # before y now son Dates
-  #Response
-  {"Report"=>{"Email"=>"EMAILPRUEBA@gmail.com", "Acount"=>"09813581", "Pin"=>"URJYRLU2PP", "StartDate"=>"20110419", "EndDate"=>"20110419", "XML"=>"1", "State"=>"2", "Pays"=>nil, "Collections"=>nil, "Tickets"=>nil, "Reception"=>nil, "Retreats"=>nil, "Credits"=>nil, "Debits"=>nil}} 
-
-  #IPN v2
-  c = DineroMailIpn::Client.new(:account => '09813581', :password => 'mipassword)
-  c.consulta_transacciones("31548", "XA5547")
-  #Response
-  {"REPORTE"=>{"ESTADOREPORTE"=>"8", "DETALLE"=>{"OPERACIONES"=>nil}}}