crates 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4a5780e22b232f7b5a861327bf82afa1280f2cd8ca5d8a0092b65ba79f7152b0
+  data.tar.gz: 1b45f8cb9729d9f4a2a4ba61853c126d0a58d2b24db5b8b98d6862048e2f1d1c
+SHA512:
+  metadata.gz: '0408be7c32cdefe1555d1a58dad04744af227990810f5a081d9d0ea3f88bfe84056a0e5d972320884e68be869dcef3df57b521b69a26bf0c30d7d20596474447'
+  data.tar.gz: 497f810951e51ea9cd169f1ee7e0da0e5f2c44965da74a20e32aea29af78fc6ea15ad45511f8defcfff2fef0b579b3632e27a3b703b043cb68bf86fd55cdc213

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 decentralizuj
+
+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,174 @@
+# Introduction
+Fast and easy way to get all data about all coins in any fiat value.
+Get data for analyze or use it to make a brand new crypto app.
+After scrapping prices in CSV file, and printing colorized output,
+you can access each rate with `#price(coin)`. No configuration, just run.
+
+ - Collect prices of defined coins from _cryptocompare.com_
+ - Save data into object
+ - Save to CSV and print colorized output
+ - Print-only without saving
+ - Save-only without printing  
+
+# How to install
+
+Make sure you have ruby and git installed:
+
+```bash
+ # download repo and install dependencies like colorize and rest-client
+ git clone https://github.com/decentralizuj/crates.git
+ cd crates
+ bundle install
+```  
+
+# How to run
+
+If you want to edit default coins:
+
+```ruby
+ # open 'bin/crates' and edit line(5):
+ > (5): COINS = %w[ ... ].freeze
+```  
+
+Run from terminal:
+
+```ruby
+ # add fiat currencies as arguments
+ # also accept `--no-save` and `--no-print` as args
+
+ $ ruby bin/crates usd eur rsd
+ $ ruby bin/crates usd eur rsd --no-save
+ $ ruby bin/crates usd eur rsd --no-print
+```    
+
+# How to use
+
+Initialize new object with your own configuration. If you want to use defaults:
+
+```ruby
+ # you can edit this in 'bin/crates'
+
+ - #coins: [BTC, LTC, XMR, ETH, BCH, ZEC]
+ - #save:  true  
+ - #print: true 
+```  
+
+Otherwise, #new accept 'currency' as argument, and an 'options hash':  
+
+```ruby
+ - first parameter is currency, defauilt is 'EUR'
+ - other accepted options are:  
+     print: boolean
+     save:  boolean
+     coins: array
+```  
+
+Example:
+
+```ruby
+ # configure default values
+
+ COINS = %w[ BTC XMR LTC ETH ZEC ].freeze
+ PRINT = true
+ SAVE  = true
+
+ # create new object
+
+ @rates = C::Rates.new( :eur, coins: COINS, print: PRINT, save: SAVE )
+
+ # make single request
+
+ @rates.get
+ 
+ # C::Rates#get accept same args as #new, but do not change default values
+
+ CURRENCIES = %w[ USD EUR RSD ].freeze
+
+ CURRENCIES.each do |currency|
+   @rates.get currency
+  end
+```  
+
+This will print/save data as configured, while making prices easily
+accessible with Rates#price(:symbol).
+
+```ruby
+ # Getter method with all coins and values 
+
+ @rates.prices
+ # => { "BTC"=>48867.67, "XMR"=>200.31, "LTC"=>164.37 }
+ # => Accessible with @rates['BTC']
+
+
+ # Get price for each coin
+ # C::Rates#price(:coin)
+
+ @rates.price(:btc)      # accept symbol
+ # => 48867.67
+
+ @rates.price('xmr')     # or string
+ # => 200.31
+```  
+
+C::Rates has two setter methods:
+
+```ruby
+ @rates.currency = 'EUR'
+
+ @rates.coins = %w[BTC XMR LTC]
+```  
+
+Other available objects are:
+
+```ruby
+ # After new object is initialized, you can use:
+
+ @rates.currency
+ # => "EUR"
+
+ @rates.coins
+ # => "BTC, XMR, LTC"
+
+ @rates.save?
+ # => save output -> (true/false)
+
+ @rates.print?
+ # => print output -> (true/false)
+
+ @rates.count
+ # => 0 -> (number of fail requests)
+
+ # After you call Rates#get:
+
+ @rates.url
+ # => constructed URL
+
+ @rates.reponse
+ # => response from RestClient.get (accept #code, #headers, #body)
+
+ @rates.data
+ # => JSON parsed object will all data about all coins
+
+ @rates.table
+ # => path to saved CSV file
+ # => file is named CURRENCY_rates.csv (eur_rates.csv)
+```  
+
+# TO-DO
+
+This gem is start of app that I am working on to help me with auto-trades.
+At the moment I use it to notify me when price change more then 2% from last trade.
+Then I perform crypto-to-crypto trade, and wait for price to change again.
+To make it reliable and worth of using, plan is to add next functions:
+
+ - add more sources to get data from them
+ - scrap more data into tables (only data I need)
+ - add support for API-KEYS
+ - rotate sources if requests are sent too often
+ - add support for proxy and headers rotation
+ - create charts from prices at given time (each 10min etc)
+ - create GIF animation from charts per time (each 30 min etc)
+
+# PREVIEW
+
+![GIF](docs/crates.gif)

data/bin/crates

@@ -0,0 +1,32 @@
+#!/usr/bin/env ruby
+
+require_relative '../lib/crates.rb'
+
+  COINS = %w[ BTC LTC XMR ETH BCH ZEC ].freeze
+
+  BANNER = [
+    "\n Run C::Rates with fiat currencies as arguments:".cyan,
+    "  $ ruby bin/crates usd eur rsd".light_green,
+    "     --no-print".light_green,
+    "     --no-save".light_green,
+    " To edit default coins, open 'bin/crates'\n".cyan
+  ]
+
+  if ARGV.include?('-h') or ARGV.include?('--help')
+    puts BANNER
+    exit 1
+  else
+    ARGV.include?('--no-save') ? ns = false : ns = true
+    ARGV.include?('--no-print') ? np = false : np = true
+    @rates = C::Rates.new(:eur, save: ns, print: np, coins: COINS)
+  end
+  
+  unless ARGV.empty?
+    ARGV.each do |fiat|
+      next if %w[--no-print --no-save].include?(fiat.to_s.downcase)
+      @rates.get fiat
+    end
+  else
+    @rates.get :eur, save: false
+  end
+

data/crates.gemspec

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+Gem::Specification.new do |s|
+  s.name        = 'crates'
+  s.version     = '0.1.0'
+  s.summary     = 'Print and Save Cryptocurrency Rates'
+  s.description = <<~DESC
+    Collect cryptocurrency prices for any fiat currency.
+    Print colorized output (or not), save as CSV (or not).
+    Lightweight, fast, simple and easily extendible. 
+  DESC
+  s.authors = ['decentralizuj']
+  s.files   = ['lib/crates.rb']
+  s.homepage = 'https://github.com/decentralizuj/crates'
+  s.license = 'MIT'
+
+  s.metadata['homepage_uri'] = 'https://github.com/decentralizuj/crates'
+  s.metadata['source_code_uri'] = 'https://github.com/decentralizuj/crates'
+  s.metadata['bug_tracker_uri'] = 'https://github.com/decentralizuj/crates/issues'
+
+  s.files = ['bin/crates', 'lib/crates.rb', 'LICENSE', 'README.md', 'crates.gemspec']
+  s.bindir = 'bin'
+  s.executables = ['crates']
+  s.require_paths = ['lib']
+
+  s.add_runtime_dependency 'rest-client', '~> 2.1.0'
+  s.add_runtime_dependency 'colorize', '~> 0.8.1'
+
+  s.add_development_dependency 'bundler', '~> 2.2.9'
+  s.add_development_dependency 'rake', '~> 13.0.3'
+end
+
+

data/lib/crates.rb

@@ -0,0 +1,101 @@
+require 'json'
+require 'csv'
+require 'colorize'
+require 'rest-client'
+
+module C
+  
+  # set default coins
+  COINS = %w[ BTC XMR LTC ETH BCH ZEC ].freeze
+  # max number of retries
+  MAX_RETRY = 3
+  # api base-url
+  URL = 'https://min-api.cryptocompare.com/data/pricemultifull?'.freeze
+
+  class Rates
+
+    attr_reader   :response, :data, :url, :table, :count, :prices
+    attr_accessor :currency, :coins
+
+    def self.get!( currency = :eur, opts = {} )
+      @rates = Rates.new currency, opts
+      @rates.get
+    end
+
+    def initialize( currency = :eur, opts = {} )
+      @save  = opts[:save ].nil? ? true : opts[:save]
+      @print = opts[:print].nil? ? true : opts[:print]
+      @coins = opts[:coins].nil? ? COINS : Array(opts[:coins])
+      @currency = currency.to_s.upcase
+    end
+
+    def get( currency = nil, opts = {} )
+      @save  = opts[:save]  unless opts[:save].nil?
+      @print = opts[:print] unless opts[:print].nil?
+      opts[:coins] ||= @coins
+      currency     ||= @currency
+      @table = currency.to_s.downcase  + '_rates.csv'
+      @count = 0
+      execute_request(opts[:coins], currency)
+    end
+
+    def price( coin )
+      @prices[coin.to_s.upcase]
+    end
+
+    def save?
+      @save == true
+    end
+
+    def print?
+      @print == true
+    end
+
+    private
+
+    def execute_request( coins = @coins, currency = @currency )
+      @prices, @data_array, coin_uri = {}, [], ''
+      coins.collect { |coin| coin_uri << "fsyms=#{coin}&" }
+      @url = URL + "#{coin_uri}tsyms=#{currency}"
+      @response = RestClient.get @url
+      @data = JSON.parse @response
+      @data_array << Time.now.to_s
+      coins.each do |coin|
+        @data_array << value = @data["RAW"][coin.to_s.upcase][currency.to_s.upcase]["PRICE"].round(2)
+        @prices[coin] = value
+      end
+      print_data_for(currency) if print?
+      save_data(coins) if save?
+     rescue
+      @count += 1
+      if @count >= MAX_RETRY
+        puts @response.to_s.split(',')
+        exit 1
+      else
+        execute_request(coins, currency)
+      end
+    end
+
+    def print_data_for( currency )
+      30.times { print '='.green } and puts
+      puts "[".green + currency.to_s.upcase.yellow.bold + "]".green + " conversion rate"
+      30.times { print '='.green } and puts
+      @prices.each do |name, value|
+        print "[".yellow.bold + "#{name}".green.bold + "]".yellow.bold
+        puts ": #{value}".bold
+      end
+    end
+  
+    def save_data( coins = nil )
+      coins ||= @coins
+      create_csv_headers(coins) unless File.exist?(@table)
+      CSV.open(@table, 'ab') { |column| column << @data_array }
+    end
+
+    def create_csv_headers( coins = [] )
+      header_array = ['TIME']
+      coins.each { |coin| header_array << coin }
+      CSV.open(@table, "w" ) { |header| header << header_array }
+    end
+  end
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: crates
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- decentralizuj
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-03-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.9
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.9
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 13.0.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 13.0.3
+description: "Collect cryptocurrency prices for any fiat currency.\nPrint colorized
+  output (or not), save as CSV (or not).\nLightweight, fast, simple and easily extendible.
+  \n"
+email: 
+executables:
+- crates
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- bin/crates
+- crates.gemspec
+- lib/crates.rb
+homepage: https://github.com/decentralizuj/crates
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/decentralizuj/crates
+  source_code_uri: https://github.com/decentralizuj/crates
+  bug_tracker_uri: https://github.com/decentralizuj/crates/issues
+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: []
+rubygems_version: 3.2.3
+signing_key: 
+specification_version: 4
+summary: Print and Save Cryptocurrency Rates
+test_files: []