eod 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4fbbd24f2657e0181eb845ed5c0d27e86ae7f5cb88063d16ea4ce078683316f2
-  data.tar.gz: c27bca383e1fc681e5866f48ded7c3580f571ab8b0d2c9035c72a181ae1a704e
+  metadata.gz: 8bd6ad52b91c2195a4d42e75945b713a2d844fa233f5866f0e15a0f24d2db36e
+  data.tar.gz: 78aa2f9f78b9b1a2bd77e5d9dfcaac25085f3fb7ac6c55e76ab8bef202a401f1
 SHA512:
-  metadata.gz: ff07259af25e6d14ee15d6a477717cb1d2f3077734ca5afd184289e9e0d766892c95a77dd25224a8fb5490439de325e25cdd9e704defd6d90ea757f4488e42d4
-  data.tar.gz: c55da90f485d8ced57beed7a9ac099bcfc4df543b77bbb0e3e1d5cb5c56c472899bc1e33686000408ad4d2413d1ac5967e84f734789a7b2e8317282960415175
+  metadata.gz: a0abd6015fd69695e8fc177d2a1ed0847bc23367ab2d65a809857790bb308fdf6aead6864a98a21f8916855e62b66bc884e8d51fb74b0e9d618e0f452afc7388
+  data.tar.gz: d69cfc7faa9cbe072aab80f19e446e4600e43d1c2178216d495f11534596d526173e65465776888998d47262b270e722cd39f6d7bca0ecaa292b0c02d1b33df7

data/README.md

@@ -2,12 +2,15 @@
 
 [![Gem Version](https://badge.fury.io/rb/eod.svg)](https://badge.fury.io/rb/eod)
 [![Build Status](https://github.com/DannyBen/eod/workflows/Test/badge.svg)](https://github.com/DannyBen/eod/actions?query=workflow%3ATest)
+[![Maintainability](https://api.codeclimate.com/v1/badges/52438abcc1532b93b525/maintainability)](https://codeclimate.com/github/DannyBen/eod/maintainability)
 
 ---
 
 This gem provides both a Ruby library and a command line interface for the 
 [EOD Historical Data][docs] data service.
 
+This gem is not affiliated with EOD Historical Data.
+
 ---
 
 
@@ -130,8 +133,6 @@ Or, to save CSV, use the `save_csv` method:
 api.save_csv "filename.csv", "eod/AAPL.US", period: 'm'
 ```
 
-
-
 ## Command Line Interface
 
 The command line utility `eod` that is installed when installing the gem acts
@@ -163,6 +164,12 @@ $ eod data AAPL.US --format csv --save aapl.csv from:2022-01-01 period:m
 Run [`eod --help`](#full-command-line-usage-patterns) for the full list of usage
 patterns.
 
+## Supported endpoints
+
+- The Ruby library supports all current and future endpoints.
+- The CLI supports most (if not all) current endpoints. If you know of an
+  endpoint that is not supported, please create an [issue][issues].
+
 
 ## Caching
 
@@ -174,18 +181,18 @@ a later stage.
 
 ```ruby
 # Disable cache completely
-api = EOD::API.new api_token,  use_cache: true
+api = EOD::API.new api_token,  use_cache: false
 
 # Set different cache directory or lifetime
 api = EOD::API.new api_token, cache_dir: 'data', cache_ilfe: '2h'
 
-# or 
+# Or configure cache after initializaation:
 
-intrinio = Intrinio::API.new username: user, password: pass
-intrinio.cache.disable
-intrinio.cache.enable
-intrinio.cache.dir = 'tmp/cache'   # Change cache folder
-intrinio.cache.life = '30m'        # Change cache life to 30 minutes
+api = EOD::API.new api_token
+api.cache.disable
+api.cache.enable
+api.cache.dir = 'tmp/cache'   # Change cache folder
+api.cache.life = '30m'        # Change cache life to 30 minutes
 ```
 
 To enable caching for the command line, simply set one or both of 
@@ -207,12 +214,15 @@ The cache life argument supports these formats:
 
 ## Full command line usage patterns
 
+<!-- USAGE -->
 ```
 $ eod --help
 
-<!-- USAGE -->
 EOD Historical Data API
 
+  API Documentation:
+  https://eodhistoricaldata.com/financial-apis/
+
 Usage:
   eod bond SYMBOL [options] [PARAMS...]
   eod bulk EXCHANGE [options] [PARAMS...]
@@ -361,9 +371,9 @@ Examples:
   eod technical AAPL.US function:sma
   eod macro USA indicator:inflation_consumer_prices_annual
 
+```
 <!-- USAGE -->
 
-````
 
 ## Contributing / Support
 

data/bin/eod

@@ -8,18 +8,15 @@ runner = EOD::CLI.runner
 
 begin
   exit runner.run ARGV
-
 rescue Interrupt
   say "\nGoodbye"
-  exit 1  
-
+  exit 1
 rescue => e
   if ENV['DEBUG']
-    puts e.backtrace.reverse 
-    say ""
+    puts e.backtrace.reverse
+    say ''
   end
-  say "!undred!ERROR: #{e.class}"
+  say "ru`ERROR: #{e.class}`"
   say e.message
   exit 1
-
 end

data/lib/eod/api.rb

@@ -16,13 +16,13 @@ module EOD
     end
 
     def default_query
-      { api_token: api_token, fmt: :json } 
+      { api_token: api_token, fmt: :json }
     end
 
     def get_csv(*args)
-      payload = get! *args
+      payload = get!(*args)
 
-      if payload.response.code != "200"
+      if payload.response.code != '200'
         raise BadResponse, "#{payload.response.code} #{payload.response.msg}"
       end
 
@@ -31,12 +31,10 @@ module EOD
 
       header = data.first.keys
 
-      result = CSV.generate do |csv|
+      CSV.generate do |csv|
         csv << header
         data.each { |row| csv << row.values }
       end
-
-      result
     end
   end
-end
+end

data/lib/eod/command.rb

@@ -9,85 +9,85 @@ module EOD
     help "EOD Historical Data API\n\n  API Documentation:\n  https://eodhistoricaldata.com/financial-apis/"
     version EOD::VERSION
 
-    usage "eod bond SYMBOL [options] [PARAMS...]"
-    usage "eod bulk EXCHANGE [options] [PARAMS...]"
-    usage "eod calendar CALENDAR [options] [PARAMS...]"
-    usage "eod data SYMBOL [options] [PARAMS...]"
-    usage "eod dividends SYMBOL [options] [PARAMS...]"
-    usage "eod events [options] [PARAMS...]"
-    usage "eod exchange EXCHANGE [options] [PARAMS...]"
-    usage "eod exchanges [options] [PARAMS...]"
-    usage "eod fundamental SYMBOL [options] [PARAMS...]"
-    usage "eod fundamental_bulk SYMBOL [options] [PARAMS...]"
-    usage "eod insider [options] [PARAMS...]"
-    usage "eod intraday SYMBOL [options] [PARAMS...]"
-    usage "eod live SYMBOL [options] [PARAMS...]"
-    usage "eod macro COUNTRY [options] [PARAMS...]"
-    usage "eod news [options] [PARAMS...]"
-    usage "eod opts SYMBOL [options] [PARAMS...]"
-    usage "eod screener [options] [PARAMS...]"
-    usage "eod search QUERY [options] [PARAMS...]"
-    usage "eod splits SYMBOL [options] [PARAMS...]"
-    usage "eod symbols EXCHANGE [options] [PARAMS...]"
-    usage "eod technical SYMBOL [options] [PARAMS...]"
-    usage "eod (-h|--help|--version)"
-
-    command "bond", "Bond fundamental data (/bond-fundamentals)"
-    command "bulk", "Historical EOD bulk data (/eod-bulk-last-day)"
-    command "calendar", "Calendar data (earnings, trends, IPOs and splits) (/calendar)"
-    command "data", "Historical EOD data (/eod)"
-    command "dividends", "Dividends data (/div)"
-    command "events", "Economic events data (/economic-events)"
-    command "exchange", "Details about an exchange (/exchanges-details)"
-    command "exchanges", "List of exchanges (/exchanges-list)"
-    command "fundamental", "Fundamental data (/fundamentals)"
-    command "fundamental_bulk", "Bulk fundamental data (/bulk-fundamentals)"
-    command "insider", "Insider transactions data (/insider-transactions)"
-    command "intraday", "Intraday data (/intraday)"
-    command "live", "Live data (/real-time)"
-    command "macro", "Macroeconomics data (/macro-indicator)"
-    command "news", "Financial news (/news)"
-    command "opts", "Options data (/options)"
-    command "screener", "Stock market screener (/screener)"
-    command "search", "Search for stocks, ETFs, funds or indices (/search)"
-    command "splits", "Splits data (/splits)"
-    command "symbols", "List of symbols for an exchange (/exchange-symbol-list)"
-    command "technical", "Technical data (/technical)"
-
-    option "-f --format FORMAT", "Output format: csv, json, yaml, pretty or url [default: pretty]"
-    option "-s --save PATH", "Save output to file"
-
-    param "SYMBOL", "Ticker symbol"
-    param "CALENDAR", "Calendar type: earnings, trends, ipos or splits"
-    param "COUNTRY", "Country code in the Alpha-3 ISO format"
-    param "EXCHANGE", "Exchange code"
-    param "PARAMS", <<~EOF
+    usage 'eod bond SYMBOL [options] [PARAMS...]'
+    usage 'eod bulk EXCHANGE [options] [PARAMS...]'
+    usage 'eod calendar CALENDAR [options] [PARAMS...]'
+    usage 'eod data SYMBOL [options] [PARAMS...]'
+    usage 'eod dividends SYMBOL [options] [PARAMS...]'
+    usage 'eod events [options] [PARAMS...]'
+    usage 'eod exchange EXCHANGE [options] [PARAMS...]'
+    usage 'eod exchanges [options] [PARAMS...]'
+    usage 'eod fundamental SYMBOL [options] [PARAMS...]'
+    usage 'eod fundamental_bulk SYMBOL [options] [PARAMS...]'
+    usage 'eod insider [options] [PARAMS...]'
+    usage 'eod intraday SYMBOL [options] [PARAMS...]'
+    usage 'eod live SYMBOL [options] [PARAMS...]'
+    usage 'eod macro COUNTRY [options] [PARAMS...]'
+    usage 'eod news [options] [PARAMS...]'
+    usage 'eod opts SYMBOL [options] [PARAMS...]'
+    usage 'eod screener [options] [PARAMS...]'
+    usage 'eod search QUERY [options] [PARAMS...]'
+    usage 'eod splits SYMBOL [options] [PARAMS...]'
+    usage 'eod symbols EXCHANGE [options] [PARAMS...]'
+    usage 'eod technical SYMBOL [options] [PARAMS...]'
+    usage 'eod (-h|--help|--version)'
+
+    command 'bond', 'Bond fundamental data (/bond-fundamentals)'
+    command 'bulk', 'Historical EOD bulk data (/eod-bulk-last-day)'
+    command 'calendar', 'Calendar data (earnings, trends, IPOs and splits) (/calendar)'
+    command 'data', 'Historical EOD data (/eod)'
+    command 'dividends', 'Dividends data (/div)'
+    command 'events', 'Economic events data (/economic-events)'
+    command 'exchange', 'Details about an exchange (/exchanges-details)'
+    command 'exchanges', 'List of exchanges (/exchanges-list)'
+    command 'fundamental', 'Fundamental data (/fundamentals)'
+    command 'fundamental_bulk', 'Bulk fundamental data (/bulk-fundamentals)'
+    command 'insider', 'Insider transactions data (/insider-transactions)'
+    command 'intraday', 'Intraday data (/intraday)'
+    command 'live', 'Live data (/real-time)'
+    command 'macro', 'Macroeconomics data (/macro-indicator)'
+    command 'news', 'Financial news (/news)'
+    command 'opts', 'Options data (/options)'
+    command 'screener', 'Stock market screener (/screener)'
+    command 'search', 'Search for stocks, ETFs, funds or indices (/search)'
+    command 'splits', 'Splits data (/splits)'
+    command 'symbols', 'List of symbols for an exchange (/exchange-symbol-list)'
+    command 'technical', 'Technical data (/technical)'
+
+    option '-f --format FORMAT', 'Output format: csv, json, yaml, pretty or url [default: pretty]'
+    option '-s --save PATH', 'Save output to file'
+
+    param 'SYMBOL', 'Ticker symbol'
+    param 'CALENDAR', 'Calendar type: earnings, trends, ipos or splits'
+    param 'COUNTRY', 'Country code in the Alpha-3 ISO format'
+    param 'EXCHANGE', 'Exchange code'
+    param 'PARAMS', <<~USAGE
       An optional list of query string parameters, separated by a space, to send with the request. \
       Each parameter should be in the format of key:value.
       example: period:w from:2022-01-01
 
       See https://eodhistoricaldata.com/financial-apis/ for all supported params.
-    EOF
-    
-    environment "EOD_API_TOKEN", "Your EOD Historical Data API token [required]"
-    environment "EOD_CACHE_DIR", "API cache diredctory [default: cache]"
-    environment "EOD_CACHE_LIFE", <<~EOF
+    USAGE
+
+    environment 'EOD_API_TOKEN', 'Your EOD Historical Data API token [required]'
+    environment 'EOD_CACHE_DIR', 'API cache diredctory [default: cache]'
+    environment 'EOD_CACHE_LIFE', <<~USAGE
       API cache life. These formats are supported:
       off - No cache
       20s - 20 seconds
       10m - 10 minutes
       10h - 10 hours
       10d - 10 days
-    EOF
-    environment "EOD_API_URI", "Override the API URI [default: #{EOD::API.base_uri}]"
+    USAGE
+    environment 'EOD_API_URI', "Override the API URI [default: #{EOD::API.base_uri}]"
 
-    example "eod symbols NASDAQ"
-    example "eod data AAPL.US"
-    example "eod data AAPL.US --format csv period:m from:2022-01-01"
-    example "eod live AAPL.US -fyaml"
+    example 'eod symbols NASDAQ'
+    example 'eod data AAPL.US'
+    example 'eod data AAPL.US --format csv period:m from:2022-01-01'
+    example 'eod live AAPL.US -fyaml'
     example "eod fundamental 'AAPL.US' filter:General"
-    example "eod technical AAPL.US function:sma"
-    example "eod macro USA indicator:inflation_consumer_prices_annual"
+    example 'eod technical AAPL.US function:sma'
+    example 'eod macro USA indicator:inflation_consumer_prices_annual'
 
     def bond_command
       disallow :csv
@@ -100,7 +100,7 @@ module EOD
 
     def calendar_command
       allowed = %w[earnings trends ipos splits]
-      
+
       unless allowed.include? calendar
         raise InputError, "Invalid calendar #{calendar}. Expecting earnings, trends, ipos or splits"
       end
@@ -117,7 +117,7 @@ module EOD
     end
 
     def events_command
-      send_output get("economic-events")
+      send_output get('economic-events')
     end
 
     def exchange_command
@@ -126,7 +126,7 @@ module EOD
     end
 
     def exchanges_command
-      send_output get("exchanges-list")
+      send_output get('exchanges-list')
     end
 
     def fundamental_command
@@ -140,7 +140,7 @@ module EOD
     end
 
     def insider_command
-      send_output get("insider-transactions")
+      send_output get('insider-transactions')
     end
 
     def intraday_command
@@ -157,7 +157,7 @@ module EOD
 
     def news_command
       disallow :csv
-      send_output get("news")
+      send_output get('news')
     end
 
     def opts_command
@@ -166,7 +166,7 @@ module EOD
     end
 
     def screener_command
-      send_output get("screener")
+      send_output get('screener')
     end
 
     def search_command
@@ -216,9 +216,9 @@ module EOD
     def api
       @api ||= begin
         EOD::API.base_uri ENV['EOD_API_URI'] if ENV['EOD_API_URI']
-        EOD::API.new api_token, 
-          use_cache: (ENV['EOD_CACHE_LIFE'] != 'off'),
-          cache_dir: ENV['EOD_CACHE_DIR'],
+        EOD::API.new api_token,
+          use_cache:  (ENV['EOD_CACHE_LIFE'] != 'off'),
+          cache_dir:  ENV['EOD_CACHE_DIR'],
           cache_life: ENV['EOD_CACHE_LIFE']
       end
     end
@@ -262,6 +262,5 @@ module EOD
     def save
       args['--save']
     end
-
   end
 end

data/lib/eod/exceptions.rb

@@ -3,4 +3,4 @@ module EOD
   class BadResponse < EODError; end
   class MissingAuth < EODError; end
   class InputError < EODError; end
-end
+end

data/lib/eod/version.rb

@@ -1,3 +1,3 @@
 module EOD
-  VERSION = "0.1.0"
-end
+  VERSION = '0.1.1'
+end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: eod
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-03-31 00:00:00.000000000 Z
+date: 2023-03-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: mister_bin
+  name: apicake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '0.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '0.1'
 - !ruby/object:Gem::Dependency
   name: lp
   requirement: !ruby/object:Gem::Requirement
@@ -39,19 +39,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.2'
 - !ruby/object:Gem::Dependency
-  name: apicake
+  name: mister_bin
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.7'
 description: Easy to use API for eodhistoricaldata.com Data service with a command
   line interface
 email: db@dannyben.com
@@ -77,6 +77,7 @@ metadata:
   changelog_uri: https://github.com/DannyBen/eod/blob/master/CHANGELOG.md
   homepage_uri: https://github.com/DannyBen/eod
   source_code_uri: https://github.com/DannyBen/eod
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -92,7 +93,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
+rubygems_version: 3.4.9
 signing_key: 
 specification_version: 4
 summary: EOD Historical Data API Library and Command Line