mymoip 0.6.1 → 0.6.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 401ae2832ae5de6b706bf0581872a9554bd06f7e
+  data.tar.gz: d8ec3a961608600adae70bd42211e07ea9aae631
+SHA512:
+  metadata.gz: e5b9b24159c3122829f406ee1e09e19db8f087f3d4e63474461b57cab065a6095aec3d7f984b6b7f2516108f94bf1e21a55800d30c7467747c7f6aa320b6e80a
+  data.tar.gz: f3bfdf0541cab984fbf4f535fe01725a83670e4429120407d6d535b9d04ef7e7e9689ca39cebbaff0320106998898c7bfc394657f04b9a3ee20022847d7d2c46

data/.gitignore

@@ -0,0 +1,15 @@
+# rdoc generated
+rdoc
+
+# yard generated
+doc
+.yardoc
+
+# bundler
+.bundle
+
+# jeweler generated
+pkg
+
+# Bundler
+Gemfile.lock

data/CHANGELOG.md

@@ -1,10 +1,28 @@
 # CHANGELOG
 
+## 0.6.2
+
+* Removed development dependency of jeweler. Gems are now managed
+directly in .gemspec file.
+* Offer a easier way to manage purchase implementations that don't have
+many customizations over passing some attribute list, making the
+checkout and getting a successful (or not) response. Through
+MyMoip::Purchase.
+* Accept string keys in initializers of CreditCard and Payer classes.
+
+## 0.6.1
+
+* Send 2 decimal place numbers in fixed and percentage values nodes of
+Comission's XML. Percentage values are required to be in a 0 to 100 range.
+Reported by @zangrandi.
+
 ## 0.6.0
+
 * Add support for Ruby 2.0.
 * Improved installments option for Instructions.
 
 ## 0.5.0
+
 * Breaking backward compatibility with exceptions raised. ArgumentError
 is not used anymore. New MyMoip::InvalidComission, MyMoip::InvalidCreditCard,
 MyMoip::InvalidInstruction and MyMoip::InvalidPayer exceptions inherited from

data/README.md

@@ -50,29 +50,29 @@ purchase_id       = 'UNIQUE_PURCHASE_ID'
 transaction_price = 100.0
 
 card_attrs = {
-  logo:            'visa',
-  card_number:     '4916654211627608',
-  expiration_date: '06/15',
-  security_code:   '000',
-  owner_name:      'Juquinha da Rocha',
-  owner_birthday:  '03/11/1980',
-  owner_phone:     '5130405060',
-  owner_cpf:       '52211670695'
+ 'logo'            => 'visa',
+ 'card_number'     => '4916654211627608',
+ 'expiration_date' => '06/15',
+ 'security_code'   => '000',
+ 'owner_name'      => 'Juquinha da Rocha',
+ 'owner_birthday'  => '03/11/1980',
+ 'owner_phone'     => '5130405060',
+ 'owner_cpf'       => '52211670695'
 }
 
 payer_attrs = {
-  id:                    'payer_id_defined_by_you',
-  name:                  'Juquinha da Rocha',
-  email:                 'juquinha@rocha.com',
-  address_street:        'Felipe Neri',
-  address_street_number: '406',
-  address_street_extra:  'Sala 501',
-  address_neighbourhood: 'Auxiliadora',
-  address_city:          'Porto Alegre',
-  address_state:         'RS',
-  address_country:       'BRA',
-  address_cep:           '90440150',
-  address_phone:         '5130405060'
+  'id'                    => 'payer_id_defined_by_you',
+  'name'                  => 'Juquinha da Rocha',
+  'email'                 => 'juquinha@rocha.com',
+  'address_street'        => 'Felipe Neri',
+  'address_street_number' => '406',
+  'address_street_extra'  => 'Sala 501',
+  'address_neighbourhood' => 'Auxiliadora',
+  'address_city'          => 'Porto Alegre',
+  'address_state'         => 'RS',
+  'address_country'       => 'BRA',
+  'address_cep'           => '90440150',
+  'address_phone'         => '5130405060'
 }
 
 purchase = MyMoip::Purchase.new(

data/lib/mymoip/commission.rb

@@ -41,8 +41,12 @@ module MyMoip
       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
+        if fixed_value
+          n1.ValorFixo(sprintf('%.2f', fixed_value))
+        end
+        if percentage_value
+          n1.ValorPercentual(sprintf('%.2f', percentage_value * 100))
+        end
       end
 
       xml

data/lib/mymoip/credit_card.rb

@@ -16,17 +16,9 @@ module MyMoip
     validates_inclusion_of :logo, in: AVAILABLE_LOGOS
 
     def initialize(attrs)
-      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)
+      attrs.each do |attr, value|
+        public_send(:"#{attr}=", value)
+      end
     end
 
     def logo=(value)

data/lib/mymoip/payer.rb

@@ -17,18 +17,9 @@ module MyMoip
     validates_length_of :address_phone, within: 10..11
 
     def initialize(attrs)
-      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]
+      attrs.each do |attr, value|
+        public_send(:"#{attr}=", value)
+      end
     end
 
     def address_cep=(value)

data/lib/mymoip/purchase.rb

@@ -0,0 +1,40 @@
+module MyMoip
+  class Purchase
+    attr_accessor :id, :price, :credit_card, :payer, :reason
+    attr_reader :code
+
+    def initialize(attrs)
+      @id          = attrs.fetch(:id) { rand }
+      @price       = attrs.fetch(:price)
+      @credit_card = MyMoip::CreditCard.new(attrs.fetch(:credit_card))
+      @payer       = MyMoip::Payer.new(attrs.fetch(:payer))
+      @reason      = attrs.fetch(:reason)
+    end
+
+    def checkout!
+      authorization = get_authorization!
+      payment = MyMoip::CreditCardPayment.new(@credit_card,
+                                              installments: 1)
+      request = MyMoip::PaymentRequest.new(@id)
+      request.api_call(payment, token: authorization.token)
+
+      @code = request.code
+      request.success?
+    end
+
+    private
+
+    def get_authorization!
+      instruction = MyMoip::Instruction.new(
+        id:             @id,
+        payment_reason: @reason,
+        values:         [@price],
+        payer:          @payer
+      )
+
+      request = MyMoip::TransparentRequest.new(@id)
+      request.api_call(instruction)
+      request
+    end
+  end
+end

data/lib/mymoip/version.rb

@@ -0,0 +1,3 @@
+module MyMoip
+  VERSION = '0.6.2'
+end

data/mymoip.gemspec

@@ -1,91 +1,30 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
-# -*- encoding: utf-8 -*-
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mymoip/version'
 
-Gem::Specification.new do |s|
-  s.name = "mymoip"
-  s.version = "0.6.1"
+Gem::Specification.new do |spec|
+  spec.name          = "mymoip"
+  spec.version       = MyMoip::VERSION
+  spec.authors       = ["Irio Irineu Musskopf Junior"]
+  spec.email         = ["iirineu@gmail.com"]
+  spec.description   = %q{The easier way to use Moip's transparent checkout.}
+  spec.summary       = %q{MoIP transactions in a gem to call your own.}
+  spec.homepage      = "https://github.com/Irio/mymoip"
+  spec.license       = "MIT"
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Irio Irineu Musskopf Junior"]
-  s.date = "2013-06-13"
-  s.description = "Provides a implementation of MoIP's transparent checkout."
-  s.email = "irio.musskopf@caixadeideias.com.br"
-  s.extra_rdoc_files = [
-    "LICENSE.txt",
-    "README.md"
-  ]
-  s.files = [
-    ".document",
-    ".travis.yml",
-    "CHANGELOG.md",
-    "Gemfile",
-    "LICENSE.txt",
-    "README.md",
-    "Rakefile",
-    "lib/mymoip.rb",
-    "lib/mymoip/commission.rb",
-    "lib/mymoip/credit_card.rb",
-    "lib/mymoip/credit_card_payment.rb",
-    "lib/mymoip/exceptions.rb",
-    "lib/mymoip/formatter.rb",
-    "lib/mymoip/instruction.rb",
-    "lib/mymoip/json_parser.rb",
-    "lib/mymoip/payer.rb",
-    "lib/mymoip/request.rb",
-    "lib/mymoip/requests/payment_request.rb",
-    "lib/mymoip/requests/transparent_request.rb",
-    "mymoip.gemspec",
-    "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/live_test.rb"
-  ]
-  s.homepage = "http://github.com/Irio/mymoip"
-  s.licenses = ["MIT"]
-  s.require_paths = ["lib"]
-  s.rubygems_version = "1.8.23"
-  s.summary = "MoIP transactions in a gem to call your own."
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
 
-  if s.respond_to? :specification_version then
-    s.specification_version = 3
-
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<builder>, [">= 0"])
-      s.add_runtime_dependency(%q<httparty>, [">= 0"])
-      s.add_runtime_dependency(%q<activemodel>, [">= 0"])
-      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
-      s.add_development_dependency(%q<bundler>, [">= 0"])
-      s.add_development_dependency(%q<jeweler>, ["~> 1.8.4"])
-      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"])
-    else
-      s.add_dependency(%q<builder>, [">= 0"])
-      s.add_dependency(%q<httparty>, [">= 0"])
-      s.add_dependency(%q<activemodel>, [">= 0"])
-      s.add_dependency(%q<rdoc>, ["~> 3.12"])
-      s.add_dependency(%q<bundler>, [">= 0"])
-      s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
-      s.add_dependency(%q<turn>, [">= 0"])
-      s.add_dependency(%q<mocha>, [">= 0"])
-      s.add_dependency(%q<vcr>, [">= 0"])
-      s.add_dependency(%q<webmock>, [">= 0"])
-    end
-  else
-    s.add_dependency(%q<builder>, [">= 0"])
-    s.add_dependency(%q<httparty>, [">= 0"])
-    s.add_dependency(%q<activemodel>, [">= 0"])
-    s.add_dependency(%q<rdoc>, ["~> 3.12"])
-    s.add_dependency(%q<bundler>, [">= 0"])
-    s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
-    s.add_dependency(%q<turn>, [">= 0"])
-    s.add_dependency(%q<mocha>, [">= 0"])
-    s.add_dependency(%q<vcr>, [">= 0"])
-    s.add_dependency(%q<webmock>, [">= 0"])
-  end
+  spec.add_dependency "activemodel"
+  spec.add_dependency "builder"
+  spec.add_dependency "httparty"
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "mocha"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rdoc",    "~> 3.12"
+  spec.add_development_dependency "vcr"
+  spec.add_development_dependency "webmock"
 end
-

data/test/lib/test_commission.rb

@@ -0,0 +1,121 @@
+require_relative '../test_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 MyMoip::InvalidComission 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.00</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>15.00</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 MyMoip::InvalidComission do
+      subject.to_xml
+    end
+  end
+end

data/test/lib/test_credit_card_payment.rb

@@ -0,0 +1,114 @@
+require_relative '../test_helper'
+
+class TestCreditCardPayment < Test::Unit::TestCase
+  def test_initialization_and_getters
+    credit_card = Fixture.credit_card
+    subject = MyMoip::CreditCardPayment.new(credit_card, 1)
+    assert_equal credit_card, subject.credit_card
+    assert_equal 1, subject.installments
+  end
+
+  def test_allow_initialization_with_a_hash_of_options
+    credit_card = Fixture.credit_card
+    subject = MyMoip::CreditCardPayment.new(credit_card, installments: 2)
+    assert_equal credit_card, subject.credit_card
+    assert_equal 2, subject.installments
+  end
+
+  def test_cash_method_with_one_tranch
+    credit_card = Fixture.credit_card
+    subject = MyMoip::CreditCardPayment.new(credit_card, 1)
+    assert_equal true, subject.cash?
+  end
+
+  def test_cash_method_with_more_than_one_installments
+    credit_card = Fixture.credit_card
+    subject = MyMoip::CreditCardPayment.new(credit_card, 3)
+    assert_equal false, subject.cash?
+  end
+
+  def test_default_initialization_with_one_tranch
+    credit_card = Fixture.credit_card
+    subject = MyMoip::CreditCardPayment.new(credit_card)
+    assert_equal 1, subject.installments
+  end
+
+  def test_json_format
+    payment = MyMoip::CreditCardPayment.new(Fixture.credit_card)
+    assert_equal "CartaoCredito", payment.to_json[:Forma]
+    assert payment.to_json[:Parcelas].kind_of?(Integer), "'Parcelas' must be a kind of integer."
+  end
+
+  def test_json_credit_card_format
+    payment = MyMoip::CreditCardPayment.new(Fixture.credit_card)
+    assert_match /\A\d+\z/, payment.to_json[:CartaoCredito][:Numero]
+    assert_match /\A((0[1-9])|(1[02]))\/\d{2}\z/, payment.to_json[:CartaoCredito][:Expiracao]
+    assert_match /\A\d{3}\z/, payment.to_json[:CartaoCredito][:CodigoSeguranca]
+    original_date = Date.new(1980, 11, 3)
+    MyMoip::Formatter.stubs(:date).returns('03/11/1980')
+    assert_equal '03/11/1980', payment.to_json[:CartaoCredito][:Portador][:DataNascimento]
+    assert_match /\A\(\d{2}\)\d{4,5}-\d{4}/, payment.to_json[:CartaoCredito][:Portador][:Telefone]
+    assert_match /\A\d{3}\.\d{3}\.\d{3}\-\d{2}\z/, payment.to_json[:CartaoCredito][:Portador][:Identidade]
+  end
+
+  def test_to_json_should_accept_any_creditcard_from_available_logos_constant
+    MyMoip::CreditCard::AVAILABLE_LOGOS.each do |logo|
+      payment = MyMoip::CreditCardPayment.new(Fixture.credit_card(logo: logo))
+      assert_nothing_raised(KeyError) { payment.to_json }
+    end
+  end
+
+  def test_to_json_method_uses_the_formatted_version_of_the_credit_cards_owner_birthday
+    date = Date.new(2040, 10, 30)
+    subject = MyMoip::CreditCardPayment.new(Fixture.credit_card(owner_birthday: date))
+    formatter = stub_everything('formatter')
+    formatter.expects(:date).with(date)
+    subject.to_json(formatter)
+  end
+
+  def test_to_json_method_skip_formatting_when_credit_cards_owner_birthday_is_nil
+    subject = MyMoip::CreditCardPayment.new(Fixture.credit_card(owner_birthday: nil))
+    formatter = stub_everything('formatter')
+    formatter.stubs(:date).with(nil).returns('should not be here')
+    json = subject.to_json(formatter)
+    assert_nil json[:CartaoCredito][:Portador][:DataNascimento]
+  end
+
+  def test_to_json_method_uses_the_formatted_version_of_the_credit_cards_owner_phone
+    subject = MyMoip::CreditCardPayment.new(Fixture.credit_card(owner_phone: '5130405060'))
+    formatter = stub_everything('formatter')
+    formatter.expects(:phone).with('5130405060')
+    subject.to_json(formatter)
+  end
+
+  def test_to_json_method_skip_formatting_when_credit_cards_owner_phone_is_nil
+    subject = MyMoip::CreditCardPayment.new(Fixture.credit_card(owner_phone: nil))
+    formatter = stub_everything('formatter')
+    formatter.stubs(:phone).with(nil).returns('should not be here')
+    json = subject.to_json(formatter)
+    assert_nil json[:CartaoCredito][:Portador][:Telefone]
+  end
+
+  def test_to_json_method_raises_an_exception_when_called_without_a_credit_card
+    subject = MyMoip::CreditCardPayment.new(nil)
+    assert_raise MyMoip::InvalidCreditCard do
+      subject.to_json
+    end
+  end
+
+  def test_to_json_method_skip_formatting_when_credit_cards_owner_cpf_is_nil
+    subject = MyMoip::CreditCardPayment.new(Fixture.credit_card(owner_cpf: nil))
+    formatter = stub_everything('formatter')
+    formatter.stubs(:cpf).with(nil).returns('should not be here')
+    json = subject.to_json(formatter)
+    assert_nil json[:CartaoCredito][:Portador][:Identidade]
+  end
+
+  def test_to_json_method_raises_an_exception_when_called_with_a_invalid_credit_card
+    subject = MyMoip::CreditCardPayment.new(Fixture.credit_card)
+    MyMoip::CreditCard.any_instance.stubs(:invalid?).returns(true)
+    assert_raise MyMoip::InvalidCreditCard do
+      subject.to_json
+    end
+  end
+end