eodhd.rb 0.13.4 → 0.13.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7c96a54dc7124036098037626b7356f343bb1f43d647b1c17c16b4e9e11cd6c6
-  data.tar.gz: 71c645d8e47a50971d44b1742e727ebe1497d312fd0ccf4af504aa796147964a
+  metadata.gz: babe78e5a3c016dc6ec370660e5a2dda227f75458fc0519a411784923c00fb13
+  data.tar.gz: 7b9221fc1b1035ddf2b20263d99a7af7a21989cc77f664f4475c7942904307c1
 SHA512:
-  metadata.gz: b20d4cddf4eee55eb6c99600e54618ab9fb236c2a0b00a593f838eaace88d0d7278994c1ad8019ff7db5b53525aff16b1a9b20c820a5e40ae371e14b2c097ec7
-  data.tar.gz: fcabde4719ecd553972d3fedaa29652435e0007813c4cb538b0065f199c427e4a4ba7e38774c22c8c9edc1a4245b3816e9daca404ab4f5f1476d1fa227dad7fe
+  metadata.gz: 93761d6297db80a6e6a206a30cf3e653634d569ae4a0bf8a90389aaba840994a487ea317ec40683b866ffd4b7bf118009f40b9574c3022b7c4ef2290727b4a56
+  data.tar.gz: fe98cf25eea41c380e2365bedb578761b4a95e6044e9e09e1c9007b0e3c921def3081fd06ff48622df2e2db79b296bae991fe7be3d55aa64c66ee2a0e08ef15b

data/eodhd.rb.gemspec

@@ -1,8 +1,8 @@
 Gem::Specification.new do |spec|
   spec.name = 'eodhd.rb'
 
-  spec.version = '0.13.4'
-  spec.date = '2024-10-09'
+  spec.version = '0.13.6'
+  spec.date = '2025-03-19'
 
   spec.summary = "Access the eodhd.com API with Ruby."
   spec.description = "Access the eodhd.com API with Ruby."

data/lib/Eodhd/Client.rb

@@ -1,6 +1,7 @@
 # Eodhd/Client.rb
 # Eodhd::Client
 
+require 'fileutils'
 require 'Hash/x_www_form_urlencode'
 gem 'http.rb'
 require 'http.rb'
@@ -8,17 +9,40 @@ require 'json'
 require 'logger'
 
 class Eodhd
+  class Error < RuntimeError
+    attr_reader :code, :message, :body
+
+    private
+
+    def initialize(code:, message:, body:)
+      @code = code
+      @message = message
+      @body = body
+    end
+  end
+
   class Client
 
     API_HOST = 'eodhd.com'
 
     class << self
-      def log_filename
-        File.expand_path('~/log/eodhd/log.txt')
+      attr_writer :log_file_path
+
+      def path_prefix
+        '/api'
+      end
+
+      def default_log_file_path
+        File.join(%w{~ log eodhd log.txt})
+      end
+
+      def log_file_path
+        File.expand_path(@log_file_path || default_log_file_path)
       end
 
       def log_file
-        File.open(log_filename, File::WRONLY | File::APPEND | File::CREAT)
+        FileUtils.mkdir_p(File.dirname(log_file_path))
+        File.open(log_file_path, File::WRONLY | File::APPEND | File::CREAT)
       end
 
       def logger
@@ -28,27 +52,27 @@ class Eodhd
 
     # 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))
+      response = get(path: '/exchanges-list'))
+      handle_response(response)
     end
 
     def exchange_symbol_list(exchange_code:)
-      path = "/api/exchange-symbol-list/#{exchange_code}"
-      do_request(request_string: request_string(path))
+      response = get(path: "/exchange-symbol-list/#{exchange_code}")
+      handle_response(response)
     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)
+      response = get(path: "/eod/#{symbol}.#{exchange_id}", args: args)
+      handle_response(response)
     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)
+      response = get(path: "/eod-bulk-last-day/#{exchange_id}", args: args)
+      handle_response(response)
     end
 
     private
@@ -58,28 +82,43 @@ class Eodhd
     end
 
     def request_string(path)
-      "https://#{API_HOST}#{path}"
+      "https://#{API_HOST}#{self.class.path_prefix}#{path}"
     end
 
     def log_args?(args)
       !args.values.all?(&:nil?)
     end
 
-    def log(request_string:, args:)
-      log_string = "GET #{request_string}"
+    def log(verb:, request_string:, args:)
+      log_string = "#{verb} #{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)
+    def do_request(verb:, path:, args: {})
+      log(verb: verb, request_string: request_string(path), 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)
+      HTTP.send(verb.to_s.downcase, request_string(path), args)
+    end
+
+    def get(path:, args: {})
+      do_request(verb: 'GET', path: path, args: args)
+    end
+
+    def handle_response(response)
+      if response.success?
+        JSON.parse(response.body)
+      else
+        raise Eodhd::Error.new(
+          code: response.code,
+          message: response.message,
+          body: response.body,
+        )
+      end
     end
   end
 end

data/lib/eodhd.rb

@@ -1,8 +1,8 @@
 # Eodhd.rb
 # Eodhd
 
-# 20241009
-# 0.13.4
+# 20250319
+# 0.13.6
 
 # Changes since 0.12:
 # -/0: Add logging.
@@ -18,14 +18,26 @@
 # 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
+# 10. + Eodhd::Client#log_args? Only need to check for whether the values are nil, since this will still work for empty args also.
+# 11. ~ Eodhd::Client#log: Use log_args?
+# 3/4: + eodhd.rb.gemspec, + additional necessary library files
+# 12. + eodhd.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
+# 4/5: Create a directory for the log file when running for the first time and also allow specification of the log file path.
+# 17. ~ Eodhd::Client#log_file: Create the log file directory if necessary.
+# 18. ~ Eodhd::Client: + attr_writer :log_file_path
+# 19. + Eodhd::Client#default_log_file_path
+# 20. ~ Eodhd::Client: /log_filename/log_file_path/
+# 5/6: Error handling for HTTP responses.
+# 21. + Eodhd::Client#handle_response
+# 22. + Eodhd::Client#get
+# 23. ~ Eodhd::Client#do_request: Accepts a verb and a path now as well as arguments, instead of a request string and arguments.
+# 23. + Eodhd::Error
+# 24. ~ Eodhd::Client#log: + verb argument
+# 25. ~ Eodhd::Client public methods: Use get() and handle_response().
 
 require_relative 'Eodhd/Client'
 require_relative 'Eodhd/EodBulkLastDay'

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: eodhd.rb
 version: !ruby/object:Gem::Version
-  version: 0.13.4
+  version: 0.13.6
 platform: ruby
 authors:
 - thoran
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-09 00:00:00.000000000 Z
+date: 2025-03-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http.rb
@@ -46,7 +45,6 @@ homepage: http://github.com/thoran/eodhd.rb
 licenses:
 - Ruby
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -61,8 +59,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.21
-signing_key:
+rubygems_version: 3.6.5
 specification_version: 4
 summary: Access the eodhd.com API with Ruby.
 test_files: []