donors_choose 0.0.1

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in donors_choose.gemspec
+gemspec

data/README.textile

@@ -0,0 +1,51 @@
+h1. donors_choose
+
+This library sprung from the 2011 Hacking Education contest for DonorsChoose.org. (http://www.donorschoose.org/hacking-education)
+
+The DonorsChoose::Data module match up the normalized data provided by DonorsChoose.org to classes that inherit from ActiveRecord::Base.
+
+*This gem assumes you have loaded the DonorsChoose.org datasets into a PostgreSQL database.*
+
+h2. Usage
+
+<code>
+project = DonorsChoose::Data::Project.first
+project.donations
+school = DonorsChoose::Data::School.last
+school.teachers
+</code>
+
+
+h3. Rails
+
+If you'd like to use it in Rails, just add the following to your Gemfile:
+
+<code>
+gem 'donors_choose'
+</code>
+
+h3. Stand alone
+
+If you'd like to use it stand alone, do the following:
+
+Create a database.yml, very similar to what you'd have in Rails:
+
+bq. adapter: postgresql
+host: localhost
+username: postgres
+password: password
+port: 5432
+database: donors_choose_data
+schema_search_path: public
+
+Then, drop into irb, require the gem, and establish the db connection
+
+<code>
+terminal$ irb
+irb(main):001:0> require 'rubygems'
+irb(main):001:0> require 'donors_choose'
+irb(main):001:0> DonorsChoose::Data.connect(YAML.load(File.read('database.yml')))
+irb(main):001:0> DonorsChoose::Data::Project.first
+</code>
+
+

data/Rakefile

@@ -0,0 +1,16 @@
+# Bundler tasks
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+# Test tasks
+require 'rake'
+require 'rake/testtask'
+
+desc "Run basic tests"
+Rake::TestTask.new("test_units") { |t|
+  t.pattern = 'test/*/*/*_test.rb'
+  t.verbose = true
+  t.warning = true
+}
+
+task :default => [:test_units]

data/donors_choose.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "donors_choose/version"
+
+Gem::Specification.new do |s|
+  s.name        = "donors_choose"
+  s.version     = DonorsChoose::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Mark McSpadden"]
+  s.email       = [""]
+  s.homepage    = ""
+  s.summary     = %q{Libaries to assist with mining and utilizing donorschoose.org}
+  s.description = %q{}
+
+  s.rubyforge_project = "donors_choose"
+  
+  s.add_dependency 'activerecord', '> 3.0'
+  s.add_dependency 'pg'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/lib/donors_choose.rb

@@ -0,0 +1,5 @@
+module DonorsChoose
+  
+end
+
+require File.expand_path(File.dirname(__FILE__) + "/donors_choose/data")

data/lib/donors_choose/data.rb

@@ -0,0 +1,18 @@
+require 'active_record'
+require 'pg'
+
+module DonorsChoose
+  module Data
+      
+    # Use this if you're going standalone (aka sans Rails)
+    def self.connect(postgres_config = {})
+      # Connect with db
+      ActiveRecord::Base.establish_connection(postgres_config)
+    end
+
+    Dir.glob("#{File.dirname __FILE__}/data/*.rb").each do |f|
+      require f
+    end  
+  end
+end
+

data/lib/donors_choose/data/account.rb

@@ -0,0 +1,10 @@
+module DonorsChoose
+  module Data
+    class Account < ActiveRecord::Base
+      set_table_name :normalized_account
+      set_primary_key :_acctid
+  
+      belongs_to :city, :foreign_key => :cityid
+    end
+  end
+end

data/lib/donors_choose/data/city.rb

@@ -0,0 +1,9 @@
+module DonorsChoose
+  module Data
+    class City < ActiveRecord::Base
+      set_table_name :normalized_city
+  
+      has_many :accounts, :foreign_key => :cityid
+    end
+  end
+end

data/lib/donors_choose/data/donation.rb

@@ -0,0 +1,10 @@
+module DonorsChoose
+  module Data
+    class Donation < ActiveRecord::Base
+      set_table_name :normalized_donation
+      set_primary_key :_donationid
+  
+      belongs_to :project, :foreign_key => :_projectid
+    end
+  end
+end

data/lib/donors_choose/data/essay.rb

@@ -0,0 +1,10 @@
+module DonorsChoose
+  module Data
+    class Essay < ActiveRecord::Base
+      set_table_name :normalized_essay
+      set_primary_key :_projectid
+  
+      belongs_to :project, :foreign_key => :_projectid
+    end
+  end
+end

data/lib/donors_choose/data/giftcard.rb

@@ -0,0 +1,8 @@
+module DonorsChoose
+  module Data
+    class Giftcard < ActiveRecord::Base
+      set_table_name :normalized_giftcard
+      set_primary_key :_giftcardid
+    end
+  end
+end

data/lib/donors_choose/data/project.rb

@@ -0,0 +1,16 @@
+module DonorsChoose
+  module Data
+    class Project < ActiveRecord::Base
+      set_table_name :normalized_project
+      set_primary_key :_projectid
+  
+      belongs_to :school, :foreign_key => :_schoolid
+      belongs_to :teacher, :foreign_key => :_teacher_acctid
+  
+      has_one :essay, :foreign_key => :_projectid
+  
+      has_many :donations, :foreign_key => :_projectid
+      has_many :resources, :foreign_key => :_projectid
+    end
+  end
+end

data/lib/donors_choose/data/resource.rb

@@ -0,0 +1,10 @@
+module DonorsChoose
+  module Data
+    class Resource < ActiveRecord::Base
+      set_table_name :normalized_resource
+      set_primary_key :_resourceid
+  
+      belongs_to :project, :foreign_key => :_projectid
+    end
+  end
+end

data/lib/donors_choose/data/school.rb

@@ -0,0 +1,11 @@
+module DonorsChoose
+  module Data
+    class School < ActiveRecord::Base
+      set_table_name :normalized_school
+      set_primary_key :_schoolid
+  
+      has_many :projects, :foreign_key => :_schoolid
+      has_many :teachers, :through => :projects
+    end
+  end
+end

data/lib/donors_choose/data/teacher.rb

@@ -0,0 +1,11 @@
+module DonorsChoose
+  module Data
+    class Teacher < ActiveRecord::Base
+      set_table_name :normalized_teacher
+      set_primary_key :_teacher_acctid
+  
+      has_many :projects, :foreign_key => :_teacher_acctid
+      has_many :schools, :through => :projects
+    end
+  end
+end

data/lib/donors_choose/version.rb

@@ -0,0 +1,3 @@
+module DonorsChoose
+  VERSION = "0.0.1"
+end

data/test/donors_choose/data/account_test.rb

@@ -0,0 +1,17 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../test_helper')
+
+class AccountTest < Test::Unit::TestCase
+  
+  def setup
+    @account = DonorsChoose::Data::Account.order(:_acctid).first
+  end
+  
+  def test_account_setup
+    assert_equal "00008481214e948f070337066f875fb2", @account._acctid
+  end
+  
+  def test_city_setup
+    assert_equal 4474, @account.city.id
+  end
+
+end

data/test/donors_choose/data/city_test.rb

@@ -0,0 +1,17 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../test_helper')
+
+class CityTest < Test::Unit::TestCase
+  
+  def setup
+    @city = DonorsChoose::Data::City.first
+  end
+  
+  def test_city_setup
+    assert_equal 1, @city.id
+  end
+  
+  def test_accounts_setup
+    assert_equal "c4127fe826abef12174ca4d0e7288f88", @city.accounts.first._acctid
+  end
+
+end

data/test/donors_choose/data/donation_test.rb

@@ -0,0 +1,16 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../test_helper')
+
+class DonationTest < Test::Unit::TestCase
+  
+  def setup
+    @donation = DonorsChoose::Data::Donation.order(:_donationid).first
+  end
+  
+  def test_donation_setup
+    assert_equal "0000023f507999464aa2b78875b7e5d6", @donation._donationid
+  end
+
+  def test_project_setup
+    assert_equal "69bf3a609bb4673818e0eebd004ea504", @donation.project._projectid
+  end
+end

data/test/donors_choose/data/essay_test.rb

@@ -0,0 +1,17 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../test_helper')
+
+class EssayTest < Test::Unit::TestCase
+  
+  def setup
+    @essay = DonorsChoose::Data::Essay.order(:_projectid).first
+  end
+  
+  def test_essay_setup
+    assert_equal "0000023f507999464aa2b78875b7e5d6", @essay._projectid
+  end
+  
+  def test_project_setup
+    assert_equal "0000023f507999464aa2b78875b7e5d6", @essay.project._projectid
+  end
+
+end

data/test/donors_choose/data/giftcard_test.rb

@@ -0,0 +1,13 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../test_helper')
+
+class GiftcardTest < Test::Unit::TestCase
+  
+  def setup
+    @giftcard = DonorsChoose::Data::Giftcard.order(:_giftcardid).first
+  end
+  
+  def test_giftcard_setup
+    assert_equal "000238b44c187c254752736e53ee46f2", @giftcard._giftcardid
+  end
+
+end

data/test/donors_choose/data/project_test.rb

@@ -0,0 +1,33 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../test_helper')
+
+class ProjectTest < Test::Unit::TestCase
+  
+  def setup
+    @project = DonorsChoose::Data::Project.order(:_projectid).first
+  end
+  
+  def test_project_setup
+    assert_equal "0000023f507999464aa2b78875b7e5d6", @project._projectid
+  end
+
+  def test_donation_setup
+    assert_equal "ee519de971e6ec8961f5efa06c6ed191", @project.donations.first._donationid
+  end
+  
+  def test_essay_setup
+    assert_equal "0000023f507999464aa2b78875b7e5d6", @project.essay._projectid
+  end
+
+  def test_teacher_setup
+    assert_equal "5ac258059d9c4fc4db5c1a92b7204db0", @project.teacher._teacher_acctid
+  end
+  
+  def test_resources_setup
+    assert_equal "179328a86f77fd5516d122f371c41d32", @project.resources.first._resourceid
+  end
+  
+  def test_school_setup
+    assert_equal "c8eafeea02033a1cacd629b410668d55", @project.school._schoolid
+  end
+
+end

data/test/donors_choose/data/resource_test.rb

@@ -0,0 +1,17 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../test_helper')
+
+class ResourceTest < Test::Unit::TestCase
+  
+  def setup
+    @resource = DonorsChoose::Data::Resource.order(:_resourceid).first
+  end
+  
+  def test_resource_setup
+    assert_equal "00000170fe6288e0bc4d136e7d9b5ff2", @resource._resourceid
+  end
+  
+  def test_project_setup
+    assert_equal "401699836249c08c7a686b33e243b826", @resource.project._projectid
+  end
+
+end

data/test/donors_choose/data/school_test.rb

@@ -0,0 +1,16 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../test_helper')
+
+class SchoolTest < Test::Unit::TestCase
+  
+  def setup
+    @school = DonorsChoose::Data::School.order(:_schoolid).first
+  end
+  
+  def test_school_setup
+    assert_equal "00064eac8b3d1f6dea8a07559922ed58", @school._schoolid
+  end
+  
+  def test_project_setup
+    assert_equal "2934f1c8ae5069a41fe601dcf57601be", @school.projects.first._projectid
+  end
+end

data/test/donors_choose/data/teacher_test.rb

@@ -0,0 +1,21 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../test_helper')
+
+class TeacherTest < Test::Unit::TestCase
+  
+  def setup
+    @teacher = DonorsChoose::Data::Teacher.order(:_teacher_acctid).first
+  end
+  
+  def test_teacher_setup
+    assert_equal "0000fc70ad0a307d08f88a484dd99cb4", @teacher._teacher_acctid
+  end
+  
+  def test_projects_setup
+    assert_equal "dde9ff3a749c46a5d6d6be4f37b0dba6", @teacher.projects.first._projectid
+  end
+  
+  def test_schools_setup
+    assert_equal "3a379fd45cb12c92c3c4283e97421111", @teacher.schools.first._schoolid
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,15 @@
+require 'test/unit'
+
+require 'rubygems'
+
+require File.expand_path(File.dirname(__FILE__) + "/../lib/donors_choose/data")
+
+postgres_config = { :adapter => "postgresql",
+                    :host => "localhost",
+                    :username => "postgres",
+                    :password => "password",
+                    :port => 5432,
+                    :database => "donors_choose_data",
+                    :schema_search_path => "public" }
+
+DonorsChoose::Data.connect postgres_config

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification 
+name: donors_choose
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Mark McSpadden
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-05-26 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">"
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        version: "3.0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: pg
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+description: ""
+email: 
+- ""
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- Gemfile
+- README.textile
+- Rakefile
+- donors_choose.gemspec
+- lib/donors_choose.rb
+- lib/donors_choose/data.rb
+- lib/donors_choose/data/account.rb
+- lib/donors_choose/data/city.rb
+- lib/donors_choose/data/donation.rb
+- lib/donors_choose/data/essay.rb
+- lib/donors_choose/data/giftcard.rb
+- lib/donors_choose/data/project.rb
+- lib/donors_choose/data/resource.rb
+- lib/donors_choose/data/school.rb
+- lib/donors_choose/data/teacher.rb
+- lib/donors_choose/version.rb
+- test/donors_choose/data/account_test.rb
+- test/donors_choose/data/city_test.rb
+- test/donors_choose/data/donation_test.rb
+- test/donors_choose/data/essay_test.rb
+- test/donors_choose/data/giftcard_test.rb
+- test/donors_choose/data/project_test.rb
+- test/donors_choose/data/resource_test.rb
+- test/donors_choose/data/school_test.rb
+- test/donors_choose/data/teacher_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: ""
+licenses: []
+
+post_install_message: 
+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"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: donors_choose
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Libaries to assist with mining and utilizing donorschoose.org
+test_files: 
+- test/donors_choose/data/account_test.rb
+- test/donors_choose/data/city_test.rb
+- test/donors_choose/data/donation_test.rb
+- test/donors_choose/data/essay_test.rb
+- test/donors_choose/data/giftcard_test.rb
+- test/donors_choose/data/project_test.rb
+- test/donors_choose/data/resource_test.rb
+- test/donors_choose/data/school_test.rb
+- test/donors_choose/data/teacher_test.rb
+- test/test_helper.rb