ctfc 0.3.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6df1fb47102b8c5c62d4340a69adf54db78ee380e8d0b88cf2b3201ad2229acb
+  data.tar.gz: 6302f744ba17f497fbd35bff59e695443bd74eec481b357462f70b3d049531a7
+SHA512:
+  metadata.gz: 050abfa5bf9c9dd8b3444c1e89dca6af824b2cc4d2b215dd4e991058026e8b7dbf018231601d0b9d6e8f221eee5cffbd77f4b38dd53bdf8787f21cb9d2e0713a
+  data.tar.gz: 862f70090801ffedd6e9a01b06f1a341f2d771673b685868c87c683a542f09da7bb2cb03c039897b34b75bbb0638369ec42634c9e63a6c988baae5a9d4fb7341

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 alx3dev
+
+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,133 @@
+# About
+
+Convert any crypto to fiat currency, gather all data and/or save in `.csv` table.  
+For now only prices are printed/saved, while all data remain easily accessible from variable (for developers).  
+  
+  
+# How to install
+
+Make sure you have ruby and git installed:
+
+```bash
+ git clone https://github.com/alx3dev/ctfc.git
+ cd ctfc && bundle install
+```  
+  
+# How to run
+
+```bash
+ruby bin/ctfc fiat_1 fiat_2 fiat_3
+```
+
+This command also accept multiple arguments:
+
+ - `--no-save`  -  do not save `.csv.` output
+ - `--no-print` -  do not print terminal output
+ - `--coins`    -  coins to scrap (default: BTC, LTC, XMR, ETH, BCH, ZEC )
+ - `--help`     -  help menu
+  
+  
+# Script Examples
+
+ 1 - Run script without arguments (default options)  
+ 
+ ```
+ ruby bin/ctfc 
+ 
+  @return:  
+   print EUR rates for default coins (BTC, LTC, XMR, ETH, BCH, ZEC)
+   do not save '.csv' table 
+ ```     
+     
+     
+ 2 - Add fiat currencies as arguments  
+
+```
+ruby bin/ctfc eur usd rsd
+
+ @return:  
+  print EUR, USD, RSD rates for default coins 
+  save data in '.csv' table with pattern: 'crypto_CURRENCY.csv'
+   -> './crypto_eur.csv', './crypto_usd.csv', './crypto_rsd.csv'
+```
+
+ 3 - Use `--no-save` and/or `--no-print`  
+ 
+```
+ruby bin/ctfc eur --no-print --coins btc xmr ltc
+ 
+ @return:
+  save EUR rates for BTC, XMR and LTC
+  do not print output  
+  
+  
+ruby bin/ctfc rsd --no-save --coins btc xmr
+
+ @return:
+  print RSD rates for BTC and XMR
+  
+```  
+
+  
+# Developer Examples
+
+
+```ruby
+# define coins to scrap
+  COINS = %w[ BTC XMR LTC ETH ]
+
+# initialize Data class  
+  # DEPRECEATED - use Ctfc.new instead
+  @data = CTFC::Data.new :eur, save: false, print: false, coins: COINS  
+   @return CTFC::Data object with data to perform request
+    => #<CTFC::Data:0x000055715a6ce898 @coins=["BTC", "LTC", "XMR", "ETH", "BCH", "ZEC"], @currency="EUR", @print=true, @save=false>
+ 
+# execute request
+  @data.get
+   @return Hash with upcase string coins as keys, and float prices
+    => {"BTC"=>36760.11, "XMR"=>169.55, "LTC"=>114.4, "ETH"=>2746.22}
+  
+# now you can use ::Data instance methods
+  @data.response
+   @return RestClient response to cryptocomare API
+    => <RestClient::Response 200 "{\"RAW\":{\"BT...">
+   
+  @data.url
+   @return Cryptocompare API url
+    => "https://min-api.cryptocompare.com/data/pricemultifull?fsyms=BTC&fsyms=LTC&fsyms=XMR&fsyms=ETH&fsyms=BCH&fsyms=ZEC&tsyms=EUR"
+    
+  @data.table
+   @return '.csv' table name
+    => 'ctfc_eur.csv'
+    
+  @data.coins
+   @return coins for scrap, also allow setter method @data.coins = [...]
+    => ['BTC', 'XMR', 'LTC', 'ETH']
+    
+  @data.data
+   @return all data returned by cryptocompare API
+    => ... ... ...
+    
+  
+  TO BE CONTINIUED ...
+```    
+
+**Class methods added in Version-0.2.1**
+
+```ruby
+# Ctfc class extend CTFC::Data, for easier work:
+
+  prices = Ctfc.new :eur, print: false
+
+# Class method `#to` was added as shortcut:
+
+ Ctfc.to :rsd, save: false
+
+# For those who don't like name `Ctfc`, you can use `Crypto` too:
+
+ prices = Crypto.to :eur, coins: %w[BTC XMR]
+
+```  
+  
+# TO-DO:
+Write documentation, examples and use-cases as gem dependency

data/bin/console

@@ -0,0 +1,9 @@
+#/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'pry'
+require 'bundler/setup'
+
+require_relative '../lib/ctfc'
+
+Pry.start

data/bin/ctfc

@@ -0,0 +1,39 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require_relative '../lib/ctfc'
+require 'optimist'
+
+opts = Optimist.options do
+  version "Software Version: #{CTFC::VERSION}"
+
+  banner ''
+  banner ' Enter fiat currencies with/out additional arguments:'
+  banner ''
+  banner '  ruby bin/ctfc eur'
+  banner '  ruby bin/ctfc eur usd --no-save --coins btc xmr ltc'
+  banner ''
+
+  opt :coins,    'Set crypto coins', default: CTFC::CONFIG::COINS
+  opt :no_save,  "Do not save '.csv' output"
+  opt :no_print, 'Do not print terminal output'
+end
+
+save  = opts[:no_save]  ? false : true
+print = opts[:no_print] ? false : true
+
+if ARGV.empty?
+
+  Crypto.to :eur, save: false, print: true
+
+else
+
+  ARGV.each do |fiat|
+    next if opts.include? fiat.downcase
+
+    Ctfc.to(fiat,
+            save: save,
+            print: print,
+            coins: opts.coins)
+  end
+end

data/ctfc.gemspec

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require_relative './lib/ctfc/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'ctfc'
+  s.version     = CTFC::VERSION
+  s.summary     = 'Crypto to Fiat currency data gathering'
+  s.description = 'Convert any crypto to fiat currency and/or save in csv table.'
+
+  s.license = 'MIT'
+  s.authors = 'alx3dev'
+  s.homepage = 'https://github.com/alx3dev/ctfc'
+
+  s.bindir = 'bin'
+  s.require_paths = ['lib']
+  s.executables = ['ctfc']
+
+  s.metadata['homepage_uri'] = 'https://github.com/alx3dev/ctfc'
+  s.metadata['source_code_uri'] = 'https://github.com/alx3dev/ctfc'
+  s.metadata['bug_tracker_uri'] = 'https://github.com/alx3dev/ctfc/issues'
+
+  s.files = ['bin/ctfc', 'bin/console', 'lib/ctfc.rb', 'LICENSE', 'README.md', 'ctfc.gemspec',
+             'lib/ctfc/config.rb', 'lib/ctfc/version.rb', 'lib/ctfc/base.rb']
+
+  s.required_ruby_version = '>= 3.0.1'
+
+  s.add_runtime_dependency 'colorize', '~> 0.8.1'
+  s.add_runtime_dependency 'optimist', '~> 3.0.1'
+  s.add_runtime_dependency 'rest-client', '~> 2.1.0'
+
+  s.add_development_dependency 'bundler', '~> 2.2.9'
+  s.add_development_dependency 'pry', '~> 0.14.1'
+  s.add_development_dependency 'rake', '~> 13.0.3'
+end

data/lib/ctfc/base.rb

@@ -0,0 +1,196 @@
+# frozen_string_literal: true
+
+require_relative 'config'
+require_relative 'version'
+
+require 'json'
+require 'csv'
+require 'colorize'
+require 'rest-client'
+
+module CTFC
+  ##
+  # Data class keep all the logic to send request, receive response,
+  # and everything between. Class Ctfc extend CTFC::Data, for easier work.
+  #
+  # @note Instead of using CTFC::Data.new, recommended way is to call Ctfc.new
+  #
+  class Data
+    include CONFIG
+
+    attr_reader   :response, :data, :url, :table, :count, :prices
+    attr_accessor :fiat, :coins
+
+    alias currency fiat
+
+    ##
+    # @example Initialization example
+    #
+    #   @data = CTFC::Data.new :eur, save: true
+    #
+    # @param [Symbol] currency **Optional**. Define fiat currency.
+    # @param [Hash] opts **Optional**. Additional options hash.
+    #
+    # @option opts [Boolean] print **Optional**. Print terminal output.
+    # @option opts [Boolean] save **Optional**. Save `.csv` output.
+    # @option opts [Array] coins **Optional**. Define coins to scrap.
+    #
+    # @return [Object] Data object to work with
+    #
+    def initialize(currency = :eur, opts = {})
+      @fiat  = currency.to_s.upcase
+      @save  = opts[:save].nil?  ? true : opts[:save]
+      @print = opts[:print].nil? ? true : opts[:print]
+      @coins = opts[:coins].nil? ? COINS : Array(opts[:coins])
+    end
+
+    ##
+    # @example Get fiat prices for previous config
+    #
+    #   @data.get
+    #
+    # @example Get prices and change previous config "on-the-fly"
+    #
+    #   @data.get :usd, save: false, coins: %w[BTC XMR ETH]
+    #
+    # @param [Symbol || String] currency **Optional**. Change fiat currency and execute request.
+    # @param [Hash] opts **Optional**. Options hash to change config 'on-the-fly' - see #initialize.
+    #
+    def get(currency = nil, opts = {})
+      @fiat  = currency.to_s.upcase unless currency.nil?
+      @coins = opts[:coins]  unless opts[:coins].nil?
+      @save  = opts[:save]   unless opts[:save].nil?
+      @print = opts[:print]  unless opts[:print].nil?
+      @count = 0
+      @table = "ctfc_#{@fiat}.csv".downcase
+      do_rest_request
+    end
+
+    ##
+    # Get fiat value from response hash with crypto prices
+    #
+    # @example
+    #
+    #   @data.price(:btc)
+    #
+    # @param [Symbol || String] coin **Required**. Coin name as symbol or string.
+    # @return [Float]
+    #
+    def price(coin)
+      @prices[coin.to_s.upcase]
+    end
+
+    ##
+    # Check if crypto prices will be saved in `.csv` table
+    #
+    # @return [true || false]
+    #
+    def save?
+      @save == true
+    end
+
+    ##
+    # Check if crypto prices will be printed in terminal
+    #
+    # @return [true || false]
+    #
+    def print?
+      @print == true
+    end
+
+    ##
+    # Change option to save '.csv' table with prices
+    #
+    # @return [true || false]
+    #
+    def save=(opt)
+      @save = opt.is_a?(TrueClass) ? true : false
+    end
+
+    ##
+    # Change option to print prices in terminal
+    #
+    # @return [true || false]
+    #
+    def print=(opt)
+      @print = opt.is_a?(TrueClass) ? true : false
+    end
+
+    ##
+    # Check if request was successful or not.
+    #
+    # @return [true || false]
+    #
+    def success?
+      return false if @response.nil?
+
+      @response.code == 200
+    end
+
+    private
+
+    def do_rest_request
+      prepare_uri
+      process_data
+      @prices
+    rescue StandardError
+      @count += 1
+
+      if @count >= MAX_RETRY
+        puts @response.to_s.split(',')
+      else
+        do_rest_request
+      end
+    end
+
+    def process_data
+      @response = RestClient.get @url
+      @data = JSON.parse @response
+
+      @data_array << Time.now.to_s
+      @coins.each do |coin|
+        value = @data['RAW'][coin.to_s.upcase][@fiat.to_s.upcase]['PRICE'].round(2)
+        @prices[coin] = value
+        @data_array << value
+      end
+
+      print_fiat_values
+      save_csv_data
+    end
+
+    def prepare_uri
+      @prices = Hash.new {}
+      @data_array = Array.new []
+      coin_uri = String.new ''
+      @coins.collect { |coin| coin_uri << "fsyms=#{coin}&" }
+      @url = URL + "#{coin_uri}tsyms=#{@fiat}"
+    end
+
+    def print_fiat_values
+      return unless print?
+
+      30.times { print '='.green }
+      puts ''
+      puts "#{'['.green}#{@fiat.to_s.upcase.yellow.bold}#{']'.green} conversion rate"
+      30.times { print '='.green }
+      puts ''
+      @prices.each do |name, value|
+        print '['.yellow.bold + name.to_s.green.bold + ']'.yellow.bold
+        puts ": #{value}".bold
+      end
+    end
+
+    def save_csv_data
+      return unless save?
+
+      create_csv_headers unless File.exist?(@table)
+      CSV.open(@table, 'ab') { |column| column << @data_array }
+    end
+
+    def create_csv_headers
+      header_array = ['TIME']
+      @coins.each { |coin| header_array << coin }
+      CSV.open(@table, 'w') { |header| header << header_array }
+    end
+  end
+end

data/lib/ctfc/config.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module CTFC
+  ##
+  # Keep default configuration data, like coins to scrap, max number
+  # of retries and cryptocompare API url.
+  #
+  module CONFIG
+    # default coins to use
+    COINS = %w[BTC LTC XMR ETH BCH ZEC].freeze
+
+    # max number of retries if request fail
+    MAX_RETRY = 3
+
+    # Cryptocompare API - base url for requests
+    URL = 'https://min-api.cryptocompare.com/data/pricemultifull?'
+  end
+end

data/lib/ctfc/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module CTFC
+  VERSION = '0.3.1'
+end

data/lib/ctfc.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require_relative 'ctfc/base'
+
+##
+# For easier job use Ctfc, instead of typing CTFC::Data.
+# You can define default coins with Ctfc::COINS=
+#
+class Ctfc < CTFC::Data
+  ##
+  # @todo Allow Ctfc to use proxy and/or tor
+  #
+  def initialize(currency = :eur, opts = {})
+    opts[:coins] ||= COINS
+    super(currency, opts)
+  end
+
+  ##
+  # @example Get EUR data for BTC, XMR, LTC, ETH, print but don't save output
+  #
+  #   Ctfc.to :eur, save: false, coins: %w[BTC XMR LTC ETH]
+  #
+  # @param [Symbol] currency **Required**. Define fiat currency.
+  # @param [Hash] opts **Optional**. Additional options hash.
+  #
+  # @option opts [Boolean] print **Optional**. Print terminal output.
+  # @option opts [Boolean] save **Optional**. Save `.csv` output.
+  # @option opts [Array] coins **Optional**. Define coins to scrap.
+  #
+  # @return [Hash] CTFC::Data#prices || CTFC::Data#response
+  #
+  def self.to(currency, opts = {})
+    new(currency.to_sym, opts).get
+  end
+end
+
+##
+# Same as Ctfc
+# @see Ctfc
+# @see CTFC::Data
+#
+class Crypto < Ctfc
+  def initialize(currency = :eur, opts = {})
+    opts[:coins] ||= COINS
+    super(currency, opts)
+  end
+end

metadata

@@ -0,0 +1,139 @@
+--- !ruby/object:Gem::Specification
+name: ctfc
+version: !ruby/object:Gem::Version
+  version: 0.3.1
+platform: ruby
+authors:
+- alx3dev
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-01-20 00:00:00.000000000 Z
+dependencies:
+- !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: optimist
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.1
+- !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: 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: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.1
+- !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: Convert any crypto to fiat currency and/or save in csv table.
+email:
+executables:
+- ctfc
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- bin/console
+- bin/ctfc
+- ctfc.gemspec
+- lib/ctfc.rb
+- lib/ctfc/base.rb
+- lib/ctfc/config.rb
+- lib/ctfc/version.rb
+homepage: https://github.com/alx3dev/ctfc
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/alx3dev/ctfc
+  source_code_uri: https://github.com/alx3dev/ctfc
+  bug_tracker_uri: https://github.com/alx3dev/ctfc/issues
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.1
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.32
+signing_key:
+specification_version: 4
+summary: Crypto to Fiat currency data gathering
+test_files: []