btcmrb 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8491ba94baa083d21f1df89c845bf25f97d98814
+  data.tar.gz: 123e5f4c4638963fdb0e60fe1157a3bd0f732f5a
+SHA512:
+  metadata.gz: cb29dd93280e6a348b3a8d0bf9c30da946c3f8faedf52d95ca1277ef4dcb002e8d462421ac11a61daa8de111d7718e54a7631b6231ff0f881c6e634f00c5e2a9
+  data.tar.gz: dc2f326f309e511b14b6cb05a02aebecd79c9980aed6f98eaf41352c541ca444c05f8cc67aebdd66383df3a198b4c813bec1aa5f88b4acc81f1771286c7b149a

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+gem 'httparty', '~> 0.14.0'
+gem "pry-byebug", '~> 3.4.0'

data/LICENSE.md

@@ -0,0 +1,7 @@
+Copyright (c) 2016 Jeremy Tennant
+
+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

@@ -0,0 +1,44 @@
+# BTCMarkets API Wrapper
+
+## Description
+Unofficial Ruby Gem for btcmarkets.net API and is still very much a work in progress.
+
+## Installation
+### Install the gem
+```sh
+gem install btcmrb
+```
+### Create some environment variables
+https://btcmarkets.net/account/apikey
+```
+export BTCM_ACCESS_KEY="YOUR ACCESS KEY"
+export BTCM_SECRET="YOUR SECRET"
+```
+
+### Account Management API
+https://github.com/BTCMarkets/API/wiki/Account-API
+```ruby
+# Example
+balance_request = Btcmrb::Account.balance
+client = Btcmrb.new(balance_request)
+# => [{"balance":1000000000,"pendingFunds":0,"currency":"AUD"},{"balance":1000000000,"pendingFunds":0,"currency":"BTC"},{"balance":1000000000,"pendingFunds":0,"currency":"LTC"}]
+```
+
+### Market Data API
+https://github.com/BTCMarkets/API/wiki/Market-data-API
+```ruby
+# Example
+ticker_request = Btcmrb::Marketdata.balance
+client = Btcmrb.new(ticker_request)
+# => {"bestBid":844.0,"bestAsk":844.98,"lastPrice":845.0,"currency":"AUD","instrument":"BTC","timestamp":1476242958,"volume24h":172.60804}
+
+orderbook_request = Btcmrb::Marketdata.orderbook
+client = Btcmrb.new(orderbook_request)
+# => {"currency":"AUD","instrument":"BTC","timestamp":1476243360,"asks":[[844.98,0.45077821],[845.0,2.7069457],[848.68,2.58512],[848.76,0.29745]],"bids":[[844.0,0.00489636],[840.21,0.060724],[840.16,0.1180803],[840.1,0.32130103]]}
+
+trades_requst = Btcmrb::Marketdata.trades
+client = Btcmrb.new(trades_requst)
+# => [{"tid":4432702312,"amount":0.01959674,"price":845.0,"date":1378878093},{"tid":59861212129,"amount":1.21434000,"price":845.15,"date":1377840783}]
+```
+## License
+MIT - For terms refer to LICENSE.md

data/lib/btcmrb/account.rb

@@ -0,0 +1,14 @@
+module Btcmrb
+  class Account
+
+    def self.balance
+      {
+        :uri => "/account/balance",
+        :body => {},
+        :verb => "GET",
+        :auth => true
+      }
+    end
+
+  end
+end

data/lib/btcmrb/client.rb

@@ -0,0 +1,94 @@
+require 'base64'
+require 'openssl'
+# require 'pry-byebug'
+
+module Btcmrb
+
+  class Client
+    BTCM_ACCESS_KEY       = ENV['BTCM_ACCESS_KEY']
+    BTCM_SECRET_KEY       = ENV['BTCM_SECRET']
+    DC_BTCM_ACCESS_KEY    = Base64.decode64(BTCM_ACCESS_KEY)
+    DC_BTCM_SECRET_KEY    = Base64.decode64(BTCM_SECRET_KEY)
+    BASE_URI              = 'https://api.btcmarkets.net'
+    include HTTParty
+
+    attr_accessor :base_uri, :timestamp
+
+    def initialize
+      @base_uri = BASE_URI
+    end
+
+    def send_request(object)
+      if object[:auth] == false
+        # Hooray! We can write less code, authentication is not necessary.
+        response = send(object[:uri])
+      else
+        # Extra work is necessary, we need to prepare and sign the request
+        timestamp = create_timestamp
+        options = {
+          :uri => object[:uri],
+          :timestamp => timestamp,
+          :body => object[:body]
+        }
+        request = format_request(options)
+        signature = sign_request(request)
+        encoded_signature = Base64.encode64(signature).to_s.gsub("\n",'')
+
+        send(object[:uri],
+          { :method => object[:verb],
+            :authentication => object[:auth],
+            :timestamp => timestamp,
+            :encoded_signature => encoded_signature
+        })
+      end
+
+    end
+
+    private
+
+      def create_timestamp
+        (Time.now.to_f * 1000).to_i.to_s
+      end
+
+      def format_request(options)
+        default = options[:uri] + "\n" + options[:timestamp] + "\n"
+        unless options[:body].empty?
+          default = primary + options[:body]
+        end
+        default
+      end
+
+      def send(uri, options={})
+        response = nil
+        default_headers = {
+          'Accept-Charset' => 'UTF-8',
+          'Accept' => 'application/json',
+          'Content-Type' => 'application/json',
+          'User-Agent' => "BTCMRB Ruby Gem v#{Btcmrb::VERSION}"
+        }
+
+        if options[:authentication] && options[:method] == "POST"
+          default_headers.merge!(
+            { 'apikey' => BTCM_ACCESS_KEY ,
+              'signature' => options[:encoded_signature],
+              'timestamp' => options[:timestamp]
+            }).to_json
+            # TODO
+        elsif options[:authentication] && options[:method] == "GET"
+          default_headers.merge!(
+            { 'apikey' => BTCM_ACCESS_KEY ,
+              'signature' => options[:encoded_signature],
+              'timestamp' => options[:timestamp]
+            }).to_json
+          HTTParty.get(BASE_URI + uri, headers: default_headers)
+        else
+          response = HTTParty.get(BASE_URI + uri)
+        end
+      end
+
+      def sign_request(str)
+        OpenSSL::HMAC.digest('sha512', DC_BTCM_SECRET_KEY, str)
+      end
+
+  end
+end

data/lib/btcmrb/marketdata.rb

@@ -0,0 +1,35 @@
+module Btcmrb
+  class Marketdata
+
+    def self.tick
+      {
+        :uri => "/market/BTC/AUD/tick",
+        :body => {},
+        :verb => "GET",
+        :auth => false
+      }
+      #=> {"bestBid":844.0,"bestAsk":844.98,"lastPrice":845.0,"currency":"AUD","instrument":"BTC","timestamp":1476242958,"volume24h":172.60804}
+    end
+
+    def self.orderbook
+      {
+        :uri => "/market/BTC/AUD/orderbook",
+        :body => {},
+        :verb => "GET",
+        :auth => false
+      }
+      #=> {"currency":"AUD","instrument":"BTC","timestamp":1476243360,"asks":[[844.98,0.45077821],[845.0,2.7069457],[848.68,2.58512],[848.76,0.29745]],"bids":[[844.0,0.00489636],[840.21,0.060724],[840.16,0.1180803],[840.1,0.32130103]]}
+    end
+
+    def self.trades
+      {
+        :uri => "/market/BTC/AUD/trades",
+        :body => {},
+        :verb => "GET",
+        :auth => false
+      }
+      #=> [{"tid":4432702312,"amount":0.01959674,"price":845.0,"date":1378878093},{"tid":59861212129,"amount":1.21434000,"price":845.15,"date":1377840783}]
+    end
+
+  end
+end

data/lib/btcmrb/version.rb

@@ -0,0 +1,3 @@
+module Btcmrb
+  VERSION = '0.1.1'
+end

data/lib/btcmrb.rb

@@ -0,0 +1,14 @@
+require "httparty"
+
+Dir[File.dirname(__FILE__) + '/btcmrb/*.rb'].each do |file|
+  require file
+end
+
+module Btcmrb
+
+  def new
+    Client.new
+  end
+  module_function :new
+
+end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification
+name: btcmrb
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Jeremy Tennant
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-11-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+description: Unofficial Ruby Gem for btcmarkets.net API
+email: tennantje@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE.md
+- README.md
+- lib/btcmrb.rb
+- lib/btcmrb/account.rb
+- lib/btcmrb/client.rb
+- lib/btcmrb/marketdata.rb
+- lib/btcmrb/version.rb
+homepage: http://rubygems.org/gems/btcmrb
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Unofficial Ruby Gem for btcmarkets.net API
+test_files: []