Skip to content
master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
lib
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Grape fragment cache.

Features

  • Grape fragment cache.

Installation

Add this line to your application's Gemfile:

gem 'grape-present_cache'

And then execute:

$ bundle

Or install it yourself as:

$ gem install grape-present-cache

Usage

module MyApi < Grape::API
  format :json

  include Grape::PresentCache

  resources :posts do
    desc "Return a post"
    get ":id" do
      post = Post.find(params[:id])
      present_cache(key: "post-#{post.id}", expires_in: 2.hours) do
        present :post, post, with: API::Entities::Post
      end
      present :meta, Meta.new, with: API::Entities::Meta
    end
  end
end

Grape::PresentCache will use the current endpoint path and method as cache key prefix.In this example, the cache key will be "#{namespace}":"#{route}":posts:#{:id}:get:post-#{post.id}.

##Configuration

By default GrapePresentCache will use an instance of ActiveSupport::Cache::MemoryStore in a non-Rails and Rails.cache in a Rails environment. You can configure it to use any other cache store.

Grape::PresentCache.configure do |config|
  config.cache = ActiveSupport::Cache::FileStore.new
end

TODO

  • Support other methods.(eg: expire, delete_matched, update...)
  • Rspec

Contributing

  1. Fork it ( https://github.com/u2/grape-present-cache/fork )
  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 a new Pull Request