tok 0.0.1.pre

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8f8d7c0073c47bf0076e05f6a2e5b0e8efc27969
+  data.tar.gz: 37421e1517b529672da047e6be6538916671b8e4
+SHA512:
+  metadata.gz: 94a39870d25f1817e861bf137e56df9b77c96cb3857426f805c7cb51af474064ddd99fc21eec39f63b5f8faba146f805c62a6a998b4b77215dd4ea539f6ad8a8
+  data.tar.gz: cec2214f4f1dafb913ab2bc24bb4622c67f25a8ecc62bbb16a5ed9fb408689ebabae96d9b7c2af52fa36bad62f2c95d2b7dc6dd821ef0e863da178795454c58a

data/.gitignore

@@ -0,0 +1,20 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/spec/dummy/db/seeds.rb
+/spec/dummy/db/migrate/*.rb
+/spec/dummy/Gemfile
+/spec/dummy/Gemfile.lock
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.ruby-version
+.ruby-gemset

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--require spec_helper
+--color

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+rvm:
+  - 2.1.3
+
+before_script:
+  - psql -c 'create database dummy_test;' -U postgres
+
+script:
+  - RAILS_ENV=test bundle exec rake db:migrate
+  - bundle exec rspec

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Ahmed Hazem
+
+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,62 @@
+# Tok
+
+No-frills token-based authentication for modern Rails applications.
+
+## Installation
+
+Tok works with (and is tested against) Rails > 4.0. To install, add this line to your Gemfile:
+
+```ruby
+gem 'tok'
+```
+
+Then run `bundle install`. You can always install the gem yourself by executing:
+
+    $ gem install tok
+
+## Usage
+
+First, run the generator by executing:
+
+    $ rails generate tok:install
+
+The generator by default does the following:
+
+- Inserts `Tok::Authentication` into `User` model (or creates one if not available)
+- Inserts `Tok::Controller` into your `ApplicationController`
+- Creates a number of default routes `signup`, `login`, and `logout`
+- Creates an initializer at `config/initializers/tok.rb` to allow further configuration
+
+A custom model can be specified by passing `--model` (or just `-m`) as an option to the generator:
+
+    $ rails generate tok:install -m Account
+    $ rails generate tok:install --model=Account
+
+In this case, the generator will also create a migration in order to create a table with the specified model pluralized.
+
+Next, run migrations by executing:
+
+    $ rake db:migrate
+
+### Configure
+
+To configure Tok, you can override defaults in your `config/initializers/tok.rb`. Be sure to check the initializer for further details into what values are used by default. 
+
+```ruby
+# Use the following configuration block to adjust Tok.
+Tok.configure do |config|
+  config.model = Account
+  config.bcrypt_cost = 8 
+  config.signup_route = "sign_up"
+  config.login_route = "sign_in"
+  config.logout_route = "sign_out"
+end
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/tok/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,22 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+namespace :db do
+  desc "Migrate /spec/dummy app's database"
+  task :migrate do
+    `cd spec/dummy && rake db:migrate` 
+  end
+
+  desc "Rollback /spec/dummy app's database"
+  task :rollback do
+    `cd spec/dummy && rake db:rollback` 
+  end
+
+  desc "Reset /spec/dummy app's development and test databases"
+  task :reset do
+    `cd spec/dummy && rake db:drop && rake db:create`
+  end
+end
+
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec

data/app/controllers/tok/base_controller.rb

@@ -0,0 +1,11 @@
+module Tok
+  class BaseController < ApplicationController 
+    include Tok::Controller
+
+    private
+
+    def model_params 
+      params.require(model_name.to_sym).permit(:email, :password)
+    end
+  end
+end

data/app/controllers/tok/sessions_controller.rb

@@ -0,0 +1,21 @@
+module Tok
+  class SessionsController < BaseController
+    # POST /login
+    def create
+      @model = model_class.authenticate(model_params)
+
+      if @model
+        render json: {token: @model.authentication_token}.to_json, status: :created
+      else
+        render json: {"error" => "Invalid email or password!"}.to_json, status: :unprocessable_entity 
+      end
+    end
+
+    # DELETE /logout
+    def destroy
+      current_user.reset_authentication_token if current_user
+
+      head :no_content
+    end
+  end
+end

data/app/controllers/tok/users_controller.rb

@@ -0,0 +1,14 @@
+module Tok
+  class UsersController < BaseController
+    # POST /signup
+    def create
+      @model = model_class.new(model_params)
+
+      if @model.save
+        render json: @model, status: :created
+      else
+        render json: @model.errors, status: :unprocessable_entity
+      end
+    end
+  end
+end

data/config/routes.rb

@@ -0,0 +1,5 @@
+Rails.application.routes.draw do
+  post   "#{Tok.configuration.signup_route}", to: "tok/users#create"
+  post   "#{Tok.configuration.login_route}",  to: "tok/sessions#create"
+  delete "#{Tok.configuration.logout_route}", to: "tok/sessions#destroy" 
+end

data/db/migrate/20141011022222_create_users.rb

@@ -0,0 +1,13 @@
+class CreateUsers < ActiveRecord::Migration
+  def change
+    create_table :users do |t|
+      t.string :email, null: false
+      t.string :encrypted_password, null: false
+      t.string :authentication_token
+      
+      t.timestamps
+    end
+
+    add_index :users, :email, unique: true 
+  end
+end

data/lib/generators/tok/install_generator.rb

@@ -0,0 +1,55 @@
+require 'rails/generators/migration'
+require 'rails/generators/active_record'
+
+module Tok
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+
+      source_root File.expand_path("../templates", __FILE__)
+
+      class_option :model, type: :string, aliases: "-m", desc: "Specify a model different than User"
+
+      def copy_initializer
+        template "tok.rb", "config/initializers/tok.rb"
+      end
+
+      def include_tok_into_application_controller
+        inject_into_class "app/controllers/application_controller.rb", ApplicationController, "  include Tok::Controller\n"
+      end
+
+      def create_or_include_tok_in_model
+        if File.exists?("app/models/#{model_file}")
+          inject_into_file "app/models/#{model_file}", "  include Tok::Authentication\n",
+                    after: "class #{model_name.classify} < ActiveRecord::Base"
+        else
+          template "model.rb", "app/models/#{model_file}"
+        end
+      end
+
+      def create_tok_migration
+        if options[:model]
+          migration_template "migration/create_model.rb", "db/migrate/create_#{options[:model].downcase.pluralize}.rb"
+        end
+      end
+
+      def self.next_migration_number(dir)
+        ActiveRecord::Generators::Base.next_migration_number(dir)
+      end
+
+      private
+
+      def model
+        options[:model].classify
+      end
+
+      def model_name
+        options[:model] || "user"
+      end
+
+      def model_file
+        "#{model_name.downcase}.rb"
+      end
+    end
+  end
+end

data/lib/generators/tok/templates/migration/create_model.rb

@@ -0,0 +1,13 @@
+class Create<%= model.pluralize %> < ActiveRecord::Migration
+  def change
+    create_table :<%= model.tableize %> do |t|
+      t.string :email, null: false
+      t.string :encrypted_password, null: false
+      t.string :authentication_token
+      
+      t.timestamps
+    end
+
+    add_index :<%= model.tableize %>, :email, unique: true
+  end
+end

data/lib/generators/tok/templates/model.rb

@@ -0,0 +1,3 @@
+class <%= model_name.classify %> < ActiveRecord::Base
+  include Tok::Authentication
+end

data/lib/generators/tok/templates/tok.rb

@@ -0,0 +1,38 @@
+# Use the following configuration block to adjust Tok.
+Tok.configure do |config|
+  # -- Model --
+  # If you used a model different than the already included `User` model, you
+  # have to specify the name of the model over here.
+  # Default: User
+  #
+  # config.model = 
+
+
+  # -- Bcrypt Cost --
+  # The cost factor for Bcrypt, defines how many rounds a password should be
+  # hashed.
+  # Default: 10
+  #
+  # config.bcrypt_cost = 
+ 
+
+  # -- Signup Route --
+  # The route to be used for handling creation of new users.
+  # Default: `signup`
+  #
+  # config.signup_route = 
+
+
+  # -- Login Route --
+  # The route to be used for handling authentication.
+  # Default: `login`
+  #
+  # config.login_route = 
+  
+
+  # -- Logout Route --
+  # The route to be used for logging users out.
+  # Default: `logout`
+  #
+  # config.logout_route = 
+end

data/lib/tok.rb

@@ -0,0 +1,19 @@
+require 'tok/engine'
+require 'tok/configuration'
+require 'tok/controller'
+require 'tok/authentication'
+require 'tok/version'
+
+module Tok
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configuration=(config)
+    @configuration = config
+  end
+
+  def self.configure
+    yield configuration
+  end
+end

data/lib/tok/authentication.rb

@@ -0,0 +1,53 @@
+module Tok
+  module Authentication
+    extend ActiveSupport::Concern
+
+    included do
+      attr_accessor :password
+
+      include Callbacks
+    end
+
+    module ClassMethods
+      def authenticate(params)
+        model = self.where(email: params[:email]).first
+        model if model && BCrypt::Password.new(model.encrypted_password) == params[:password]
+      end
+    end
+
+    module Callbacks
+      extend ActiveSupport::Concern
+
+      included do
+        before_save :encrypt_password
+        before_create :ensure_authentication_token
+      end
+    end
+
+    def reset_authentication_token
+      self.authentication_token = generate_authentication_token
+      self.save
+    end
+
+    private
+
+    def encrypt_password
+      self.encrypted_password = encrypt(password) if password.present?
+    end
+
+    def encrypt(password)
+      BCrypt::Password.create(password, cost: Tok.configuration.bcrypt_cost)
+    end
+
+    def ensure_authentication_token
+      self.authentication_token = generate_authentication_token if authentication_token.blank?
+    end
+
+    def generate_authentication_token
+      loop do
+        random = SecureRandom.urlsafe_base64(nil, false)
+        break random unless self.class.exists?(authentication_token: random)
+      end
+    end
+  end
+end

data/lib/tok/configuration.rb

@@ -0,0 +1,41 @@
+require 'bcrypt'
+
+module Tok
+  class Configuration
+    attr_accessor :model,
+                  :bcrypt_cost,
+                  :signup_route,
+                  :login_route,
+                  :logout_route
+
+    def model 
+      @model || ::User
+    end
+
+    def bcrypt_cost
+      if test_environment?
+        BCrypt::Engine::MIN_COST
+      else
+        @bcrypt_cost || BCrypt::Engine::DEFAULT_COST
+      end
+    end
+
+    def signup_route
+      @signup_route || "signup"
+    end
+
+    def login_route
+      @login_route || "login"
+    end
+
+    def logout_route
+      @logout_route || "logout"
+    end
+
+    private
+
+    def test_environment?
+      defined?(:Rails) && Rails.env.test?
+    end
+  end
+end