dinero_mail_ipn 2.0.2 → 2.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 86a5daf19ae3051243508551acaaa0df154eff0b
+  data.tar.gz: 316610cca775592917f263de02e8d6478f9ce601
+SHA512:
+  metadata.gz: f0756f106663c222b22af7408dfda1709f121808c105c56d38554cfe02c3687c82822b3ec053c30fcade005251d4c86fa98da96d0a8b1d57bf5f6fac89115fc6
+  data.tar.gz: b5704a6e945df2151ccb6351cf41c15dec9bf910538aa4055e9f9b2b8d3353fe0a44917e40ed23dc53d580ab81d74adb7ac19681f226c7958a629a5f6836c229

data/.gitignore

@@ -1,6 +1,9 @@
+# RVM or rbenv
+.ruby-version
+.rvmrc
+
 pkg/*
 *.gem
 .bundle
 .yardoc
-.rvmrc
 doc

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 1.9.3

data/Gemfile

@@ -1,3 +1,3 @@
-source :rubygems
+source 'https://rubygems.org'
 
 gemspec

data/Gemfile.lock

@@ -1,24 +1,24 @@
 PATH
   remote: .
   specs:
-    dinero_mail_ipn (2.0.2)
+    dinero_mail_ipn (2.0.3)
       chronic
       httparty (~> 0.8.1)
       nokogiri (~> 1.5.0)
 
 GEM
-  remote: http://rubygems.org/
+  remote: https://rubygems.org/
   specs:
-    chronic (0.8.0)
+    chronic (0.10.2)
     coderay (1.0.8)
     fakeweb (1.3.0)
-    httparty (0.8.1)
-      multi_json
+    httparty (0.8.3)
+      multi_json (~> 1.0)
       multi_xml
     method_source (0.8.1)
-    multi_json (1.0.4)
-    multi_xml (0.4.1)
-    nokogiri (1.5.0)
+    multi_json (1.10.1)
+    multi_xml (0.5.5)
+    nokogiri (1.5.11)
     pry (0.9.10)
       coderay (~> 1.0.5)
       method_source (~> 0.8)

data/README.markdown

@@ -1,4 +1,6 @@
-# Dinero Mail IPN Gem
+# Dinero Mail IPN
+
+[![Build Status](https://travis-ci.org/etagwerker/dinero_mail_ipn.png?branch=master)](https://travis-ci.org/etagwerker/dinero_mail_ipn) [![Code Climate](https://codeclimate.com/github/etagwerker/dinero_mail_ipn.png)](https://codeclimate.com/github/etagwerker/dinero_mail_ipn)
 
 Ruby gem para consumir los métodos de IPN 1 y IPN 2 de [Dinero
 Mail](http://dineromail.com)
@@ -17,15 +19,15 @@ Mail](http://dineromail.com)
 
 ### IPN v1
 
-Consulta de pagos en períodos de una semana. 
+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", 
+    # "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? 
+    response.ok?
     # true
     response.state_description
     # "La consulta se realizó correctamente"
@@ -60,8 +62,6 @@ Si falta algo, por favor reportarlo como issue.
 
 ## Patches/Pull Requests
 
-Lo de siempre. 
-
 Fork the project.
 
 Make your feature addition or bug fix.
@@ -74,4 +74,10 @@ Send me a pull request. Bonus points for topic branches.
 
 ## Licencia
 
-Dinero Mail IPN is released under the MIT license.
+Copyright (c) 2014 Ernesto Tagwerker
+
+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/lib/dinero_mail_ipn.rb

@@ -8,6 +8,14 @@ Dir[File.join(File.dirname(__FILE__),'dinero_mail_ipn', '*')].each {|file| requi
 
 module DineroMailIpn
 
+  def self.root_path
+    File.expand_path("../..", __FILE__)
+  end
+
+  def self.resources_path
+    File.expand_path(File.join(self.root_path, "resources"))
+  end
+
   # # Cliente para Dinero Mail API (v1 y v2)
   #
   # Cliente para consumir los métodos de la API IPN v1 y v2.

data/lib/dinero_mail_ipn/consulta_pago_response.rb

@@ -68,14 +68,16 @@ module DineroMailIpn
 
       @payments = []
       begin
-        pays = self.dm_hash["Report"]["Pays"]["Pay"]
+        if dm_hash["Report"]["Pays"]
+          pays = dm_hash["Report"]["Pays"]["Pay"]
 
-        if pays
-          case pays.class.name
-          when "Hash"
-            @payments << Payment.new(pays)
-          when "Array"
-            pays.each { |pay| @payments << Payment.new(pay) }
+          if pays
+            case pays.class.name
+            when "Hash"
+              @payments << Payment.new(pays)
+            when "Array"
+              pays.each { |pay| @payments << Payment.new(pay) }
+            end
           end
         end
       rescue Exception => e

data/lib/dinero_mail_ipn/notification_parser.rb

@@ -0,0 +1,76 @@
+module DineroMailIpn
+  class NotificationParser
+    attr_reader :doc
+
+    # @param [String] XML file containing DM IPNv2 operations.
+    # @param [Hash] a Hash of optional parameters.
+    def initialize(xml_file, options = {})
+      raise ArgumentError, "No XML provided" if xml_file.nil?
+
+      @xsd = Nokogiri::XML::Schema(xsd_file('notifications.xsd'))
+      @doc = Nokogiri::XML(xml_file.downcase)
+    end
+
+    # Parses the XML notification POSTed by DineroMail IPNv2
+    # notification system.
+    #
+    # @return [DineroMailIpn::Notification] a parsed Notification
+    def parse
+      return unless valid?
+
+      type = @doc.xpath("//tiponotificacion").text
+
+      operations = @doc.xpath("//operacion").inject([]) do |result, operation|
+        result << [operation.xpath('tipo').text, operation.xpath('id').text]
+        result
+      end
+
+      notification = Notification.new(type, operations)
+
+      notification
+    end
+
+    # Checks that the XML document is valid.
+    #
+    # @return [Boolean]
+    def valid?
+      @xsd.valid?(@doc)
+    end
+
+    # Retrieves an [Array] of [Nokogiri::XML::Schema::SyntaxError]
+    # with the XML document errors.
+    #
+    # @return [Array] list of errors found on the XML document
+    def validate
+      @xsd.validate(@doc)
+    end
+
+    private
+
+    # Locates an XSD file.
+    #
+    # @param filename [String] the XSD filename
+    def xsd_file(filename)
+      xsd_file_location = File.join(DineroMailIpn.resources_path, "/validation/xsd/#{filename}")
+      xsd_file = File.read(xsd_file_location)
+      xsd_file
+    end
+  end
+
+  class Notification
+    attr_accessor :type, :operations
+
+    def initialize(type, raw_operations, options = {})
+      raise ArgumentError, "No operations received" if (raw_operations.empty? || raw_operations.nil?)
+
+      @operations = raw_operations.inject([]) do |result, (type, id)|
+        result << Operation.new(type, id)
+        result
+      end
+
+      @type = type
+    end
+  end
+
+  class Operation < Struct.new(:type, :id); end
+end

data/lib/dinero_mail_ipn/report.rb

@@ -28,7 +28,7 @@ module DineroMailIpn
     def initialize(opts)
       @id = opts[:id]
       @amount = opts[:amount]
-      @state = opts[:state]
+      @state = opts[:state].to_i
       @payer_email = opts[:payer_email]
       @numtransaction = opts[:numtransaction]
       @date          = opts[:date]

data/lib/dinero_mail_ipn/version.rb

@@ -1,3 +1,3 @@
 module DineroMailIpn
-  VERSION = "2.0.2"
+  VERSION = "2.0.3"
 end

data/resources/validation/xsd/notifications.xsd

@@ -0,0 +1,23 @@
+<xs:schema attributeFormDefault="unqualified" elementFormDefault="qualified" xmlns:xs="http://www.w3.org/2001/XMLSchema">
+  <xs:element name="notificacion">
+    <xs:complexType>
+      <xs:sequence>
+        <xs:element name="tiponotificacion"/>
+        <xs:element name="operaciones">
+          <xs:complexType>
+            <xs:sequence>
+              <xs:element name="operacion" maxOccurs="unbounded" minOccurs="0">
+                <xs:complexType>
+                  <xs:sequence>
+                    <xs:element type="xs:string" name="tipo"/>
+                    <xs:element type="xs:string" name="id"/>
+                  </xs:sequence>
+                </xs:complexType>
+              </xs:element>
+            </xs:sequence>
+          </xs:complexType>
+        </xs:element>
+      </xs:sequence>
+    </xs:complexType>
+  </xs:element>
+</xs:schema>

data/test/fixtures/ipn-v2-notification.xml

@@ -0,0 +1,13 @@
+<notificacion>
+  <tiponotificacion>1</tiponotificacion>
+  <operaciones>
+    <operacion>
+      <tipo>1</tipo>
+      <id>31548</id>
+    </operacion>
+    <operacion>
+      <tipo>1</tipo>
+      <id>XA5547</id>
+    </operacion>
+  </operaciones>
+</notificacion>

data/test/fixtures/malformed-ipn-v2-notification.xml

@@ -0,0 +1,13 @@
+<lanotificacion>
+  <tiponotificacion>1</tiponotificacion>
+  <ops>
+    <operacion>
+      <tipo>1</tipo>
+      <id>31548</id>
+    </operacion>
+    <operacion>
+      <type>1</type>
+      <id>XA5547</id>
+    </operacion>
+  </ops>
+</lanotificacion>

data/test/helper.rb

@@ -5,12 +5,22 @@ require File.expand_path('../../lib/dinero_mail_ipn', __FILE__)
 
 FakeWeb.allow_net_connect = false
 
+# Reads a fixture file from /test/fixtures/
+# 
+# @param [String] File name with extension
+# @return [File]
 def fixture_file(filename)
   return '' if filename == ''
   file_path = File.expand_path(File.dirname(__FILE__) + '/fixtures/' + filename)
   File.read(file_path)
 end
 
+# Translates a relative path into a 
+# absolute URL.
+# 
+# @param [String] Relative path
+# @param [Hash] Options: :https => true, :country => 'chile'
+# @return [String] Absolute URL
 def dinero_mail_url(path, options = {})
   options[:https] = true if options[:https].nil?
   options[:country] ||= 'argentina'
@@ -18,12 +28,24 @@ def dinero_mail_url(path, options = {})
   "#{protocol}://#{options[:country]}.dineromail.com#{path}"
 end
 
+# Stubs a GET request for the relative path,
+# using the fixture file.
+# 
+# @param [String] Relative path
+# @param [String] Fixture file name
+# @param [Hash] Options for FakeWeb.register_uri
 def stub_get(path, filename, options={})
   opts = {:body => fixture_file(filename)}.merge(options)
 
   FakeWeb.register_uri(:get, dinero_mail_url(path), opts)
 end
 
+# Stubs a POST request for the relative path,
+# using the fixture file.
+# 
+# @param [String] Relative path
+# @param [String] Fixture file name
+# @param [Hash] Options for FakeWeb.register_uri
 def stub_post(path, filename, options={})
   opts = {:body => fixture_file(filename)}.merge(options)
 

data/test/test_dinero_mail_ipn.rb

@@ -19,7 +19,7 @@ class TestDineroMailIpn < Test::Unit::TestCase
 
     should "return OK with 1 payment" do
       stub_get("/vender/ConsultaPago.asp?XML=1&Acount=17128254&Pin=AYCN7IXDTM&Email=ernesto%40ombushop.com&StartDate=20110702&EndDate=20110703",
-         "ConsultaPagoOKWith1Pay.xml")
+         "ConsultaPagoOkWith1Pay.xml")
       client = DineroMailIpn::Client.new(:email => 'ernesto@ombushop.com',
                                           :account => '17128254',
                                           :pin => 'AYCN7IXDTM')

data/test/test_notification_parser.rb

@@ -0,0 +1,64 @@
+# encoding: utf-8
+
+require File.expand_path("../helper", __FILE__)
+
+class TestDineroMailIpnNotificationParser < Test::Unit::TestCase
+  def setup
+    @xml_file = fixture_file("ipn-v2-notification.xml")
+    @bad_xml_file = fixture_file("malformed-ipn-v2-notification.xml")
+  end
+
+  context "initialization" do
+    should "fail when no XML is provided" do
+      assert_raise ArgumentError do
+        DineroMailIpn::NotificationParser.new
+      end
+    end
+
+    should "fail when an invalid XML is provided" do
+      notification_parser = DineroMailIpn::NotificationParser.new(@bad_xml_file)
+
+      assert !notification_parser.valid?
+    end
+
+    should "pass when a valid XML is provided" do
+      notification_parser = DineroMailIpn::NotificationParser.new(@xml_file)
+
+      assert notification_parser.doc.kind_of? Nokogiri::XML::Document
+      assert notification_parser.valid?
+    end
+  end
+
+  context "retrieving notified operations" do
+    context "from a valid XML notification" do
+      should "retrieve all valid notified operations" do
+        notification_parser = DineroMailIpn::NotificationParser.new(@xml_file)
+
+        notification = notification_parser.parse
+
+        operations = notification.operations
+
+        assert operations.is_a? Array
+        assert_equal operations.size, 2
+      end
+    end
+
+    context "from an invalid XML notification" do
+      should "return nothing if XML is invalid" do
+        notification_parser = DineroMailIpn::NotificationParser.new(@bad_xml_file)
+        notification = notification_parser.parse
+
+        assert_nil notification
+      end
+
+      should "return a list of errors for that invalid XML" do
+        notification_parser = DineroMailIpn::NotificationParser.new(@bad_xml_file)
+
+        errors = notification_parser.validate
+        error_message = errors.map(&:message).first
+
+        assert error_message =~ /No matching global declaration available for the validation root/
+      end
+    end
+  end
+end

data/test/test_report.rb

@@ -17,16 +17,22 @@ class TestDineromailIpnReport < Test::Unit::TestCase
   def test_transaction_completed?
     report = DineroMailIpn::Report.new(:state => 2)
     assert report.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?
+    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?
+    report = DineroMailIpn::Report.new(:state => "3")
+    assert report.transaction_cancelled?
   end
 
 end

metadata

@@ -1,8 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dinero_mail_ipn
 version: !ruby/object:Gem::Version
-  version: 2.0.2
-  prerelease: 
+  version: 2.0.3
 platform: ruby
 authors:
 - Ernesto Tagwerker
@@ -10,150 +9,132 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-16 00:00:00.000000000 Z
+date: 2014-06-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.8.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.8.1
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.5.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.5.0
 - !ruby/object:Gem::Dependency
   name: chronic
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: shoulda
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.11.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.11.3
 - !ruby/object:Gem::Dependency
   name: fakeweb
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.3.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.3.0
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.7.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.7.4
 - !ruby/object:Gem::Dependency
   name: redcarpet
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.0.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.0.1
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Dinero Mail IPN stub
@@ -164,9 +145,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rvmrc.sample
-- .yardopts
+- ".gitignore"
+- ".rvmrc.sample"
+- ".travis.yml"
+- ".yardopts"
 - Gemfile
 - Gemfile.lock
 - MIT-LICENSE
@@ -177,11 +159,13 @@ files:
 - 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/notification_parser.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
+- resources/validation/xsd/notifications.xsd
 - script/console
 - test/fixtures/ConsultaPagoErrorBadCredentials.xml
 - test/fixtures/ConsultaPagoOKWith2Pays.xml
@@ -189,39 +173,35 @@ files:
 - test/fixtures/ConsultaPagoOkWithoutCollections.xml
 - test/fixtures/ConsultaTransacciones1-2Success.xml
 - test/fixtures/ConsultaTransacciones1Success.xml
+- test/fixtures/ipn-v2-notification.xml
+- test/fixtures/malformed-ipn-v2-notification.xml
 - test/helper.rb
 - test/test_dinero_mail_ipn.rb
+- test/test_notification_parser.rb
 - test/test_report.rb
 - test/test_reporter.rb
 homepage: ''
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -2281383812012634155
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -2281383812012634155
 requirements: []
 rubyforge_project: dinero_mail_ipn
-rubygems_version: 1.8.24
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Dinero Mail IPN gem
 test_files:
 - test/helper.rb