eodhd.rb 0.13.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7c96a54dc7124036098037626b7356f343bb1f43d647b1c17c16b4e9e11cd6c6
+  data.tar.gz: 71c645d8e47a50971d44b1742e727ebe1497d312fd0ccf4af504aa796147964a
+SHA512:
+  metadata.gz: b20d4cddf4eee55eb6c99600e54618ab9fb236c2a0b00a593f838eaace88d0d7278994c1ad8019ff7db5b53525aff16b1a9b20c820a5e40ae371e14b2c097ec7
+  data.tar.gz: fcabde4719ecd553972d3fedaa29652435e0007813c4cb538b0065f199c427e4a4ba7e38774c22c8c9edc1a4245b3816e9daca404ab4f5f1476d1fa227dad7fe

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/README.md

@@ -0,0 +1,73 @@
+# eodhd.rb
+
+## Description
+
+Access the eodhd.com API with Ruby.
+
+## Installation
+
+Add this line to your application's Gemfile:
+```ruby
+  gem 'eodhd.rb'
+```
+And then execute:
+```bash
+  $ bundle
+```
+Or install it yourself as:
+```bash
+  $ gem install eodhd.rb
+```
+
+## Usage
+
+### Setup
+```ruby
+api_token = 'api_token'
+eodhd_api ||= Eodhd.new(api_token: api_token)
+```
+
+### List of Exchanges
+```ruby
+eodhd_api.exchanges
+```
+
+### List of Exchange Symbols
+```ruby
+exchange = eodhd_api.exchanges.first
+
+eod_api.exchange_symbols(exchange: exchange)
+# OR
+eod_api.exchange_symbols(exchange_code: exchange.code)
+```
+
+### Retrieve EOD Data For One Symbol
+```ruby
+exchange = eodhd_api.exchanges.first
+exchange_symbol = eod_api.exchange_symbols(exchange: exchange).first
+
+eod_api.eod_data(exchange: exchange, exchange_symbol: exchange_symbol)
+# OR
+eod_api.eod_data(exchange_code: exchange.code, exchange_symbol: exchange_symbol)
+# OR
+eod_api.eod_data(exchange: exchange, symbol: exchange_symbol.code)
+# OR
+eod_api.eod_data(exchange_code: exchange.code, symbol: exchange_symbol.code)
+```
+
+### Retrieve EOD Data For Multiple Symbols For One Date
+```ruby
+exchange = eodhd_api.exchanges.first
+
+eod_api.eod_bulk_last_day(exchange: exchange, date: Date.today)
+# OR
+eod_api.eod_bulk_last_day(exchange_code: exchange.code, date: Date.today)
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/thoran/eodhd.rb/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new pull request

data/eodhd.rb.gemspec

@@ -0,0 +1,26 @@
+Gem::Specification.new do |spec|
+  spec.name = 'eodhd.rb'
+
+  spec.version = '0.13.4'
+  spec.date = '2024-10-09'
+
+  spec.summary = "Access the eodhd.com API with Ruby."
+  spec.description = "Access the eodhd.com API with Ruby."
+
+  spec.author = 'thoran'
+  spec.email = 'code@thoran.com'
+  spec.homepage = 'http://github.com/thoran/eodhd.rb'
+  spec.license = 'Ruby'
+
+  spec.required_ruby_version = '>= 2.5'
+
+  spec.add_dependency('http.rb')
+  spec.files = [
+    'eodhd.rb.gemspec',
+    'Gemfile',
+    Dir['lib/**/*.rb'],
+    'README.md',
+    Dir['test/**/*.rb']
+  ].flatten
+  spec.require_paths = ['lib']
+end

data/lib/Eodhd/Client.rb

@@ -0,0 +1,85 @@
+# Eodhd/Client.rb
+# Eodhd::Client
+
+require 'Hash/x_www_form_urlencode'
+gem 'http.rb'
+require 'http.rb'
+require 'json'
+require 'logger'
+
+class Eodhd
+  class Client
+
+    API_HOST = 'eodhd.com'
+
+    class << self
+      def log_filename
+        File.expand_path('~/log/eodhd/log.txt')
+      end
+
+      def log_file
+        File.open(log_filename, File::WRONLY | File::APPEND | File::CREAT)
+      end
+
+      def logger
+        @logger ||= Logger.new(log_file, 'daily')
+      end
+    end # class << self
+
+    # This endpoint always returns json regardless of what fmt is specified.
+    def exchanges_list
+      path = "/api/exchanges-list"
+      do_request(request_string: request_string(path))
+    end
+
+    def exchange_symbol_list(exchange_code:)
+      path = "/api/exchange-symbol-list/#{exchange_code}"
+      do_request(request_string: request_string(path))
+    end
+
+    def eod_data(exchange_id:, symbol:, period:, from: nil, to: nil)
+      path = "/api/eod/#{symbol}.#{exchange_id}"
+      args = {period: period}
+      args.merge!(from: from) if from
+      args.merge!(to: to) if to
+      do_request(request_string: request_string(path), args: args)
+    end
+
+    def eod_bulk_last_day(exchange_id:, date:)
+      path = "/api/eod-bulk-last-day/#{exchange_id}"
+      args = {date: date}
+      do_request(request_string: request_string(path), args: args)
+    end
+
+    private
+
+    def initialize(api_token:)
+      @api_token = api_token
+    end
+
+    def request_string(path)
+      "https://#{API_HOST}#{path}"
+    end
+
+    def log_args?(args)
+      !args.values.all?(&:nil?)
+    end
+
+    def log(request_string:, args:)
+      log_string = "GET #{request_string}"
+      if log_args?(args)
+        log_string << "?#{args.x_www_form_urlencode}"
+      end
+      self.class.logger.info(log_string)
+    end
+
+    def do_request(request_string:, args: {})
+      log(request_string: request_string, args: args)
+      api_token = args[:api_token] || @api_token
+      fmt = args[:fmt] || 'json'
+      args.merge!(api_token: api_token, fmt: fmt)
+      response = HTTP.get(request_string, args)
+      JSON.parse(response.body)
+    end
+  end
+end

data/lib/Eodhd/EodBulkLastDay.rb

@@ -0,0 +1,54 @@
+# Eodhd/EodBulkLastDay.rb
+# Eodhd::EodBulkLastDay
+
+class Eodhd
+  class EodBulkLastDay
+    class << self
+      def all(client: nil, api_token: nil, exchange_code:, date:)
+        load(client: client, api_token: api_token, exchange_code: exchange_code, date:)
+      end
+
+      private
+
+      def load(client: nil, api_token: nil, exchange_code:, date:)
+        client ||= Client.new(api_token: api_token)
+        client.eod_bulk_last_day(exchange_id: exchange_code, date: date).collect do |eod_bulk_last_day|
+          self.new(
+            code: eod_bulk_last_day['code'],
+            exchange_short_name: eod_bulk_last_day['exchange_short_name'],
+            date: eod_bulk_last_day['date'],
+            open: eod_bulk_last_day['open'],
+            high: eod_bulk_last_day['high'],
+            low: eod_bulk_last_day['low'],
+            close: eod_bulk_last_day['close'],
+            adjusted_close: eod_bulk_last_day['adjusted_close'],
+            volume: eod_bulk_last_day['volume']
+          )
+        end
+      end
+    end # class << self
+
+    attr_reader\
+      :code,
+      :exchange_short_name,
+      :date,
+      :open,
+      :high,
+      :low,
+      :close,
+      :adjusted_close,
+      :volume
+
+    def initialize(code:, exchange_short_name:, date:, open:, high:, low:, close:, adjusted_close:, volume:)
+      @code = code
+      @exchange_short_name = exchange_short_name
+      @date = date
+      @open = open
+      @high = high
+      @low = low
+      @close = close
+      @adjusted_close = adjusted_close
+      @volume = volume
+    end
+  end
+end

data/lib/Eodhd/EodData.rb

@@ -0,0 +1,54 @@
+# Eodhd/EodData.rb
+# Eodhd::EodData
+
+class Eodhd
+  class EodData
+    class << self
+      def all(client: nil, api_token: nil, exchange_code:, symbol:, period: 'd', from: nil, to: nil)
+        load(client: client, api_token: api_token, exchange_code: exchange_code, symbol: symbol, period: period, from: from, to: to)
+      end
+
+      private
+
+      def load(client: nil, api_token: nil, exchange_code:, symbol:, period:, from:, to:)
+        client ||= Client.new(api_token: api_token)
+        client.eod_data(exchange_id: exchange_code, symbol: symbol, period: period, from: from, to: to).collect do |eod_data|
+          self.new(
+            exchange_code: eod_data['exchange_code'],
+            symbol: eod_data['symbol'],
+            date: eod_data['date'],
+            open: eod_data['open'],
+            high: eod_data['high'],
+            low: eod_data['low'],
+            close: eod_data['close'],
+            adjusted_close: eod_data['adjusted_close'],
+            volume: eod_data['volume']
+          )
+        end
+      end
+    end # class << self
+
+    attr_reader\
+      :exchange_code,
+      :symbol,
+      :date,
+      :open,
+      :high,
+      :low,
+      :close,
+      :adjusted_close,
+      :volume
+
+    def initialize(exchange_code:, symbol:, date:, open:, high:, low:, close:, adjusted_close:, volume:)
+      @exchange_code = exchange_code
+      @symbol = symbol
+      @date = date
+      @open = open
+      @high = high
+      @low = low
+      @close = close
+      @adjusted_close = adjusted_close
+      @volume = volume
+    end
+  end
+end

data/lib/Eodhd/Exchange.rb

@@ -0,0 +1,48 @@
+# Eodhd/Exchange.rb
+# Eodhd::Exchange
+
+class Eodhd
+  class Exchange
+    class << self
+      def all(client: nil, api_token: nil)
+        load(client: client, api_token: api_token)
+      end
+
+      private
+
+      def load(client: nil, api_token: nil)
+        client ||= Client.new(api_token: api_token)
+        client.exchanges_list.collect do |exchange|
+          self.new(
+            name: exchange['Name'],
+            code: exchange['Code'],
+            operating_mic: exchange['OperatingMIC'],
+            country: exchange['Country'],
+            currency: exchange['Currency'],
+            country_iso2: exchange['CountryISO2'],
+            country_iso3: exchange['CountryISO3']
+          )
+        end
+      end
+    end # class << self
+
+    attr_reader\
+      :name,
+      :code,
+      :operating_mic,
+      :country,
+      :currency,
+      :country_iso2,
+      :country_iso3
+
+    def initialize(name:, code:, operating_mic:, country:, currency:, country_iso2:, country_iso3:)
+      @name = name
+      @code = code
+      @operating_mic = operating_mic
+      @country = country
+      @currency = currency
+      @country_iso2 = country_iso2
+      @country_iso3 = country_iso3
+    end
+  end
+end

data/lib/Eodhd/ExchangeSymbol.rb

@@ -0,0 +1,48 @@
+# Eodhd/ExchangeSymbol.rb
+# Eodhd::ExchangeSymbol
+
+class Eodhd
+  class ExchangeSymbol
+    class << self
+      def all(client: nil, api_token: nil, exchange_code: nil)
+        load(client: client, api_token: api_token, exchange_code: exchange_code)
+      end
+
+      private
+
+      def load(client: nil, api_token: nil, exchange_code: nil)
+        client ||= Client.new(api_token: api_token)
+        client.exchange_symbol_list(exchange_code: exchange_code).collect do |symbol|
+          self.new(
+            code: symbol['Code'],
+            name: symbol['Name'],
+            country: symbol['Country'],
+            exchange: symbol['Exchange'],
+            currency: symbol['Currency'],
+            type: symbol['Type'],
+            isin: symbol['Isin']
+          )
+        end
+      end
+    end # class << self
+
+    attr_reader\
+      :code,
+      :name,
+      :country,
+      :exchange,
+      :currency,
+      :type,
+      :isin
+
+    def initialize(code:, name:, country:, exchange:, currency:, type:, isin:)
+      @code = code
+      @name = name
+      @country = country
+      @exchange = exchange
+      @currency = currency
+      @type = type
+      @isin = isin
+    end
+  end
+end

data/lib/Hash/x_www_form_urlencode.rb

@@ -0,0 +1,7 @@
+# Hash/x_www_form_urlencode.rb
+# Hash#x_www_form_urlencode
+
+# 20241009
+# 0.1.0
+
+require 'Thoran/Hash/XWwwFormUrlencode/x_www_form_urlencode'

data/lib/Thoran/Hash/XWwwFormUrlencode/x_www_form_urlencode.rb

@@ -0,0 +1,26 @@
+# Thoran/Hash/XWwwFormUrlEncode/x_www_form_urlencode.rb
+# Thoran::Hash::XWwwFormUrlEncode#x_www_form_urlencode
+
+# 20241009
+# 0.2.0
+
+# Changes since 0.1:
+# -/0: (The class name and the snake case name are consistent now.)
+# 1. /XWWWFormUrlEncode/XWwwFormUrlEncode/
+
+require 'Thoran/String/UrlEncode/url_encode'
+
+module Thoran
+  module Hash
+    module XWwwFormUrlEncode
+
+      def x_www_form_url_encode(joiner = '&')
+        inject([]){|a,e| a << "#{e.first.to_s.url_encode}=#{e.last.to_s.url_encode}" unless e.last.nil?; a}.join(joiner)
+      end
+      alias_method :x_www_form_urlencode, :x_www_form_url_encode
+
+    end
+  end
+end
+
+Hash.send(:include, Thoran::Hash::XWwwFormUrlEncode)

data/lib/Thoran/String/UrlEncode/url_encode.rb

@@ -0,0 +1,26 @@
+# Thoran/String/UrlEncode/url_encode.rb
+# Thoran::String::UrlEncode#url_encode
+
+# 20160505
+# 0.3.0
+
+# Acknowledgements: I've simply ripped off and refashioned the code from the CGI module!...
+
+# Changes since 0.2:
+# 1. + Thoran namespace.
+
+module Thoran
+  module String
+    module UrlEncode
+
+      def url_encode
+        self.gsub(/([^ a-zA-Z0-9_.-]+)/n) do
+          '%' + $1.unpack('H2' * $1.size).join('%').upcase
+        end.tr(' ', '+')
+      end
+
+    end
+  end
+end
+
+String.send(:include, Thoran::String::UrlEncode)

data/lib/eodhd.rb

@@ -0,0 +1,60 @@
+# Eodhd.rb
+# Eodhd
+
+# 20241009
+# 0.13.4
+
+# Changes since 0.12:
+# -/0: Add logging.
+# 1. + require 'logger'
+# 2. + Eodhd::Client.log_filename
+# 3. + Eodhd::Client.log_file
+# 4. + Eodhd::Client.logger
+# 5. + Eodhd::Client#log
+# 6. ~ Eodhd::Client#do_request: Call log().
+# 0/1: Add args to the log string.
+# 7. ~ Eodhd::Client#do_request: Add the args to the log string.
+# 1/2: Log '?' and args only if args are present.
+# 8. ~ Eodhd::Client#log: Construct the log string in the method, constructing a log string with arguments if present.
+# 9. ~ Eodhd::Client#do_request: Call the new interface for log().
+# 2/3: Fix logging '?' for when args values are nil.
+# 10. + Eod::Client#log_args? Only need to check for whether the values are nil, since this will still work for empty args also.
+# 11. ~ Eod::Client#log: Use log_args?
+# 3/4: + eod.rb.gemspec, + additional necessary library files
+# 12. + eod.rb.gemspec
+# 13. ~ Gemfile: Use gemspec.
+# 14. + lib/Hash/x_www_form_urlencode.rb
+# 15. + lib/Thoran/Hash/XWwwFormUrlEncode/x_www_form_url_encode.rb
+# 16. + lib/Thoran/String/UrlEncode/url_encode.rb
+
+require_relative 'Eodhd/Client'
+require_relative 'Eodhd/EodBulkLastDay'
+require_relative 'Eodhd/EodData'
+require_relative 'Eodhd/Exchange'
+require_relative 'Eodhd/ExchangeSymbol'
+
+class Eodhd
+  def initialize(api_token:)
+    @api_token = api_token
+  end
+
+  def exchanges
+    Eodhd::Exchange.all(api_token: @api_token)
+  end
+
+  def exchange_symbols(exchange: nil, exchange_code: nil)
+    exchange_code ||= exchange.code
+    Eodhd::ExchangeSymbol.all(api_token: @api_token, exchange_code: exchange_code)
+  end
+
+  def eod_data(exchange: nil, exchange_code: nil, exchange_symbol: nil, symbol: nil, period: nil, from: nil, to: nil)
+    exchange_code ||= exchange.code
+    symbol ||= exchange_symbol.code
+    Eodhd::EodData.all(api_token: @api_token, exchange_code: exchange_code, symbol: symbol, period: period, from: from, to: to)
+  end
+
+  def eod_bulk_last_day(exchange: nil, exchange_code: nil, date:)
+    exchange_code ||= exchange.code
+    Eodhd::EodBulkLastDay.all(api_token: @api_token, exchange_code: exchange_code, date: date)
+  end
+end

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification
+name: eodhd.rb
+version: !ruby/object:Gem::Version
+  version: 0.13.4
+platform: ruby
+authors:
+- thoran
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-10-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: http.rb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Access the eodhd.com API with Ruby.
+email: code@thoran.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- README.md
+- eodhd.rb.gemspec
+- lib/Eodhd/Client.rb
+- lib/Eodhd/EodBulkLastDay.rb
+- lib/Eodhd/EodData.rb
+- lib/Eodhd/Exchange.rb
+- lib/Eodhd/ExchangeSymbol.rb
+- lib/Hash/x_www_form_urlencode.rb
+- lib/Thoran/Hash/XWwwFormUrlencode/x_www_form_urlencode.rb
+- lib/Thoran/String/UrlEncode/url_encode.rb
+- lib/eodhd.rb
+homepage: http://github.com/thoran/eodhd.rb
+licenses:
+- Ruby
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.5'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.21
+signing_key:
+specification_version: 4
+summary: Access the eodhd.com API with Ruby.
+test_files: []