gocoin 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 082a6ad98fcbf6f29a42ad086bd089c2affb6e6f
+  data.tar.gz: f5e3522ec8d5b26df2b5846b70b1fdb20e3e526a
+SHA512:
+  metadata.gz: 9800f8ac6fa21d075d7e58c5d1d3ba8689f1ca5dc91ffa178f2c91231eecf28ad93e0714de18b1a5c451187725af698cc6e6b7e4d1f2dca3ee1dc460eb32ec1e
+  data.tar.gz: 5900480732b45f00b73f2f5a17e1cc6e854a9e1487ea41a0310d74d5ed0cdeb1c2044517cd33c9ae066d93db18ac2dfc3af9bf0d87a087114ad1267592e67001

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,191 @@
+Apache License
+Version 2.0, January 2004
+http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+"License" shall mean the terms and conditions for use, reproduction, and
+distribution as defined by Sections 1 through 9 of this document.
+
+"Licensor" shall mean the copyright owner or entity authorized by the copyright
+owner that is granting the License.
+
+"Legal Entity" shall mean the union of the acting entity and all other entities
+that control, are controlled by, or are under common control with that entity.
+For the purposes of this definition, "control" means (i) the power, direct or
+indirect, to cause the direction or management of such entity, whether by
+contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the
+outstanding shares, or (iii) beneficial ownership of such entity.
+
+"You" (or "Your") shall mean an individual or Legal Entity exercising
+permissions granted by this License.
+
+"Source" form shall mean the preferred form for making modifications, including
+but not limited to software source code, documentation source, and configuration
+files.
+
+"Object" form shall mean any form resulting from mechanical transformation or
+translation of a Source form, including but not limited to compiled object code,
+generated documentation, and conversions to other media types.
+
+"Work" shall mean the work of authorship, whether in Source or Object form, made
+available under the License, as indicated by a copyright notice that is included
+in or attached to the work (an example is provided in the Appendix below).
+
+"Derivative Works" shall mean any work, whether in Source or Object form, that
+is based on (or derived from) the Work and for which the editorial revisions,
+annotations, elaborations, or other modifications represent, as a whole, an
+original work of authorship. For the purposes of this License, Derivative Works
+shall not include works that remain separable from, or merely link (or bind by
+name) to the interfaces of, the Work and Derivative Works thereof.
+
+"Contribution" shall mean any work of authorship, including the original version
+of the Work and any modifications or additions to that Work or Derivative Works
+thereof, that is intentionally submitted to Licensor for inclusion in the Work
+by the copyright owner or by an individual or Legal Entity authorized to submit
+on behalf of the copyright owner. For the purposes of this definition,
+"submitted" means any form of electronic, verbal, or written communication sent
+to the Licensor or its representatives, including but not limited to
+communication on electronic mailing lists, source code control systems, and
+issue tracking systems that are managed by, or on behalf of, the Licensor for
+the purpose of discussing and improving the Work, but excluding communication
+that is conspicuously marked or otherwise designated in writing by the copyright
+owner as "Not a Contribution."
+
+"Contributor" shall mean Licensor and any individual or Legal Entity on behalf
+of whom a Contribution has been received by Licensor and subsequently
+incorporated within the Work.
+
+2. Grant of Copyright License.
+
+Subject to the terms and conditions of this License, each Contributor hereby
+grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free,
+irrevocable copyright license to reproduce, prepare Derivative Works of,
+publicly display, publicly perform, sublicense, and distribute the Work and such
+Derivative Works in Source or Object form.
+
+3. Grant of Patent License.
+
+Subject to the terms and conditions of this License, each Contributor hereby
+grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free,
+irrevocable (except as stated in this section) patent license to make, have
+made, use, offer to sell, sell, import, and otherwise transfer the Work, where
+such license applies only to those patent claims licensable by such Contributor
+that are necessarily infringed by their Contribution(s) alone or by combination
+of their Contribution(s) with the Work to which such Contribution(s) was
+submitted. If You institute patent litigation against any entity (including a
+cross-claim or counterclaim in a lawsuit) alleging that the Work or a
+Contribution incorporated within the Work constitutes direct or contributory
+patent infringement, then any patent licenses granted to You under this License
+for that Work shall terminate as of the date such litigation is filed.
+
+4. Redistribution.
+
+You may reproduce and distribute copies of the Work or Derivative Works thereof
+in any medium, with or without modifications, and in Source or Object form,
+provided that You meet the following conditions:
+
+You must give any other recipients of the Work or Derivative Works a copy of
+this License; and
+You must cause any modified files to carry prominent notices stating that You
+changed the files; and
+You must retain, in the Source form of any Derivative Works that You distribute,
+all copyright, patent, trademark, and attribution notices from the Source form
+of the Work, excluding those notices that do not pertain to any part of the
+Derivative Works; and
+If the Work includes a "NOTICE" text file as part of its distribution, then any
+Derivative Works that You distribute must include a readable copy of the
+attribution notices contained within such NOTICE file, excluding those notices
+that do not pertain to any part of the Derivative Works, in at least one of the
+following places: within a NOTICE text file distributed as part of the
+Derivative Works; within the Source form or documentation, if provided along
+with the Derivative Works; or, within a display generated by the Derivative
+Works, if and wherever such third-party notices normally appear. The contents of
+the NOTICE file are for informational purposes only and do not modify the
+License. You may add Your own attribution notices within Derivative Works that
+You distribute, alongside or as an addendum to the NOTICE text from the Work,
+provided that such additional attribution notices cannot be construed as
+modifying the License.
+You may add Your own copyright statement to Your modifications and may provide
+additional or different license terms and conditions for use, reproduction, or
+distribution of Your modifications, or for any such Derivative Works as a whole,
+provided Your use, reproduction, and distribution of the Work otherwise complies
+with the conditions stated in this License.
+
+5. Submission of Contributions.
+
+Unless You explicitly state otherwise, any Contribution intentionally submitted
+for inclusion in the Work by You to the Licensor shall be under the terms and
+conditions of this License, without any additional terms or conditions.
+Notwithstanding the above, nothing herein shall supersede or modify the terms of
+any separate license agreement you may have executed with Licensor regarding
+such Contributions.
+
+6. Trademarks.
+
+This License does not grant permission to use the trade names, trademarks,
+service marks, or product names of the Licensor, except as required for
+reasonable and customary use in describing the origin of the Work and
+reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty.
+
+Unless required by applicable law or agreed to in writing, Licensor provides the
+Work (and each Contributor provides its Contributions) on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied,
+including, without limitation, any warranties or conditions of TITLE,
+NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are
+solely responsible for determining the appropriateness of using or
+redistributing the Work and assume any risks associated with Your exercise of
+permissions under this License.
+
+8. Limitation of Liability.
+
+In no event and under no legal theory, whether in tort (including negligence),
+contract, or otherwise, unless required by applicable law (such as deliberate
+and grossly negligent acts) or agreed to in writing, shall any Contributor be
+liable to You for damages, including any direct, indirect, special, incidental,
+or consequential damages of any character arising as a result of this License or
+out of the use or inability to use the Work (including but not limited to
+damages for loss of goodwill, work stoppage, computer failure or malfunction, or
+any and all other commercial damages or losses), even if such Contributor has
+been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability.
+
+While redistributing the Work or Derivative Works thereof, You may choose to
+offer, and charge a fee for, acceptance of support, warranty, indemnity, or
+other liability obligations and/or rights consistent with this License. However,
+in accepting such obligations, You may act only on Your own behalf and on Your
+sole responsibility, not on behalf of any other Contributor, and only if You
+agree to indemnify, defend, and hold each Contributor harmless for any liability
+incurred by, or claims asserted against, such Contributor by reason of your
+accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work
+
+To apply the Apache License to your work, attach the following boilerplate
+notice, with the fields enclosed by brackets "[]" replaced with your own
+identifying information. (Don't include the brackets!) The text should be
+enclosed in the appropriate comment syntax for the file format. We also
+recommend that a file or class name and description of purpose be included on
+the same "printed page" as the copyright notice for easier identification within
+third-party archives.
+
+   Copyright 2013 GoCoin Pte.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,242 @@
+# gocoin-ruby
+
+A Ruby gem for the GoCoin API.
+
+#### NOTICE:
+This code is highly experimental. If you are interested in GoCoin, please contact kevin@gocoin.com
+
+## Installation
+
+``` ruby
+gem 'gocoin'
+```
+or in a Gemfile
+``` ruby
+require 'gocoin'
+```
+
+##Usage
+
+#### Instantiate a Gocoin client
+
+``` ruby
+gocoin_client = Gocoin::Client.new(
+	client_id: '<CLIENT ID>',
+	client_secret: '<CLIENT SECRET>',
+	redirect_uri: 'https://myapp.com'
+)
+```
+
+#### Generate the URL a user must visit to authorize the app
+
+``` ruby
+gocoin_client.auth.construct_code_url(
+	response_type: 'code',
+	client_id: gocoin_client.options[:client_id],
+	redirect_uri: gocoin_client.options[:redirect_uri],
+	scope: 'user_read_write invoice_read_write',
+	state: 'state_token_you_provide'
+)
+```
+
+The redirect will return the code as a parameter in the URL. For example:
+https://myapp.com?code=RETURNED_CODE&state=state_token_you_provide 
+Call Client#authenticate with the code as a parameter to retrieve a persistent token with the requests grant permissions.
+
+``` ruby
+token = gocoin_client.authenticate( code: CODE )
+gocoin_client.token = token[:access_token]
+```
+Note that token[:access_token] should be stored in your app if you wish to avoid the authentication procedure each time the app is used.
+
+
+#### Retrieve user data from the API.
+
+``` ruby
+# Gocoin::User#self()
+# Require user_read or user_read_write privilege
+user_self = gocoin_client.user.self
+
+# Gocoin::User#get(id)
+same_user = gocoin_client.user.get(user_self[:id])
+```
+
+#### Update user data.
+
+``` ruby
+# Gocoin::User#update(id, params = {})
+# Requires user_read_write grant_type
+gocoin_client.user.update( user_self[:id],
+	email: 'updated@emailaddress.com',
+	first_name: 'Your',
+	last_name: 'NewName'
+)
+```
+
+#### Update the user's password
+
+``` ruby
+# Gocoin::User#update_password(id, params = {})
+# Requires user_password_write permission
+gocoin_client.user.update_password(
+	user_self[:id],
+	current_password: 'gocoin',
+	password: 'gocoin2',
+	password_confirmation: 'gocoin2'
+)
+```
+
+#### Get your merchant_id from your user object (as shown above)
+
+``` ruby
+merchant_id = user_self[:merchant_id]
+
+# Gocoin::Merchant#get(id)
+# Requires merchants_read or merchant_read_write privilege
+merchant_self = gocoin_client.merchant.get(merchant_id))
+```
+
+#### Update your merchant data
+
+``` ruby
+# Gocoin::Merchant#update(id, params = {})
+# Requires merchant_read_write privilege
+gocoin_client.merchant.update( merchant_id,
+  name: "Blingin' Merchant", 
+  address_1: "123 Main St.",
+  address_2: "Suite 1", 
+  city: "Los Angeles", 
+  region: "CA", 
+  country_code: "US", 
+  postal_code: "90000", 
+  contact_name: "Bling McBlingerton", 
+  phone: "1-555-555-5555", 
+  website: "http://www.blinginmerchant.com", 
+  description: "Some description.", 
+  tax_id: "000000"
+)
+```
+
+#### Get info on your accounts payable
+
+``` ruby
+# Gocoin::Merchant#accounts(merchant_id)
+# Requires merchant_read or merchant_read_write privilege
+gocoin_client.merchant.accounts( merchant_id )
+```
+
+#### Get a list of transactions on an account payable
+
+``` ruby
+# Gocoin::Accounts#transactions(account_id, params = {})
+# Requires account_read privilege
+gocoin_client.accounts.transactions( account_id )
+```
+
+#### Create an invoice
+
+``` ruby
+# Gocoin::Invoices#create(id, params = {})
+# Requires invoice_read_write privilege
+created_invoice = gocoin_client.invoices.create( merchant_id,
+  price_currency: "BTC",
+  base_price: 134.00,
+  base_price_currency: "USD",
+  confirmations_required: 6,
+  notification_level: "all",
+  callback_url: "https://myapp.com/gocoin/callback",
+  redirect_url: "https://myapp.com/redirect"
+)
+```
+
+#### Retrieve invoices from the API
+
+``` ruby
+# Gocoin::Invoices#get(id)
+retrieved_invoice = gocoin_client.invoices.get(created_invoice[:id]
+
+# Gocoin::Invoices#search(params = {})
+searched_invoices = gocoin_client.invoices.search(
+	merchant_id: merchant_id,
+	status: 'new',
+	start_time: '2013-01-01',
+	end_time: '2013-12-31',
+	page: 1,
+	per_page: 20
+)
+```
+
+#### Request a payout
+
+``` ruby
+# Gocoin::Merchant::Payouts#request(merchant_id, params)
+# Requires merchant_read_write privilege
+requested_payout = gocoin_client.merchant.payouts.request( merchant_id,
+  currency_code: "BTC",
+  amount: 10
+)
+```
+
+#### Retrieve existing payout requests
+
+``` ruby
+# Gocoin::Merchant::Payouts#get(merchant_id, payout_id)
+# Requires merchant_read_write privilege
+existing_payout = gocoin_client.merchant.payouts.get( merchant_id, payout_id )
+```
+
+``` ruby
+# Gocoin::Merchant::Payouts#list(merchant_id)
+# Requires merchant_read_write privilege
+existing_payouts = gocoin_client.merchant.payouts.list( merchant_id )
+```
+
+#### Request a currency conversion
+
+``` ruby
+# Gocoin::Merchant::CurrencyConversions#request(merchant_id, params)
+# Requires merchant_read_write privilege
+requested_currency_conversion = gocoin_client.merchant.currency_conversions.request( merchant_id,
+  base_currency: "BTC",
+  base_currency_amount: 10,
+  final_currency: "USD"
+)
+```
+
+#### Retrieve existing currency conversion requests
+
+``` ruby
+# Gocoin::Merchant::CurrencyConversions#get(merchant_id, currency_conversion_id)
+# Requires merchant_read_write privilege
+existing_currency_conversion = gocoin_client.merchant.currency_conversions.get( merchant_id, currency_conversion_id )
+```
+
+``` ruby
+# Gocoin::Merchant::CurrencyConversions#list(merchant_id)
+# Requires merchant_read_write privilege
+existing_currency_conversions = gocoin_client.merchant.currency_conversions.list( merchant_id )
+```
+
+#### Retrieve data on supported currencies
+
+``` ruby
+# Gocoin::Merchant::Currencies#get(merchant_id, currency_conversion_id)
+# Requires merchant_read or merchant_read_write privilege
+currency_detail = gocoin_client.merchant.currencies.get( merchant_id, 'BTC' )
+```
+
+``` ruby
+# Gocoin::Merchant::Currencies#list(merchant_id)
+# Requires merchant_read or merchant_read_write privilege
+all_currency_details = gocoin_client.merchant.currency_conversions.list( merchant_id )
+```
+
+#### Update your crypto/fiat split for a currency
+
+``` ruby
+# Gocoin::Merchant::Currencies#update(merchant_id, currency_code, params)
+# Requires merchant_read_write privilege
+gocoin_client.merchant.currencies.update( merchant_id, 'BTC',
+  payment_crypto_split: 75
+)
+```

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