grape-shaman_cache 0.1.1

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-shaman_cache.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Victor Wang
+
+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,71 @@
+# Grape::ShamanCache
+
+## Features
+
+HTTP and server side cache integration for Grape and Jbuilder without Rails application.
+
+If you're not familiar with HTTP caching, ETags and If-Modified-Since, here are some resources.
+
+* [From Zero to API Cache w/ Grape & MongoDB in 10 Minutes](http://www.confreaks.com/videos/986-goruco2012-from-zero-to-api-cache-w-grape-mongodb-in-10-minutes)
+* [Doing HTTP Caching Right: Introducing httplib2](http://www.xml.com/lpt/a/1642)
+* [Introducing Rack::Cache](http://tomayko.com/writings/rack-cache-announce)
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'grape-shaman_cache'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install grape-shaman_cache
+
+remember to modify your config.ru file:
+
+```
+use Rack::ConditionalGet
+use Rack::ETag
+```
+
+## Usage
+
+```
+class Welcome < Grape::API
+
+  include Grape::ShamanCache
+
+  format :json
+  formatter :json, Grape::Formatter::Jbuilder
+
+  get :home, jbuilder: 'welcome/home' do
+    @banners = Article.banner.without_gifts
+    cache(key: [:v2, :home, @banners.last], expires_in: 2.hours) do
+      @banners
+    end
+  end
+
+end
+```
+
+## Configuration
+
+By default `Grape::ShamanCache` will use an instance of `ActiveSupport::Cache::MemoryStore` in a non-Rails application. You can configure it to use any other cache store.
+
+```
+Grape::ShamanCache.configure do |config|
+  config.cache = ActiveSupport::Cache::FileStore.new("tmp/cache")
+end
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/grape-shaman_cache.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'grape-shaman_cache/version'
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Victor Wang"]
+  gem.email         = ["wjp2013@gmail.com"]
+  gem.description   = %q{HTTP and server side cache integration for Grape and Rack applications}
+  gem.summary       = %q{HTTP and server side cache integration for Grape and Rack applications}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "grape-shaman_cache"
+  gem.require_paths = ["lib"]
+  gem.version       = Grape::ShamanCache::VERSION
+
+  gem.add_dependency "grape", ">= 0.6.1"
+  gem.add_dependency "jbuilder"
+  gem.add_dependency "activesupport"
+
+  gem.add_development_dependency "bundler", "~> 1.3"
+  gem.add_development_dependency "rake"
+end

data/lib/grape-shaman_cache.rb

@@ -0,0 +1,4 @@
+require "grape-shaman_cache/version"
+require "grape-shaman_cache/config"
+require "grape-shaman_cache/formatter"
+require "grape-shaman_cache/shaman_cache"

data/lib/grape-shaman_cache/config.rb

@@ -0,0 +1,103 @@
+module Grape
+  module ShamanCache
+
+      class << self
+        # Set the configuration options. Best used by passing a block.
+        #
+        # @example Set up configuration options.
+        # ShamanCache.configure do |config|
+        # config.cache = Rails.cache
+        # end
+        #
+        # @return [Config] The configuration object.
+        def configure
+          block_given? ? yield(ShamanCache::Config) : ShamanCache::Config
+        end
+        alias :config :configure
+      end
+
+      module Config
+        extend self
+
+        # Current configuration settings.
+        attr_accessor :settings
+
+        # Default configuration settings.
+        attr_accessor :defaults
+
+        @settings = {}
+        @defaults = {}
+
+        # Define a configuration option with a default.
+        #
+        # @example Define the option.
+        # Config.option(:cache, :default => nil)
+        #
+        # @param [Symbol] name The name of the configuration option.
+        # @param [Hash] options Extras for the option.
+        #
+        # @option options [Object] :default The default value.
+        def option(name, options = {})
+          defaults[name] = settings[name] = options[:default]
+
+          class_eval <<-RUBY
+            def #{name}
+              settings[#{name.inspect}]
+            end
+
+            def #{name}=(value)
+              settings[#{name.inspect}] = value
+            end
+
+            def #{name}?
+              #{name}
+            end
+          RUBY
+        end
+
+        # Returns the default cache store, either Rails.cache or an instance
+        # of ActiveSupport::Cache::MemoryStore.
+        #
+        # @example Get the default cache store
+        # config.default_cache
+        #
+        # @return [Cache] The default cache store instance.
+        def default_cache
+          if defined?(Rails) && Rails.respond_to?(:cache)
+            Rails.cache
+          else
+            ::ActiveSupport::Cache::MemoryStore.new
+          end
+        end
+
+        # Returns the cache, or defaults to Rails cache when running in Rails
+        # or an instance of ActiveSupport::Cache::MemoryStore otherwise.
+        #
+        # @example Get the cache.
+        # config.cache
+        #
+        # @return [Cache] The configured cache or a default cache instance.
+        def cache
+          settings[:cache] = default_cache unless settings.has_key?(:cache)
+          settings[:cache]
+        end
+
+        # Sets the cache to use.
+        #
+        # @example Set the cache.
+        # config.cache = Rails.cache
+        #
+        # @return [Cache] The newly set cache.
+        def cache=(cache)
+          settings[:cache] = cache
+        end
+
+        # Default cache options
+        option(:global_cache_options, :default => {})
+
+        # Default cache expiration time.
+        option(:expires_in, :default => nil)
+      end
+
+  end
+end

data/lib/grape-shaman_cache/formatter.rb

@@ -0,0 +1,23 @@
+# Rewrite Grape::Formatter::Jbuilder.call defined by 'grape-jbuilder' gem.
+module Grape
+  module Formatter
+    # For maximum performance we are fetching string from redis and return them with no parsing at all
+    module Jbuilder
+      def self.call(object, env)
+        @env      = env
+        @endpoint = env['api.endpoint']
+        # object is string means that we need to use cache
+        return object if object.is_a?(String)
+
+        if jbuilderable?
+          jbuilder do |template|
+            engine = ::Tilt.new(view_path(template), nil, view_path: env['api.tilt.root'])
+            engine.render(endpoint, {})
+          end
+        else
+          Grape::Formatter::Json.call object, env
+        end
+      end
+    end
+  end
+end

data/lib/grape-shaman_cache/shaman_cache.rb

@@ -0,0 +1,56 @@
+module Grape
+  module ShamanCache
+
+      extend ActiveSupport::Concern
+
+      included do
+        helpers do
+
+          # 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 = ActiveSupport::Cache.expand_cache_key(opts[:key])
+
+            # compare_etag(opts[:etag]) # Check if client has fresh version
+            # Check if client has fresh version
+
+            # Set Cache-Control
+            expire_time = opts[:expires_in] || default_expire_time
+            expires_in(expire_time, public: true)
+
+            # Try to fetch from server side cache
+            # MemCacheStore's write method supports the :raw option
+            # which tells the memcached server to store all values as strings.
+            cache = Grape::ShamanCache.config.cache
+            cache.fetch(cache_key, raw: true, expires_in: expire_time) do
+              Grape::Formatter::Jbuilder.call block, env
+            end
+          end
+
+        end
+      end
+
+
+  end
+end

data/lib/grape-shaman_cache/version.rb

@@ -0,0 +1,5 @@
+module Grape
+  module ShamanCache
+    VERSION = "0.1.1"
+  end
+end

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification
+name: grape-shaman_cache
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+  prerelease: 
+platform: ruby
+authors:
+- Victor Wang
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: grape
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.6.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.6.1
+- !ruby/object:Gem::Dependency
+  name: jbuilder
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: HTTP and server side cache integration for Grape and Rack applications
+email:
+- wjp2013@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- grape-shaman_cache.gemspec
+- lib/grape-shaman_cache.rb
+- lib/grape-shaman_cache/config.rb
+- lib/grape-shaman_cache/formatter.rb
+- lib/grape-shaman_cache/shaman_cache.rb
+- lib/grape-shaman_cache/version.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: HTTP and server side cache integration for Grape and Rack applications
+test_files: []