inaka-wp_on_rails 0.1.0

data/README.rdoc

@@ -0,0 +1,61 @@
+== WordPress On Rails
+
+The goal of this simple Gem is to provide a set of ActiveRecord objects 
+that can manipulate a WordPress database. 
+
+== What's new in this release?
+ 
+This is really just a set of objects right now. It needs to be expanded on before it can be used to manipulate a WP installation without a lot of inside information as to what each field means.
+
+== Installation/Usage
+
+WordPress Administrators must use PRE-2.5 credential hashing algorithm, which is less secure, if you want to be able to authenticate users
+in Rails. See http://wordpress.org/extend/plugins/md5-password-hashes/
+gem install wp_on_rails
+
+require 'wp_on_rails'
+
+# if you want to use one database for your rails application and another for wordpress
+# create a 'blog' connection in your database file with the proper credentials 
+# also, a third parameter can be passed in which is the prefix to assign to the 
+# wordpress table names - this is optional.
+WordPress::Base.init_connection(#{RAILS_ROOT}/config/database.yml','blog','blog1_')
+
+# if you set a prefix in your installation and your wordpress tables are in the current database
+WordPress::Base.set_table_prefix('prefix_')  
+
+== TODO
+
+- Not all tables are in place
+- Relationships between tables are missing
+- Tests
+- Documentation
+- Implement PHPass and remove MD5 password hashing requirement
+
+== See Also
+
+The WordPress schema is at http://codex.wordpress.org/Database_Description
+  
+== License
+
+(Licensed under the terms of the MIT License)
+
+Copyright (c) 2008 Chad DePue, Electronic Inaka, LLC
+
+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/Rakefile

@@ -0,0 +1,14 @@
+require 'rubygems'
+require 'rake'
+require 'echoe'
+
+Echoe.new('wp_on_rails','0.1.0') do |p|
+  p.description = "Use ActiveRecord to manipulate a WordPress database directly."
+  p.url = "http://github.com/inaka/wp_on_rails"
+  p.author = "Chad DePue"
+  p.email = "chad@inakanetworks.com"
+  p.ignore_pattern = ["tmp/*", "script/*"]
+  p.development_dependencies = []
+end
+
+Dir["#{File.dirname(__FILE__)}/tasks/*.rake"].sort.each { |ext| load ext }

data/lib/wp_on_rails.rb

@@ -0,0 +1,90 @@
+require 'active_record'
+
+module WordPress
+  def self.included(base)
+    base.extend ClassMethods
+  end
+  
+  module ClassMethods
+    
+    attr_accessor :config
+    attr_accessor :yaml_db_name
+
+    # a wordpress installation may prefix all tables with a string to allow a DB to colocate multiple installations in the same physical db
+    # we must track the 'root name' of the table and call set_table_name when the prefix is set. 
+    attr_accessor :table_root
+ 
+    # establishes a separate connection to a WP database. Expects a YAML file with the name of the database
+    def init_connection(file, db_name, prefix=nil)
+      config = YAML.load_file(file)
+      @yaml_db_name = db_name
+      self.subclasses.each() do |c| 
+        c.establish_connection(config[db_name])
+        c.send('set_table_name',prefix.blank? ? c.table_root : "#{prefix}#{c.table_root}")
+      end
+    end
+    
+    def set_table_prefix(prefix)
+      self.subclasses.each() { |c| c.send('set_table_name',prefix.blank? ? c.table_root : "#{prefix}#{c.table_root}") }
+    end
+    
+    def set_table_root(table)
+      @table_root = table
+    end
+    
+    # currently only supports md5 passwords - requires wp administrator
+    # to install this plugin - http://wordpress.org/extend/plugins/md5-password-hashes/
+    # should upgrade to match encryption w/PHPass
+    def hash_password(pass)
+      require 'digest/md5'
+      Digest::MD5.digest(pass).unpack("H*")[0]
+    end
+  end
+  
+  class Base < ActiveRecord::Base
+    extend WordPress::ClassMethods 
+  end
+  
+  class Comment < WordPress::Base
+    set_table_root 'comments'
+  end
+  
+  class Link < WordPress::Base
+    set_table_root 'links'
+  end
+  
+  class Option < WordPress::Base
+    set_table_root 'options'
+  end
+  
+  class PostMeta < WordPress::Base
+    set_table_root 'postmeta'
+    set_primary_key 'meta_id'
+    belongs_to :post, :class_name => "WordPress::Post"
+  end
+  
+  class Term < WordPress::Base
+    set_table_root 'terms'
+  end
+  
+  class Post < WordPress::Base
+    set_table_root 'posts'
+    set_primary_key 'ID'  # required because the field in the wp db is capitalized
+    has_many :post_metas, :class_name => "WordPress::PostMeta", :foreign_key => "post_id" 
+  end
+  
+  class User < WordPress::Base
+    set_table_root 'users'
+  end
+  
+  class Usermeta < WordPress::Base
+    set_table_root 'usermeta'
+    set_primary_key 'umeta_id'
+  end
+  
+  # must be at end to set all subclasses
+  class Base < ActiveRecord::Base
+    set_table_prefix 'wp_'  # default prefix
+  end
+  
+end

metadata

@@ -0,0 +1,56 @@
+--- !ruby/object:Gem::Specification 
+name: inaka-wp_on_rails
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Chad DePue
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-01-04 00:00:00 -08:00
+default_executable: 
+dependencies: []
+
+description: wp_on_rails is an ActiveRecord interface to a WordPress database.
+email: chad@inakanetworks.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README.rdoc
+- lib/wp_on_rails.rb
+- Manifest
+- Rakefile
+has_rdoc: true
+homepage: http://github.com/inaka/wp_on_rails
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: ActiveRecord interface to a WordPress database
+test_files: []
+