Module: Coinfloor

Defined in:
lib/coinfloor.rb,
lib/coinfloor/net.rb,
lib/coinfloor/model.rb,
lib/coinfloor/helper.rb,
lib/coinfloor/orders.rb,
lib/coinfloor/ticker.rb,
lib/coinfloor/collection.rb,
lib/coinfloor/transactions.rb

Defined Under Namespace

Modules: Helper, Net Classes: Collection, MissingConfigExeception, Model, Order, Orders, Ticker, Transactions, UserTransaction, UserTransactions

Constant Summary collapse

@@currency = 
:gbp

Class Method Summary collapse

Class Method Details

.balance ⇒ Object 



48
49
50
51
52
 
# File 'lib/coinfloor.rb', line 48

def self.balance
  self.sanity_check!

  JSON.parse Coinfloor::Net.post('/balance').to_str
end

.bitcoin_deposit_address ⇒ Object 



67
68
69
70
71
 
# File 'lib/coinfloor.rb', line 67

def self.bitcoin_deposit_address
  # returns the deposit address
  self.sanity_check!
  return Coinfloor::Net.post('/bitcoin_deposit_address').body_str
end

.configured? ⇒ Boolean

Returns:

  • (Boolean) 


90
91
92
 
# File 'lib/coinfloor.rb', line 90

def self.configured?
  self.key && self.secret && self.client_id
end

.order_book ⇒ Object 



82
83
84
 
# File 'lib/coinfloor.rb', line 82

def self.order_book
  return JSON.parse Coinfloor::Net.get('/order_book').to_str
end

.orders ⇒ Object 



32
33
34
35
36
 
# File 'lib/coinfloor.rb', line 32

def self.orders
  self.sanity_check!

  @@orders ||= Coinfloor::Orders.new
end

.sanity_check! ⇒ Object 



94
95
96
97
98
 
# File 'lib/coinfloor.rb', line 94

def self.sanity_check!
  unless configured?
    raise MissingConfigExeception.new("Coinfloor Gem not properly configured")
  end
end

.setup {|_self| ... } ⇒ Object

Yields:

  • (_self)

Yield Parameters:

  • _self (Coinfloor) —

    the object that the method was called on



86
87
88
 
# File 'lib/coinfloor.rb', line 86

def self.setup
  yield self
end

.ticker ⇒ Object 



78
79
80
 
# File 'lib/coinfloor.rb', line 78

def self.ticker
  return Coinfloor::Ticker.from_api
end

.transactions ⇒ Object 



44
45
46
 
# File 'lib/coinfloor.rb', line 44

def self.transactions
  return Coinfloor::Transactions.from_api
end

.unconfirmed_user_deposits ⇒ Object 



73
74
75
76
 
# File 'lib/coinfloor.rb', line 73

def self.unconfirmed_user_deposits
  self.sanity_check!
  return JSON.parse Coinfloor::Net::post("/unconfirmed_btc").body_str
end

.user_transactions ⇒ Object 



38
39
40
41
42
 
# File 'lib/coinfloor.rb', line 38

def self.user_transactions
  self.sanity_check!

  @@transactions ||= Coinfloor::UserTransactions.new
end

.withdraw_bitcoins(options = {}) ⇒ Object 



54
55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/coinfloor.rb', line 54

def self.withdraw_bitcoins(options = {})
  self.sanity_check!
  if options[:amount].nil? || options[:address].nil?
    raise MissingConfigExeception.new("Required parameters not supplied, :amount, :address")
  end
  response_body = Coinfloor::Net.post('/bitcoin_withdrawal',options).body_str
  if response_body != 'true'
    return JSON.parse response_body
  else
    return response_body
  end
end