rbtc_arbitrage 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 085039358b729bed53c64ff11885c145b9a90686
-  data.tar.gz: 841862abfc69c37d33ed1225727f19a5fe2be36c
+  metadata.gz: a1ae715eb30b67673c7fb9efa9cd6a9d7fcbc786
+  data.tar.gz: ac76073648c581650bece469ab13d79af0034653
 SHA512:
-  metadata.gz: 4523e93e04eff256b8e811f20c1abe832d156e05bf965cf6053989bb772e55d91f7563d647bff86f0d2ef0b3dabf690ee9408c40d00e80b9bbde2b2266ae852e
-  data.tar.gz: eaf1b7274b62f349c57141f82826fba5dea50394b13f26a6d59c3be79b20e30688ea4fce917077cf1e171f7980be2297b9043138ae8a3c9c2d90d9b226d8b369
+  metadata.gz: 6ef2161031e005cf0b32454b61b2737fe1af44319aa78486e79878fb7af461af21a91411437d8e110fc080496b7095e3dda5b3c95ac1343a0b0e514f62b7d162
+  data.tar.gz: b140bab5a24e2df05e6314df2f06826cd14144982bf561afe57e1f544d2d4705e3efe19d0e86aa530c7732e9c338f76a503acfe087fa57f9ddf6a210fd8fe779

data/README.md

@@ -40,7 +40,7 @@ After installing the gem, simply run `rbtc` in the command line.
 - **Cutoff**: the minimum profit percentage required to execute a trade. Defaults to **%2.00**.
 - **Volume**: The amount of bitcoins to trade per transaction. Defaults to **0.01** (the minimum transaction size).
 - **Buyer**: The exchange you'd like to buy bitcoins from during arbitrage. `"mtgox"` or `"bitstamp"`. Default is `bitstamp`
-- **Seller**: The exchange you'd like to sell bitcoins from during arbitrage. `"mtgox"` or `"bitstamp"`. Default is `bitstamp`
+- **Seller**: The exchange you'd like to sell bitcoins from during arbitrage. `"mtgox"` or `"bitstamp"`. Default is `mtgox`
 
 #### Examples
 
@@ -62,12 +62,7 @@ The output will look like this:
 
 ## Changelog
 
-### 2.0.0
-
-- full refactor
-- 100% test coverage
-- Modularized exchange-specific code to allow for easier extension.
-- CLI `buyer` and `seller` option.
+See [releases](https://github.com/hstove/rbtc_arbitrage/releases).
 
 ## Contributing
 
@@ -88,5 +83,6 @@ Right now there is support for only MtGox and Bitstamp, but adding support for o
 - `price`
 - `trade`
 - `exchange`
+- `transfer`
 
 Make sure that the methods accept the same arguments and return similar objects. At the same time, make sure you copy the [mtgox_cient_spec](https://github.com/hstove/rbtc_arbitrage/blob/master/spec/clients/mtgox_client_spec.rb) and change it to test your client.

data/lib/rbtc_arbitrage/clients/mtgox_client.rb

@@ -3,12 +3,19 @@ module RbtcArbitrage
     class MtGoxClient
       include RbtcArbitrage::Client
 
+      ##
+      # Returns an array of Floats.
+      # The first element is the balance in BTC;
+      # The second is in USD.
       def balance
         return @balance if @balance
         balances = MtGox.balance
         @balance = [balances[0].amount.to_f, balances[1].amount.to_f]
       end
 
+      ##
+      # Configures the MtGox
+      # client's API keys.
       def validate_env
         validate_keys
         MtGox.configure do |config|
@@ -22,6 +29,7 @@ module RbtcArbitrage
       end
 
       # `action` is :buy or :sell
+      # Returns a Numeric type.
       def price action
         return @price if @price
         action = {
@@ -37,6 +45,9 @@ module RbtcArbitrage
         MtGox.send(action, @options[:volume], :market)
       end
 
+      ##
+      # Transfers BTC to the address of a different
+      # exchange.
       def transfer other_client
         MtGox.withdraw! @options[:volume], other_client.address
       end

data/lib/rbtc_arbitrage/version.rb

@@ -1,3 +1,3 @@
 module RbtcArbitrage
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

data/lib/rbtc_arbitrage.rb

@@ -2,8 +2,14 @@ require 'thor'
 require 'mtgox'
 require_relative 'rbtc_arbitrage/campbx.rb'
 require 'bitstamp'
-require 'btce'
+# require 'btce'
+require_relative 'rbtc_arbitrage/client.rb'
 Dir["#{File.dirname(__FILE__)}/rbtc_arbitrage/**/*.rb"].each { |f| require(f) }
 
 module RbtcArbitrage
+  def self.clients
+    RbtcArbitrage::Clients.constants.collect do |c|
+      RbtcArbitrage::Clients.const_get(c)
+    end
+  end
 end

data/spec/rbtc_arbitrage_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe RbtcArbitrage do
+  describe ".clients" do
+    it "includes clients" do
+      clients = RbtcArbitrage.clients
+      clients.should include(RbtcArbitrage::Clients::MtGoxClient)
+      clients.should include(RbtcArbitrage::Clients::BitstampClient)
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rbtc_arbitrage
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Hank Stoever
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-18 00:00:00.000000000 Z
+date: 2013-12-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -167,6 +167,7 @@ files:
 - spec/client_spec.rb
 - spec/clients/bitstamp_client_spec.rb
 - spec/clients/mtgox_client_spec.rb
+- spec/rbtc_arbitrage_spec.rb
 - spec/spec_helper.rb
 - spec/support/cassettes/RbtcArbitrage_Clients_BitstampClient/_balance/fetches_the_balance_correctly.yml
 - spec/support/cassettes/RbtcArbitrage_Clients_BitstampClient/_price/fetches_price_for_buy_correctly.yml
@@ -213,6 +214,7 @@ test_files:
 - spec/client_spec.rb
 - spec/clients/bitstamp_client_spec.rb
 - spec/clients/mtgox_client_spec.rb
+- spec/rbtc_arbitrage_spec.rb
 - spec/spec_helper.rb
 - spec/support/cassettes/RbtcArbitrage_Clients_BitstampClient/_balance/fetches_the_balance_correctly.yml
 - spec/support/cassettes/RbtcArbitrage_Clients_BitstampClient/_price/fetches_price_for_buy_correctly.yml