finnhubrb 1.0.0

data/lib/Country.rb

@@ -0,0 +1,17 @@
+module Finnhub
+  class Merge_Country
+    def initialize(client:, country:)
+      @client = client
+      @country = country
+    end
+
+    attr_reader :country
+
+    def merger(from: nil, to: nil)
+      url = "/merger?country=#{@country}"
+      url += "&from=#{from}" unless from.nil?
+      url += "&to=#{to}" unless to.nil?
+      @client.request(url)
+    end
+  end
+end

data/lib/Crypto.rb

@@ -0,0 +1,59 @@
+ module Finnhub
+  class Crypto_Exchange
+    def initialize(client:, name:)
+      @client = client
+      @name = name
+    end
+
+    attr_reader :name
+
+    def symbols(plain: false)
+      output = @client.request("/crypto/symbol?exchange=#{@name}")
+      return output if plain
+
+      output.map do |o|
+        Finnhub::Crypto_Symbol.new(client: @client, exchange: @name, **o)
+      end
+    end
+
+    def symbol(**args)
+      Finnhub::Crypto_Symbol.new(client: @client, exchange: @name, **args)
+    end
+  end
+
+  class Crypto_Symbol
+    include Finnhub::Analysis
+
+    def initialize(client:, exchange:, description: nil, hasWM: nil,
+      displaySymbol: nil, symbol: nil)
+      @client = client
+      @exchange = exchange
+      @hashWM = hasWM
+      @displaySymbol = displaySymbol
+      @symbol = symbol
+    end
+
+    attr_reader :client, :exchange, :hashWM, :displaySymbol, :symbol
+
+    def timeseries(**args)
+      Finnhub::Crypto_Timeseries.new(client: @client, symbol: @symbol, **args)
+    end
+  end
+
+  class Crypto_Timeseries < Finnhub::Timeseries
+    def initialize(client:, symbol:, resolution: "D", count: nil,
+      from: nil, to: nil, format: nil)
+      url = "/crypto/candle?symbol=#{symbol}&resolution=#{resolution}"
+      url += "&count=#{count}" unless count.nil?
+      url += "&from=#{from}" unless from.nil?
+      url += "&to=#{to}" unless to.nil?
+      url += "&format=#{format}" unless format.nil?
+      @output = client.request(url)
+      if @output.is_a?(Hash) && @output[:s] == "ok"
+        @timestamps = @output[:t]&.map{|t| DateTime.strptime(t.to_s,'%s')}
+      else
+        @timestamps = []
+      end
+    end
+  end
+end

data/lib/Economic.rb

@@ -0,0 +1,18 @@
+module Finnhub
+  class Economic_Code
+    def initialize(client:, code:, description:)
+      @client = client
+      @code = code
+      @description = description
+    end
+
+    attr_reader :code, :description
+
+    def data(plain: false)
+      output = @client.request("/economic?code=#{@code}")
+      return output if plain
+
+      output.map{|o| [Time.parse(o[0]), o[1]]}
+    end
+  end
+end

data/lib/Error.rb

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

data/lib/Forex.rb

@@ -0,0 +1,59 @@
+module Finnhub
+  class Forex_Exchange
+    def initialize(client:, name:)
+      @client = client
+      @name = name
+    end
+
+    attr_reader :name
+
+    def symbols(plain: false)
+      output = @client.request("/forex/symbol?exchange=#{@name}")
+      return output if plain
+
+      output.map do |o|
+        Finnhub::Forex_Symbol.new(client: @client, exchange: @name, **o)
+      end
+    end
+
+    def symbol(**args)
+      Finnhub::Forex_Symbol.new(client: @client, exchange: @name, **args)
+    end
+  end
+
+  class Forex_Symbol
+    include Finnhub::Analysis
+
+    def initialize(client:, exchange: nil, description: nil, hasWM: nil,
+      displaySymbol: nil, symbol:)
+      @client = client
+      @exchange = exchange
+      @hashWM = hasWM
+      @displaySymbol = displaySymbol
+      @symbol = symbol
+    end
+
+    attr_reader :client, :exchange, :hashWM, :displaySymbol, :symbol
+
+    def timeseries(**args)
+      Finnhub::Forex_Timeseries.new(client: @client, symbol: @symbol, **args)
+    end
+  end
+
+  class Forex_Timeseries < Finnhub::Timeseries
+    def initialize(client:, symbol:, resolution: "D", count: nil,
+      from: nil, to: nil, format: nil)
+      url = "/forex/candle?symbol=#{symbol}&resolution=#{resolution}"
+      url += "&count=#{count}" unless count.nil?
+      url += "&from=#{from}" unless from.nil?
+      url += "&to=#{to}" unless to.nil?
+      url += "&format=#{format}" unless format.nil?
+      @output = client.request(url)
+      if @output.is_a?(Hash) && @output[:s] == "ok"
+        @timestamps = @output[:t]&.map{|t| DateTime.strptime(t.to_s,'%s')}
+      else
+        @timestamps = []
+      end
+    end
+  end
+end

data/lib/Stock.rb

@@ -0,0 +1,55 @@
+module Finnhub
+  class Stock
+    include Finnhub::Analysis
+
+    def initialize(client:, symbol:)
+      @client = client
+      @symbol = symbol
+    end
+
+    attr_reader :symbol
+
+    def profile
+      @client.request("/stock/profile?symbol=#{@symbol}")
+    end
+
+    def ceo_compensation
+      @client.request("/stock/ceo-compensation?symbol=#{@symbol}")
+    end
+
+    def recommendation
+      @client.request("/stock/recommendation?symbol=#{@symbol}")
+    end
+
+    def price_target
+      @client.request("/stock/price-target?symbol=#{@symbol}")
+    end
+
+    def option_chain
+      @client.request("/stock/option-chain?symbol=#{@symbol}")
+    end
+
+    def peers(plain: false)
+      output = @client.request("/stock/peers?symbol=#{@symbol}")
+      return output if plain
+
+      output.map{|o| Finnhub::Stock.new(client: @client, symbol: o)}
+    end
+
+    def earnings
+      @client.request("/stock/earnings?symbol=#{@symbol}")
+    end
+
+    def news
+      @client.request("/news/#{@symbol}")
+    end
+
+    def sentiment
+      @client.request("/news-sentiment?symbol=#{@symbol}")
+    end
+
+    def timeseries(**args)
+      Finnhub::Timeseries.new(client: @client, stock: self, **args)
+    end
+  end
+end

data/lib/Timeseries.rb

@@ -0,0 +1,55 @@
+module Finnhub
+  class Timeseries
+    def initialize(client:, stock:, resolution: "D", count: 100,
+      from: nil, to: nil, format: nil)
+      url = "/stock/candle?symbol=#{stock.symbol}&resolution=#{resolution}"
+      url += "&count=#{count}" unless count.nil?
+      from = from.to_i if from.is_a?(Time)
+      url += "&from=#{from}" unless from.nil?
+      to = to.to_i if to.is_a?(Time)
+      url += "&to=#{to}" unless to.nil?
+      url += "&format=#{format}" unless format.nil?
+      @output = client.request(url)
+      if @output.is_a?(Hash) && @output[:s] == "ok"
+        @timestamps = @output[:t]&.map{|t| DateTime.strptime(t.to_s,'%s')}
+      else
+        @timestamps = []
+      end
+    end
+
+    attr_reader :output, :timestamps
+
+    def open
+      operation(:o)
+    end
+
+    def high
+      operation(:h)
+    end
+
+    def low
+      operation(:l)
+    end
+
+    def close
+      operation(:c)
+    end
+
+    def volume
+      operation(:v)
+    end
+
+    def status
+      raise Finnhub::Error message: "Output is not a hash" unless @output.is_a?(Hash)
+      @output[:s]
+    end
+
+    private
+
+    def operation(type)
+      raise Finnhub::Error message: "Output is not a hash" unless @output.is_a?(Hash)
+      return [] if @output[type].nil?
+      @timestamps.zip(@output[type])
+    end
+  end
+end

data/lib/Websocket.rb

@@ -0,0 +1,29 @@
+module Finnhub
+  class Websocket < Faye::WebSocket::Client
+    def initialize(apikey)
+      super("wss://ws.finnhub.io?token=#{apikey}")
+    end
+
+    def subscribe(symbol)
+      case symbol
+      when Finnhub::Stock, Finnhub::Crypto_Symbol, Finnhub::Forex_Symbol
+        symbol = symbol.symbol
+      end
+
+      send(Oj.dump(
+        {"type": "subscribe", "symbol": symbol},
+        mode: :json))
+    end
+
+    def unsubscribe(symbol)
+      case symbol
+      when Finnhub::Stock, Finnhub::Crypto_Symbol, Finnhub::Forex_Symbol
+        symbol = symbol.symbol
+      end
+
+      send(Oj.dump(
+        {"type": "unsubscribe", "symbol": symbol},
+        mode: :json))
+    end
+  end
+end

data/lib/finnhubrb.rb

@@ -0,0 +1,16 @@
+require "oj"
+require "httparty"
+require "time"
+require 'em/pure_ruby'
+require "faye/websocket"
+require_relative "Analysis"
+require_relative "Calendar"
+require_relative "Timeseries"
+require_relative "Client"
+require_relative "Country"
+require_relative "Crypto"
+require_relative "Economic"
+require_relative "Error"
+require_relative "Forex"
+require_relative "Stock"
+require_relative "Websocket"

data/spec/1.0.0/crypto.rb

@@ -0,0 +1,84 @@
+require_relative '../spec_helper'
+
+describe "1.0.0" do
+  context "Crypto" do
+    it "create a new client" do
+      @store[:client] = Finnhub::Client.new(key: @key, verbose: true)
+      expect(@store[:client].class).to be Finnhub::Client
+    end
+
+    it "can retrieve multiple crypto_exchanges" do
+      crypto_exchanges = @store[:client].crypto_exchanges(plain: true)
+      expect(crypto_exchanges.class).to be Array
+
+      @store[:crypto_exchange_name] = crypto_exchanges[0]
+
+      crypto_exchanges = @store[:client].crypto_exchanges
+      expect(crypto_exchanges.class).to be Array
+      expect(crypto_exchanges[0].class).to be Finnhub::Crypto_Exchange
+    end
+
+    it "can create a crypto_exchange instance" do
+      @store[:crypto_exchange] = @store[:client].crypto_exchange(name: @store[:crypto_exchange_name])
+      expect(@store[:crypto_exchange].class).to be Finnhub::Crypto_Exchange
+    end
+
+    it "can retrieve multiple symbols" do
+      crypto_symbols = @store[:crypto_exchange].symbols(plain: true)
+      expect(crypto_symbols.class).to be Array
+
+      @store[:crypto_exchange_symbol] = crypto_symbols[0][:symbol]
+
+      crypto_symbols = @store[:crypto_exchange].symbols
+      expect(crypto_symbols.class).to be Array
+      expect(crypto_symbols[0].class).to be Finnhub::Crypto_Symbol
+    end
+
+    it "create a new crypto_symbol" do
+      @store[:crypto_symbol] = @store[:crypto_exchange].symbol(symbol: @store[:crypto_exchange_symbol])
+      expect(@store[:crypto_symbol].class).to be Finnhub::Crypto_Symbol
+    end
+
+
+    it "can retrieve timeseries" do
+      timeseries = @store[:crypto_symbol].timeseries(count: 100)
+      expect(timeseries.open.class).to be Array
+      expect(timeseries.high.class).to be Array
+      expect(timeseries.low.class).to be Array
+      expect(timeseries.close.class).to be Array
+      expect(timeseries.volume.class).to be Array
+      expect(timeseries.status).to eq "ok"
+      expect(timeseries.output.class).to be Hash
+
+      timeseries = @store[:crypto_symbol].timeseries(resolution: 60, from: Time.now-24*30*3600, to: Time.now)
+      expect(timeseries.open.class).to be Array
+      expect(timeseries.status).to eq "ok"
+
+      timeseries = @store[:crypto_symbol].timeseries(resolution: 60, from: Time.now-24*30*3600, to: Time.now, format: "csv")
+      expect(timeseries.output.class).to be String
+
+      error = nil
+      begin
+        @store[:crypto_symbol].timeseries(resolution: 60, from: Time.now-24*30*3600, to: Time.now, format: "wrong")
+      rescue Finnhub::Error => e
+        error = e
+      end
+      expect(error.class).to be Finnhub::Error
+    end
+
+    it "can retrieve pattern" do
+      output = @store[:crypto_symbol].pattern
+      expect(output[:points][0].key?(:symbol)).to eq true
+    end
+
+    it "can retrieve support_resistance" do
+      output = @store[:crypto_symbol].support_resistance
+      expect(output.key?(:levels)).to be true
+    end
+
+    it "can retrieve technical_indicators" do
+      output = @store[:crypto_symbol].technical_indicators
+      expect(output.key?(:technicalAnalysis)).to be true
+    end
+  end
+end

data/spec/1.0.0/forex.rb

@@ -0,0 +1,84 @@
+require_relative '../spec_helper'
+
+describe "1.0.0" do
+  context "Forex" do
+    it "create a new client" do
+      @store[:client] = Finnhub::Client.new(key: @key, verbose: true)
+      expect(@store[:client].class).to be Finnhub::Client
+    end
+
+    it "can retrieve multiple forex_exchanges" do
+      forex_exchanges = @store[:client].forex_exchanges(plain: true)
+      expect(forex_exchanges.class).to be Array
+
+      @store[:forex_exchange_name] = forex_exchanges[0]
+
+      forex_exchanges = @store[:client].forex_exchanges
+      expect(forex_exchanges.class).to be Array
+      expect(forex_exchanges[0].class).to be Finnhub::Forex_Exchange
+    end
+
+    it "can create a forex_exchange instance" do
+      @store[:forex_exchange] = @store[:client].forex_exchange(name: @store[:forex_exchange_name])
+      expect(@store[:forex_exchange].class).to be Finnhub::Forex_Exchange
+    end
+
+    it "can retrieve multiple symbols" do
+      forex_symbols = @store[:forex_exchange].symbols(plain: true)
+      expect(forex_symbols.class).to be Array
+
+      @store[:forex_exchange_symbol] = forex_symbols[0][:symbol]
+
+      forex_exchanges = @store[:forex_exchange].symbols
+      expect(forex_exchanges.class).to be Array
+      expect(forex_exchanges[0].class).to be Finnhub::Forex_Symbol
+    end
+
+    it "create a new forex_symbol" do
+      @store[:forex_symbol] = @store[:forex_exchange].symbol(symbol: @store[:forex_exchange_symbol])
+      expect(@store[:forex_symbol].class).to be Finnhub::Forex_Symbol
+    end
+
+
+    it "can retrieve timeseries" do
+      timeseries = @store[:forex_symbol].timeseries(count: 100)
+      expect(timeseries.open.class).to be Array
+      expect(timeseries.high.class).to be Array
+      expect(timeseries.low.class).to be Array
+      expect(timeseries.close.class).to be Array
+      expect(timeseries.volume.class).to be Array
+      expect(timeseries.status).to eq "ok"
+      expect(timeseries.output.class).to be Hash
+
+      timeseries = @store[:forex_symbol].timeseries(resolution: 60, from: Time.now-24*30*3600, to: Time.now)
+      expect(timeseries.open.class).to be Array
+      expect(["ok", "no_data"]).to include timeseries.status
+
+      timeseries = @store[:forex_symbol].timeseries(resolution: 60, from: Time.now-24*30*3600, to: Time.now, format: "csv")
+      expect(timeseries.output.class).to be String
+
+      error = nil
+      begin
+        @store[:forex_symbol].timeseries(resolution: 60, from: Time.now-24*30*3600, to: Time.now, format: "wrong")
+      rescue Finnhub::Error => e
+        error = e
+      end
+      expect(error.class).to be Finnhub::Error
+    end
+
+    it "can retrieve pattern" do
+      output = @store[:forex_symbol].pattern
+      expect(output[:points][0].key?(:symbol)).to eq true
+    end
+
+    it "can retrieve support_resistance" do
+      output = @store[:forex_symbol].support_resistance
+      expect(output.key?(:levels)).to be true
+    end
+
+    it "can retrieve technical_indicators" do
+      output = @store[:forex_symbol].technical_indicators
+      expect(output.key?(:technicalAnalysis)).to be true
+    end
+  end
+end