phono 0.1 → 0.2

data/.gitignore

@@ -4,3 +4,4 @@ Thumbs.db
 *.gem
 .rvmrc
 ~*
+*.php

data/README.md

@@ -69,3 +69,10 @@ Get a resized and cropped version :
 You can also force the resize (with deformation) :
 
       "#{instance['picture']}?size=300x200&force=true"
+
+## Cache control
+
+All JSON responses are cached (5 minutes by default) for performance.
+You can override this timeout by passing the value you want as a 2nd parameter to the client's constructor :
+
+      Phono::Client.new('424242424242424242424242', 3600) # responses will be cached for 1 hour

data/lib/phono/client.rb

@@ -1,56 +1,67 @@
 require 'httparty'
+require 'httparty-icebox'
 require 'active_support'
+require 'active_support/core_ext/hash/keys'
 
 module Phono
-	class Client
-		include HTTParty
-
-		base_uri 'http://phono.phonoid.com/api'
-
-		def initialize(api_key)
-			@api_key  = api_key
-		end
-
-		def all(ref, params = {})
-			self.class.get("/#{ref}.json", {
-				:query => base_params.merge!(params)
-			})
-		end
-
-		def find(ref, id)
-			self.class.get("/#{ref}/#{id}.json", {
-				:query => base_params
-			})
-		end
-
-		def create(ref, attributes = {})
-			self.class.post("/#{ref}.json", {
-				:query => base_params.merge!({
-					ref.singularize.to_sym => attributes
-				})
-			})
-		end
-
-		def update(ref, id, params = {})
-			self.class.put("/#{ref}/#{id}.json", {
-				:query => base_params.merge!({
-					ref.singularize.to_sym => attributes
-				})
-			})
-		end
-
-		def destroy(ref, id)
-			self.class.delete("/#{ref}/#{id}.json", {
-				:query => base_params
-			})
-		end
-
-		protected
-
-		def base_params
-			{
-				:api_key => @api_key
-			}
-		end
-	end
+  class Client
+    include HTTParty
+    include HTTParty::Icebox
+
+    base_uri 'http://phono.phonoid.com/api'
+
+    def initialize(api_key, params = {})
+      @api_key  = api_key
+
+      self.class.cache(:timeout => params[:cache_timeout] || 60)
+    end
+
+    def all(ref, params = {})
+      params.stringify_keys!
+      method = params.delete('cache').nil? ? :get : :get_without_caching
+
+      self.class.send(method, "/#{ref}.json", {
+        :query => base_params.merge!(params)
+      })
+    end
+
+    def find(ref, id, params = {})
+      params.stringify_keys!
+      method = params.delete('cache').nil? ? :get : :get_without_caching
+
+      self.class.send(method, "/#{ref}/#{id}.json", {
+        :query => base_params
+      })
+    end
+
+    def create(ref, attributes = {})
+      self.class.post("/#{ref}.json", {
+        :query => base_params.merge!({
+          ref.singularize.to_sym => attributes
+        })
+      })
+    end
+
+    def update(ref, id, params = {})
+      self.class.put("/#{ref}/#{id}.json", {
+        :query => base_params.merge!({
+          ref.singularize.to_sym => attributes
+        })
+      })
+    end
+
+    def destroy(ref, id)
+      self.class.delete("/#{ref}/#{id}.json", {
+        :query => base_params
+      })
+    end
+
+    protected
+
+    def base_params
+      {
+        :api_key => @api_key
+      }
+    end
+  end
 end

data/phono.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name    = %q{phono}
-  s.version = "0.1"
+  s.version = "0.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Aurélien Malisart"]
@@ -29,5 +29,6 @@ Gem::Specification.new do |s|
     s.specification_version = 3
     s.add_dependency(%q<httparty>)
     s.add_dependency(%q<activesupport>, '>= 2.0.0')
+    s.add_dependency(%q<httparty-icebox>)
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: phono
 version: !ruby/object:Gem::Version
-  version: '0.1'
+  version: '0.2'
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-02-04 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
-  requirement: &2163328660 !ruby/object:Gem::Requirement
+  requirement: &2164742740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2163328660
+  version_requirements: *2164742740
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &2163328120 !ruby/object:Gem::Requirement
+  requirement: &2164741160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +32,18 @@ dependencies:
         version: 2.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *2163328120
+  version_requirements: *2164741160
+- !ruby/object:Gem::Dependency
+  name: httparty-icebox
+  requirement: &2164739120 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2164739120
 description: Simple Ruby client for the Phono API
 email: aurelien.malisart@gmail.com
 executables: []