ctfc 0.3.1 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6df1fb47102b8c5c62d4340a69adf54db78ee380e8d0b88cf2b3201ad2229acb
-  data.tar.gz: 6302f744ba17f497fbd35bff59e695443bd74eec481b357462f70b3d049531a7
+  metadata.gz: 409d75b59775b440b646f56056d957339253c550befff121d954373b4e26634f
+  data.tar.gz: 5c11ef13d7da7fb6dcfac08b0985620d9104100db0851a3760066d08b261d84b
 SHA512:
-  metadata.gz: 050abfa5bf9c9dd8b3444c1e89dca6af824b2cc4d2b215dd4e991058026e8b7dbf018231601d0b9d6e8f221eee5cffbd77f4b38dd53bdf8787f21cb9d2e0713a
-  data.tar.gz: 862f70090801ffedd6e9a01b06f1a341f2d771673b685868c87c683a542f09da7bb2cb03c039897b34b75bbb0638369ec42634c9e63a6c988baae5a9d4fb7341
+  metadata.gz: 2a6011b38fb81898fae7a59d54e512104b7e8bee9f15d38d5f716d6680a62bf07e6beb6d67615c4486bb971f2ac8db8c9652ceb7f0328145f484e36e6ee362ea
+  data.tar.gz: c2cecff14b934c6cfb467933528329be3ad79ed5e5a5205a4448e587d7d2f1a185e6c10e24d858dc6f76b2e019a9242f8d7d6e13a516d71535f0819b6ce540e6

data/LICENSE

@@ -1,3 +1,9 @@
+##
+# CTFC gem is copyrighted under MIT license.  
+# From version `0.4.1`, first stable Open Source version, gem `colorize` was removed
+# to keep it all under MIT.
+##
+
 MIT License
 
 Copyright (c) 2022 alx3dev

data/README.md

@@ -1,19 +1,29 @@
-# About
+[**NOTE:**](https://www.github.com/alx3dev/ctfc/LICENSE_DEPENDENCIES.md)
+ >Removed gem `colorize` to allow **MIT** license.  
+ >All comits from `v-0.4.0` must be signed and tagged **verified**.
+
 
+# 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  
 
-Make sure you have ruby and git installed:
-
+Install from source:
 ```bash
  git clone https://github.com/alx3dev/ctfc.git
  cd ctfc && bundle install
 ```  
-  
+
+Install from rubygems:
+
+```bash
+gem install ctfc
+```
 # How to run
+  - **Read documentation on:** https://rubydoc.info/gems/ctfc/CTFC/Data  
 
 ```bash
 ruby bin/ctfc fiat_1 fiat_2 fiat_3
@@ -21,113 +31,147 @@ 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
+ - `--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 )
+ - `--loop`     - repeat script N times (default 1)
+ - `--wait`     - wait N seconds between loops (default 0)
+ - `--help`     - help menu
   
   
 # Script Examples
-
  1 - Run script without arguments (default options)  
  
- ```
+```ruby
  ruby bin/ctfc 
  
-  @return:  
-   print EUR rates for default coins (BTC, LTC, XMR, ETH, BCH, ZEC)
-   do not save '.csv' table 
- ```     
+ => 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
 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'
+ => 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`  
+ 3 - Use `--no-save`, `--no-print`, `--loop`, `--wait`
  
-```
+```ruby
 ruby bin/ctfc eur --no-print --coins btc xmr ltc
  
- @return:
-  save EUR rates for BTC, XMR and LTC
-  do not print output  
+ => 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
-  
+ => return:
+      print RSD rates for BTC and XMR
+
+
+# added in version 0.4.0
+ruby bin/ctfc rsd --no-print --loop 1440 --wait 60
+
+ => return:
+      save RSD rates without print, run each minute for 24 hours
 ```  
 
   
 # Developer Examples
-
-
 ```ruby
-# define coins to scrap
+  # 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>
+  # initialize Data class  
+  @data = Ctfc.new :eur, save: false, print: false, coins: COINS
+    => return Ctfc object to work with
+    -> #<Ctfc:0x000055b5c8b61a38 @coins=["BTC", "LTC", "XMR", "ETH", "BCH", "ZEC"], @fiat="EUR", @print=true, @save=true>
  
-# execute request
+  # 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}
+    => 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
+  # now you can use ::Data instance methods
   @data.response
-   @return RestClient response to cryptocomare API
-    => <RestClient::Response 200 "{\"RAW\":{\"BT...">
-   
+    => return RestClient response to cryptocomare API
+    -> <RestClient::Response 200 "{\"RAW\":{\"BT...">
+  
+  # check request url 
   @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"
-    
+    => 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"
+  
+  # name of csv table (saved in working directory)  
   @data.table
-   @return '.csv' table name
-    => 'ctfc_eur.csv'
-    
+    => return '.csv' table name
+    -> 'ctfc_eur.csv'
+
+  # array of coins to work with
   @data.coins
-   @return coins for scrap, also allow setter method @data.coins = [...]
-    => ['BTC', 'XMR', 'LTC', 'ETH']
-    
+    => return coins for scrap, also allow setter method @data.coins = [...]
+    -> ['BTC', 'XMR', 'LTC', 'ETH']
+
+  # get all data about all coins (json api response)
   @data.data
-   @return all data returned by cryptocompare API
-    => ... ... ...
+    => return all data returned by cryptocompare API
+    -> {"RAW"=>
+      {"BTC"=>
+        {"EUR"=>
+          {"TYPE"=>"5",
+           "MARKET"=>"CCCAGG",
+           "FROMSYMBOL"=>"BTC",
+           "TOSYMBOL"=>"EUR",
+           "FLAGS"=>"2049",
+           "PRICE"=>33851.17,
+           "LASTUPDATE"=>1642773847,
+           "MEDIAN"=>33853.8,
+           "LASTVOLUME"=>0.1,
+           "LASTVOLUMETO"=>3384.3676,
+           "LASTTRADEID"=>"2024043",
+           ... ... ... ... ... ... ...
     
   
   TO BE CONTINIUED ...
 ```    
 
-**Class methods added in Version-0.2.1**
+**Class methods as shortcuts:**
 
 ```ruby
-# Ctfc class extend CTFC::Data, for easier work:
+# get default coins in EUR, save output without printing
+  prices = Ctfc.to :eur, print: false
 
-  prices = Ctfc.new :eur, print: false
+# get default coins in RSD, print output, don't save
+  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]
+```  
 
-# Class method `#to` was added as shortcut:
+# Tests
+To run tests use `./check-syntax.sh`.  
+This command will run rubocop for code inspection, but with some errors hidden by `.rubocop_todo.yml`. Using check-syntax script, all test should pass.
 
- Ctfc.to :rsd, save: false
 
-# For those who don't like name `Ctfc`, you can use `Crypto` too:
+# Contribution
+Any contribution is highly appreciated, as long as you follow Code of Conduct.
 
- prices = Crypto.to :eur, coins: %w[BTC XMR]
+ - Fork repository
+ - Make your changes
+ - Write tests
+ - Submit pull request  
 
-```  
-  
-# TO-DO:
-Write documentation, examples and use-cases as gem dependency
+# License
+Don't be a dick - it's MIT.
+
+# To-Do:
+See **Projects**

data/bin/ctfc

@@ -5,7 +5,8 @@ require_relative '../lib/ctfc'
 require 'optimist'
 
 opts = Optimist.options do
-  version "Software Version: #{CTFC::VERSION}"
+  version "Crypto To Fiat Currency\n".cyan.bold \
+          + "Gem Version: #{CTFC::VERSION}"
 
   banner ''
   banner ' Enter fiat currencies with/out additional arguments:'
@@ -14,26 +15,42 @@ opts = Optimist.options do
   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'
+  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'
+  opt :loop,      'Run script N times',           default: 1, type: :integer
+  opt :wait,      'Wait N seconds between loop',  default: 0, type: :integer
 end
 
 save  = opts[:no_save]  ? false : true
 print = opts[:no_print] ? false : true
 
+@crypto = Ctfc.new
+
 if ARGV.empty?
 
-  Crypto.to :eur, save: false, print: true
+  @crypto.get(:eur, save: false)
 
 else
 
-  ARGV.each do |fiat|
-    next if opts.include? fiat.downcase
+  opts[:loop].times do
+    ARGV.each do |fiat|
+      next if opts.include?(fiat.downcase)
+
+      @crypto.get(fiat,
+                  save: save,
+                  print: print,
+                  coins: opts.coins)
+      sleep 1 # wait between requests
+    end
+
+    # end if no `--loop` arg
+    next unless opts[:loop] > 1
+
+    # pause between loops
+    sleep opts[:wait]
 
-    Ctfc.to(fiat,
-            save: save,
-            print: print,
-            coins: opts.coins)
+    # clear screan - depending on OS
+    system 'clear' or system 'cls'
   end
 end

data/ctfc.gemspec

@@ -5,31 +5,44 @@ 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.summary     = 'Cryptocurrency to Fiat values, get data and save prices.'
+  s.description = <<~DESCRIPTION
+    Convert any cryptocurrency to any fiat value, export data to csv table.
+    Print colorized terminal output.
+  DESCRIPTION
 
   s.license = 'MIT'
   s.authors = 'alx3dev'
   s.homepage = 'https://github.com/alx3dev/ctfc'
 
   s.bindir = 'bin'
-  s.require_paths = ['lib']
-  s.executables = ['ctfc']
+  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.metadata['documentation_uri'] = "https://rubydoc.info/gems/#{s.name}"
+  s.metadata['rubygems_mfa_required'] = 'true'
+
+  s.files = %w[ bin/ctfc
+                bin/console
+                lib/ctfc.rb
+                lib/ctfc/version.rb
+                lib/ctfc/base.rb
+                lib/ctfc/config.rb
+                LICENSE
+                README.md
+                ctfc.gemspec]
 
   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_runtime_dependency 'kolorit', '~> 0.1.3'
 
   s.add_development_dependency 'bundler', '~> 2.2.9'
   s.add_development_dependency 'pry', '~> 0.14.1'
   s.add_development_dependency 'rake', '~> 13.0.3'
+  s.add_development_dependency 'rspec', '~> 3.10.0'
 end

data/lib/ctfc/base.rb

@@ -5,15 +5,23 @@ require_relative 'version'
 
 require 'json'
 require 'csv'
-require 'colorize'
+require 'kolorit'
 require 'rest-client'
 
+##
+# Module **CTFC** keep everything together. **CTFC::CONFIG** module for default setup,
+# and **CTFC::Data** class for actual request execution. For instance methods look
+# at **CTFC::Data**, for class methods look at **Ctfc**.
+#
+# @see CTFC::Data
+# @see Ctfc
+#
 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
+  # @note Instead of using CTFC::Data.new, you can also call Ctfc.new
   #
   class Data
     include CONFIG
@@ -25,7 +33,6 @@ module CTFC
 
     ##
     # @example Initialization example
-    #
     #   @data = CTFC::Data.new :eur, save: true
     #
     # @param [Symbol] currency **Optional**. Define fiat currency.
@@ -35,7 +42,7 @@ module CTFC
     # @option opts [Boolean] save **Optional**. Save `.csv` output.
     # @option opts [Array] coins **Optional**. Define coins to scrap.
     #
-    # @return [Object] Data object to work with
+    # @return [Data] Data object to work with
     #
     def initialize(currency = :eur, opts = {})
       @fiat  = currency.to_s.upcase
@@ -45,17 +52,19 @@ module CTFC
     end
 
     ##
-    # @example Get fiat prices for previous config
+    # @example Get fiat prices for initialized config
     #
     #   @data.get
     #
-    # @example Get prices and change previous config "on-the-fly"
+    # @example Get prices and change initialized 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.
     #
+    # @return [Hash || false] Hash of coins and fiat values, or false if all requests fail
+    #
     def get(currency = nil, opts = {})
       @fiat  = currency.to_s.upcase unless currency.nil?
       @coins = opts[:coins]  unless opts[:coins].nil?
@@ -104,7 +113,7 @@ module CTFC
     # @return [true || false]
     #
     def save=(opt)
-      @save = opt.is_a?(TrueClass) ? true : false
+      @save = opt.is_a?(TrueClass)
     end
 
     ##
@@ -113,7 +122,7 @@ module CTFC
     # @return [true || false]
     #
     def print=(opt)
-      @print = opt.is_a?(TrueClass) ? true : false
+      @print = opt.is_a?(TrueClass)
     end
 
     ##
@@ -134,10 +143,9 @@ module CTFC
       process_data
       @prices
     rescue StandardError
-      @count += 1
-
-      if @count >= MAX_RETRY
+      if (@count += 1) >= MAX_RETRY
         puts @response.to_s.split(',')
+        false
       else
         do_rest_request
       end
@@ -159,8 +167,8 @@ module CTFC
     end
 
     def prepare_uri
-      @prices = Hash.new {}
-      @data_array = Array.new []
+      @prices = {}
+      @data_array = []
       coin_uri = String.new ''
       @coins.collect { |coin| coin_uri << "fsyms=#{coin}&" }
       @url = URL + "#{coin_uri}tsyms=#{@fiat}"
@@ -169,13 +177,13 @@ module CTFC
     def print_fiat_values
       return unless print?
 
-      30.times { print '='.green }
+      30.times { print '='.cyan }
       puts ''
-      puts "#{'['.green}#{@fiat.to_s.upcase.yellow.bold}#{']'.green} conversion rate"
-      30.times { print '='.green }
+      puts "#{'['.cyan.bold}#{@fiat.to_s.upcase.yellow.bold}#{']'.cyan.bold} conversion rate"
+      30.times { print '='.cyan }
       puts ''
       @prices.each do |name, value|
-        print '['.yellow.bold + name.to_s.green.bold + ']'.yellow.bold
+        print '['.yellow.bold + name.to_s.cyan.bold + ']'.yellow.bold
         puts ": #{value}".bold
       end
     end

data/lib/ctfc/version.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
 module CTFC
-  VERSION = '0.3.1'
+  # gem version
+  VERSION = '0.4.2'
 end

data/lib/ctfc.rb

@@ -6,6 +6,8 @@ require_relative 'ctfc/base'
 # For easier job use Ctfc, instead of typing CTFC::Data.
 # You can define default coins with Ctfc::COINS=
 #
+# @note For instance methods look at CTFC::Data.
+#
 class Ctfc < CTFC::Data
   ##
   # @todo Allow Ctfc to use proxy and/or tor

metadata

@@ -1,57 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: ctfc
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.2
 platform: ruby
 authors:
 - alx3dev
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-01-20 00:00:00.000000000 Z
+date: 2022-01-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: colorize
+  name: optimist
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.1
+        version: 3.0.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.1
+        version: 3.0.1
 - !ruby/object:Gem::Dependency
-  name: optimist
+  name: rest-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.1
+        version: 2.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.1
+        version: 2.1.0
 - !ruby/object:Gem::Dependency
-  name: rest-client
+  name: kolorit
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.1.0
+        version: 0.1.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.1.0
+        version: 0.1.3
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -94,7 +94,23 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 13.0.3
-description: Convert any crypto to fiat currency and/or save in csv table.
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.10.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.10.0
+description: |
+  Convert any cryptocurrency to any fiat value, export data to csv table.
+  Print colorized terminal output.
 email:
 executables:
 - ctfc
@@ -117,6 +133,8 @@ 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
+  documentation_uri: https://rubydoc.info/gems/ctfc
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -135,5 +153,5 @@ requirements: []
 rubygems_version: 3.2.32
 signing_key:
 specification_version: 4
-summary: Crypto to Fiat currency data gathering
+summary: Cryptocurrency to Fiat values, get data and save prices.
 test_files: []