simple_token_auth 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2aaf16b1c965cf81c5493fd2ea2631c88c603442
+  data.tar.gz: 13e203296f723ba40b6d26e66260b18624723877
+SHA512:
+  metadata.gz: 33b9131c03bb9b7b28c83f8c4c3c953a095c3de2c562cd530284e376ff11e45be70726cb8075424a3f7ecfcb4e355cf2659ffadc4752ef942cf1c036c1e26aa6
+  data.tar.gz: 6743e331d39a3854367b804f94cec344a434bb42d2a01f46028a52063a024546929b49c0c0a8b0fe8c9c8ef520cd8db6327cc9388c1f2d1ff2444dc0b5cd6e5c

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014 YOURNAME
+
+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/Rakefile

@@ -0,0 +1,32 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'SimpleTokenAuth'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/lib/generators/active_record/simple_token_auth_generator.rb

@@ -0,0 +1,15 @@
+require 'rails/generators/active_record'
+
+module ActiveRecord
+  module Generators
+    class SimpleTokenAuthGenerator < ActiveRecord::Generators::Base
+      source_root File.expand_path("../templates", __FILE__)
+
+      def append_to_token_authenticatable_model
+        inject_into_class "app/models/#{name}.rb", name.camelize.constantize, <<-END
+  include SimpleTokenAuth::TokenAuthenticatable
+END
+      end
+    end
+  end
+end

data/lib/generators/simple_token_auth/install_generator.rb

@@ -0,0 +1,39 @@
+require 'rails/generators/base'
+
+module SimpleTokenAuth
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+
+      source_root File.expand_path("../../templates", __FILE__)
+
+      desc "Generates a TokenAuth initializer and migrations for api_key"
+
+      def self.orm
+        Rails::Generators.options[:rails][:orm]
+      end
+
+      def self.orm_has_migration?
+        [:active_record].include? orm
+      end
+
+      def self.next_migration_number(path)
+        Time.now.utc.strftime("%Y%m%d%H%M%S")
+      end
+
+      def create_migration_file
+        if self.class.orm_has_migration?
+          migration_template 'migration.rb', 'db/migrate/simple_token_auth_migration.rb'
+        end
+      end
+
+      def copy_initializer
+        template "simple_token_auth.rb", "config/initializers/simple_token_auth.rb"
+      end
+
+      def copy_api_key_model
+        template "api_key.rb", "app/models/api_key.rb"
+      end
+    end
+  end
+end

data/lib/generators/simple_token_auth/simple_token_auth_generator.rb

@@ -0,0 +1,15 @@
+require 'rails/generators/named_base'
+
+module SimpleTokenAuth
+  module Generators
+    class SimpleTokenAuthGenerator < Rails::Generators::NamedBase
+      include Rails::Generators::ResourceHelpers
+
+      namespace 'simple_token_auth'
+      source_root File.expand_path("../templates", __FILE__)
+
+      desc 'Insert include for given NAME model'
+      hook_for :orm
+    end
+  end
+end

data/lib/generators/templates/api_key.rb

@@ -0,0 +1,30 @@
+class ApiKey < ActiveRecord::Base
+  belongs_to :token_authenticatable, polymorphic: true
+  before_create :renew
+
+  def expired?
+    expired_at < Time.now.utc
+  end
+
+  def renew!
+    renew
+    save!
+  end
+
+  private
+
+  def renew
+    generate_access_token
+    set_expiry_date
+  end
+
+  def set_expiry_date
+    self.expired_at = SimpleTokenAuth.expire_in.since
+  end
+
+  def generate_access_token
+    begin
+      self.access_token = SecureRandom.hex
+    end while self.class.exists?(access_token: access_token)
+  end
+end

data/lib/generators/templates/migration.rb

@@ -0,0 +1,12 @@
+class SimpleTokenAuthMigration < ActiveRecord::Migration
+  def change
+    create_table :api_keys do |t|
+      t.integer :token_authenticatable_id,  null: false
+      t.string :token_authenticatable_type, null: false
+      t.string :access_token,               null: false
+      t.datetime :expired_at
+      t.datetime :created_at
+    end
+    add_index :api_keys, :access_token, unique: true
+  end
+end

data/lib/generators/templates/simple_token_auth.rb

@@ -0,0 +1,14 @@
+SimpleTokenAuth.configure do |config|
+  config.find_scope_strategy = -> (scope_class, token) do
+    field, token = token.split('.')
+    scope = scope_class.find(field.to_i)
+    [scope, token]
+  end
+
+  config.after_authenticated_strategy = -> (scope, controller) do
+    # Devise way of after authenticated a user
+    controller.sign_in scope, {}
+  end
+
+  config.expire_in = 3.hours
+end

data/lib/simple_token_auth.rb

@@ -0,0 +1,28 @@
+require_relative 'simple_token_auth/configuration'
+require_relative 'simple_token_auth/helpers'
+
+module SimpleTokenAuth
+  extend Configuration
+  extend Helpers
+
+  class << self
+    def compare_token(a, b)
+      compare_token_strategy.(a, b)
+    end
+
+    def generate_authentication_token
+      generate_authentication_token_strategy.()
+    end
+
+    def find_scope(scope_class, token)
+      find_scope_strategy.(scope_class, token)
+    end
+
+    def after_authenticated(scope, controller)
+      after_authenticated_strategy.(scope, controller)
+    end
+  end
+end
+
+require_relative 'simple_token_auth/authenticate_with_token'
+require_relative 'simple_token_auth/token_authenticatable'

data/lib/simple_token_auth/authenticate_with_token.rb

@@ -0,0 +1,54 @@
+# Usage:
+#
+# class ApplicationController
+#   include SimpleTokenAuth::AuthenticateWithToken
+# end
+#
+# class UserController < ApplicationController
+#   prepend_before_action :authenticate_user_from_token!
+# end
+#
+module SimpleTokenAuth
+  module AuthenticateWithToken
+    def method_missing(method, *args, &block)
+      if m = method.to_s.match(/authenticate_(.+)_from_token!/)
+        send :authenticate_from_token!, m[1]
+      else
+        super
+      end
+    end
+
+    private
+
+    def authenticate_from_token!(scope_name)
+      scope_class = scope_name.camelize.constantize
+      authenticate_or_request_with_http_token do |token, options|
+        return false if token.blank?
+
+        scope, token  = *find_scope(scope_class, token)
+        authenticated = false
+
+        if scope
+          api_key = scope.api_key
+          authenticated = api_key && !api_key.expired? && compare_token(api_key.access_token, token)
+        end
+
+        after_authenticated(scope, self) if authenticated
+
+        authenticated
+      end
+    end
+
+    def after_authenticated(*args)
+      SimpleTokenAuth.after_authenticated(*args)
+    end
+
+    def find_scope(*args)
+      SimpleTokenAuth.find_scope(*args)
+    end
+
+    def compare_token(a, b)
+      SimpleTokenAuth.compare_token(a, b)
+    end
+  end
+end

data/lib/simple_token_auth/configuration.rb

@@ -0,0 +1,29 @@
+module SimpleTokenAuth
+  module Configuration
+    mattr_accessor :generate_authentication_token_strategy
+    mattr_accessor :compare_token_strategy
+    mattr_accessor :find_scope_strategy
+    mattr_accessor :after_authenticated_strategy
+    mattr_accessor :expire_in
+
+    class MissingConfiguration
+      def initialize(message)
+        @message = message
+      end
+
+      def call(*args)
+        raise NotImplementedError, @message
+      end
+    end
+
+    # Defaults
+    @@generate_authentication_token_strategy = -> { SimpleTokenAuth.friendly_token }
+    @@compare_token_strategy                 = -> (a, b) { SimpleTokenAuth.secure_compare(a, b) }
+    @@find_scope_strategy                    = MissingConfiguration.new("find_scope_strategy needs to be configured")
+    @@after_authenticated_strategy           = MissingConfiguration.new("after_authenticated_strategy needs to be configured")
+
+    def configure
+      yield self if block_given?
+    end
+  end
+end

data/lib/simple_token_auth/helpers.rb

@@ -0,0 +1,20 @@
+# https://github.com/plataformatec/devise
+#
+module SimpleTokenAuth
+  module Helpers
+    # Generate a friendly string randomly to be used as token.
+    def friendly_token
+      SecureRandom.urlsafe_base64(15).tr('lIO0', 'sxyz')
+    end
+
+    # constant-time comparison algorithm to prevent timing attacks
+    def secure_compare(a, b)
+      return false if a.blank? || b.blank? || a.bytesize != b.bytesize
+      l = a.unpack "C#{a.bytesize}"
+
+      res = 0
+      b.each_byte { |byte| res |= byte ^ l.shift }
+      res == 0
+    end
+  end
+end

data/lib/simple_token_auth/token_authenticatable.rb

@@ -0,0 +1,31 @@
+# Ensures a token is generated
+#
+# class User < ActiveRecord::Base
+#   include SimpleTokenAuth::TokenAuthenticatable
+# end
+#
+module SimpleTokenAuth
+  module TokenAuthenticatable
+    extend ActiveSupport::Concern
+
+    included do
+      before_save :ensure_api_key
+
+      has_one :api_key, as: :token_authenticatable
+    end
+
+    def auth_token
+      api_key.access_token
+    end
+
+    def renew_api_key
+      api_key.renew!
+    end
+
+    private
+
+    def ensure_api_key
+      build_api_key unless api_key.present?
+    end
+  end
+end

data/lib/simple_token_auth/version.rb

@@ -0,0 +1,3 @@
+module SimpleTokenAuth
+  VERSION = "0.0.3"
+end

data/lib/tasks/simple_token_auth_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :simple_token_auth do
+#   # Task goes here
+# end

data/test/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/test/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Rails.application.load_tasks

data/test/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/test/dummy/app/assets/javascripts/users.js

@@ -0,0 +1,2 @@
+// Place all the behaviors and hooks related to the matching controller here.
+// All this logic will automatically be available in application.js.

data/test/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */