wepay-api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 69fe9591ca7ea909e13e1301d6b93b87c2c21588
+  data.tar.gz: ce7367f286d651a7efbc83ff695118a96389602c
+SHA512:
+  metadata.gz: 196804d90615ef5986048dedc4a5c99fd2e0a6abe73326632dcc211586021ea0ba062b336e915d2ca44d6133bdfacc945903b4fcc3d1a873808c1344aaa2d73f
+  data.tar.gz: 11402411fcd33b29c230c716d464270d0c35b928e86e325fda68a34ea0cac484bcbf1d657445f09c523f99dbdb348a2c063b3b32b40bfdbfcda9ccc7ffed76e5

data/.gitignore

@@ -0,0 +1,21 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.iml
+.idea
+.rvmrc
+spec/settings.yml

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - jruby-19mode

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in wepay-api.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Anh Nguyen
+
+MIT License
+
+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

@@ -0,0 +1,118 @@
+[![Build Status](https://travis-ci.org/B-Sides/wepay-api.png?branch=master)](https://travis-ci.org/B-Sides/wepay-api)
+
+# wepay-api
+
+`wepay-api` is a Ruby wrapper for Wepay API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'wepay-api'
+
+Or install it yourself as:
+
+    $ gem install wepay-api
+
+## Configuration
+`wepay-api` can be configured as following:
+
+```ruby
+Wepay.configure do |config|
+  config.client_id     = ...  # app id                                  (compulsory)
+  config.client_secret = ...  # app secret                              (compulsory)
+  config.access_token  = ...  # access token of the app                 (compulsory)
+  config.account_id    = ...  # caller's account id                     (compulsory)
+  config.scope         = ...  # the permission for OAuth authorization  (compulsory)
+  config.using_stage   = ...  # set to true/false                       (compulsory)
+  config.open_timeout  = 5    # default is 5 seconds                    (optional)
+  config.timeout       = 10   # default is 10 seconds                   (optional)
+end
+```
+
+## Usage
+
+### OAuth
+#### OAuth authorization URL
+To get the authorization URL for OAuth, use following method:
+
+```ruby
+Wepay.authorization_url(redirect_uri)
+```
+
+Refer to [https://stage.wepay.com/developer/reference/oauth2#authorize](https://stage.wepay.com/developer/reference/oauth2#authorize) for more details.
+
+#### User's access token
+To get the access token from user, use following method:
+
+```ruby
+Wepay.get_access_token(code, redirect_uri)
+```
+
+Refer to [https://stage.wepay.com/developer/reference/oauth2#token](https://stage.wepay.com/developer/reference/oauth2#token) for more details.
+
+### API
+#### Available API
+  - [/account](lib/wepay/api/account.rb)
+  - [/checkout](lib/wepay/api/checkout.rb)
+  - [/preapproval](lib/wepay/api/preapproval.rb)
+  - [/subscription_plan](lib/wepay/api/subscription_plan.rb)
+  - [/subscription](lib/wepay/api/subscription.rb)
+  - [/withdrawal](lib/wepay/api/withdrawal.rb)
+
+Notice: WePay is using **POST** for **ALL** the requests, **even the API method says "get_..."**
+
+#### API calls
+In order to make an API call, we can follow the convention for the method call:
+
+Wepay.`api_type`.`api_method`(params)
+
+For example, to create a checkout:
+
+```ruby
+Wepay.checkout.create(
+  short_description:  "my description for the checkout",
+  type:               "GOODS",
+  fee_payer:          "payee",
+  amount:	          10,
+  redirect_uri:       "redirect_uri",
+  ...
+)
+```
+
+`params` is a Hash which captures the whole query as in Wepay API documentation, so refer to the documentation if any doubts.
+
+Response from these API calls will be converted to `Hashied::Mash` object to make it easier for data accessing.
+Refer to [https://github.com/intridea/hashie#mash](https://github.com/intridea/hashie#mash) for more details.
+
+#### User's authorized calls
+After configured, the http client from `wepay-api` will try to make use of app's `access_token` (in the configuration) as the default authorization of the api calls.
+There are some situations that user's `access_token` need to be used, e.g. create an account for the user, so we can embed the user's `access_token`
+in the call by adding field `access_token` to the params, for example:
+
+```ruby
+Wepay.account.create(
+  ...
+  access_token:   "user's access token"
+)
+```
+
+#### Error/ Exception
+If an API call has errors, it will raise an Wepay::ApiError with following fields:
+  - type,     e.g. invalid_request
+  - code,     e.g. 1001
+  - message
+
+Give a rescue block to the API calls to make sure the error is handled in any situation.
+
+## Development notes
+  - Copy `spec/settings.yml.example` into `spec/settings.yml` and replace with your credentials to make record the requests for testing using VCR
+  - Before committing VCR fixtures, remember to remove any sensitive data from the fixtures: account id, client secret, ...
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new
+
+task default: :spec
+task test:    :spec

data/lib/wepay-api.rb

@@ -0,0 +1,2 @@
+require "wepay"
+require "wepay/version"

data/lib/wepay.rb

@@ -0,0 +1,23 @@
+require 'wepay/error'
+require 'wepay/configuration'
+require 'wepay/oauth'
+
+require 'wepay/middleware'
+require 'wepay/client'
+require 'wepay/client/data'
+require 'wepay/client/token'
+
+require 'wepay/api'
+require 'wepay/api/base'
+require 'wepay/api/checkout'
+require 'wepay/api/account'
+require 'wepay/api/preapproval'
+require 'wepay/api/withdrawal'
+require 'wepay/api/subscription_plan'
+require 'wepay/api/subscription'
+
+module Wepay
+  extend Wepay::Configuration
+  extend Wepay::Api
+  extend Wepay::OAuth
+end

data/lib/wepay/api.rb

@@ -0,0 +1,27 @@
+module Wepay
+  module Api
+    def account
+      Wepay::Api::Account.new
+    end
+
+    def checkout
+      Wepay::Api::Checkout.new
+    end
+
+    def preapproval
+      Wepay::Api::Preapproval.new
+    end
+
+    def withdrawal
+      Wepay::Api::Withdrawal.new
+    end
+
+    def subscription_plan
+      Wepay::Api::SubscriptionPlan.new
+    end
+
+    def subscription
+      Wepay::Api::Subscription.new
+    end
+  end
+end

data/lib/wepay/api/account.rb

@@ -0,0 +1,86 @@
+module Wepay
+  module Api
+    class Account < Base
+      ##
+      # @param params [Hash] See documentation below
+      # @return [Hashie::Mash]
+      # @docs [/account](https://www.wepay.com/developer/reference/account#lookup)
+      #
+      def show(params)
+        post 'account', params
+      end
+
+      ##
+      # @param params [Hash] See documentation below
+      # @return [Hashie::Mash]
+      # @docs [/account/find](https://www.wepay.com/developer/reference/account#find)
+      #
+      def find(params)
+        post 'account/find', params
+      end
+
+      ##
+      # @param params [Hash] See documentation below
+      # @return [Hashie::Mash]
+      # @docs [/account/create](https://www.wepay.com/developer/reference/account#create)
+      #
+      def create(params)
+        post 'account/create', params
+      end
+
+      ##
+      # @param params [Hash] See documentation below
+      # @return [Hashie::Mash]
+      # @docs [/account/modify](https://www.wepay.com/developer/reference/account#modify)
+      #
+      def modify(params)
+        post 'account/modify', params
+      end
+
+      ##
+      # @param params [Hash] See documentation below
+      # @return [Hashie::Mash]
+      # @docs [/account/delete](https://www.wepay.com/developer/reference/account#delete)
+      #
+      def delete(params)
+        post 'account/delete', params
+      end
+
+      ##
+      # @param params [Hash] See documentation below
+      # @return [Hashie::Mash]
+      # @docs [/account/balance](https://www.wepay.com/developer/reference/account#balance)
+      #
+      def balance(params)
+        post 'account/balance', params
+      end
+
+      ##
+      # @param params [Hash] See documentation below
+      # @return [Hashie::Mash]
+      # @docs [/account/add_bank](https://www.wepay.com/developer/reference/account#add_bank)
+      #
+      def add_bank(params)
+        post 'account/add_bank', params
+      end
+
+      ##
+      # @param params [Hash] See documentation below
+      # @return [Hashie::Mash]
+      # @docs [/account/set_tax](https://www.wepay.com/developer/reference/account#set_tax)
+      #
+      def set_tax(params)
+        post 'account/set_tax', params
+      end
+
+      ##
+      # @param params [Hash] See documentation below
+      # @return [Hashie::Mash]
+      # @docs [/account/get_tax](https://www.wepay.com/developer/reference/account#get_tax)
+      #
+      def get_tax(params)
+        post 'account/get_tax', params
+      end
+    end
+  end
+end

data/lib/wepay/api/base.rb

@@ -0,0 +1,25 @@
+module Wepay
+  module Api
+    class Base
+      def initialize
+      end
+
+      private
+      def get(path, params = {})
+        make_request(:get, path, params)
+      end
+
+      def post(path, params = {})
+        make_request(:post, path, params)
+      end
+
+      def make_request(http_method, path, params = {})
+        client.send(http_method, path, params)
+      end
+
+      def client
+        @client ||= ::Wepay::Client::Data.new
+      end
+    end
+  end
+end

data/lib/wepay/api/checkout.rb

@@ -0,0 +1,68 @@
+module Wepay
+  module Api
+    class Checkout < Base
+      ##
+      # @param params [Hash] See documentation below
+      # @return [Hashie::Mash]
+      # @docs [/checkout](https://www.wepay.com/developer/reference/checkout#lookup)
+      #
+      def show(params)
+        post 'checkout', params
+      end
+
+      ##
+      # @param params [Hash] See documentation below
+      # @return [Hashie::Mash]
+      # @docs [/checkout/find](https://www.wepay.com/developer/reference/checkout#find)
+      #
+      def find(params)
+        post 'checkout/find', params
+      end
+
+      ##
+      # @param params [Hash] See documentation below
+      # @return [Hashie::Mash]
+      # @docs [/checkout/create](https://www.wepay.com/developer/reference/checkout#create)
+      #
+      def create(params)
+        post 'checkout/create', params
+      end
+
+      ##
+      # @param params [Hash] See documentation below
+      # @return [Hashie::Mash]
+      # @docs [/checkout/cancel](https://www.wepay.com/developer/reference/checkout#cancel)
+      #
+      def cancel(params)
+        post 'checkout/cancel', params
+      end
+
+      ##
+      # @param params [Hash] See documentation below
+      # @return [Hashie::Mash]
+      # @docs [/checkout/refund](https://www.wepay.com/developer/reference/checkout#refund)
+      #
+      def refund(params)
+        post 'checkout/refund', params
+      end
+
+      ##
+      # @param params [Hash] See documentation below
+      # @return [Hashie::Mash]
+      # @docs [/checkout/capture](https://www.wepay.com/developer/reference/checkout#capture)
+      #
+      def capture(params)
+        post 'checkout/capture', params
+      end
+
+      ##
+      # @param params [Hash] See documentation below
+      # @return [Hashie::Mash]
+      # @docs [/checkout/modify](https://www.wepay.com/developer/reference/checkout#modify)
+      #
+      def modify(params)
+        post 'checkout/modify', params
+      end
+    end
+  end
+end

data/lib/wepay/api/preapproval.rb

@@ -0,0 +1,50 @@
+module Wepay
+  module Api
+    class Preapproval < Base
+      ##
+      # @param params [Hash] See documentation below
+      # @return [Hashie::Mash]
+      # @docs [/preapproval](https://www.wepay.com/developer/reference/preapproval#lookup)
+      #
+      def show(params)
+        post 'preapproval', params
+      end
+
+      ##
+      # @param params [Hash] See documentation below
+      # @return [Hashie::Mash]
+      # @docs [/preapproval/find](https://www.wepay.com/developer/reference/preapproval#find)
+      #
+      def find(params)
+        post 'preapproval/find', params
+      end
+
+      ##
+      # @param params [Hash] See documentation below
+      # @return [Hashie::Mash]
+      # @docs [/preapproval/create](https://www.wepay.com/developer/reference/preapproval#create)
+      #
+      def create(params)
+        post 'preapproval/create', params
+      end
+
+      ##
+      # @param params [Hash] See documentation below
+      # @return [Hashie::Mash]
+      # @docs [/preapproval/cancel](https://www.wepay.com/developer/reference/preapproval#cancel)
+      #
+      def cancel(params)
+        post 'preapproval/cancel', params
+      end
+
+      ##
+      # @param params [Hash] See documentation below
+      # @return [Hashie::Mash]
+      # @docs [/preapproval/modify](https://www.wepay.com/developer/reference/preapproval#modify)
+      #
+      def modify(params)
+        post 'preapproval/modify', params
+      end
+    end
+  end
+end