apicake 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2e430833ce1d205a599a9790cf91c76c752f950b
-  data.tar.gz: 7329dbbb5fab3f75498ae43c2c93e74557a92ef1
+  metadata.gz: 40e714671fc06714a55011b766e49b9b9864f844
+  data.tar.gz: 44de7eae53d8dc0de613d8a50b7a1ec69b6d66b0
 SHA512:
-  metadata.gz: 772410ef64c4a957267f2b33e37e21565bc7e684e05cf5e7f695abdaeca5cf73b86237b213bf3ad41bfa530f0725bec7e1e2a20beea9b41bc02131828f82b447
-  data.tar.gz: e0bd4acf2f34a15aee3879468aef787ab7d958aa02342a6ed5e047459a5b1c810d4a0c37e90bd98da6c1b06345f12b4731038726c317b5380d839a99156120bb
+  metadata.gz: 72f08448fd1f559f837dfd6d689a86b4832d8b75e3259fabc82c7c2a23c2d6c512b9e9bce6e19921b39fab0726d6b8f409bba15938461d5a61e8c2cc31bf2c10
+  data.tar.gz: 6e5d65bd2804c5b325c96a3f459408f239f3b3f7b3984ed1c844b41d10a380f70aa33f6bab7cebb949001bc18d11bbad9cd0fa94b280bad36b2ff7912ef2af7d

data/README.md

@@ -93,11 +93,16 @@ recipies.cakes 'chocolate'
 recipies.cakes 'chocolate', layers: 3
 ```
 
+See the [Examples folder][1] for more examples.
+
 
 Caching
 --------------------------------------------------
 
-Documentation to be completed
+APICake uses [Lightly][2] for caching. By default, cached objects are stored
+in the `./cache` directory for 3600 seconds.
+
+See the [caching example][3].
 
 
 Method Reference
@@ -106,3 +111,8 @@ Method Reference
 Documentation to be completed
 
 
+---
+
+[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

data/lib/apicake/base.rb

@@ -5,37 +5,55 @@ module APICake
   class Base
     include HTTParty
 
-    attr_reader :last_payload
+    attr_reader :last_payload, :last_url
 
+    # Any undefined method will be delegated to the #get method
     def method_missing(method_sym, *arguments, &_block)
       get "/#{method_sym}", *arguments
     end
 
+    # This is the Lightly cache object. You can access or modify cache 
+    # settings with this object.
     def cache
       @cache ||= Lightly.new
     end
 
-    # Overridables
-    def default_params; {}; end
+    # Override this method in order to merge parameters into the query 
+    # string.
     def default_query;  {}; end
 
+    # Override this method in order to merge parameters into the HTTParty
+    # get request. 
+    # See http://www.rubydoc.info/github/jnunemaker/httparty/HTTParty/ClassMethods
+    def default_params; {}; end
+
+    # Make a request or get it from cache, and return the parsed response.
     def get(path, extra=nil, params={})
       get!(path, extra, params).parsed_response
     end
 
+    # Make a request or get it from cache, and return the entire payload 
+    # objkect.
     def get!(path, extra=nil, params={})
-      key = "#{self.class.base_uri}+#{path}+#{extra}+#{params}"
+      path, extra, params = normalize path, extra, params
+      key = cache_key path, extra, params
 
       @last_payload = cache.get key do
         http_get(path, extra, params)
       end
+
+      @last_url = @last_payload.request.last_uri.to_s
+      @last_payload
     end
 
+    # A shortcut to just get the constructed URL. Note that this call will
+    # make the request (unless it is already cached).
     def url(path, extra=nil, params={})
-      payload = get! path, extra, params
-      payload.request.last_uri.to_s
+      get! path, extra, params
+      last_url
     end
 
+    # Save the response body to a file
     def save(filename, path, params={})
       payload = get! path, nil, params
       File.write filename, payload.response.body
@@ -43,7 +61,14 @@ module APICake
 
     private
 
+    # Make a call with HTTParty and return a payload object.
     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={})
       if extra.is_a?(Hash) and params.empty?
         params = extra
         extra = nil
@@ -52,11 +77,17 @@ module APICake
       path = "#{path}/#{extra}" if extra
       path = "/#{path}" unless path[0] == '/'
 
-      params[:query] = default_query.merge params
+      query = default_query.merge params
+
+      params[:query] = query unless query.empty?
       params = default_params.merge params
 
-      payload = self.class.get path, params
-      APICake::Payload.new payload
+      [path, extra, params]
+    end
+
+    # The key for the cache object
+    def cache_key(path, extra, params)
+      "#{self.class.base_uri}+#{path}+#{extra}+#{params}"
     end
   end
 end

data/lib/apicake/version.rb

@@ -1,3 +1,3 @@
 module APICake
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: apicake
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-16 00:00:00.000000000 Z
+date: 2017-02-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lightly