bitstampede 0.1.5 → 0.1.6

data/README.md

@@ -37,6 +37,9 @@ client = Bitstampede::Client.new
 client.key = 'YOUR_USER_ID'
 client.secret = 'YOUR_PASSWORD'
 
+# Alternatively, you can configure the client on initialization with:
+client = Bitstampede::Client.new('YOUR_USER_ID', 'YOUR_PASSWORD')
+
 # Fetch your balance
 client.balance
 # => #<Bitstampede::Entities::Balance:0x0000000259f338 @usd_balance=#<BigDecimal:259e898,'0.0',9(9)>, @btc_balance=#<BigDecimal:2726698,'0.0',9(9)>, @usd_reserved=#<BigDecimal:2726328,'0.0',9(9)>, @btc_reserved=#<BigDecimal:2725fb8,'0.0',9(9)>, @usd_available=#<BigDecimal:2725c48,'0.0',9(9)>, @btc_available=#<BigDecimal:27258b0,'0.0',9(9)>, @fee=#<BigDecimal:2725540,'0.0',9(9)>>
@@ -75,3 +78,10 @@ ruby example/balance.rb
 ## License
 
 This software is licensed under [the MIT License.](./LICENSE.md)
+
+## Contributors
+
+These people have contributed to the gem.  Many thanks!:
+
+- Josh Adams
+- [Robert Jackson](https://github.com/rjackson)

data/lib/bitstampede/client.rb

@@ -7,7 +7,9 @@ module Bitstampede
     attr_accessor :key
     attr_accessor :secret
 
-    def initialize
+    def initialize(key = nil, secret = nil)
+      @key    = key
+      @secret = secret
     end
 
     def balance

data/lib/bitstampede/entities/base.rb

@@ -9,10 +9,9 @@ module Bitstampede
         self.mappings.keys
       end
 
-      def initialize(balance_hash)
-        self.class.keys.each do |key|
-          instance_variable_set("@#{key}", self.class.mappings[key].call(balance_hash[key.to_s].to_s))
-        end
+      def initialize(hash)
+        check_for_errors(hash)
+        map_instance_variables(hash)
       end
 
       def inspect
@@ -35,6 +34,19 @@ module Bitstampede
       def self.map_decimal
         ->(val) { BigDecimal(val) }
       end
+
+      private
+      def map_instance_variables(hash)
+        self.class.keys.each do |key|
+          instance_variable_set("@#{key}", self.class.mappings[key].call(hash[key.to_s].to_s))
+        end
+      end
+
+      def check_for_errors(hash)
+        if hash.keys.include?("error")
+          raise Bitstampede::StandardError.new(hash["error"]["__all__"].join(".  "))
+        end
+      end
     end
   end
 end

data/lib/bitstampede/net.rb

@@ -44,7 +44,7 @@ module Bitstampede
     end
 
     def raw_post(endpoint, options)
-      HTTParty.post(url_for(endpoint), body: options.merge(auth_options)).to_s
+      HTTParty.post(url_for(endpoint), body: options.merge(auth_options)).to_s.tap {|r| STDOUT.puts r}
     end
   end
 end

data/lib/bitstampede/version.rb

@@ -1,3 +1,3 @@
 module Bitstampede
-  VERSION = "0.1.5"
+  VERSION = "0.1.6"
 end

data/spec/integration/client_spec.rb

@@ -46,21 +46,33 @@ describe "Integrating a client" do
     expect(orders[0].type).to eq(:buy)
   end
 
-  it "handles #buy!" do
-    example_buy_response = <<-JSON
-      {
-        "id": "1",
-        "datetime": "1234567",
-        "type": 0,
-        "price": "12.34",
-        "amount": "100"
-      }
-    JSON
+  context "handling #buy!" do
+    it "succeeds properly" do
+      example_buy_response = <<-JSON
+        {
+          "id": "1",
+          "datetime": "1234567",
+          "type": 0,
+          "price": "12.34",
+          "amount": "100"
+        }
+      JSON
+
+      FakeWeb.register_uri(:post, "https://www.bitstamp.net/api/buy/", body: example_buy_response)
+
+      buy = subject.buy!(BigDecimal('1'), BigDecimal('100'))
+      expect(buy.type).to eq(:buy)
+    end
+
+    it "fails properly" do
+      example_buy_response = <<-JSON
+        {"error"=>{"__all__"=>["Minimum order size is $1"]}}
+      JSON
 
-    FakeWeb.register_uri(:post, "https://www.bitstamp.net/api/buy/", body: example_buy_response)
+      FakeWeb.register_uri(:post, "https://www.bitstamp.net/api/buy/", body: example_buy_response)
 
-    buy = subject.buy!(BigDecimal('1'), BigDecimal('100'))
-    expect(buy.type).to eq(:buy)
+      expect{ subject.buy!(BigDecimal('1'), BigDecimal('100')) }.to raise_error(Bitstampede::StandardError, "Minimum order size is $1")
+    end
   end
 
   it "handles #sell!" do

data/spec/unit/bitstampede/client_spec.rb

@@ -1,13 +1,26 @@
 require_relative '../../spec_helper'
 
 describe Bitstampede::Client do
-  subject { described_class.new }
-  let(:net){ subject.send(:net) }
-  let(:mapper){ subject.send(:mapper) }
+  subject(:client) { described_class.new }
+  let(:net){ client.send(:net) }
+  let(:mapper){ client.send(:mapper) }
 
   before do
-    subject.key = '1'
-    subject.secret = '2'
+    client.key = '1'
+    client.secret = '2'
+  end
+
+  describe '#initialize' do
+    it 'does not require any initial parameters' do
+      expect { described_class.new }.not_to raise_error
+    end
+
+    it 'allows specifying key/secret on initialize' do
+      client = described_class.new('KEY', 'SECRET')
+
+      expect(client.key).to eql('KEY')
+      expect(client.secret).to eql('SECRET')
+    end
   end
 
   describe '#balance' do
@@ -17,7 +30,7 @@ describe Bitstampede::Client do
     before do
       net.stub(:post).and_return(api_balance_response)
       mapper.stub(:map_balance).and_return(balance_object)
-      subject.balance
+      client.balance
     end
 
     it 'requests the balance from the API' do
@@ -29,7 +42,7 @@ describe Bitstampede::Client do
     end
 
     it 'returns the mapped object' do
-      expect(subject.balance).to eq(balance_object)
+      expect(client.balance).to eq(balance_object)
     end
   end
 
@@ -40,7 +53,7 @@ describe Bitstampede::Client do
     before do
       net.stub(:post).and_return(api_orders_response)
       mapper.stub(:map_orders).and_return([order_object])
-      subject.orders
+      client.orders
     end
 
     it 'requests open orders from the API' do
@@ -62,18 +75,18 @@ describe Bitstampede::Client do
     end
 
     it 'submits a buy order to the API' do
-      subject.buy!(BigDecimal('100'), BigDecimal('1'))
+      client.buy!(BigDecimal('100'), BigDecimal('1'))
       expect(net).to have_received(:post).with('buy', { amount: '100.0', price: '1.0' })
     end
 
     it 'maps the API response to an Order object' do
-      subject.buy!(BigDecimal('100'), BigDecimal('1'))
+      client.buy!(BigDecimal('100'), BigDecimal('1'))
       expect(mapper).to have_received(:map_order).with(api_buy_response)
     end
 
     it 'wraps exceptions in its own class' do
       net.stub(:post).and_raise(StandardError)
-      expect{ subject.buy!(BigDecimal('100'), BigDecimal('1')) }.to raise_error(Bitstampede::StandardError)
+      expect{ client.buy!(BigDecimal('100'), BigDecimal('1')) }.to raise_error(Bitstampede::StandardError)
     end
   end
 
@@ -84,7 +97,7 @@ describe Bitstampede::Client do
     before do
       net.stub(:post).and_return(api_sell_response)
       mapper.stub(:map_order).and_return(order_object)
-      subject.sell!(BigDecimal('100'), BigDecimal('1'))
+      client.sell!(BigDecimal('100'), BigDecimal('1'))
     end
 
     it 'submits a sell order to the API' do
@@ -97,7 +110,7 @@ describe Bitstampede::Client do
 
     it 'wraps exceptions in its own class' do
       net.stub(:post).and_raise(StandardError)
-      expect{ subject.sell!(BigDecimal('100'), BigDecimal('1')) }.to raise_error(Bitstampede::StandardError)
+      expect{ client.sell!(BigDecimal('100'), BigDecimal('1')) }.to raise_error(Bitstampede::StandardError)
     end
   end
 
@@ -107,7 +120,7 @@ describe Bitstampede::Client do
     before do
       net.stub(:post).and_return(api_cancel_response)
       mapper.stub(:map_cancel).and_return(true)
-      subject.cancel(1234)
+      client.cancel(1234)
     end
 
     it 'submits a cancel order to the API' do
@@ -120,7 +133,7 @@ describe Bitstampede::Client do
 
     it 'wraps exceptions in its own class' do
       net.stub(:post).and_raise(StandardError)
-      expect{ subject.cancel(123) }.to raise_error(Bitstampede::StandardError)
+      expect{ client.cancel(123) }.to raise_error(Bitstampede::StandardError)
     end
   end
 end

data/spec/unit/bitstampede/entities/balance_spec.rb

@@ -12,37 +12,37 @@ describe Bitstampede::Entities::Balance do
       "fee" => "1.11"
     }
   }
-  subject{ described_class.new(balance_hash) }
+  subject(:balance) { described_class.new(balance_hash) }
 
   it "has a usd_balance" do
-    expect(subject.usd_balance).to eq(BigDecimal('111.12'))
+    expect(balance.usd_balance).to eq(BigDecimal('111.12'))
   end
 
   it "has a btc_balance" do
-    expect(subject.btc_balance).to eq(BigDecimal('211.23'))
+    expect(balance.btc_balance).to eq(BigDecimal('211.23'))
   end
 
   it "has a usd_reserved" do
-    expect(subject.usd_reserved).to eq(BigDecimal('1.20'))
+    expect(balance.usd_reserved).to eq(BigDecimal('1.20'))
   end
 
   it "has a btc_reserved" do
-    expect(subject.btc_reserved).to eq(BigDecimal('2.30'))
+    expect(balance.btc_reserved).to eq(BigDecimal('2.30'))
   end
 
   it "has a usd_available" do
-    expect(subject.usd_available).to eq(BigDecimal('5.50'))
+    expect(balance.usd_available).to eq(BigDecimal('5.50'))
   end
 
   it "has a btc_available" do
-    expect(subject.btc_available).to eq(BigDecimal('6.60'))
+    expect(balance.btc_available).to eq(BigDecimal('6.60'))
   end
 
   it "has a fee" do
-    expect(subject.fee).to eq(BigDecimal('1.11'))
+    expect(balance.fee).to eq(BigDecimal('1.11'))
   end
 
   it "can be inspected" do
-    expect { subject.inspect }.to_not raise_error
+    expect { balance.inspect }.to_not raise_error
   end
 end

data/spec/unit/bitstampede/entities/order_spec.rb

@@ -1,33 +1,51 @@
 require_relative '../../../spec_helper'
 
 describe Bitstampede::Entities::Order do
-  let(:order_hash){
-    {
-      "id" => "1",
-      "datetime" => 1234567,
-      "type" => 0,
-      "price" => "1.23",
-      "amount" => "10"
-    }
-  }
   subject{ described_class.new(order_hash) }
 
-  it "has an id" do
-    expect(subject.id).to eq(1)
-  end
+  context "a successful order" do
+    let(:order_hash){
+      {
+        "id" => "1",
+        "datetime" => 1234567,
+        "type" => 0,
+        "price" => "1.23",
+        "amount" => "10"
+      }
+    }
 
-  describe "type" do
-    it "maps 0 to :buy" do
-      expect(subject.type).to eq(:buy)
+    it "has an id" do
+      expect(subject.id).to eq(1)
     end
 
-    it "maps 1 to :sell" do
-      order = described_class.new(order_hash.merge({"type" => 1}))
-      expect(order.type).to eq(:sell)
+    describe "type" do
+      it "maps 0 to :buy" do
+        expect(subject.type).to eq(:buy)
+      end
+
+      it "maps 1 to :sell" do
+        order = described_class.new(order_hash.merge({"type" => 1}))
+        expect(order.type).to eq(:sell)
+      end
+
+      it "raises InvalidTypeError for other values" do
+        expect { described_class.new(order_hash.merge({"type" => 2})) }.to raise_error(Bitstampede::Entities::Order::InvalidTypeError)
+      end
     end
+  end
+
+  context "an unsuccessful order" do
+    let(:order_hash){
+      # Don't get mad at me, not my fault bitstamp errors look like this
+      {
+        "error" => {
+          "__all__" => ["Minimum order size is $1"]
+        }
+      }
+    }
 
-    it "raises InvalidTypeError for other values" do
-      expect { described_class.new(order_hash.merge({"type" => 2})) }.to raise_error(Bitstampede::Entities::Order::InvalidTypeError)
+    it "raises an appropriate error" do
+      expect{ subject }.to raise_error(Bitstampede::StandardError, "Minimum order size is $1")
     end
   end
 end

data/spec/unit/bitstampede/mapper_spec.rb

@@ -1,7 +1,7 @@
 require_relative '../../spec_helper'
 
 describe Bitstampede::Mapper do
-  subject { described_class.new }
+  subject(:mapper) { described_class.new }
   let(:json_object){ '{"foo": "bar"}' }
   let(:json_array){ '[{"foo": "bar"}]' }
 
@@ -13,12 +13,12 @@ describe Bitstampede::Mapper do
     end
 
     it "maps a balance API response into a Balance entity" do
-      subject.map_balance(json_object)
+      mapper.map_balance(json_object)
       expect(Entities::Balance).to have_received(:new).with(json_parse(json_object))
     end
 
     it "returns the mapped Balance entity" do
-      expect(subject.map_balance(json_object)).to eq(balance)
+      expect(mapper.map_balance(json_object)).to eq(balance)
     end
   end
 
@@ -30,15 +30,15 @@ describe Bitstampede::Mapper do
     end
 
     it "maps an open_orders API response into an array of Order entities" do
-      subject.map_orders(json_array)
+      mapper.map_orders(json_array)
       expect(Entities::Order).to have_received(:new).with(json_parse(json_array)[0])
     end
   end
 
   describe '#map_cancel' do
     it "maps a cancel API response to a boolean" do
-      expect(subject.map_cancel('"true"')).to eq(true)
-      expect(subject.map_cancel('"false"')).to eq(false)
+      expect(mapper.map_cancel('"true"')).to eq(true)
+      expect(mapper.map_cancel('"false"')).to eq(false)
     end
   end
 end

data/spec/unit/bitstampede/net_spec.rb

@@ -2,7 +2,7 @@ require_relative '../../spec_helper'
 
 describe Bitstampede::Net do
   let(:client){ double }
-  subject { described_class.new(client) }
+  subject(:net) { described_class.new(client) }
 
   before do
     client.stub(:secret).and_return(1)
@@ -10,15 +10,15 @@ describe Bitstampede::Net do
   end
 
   it 'gets instantiated with a client' do
-    expect(subject.client).to eq(client)
+    expect(net.client).to eq(client)
   end
 
   it 'defers to its client for secret' do
-    expect(subject.secret).to eq(1)
+    expect(net.secret).to eq(1)
   end
 
   it 'defers to its client for key' do
-    expect(subject.key).to eq(2)
+    expect(net.key).to eq(2)
   end
 
   describe '#post' do
@@ -36,7 +36,7 @@ describe Bitstampede::Net do
       end
 
       it "queries the appropriate endpoint and returns its body as a string" do
-        expect(json_parse(subject.post('balance'))).to eq(json_parse(example_balance))
+        expect(json_parse(net.post('balance'))).to eq(json_parse(example_balance))
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bitstampede
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-01 00:00:00.000000000 Z
+date: 2013-07-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -191,7 +191,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 517563183236456493
+      hash: -2456329211082367398
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -200,7 +200,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 517563183236456493
+      hash: -2456329211082367398
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25