mymoip 0.2.4 → 0.2.5

data/CHANGELOG.md

@@ -1,22 +1,29 @@
 CHANGELOG
 =========
 
+**0.2.5**
+* Request's log messages moved to debug level.
+* Make CreditCard class accept string and symbol logos.
+* Create MyMoip::CreditCard::AVAILABLE_LOGOS constant.
+* Standardise Request#api_call parameters.
+
 **0.2.4**
+* Fix American Express logo format expected by Moip.
 
 **0.2.3**
 * Remove .rvmrc
-* CreditCardPayment's initialization can now receive a hash of options
-* lib/requests folder created
-* Requests has methods to return its response id
+* CreditCardPayment's initialization can now receive a hash of options.
+* lib/requests folder created.
+* Requests has methods to return its response id.
 
 **0.2.2**
-* Explicitly require order for Requests classes
+* Explicitly require order for Requests classes.
 
 **0.2.1**
 * Bugfix related to explicitly require MyMoip class being needed.
 
 **0.2.0**
-* Update production url from `https://desenvolvedor.moip.com.br` to `https://www.moip.com.br`
+* Update production url from `https://desenvolvedor.moip.com.br` to `https://www.moip.com.br`.
 
 **0.1.0**
 * First version of the gem.

data/README.md

@@ -37,7 +37,7 @@ MyMoip.key   = "your_moip_dev_key"
 **First request: what and from who**
 ```ruby
 payer = MyMoip::Payer.new(
-  id: "your_own_id",
+  id: "payer_id_defined_by_you",
   name: "Juquinha da Rocha",
   email: "juquinha@rocha.com",
   address_street: "Felipe Neri",
@@ -52,13 +52,13 @@ payer = MyMoip::Payer.new(
 ) # 9 digit phones must be in "(11)93040-5060" format
 
 instruction = MyMoip::Instruction.new(
-  id: "your_own_id",
+  id: "instruction_id_defined_by_you",
   payment_reason: "Order in Buy Everything Store",
   values: [100.0],
   payer: payer
 )
 
-transparent_request = MyMoip::TransparentRequest.new("your_own_id")
+transparent_request = MyMoip::TransparentRequest.new("your_logging_id")
 transparent_request.api_call(instruction)
 ```
 
@@ -76,7 +76,7 @@ credit_card = MyMoip::CreditCard.new(
 )
 
 credit_card_payment = MyMoip::CreditCardPayment.new(credit_card, installments: 1)
-payment_request = MyMoip::PaymentRequest.new("your_own_id")
+payment_request = MyMoip::PaymentRequest.new("your_logging_id")
 payment_request.api_call(credit_card_payment, token: transparent_request.token)
 ```
 

data/VERSION

@@ -1 +1 @@
-0.2.4
+0.2.5

data/lib/mymoip/credit_card.rb

@@ -3,6 +3,10 @@ module MyMoip
     attr_accessor :logo, :card_number, :expiration_date, :security_code,
                 :owner_name, :owner_birthday, :owner_phone, :owner_rg
 
+    AVAILABLE_LOGOS = [
+      :american_express, :diners, :hipercard, :mastercard, :visa
+    ]
+
     def initialize(params)
       @logo            = params[:logo]            if params.has_key? :logo
       @card_number     = params[:card_number]     if params.has_key? :card_number

data/lib/mymoip/credit_card_payment.rb

@@ -37,7 +37,7 @@ module MyMoip
         hipercard:        "Hipercard",
         mastercard:       "Mastercard",
         visa:             "Visa"
-      }.fetch credit_card.logo
+      }.fetch(credit_card.logo.to_sym)
 
       if cash?
         json[:Recebimento] = "AVista"

data/lib/mymoip/request.rb

@@ -8,19 +8,20 @@ module MyMoip
       @id = id
     end
 
-    def api_call(params, logger = nil, username = MyMoip.token, password = MyMoip.key)
-      logger   ||= MyMoip.logger
-      username ||= MyMoip.token
-      password ||= MyMoip.key
+    def api_call(params, opts = {})
+      opts[:logger]   ||= MyMoip.logger
+      opts[:username] ||= MyMoip.token
+      opts[:password] ||= MyMoip.key
 
-      logger.info "MyMoip::Request of ##{@id} with #{params[:body].inspect}"
+      opts[:logger].info "New #{self.class} being sent to MoIP."
+      opts[:logger].debug "#{self.class} of ##{@id} with #{params.inspect}"
 
       url = MyMoip.api_url + params.delete(:path)
-      params[:basic_auth] = { username: username, password: password }
+      params[:basic_auth] = { username: opts[:username], password: opts[:password] }
 
       @response = HTTParty.send params.delete(:http_method), url, params
 
-      logger.info "MyMoip::Request of ##{@id} to #{url} had response #{@response}"
+      opts[:logger].debug "#{self.class} of ##{@id} to #{url} had response #{@response.inspect}"
     end
   end
 end

data/lib/mymoip/requests/payment_request.rb

@@ -6,14 +6,14 @@ module MyMoip
     REQUIRES_AUTH = false
     FORMAT        = :json
 
-    def api_call(data, extra_attrs)
-      extra_attrs[:referer_url] ||= MyMoip.default_referer_url
-      extra_attrs[:parser]      ||= MyMoip::JsonParser
+    def api_call(data, opts)
+      opts[:referer_url] ||= MyMoip.default_referer_url
+      opts[:parser]      ||= MyMoip::JsonParser
 
       json = JSON.generate({
         pagamentoWidget: {
-          referer:        extra_attrs[:referer_url],
-          token:          extra_attrs[:token],
+          referer:        opts[:referer_url],
+          token:          opts[:token],
           dadosPagamento: data.to_json
         }
       })
@@ -25,9 +25,9 @@ module MyMoip
         path:          PATH,
         format:        FORMAT
       }
-      params[:parser] = extra_attrs.delete :parser unless extra_attrs[:parser].nil?
+      params[:parser] = opts.delete(:parser) unless opts[:parser].nil?
 
-      super params
+      super(params)
     end
 
     def success?

data/lib/mymoip/requests/transparent_request.rb

@@ -5,16 +5,15 @@ module MyMoip
     PATH          = "/ws/alpha/EnviarInstrucao/Unica"
     REQUIRES_AUTH = true
 
-    def api_call(data, logger = MyMoip.logger)
+    def api_call(data, opts = {})
       params = {
         body:          data.to_xml,
         http_method:   HTTP_METHOD,
         requires_auth: REQUIRES_AUTH,
-        path:          PATH,
-        logger:        logger
+        path:          PATH
       }
 
-      super params
+      super(params, opts)
     end
 
     def success?

data/mymoip.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "mymoip"
-  s.version = "0.2.4"
+  s.version = "0.2.5"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Irio Irineu Musskopf Junior"]
-  s.date = "2012-10-18"
+  s.date = "2012-10-28"
   s.description = "Provides a implementation of MoIP's transparent checkout."
   s.email = "irio.musskopf@caixadeideias.com.br"
   s.extra_rdoc_files = [

data/test/fixtures/fixture.rb

@@ -25,8 +25,8 @@ class Fixture
     )
   end
 
-  def self.credit_card
-    MyMoip::CreditCard.new(
+  def self.credit_card(params = {})
+    params = {
       logo: :visa,
       card_number: "4916654211627608",
       expiration_date: "06/15",
@@ -35,7 +35,8 @@ class Fixture
       owner_birthday: Date.new(1984, 11, 3),
       owner_phone: "(51)3040-5060",
       owner_rg: "1010202030"
-    )
+    }.merge(params)
+    MyMoip::CreditCard.new(params)
   end
 
 end

data/test/test_credit_card_payment.rb

@@ -52,4 +52,18 @@ class TestCreditCardPayment < Test::Unit::TestCase
     assert_match /\A\d+\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_should_accept_any_creditcard_logo_as_string
+    MyMoip::CreditCard::AVAILABLE_LOGOS.each do |logo|
+      payment = MyMoip::CreditCardPayment.new(Fixture.credit_card(logo: logo.to_s))
+      assert_nothing_raised(KeyError) { payment.to_json }
+    end
+  end
+
 end

data/test/test_payment_request.rb

@@ -46,7 +46,7 @@ class TestPaymentRequest < Test::Unit::TestCase
     request.api_call(request_data, token: "big_transparent_token")
   end
 
-  def test_succesful_status
+  def test_successful_status
     MyMoip.default_referer_url = "http://localhost/default"
     HTTParty.stubs(:send).returns(
       JSON.parse '{"Status":"EmAnalise","Codigo":0,"CodigoRetorno":"","TaxaMoIP":"7.79","StatusPagamento":"Sucesso","Classificacao":{"Codigo":999,"Descricao":"Não suportado no ambiente Sandbox"},"CodigoMoIP":77316,"Mensagem":"Requisição processada com sucesso","TotalPago":"100.00"}'

data/test/test_request.rb

@@ -6,7 +6,7 @@ class TestRequest < Test::Unit::TestCase
     assert_equal "request_id", request.id
   end
 
-  def test_logs_api_call_method
+  def test_logs_api_call_method_in_info_level
     logger = stub_everything
     request = MyMoip::Request.new("request_id")
     params = {
@@ -15,12 +15,12 @@ class TestRequest < Test::Unit::TestCase
 
     HTTParty.stubs(:send).returns("<html>some_result</html>")
     logger.expects(:info).at_least_once.
-      with(regexp_matches(/request_id.+<html>some_result<\/html>/))
+      with(regexp_matches(/being sent to MoIP/))
 
-    request.api_call(params, logger)
+    request.api_call(params, logger: logger)
   end
 
-  def test_logs_api_call_response
+  def test_logs_api_call_method_parameters_in_debug_level
     logger = stub_everything
     request = MyMoip::Request.new("request_id")
     params = {
@@ -28,10 +28,24 @@ class TestRequest < Test::Unit::TestCase
     }
 
     HTTParty.stubs(:send).returns("<html>some_result</html>")
-    logger.expects(:info).at_least_once.
+    logger.expects(:debug).at_least_once.
+      with(regexp_matches(/request_id.+<pretty><xml><\/xml><\/pretty>/))
+
+    request.api_call(params, logger: logger)
+  end
+
+  def test_logs_api_call_response_in_debug_level
+    logger = stub_everything
+    request = MyMoip::Request.new("request_id")
+    params = {
+      http_method: :post, body: "<pretty><xml></xml></pretty>", path: "/ws/alpha/EnviarInstrucao/Unica"
+    }
+
+    HTTParty.stubs(:send).returns("<html>some_result</html>")
+    logger.expects(:debug).at_least_once.
       with(regexp_matches(/request_id.+<html>some_result<\/html>/))
 
-    request.api_call(params, logger)
+    request.api_call(params, logger: logger)
   end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mymoip
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.2.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-18 00:00:00.000000000 Z
+date: 2012-10-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: builder
@@ -209,7 +209,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3682767016896274367
+      hash: -300341393790101532
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: