grape-rails-cache 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9ed6145ae0b11da1d0d35a9611c67572a3ebd2c6
+  data.tar.gz: c9e5405e3375107967457509aa4051a17363311b
+SHA512:
+  metadata.gz: 37d20990ba391b0c4b7e628f673da0c89285362bc66711366934324948a908ba4968828d3bbd09b631fc31fd5e2157367b1f474f6d0469de4167fdcaa1636bf5
+  data.tar.gz: 35457c02458efced04c9aae8b29887b64c76f0096c72a859aecfcbf40f7af594729a71c600b091f6814c00612a15c05328b2633eaef291c24238ae450b2e3a9b

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in grape-rails-cache.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Monterail.com
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,45 @@
+# HTTP and server side cache integration for Grape and Rails
+
+## Features
+
+- HTTP Headers cache, ETag, Cache-Control, If-None-Match
+- Server side cache for response body
+
+
+## Installation
+
+Add this line to your rails application's Gemfile:
+
+    gem 'grape-rails-cache'
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+```ruby
+module MyApi < Grape::API
+  format :json
+
+  include Grape::Rails::Cache
+
+  resources :posts do
+    desc "Return a post"
+    get ":id" do
+      post = Post.find(params[:id])
+      cache(key: "api:posts:#{post.id}", etag: post.updated_at, expires_in: 2.hours) do
+        post # post.extend(PostRepresenter) etc, any code that renders response
+      end
+    end
+  end
+end
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/grape-rails-cache.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'grape/rails/cache/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "grape-rails-cache"
+  spec.version       = Grape::Rails::Cache::VERSION
+  spec.authors       = ["Tymon Tobolski"]
+  spec.email         = ["tymon.tobolski@monterail.com"]
+  spec.description   = %q{HTTP and server side cache integration for Grape and Rails}
+  spec.summary       = %q{HTTP and server side cache integration for Grape and Rails}
+  spec.homepage      = "https://github.com/monterail/grape-rails-cache"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "grape"
+  spec.add_dependency "activesupport"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/lib/grape-rails-cache.rb

@@ -0,0 +1 @@
+require "grape/rails/cache"

data/lib/grape/rails/cache.rb

@@ -0,0 +1,63 @@
+require "grape/rails/cache/version"
+require "grape/rails/cache/formatter"
+
+module Grape
+  module Rails
+    module Cache
+      extend ActiveSupport::Concern
+
+      included do
+        formatter :json, Grape::Rails::Cache::JsonFormatter
+
+        helpers do
+          def compare_etag(etag)
+            etag = Digest::SHA1.hexdigest(etag.to_s)
+            error!("Not Modified", 304) if request.headers["If-None-Match"] == etag
+
+            header "ETag", etag
+          end
+
+          # Based on actionpack/lib/action_controller/base.rb, line 1216
+          def expires_in(seconds, options = {})
+            cache_control = []
+            cache_control << "max-age=#{seconds}"
+            cache_control.delete("no-cache")
+            if options[:public]
+              cache_control.delete("private")
+              cache_control << "public"
+            else
+              cache_control << "private"
+            end
+
+            # This allows for additional headers to be passed through like 'max-stale' => 5.hours
+            cache_control += options.symbolize_keys.reject{|k,v| k == :public || k == :private }.map{ |k,v| v == true ? k.to_s : "#{k.to_s}=#{v.to_s}"}
+
+            header "Cache-Control", cache_control.join(', ')
+          end
+
+          def default_expire_time
+            2.hours
+          end
+
+          def cache(opts = {}, &block)
+            # HTTP Cache
+            cache_key = opts[:key]
+
+            if opts[:etag]
+              cache_key += ActiveSupport::Cache.expand_cache_key(opts[:etag])
+              compare_etag(opts[:etag]) # Check if client has fresh version
+            end
+
+            # Set Cache-Control
+            expires_in(opts[:expires_in] || default_expire_time, public: true)
+
+            # Try to fetch from server side cache
+            ::Rails.cache.fetch(cache_key, raw: true, expires_in: opts[:expires_in]) do
+              block.call.to_json
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/grape/rails/cache/formatter.rb

@@ -0,0 +1,12 @@
+module Grape
+  module Rails
+    module Cache
+      # For maximum performance we are fetching string from redis and return them with no parsing at all
+      module JsonFormatter
+        def self.call(object, env)
+          object.is_a?(String) ? object : MultiJson.dump(object)
+        end
+      end
+    end
+  end
+end

data/lib/grape/rails/cache/version.rb

@@ -0,0 +1,7 @@
+module Grape
+  module Rails
+    module Cache
+      VERSION = "0.1.0"
+    end
+  end
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: grape-rails-cache
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tymon Tobolski
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: grape
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: HTTP and server side cache integration for Grape and Rails
+email:
+- tymon.tobolski@monterail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- grape-rails-cache.gemspec
+- lib/grape-rails-cache.rb
+- lib/grape/rails/cache.rb
+- lib/grape/rails/cache/formatter.rb
+- lib/grape/rails/cache/version.rb
+homepage: https://github.com/monterail/grape-rails-cache
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.1.3
+signing_key: 
+specification_version: 4
+summary: HTTP and server side cache integration for Grape and Rails
+test_files: []
+has_rdoc: