Module: Buttercoin::Client::TransactionMethods

Included in:
Buttercoin::Client
Defined in:
lib/buttercoin/client/transaction_methods.rb

Instance Method Summary collapse

Instance Method Details

#cancel_transaction(transactionId, timestamp = nil) ⇒ Object

Cancel transaction by id

Parameters:

  • timestamp (defaults to: nil) —

    integer (optional)

Returns:

  • Hashie object containing status and success message



82
83
84
 
# File 'lib/buttercoin/client/transaction_methods.rb', line 82

def cancel_transaction(transactionId, timestamp=nil)
  delete '/transactions/'+transactionId, timestamp
end

#create_deposit(options, timestamp = nil) ⇒ Object

Create new deposit with the given params

Parameters:

  • timestamp (defaults to: nil) —

    integer (optional)

  • options —

    Hash (required) transaction params

Returns:

  • string containing response location header url



49
50
51
 
# File 'lib/buttercoin/client/transaction_methods.rb', line 49

def create_deposit(options, timestamp=nil)
  post '/transactions/deposit', timestamp, options
end

#create_withdrawal(options, timestamp = nil) ⇒ Object

Create new withdrawal with the given params

Parameters:

  • timestamp (defaults to: nil) —

    integer (optional)

  • options —

    Hash (required) transaction params

Returns:

  • string containing response location header url



60
61
62
 
# File 'lib/buttercoin/client/transaction_methods.rb', line 60

def create_withdrawal(options, timestamp=nil)
  post '/transactions/withdraw', timestamp, options
end

#get_transaction_by_id(transactionId, timestamp = nil) ⇒ Object

Retrieve the transaction by id

Parameters:

  • timestamp (defaults to: nil) —

    integer (optional)

Returns:

  • Hashie object containing transaction info



12
13
14
 
# File 'lib/buttercoin/client/transaction_methods.rb', line 12

def get_transaction_by_id(transactionId, timestamp=nil)
  get '/transactions/'+transactionId, timestamp
end

#get_transaction_by_url(url, timestamp = nil) ⇒ Object

Retrieve the transaction by url

Parameters:

  • url —

    full url of the transaction request

  • timestamp (defaults to: nil) —

    integer (optional)

Returns:

  • Hashie object containing transaction info

Raises:



23
24
25
26
27
28
 
# File 'lib/buttercoin/client/transaction_methods.rb', line 23

def get_transaction_by_url(url, timestamp=nil)
  index = url.rindex('/transactions')
  raise Error.new('Url not correctly formatted for transactions') if index.nil?
  path = url[index..-1]
  get path, timestamp
end

#get_transactions(options = {}, timestamp = nil) ⇒ Object

Get list of transactions by search criteria

Parameters:

  • timestamp (defaults to: nil) —

    integer (optional)

  • options (defaults to: {}) —

    Hash (optional) criteria to filter list

Returns:

  • Hashie object containing list of transactions



37
38
39
40
 
# File 'lib/buttercoin/client/transaction_methods.rb', line 37

def get_transactions(options={}, timestamp=nil)
  mash = get '/transactions', timestamp, options
  mash.results
end

#send_bitcoin(options, timestamp = nil) ⇒ Object

Create new bitcoin withdrawal with the given params

Parameters:

  • timestamp (defaults to: nil) —

    integer (optional)

  • options —

    Hash (required) transaction params

Returns:

  • string containing response location header url



71
72
73
 
# File 'lib/buttercoin/client/transaction_methods.rb', line 71

def send_bitcoin(options, timestamp=nil)
  post '/transactions/send', timestamp, options
end