apicake 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2e6b6cb8fc605e0694774ccfb447a645c22514a8
-  data.tar.gz: e7331e6c9517f5eac47d26547ef944ec83fd5a4e
+  metadata.gz: 2e430833ce1d205a599a9790cf91c76c752f950b
+  data.tar.gz: 7329dbbb5fab3f75498ae43c2c93e74557a92ef1
 SHA512:
-  metadata.gz: 90526475b421ac3b3914af56455de4376fc82d9f377880b4aa353a19ece6b0932b593109a07adf8ce54368d58098bd836fd457a1f979a35fc11e2d610dc063dd
-  data.tar.gz: 2a43afac9912fd1ca3d9b0806993c74b0741acdaaff9b42e5a28bee9a71c627e3e63b22d7e5ae49b7a147f8f75257ef86ba2eb6877d699056084d03443bda5dc
+  metadata.gz: 772410ef64c4a957267f2b33e37e21565bc7e684e05cf5e7f695abdaeca5cf73b86237b213bf3ad41bfa530f0725bec7e1e2a20beea9b41bc02131828f82b447
+  data.tar.gz: e0bd4acf2f34a15aee3879468aef787ab7d958aa02342a6ed5e047459a5b1c810d4a0c37e90bd98da6c1b06345f12b4731038726c317b5380d839a99156120bb

data/README.md

@@ -1,6 +1,21 @@
 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)
+
+
+---
+
+This gem allows you to easily build rich API wrappers with minimal code.
+
+It is HTTParty with a Cake.
+
+---
+
+
 Install
 --------------------------------------------------
 
@@ -13,3 +28,81 @@ Or with bundler:
 ```ruby
 gem 'apicake'
 ```
+
+
+TL;DR
+--------------------------------------------------
+
+Turn this hypothetical API URL:
+
+```
+http://api.recipies.com/cakes?layers=3 
+```
+
+To this:
+
+```ruby
+Recipies.cakes layers:3
+```
+
+Using this code only:
+
+```ruby
+class Recipies < APICake::Base
+  base_url 'api.recipies.com'
+end
+```
+
+
+Features
+--------------------------------------------------
+
+- Uses HTTParty
+- Built in caching
+- Built in save to file
+- Built in response parsing (part of HTTParty)
+- Designed for GET-only APIs (e.g., data services)
+
+
+Usage
+--------------------------------------------------
+
+Create a class and inherit from `APICake::Base`.
+
+This class automatically includes HTTParty, so you can do whatever you do in
+HTTParty. In addition, the `APICake::Base` class defines a `method_missing`
+method, so any call to an undefined method, will simply be converted to a 
+URL.
+
+For example:
+
+```ruby
+class Recipies << APICake::Base
+  base_url 'api.recipies.com/v1'
+end
+
+recipies = Rcipies.new
+
+# This will access http://api.recipies.com/v1/cakes
+recipies.cakes
+
+# This will access http://api.recipies.com/v1/cakes/chocolate
+recipies.cakes 'chocolate'
+
+# This will access http://api.recipies.com/v1/cakes/chocolate?layers=3
+recipies.cakes 'chocolate', layers: 3
+```
+
+
+Caching
+--------------------------------------------------
+
+Documentation to be completed
+
+
+Method Reference
+--------------------------------------------------
+
+Documentation to be completed
+
+

data/lib/apicake/base.rb

@@ -5,21 +5,10 @@ module APICake
   class Base
     include HTTParty
 
-    @@disable_dynamic_methods = false
-
-    # Disable dynamic methods. This is enabled by default.
-    # The main reason you may want to disable it sometimes is for easier
-    # debugging.
-    def self.disable_dynamic_methods
-      @@disable_dynamic_methods = true
-    end
+    attr_reader :last_payload
 
     def method_missing(method_sym, *arguments, &_block)
-      if @@disable_dynamic_methods
-        super
-      else
-        get "/#{method_sym}", *arguments
-      end
+      get "/#{method_sym}", *arguments
     end
 
     def cache
@@ -30,6 +19,18 @@ module APICake
     def default_params; {}; end
     def default_query;  {}; end
 
+    def get(path, extra=nil, params={})
+      get!(path, extra, params).parsed_response
+    end
+
+    def get!(path, extra=nil, params={})
+      key = "#{self.class.base_uri}+#{path}+#{extra}+#{params}"
+
+      @last_payload = cache.get key do
+        http_get(path, extra, params)
+      end
+    end
+
     def url(path, extra=nil, params={})
       payload = get! path, extra, params
       payload.request.last_uri.to_s
@@ -40,17 +41,7 @@ module APICake
       File.write filename, payload.response.body
     end
 
-    def get(path, extra=nil, params={})
-      get!(path, extra, params).parsed_response
-    end
-
-    def get!(path, extra=nil, params={})
-      key = "#{path}+#{extra}+#{params}"
-
-      cache.get key do
-        http_get(path, extra, params)
-      end
-    end
+    private
 
     def http_get(path, extra=nil, params={})
       if extra.is_a?(Hash) and params.empty?
@@ -68,4 +59,4 @@ module APICake
       APICake::Payload.new payload
     end
   end
-end
+end

data/lib/apicake/payload.rb

@@ -9,11 +9,10 @@ module APICake
       @parsed_response = response.parsed_response
     end
 
-    def inspect
+    def to_h
       { request: request, response: response, headers: headers, 
         parsed_response: parsed_response }
     end
-    alias_method :to_h, :inspect
 
     def to_s
       parsed_response.to_s

data/lib/apicake/version.rb

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

metadata

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