apicake 0.1.5 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 61152c75df8d4887a4b07dcb947abf7187269648ec316e08d2720731ff99fdc6
-  data.tar.gz: 9486e4dce9708d24eafda47de4b49f32b6a7b1bf7d29468a28372cf1f7b911d6
+  metadata.gz: 99a92916c5b6d98058f53ba677f876d2788ee2a5c3809ff094073c27136b9730
+  data.tar.gz: 8728e666564cc4d634c0d8b2eeb77d4ea7654effaf7d4a1f6c88b65907142b6a
 SHA512:
-  metadata.gz: c3c63cc09e815e0ff83a25065437b1bef7b3e714dd8da78bb82a3771e3f9868f1bec390028e1815ba3693132ce47ff290d8438500993ba19e2bd5e5b6ad224b5
-  data.tar.gz: 39665beaf97f8c22b3301b5ad899c8b15f3851aca650e3deb1cb66349114364a7ad30ae39a9292ddbe50fdb17c41c8c9351fb460855119010bfafba9dfd196db
+  metadata.gz: 10800e96a2a874a11b2c398f8e0a0bf37e530e7f489c3b3267c66078dbfb9345b762986f07ad0c739ef3f2811efd7135465edad20b037d615101c7687fe96478
+  data.tar.gz: e1807403c90bd2dff54f139fe8dd3c48e30aa4a8b73fbb904c69bb23e01c08c3995a89677270b1c558d6da08b320b285abda2ec75af9d1da188e21357954159b

data/README.md

@@ -1,21 +1,12 @@
-API Cake - Build Dynamic API Wrappers
-==================================================
+# API Cake - Build Dynamic API Wrappers
 
-[![Gem Version](https://badge.fury.io/rb/apicake.svg)](https://badge.fury.io/rb/apicake)
-[![Build Status](https://github.com/DannyBen/apicake/workflows/Test/badge.svg)](https://github.com/DannyBen/apicake/actions?query=workflow%3ATest)
-[![Maintainability](https://api.codeclimate.com/v1/badges/07bd0f8653914ce703a6/maintainability)](https://codeclimate.com/github/DannyBen/apicake/maintainability)
-
----
+![repocard](repocard.svg)
 
 This gem allows you to easily build rich API wrappers with minimal code.
 
 It is HTTParty with a Cake.
 
----
-
-
-Install
---------------------------------------------------
+## Install
 
 ```
 $ gem install apicake
@@ -28,8 +19,7 @@ gem 'apicake'
 ```
 
 
-TL;DR
---------------------------------------------------
+## TL;DR
 
 Turn this hypothetical API URL:
 
@@ -53,8 +43,7 @@ end
 ```
 
 
-Features
---------------------------------------------------
+## Features
 
 - Uses HTTParty
 - Built in caching
@@ -64,8 +53,7 @@ Features
 - Designed for GET-only APIs (e.g., data services)
 
 
-Usage
---------------------------------------------------
+## Usage
 
 Create a class and inherit from `APICake::Base`.
 
@@ -96,8 +84,7 @@ recipes.cakes 'chocolate', layers: 3
 See the [Examples folder][1] for more examples.
 
 
-Caching
---------------------------------------------------
+## Caching
 
 APICake uses [Lightly][2] for caching. By default, cached objects are stored
 in the `./cache` directory for 3600 seconds.
@@ -105,21 +92,21 @@ in the `./cache` directory for 3600 seconds.
 See the [caching example][3].
 
 
-Method Reference
---------------------------------------------------
+## Method Reference
 
 For a detailed explanation of the services and methods you get when inheriting
 from `APICake::Base`, see the [class documentation][4].
 
 
-Real World Examples
---------------------------------------------------
+## Real World Examples
 
 These gems use APICake:
 
 - [Fredric][5] - API wrapper for the FRED database ([go straight to API class][8])
 - [Intrinio][6] - API wrapper for the Intrinio data service ([go straight to API class][9])
 - [Quata][7] - API wrapper for the Quandl data service ([go straight to API class][10])
+- [EOD Historical Data][11] - API wrapper for the EOD Historical Data service ([go straight to API class][12])
+- [Nasdaq][13] - API wrapper for the Nasdaq Data Link API ([go straight to API class][14])
 
 
 ---
@@ -133,4 +120,8 @@ These gems use APICake:
 [7]: https://github.com/DannyBen/quata
 [8]: https://github.com/DannyBen/fredric/blob/master/lib/fredric/api.rb
 [9]: https://github.com/DannyBen/intrinio/blob/master/lib/intrinio/api.rb
-[10]: https://github.com/DannyBen/quata/blob/master/lib/quata/api.rb
+[10]: https://github.com/DannyBen/quata/blob/master/lib/quata/api.rb
+[11]: https://github.com/DannyBen/eod
+[12]: https://github.com/DannyBen/eod/blob/master/lib/eod/api.rb
+[13]: https://github.com/dannyben/nasdaq
+[14]: https://github.com/dannyben/nasdaqblob/master/lib/nasdaq/api.rb

data/lib/apicake/base.rb

@@ -1,5 +1,6 @@
-require "httparty"
-require "lightly"
+require 'httparty'
+require 'lightly'
+require 'csv'
 
 module APICake
   # To create your API wrapper, make a class that inherit from this class.
@@ -53,8 +54,13 @@ module APICake
     #
     #   client.get 'path/optional_sub_path', optional_param: value, optional_param: value
     #
-    def method_missing(method_sym, *arguments, &_block)
-      get "/#{method_sym}", *arguments
+    def method_missing(method_sym, *)
+      get("/#{method_sym}", *)
+    end
+
+    # Any undefined method call can be handled by this class.
+    def respond_to_missing?(*)
+      true
     end
 
     # This is the {https://github.com/DannyBen/lightly Lightly} cache object.
@@ -94,7 +100,9 @@ module APICake
     #   p client.last_url
     #   # => "http://some.api.com/v3/some_path?api_key=secret&param=value"
     #
-    def default_query; {}; end
+    def default_query
+      {}
+    end
 
     # Override this method in order to merge parameters into the HTTParty
     # get request.
@@ -115,7 +123,9 @@ module APICake
     #
     # @see http://www.rubydoc.info/github/jnunemaker/httparty/HTTParty/ClassMethods HTTParty Class Methods documentation
     #
-    def default_params; {}; end
+    def default_params
+      {}
+    end
 
     # Make a request or get it from cache, and return the parsed response.
     #
@@ -142,7 +152,7 @@ module APICake
       key = cache_key path, extra, params
 
       @last_payload = cache.get key do
-        http_get(path, extra, params)
+        http_get path, params
       end
 
       @last_url = @last_payload.request.uri.to_s
@@ -178,34 +188,26 @@ module APICake
     # You can override this method if you wish to provide a different
     # behavior.
     #
-    def get_csv(*args)
-      payload = get!(*args)
-
-      if payload.response.code != "200"
-        raise BadResponse, "#{payload.response.code} #{payload.response.msg}"
-      end
+    def get_csv(*)
+      payload = get!(*)
+      raise BadResponse, "#{payload.response.code} #{payload.response.msg}" if payload.response.code != '200'
 
       response = payload.parsed_response
-
-      unless response.is_a? Hash
-        raise BadResponse, "Cannot parse response"
-      end
+      raise BadResponse, 'Cannot parse response' unless response.is_a? Hash
 
       data = csv_node response
-
       header = data.first.keys
-      result = CSV.generate do |csv|
+
+      CSV.generate do |csv|
         csv << header
         data.each { |row| csv << row.values }
       end
-
-      result
     end
 
     # Same as {#save}, only use the output of {#get_csv} instead of the
     # response body.
-    def save_csv(file, *args)
-      File.write file, get_csv(*args)
+    def save_csv(file, *)
+      File.write file, get_csv(*)
     end
 
     # Determins which part of the data is best suited to be displayed
@@ -223,23 +225,23 @@ module APICake
       arrays.empty? ? [data] : data[arrays.first]
     end
 
-    private
+  private
 
     # Make a call with HTTParty and return a payload object.
-    def http_get(path, extra = nil, params = {})
+    def http_get(path, params = {})
       payload = self.class.get path, params
       APICake::Payload.new payload
     end
 
     # Normalize the three input parameters
     def normalize(path, extra = nil, params = {})
-      if extra.is_a?(Hash) and params.empty?
+      if extra.is_a?(Hash) && params.empty?
         params = extra
         extra = nil
       end
 
       path = "#{path}/#{extra}" if extra
-      path = "/#{path}" unless path[0] == "/"
+      path = "/#{path}" unless path[0] == '/'
 
       query = default_query.merge params
 

data/lib/apicake/version.rb

@@ -1,3 +1,3 @@
 module APICake
-  VERSION = "0.1.5"
+  VERSION = '0.2.0'
 end

data/lib/apicake.rb

@@ -1,4 +1,4 @@
-require "apicake/version"
-require "apicake/base"
-require "apicake/payload"
-require "apicake/exceptions"
+require 'apicake/version'
+require 'apicake/base'
+require 'apicake/payload'
+require 'apicake/exceptions'

metadata

@@ -1,43 +1,56 @@
 --- !ruby/object:Gem::Specification
 name: apicake
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.2.0
 platform: ruby
 authors:
 - Danny Ben Shitrit
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-09-30 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.20'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.20'
 - !ruby/object:Gem::Dependency
   name: lightly
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.3'
 - !ruby/object:Gem::Dependency
-  name: httparty
+  name: csv
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.14'
+        version: '3.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.14'
+        version: '3.3'
 description: Build Dynamic API Wrappers
 email: db@dannyben.com
 executables: []
@@ -55,8 +68,9 @@ licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/DannyBen/apicake/issues
+  changelog_uri: https://github.com/DannyBen/apicake/blob/master/CHANGELOG.md
   source_code_uri: https://github.com/DannyBen/apicake
-post_install_message: 
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib
@@ -64,15 +78,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.4'
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.25
-signing_key: 
+rubygems_version: 4.0.3
 specification_version: 4
 summary: API Building Toolkit
 test_files: []