leetchi-wallet-services 0.0.1

data/CONTRIBUTING.md

@@ -0,0 +1,51 @@
+# Contributing to Bankiwi
+
+## Bugs
+A bug is a _demonstrable problem_ that is caused by the code in the repository. Good bug reports are extremely helpful - thank you!
+
+Guidelines for bug reports:
+
+1. **Use the GitHub issue search**: check if the issue has already been reported.
+
+2. **Check if the issue has been fixed**: try to reproduce it using the latest `master` branch in the repository.
+
+3. **Isolate the problem**: ideally create a [reduced test case](http://css-tricks.com/6263-reduced-test-cases/) and a live example.
+
+A good bug report shouldn't leave others needing to chase you up for more information. Please try to be as detailed as possible in your report. What is your environment? What steps will reproduce the issue? What browser(s) and OS experience the problem? What would you expect to be the outcome? All these details will help people to fix any potential bugs.
+
+Example:
+
+> Short and descriptive example bug report title
+>
+> A summary of the issue and the browser/OS environment in which it occurs.
+> If suitable, include the steps required to reproduce the bug.
+>
+	> 1. This is the first step
+	> 2. This is the second step
+	> 3. Further steps, etc.
+>
+> `<url>` (a link to the reduced test case)
+>
+> Screenshots of the bug. (especially if it's a visual one)
+>
+> Any other information you want to share that is relevant to the issue being reported. This might include the lines of code that you have identified as causing the bug, and potential solutions (and your opinions on their merits).
+**[File a bug report](https://github.com/leetchi/bankiwi/issues/)**
+
+## Pull requests
+Good pull requests - patches, improvements, new features - are a fantastic help. They should remain focused in scope and avoid containing unrelated commits. If your contribution involves a significant amount of work or substantial changes to any part of the project, please open an issue to discuss it first.
+
+Make sure to adhere to the coding conventions used throughout a project (indentation, accurate comments, etc.). Please update any documentation that is relevant to the change you're making.
+
+Please follow this process; it's the best way to get your work included in the project:
+
+1. Create a new branch based on master
+2. Once you've done your first commit on the newly created branch [Open a Pull Request](http://help.github.com/send-pull-requests/) with a clear title and description of the changes you intend to do
+3. Every pull request will be attributed a version number following this schema: [MAJOR_VERSION_NUMBER].[MINOR_VERSION_NUMBER].[PATCH_VERSION_NUMBER]
+4. Once your pull-request is fully tested, documented, and approved by everyone working on the project you will be ask to merge it with master.
+
+You can then make your first push to production. Enjoy :-)
+
+## Do Not 
+Please **do not** use the issue tracker for personal support requests.
+
+Please **do not** derail or troll issues. Keep the discussion on topic and respect the opinions of others.

data/Gemfile

@@ -0,0 +1,11 @@
+source :rubygems
+
+gem "json"
+
+group :test do
+    gem 'minitest'
+    gem 'webmock'
+    gem 'vcr'
+    gem 'turn'
+    gem 'rake'
+end

data/Gemfile.lock

@@ -0,0 +1,26 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    addressable (2.3.2)
+    ansi (1.4.3)
+    crack (0.3.2)
+    json (1.7.6)
+    minitest (4.6.1)
+    rake (10.0.3)
+    turn (0.9.6)
+      ansi
+    vcr (2.4.0)
+    webmock (1.9.0)
+      addressable (>= 2.2.7)
+      crack (>= 0.1.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  json
+  minitest
+  rake
+  turn
+  vcr
+  webmock

data/README.md

@@ -0,0 +1,64 @@
+# leetchi-api-ruby-sdk
+
+The gem for interacting with Leetchi API.
+See the [API documentation](http://doc.api.leetchi.com/) for more details on the API.
+
+Tested on the following versions of Ruby: 1.9.2, 1.9.3
+
+## Requirements
+
+This gem uses mainly ruby stdlib and the *json* gem.
+
+## Configuration
+
+Setup the following ENV:
+
+```ruby
+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 Leetchi API ID
+```
+
+## Usage
+
+The gem implements the following resources:  
+- Beneficiary  
+- Card  
+- Contribution  
+- Expense  
+- Operation  
+- 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 Leetchi API.  
+Calling those methods return the Leetchi API response has an object. Every executions are made synchronously.
+
+### Example
+
+This example creates a user and returns its informations:
+
+```ruby
+Leetchi::User.create({
+    'Tag' => 'test',
+    'Email' => 'my@email.com',
+    'FistName' => 'Jack',
+    'LastName' => 'Nelson',
+    'CanRegisterMeanOfPayment' => true
+})
+```
+
+This example returns a specific user's data:
+
+```ruby
+Leetchi::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/Leetchi/leetchi-api-ruby-sdk/issues)

data/Rakefile

@@ -0,0 +1,8 @@
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.test_files = FileList['spec/lib/leetchi/*_spec.rb']
+  t.verbose = true
+end
+
+task :default => :test

data/lib/leetchi-wallet-services.rb

@@ -0,0 +1,21 @@
+module Leetchi
+
+  require 'json'
+  require 'base64'
+  require 'openssl'
+  require 'net/http'
+
+  require 'leetchi/ressource'
+  require 'leetchi/user'
+  require 'leetchi/wallet'
+  require 'leetchi/card'
+  require 'leetchi/contribution'
+  require 'leetchi/transfer'
+  require 'leetchi/beneficiary'
+  require 'leetchi/withdrawal'
+  require 'leetchi/strong_authentication'
+  require 'leetchi/operation'
+  require 'leetchi/expense'
+  require 'leetchi/recurrent_contribution'
+
+end

data/lib/leetchi/beneficiary.rb

@@ -0,0 +1,73 @@
+module Leetchi
+  # A beneficiary is an item who is the target of withdrawal.
+  # It's the object that contains the bank details for a withdrawal.
+  # A beneficiary can be linked to a user.
+  class Beneficiary < Leetchi::Ressource
+
+    # Create a beneficiary
+    #
+    # * *Args*    :
+    #   - +data+ -> A JSON with the following attributes (Square brackets for optionals):
+    #               * [Tag]
+    #               * [UserID]
+    #               * BankAccountOwnerName
+    #               * BankAccountIBAN
+    #               * BankAccountBIC
+    # * *Returns* :
+    #   - A beneficiary object in case of success
+    #
+    def self.create(data)
+      post_request('beneficiaries', data)
+    end
+
+    # Get a beneficiary
+    #
+    # * *Args*    :
+    #   - +beneficiary_id+ -> The id of the beneficiary you want to get
+    # * *Returns* :
+    #   - A beneficiary object if it exists
+    #
+    def self.details(beneficiary_id)
+      get_request(File.join('beneficiaries', beneficiary_id.to_s))
+    end
+
+    # Create a strong authentication for a given beneficiary
+    #
+    # * *Args*    :
+    #   - +beneficiary_id+ -> The id of the beneficiary you want strongly authenticate
+    #   - +data+ -> A JSON with the following attributes (Square brackets for optionals):
+    #               * [Tag]
+    # * *Returns* :
+    #   - A strong authentication object
+    #
+    def self.create_strong_authentication(beneficiary_id, data)
+        post_request(File.join('beneficiaries', beneficiary_id.to_s, 'strongAuthentication'), data)
+    end
+
+    # Get the strong authentication for a given beneficiary
+    #
+    # * *Args*    :
+    #   - +beneficiary_id+ -> The id of the beneficiary you want strongly authenticate
+    # * *Returns* :
+    #   - A strong authentication object
+    #
+    def self.get_strong_authentication(beneficiary_id)
+        get_request(File.join('beneficiaries', beneficiary_id.to_s, 'strongAuthentication'))
+    end
+
+    # Update a strong authentication object for a given beneficiary
+    #
+    # * *Args*    :
+    #   - +beneficiary_id+ -> The id of the beneficiary you want strongly authenticate
+    #   - +data+ -> A JSON with the following attributes (Square brackets for optionals):
+    #               * [Tag]
+    #               * [IsDocumentsTransmitted]
+    # * *Returns* :
+    #   - A strong authentication object
+    #
+    def self.update_strong_authentication(beneficiary_id, data)
+        put_request(File.join('beneficiaries', beneficiary_id.to_s, 'strongAuthentication'), data)
+    end
+
+  end
+end

data/lib/leetchi/card.rb

@@ -0,0 +1,42 @@
+module Leetchi
+  # A payment card.
+  class Card < Leetchi::Ressource
+
+    # Create a payment card
+    #
+    # * *Args*    :
+    #   - +data+ -> A JSON with the following attributes (Square brackets for optionals):
+    #               * [Tag]
+    #               * OwnerID
+    #               * ReturnURL
+    #               * [TemplateURL]
+    # * *Returns* :
+    #   - A payment card object
+    #
+    def self.create(data)
+      post_request('cards', data)
+    end
+
+    # Get a payment card
+    #
+    # * *Args*    :
+    #   - +card_id+ -> The id of the card you want to retrieve
+    # * *Returns* :
+    #   - A payment card object
+    #
+    def self.details(card_id)
+      get_request(File.join('cards', card_id.to_s))
+    end
+
+    # Delete a payment card
+    #
+    # * *Args*    :
+    #   - +card_id+ -> The id of the card you want to delete
+    # * *Returns* :
+    #   - A "OK" string on success
+    #
+    def self.delete(card_id)
+      delete_request(File.join('cards', card_id.to_s))
+    end
+  end
+end

data/lib/leetchi/contribution.rb

@@ -0,0 +1,61 @@
+module Leetchi
+  # A contribution help you deposit money to a wallet.
+  class Contribution < Leetchi::Ressource
+
+    # Create a contribution
+    #
+    # * *Args*    :
+    #   - +data+ -> A JSON with the following attributes (Square brackets for optionals):
+    #               * [Tag]
+    #               * UserID
+    #               * WalletID
+    #               * Amount
+    #               * [ClientFeeAmount]
+    #               * ReturnURL
+    #               * [TemplateURL]
+    #               * [RegisterMeanOfPayment]
+    #               * [PaymentCardID]
+    # * *Returns* :
+    #   - A contribution object
+    #
+    def self.create(data)
+      post_request('contributions', data)
+    end
+
+    # Get a contribution
+    #
+    # * *Args*    :
+    #   - +contribution_id+ -> The id of the contribution you want to retrieve
+    # * *Returns* :
+    #   - A contribution object
+    #
+    def self.details(contribution_id)
+      get_request(File.join('contributions', contribution_id.to_s))
+    end
+
+    # Refund a given contribution
+    #
+    # * *Args*    :
+    #   - +data+ -> A JSON with the following attributes (Square brackets for optionals):
+    #               * [Tag]
+    #               * ContributionID
+    #               * UserID
+    # * *Returns* :
+    #   - A refund object
+    #
+    def self.refund(data)
+      post_request(File.join('refunds'), data)
+    end
+
+    # Get a refund object
+    #
+    # * *Args*    :
+    #   - +contribution_refund_id+ -> The id of the refund you want to retrieve
+    # * *Returns* :
+    #   - A refund object
+    #
+    def self.get_refund(contribution_refund_id)
+      get_request(File.join('refunds', contribution_refund_id.to_s))
+    end
+  end
+end

data/lib/leetchi/expense.rb

@@ -0,0 +1,17 @@
+module Leetchi
+   # In order to make an expense you need to get a list of expense sites and then redirect a user to ExpenseURL.
+   # When the user selects a product and pays, you will be notified about an expense through the notification mechanism.
+  class Expense < Leetchi::Ressource
+
+    # Get an expense
+    #
+    # * *Args*    :
+    #   - +expense_id+ -> The id of the expense you want to retrieve
+    # * *Returns* :
+    #   - An expense object
+    #
+    def self.get(expense_id)
+      get_request(File.join('expenses', expense_id.to_s))
+    end
+  end
+end

data/lib/leetchi/operation.rb

@@ -0,0 +1,16 @@
+module Leetchi
+    # Operation
+    class Operation < Leetchi::Ressource
+
+        # Get an operation
+        #
+        # * *Args*    :
+        #   - +operation_id+ -> The id of the operation you want to retrieve
+        # * *Returns* :
+        #   - An operation object
+        #
+        def self.get(operation_id)
+            get_request(File.join('operations', operation_id.to_s))
+        end
+    end
+end

data/lib/leetchi/recurrent_contribution.rb

@@ -0,0 +1,38 @@
+module Leetchi
+
+  # Recurrent Contribution are available in test environment only, soon in production.
+  class RecurrentContribution < Leetchi::Ressource
+
+    # Create a recurrent contribution
+    #
+    # * *Args*    :
+    #   - +data+ -> A JSON with the following attributes (Square brackets for optionals):
+    #               * [Tag]
+    #               * UserID
+    #               * WalletID
+    #               * Amount
+    #               * [ClientFeeAmount]
+    #               * ReturnURL
+    #               * [TemplateURL]
+    #               * StartDate
+    #               * FrequencyCode
+    #               * NumberOfExecutions
+    # * *Returns* :
+    #   - A recurrent contribution object
+    #
+    def self.create(data)
+      post_request('recurrent-contributions', data)
+    end
+
+    # Get a recurrent contribution
+    #
+    # * *Args*    :
+    #   - +recurrent_contributions_id+ -> The id of the recurrent contribution you want to retrieve
+    # * *Returns* :
+    #   - A recurrent contribution object
+    #
+    def self.get(recurrent_contributions_id)
+      get_request(File.join('recurrent-contributions', recurrent_contributions_id.to_s))
+    end
+  end
+end