rack_warden 0.0.4 → 0.0.5

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MzJhMzZlZDM3YTVkYjE4MDczZTM2ZjhlYmU0MTQ0NmYyMjVkMmY3Mg==
+    ZjdjY2YyZWIwODFiZWVhY2FiNGNiOTNjNGE3ZGRiYjI0OWFlNWExMA==
   data.tar.gz: !binary |-
-    NzIwOGNlNTQzZDBkZjk4NTgwYTllOTM3MTJkMzM2Y2EyNWUzNmY0NA==
+    ZjFjZTkwOTFhNWY5NTRlOTQxODM1NmZjOTAyNDlkMGE2OTFlMTk4NA==
 SHA512:
   metadata.gz: !binary |-
-    ZGFlMzk2OTNiYWU0OGJjYmUxNjAyN2U1MTU0Y2YzMTUyZGI0NDg1MTEzYjgz
-    NGFkOGU1ZDk5YjcxOGI5MTNlMmNkMjc2Nzk4OWQzZGY2MjM5NzFkMjgyODcw
-    MTI4OGU3YTQxMDI1OTNlYTAwN2Q1MTYwMTFiZDQyMTQ5MzRkODc=
+    ODRhZDRjZTMyNGNmYmRkZTdmYzIyYWM5NGU3ZjcwZjEwOTdhNzI5OWZiOTg4
+    ZDZmMDdhYjA4ZWJhYWYzNTE4ZDNkNWJlZDZhZjg4MzcyZmNjMzYzN2U0YzUx
+    N2YxNDQyZjhmMjIzOTU3NjEzOTNjZDIzYzhmYzcyYTE3Mzc0NDQ=
   data.tar.gz: !binary |-
-    Yjk0MWUyMTBjZmMyNmEwNjZlNTAwZmM1M2Q2NmJkYjViNzllYTlhMGIwNDA2
-    YTc1NzY0MGY0NDQ4YmExMDA1NzQyYTNiM2YxZDE4ZWJhMmE0MTU4OTg3MGEx
-    MWI1MDE5ZjNkOGRjNTUyNjBmMzU0YThkY2JkNzgzMmM0ZDFjNzg=
+    ZDdlMjNiMmIzMjU3N2Q3MGU2ZGQzYWU2ODY2NDJjZjM5MmVlZDk3MGEwYjZl
+    Zjc1NDI4YTQ5YTEzOWY1YmQzNmM0NTdhOTZmNGZjOTUyOWE0M2YzNDFhODU5
+    MTFhNDM3ZGQ5YjRjZmJiMmNjZDE1MzM2YmQ0M2JlNzdiZjZjMzg=

data/.gitignore

@@ -19,4 +19,4 @@ todo.txt
 *.bak
 *.gem
 rack_warden.y*ml
-
+.DS_Store

data/README.md

@@ -6,12 +6,20 @@ RackWarden uses Sinatra for the mini-app, Warden for authentication, and DataMap
 
 My goal in developing this software is to have drop-in authentication containing most of the features you see in user/account management sections of a typical web site. But I don't want to be strapped by this module in any of my projects, so it must be customizable. Or rather, overridable. The basics of this flexibility are already in place, and it will be a central theme throughout. See below for examples on overriding and customizing RackWarden.
 
+## What Does it Do?
+
+RackWarden acts as a self-sufficient gatekeeper for your ruby web app. Once you enable RackWarden in your rack-based project, all routes/actions in your project will require a login and will redirect browsers to an authentication page. RackWarden provides its own view & layout templates to facilitate user authentication. RackWarden also provides it's own tables to store user data.
+
+Once RackWarden authenticates a user, it gets out of the way, and the user is returned to your application. RackWarden also provides a number of user management tools for common actions like creating, updating, and deleting users.
+
+Most of the RackWarden features can be customized. You can override the views, the database, the actions, and even the authentication logic with your own. The easiest (and possibly the most dramatic) customization is to provide RackWarden with your own layout template, giving RackWarden the look-and-feel of your own application.
+
 
 ## Installation
 
 In your Gemfile:
 
-		gem 'rack_warden'
+    gem 'rack_warden'
 
 Then:
 
@@ -28,88 +36,127 @@ A few simple steps will have your entire app protected.
 
 ### Sinatra
 
-		class MySinatraApp < Sinatra::Base
-			use RackWarden::App
-			
-			before do
-				require_login
-			end
-		
-			get "/" do
-				erb "All routes are now protected"
-			end
-		end
+    class MySinatraApp < Sinatra::Base
+      use RackWarden::App
+    
+      get "/" do
+        erb "All routes are now protected"
+      end
+    end
 
 ### Rails
 
 application.rb or environment.rb
 
-		config.middleware.use RackWarden::App
-		
-application-controller.rb
-
-		before_filter :require_login
-		
+    config.middleware.use RackWarden::App
+    
+    # All routes are now protected
+    
 
 
 ## Configuration
 
-Pass configuration settings to RackWarden through your ``use`` method. The params hash will be translated directly to the app's settings. You can currently specify :layout, :database, :default_route, and :recaptcha. You can also specify any of the standard Sinatra settings, like :views.
+Pass configuration settings to RackWarden through the ``use`` method of your framework. The params hash of ``use`` will be translated directly to RackWarden's settings. In addition to RackWarden's specific configuration options, you can also pass in any settings that Sinatra recognizes.
 
-If you pass a block with the ``use`` method, the block will be evaluated in the context of the RackWarden::App class. Anything you do in that block is just as if you were writing code in the app class itself. While in the block, you also have access to two relevant objects.
+If you pass a block with the ``use`` method, the block will be evaluated in the context of the RackWarden::App class. Anything you do in that block is just as if you were writing code in the app class itself. While in the block, you also have access to the current instance of RackWarden::App and the current instance of the parent app.
 
-		use RackWarden::App do |rack_warden_app_instance, parent_app_instance|
-			set :somesetting, 'some_value'
-		end
+    use RackWarden::App do |rack_warden_app_instance, parent_app_instance|
+      set :somesetting, 'some_value'
+    end
 
 ### Configuration Options
 
-Current list of settings specific to rack_warden, with defaults.
+Current list of settings specific to rack\_warden, with defaults.
 
 #### :layout
 
 A symbol representing a layout file in any of the view paths.
-		
-		:layout => :'rack_warden_layout.html'
-		
-#### :default_route
+    
+    layout: :'rack_warden_layout.html'
+    
+#### :default\_route
 
 A Sinatra route to fall back on after logout, errors, or any action that has no specified route.
 
-		:default_route => '/'
-		
-#### :database
-
-A DataMapper database specification
-
-		:database => "sqlite:///Absolute/path/to/your/project/rack_warden.sqlite.db"
-		
+    default_route: '/'
+    
+#### :database\_config
+
+A database specification hash or or url string.
+
+    database_config: "sqlite:///Absolute/path/to/your/rack_warden.sqlite3.db"
+    
+    # or
+    
+    database_config: 
+      adapter: mysql2
+      encoding: utf8
+      database: my_db_name
+      username: root
+      password: my_password
+      host: 127.0.0.1
+      port: 3306
+
+#### :require\_login
+
+Parameters to pass to the before/before\_filter for require\_login.
+So if you're main app is Sinatra,
+
+    require_login: /^\/.+/
+    
+is the same as
+
+    class MySinatraApp
+      require_login /^\/.+/
+    end
+    
+which is the same as
+
+    class MySinatraApp
+      before /^\/.+/ do
+        require_login
+      end
+    end
+    
+For Rails, you would be passing a hash of :only or :except keys.
+
+    require_login:
+      except: :index
+    
+The default for :require\_login is nil, which means require login on every route or action.
+To disable automatic activation of require\_login, pass it ``false``.
+
+#### :allow\_public\_signup
+
+Allows public access to the account creation view & action.
+
+    allow_public_signup: false
+    
+    
 #### :recaptcha
 
 Settings for Google's recaptcha service
 
-		:recaptcha => {
-			:sitekey => '',
-			:secret  => ''
-		}
+    :recaptcha => {
+      :sitekey => '',
+      :secret  => ''
+    }
 
 ## Customization
 
 To customize RackWarden for your specific project, you can set :views to point to a directory within your project. Then create templates that match the names of RackWarden templates, and they will be picked up and rendered. RackWarden looks for templates at the top level of your views directory as a default. You can change or add to this when you define the middleware in your project.
 
-		use RackWarden::App, :views => File.join(Dir.pwd, 'app/views/rack_warden')
-		
+    use RackWarden::App, :views => File.join(Dir.pwd, 'app/views/rack_warden')
+    
 Or if you simply want RackWarden to use your own custom layout, pass it a file path in the :layout parameter.
 
-		use RackWarden::App, :layout => :'layouts/rack_warden_layout.html'
-		
-Just remember that RackWarden is Sinatra, and any templates you pass must use Sinatra-specific code. For example, Sinatra uses ``url`` instead of Rails' ``url_for``. Also remember that template names in Sinatra must always be symbols.
-
-Another way to customize RackWarden is to override its classes and methods, as you would with any other ruby code.
+    use RackWarden::App, :layout => :'layouts/rack_warden_layout.html'
+    
+Just remember that RackWarden is Sinatra, and any templates you pass must use Sinatra-specific code. For example, Sinatra uses ``url`` instead of Rails' ``url_for``. Also remember that template names in Sinatra must always be symbols. Have a look at the readme on Sinatra's web site for more details on Sinatra's DSL.
 
-And if you want to customize RackWarden more extensively, you can always download the source from github and directly modify the app file and templates. Then point to this modified gem in your project Gemfile.
+Another way to customize RackWarden is to override its classes and methods, as you would with any other ruby code. And if you want to customize RackWarden more extensively, you can always download the source from github and directly modify the app file and templates. Then point to this modified gem in your project Gemfile.
 
-		gem 'rack_warden', :path => "../RackWarden/"
+    gem 'rack_warden', :path => "../RackWarden/"
 
 
 

data/lib/rack_warden/app.rb

@@ -8,8 +8,10 @@ module RackWarden
     set :config_files, [ENV['RACK_WARDEN_CONFIG_FILE'], 'rack_warden.yml', 'config/rack_warden.yml'].compact.uniq
     set :layout, :'rack_warden_layout.html'
     set :default_route, '/'
-    set :database, "sqlite://#{Dir.pwd}/rack_warden.sqlite.db"
+    set :database_config, "sqlite3:///#{Dir.pwd}/rack_warden.sqlite3.db"
     set :recaptcha, Hash.new
+    set :require_login, nil
+    set :allow_public_signup, false
     
     # Load config from file, if any exist.
     Hash.new.tap do |hash|
@@ -29,7 +31,7 @@ module RackWarden
   	#	end
   	#
   	def initialize(parent_app=nil, *args, &block)
-  		#puts "INITIALIZE RackWarden::App INSTANCE [parent_app, self, args, block]: #{[parent_app, self, args, block]}"
+  		puts "INITIALIZE RackWarden::App INSTANCE [parent_app, self, args, block]: #{[parent_app, self, args, block]}"
   		# extract options.
   		opts = args.last.is_a?(Hash) ? args.pop : {}
   		klass = self.class
@@ -58,9 +60,29 @@ module RackWarden
   		when parent_app.class.ancestors.find{|x| x.to_s=='Sinatra::Base'}
   			parent_app.class.helpers(RackWardenHelpers)
   			default_parent_views = File.join(Dir.pwd,"views")
+  			
+  			parent_app.class.instance_eval do
+  			  def self.require_login(*args)
+    			  #options = args.last.is_a?(Hash) ? args.pop : Hash.new
+  			    before(*args) do
+  			      require_login
+  			    end
+  			  end
+			  end
+  			parent_app.class.require_login(klass.require_login) if klass.require_login != false
   		when parent_app.class.parents.find{|x| x.to_s=='ActionDispatch'}
   			ApplicationController.send(:include, RackWardenHelpers)
   			default_parent_views = File.join(Dir.pwd, "app/views")
+  			
+  			parent_app.class.instance_eval do
+  			  def self.require_login(*args)
+    			  #options = args.last.is_a?(Hash) ? args.pop : Hash.new
+  			    before_filter(:require_login, *args) do
+  			      require_login
+  			    end
+  			  end
+			  end
+  			(ApplicationController.before_filter :require_login, *Array(klass.require_login).flatten) if klass.require_login != false
   		end
 		
   		new_views = []
@@ -149,7 +171,7 @@ module RackWarden
   	  # TODO: Shouldn't these be in warden block above? But they don't work there for some reason.
 	  
   	  def valid_user_input?
-  	    params['user'] && params['user']['username'] && params['user']['password']
+  	    params['user'] && params['user']['email'] && params['user']['password']
   	  end
 	  
   		def create_user
@@ -157,9 +179,10 @@ module RackWarden
   			verify_recaptcha if settings.recaptcha[:secret]
 		
   			return unless valid_user_input?
-  			user = User.create(username: params['user']['username'])
-  			user.password = params['user']['password']
-  			user.save && warden.set_user(user)
+        #user = User.create(username: params['user']['username'])
+        @user = User.new(params['user'])
+  			#user.password = params['user']['password']
+  			@user.save && warden.set_user(@user)
   		end
 		
    		def verify_recaptcha(skip_redirect=false, ip=request.ip, response=params['g-recaptcha-response'])
@@ -214,8 +237,9 @@ module RackWarden
       redirect url(settings.default_route, false)
     end
 
-  	get '/auth/create' do
-      erb :'create_user.html', :layout=>settings.layout, :locals=>{:recaptcha_sitekey=>settings.recaptcha[:sitekey]}
+  	get '/auth/new' do
+  	  halt 403 unless settings.allow_public_signup or !(User.count > 0)
+      erb :'create_user.html', :layout=>settings.layout, :locals=>{:recaptcha_sitekey=>settings.recaptcha['sitekey']}
     end
 
     post '/auth/create' do
@@ -224,7 +248,7 @@ module RackWarden
   	    redirect session[:return_to] || url(settings.default_route, false)
   	  else
   	  	flash(:rwarden)[:error] = warden.message || "Could not create account"
-  	  	redirect url('/auth/create', false)
+  	  	redirect back #url('/auth/new', false)
   	  end
     end
 
@@ -233,8 +257,13 @@ module RackWarden
       session[:return_to] = env['warden.options'][:attempted_path] if !request.xhr? && !env['warden.options'][:attempted_path][/login/]
       puts "WARDEN ATTEMPTED PATH: #{env['warden.options'][:attempted_path]}"
       puts warden
-      flash(:rwarden)[:error] = warden.message || "Please login to continue"
-      redirect url('/auth/login', false)
+      if User.count > 0
+        flash(:rwarden)[:error] = warden.message || "Please login to continue"
+        redirect url('/auth/login', false)
+      else
+        flash(:rwarden)[:error] = warden.message || "Please create an admin account"
+        redirect url('/auth/new', false)
+      end
     end
 
     get '/auth/protected' do
@@ -242,6 +271,11 @@ module RackWarden
 
       erb :'rack_warden_protected.html', :layout=>settings.layout
     end
+    
+    get '/auth/admin' do
+      warden.authenticate!
+      erb :'rw_admin.html', :layout=>settings.layout
+    end
 
   end # App 
 end # RackWarden

data/lib/rack_warden/model.rb

@@ -1,12 +1,16 @@
 #require 'bcrypt'
-DataMapper.setup(:default, RackWarden::App.database)
+DataMapper::Logger.new(File.join(Dir.pwd, 'log', 'rack_warden.log'))
+DataMapper.setup(:default, RackWarden::App.database_config)
+
+# Do DataMapper.repository.adapter to get connection info for this connection.
 
 class User
   include DataMapper::Resource
   include BCrypt
 
   property :id, Serial, key: true
-  property :username, String, length: 128
+  property :username, String, length: 128, required: true, unique: true, default: lambda {|r,v| r.instance_variable_get :@email}
+  property :email, String, length: 128, required: true, unique: true, default: 'error'
 
   property :password, BCryptHash
 

data/lib/rack_warden/version.rb

@@ -1,3 +1,3 @@
 module RackWarden
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

data/lib/rack_warden/views/create_user.html.erb

@@ -1,9 +1,11 @@
 <% @section_title = "Create Account" %>
 <form action="<%=url('/auth/create', false)%>" method="post">
+	<p>Email: <input type="text" name="user[email]" /></p>
   <p>Username: <input type="text" name="user[username]" /></p>
   <p>Password: <input type="password" name="user[password]" /></p>
-  <% if recaptcha_sitekey %>
+  <% if recaptcha_sitekey && User.count > 0 %>
 	  <div class="g-recaptcha control text-control" data-sitekey="<%=recaptcha_sitekey%>"></div>
   <% end %>
   <input type="submit" value="Create" />
+	<p><%= @user.errors.to_yaml if @user && @user.errors %></p>
 </form>

data/lib/rack_warden/views/login_user.html.erb

@@ -2,5 +2,8 @@
 <form action="<%=url('/auth/login', false)%>" method="post">
   <p>Username: <input type="text" name="user[username]" /></p>
   <p>Password: <input type="password" name="user[password]" /></p>
-  <input type="submit" value="Log In" /> or <a href="<%=url('/auth/create', false)%>">Create a new account</a>
+  <input type="submit" value="Log In" />
+	<% if settings.allow_public_signup %>
+		or <a href="<%=url('/auth/new', false)%>">Create a new account</a>
+	<% end %>
 </form>

data/lib/rack_warden/views/rw_admin.html.erb

@@ -0,0 +1,18 @@
+<% @section_title = "RackWarden Admin" %>
+<table>
+	<thead>
+		<tr>
+			<th>Email</th>
+			<th>User</th>
+			<th>Id</th>
+		</tr>
+	<tbody>
+		<% User.all(:limit=>100).each do |user| %>
+			<tr>
+				<td><%=user.email%></td>
+				<td><%=user.username%></td>
+				<td><%=user.id%></td>
+			</tr>
+		<% end %>
+	</tbody>
+</table>

data/lib/rack_warden.rb

@@ -10,8 +10,9 @@ require 'open-uri'
 # gem 'warden'
 
 require "rack_warden/app"
-require "rack_warden/model"
 require "rack_warden/version"
+autoload :User, "rack_warden/model"
+
 
 module RackWarden
   # Your code goes here...

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rack_warden
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - William Richardson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-29 00:00:00.000000000 Z
+date: 2014-12-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -173,6 +173,7 @@ files:
 - lib/rack_warden/views/rack_warden_index.html.erb
 - lib/rack_warden/views/rack_warden_layout.html.erb
 - lib/rack_warden/views/rack_warden_protected.html.erb
+- lib/rack_warden/views/rw_admin.html.erb
 - rack_warden.gemspec
 homepage: ''
 licenses: