coinpare 0.0.0 → 0.1.0

data/README.md

@@ -1,28 +1,258 @@
-# Coinpare
+<div align="center">
+  <img width="207" src="https://cdn.rawgit.com/piotrmurach/coinpare/master/assets/coinpare_logo_stacked.png" alt="coinpare logo" />
+</div>
+<br/>
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/coinpare`. To experiment with that code, run `bin/console` for an interactive prompt.
+# Coinpare [![Gitter](https://badges.gitter.im/Join%20Chat.svg)][gitter]
 
-TODO: Delete this and the text above, and describe your gem
+[![Gem Version](https://badge.fury.io/rb/coinpare.svg)][gem]
+[![Build Status](https://secure.travis-ci.org/piotrmurach/coinpare.svg?branch=master)][travis]
+[![Maintainability](https://api.codeclimate.com/v1/badges/1072406ba7e951e355e4/maintainability)][codeclimate]
+[![Test Coverage](https://api.codeclimate.com/v1/badges/1072406ba7e951e355e4/test_coverage)][coverage]
+[![Inline docs](http://inch-ci.org/github/piotrmurach/coinpare.svg?branch=master)][inchpages]
+
+[gitter]: https://gitter.im/piotrmurach/coinpare
+[gem]: http://badge.fury.io/rb/coinpare
+[travis]: http://travis-ci.org/piotrmurach/coinpare
+[codeclimate]: https://codeclimate.com/github/piotrmurach/coinpare/maintainability
+[coverage]: https://codeclimate.com/github/piotrmurach/coinpare/test_coverage
+[inchpages]: http://inch-ci.org/github/piotrmurach/coinpare
+
+> Compare cryptocurrency trading data across multiple exchanges and blockchains in the comfort of your terminal
+
+A screenshot is worth a thousand words:
+
+![CoinsView](https://github.com/piotrmurach/coinpare/raw/master/assets/coinpare_coins.png)
 
 ## Installation
 
-Add this line to your application's Gemfile:
+This project uses Ruby, before installing the `coinpare` tool, you'll need to ensure Ruby is installed on your machine.
+
+In your terminal execute `ruby` command with `-v` option:
+
+```
+$ ruby -v
+```
+
+If you have version of Ruby greater than `2.0.0` then you're good to go.
+
+Otherwise, please follow [Installing Ruby](https://www.ruby-lang.org/en/documentation/installation/#apt) to pick best installation method for your operating system.
+
+Once Ruby is installed, install the `coinpare` gem:
 
-```ruby
-gem 'coinpare'
+```
+$ gem install coinpare
 ```
 
-And then execute:
+And then execute `coinpare` to see all available options:
 
-    $ bundle
+```
+$ coinpare
+```
 
-Or install it yourself as:
+## Features
 
-    $ gem install coinpare
+* Compare chosen or top coins trading info(price, vol, open, high, low etc)
+* Compare top markets by a trading coin pair
+* Create your custom portfolio and track your holdings
+* Auto refresh cryptocurrencies info with a configurable time interval
 
 ## Usage
 
-TODO: Write usage instructions here
+To use all available commands, run the folling in your terminal:
+
+```bash
+$ coinpare
+```
+
+You will be presented with the following interface:
+
+![Interface](https://github.com/piotrmurach/coinpare/raw/master/assets/coinpare_interface.png)
+
+## View coins
+
+You can see top 10 trading info (price, volume, open, high, low etc) of any cyptocurrency in any other currency by executing the following in your terminal:
+
+```bash
+$ coinpare coins
+```
+
+By default, `USD` is used as the base currency price conversion. You can change this by passing `--base` or `-b` flag:
+
+```bash
+$ coinpare coins --base BTC
+```
+
+If you wish to see more currencies use `--top` flag:
+
+```bash
+$ coinpare coins --top 30
+```
+
+Alternatively, you can specify exactly the coins you're interested in by naming them separated by space:
+
+```bash
+$ coinpare coins ETH BCH LTC --base btc
+```
+
+You can also change the default exchange `CCCAGG` using the `--exchange` or `-e` flag:
+
+```bash
+$ coinpare coins BTC ETH --exchange coinbase
+```
+
+See [view markets](#view-markets) for more information on available exchanges.
+
+Finally, if you want to auto refresh data use `--watch` or `-w` flag:
+
+```bash
+$ coinpare coins --watch
+$ coinpare coins -w
+```
+
+You can watch for changes on your preferred cryptocurrencies:
+
+```bash
+$ coinpare coins BTC ETH LTC ZEC --watch
+```
+
+By default 5 seconds interval is used which you can change by providing a new value after `--watch` flag:
+
+```bash
+$ coinpare coins --watch 20   # every 20 seconds
+```
+
+To finish watching for changes hold down `Ctrl+C` key combination.
+
+## View markets
+
+You can get top markets by volume for any currency pair. By default 10 top exchanges for the BTC and USD pair by their total volume across all markets in the last 24 hours are displayed.
+
+```bash
+$ coinpare markets
+```
+
+is equivalent to:
+
+```bash
+$ coinpare markets BTC --base USD
+```
+
+An example output:
+
+![MarketsView](https://github.com/piotrmurach/coinpare/raw/master/assets/coinpare_markets.png)
+
+To change the pair do:
+
+```bash
+$ coinpare markets ETH -b BTC
+```
+
+You can specify the number of displayed exchanges with `--top` or `-t` flag:
+
+```bash
+$ coinpare markets --top 30
+```
+
+To watch for changes use the `--watch` or `-w` flag:
+
+```bash
+$ coinpare markets --watch
+$ coinpare markets -w
+```
+
+To finish watching for changes hold down `Ctrl+C` key combination.
+
+## Create portfolio
+
+There is an easy way for you to keep track of all your investments using the `holdings` command.
+When run for the first time, you will be presented with a prompt that will guide you through the portfolio setup and allow you to add as many holdings as you wish.
+
+```bash
+$ coinpare holdings
+```
+
+The prompt may look:
+
+![CreateHoldings](https://github.com/piotrmurach/coinpare/raw/master/assets/coinpare_create_holdings.png)
+
+All your holdings information will be persisted in your user home directory in a file called `coinpare.toml`. You can edit this file directly using your configured editor by passing the `--edit` flag:
+
+```bash
+$ coinpare holdings --edit
+```
+
+An example configuration file may look:
+
+```
+[[holdings]]
+amount = 1.0
+name = "BTC"
+price = 9000.0
+
+[[holdings]]
+amount = 5.0
+name = "LTC"
+price = 100.0
+
+[[holdings]]
+amount = 2.3
+name = "BTC"
+price = 5000.0
+
+[[holdings]]
+amount = 1000.0
+name = "TRX"
+price = 2.0
+
+[settings]
+base = "USD"
+color = true
+exchange = "CCCAGG"
+```
+
+Once configured, any subsequent execution of `holdings` command will display current prices and totals. For example, the beforementioned configuration file may produce the following result:
+
+![ViewHoldings](https://github.com/piotrmurach/coinpare/raw/master/assets/coinpare_holdings.png)
+
+Similar to other commands, if you want to auto refresh data use `--watch` or `-w` flag:
+
+```bash
+$ coinpare holdings --watch
+$ coinpare holdings -w
+```
+
+To finish watching for changes hold down `Ctrl+C` key combination.
+
+### Add/remove coins
+
+**Coinpare** allows you to easily add and remove individual coins to and from your holdings portfolio.
+
+To add a coin to your current portfolio use `--add` flag
+
+```bash
+$ coinpare holdings --add
+```
+
+For example, the following screenshot shows adding an `ETH` coin:
+
+![AddHoldings](https://github.com/piotrmurach/coinpare/raw/master/assets/coinpare_holdings_add.png)
+
+To remove one or more coins from your current portfolio use `--remove` flag:
+
+```bash
+$ coinpare holdings --remove
+```
+
+You will be presented with a multi select menu that contains all current holdings similar to the one below:
+
+![RemoveHoldings](https://github.com/piotrmurach/coinpare/raw/master/assets/coinpare_holdings_remove.png)
+
+Finally, if you wish to clear all your holdings and start again use `--clear` flag:
+
+```bash
+$ coinpare holdings --clear
+```
 
 ## Development
 
@@ -32,12 +262,16 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/coinpare. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/piotrmurach/coinpare. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## Code of Conduct
 
-## License
+Everyone interacting in the Coinpare project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/piotrmurach/coinpare/blob/master/CODE_OF_CONDUCT.md).
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+## Credits
 
-## Code of Conduct
+All the data is obtained from [CryptoCompare](https://www.cryptocompare.com/api).
+
+## Copyright
 
-Everyone interacting in the Coinpare project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/coinpare/blob/master/CODE_OF_CONDUCT.md).
+Copyright (c) 2018 Piotr Murach. See [GNU Affero General Public License v3.0](LICENSE.txt) for further details.

data/Rakefile

@@ -3,4 +3,7 @@ require "rspec/core/rake_task"
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+desc 'Run all specs'
+task ci: %w[ spec ]
+
+task default: :spec

data/coinpare.gemspec

@@ -1,26 +1,42 @@
-
 lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "coinpare/version"
 
 Gem::Specification.new do |spec|
   spec.name          = "coinpare"
+  spec.license       = "AGPL-3.0"
   spec.version       = Coinpare::VERSION
   spec.authors       = ["Piotr Murach"]
-  spec.email         = []
+  spec.email         = [""]
 
-  spec.summary       = %q{Write a short summary, because RubyGems requires one.}
-  spec.description   = %q{Write a longer description or delete this line.}
-  spec.license       = "MIT"
+  spec.summary       = %q{Compare cryptocurrency trading data across multiple exchanges and blockchains.}
+  spec.description   = %q{Compare cryptocurrency trading data across multiple exchanges and blockchains.}
+  spec.homepage      = "https://github.com/piotrmurach/coinpare"
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
-    f.match(%r{^(test|spec|features)/})
+    f.match(%r{^(test|spec|features|assets)/})
   end
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.add_dependency "tty-color", "~> 0.4.2"
+  spec.add_dependency "tty-config", "~> 0.2.0"
+  spec.add_dependency "tty-cursor", "~> 0.5.0"
+  spec.add_dependency "tty-editor", "~> 0.4.0"
+  spec.add_dependency "tty-font", "~> 0.2.0"
+  spec.add_dependency "tty-pager", "~> 0.11.0"
+  spec.add_dependency "tty-prompt", "~> 0.16.1"
+  spec.add_dependency "tty-spinner", "~> 0.8.0"
+  spec.add_dependency "tty-table", "~> 0.10.0"
+  spec.add_dependency "pastel", "~> 0.7.2"
+  spec.add_dependency "thor", "~> 0.20.0"
+  spec.add_dependency "toml", "~> 0.2.0"
+  spec.add_dependency "timers", "~> 4.1.2"
+
   spec.add_development_dependency "bundler", "~> 1.16"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "webmock", "~> 3.3"
+  spec.add_development_dependency "timecop", "~> 0.9.1"
 end

data/exe/coinpare

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+lib_path = File.expand_path('../lib', __dir__)
+$:.unshift(lib_path) if !$:.include?(lib_path)
+require 'coinpare/cli'
+
+Signal.trap('INT') do
+  warn("\n#{caller.join("\n")}: interrupted")
+  exit(1)
+end
+
+begin
+  Coinpare::CLI.start
+rescue Coinpare::CLI::Error => err
+  puts "ERROR: #{err.message}"
+  exit 1
+end

data/lib/coinpare.rb

@@ -1,5 +1,4 @@
 require "coinpare/version"
 
 module Coinpare
-  # Your code goes here...
 end

data/lib/coinpare/cli.rb

@@ -0,0 +1,148 @@
+# frozen_string_literal: true
+
+require 'thor'
+require 'pastel'
+require 'tty-font'
+
+module Coinpare
+  # Handle the application command line parsing
+  # and the dispatch to various command objects
+  #
+  # @api public
+  class CLI < Thor
+    # Error raised by this runner
+    Error = Class.new(StandardError)
+
+    def help(*args)
+      font =  TTY::Font.new(:standard)
+      pastel = Pastel.new(enabled: !options['no-color'])
+      puts pastel.yellow(font.write("Coinpare"))
+      super
+    end
+
+    class_option :"no-color", type: :boolean, default: false,
+                              desc: 'Disable colorization in output'
+
+    desc 'coins NAMES...', 'Get all the current trading data for the coin names...'
+    long_desc <<-DESC
+      Get all the current trading info (price, vol, open, high, low etc)
+      of any list of cryptocurrencies in any other currency that you need.
+
+      By default 10 top coins by their total volume across all markets in
+      the last 24 hours.
+
+      Example:
+
+      > $ coinpare coins BTC ETH --base USD
+
+      Example:
+
+      > $ coinpare coins BTC ETH --exchange coinbase
+    DESC
+    method_option :base, aliases: '-b', type: :string, default: "USD",
+                         desc: 'The currency symbol to convert into',
+                         banner: 'CURRENCY'
+    method_option :columns, aliases: '-c', type: :array,
+                            desc: 'Specify columns to display',
+                            banner: '0 1 2'
+    method_option :exchange, aliases: '-e', type: :string, default: "CCCAGG",
+                             desc: 'Name of exchange',
+                             banner: 'name'
+    method_option :help, aliases: '-h', type: :boolean,
+                         desc: 'Display usage information'
+    method_option :top, aliases: '-t', type: :numeric, default: 10, banner: 'N',
+                        desc: "The number of top coins by total volume accross all markets in 24 hours"
+    method_option :watch, aliases: '-w', banner: 'N',
+                          desc: 'Automatically refresh data every n seconds, default 5 sec'
+    def coins(*names)
+      if options[:help]
+        invoke :help, ['coins']
+      else
+        require_relative 'commands/coins'
+        Coinpare::Commands::Coins.new(names, options).execute
+      end
+    end
+
+    desc 'holdings', 'Keep track of all your cryptocurrency investments'
+    long_desc <<-DESC
+      Get the current trading prices and their change in value and percentage
+      for all your cryptocurrency investments.
+
+      Example:
+
+      > $ coinpare holdings
+
+      Example
+
+      > $ coinpare holdings --exchange coinbase --base USD
+    DESC
+    method_option :add, type: :boolean,
+                  desc: "Add a new coin without altering any existhing holdings"
+    method_option :base, aliases: '-b', type: :string,
+                         desc: 'The currency symbol to convert into',
+                         banner: 'CURRENCY'
+    method_option :clear, type: :boolean, default: false,
+                          desc: 'Remove all coins from your existing holdings'
+    method_option :edit, type: :string, banner: 'editor',
+                         desc: 'Open the holdings configuration file for editing in EDITOR, or the default editor if not specified.'
+    method_option :exchange, aliases: '-e', type: :string,
+                             desc: 'Name of exchange', banner: 'NAME'
+    method_option :help, aliases: '-h', type: :boolean,
+                         desc: 'Display usage information'
+    method_option :remove, type: :boolean,
+                  desc: "Remove the given coin(s) from holdings"
+    method_option :watch, aliases: '-w', banner: 'N',
+                          desc: 'Automatically refresh data every n seconds, default 5 sec'
+    def holdings(*)
+      if options[:help]
+        invoke :help, ['holdings']
+      else
+        require_relative 'commands/holdings'
+        Coinpare::Commands::Holdings.new(options).execute
+      end
+    end
+
+    desc 'markets [NAME]', 'Get top markets by volume for a currency pair'
+    long_desc <<-DESC
+      Get top markets by volume for a currency pair.
+
+      By default 10 top markets by their total volume across all markets in
+      the last 24 hours.
+
+      Example:
+
+      > $ coinpare markets BTC --base USD
+
+      Example:
+
+      > $ coinpare markets ETH -b BTC
+    DESC
+    method_option :base, aliases: '-b', type: :string, default: "USD",
+                         desc: 'The currency symbol to convert into',
+                         banner: 'CURRENCY'
+    method_option :columns, aliases: '-c', type: :array,
+                            desc: 'Specify columns to display',
+                            banner: '0 1 2'
+    method_option :help, aliases: '-h', type: :boolean,
+                         desc: 'Display usage information'
+    method_option :top, aliases: '-t', type: :numeric, default: 10,
+                        desc: "The number of top exchanges by total volume in 24 hours"
+    method_option :watch, aliases: '-w', banner: 'N',
+                          desc: 'Automatically refresh data every n seconds, default 5 sec'
+    def markets(name = 'BTC')
+      if options[:help]
+        invoke :help, ['markets']
+      else
+        require_relative 'commands/markets'
+        Coinpare::Commands::Markets.new(name, options).execute
+      end
+    end
+
+    desc 'version', 'coinpare version'
+    def version
+      require_relative 'version'
+      puts "v#{Coinpare::VERSION}"
+    end
+    map %w(--version -v) => :version
+  end
+end