invision_bridge 0.1.0 → 0.2.0

data/README.md

@@ -0,0 +1,66 @@
+# 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.
+
+## Usage
+
+### Database configuration
+
+You'll need to **manually** alter the `ibf_members` table in your IP.Board database to
+add the following fields for use by Authlogic:
+
+    persistence_token             varchar(255)          NOT NULL
+    last_request_at               datetime              NULL
+    current_login_at              datetime              NULL
+    last_login_at                 datetime              NULL
+    current_login_ip              varchar(255)          NULL
+    last_login_ip                 varchar(255)          NULL
+    single_access_token           varchar(255)          NULL
+
+Modify your `config/database.yml` file to include your IP.Board database information:
+
+    invision_bridge_development:
+      adapter: mysql
+      database: my_forums_development
+      host: localhost
+      user: username
+      password: password
+      prefix: ibf_
+
+    invision_bridge_production:
+      adapter: mysql
+      database: my_forums
+      host: localhost
+      user: username
+      password: password
+      prefix: ibf_
+
+### Model creation
+
+Modify or create your User model to inherit from `InvisionBridge::User::Base`
+
+    class User < InvisionBridge::User::Base
+    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
+      ADMIN_GROUP = 1
+
+      def is_admin?
+        self.member_group_id == ADMIN_GROUP
+      end
+    end
+
+## Known Issues
+
+While using this in my own production application, I'd occasionally get "MySQL
+server has gone away" exceptions popping up. I still don't know the root cause,
+but I was able to make the error stop appearing by adding `reconnect: true` to the
+`invision_bridge_production` database definition.
+
+## Credits
+
+Copyright (c) 2010 Robert Speicher, released under the MIT license

data/Rakefile

@@ -26,10 +26,10 @@ begin
   require 'jeweler'
   Jeweler::Tasks.new do |s|
     s.name        = "invision_bridge"
-    s.summary     = "Uses Authlogic to allow your User model to use an IP.Board 3.x database."
+    s.summary     = "Allows your Authlogic-based User model to authenticate using an IP.Board 3.x database."
     s.email       = "rspeicher@gmail.com"
     s.homepage    = "http://github.com/tsigo/invision_bridge"
-    s.description = "Uses Authlogic to allow your User model to use an IP.Board 3.x database."
+    s.description = "Allows your Authlogic-based User model to authenticate using an IP.Board 3.x database."
     s.authors     = ["Robert Speicher"]
     s.files       = FileList["[A-Za-z]*", "{lib,rails,spec,config}/**/*"]
     s.add_dependency 'authlogic'

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/invision_bridge.gemspec

@@ -5,19 +5,19 @@
 
 Gem::Specification.new do |s|
   s.name = %q{invision_bridge}
-  s.version = "0.1.0"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Robert Speicher"]
-  s.date = %q{2010-01-29}
-  s.description = %q{Uses Authlogic to allow your User model to use an IP.Board 3.x database.}
+  s.date = %q{2010-08-18}
+  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 = [
-    "README.textile"
+    "README.md"
   ]
   s.files = [
     "MIT-LICENSE",
-     "README.textile",
+     "README.md",
      "Rakefile",
      "VERSION",
      "config/database.yml.example",
@@ -38,8 +38,8 @@ Gem::Specification.new do |s|
   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.5}
-  s.summary = %q{Uses Authlogic to allow your User model to use an IP.Board 3.x database.}
+  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"
@@ -49,7 +49,7 @@ Gem::Specification.new do |s|
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<authlogic>, [">= 0"])
     else
       s.add_dependency(%q<authlogic>, [">= 0"])

data/lib/invision_bridge/invision_bridge.rb

@@ -7,14 +7,20 @@ module InvisionBridge
     module ClassMethods
       def establish_bridge()
         if Rails
-          config = YAML::load(File.open(Rails.configuration.database_configuration_file))
-          config = config["invision_bridge_#{Rails.env}"]
+          config_file  = Rails.configuration.database_configuration_file
+          config_group = "invision_bridge_#{Rails.env}"
         else
-          config = YAML::load(File.open(File.join(File.dirname(__FILE__), '..', '..', 'config', 'database.yml')))
-          config = config["invision_bridge"]
+          config_file  = File.join(File.dirname(__FILE__), '..', '..', 'config', 'database.yml')
+          config_group = "invision_bridge"
         end
 
-        config['prefix'] ||= 'ibf_'
+        begin
+          config = YAML::load(config_file)
+          config = config[config_group]
+          config['prefix'] ||= 'ibf_'
+        rescue NoMethodError
+          raise "Unable to read database configuration from #{config_file} -- Make sure an #{config_group} definition exists."
+        end
 
         establish_connection(config)
 

metadata

@@ -1,7 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: invision_bridge
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  hash: 23
+  prerelease: false
+  segments: 
+  - 0
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Robert Speicher
@@ -9,30 +15,34 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-01-29 00:00:00 -05:00
+date: 2010-08-18 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: authlogic
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
         version: "0"
-    version: 
-description: Uses Authlogic to allow your User model to use an IP.Board 3.x database.
+  type: :runtime
+  version_requirements: *id001
+description: Allows your Authlogic-based User model to authenticate using an IP.Board 3.x database.
 email: rspeicher@gmail.com
 executables: []
 
 extensions: []
 
 extra_rdoc_files: 
-- README.textile
+- README.md
 files: 
 - MIT-LICENSE
-- README.textile
+- README.md
 - Rakefile
 - VERSION
 - config/database.yml.example
@@ -59,24 +69,30 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: Uses Authlogic to allow your User model to use an IP.Board 3.x database.
+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

data/README.textile

@@ -1,7 +0,0 @@
-h1. InvisionBridge
-
-A Rails plugin to allow Authlogic to use an Invision Power Board database's user credentials.
-
-h2. Credits
-
-Copyright (c) 2009 Robert Speicher, released under the MIT license