shield-contrib 0.0.1

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2009 Michel Martens, Damian Janowski and Cyril David
+
+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/lib/shield/contrib.rb

@@ -0,0 +1,8 @@
+module Shield
+  module Contrib
+    VERSION = "0.0.1"
+  end
+
+  autoload :Ohm,     "shield/contrib/ohm"
+  autoload :Sinatra, "shield/contrib/sinatra"
+end

data/lib/shield/contrib/ohm.rb

@@ -0,0 +1,8 @@
+require "shield"
+require "ohm"
+
+module Shield
+  module Ohm
+    autoload :EmailPassword, "shield/contrib/ohm/email_password"
+  end
+end

data/lib/shield/contrib/ohm/email_password.rb

@@ -0,0 +1,50 @@
+module Shield
+  module Ohm
+    module EmailPassword
+      def self.included(model)
+        model.extend Shield::Model
+        model.extend Fetch
+        model.attribute :email
+        model.index :email
+
+        model.attribute :crypted_password
+      end
+
+      EMAIL_REGEX = /^([\w\!\#$\%\&\'\*\+\-\/\=\?\^\`{\|\}\~]+\.)*[\w\!\#$\%\&\'\*\+\-\/\=\?\^\`{\|\}\~]+@((((([a-z0-9]{1}[a-z0-9\-]{0,62}[a-z0-9]{1})|[a-z])\.)+[a-z]{2,6})|(\d{1,3}\.){3}\d{1,3}(\:\d{1,5})?)$/i
+
+      module Fetch
+        def fetch(email)
+          find(:email => email).first
+        end
+      end
+
+      attr_reader   :password
+      attr_accessor :password_confirmation
+
+      def validate
+        super
+
+        assert_present(:email) && assert_email(:email) && assert_unique(:email)
+
+        assert_present(:password) if new?
+
+        unless password.to_s.empty?
+          assert password == password_confirmation, [:password, :not_confirmed]
+        end
+      end
+
+      def password=(password)
+        unless password.to_s.empty?
+          self.crypted_password = Shield::Password.encrypt(password)
+        end
+
+        @password = password
+      end
+
+    private
+      def assert_email(att, error = [att, :not_email])
+        assert_format(att, EMAIL_REGEX, error)
+      end
+    end
+  end
+end

data/lib/shield/contrib/sinatra.rb

@@ -0,0 +1,8 @@
+require "shield"
+require "sinatra/base"
+
+module Shield
+  module Sinatra
+    autoload :Default, "shield/contrib/sinatra/default"
+  end
+end

data/lib/shield/contrib/sinatra/default.rb

@@ -0,0 +1,50 @@
+module Shield
+  module Sinatra
+    module Default
+      def self.registered(m)
+        m.set :shield_redirect_after_login,  "/"
+        m.set :shield_redirect_after_logout, "/"
+        m.set :shield_auth_failure, "Wrong Username and/or Password combination."
+
+        m.enable :sessions
+
+        m.helpers Shield::Helpers
+        m.helpers do
+          def current_user
+            authenticated(User)
+          end
+
+          def is_logged_in?
+            !! current_user
+          end
+
+          def ensure_authenticated(model = User)
+            super
+          end
+
+          def logout(model = User)
+            super
+          end
+        end
+
+        m.get "/login" do
+          haml :login
+        end
+
+        m.post "/login" do
+          if login(User, params[:username], params[:password])
+            redirect settings.shield_redirect_after_login
+          else
+            session[:error] = settings.shield_auth_failure
+            redirect "/login"
+          end
+        end
+
+        m.get "/logout" do
+          logout
+          redirect settings.shield_redirect_after_logout
+        end
+      end
+    end
+  end
+end

data/test/helper.rb

@@ -0,0 +1,32 @@
+$:.unshift(File.expand_path("../lib", File.dirname(__FILE__)))
+
+puts "!! REMOVE THIS IN LINE: #{__LINE__} of #{__FILE__}"
+$:.unshift("/Users/cyx/Labs/shield/lib")
+
+require "shield/contrib"
+require "spawn"
+require "ohm"
+require "rack/test"
+require "sinatra/base"
+require "haml"
+
+prepare { Ohm.flush }
+
+def setup(&block)
+  @_setup = block if block_given?
+  @_setup
+end
+
+class Cutest::Scope
+  include Rack::Test::Methods
+
+  def assert_redirected_to(path)
+    assert 302  == last_response.status
+    assert path == last_response.headers["Location"]
+  end
+
+
+  def session
+    last_request.env["rack.session"]
+  end
+end

data/test/ohm_email_password_test.rb

@@ -0,0 +1,97 @@
+require File.expand_path("helper", File.dirname(__FILE__))
+
+class User < Ohm::Model
+  include Shield::Ohm::EmailPassword
+
+  extend Spawn
+  spawner do |u|
+    u.email = "quentin@test.com"
+    u.password = "password"
+    u.password_confirmation = "password"
+  end
+end
+
+test "adds email and password attributes and indices" do
+  assert User.attributes.include?(:email)
+  assert User.attributes.include?(:crypted_password)
+
+  assert User.indices.include?(:email)
+end
+
+# email validation
+scope do
+  setup do
+    User.new
+  end
+
+  test "assert present email" do |u|
+    u.email = ""
+    assert ! u.valid?
+    assert u.errors.include?([:email, :not_present])
+  end
+
+  test "assert email format" do |u|
+    u.email = "q"
+    assert ! u.valid?
+    assert u.errors.include?([:email, :not_email])
+  end
+
+  test "assert unique email" do |u|
+    User.spawn(:email => "quentin@test.com")
+
+    u.email = "quentin@test.com"
+    assert ! u.valid?
+    assert u.errors.include?([:email, :not_unique])
+  end
+end
+
+# password validation on a new record
+scope do
+  setup do
+    User.new
+  end
+
+  test "assert present password" do |u|
+    u.password = ""
+    assert ! u.valid?
+    assert u.errors.include?([:password, :not_present])
+  end
+
+  test "assert confirmed password" do |u|
+    u.password = "foobar"
+    assert ! u.valid?
+    assert u.errors.include?([:password, :not_confirmed])
+  end
+end
+
+# password validation on an existing record
+scope do
+  setup do
+    User.spawn(:email => "quentin@test.com")
+  end
+
+  test "no assert present when existing" do |u|
+    u.password = ""
+    u.password_confirmation = ""
+
+    assert u.valid?
+  end
+
+  test "assert confirmed password when existing" do |u|
+    u.password = "foobar"
+    assert ! u.valid?
+    assert u.errors.include?([:password, :not_confirmed])
+  end
+
+  test "password is not persisted when set as an empty string" do |u|
+    u.password = ""
+    assert u.save
+
+    assert u == User.authenticate("quentin@test.com", "password")
+  end
+end
+
+test "implements fetch" do
+  quentin = User.spawn(:email => "quentin@test.com")
+  assert quentin == User.authenticate("quentin@test.com", "password")
+end

data/test/ohm_test.rb

@@ -0,0 +1,12 @@
+require File.expand_path("helper", File.dirname(__FILE__))
+
+test "autoloads Ohm" do
+  ex = nil
+  begin
+    Shield::Ohm
+  rescue Exception => e
+    ex = e
+  end
+
+  assert nil == e
+end

data/test/sinatra_default_test.rb

@@ -0,0 +1,53 @@
+require File.expand_path("helper", File.dirname(__FILE__))
+
+class App < Sinatra::Base
+  register Shield::Sinatra::Default
+
+  set :shield_redirect_after_login, "/dashboard"
+  set :shield_redirect_after_logout, "/thank-you"
+
+  set :views, File.join(File.dirname(__FILE__), "fixtures", "views")
+
+  get "/dashboard" do
+    ensure_authenticated
+
+    "Dashboard"
+  end
+
+  get "/thank-you" do
+    "Thank you."
+  end
+end
+
+class User < Struct.new(:id)
+  def self.authenticate(username, password)
+    new(1001) if ["quentin", "password"] == [username, password]
+  end
+end
+scope do
+  def app
+    App.new
+  end
+
+  test "GET /login" do
+    get "/login"
+    assert "<h1>Login</h1>\n" == last_response.body
+  end
+
+  test "POST /login" do
+    post "/login", :username => "quentin", :password => "password"
+    assert 1001 == session["User"]
+
+    assert_redirected_to "/dashboard"
+    follow_redirect!
+
+    assert "Dashboard" == last_response.body
+  end
+
+  test "GET /logout" do
+    post "/login", :username => "quentin", :password => "password"
+    get "/logout"
+
+    assert_redirected_to "/thank-you"
+  end
+end

metadata

@@ -0,0 +1,170 @@
+--- !ruby/object:Gem::Specification 
+name: shield-contrib
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Michel Martens
+- Damian Janowski
+- Cyril David
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-10-21 00:00:00 +08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: shield
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: cutest
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: spawn
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: ohm
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: rack-test
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: sinatra
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: haml
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id007
+description: "\n    Provides various specific implementations based on the Shield protocol.\n    Examples include a drop-in Sinatra Extension, an Ohm specific model,\n    and a Sequel specific model.\n  "
+email: 
+- michel@soveran.com
+- djanowski@dimaion.com
+- cyx@pipetodevnull.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/shield/contrib/ohm/email_password.rb
+- lib/shield/contrib/ohm.rb
+- lib/shield/contrib/sinatra/default.rb
+- lib/shield/contrib/sinatra.rb
+- lib/shield/contrib.rb
+- README.markdown
+- LICENSE
+- Rakefile
+- test/helper.rb
+- test/ohm_email_password_test.rb
+- test/ohm_test.rb
+- test/sinatra_default_test.rb
+has_rdoc: true
+homepage: http://github.com/cyx/shield-contrib
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: shield-contrib
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A collection of implementations based on the Shield protocol.
+test_files: []
+