wcc-api 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1d0d85a20f019b951bef1ae2da1975d22c541af6
-  data.tar.gz: adb5cd3c3c01bc1492488a56125429c9ba0647d8
+  metadata.gz: 74231ceb352ccd172873342f6505b620cf239380
+  data.tar.gz: d4ecba5f2d57c5ed15b361362e11e4dca1c17906
 SHA512:
-  metadata.gz: 74a49e4005e9a8b621aae1fb71513b30aa965e3a1575d58efaa1b7e2e7d03a967953a8b77c95eefbe56637510a870d3e168410fd2ef74cbfc2f024b038e93bd8
-  data.tar.gz: f65f84b847eb889eeb9e66284465427ccb73f072706a43dbaf02390461676f066b94f814ecb4c7905cac57a9d6b079c2a29a82b8b315df245acbb61967642797
+  metadata.gz: 50d9e33f6592e94854cc838ae7f5de355ad90c53b961da4de8cd3d6d8c87636f0e8655404c5bb04ab7331b5ab196b1b6c51da998e11119905247eadadd694092
+  data.tar.gz: fa178778ec21bb489148291e23dabb36c5e49b7b6d4c044e2e4584f18e93d43c9106f0f4953faf9572e6416282d34456d028823fae53029d98e006cc5f3a019c

data/lib/wcc/api/controller_helpers.rb

@@ -0,0 +1,15 @@
+module WCC::API
+  module ControllerHelpers
+
+    private def set_cache_headers(scope_or_record, options = {})
+      options = {public: true, must_revalidate: true}.merge!(options)
+
+      if expiry = options.delete(:expiry)
+        expires_in expiry, options.slice(:public, :must_revalidate)
+      end
+
+      fresh_when scope_or_record, options.slice(:etag, :public, :last_modified)
+    end
+
+  end
+end

data/lib/wcc/api/rspec/cache_header_examples.rb

@@ -0,0 +1,41 @@
+RSpec.shared_examples_for "cached resource defaults" do
+  it "sets etag" do
+    expect(response.etag).to_not be_nil
+  end
+
+  it "sets public: true" do
+    expect(response.cache_control[:public]).to be_truthy
+  end
+end
+
+RSpec.shared_examples_for "cached member resource" do
+  include_examples "cached resource defaults"
+
+  it "sets last modified" do
+    expect(response.last_modified).to_not be_nil
+  end
+
+  it "does not set max age" do
+    expect(response.cache_control[:max_age]).to be_nil
+  end
+
+  it "does not set must_revalidate" do
+    expect(response.cache_control[:must_revalidate]).to be_nil
+  end
+end
+
+RSpec.shared_examples_for "cached collection resource" do |max_age|
+  include_examples "cached resource defaults"
+
+  it "sets max age" do
+    expect(response.cache_control[:max_age]).to eq(max_age.to_s)
+  end
+
+  it "sets must_revalidate: true" do
+    expect(response.cache_control[:must_revalidate]).to be_truthy
+  end
+
+  it "does not set last modified" do
+    expect(response.last_modified).to be_nil
+  end
+end

data/lib/wcc/api/rspec.rb

@@ -1,3 +1,4 @@
-require 'wcc/api/rspec/pagination_examples'
+require 'wcc/api/rspec/cache_header_examples'
 require 'wcc/api/rspec/collection_matchers'
+require 'wcc/api/rspec/pagination_examples'
 

data/lib/wcc/api/version.rb

@@ -1,5 +1,5 @@
 module WCC
   module API
-    VERSION = "0.1.1"
+    VERSION = "0.2.0"
   end
 end

data/lib/wcc/api.rb

@@ -13,5 +13,6 @@ end
 
 require 'wcc/api/base_query'
 require 'wcc/api/json'
+require 'wcc/api/controller_helpers'
 require 'wcc/api/view_helpers'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wcc-api
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Watermark Dev Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-12 00:00:00.000000000 Z
+date: 2015-06-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: wcc-base
@@ -66,10 +66,12 @@ files:
 - Rakefile
 - lib/wcc/api.rb
 - lib/wcc/api/base_query.rb
+- lib/wcc/api/controller_helpers.rb
 - lib/wcc/api/json.rb
 - lib/wcc/api/json/pagination.rb
 - lib/wcc/api/railtie.rb
 - lib/wcc/api/rspec.rb
+- lib/wcc/api/rspec/cache_header_examples.rb
 - lib/wcc/api/rspec/collection_matchers.rb
 - lib/wcc/api/rspec/pagination_examples.rb
 - lib/wcc/api/version.rb