monban 0.0.1 → 0.0.2

data/.gitignore

@@ -1,3 +1,4 @@
 spec/rails_app/log/*
 spec/rails_app/tmp/*
 *.sqlite3
+pkg

data/README.md

@@ -9,8 +9,8 @@ Monban makes authentication simple:
 
 - Uses warden
 - Provides convenient controller helpers
+- Provides a rails generator for default controllers and views
 - TODO: Very customizable
-- TODO: provides a generator for default controllers and views
 
 Monban doesn't do the following:
 
@@ -29,6 +29,14 @@ Then inside of your ApplicationController add the following:
 
     include Monban::ControllerHelpers
 
+You may also generate a scaffold to start with:
+
+    rails g monban:scaffold
+
+This will generate a bare bones starting point. If you don't want the full stack you can just generate some controllers with:
+
+    rails g monban:controllers
+
 ## Usage
 
 Monban does currently have some expectations, but these will change. Here are the current requirements:
@@ -56,6 +64,32 @@ And this filter:
 
 - `require_login`
 
+### Advanced Functionality
+
+You may perform a look up on a user using multiple fields by doing something like the following:
+
+    class SessionsController < ApplicationController
+      def create
+        if user = authenticate_session(session_params, email_or_username: [:email, :username])
+          sign_in user
+          redirect_to root_path
+        else
+          flash.now.notice = "Invalid username or password"
+          render :new
+        end
+      end
+
+      private
+
+      def session_params
+        params.require(:session).permit(:email_or_username, :password)
+      end
+
+    end
+
+This will allow the user to enter either their username or email to login
+
+
 ## Contributing
 
 1. Fork it

data/lib/monban/version.rb

@@ -1,3 +1,3 @@
 module Monban
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/monban.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |gem|
   gem.email         = ["halogenandtoast@gmail.com"]
   gem.description   = %q{simple rails authentication}
   gem.summary       = %q{Making rails authentication as simple as possible}
-  gem.homepage      = ""
+  gem.homepage      = "https://github.com/halogenandtoast/monban"
 
   gem.files         = `git ls-files`.split($/)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: monban
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -231,7 +231,7 @@ files:
 - spec/rails_app/public/favicon.ico
 - spec/rails_app/script/rails
 - spec/spec_helper.rb
-homepage: ''
+homepage: https://github.com/halogenandtoast/monban
 licenses: []
 post_install_message: 
 rdoc_options: []