alphavantagerb 1.0.0

data/lib/Client.rb

@@ -0,0 +1,70 @@
+module Alphavantage
+  class Client
+    include HelperFunctions
+
+    def initialize key:, verbose: false
+      check_argument([true, false], verbose, "verbose")
+      @apikey = key
+      @base_uri = 'https://www.alphavantage.co'
+      @verbose = verbose
+    end
+
+    attr_reader :verbose
+
+    def verbose=(verbose)
+      check_argument([true, false], verbose, "verbose")
+      @verbose = verbose
+    end
+
+    def request(url)
+      send_url = "#{@base_uri}/query?#{url}&apikey=#{@apikey}"
+      puts "\n#{send_url}\n" if @verbose
+      begin
+        response = HTTParty.get(send_url)
+      rescue Exception => e
+        raise Alphavantage::Error.new message: "Failed request: #{e.message}"
+      end
+      data = response.body
+      begin
+        data = JSON.parse(data)
+      rescue Exception => e
+        raise Alphavantage::Error.new message: "Parsing failed",
+          data: data
+      end
+      if !data["Error Message"].nil?
+        raise Alphavantage::Error.new message:  data["Error Message"], data: data
+      elsif !data["Information"].nil?
+        raise Alphavantage::Error.new message: data["Information"], data: data
+      end
+      return data
+    end
+
+    def download(url, file)
+      send_url = "#{@base_uri}/query?#{url}&datatype=csv&apikey=#{@apikey}"
+      begin
+        puts send_url if @verbose
+        uri = URI.parse(send_url)
+        uri.open{|csv| IO.copy_stream(csv, file)}
+      rescue Exception => e
+        raise Alphavantage::Error.new message: "Failed to save the CSV file: #{e.message}"
+      end
+      return "CSV saved in #{file}"
+    end
+
+    def stock(symbol:, datatype: "json")
+      Alphavantage::Stock.new symbol: symbol, key: self, datatype: datatype
+    end
+
+    def exchange(from:, to:)
+      Alphavantage::Exchange.new from: from, to: to, key: self
+    end
+
+    def crypto(symbol:, market:, datatype: "json")
+      Alphavantage::Crypto.new symbol: symbol, key: self, datatype: datatype, market: market
+    end
+
+    def sector
+      Alphavantage::Sector.new key: self
+    end
+  end
+end

data/lib/Crypto.rb

@@ -0,0 +1,26 @@
+module Alphavantage
+  class Crypto
+    include HelperFunctions
+
+    def initialize symbol:, datatype: "json", key:, verbose: false, market:
+      check_argument([true, false], verbose, "verbose")
+      @client = return_client(key, verbose)
+      @symbol = symbol
+      @market = market
+      @datatype = datatype
+    end
+
+    attr_accessor :symbol, :market
+    attr_reader :datatype
+
+    def datatype=(datatype)
+      check_argument(["json", "csv"], datatype, "datatype")
+      @datatype = datatype
+    end
+
+    def timeseries type: "intraday", market: @market, file: nil, datatype: @datatype
+      Alphavantage::Crypto_Timeseries.new type: type, market: market,
+        symbol: @symbol, datatype: datatype, file: file, key: @client
+    end
+  end
+end

data/lib/Crypto_Timeseries.rb

@@ -0,0 +1,67 @@
+module Alphavantage
+  class Crypto_Timeseries
+    include HelperFunctions
+
+    def initialize type: "intraday", market:, symbol:, datatype: "json", file: nil,
+      key:, verbose: false
+      check_argument([true, false], verbose, "verbose")
+      @client = return_client(key, verbose)
+      check_argument(["json", "csv"], datatype, "datatype")
+      if datatype == "csv" && file.nil?
+        raise Alphavantage::Error.new message: "No file specified where to save the CSV data"
+      elsif datatype != "csv" && !file.nil?
+        raise Alphavantage::Error.new message: "Hash error: No file necessary"
+      end
+
+      @selected_time_series = which_series(type)
+      url = "function=#{@selected_time_series}&symbol=#{symbol}&market=#{market}"
+      return @client.download(url, file) if datatype == "csv"
+      @hash = @client.request(url)
+      metadata = @hash.dig("Meta Data") || {}
+      metadata.each do |key, val|
+        key_sym = key.downcase.gsub(/[0-9.]/, "").lstrip.gsub(" ", "_").to_sym
+        define_singleton_method(key_sym) do
+          return val
+        end
+      end
+      @open = []; @high = []; @low = []; @close = []; @volume = [];
+      @open_usd = []; @high_usd = []; @low_usd = []; @close_usd = [];
+      @market_cap_usd = [];
+
+      begin
+        time_series = @hash.find{|key, val| key.include?("Time Series")}[1]
+      rescue Exception => e
+        raise Alphavantage::Error.new message: "No Time Series found: #{e.message}",
+          data: @hash
+      end
+
+      series = {}
+      convert_key = {}
+      time_series.values[0].keys.each do |key|
+        key_sym = recreate_metadata_key(key)
+        series[key_sym] = []
+        convert_key[key] = key_sym
+      end
+      time_series.each do |time, ts_hash|
+        ts_hash.each do |key, value|
+          series[convert_key[key]] << [time, value]
+        end
+      end
+      series.keys.each do |key_sym|
+        define_singleton_method(key_sym) do |*args|
+          args ||= []
+          return return_series(series[key_sym], args[0])
+        end
+      end
+    end
+
+    attr_reader :hash
+
+    def which_series(type)
+      check_argument(["intraday", "daily", "weekly", "monthly"], type, "type")
+      series = "DIGITAL_CURRENCY_"
+      series += type.upcase
+      return series
+    end
+  end
+end

data/lib/Errors.rb

@@ -0,0 +1,9 @@
+module Alphavantage
+  class Error < StandardError
+    def initialize(message: , data: nil)
+      @data = data
+      super(message)
+    end
+    attr_reader :data
+  end
+end

data/lib/Exchange.rb

@@ -0,0 +1,23 @@
+module Alphavantage
+  class Exchange
+    include HelperFunctions
+
+    def initialize from:, to:, key:, verbose: false
+      check_argument([true, false], verbose, "verbose")
+      @client = return_client(key, verbose)
+      @from = from
+      @to = to
+      @hash = @client.request("function=CURRENCY_EXCHANGE_RATE&from_currency=#{@from}&to_currency=#{@to}")
+      hash = @hash["Realtime Currency Exchange Rate"]
+      hash.each do |key, val|
+        key_sym = recreate_metadata_key(key)
+        define_singleton_method(key_sym) do
+          return val
+        end
+      end
+    end
+
+    attr_reader :hash
+
+  end
+end

data/lib/Indicator.rb

@@ -0,0 +1,135 @@
+module Alphavantage
+  class Indicator
+    include HelperFunctions
+
+    def initialize function:, symbol:, interval: "daily", time_period: "60",
+      series_type: "close", fastlimit: "0.01", slowlimit: "0.01",
+      fastperiod: "12", slowperiod: "26", signalperiod: "9",
+      fastmatype: "0", slowmatype: "0", signalmatype: "0",
+      fastkperiod: "5", slowkperiod: "3", slowdperiod: "3",
+      slowkmatype: "0", slowdmatype: "0", fastdperiod: "3",
+      fastdmatype: "0", matype: "0", timeperiod1: "7", timeperiod2: "14",
+      timeperiod3: "28", nbdevup: "2", nbdevdn: "2", acceleration: "0.01",
+      maximum: "0.20", key:, verbose: false
+      check_argument([true, false], verbose, "verbose")
+      @client = return_client(key, verbose)
+      check_argument(["SMA", "EMA", "WMA", "DEMA", "TEMA", "TRIMA", "KAMA", "T3",
+        "RSI","MAMA", "MACD", "MACDEXT", "STOCH", "STOCHF", "STOCHRSI", "WILLR",
+        "ADX", "ADXR", "APO", "PPO", "MOM", "BOP", "CCI", "CMO", "ROC", "ROCR",
+        "AROON", "AROONOSC", "MFI", "TRIX", "ULTOSC", "DX", "MINUS_DI",
+        "PLUS_DI", "MINUS_DM", "PLUS_DM", "BBANDS", "MIDPOINT", "MIDPRICE",
+        "SAR", "TRANGE", "ATR", "NATR", "AD", "ADOSC", "OBV", "HT_SINE",
+        "HT_TRENDLINE", "HT_TRENDMODE", "HT_DCPERIOD", "HT_DCPHASE",
+        "HT_PHASOR"], function, "function")
+      url = "function=#{function}&symbol=#{symbol}"
+
+      if ["SMA", "EMA", "WMA", "DEMA", "TEMA", "TRIMA", "KAMA", "T3", "RSI",
+        "MAMA", "MACD", "MACDEXT", "STOCH", "STOCHF", "STOCHRSI", "WILLR",
+        "ADX", "ADXR", "APO", "PPO", "MOM", "BOP", "CCI", "CMO", "ROC", "ROCR",
+        "AROON", "AROONOSC", "MFI", "TRIX", "ULTOSC", "DX", "MINUS_DI",
+        "PLUS_DI", "MINUS_DM", "PLUS_DM", "BBANDS", "MIDPOINT", "MIDPRICE",
+        "SAR", "TRANGE", "ATR", "NATR", "AD", "ADOSC", "OBV", "HT_SINE",
+        "HT_TRENDLINE", "HT_TRENDMODE", "HT_DCPERIOD", "HT_DCPHASE",
+        "HT_PHASOR"].include? function
+        check_argument(["1min", "5min", "15min", "30min", "60min", "daily", "weekly", "monthly"], interval, "interval")
+        url += "&interval=#{interval}"
+      end
+      if ["SMA", "EMA", "WMA", "DEMA", "TEMA", "TRIMA", "KAMA", "T3", "RSI",
+        "STOCHRSI", "WILLR", "ADX", "ADXR", "MOM", "CCI", "CMO", "ROC", "ROCR",
+        "AROON", "AROONOSC", "MFI", "TRIX", "DX", "MINUS_DI", "PLUS_DI",
+        "MINUS_DM", "PLUS_DM", "BBANDS", "MIDPOINT", "MIDPRICE", "ATR",
+        "NATR"].include? function
+        url += return_int_val(time_period, "time_period", "integer")
+      end
+      if ["SMA", "EMA", "WMA", "DEMA", "TEMA", "TRIMA", "KAMA", "T3", "RSI",
+        "MAMA", "MACD", "MACDEXT", "STOCHRSI", "APO", "PPO", "MOM", "ROC",
+        "ROCR", "TRIX", "BBANDS", "MIDPOINT", "HT_SINE", "HT_TRENDLINE",
+        "HT_TRENDMODE", "HT_DCPERIOD", "HT_DCPHASE", "HT_PHASOR", "CMO"].include? function
+        check_argument(["close", "open", "high", "low"], series_type, "series_type")
+        url += "&series_type=#{series_type}"
+      end
+      if ["MAMA"].include? function
+        url += return_int_val(fastlimit, "fastlimit", "float")
+        url += return_int_val(slowlimit, "slowlimit", "float")
+      end
+      if ["MACD", "MACDEXT", "APO", "PPO", "ADOSC"].include? function
+        url += return_int_val(fastperiod, "fastperiod", "integer")
+        url += return_int_val(slowperiod, "slowperiod", "integer")
+      end
+      if ["MACD", "MACDEXT"].include? function
+        url += return_int_val(signalperiod, "signalperiod", "integer")
+      end
+      if ["MACDEXT"].include? function
+        url += return_matype(fastmatype, "fastmatype")
+        url += return_matype(slowmatype, "slowmatype")
+        url += return_matype(signalmatype, "signalmatype")
+      end
+      if ["STOCH", "STOCHF", "STOCHRSI"].include? function
+        url += return_int_val(fastkperiod, "fastkperiod", "integer")
+        url += return_int_val(fastdperiod, "fastdperiod", "integer")
+      end
+      if ["STOCH"].include? function
+        url += return_int_val(slowkperiod, "slowkperiod", "integer")
+        url += return_int_val(signalperiod, "signalperiod", "integer")
+        url += return_matype(slowkmatype, "slowkmatype")
+        url += return_matype(slowdmatype, "slowdmatype")
+      end
+      if ["STOCH", "STOCHF", "STOCHRSI"].include? function
+        url += return_matype(fastdmatype, "fastdmatype")
+      end
+      if ["APO", "PPO", "BBANDS"].include? function
+        url += return_matype(matype, "matype")
+      end
+      if ["ULTOSC"].include? function
+        url += return_int_val(timeperiod1, "timeperiod1", "integer")
+        url += return_int_val(timeperiod2, "timeperiod2", "integer")
+        url += return_int_val(timeperiod3, "timeperiod3", "integer")
+      end
+      if ["BBANDS"].include? function
+        url += return_int_val(nbdevup, "nbdevup", "integer")
+        url += return_int_val(nbdevdn, "nbdevdn", "integer")
+      end
+      if ["SAR"].include? function
+        url += return_int_val(acceleration, "acceleration", "float")
+        url += return_int_val(maximum, "maximum", "float")
+      end
+
+      @hash = @client.request(url)
+      metadata = @hash.dig("Meta Data") || {}
+      metadata.each do |key, val|
+        key_sym = recreate_metadata_key(key)
+        define_singleton_method(key_sym) do
+          return val
+        end
+      end
+
+      begin
+        time_series = @hash.find{|key, val| key.include?("Technical Analysis")}[1]
+      rescue Exception => e
+        raise Alphavantage::Error.new message: "No Time Series found: #{e.message}",
+          data: @hash
+      end
+
+      series = {}
+      convert_key = {}
+      time_series.values[0].keys.each do |key|
+        key_sym = key.downcase.gsub(/[.\/]/, "").lstrip.gsub(" ", "_").to_sym
+        series[key_sym] = []
+        convert_key[key] = key_sym
+      end
+      time_series.each do |time, ts_hash|
+        ts_hash.each do |key, value|
+          series[convert_key[key]] << [time, value]
+        end
+      end
+      series.keys.each do |key_sym|
+        define_singleton_method(key_sym) do |*args|
+          args ||= []
+          return return_series(series[key_sym], args[0])
+        end
+      end
+    end
+
+    attr_reader :hash
+  end
+end

data/lib/Sector.rb

@@ -0,0 +1,34 @@
+module Alphavantage
+  class Sector
+    include HelperFunctions
+
+    def initialize key:, verbose: false
+      check_argument([true, false], verbose, "verbose")
+      @client = return_client(key, verbose)
+      @hash = @client.request("function=SECTOR")
+      metadata = @hash.dig("Meta Data") || {}
+      metadata.each do |key, val|
+        key_sym = key.downcase.gsub(/[0-9.]/, "").lstrip.gsub(" ", "_").to_sym
+        define_singleton_method(key_sym) do
+          return val
+        end
+      end
+      @hash.each do |key, val|
+        next if key == "Meta Data"
+        key = key.split(":")[1].lstrip
+        key = key.split(" ")
+        if key[0].to_i != 0
+          key[0] = key[0].to_i.humanize
+        end
+        key.delete_if{|k| k.include?("(")}
+        key = key.join("_")
+        key_sym = key.downcase.gsub("-", "_").to_sym
+        define_singleton_method(key_sym) do
+          return val
+        end
+      end
+    end
+
+    attr_reader :hash
+  end
+end

data/lib/Stock.rb

@@ -0,0 +1,49 @@
+module Alphavantage
+  class Stock
+    include HelperFunctions
+
+    def initialize symbol:, datatype: "json", key:, verbose: false
+      check_argument([true, false], verbose, "verbose")
+      @client = return_client(key, verbose)
+      @symbol = symbol
+      @datatype = datatype
+    end
+
+    attr_accessor :symbol
+    attr_reader :datatype
+
+    def datatype=(datatype)
+      check_argument(["json", "csv"], datatype, "datatype")
+      @datatype = datatype
+    end
+
+    def timeseries type: "daily", interval: nil, outputsize: "compact",
+      file: nil, datatype: @datatype, adjusted: false
+      Alphavantage::Timeseries.new type: type, interval: interval,
+        outputsize: outputsize, symbol: @symbol, datatype: datatype, file: file,
+        key: @client, adjusted: adjusted
+    end
+
+    def indicator function:, interval: "daily", time_period: "60",
+      series_type: "close", fastlimit: "0.01", slowlimit: "0.01",
+      fastperiod: "12", slowperiod: "26", signalperiod: "9",
+      fastmatype: "0", slowmatype: "0", signalmatype: "0",
+      fastkperiod: "5", slowkperiod: "3", slowdperiod: "3",
+      slowkmatype: "0", slowdmatype: "0", fastdperiod: "3",
+      fastdmatype: "0", matype: "0", timeperiod1: "7", timeperiod2: "14",
+      timeperiod3: "28", nbdevup: "2", nbdevdn: "2", acceleration: "0.01",
+      maximum: "0.20"
+      Alphavantage::Indicator.new function: function, symbol: @symbol,
+        interval: interval, time_period: time_period, series_type: series_type,
+        fastlimit: fastlimit, slowlimit: slowlimit, fastperiod: fastperiod,
+        slowperiod: slowperiod, signalperiod: signalperiod,
+        fastmatype: fastmatype, slowmatype: slowmatype,
+        signalmatype: signalmatype, fastkperiod: fastkperiod, slowkperiod: slowkperiod,
+        slowdperiod: slowdperiod, slowkmatype: slowkmatype, slowdmatype: slowdmatype,
+        fastdperiod: fastdperiod, fastdmatype: fastdmatype, matype: matype,
+        timeperiod1: timeperiod1, timeperiod2: timeperiod2, timeperiod3: timeperiod3,
+        nbdevup: nbdevup, nbdevdn: nbdevdn, acceleration: acceleration,
+        maximum: maximum, key: @client
+    end
+  end
+end

data/lib/Timeseries.rb

@@ -0,0 +1,76 @@
+module Alphavantage
+  class Timeseries
+    include HelperFunctions
+
+    def initialize type: "daily", interval: nil, outputsize: "compact",
+      symbol:, datatype: "json", file: nil, key:, verbose: false,
+      adjusted: false
+      check_argument([true, false], verbose, "verbose")
+      @client = return_client(key, verbose)
+      if type == "intraday"
+        interval ||= "1min"
+        check_argument(["1min", "5min", "15min", "30min", "60min"], interval, "interval")
+        check_argument([false], adjusted, "adjusted")
+        interval = "&interval=#{interval}"
+      else
+        check_argument([nil], interval, "interval")
+        interval = ""
+      end
+      check_argument(["compact", "full"], outputsize, "outputsize")
+      check_argument(["json", "csv"], datatype, "datatype")
+      if datatype == "csv" && file.nil?
+        raise Alphavantage::Error.new message: "No file specified where to save the CSV ata"
+      elsif datatype != "csv" && !file.nil?
+        raise Alphavantage::Error.new message: "Hash error: No file necessary"
+      end
+
+      @selected_time_series = which_series(type, adjusted)
+      url = "function=#{@selected_time_series}&symbol=#{symbol}#{interval}&outputsize=#{outputsize}"
+      return @client.download(url, file) if datatype == "csv"
+      @hash = @client.request(url)
+      metadata = @hash.dig("Meta Data") || {}
+      metadata.each do |key, val|
+        key_sym = recreate_metadata_key(key)
+        define_singleton_method(key_sym) do
+          return val
+        end
+      end
+
+      begin
+        time_series = @hash.find{|key, val| key.include?("Time Series")}[1]
+      rescue Exception => e
+        raise Alphavantage::Error.new message: "No Time Series found: #{e.message}",
+          data: @hash
+      end
+
+      series = {}
+      convert_key = {}
+      time_series.values[0].keys.each do |key|
+        key_sym = key.downcase.gsub(/[0-9.]/, "").lstrip.gsub(" ", "_").to_sym
+        series[key_sym] = []
+        convert_key[key] = key_sym
+      end
+      time_series.each do |time, ts_hash|
+        ts_hash.each do |key, value|
+          series[convert_key[key]] << [time, value]
+        end
+      end
+      series.keys.each do |key_sym|
+        define_singleton_method(key_sym) do |*args|
+          args ||= []
+          return return_series(series[key_sym], args[0])
+        end
+      end
+    end
+
+    attr_reader :hash
+
+    def which_series(type, adjusted)
+      check_argument(["intraday", "daily", "weekly", "monthly"], type, "type")
+      series = "TIME_SERIES_"
+      series += type.upcase
+      series += "_ADJUSTED" if adjusted
+      return series
+    end
+  end
+end