cointools 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0131dd2bc4e77dd203eacdfb8d13f31693f71394
+  data.tar.gz: dfd75a7b004577d0ec16cda14e8a3e896399b526
+SHA512:
+  metadata.gz: 541daf33af1f794e931e1811bb4d25b1efd8d568f4f790e991142126cee37f9bcfcaf07acb1cfe51f86e230686ed22ee05f4c495152ac9a6f75dc708fde70cbe
+  data.tar.gz: 8f1e98132e55e483d4e4fe6db93315f1b4e6591f65fcbee30b666eb22db534d44c585cd341dfe3699eebacdf9a8bfdffe082c7c24598f306900fe75e82a250a5

data/README.md

@@ -0,0 +1,67 @@
+# Cointools
+
+This is a collection of Ruby scripts and library classes that let you check cryptocurrency prices on various services (currently Cryptowatch).
+
+## Installation
+
+To use the scripts from the command line, install the gem:
+
+```
+gem install cointools
+```
+
+To use the code as a library, add it to your Gemfile:
+
+```ruby
+gem 'cointools'
+```
+
+## Usage
+
+### [Cryptowatch](https://cryptowat.ch)
+
+To check past price of a given coin on a chosen exchange, pass the exchange and market name and a properly formatted timestamp:
+
+```
+cryptowatch bitfinex btcusd "2017-12-17 13:00"
+```
+
+To check the current price, skip the timestamp:
+
+```
+cryptowatch bitfinex btcusd
+```
+
+You can fetch a list of available exchanges and markets using these commands:
+
+```
+cryptowatch --list-exchanges
+cryptowatch --list-markets bithumb
+```
+
+In code:
+
+```ruby
+require 'cointools'
+cryptowatch = CoinTools::Cryptowatch.new
+
+exchange = cryptowatch.exchanges.first
+
+list = cryptowatch.get_markets(exchange)
+market = list.select { |x| x =~ /ltc/ && x !~ /btc/ }.first.upcase
+
+result = cryptowatch.get_price(exchange, market, Time.now - 86400)
+puts "#{market} yesterday: #{result.price}"
+
+result = cryptowatch.get_current_price(exchange, market)
+puts "#{market} today: #{result.price}"
+```
+
+The result object contains the requested price and (for historical prices) the actual timestamp of the found price, which might slightly differ from the timestamp passed in the argument (the earlier the date, the less precise the result).
+
+
+## Credits & contributing
+
+Copyright © 2018 [Kuba Suder](https://mackuba.eu). Licensed under [Very Simple Public License](https://github.com/mackuba/cointools/blob/master/VSPL-LICENSE.txt), my custom license that's basically a simplified version of the MIT license that fits in 3 lines.
+
+If you'd like to help me extend the scripts with some additional features or add support for new services, [send me a pull request](https://github.com/mackuba/cointools/pulls).

data/VSPL-LICENSE.txt

@@ -0,0 +1,5 @@
+Copyright (c) 2018 Kuba Suder
+
+You can modify, distribute and use this software for any purpose without any
+restrictions as long as you keep this copyright notice intact. The software is
+provided without any warranty.

data/bin/cryptowatch

@@ -0,0 +1,65 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'cointools'
+
+require 'optparse'
+require 'time'
+
+verbose = false
+
+OptionParser.new do |opts|
+  opts.on('-v', '--verbose') { verbose = true }
+
+  opts.on('--list-exchanges') do
+    puts CoinTools::Cryptowatch.new.exchanges
+    exit 0
+  end
+
+  opts.on('--list-markets EXCHANGE') do |exchange|
+    begin
+      puts CoinTools::Cryptowatch.new.get_markets(exchange)
+      exit 0
+    rescue CoinTools::Cryptowatch::BadRequestException => e
+      $stderr.puts "Error: Incorrect exchange name: #{e}"
+      exit 3
+    end
+  end
+
+  opts.parse!
+end
+
+if ARGV.length < 2 || ARGV.length > 3
+  puts "Usage: #{$PROGRAM_NAME} <exchange> <market> [<date>] [-v/--verbose]"
+  puts " e.g.: #{$PROGRAM_NAME} gdax btcusd \"2017-06-30 15:27\""
+  puts
+  puts "* To print a list of available exchanges:"
+  puts "       #{$PROGRAM_NAME} --list-exchanges"
+  puts "* To print a list of available markets on an exchange:"
+  puts "       #{$PROGRAM_NAME} --list-markets kraken"
+  exit 1
+end
+
+exchange = ARGV[0].downcase
+market = ARGV[1].downcase
+date = Time.parse(ARGV[2]) if ARGV[2]
+
+begin
+  result = CoinTools::Cryptowatch.new.get_price(exchange, market, date)
+
+  if verbose
+    puts "#{exchange}:#{market} @ #{result.time || Time.now} ==> #{result.price}"
+    puts
+  else
+    puts result.price
+  end
+rescue CoinTools::Cryptowatch::InvalidDateException => e
+  $stderr.puts "Error: #{e}"
+  exit 2
+rescue CoinTools::Cryptowatch::BadRequestException => e
+  $stderr.puts "Error: Incorrect exchange or market name: #{e}"
+  exit 3
+rescue CoinTools::Cryptowatch::NoDataException => e
+  $stderr.puts "Error: #{e}: data not ready yet"
+  exit 4
+end

data/lib/cointools/cryptowatch.rb

@@ -0,0 +1,151 @@
+require_relative 'version'
+
+require 'json'
+require 'net/http'
+require 'uri'
+
+module CoinTools
+  class Cryptowatch
+    BASE_URL = "https://api.cryptowat.ch"
+    USER_AGENT = "cointools/#{CoinTools::VERSION}"
+
+    DataPoint = Struct.new(:price, :time)
+
+    class InvalidResponseException < StandardError
+      attr_reader :response
+
+      def initialize(response)
+        super("#{response.code} #{response.message}")
+        @response = response
+      end
+    end
+
+    class BadRequestException < InvalidResponseException
+    end
+
+    class NoDataException < StandardError
+    end
+
+    class InvalidDateException < StandardError
+    end
+
+    def exchanges
+      @exchanges ||= get_exchanges
+    end
+
+    def get_markets(exchange)
+      url = URI("#{BASE_URL}/markets/#{exchange}")
+
+      response = make_request(url)
+
+      case response
+      when Net::HTTPSuccess
+        json = JSON.load(response.body)
+        return json['result'].select { |m| m['active'] == true }.map { |m| m['pair'] }.sort
+      when Net::HTTPBadRequest
+        raise BadRequestException.new(response)
+      else
+        raise Exception.new(response)
+      end
+    end
+
+    def get_price(exchange, market, time = nil)
+      return get_current_price(exchange, market) if time.nil?
+
+      (time <= Time.now) or raise InvalidDateException.new('Future date was passed')
+      (time.year >= 2009) or raise InvalidDateException.new('Too early date was passed')
+
+      unixtime = time.to_i
+      current_time = Time.now.to_i
+      url = URI("#{BASE_URL}/markets/#{exchange}/#{market}/ohlc?after=#{unixtime}")
+
+      response = make_request(url)
+
+      case response
+      when Net::HTTPSuccess
+        json = JSON.load(response.body)
+        data = json['result']
+
+        timestamp, o, h, l, c, volume = best_matching_record(data, unixtime, current_time)
+        raise NoDataException.new('No data found for a given time') if timestamp.nil?
+
+        actual_time = Time.at(timestamp)
+        return DataPoint.new(o, actual_time)
+      when Net::HTTPBadRequest
+        raise BadRequestException.new(response)
+      else
+        raise Exception.new(response)
+      end
+    end
+
+    def get_current_price(exchange, market)
+      url = URI("#{BASE_URL}/markets/#{exchange}/#{market}/price")
+
+      response = make_request(url)
+
+      case response
+      when Net::HTTPSuccess
+        json = JSON.load(response.body)
+        price = json['result']['price']
+
+        return DataPoint.new(price, nil)
+      when Net::HTTPBadRequest
+        raise BadRequestException.new(response)
+      else
+        raise Exception.new(response)
+      end
+    end
+
+
+    private
+
+    def make_request(url)
+      Net::HTTP.start(url.host, url.port, use_ssl: true) do |http|
+        request = Net::HTTP::Get.new(url)
+        request['User-Agent'] = USER_AGENT
+
+        http.request(request)
+      end
+    end
+
+    def best_matching_record(data, unixtime, request_time)
+      candidates = []
+
+      data.keys.sort_by { |k| k.to_i }.each do |k|
+        records = data[k]
+        previous = nil
+
+        records.each do |record|
+          timestamp, o, h, l, c, volume = record
+
+          if timestamp >= unixtime
+            candidates.push(record) unless timestamp > request_time
+            break
+          else
+            previous = record
+          end
+        end
+
+        candidates.push(previous) if previous
+      end
+
+      candidates.sort_by { |record| (record[0] - unixtime).abs }.first
+    end
+
+    def get_exchanges
+      url = URI("#{BASE_URL}/exchanges")
+
+      response = make_request(url)
+
+      case response
+      when Net::HTTPSuccess
+        json = JSON.load(response.body)
+        return json['result'].select { |e| e['active'] == true }.map { |e| e['symbol'] }.sort
+      when Net::HTTPBadRequest
+        raise BadRequestException.new(response)
+      else
+        raise Exception.new(response)
+      end
+    end
+  end
+end

data/lib/cointools/version.rb

@@ -0,0 +1,3 @@
+module CoinTools
+  VERSION = "0.1.1"
+end

data/lib/cointools.rb

@@ -0,0 +1,5 @@
+require 'cointools/cryptowatch'
+require 'cointools/version'
+
+module CoinTools
+end

metadata

@@ -0,0 +1,51 @@
+--- !ruby/object:Gem::Specification
+name: cointools
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Kuba Suder
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-01-24 00:00:00.000000000 Z
+dependencies: []
+description: 
+email:
+- jakub.suder@gmail.com
+executables:
+- cryptowatch
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- VSPL-LICENSE.txt
+- bin/cryptowatch
+- lib/cointools.rb
+- lib/cointools/cryptowatch.rb
+- lib/cointools/version.rb
+homepage: https://github.com/mackuba/cointools
+licenses:
+- Nonstandard
+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: A collection of scripts for checking cryptocurrency prices.
+test_files: []