mangopay 3.0.23 → 3.0.25.pre.alpha.pre.20

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 66c9892c195aece2222cf16271e0f667feb321fe
-  data.tar.gz: d1b4c622c63bbc55a6689bbf458d9aaabb9f157d
+  metadata.gz: 59750018709e9f6cc230860a7a5da0087d6d4c90
+  data.tar.gz: 565a81ec2033f943679745f2b5a8afd856042b26
 SHA512:
-  metadata.gz: 9d95ae1f194bf4b1efa39c4ecc353fd93b77b59ce838f17efea87fa13ef20d8f200f9c5d0deb6aa931948f559d03df7846db703be45f7b79103c3fd140c3e850
-  data.tar.gz: 8c3f0400d5f58c06f9f0af78e83329b4dd1c1170d210da2b1a677fc03f7854f965572eeb1ace71cd0257b5051cd9392312ef8ac4dca97c0705ffeaab9d5815b3
+  metadata.gz: a0f3a0c1a213e312f95406483006fa78a5bcf228ad49c1ada12596d66622920065cf1ea8636d5356c2a019ab2de4625ca09b7627eb7f037fb19660b328efe203
+  data.tar.gz: 6dc436c68121b7c9649c0264ee108dc3db0f625abe6941038550441ef7c784ea3d41c8f961952266f008f99eb1edb74751d756964b7fbc483b2b73b6056cb963

data/.gitignore

@@ -1,26 +1,28 @@
-*.gem
-*.rbc
-.bundle
-.config
-coverage
-InstalledFiles
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-spec/tmp/*.tmp
-test/tmp
-test/version_tmp
-tags
-
-# YARD artifacts
-.yardoc
-_yardoc
-doc/
-
-.DS_Store
-.rvmrc
-/Gemfile.lock
-/mangopay-*.gem
-
-/nbproject/
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+spec/tmp/*.tmp
+test/tmp
+test/version_tmp
+tags
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/
+
+.DS_Store
+.rvmrc
+/Gemfile.lock
+/mangopay-*.gem
+
+/nbproject/
+
+/*.sublime-*

data/.rspec

@@ -1,3 +1,3 @@
---color
---profile
+--color
+--profile
 --r spec_helper

data/.travis.yml

@@ -0,0 +1,13 @@
+language: ruby
+rvm:
+- 2.0.0
+script: bundle exec rspec
+deploy:
+  provider: rubygems
+  api_key:
+    secure: gvlnYEh9cyL+mYeudKzlD+2Po+LgIzCjHzggJH+WDcbtgxlGAFpxbVJOOm/KY8VKhMgIudNV7FJl4Gl4rrG8JjNxbb+qM57ypU3yyDcUesQ+uj0DnN+xszv7M+XtcRQMlhkStawoj/E0QMYBPkAAr1lBpPIFQdC17GDkdn5XvaQ=
+  gem: mangopay
+  on:
+    tags: false
+    repo: Mangopay/mangopay2-ruby-sdk
+    branch: MPSDK-23-configure-gem-deployment

data/Gemfile

@@ -1,2 +1,2 @@
-source "https://rubygems.org"
-gemspec
+source "https://rubygems.org"
+gemspec

data/LICENSE

@@ -1,20 +1,20 @@
-The MIT License (MIT)
-
-Copyright (c) 2013 Mangopay
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of
-this software and associated documentation files (the "Software"), to deal in
-the Software without restriction, including without limitation the rights to
-use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
-the Software, and to permit persons to whom the Software is furnished to do so,
-subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
-FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
-COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
-IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
-CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+The MIT License (MIT)
+
+Copyright (c) 2013 Mangopay
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -1,123 +1,126 @@
-# Mangopay Ruby SDK
-
-The gem for interacting with the version 2 of the Mangopay API.
-See the [API documentation](http://docs.mangopay.com/api-references/)
-for more details on the API.
-
-Tested on the following versions of Ruby: 1.9.2, 1.9.3, 2.0.0
-
-## NEWS
-
-### Version 3.*
-** BREAKING CHANGES **
-This version (3.*) of the gem is targeting the Mangopay API Version 2.
-It has a brand new structure to make the api calls easier to use
-and is not backward compatible with 2.* series.
-
-Since [v3.0.17](https://github.com/Mangopay/mangopay2-ruby-sdk/releases/tag/v3.0.17) of the SDK, you must be using at least v2.01 of the API (more information about the changes required [here](https://docs.mangopay.com/api-v2-01-overview/))
-
-Account creation
--------------------------------------------------
-You can get yourself a [free sandbox account](https://www.mangopay.com/signup/create-sandbox/) or sign up for a [production account](https://www.mangopay.com/signup/submit-your-app/go-live/) (note that validation of your production account can take a few days, so think about doing it in advance of when you actually want to go live).
-
-## Usage
-
-### Install
-* You can get yourself a [free sandbox account](https://www.mangopay.com/get-started/create-sandbox/) or sign up for a [production account](https://www.mangopay.com/get-started/submit-your-app/create-credentials/) (note that validation of your production account can take a few days, so think about doing it in advance of when you actually want to go live).
-
-* Install the gem by either running ```gem install mangopay```
-or by adding it to your Gemfile ```gem 'mangopay'```
-
-* Using the credential info from the signup process above, call ```MangoPay.configure``` in your script as shown in the snippet below.
-
-### Examples
-
-```ruby
-require 'mangopay'
-
-
-# configuration
-MangoPay.configure do |c|
-  c.preproduction = true
-  c.client_id = 'YOUR_CLIENT_ID'
-  c.client_passphrase = 'YOUR_CLIENT_PASSWORD'
-end
-
-
-# get some user by id
-john = MangoPay::User.fetch(john_id) # => {FirstName"=>"John", "LastName"=>"Doe", ...}
-
-
-# update some of his data
-MangoPay::NaturalUser.update(john_id, {'LastName' => 'CHANGED'}) # => {FirstName"=>"John", "LastName"=>"CHANGED", ...}
-
-
-# get all users (with pagination)
-pagination = {'page' => 1, 'per_page' => 8} # get 1st page, 8 items per page
-users = MangoPay::User.fetch(pagination) # => [{...}, ...]: list of 8 users data hashes
-pagination # => {"page"=>1, "per_page"=>8, "total_pages"=>748, "total_items"=>5978}
-
-
-# get John's bank accounts
-accounts = MangoPay::BankAccount.fetch(john_id) # => [{...}, ...]: list of accounts data hashes (10 per page by default)
-
-
-# error handling
-begin
-  MangoPay::NaturalUser.create({})
-rescue MangoPay::ResponseError => ex
-
-  ex # => #<MangoPay::ResponseError: One or several required parameters are missing or incorrect. [...] FirstName: The FirstName field is required. LastName: The LastName field is required. Nationality: The Nationality field is required.>
-
-  ex.details # => {
-             #   "Message"=>"One or several required parameters are missing or incorrect. [...]",
-             #   "Type"=>"param_error",
-             #   "Id"=>"5c080105-4da3-467d-820d-0906164e55fe",
-             #   "Date"=>1409048671.0,
-             #   "errors"=>{
-             #     "FirstName"=>"The FirstName field is required.",
-             #     "LastName"=>"The LastName field is required.", ...},
-             #   "Code"=>"400",
-             #   "Url"=>"/v2/.../users/natural"
-             # }
-end
-```
-
-### Tests
-Make sure that you have run: ```bundle install```
-Then you just have to run rspec ```rspec``` to run all the test suite.
-Feel free to report any test failure by creating an issue
-on the [Gem's Github](https://github.com/Mangopay/mangopay2-ruby-sdk/issues)
-
-## Contributing
-
-1. Fork the repo.
-
-2. Run the tests. We only take pull requests with passing tests, and it's great
-to know that you have a clean slate: `bundle && bundle exec rspec`
-
-3. Add a test for your change. Only refactoring and documentation changes
-require no new tests. If you are adding functionality or fixing a bug, we need
-a test!
-
-4. Make the test pass.
-
-5. Push to your fork and submit a pull request.
-
-At this point you're waiting on us. We like to at least comment on, if not
-accept, pull requests within three business days (and, typically, one business
-day). We may suggest some changes or improvements or alternatives.
-
-Syntax:
-
-* Two spaces, no tabs.
-* No trailing whitespace. Blank lines should not have any space.
-* Prefer &&/|| over and/or.
-* MyClass.my_method(my_arg) not my_method( my_arg ) or my_method my_arg.
-* a = b and not a=b.
-* Follow the conventions you see used in the source already.
-
-A contribution can also be as simple as a +1 on issues tickets to show us
-what you would like to see in this gem.
-
-That's it for now. Good Hacking...
+# Mangopay Ruby SDK [![Build Status](https://travis-ci.org/Mangopay/mangopay2-ruby-sdk.svg?branch=master)](https://travis-ci.org/Mangopay/mangopay2-ruby-sdk)
+
+The gem for interacting with the version 2 of the Mangopay API.
+See the [API documentation](http://docs.mangopay.com/api-references/)
+for more details on the API.
+
+Tested on the following versions of Ruby: 1.9.2, 1.9.3, 2.0.0
+
+## NEWS
+
+### Version 3.*
+**BREAKING CHANGES:** This version (3.\*) of the gem is targeting the Mangopay API Version 2. It has a brand new structure to make the api calls easier to use and is not backward compatible with 2.\* series.
+
+Since [v3.0.17](https://github.com/Mangopay/mangopay2-ruby-sdk/releases/tag/v3.0.17) of the SDK, you must be using at least v2.01 of the API (more information about the changes required [here](https://docs.mangopay.com/api-v2-01-overview/))
+
+Account creation
+-------------------------------------------------
+You can get yourself a [free sandbox account](https://www.mangopay.com/signup/create-sandbox/) or sign up for a [production account](https://www.mangopay.com/signup/submit-your-app/go-live/) (note that validation of your production account can take a few days, so think about doing it in advance of when you actually want to go live).
+
+## Usage
+
+### Install
+* You can get yourself a [free sandbox account](https://www.mangopay.com/get-started/create-sandbox/) or sign up for a [production account](https://www.mangopay.com/get-started/submit-your-app/create-credentials/) (note that validation of your production account can take a few days, so think about doing it in advance of when you actually want to go live).
+
+* Install the gem by either running ```gem install mangopay```
+or by adding it to your Gemfile ```gem 'mangopay'```
+
+* Using the credential info from the signup process above, call ```MangoPay.configure``` in your script as shown in the snippet below.
+
+### Examples
+
+```ruby
+require 'mangopay'
+
+
+# configuration
+MangoPay.configure do |c|
+  c.preproduction = true
+  c.client_id = 'YOUR_CLIENT_ID'
+  c.client_passphrase = 'YOUR_CLIENT_PASSWORD'
+  c.log_file = File.join('mypath', 'mangopay.log')
+end
+
+
+# get some user by id
+john = MangoPay::User.fetch(john_id) # => {FirstName"=>"John", "LastName"=>"Doe", ...}
+
+
+# update some of his data
+MangoPay::NaturalUser.update(john_id, {'LastName' => 'CHANGED'}) # => {FirstName"=>"John", "LastName"=>"CHANGED", ...}
+
+
+# get all users (with pagination)
+pagination = {'page' => 1, 'per_page' => 8} # get 1st page, 8 items per page
+users = MangoPay::User.fetch(pagination) # => [{...}, ...]: list of 8 users data hashes
+pagination # => {"page"=>1, "per_page"=>8, "total_pages"=>748, "total_items"=>5978}
+
+
+# get John's bank accounts
+accounts = MangoPay::BankAccount.fetch(john_id) # => [{...}, ...]: list of accounts data hashes (10 per page by default)
+
+
+# error handling
+begin
+  MangoPay::NaturalUser.create({})
+rescue MangoPay::ResponseError => ex
+
+  ex # => #<MangoPay::ResponseError: One or several required parameters are missing or incorrect. [...] FirstName: The FirstName field is required. LastName: The LastName field is required. Nationality: The Nationality field is required.>
+
+  ex.details # => {
+             #   "Message"=>"One or several required parameters are missing or incorrect. [...]",
+             #   "Type"=>"param_error",
+             #   "Id"=>"5c080105-4da3-467d-820d-0906164e55fe",
+             #   "Date"=>1409048671.0,
+             #   "errors"=>{
+             #     "FirstName"=>"The FirstName field is required.",
+             #     "LastName"=>"The LastName field is required.", ...},
+             #   "Code"=>"400",
+             #   "Url"=>"/v2/.../users/natural"
+             # }
+end
+```
+
+### Log requests and responses
+You can easily enable logs by setting the ```log_file``` configuration option (see the section **configuration** above). If you don't want logs, remove the ```log_file``` line.
+
+Requests and responses are filtered, so confidential data is not saved in logs.
+
+### Tests
+Make sure that you have run: ```bundle install```
+Then you just have to run rspec ```rspec``` to run all the test suite.
+Feel free to report any test failure by creating an issue
+on the [Gem's Github](https://github.com/Mangopay/mangopay2-ruby-sdk/issues)
+
+## Contributing
+
+1. Fork the repo.
+
+2. Run the tests. We only take pull requests with passing tests, and it's great
+to know that you have a clean slate: `bundle && bundle exec rspec`
+
+3. Add a test for your change. Only refactoring and documentation changes
+require no new tests. If you are adding functionality or fixing a bug, we need
+a test!
+
+4. Make the test pass.
+
+5. Push to your fork and submit a pull request.
+
+At this point you're waiting on us. We like to at least comment on, if not
+accept, pull requests within three business days (and, typically, one business
+day). We may suggest some changes or improvements or alternatives.
+
+Syntax:
+
+* Two spaces, no tabs.
+* No trailing whitespace. Blank lines should not have any space.
+* Prefer &&/|| over and/or.
+* MyClass.my_method(my_arg) not my_method( my_arg ) or my_method my_arg.
+* a = b and not a=b.
+* Follow the conventions you see used in the source already.
+
+A contribution can also be as simple as a +1 on issues tickets to show us
+what you would like to see in this gem.
+
+That's it for now. Good Hacking...

data/bin/mangopay

@@ -1,9 +1,9 @@
-#!/usr/bin/env ruby
-
-irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
-
-libs = " -r irb/completion"
-libs <<  " -r #{File.dirname(__FILE__) + '/../lib/mangopay'}"
-
-puts "Loading MangoPay gem"
-exec "#{irb} #{libs}"
+#!/usr/bin/env ruby
+
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs = " -r irb/completion"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/mangopay'}"
+
+puts "Loading MangoPay gem"
+exec "#{irb} #{libs}"

data/lib/generators/mangopay/install_generator.rb

@@ -1,60 +1,60 @@
-require 'rails/generators/base'
-require 'mangopay'
-
-module Mangopay
-  module Generators
-    class InstallGenerator < Rails::Generators::Base
-      source_root File.expand_path('../../templates', __FILE__)
-      argument :client_id, type: :string,
-        desc: 'The id you want to use to query the MangoPay API (must match with the regex ^[a-z0-9_-]{4,20}$)'
-      argument :client_name, type: :string, desc: "Full name of you're organization"
-      argument :client_email, type: :string, desc: "An email for future contacts"
-      class_option :preproduction, type: :boolean, default: true, desc: 'Whether or not use the preproduction environment'
-
-      desc 'Installs all the basic configuration of the mangopay gem'
-      def setup
-        begin
-          client = client_id_valid?
-          remove_file 'config/initializers/mangopay.rb'
-          @client_id = client_id
-          @client_passphrase = client['Passphrase']
-          template 'mangopay.rb.erb', 'config/initializers/mangopay.rb'
-        rescue => e
-          puts e.message
-        end
-      end
-
-      protected
-
-      def client_id_valid?
-        check_client_id_validity
-        check_client_id_availablility
-      end
-
-      def check_client_id_validity
-        if (/^[a-z0-9_-]{4,20}$/ =~ client_id).nil?
-          raise "The client_id must match the regexp ^[a-z0-9_-]{4,20}$"
-        end
-      end
-
-      def check_client_id_availablility
-        client = create_client
-        if client['Type'] == 'ClientID_already_exist'
-          raise client['Message']
-        end
-        client
-      end
-
-      def create_client
-        MangoPay.configure do |c|
-          c.preproduction = options[:preproduction]
-        end
-        MangoPay::Client.create({
-          ClientID: client_id,
-          Name: client_name,
-          Email: client_email
-        })
-      end
-    end
-  end
-end
+require 'rails/generators/base'
+require 'mangopay'
+
+module Mangopay
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path('../../templates', __FILE__)
+      argument :client_id, type: :string,
+        desc: 'The id you want to use to query the MangoPay API (must match with the regex ^[a-z0-9_-]{4,20}$)'
+      argument :client_name, type: :string, desc: "Full name of you're organization"
+      argument :client_email, type: :string, desc: "An email for future contacts"
+      class_option :preproduction, type: :boolean, default: true, desc: 'Whether or not use the preproduction environment'
+
+      desc 'Installs all the basic configuration of the mangopay gem'
+      def setup
+        begin
+          client = client_id_valid?
+          remove_file 'config/initializers/mangopay.rb'
+          @client_id = client_id
+          @client_passphrase = client['Passphrase']
+          template 'mangopay.rb.erb', 'config/initializers/mangopay.rb'
+        rescue => e
+          puts e.message
+        end
+      end
+
+      protected
+
+      def client_id_valid?
+        check_client_id_validity
+        check_client_id_availablility
+      end
+
+      def check_client_id_validity
+        if (/^[a-z0-9_-]{4,20}$/ =~ client_id).nil?
+          raise "The client_id must match the regexp ^[a-z0-9_-]{4,20}$"
+        end
+      end
+
+      def check_client_id_availablility
+        client = create_client
+        if client['Type'] == 'ClientID_already_exist'
+          raise client['Message']
+        end
+        client
+      end
+
+      def create_client
+        MangoPay.configure do |c|
+          c.preproduction = options[:preproduction]
+        end
+        MangoPay::Client.create({
+          ClientID: client_id,
+          Name: client_name,
+          Email: client_email
+        })
+      end
+    end
+  end
+end