casino_core-authenticator-activerecord 0.0.1

data/.gitignore

@@ -0,0 +1,49 @@
+# rcov generated
+coverage
+coverage.data
+
+# rdoc generated
+rdoc
+
+# yard generated
+doc
+.yardoc
+
+# bundler
+.bundle
+
+# jeweler generated
+pkg
+
+# Have editor/IDE/OS specific files you need to ignore? Consider using a global gitignore: 
+#
+# * Create a file at ~/.gitignore
+# * Include files you want ignored
+# * Run: git config --global core.excludesfile ~/.gitignore
+#
+# After doing this, these files will be ignored in all your git projects,
+# saving you from having to 'pollute' every project you touch with them
+#
+# Not sure what to needs to be ignored for particular editors/OSes? Here's some ideas to get you started. (Remember, remove the leading # of the line)
+#
+# For MacOS:
+#
+#.DS_Store
+
+# For TextMate
+#*.tmproj
+#tmtags
+
+# For emacs:
+#*~
+#\#*
+#.\#*
+
+# For vim:
+#*.swp
+
+# For redcar:
+#.redcar
+
+# For rubinius:
+#*.rbc

data/.rvmrc

@@ -0,0 +1,48 @@
+#!/usr/bin/env bash
+
+# This is an RVM Project .rvmrc file, used to automatically load the ruby
+# development environment upon cd'ing into the directory
+
+# First we specify our desired <ruby>[@<gemset>], the @gemset name is optional,
+# Only full ruby name is supported here, for short names use:
+#     echo "rvm use 1.9.3" > .rvmrc
+environment_id="ruby-1.9.3-p194@casino_core-authenticator-activerecord"
+
+# Uncomment the following lines if you want to verify rvm version per project
+# rvmrc_rvm_version="1.15.8 (stable)" # 1.10.1 seams as a safe start
+# eval "$(echo ${rvm_version}.${rvmrc_rvm_version} | awk -F. '{print "[[ "$1*65536+$2*256+$3" -ge "$4*65536+$5*256+$6" ]]"}' )" || {
+#   echo "This .rvmrc file requires at least RVM ${rvmrc_rvm_version}, aborting loading."
+#   return 1
+# }
+
+# First we attempt to load the desired environment directly from the environment
+# file. This is very fast and efficient compared to running through the entire
+# CLI and selector. If you want feedback on which environment was used then
+# insert the word 'use' after --create as this triggers verbose mode.
+if [[ -d "${rvm_path:-$HOME/.rvm}/environments"
+  && -s "${rvm_path:-$HOME/.rvm}/environments/$environment_id" ]]
+then
+  \. "${rvm_path:-$HOME/.rvm}/environments/$environment_id"
+  [[ -s "${rvm_path:-$HOME/.rvm}/hooks/after_use" ]] &&
+    \. "${rvm_path:-$HOME/.rvm}/hooks/after_use" || true
+else
+  # If the environment file has not yet been created, use the RVM CLI to select.
+  rvm --create  "$environment_id" || {
+    echo "Failed to create RVM environment '${environment_id}'."
+    return 1
+  }
+fi
+
+# If you use bundler, this might be useful to you:
+# if [[ -s Gemfile ]] && {
+#   ! builtin command -v bundle >/dev/null ||
+#   builtin command -v bundle | GREP_OPTIONS= \grep $rvm_path/bin/bundle >/dev/null
+# }
+# then
+#   printf "%b" "The rubygem 'bundler' is not installed. Installing it now.\n"
+#   gem install bundler
+# fi
+# if [[ -s Gemfile ]] && builtin command -v bundle >/dev/null
+# then
+#   bundle install | GREP_OPTIONS= \grep -vE '^Using|Your bundle is complete'
+# fi

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/Gemfile.lock

@@ -0,0 +1,52 @@
+PATH
+  remote: .
+  specs:
+    casino_core-authenticator-activerecord (0.0.1)
+      activerecord (~> 3.2.12)
+      unix-crypt (~> 1.0.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (3.2.12)
+      activesupport (= 3.2.12)
+      builder (~> 3.0.0)
+    activerecord (3.2.12)
+      activemodel (= 3.2.12)
+      activesupport (= 3.2.12)
+      arel (~> 3.0.2)
+      tzinfo (~> 0.3.29)
+    activesupport (3.2.12)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    arel (3.0.2)
+    builder (3.0.4)
+    diff-lcs (1.1.3)
+    i18n (0.6.1)
+    multi_json (1.6.1)
+    rake (10.0.3)
+    rspec (2.12.0)
+      rspec-core (~> 2.12.0)
+      rspec-expectations (~> 2.12.0)
+      rspec-mocks (~> 2.12.0)
+    rspec-core (2.12.2)
+    rspec-expectations (2.12.1)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.12.1)
+    simplecov (0.7.1)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.7.1)
+    simplecov-html (0.7.1)
+    sqlite3 (1.3.7)
+    tzinfo (0.3.35)
+    unix-crypt (1.0.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  casino_core-authenticator-activerecord!
+  rake (~> 10.0)
+  rspec (~> 2.12)
+  simplecov (~> 0.7)
+  sqlite3 (~> 1.3.7)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2013 Nils Caspar
+
+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/README.md

@@ -0,0 +1,40 @@
+# casino_core-authenticator-activerecord [![Build Status](https://travis-ci.org/rbCAS/casino_core-authenticator-activerecord.png?branch=master)](https://travis-ci.org/rbCAS/casino_core-authenticator-activerecord)
+
+Provides mechanism to use ActiveRecord as an authenticator for [CASinoCore](https://github.com/rbCAS/CASinoCore).
+
+ActiveRecord supports many SQL databases such as MySQL, PostgreSQL, SQLite, ...
+
+To use the ActiveRecord authenticator, configure it in your cas.yml:
+
+    authenticators:
+      my_company_sql:
+        authenticator: "ActiveRecord"
+        options:
+          connection:
+            adapter: "mysql"
+            host: "localhost"
+            username: "casino"
+            password: "secret"
+            database: "users"
+          table: "users"
+          username_column: "username"
+          password_column: "password"
+          extra_attributes:
+            email: "email_database_column"
+            fullname: "displayname_database_column"
+
+## Contributing to casino_core-authenticator-activerecord
+
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+## Copyright
+
+Copyright (c) 2013 Nils Caspar. See LICENSE.txt
+for further details.
+

data/Rakefile

@@ -0,0 +1,11 @@
+require 'bundler'
+require 'rake'
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+task :default => :spec
+
+desc 'Run all specs'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/casino_core-authenticator-activerecord.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path('../lib', __FILE__)
+require 'casino_core/authenticator/activerecord/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'casino_core-authenticator-activerecord'
+  s.version     = CASinoCore::Authenticator::ActiveRecord::VERSION
+  s.authors     = ['Nils Caspar', 'Raffael Schmid']
+  s.email       = ['ncaspar@me.com', 'raffael@yux.ch']
+  s.homepage    = 'http://rbcas.org/'
+  s.license     = 'MIT'
+  s.summary     = 'Provides mechanism to use ActiveRecord as an authenticator for CASinoCore.'
+  s.description = 'This gem can be used to allow the CASinoCore backend to authenticate against an SQL server using ActiveRecord.'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ['lib']
+
+  s.add_development_dependency 'rake', '~> 10.0'
+  s.add_development_dependency 'rspec', '~> 2.12'
+  s.add_development_dependency 'simplecov', '~> 0.7'
+  s.add_development_dependency 'sqlite3', '~> 1.3.7'
+
+  s.add_runtime_dependency 'activerecord', '~> 3.2.12'
+  s.add_runtime_dependency 'unix-crypt', '~> 1.0.2'
+end

data/lib/casino_core-authenticator-activerecord.rb

@@ -0,0 +1,2 @@
+require 'casino_core/authenticator/activerecord/version'
+require 'casino_core/authenticator/activerecord'

data/lib/casino_core/authenticator/activerecord.rb

@@ -0,0 +1,45 @@
+require 'active_record'
+require 'unix_crypt'
+
+class CASinoCore::Authenticator::ActiveRecord
+
+  # @param [Hash] options
+  def initialize(options)
+    @options = options
+    ::ActiveRecord::Base.establish_connection @options[:connection]
+
+    eval <<-END
+      class #{@options[:table].classify} < ActiveRecord::Base
+      end
+    END
+
+    @model = "#{self.class.to_s}::#{@options[:table].classify}".constantize
+  end
+
+  def validate(username, password)
+    user = @model.send("find_by_#{@options[:username_column]}!", username)
+    password_from_database = user.send(@options[:password_column])
+
+    if valid_password?(password, password_from_database)
+      { username: user.send(@options[:username_column]) }.merge(extra_attributes(user))
+    else
+      false
+    end
+
+  rescue ActiveRecord::RecordNotFound
+    false
+  end
+
+  private
+  def valid_password?(password, password_from_database)
+    UnixCrypt.valid?(password, password_from_database)
+  end
+
+  def extra_attributes(user)
+    attributes = {}
+    @options[:extra_attributes].each do |attribute_name, database_column|
+      attributes[attribute_name] = user.send(database_column)
+    end
+    attributes
+  end
+end

data/lib/casino_core/authenticator/activerecord/version.rb

@@ -0,0 +1,7 @@
+module CASinoCore
+  class Authenticator
+    class ActiveRecord
+      VERSION = '0.0.1'
+    end
+  end
+end

data/spec/casino_core/authenticator/activerecord_spec.rb

@@ -0,0 +1,70 @@
+require 'spec_helper'
+require 'casino_core/authenticator/activerecord'
+
+describe CASinoCore::Authenticator::ActiveRecord do
+
+  let(:options) do
+    {
+      connection: {
+        adapter: 'sqlite3',
+        database: ':memory:'
+      },
+      table: 'users',
+      username_column: 'username',
+      password_column: 'password',
+      extra_attributes: {
+        email: 'mail_address'
+      }
+    }
+  end
+
+  before do
+
+    @authenticator = CASinoCore::Authenticator::ActiveRecord.new(options)
+
+    ActiveRecord::Migration.suppress_messages do
+      ActiveRecord::Schema.define do
+        create_table :users do |t|
+          t.string :username
+          t.string :password
+          t.string :mail_address
+        end
+      end
+    end
+
+    CASinoCore::Authenticator::ActiveRecord::User.create!(
+      username: 'test',
+      password: '$5$cegeasjoos$vPX5AwDqOTGocGjehr7k1IYp6Kt.U4FmMUa.1l6NrzD', # password: testpassword
+      mail_address: 'mail@example.org')
+  end
+
+  describe '#validate' do
+
+    context 'valid username' do
+      context 'valid password' do
+        it 'returns the username' do
+          @authenticator.validate('test', 'testpassword')[:username].should eq('test')
+        end
+
+        it 'returns the extra attributes' do
+          @authenticator.validate('test', 'testpassword')[:email].should eq('mail@example.org')
+        end
+      end
+
+      context 'invalid password' do
+        it 'returns false' do
+          @authenticator.validate('test', 'wrongpassword').should eq(false)
+        end
+      end
+    end
+
+    context 'invalid username' do
+      it 'returns false' do
+        @authenticator.validate('does-not-exist', 'testpassword').should eq(false)
+      end
+    end
+
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,22 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'simplecov'
+SimpleCov.start do
+  add_filter '/spec'
+end
+
+require 'rspec'
+require 'casino_core-authenticator-activerecord'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,161 @@
+--- !ruby/object:Gem::Specification
+name: casino_core-authenticator-activerecord
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Nils Caspar
+- Raffael Schmid
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.12'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.7
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.12
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.12
+- !ruby/object:Gem::Dependency
+  name: unix-crypt
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.2
+description: This gem can be used to allow the CASinoCore backend to authenticate
+  against an SQL server using ActiveRecord.
+email:
+- ncaspar@me.com
+- raffael@yux.ch
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rvmrc
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- casino_core-authenticator-activerecord.gemspec
+- lib/casino_core-authenticator-activerecord.rb
+- lib/casino_core/authenticator/activerecord.rb
+- lib/casino_core/authenticator/activerecord/version.rb
+- spec/casino_core/authenticator/activerecord_spec.rb
+- spec/spec_helper.rb
+homepage: http://rbcas.org/
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Provides mechanism to use ActiveRecord as an authenticator for CASinoCore.
+test_files:
+- spec/casino_core/authenticator/activerecord_spec.rb
+- spec/spec_helper.rb