access_token 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: aed36edb392a0af5ee9c97a0190ecac3dad636d5
+  data.tar.gz: b8387c690fb472abc595061d3e25f4ab19a93fc0
+SHA512:
+  metadata.gz: 1bfeb8a5eec2377decee65cddfd0054deb0e99c134ef638ea8168539edd7e97079d57044cf86e3341beba2f8a689d9881bdc76ed7b7c1a8a9a761d13801e877a
+  data.tar.gz: 367b5a440d992b167e138126fa85f6e66657c4a9e83a193929aff9b9938c518c868ca3df6908522ed8b94ab386e625437bcfee649e46b7bf291d9d8d45648ed1

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.sqlite3

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+cache: bundler
+sudo: false
+rvm:
+  - 2.2.2
+services:
+  - redis-server
+  - memcached

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+# v0.1.0 - unreleased
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Nando Vieira
+
+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,169 @@
+# AccessToken
+
+[![Build Status](https://travis-ci.org/fnando/access_token.svg)](https://travis-ci.org/fnando/access_token)
+
+A simple and easy-to-use access token generator.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'access_token'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install access_token
+
+## Usage
+
+```ruby
+class ApplicationController < ActionController::Base
+  private
+
+  def access_token
+    @access_token ||= AccessToken.new(
+      request: request,
+      response: response,
+      secret: Rails.application.secrets.access_token_secret,
+      ttl: 3600
+    )
+  end
+
+  def current_user
+    @current_user
+  end
+
+  def authenticate!
+    @current_user = User.find_by_id(access_token.resolve)
+    return render(nothing: true, status: 401) unless current_user
+    access_token.update(current_user)
+  end
+end
+
+class AuthController < ApplicationController
+  def create
+    user = User.find_by_email(params[:email].to_s)
+            .try(:authenticate, params[:password].to_s)
+
+    if user
+      access_token.update(user)
+      render json: user
+    else
+      render nothing: true, status: 401
+    end
+  end
+end
+
+class ProfileController < ApplicationController
+  before_action :authenticate!
+
+  def show
+    render json: current_user
+  end
+end
+
+Rails.application.routes.draw do
+  get '/profile', to: 'profile#show'
+  post '/auth', to: 'auth#create'
+end
+```
+
+Now, testing authentication using [httpie](http://httpie.org).
+
+```
+$ http --form POST localhost:3000/auth email=john@example.com password=test
+HTTP/1.1 200 OK
+Bearer: 5A2tPbDOXrQSMH1WzsEhhPaw4rNa1sJ9j7OyAU6gr1kfaZM0xDiXUGuENKyKLC/rKuzhrDXG6FwehWhIWy3IMfhQ9n6FJwBCERlF1TavYo2lG0UM8Bz1/0vrz3DxJc/r
+Cache-Control: max-age=0, private, must-revalidate
+Connection: Keep-Alive
+Content-Length: 196
+Content-Type: application/json; charset=utf-8
+Date: Mon, 01 Jun 2015 00:22:12 GMT
+Etag: W/"a710bcbfd462f6c4f7fed6bd7cff32b5"
+Expires: Mon, 01 Jun 2015 01:22:12 GMT
+Server: WEBrick/1.3.1 (Ruby/2.2.2/2015-04-13)
+X-Content-Type-Options: nosniff
+X-Frame-Options: SAMEORIGIN
+X-Request-Id: e4a07ab3-fa31-4058-aad5-2bcb5ce1f16e
+X-Runtime: 0.102162
+X-Xss-Protection: 1; mode=block
+
+{
+    "created_at": "2015-06-01T00:08:46.308Z",
+    "email": "john@example.com",
+    "id": 1,
+    "password_digest": "$2a$10$ayl6Yj.Hu1s.sba11YuMpOwDX.fZ.zsj.lPAvyapgLf6FWZtin.FW",
+    "updated_at": "2015-06-01T00:08:46.308Z"
+}
+```
+
+You can use the bearer by setting the `Authorization` header.
+
+```
+$ http GET localhost:3000/profile Authorization:'Bearer 5A2tPbDOXrQSMH1WzsEhhPaw4rNa1sJ9j7OyAU6gr1kfaZM0xDiXUGuENKyKLC/rKuzhrDXG6FwehWhIWy3IMfhQ9n6FJwBCERlF1TavYo2lG0UM8Bz1/0vrz3DxJc/r'
+HTTP/1.1 200 OK
+Bearer: 5A2tPbDOXrQSMH1WzsEhhAgjsNRUhdJ6MZkah4PAU8840fSkebzmJpooRIkcc3csBafqjm5tR+nPbnydN1N378bXQtxvKr6m5doHp/rhCYYF+PbR72NE37Q/DpRgg577
+Cache-Control: max-age=0, private, must-revalidate
+Connection: Keep-Alive
+Content-Length: 196
+Content-Type: application/json; charset=utf-8
+Date: Mon, 01 Jun 2015 00:23:03 GMT
+Etag: W/"a710bcbfd462f6c4f7fed6bd7cff32b5"
+Expires: Mon, 01 Jun 2015 01:23:03 GMT
+Server: WEBrick/1.3.1 (Ruby/2.2.2/2015-04-13)
+X-Content-Type-Options: nosniff
+X-Frame-Options: SAMEORIGIN
+X-Request-Id: 45ee363e-5df5-4514-b625-d4eb1dcb2e2a
+X-Runtime: 0.024450
+X-Xss-Protection: 1; mode=block
+
+{
+    "created_at": "2015-06-01T00:08:46.308Z",
+    "email": "john@example.com",
+    "id": 1,
+    "password_digest": "$2a$10$ayl6Yj.Hu1s.sba11YuMpOwDX.fZ.zsj.lPAvyapgLf6FWZtin.FW",
+    "updated_at": "2015-06-01T00:08:46.308Z"
+}
+```
+
+Notice that a new bearer is returned every time you call `access_token.update(current_user)`.
+
+If you're using Redis or Memcached store, you can't use the same bearer twice.
+
+```
+$ http GET localhost:3000/profile Authorization:'Bearer 5A2tPbDOXrQSMH1WzsEhhPaw4rNa1sJ9j7OyAU6gr1kfaZM0xDiXUGuENKyKLC/rKuzhrDXG6FwehWhIWy3IMfhQ9n6FJwBCERlF1TavYo2lG0UM8Bz1/0vrz3DxJc/r'
+HTTP/1.1 401 Unauthorized
+Cache-Control: no-cache
+Connection: Keep-Alive
+Content-Length: 0
+Content-Type: text/plain; charset=utf-8
+Date: Mon, 01 Jun 2015 00:23:23 GMT
+Server: WEBrick/1.3.1 (Ruby/2.2.2/2015-04-13)
+X-Content-Type-Options: nosniff
+X-Frame-Options: SAMEORIGIN
+X-Request-Id: 401c9b61-824c-44a0-8cd2-faab545127cc
+X-Runtime: 0.024320
+X-Xss-Protection: 1; mode=block
+```
+
+Also, check out the `examples` directory.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/fnando/access_token/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

data/Rakefile

@@ -0,0 +1,9 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.test_files = FileList['./test/**/*_test.rb']
+end
+
+task :default => :test

data/access_token.gemspec

@@ -0,0 +1,32 @@
+require './lib/access_token/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'access_token'
+  spec.version       = AccessToken::VERSION
+  spec.authors       = ['Nando Vieira']
+  spec.email         = ['fnando.vieira@gmail.com']
+
+  spec.summary       = 'Access token for client-side and API authentication.'
+  spec.description   = spec.summary
+  spec.homepage      = 'http://rubygems.org/gems/access_token'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'parsel'
+  spec.add_development_dependency 'bundler', '~> 1.9'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'minitest'
+  spec.add_development_dependency 'minitest-utils'
+  spec.add_development_dependency 'rack-test'
+  spec.add_development_dependency 'sinatra'
+  spec.add_development_dependency 'activerecord'
+  spec.add_development_dependency 'sqlite3'
+  spec.add_development_dependency 'bcrypt'
+  spec.add_development_dependency 'pry-meta'
+  spec.add_development_dependency 'redis'
+  spec.add_development_dependency 'dalli'
+end

data/examples/rails-app/.gitignore

@@ -0,0 +1,17 @@
+# See https://help.github.com/articles/ignoring-files for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile '~/.gitignore_global'
+
+# Ignore bundler config.
+/.bundle
+
+# Ignore the default SQLite database.
+/db/*.sqlite3
+/db/*.sqlite3-journal
+
+# Ignore all logfiles and tempfiles.
+/log/*
+!/log/.keep
+/tmp

data/examples/rails-app/Gemfile

@@ -0,0 +1,13 @@
+source 'https://rubygems.org'
+
+gem 'rails', '4.2.1'
+gem 'sqlite3'
+gem 'sass-rails', '~> 5.0'
+gem 'uglifier', '>= 1.3.0'
+gem 'bcrypt', '~> 3.1.7'
+gem 'access_token', path: '../..'
+gem 'redis'
+
+group :development do
+  gem 'pry-meta'
+end

data/examples/rails-app/Gemfile.lock

@@ -0,0 +1,149 @@
+PATH
+  remote: ../..
+  specs:
+    access_token (0.1.0)
+      parsel
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionmailer (4.2.1)
+      actionpack (= 4.2.1)
+      actionview (= 4.2.1)
+      activejob (= 4.2.1)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+    actionpack (4.2.1)
+      actionview (= 4.2.1)
+      activesupport (= 4.2.1)
+      rack (~> 1.6)
+      rack-test (~> 0.6.2)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+      rails-html-sanitizer (~> 1.0, >= 1.0.1)
+    actionview (4.2.1)
+      activesupport (= 4.2.1)
+      builder (~> 3.1)
+      erubis (~> 2.7.0)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+      rails-html-sanitizer (~> 1.0, >= 1.0.1)
+    activejob (4.2.1)
+      activesupport (= 4.2.1)
+      globalid (>= 0.3.0)
+    activemodel (4.2.1)
+      activesupport (= 4.2.1)
+      builder (~> 3.1)
+    activerecord (4.2.1)
+      activemodel (= 4.2.1)
+      activesupport (= 4.2.1)
+      arel (~> 6.0)
+    activesupport (4.2.1)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    arel (6.0.0)
+    awesome_print (1.6.1)
+    bcrypt (3.1.10)
+    builder (3.2.2)
+    byebug (4.0.5)
+      columnize (= 0.9.0)
+    coderay (1.1.0)
+    columnize (0.9.0)
+    erubis (2.7.0)
+    execjs (2.5.2)
+    globalid (0.3.5)
+      activesupport (>= 4.1.0)
+    i18n (0.7.0)
+    json (1.8.2)
+    loofah (2.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.6.3)
+      mime-types (>= 1.16, < 3)
+    method_source (0.8.2)
+    mime-types (2.6.1)
+    mini_portile (0.6.2)
+    minitest (5.7.0)
+    nokogiri (1.6.6.2)
+      mini_portile (~> 0.6.0)
+    parsel (0.2.0)
+    pry (0.10.1)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    pry-byebug (3.1.0)
+      byebug (~> 4.0)
+      pry (~> 0.10)
+    pry-meta (0.0.10)
+      awesome_print
+      pry
+      pry-byebug
+      pry-remote
+    pry-remote (0.1.8)
+      pry (~> 0.9)
+      slop (~> 3.0)
+    rack (1.6.1)
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    rails (4.2.1)
+      actionmailer (= 4.2.1)
+      actionpack (= 4.2.1)
+      actionview (= 4.2.1)
+      activejob (= 4.2.1)
+      activemodel (= 4.2.1)
+      activerecord (= 4.2.1)
+      activesupport (= 4.2.1)
+      bundler (>= 1.3.0, < 2.0)
+      railties (= 4.2.1)
+      sprockets-rails
+    rails-deprecated_sanitizer (1.0.3)
+      activesupport (>= 4.2.0.alpha)
+    rails-dom-testing (1.0.6)
+      activesupport (>= 4.2.0.beta, < 5.0)
+      nokogiri (~> 1.6.0)
+      rails-deprecated_sanitizer (>= 1.0.1)
+    rails-html-sanitizer (1.0.2)
+      loofah (~> 2.0)
+    railties (4.2.1)
+      actionpack (= 4.2.1)
+      activesupport (= 4.2.1)
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (10.4.2)
+    redis (3.2.1)
+    sass (3.4.14)
+    sass-rails (5.0.3)
+      railties (>= 4.0.0, < 5.0)
+      sass (~> 3.1)
+      sprockets (>= 2.8, < 4.0)
+      sprockets-rails (>= 2.0, < 4.0)
+      tilt (~> 1.1)
+    slop (3.6.0)
+    sprockets (3.1.0)
+      rack (~> 1.0)
+    sprockets-rails (2.3.1)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      sprockets (>= 2.8, < 4.0)
+    sqlite3 (1.3.10)
+    thor (0.19.1)
+    thread_safe (0.3.5)
+    tilt (1.4.1)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+    uglifier (2.7.1)
+      execjs (>= 0.3.0)
+      json (>= 1.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  access_token!
+  bcrypt (~> 3.1.7)
+  pry-meta
+  rails (= 4.2.1)
+  redis
+  sass-rails (~> 5.0)
+  sqlite3
+  uglifier (>= 1.3.0)