apicake 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5e37316523122c1cc0324208f5de204a9d6c837478dbb8b522410120487a1404
-  data.tar.gz: a0d5118f54fbd5af3d37d06e106f856c1fa3dc7d85f4ba3ccf56498808ed9f2a
+  metadata.gz: 2016b0c4a2652010b263db2d6e6d85804c2cfb23f9c8a8c0d66e55f443e4dee6
+  data.tar.gz: 56475f108cc6bb2ad7637005af0f58a73b0bd4cb1587c22f49ec50a61f1aafa3
 SHA512:
-  metadata.gz: bda6c3815dcb8c670883c0bf82b55bdcc32ce0461642149727253d8c4d1657c48ba9d7bec94b0a2b979a8030e42c72c6a2c78f02c429d9ff70dadb0509d21133
-  data.tar.gz: '0258f564a7ff9d17e60cbdaa8b0194f4b115494ddcb6fcf0fa38a9cdf00a1ab661f93c9efc3556de43b84d89c329ed92df28a19b023a2fefb4dec25b0b6937f2'
+  metadata.gz: 1345df60ac9a9cba25e27a846b14571c3c84e33fe124d4917ef198f0f8d471f2e59a855d5456b909739e29a1c37791f72a3455f30811ab03f70c338dddef0da4
+  data.tar.gz: c491ea7c9e46d9f028ae37723ffc3003226360714cf3d581a1448b54a981fc0392b488c2d28c71ee36abb9d072e34bc8cb3171d7c6f8b2f3d36862ebc9178e9a

data/README.md

@@ -2,9 +2,8 @@ API Cake - Build Dynamic API Wrappers
 ==================================================
 
 [![Gem Version](https://badge.fury.io/rb/apicake.svg)](https://badge.fury.io/rb/apicake)
-[![Build Status](https://travis-ci.com/DannyBen/apicake.svg?branch=master)](https://travis-ci.com/DannyBen/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)
-[![Test Coverage](https://api.codeclimate.com/v1/badges/07bd0f8653914ce703a6/test_coverage)](https://codeclimate.com/github/DannyBen/apicake/test_coverage)
 
 ---
 

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
 
@@ -151,11 +150,11 @@ module APICake
     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.3"
-end
+  VERSION = "0.1.4"
+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.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-11 00:00:00.000000000 Z
+date: 2021-09-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lightly
@@ -53,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:
@@ -62,15 +64,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.2.2
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.2.25
 signing_key: 
 specification_version: 4
 summary: API Building Toolkit