quata 0.1.8 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 976dad60f84a4420bb1ec96a702f206559ae8de553887e9dd64d39b832e5e2cd
-  data.tar.gz: fb5bbb8cc05ae02ae670be7180e5d00732f9064cc55e853dba207c9db840fbed
+  metadata.gz: 9f8a79d81a044a3ef2f27c500aa3bd40ccf5ad27f3cce012e214c567ad4b6590
+  data.tar.gz: 59bf47fc2efe048c885788a1b27f95870545bebb8d22b887d11bac65b6387457
 SHA512:
-  metadata.gz: e8119109be5832618b25e534de4f0ff4b7b5fd33700ed9b7c4fdfb3a134277c5f2d8a69a0a5f1f9bd8b79af08fa4fcf6b2b582c8d8a6370f177492cba79bfb69
-  data.tar.gz: e693e4238d4d990e23945094847750d4a7ba936b371bbb99641bc77d3b0c95fbac9ff09713d77f1fe222f739f03cac87f55b9a76a8f61f8bcff3030842985e68
+  metadata.gz: '0790bad1bd04690821b44f64b3a6c078cdeb09665083cf9a96ad797962a479c2e9f693d7ae7b1d9d4c2a331ebf2d625915615a56928edf9d7f735a1d1ec8e527'
+  data.tar.gz: a154712860a21fd6c374ebc34fb2d8dc4c73ec0bef33a5f34ff19e8b9fa66b0bc69af8a20e10d7d9bd0a8683b4a664b38288f6a3221dca1a886b7c1fdfcfe4eb

data/README.md

@@ -1,5 +1,4 @@
-Quata - Quandl API Library and Command Line
-==================================================
+# Quata - Quandl API Library and Command Line
 
 [![Gem Version](https://badge.fury.io/rb/quata.svg)](https://badge.fury.io/rb/quata)
 [![Build Status](https://github.com/DannyBen/quata/workflows/Test/badge.svg)](https://github.com/DannyBen/quata/actions?query=workflow%3ATest)
@@ -10,12 +9,12 @@ Quata - Quandl API Library and Command Line
 Quata is a lightweight ruby library for accessing Quandl, and includes 
 a command line interface.
 
-It provides direct access to all of the [Quandl API][1] endpoints.
+It provides direct access to all of the [Nasdaq Data Link API][1]
+(formerly Quandl) endpoints.
 
 ---
 
-Install
---------------------------------------------------
+## Install
 
 ```
 $ gem install quata
@@ -28,25 +27,23 @@ gem 'quata'
 ```
 
 
-Features
---------------------------------------------------
+## Features
 
 * Easy to use interface.
 * Use as a library or through the command line.
 * Access any Quandl endpoint directly.
 * Display output in various formats.
-* Save output to a file, including bulk downloads.
+* Save output to a file.
 * Includes a built in file cache (disabled by default).
 
 
-Usage
---------------------------------------------------
+## Usage
 
 First, require and initialize with your API key
 
 ```ruby
 require 'quata'
-quandl = Quata::API.new 'Your API Key'
+quandl = Quata::API.new 'your-api-key'
 ```
 
 Now, you can access any Quandl endpoint with any optional parameter, like
@@ -130,21 +127,24 @@ quandl.save_csv "filename.csv", "datasets/WIKI/AAPL", rows: 3
 ```
 
 
-Command Line
---------------------------------------------------
+## Command Line
 
 The command line utility `quata` acts in a similar way. To use your Quandl
 API key, simply set it in the environment variables `QUANDL_KEY`:
 
-`$ export QUANDL_KEY=your_key`
+```
+$ export QUANDL_KEY=your_key
+```
 
 These commands are available:
 
-`$ quata get PATH [PARAMS...]` - print the output.  
-`$ quata pretty PATH [PARAMS...]` - print a pretty JSON.  
-`$ quata see PATH [PARAMS...]` - print a colored output.  
-`$ quata url PATH [PARAMS...]` - show the constructed URL.  
-`$ quata save FILE PATH [PARAMS...]` - save the output to a file.  
+```bash
+$ quata get PATH [PARAMS...]        # print the output.  
+$ quata pretty PATH [PARAMS...]     # print a pretty JSON.  
+$ quata see PATH [PARAMS...]        # print a colored output.  
+$ quata url PATH [PARAMS...]        # show the constructed URL.  
+$ quata save FILE PATH [PARAMS...]  # save the output to a file.  
+```
 
 Run `quata --help` for more information, or view the [full usage help][2].
 
@@ -177,17 +177,16 @@ $ quata save output.csv datasets/WIKI/AAPL rows:5
 
 # Shows the URL that Quata has constructed, good for debugging
 $ quata url datasets/WIKI/AAPL rows:5
-# => https://www.quandl.com/api/v3/datasets/WIKI/AAPL.csv?auth_token=YOUR_KEY&rows=5
+# => https://data.nasdaq.com/api/v3/datasets/WIKI/AAPL.csv?api_key=YOUR_KEY&rows=5
 ```
 
-Caching
---------------------------------------------------
+## Caching
 
 Quata uses the [Lightly][3] gem for automatic HTTP caching.
 To take the path of least surprises, caching is disabled by default.
 
 You can enable and customize it by either passing options on 
-initialization, or by accessing the `WebCache` object directly at 
+initialization, or by accessing the `Lightly` object directly at 
 a later stage.
 
 ```ruby
@@ -214,12 +213,11 @@ $ quata get datasets/WIKI/AAPL
 ```
 
 
-Terminalcast
---------------------------------------------------
+## Terminalcast
 
 ![Quata Demo](https://raw.githubusercontent.com/DannyBen/quata/master/demo.gif "Quata Demo")
 
-[1]: https://www.quandl.com/blog/getting-started-with-the-quandl-api
+[1]: https://docs.data.nasdaq.com/docs/getting-started
 [2]: https://github.com/DannyBen/quata/blob/master/lib/quata/docopt.txt
 [3]: https://github.com/DannyBen/lightly
 

data/bin/quata

@@ -5,5 +5,5 @@ require 'quata'
 begin
   Quata::CommandLine.execute ARGV
 rescue Quata::BadResponse => e
-  STDERR.puts "#{e.class} - #{e.message}"
+  warn "#{e.class} - #{e.message}"
 end

data/lib/quata/api.rb

@@ -3,16 +3,18 @@ require 'apicake'
 module Quata
   # Provides access to all the Quandl API endpoints
   class API < APICake::Base
-    base_uri 'https://www.quandl.com/api/v3'
+    base_uri 'https://data.nasdaq.com/api/v3'
 
     attr_reader :api_key
 
-    # TODO:
-    # - handle format
+    # TODO: handle format
 
     # Initializes the API with an optional API Key, and cache settings.
-    def initialize(api_key=nil, opts={})
-      opts, api_key = api_key, nil if api_key.is_a?(Hash) && opts.empty?
+    def initialize(api_key = nil, opts = {})
+      if api_key.is_a?(Hash) && opts.empty?
+        opts = api_key
+        api_key = nil
+      end
       @api_key = api_key
       cache.disable unless opts[:use_cache]
       cache.dir = opts[:cache_dir] if opts[:cache_dir]
@@ -22,13 +24,13 @@ module Quata
     # Returns a hash that will be merged into all query strings before
     # sending the request to Quandl. This method is used by API Cake.
     def default_query
-      { api_key: api_key } 
+      { api_key: api_key }
     end
 
     # Forwards all arguments to #get! and converts the JSON response to CSV
     # If the response contains one or more arrays, the first array will be
     # the CSV output. Otherwise, the response itself will be used.
-    def get_csv(path, params={})
+    def get_csv(path, params = {})
       path = "#{path}.csv"
       payload = get! path, params
 
@@ -39,4 +41,4 @@ module Quata
       payload.response.body
     end
   end
-end
+end

data/lib/quata/command_line.rb

@@ -3,12 +3,11 @@ require 'json'
 require 'lp'
 
 module Quata
-
   # Handles the command line interface
   class CommandLine < SuperDocopt::Base
     version VERSION
     docopt File.expand_path 'docopt.txt', __dir__
-    subcommands ['get', 'pretty', 'see', 'url', 'save']
+    subcommands %w[get pretty see url save]
 
     attr_reader :path, :params, :file, :csv
 
@@ -29,12 +28,12 @@ module Quata
     end
 
     def save
-      if csv
-        success = quandl.save_csv file, path, params
+      success = if csv
+        quandl.save_csv file, path, params
       else
-        success = quandl.save file, path, params
+        quandl.save file, path, params
       end
-      puts success ? "Saved #{file}" : "Saving failed"
+      puts success ? "Saved #{file}" : 'Saving failed'
     end
 
     def pretty
@@ -54,7 +53,7 @@ module Quata
       @quandl ||= quandl!
     end
 
-    private
+  private
 
     def quandl!
       API.new api_key, options
@@ -65,6 +64,7 @@ module Quata
     def translate_params(pairs)
       result = {}
       return result if pairs.empty?
+
       pairs.each do |pair|
         key, value = pair.split ':'
         result[key.to_sym] = value
@@ -93,6 +93,5 @@ module Quata
     def cache_life
       ENV['QUANDL_CACHE_LIFE']
     end
-
   end
 end

data/lib/quata/exceptions.rb

@@ -1,3 +1,3 @@
 module Quata
   class BadResponse < StandardError; end
-end
+end

data/lib/quata/version.rb

@@ -1,3 +1,3 @@
 module Quata
-  VERSION = "0.1.8"
-end
+  VERSION = '0.2.0'
+end

data/lib/quata.rb

@@ -2,3 +2,4 @@ require 'quata/version'
 require 'quata/api'
 require 'quata/command_line'
 require 'quata/exceptions'
+require 'byebug' if ENV['BYEBUG']

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: quata
 version: !ruby/object:Gem::Version
-  version: 0.1.8
+  version: 0.2.0
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-07 00:00:00.000000000 Z
+date: 2023-03-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: super_docopt
+  name: apicake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -39,19 +39,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.2'
 - !ruby/object:Gem::Dependency
-  name: apicake
+  name: super_docopt
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.2'
 description: Easy to use API for Quandl data service with a command line interface
 email: db@dannyben.com
 executables:
@@ -70,8 +70,10 @@ files:
 homepage: https://github.com/DannyBen/quata
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message: 'WARNING: The ''quata'' gem was renamed to ''nasdaq'', please
+  install it instead.'
 rdoc_options: []
 require_paths:
 - lib
@@ -79,14 +81,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.4.9
 signing_key: 
 specification_version: 4
 summary: Quandl API Library and Command Line