0.0
No commit activity in last 3 years
No release in over 3 years
Adds Rails like cookie support to grape api
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

Runtime

>= 4.1.0, ~> 4.1
>= 4.1.0, ~> 4.1
>= 1.3.0, ~> 1.3
 Project Readme

Grape::Cookies (Project-State: Proposal)

Make Rails cookie handling available for grape. cookies method will return an ActionDispatch::Cookies::CookieJar instead of Grape::Cookie.

The following classes will be monkey patched:

  • Grape::Endpoint
  • Grape::Request
  • Grape::Cookies is deleted if it exists
  • ActionDispatch::Cookies::CookieJar

Installation

Add this line to your application's Gemfile:

gem 'grape-cookies'

And then execute:

$ bundle

Or install it yourself as:

$ gem install grape-cookies

Usage

# Only needed if you want to use signed cookies
Grape::Cookies.configure do
  signed_cookie_salt 'signed cookie'
  encrypted_cookie_salt 'encrypted cookie'
  encrypted_signed_cookie_salt 'signed encrypted cookie'
  secret_key_base 'secret base'
  cookies_serializer :json
end

class API < Grape::API
  include Grape::Cookies::Ext::API
  
  
  get '/test' do
    cookies.signed['test_signed'] = '1234'
    cookies['test_unsigned_signed'] = 'unsigned_1234'
  end

end

When secret_key_base is not set and a cookie is signed an ArgumentError will be thrown.

Contributing

  1. Fork it ( https://github.com/faber-lotto/grape-cookies/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