moiper 0.0.1

data/lib/moiper/payment.rb

@@ -0,0 +1,58 @@
+require "nokogiri"
+
+module Moiper
+  class Payment
+    # The unique ID you can set for this payment. This is usefull to keep
+    # trak of which payment we will receive on the Moip's notification process.
+    attr_accessor :id
+
+    # The description of the purchase.
+    attr_accessor :description
+
+    # The amount to be billed from the user.
+    attr_accessor :price
+
+    # The URL where the user will be redirected after he finishes the
+    # payment process.
+    attr_accessor :return_url
+
+    # The URL where Moip will send notifications about your purchase updates.
+    attr_accessor :notification_url
+
+    # Create a new Moip Payment request
+    def initialize(options = {})
+      raise ArgumentError if options[:description].nil? || options[:description].empty?
+      raise ArgumentError if options[:price].nil? || options[:price].to_f <= 0
+
+      options.each do |attribute, value|
+        send "#{attribute}=", value
+      end
+    end
+
+    # Create the payment XML representation
+    def to_xml
+      builder = Nokogiri::XML::Builder.new(:encoding => "UTF-8") do |xml|
+        xml.EnviarInstrucao {
+          xml.InstrucaoUnica {
+            xml.Razao description
+            xml.IdProprio id
+
+            xml.Valores {
+              xml.Valor price, :moeda => "BRL"
+            }
+
+            xml.URLNotificacao notification_url
+            xml.URLRetorno return_url
+          }
+        }
+      end
+
+      builder.to_xml
+    end
+
+    def checkout
+      request = Request.new
+      request.process(to_xml)
+    end
+  end
+end

data/lib/moiper/request.rb

@@ -0,0 +1,46 @@
+require "net/http"
+require "net/https"
+
+module Moiper
+  class Request
+    CA_FILE = File.expand_path(File.dirname(__FILE__)) + "/cacert.pem"
+
+    attr_reader :response
+
+    def process(payload)
+      @response = post(payload)
+      Response.new(@response.body)
+    end
+
+    def client
+      @client ||= Net::HTTP.new(uri.host, uri.port).tap do |http|
+        http.use_ssl = true
+        http.ca_file = CA_FILE
+        http.verify_mode = OpenSSL::SSL::VERIFY_PEER
+      end
+    end
+
+    def request
+      @request ||= Net::HTTP::Post.new(uri.path).tap do |request|
+        request.basic_auth Moiper.token, Moiper.key
+        request.content_type = "text/xml"
+        request["User-Agent"] = "Moiper/#{Moiper::VERSION}"
+      end
+    end
+
+    private
+
+    def post(payload)
+      request.body = payload
+      client.request(request)
+    end
+
+    def uri
+      @uri ||= URI(Moiper.api_entrypoint + path)
+    end
+
+    def path
+      "ws/alpha/EnviarInstrucao/Unica"
+    end
+  end
+end

data/lib/moiper/response.rb

@@ -0,0 +1,29 @@
+module Moiper
+  class Response
+    def initialize(body)
+      @body = body
+    end
+
+    def success?
+      parsed_body.css("Status").text == "Sucesso"
+    end
+
+    def checkout_url
+      Moiper.api_entrypoint + "Instrucao.do?token=" + token if success?
+    end
+
+    def token
+      parsed_body.css("Token").text
+    end
+
+    def errors
+      parsed_body.css("Erro").map(&:text)
+    end
+
+    private
+
+    def parsed_body
+      @parsed_body ||= Nokogiri::XML(@body)
+    end
+  end
+end

data/lib/moiper/version.rb

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

data/lib/moiper.rb

@@ -0,0 +1,47 @@
+require "moiper/version"
+require "moiper/payment"
+require "moiper/request"
+require "moiper/response"
+
+module Moiper
+  API_ENTRYPOINTS = {
+    :sandbox    => "https://desenvolvedor.moip.com.br/sandbox/",
+    :production => "https://www.moip.com.br/"
+  }
+
+  class << self
+    # Set Moip's API token
+    attr_accessor :token
+
+    # Set Moip's API key
+    attr_accessor :key
+
+    # Define if requests should be made against Moip's sandbox
+    # environment. This is specially usefull when running
+    # on development or test mode. Default is false.
+    #
+    #  Moiper.sandbox = true
+    #
+    attr_accessor :sandbox
+
+    # Configure Moiper options.
+    #
+    #  Moiper.configure do |config|
+    #    config.sandbox = true
+    #  end
+    #
+    def configure(&block)
+      yield self
+    end
+
+    # Inform if in sandbox mode
+    def sandbox?
+      sandbox == true
+    end
+
+    # Returns the Moip API entrypoint based on the current environment
+    def api_entrypoint
+      sandbox? ? API_ENTRYPOINTS[:sandbox] : API_ENTRYPOINTS[:production]
+    end
+  end
+end

data/moiper.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'moiper/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "moiper"
+  gem.version       = Moiper::VERSION
+  gem.authors       = ["Rodrigo Navarro"]
+  gem.email         = ["rnavarro1@gmail.com"]
+  gem.description   = %q{Moip payment service integration library.}
+  gem.summary       = gem.description
+  gem.homepage      = "http://rubygems.org/gems/moiper"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency "nokogiri"
+  gem.add_development_dependency "rspec"
+end

data/spec/moiper/payment_spec.rb

@@ -0,0 +1,108 @@
+require "spec_helper"
+
+describe Moiper::Payment do
+  describe "#initialize" do
+    subject {
+      Moiper::Payment.new(
+        :description      => "A chair",
+        :price            => 1.99,
+        :id               => "some unique id",
+        :return_url       => "http://example.org/thank_you",
+        :notification_url => "http://example.org/moip/notification"
+      )
+    }
+
+    its(:description) { should eq "A chair" }
+    its(:price)       { should == 1.99 }
+    its(:id)          { should eq "some unique id" }
+    its(:return_url)  { should eq "http://example.org/thank_you"}
+    its(:notification_url) { should eq "http://example.org/moip/notification" }
+
+    it "raises an error when no description is given" do
+      expect {
+        Moiper::Payment.new(
+          :price            => 1.99,
+          :id               => "some unique id",
+          :return_url       => "http://example.org/thank_you",
+          :notification_url => "http://example.org/moip/notification"
+        )
+      }.to raise_error ArgumentError
+    end
+
+    it "raises an error when a blank description is given" do
+      expect {
+        Moiper::Payment.new(
+          :description      => "",
+          :price            => 1.99,
+          :id               => "some unique id",
+          :return_url       => "http://example.org/thank_you",
+          :notification_url => "http://example.org/moip/notification"
+        )
+      }.to raise_error ArgumentError
+    end
+
+    it "raises an error when no price is given" do
+      expect {
+        Moiper::Payment.new(
+          :description      => "Some description",
+          :id               => "some unique id",
+          :return_url       => "http://example.org/thank_you",
+          :notification_url => "http://example.org/moip/notification"
+        )
+      }.to raise_error ArgumentError
+    end
+
+    it "raises an error when the price is zero" do
+      expect {
+        Moiper::Payment.new(
+          :description      => "Some description",
+          :price            => 0,
+          :id               => "some unique id",
+          :return_url       => "http://example.org/thank_you",
+          :notification_url => "http://example.org/moip/notification"
+        )
+      }.to raise_error ArgumentError
+    end
+
+    it "raises an error when the price is lower than zero" do
+      expect {
+        Moiper::Payment.new(
+          :description      => "Some description",
+          :price            => -10,
+          :id               => "some unique id",
+          :return_url       => "http://example.org/thank_you",
+          :notification_url => "http://example.org/moip/notification"
+        )
+      }.to raise_error ArgumentError
+    end
+  end
+
+  describe "#to_xml" do
+    let(:payment) {
+      Moiper::Payment.new(
+        :description      => "A chair",
+        :price            => 1.99,
+        :id               => "some unique id",
+        :return_url       => "http://example.org/thank_you",
+        :notification_url => "http://example.org/moip/notification"
+      )
+    }
+
+    let(:doc) { Nokogiri::XML(payment.to_xml) }
+
+    it { doc.at_css("> EnviarInstrucao").should_not be_nil }
+    it { doc.at_css("EnviarInstrucao > InstrucaoUnica").should_not be_nil }
+    it { doc.at_css("InstrucaoUnica > IdProprio").should_not be_nil }
+    it { doc.at_css("InstrucaoUnica > Valores").should_not be_nil }
+    it { doc.at_css("Valores > Valor").should_not be_nil }
+    it { doc.at_css("InstrucaoUnica > URLRetorno").should_not be_nil }
+    it { doc.at_css("InstrucaoUnica > URLNotificacao").should_not be_nil }
+
+    it { doc.at_css("InstrucaoUnica > IdProprio").text.should eq "some unique id"}
+    it { doc.at_css("Valores > Valor").text.should eq "1.99"}
+    it { doc.at_css("Valores > Valor").attributes["moeda"].value.should eq "BRL"}
+
+    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" }
+  end
+end

data/spec/moiper/request_spec.rb

@@ -0,0 +1,41 @@
+require "spec_helper"
+
+describe Moiper::Request do
+  describe "#process" do
+    it "returns a Response object" do
+      response = Moiper::Request.new.process("<someXml></someXml>")
+      response.should be_kind_of Moiper::Response
+    end
+  end
+
+  describe "#client" do
+    let(:client) { Moiper::Request.new.client }
+
+    it "uses SSL" do
+      client.use_ssl?.should be_true
+    end
+
+    it "verifies the certificate" do
+      client.verify_mode.should == OpenSSL::SSL::VERIFY_PEER
+    end
+
+    it "uses the right ca file" do
+      client.ca_file.should == Moiper::Request::CA_FILE
+    end
+  end
+
+  describe "#request" do
+    subject { Moiper::Request.new.request }
+    its(:content_type) { should eq "text/xml" }
+
+    it "sets the correct token and key parameters" do
+      Net::HTTP::Post.any_instance.should_receive(:basic_auth).with(Moiper.token, Moiper.key)
+      Moiper::Request.new.request
+    end
+
+    it "has the correct user agent" do
+      headers = Hash[subject.each_capitalized.to_a]
+      headers["User-Agent"].should eq "Moiper/#{Moiper::VERSION}"
+    end
+  end
+end

data/spec/moiper/response_spec.rb

@@ -0,0 +1,78 @@
+# encoding: utf-8
+
+require "spec_helper"
+
+describe Moiper::Response do
+  let(:success_response_fixture) {
+    %Q{
+    <?xml version="1.0"?>
+      <ns1:EnviarInstrucaoUnicaResponse xmlns:ns1="http://www.moip.com.br/ws/alpha/">
+        <Resposta>
+          <ID>201301221539573040000001453849</ID>
+          <Status>Sucesso</Status>
+          <Token>M2M0J1D3M0U1L2L2S1W5V3X9T5V7Y3X0W4U0M0Z0L0G02001S4F513N8N4J9</Token>
+        </Resposta>
+      </ns1:EnviarInstrucaoUnicaResponse>
+    }
+  }
+
+  let(:error_response_fixture) {
+    %Q{
+      <?xml version="1.0"?>
+        <ns1:EnviarInstrucaoUnicaResponse xmlns:ns1="http://www.moip.com.br/ws/alpha/">
+          <Resposta>
+            <ID>201301221546325890000001453860</ID>
+            <Status>Falha</Status>
+            <Erro Codigo="101">A razão do pagamento deve ser enviada obrigatoriamente</Erro>
+            <Erro Codigo="102">Id Próprio já foi utilizado em outra Instrução</Erro>
+          </Resposta>
+        </ns1:EnviarInstrucaoUnicaResponse>
+    }
+  }
+
+  describe "#checkout_url" do
+    context "when the response is success" do
+      it "returns the url the user should be redirected" do
+        response = Moiper::Response.new(success_response_fixture)
+        response.checkout_url.should eq Moiper.api_entrypoint + "Instrucao.do?token=" + response.token
+      end
+    end
+
+    context "when the response returns an error" do
+      it "returns nil" do
+        response = Moiper::Response.new(error_response_fixture)
+        response.checkout_url.should be_nil
+      end
+    end
+  end
+
+  describe "#success?" do
+    subject { Moiper::Response.new(body).success? }
+
+    context "when the response is success" do
+      let(:body) { success_response_fixture }
+      it { should be_true }
+    end
+
+    context "when the response returns an error" do
+      let(:body) { error_response_fixture }
+      it { should be_false }
+    end
+  end
+
+  describe "#errors" do
+    context "when the response is success" do
+      it "is an empty array" do
+        Moiper::Response.new(success_response_fixture).errors.should be_empty
+      end
+    end
+
+    context "when the response returns an error" do
+      it "returns an array with errors" do
+        errors = Moiper::Response.new(error_response_fixture).errors
+        errors.should include "A razão do pagamento deve ser enviada obrigatoriamente"
+        errors.should include "Id Próprio já foi utilizado em outra Instrução"
+      end
+    end
+  end
+end

data/spec/moiper_spec.rb

@@ -0,0 +1,59 @@
+require "spec_helper"
+
+describe Moiper do
+  describe ".configure" do
+    it "yields Moiper" do
+      Moiper.configure do |config|
+        config.should be Moiper
+      end
+    end
+
+    it "sets a token configuration" do
+      Moiper.configure do |config|
+        config.token = "Some Token"
+      end
+
+      Moiper.token.should eq "Some Token"
+    end
+
+    it "sets a key configuration" do
+      Moiper.configure do |config|
+        config.key = "Some Key"
+      end
+
+      Moiper.key.should eq "Some Key"
+    end
+  end
+
+  describe ".sandbox?" do
+    it "is true when you set sandbox configuration true" do
+      Moiper.configure do |config|
+        config.sandbox = true
+      end
+
+      Moiper.sandbox?.should be_true
+    end
+
+    it "is false when you set sandbox configuration to false" do
+      Moiper.configure do |config|
+        config.sandbox = false
+      end
+
+      Moiper.sandbox?.should be_false
+    end
+  end
+
+  describe ".api_entrypoint" do
+    subject { Moiper.api_entrypoint }
+
+    it "is the sandbox url when sandbox is enabled" do
+      Moiper.sandbox = true
+      should == Moiper::API_ENTRYPOINTS[:sandbox]
+    end
+
+    it "is the production url when sandbox is disabled" do
+      Moiper.sandbox = false
+      should == Moiper::API_ENTRYPOINTS[:production]
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require "moiper"
+
+RSpec.configure do |config|
+  config.before do
+    Moiper.configure do |config|
+      config.sandbox = true
+      config.token = "01010101010101010101010101010101"
+      config.key = "ABABABABABABABABABABABABABABABABABABABAB"
+    end
+  end
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: moiper
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Rodrigo Navarro
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: &2160726500 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2160726500
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2160725540 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2160725540
+description: Moip payment service integration library.
+email:
+- rnavarro1@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/moiper.rb
+- lib/moiper/cacert.pem
+- lib/moiper/payment.rb
+- lib/moiper/request.rb
+- lib/moiper/response.rb
+- lib/moiper/version.rb
+- moiper.gemspec
+- spec/moiper/payment_spec.rb
+- spec/moiper/request_spec.rb
+- spec/moiper/response_spec.rb
+- spec/moiper_spec.rb
+- spec/spec_helper.rb
+homepage: http://rubygems.org/gems/moiper
+licenses: []
+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: 657788424020654005
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 657788424020654005
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: Moip payment service integration library.
+test_files:
+- spec/moiper/payment_spec.rb
+- spec/moiper/request_spec.rb
+- spec/moiper/response_spec.rb
+- spec/moiper_spec.rb
+- spec/spec_helper.rb