entrance 0.2.5 → 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9db48b6f4e950ecfecf95a8c51d17fd8e29296cc
+  data.tar.gz: 7cd2766497f3634f0ba201d1360055a11201e80d
+SHA512:
+  metadata.gz: bbde9df5134233c9eee47139dd28643ed09653fd1f4509db82551e5d85b76fa6dc62bcce43e888dc55130f15525322af62920db80b5a378c34effe333b2fb18e
+  data.tar.gz: 6a2da9b7a78dcb87c790a9d1833f7d8591fb99e5bc604f5a51c02002ec70dc39655b78f436df11c5b62b4b5c54d76c5e14a7d83948cf60270d8d9d365c617487

data/README.md

@@ -35,7 +35,9 @@ end
 class User
   include Entrance::Model
 
-  ...
+  ... (setup fields)
+  
+  validate_entrance! # ensures fields for authentication/remember/reset are present
 end
 ```
 
@@ -125,15 +127,17 @@ And the following helpers:
 
 Provides:
 
+ - .validate_entrance!
  - .authenticate(username, password)
- - #remember_me! and #forget_me!
+ - .with_password_reset_token(token)
  - #password and #password=(value)
- - #request_password_reset!
+ - #remember_me! and #forget_me!  (unless remember_attr is set to nil)
+ - #request_password_reset! (unless reset_attr is set to nil)
 
 Examples
 ========
 
-Thought you might ask. There's a full example Rails app in the examples folder. Check it out. 
+Thought you might ask. There's a full example Rails app and a Sinatra app in the examples folder. Check them out. 
  
 Author
 ======

data/examples/rails-app/app/models/user.rb

@@ -1,3 +1,5 @@
 class User < ActiveRecord::Base
   include Entrance::Model
+  
+  validate_entrance! # ensures everything is in order, and sets up password validations
 end

data/examples/sinatra-app/README.md

@@ -0,0 +1,12 @@
+## Example Sinatra App with Entrance
+
+A quick example that shows how to use Entrance with a Sinatra modular app. Requires MongoDB.
+
+To run:
+
+    git clone https://github.com/tomas/entrance
+    cd entrance/examples/sinatra-app
+    bundle install
+    bundle exec puma
+
+And ready-o. Then point your browser to localhost:9292 and sign up, then sign in using your credentials.

data/examples/sinatra-app/app/models.rb

@@ -14,6 +14,7 @@ end
 
 class User
   include MongoMapper::Document
+  include Entrance::Model
 
   key :state, :default => 'active'
 
@@ -27,10 +28,10 @@ class User
   key :reset_token
   key :reset_token_expires_at, Time
 
-  include Entrance::Model # needs to be included after the properties are declared
+  validate_entrance! # ensures everything is in order, and sets up password validations
 
   def active?
     state.to_sym == :active
   end
 
-end
+end

data/examples/sinatra-app/app/views/login.erb

@@ -15,7 +15,7 @@
     <input checked="checked" id="remember_me" name="remember_me" type="checkbox" />
   </p>
 
-  <input class="right btn btn-primary" data-disable-with="Logging in..." name="commit" tabindex="4" type="submit" value="Log in" />
+  <input class="right btn btn-primary" tabindex="3" type="submit" value="Log in" />
 
 </form>
   

data/examples/sinatra-app/app/views/signup.erb

@@ -1,6 +1,6 @@
 <h2>Sign up</h2>
 
-<form accept-charset="UTF-8" action="/signup" class="new_user" method="post">
+<form accept-charset="UTF-8" action="/signup" method="post">
 
   <p>
     <input id="user_name" name="user[name]" placeholder="Your name" tabindex="1" type="text" />
@@ -18,8 +18,8 @@
     <input id="user_password_confirmation" name="user[password_confirmation]" placeholder="Retype password" tabindex="4" type="password" />
   </p>
 
-  <input class="right btn btn-primary" data-disable-with="Creating account..." name="commit" tabindex="4" type="submit" value="Sign up" />
+  <input class="right btn btn-primary" tabindex="5" type="submit" value="Sign up" />
 
 </form>
 
-<p>Have an account? <a href="<%= url('/login') %>">Log in</a></p>
+<p>Have an account? <a href="<%= url('/login') %>">Log in</a>.</p>

data/lib/entrance/model.rb

@@ -3,61 +3,63 @@ module Entrance
 
     def self.included(base)
 
-      # if the target model class does not have a Model.where() method, 
+      # if the target model class does not have a Model.where() method,
       # then login_by_session wont work, nor the ClassMethods below.
       # won't work so we cannot continue.
       unless base.respond_to?(:where)
-        raise "#{base.name} does not have a .where() class method. Cannot continue."
+        raise "#{base.name} does not have a .where() finder class method. Cannot continue."
       end
 
-      fields = if base.respond_to?(:columns)   # ActiveRecord::Base
-        base.columns.collect(&:name)
-      elsif base.respond_to?(:keys)            # MongoMapper::Document
-        base.keys.keys
-      else                                     # just get setters in the class
-        base.instance_methods(false).select { |m| m[/\=$/] }.map { |s| s.to_s.sub('=', '') }
-      end.map { |el| el.to_sym }
-
-      %w(username_attr password_attr).each do |key|
-        field = Entrance.config.send(key)
-        unless fields.include?(field.to_sym)
-          raise "Couldn't find '#{field}' in #{base.name} model." 
-        end
-      end
+      base.extend(ClassMethods)
+    end
 
-      %w(remember reset).each do |what|
-        if field = Entrance.config.send("#{what}_token_attr")
-          until_field = Entrance.config.send("#{what}_until_attr")
+    module ClassMethods
 
+      def validate_entrance!
+        fields = if self.respond_to?(:columns)   # ActiveRecord::Base
+          columns.collect(&:name)
+        elsif self.respond_to?(:keys)            # MongoMapper::Document
+          keys.keys
+        else                                     # just get setters in the class
+          instance_methods(false).select { |m| m[/\=$/] }.map { |s| s.to_s.sub('=', '') }
+        end.map { |el| el.to_sym }
+
+        %w(username_attr password_attr).each do |key|
+          field = Entrance.config.send(key)
           unless fields.include?(field.to_sym)
-            raise "No #{Entrance.config.send("#{what}_token_attr")} field found. \
-                   Set the config.#{what}_token_attr option to nil to disable the #{what} option."
+            raise "Couldn't find '#{field}' in #{base.name} model."
           end
+        end
+
+        %w(remember reset).each do |what|
+          if field = Entrance.config.send("#{what}_token_attr")
+            until_field = Entrance.config.send("#{what}_until_attr")
 
-          if until_field
-            unless fields.include?(until_field.to_sym)
-              raise "Couldn't find a #{Entrance.config.send("#{what}_until_attr")} field. Cannot continue."
+            unless fields.include?(field.to_sym)
+              raise "No #{Entrance.config.send("#{what}_token_attr")} field found. \
+                     Set the config.#{what}_token_attr option to nil to disable the #{what} option."
+            end
+
+            if until_field
+              unless fields.include?(until_field.to_sym)
+                raise "Couldn't find a #{Entrance.config.send("#{what}_until_attr")} field. Cannot continue."
+              end
+            else
+              puts "Disabling expiration timestamp for the #{what} option. This is a VERY bad idea."
             end
-          else
-            puts "Disabling expiration timestamp for the #{what} option. This is a VERY bad idea."
-          end
 
-          Entrance.config.can?(what, true)
-          base.include what.to_sym == :remember ? RememberMethods : ResetMethods
+            Entrance.config.can?(what, true)
+            self.send(:include, what.to_sym == :remember ? RememberMethods : ResetMethods)
+          end
         end
-      end
 
-      if base.respond_to?(:validates)
-        base.validates :password, :presence => true, :length => 6..32, :if => :password_required?
-        base.validates :password, :confirmation => true, :if => :password_required?
-        base.validates :password_confirmation, :presence => true, :if => :password_required?
+        if self.respond_to?(:validates)
+          validates :password, :presence => true, :length => 6..32, :if => :password_required?
+          validates :password, :confirmation => true, :if => :password_required?
+          validates :password_confirmation, :presence => true, :if => :password_required?
+        end
       end
 
-      base.extend(ClassMethods)
-    end
-
-    module ClassMethods
-
       def authenticate(username, password)
         return if username.blank? or password.blank?
 

data/lib/entrance/sinatra.rb

@@ -0,0 +1,61 @@
+require 'entrance'
+
+module Sinatra
+
+  module Entrance
+
+    def self.registered(app)
+
+      app.include ::Entrance::Controller
+
+      app.helpers do
+        def redirect_with(url, type, message)
+          flash[type] = message if respond_to?(:flash)
+          redirect(to(url))
+        end
+      end
+
+      app.get '/login' do
+        if logged_in?
+          redirect(to('/'))
+        else
+          erb :'public/login'
+        end
+      end
+
+      app.post '/login' do
+        remember = ['on', 'true', '1'].include?(params[:remember])
+        if user = authenticate_and_login(params[:username], params[:password], remember)
+          flash[:success] = 'Welcome back!'
+          redirect_to_stored_or(to('/'))
+        else
+          redirect_with('/login', :error, "Couldn't log you in. Please try again.")
+        end
+      end
+
+      app.get '/logout' do
+        kill_session!
+        redirect_with('/login', :notice, 'Logged out! See you soon.')
+      end
+
+      app.get '/signup' do
+        return redirect(to('/')) if logged_in?
+        @user = ::Entrance.model.new
+        erb :'public/signup'
+      end
+
+      app.post '/signup' do
+        @user = ::Entrance.model.new(params[:user])
+        if @user.valid? && @user.save
+          redirect_with('/login', :success, "Account created! Please sign in to continue.")
+        else
+          flash[:error] = "Couldn't sign you up. Please try again."
+          erb :'public/signup'
+        end
+      end
+
+    end
+
+  end
+
+end

data/lib/entrance/version.rb

@@ -1,7 +1,7 @@
 module Entrance
   MAJOR = 0
-  MINOR = 2
-  PATCH = 5
+  MINOR = 3
+  PATCH = 0
 
   VERSION = [MAJOR, MINOR, PATCH].join('.')
 end

metadata

@@ -1,46 +1,37 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: entrance
-version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 2
-  - 5
-  version: 0.2.5
+version: !ruby/object:Gem::Version
+  version: 0.3.0
 platform: ruby
-authors: 
-- "Tom\xC3\xA1s Pollak"
+authors:
+- Tomás Pollak
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2015-01-15 00:00:00 -03:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2015-03-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: bcrypt
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 3
-        - 0
-        version: "3.0"
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
   type: :runtime
-  version_requirements: *id001
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 description: Doesn't fiddle with your controllers and routes.
-email: 
+email:
 - tomas@forkhq.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
-- .gitignore
+files:
+- ".gitignore"
 - README.md
 - Rakefile
 - entrance.gemspec
@@ -109,6 +100,7 @@ files:
 - examples/rails-app/vendor/assets/javascripts/.keep
 - examples/rails-app/vendor/assets/stylesheets/.keep
 - examples/sinatra-app/Gemfile
+- examples/sinatra-app/README.md
 - examples/sinatra-app/app/models.rb
 - examples/sinatra-app/app/routes.rb
 - examples/sinatra-app/app/views/layout.erb
@@ -121,38 +113,30 @@ files:
 - lib/entrance/config.rb
 - lib/entrance/controller.rb
 - lib/entrance/model.rb
+- lib/entrance/sinatra.rb
 - lib/entrance/version.rb
-has_rdoc: true
 homepage: https://github.com/tomas/entrance
 licenses: []
-
+metadata: {}
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  requirements: 
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  requirements: 
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 1
-      - 3
-      - 6
+    - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
-
 rubyforge_project: entrance
-rubygems_version: 1.3.6
+rubygems_version: 2.2.0
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Lean authentication alternative for Rails and Sinatra.
 test_files: []
-
+has_rdoc: