gocoin 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 082a6ad98fcbf6f29a42ad086bd089c2affb6e6f
-  data.tar.gz: f5e3522ec8d5b26df2b5846b70b1fdb20e3e526a
+  metadata.gz: 2a152b7a8a1c7e064060559e7b8a6db907dc6d8b
+  data.tar.gz: a872f3d1ae7c5a4dc44f2cadd7ca014730cbaa5c
 SHA512:
-  metadata.gz: 9800f8ac6fa21d075d7e58c5d1d3ba8689f1ca5dc91ffa178f2c91231eecf28ad93e0714de18b1a5c451187725af698cc6e6b7e4d1f2dca3ee1dc460eb32ec1e
-  data.tar.gz: 5900480732b45f00b73f2f5a17e1cc6e854a9e1487ea41a0310d74d5ed0cdeb1c2044517cd33c9ae066d93db18ac2dfc3af9bf0d87a087114ad1267592e67001
+  metadata.gz: 744d175663553ebdad11c42a35a1320c91442019ac32519fc1da00422132551df593bd177bb05a4066b3f530d36ca498416d1ab4403c2a48366299c42592ece9
+  data.tar.gz: 73201092c45f9ea43f747aa2f3d210ffced38df3b0493c6d3f61d04c90065a10b4912819eaa0b75db5267e5157ab9d40ffe304e00b69542ebba72d43af676188

data/README.md

@@ -2,9 +2,6 @@
 
 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
@@ -39,18 +36,21 @@ gocoin_client.auth.construct_code_url(
 )
 ```
 
+You then need to either use an HTTP client to GET the URL returned by construct_code_url or paste it into your browser and manually copy the RETURNED_CODE in the redirect (see below).
+
 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.
+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. Once you have a valid access token, you can make all of the following API calls.
 
 
-#### Retrieve user data from the API.
+#### Retrieve user data
 
 ``` ruby
 # Gocoin::User#self()
@@ -61,7 +61,7 @@ user_self = gocoin_client.user.self
 same_user = gocoin_client.user.get(user_self[:id])
 ```
 
-#### Update user data.
+#### Update user data
 
 ``` ruby
 # Gocoin::User#update(id, params = {})
@@ -149,7 +149,7 @@ created_invoice = gocoin_client.invoices.create( merchant_id,
 )
 ```
 
-#### Retrieve invoices from the API
+#### Retrieve invoices
 
 ``` ruby
 # Gocoin::Invoices#get(id)
@@ -166,18 +166,7 @@ searched_invoices = gocoin_client.invoices.search(
 )
 ```
 
-#### 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
+#### Retrieve existing payout details
 
 ``` ruby
 # Gocoin::Merchant::Payouts#get(merchant_id, payout_id)
@@ -191,19 +180,7 @@ existing_payout = gocoin_client.merchant.payouts.get( merchant_id, payout_id )
 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
+#### Retrieve existing currency conversion details
 
 ``` ruby
 # Gocoin::Merchant::CurrencyConversions#get(merchant_id, currency_conversion_id)

data/VERSION

@@ -1 +1 @@
-0.1.2
+0.1.3

data/history.md

@@ -19,3 +19,10 @@ Added methods:
 * client.merchant.payouts.get
 * client.merchant.payouts.list
 * client.merchant.payouts.request
+
+###### v0.1.3:
+Enhanced README documentation. <br>
+
+Removed methods:
+* client.merchant.currency_conversions.request
+* client.merchant.payouts.request

data/lib/gocoin/api/merchants/currency_conversions.rb

@@ -20,16 +20,6 @@ module Gocoin
 				@api.request route, options
 			end
 
-			def request(merchant_id, params)
-				@api.client.logger.debug 'Gocoin::Merchants::CurrencyConversion#request called.'
-				route = "/merchants/#{merchant_id}/currency_conversions"
-				options = {
-					method: 'POST',
-					payload: params
-				}
-				@api.request route, options
-			end
-
 		end
 	end
 end

data/lib/gocoin/api/merchants/payouts.rb

@@ -20,16 +20,6 @@ module Gocoin
 				@api.request route, options
 			end
 
-			def request(merchant_id, params)
-				@api.client.logger.debug 'Gocoin::Merchants::Payouts#request called.'
-				route = "/merchants/#{merchant_id}/payouts"
-				options = {
-					method: 'POST',
-					payload: params
-				}
-				@api.request route, options
-			end
-
 		end
 	end
 end

data/lib/gocoin/version.rb

@@ -1,3 +1,3 @@
 module Gocoin
-  VERSION = '0.1.2'
+  VERSION = '0.1.3'
 end

data/spec/gocoin/api/merchants/currency_conversions_spec.rb

@@ -44,14 +44,6 @@ describe Gocoin::Merchants::CurrencyConversions do
 
 	end
 
-	describe "'request' method" do
-
-    it 'should return the correct result' do
-    	@currency_conversions.request(@merchant_id, @request_params).should == @request_api_return_hash
-    end
-
-	end
-
 	describe "'list' method" do
 
     it 'should return the correct result' do

data/spec/gocoin/api/merchants/payouts_spec.rb

@@ -44,14 +44,6 @@ describe Gocoin::Merchants::Payouts do
 
 	end
 
-	describe "'request' method" do
-
-    it 'should return the correct result' do
-    	@payouts.request(@merchant_id, @request_params).should == @request_api_return_hash
-    end
-
-	end
-
 	describe "'list' method" do
 
     it 'should return the correct result' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gocoin
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - GoCoin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-24 00:00:00.000000000 Z
+date: 2014-03-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client