apicake 0.1.1 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: c1d09e6b00d7fb1d19163aa2e7a6912dbf571053
-  data.tar.gz: 48c802fe5b974895e65fd2808b2cdf711087087a
+SHA256:
+  metadata.gz: 61152c75df8d4887a4b07dcb947abf7187269648ec316e08d2720731ff99fdc6
+  data.tar.gz: 9486e4dce9708d24eafda47de4b49f32b6a7b1bf7d29468a28372cf1f7b911d6
 SHA512:
-  metadata.gz: c95806cee75f5e4574ece5ce97bae1c51c345506ec42d7ae5c6b1dd0ea12100269bbce230b725942eb603f7f80028cf40740e453113faa95f6ce314401a25b25
-  data.tar.gz: d324e21a09236ea45bcd9cbef8e7e702e92b52a519b877534a3c1d5f1ba3c0030fe074f106f2d525ef5b76d69848072d36e7243f00399857fb89e92f5970ce15
+  metadata.gz: c3c63cc09e815e0ff83a25065437b1bef7b3e714dd8da78bb82a3771e3f9868f1bec390028e1815ba3693132ce47ff290d8438500993ba19e2bd5e5b6ad224b5
+  data.tar.gz: 39665beaf97f8c22b3301b5ad899c8b15f3851aca650e3deb1cb66349114364a7ad30ae39a9292ddbe50fdb17c41c8c9351fb460855119010bfafba9dfd196db

data/README.md

@@ -1,11 +1,9 @@
 API Cake - Build Dynamic API Wrappers
 ==================================================
 
-[![Gem](https://img.shields.io/gem/v/apicake.svg?style=flat-square)](https://rubygems.org/gems/apicake)
-[![Travis](https://img.shields.io/travis/DannyBen/apicake.svg?style=flat-square)](https://travis-ci.org/DannyBen/apicake)
-[![Code Climate](https://img.shields.io/codeclimate/github/DannyBen/apicake.svg?style=flat-square)](https://codeclimate.com/github/DannyBen/apicake)
-[![Gemnasium](https://img.shields.io/gemnasium/DannyBen/apicake.svg?style=flat-square)](https://gemnasium.com/DannyBen/apicake)
-
+[![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)
 
 ---
 
@@ -36,20 +34,21 @@ TL;DR
 Turn this hypothetical API URL:
 
 ```
-http://api.recipies.com/cakes?layers=3 
+http://api.recipes.com/cakes?layers=3 
 ```
 
 To this:
 
 ```ruby
-Recipies.cakes layers:3
+recipes = Recipes.new
+recipes.cakes layers:3
 ```
 
 Using this code only:
 
 ```ruby
-class Recipies < APICake::Base
-  base_url 'api.recipies.com'
+class Recipes < APICake::Base
+  base_uri 'api.recipes.com'
 end
 ```
 
@@ -78,20 +77,20 @@ URL.
 For example:
 
 ```ruby
-class Recipies << APICake::Base
-  base_url 'api.recipies.com/v1'
+class Recipes << APICake::Base
+  base_uri 'api.recipes.com/v1'
 end
 
-recipies = Rcipies.new
+recipes = Recipes.new
 
-# This will access http://api.recipies.com/v1/cakes
-recipies.cakes
+# This will access http://api.recipes.com/v1/cakes
+recipes.cakes
 
-# This will access http://api.recipies.com/v1/cakes/chocolate
-recipies.cakes 'chocolate'
+# This will access http://api.recipes.com/v1/cakes/chocolate
+recipes.cakes 'chocolate'
 
-# This will access http://api.recipies.com/v1/cakes/chocolate?layers=3
-recipies.cakes 'chocolate', layers: 3
+# This will access http://api.recipes.com/v1/cakes/chocolate?layers=3
+recipes.cakes 'chocolate', layers: 3
 ```
 
 See the [Examples folder][1] for more examples.
@@ -113,9 +112,25 @@ For a detailed explanation of the services and methods you get when inheriting
 from `APICake::Base`, see the [class documentation][4].
 
 
+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])
+
+
 ---
 
 [1]: https://github.com/DannyBen/apicake/tree/master/examples
 [2]: https://github.com/DannyBen/lightly
 [3]: https://github.com/DannyBen/apicake/blob/master/examples/04-caching.rb
-[4]: http://www.rubydoc.info/gems/apicake/APICake/Base
+[4]: http://www.rubydoc.info/gems/apicake/0.1.1/APICake/Base
+[5]: https://github.com/DannyBen/fredric
+[6]: https://github.com/DannyBen/intrinio
+[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

data/lib/apicake/base.rb

@@ -1,14 +1,14 @@
-require 'httparty'
-require 'lightly'
+require "httparty"
+require "lightly"
 
 module APICake
   # To create your API wrapper, make a class that inherit from this class.
-  # 
-  # This class includes the HTTParty module, and the only requirement, 
+  #
+  # This class includes the HTTParty module, and the only requirement,
   # is that you call +base_uri+ to define the base URI of the API.
   #
   # === Example
-  # 
+  #
   #   class Client < APICake::Base
   #     base_uri: 'http://some.api.com/v3'
   #   end
@@ -20,20 +20,19 @@ module APICake
     # {#get}, {#get!}, {#get_csv} or {#save_csv}
     #
     # === Example
-    # 
+    #
     #   client = Client.new
     #   client.some_path, param: value
     #   p client.last_payload
     #   # => a Payload object
     #
     attr_reader :last_payload
-    
 
     # Holds the last URL that was downloaded by the last call to
     # {#get}, {#get!}, {#get_csv} or {#save_csv}.
     #
     # === Example
-    # 
+    #
     #   client = Client.new
     #   client.some_path, param: value
     #   p client.last_url
@@ -42,27 +41,27 @@ module APICake
     attr_reader :last_url
 
     # Any undefined method call will be delegated to the {#get} method.
-    # 
+    #
     # === Example
-    # 
+    #
     # This:
     #
     #   client = Client.new
-    #   client.path 'optional_sub_path', optional_param: value, optional_param: value 
+    #   client.path 'optional_sub_path', optional_param: value, optional_param: value
     #
     # Is equivalent to this:
-    #  
-    #   client.get 'path/optional_sub_path', optional_param: value, optional_param: value 
+    #
+    #   client.get 'path/optional_sub_path', optional_param: value, optional_param: value
     #
     def method_missing(method_sym, *arguments, &_block)
       get "/#{method_sym}", *arguments
     end
 
-    # This is the {https://github.com/DannyBen/lightly Lightly} cache object. 
+    # This is the {https://github.com/DannyBen/lightly Lightly} cache object.
     # You can access or modify cache settings with this object.
     #
     # === Example
-    # 
+    #
     #   client = Client.new
     #   client.cache.life = 3600
     #   client.cache.dir = './cache'
@@ -73,42 +72,42 @@ module APICake
       @cache ||= Lightly.new
     end
 
-    # Override this method in order to merge parameters into the query 
+    # Override this method in order to merge parameters into the query
     # string before each call.
     #
     # === Example
     #
     #   class Client < APICake::Base
-    #     base_uri: 'http://some.api.com/v3'      
-    #  
+    #     base_uri: 'http://some.api.com/v3'
+    #
     #     def initialize(api_key)
     #       @api_key = api_key
     #     end
-    #  
+    #
     #     def default_query
     #       { api_key: @api_key }
     #     end
     #   end
-    #  
+    #
     #   client = Client.new 'secret'
     #   client.some_path param: 'value'
     #   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. 
+    # get request.
     #
     # === Eexample
     #
     #   class Client < APICake::Base
-    #     base_uri: 'http://some.api.com/v3'      
-    #  
+    #     base_uri: 'http://some.api.com/v3'
+    #
     #     def initialize(user, pass)
     #       @user, @pass = user, pass
     #     end
-    #  
+    #
     #     def default_params
     #       { basic_auth: { username: user, password: pass }
     #     end
@@ -124,7 +123,7 @@ module APICake
     # value.
     #
     # Normally, you should not have the need to use this method, since all
-    # unhandled method calls are handled by {#method_missing} and are 
+    # unhandled method calls are handled by {#method_missing} and are
     # delegated here.
     #
     # === Example
@@ -132,13 +131,13 @@ module APICake
     #   client = Client.new
     #   client.get 'path/to/resource', param: value, param: value
     #
-    def get(path, extra=nil, params={})
-      get!(path, extra, params).parsed_response
+    def get(path, extra = nil, params = {})
+      get!(path.clone, extra.clone, params.clone).parsed_response
     end
 
-    # Make a request or get it from cache, and return the entire {Payload} 
+    # Make a request or get it from cache, and return the entire {Payload}
     # object.
-    def get!(path, extra=nil, params={})
+    def get!(path, extra = nil, params = {})
       path, extra, params = normalize path, extra, params
       key = cache_key path, extra, params
 
@@ -146,16 +145,16 @@ module APICake
         http_get(path, extra, params)
       end
 
-      @last_url = @last_payload.request.last_uri.to_s
+      @last_url = @last_payload.request.uri.to_s
       @last_payload
     end
 
     # A shortcut to just get the constructed URL of the request.
-    # Note that this call will make the HTTP request (unless it is already 
+    # Note that this call will make the HTTP request (unless it is already
     # cached).
-    # 
+    #
     # If you have already made the request, you can use {#last_url} instead.
-    def url(path, extra=nil, params={})
+    def url(path, extra = nil, params = {})
       get! path, extra, params
       last_url
     end
@@ -167,22 +166,22 @@ module APICake
     #   client = Client.new
     #   client.save 'out.json', 'some/to/resource', param: value
     #
-    def save(filename, path, params={})
+    def save(filename, path, params = {})
       payload = get! path, nil, params
       File.write filename, payload.response.body
     end
 
     # This method uses {#get!} to download and parse the content. It then
-    # makes the best effort to convert the right part of the data to a 
+    # makes the best effort to convert the right part of the data to a
     # CSV string.
     #
-    # You can override this method if you wish to provide a different 
+    # 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'
+      if payload.response.code != "200"
         raise BadResponse, "#{payload.response.code} #{payload.response.msg}"
       end
 
@@ -191,7 +190,7 @@ module APICake
       unless response.is_a? Hash
         raise BadResponse, "Cannot parse response"
       end
-      
+
       data = csv_node response
 
       header = data.first.keys
@@ -203,14 +202,14 @@ module APICake
       result
     end
 
-    # Same as {#save}, only use the output of {#get_csv} instead of the 
+    # 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)
     end
 
-    # Determins which part of the data is best suited to be displayed 
-    # as CSV. 
+    # Determins which part of the data is best suited to be displayed
+    # as CSV.
     #
     # - If the response contains one or more arrays, the first array will
     #   be the CSV output
@@ -227,20 +226,20 @@ module APICake
     private
 
     # Make a call with HTTParty and return a payload object.
-    def http_get(path, extra=nil, params={})
+    def http_get(path, extra = nil, params = {})
       payload = self.class.get path, params
       APICake::Payload.new payload
     end
 
     # Normalize the three input parameters
-    def normalize(path, extra=nil, params={})
+    def normalize(path, extra = nil, params = {})
       if extra.is_a?(Hash) and 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/exceptions.rb

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

data/lib/apicake/payload.rb

@@ -3,14 +3,14 @@ module APICake
     attr_reader :request, :response, :headers, :parsed_response
 
     def initialize(response)
-      @request         = response.request
-      @headers         = response.headers
-      @response        = response.response
+      @request = response.request
+      @headers = response.headers
+      @response = response.response
       @parsed_response = response.parsed_response
     end
 
     def to_h
-      { request: request, response: response, headers: headers, 
+      { request: request, response: response, headers: headers,
         parsed_response: parsed_response }
     end
 

data/lib/apicake/version.rb

@@ -1,3 +1,3 @@
 module APICake
-  VERSION = "0.1.1"
-end
+  VERSION = "0.1.5"
+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,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: apicake
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.5
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-18 00:00:00.000000000 Z
+date: 2021-09-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lightly
@@ -38,118 +38,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.14'
-- !ruby/object:Gem::Dependency
-  name: runfile
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.8'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.8'
-- !ruby/object:Gem::Dependency
-  name: runfile-tasks
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.4'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.4'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.5'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.5'
-- !ruby/object:Gem::Dependency
-  name: rdoc
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.0'
-- !ruby/object:Gem::Dependency
-  name: byebug
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '9.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '9.0'
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.13'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.13'
-- !ruby/object:Gem::Dependency
-  name: require_all
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.4'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.4'
-- !ruby/object:Gem::Dependency
-  name: yard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.8'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.8'
 description: Build Dynamic API Wrappers
 email: db@dannyben.com
 executables: []
@@ -165,7 +53,9 @@ files:
 homepage: https://github.com/DannyBen/apicake
 licenses:
 - MIT
-metadata: {}
+metadata:
+  bug_tracker_uri: https://github.com/DannyBen/apicake/issues
+  source_code_uri: https://github.com/DannyBen/apicake
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -174,15 +64,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.0.0
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.6
+rubygems_version: 3.2.25
 signing_key: 
 specification_version: 4
 summary: API Building Toolkit