api-model 2.2.3 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 67b49931f63da3d0513936563bbd57b3d0d748d1
-  data.tar.gz: 35ac10fb3187252443df74c7e5d36efdb31ffdc4
+  metadata.gz: 52cac4da2cc85c6c496d340cb4cca2c4b6662de2
+  data.tar.gz: 6009b3cf582247c64c7f34b5b3eec4f4405a23b0
 SHA512:
-  metadata.gz: 593efe9fb7d5b3411400ac81269938bcffe17515c185f9c7724483d79195f1cb0401e6ff86b95a6157c19afe8863dbab55d446a0e312ad53b8083c5215ba946b
-  data.tar.gz: 8970ca96cb6f76534fe2d5a312c9e9aed4c49f784ec6c8fcfb631dfa303ceb704d95848ddad43b58e32aa648e55c69664eab5e60be2192a1f16ca87b92fc5fa0
+  metadata.gz: 5acbe5cfb9066089acdb1cccf1b663062052196287b28d7f04eae7f16fd47b94b37799b8160a525da52cddd02f42c234e4b9aff3ebb86fae0dd350ab9894cb84
+  data.tar.gz: d3da9f0ec5bd00b6114fae65cc8fee7cc7f0a6c0707f98815f85e556187a74fa344e8f47d20eab5ecf39c63125aafe2ee6058cc83f25b9dbb5c9af8dc73c23b0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    api-model (2.2.3)
+    api-model (2.3.0)
       activemodel (~> 4.1)
       activesupport (~> 4.1)
       hash-pipe (~> 0.0)
@@ -12,10 +12,10 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (4.1.7)
-      activesupport (= 4.1.7)
+    activemodel (4.1.8)
+      activesupport (= 4.1.8)
       builder (~> 3.1)
-    activesupport (4.1.7)
+    activesupport (4.1.8)
       i18n (~> 0.6, >= 0.6.9)
       json (~> 1.7, >= 1.7.7)
       minitest (~> 5.1)

data/README.md

@@ -215,6 +215,13 @@ something like this:
   end
 ```
 
+By default, the unique id for the cache store/fetch will be a combination of the path and parameters. If you want to override
+this, you can either redefine the `cache_id` method, or set the cache_id when making requests:
+
+```ruby
+  MyModel.get_json "/foo", { some_param: "bar" }, cache_id: "whatever!"
+```
+
 ### Headers
 
 ```ruby

data/api-model.gemspec

@@ -2,7 +2,7 @@ $:.push File.expand_path("../lib", __FILE__)
 
 Gem::Specification.new do |s|
   s.name        = "api-model"
-  s.version     = "2.2.3"
+  s.version     = "2.3.0"
   s.authors     = ["Damien Timewell", "Erik Rothoff Andersson"]
   s.email       = ["mail@damientimewell.com", "erik.rothoff@gmail.com"]
   s.licenses    = ['MIT']

data/lib/api_model/class_methods.rb

@@ -1,7 +1,6 @@
 module ApiModel
   module ClassMethods
 
-    # TODO - try to think of a more memorable name for this...
     def attribute_synonym(primary_method_name, *alternate_names)
       alternate_names.each do |alternate_name|
         alias_method "#{alternate_name}=".to_sym, "#{primary_method_name}=".to_sym
@@ -26,7 +25,7 @@ module ApiModel
     end
 
     def call_api(method, path, options={})
-      cache cache_id(path, options) do
+      cache options.delete(:cache_id) || cache_id(path, options) do
         request = HttpRequest.new path: path, method: method, config: api_model_configuration
         request.builder = options.delete(:builder) || api_model_configuration.builder || self
         request.options.deep_merge! options
@@ -35,7 +34,6 @@ module ApiModel
     end
 
     def cache_id(path, options={})
-      return @cache_id if @cache_id
       p = (options[:params] || {}).collect{ |k,v| "#{k}#{v}" }.join("")
       "#{path}#{p}"
     end

data/spec/api-model/api_model_spec.rb

@@ -296,10 +296,21 @@ describe ApiModel do
     end
   end
 
-  describe "cache_id" do
-    it 'should use options and the request path to create an identifier for the cache' do
+  describe "caching" do
+    it 'should use options and the request path to create an identifier for the cache_id' do
       BlogPost.cache_id("/box", params: { foo: "bar" }).should eq "/boxfoobar"
     end
+
+    it 'should use a custom cache key instead of the cache_id if it is present' do
+      BlogPost.should_not_receive :cache_id
+      VCR.use_cassette('posts') { BlogPost.get_json "http://api-model-specs.com/single_post", {}, cache_id: "custom_key" }
+    end
+
+    it 'should not pass custom cache_ids onto api requests' do
+      expect {
+        VCR.use_cassette('posts') { BlogPost.get_json "http://api-model-specs.com/single_post", {}, cache_id: "custom_key" }
+      }.to_not raise_error(Ethon::Errors::InvalidOption)
+    end
   end
 
   describe "successful?" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: api-model
 version: !ruby/object:Gem::Version
-  version: 2.2.3
+  version: 2.3.0
 platform: ruby
 authors:
 - Damien Timewell
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-18 00:00:00.000000000 Z
+date: 2014-11-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport