dineromail 0.0.4 → 0.1.0

data/README.rdoc

@@ -0,0 +1,49 @@
+= Dineromail / Rails
+
+Dineromail is an unofficial library for interacting with the Dineromail payment api.
+
+== Getting Started
+
+Dineromail is released as a Ruby Gem. The gem is to be installed within a Ruby
+on Rails 3 application. To install, simply add the following to your Gemfile:
+
+  # Gemfile
+  gem 'dineromail'
+
+== General Configuration
+
+You need to create a config file (config/initializers/dineromail.rb) with:
+
+    Dineromail.configure do |config|
+      config.pay_methods = '' #All the available methods
+      config.account_number = 'your_account_number'
+      config.password = 'your_password'
+      config.logo_url = 'http://my-web.com/images/logo.png'
+      config.return_url = 'http://my-web.com/success'
+      config.error_url = 'http://my-web.com/error'
+      config.currency = Dineromail::Configuration::PESO
+      config.ipn_webservice_url = 'https://argentina.dineromail.com/Vender/Consulta_IPN.asp'
+      config.payment_url = 'https://argentina.dineromail.com/Shop/Shop_Ingreso.asp'
+      config.button_image_url = 'https://argentina.dineromail.com/imagenes/vender/boton/comprar-gris.gif'
+    end
+
+== Example rails controller
+
+    class DineromailController < ApplicationController
+      def ipn
+        notifications = Dineromail::Notification.parse(params[:Notificacion])
+        notifications.each do |notify|
+          if notify.valid_report? && notify.completed?
+            order = Order.find(notify.transaction_id)
+            #Allways check the amount
+            order.success = order.amount == notify.amount ? 'success' : 'failure'
+            order.save
+          end
+        end
+        render :nothing => true
+      end
+    end
+
+== Example dineromail forward page
+
+    <%= dineromail_button('Item name',price,:transaction_id => @transaction_id) %>

data/dineromail.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |s|
   s.summary     = %q{Dineromail library for Rails}
   s.description = %q{Integration with dineromail plataform for rails projects}
   
-  s.add_dependency "xml-simple"
+  s.add_dependency "happymapper"
   s.add_dependency "httparty"
   s.add_dependency "rails", ["~> 3.0"]
   s.add_development_dependency "bundler"

data/lib/dineromail.rb

@@ -1,8 +1,9 @@
 require 'dineromail/version'
 require 'dineromail/notification'
-require 'dineromail/status_report'
 require 'dineromail/buyer'
+require 'dineromail/operation'
 require 'dineromail/item'
+require 'dineromail/status_report'
 require 'dineromail/configuration'
 require 'dineromail/app/helpers/dineromail_helper'
 require 'action_controller'
@@ -11,7 +12,7 @@ module Dineromail
   self.configure do |config|
     #Default confiuration
     config.ipn_webservice_url = 'https://argentina.dineromail.com/Vender/Consulta_IPN.asp'
-    config.currency = 1
+    config.currency = Configuration::PESO
     config.pay_methods = '' #Todos
     config.payment_url = 'https://argentina.dineromail.com/Shop/Shop_Ingreso.asp'
     config.button_image_url = 'https://argentina.dineromail.com/imagenes/vender/boton/comprar-gris.gif'

data/lib/dineromail/app/helpers/dineromail_helper.rb

@@ -1,14 +1,16 @@
 module DineromailHelper
  
-  def dineromail_form(item_name,amount,options = {})
+  def dineromail_button(item_name,amount,options = {})
     options = options.symbolize_keys
     button_image_url = options.delete(:button_image_url) || Dineromail.configuration.button_image_url
     payment_url = options.delete(:payment_url) || Dineromail.configuration.payment_url
     form_options = options.delete(:form) || {}
     form_options[:action] = payment_url
     content_tag(:form, form_options ) do
-      dineromail_inputs(item_name,amount,options) +
-      content_tag(:input,nil, :type => 'image', :src => button_image_url, :border => '0', :name=> 'submit', :alt=>'Pagar con Dineromail' )
+      ''.tap do |html|
+        html << dineromail_inputs(item_name,amount,options)
+        html << content_tag(:input,nil, :type => 'image', :src => button_image_url, :border => '0', :name=> 'submit', :alt=>'Pagar con Dineromail' )
+      end
     end
   end
   
@@ -25,19 +27,19 @@ module DineromailHelper
     transaction_id = options[:transaction_id]
     item_number = options[:item_number]
     
-    html = content_tag(:input,nil, :type => 'hidden', :name => 'NombreItem', :value =>item_name)
-    html += content_tag(:input,nil, :type => 'hidden', :name => 'TipoMoneda', :value =>currency)
-    html += content_tag(:input,nil, :type => 'hidden', :name => 'PrecioItem', :value =>amount)
-    html += content_tag(:input,nil, :type => 'hidden', :name => 'E_Comercio', :value =>account_number)
-    html += content_tag(:input,nil, :type => 'hidden', :name => 'image_url', :value =>logo_url)
-    html += content_tag(:input,nil, :type => 'hidden', :name => 'DireccionExito', :value => return_url)
-    html += content_tag(:input,nil, :type => 'hidden', :name => 'DireccionFracaso', :value => error_url)
-    html += content_tag(:input,nil, :type => 'hidden', :name => 'Mensaje', :value => message)
-    html += content_tag(:input,nil, :type => 'hidden', :name => 'MediosPago', :value => pay_methods)
-    html += content_tag(:input,nil, :type => 'hidden', :name => 'NroItem', :value => item_number) if item_number
-    html += content_tag(:input,nil, :type => 'hidden', :name => 'TRX_ID', :value => transaction_id) if transaction_id
-    
-    html
+    ''.tap do |html|
+      html << content_tag(:input,nil, :type => 'hidden', :name => 'NombreItem', :value =>item_name)
+      html << content_tag(:input,nil, :type => 'hidden', :name => 'TipoMoneda', :value =>currency)
+      html << content_tag(:input,nil, :type => 'hidden', :name => 'PrecioItem', :value =>amount)
+      html << content_tag(:input,nil, :type => 'hidden', :name => 'E_Comercio', :value =>account_number)
+      html << content_tag(:input,nil, :type => 'hidden', :name => 'image_url', :value =>logo_url)
+      html << content_tag(:input,nil, :type => 'hidden', :name => 'DireccionExito', :value => return_url)
+      html << content_tag(:input,nil, :type => 'hidden', :name => 'DireccionFracaso', :value => error_url)
+      html << content_tag(:input,nil, :type => 'hidden', :name => 'Mensaje', :value => message)
+      html << content_tag(:input,nil, :type => 'hidden', :name => 'MediosPago', :value => pay_methods)
+      html << content_tag(:input,nil, :type => 'hidden', :name => 'NroItem', :value => item_number) if item_number
+      html << content_tag(:input,nil, :type => 'hidden', :name => 'TRX_ID', :value => transaction_id) if transaction_id
+    end
   end  
   
   

data/lib/dineromail/buyer.rb

@@ -1,12 +1,15 @@
 module Dineromail
   class Buyer
-    attr_accessor :email, :address, :name, :phone, :document_type, :document_number, :comment
+    include HappyMapper
     
-    def initialize(attributes = {})
-      attributes.each do |name, value|
-        send("#{name}=", value)
-      end
-    end
+    tag 'COMPRADOR'
+    element :email, String, :tag => 'EMAIL'
+    element :address, String, :tag => 'DIRECCION'
+    element :name, String, :tag => 'NOMBRE'
+    element :phone, String, :tag => 'TELEFONO'
+    element :document_type, String, :tag => 'TIPODOC'
+    element :document_number, String, :tag => 'NUMERODOC'
+    element :comment, String, :tag => 'COMENTARIO'
     
   end
 end

data/lib/dineromail/configuration.rb

@@ -2,6 +2,9 @@ module Dineromail
   class Configuration
     attr_accessor :payment_url, :ipn_webservice_url, :account_number, :password,
               :logo_url, :return_url, :error_url, :pay_methods, :currency, :button_image_url
+            
+    PESO = 1
+    DOLLAR = 2
   end
 
   class << self

data/lib/dineromail/item.rb

@@ -1,15 +1,15 @@
 module Dineromail
   class Item
-    attr_accessor :description, :currency, :unit_price, :count
+    include HappyMapper
     
-    DOLLAR = 2
-    PESO = 1
+    tag 'ITEM'
+    element :description, String, :tag => 'DESCRIPCION'
+    element :currency, Integer, :tag => 'MONEDA'
+    element :unit_price, Float, :tag => 'PRECIOUNITARIO'
+    element :count, Integer, :tag => 'CANTIDAD'
     
-    def initialize(attributes = {})
-      attributes.each do |name, value|
-        send("#{name}=", value)
-      end
-    end
+    DOLLAR = 2
+    PESO = 1    
     
   end
 end

data/lib/dineromail/notification.rb

@@ -1,35 +1,27 @@
-require 'xmlsimple'
+require 'happymapper'
 module Dineromail
   class Notification
+    include HappyMapper
     
-    attr_reader :transaction_id, :tipo
-    
-    def initialize(transaction_id, tipo = nil)
-      @transaction_id = transaction_id
-      @tipo = tipo
-    end
+    tag 'OPERACION'
+    element :transaction_id, Integer, :tag => 'ID'
+    element :type, String, :tag => 'TIPO'
     
     def status_report
       unless @status_report
-        @status_report = StatusReport.new(transaction_id)
+        @status_report = StatusReport.get_report_for(transaction_id)
       end
       @status_report
     end
     
-    def self.from_xml(notification_xml)
-      notifications = []
-      notificaction_data = XmlSimple.xml_in(notification_xml,'KeyToSymbol' => true)
-      operations = notificaction_data[:operaciones].first[:operacion]
-      operations.each do |operation|
-        tipo = operation[:tipo].first
-        transaction_id = operation[:id].first
-        notifications << self.new(transaction_id, tipo)
-      end
-      notifications
+    def valid_report?
+      status_report.valid_report?
     end
     
-    def self.method_missing(symbol, *args)
-      status_report.send(symbol, *args)
+    def method_missing(symbol, *args)
+      unless status_report.operations.empty?
+        status_report.operations.first.send(symbol, *args)
+      end
     end
     
   end

data/lib/dineromail/operation.rb

@@ -0,0 +1,34 @@
+require 'dineromail/item'
+module Dineromail
+  class Operation
+    include HappyMapper
+    
+    tag 'OPERACION'
+    element :transaction_id, Integer, :tag => 'ID'
+    element :date, DateTime, :tag => 'FECHA'
+    element :status, Integer, :tag => 'ESTADO'
+    element :amount, Float, :tag => 'MONTO'
+    element :net_amount, Float, :tag => 'MONTONETO'
+    element :pay_method, String, :tag => 'METODOPAGO'
+    element :pay_medium, String, :tag => 'MEDIOPAGO'
+    has_one :buyer, Buyer, :tag => 'COMPRADOR'
+    has_many :items, Dineromail::Item, :tag => 'ITEM'
+    
+    PENDING_STATUS = 1
+    COMPLETED_STATUS = 2
+    CANCELLED_STATUS = 3
+    
+    def pending?
+      status == PENDING_STATUS
+    end
+    
+    def completed?
+      status == ACCREDITED_STATUS
+    end
+    
+    def cancelled?
+      status == CANCELLED_STATUS
+    end
+    
+  end
+end

data/lib/dineromail/status_report.rb

@@ -1,13 +1,16 @@
-require 'xmlsimple'
+require 'happymapper'
 require 'httparty'
 require 'dineromail/buyer'
+require 'dineromail/operation'
 module Dineromail
   class StatusReport
-    attr_accessor :transaction_id, :date,:report_status, :status, :amount, :net_amount, :pay_method, :pay_medium, :buyer, :items
+    attr_accessor :transaction_id
     
-    PENDING_STATUS = 1
-    COMPLETED_STATUS = 2
-    CANCELLED_STATUS = 3
+    include HappyMapper
+    
+    tag 'REPORTE'
+    element :report_status, Integer, :tag => 'ESTADOREPORTE'
+    has_many :operations, Operation
     
     VALID_REPORT_STATUS = 1
     MALFORMED_REPORT_STATUS = 2
@@ -18,31 +21,12 @@ module Dineromail
     INVALID_PASSWORD_OR_ACCOUNT_NUMBER_REQUEST_STATUS = 7
     TRANSACTION_NOT_FOUND_REQUEST_STATUS = 8
     
-    def initialize(transaction_id = nil)
-      @items = []
-      if transaction_id
-        obtain_status_report_data_for transaction_id
-      end
-    end
-    
     def valid_report?
       report_status == VALID_REPORT_STATUS
     end
     
-    def pending?
-      status == PENDING_STATUS
-    end
     
-    def completed?
-      status == ACCREDITED_STATUS
-    end
-    
-    def cancelled?
-      status == CANCELLED_STATUS
-    end
-    
-    def obtain_status_report_data_for(transaction_id)
-      self.transaction_id = transaction_id
+    def self.get_report_for(transaction_id)
       account_number = Dineromail.configuration.account_number
       password = Dineromail.configuration.password
       ipn_url = Dineromail.configuration.ipn_webservice_url
@@ -59,41 +43,7 @@ module Dineromail
             </DETALLE>
           </REPORTE>"
       response = HTTParty.get ipn_url , :query => {:data => request_data}
-      parse_response response.body
-    end
-   
-    def parse_response(response)
-      response_data = XmlSimple.xml_in(response,'KeyToSymbol' => true )
-      self.report_status = response_data[:estadoreporte].first.to_i
-      operations = response_data[:detalle].first[:operaciones].first
-      if operations
-        operation = operations[:operacion].first
-        self.transaction_id = operation[:id].first.to_i
-        self.date = DateTime.parse operation[:fecha].first
-        self.status = operation[:estado].first.to_i
-        self.amount = operation[:monto].first.to_f
-        self.net_amount = operation[:montoneto].first.to_f
-        self.pay_method = operation[:metodopago].first
-        self.pay_medium = operation[:mediopago].first
-        buyer_data = operation[:comprador].first
-        self.buyer = Buyer.new
-        buyer.email = buyer_data[:email].first
-        buyer.address = buyer_data[:direccion].first
-        buyer.comment = buyer_data[:comentario].first
-        buyer.name = buyer_data[:nombre].first
-        buyer.phone = buyer_data[:telefono].first
-        buyer.document_type = buyer_data[:tipodoc].first
-        buyer.document_number = buyer_data[:numerodoc].first
-        items_data = operation[:items].first[:item]
-        items_data.each do |item_data|
-          item = Item.new
-          item.description = item_data[:descripcion].first
-          item.currency = item_data[:moneda].first.to_i
-          item.unit_price = item_data[:preciounitario].first.to_f
-          item.count = item_data[:cantidad].first.to_i
-          self.items << item
-        end
-      end
+      self.parse response.body
     end
     
   end

data/lib/dineromail/version.rb

@@ -1,3 +1,3 @@
 module Dineromail
-  VERSION = "0.0.4"
+  VERSION = "0.1.0"
 end

data/spec/dineromail/notification_spec.rb

@@ -2,13 +2,24 @@ require 'spec_helper'
 
 describe Dineromail::Notification do
   it 'should load the notifications from the notification xml' do
-    notification_xml = '<NOTIFICACION><TIPONOTIFICACION>1</TIPONOTIFICACION><OPERACIONES><OPERACION><TIPO>1</TIPO><ID>31548</ID></OPERACION><OPERACION><TIPO>1</TIPO><ID>XA5547</ID></OPERACION></OPERACIONES></NOTIFICACION>'
-    notifications = Dineromail::Notification.from_xml(notification_xml)
+    notification_xml = File.read( 'spec/fixtures/notification.xml')
+    notifications = Dineromail::Notification.parse(notification_xml)
     notifications.count.should == 2
-    notifications.first.transaction_id.should == '31548'
-    notifications.last.transaction_id.should == 'XA5547'
+    notifications.first.transaction_id.should == 1889
+    notifications.last.transaction_id.should == 5547
   end
   
-  
+  it 'should get automaticaly the status data associated with the notification' do
+    HTTParty.stub!(:get).and_return {
+      response = Object.new
+      response.stub!(:body).and_return(File.read( 'spec/fixtures/status_report.xml'))
+      response
+    }
+    notification_xml = File.read( 'spec/fixtures/notification.xml')
+    notifications = Dineromail::Notification.parse(notification_xml)
+    notification = notifications.first
+    notification.valid_report?.should be_true
+    notification.net_amount.should == 50.3
+  end
   
 end

data/spec/dineromail/status_report_spec.rb

@@ -2,48 +2,22 @@ require 'spec_helper'
 
 describe Dineromail::StatusReport do
   it 'should load the status report from xml' do
-    xml = '<REPORTE><ESTADOREPORTE>1</ESTADOREPORTE><DETALLE><OPERACIONES><OPERACION>
-          <ID>1889</ID>
-          <FECHA>01/28/2011 12:02:01 PM</FECHA>
-          <ESTADO>1</ESTADO>
-          <NUMTRANSACCION>67777</NUMTRANSACCION>
-          <COMPRADOR>
-            <EMAIL>comprador@email.com</EMAIL>
-            <DIRECCION>San Martin 10</DIRECCION>
-            <COMENTARIO>comentario</COMENTARIO>
-            <NOMBRE>Juan</NOMBRE>
-            <TELEFONO>4444444</TELEFONO>
-            <TIPODOC>DNI</TIPODOC>
-            <NUMERODOC>222222222</NUMERODOC>
-          </COMPRADOR>
-          <MONTO>60.2</MONTO>
-          <MONTONETO>50.3</MONTONETO>
-          <METODOPAGO>TARJETA DE CREDITO</METODOPAGO>
-          <MEDIOPAGO>VISA</MEDIOPAGO>
-          <CUOTAS>1</CUOTAS>
-          <ITEMS>
-            <ITEM>
-              <DESCRIPCION>Libro</DESCRIPCION>
-              <MONEDA>1</MONEDA>
-              <PRECIOUNITARIO>6.90</PRECIOUNITARIO>
-              <CANTIDAD>2</CANTIDAD>
-            </ITEM>
-          </ITEMS><VENDEDOR><TIPODOC></TIPODOC><NUMERODOC></NUMERODOC></VENDEDOR></OPERACION></OPERACIONES></DETALLE></REPORTE>'
+    xml = File.read( 'spec/fixtures/status_report.xml')
     
-    status_report = Dineromail::StatusReport.new    
-    status_report.parse_response(xml)
-    buyer = status_report.buyer
-    item = status_report.items.first
+    status_report = Dineromail::StatusReport.parse(xml)
+    operation = status_report.operations.first
+    buyer = operation.buyer
+    item = operation.items.first
     
     status_report.report_status.should == 1
     status_report.valid_report?.should be_true
-    status_report.transaction_id.should == 1889
-    status_report.date.should == DateTime.ordinal(2011,28,12,2,1)
-    status_report.status.should == Dineromail::StatusReport::PENDING_STATUS
-    status_report.amount.should == 60.2
-    status_report.net_amount.should == 50.3
-    status_report.pay_method.should == 'TARJETA DE CREDITO'
-    status_report.pay_medium.should == 'VISA'
+    operation.transaction_id.should == 1889
+    operation.date.should == DateTime.ordinal(2011,28,12,2,1)
+    operation.status.should == Dineromail::Operation::PENDING_STATUS
+    operation.amount.should == 60.2
+    operation.net_amount.should == 50.3
+    operation.pay_method.should == 'TARJETA DE CREDITO'
+    operation.pay_medium.should == 'VISA'
     buyer.email.should == 'comprador@email.com'
     buyer.address.should == 'San Martin 10'
     buyer.comment.should == 'comentario'
@@ -52,7 +26,7 @@ describe Dineromail::StatusReport do
     buyer.document_type.should == 'DNI'
     buyer.document_number.should == '222222222'
     item.description.should == 'Libro'
-    item.currency.should == 1
+    item.currency.should == Dineromail::Configuration::PESO
     item.count.should == 2
     item.unit_price.should == 6.9
   end

data/spec/fixtures/notification.xml

@@ -0,0 +1,14 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<NOTIFICACION>
+    <TIPONOTIFICACION>1</TIPONOTIFICACION>
+    <OPERACIONES>
+        <OPERACION>
+            <TIPO>1</TIPO>
+            <ID>1889</ID>
+        </OPERACION>
+        <OPERACION>
+            <TIPO>1</TIPO>
+            <ID>5547</ID>
+        </OPERACION>
+    </OPERACIONES>
+</NOTIFICACION>

data/spec/fixtures/status_report.xml

@@ -0,0 +1,40 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<REPORTE>
+    <ESTADOREPORTE>1</ESTADOREPORTE>
+    <DETALLE>
+        <OPERACIONES>
+            <OPERACION>
+                <ID>1889</ID>
+                <FECHA>01/28/2011 12:02:01 PM</FECHA>
+                <ESTADO>1</ESTADO>
+                <NUMTRANSACCION>67777</NUMTRANSACCION>
+                <COMPRADOR>
+                    <EMAIL>comprador@email.com</EMAIL>
+                    <DIRECCION>San Martin 10</DIRECCION>
+                    <COMENTARIO>comentario</COMENTARIO>
+                    <NOMBRE>Juan</NOMBRE>
+                    <TELEFONO>4444444</TELEFONO>
+                    <TIPODOC>DNI</TIPODOC>
+                    <NUMERODOC>222222222</NUMERODOC>
+                </COMPRADOR>
+                <MONTO>60.2</MONTO>
+                <MONTONETO>50.3</MONTONETO>
+                <METODOPAGO>TARJETA DE CREDITO</METODOPAGO>
+                <MEDIOPAGO>VISA</MEDIOPAGO>
+                <CUOTAS>1</CUOTAS>
+                <ITEMS>
+                    <ITEM>
+                        <DESCRIPCION>Libro</DESCRIPCION>
+                        <MONEDA>1</MONEDA>
+                        <PRECIOUNITARIO>6.90</PRECIOUNITARIO>
+                        <CANTIDAD>2</CANTIDAD>
+                    </ITEM>
+                </ITEMS>
+                <VENDEDOR>
+                    <TIPODOC></TIPODOC>
+                    <NUMERODOC></NUMERODOC>
+                </VENDEDOR>
+            </OPERACION>
+        </OPERACIONES>
+    </DETALLE>
+</REPORTE>

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: dineromail
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 27
   prerelease: false
   segments: 
   - 0
+  - 1
   - 0
-  - 4
-  version: 0.0.4
+  version: 0.1.0
 platform: ruby
 authors: 
 - Nicolas Mosconi
@@ -17,11 +17,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-02 00:00:00 -03:00
+date: 2011-06-23 00:00:00 -03:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: xml-simple
+  name: happymapper
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
@@ -105,6 +105,7 @@ extra_rdoc_files: []
 files: 
 - .gitignore
 - Gemfile
+- README.rdoc
 - Rakefile
 - dineromail.gemspec
 - lib/dineromail.rb
@@ -113,10 +114,13 @@ files:
 - lib/dineromail/configuration.rb
 - lib/dineromail/item.rb
 - lib/dineromail/notification.rb
+- lib/dineromail/operation.rb
 - lib/dineromail/status_report.rb
 - lib/dineromail/version.rb
 - spec/dineromail/notification_spec.rb
 - spec/dineromail/status_report_spec.rb
+- spec/fixtures/notification.xml
+- spec/fixtures/status_report.xml
 - spec/spec_helper.rb
 has_rdoc: true
 homepage: ""