ctfc 0.3.3 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9eb6a110a8c9249570c3581febbeda07c970d4265e2f4e28c72e63cfd3007e58
-  data.tar.gz: 291e835ae45d67bbc37ac7eaad33fbf74e581e21c5e4e760dcca39acb8cbd8ab
+  metadata.gz: 6d7f984c8d01fdb97f4540e23e244331f7b633d542a812137ba88333fea81c51
+  data.tar.gz: cf87ca5035df753c47613b9ebc9446583241bef10ed5cc6c50407f3e5594ebd1
 SHA512:
-  metadata.gz: 624349dc7c81ec34cfa33d46869482fab91f2d8e02f57a3723b220135e3db4ce2fe607d738fdcd565b91b22dc342c6fe342f22af9a55ae4b90e4be50b0cd6d18
-  data.tar.gz: b051e5169a7c2cf0724c9d2af55477731e8dc5163e04951c9d5f333278e064b2ec95b28d8b932018eeeb9a89dfc8b9c4e6bc8d9c37b13c7d90cc97633378c953
+  metadata.gz: 5a0d314f9b292f1397d298f08b3d2af7184b65219dbb4e5e84fac85c72bc337e2d0eccce13f191c4ed39cee98d8f13884339eb7f4d2cb209f15d3fa1f91de872
+  data.tar.gz: 9ca4b6afa5b06d20b22a3646f4a2d5cbe017346c148432904a7224a4b66870b0040dee4910ac565688b534bc7c6b46c49d67f837bc5ca57e365f4594786806ae

data/LICENSE

@@ -1,3 +1,6 @@
+# CTFC gem is licensed under MIT license.
+# For it's dependencies, look at LICENSE_DEPENDENCIES.md.
+
 MIT License
 
 Copyright (c) 2022 alx3dev

data/README.md

@@ -18,7 +18,7 @@ Install from rubygems:
 gem install ctfc
 ```
 # How to run
-  - **Read documentation on:** https://rubydoc.info/gems/ctfc/0.3.1/CTFC/Data  
+  - **Read documentation on:** https://rubydoc.info/gems/ctfc/CTFC/Data  
 
 ```bash
 ruby bin/ctfc fiat_1 fiat_2 fiat_3
@@ -26,22 +26,24 @@ 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
  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  
@@ -55,7 +57,7 @@ ruby bin/ctfc eur usd rsd
       -> './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
@@ -69,7 +71,13 @@ ruby bin/ctfc rsd --no-save --coins btc 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
 ```  
 
   
@@ -81,37 +89,37 @@ ruby bin/ctfc rsd --no-save --coins btc xmr
   # 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>
+    -> #<Ctfc:0x000055b5c8b61a38 @coins=["BTC", "LTC", "XMR", "ETH", "BCH", "ZEC"], @fiat="EUR", @print=true, @save=true>
  
   # 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}
+    -> {"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...">
+    -> <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"
+    -> "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'
+    -> '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']
+    -> ['BTC', 'XMR', 'LTC', 'ETH']
 
   # get all data about all coins (json api response)
   @data.data
     => return all data returned by cryptocompare API
-    => {"RAW"=>
+    -> {"RAW"=>
       {"BTC"=>
         {"EUR"=>
           {"TYPE"=>"5",
@@ -144,11 +152,17 @@ ruby bin/ctfc rsd --no-save --coins btc xmr
   prices = Crypto.to :eur, coins: %w[BTC XMR]
 ```  
 
+# 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.
+
+
 # Contribution
 Any contribution is highly appreciated, as long as you follow Code of Conduct.
 
  - Fork repository
  - Make your changes
+ - Write tests
  - Submit pull request  
 
 # License

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,25 +5,35 @@ 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.metadata['documentation_uri'] = "https://rubydoc.info/gems/#{s.name}/#{s.version}"
+  s.metadata['documentation_uri'] = "https://rubydoc.info/gems/#{s.name}"
   s.metadata['rubygems_mfa_required'] = 'true'
 
-  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.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'
 
@@ -34,4 +44,5 @@ Gem::Specification.new do |s|
   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

@@ -8,12 +8,20 @@ require 'csv'
 require 'colorize'
 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?
@@ -141,6 +150,7 @@ module CTFC
       else
         do_rest_request
       end
+      false
     end
 
     def process_data

data/lib/ctfc/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ctfc
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.4.0
 platform: ruby
 authors:
 - alx3dev
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-01-22 00:00:00.000000000 Z
+date: 2022-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -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,7 +133,7 @@ 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/0.3.3
+  documentation_uri: https://rubydoc.info/gems/ctfc
   rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
@@ -137,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: []