groot 1.0.0.beta

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6d417b0a6033a346014fa1da80643f88d33782e5
+  data.tar.gz: 416dfd442d194ac7c3413b716b1cf6cf34dbe7ec
+SHA512:
+  metadata.gz: c01092415acfe65c21a32192b0cf463d425db972d77ab27acd098ca66cf0e7fddefcb6c4f972576368f41a28e62fe083d711b6eb827bfef39f5c9ec6887dd386
+  data.tar.gz: f8c04a188fcb95c80bd9d1c8cf6ae16e7e4b4676948caa8e6363961be5f986942b07ece7afe887990e5968284bc184a6d47710277379d46c58d26e72c6abecc5

data/.gitignore

@@ -0,0 +1,16 @@
+.bundle/
+log/*.log
+pkg/
+/Gemfile.lock
+spec/dummy/db/*.sqlite3
+spec/dummy/db/*.sqlite3-journal
+spec/dummy/log/*.log
+spec/dummy/tmp/
+*.gem
+
+
+
+
+.DS_Store
+dump.rdb
+

data/Gemfile

@@ -0,0 +1,14 @@
+source 'https://rubygems.org'
+
+# Declare your gem's dependencies in groot.gemspec.
+# Bundler will treat runtime dependencies like base dependencies, and
+# development dependencies will be added by default to the :development group.
+gemspec
+
+# Declare any dependencies that are still in development here instead of in
+# your gemspec. These might include edge Rails or gems from your path or
+# Git. Remember to move these dependencies to your gemspec before releasing
+# your gem to rubygems.org.
+
+# To use a debugger
+# gem 'byebug', group: [:development, :test]

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2017 Alisson Bruno
+
+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,57 @@
+# Groot
+Groot is a simple gem to help you authenticate using [JWT](https://github.com/jwt/ruby-jwt).
+## Installation
+
+Add it to your Gemfile:
+
+```ruby
+gem 'groot'
+```
+
+Run the following command to install it:
+```console
+bundle install
+```
+
+Run the generator:
+```console
+rails generate groot:install
+```
+
+## Usage
+In the following command you should replace MODEL with your user application class
+```console
+rails generate groot:auth MODEL
+```
+Take a look at the MODEL and if you want, you can add any additional configuration to it.
+Add the following line to your routes.rb file (assuming your model is 'Admin'):
+```console
+    auth_for :admins 
+```
+It will create the routes to Groot controllers.
+
+
+### Filter and Helpers
+Groot will create a filter for user authentication, to configure it just add the following line to your controller: (assuming again that your model is Admin):
+
+```ruby
+before_action :authenticate_admin!
+```
+Groot will also create some helpers to make your life easier.
+
+To get the current signed-in user:
+```ruby
+current_admin
+```
+To verify if there is a user signed in:
+```ruby
+admin_signed_in?
+```
+## ORMs
+So far Groot only supports ActiveRecord.
+
+## Contributing
+Bug reports and pull requests are welcome on GitHub at https://github.com/alissonbrunosa/groot.
+
+## License
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,37 @@
+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    = 'Groot'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+load 'rails/tasks/statistics.rake'
+
+
+
+require 'bundler/gem_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/app/controllers/groot/auth_controller.rb

@@ -0,0 +1,28 @@
+module Groot
+  class AuthController < ApplicationController
+
+    # TODO Do something to get the real model 
+    def create
+      user = resource_class.find_by(email: params[:email])
+      if(user && user.authenticate(params[:password]))
+        render json: { user: user, access_token: encode(user) } , status: :ok
+      else
+        render json: { message: 'Email/Password incorrect.' }, status: :forbidden
+      end
+    end
+
+    def destroy
+      raise NotImplementedError
+    end
+
+
+    private
+      def resource_class
+        mapping.clazz
+      end
+
+      def mapping
+        @mapping ||= request.env['groot.mapping']
+      end
+  end
+end

data/app/helpers/groot/application_helper.rb

@@ -0,0 +1,4 @@
+module Groot
+  module ApplicationHelper
+  end
+end

data/app/jobs/groot/application_job.rb

@@ -0,0 +1,4 @@
+module Groot
+  class ApplicationJob < ActiveJob::Base
+  end
+end

data/app/mailers/groot/application_mailer.rb

@@ -0,0 +1,6 @@
+module Groot
+  class ApplicationMailer < ActionMailer::Base
+    default from: 'from@example.com'
+    layout 'mailer'
+  end
+end

data/app/views/layouts/groot/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Groot</title>
+  <%= stylesheet_link_tag    "groot/application", media: "all" %>
+  <%= javascript_include_tag "groot/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/bin/rails

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails gems
+# installed from the root of your application.
+
+ENGINE_ROOT = File.expand_path('../..', __FILE__)
+ENGINE_PATH = File.expand_path('../../lib/groot/engine', __FILE__)
+
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+
+require 'rails/all'
+require 'rails/engine/commands'

data/config/routes.rb

@@ -0,0 +1,2 @@
+Groot::Engine.routes.draw do
+end

data/groot.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+# Maintain your gem"s version:
+require "groot/version"
+
+# Describe your gem and declare its dependencies:
+Gem::Specification.new do |spec|
+  spec.name        = "groot"
+  spec.version     = Groot::VERSION
+  spec.authors     = ["Alisson Bruno"]
+  spec.email       = ["alissonbruno.sa@gmail.com"]
+
+  spec.summary     = "Simple token authentication and authorization"
+  spec.description = "Simple token authentication and authorization solution for Rails with JWT."
+  spec.homepage    = "https://github.com/alissonbrunosa/groot"
+  spec.license     = "MIT"
+
+  # spec.files = Dir["{app,config,db,lib}/**/*", "MIT-LICENSE", "Rakefile", "README.md"]
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.add_dependency "rails", "~> 5.0", ">= 5.0.0"
+  spec.add_dependency "jwt", "~> 1.5", ">= 1.5.6"
+  spec.add_dependency "bcrypt", "~> 3.1", ">= 3.1.7"
+
+  spec.add_development_dependency "sqlite3", "~> 1.3"
+end

data/lib/generators/groot/auth_generator.rb

@@ -0,0 +1,54 @@
+require 'rails/generators/active_record'
+
+module ActiveRecord
+  module Generators
+    class AuthGenerator < ActiveRecord::Generators::Base
+      namespace "groot:auth"
+      argument :attributes, type: :array, default: [], banner: "field:type field:type"
+      source_root File.expand_path("../templates", __FILE__)
+
+      class_option :parent, type: :string, desc: "The parent class for the generated model"
+
+      def create_migration_file
+        if(model_exists?)
+          migration_template "../templates/migration/migration_existing.rb", "db/migrate/add_groot_to_#{table_name}.rb"
+        else
+          migration_template "../templates/migration/create_migration.rb", "db/migrate/create_#{table_name}.rb"
+        end
+      end
+
+      def create_model_file
+        template "model.rb", model_path unless model_exists?
+      end
+
+
+      private 
+
+        def attributes_auth
+<<RUBY
+      t.string :email,              null: false, default: ""
+      t.string :password_digest, null: false, default: ""
+
+      t.string   :reset_password_token
+      t.datetime :reset_password_sent_at
+RUBY
+      end
+
+        def attributes_with_index
+          attributes.select { |a| !a.reference? && a.has_index? }
+        end
+
+        def model_exists?
+          File.exist?(File.join(destination_root, model_path))
+        end
+
+        def model_path
+          @model_path ||= File.join("app", "models", "#{file_path}.rb")
+        end
+
+        def parent_class_name
+          options[:parent] || "ApplicationRecord"
+        end
+    end
+  end
+end

data/lib/generators/groot/install_generator.rb

@@ -0,0 +1,12 @@
+module Groot
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      # namespace "groot:install"
+      source_root File.expand_path("../templates", __FILE__)
+
+      def copy_initializer_file
+        template "config.rb", "config/initializers/groot.rb"
+      end
+    end
+  end
+end

data/lib/generators/groot/templates/config.rb

@@ -0,0 +1,3 @@
+Groot.setup do |config|
+  config.hmac_secret = "<%= SecureRandom.hex(64) %>"
+end

data/lib/generators/groot/templates/migration/create_migration.rb

@@ -0,0 +1,14 @@
+class <%= migration_class_name %> < ActiveRecord::Migration[<%= ActiveRecord::Migration.current_version %>]
+  def change
+    create_table :<%= table_name %><%= primary_key_type %> do |t|
+<%= attributes_auth -%>
+
+<% attributes.each do |attribute| -%>
+      t.<%= attribute.type %> :<%= attribute.name %>
+<% end -%>
+    end
+    
+    add_index :<%= table_name %>, :email,                unique: true
+    add_index :<%= table_name %>, :reset_password_token, unique: true
+  end
+end

data/lib/generators/groot/templates/migration/migration_existing.rb

@@ -0,0 +1,20 @@
+class AddGrootTo<%= table_name.camelize %> < ActiveRecord::Migration[<%= ActiveRecord::Migration.current_version %>]
+  def self.up
+    change_table :<%= table_name %> do |t|
+<%= attributes_auth -%>
+
+<% attributes.each do |attribute| -%>
+      t.<%= attribute.type %> :<%= attribute.name %>
+<% end -%>
+    end
+
+    add_index :<%= table_name %>, :email,                unique: true
+    add_index :<%= table_name %>, :reset_password_token, unique: true
+  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/groot/templates/model.rb

@@ -0,0 +1,11 @@
+<% module_namespacing do -%>
+class <%= class_name %> < <%= parent_class_name.classify %>
+<% attributes.select(&:reference?).each do |attribute| -%>
+  belongs_to :<%= attribute.name %><%= ', polymorphic: true' if attribute.polymorphic? %><%= ', required: true' if attribute.required? %>
+<% end -%>
+<% attributes.select(&:token?).each do |attribute| -%>
+  has_secure_token<% if attribute.name != "token" %> :<%= attribute.name %><% end %>
+<% end -%>
+  has_secure_password
+end
+<% end -%>

data/lib/groot.rb

@@ -0,0 +1,27 @@
+require "groot/engine"
+
+module Groot
+  extend ActiveSupport::Autoload
+
+  autoload :Mapping
+
+  module Controllers
+    autoload :Helpers, 'groot/controllers/helpers'
+  end
+
+
+
+
+  mattr_accessor :hmac_secret
+  @@hmac_secret = nil
+
+  def self.setup
+    yield self
+  end
+
+  def self.mapping(resource)
+    mapping = Mapping.new(resource)
+    Controllers::Helpers.define_method(mapping)
+    mapping
+  end
+end

data/lib/groot/controllers/helpers.rb

@@ -0,0 +1,58 @@
+require 'jwt'
+
+module Groot
+  module Controllers
+    module Helpers
+      def self.define_method(mapping)
+        name = mapping.name
+        class_eval <<-METHODS, __FILE__, __LINE__ + 1
+          def authenticate_#{name}!
+            decode(http_token)
+          end
+          def #{name}_signed_in?
+            !!current_user
+          end
+          def current_#{name}
+            payload = decode(http_token)
+            @current_user ||= #{mapping.clazz}.find(payload["id"])
+          end
+        METHODS
+
+        ActiveSupport.on_load(:action_controller) do
+          if respond_to?(:helper_method)
+            helper_method "current_#{name}", "#{name}_signed_in?"
+          end
+        end
+      end
+
+      private
+
+      def http_token
+        @http_token ||= request.headers['Authorization'].split(' ').last if request.headers['Authorization'].present?
+      end 
+
+      def encode(resource)
+        payload = {
+          id: resource.id,
+          exp: (Time.now + 24.hours).to_i
+        }
+        JWT.encode(payload, Groot.hmac_secret, 'HS256')
+      end
+
+      def decode(token)
+        begin
+          options = { 
+            algorithm: 'HS256'
+          }
+          JWT.decode(token, Groot.hmac_secret, true, options).first
+        rescue JWT::ExpiredSignature
+          render json: { message: 'The token has expired.' }, status: :forbidden
+        rescue JWT::VerificationError
+          render json: { message: 'Invalid access token.' }, status: :forbidden
+        rescue JWT::DecodeError
+          render json: { message: 'Invalid access token.' }, status: :forbidden
+        end
+      end
+    end
+  end
+end

data/lib/groot/engine.rb

@@ -0,0 +1,12 @@
+require 'groot/rails/routes'
+module Groot
+  class Engine < ::Rails::Engine
+    isolate_namespace Groot
+
+    initializer "groot.add_helpers" do
+      ActiveSupport.on_load(:action_controller) do
+        include Controllers::Helpers
+      end
+    end
+  end
+end

data/lib/groot/mapping.rb

@@ -0,0 +1,22 @@
+module Groot 
+  class Mapping
+    attr_accessor :resource, :class_name, :path_names
+    def initialize(resource)
+      @resource = resource
+      @path_names = Hash.new { |h,k| h[k] = k.to_s }
+    end
+
+    def singular
+      resource.to_s.singularize
+    end
+    alias :name :singular
+
+    def class_name
+      @class_name ||= singular.classify
+    end
+
+    def clazz
+      @clazz ||= class_name.constantize
+    end
+  end
+end

data/lib/groot/rails/routes.rb

@@ -0,0 +1,22 @@
+module ActionDispatch::Routing
+  class Mapper
+    def auth_for(resource)
+      mapping = Groot.mapping(resource)
+      constraint = lambda do |request| 
+        request.env['groot.mapping'] = mapping 
+        true
+      end
+      constraints(constraint) do
+        auth_routes(mapping)
+      end
+    end
+
+    private 
+      def auth_routes(mapping) #:nodoc:
+        resource mapping.resource, only: [], controller: 'groot/auth' do 
+          post   :create,  path: mapping.path_names[:login]
+          delete :destroy, path: mapping.path_names[:logout]
+        end
+      end
+  end
+end

data/lib/groot/version.rb

@@ -0,0 +1,3 @@
+module Groot
+  VERSION = '1.0.0.beta'
+end

data/lib/tasks/groot_tasks.rake

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

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification
+name: groot
+version: !ruby/object:Gem::Version
+  version: 1.0.0.beta
+platform: ruby
+authors:
+- Alisson Bruno
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-02-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+- !ruby/object:Gem::Dependency
+  name: jwt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.5.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.5.6
+- !ruby/object:Gem::Dependency
+  name: bcrypt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.7
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+description: Simple token authentication and authorization solution for Rails with
+  JWT.
+email:
+- alissonbruno.sa@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/controllers/groot/auth_controller.rb
+- app/helpers/groot/application_helper.rb
+- app/jobs/groot/application_job.rb
+- app/mailers/groot/application_mailer.rb
+- app/views/layouts/groot/application.html.erb
+- bin/rails
+- config/routes.rb
+- groot.gemspec
+- lib/generators/.DS_Store
+- lib/generators/groot/auth_generator.rb
+- lib/generators/groot/install_generator.rb
+- lib/generators/groot/templates/.DS_Store
+- lib/generators/groot/templates/config.rb
+- lib/generators/groot/templates/migration/create_migration.rb
+- lib/generators/groot/templates/migration/migration_existing.rb
+- lib/generators/groot/templates/model.rb
+- lib/groot.rb
+- lib/groot/controllers/helpers.rb
+- lib/groot/engine.rb
+- lib/groot/mapping.rb
+- lib/groot/rails/routes.rb
+- lib/groot/version.rb
+- lib/tasks/groot_tasks.rake
+homepage: https://github.com/alissonbrunosa/groot
+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: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Simple token authentication and authorization
+test_files: []