ctfc 0.3.3 → 1.0.0.alpha

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9eb6a110a8c9249570c3581febbeda07c970d4265e2f4e28c72e63cfd3007e58
-  data.tar.gz: 291e835ae45d67bbc37ac7eaad33fbf74e581e21c5e4e760dcca39acb8cbd8ab
+  metadata.gz: f2aa46b7e28383d2845d81ddeed7173ac7423e6e960dea6ffb4f37ba5e536969
+  data.tar.gz: 86ecfff9bb989a17054570ce600ea70e35c71fb1b01ce34e32265c010efa6e44
 SHA512:
-  metadata.gz: 624349dc7c81ec34cfa33d46869482fab91f2d8e02f57a3723b220135e3db4ce2fe607d738fdcd565b91b22dc342c6fe342f22af9a55ae4b90e4be50b0cd6d18
-  data.tar.gz: b051e5169a7c2cf0724c9d2af55477731e8dc5163e04951c9d5f333278e064b2ec95b28d8b932018eeeb9a89dfc8b9c4e6bc8d9c37b13c7d90cc97633378c953
+  metadata.gz: cacd0718b90b741a18ddf4199b9ceb23a49fcf63505e741c2c55c40183b0ae40979192b2e875046424db9a0dccee2df04ce8e9973a0be6b90236d395297fd2b3
+  data.tar.gz: 12c0ae246495fde8927693ee626d198268d1686483d4ed2e02494c35230511537b3e41030b92eae25278d6b709a12e2ba3e80fe38ab7f2322342850d93635441

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,158 +1 @@
-# 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  
-
-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
-```
-
-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
- 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
-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
-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  
-  @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
-  @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...">
-  
-  # 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"
-  
-  # name of csv table (saved in working directory)  
-  @data.table
-    => 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']
-
-  # get all data about all coins (json api response)
-  @data.data
-    => 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 as shortcuts:**
-
-```ruby
-# get default coins in EUR, save output without printing
-  prices = Ctfc.to :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]
-```  
-
-# Contribution
-Any contribution is highly appreciated, as long as you follow Code of Conduct.
-
- - Fork repository
- - Make your changes
- - Submit pull request  
-
-# License
-Don't be a dick - it's MIT.
-
-# To-Do:
-See **Projects**
+This is development branch, testing code before merge.

data/bin/ctfc

@@ -1,11 +1,14 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-require_relative '../lib/ctfc'
 require 'optimist'
+require_relative '../lib/ctfc'
+require_relative '../lib/ctfc/helpers/cli'
+
+COINS = %w[BTC XMR ETH LTC].freeze
 
 opts = Optimist.options do
-  version "Software Version: #{CTFC::VERSION}"
+  version "Crypto To Fiat Currency\nGem Version: #{CTFC::VERSION}"
 
   banner ''
   banner ' Enter fiat currencies with/out additional arguments:'
@@ -14,26 +17,38 @@ 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: COINS
+  opt :save,      "Save prices in '.csv' table",      default: false
+  opt :export,    "Export all data in '.json' file",  default: false
+  opt :no_print,  'Do not print terminal output',     default: false
+  opt :source,    'Set source to extract data',       default: 'cryptocompare'
+  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
+coins  = opts[:coins]
+source = opts[:source]
+save   = opts[:save]
+export = opts[:export]
+print  = true unless opts[:no_print]
 
 if ARGV.empty?
+  prices = Crypto.to :usd, coins, source.to_sym, save: save, export: export
+  Cli.print_output :USD, prices if print
+else
+  opts[:loop].times do
+    ARGV.each do |fiat|
+      next if opts.include?(fiat.downcase)
 
-  Crypto.to :eur, save: false, print: true
+      prices = Crypto.to fiat, coins, source.to_sym, save: save, export: export
+      next unless print
 
-else
+      system 'clear' or system 'cls'
+      Cli.print_output fiat, prices
+    end
 
-  ARGV.each do |fiat|
-    next if opts.include? fiat.downcase
+    next unless opts[:loop] > 1
 
-    Ctfc.to(fiat,
-            save: save,
-            print: print,
-            coins: opts.coins)
+    sleep opts[:wait]
   end
 end

data/ctfc.gemspec

@@ -1,37 +1,58 @@
 # frozen_string_literal: true
 
 require_relative './lib/ctfc/version'
+require_relative './lib/ctfc/helpers/list'
 
 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 data gathering gem. Scrap and save as CSV and/or JSON.'
+  s.description = <<~DESCRIPTION
+    == DEVELOPMENT VERSION==
+    Cryptocurrency data gathering gem. Get data from multiple APIs, print and
+    save output as you wish. Run script from terminal, or use in another app.
+    Class-template based, easy to extend to add more sources. MIT License.
+  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['changelog_uri'] = 'https://github.com/alx3dev/ctfc/CHANGELOG.md'
   s.metadata['documentation_uri'] = "https://rubydoc.info/gems/#{s.name}/#{s.version}"
+  s.metadata['license_uri'] = 'https://github.com/alx3dev/ctfc/LICENSE'
   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.required_ruby_version = '>= 3.0.1'
-
-  s.add_runtime_dependency 'colorize', '~> 0.8.1'
+  s.files = %w[ lib/ctfc.rb
+                lib/ctfc/client.rb
+                lib/ctfc/export.rb
+                lib/ctfc/version.rb
+                lib/ctfc/api.rb
+                lib/ctfc/api/apitemplate.rb
+                LICENSE
+                README.md
+                ctfc.gemspec]
+
+  # auto-add sources in api dir
+  List.source_files.select do |source|
+    file = "lib/ctfc/api/#{source}"
+    s.files += [file]
+  end
+
+  s.required_ruby_version = '> 2.7', '< 3.2'
+
+  s.add_runtime_dependency 'kolorit', '~> 0.2'
   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'
+  s.add_development_dependency 'bundler', '~> 2.3'
+  s.add_development_dependency 'pry', '~> 0.14'
+  s.add_development_dependency 'rake', '~> 13.0'
 end

data/lib/ctfc/api/apitemplate.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+require 'rest-client'
+require 'json'
+
+module CTFC
+  module API
+    # Template for other sources. Every file in api dir should extend this class.
+    # Automatically call method #process to send api request after initialization.
+    # This mean every source should include method #process, that will be executed
+    # after initialization.
+    #
+    # @see CTFC::API
+    # @see CTFC::API::Cryptocompare
+    #
+    class ApiTemplate
+      attr_reader :response
+
+      # max number of requests to send
+      MAX_RETRY = 3
+
+      # Construct response hash from given arguments, and start counting requests.
+      # Call private method #process to extract data from web.
+      #
+      # @example Send request to cryptocompare
+      #  crypto = Cryptocompare.new :eur, %w[BTC XMR]
+      #
+      # @param [Symbol] fiat **Required**. Fiat currency to use for conversion.
+      # @param [Array] coins **Required**. Array of coins to extract data.
+      #
+      # @return [Object] Source instance.
+      #
+      def initialize(fiat, coins)
+        @response = { fiat: fiat, coins: coins, success: false }
+        @counter  = 0
+        process
+      end
+
+      # Initialize new instance, send request and return response hash.
+      # @example
+      #  Cryptocompare[:eur, %w[BTC XMR]]
+      #
+      # @param [Symbol] fiat **Required**. Fiat currency.
+      # @param [Array] coins **Required**. Cryptocurrency coins.
+      #
+      # @return [Hash] Response hash object.
+      #
+      def self.[](fiat, coins)
+        new(fiat, coins).response
+      end
+
+      private
+
+      def process
+        return false unless response[:fiat] && response[:coins]
+      end
+
+      def success!(set: true)
+        @counter = 0 if set == true
+        @response[:success] = set
+      end
+    end
+  end
+end

data/lib/ctfc/api/cryptocompare.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require_relative 'apitemplate' unless defined? CTFC::API::ApiTemplate
+
+module CTFC
+  module API
+    # Source file for cryptocompare api.
+    # Initialize will automatically call #process,
+    # to send request after all attributes and variables are configured.
+    #
+    # @see CTFC::API::ApiTemplate
+    #
+    class Cryptocompare < ApiTemplate
+      # Cryptocompare API base url, where we add coins and fiat currency.
+      BASE_URL = 'https://min-api.cryptocompare.com/data/pricemultifull?'
+
+      private
+
+      def process
+        super
+        uri = ''
+        response[:coins].collect do |coin|
+          uri += "fsyms=#{coin}&" unless uri.include? coin
+        end
+        uri += "tsyms=#{response[:fiat]}"
+        @response[:uri] = BASE_URL + uri
+        do_rest_request
+      end
+
+      def do_rest_request(time = Time.now)
+        rest = RestClient.get(response[:uri])
+        success! if rest.code == 200
+        process_json_data JSON.parse(rest), time
+      rescue StandardError => e
+        success! set: false
+        if (@counter += 1) > MAX_RETRY
+          puts e.message
+        else
+          retry
+        end
+      end
+
+      def process_json_data(data, time)
+        fiat = response[:fiat]
+        prices = {}
+        response[:coins].each do |coin|
+          value = data['RAW'][coin.upcase][fiat.to_s.upcase]['PRICE'].round(2)
+          prices[coin] = value
+        end
+        @response.merge!(time: time.to_s, prices: prices, data: data)
+      end
+    end
+  end
+end

data/lib/ctfc/api.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+# Benchmark say it's faster to use **unless defined?** if we require file
+# on multiple locations
+
+require_relative 'api/apitemplate' unless defined? CTFC::API::ApiTemplate
+require_relative 'helpers/list' unless defined? List
+
+# automatically require new apis
+List.sources.select { |source| require_relative "api/#{source}" }
+
+module CTFC
+  #
+  # Keep sources to extract data. Each source has to be a class,
+  # named as API domain, extending ApiTemplate. This will automatically
+  # make it available in Client, but also added to .gemspec.
+  #
+  # @see CTFC::API::ApiTemplate
+  # @see CTFC::API::Cryptocompare
+  #
+  # @example Add a new source to extract data:
+  #  # make file new_source.rb
+  #  class NewSource < ApiTemplate
+  #
+  #    private
+  #
+  #    def process
+  #      # check response hash for persistence of fiat and coins
+  #      super
+  #      # write method to scrap data from NewSource
+  #    end
+  #  end
+  #
+  module API
+  end
+end

data/lib/ctfc/client.rb

@@ -0,0 +1,146 @@
+# frozen_string_literal: true
+
+require_relative 'api'
+require_relative 'export'
+
+module CTFC
+  #
+  # Client allow us to get data from our sources, and to
+  # manipulate with that data. While other classes are mostly
+  # used by each-other, Client is mostly used directly by user.
+  #
+  class Client
+    attr_reader :config, :response, :prices
+
+    #
+    # Choose fiat currency, coins and source for new client.
+    # @example Initialize new **EUR** client
+    #  client = CTFC::Client.new :eur, %w[BTC XMR LTC ETH]
+    #
+    # @param [Symbol] currency **Required**. Set fiat currency.
+    # @param [Array] coins **Required**. Set crypto coins.
+    # @param [Symbol] source Optional. Source for data extraction.
+    # @param [Hash] opts Options hash for additional configuration.
+    #
+    # @option opts [Symbol] source Set source to extract data.
+    # @option opts [Boolean] save Set option to save prices in csv table.
+    # @option opts [Boolean] export Set option to export all data in json file.
+    #
+    # @return [Client] Client instance.
+    #
+    def initialize(fiat, coins, source = nil, opts = {})
+      @config = {
+        fiat: fiat,
+        coins: coins,
+        source: source || opts[:source],
+        save: [nil, true].include?(opts[:save]),
+        export: opts[:export].is_a?(TrueClass)
+      }
+    end
+
+    # Scrap data from source.
+    # @example
+    #  client.get :cryptocompare
+    #
+    # @param [Symbol] source Source to send api request
+    # @return [Hash] Hash of fiat values for scrapped coins
+    #
+    def get(source = nil)
+      source ||= config[:source]
+      send_api_request(source)
+      if success?
+        Export.to_csv(source, response) if save?
+        Export.to_json(source, response) if export?
+      end
+      @prices = response[:prices]
+    end
+
+    # Source for data extraction.
+    # @return [Symbol]
+    #
+    def source
+      config[:source]
+    end
+
+    # Set source for data extraction.
+    # @return [Symbol]
+    #
+    def source=(param)
+      @config[:source] = param
+    end
+
+    # Check if csv output will be saved after request.
+    # @return [Boolean]
+    #
+    def save?
+      config[:save].is_a?(TrueClass)
+    end
+
+    # Change option to save prices in csv table after request.
+    # @return [Boolean]
+    #
+    def save=(opt)
+      @config[:save] = opt.is_a?(TrueClass)
+    end
+
+    # Check if json output will be exported after request.
+    # @return [Boolean]
+    #
+    def export?
+      config[:export].is_a?(TrueClass)
+    end
+
+    # Change option to export all data in json file after request.
+    # @return [Boolean]
+    #
+    def export=(opt)
+      @config[:export] = opt.is_a?(TrueClass)
+    end
+
+    # Get fiat value from response hash with crypto prices
+    # @example
+    #  client.price(:btc)
+    #
+    # @param [Symbol] coin **Required**. Coin name as symbol.
+    # @return [Float]
+    #
+    def price(coin)
+      prices[coin.to_s.upcase]
+    end
+
+    # Check if request was successful.
+    #
+    def success?
+      return false if response.nil?
+
+      response[:success].is_a?(TrueClass)
+    end
+
+    private
+
+    def send_api_request(source)
+      # automatically add new sources to the client, but be careful with eval.
+      if List.sources.include? source
+        klass = check_source_name source
+
+        @response =
+          instance_eval "CTFC::API::#{klass}[ config[:fiat], config[:coins] ]"\
+                        '# CTFC::API::Cryptocompare[fiat, coins]', __FILE__, __LINE__ - 1
+      else
+        message = 'Add source to extract data' if source.nil?
+        message = "#{source} not included in API list" if source
+        raise ArgumentError, message
+      end
+    end
+
+    # Check for underscore and capitalize each word.
+    #
+    def check_source_name(source)
+      if source.to_s.include? '_'
+        source.split('_').select(&:capitalize!).join
+      else
+        source.to_s.capitalize
+      end
+    end
+  end
+end

data/lib/ctfc/export.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require 'csv'
+
+# Keep methods to export data as csv or json.
+# JSON extract all data, while CSV only prices.
+#
+module Export
+  class << self
+    #
+    # Save crypto prices in csv table.
+    #
+    def to_csv(source, response = {})
+      table = "ctfc_#{response[:fiat]}_#{source}.csv"
+      coins = response[:coins]
+      data_row = price_array_from response
+      create_csv_headers(table, coins) unless File.exist?(table)
+      CSV.open(table, 'ab') { |column| column << data_row }
+    end
+
+    # Extract all data in json file.
+    #
+    def to_json(source, response = {})
+      table = "ctfc_#{response[:fiat]}_#{source}.json"
+      File.open(table, 'ab') do |append|
+        append.puts JSON.pretty_generate response
+      end
+    end
+
+    private
+
+    def create_csv_headers(table, coins)
+      header_array = ['TIME']
+      coins.each { |coin| header_array << coin }
+      CSV.open(table, 'w') { |header| header << header_array }
+    end
+
+    def price_array_from(response = {})
+      price_array = [response[:time]]
+      response[:prices].each do |_coin, price|
+        price_array << price
+      end
+      price_array
+    end
+  end
+end

data/lib/ctfc/version.rb

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

data/lib/ctfc.rb

@@ -1,49 +1,24 @@
 # frozen_string_literal: true
 
-require_relative 'ctfc/base'
+require_relative 'ctfc/client'
+require_relative 'ctfc/version'
 
-##
-# 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
-  #
-  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
+# Ctfc is shortcut for CTFC::Client.
+# @see CTFC::Client
+class Ctfc < CTFC::Client
 end
 
-##
-# Same as Ctfc
-# @see Ctfc
-# @see CTFC::Data
+# Shortcut to initialize new client,
+# and get prices hash.
+#
+# @example Get EUR prices for coins:
+#   coins = %w[BTC XMR LTC ETH]
+#   Crypto.to :eur, coins, :cryptocompare, save: true
 #
-class Crypto < Ctfc
-  def initialize(currency = :eur, opts = {})
-    opts[:coins] ||= COINS
-    super(currency, opts)
+class Crypto
+  # @return [Hash]
+  # @see CTFC::Client
+  def self.to(*args)
+    CTFC::Client.new(*args).get
   end
 end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: ctfc
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 1.0.0.alpha
 platform: ruby
 authors:
 - alx3dev
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-01-22 00:00:00.000000000 Z
+date: 2022-02-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: colorize
+  name: kolorit
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.1
+        version: '0.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.1
+        version: '0.2'
 - !ruby/object:Gem::Dependency
   name: optimist
   requirement: !ruby/object:Gem::Requirement
@@ -58,43 +58,47 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.2.9
+        version: '2.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.2.9
+        version: '2.3'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.14.1
+        version: '0.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.14.1
+        version: '0.14'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 13.0.3
+        version: '13.0'
   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.
+        version: '13.0'
+description: |
+  == DEVELOPMENT VERSION==
+  Cryptocurrency data gathering gem. Get data from multiple APIs, print and
+  save output as you wish. Run script from terminal, or use in another app.
+  Class-template based, easy to extend to add more sources. MIT License.
 email:
 executables:
 - ctfc
@@ -103,12 +107,14 @@ 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/api.rb
+- lib/ctfc/api/apitemplate.rb
+- lib/ctfc/api/cryptocompare.rb
+- lib/ctfc/client.rb
+- lib/ctfc/export.rb
 - lib/ctfc/version.rb
 homepage: https://github.com/alx3dev/ctfc
 licenses:
@@ -117,7 +123,9 @@ 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
+  changelog_uri: https://github.com/alx3dev/ctfc/CHANGELOG.md
+  documentation_uri: https://rubydoc.info/gems/ctfc/1.0.0.alpha
+  license_uri: https://github.com/alx3dev/ctfc/LICENSE
   rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
@@ -125,17 +133,20 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: 3.0.1
+      version: '2.7'
+  - - "<"
+    - !ruby/object:Gem::Version
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubygems_version: 3.2.32
+rubygems_version: 3.3.6
 signing_key:
 specification_version: 4
-summary: Crypto to Fiat currency data gathering
+summary: Cryptocurrency data gathering gem. Scrap and save as CSV and/or JSON.
 test_files: []

data/bin/console

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

data/lib/ctfc/base.rb

@@ -1,196 +0,0 @@
-# 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)
-    end
-
-    ##
-    # Change option to print prices in terminal
-    #
-    # @return [true || false]
-    #
-    def print=(opt)
-      @print = opt.is_a?(TrueClass)
-    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 = {}
-      @data_array = []
-      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

@@ -1,18 +0,0 @@
-# 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