nostos-source-illiad 0.0.2 → 0.0.4

data/README.md

@@ -12,20 +12,26 @@ Add the following to your Gemfile and run `bundle install`
 
 ## Configuration
 
-In `config/application.rb` add the following options:
-
-    config.source_illiad.number_of_days_to_poll = 2
-    config.source_illiad.db = {
-      :dataserver => '',
-      :adapter => 'sqlserver',
-      :host => '',
-      :dsn => '',
-      :username => '',
-      :password => '',
-      :database => ''
-    }
-
-`dataserver` is the name for your server as defined in freetds.conf. `number_of_days_to_poll` is how many days you want to poll into the past. This number must be greater than how often you run Nostos in order to stay synchronized. I recommend polling 2-3 days in the past at most.
+You can interactively configure the Illiad source driver by running `rails generate source_illiad:install`. This will prompt you for the necessariy values.
+
+You can manually configure the Illiad source drive in `config/source_illiad.rb`:
+
+    number_of_days_to_poll: 14
+
+    db:
+      adapter:    'sqlserver'
+      dataserver: ''
+      username:   ''
+      password:   ''
+
+    webcirc:
+      url:      'http://HOSTNAME/illiad/WebCirc/Logon.aspx'
+      username: ''
+      password: ''
+
+`dataserver` is the name for your server as defined in freetds.conf. `number_of_days_to_poll` is how many days you want to poll into the past. This number must be greater than how often you run Nostos in order to stay synchronized. I recommend polling 2-3 days in the past at most. Your WebCirc URL may be different, though the above should hold true for most OCLC hosted servers.
+
+The `db` variable will actually be passed directly to `ActiveRecord#establish_connection` so you can define any additional parameters as necessary.
 
 # Author
 

data/lib/nostos-source-illiad.rb

@@ -1,16 +1,13 @@
 # Source::Illiad, Nostos Source Driver for Illiad
 
-require 'nostos-source-illiad/railtie.rb'
+require 'nostos-source-illiad/railtie.rb' if defined?(Rails)
 require 'nostos-source-illiad/config.rb'
 require 'nostos-source-illiad/record.rb'
 require 'illiad'
 require 'illiad/transaction.rb'
+require 'nostos-source-illiad/generators/source_illiad_generator.rb'
 
 
-# activerecord-illiad-adapter is named Illiad, so we must rename it to avoid 
-# naming conflict.
-IlliadAR = Illiad
-
 module Source
   module Illiad 
     def self.config
@@ -22,7 +19,7 @@ module Source
     end
 
     def self.find(id)
-      IlliadAR::AR::Transaction.find(id).to_record
+      ::Illiad::AR::Transaction.find(id).to_record
     end
 
     # Poll Illiad for new transactions to process. The strategy is to find
@@ -50,7 +47,7 @@ module Source
           Transactions.RequestType = 'Loan'
       SQL
 
-      IlliadAR::AR::Transaction.find_by_sql(sql).map {|t| t.to_record}
+      ::Illiad::AR::Transaction.find_by_sql(sql).map {|t| t.to_record}
     end
   end
 end

data/lib/nostos-source-illiad/generators/source_illiad_generator.rb

@@ -0,0 +1,50 @@
+require 'rails/generators'
+
+module SourceIlliad
+  class InstallGenerator < Rails::Generators::Base
+    def configure
+      # Ask General Questions
+      puts "General Configuration:"
+      number_of_days_to_poll = ask('How many days in the past would you like to poll Illiad? [7]')
+      number_of_days_to_poll = 7 if number_of_days_to_poll.blank?
+
+      # Ask DB Questions
+      puts "Database Configuration:"
+      puts "The following fields are required to establish a connection with your Illiad server."
+      db = {}
+      db[:dataserver] = ask('dataserver (the name for your server as defined in freetds.conf): ')
+      db[:username] = ask('username (the database server user): ')
+      db[:password] = ask('password (the user password): ')
+
+      # Ask WebCirc Questions
+      puts "WebCirc Configuration:"
+      webcirc = {}
+      webcirc[:url] = ask('URL: ')
+      webcirc[:username] = ask('Username: ')
+      webcirc[:password] = ask('Password: ')
+
+      # Configure application settings
+      create_file File.join(Rails.root, 'config', 'source_illiad.yml'), <<CONFIG
+# Source Illiad Configuration
+
+# This is the number of days into the past you would like to poll. 
+# This value must be greater than how often you run your daily cron job.
+number_of_days_to_poll: #{number_of_days_to_poll}
+
+# Database
+db:
+  adapter:    'sqlserver'
+  dataserver: '#{db[:dataserver]}'
+  username:   '#{db[:username]}'
+  password:   '#{db[:password]}'
+
+# Web Circulation
+webcirc:
+  url:      '#{webcirc[:url]}'
+  username: '#{webcirc[:username]}'
+  password: '#{webcirc[:password]}'
+CONFIG
+
+    end
+  end
+end

data/lib/nostos-source-illiad/railtie.rb

@@ -5,16 +5,21 @@ module Source
     class Railtie < Rails::Railtie
       config.source_illiad = ActiveSupport::OrderedOptions.new
 
+      
       initializer "source_illiad.configure" do |app|
-        Source::Illiad.configure do |config|
-          config.number_of_days_to_poll = app.config.source_illiad[:number_of_days_to_poll]
-          config.db = app.config.source_illiad[:db]
-          config.webcirc = app.config.source_illiad[:webcirc]
-        end
-      end
+        config_file = File.join(Rails.root, 'config', 'source_illiad.yml')
 
-      initializer "source_illiad.establish_connection", :after => "source_illiad.configure" do |app|
-        IlliadAR::AR::Base.establish_connection(Source::Illiad.config.db)
+        # Only run configuration if config/source_illiad.yml exists
+        if File.exists?(config_file)
+          CONFIG = YAML::load(File.open(config_file))
+          Source::Illiad.configure do |config|
+            config.number_of_days_to_poll = CONFIG["number_of_days_to_poll"]
+            config.db = CONFIG["db"]
+            config.webcirc = CONFIG["webcirc"]
+          end
+
+          ::Illiad::AR::Base.establish_connection(Source::Illiad.config.db)
+        end
       end
     end
   end

data/lib/nostos-source-illiad/record.rb

@@ -15,7 +15,7 @@ module Source
 
       def charged?(force = false)
         if force then
-          t = IlliadAR::AR::Transaction.find(@id)
+          t = ::Illiad::AR::Transaction.find(@id)
           @due_date = t.due_date
           @charged = t.charged?
         end
@@ -28,12 +28,12 @@ module Source
         agent = Mechanize.new# { |a| a.log = Logger.new(STDERR) }
 
         # Load Illiad Web Circulation
-        page = agent.get(Source::Illiad.config.webcirc[:url])
+        page = agent.get(Source::Illiad.config.webcirc['url'])
 
         # Select, fill in, and submit the logon form.
         page = page.form('formLogon') do |f|
-          f.TextBoxUsername = Source::Illiad.config.webcirc[:username]
-          f.TextBoxPassword = Source::Illiad.config.webcirc[:password]
+          f.TextBoxUsername = Source::Illiad.config.webcirc['username']
+          f.TextBoxPassword = Source::Illiad.config.webcirc['password']
         end.click_button
 
         # Mechanize::ResponseCodeError - 500 => Net::HTTPInternalServerError:

data/lib/nostos-source-illiad/version.rb

@@ -1,5 +1,5 @@
 module Source
   module Illiad
-    VERSION = "0.0.2"
+    VERSION = "0.0.4"
   end
 end

metadata

@@ -2,7 +2,7 @@
 name: nostos-source-illiad
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.2
+  version: 0.0.4
 platform: ruby
 authors: 
 - Brice Stacey
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-15 00:00:00 Z
+date: 2011-04-21 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: illiad
@@ -51,6 +51,7 @@ files:
 - lib/illiad/transaction.rb
 - lib/nostos-source-illiad.rb
 - lib/nostos-source-illiad/config.rb
+- lib/nostos-source-illiad/generators/source_illiad_generator.rb
 - lib/nostos-source-illiad/railtie.rb
 - lib/nostos-source-illiad/record.rb
 - lib/nostos-source-illiad/version.rb