json_api_resource_connections 0.3.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5464f3db319f337b50a49b11d643c6b667b25f24
-  data.tar.gz: 849c3f3dc0eebc242e7fa0b24a29bd5ca1b0a1db
+  metadata.gz: e7b6b129c190c2f8b7c19ca6d5a7fa8aac51fd2b
+  data.tar.gz: 140f813cb5c8e8ce1f6f9366e009b2431a766b55
 SHA512:
-  metadata.gz: 58861256f912031c5364396f1d7d1d2dbab728c77a095809176683f597706cd1ac4b3a428e3dd02e9a290b50848f8dfc47379cf97d50bf0c7e3a04ac5fd3aa83
-  data.tar.gz: bbc346515f3454d659f8c3edb5e144e73629b2a9e98f614566bc54a4a1c25ca037423698d50d4333252ab315366bbaf869c1e40aa646309013ff0d1ae0da2258
+  metadata.gz: c38fdb33bac91aba9d5f0ab10d091ee51dcedfdcfcbd375baaea7e0414cdb7963ddf52f04321b631aaff1cb864da40d7799533c63872e9880c669a1633087322
+  data.tar.gz: 63d512bde9bd0599b00c7ef3aa47a089fe7b0c164bd3fb9ecc0e6a193c1b39b17df90a83aa527da08f9f1e084b8a44db25bc6f79f69498dec96f3d45fb8b149c

data/Gemfile

@@ -5,7 +5,7 @@ gemspec
 
 gem 'rake'
 
-gem 'json_api_resource', path: "../json_api_resource"
+gem 'json_api_resource'
 
 group :test do
   gem 'simplecov'

data/README.md

@@ -1,8 +1,6 @@
 # JsonApiResourceConnections
 
-Complex connection behaviour to sit on top of [JsonApiResource](http://github.com/avvo/json_api_resource) v2.0. This makes circuitbreaker connections default and enables cache flallbacks to when the server replies with anything other than a 404
-
-TODO: Delete this and the text above, and describe your gem
+Complex connection behaviour to sit on top of [JsonApiResource](http://github.com/avvo/json_api_resource) v2.0. This makes circuitbreaker connections default and enables cache fallbacks to when the server replies with anything other than a 404
 
 ## Installation
 
@@ -24,7 +22,25 @@ And it should auto magically inject itself into `JsonApiResource::Resource`
 
 ## Usage
 
-### CacheProcessor
+Once the gem is included, it automatically injects its code into all `JsonApiResource`s, giving them default circuitbreaker connections. There are 3 major components and a couple handy helpers.
+
+### Helpers
+
+#### cache_fallback( *actions )
+
+Enables retreival of data from cache if the server connection fails. Passing no actions will enable cache fallbacks for everything. 
+
+Requires caching to be enabled as described in [setup](#setup).
+
+#### try_cache_first( *actions )
+
+Will force the resource to try to fetch the data requested from the cache first, before it tries to hit the server. Passing no actions will force trying caching for everything.
+
+Requires caching to be enabled as described in [setup](#setup).
+
+### Components
+
+#### CacheProcessor
 
 Cache Processor is the component that handles caching. `CompressedCacheProcessor` caches results in two pieces: the actual object and the ids for the action. So your `Snack.search(q: "cheezbergher")` call will cache as 
 ``` ruby
@@ -32,14 +48,28 @@ Cache Processor is the component that handles caching. `CompressedCacheProcessor
 
 # and
 
-"snack/search/1" => {id: 1, ... }
-"snack/search/2" => {id: 2, ... }
+"snack/search/id:1" => {id: 1, ... }
+"snack/search/id:2" => {id: 2, ... }
 ...
 ```
 
 When no id is present in the response, the full response will be cached.
 
-#### Setup
+#### CachedCircuitbreakerServerConnection
+
+New default connection. Calls the server, but if the request fails, it will drop all subsequent calls for 30 seconds. Failure is defined as any non-404 error; a 500 server error or any exception in the code will trip the circuitbreaker.
+
+If the request succeeds, it will try to cache the result using its cache_processor. If none is set up, no caching will occur. 
+
+See [setup](#setup) for enabling caching.
+
+#### CacheConnection
+
+Given an action, will try to fetch results from the cache via cache_processor. Is used as both fallback and cache first connection. 
+
+Requires caching to be enabled as described in [setup](#setup).
+
+## Setup
 
 In your `config/json_api_resource.rb` you will need to set up the cache layer for the `CacheProcessor`
 
@@ -59,19 +89,15 @@ module JsonApiResource
 end
 ```
 
-### Connections
-
-The default connection is the `CachedCircuitbreakerServerConnection`. It will prevent any more calls to the server if any non-404 error is returned for 30 seconds. If you assign cache_processor, the cache part will kick in and cache the results returnrd from the server. 
-
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To install this gem onto your local machine, run `bundle exec rake install`.
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/json_api_resource_connections.
+Bug reports and pull requests are welcome on GitHub at https://github.com/avvo]/json_api_resource_connections.
 
 
 ## License

data/lib/json_api_resource/cache_processor/compressed_cache_processor.rb

@@ -19,7 +19,7 @@ module JsonApiResource
             write_objects(client, action, result_set)
 
           else
-            cache.write key, result_set
+            write_blob(key, result_set)
           end
 
           result
@@ -37,11 +37,12 @@ module JsonApiResource
             if item.is_a? Integer
               # grab the actual object from cache
               key = item_cache_key(client, action, item)
-              cache.fetch key
+              attrs = cache.fetch key
+              client.new attrs
             # if they are not ids
             else
               # they have to be the full objects. return them
-              item
+              client.new item
             end
           end
           JsonApiClient::ResultSet.new(Array(set))
@@ -55,7 +56,7 @@ module JsonApiResource
           class_string = client.is_a?(Class) ? client.to_s : client.class.to_s
           class_string = class_string.underscore
           formatted_args = args.present? ? ordered_args(*args) : nil
-          "#{class_string}/#{action}/#{formatted_args}"
+          "connection::#{JsonApiResourceConnections::VERSION}/#{class_string}/#{action}/#{formatted_args}"
         end
 
         def item_cache_key(client, action, id)
@@ -79,9 +80,13 @@ module JsonApiResource
         def write_objects(client, action, result_set)
           result_set.each do |item|
             key = item_cache_key client, action, item["id"]
-            cache.write key, item
+            cache.write key, item.attributes
           end
         end
+
+        def write_blob(key, result_set)
+          cache.write key, result_set.map(&:attributes)
+        end
       end
     end
   end

data/lib/json_api_resource_connections/version.rb

@@ -1,3 +1,3 @@
 module JsonApiResourceConnections
-  VERSION = "0.3.0"
+  VERSION = "1.0.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: json_api_resource_connections
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Greg
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-04-21 00:00:00.000000000 Z
+date: 2016-05-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport