bittrader-bot 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5dde23b9eebb480b78a4a0da149fb8e7eab17381
+  data.tar.gz: a2d4471efbdde6f902d528a55d48d04283bc9290
+SHA512:
+  metadata.gz: 15413052b5db609311955af51b0965b740b91bfcf31b089826f93f5fc5ea304f0a211e0d44e90be2be4e56c17b6b1bcce522b7de1e05fb2a33bf2549f8318ee7
+  data.tar.gz: 9dc2d788b9b7b7ec3acfb6bd1ecef0c9bfc27e3d3d97a89e19defa4b951e281b6c42bb411e5ecf73d1e1753d0fb694b585f999d00d2a8814738223cc239aab67

data/bin/bittrader-bot

@@ -0,0 +1,31 @@
+#!/usr/bin/env ruby'
+# Copyright 2017 Richard Davis
+#
+# This file is part of bittrader-bot.
+#
+# bittrader-bot is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# bittrader-bot is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with bittrader-bot.  If not, see <http://www.gnu.org/licenses/>.
+
+##
+# = /bin/bittrader-bot
+# Author::    Richard Davis
+# Copyright:: Copyright 2017 Richard Davis
+# License::   GNU Public License 3
+#
+# Project executable file.
+begin
+  require 'bittrader-bot'
+rescue LoadError
+  require 'rubygems'
+  require 'bittrader-bot'
+end

data/lib/bittrader-bot.rb

@@ -0,0 +1,126 @@
+# Copyright 2017 Richard Davis
+#
+# This file is part of bittrader-bot.
+#
+# bittrader-bot is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# bittrader-bot is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with bittrader-bot.  If not, see <http://www.gnu.org/licenses/>.
+
+##
+# = /lib/bittrader-bot.rb
+# Author::    Richard Davis
+# Copyright:: Copyright 2017 Richard Davis
+# License::   GNU Public License 3
+#
+# Main application file that loads other files.
+require 'bittrader-bot/bot_logic'
+require 'bittrader-bot/namespace'
+require 'bittrader-bot/coinmarketcap'
+require 'bittrader-bot/exchange_interface'
+require 'bittrader-bot/poloniex'
+
+require 'optparse'
+
+require 'telegram/bot'
+
+trap('INT') do
+  puts "\nTerminating..."
+  exit
+end
+
+options = {}
+
+optparse = OptionParser.new do |opts|
+  opts.banner = 'Usage: bittrader-bot [options]'
+
+  opts.on('-e', '--execute FILE', 'Launches the bot with the specified configuration file.') do |file|
+    options[:execute] = true
+    options[:file] = file
+  end
+
+  opts.on('-l', '--license', 'Displays the copyright notice') do
+    puts "This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+"
+  end
+
+  opts.on('-w', '--warranty', 'Displays the warranty statement') do
+    puts "This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+"
+  end
+
+  opts.on_tail('-h', '--help', 'Displays the help screen') do
+    puts opts
+    exit
+  end
+end
+
+optparse.parse!
+
+##
+# Launches bot with values read from config file
+def start_bot config
+  puts 'Loading configuration file...'
+  file = File.read(config)
+  config = JSON.parse file
+  @bot = BittraderBot::BotLogic.new(config.to_h)
+  puts 'Bittrader-Bot initialized.'
+end
+
+##
+# Queries CoinMarketCap's API for a coin's current value in BTC and USD
+def query_coin_price coin
+  data = BittraderBot::CoinMarketCap.ticker_by_currency(coin)
+  response = @bot.send_get_request(data[0], data[1])
+  response_json = JSON.parse(response.body)
+  coin_data = response_json[0].to_h
+  "The price of #{coin} is currently #{coin_data['price_btc']} BTC (#{coin_data['price_usd']} USD)"
+end
+
+def on regex, message, &block
+  regex =~ message.text
+
+  if $~
+    case block.arity
+    when 0
+      yield
+    when 1
+      yield $1
+    when 2
+      yield $1, $2
+    end
+  end
+end
+
+if options[:execute]
+  start_bot options[:file]
+  Telegram::Bot::Client.run(@bot.telegram_token) do |bot|
+    bot.listen do |message|
+      on (/^\/start/), message do
+        bot.api.send_message(chat_id: message.chat.id, text: "Hello, #{message.from.first_name}")
+      end
+
+      on (/^\/check (.+)/), message do |arg|
+        bot.api.send_message(chat_id: message.chat.id, text: "#{query_coin_price arg}")
+      end
+
+      on (/^\/stop/), message do
+        bot.api.send_message(chat_id: message.chat.id, text: "Bye, #{message.from.first_name}")
+      end
+    end
+  end
+end

data/lib/bittrader-bot/bot_logic.rb

@@ -0,0 +1,77 @@
+# Copyright 2017 Richard Davis
+#
+# This file is part of bittrader-bot.
+#
+# bittrader-bot is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# bittrader-bot is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with bittrader-bot.  If not, see <http://www.gnu.org/licenses/>.
+
+require 'uri'
+require 'net/http'
+require 'net/https'
+require 'json'
+
+##
+# = BotLogic
+# Author::    Richard Davis
+# Copyright:: Copyright 2017 Richard Davis
+# License::   GNU Public License 3
+#
+# Provides object for basic bot behavior over HTTP
+module BittraderBot
+  class BotLogic
+    attr_reader :exchange, :telegram_token, :key, :secret
+
+    ##
+    # Initializes a BotLogic object
+    def initialize config
+      @exchange = config['exchange']
+      @telegram_token = config['telegram_token']
+      @key = config['key']
+    end
+
+    ##
+    # Starts the connection to the server and provides identification
+    def start_connection host
+      uri = URI.parse(host)
+      https = Net::HTTP.new(uri.host, 443)
+      https.use_ssl = true
+      return https
+    end
+
+    ##
+    # Send GET request to exchange
+    def send_get_request host, request
+      https = start_connection host
+      req = Net::HTTP::Get.new(request)
+      https.request(req)
+    end
+
+    ##
+    # Sends POST request to exchange
+    def send_post_request data
+      request = Net::HTTP::Post.new(uri.path, initheader: {'Content-Type' =>'application/json'})
+      request['key'] = @key
+      request['sign'] = sign_post_data(data.to_json)
+      request.body = data.to_json
+      response = https.request(request)
+      puts "Response #{response.code} #{response.message}: #{response.body}"
+    end
+
+    ##
+    # Signs POST data using HMAC-SHA512 method
+    def sign_post_data data
+      digest = OpenSSL::Digest.new('sha512')
+      OpenSSL::HMAC.digest(digest, @secret, data)
+    end
+  end
+end

data/lib/bittrader-bot/coinmarketcap.rb

@@ -0,0 +1,41 @@
+# Copyright 2017 Richard Davis
+#
+# This file is part of bittrader-bot.
+#
+# bittrader-bot is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# bittrader-bot is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with bittrader-bot.  If not, see <http://www.gnu.org/licenses/>.
+
+module BittraderBot
+  ##
+  # = CoinMarketCap
+  # Author::    Richard Davis
+  # Copyright:: Copyright 2017 Richard Davis
+  # License::   GNU Public License 3
+  #
+  # Holds methods for interacting with CoinMarketCap
+  module CoinMarketCap
+    @host = 'https://api.coinmarketcap.com/'
+
+    ##
+    # Gets ticker information for a given currency
+    def self.ticker
+      return @host,'/v1/ticker/'
+    end
+
+    ##
+    # Gets ticker information for a given currency
+    def self.ticker_by_currency currency
+      return @host, "/v1/ticker/#{currency}/"
+    end
+  end
+end

data/lib/bittrader-bot/exchange_interface.rb

@@ -0,0 +1,32 @@
+# Copyright 2017 Richard Davis
+#
+# This file is part of bittrader-bot.
+#
+# bittrader-bot is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# bittrader-bot is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with bittrader-bot.  If not, see <http://www.gnu.org/licenses/>.
+
+module BittraderBot
+  ##
+  # = ExchangeInterface
+  # Author::    Richard Davis
+  # Copyright:: Copyright 2017 Richard Davis
+  # License::   GNU Public License 3
+  #
+  # Provides namespace for all exchange wrapper modules
+  module ExchangeInterface
+    def self.proc_request host, endpoint, params
+      params_str = params.map{|param, value| "#{param}=#{value}"}.join('&')
+      return host, "#{endpoint}?#{params_str}"
+    end
+  end
+end

data/lib/bittrader-bot/namespace.rb

@@ -0,0 +1,26 @@
+# Copyright 2017 Richard Davis
+#
+# This file is part of bittrader-bot.
+#
+# bittrader-bot is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# bittrader-bot is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with bittrader-bot.  If not, see <http://www.gnu.org/licenses/>.
+
+##
+# = BittraderBot
+# Author::    Richard Davis
+# Copyright:: Copyright 2017 Richard Davis
+# License::   GNU Public License 3
+#
+# Top-level namespace for BittraderBot modules and classes
+module BittraderBot
+end

data/lib/bittrader-bot/poloniex.rb

@@ -0,0 +1,177 @@
+# Copyright 2017 Richard Davis
+#
+# This file is part of bittrader-bot.
+#
+# bittrader-bot is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# bittrader-bot is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with bittrader-bot.  If not, see <http://www.gnu.org/licenses/>.
+
+module BittraderBot
+  module ExchangeInterface
+    ##
+    # = Poloniex
+    # Author::    Richard Davis
+    # Copyright:: Copyright 2017 Richard Davis
+    # License::   GNU Public License 3
+    #
+    # Holds methods for interacting with Poloniex Exchange
+    module Poloniex
+      @public_host = 'https://poloniex.com/'
+
+      ##
+      # Returns ticker information
+      def self.return_ticker
+        endpoint = 'public'
+        params = {
+          command: 'returnTicker'
+        }
+        return @public_host, endpoint, params
+      end
+
+      def self.return_24_volume
+      end
+
+      def self.return_order_book
+      end
+
+      def self.return_trade_history
+      end
+
+      def self.return_chart_data
+      end
+
+      def self.return_currencies
+      end
+
+      def self.return_loan_orders
+      end
+
+      def self.return_balances
+      end
+
+      def self.return_complete_balances
+      end
+
+      ##
+      # Not implemented
+      def self.return_deposit_addresses
+      end
+
+      ##
+      # Not implemented
+      def self.generate_new_address
+      end
+
+      ##
+      # Not implemented
+      def self.return_deposits_withdrawals
+      end
+
+      def self.return_open_orders
+      end
+
+      def self.return_trade_history
+      end
+
+      def self.order_trades
+      end
+
+      def self.buy
+      end
+
+      def self.sell
+      end
+
+      def self.cancel_order
+      end
+
+      ##
+      # Not implemented
+      def self.move_order
+      end
+
+      ##
+      # Not implemented
+      def self.withdraw
+      end
+
+      def self.return_fee_info
+      end
+
+      def self.return_available_account_balances
+      end
+
+      def self.return_tradable_balances
+      end
+
+      ##
+      # Not implemented
+      def self.transfer_balance
+      end
+
+      ##
+      # Not implemented
+      def self.return_margin_account_summary
+      end
+
+      ##
+      # Not implemented
+      def self.margin_buy
+      end
+
+      ##
+      # Not implemented
+      def self.margin_sell
+      end
+
+      ##
+      # Not implemented
+      def self.get_margin_position
+      end
+
+      ##
+      # Not implemented
+      def self.close_margin_position
+      end
+
+      ##
+      # Not implemented
+      def self.create_loan_offer
+      end
+
+      ##
+      # Not implemented
+      def self.cancel_loan_offer
+      end
+
+      ##
+      # Not implemented
+      def self.return_open_loan_offers
+      end
+
+      ##
+      # Not implemented
+      def self.return_active_loans
+      end
+
+      ##
+      # Not implemented
+      def self.return_lending_history
+      end
+
+      ##
+      # Not implemented
+      def self.toggle_auto_renew
+      end
+    end
+  end
+end

data/test/test_bot_logic.rb

@@ -0,0 +1,41 @@
+# Copyright 2017 Richard Davis
+#
+# This file is part of bittrader-bot.
+#
+# bittrader-bot is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# bittrader-bot is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with bittrader-bot.  If not, see <http://www.gnu.org/licenses/>.
+
+require 'minitest/autorun'
+require_relative '../lib/bittrader-bot/bot_logic'
+
+##
+# = BotLogicTest
+# Author::    Richard Davis
+# Copyright:: Copyright 2017 Richard Davis
+# License::   GNU Public License 3
+#
+# Tests for Bittrader::BotLogic class
+class BotLogicTest < Minitest::Test
+  ##
+  # Initializes test with sample data
+  def setup
+    config = { telegram_token: 'example_token' }
+    @bot = BittraderBot::BotLogic.new(config)
+  end
+
+  ##
+  # Tests that telegram_token gets properly initialized
+  def test_telegram_token
+    assert_equal('example_token', @bot.telegram_token)
+  end
+end

metadata

@@ -0,0 +1,54 @@
+--- !ruby/object:Gem::Specification
+name: bittrader-bot
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Richard Davis
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-12-25 00:00:00.000000000 Z
+dependencies: []
+description: "  A cryptocurrency trading bot that interfaces with a given cryptocurrency
+  trading exchange and sends notifications of trades via Telegram.\n"
+email: rvdavis@member.fsf.org
+executables:
+- bittrader-bot
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/bittrader-bot
+- lib/bittrader-bot.rb
+- lib/bittrader-bot/bot_logic.rb
+- lib/bittrader-bot/coinmarketcap.rb
+- lib/bittrader-bot/exchange_interface.rb
+- lib/bittrader-bot/namespace.rb
+- lib/bittrader-bot/poloniex.rb
+- test/test_bot_logic.rb
+homepage: https://github.com/d3d1rty/bittrader-bot
+licenses:
+- GPL-3.0
+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.6.11
+signing_key: 
+specification_version: 4
+summary: A cryptocurrency trading bot.
+test_files:
+- test/test_bot_logic.rb