lockie 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fc55c292f0425ca3158d054001d53bd61f12e99c5dc43f8d2fc57262cfd367f2
+  data.tar.gz: 7e4e9b6c6df39bf3070617119ff6e191a5e3519228b6693526bfbb8a6ea0bc53
+SHA512:
+  metadata.gz: 7d5272797247572c2d7455b0be3556cfe7297691803d181c5d0cc77874642f59af78a884d5836f73d52a84734687c24ad34d49396e1185d41befc39d07c9f539
+  data.tar.gz: e3d304b82778ed8762c39873dedfb530eeee1d7732db2156562bfb949efbfa23880f8667d6d5fb7862351453cb721a51fe70680ecd867c9e1c29f29a9b6c114d

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2019 Melvin Sembrano
+
+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,30 @@
+[![Build Status](https://travis-ci.org/melvinsembrano/lockie.svg?branch=master)](https://travis-ci.org/melvinsembrano/lockie)
+
+# Lockie
+Short description and motivation.
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'lockie'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install lockie
+```
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,27 @@
+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    = 'Lockie'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/lib/lockie.rb

@@ -0,0 +1,37 @@
+require 'rails'
+require 'warden'
+require_relative "lockie/rails"
+require_relative "lockie/log_helper"
+require_relative "lockie/model_helper"
+require_relative "lockie/strategies/email_password"
+require_relative "lockie/strategies/jwt"
+require_relative "lockie/strategies/failed"
+
+module Lockie
+  autoload :FailureApp, 'lockie/failure_app'
+
+  class Configuration
+    attr_accessor :model_name
+    attr_accessor :unauthenticated_path
+    attr_accessor :default_strategies
+    attr_accessor :jwt_secret
+    attr_accessor :hash_algorithm
+
+    def initialize
+      @model_name = "User"
+      @unauthenticated_path = "/login"
+      @default_strategies = [:email_passwrd, :jwt]
+      @hash_algorithm = "HS256"
+    end
+  end
+
+  class << self
+    def configure
+      yield config
+    end
+
+    def config
+      @config ||= Configuration.new
+    end
+  end
+end

data/lib/lockie/failure_app.rb

@@ -0,0 +1,56 @@
+require 'action_controller/metal'
+module Lockie
+  class FailureApp < ActionController::Metal
+    include ActionController::Redirecting
+
+    delegate :flash, to: :request
+
+    def self.call(*args)
+      req = ActionDispatch::Request.new(*args)
+      action(req.env['warden.options'][:action]).call(*args)
+    end
+
+    def unauthenticated
+      if request.xhr?
+        api_response(:text)
+      elsif request.format.to_sym == :json || request.content_type.to_s.split("/").last == 'json'
+        api_response(:json)
+      else
+        html_response
+      end
+    end
+
+    def api_response(format = :text)
+      self.status = 401
+      self.content_type = request.format.to_s
+      if format.eql?(:text)
+        self.response_body  = message
+      else
+        self.response_body  = { message: message }.to_json
+      end
+    end
+
+    def html_response
+      flash[type] = message if message
+      self.status = 302
+      redirect_to Lockie.config.unauthenticated_path
+    end
+
+    def message
+      @message ||= request.env['warden.message']
+    end
+
+    def warden_options
+      request.env['warden.options']
+    end
+
+    def type
+      @type ||= warden_options[:type] || :error
+    end
+
+    def warden
+      env['warden']
+    end
+
+  end
+end

data/lib/lockie/log_helper.rb

@@ -0,0 +1,8 @@
+module Lockie
+  module LogHelper
+
+    def set_message(message)
+      env['warden.message'] = message
+    end
+  end
+end

data/lib/lockie/model_helper.rb

@@ -0,0 +1,34 @@
+require 'jwt'
+
+module Lockie
+  module ModelHelper
+    extend ActiveSupport::Concern
+
+    def auth_object
+      @auth_object ||= Lockie.config.model_name.classify.constantize
+    end
+
+    included do
+
+        def create_token(payload = {})
+          payload = {
+            aud: 'lockie-app',
+            sub: id,
+            sub_type: self.class.name,
+          }.merge(payload)
+
+          JWT.encode(payload, Lockie.config.jwt_secret, Lockie.config.hash_algorithm)
+        end
+    end
+
+    class_methods do
+
+      def find_by_token(token)
+        payload = JWT.decode(token, Lockie.config.jwt_secret, true, { algorithm: Lockie.config.hash_algorithm })
+        auth_id = payload.first.fetch('sub') { nil }
+        find(auth_id)
+      end
+
+    end
+  end
+end

data/lib/lockie/rails.rb

@@ -0,0 +1,18 @@
+require 'lockie/model_helper'
+
+module Lockie
+  class Engine < ::Rails::Engine
+    include Lockie::ModelHelper
+
+    config.app_middleware.use Warden::Manager do |manager|
+        manager.default_strategies Lockie.config.default_strategies
+        manager.failure_app = Lockie::FailureApp
+
+        # manager.serialize_into_session(&:id)
+				# manager.serialize_from_session do |id|
+					# auth_object.find(id)
+				# end
+
+      end
+  end
+end

data/lib/lockie/strategies/email_password.rb

@@ -0,0 +1,29 @@
+module Lockie
+  module Strategies
+    class EmailPassword < ::Warden::Strategies::Base
+      include Lockie::ModelHelper
+      include Lockie::LogHelper
+
+      def request
+        @request ||= ActionDispatch::Request.new(env)
+      end
+
+      def valid?
+        request.params['email'].present? && request.params['password'].present?
+      end
+
+      def authenticate!
+        auth = auth_object.find_by_email(request.params['email'])
+
+        if auth && auth.authenticate(request.params['password'])
+          success!(auth)
+        else
+          set_message('Invalid username or password')
+          fail!
+        end
+      end
+
+    end
+  end
+end
+Warden::Strategies.add(:email_password, Lockie::Strategies::EmailPassword)

data/lib/lockie/strategies/failed.rb

@@ -0,0 +1,17 @@
+module Lockie
+  module Strategies
+    class Failed < ::Warden::Strategies::Base
+      include Lockie::LogHelper
+
+      def valid?
+        true
+      end
+
+      def authenticate!
+        set_message 'Unauthorised'
+        fail!
+      end
+    end
+  end
+end
+Warden::Strategies.add(:failed, Lockie::Strategies::Failed)

data/lib/lockie/strategies/jwt.rb

@@ -0,0 +1,43 @@
+module Lockie
+  module Strategies
+    class Jwt < ::Warden::Strategies::Base
+      include Lockie::ModelHelper
+      include Lockie::LogHelper
+
+      def auth
+        @auth ||= ActionDispatch::Request.new(env)
+      end
+
+      def headers
+        auth.headers
+      end
+
+      def valid?
+        headers['Authorization'].present?
+      end
+
+      def token
+        headers['Authorization'].split.last.strip
+      end
+
+      def authenticate!
+        begin
+          auth = auth_object.find_by_token(token)
+          if auth
+            success! auth
+          else
+            set_message "Invalid token"
+            fail!
+          end
+        rescue # => err
+          set_message "Invalid token"
+          fail!
+        end
+      end
+
+    end
+  end
+end
+
+Warden::Strategies.add(:jwt, Lockie::Strategies::Jwt)
+

data/lib/lockie/version.rb

@@ -0,0 +1,3 @@
+module Lockie
+  VERSION = '0.1.0'
+end

data/lib/tasks/lockie_tasks.rake

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

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification
+name: lockie
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Melvin Sembrano
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-02-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: warden
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: jwt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.6
+- !ruby/object:Gem::Dependency
+  name: bcrypt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.7
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+description: Drop in password and JWT token authentication for Ruby on Rails
+email:
+- melvinsembrano@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/lockie.rb
+- lib/lockie/failure_app.rb
+- lib/lockie/log_helper.rb
+- lib/lockie/model_helper.rb
+- lib/lockie/rails.rb
+- lib/lockie/strategies/email_password.rb
+- lib/lockie/strategies/failed.rb
+- lib/lockie/strategies/jwt.rb
+- lib/lockie/version.rb
+- lib/tasks/lockie_tasks.rake
+homepage: https://github.com/melvinsembrano/lockie
+licenses:
+- MIT
+metadata:
+  allowed_push_host: 'TODO: Set to ''http://mygemserver.com'''
+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: []
+rubygems_version: 3.0.2
+signing_key: 
+specification_version: 4
+summary: Drop in password and JWT token authentication for Ruby on Rails
+test_files: []