apicake 0.1.4 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2016b0c4a2652010b263db2d6e6d85804c2cfb23f9c8a8c0d66e55f443e4dee6
-  data.tar.gz: 56475f108cc6bb2ad7637005af0f58a73b0bd4cb1587c22f49ec50a61f1aafa3
+  metadata.gz: 812c64d0f7d4a2004da300a7992177452e9226cc8f160d424da7059f7a9328e5
+  data.tar.gz: 4fcb4c15447fffe6cdeb61f971b4592527c68cb6f28f0106e7203832ee25b90e
 SHA512:
-  metadata.gz: 1345df60ac9a9cba25e27a846b14571c3c84e33fe124d4917ef198f0f8d471f2e59a855d5456b909739e29a1c37791f72a3455f30811ab03f70c338dddef0da4
-  data.tar.gz: c491ea7c9e46d9f028ae37723ffc3003226360714cf3d581a1448b54a981fc0392b488c2d28c71ee36abb9d072e34bc8cb3171d7c6f8b2f3d36862ebc9178e9a
+  metadata.gz: 7701d7614c3b9f60d448d6c7b9823edd2bd889d25fafc2c289359ef022cfdcb4428de8c2aba2419b014111c860b437c06e6eaca5db6226a378c9959855333d35
+  data.tar.gz: c550aae7a16bdbf8156915fb65e3906e457301fdeb4d00862255e88b1fa3fccbaee54421aed025639100707fb70c09e26ed434d797667851d5b0b16c43d799a3

data/README.md

@@ -1,5 +1,4 @@
-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)
@@ -14,8 +13,7 @@ It is HTTParty with a Cake.
 ---
 
 
-Install
---------------------------------------------------
+## Install
 
 ```
 $ gem install apicake
@@ -28,8 +26,7 @@ gem 'apicake'
 ```
 
 
-TL;DR
---------------------------------------------------
+## TL;DR
 
 Turn this hypothetical API URL:
 
@@ -53,8 +50,7 @@ end
 ```
 
 
-Features
---------------------------------------------------
+## Features
 
 - Uses HTTParty
 - Built in caching
@@ -64,8 +60,7 @@ Features
 - Designed for GET-only APIs (e.g., data services)
 
 
-Usage
---------------------------------------------------
+## Usage
 
 Create a class and inherit from `APICake::Base`.
 
@@ -96,8 +91,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 +99,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 +127,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,5 @@
-require "httparty"
-require "lightly"
+require 'httparty'
+require 'lightly'
 
 module APICake
   # To create your API wrapper, make a class that inherit from this class.
@@ -53,8 +53,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, *args)
+      get "/#{method_sym}", *args
+    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 +99,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 +122,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,10 +151,10 @@ 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.last_uri.to_s
+      @last_url = @last_payload.request.uri.to_s
       @last_payload
     end
 
@@ -180,26 +189,18 @@ module APICake
     #
     def get_csv(*args)
       payload = get!(*args)
-
-      if payload.response.code != "200"
-        raise BadResponse, "#{payload.response.code} #{payload.response.msg}"
-      end
+      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
@@ -223,23 +224,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.4"
+  VERSION = '0.1.6'
 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,85 @@
 --- !ruby/object:Gem::Specification
 name: apicake
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.6
 platform: ruby
 authors:
 - Danny Ben Shitrit
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-09-28 00:00:00.000000000 Z
+date: 2024-02-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: lightly
+  name: httparty
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.20'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.20'
 - !ruby/object:Gem::Dependency
-  name: httparty
+  name: lightly
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.14'
+        version: '0.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.14'
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: base64
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bigdecimal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: csv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Build Dynamic API Wrappers
 email: db@dannyben.com
 executables: []
@@ -56,7 +98,8 @@ licenses:
 metadata:
   bug_tracker_uri: https://github.com/DannyBen/apicake/issues
   source_code_uri: https://github.com/DannyBen/apicake
-post_install_message: 
+  rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -64,15 +107,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.4'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.25
-signing_key: 
+rubygems_version: 3.5.6
+signing_key:
 specification_version: 4
 summary: API Building Toolkit
 test_files: []