artk 0.0.1 → 0.1.0

data/README.md

@@ -38,17 +38,46 @@ And then add the engine to your application
 
     mount Artk::Engine => '/artk'
 
-Configure the gem to connect to your database by adding a `config/initializers/at_connect.rb` file:
-
-    ActiveRecord::Base.establish_connection(
-      :adapter  => 'mysql2',
-      :encoding => 'utf8',
-      :database => 'at_database_name',
-      :host     => 'host_of_the_at_database',
-      :username => 'username',
-      :password => 'password'
-    )
-
+Configure the gem to connect to your Archivists' Toolkit database by editing `config/database.yml` and adding these lines: 
+
+    artk_development:
+      adapter: mysql2
+      encoding: utf8
+      reconnect: false
+      database: atk
+      pool: 5
+      username: root
+      password: password 
+      host: localhost
+
+    artk_test:
+      adapter: mysql2
+      encoding: utf8
+      reconnect: false
+      database: bl_test
+      pool: 5
+      username: root
+      password: password
+      host: localhost
+
+    artk_production:
+      adapter: mysql2
+      encoding: utf8
+      reconnect: false
+      database: bl_prod
+      pool: 5
+      username: root
+      password: password
+      host: localhost
+
+The above configuration is for Mysql, so your adapater may vary, and you'll need to change these username,
+password, and host values to match your environment.  Using this configuration allows you to keep your databases
+separate.  For example, the Rails database for your application would be defined by the `developement` yaml
+value, while the Archivists' Toolkit database by the `artk_development` yaml value, and so forth with the other
+environments.
+
+To be safe, you might want to use a username for the Toolkit connection that has only SELECT rights,
+and avoid any possibility of the Rails application trying to make changes to the wrong database.
 
 ## Contributing
 

data/app/models/artk/accession.rb

@@ -1,4 +1,5 @@
-class Artk::Accession < ActiveRecord::Base
+module Artk
+class Accession < Artk::Base
   
   def self.table_name
     "Accessions"
@@ -8,4 +9,5 @@ class Artk::Accession < ActiveRecord::Base
     "accessionId"
   end
 
+end
 end

data/app/models/artk/base.rb

@@ -0,0 +1,6 @@
+module Artk
+class Base < ActiveRecord::Base
+  self.abstract_class = true
+  establish_connection "artk_#{Rails.env}"
+end
+end

data/app/models/artk/component.rb

@@ -1,5 +1,5 @@
 module Artk
-class Component < ActiveRecord::Base
+class Component < Artk::Base
 
   belongs_to :resource, :foreign_key => "resourceId"
   has_many :sub_components, :class_name => "Component", :foreign_key => "parentResourceComponentId"

data/app/models/artk/resource.rb

@@ -1,5 +1,5 @@
 module Artk
-class Resource < ActiveRecord::Base
+class Resource < Artk::Base
 
   has_many :components, :foreign_key => "resourceId"
 

data/lib/artk/version.rb

@@ -1,3 +1,3 @@
 module Artk
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: artk
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-08 00:00:00.000000000 Z
+date: 2013-10-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -44,7 +44,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec-rails
+  name: mysql2
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -60,7 +60,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: mysql2
+  name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -106,10 +106,10 @@ files:
 - app/controllers/artk/resources_controller.rb
 - app/helpers/artk/application_helper.rb
 - app/models/artk/accession.rb
+- app/models/artk/base.rb
 - app/models/artk/component.rb
 - app/models/artk/resource.rb
 - app/views/layouts/artk/application.html.erb
-- config/initializers/at_connect.rb
 - config/routes.rb
 - lib/artk/engine.rb
 - lib/artk/version.rb
@@ -133,7 +133,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2761099062751207607
+      hash: 4392052325810986348
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -142,7 +142,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2761099062751207607
+      hash: 4392052325810986348
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23

data/config/initializers/at_connect.rb

@@ -1,11 +0,0 @@
-# sample connection configuration.  Rename to at_connect.rb 
-#
-# We override ActiveRecord to connect to our AT Database
-ActiveRecord::Base.establish_connection(
-  :adapter  => 'mysql2',
-  :encoding => 'utf8',
-  :database => 'atk',
-  :host     => 'localhost',
-  :username => 'root',
-  :password => 'password'
-)