invision_bridge 0.2.1 → 0.3.0

data/README.md

@@ -1,6 +1,6 @@
 # InvisionBridge
 
-Allows your [Authlogic](http://github.com/binarylogic/authlogic)-based User model to authenticate using an [IP.Board](http://www.invisionpower.com/) 3.x database.
+Allows your [Authlogic](http://github.com/binarylogic/authlogic)-based user model to authenticate using an [IP.Board](http://www.invisionpower.com/) 3.x database.
 
 ## Usage
 
@@ -37,16 +37,19 @@ Modify your `config/database.yml` file to include your IP.Board database informa
 
 ### Model creation
 
-Modify or create your User model to inherit from `InvisionBridge::User::Base`
+Modify or create your User model to include `InvisionBridge`
 
-    class User < InvisionBridge::User::Base
+    class User < ActiveRecord::Base
+      include InvisionBridge
     end
 
 That's it. You can further customize your model as needed. For example, you may
 have a group of administrators on your forum that you want to be administrators
 in your Rails application.
 
-    class User < InvisionBridge::User::Base
+    class User < ActiveRecord::Base
+      include InvisionBridge
+
       ADMIN_GROUP = 1
 
       def is_admin?
@@ -54,6 +57,10 @@ in your Rails application.
       end
     end
 
+### ORM Adapters
+
+Currently InvisionBridge only works with ActiveRecord models. I'd love to add a DataMapper adapter if/when I need one.
+
 ## Known Issues
 
 While using this in my own production application, I'd occasionally get "MySQL
@@ -63,4 +70,4 @@ but I was able to make the error stop appearing by adding `reconnect: true` to t
 
 ## Credits
 
-Copyright (c) 2010 Robert Speicher, released under the MIT license
+Copyright (c) 2010 Robert Speicher, released under the MIT license

data/Rakefile

@@ -1,18 +1,6 @@
 require 'rake'
 require 'rake/rdoctask'
 
-gem 'rspec-rails', '>= 1.0.0'
-require 'spec/rake/spectask'
-
-desc 'Default: run unit tests.'
-task :default => :spec
-
-desc 'Test the invision_bridge plugin.'
-Spec::Rake::SpecTask.new('spec') do |t|
-  t.spec_files = FileList['spec/**/*_spec.rb']
-  t.spec_opts = ["-c"]
-end
-
 desc 'Generate documentation for the invision_bridge plugin.'
 Rake::RDocTask.new(:rdoc) do |rdoc|
   rdoc.rdoc_dir = 'rdoc'

data/VERSION

@@ -1 +1 @@
-0.2.1
+0.3.0

data/invision_bridge.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{invision_bridge}
-  s.version = "0.2.1"
+  s.version = "0.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Robert Speicher"]
-  s.date = %q{2010-08-18}
+  s.date = %q{2010-09-24}
   s.description = %q{Allows your Authlogic-based User model to authenticate using an IP.Board 3.x database.}
   s.email = %q{rspeicher@gmail.com}
   s.extra_rdoc_files = [
@@ -22,28 +22,17 @@ Gem::Specification.new do |s|
      "VERSION",
      "config/database.yml.example",
      "init.rb",
-     "install.rb",
      "invision_bridge.gemspec",
+     "lib/authlogic/crypto_providers/invision_power_board.rb",
      "lib/invision_bridge.rb",
-     "lib/invision_bridge/crypto_provider.rb",
-     "lib/invision_bridge/invision_bridge.rb",
-     "lib/invision_bridge/rails.rb",
-     "lib/invision_bridge/user/base.rb",
-     "rails/init.rb",
-     "spec/invision_bridge/crypto_provider_spec.rb",
-     "spec/spec.opts",
-     "spec/spec_helper.rb",
-     "uninstall.rb"
+     "lib/invision_bridge/active_record.rb",
+     "rails/init.rb"
   ]
   s.homepage = %q{http://github.com/tsigo/invision_bridge}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
   s.rubygems_version = %q{1.3.7}
   s.summary = %q{Allows your Authlogic-based User model to authenticate using an IP.Board 3.x database.}
-  s.test_files = [
-    "spec/invision_bridge/crypto_provider_spec.rb",
-     "spec/spec_helper.rb"
-  ]
 
   if s.respond_to? :specification_version then
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION

data/lib/{invision_bridge/crypto_provider.rb → authlogic/crypto_providers/invision_power_board.rb}

@@ -8,18 +8,18 @@ module Authlogic
           tokens = tokens.flatten
           digest = tokens.shift
           digest = filter_input(digest)
-          
+
           # Invision's hash: MD5(MD5(salt) + MD5(raw))
           digest = Digest::MD5.hexdigest(Digest::MD5.hexdigest(tokens.join('')) + Digest::MD5.hexdigest(digest))
-          
+
           digest
         end
-    
+
         # Does the crypted password match the tokens? Uses the same tokens that were used to encrypt.
         def matches?(crypted, *tokens)
           encrypt(*tokens) == crypted
         end
-        
+
         private
           def filter_input(input)
             # Invision's input filtering replaces a bunch of characters before
@@ -46,4 +46,4 @@ module Authlogic
       end
     end
   end
-end
+end

data/lib/invision_bridge.rb

@@ -1,2 +1,40 @@
 require 'authlogic'
-require 'invision_bridge/crypto_provider'
+require 'authlogic/crypto_providers/invision_power_board'
+
+module InvisionBridge
+  autoload :ActiveRecord, 'invision_bridge/active_record'
+
+  def self.config
+    if @config.nil?
+      if Rails
+        config_file = File.join(Rails.root, 'config', 'database.yml')
+        config_group = "invision_bridge_#{Rails.env}"
+      else
+        config_file = File.join(File.dirname(__FILE__), '..', '..', 'config', 'database.yml')
+        config_group = "invision_bridge"
+      end
+
+      config = YAML::load(File.open(config_file))
+      config = config[config_group]
+
+      if config.nil?
+        raise "** [InvisionBridge] Unable to read database configuration from #{config_file} -- Make sure an #{config_group} definition exists."
+      else
+        config['prefix'] ||= 'ibf_'
+      end
+
+      @config = config
+    end
+
+    @config
+  end
+
+  def self.included(base)
+    if base.respond_to? :establish_connection
+      base.send(:include, InvisionBridge::ActiveRecord)
+    else
+      raise "** [InvisionBridge] Currently we only support ActiveRecord models. Sorry."
+    end
+  end
+
+end

data/lib/invision_bridge/active_record.rb

@@ -0,0 +1,23 @@
+module InvisionBridge
+  module ActiveRecord
+    def self.included(base)
+      base.class_eval do
+        establish_connection(InvisionBridge.config)
+
+        # IP.Board database design, grumble grumble
+        set_table_name "#{InvisionBridge.config['prefix']}members"
+        set_primary_key "member_id"
+
+        # Configure Authlogic
+        attr_accessible :name, :login, :password, :password_confirmation
+        acts_as_authentic do |c|
+          c.crypto_provider          = Authlogic::CryptoProviders::InvisionPowerBoard
+          c.login_field              = :name
+          c.crypted_password_field   = :members_pass_hash
+          c.password_salt_field      = :members_pass_salt
+          c.validate_password_field  = false
+        end
+      end
+    end
+  end
+end

data/rails/init.rb

@@ -1 +1 @@
-require 'invision_bridge/rails'
+require 'invision_bridge'

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: invision_bridge
 version: !ruby/object:Gem::Version 
-  hash: 21
+  hash: 19
   prerelease: false
   segments: 
   - 0
-  - 2
-  - 1
-  version: 0.2.1
+  - 3
+  - 0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Robert Speicher
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-18 00:00:00 -04:00
+date: 2010-09-24 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -47,18 +47,11 @@ files:
 - VERSION
 - config/database.yml.example
 - init.rb
-- install.rb
 - invision_bridge.gemspec
+- lib/authlogic/crypto_providers/invision_power_board.rb
 - lib/invision_bridge.rb
-- lib/invision_bridge/crypto_provider.rb
-- lib/invision_bridge/invision_bridge.rb
-- lib/invision_bridge/rails.rb
-- lib/invision_bridge/user/base.rb
+- lib/invision_bridge/active_record.rb
 - rails/init.rb
-- spec/invision_bridge/crypto_provider_spec.rb
-- spec/spec.opts
-- spec/spec_helper.rb
-- uninstall.rb
 has_rdoc: true
 homepage: http://github.com/tsigo/invision_bridge
 licenses: []
@@ -93,6 +86,5 @@ rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Allows your Authlogic-based User model to authenticate using an IP.Board 3.x database.
-test_files: 
-- spec/invision_bridge/crypto_provider_spec.rb
-- spec/spec_helper.rb
+test_files: []
+

data/install.rb

@@ -1 +0,0 @@
-# Install hook code here

data/lib/invision_bridge/invision_bridge.rb

@@ -1,34 +0,0 @@
-module InvisionBridge
-  module Base
-    def self.included(base)
-      base.extend(ClassMethods)
-    end
-
-    module ClassMethods
-      def establish_bridge()
-        if Rails
-          config_file  = Rails.configuration.database_configuration_file
-          config_group = "invision_bridge_#{Rails.env}"
-        else
-          config_file  = File.join(File.dirname(__FILE__), '..', '..', 'config', 'database.yml')
-          config_group = "invision_bridge"
-        end
-
-        config = YAML::load(File.open(config_file))
-        config = config[config_group]
-
-        if config.nil?
-          raise "Unable to read database configuration from #{config_file} -- Make sure an #{config_group} definition exists."
-        else
-          config['prefix'] ||= 'ibf_'
-        end
-
-        establish_connection(config)
-
-        unloadable # http://www.dansketcher.com/2009/05/11/cant-dup-nilclass/
-        set_table_name "#{config['prefix']}members"
-        set_primary_key "member_id"
-      end
-    end
-  end
-end

data/lib/invision_bridge/rails.rb

@@ -1,3 +0,0 @@
-require 'invision_bridge'
-require 'invision_bridge/invision_bridge'
-require 'invision_bridge/user/base'

data/lib/invision_bridge/user/base.rb

@@ -1,27 +0,0 @@
-module InvisionBridge
-  module User
-    class Base < ActiveRecord::Base
-      self.abstract_class = true
-
-      include InvisionBridge::Base
-      establish_bridge
-
-      # Authlogic -----------------------------------------------------------------
-      attr_accessible :login, :password, :password_confirmation
-      acts_as_authentic do |c|
-        c.crypto_provider          = Authlogic::CryptoProviders::InvisionPowerBoard
-        c.login_field              = :name
-        c.crypted_password_field   = :members_pass_hash
-        c.password_salt_field      = :members_pass_salt
-        c.validate_password_field  = false
-      end
-
-      # ---------------------------------------------------------------------------
-      # Override some AR methods; we don't want to mess with Invision's integrity
-      def destroy; end
-      def delete; end
-      def self.destroy_all; end
-      def self.delete_all; end
-    end
-  end
-end

data/spec/invision_bridge/crypto_provider_spec.rb

@@ -1,18 +0,0 @@
-require 'spec_helper'
-
-describe Authlogic::CryptoProviders::InvisionPowerBoard do
-  it "should encrypt" do
-    Authlogic::CryptoProviders::InvisionPowerBoard.encrypt("mypass").should be_true
-  end
-  
-  it "should match expected output" do
-    hash = Authlogic::CryptoProviders::InvisionPowerBoard.encrypt("mypass")
-    Authlogic::CryptoProviders::InvisionPowerBoard.matches?(hash, "mypass").should be_true
-  end
-  
-  it "should filter characters" do
-    pass = '?&amp;!&><"!\''
-    hash = Authlogic::CryptoProviders::InvisionPowerBoard.encrypt(pass)
-    Authlogic::CryptoProviders::InvisionPowerBoard.matches?(hash, pass).should be_true
-  end
-end

data/spec/spec.opts

@@ -1,3 +0,0 @@
---colour
---reverse
---backtrace

data/spec/spec_helper.rb

@@ -1,6 +0,0 @@
-require 'rubygems'
-require 'spec'
-require 'invision_bridge'
-
-$: << File.join(File.dirname(__FILE__), '..', 'lib')
-require File.join(File.dirname(__FILE__), '..', 'init')

data/uninstall.rb

@@ -1 +0,0 @@
-# Uninstall hook code here