Giter VIP home page Giter VIP logo

grape-rails-cache's Introduction

HTTP and server side cache integration for Grape and Rails Gem Version

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

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

grape-rails-cache's People

Contributors

chrisdebruin avatar chytreg avatar maruware avatar teamon avatar waynerobinson avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar

grape-rails-cache's Issues

Expires in issue

Issue:
On 304 response the max-age value is not set. In this situation client will consecutive make requests, but should't.

Solution:
We should invoke expires_in method before compare_etag.

default to cache_key

Any reason why you are not using cache_key instance method by default?

post = Post.find(params[:id])
cache(key: post.cache_key, etag: post.updated_at, expires_in: 2.hours) do
  post # post.extend(PostRepresenter) etc, any code that renders response
end

post.cache_key could also be used to generate etag since the key already includes the updated_at.

This would allow a nicer API:

post = Post.find(params[:id])
cache(post, expires_in: 2.hours) do
  post # post.extend(PostRepresenter) etc, any code that renders response
end

Double Escaping

When I try and run the example as in the documentation... it double escapes. Aka, the whole string returned by cache() is "" all over... :(

json format

Any reason why you call to_json yourself? What happens if we want to return an xml format instead? Should probably return a hash instead

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.