toll 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6b41bcc7073e05f9526843c304438b7bb81d558e
+  data.tar.gz: 175b6d736cc1d7353182fcd0450197ad76fce2b5
+SHA512:
+  metadata.gz: 1a5f1675bf327e628a767611f5058a298079a87d06fdabd2b876d49fe1cf101e6272c4df637d06a1630377d2cd6e7ba66aaa90ae8d47ab07609d543f402ece6d
+  data.tar.gz: 097286e579359a2a70adeaa41568be6c6a0311e877debd0d27a6a8dc17e2da05a015a46aceebbc965bbdd4c78bf81e15e2dde661da0254dc96f155b1f62d5d40

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.1

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 toll.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Abraham Kuri
+
+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,39 @@
+# Toll
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/toll`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'toll'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install toll
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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/[my-github-username]/toll/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 @@
+require "bundler/gem_tasks"

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "toll"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/generators/active_record/templates/existing_migration.rb

@@ -0,0 +1,19 @@
+class AddTollTo<%= table_name.camelize %> < ActiveRecord::Migration
+  def self.up
+    change_table(:<%= table_name %>) do |t|
+      <%= migration_data -%>
+      <% attributes.each do |attribute| -%>
+        t.<%= attribute.type %> :<%= attribute.name %>
+      <% end -%>
+
+      # Uncomment below if timestamps were not included in your original model.
+      # t.timestamps
+    end
+  end
+
+  def self.down
+    # By default, we don't want to make any assumption about how to roll back a migration when your
+    # model already existed. Please edit below which fields you would like to remove in this migration.
+    raise ActiveRecord::IrreversibleMigration
+  end
+end

data/lib/generators/active_record/templates/migration.rb

@@ -0,0 +1,12 @@
+class TollCreate<%= table_name.camelize %> < ActiveRecord::Migration
+  def change
+    create_table(:<%= table_name %>) do |t|
+      <%= migration_data -%>
+      <% attributes.each do |attribute| -%>
+        t.<%= attribute.type %> :<%= attribute.name %>
+      <% end -%>
+
+      t.timestamps
+    end
+  end
+end

data/lib/generators/active_record/toll_generator.rb

@@ -0,0 +1,46 @@
+require 'rails/generators/active_record'
+require 'generators/toll/orm_helpers'
+
+module ActiveRecord
+  module Generators
+    class TollGenerator < ActiveRecord::Generators::Base
+      argument :attributes, :type => :array, :default => [], :banner => "field:type field:type"
+
+      include Toll::Generators::OrmHelpers
+
+      source_root File.expand_path("../templates", __FILE__)
+
+      def copy_toll_migration
+        if (behavior == :invoke && model_exists?) || (behavior == :revoke && migration_exists?(table_name))
+          migration_template "existing_migration.rb", "db/migrate/add_toll_to_#{table_name}.rb"
+        else
+          migration_template "migration.rb", "db/migrate/toll_create_#{table_name}.rb"
+        end
+      end
+
+      def generate_model
+        invoke "active_record:model", [name], :migration => false unless model_exists? && behavior == :invoke
+      end
+
+      def inject_toll_content
+        content = %q{  tollify}
+
+        class_path = if namespaced?
+                       class_name.to_s.split("::")
+                     else
+                       [class_name]
+                     end
+
+        indent_depth = class_path.size - 1
+        content = content.split("\n").map { |line| "  " * indent_depth + line } .join("\n") << "\n"
+        inject_into_class(model_path, class_path.last, content) if model_exists?
+      end
+
+      def migration_data
+      %Q{
+    ## Toll model fields
+    t.string :authentication_token}
+      end
+    end
+  end
+end

data/lib/generators/toll/install_generator.rb

@@ -0,0 +1,13 @@
+module Toll
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("../templates", __FILE__) 
+
+      desc "Creates a Toll initializer in your application"
+
+       def copy_initializer
+        template "toll.rb", "config/initializers/toll.rb"
+       end
+    end
+  end
+end

data/lib/generators/toll/orm_helpers.rb

@@ -0,0 +1,22 @@
+module Toll
+  module Generators
+    module OrmHelpers
+
+      def model_exists?
+        File.exists?(File.join(destination_root, model_path))
+      end
+
+      def migration_exists?(table_name)
+        Dir.glob("#{File.join(destination_root, migration_path)}/[0-9]*_*.rb").grep(/\d+_add_toll_to_#{table_name}.rb$/).first
+      end
+
+      def migration_path
+        @migration_path ||= File.join("db", "migrate")
+      end
+
+      def model_path
+        @model_path ||= File.join("app", "models", "#{file_path}.rb")
+      end
+    end
+  end
+end

data/lib/generators/toll/templates/toll.rb

@@ -0,0 +1,16 @@
+# Use this module to configure pager the available options
+#
+# Made with love by @icalialabs
+
+Toll.setup do |config|
+
+  # The keys to use for user authentication
+  # config.authentication_keys = [:email]
+  #
+
+  # Name of the authentication token attribute for the User
+  # config.authentication_token_attribute_name = :authentication_token
+  
+  # Authentication Token Length
+  # config.authentication_token_length = 64
+end

data/lib/generators/toll/toll_generator.rb

@@ -0,0 +1,13 @@
+module Toll
+  module Generators
+    class TollGenerator < Rails::Generators::NamedBase
+      include Rails::Generators::ResourceHelpers
+
+      namespace "toll"
+      desc "Creates a model with the given name with toll" <<
+           "includes migration files"
+
+     hook_for :orm
+    end
+  end
+end

data/lib/toll.rb

@@ -0,0 +1,29 @@
+module Toll
+
+  # The keys to use for user authentication
+  mattr_accessor :authentication_keys
+  @@authentication_keys = [:email]
+
+  # Name of the authentication token attribute for the User
+  mattr_accessor :authentication_token_attribute_name
+  @@authentication_token_attribute_name = :authentication_token
+
+  # Authentication Token Length
+  mattr_accessor :authentication_token_length
+  @@authentication_token_length = 64
+
+  # Method to configure Toll
+  def self.setup
+    yield self
+  end
+
+  # Method to generate a Token
+  #
+  def self.token(length = Toll.authentication_token_length)
+    SecureRandom.urlsafe_base64(length)
+  end
+end
+
+require "toll/version"
+require "toll/controllers/authenticable"
+require "toll/hooks"

data/lib/toll/controllers/authenticable.rb

@@ -0,0 +1,59 @@
+module Toll
+  module Controllers
+    module Authenticable
+
+      protected
+
+      def authenticate!
+        authenticate_with_token || render_unauthorized
+      end
+
+      def render_unauthorized
+        self.headers['WWW-Authenticate'] = 'Token realm="Application"'
+        render json: { errors: "Invalid session data" },
+          status: :unauthorized
+      end
+
+      def authenticate_with_token
+        authenticate_with_http_token do |token, options|
+
+          user = User.find_by(authentication_keys(options))
+
+          if user && secure_token_compare(user.send(Toll.authentication_token_attribute_name), token)
+            @current_user = user
+          end
+        end
+      end
+
+      def current_user
+        @current_user
+      end
+
+      def authenticated?
+        current_user.present?
+      end
+
+      private
+
+      # constant-time comparison algorithm to prevent timing attacks
+      # Thanks Devise
+      def secure_token_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
+
+      def authentication_keys(options = {})
+        {}.tap do |authentication_keys|
+          Toll.authentication_keys.each do |key|
+            authentication_keys[key] = options[key]
+          end
+        end
+      end
+    end
+  end
+end
+

data/lib/toll/hooks.rb

@@ -0,0 +1,5 @@
+require 'toll/interface'
+
+ActiveSupport.on_load :active_record do
+  include Toll::Interface
+end

data/lib/toll/interface.rb

@@ -0,0 +1,22 @@
+require "toll/models/authenticable"
+
+module Toll
+  module Interface
+
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+
+      def tollify
+        before_validation :ensure_authentication_token!
+
+        validates Toll.authentication_token_attribute_name, presence: true,
+                                                            uniqueness: true
+
+        include Toll::Models::Authenticable
+      end
+    end
+  end
+end

data/lib/toll/models/authenticable.rb

@@ -0,0 +1,55 @@
+module Toll
+  module Models
+    module Authenticable
+
+      # Updates the record authentication but:
+      #
+      # - Validation is skipped.
+      # - Callbacks are invoked.
+      # - updated_at/updated_on column is updated if that column is available.
+      # - Updates all the attributes that are dirty in this object.
+      #
+      def update_authentication_token_without_validations
+        generate_authentication_token!
+        update_attribute(Toll.authentication_token_attribute_name, self.send(Toll.authentication_token_attribute_name))
+      end
+
+      # Updates the record but:
+      #
+      # - Validations are skipped.
+      # - Callbacks are skipped.
+      # - updated_at/updated_on are not updated.
+      def update_authentication_token!
+        generate_authentication_token!
+        update_column(Toll.authentication_token_attribute_name, self.send(Toll.authentication_token_attribute_name))
+      end
+
+      # Method to authenticate the user
+      # It only updates the token
+      #
+      # We are making sure the user is a valid record, that's why
+      # the `save` call
+      def authenticate_with_token
+        generate_authentication_token!
+        save
+        self
+      end
+
+      # Not really convinced about the sign_out method name
+      alias_method :sign_out, :authenticate_with_token
+
+      private
+
+        def generate_authentication_token!
+          begin
+            self.send("#{Toll.authentication_token_attribute_name}=", Toll.token)
+          end while self.class.exists?(Toll.authentication_token_attribute_name => self.send(Toll.authentication_token_attribute_name))
+        end
+
+        def ensure_authentication_token!
+          generate_authentication_token!
+        end
+
+    end
+  end
+end

data/lib/toll/version.rb

@@ -0,0 +1,3 @@
+module Toll
+  VERSION = "0.1.0"
+end

data/toll.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'toll/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "toll"
+  spec.version       = Toll::VERSION
+  spec.authors       = ["Abraham Kuri"]
+  spec.email         = ["kurenn@icalialabs.com"]
+
+  spec.summary       = %q{Super simple yet powerful authentication for Rails APIs}
+  spec.description   = %q{It is a super simple solution to authenticate users on an API using Rails based authentication_with_token}
+  spec.homepage      = "https://github.com/IcaliaLabs/toll"
+  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_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: toll
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Abraham Kuri
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-08-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: It is a super simple solution to authenticate users on an API using Rails
+  based authentication_with_token
+email:
+- kurenn@icalialabs.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/generators/active_record/templates/existing_migration.rb
+- lib/generators/active_record/templates/migration.rb
+- lib/generators/active_record/toll_generator.rb
+- lib/generators/toll/install_generator.rb
+- lib/generators/toll/orm_helpers.rb
+- lib/generators/toll/templates/toll.rb
+- lib/generators/toll/toll_generator.rb
+- lib/toll.rb
+- lib/toll/controllers/authenticable.rb
+- lib/toll/hooks.rb
+- lib/toll/interface.rb
+- lib/toll/models/authenticable.rb
+- lib/toll/version.rb
+- toll.gemspec
+homepage: https://github.com/IcaliaLabs/toll
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Super simple yet powerful authentication for Rails APIs
+test_files: []
+has_rdoc: