lockie 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 56ac562d5ffc3b7bc21d0bb22dccc6c6a7ead70162c912b055d3999a5e2c1b8c
-  data.tar.gz: 380fe47309f87cfeb428a8e51964c7eb661f49b7c825169bb569a8edcc21ecef
+  metadata.gz: 5611c39c34639b730d1e727ac9d19d9606e54a34a289f3dedf863a83d71175c5
+  data.tar.gz: f25907b964058f449210ace1e8b1d91cc7ea35f7b0972fc2ffb358c004aa7c58
 SHA512:
-  metadata.gz: 316f8e4f88e655554ccb01c9e2be897dcfdbfaae1082b141a94fb973d4867a429cf836d0c3cd4abc9f2cbad4a2a1e505d4317846fde910ab49f1c3cc9cfbbb33
-  data.tar.gz: 9a8dbcb5645b15788f3bf3c8e1ed553c1174766193f48c27334d28763935bfe64e7adbab201821d03e5c1d1ba348f010920d5c31f0badfe0b3998000407dcb56
+  metadata.gz: '08027dfcd40444551b9a561634dc9f192facea3d496d5a144b6c62840c45e781d56fba32f213d14eb99ffbbba7d1c7aef43ae96529c8032a4faa7360027ab679'
+  data.tar.gz: 2007a0a5ecb0c78f732db3c9875dd0419c5e18242b2431e265d9cf9e3be8f45cd3f40a9e1c563c5c4be264102f0809bdc771d32ab49b187ea0c025e5e11b2e65

data/README.md

@@ -2,10 +2,8 @@
 [![Gem Version](https://badge.fury.io/rb/lockie.svg)](https://badge.fury.io/rb/lockie)
 
 # Lockie
-Short description and motivation.
+A drop-in, none assuming warden based Password and JWT authentication for Rails 5.2++
 
-## Usage
-How to use my plugin.
 
 ## Installation
 Add this line to your application's Gemfile:
@@ -19,9 +17,57 @@ And then execute:
 $ bundle
 ```
 
-Or install it yourself as:
-```bash
-$ gem install lockie
+## Usage
+Add the following lines to your authenticaiton model e.g. `User`:
+
+```ruby
+has_secure_password
+include Lockie::ModelHelper
+```
+
+Add the following lines to your base controller e.g. `ApplicationController`:
+```ruby
+include Lockie::ControllerHelper
+before_action :authenticate!
+```
+That's it! All your controllers that inherits `ApplicationController` are now protected.
+
+
+## Adding a session controller
+Creating a session controller is simple as:
+
+Session controller
+```ruby
+class SessionController < ApplicationController
+  skip_before_action :authenticate!, only: [:new]
+
+  def create
+    # on successful login redirect to your user's page
+    redirect_to root_url
+  end
+
+  def destroy
+    logout
+    redirect_to login_url
+  end
+end
+
+```
+
+routes.rb
+```ruby
+get 'login' => 'session#new'
+post 'login' => 'session#create'
+get 'logout' => 'session#destroy'
+```
+
+session/new.html.erb view:
+```ruby
+<%= form_tag(login_url) do -%>
+<%= email_field_tag 'email' %>
+<%= password_field_tag 'password' %>
+<%= submit_tag "Login" %>
+<% end -%>
 ```
 
 ## Contributing

data/lib/lockie/controller_helper.rb

@@ -4,7 +4,7 @@ module Lockie
 
     included do
       if respond_to?(:helper_method)
-        helper_method :current_user
+        helper_method "current_#{ Lockie.config.model_name.underscore }".to_sym
         helper_method :logged_in?
         helper_method :authenticated?
       end
@@ -14,7 +14,7 @@ module Lockie
         env['warden']
       end
 
-      def current_user(*args)
+      define_method "current_#{ Lockie.config.model_name.underscore }".to_sym do |*args|
         warden.user(*args)
       end
 

data/lib/lockie/version.rb

@@ -1,3 +1,3 @@
 module Lockie
-  VERSION = '0.2.0'
+  VERSION = '0.2.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lockie
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Melvin Sembrano