task_helper 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 51608c11313019a92faf2883d4eccefbff7ee436
-  data.tar.gz: 50fbda3969ac23aaeca972c5374f6dbc476a633f
+  metadata.gz: 0f0bec83e9bd57e8829c3c5a0193de45677cb253
+  data.tar.gz: ac45b04ad8a57b31affe767dc0816f3784bf6e2e
 SHA512:
-  metadata.gz: 9c2626aba9b0d710000be2c6d3f4c5fb82fb303dfbf101dd731f45be5fd56246560ac80048118354078d003709d95a0fae6a8c4a5943d1693a75727c664240fe
-  data.tar.gz: db5c31c47fcf0fe63196fd1e2bd13c34a66d88147559b2891674fd05c7ba32fcc70697e805b38953f6dc1b70be168561fa12ab25cbb8efbbadb486b1f16f2b7a
+  metadata.gz: d1967e11fb7593c068839c5e0574fd5653b65dd7aa2df5b38f346a4070a1227722b6c022aa54ba50800ead687ca829352d4c4cd914aa0c693488034ef4a5c10e
+  data.tar.gz: 79f758cb137743cc4a957f471986fec6516562dbd7ab30ae045661cf1f96d2e2fc5eea851fd7770c0675a43d44c5be926bf00fd5b3be93a2c167499838a35608

data/README.md

@@ -40,6 +40,27 @@ an ActiveRecord like fashion. Each class contains methods for fetching
 objects from the API, readers for attributes of retrieved objects,
 and methods to navigate between related resources.
 
+### Caching
+
+Each model manages a cache of calls to the API that it makes.
+The model's cache has a limit (the number of responses to be cached)
+and a timeout (the number of seconds until an individual response expires).
+By default, limit and timeout are set to zero (no caching). This can be
+changed for each model using `Model::set_cache`.
+
+For example
+
+    TaskHelper::Database.set_cache(limit: 5, timeout: 60)
+
+will cache up to five responses from the API's database resource, for
+up to 60 seconds each. This means, if you call `TashHelper::Database.all`
+10 times in 60 seconds, the gem will only contact the API once. After 60
+seconds, if you ask for all databases again, the cache will be refreshed.
+
+Changing the cache settings for one model does not affect the others.
+So, to cache all responses, each model must be individually configured
+to cache its responses.
+
 #### Database
 
 This class offers functionality to retrieve and interact with databases

data/lib/task_helper/api/cache.rb

@@ -1,13 +1,14 @@
 module TaskHelper
   module API
     class Cache
-      def initialize(limit: 10)
+      def initialize(limit: 0, **call_defaults)
         @limit = limit
+        @call_defaults = call_defaults
         @calls = []
       end
 
       def get(**args)
-        new_call = Call.new(args)
+        new_call = Call.new(@call_defaults.merge(args))
         cached_call = @calls.find { |call| call == new_call }
         if cached_call
           cached_call.run

data/lib/task_helper/api/call.rb

@@ -6,7 +6,7 @@ module TaskHelper
       attr_reader :route, :params, :time
       protected :route, :params
 
-      def initialize(route:, params: {}, timeout: 314, time: Time.now)
+      def initialize(route:, params: {}, timeout: 0, time: Time.now)
         @params = { rest_api_key: API.rest_api_key }.merge(params)
         if @params[:rest_api_key].nil?
           raise MissingAPIKey, "Rest API key not provided. " \

data/lib/task_helper/version.rb

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

data/spec/lib/task_helper/api/call_spec.rb

@@ -73,8 +73,9 @@ describe TaskHelper::API::Call do
       context 'request has been cached' do
         it 'should return the cached response' do
           expect(HTTParty).to receive(:get).once.and_return(response)
-          result = subject.run
-          expect(subject.run).to eq(result)
+          call = described_class.new(route: 'hello', timeout: 314)
+          result = call.run
+          expect(call.run).to eq(result)
         end
       end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: task_helper
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - JC Wilcox
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-08 00:00:00.000000000 Z
+date: 2015-07-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler