eodhd.rb 0.13.5 → 0.13.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 72b64180485bc086dd1306c1269feaf9a3bd10fe7ad7a43da2c1731043004908
-  data.tar.gz: 8fb6a353e72d30bc9dec792a2ce4f356b74a4e62506887f09d56b2d4ba68ec4d
+  metadata.gz: afa9158cc3f9bb4c08a8d547cd2011ed7291e04f5e4b2ecba57bec99c0423a20
+  data.tar.gz: '0209d6df466503644d89e99bcc8c55a717707cbf466524de79e53dcb834bfacd'
 SHA512:
-  metadata.gz: 37ae6f52d8be92689d04a2b695d505c11ddd083b9f7d15d41ba9b367a27b8b1c3f61868055832c38257bef95bb282e051f0a3838f8aab18f3f266927d7c1ab0c
-  data.tar.gz: 0e9a591954d3a57e89c7e106ff09769e67d6aa5936fc5904b9de96d4eb499cd01d5c70564ef389b1dd504f3bfe0cd53cd088b6c70972703cd044c5f2496d6bb1
+  metadata.gz: a4e8a34f9f8fbc6abc74abbbfa2d66efe96a3b18c9a6092ffc775484068ccf36b93168a690d04634f5723f156d3bdf87f5e2943b8ec5e4ce660de1519a50dc83
+  data.tar.gz: b87d229a34f838e524ac7d67ec9d4171087f708080700a797572a3913d859f33d8a7bab10aa5b0d9f71d77aad5814500ef66eac2f57e74a1e139f04c4065cd2b

data/eodhd.rb.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |spec|
   spec.name = 'eodhd.rb'
 
-  spec.version = '0.13.5'
+  spec.version = '0.13.7'
   spec.date = '2025-03-19'
 
   spec.summary = "Access the eodhd.com API with Ruby."

data/lib/Eodhd/Client.rb

@@ -9,6 +9,18 @@ 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'
@@ -16,6 +28,10 @@ class Eodhd
     class << self
       attr_writer :log_file_path
 
+      def path_prefix
+        '/api'
+      end
+
       def default_log_file_path
         File.join(%w{~ log eodhd log.txt})
       end
@@ -36,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
@@ -66,28 +82,53 @@ 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_request(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 log_error(code:, message:, body:)
+      log_string = "#{code}\n#{message}\n#{body}"
+      self.class.logger.error(log_string)
+    end
+
+    def do_request(verb:, path:, args: {})
+      log_request(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
+        log_error(
+          code: response.code,
+          message: response.message,
+          body: response.body
+        )
+        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.7
 
 # Changes since 0.12:
 # -/0: Add logging.
@@ -18,14 +18,31 @@
 # 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().
+# 6/7. Logging for HTTP errors.
+# 26. ~ Eodhd::Client: /log()/log_request()/
+# 27. + Eodhd::Client#log_error
+# 28. ~ Eodhd::Client#do_request: /log/log_request/.
+# 29. ~ Eodhd::Client#handle_response: Use log_error().
 
 require_relative 'Eodhd/Client'
 require_relative 'Eodhd/EodBulkLastDay'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: eodhd.rb
 version: !ruby/object:Gem::Version
-  version: 0.13.5
+  version: 0.13.7
 platform: ruby
 authors:
 - thoran