ctfc 0.3.1 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6df1fb47102b8c5c62d4340a69adf54db78ee380e8d0b88cf2b3201ad2229acb
-  data.tar.gz: 6302f744ba17f497fbd35bff59e695443bd74eec481b357462f70b3d049531a7
+  metadata.gz: 9eb6a110a8c9249570c3581febbeda07c970d4265e2f4e28c72e63cfd3007e58
+  data.tar.gz: 291e835ae45d67bbc37ac7eaad33fbf74e581e21c5e4e760dcca39acb8cbd8ab
 SHA512:
-  metadata.gz: 050abfa5bf9c9dd8b3444c1e89dca6af824b2cc4d2b215dd4e991058026e8b7dbf018231601d0b9d6e8f221eee5cffbd77f4b38dd53bdf8787f21cb9d2e0713a
-  data.tar.gz: 862f70090801ffedd6e9a01b06f1a341f2d771673b685868c87c683a542f09da7bb2cb03c039897b34b75bbb0638369ec42634c9e63a6c988baae5a9d4fb7341
+  metadata.gz: 624349dc7c81ec34cfa33d46869482fab91f2d8e02f57a3723b220135e3db4ce2fe607d738fdcd565b91b22dc342c6fe342f22af9a55ae4b90e4be50b0cd6d18
+  data.tar.gz: b051e5169a7c2cf0724c9d2af55477731e8dc5163e04951c9d5f333278e064b2ec95b28d8b932018eeeb9a89dfc8b9c4e6bc8d9c37b13c7d90cc97633378c953

data/README.md

@@ -1,19 +1,24 @@
 # 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/0.3.1/CTFC/Data  
 
 ```bash
 ruby bin/ctfc fiat_1 fiat_2 fiat_3
@@ -28,13 +33,12 @@ This command also accept multiple arguments:
   
   
 # Script Examples
-
  1 - Run script without arguments (default options)  
  
- ```
+ ```ruby
  ruby bin/ctfc 
  
-  @return:  
+  return:  
    print EUR rates for default coins (BTC, LTC, XMR, ETH, BCH, ZEC)
    do not save '.csv' table 
  ```     
@@ -42,92 +46,113 @@ This command also accept multiple arguments:
      
  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`  
  
-```
+```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
   
 ```  
 
   
 # 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
+    => 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
+    => return RestClient response to cryptocomare API
     => <RestClient::Response 200 "{\"RAW\":{\"BT...">
-   
+  
+  # check request url 
   @data.url
-   @return Cryptocompare API 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"
-    
+  
+  # name of csv table (saved in working directory)  
   @data.table
-   @return '.csv' table name
+    => 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 = [...]
+    => 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:
+# Contribution
+Any contribution is highly appreciated, as long as you follow Code of Conduct.
 
- Ctfc.to :rsd, save: false
+ - Fork repository
+ - Make your changes
+ - Submit pull request  
 
-# For those who don't like name `Ctfc`, you can use `Crypto` too:
+# License
+Don't be a dick - it's MIT.
 
- prices = Crypto.to :eur, coins: %w[BTC XMR]
-
-```  
-  
-# TO-DO:
-Write documentation, examples and use-cases as gem dependency
+# To-Do:
+See **Projects**

data/ctfc.gemspec

@@ -19,6 +19,8 @@ Gem::Specification.new do |s|
   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['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']

data/lib/ctfc/base.rb

@@ -104,7 +104,7 @@ module CTFC
     # @return [true || false]
     #
     def save=(opt)
-      @save = opt.is_a?(TrueClass) ? true : false
+      @save = opt.is_a?(TrueClass)
     end
 
     ##
@@ -113,7 +113,7 @@ module CTFC
     # @return [true || false]
     #
     def print=(opt)
-      @print = opt.is_a?(TrueClass) ? true : false
+      @print = opt.is_a?(TrueClass)
     end
 
     ##
@@ -159,8 +159,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}"

data/lib/ctfc/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module CTFC
-  VERSION = '0.3.1'
+  VERSION = '0.3.3'
 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,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ctfc
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.3
 platform: ruby
 authors:
 - alx3dev
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-01-20 00:00:00.000000000 Z
+date: 2022-01-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -117,6 +117,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/0.3.3
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths: