moiper 0.1.0 → 0.1.1

data/README.md

@@ -1,6 +1,6 @@
 # Moiper
 
-Moip payment service integration library.
+[Moip payment service](http://moip.com.br/) integration library.
 
 ## Installation
 
@@ -35,7 +35,7 @@ Moiper.configure do |config|
 end
 ```
 
-To make a payment request:
+Then, you can request a new payment authorization:
 
 ```ruby
 payment = Moiper::Payment.new(
@@ -48,12 +48,18 @@ payment = Moiper::Payment.new(
 
 response = payment.checkout
 
-redirect_to response.checkout_url if response.success?
+if response.success?
+  redirect_to response.checkout_url
+else
+  render :text => response.errors.to_sentence
+end
 ```
 
+You need to redirect your user to the url returned by `response.checkout_url`. After the user accepts or rejects your payment request, he will be redirected to the `return_url` you specified on the payment. In case of possible errors during the payment request phase, you can access then through the `response.errors` method.
+
 ### Notifications
 
-Moip will notify your application with a POST, you can see more information at this url: http://labs.moip.com.br/referencia/nasp/
+Moip will notify your application about order updates through [NASP](http://labs.moip.com.br/referencia/nasp/). Moiper provides a Rails controller helper to you can easily intercept these notifications with the `moip_notification` method.
 
 ```ruby
 class OrdersController < ApplicationController
@@ -61,15 +67,60 @@ class OrdersController < ApplicationController
 
   def confirm
     moip_notification do |notification|
-      # Here you can update your database with updated information from Moip
+      # Here you can update your database with updated information.
+      # Ex:
       @order = Order.find_by_unique_identifier(notification.id)
       @order.update_attribute :status, notification.payment_status
       @order.save
+
+      # Moip will recognize the request as successfully if the statuses
+      # are 200, 201, 202, 203, 204, 205, 206 or 207.
+      head 200
     end
   end
 end
 ```
 
+#### Payment Status
+
+Following are the possible payment statuses returned by the `Moip::Notification#payment_status`.
+
+* `authorized`
+* `started`
+* `payment_form_printed`
+* `finished`
+* `canceled`
+* `under_analysis`
+* `returned`
+* `reimbursed`
+
+#### Payment Methods
+
+Following are the possible financial institutions returned by the `Moip::Notification#payment_method`.
+
+* `payment_form`
+* `credit_card`
+* `debit`
+* `debit_card`
+* `financing`
+* `moip_account`
+
+#### Financial Institution
+
+Following are the possible financial institutions returned by the `Moip::Notification#financial_institution`.
+
+* MoIP
+* Visa
+* AmericanExpress
+* Mastercard
+* Diners
+* BancoDoBrasil
+* Bradesco
+* Itau
+* Hipercard
+* Paggo
+* Banrisul
+
 ## Disclaimer
 
 This gem is being developed in a workshop-like manner, during the trainee training program at Tagview, so the students can understand concepts such as open source development, TDD, API integration and documentation.

data/lib/moiper/payment.rb

@@ -35,14 +35,14 @@ module Moiper
         xml.EnviarInstrucao {
           xml.InstrucaoUnica {
             xml.Razao description
-            xml.IdProprio id
+            xml.IdProprio id if id
 
             xml.Valores {
               xml.Valor price, :moeda => "BRL"
             }
 
-            xml.URLNotificacao notification_url
-            xml.URLRetorno return_url
+            xml.URLNotificacao notification_url if notification_url
+            xml.URLRetorno return_url if return_url
           }
         }
       end

data/lib/moiper/version.rb

@@ -1,4 +1,4 @@
 module Moiper
   # Specify the current gem version
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/spec/moiper/payment_spec.rb

@@ -104,5 +104,20 @@ describe Moiper::Payment do
 
     it { doc.at_css("InstrucaoUnica > URLRetorno").text.should eq "http://example.org/thank_you" }
     it { doc.at_css("InstrucaoUnica > URLNotificacao").text.should eq "http://example.org/moip/notification" }
+
+    context "when no id is informed" do
+      before { payment.id = nil }
+      it { doc.at_css("InstrucaoUnica > IdProprio").should be_nil }
+    end
+
+    context "when no notification_url is informed" do
+      before { payment.notification_url = nil }
+      it { doc.at_css("InstrucaoUnica > URLNotificacao").should be_nil }
+    end
+
+    context "when no return_url is informed" do
+      before { payment.return_url = nil }
+      it { doc.at_css("InstrucaoUnica > URLRetorno").should be_nil }
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: moiper
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2013-01-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &2160905440 !ruby/object:Gem::Requirement
+  requirement: &2152746220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2160905440
+  version_requirements: *2152746220
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2160904920 !ruby/object:Gem::Requirement
+  requirement: &2152745700 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +32,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2160904920
+  version_requirements: *2152745700
 description: Moip payment service integration library.
 email:
 - rnavarro1@gmail.com
@@ -76,7 +76,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3233836298932843302
+      hash: 1028028193519655170
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -85,7 +85,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3233836298932843302
+      hash: 1028028193519655170
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.11