quadrigacx 0.10.1 → 0.12.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 87dc9a8f727cc5f6e4749da2d2249eb4b9a971f7
-  data.tar.gz: aa49fdb5c2851d458aacd553d69d80d13335278f
+  metadata.gz: 565de7d0bcdfd3b98d27fbd90bf391a4200a5fb0
+  data.tar.gz: d94ceaf268848220b477e90fe08f989ad35be137
 SHA512:
-  metadata.gz: 30d28d85cce4ff896ef52e42ac09598fb1066f7506dc40814a49b4611b6ad516b871a75df948c543801131a15e5b54ae46857415a842a986a2ab58c868cd6501
-  data.tar.gz: d4f22e10b82b5f0d0dc4c71cad5b0103bd3928cab809d4f22e782de47c86847cac3cef07934f82a38267defcad96d73f343d24c5e4f0b841957d82bf963e7b3d
+  metadata.gz: ddd9327a61471d74a17767a8537f3877f39913990e54076aee5bedbdfef6ebb9d97930670667c9d9cca9f3152e744ccc27e67c2dded54859ced9996d840d84c9
+  data.tar.gz: ed0d5fa33d2751ccb443caa5a66f82373d94a9a29a722e0a9d263d2c91fbfed8455c2cd031f54dd9295193e8ea9bf1079afd7d7f017d792074b87966a477fdc3

data/.gitignore

@@ -1,36 +1,16 @@
-*.gem
-*.rbc
-/.config
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
 /coverage/
-/InstalledFiles
+/doc/
 /pkg/
 /spec/reports/
-/test/tmp/
-/test/version_tmp/
 /tmp/
-
-## Specific to RubyMotion:
-.dat*
-.repl_history
-build/
-
-## Documentation cache and generated files:
-/.yardoc/
-/_yardoc/
-/doc/
-/rdoc/
-
-## Environment normalisation:
-/.bundle/
-/lib/bundler/man/
-
-# for a library or gem, you might want to ignore these files since the code is
-# intended to run in multiple environments; otherwise, check them in:
-# Gemfile.lock
-# .ruby-version
-# .ruby-gemset
-
-# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
-.rvmrc
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
 
 .env

data/Gemfile.lock

@@ -1,8 +1,7 @@
 PATH
   remote: .
   specs:
-    quadrigacx (0.9.0)
-      hashie (~> 3.3)
+    quadrigacx (0.12.2)
       json (~> 1.8)
       rest-client (~> 1.7)
 
@@ -20,12 +19,12 @@ GEM
       unf (>= 0.0.5, < 1.0.0)
     dotenv (1.0.2)
     gem-release (0.7.3)
-    hashie (3.4.2)
     http-cookie (1.0.2)
       domain_name (~> 0.5)
     json (1.8.3)
     mime-types (2.6.1)
     netrc (0.10.3)
+    rake (10.4.2)
     rest-client (1.8.0)
       http-cookie (>= 1.0.2, < 2.0)
       mime-types (>= 1.16, < 3.0)
@@ -55,10 +54,12 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  bundler (~> 1.7)
   byebug (~> 5.0)
   dotenv (~> 1.0)
   gem-release (~> 0.7)
   quadrigacx!
+  rake (~> 10.0)
   rspec (~> 3.1)
   vcr (~> 2.9)
   webmock (~> 1.20)

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Maros Hluska
+
+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

@@ -1,15 +1,150 @@
-# QuadrigaCX
+# Quadrigacx
 
-Ruby wrapper for the QuadrigaCX API
+Ruby wrapper for the QuadrigaCX API.
 
-`gem install quadrigacx`
+## Installation
 
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'quadrigacx'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install quadrigacx
+
+## Usage
+
+```ruby
+require 'quadrigacx'
+
+QuadrigaCX.configure do |config|
+  config.client_id  = 'your-client-id'
+  config.api_key    = 'your-api-key'
+  config.api_secret = 'your-api-secret'
+end
+
+client = QuadrigaCX::Client.new
+```
+
+### Public Methods
+
+#### Ticker
+
+Return trading information.
+
+```ruby
+ticker = client.ticker
+```
+
+#### Order Book
+
+List all open orders.
+
+```ruby
+order_book = client.order_book
+order_book_ungrouped = client.order_book(group: 0)
+```
+
+#### Transactions
+
+Return descending JSON list of recent trades.
+
+```ruby
+transactions = client.transactions
+```
+
+### Private Methods
+
+#### Balance
+
+List all account balances.
+
+```ruby
+balance = client.balance
+```
+
+#### Limit Buy
+
+Place a limit buy order. Returns JSON describing the order.
+
+```ruby
+order = client.limit_buy(price: 200, amount: 1)
 ```
-client = QuadrigaCX::Client.new(
-	api_key:    'API_KEY', 
-	api_secret: 'API_SECRET', 
-	client_id:  'CLIENT_ID',
-)
 
-puts client.balance
+#### Limit Sell
+
+Place a limit sell order. Returns JSON describing the order.
+
+```ruby
+order = client.limit_sell(price: 200, amount: 1)
+```
+
+#### Market Buy
+
+Place a market order. Returns JSON describing the order.
+
+```ruby
+order = client.market_buy(amount: 5.00)
+```
+
+#### Market Sell
+
+Place a market order. Returns JSON describing the order.
+
+```ruby
+order = client.market_sell(amount: 0.01)
+```
+
+#### Cancel
+
+Cancel an order.
+
+```ruby
+client.cancel(order.id)
+```
+
+#### Withdraw
+
+Withdraw bitcoins.
+
+```ruby
+response = client.withdraw(amount: 1, address: '1FAs1ywa3pqS6S5mvypXjCtHAzwCkymNUX')
+```
+
+#### Open Orders
+
+Return a JSON list of open orders.
+
+```ruby
+response = client.open_orders
+```
+
+#### Wallet Address
+
+Return a bitcoin deposit address.
+
+```ruby
+response = client.wallet_address
+```
+
+#### User Transactions
+
+Return a list of user transactions.
+
+```ruby
+response = client.user_transactions
 ```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/quadrigacx/fork )
+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 a new Pull Request

data/Rakefile

@@ -1 +1,2 @@
-require 'bundler/gem_tasks'
+require "bundler/gem_tasks"
+

data/lib/quadrigacx.rb

@@ -1,36 +1,19 @@
-require 'quadrigacx/request'
-require 'quadrigacx/client'
-require 'quadrigacx/version'
-require 'quadrigacx/error'
-
 module QuadrigaCX
-  @@options = {}
-
-  # Define a global configuration
-  #
-  # options[:api_key]
-  # options[:api_secret]
-  #
-  def self.configure options={}
-    unless options.kind_of?(Hash)
-      raise ArgumentError, "Options hash required"
-    end
+  autoload :Error,   'quadrigacx/error'
+  autoload :Request, 'quadrigacx/request'
+  autoload :Client,  'quadrigacx/client'
+  autoload :Version, 'quadrigacx/version'
 
-    @@options[:client_id]  = options[:client_id]
-    @@options[:api_key]    = options[:api_key]
-    @@options[:api_secret] = options[:api_secret]
-    @@options
+  class << self
+    attr_accessor :configuration
   end
 
-  # Returns global configuration hash
-  #
-  def self.configuration
-    @@options
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration)
   end
 
-  # Resets the global configuration
-  #
-  def self.reset_configuration
-    @@options = {}
+  class Configuration
+    attr_accessor :client_id, :api_key, :api_secret
   end
 end

data/lib/quadrigacx/client.rb

@@ -1,11 +1,11 @@
-require_relative 'client/public'
-require_relative 'client/private'
-
 module QuadrigaCX
+  autoload :Public,  'quadrigacx/client/public'
+  autoload :Private, 'quadrigacx/client/private'
+
   class Client
-    include QuadrigaCX::Request
-    include QuadrigaCX::Public
-    include QuadrigaCX::Private
+    include Request
+    include Public
+    include Private
 
     attr_reader :api_key, :api_secret, :client_id
 

data/lib/quadrigacx/client/private.rb

@@ -1,12 +1,12 @@
 module QuadrigaCX
   module Private
-    # List all account balances
+    # List all account balances.
     #
     def balance
       request(:post, '/balance')
     end
 
-    # Places a limit buy order. Returns JSON describing the order
+    # Place a limit buy order. Returns JSON describing the order.
     #
     # amount - amount of major currency
     # price  - price to buy at
@@ -16,7 +16,7 @@ module QuadrigaCX
       request(:post, '/buy', params)
     end
 
-    # Places a limit sell order. Returns JSON describing the order
+    # Place a limit sell order. Returns JSON describing the order.
     #
     # amount - amount of major currency
     # price  - price to sell at
@@ -26,7 +26,7 @@ module QuadrigaCX
       request(:post, '/sell', params)
     end
 
-    # Places a market order. Returns JSON describing the order
+    # Place a market order. Returns JSON describing the order.
     #
     # amount - amount of minor currency to spend
     # book   - optional, if not specified, will default to btc_cad
@@ -34,14 +34,22 @@ module QuadrigaCX
       request(:post, '/buy', params)
     end
 
-    # Cancels an order
+    # Place a market order. Returns JSON describing the order.
+    #
+    # amount - amount of minor currency to spend
+    # book   - optional, if not specified, will default to btc_cad
+    def market_sell params={}
+      request(:post, '/sell', params)
+    end
+
+    # Cancel an order.
     #
     # id – a 64 characters long hexadecimal string taken from the list of orders
     def cancel params={}
       request(:post, '/cancel_order', params)
     end
 
-    # Withdraw bitcoins
+    # Withdraw bitcoins.
     #
     # amount  – The amount to withdraw
     # address – The bitcoin address we will send the amount to
@@ -49,19 +57,20 @@ module QuadrigaCX
       request(:post, '/bitcoin_withdrawal', params)
     end
 
-    # Returns a JSON list of open orders
+    # Return a JSON list of open orders.
     #
     # book - optional, if not specified, will default to btc_cad
     def open_orders params={}
       request(:post, '/open_orders', params)
     end
 
-    # Returns a bitcoin deposit address for funding your account
+    # Return a bitcoin deposit address.
     def wallet_address params={}
       request(:post, '/bitcoin_deposit_address', params)
     end
 
-    # Returns a descending list of user transactions
+    # Return a list of user transactions.
+    #
     # offset - optional, skip that many transactions before beginning to return results. Default: 0.
     # limit  - optional, limit result to that many transactions. Default: 100.
     # sort   - optional, sorting by date and time (asc - ascending; desc - descending). Default: desc.

data/lib/quadrigacx/client/public.rb

@@ -7,7 +7,7 @@ module QuadrigaCX
       request(:get, '/ticker', params)
     end
 
-    # List all open orders
+    # List all open orders.
     #
     # book  - optional, book to return orders for. Default btc_cad.
     # group - optional, group orders with the same price (0 - false; 1 - true). Default: 1.
@@ -15,7 +15,7 @@ module QuadrigaCX
       request(:get, '/order_book', params)
     end
 
-    # Returns descending JSON list of recent trades
+    # Return descending JSON list of recent trades.
     #
     # book - optional, book to return orders for (default btc_cad)
     # time - optional, time frame for transaction export ("minute" - 1 minute, "hour" - 1 hour). Default: hour.