mymoip 0.6.0 → 0.6.1

data/Gemfile

@@ -1,15 +1,4 @@
-source 'http://rubygems.org'
+source 'https://rubygems.org'
 
-gem 'builder'
-gem 'httparty'
-gem 'activemodel'
-
-group :development do
-  gem 'rdoc',    '~> 3.12'
-  gem 'bundler', '>= 0'
-  gem 'jeweler', '~> 1.8.4'
-  gem 'turn'
-  gem 'mocha', require: false
-  gem 'vcr'
-  gem 'webmock'
-end
+# Specify your gem's dependencies in new_gem.gemspec
+gemspec

data/README.md

@@ -2,9 +2,9 @@
 
 MoIP transactions in a gem to call your own.
 
-Provides a implementation of MoIP's transparent checkout.
+The easier way to use Moip's transparent checkout.
 
-Planning to use with Rails? Check [my_moip-rails](https://github.com/Irio/my_moip-rails).
+Planning to use with Rails? Check [my_moip-rails](https://github.com/Irio/my_moip-rails) too.
 
 ## Contributing to MyMoip
 
@@ -14,80 +14,130 @@ Climate](https://codeclimate.com/github/Irio/mymoip.png)](https://codeclimate.co
 
 What would you do if you could make your own implementation of MoIP?
 
-Any patch are welcome, even removing extra blank spaces.
+Any patch are welcome, even removing extra white spaces.
 
 1. Open a pull request.
 2. Done.
 
-## Using
+# Using
 
-Currently under active development.
+## First of all
 
 **Bundler - Gemfile**
 ```ruby
 gem 'mymoip'
 ```
 
-### Configuration
+**Configuration**
 ```ruby
-MyMoip.environment = "production" # "sandbox" by default
+MyMoip.environment = 'production' # 'sandbox' by default
 
-MyMoip.sandbox_token    = "your_moip_sandbox_token"
-MyMoip.sandbox_key      = "your_moip_sandbox_key"
+MyMoip.sandbox_token    = 'your_moip_sandbox_token'
+MyMoip.sandbox_key      = 'your_moip_sandbox_key'
 
-MyMoip.production_token = "your_moip_production_token"
-MyMoip.production_key   = "your_moip_production_key"
+MyMoip.production_token = 'your_moip_production_token'
+MyMoip.production_key   = 'your_moip_production_key'
 ```
 
-### First request: what and from who
+## The easy way
 
+If you just need to pass some attributes and get if the payment based on them was succesfull or not, this can be your start point.
+
+The payer attributes will be sent to Moip to be stored as your client, identified by... his id. If you don't want to, on each payment, ask your user to all his data, you can always save them in your database.
+
+```ruby
+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'
+}
+
+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'
+}
+
+purchase = MyMoip::Purchase.new(
+  id:          purchase_id,
+  price:       transaction_price,
+  reason:      'Payment of my product',
+  credit_card: card_attrs,
+  payer:       payer_attrs
+)
+purchase.checkout! # => true OR false (succesfull state)
+purchase.code # Moip code or nil, depending of the checkout's return
+```
+
+## The hard way
+
+**First request: what and from who**
 ```ruby
 payer = MyMoip::Payer.new(
-  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'
 )
 
 instruction = MyMoip::Instruction.new(
-  id: "instruction_id_defined_by_you",
-  payment_reason: "Order in Buy Everything Store",
-  values: [100.0],
-  payer: payer
+  id:             'instruction_id_defined_by_you',
+  payment_reason: 'Order in Buy Everything Store',
+  values:         [100.0],
+  payer:          payer
 )
 
-transparent_request = MyMoip::TransparentRequest.new("your_logging_id")
+transparent_request = MyMoip::TransparentRequest.new('your_logging_id')
 transparent_request.api_call(instruction)
 ```
 
-### Second request: how
+**Second request: how**
 
 ```ruby
 credit_card = MyMoip::CreditCard.new(
-  logo: :visa,
-  card_number: "4916654211627608",
-  expiration_date: "06/15",
-  security_code: "000",
-  owner_name: "Juquinha da Rocha",
-  owner_birthday: "03/11/1984",
-  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/1984',
+  owner_phone:     '5130405060',
+  owner_cpf:       '52211670695'
 )
 
-credit_card_payment = MyMoip::CreditCardPayment.new(credit_card, installments: 1)
-payment_request = MyMoip::PaymentRequest.new("your_logging_id")
-payment_request.api_call(credit_card_payment, token: transparent_request.token)
+credit_card_payment = MyMoip::CreditCardPayment.new(credit_card,
+                                                    installments: 1)
+payment_request = MyMoip::PaymentRequest.new('your_logging_id')
+payment_request.api_call(credit_card_payment,
+                         token: transparent_request.token)
 ```
 
-### Success?
+**Success?**
 ```ruby
 payment_request.success?
 ```
@@ -106,27 +156,27 @@ Choosing between commission with fixed or percentage value.
 
 ```ruby
 commissions = [MyMoip::Commission.new(
-  reason: 'System maintenance',
+  reason:         'System maintenance',
   receiver_login: 'commissioned_moip_login',
-  fixed_value: 15.0
+  fixed_value:    15.0
 )]
 
 # OR
 
 commissions = [MyMoip::Commission.new(
-  reason: 'Shipping',
-  receiver_login: 'commissioned_moip_login',
+  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
+  id:             'instruction_id_defined_by_you',
+  payment_reason: 'Order in Buy Everything Store',
+  values:         [100.0],
+  payer:          payer,
+  commissions:    commissions
 )
 ```
 
@@ -146,11 +196,11 @@ installments = [
 ]
 
 MyMoip::Instruction.new(
-  id: "instruction_id_defined_by_you",
-  payment_reason: "Order in Buy Everything Store",
-  values: [100.0],
-  payer: payer,
-  installments: installments
+  id:             'instruction_id_defined_by_you',
+  payment_reason: 'Order in Buy Everything Store',
+  values:         [100.0],
+  payer:          payer,
+  installments:   installments
 )
 ```
 

data/Rakefile

@@ -1,45 +1,10 @@
-# encoding: utf-8
-
-require 'rubygems'
-require 'bundler'
-begin
-  Bundler.setup(:default, :development)
-rescue Bundler::BundlerError => e
-  $stderr.puts e.message
-  $stderr.puts "Run `bundle install` to install missing gems"
-  exit e.status_code
-end
-require 'rake'
-
-require 'jeweler'
-Jeweler::Tasks.new do |gem|
-  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
-  gem.name = "mymoip"
-  gem.homepage = "http://github.com/Irio/mymoip"
-  gem.license = "MIT"
-  gem.summary = "MoIP transactions in a gem to call your own."
-  gem.description = "Provides a implementation of MoIP's transparent checkout."
-  gem.email = "irio.musskopf@caixadeideias.com.br"
-  gem.authors = ["Irio Irineu Musskopf Junior"]
-  # dependencies defined in Gemfile
-end
-Jeweler::RubygemsDotOrgTasks.new
-
+require 'bundler/gem_tasks'
 require 'rake/testtask'
-Rake::TestTask.new(:test) do |test|
-  test.libs << 'lib' << 'test'
-  test.pattern = 'test/**/test_*.rb'
-  test.verbose = true
-end
-
-task :default => :test
-
-require 'rdoc/task'
-Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
-
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "mymoip #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
+ 
+Rake::TestTask.new do |t|
+  t.libs << 'lib/mymoip'
+  t.test_files = FileList['test/test_*.rb']
+  t.verbose = true
+end
+ 
+task default: :test

data/lib/mymoip/request.rb

@@ -13,6 +13,10 @@ module MyMoip
       opts[:username] ||= MyMoip.token
       opts[:password] ||= MyMoip.key
 
+      unless opts[:username].present? && opts[:password].present?
+        MyMoip.ensure_key_and_token_set!
+      end
+
       opts[:logger].info "New #{self.class} being sent to MoIP."
       opts[:logger].debug "#{self.class} of ##{@id} with #{params.inspect}"
 

data/lib/mymoip.rb

@@ -35,6 +35,14 @@ module MyMoip
     def token
       send(:"#{environment}_token")
     end
+
+    def ensure_key_and_token_set!
+      if MyMoip.key.blank?
+        raise StandardError, "Invalid MyMoip.#{environment}_key set."
+      elsif MyMoip.token.blank?
+        raise StandardError, "Invalid MyMoip.#{environment}_token set."
+      end
+    end
   end
 end
 

data/mymoip.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "mymoip"
-  s.version = "0.6.0"
+  s.version = "0.6.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Irio Irineu Musskopf Junior"]
-  s.date = "2013-04-27"
+  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 = [
@@ -24,7 +24,6 @@ Gem::Specification.new do |s|
     "LICENSE.txt",
     "README.md",
     "Rakefile",
-    "VERSION",
     "lib/mymoip.rb",
     "lib/mymoip/commission.rb",
     "lib/mymoip/credit_card.rb",
@@ -42,18 +41,7 @@ Gem::Specification.new do |s|
     "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",
-    "test/test_instruction.rb",
-    "test/test_mymoip.rb",
-    "test/test_payer.rb",
-    "test/test_payment_request.rb",
-    "test/test_request.rb",
-    "test/test_transparent_request.rb"
+    "test/live_test.rb"
   ]
   s.homepage = "http://github.com/Irio/mymoip"
   s.licenses = ["MIT"]

data/test/live_test.rb

@@ -1,4 +1,4 @@
-require './lib/mymoip'
+require_relative '../lib/mymoip'
 
 MyMoip.sandbox_token = 'YOUR_MOIP_TOKEN'
 MyMoip.sandbox_key   = 'YOUR_MOIP_KEY'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mymoip
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.6.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-27 00:00:00.000000000 Z
+date: 2013-06-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: builder
@@ -186,7 +186,6 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- VERSION
 - lib/mymoip.rb
 - lib/mymoip/commission.rb
 - lib/mymoip/credit_card.rb
@@ -204,18 +203,7 @@ files:
 - 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
-- test/test_instruction.rb
-- test/test_mymoip.rb
-- test/test_payer.rb
-- test/test_payment_request.rb
-- test/test_request.rb
-- test/test_transparent_request.rb
 homepage: http://github.com/Irio/mymoip
 licenses:
 - MIT
@@ -231,7 +219,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 165777608342011895
+      hash: 4071666260752952182
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:

data/VERSION

@@ -1 +0,0 @@
-0.6.0

data/test/helper.rb

@@ -1,29 +0,0 @@
-require 'rubygems'
-require 'bundler'
-begin
-  Bundler.setup(:default, :development)
-rescue Bundler::BundlerError => e
-  $stderr.puts e.message
-  $stderr.puts "Run `bundle install` to install missing gems"
-  exit e.status_code
-end
-require 'test/unit'
-require 'turn/autorun'
-require 'mocha/setup'
-require 'vcr'
-
-VCR.configure do |c|
-  c.cassette_library_dir = 'test/fixtures/vcr_cassettes'
-  c.hook_into :webmock
-end
-
-require 'live_test'
-
-require 'fixtures/fixture'
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-$LOAD_PATH.unshift(File.dirname(__FILE__))
-
-Dir[File.dirname(__FILE__) + "/../lib/*.rb"].each { |file| require file }
-
-MyMoip.logger = Logger.new("/dev/null")
-$VERBOSE = nil

data/test/test_commission.rb

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