mymoip 0.3.1 → 0.4.0

data/CHANGELOG.md

@@ -1,6 +1,15 @@
 CHANGELOG
 =========
 
+0.4.0
+-----
+
+* Accept multiple receivers for each instruction.
+    * Can set a fixed value (e.g. R$ 50,00).
+    * Can set a percentage value (e.g. 10%).
+    * Define which one will take the fees.
+* Accept payments to any MoIP users, even those without API keys.
+
 0.3.1
 -----
 

data/Gemfile

@@ -17,5 +17,7 @@ group :development do
   gem "turn"
   gem "mocha", require: false
   gem "vcr"
-  gem "webmock"
+  # Version requirement caused by VCR's warning.
+  # Can be removed after merge of https://github.com/vcr/vcr/commit/f75353b75e1ac1e4309faa9323e7c01d8ce28e46
+  gem "webmock", "< 1.9.0"
 end

data/Gemfile.lock

@@ -1,18 +1,18 @@
 GEM
   remote: http://rubygems.org/
   specs:
-    activemodel (3.2.8)
-      activesupport (= 3.2.8)
+    activemodel (3.2.9)
+      activesupport (= 3.2.9)
       builder (~> 3.0.0)
-    activesupport (3.2.8)
+    activesupport (3.2.9)
       i18n (~> 0.6)
       multi_json (~> 1.0)
     addressable (2.3.2)
     ansi (1.4.3)
-    builder (3.0.0)
+    builder (3.0.4)
     crack (0.3.1)
     git (1.2.5)
-    httparty (0.8.3)
+    httparty (0.9.0)
       multi_json (~> 1.0)
       multi_xml
     i18n (0.6.1)
@@ -21,18 +21,18 @@ GEM
       git (>= 1.2.5)
       rake
       rdoc
-    json (1.7.4)
+    json (1.7.5)
     metaclass (0.0.1)
-    mocha (0.12.3)
+    mocha (0.13.0)
       metaclass (~> 0.0.1)
-    multi_json (1.3.6)
+    multi_json (1.4.0)
     multi_xml (0.5.1)
-    rake (0.9.2.2)
+    rake (10.0.2)
     rdoc (3.12)
       json (~> 1.4)
     turn (0.9.6)
       ansi
-    vcr (2.2.5)
+    vcr (2.3.0)
     webmock (1.8.11)
       addressable (>= 2.2.7)
       crack (>= 0.1.7)
@@ -50,4 +50,4 @@ DEPENDENCIES
   rdoc (~> 3.12)
   turn
   vcr
-  webmock
+  webmock (< 1.9.0)

data/README.md

@@ -85,6 +85,39 @@ payment_request.api_call(credit_card_payment, token: transparent_request.token)
 payment_request.success?
 ```
 
+Sending payments to multiple receivers
+--------------------------------------
+
+Choosing between commission with fixed or percentage value.
+
+```ruby
+commissions = [MyMoip::Commission.new(
+  reason: 'System maintenance',
+  receiver_login: 'commissioned_moip_login',
+  fixed_value: 15.0
+)]
+
+# OR
+
+commissions = [MyMoip::Commission.new(
+  reason: 'Shipping',
+  receiver_login: 'commissioned_moip_login',
+  percentage_value: 0.15
+)]
+```
+
+```ruby
+instruction = MyMoip::Instruction.new(
+  id: "instruction_id_defined_by_you",
+  payment_reason: "Order in Buy Everything Store",
+  values: [100.0],
+  payer: payer,
+  commissions: commissions
+)
+```
+
+[Wiki](https://github.com/Irio/mymoip/wiki/Sending-payments-to-multiple-receivers) will be helpful here.
+
 Documentation
 -------------
 

data/VERSION

@@ -1 +1 @@
-0.3.1
+0.4.0

data/lib/mymoip/commission.rb

@@ -0,0 +1,51 @@
+module MyMoip
+  class Commission
+    include ActiveModel::Validations
+
+    attr_accessor :reason, :receiver_login, :fixed_value, :percentage_value
+
+    validates_presence_of :reason, :receiver_login
+    validates_presence_of :fixed_value, if: -> { percentage_value.nil? }
+    validates_presence_of :percentage_value, if: -> { fixed_value.nil? }
+    validates_numericality_of :fixed_value, greater_than_or_equal_to: 0,
+                                            allow_nil: true
+    validates_numericality_of :percentage_value, greater_than_or_equal_to: 0,
+                                                 less_than_or_equal_to: 1,
+                                                 allow_nil: true
+
+    def initialize(attrs)
+      self.reason           = attrs[:reason]
+      self.receiver_login   = attrs[:receiver_login]
+      self.fixed_value      = attrs[:fixed_value]
+      self.percentage_value = attrs[:percentage_value]
+    end
+
+    def gross_amount(instruction)
+      if fixed_value
+        fixed_value
+      elsif percentage_value
+        percentage_value * instruction.gross_amount
+      else
+        raise ArgumentError, 'Cannot give gross_amount without fixed_value or percentage_value'
+      end
+    end
+
+    def to_xml(root = nil)
+      raise ArgumentError, "Invalid params for Commission" if invalid?
+
+      if root.nil?
+        xml  = ""
+        root ||= Builder::XmlMarkup.new(target: xml)
+      end
+
+      root.Comissionamento do |n1|
+        n1.Razao(reason)
+        n1.Comissionado {|n2| n2.LoginMoIP(receiver_login)}
+        n1.ValorFixo(fixed_value) if fixed_value
+        n1.ValorPercentual(percentage_value) if percentage_value
+      end
+
+      xml
+    end
+  end
+end

data/lib/mymoip/credit_card.rb

@@ -16,17 +16,17 @@ module MyMoip
     validates_inclusion_of :logo, in: AVAILABLE_LOGOS
 
     def initialize(attrs)
-      self.logo            = attrs[:logo]            if attrs.has_key?(:logo)
-      self.card_number     = attrs[:card_number]     if attrs.has_key?(:card_number)
-      self.expiration_date = attrs[:expiration_date] if attrs.has_key?(:expiration_date)
-      self.security_code   = attrs[:security_code]   if attrs.has_key?(:security_code)
-      self.owner_name      = attrs[:owner_name]      if attrs.has_key?(:owner_name)
-      self.owner_birthday  = attrs[:owner_birthday]  if attrs.has_key?(:owner_birthday)
-      self.owner_phone     = attrs[:owner_phone]     if attrs.has_key?(:owner_phone)
-      self.owner_cpf       = attrs[:owner_cpf]       if attrs.has_key?(:owner_cpf)
+      self.logo            = attrs[:logo]
+      self.card_number     = attrs[:card_number]
+      self.expiration_date = attrs[:expiration_date]
+      self.security_code   = attrs[:security_code]
+      self.owner_name      = attrs[:owner_name]
+      self.owner_birthday  = attrs[:owner_birthday]
+      self.owner_phone     = attrs[:owner_phone]
+      self.owner_cpf       = attrs[:owner_cpf]
 
       # Deprecated attributes
-      self.owner_rg        = attrs[:owner_rg]        if attrs.has_key?(:owner_rg)
+      self.owner_rg        = attrs[:owner_rg] if attrs.has_key?(:owner_rg)
     end
 
     def logo=(value)

data/lib/mymoip/instruction.rb

@@ -2,20 +2,31 @@ module MyMoip
   class Instruction
     include ActiveModel::Validations
 
-    attr_accessor :id, :payment_reason, :values, :payer
+    attr_accessor :id, :payment_reason, :values, :payer,
+                  :commissions, :fee_payer_login, :payment_receiver_login,
+                  :payment_receiver_name
 
     validates_presence_of :id, :payment_reason, :values, :payer
+    validate :commissions_value_must_be_lesser_than_values
+    validate :payment_receiver_presence_in_commissions
 
     def initialize(attrs)
-      self.id             = attrs[:id]             if attrs.has_key?(:id)
-      self.payment_reason = attrs[:payment_reason] if attrs.has_key?(:payment_reason)
-      self.values         = attrs[:values]         if attrs.has_key?(:values)
-      self.payer          = attrs[:payer]          if attrs.has_key?(:payer)
+      self.id                     = attrs[:id]
+      self.payment_reason         = attrs[:payment_reason]
+      self.values                 = attrs[:values]
+      self.payer                  = attrs[:payer]
+      self.commissions            = attrs[:commissions] || []
+      self.fee_payer_login        = attrs[:fee_payer_login]
+      self.payment_receiver_login = attrs[:payment_receiver_login]
+      self.payment_receiver_name  = attrs[:payment_receiver_name]
     end
 
     def to_xml(root = nil)
       raise ArgumentError, 'Invalid payer' if payer.invalid?
       raise ArgumentError, 'Invalid params for instruction' if self.invalid?
+      if invalid_commission = commissions.detect { |c| c.invalid? }
+        raise ArgumentError, "Invalid commission: #{invalid_commission}"
+      end
 
       xml  = ""
       root = Builder::XmlMarkup.new(target: xml)
@@ -27,11 +38,53 @@ module MyMoip
             @values.each { |v| n3.Valor("%.2f" % v, moeda: "BRL") }
           end
           n2.IdProprio(@id)
+
+          commissions_to_xml n2  if !commissions.empty?
+          payment_receiver_to_xml n2 if payment_receiver_login
+
           n2.Pagador { |n3| @payer.to_xml(n3) }
         end
       end
 
       xml
     end
+
+    def commissions_sum
+      commissions.inject(0) do |sum, commission|
+        sum + commission.gross_amount(self)
+      end
+    end
+
+    def gross_amount
+      values ? values.reduce(0) { |sum, value| sum + value } : 0
+    end
+
+    protected
+
+    def commissions_value_must_be_lesser_than_values
+      if commissions_sum > gross_amount
+        errors.add(:commissions, "Commissions value sum is greater than instruction value sum")
+      end
+    end
+
+    def payment_receiver_presence_in_commissions
+      if commissions.find { |c| c.receiver_login == payment_receiver_login }
+        errors.add(:payment_receiver_login, "Payment receiver can't be commissioned")
+      end
+    end
+
+    def commissions_to_xml(node)
+      node.Comissoes do |n|
+        commissions.each { |c| c.to_xml(n) }
+        n.PagadorTaxa { |pt| pt.LoginMoIP(fee_payer_login) } if fee_payer_login
+      end
+    end
+
+    def payment_receiver_to_xml(node)
+      node.Recebedor do |n|
+        n.LoginMoIP(payment_receiver_login)
+        n.Apelido(payment_receiver_name)
+      end
+    end
   end
 end

data/lib/mymoip/json_parser.rb

@@ -1,6 +1,5 @@
 module MyMoip
   class JsonParser
-
     def self.call(body, format)
       if format == :json
         JSON.parse body.match(/\?\((?<valid_json>.+)\)/)[:valid_json]
@@ -8,6 +7,5 @@ module MyMoip
         body
       end
     end
-
   end
 end

data/lib/mymoip/payer.rb

@@ -17,18 +17,18 @@ module MyMoip
     validates_length_of :address_phone, within: 10..11
 
     def initialize(attrs)
-      self.id                    = attrs[:id]                    if attrs.has_key?(:id)
-      self.name                  = attrs[:name]                  if attrs.has_key?(:name)
-      self.email                 = attrs[:email]                 if attrs.has_key?(:email)
-      self.address_street        = attrs[:address_street]        if attrs.has_key?(:address_street)
-      self.address_street_number = attrs[:address_street_number] if attrs.has_key?(:address_street_number)
-      self.address_street_extra  = attrs[:address_street_extra]  if attrs.has_key?(:address_street_extra)
-      self.address_neighbourhood = attrs[:address_neighbourhood] if attrs.has_key?(:address_neighbourhood)
-      self.address_city          = attrs[:address_city]          if attrs.has_key?(:address_city)
-      self.address_state         = attrs[:address_state]         if attrs.has_key?(:address_state)
-      self.address_country       = attrs[:address_country]       if attrs.has_key?(:address_country)
-      self.address_cep           = attrs[:address_cep]           if attrs.has_key?(:address_cep)
-      self.address_phone         = attrs[:address_phone]         if attrs.has_key?(:address_phone)
+      self.id                    = attrs[:id]
+      self.name                  = attrs[:name]
+      self.email                 = attrs[:email]
+      self.address_street        = attrs[:address_street]
+      self.address_street_number = attrs[:address_street_number]
+      self.address_street_extra  = attrs[:address_street_extra]
+      self.address_neighbourhood = attrs[:address_neighbourhood]
+      self.address_city          = attrs[:address_city]
+      self.address_state         = attrs[:address_state]
+      self.address_country       = attrs[:address_country]
+      self.address_cep           = attrs[:address_cep]
+      self.address_phone         = attrs[:address_phone]
     end
 
     def address_cep=(value)

data/mymoip.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "mymoip"
-  s.version = "0.3.1"
+  s.version = "0.4.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Irio Irineu Musskopf Junior"]
-  s.date = "2012-11-17"
+  s.date = "2012-12-01"
   s.description = "Provides a implementation of MoIP's transparent checkout."
   s.email = "irio.musskopf@caixadeideias.com.br"
   s.extra_rdoc_files = [
@@ -26,6 +26,7 @@ Gem::Specification.new do |s|
     "Rakefile",
     "VERSION",
     "lib/mymoip.rb",
+    "lib/mymoip/commission.rb",
     "lib/mymoip/credit_card.rb",
     "lib/mymoip/credit_card_payment.rb",
     "lib/mymoip/formatter.rb",
@@ -39,8 +40,10 @@ Gem::Specification.new do |s|
     "test/fixtures/fixture.rb",
     "test/fixtures/vcr_cassettes/payment_request.yml",
     "test/fixtures/vcr_cassettes/transparent_request.yml",
+    "test/fixtures/vcr_cassettes/transparent_request_with_commissions.yml",
     "test/helper.rb",
     "test/live_test.rb",
+    "test/test_commission.rb",
     "test/test_credit_card_payment.rb",
     "test/test_creditcard.rb",
     "test/test_formatter.rb",
@@ -70,7 +73,7 @@ Gem::Specification.new do |s|
       s.add_development_dependency(%q<turn>, [">= 0"])
       s.add_development_dependency(%q<mocha>, [">= 0"])
       s.add_development_dependency(%q<vcr>, [">= 0"])
-      s.add_development_dependency(%q<webmock>, [">= 0"])
+      s.add_development_dependency(%q<webmock>, ["< 1.9.0"])
     else
       s.add_dependency(%q<builder>, [">= 0"])
       s.add_dependency(%q<httparty>, [">= 0"])
@@ -81,7 +84,7 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<turn>, [">= 0"])
       s.add_dependency(%q<mocha>, [">= 0"])
       s.add_dependency(%q<vcr>, [">= 0"])
-      s.add_dependency(%q<webmock>, [">= 0"])
+      s.add_dependency(%q<webmock>, ["< 1.9.0"])
     end
   else
     s.add_dependency(%q<builder>, [">= 0"])
@@ -93,7 +96,7 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<turn>, [">= 0"])
     s.add_dependency(%q<mocha>, [">= 0"])
     s.add_dependency(%q<vcr>, [">= 0"])
-    s.add_dependency(%q<webmock>, [">= 0"])
+    s.add_dependency(%q<webmock>, ["< 1.9.0"])
   end
 end
 

data/test/fixtures/fixture.rb

@@ -41,4 +41,13 @@ class Fixture
     MyMoip::CreditCard.new(params)
   end
 
+  def self.commission(params = {})
+    params = {
+        reason: 'Because we can',
+        receiver_login: 'commissioned_indentifier',
+        fixed_value: 23.4
+    }.merge(params)
+    MyMoip::Commission.new(params)
+  end
+
 end

data/test/fixtures/vcr_cassettes/transparent_request_with_commissions.yml

@@ -0,0 +1,35 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://YOUR_MOIP_TOKEN:YOUR_MOIP_KEY@desenvolvedor.moip.com.br/sandbox/ws/alpha/EnviarInstrucao/Unica
+    body:
+      encoding: US-ASCII
+      string: <EnviarInstrucao><InstrucaoUnica TipoValidacao="Transparente"><Razao>some
+        payment_reason</Razao><Valores><Valor moeda="BRL">100.00</Valor><Valor moeda="BRL">200.00</Valor></Valores><IdProprio>your_own_instruction_id</IdProprio><Comissoes><Comissionamento><Razao>Because
+        we can</Razao><Comissionado><LoginMoIP>commissioned_id</LoginMoIP></Comissionado><ValorFixo>5</ValorFixo></Comissionamento></Comissoes><Pagador><Nome>Juquinha
+        da Rocha</Nome><Email>juquinha@rocha.com</Email><IdPagador>your_own_payer_id</IdPagador><EnderecoCobranca><Logradouro>Felipe
+        Neri</Logradouro><Numero>406</Numero><Complemento>Sala 501</Complemento><Bairro>Auxiliadora</Bairro><Cidade>Porto
+        Alegre</Cidade><Estado>RS</Estado><Pais>BRA</Pais><CEP>90440-150</CEP><TelefoneFixo>(51)3040-5060</TelefoneFixo></EnderecoCobranca></Pagador></InstrucaoUnica></EnviarInstrucao>
+    headers: {}
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Wed, 28 Nov 2012 14:20:49 GMT
+      Server:
+      - Apache/2.2.23 (CentOS)
+      Content-Length:
+      - '273'
+      Vary:
+      - Accept-Encoding
+      Content-Type:
+      - text/xml;charset=UTF-8
+    body:
+      encoding: US-ASCII
+      string: <ns1:EnviarInstrucaoUnicaResponse xmlns:ns1="http://www.moip.com.br/ws/alpha/"><Resposta><ID>YOUR_REQUEST_ID</ID><Status>Sucesso</Status><Token>YOUR_MOIP_TOKEN</Token></Resposta></ns1:EnviarInstrucaoUnicaResponse>
+    http_version: 
+  recorded_at: Wed, 28 Nov 2012 14:17:23 GMT
+recorded_with: VCR 2.2.5

data/test/helper.rb

@@ -9,7 +9,7 @@ rescue Bundler::BundlerError => e
 end
 require 'test/unit'
 require 'turn/autorun'
-require 'mocha'
+require 'mocha/setup'
 require 'vcr'
 
 VCR.configure do |c|

data/test/test_commission.rb

@@ -0,0 +1,121 @@
+require 'helper'
+
+class TestCommission < Test::Unit::TestCase
+  def test_initialization_and_setters
+    params = {
+      reason: 'Because we can',
+      receiver_login: 'comissioned_indentifier',
+      fixed_value: 23.5,
+      percentage_value: 0.15
+    }
+    subject = MyMoip::Commission.new(params)
+    assert_equal params[:reason], subject.reason
+    assert_equal params[:receiver_login], subject.receiver_login
+    assert_equal params[:fixed_value], subject.fixed_value
+    assert_equal params[:percentage_value], subject.percentage_value
+  end
+
+  def test_validate_presence_of_reason
+    subject = Fixture.commission(reason: nil)
+    assert subject.invalid? && subject.errors[:reason].present?,
+           "should be invalid without a reason"
+  end
+
+  def test_validate_presence_of_receiver_login
+    subject = Fixture.commission(receiver_login: nil)
+    assert subject.invalid? && subject.errors[:receiver_login].present?,
+           "should be invalid without a receiver_login"
+  end
+
+  def test_validate_presence_of_fixed_value_or_percentage_value
+    subject = Fixture.commission(fixed_value: nil, percentage_value: nil)
+
+    assert subject.invalid? && subject.errors[:fixed_value].present?,
+           "should be invalid without a fixed value"
+
+    assert subject.invalid? && subject.errors[:percentage_value].present?,
+           "should be invalid without a percentage value"
+
+    subject.fixed_value = 2
+    assert subject.valid?, "should be valid with only fixed value set"
+
+    subject.fixed_value = nil
+    subject.percentage_value = 0.15
+    assert subject.valid?, "should be valid with only percentage value set"
+
+    subject.fixed_value = subject.percentage_value
+    assert subject.valid?, "should be valid with both values set"
+  end
+
+
+  def test_validate_numericality_of_fixed_value
+    subject = Fixture.commission(fixed_value: "I'm not a number")
+    assert subject.invalid? && subject.errors[:fixed_value].present?,
+           "should be invalid with a non number"
+  end
+
+  def test_validate_numericality_of_percentage_value
+    subject = Fixture.commission(percentage_value: "I'm not a number", fixed_value: nil)
+    assert subject.invalid? && subject.errors[:percentage_value].present?,
+           "should be invalid with a non number"
+  end
+
+  def test_validate_positive_number_of_fixed_value
+    subject = Fixture.commission(fixed_value: -0.1)
+    assert subject.invalid? && subject.errors[:fixed_value].present?,
+           "should be invalid with negative number"
+  end
+
+  def test_validate_percentage_number_of_percentage_value
+    subject = Fixture.commission(percentage_value: -0.1, fixed_value: nil)
+    assert subject.invalid? && subject.errors[:percentage_value].present?,
+           "should be invalid if lesser than 0"
+    subject.percentage_value = 1.01
+    assert subject.invalid? && subject.errors[:percentage_value].present?,
+           "should be invalid if greater than 1"
+  end
+
+  def test_gross_amount_is_equal_to_fixed_value_when_this_is_present
+    instruction = Fixture.instruction
+    subject = Fixture.commission(fixed_value: 5, percentage_value: nil)
+    assert_equal 5, subject.gross_amount(instruction)
+  end
+
+  def test_gross_amount_with_percentage_is_equal_to_a_percentage_of_instructions_values
+    instruction = stub(gross_amount: 200)
+    subject = Fixture.commission(fixed_value: nil, percentage_value: 0.2)
+    assert_equal 40, subject.gross_amount(instruction)
+  end
+
+  def test_cannot_give_gross_amount_without_fixed_or_percentage_value_set
+    instruction = stub(gross_amount: 200)
+    subject = Fixture.commission(fixed_value: nil, percentage_value: nil)
+    assert_raise ArgumentError do
+      subject.gross_amount(instruction)
+    end
+  end
+
+  def test_xml_format_with_fixed_value
+    subject = Fixture.commission(fixed_value: 5)
+    expected_format = <<XML
+<Comissionamento><Razao>Because we can</Razao><Comissionado><LoginMoIP>commissioned_indentifier</LoginMoIP></Comissionado><ValorFixo>5</ValorFixo></Comissionamento>
+XML
+    assert_equal expected_format.rstrip, subject.to_xml
+  end
+
+  def test_xml_format_with_percentage_value
+    subject = Fixture.commission(percentage_value: 0.15, fixed_value: nil)
+    expected_format = <<XML
+<Comissionamento><Razao>Because we can</Razao><Comissionado><LoginMoIP>commissioned_indentifier</LoginMoIP></Comissionado><ValorPercentual>0.15</ValorPercentual></Comissionamento>
+XML
+    assert_equal expected_format.rstrip, subject.to_xml
+  end
+
+  def test_xml_method_raises_exception_when_called_with_invalid_params
+    subject = Fixture.commission
+    subject.stubs(:invalid?).returns(true)
+    assert_raise ArgumentError do
+      subject.to_xml
+    end
+  end
+end

data/test/test_instruction.rb

@@ -3,17 +3,26 @@ require 'helper'
 class TestInstruction < Test::Unit::TestCase
   def test_getters_for_attributes
     payer       = Fixture.payer
+    commissions = [Fixture.commission]
     instruction = MyMoip::Instruction.new(
       id: "some id",
       payment_reason: "some payment_reason",
       values: [100.0, 200.0],
-      payer: payer
+      payer: payer,
+      commissions: commissions,
+      fee_payer_login: "fee_payer_login",
+      payment_receiver_login: "payment_receiver_login",
+      payment_receiver_name: "nick_fury"
     )
 
     assert_equal "some id", instruction.id
     assert_equal "some payment_reason", instruction.payment_reason
     assert_equal [100.0, 200.0], instruction.values
     assert_equal payer, instruction.payer
+    assert_equal commissions, instruction.commissions
+    assert_equal "fee_payer_login", instruction.fee_payer_login
+    assert_equal "payment_receiver_login", instruction.payment_receiver_login
+    assert_equal "nick_fury", instruction.payment_receiver_name
   end
 
   def test_should_generate_a_string_when_converting_to_xml
@@ -32,6 +41,60 @@ XML
     assert_equal expected_format.rstrip, instruction.to_xml
   end
 
+  def test_xml_format_with_commissions
+    commissions = [Fixture.commission(fixed_value: 5), Fixture.commission(percentage_value: 0.15, fixed_value: nil)]
+    payer       = Fixture.payer
+    instruction = Fixture.instruction(payer: payer, commissions: commissions)
+    expected_format = <<XML
+<EnviarInstrucao><InstrucaoUnica TipoValidacao=\"Transparente\"><Razao>some payment_reason</Razao><Valores><Valor moeda=\"BRL\">100.00</Valor><Valor moeda=\"BRL\">200.00</Valor></Valores><IdProprio>your_own_instruction_id</IdProprio><Comissoes><Comissionamento><Razao>Because we can</Razao><Comissionado><LoginMoIP>commissioned_indentifier</LoginMoIP></Comissionado><ValorFixo>5</ValorFixo></Comissionamento><Comissionamento><Razao>Because we can</Razao><Comissionado><LoginMoIP>commissioned_indentifier</LoginMoIP></Comissionado><ValorPercentual>0.15</ValorPercentual></Comissionamento></Comissoes><Pagador><Nome>Juquinha da Rocha</Nome><Email>juquinha@rocha.com</Email><IdPagador>your_own_payer_id</IdPagador><EnderecoCobranca><Logradouro>Felipe Neri</Logradouro><Numero>406</Numero><Complemento>Sala 501</Complemento><Bairro>Auxiliadora</Bairro><Cidade>Porto Alegre</Cidade><Estado>RS</Estado><Pais>BRA</Pais><CEP>90440-150</CEP><TelefoneFixo>(51)3040-5060</TelefoneFixo></EnderecoCobranca></Pagador></InstrucaoUnica></EnviarInstrucao>
+XML
+    assert_equal expected_format.rstrip, instruction.to_xml
+  end
+
+  def test_xml_format_with_commissions_and_fee_payer
+    commissions = [Fixture.commission(fixed_value: 5), Fixture.commission(percentage_value: 0.15,fixed_value: nil)]
+    payer       = Fixture.payer
+    instruction = Fixture.instruction(payer: payer, commissions: commissions, fee_payer_login: 'fee_payer_indentifier')
+    expected_format = <<XML
+<EnviarInstrucao><InstrucaoUnica TipoValidacao=\"Transparente\"><Razao>some payment_reason</Razao><Valores><Valor moeda=\"BRL\">100.00</Valor><Valor moeda=\"BRL\">200.00</Valor></Valores><IdProprio>your_own_instruction_id</IdProprio><Comissoes><Comissionamento><Razao>Because we can</Razao><Comissionado><LoginMoIP>commissioned_indentifier</LoginMoIP></Comissionado><ValorFixo>5</ValorFixo></Comissionamento><Comissionamento><Razao>Because we can</Razao><Comissionado><LoginMoIP>commissioned_indentifier</LoginMoIP></Comissionado><ValorPercentual>0.15</ValorPercentual></Comissionamento><PagadorTaxa><LoginMoIP>fee_payer_indentifier</LoginMoIP></PagadorTaxa></Comissoes><Pagador><Nome>Juquinha da Rocha</Nome><Email>juquinha@rocha.com</Email><IdPagador>your_own_payer_id</IdPagador><EnderecoCobranca><Logradouro>Felipe Neri</Logradouro><Numero>406</Numero><Complemento>Sala 501</Complemento><Bairro>Auxiliadora</Bairro><Cidade>Porto Alegre</Cidade><Estado>RS</Estado><Pais>BRA</Pais><CEP>90440-150</CEP><TelefoneFixo>(51)3040-5060</TelefoneFixo></EnderecoCobranca></Pagador></InstrucaoUnica></EnviarInstrucao>
+XML
+    assert_equal expected_format.rstrip, instruction.to_xml
+  end
+
+  def test_xml_format_with_commissions_and_payment_receiver
+    commissions = [Fixture.commission(fixed_value: 5), Fixture.commission(percentage_value: 0.15, fixed_value: nil)]
+    payer       = Fixture.payer
+    instruction = Fixture.instruction(payer: payer, commissions: commissions,
+                                      payment_receiver_login:'payment_receiver_indentifier',
+                                      payment_receiver_name: 'nick_fury' )
+    expected_format = <<XML
+<EnviarInstrucao><InstrucaoUnica TipoValidacao=\"Transparente\"><Razao>some payment_reason</Razao><Valores><Valor moeda=\"BRL\">100.00</Valor><Valor moeda=\"BRL\">200.00</Valor></Valores><IdProprio>your_own_instruction_id</IdProprio><Comissoes><Comissionamento><Razao>Because we can</Razao><Comissionado><LoginMoIP>commissioned_indentifier</LoginMoIP></Comissionado><ValorFixo>5</ValorFixo></Comissionamento><Comissionamento><Razao>Because we can</Razao><Comissionado><LoginMoIP>commissioned_indentifier</LoginMoIP></Comissionado><ValorPercentual>0.15</ValorPercentual></Comissionamento></Comissoes><Recebedor><LoginMoIP>payment_receiver_indentifier</LoginMoIP><Apelido>nick_fury</Apelido></Recebedor><Pagador><Nome>Juquinha da Rocha</Nome><Email>juquinha@rocha.com</Email><IdPagador>your_own_payer_id</IdPagador><EnderecoCobranca><Logradouro>Felipe Neri</Logradouro><Numero>406</Numero><Complemento>Sala 501</Complemento><Bairro>Auxiliadora</Bairro><Cidade>Porto Alegre</Cidade><Estado>RS</Estado><Pais>BRA</Pais><CEP>90440-150</CEP><TelefoneFixo>(51)3040-5060</TelefoneFixo></EnderecoCobranca></Pagador></InstrucaoUnica></EnviarInstrucao>
+XML
+    assert_equal expected_format.rstrip, instruction.to_xml
+  end
+
+  def test_xml_format_with_commissions_and_payment_receiver_and_fee_payer
+    commissions = [Fixture.commission(fixed_value: 5), Fixture.commission(percentage_value: 0.15, fixed_value: nil)]
+    payer       = Fixture.payer
+    instruction = Fixture.instruction(payer: payer, commissions: commissions,
+                                      payment_receiver_login:'payment_receiver_indentifier',
+                                      payment_receiver_name: 'nick_fury',
+                                      fee_payer_login: 'fee_payer_indentifier')
+    expected_format = <<XML
+<EnviarInstrucao><InstrucaoUnica TipoValidacao=\"Transparente\"><Razao>some payment_reason</Razao><Valores><Valor moeda=\"BRL\">100.00</Valor><Valor moeda=\"BRL\">200.00</Valor></Valores><IdProprio>your_own_instruction_id</IdProprio><Comissoes><Comissionamento><Razao>Because we can</Razao><Comissionado><LoginMoIP>commissioned_indentifier</LoginMoIP></Comissionado><ValorFixo>5</ValorFixo></Comissionamento><Comissionamento><Razao>Because we can</Razao><Comissionado><LoginMoIP>commissioned_indentifier</LoginMoIP></Comissionado><ValorPercentual>0.15</ValorPercentual></Comissionamento><PagadorTaxa><LoginMoIP>fee_payer_indentifier</LoginMoIP></PagadorTaxa></Comissoes><Recebedor><LoginMoIP>payment_receiver_indentifier</LoginMoIP><Apelido>nick_fury</Apelido></Recebedor><Pagador><Nome>Juquinha da Rocha</Nome><Email>juquinha@rocha.com</Email><IdPagador>your_own_payer_id</IdPagador><EnderecoCobranca><Logradouro>Felipe Neri</Logradouro><Numero>406</Numero><Complemento>Sala 501</Complemento><Bairro>Auxiliadora</Bairro><Cidade>Porto Alegre</Cidade><Estado>RS</Estado><Pais>BRA</Pais><CEP>90440-150</CEP><TelefoneFixo>(51)3040-5060</TelefoneFixo></EnderecoCobranca></Pagador></InstrucaoUnica></EnviarInstrucao>
+XML
+    assert_equal expected_format.rstrip, instruction.to_xml
+  end
+
+  def test_to_xml_method_raises_exception_when_called_with_some_invalid_comission
+    invalid_commission = Fixture.commission
+    invalid_commission.stubs(:invalid?).returns(true)
+    subject = Fixture.instruction(commissions: [Fixture.commission, invalid_commission])
+    assert_raise ArgumentError do
+      subject.to_xml
+    end
+  end
+
   def test_to_xml_method_raises_exception_when_called_with_invalid_payer
     subject = Fixture.instruction
     MyMoip::Payer.any_instance.stubs(:invalid?).returns(true)
@@ -64,6 +127,31 @@ XML
     end
   end
 
+  def test_validate_no_presence_of_payment_receiver_in_commissions
+    commissions = [Fixture.commission(receiver_login: 'payment_receiver_id')]
+    subject = Fixture.instruction(payment_receiver_login: 'payment_receiver_id', commissions: commissions)
+    assert subject.invalid? &&  subject.errors[:payment_receiver_login].present?,
+           "should be invalid with receiver present on commissions"
+  end
+
+  def test_gross_amount
+    subject = Fixture.instruction(values: [6, 5])
+    assert_equal 11, subject.gross_amount
+  end
+
+  def test_commissions_sum
+    commissions = [Fixture.commission(fixed_value: 5), Fixture.commission(percentage_value: 0.1, fixed_value: nil)]
+    subject = Fixture.instruction(commissions: commissions, values: [10])
+    assert_equal 6, subject.commissions_sum
+  end
+
+  def test_validate_commissions_sum
+    commissions = [Fixture.commission(fixed_value: 5), Fixture.commission(fixed_value: 5)]
+    subject = Fixture.instruction(commissions: commissions, values: [6])
+    assert subject.invalid? && subject.errors[:commissions].present?,
+           "should be invalid with commissions sum greater than values sum"
+  end
+
   def test_validate_presence_of_id_attribute
     subject = Fixture.instruction
     subject.id = nil

data/test/test_transparent_request.rb

@@ -61,4 +61,12 @@ class TestTransparentRequest < Test::Unit::TestCase
     end
     assert_equal "201210171118501100000001102691", request.id
   end
+
+  def test_should_provide_the_transaction_id_get_by_the_request_with_commissions_feature
+    request = MyMoip::TransparentRequest.new("some_id")
+    VCR.use_cassette('transparent_request_with_commissions') do
+      request.api_call Fixture.instruction(commissions: [Fixture.commission])
+    end
+    assert_equal "YOUR_REQUEST_ID", request.id
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mymoip
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-17 00:00:00.000000000 Z
+date: 2012-12-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: builder
@@ -160,17 +160,17 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - <
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.9.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - <
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.9.0
 description: Provides a implementation of MoIP's transparent checkout.
 email: irio.musskopf@caixadeideias.com.br
 executables: []
@@ -188,6 +188,7 @@ files:
 - Rakefile
 - VERSION
 - lib/mymoip.rb
+- lib/mymoip/commission.rb
 - lib/mymoip/credit_card.rb
 - lib/mymoip/credit_card_payment.rb
 - lib/mymoip/formatter.rb
@@ -201,8 +202,10 @@ files:
 - test/fixtures/fixture.rb
 - test/fixtures/vcr_cassettes/payment_request.yml
 - test/fixtures/vcr_cassettes/transparent_request.yml
+- test/fixtures/vcr_cassettes/transparent_request_with_commissions.yml
 - test/helper.rb
 - test/live_test.rb
+- test/test_commission.rb
 - test/test_credit_card_payment.rb
 - test/test_creditcard.rb
 - test/test_formatter.rb
@@ -227,7 +230,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3042837852117747253
+      hash: -3065354461794399746
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: