mangopay 2.0.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b09720dac2af9cba56800c7b8300b216bb9bdd55
-  data.tar.gz: 1980d47b7aa7bab13ad6dcb7e3ff4e94c2801592
+  metadata.gz: 70750c7027d98926cc945a63e4a3ec94b72da433
+  data.tar.gz: 7804bbb5e621985168b1956879efd2a05793708e
 SHA512:
-  metadata.gz: 971c9855f24cb3179100eb0a62255108361b6b40a668fc72ed77b5724c2351566cb13872321c4da0e0e12074b8d8e3189585e2dbe5b16ca74002bd08395e2040
-  data.tar.gz: cd6f739af9810c957411d8e330f9443b846d092089cb01137770b5d1d71aa2f7a2ac3c821c074a5727657c340ae7d71a3af53e67ea87109cab370e092d18c858
+  metadata.gz: a771d8de26c6dbec506734008b57bbd7ad133a48ec8feba3af8a90d545f209a0574d64723460157ea742a69c82c5be0c8980e7ca40beef7dfe0c6053f329cb80
+  data.tar.gz: 65b199274b1b0f8c975fc6021a03f9a9c99da6d5ef3c94fe4ef7fae95149474c995c83c189dd4df1c93fabd971c99e2bef326f4f2c4f5850990b454187230b4c

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--profile

data/Gemfile

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

data/LICENSE

@@ -0,0 +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.

data/README.md

@@ -1,112 +1,40 @@
-# mangopay
+# MangoPay2 Ruby SDK
 
-The gem for interacting with MangoPay API.
-See the [API documentation](http://www.mangopay.com/api-references/) for more details on the API.
+The gem for interacting with the version 2 of the MangoPay API.
+See the [API documentation]() for more details on the API.
 
 Tested on the following versions of Ruby: 1.9.2, 1.9.3, 2.0.0
 
 ## Code Status
-[![Build Status](https://travis-ci.org/MangoPay/mangopay.png?branch=master)](https://travis-ci.org/MangoPay/leetchi-api-ruby-sdk)
-[![Code Climate](https://codeclimate.com/github/MangoPay/mangopay.png)](https://codeclimate.com/github/MangoPay/leetchi-api-ruby-sdk)
-[![Dependency Status](https://gemnasium.com/MangoPay/mangopay.png)](https://gemnasium.com/MangoPay/leetchi-api-ruby-sdk)
+[![Build Status]()]()
+[![Code Climate]()]()
+[![Dependency Status]()]()
 
 ## NEWS
 
-### Version 2.0.0
-** BREAKING CHANGES **  
-The Gem has been updated to 2.0.0
-It has been renamed from leetchi-api-ruby-sdk to mangopay.
+### Version 3.0.0
+** BREAKING CHANGES **
+This version of the gem is targeting the MangoPay API Version 2.
+It has a brand new structure to make the api calls easier to use
 
-Please make sure you update all the internal calls from Leetchi to MangoPay.
-
-## Requirements
-
-This gem uses mainly ruby stdlib and the *json* gem.
-
-## Configuration
-
-Please note that the gem configuration process change between 0.0.1 and 1.0.0.
-
-### Version 0.0.1
-
-Setup the following ENV:
-
-```
-ENV['LEETCHI_API_BASE_URL'] = "https://api-preprod.leetchi.com" # once you've run your test using the preproduction environment use the production one
-ENV['LEETCHI_KEY_PATH'] = "abcd"                                # the full path to your leetchi key
-ENV['LEETCHI_PASSPHRASE'] = "efgh"                              # you key's passphrase (leave blank if none)
-ENV['LEETCHI_PARTNER_ID'] = "myID"                              # your MangoPay API ID
-```
-
-### Version 1.0.0
-
-You can now call the MangoPay.configure method like this:
-
-```ruby
-MangoPay.configure do |c|
-    c.preproduction = true
-    c.partner_id = 'example'
-    c.key_path = './spec/support-files/example.pem'
-    c.key_password = ''
-end
-```
-
-The **preproduction** attribute let you specify if you want to use the preproduction api endpoint.
-
-The **partner_id** is the id that was issue to you during you registration process.
+## Usage
 
-The **key_path** and **key_password** arguments are here to let you use the key you've created before the registration process.
+### Install
+* Install the gem by either running ```gem install mangopay``` or by adding it to your Gemfile ```gem 'mangopay'```
 
-This configure method can of course be use to define a Ruby on Rails initialiser.
+* The Rails users will be happy to know that there is a new generator script that will help you configure your access to the MangoPay API version 2.
+Simply run ``rails generate mangopay:install CLIENT_ID CLIENT_NAME`` where CLIENT_ID is the id you will use to connect to the api and CLIENT_NAME is a full name that will be use to identify all communications between you and the MangoPay Team.
 
-## Usage
+### Examples
 
-The gem implements the following resources:
-- Beneficiary
-- Card
-- Contribution
-- Expense
-- Operation
-- Immediate Contribution
-- Recurrent Contribution (only available in preproduction)
-- Strong Authentication
-- Transfer
-- User
-- Wallet
-- Withdrawal
-
-Each resource has specifics methods such has `create`, `details`, `update`, etc. Those methods must be called with an ID and / or an Object matching the MangoPay API.
-Calling those methods return the MangoPay API response has an object. Every executions are made synchronously.
-
-### Example
-
-This example creates a user and returns its informations:
-
-```ruby
-MangoPay::User.create({
-    'Tag' => 'test',
-    'Email' => 'my@email.com',
-    'FistName' => 'Jack',
-    'LastName' => 'Nelson',
-    'CanRegisterMeanOfPayment' => true
-})
-```
-
-This example returns a specific user's data:
-
-```ruby
-MangoPay::User.details(123)
-```
 
 ### Tests
 Make sure that you have run: ```bundle install```
-Then you just have to run the rake task ```rake test``` 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/leetchi-api-ruby-sdk/issues)
+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
 
-Take a look at the [CONTRIBUTING](https://github.com/Leetchi/mangopay/blob/master/CONTRIBUTING.md) file of this repo
-
 1. Fork the repo.
 
 2. Run the tests. We only take pull requests with passing tests, and it's great
@@ -136,3 +64,4 @@ Syntax:
 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...
+>>>>>>> dev

data/bin/mangopay

@@ -0,0 +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}"

data/lib/generators/mangopay/install_generator.rb

@@ -0,0 +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', '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

data/lib/generators/templates/mangopay.rb

@@ -0,0 +1,5 @@
+MangoPay.configure do |c|
+  c.preproduction = <%= options[:preproduction] %>
+  c.client_id = '<%= @client_id %>'
+  c.client_passphrase = '<%= @client_passphrase %>'
+end

data/lib/mangopay.rb

@@ -1,36 +1,40 @@
-module MangoPay
+require 'net/http'
+require 'multi_json'
+
+# Version
+require 'mangopay/version'
+
+# JSON
+require 'mangopay/json'
 
-  require 'json'
-  require 'base64'
-  require 'openssl'
-  require 'net/http'
-  require 'net/http/post/multipart'
-
-  require 'mangopay/ressource'
-  require 'mangopay/user'
-  require 'mangopay/wallet'
-  require 'mangopay/card'
-  require 'mangopay/contribution'
-  require 'mangopay/immediate_contribution'
-  require 'mangopay/withdrawal_contribution'
-  require 'mangopay/transfer'
-  require 'mangopay/beneficiary'
-  require 'mangopay/withdrawal'
-  require 'mangopay/strong_authentication'
-  require 'mangopay/operation'
-  require 'mangopay/expense'
-  require 'mangopay/recurrent_contribution'
+# Resources
+require 'mangopay/http_calls'
+require 'mangopay/resource'
+require 'mangopay/client'
+require 'mangopay/user'
+require 'mangopay/natural_user'
+require 'mangopay/legal_user'
+require 'mangopay/payin'
+require 'mangopay/payout'
+require 'mangopay/transfer'
+require 'mangopay/transaction'
+require 'mangopay/wallet'
+require 'mangopay/bank_account'
 
+# Errors
+require 'mangopay/errors'
+
+module MangoPay
 
   class Configuration
-    attr_accessor :base_url, :partner_id, :key_path, :key_password, :preproduction
+    attr_accessor :root_url, :client_id, :client_passphrase, :preproduction
 
     def preproduction
       @preproduction || false
     end
 
-    def base_url
-      @base_url || (@preproduction == true  ? "https://api-preprod.leetchi.com" : "https://api.leetchi.com")
+    def root_url
+      @root_url || (@preproduction == true  ? "https://mangopay-api-inte.leetchi.com" : "https://api.leetchi.com")
     end
   end
 
@@ -42,4 +46,70 @@ module MangoPay
     self.configuration ||= Configuration.new
     yield configuration
   end
+
+  def self.api_uri(url='')
+    URI(configuration.root_url + url)
+  end
+
+  def self.request(method, url, params={}, headers={})
+    uri = api_uri(url)
+
+    res = Net::HTTP.start(uri.host, uri.port, use_ssl: uri.scheme == 'https') do |http|
+      request = Net::HTTP::const_get(method.capitalize).new(uri.request_uri, request_headers)
+      request.body = MangoPay::JSON.dump(params)
+      http.request request
+    end
+    MangoPay::JSON.load(res.body)
+  end
+
+  def self.user_agent
+    @uname ||= get_uname
+
+    {
+      bindings_version: MangoPay::VERSION,
+      lang: 'ruby',
+      lang_version: "#{RUBY_VERSION} p#{RUBY_PATCHLEVEL} (#{RUBY_RELEASE_DATE})",
+      platform: RUBY_PLATFORM,
+      uname: @uname
+    }
+  end
+
+  def self.get_uname
+    `uname -a 2>/dev/null`.strip if RUBY_PLATFORM =~ /linux|darwin/i
+  rescue Errno::ENOMEM
+    'uname lookup failed'
+  end
+
+  def self.get_oauth_token
+    if @auth_timestamp.nil? || @auth_timestamp <= Time.now || @auth_token.nil?
+      uri = api_uri('/api/oauth/token')
+      res = Net::HTTP.start(uri.host, uri.port, use_ssl: uri.scheme == 'https') do |http|
+        req = Net::HTTP::Post.new(uri.request_uri)
+        req.basic_auth configuration.client_id, configuration.client_passphrase
+        req.body = 'grant_type=client_credentials'
+        http.request req
+      end
+      @auth_token = MangoPay::JSON.load(res.body)
+      @auth_timestamp = Time.now + @auth_token['expires_in'].to_i
+    end
+    @auth_token
+  end
+
+  def self.oauth_token
+    oauth = get_oauth_token
+    "#{oauth['token_type']} #{oauth['access_token']}"
+  end
+
+  def self.request_headers
+    headers = {
+      'user_agent' => "MangoPay V1 RubyBindings/#{MangoPay::VERSION}",
+      'Authorization' => oauth_token,
+      'Content-Type' => 'application/json'
+    }
+    begin
+      headers.update('x_mangopay_client_user_agent' => MangoPay::JSON.dump(user_agent))
+    rescue => e
+      headers.update('x_mangopay_client_raw_user_agent' => user_agent.inspect, error: "#{e} (#{e.class})")
+    end
+  end
 end

data/lib/mangopay/bank_account.rb

@@ -0,0 +1,21 @@
+module MangoPay
+  class BankAccount < Resource
+    include MangoPay::HTTPCalls::Create
+    include MangoPay::HTTPCalls::Fetch
+
+    def self.fetch(*ids)
+      url = ids.length == 1 ? url(ids[0]) : url(ids[0], ids[1])
+      MangoPay.request(:get, url)
+    end
+
+    private
+
+    def self.url(*id)
+      if id.length == 1
+        "/v2/#{MangoPay.configuration.client_id}/users/#{CGI.escape(id[0])}/bankaccounts"
+      else
+        "/v2/#{MangoPay.configuration.client_id}/users/#{CGI.escape(id[0])}/bankaccounts/#{CGI.escape(id[1])}"
+      end
+    end
+  end
+end

data/lib/mangopay/client.rb

@@ -0,0 +1,17 @@
+module MangoPay
+  class Client < Resource
+
+    def self.create(params)
+      uri = URI(MangoPay.configuration.root_url + '/api/clients/')
+      res = Net::HTTP.start(uri.host, uri.port, use_ssl: uri.scheme == 'https') do |http|
+        request = Net::HTTP::Post.new(uri.request_uri, {
+          'user_agent' => "MangoPay V1 RubyBindings/#{MangoPay::VERSION}",
+          'Content-Type' => 'application/json'
+        })
+        request.body = MangoPay::JSON.dump(params)
+        http.request request
+      end
+      MangoPay::JSON.load(res.body)
+    end
+  end
+end