schoolfinder 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,22 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC
+spec/schoolfinder_api_key.yml

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 tcocca
+
+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/README.rdoc

@@ -0,0 +1,127 @@
+= schoolfinder
+
+A gem to interact with the education.com free schoolfinder api.
+
+Register for a Schoolfinder API Key Here:
+http://www.education.com/schoolfinder/tools/webservice/
+
+Schoolfinder API Documentation:
+http://www.education.com/schoolfinder/tools/webservice/documentation/
+
+
+== Installation
+
+  gem install schoolfinder
+
+In a rails app:
+
+  config.gem 'schoolfinder'
+
+
+== Usage
+
+Create a new instance of the Schoolfinder Client
+
+  @schoolfinder = Schoolfinder::Client.new('your_api_key')
+
+The following methods are available to the Schoolfinder::Client class, each method corresponds to an api call
+Each method returns a Schoolfinder::Response which responds to a call to :body
+
+:body is an instance of Hashie::Rash.  Hashie::Rash inherits from Hashie::Mash (see the following:  http://github.com/intridea/hashie ) with the only difference being that in a Hashie::Rash all keys (method names) of the original hash are "rubyified", converted from camelCase to underscore.  So, "methodName"  would be "method_name".  This in turn looks something like the following example:
+
+  @response = @schoolfinder.school_search(:zip => 02215)
+  @response.body.first.schoolname # => 'Fenway Park Academy'
+
+
+=== Schoolfinder::Client methods
+
+Notes on passing params to each method:  All parameter keys should be passed in exactly as stated in the schoolfinder api documentation linked above.
+
+The following default parameters are automatically passed through so you don't need to worry about them:
+
+  sn = sf, key = (your API key), f = (method_name), v = 3
+
+==== Search for Schools:
+
+  @response = @schoolfinder.school_search
+
+school_search takes an optional params hash.
+@response.body is an Array of Hashie:Rash objects
+
+==== Get Test Ratings:
+
+  @response = @schoolfinder.test_rating(:nces_id => "061029001146")
+
+test_rating requires either an nces_id or schoolid parameter passed through in hash format.
+@response.body is an Array of Hashie:Rash objects
+
+==== Get Student Diversity
+
+  @response = @response = @schoolfinder.student_diversity(:nces_id => "450231000564")
+
+student_diversity requires one of nces_id, schoolid, city or state
+@response.body is a Hashie:Rash object
+
+==== Get Test Scores
+
+  @response = @response = @schoolfinder.test_scores(:nces_id => "450231000564")
+
+test_scores requires one of schoolid, nces_id, districtid, districtleaid
+@response.body is a Hashie:Rash object
+
+==== Get Teacher Stats
+
+  @response = @schoolfinder.teacher_stats(:nces_id => "450231000564", :districtleaid => "4502310")
+
+teacher_stats requires one of schoolid, nces_id, districtid, districtleaid
+@response.body is a Hashie:Rash object
+
+==== Get Student Stats
+
+  @response = @schoolfinder.student_stats(:nces_id => "450231000564", :districtleaid => "4502310", :city => "Greenville", :state => "SC")
+
+student_stats requires one of schoolid, nces_id, districtid, districtleaid, city, state
+@response.body is a Hashie:Rash object
+
+==== Get Reviews
+
+  @response = @schoolfinder.get_reviews(:schoolid => "25381")
+
+get_reviews requires one of schoolid, nces_id
+@response.body is a Hashie:Rash object
+
+==== Number Of (for a city and state)
+
+  @response = @schoolfinder.number_of("Greenville", "SC")
+
+number_of requires 2 parameters  (city, state)
+@response.body is an Array of Hashie:Rash objects
+
+==== District Search
+
+  @response = @schoolfinder.district_search(:city => "Greenville", :state => "SC")
+
+district_search requires one of districtid, districtleaid, districtname, state, city, zip
+@response.body is an Array of Hashie:Rash objects
+
+==== Get Branding Data
+
+  @response = @schoolfinder.branding_data
+
+branding_data takes optional parameters (as noted in the documentation)
+@response.body is a Hashie:Rash object
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+
+== Copyright
+
+Copyright (c) 2010 Tom Cocca. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,48 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "schoolfinder"
+    gem.summary = %Q{api wrapper for the education.com schoolfinder}
+    gem.description = %Q{api wrapper for the education.com schoolfinder}
+    gem.email = "tom.cocca@gmail.com"
+    gem.homepage = "http://github.com/tcocca/schoolfinder"
+    gem.authors = ["tcocca"]
+    gem.add_dependency "httparty", ">= 0.6.1"
+    gem.add_dependency "hashie", ">= 0.3.1"
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    gem.add_development_dependency "webmock", ">= 1.3.4"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "schoolfinder #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/rash.rb

@@ -0,0 +1,67 @@
+class Hash
+  
+  # Converts all of the keys to strings, optionally formatting key name
+  def rubyify_keys!
+    keys.each{ |k|
+      v = delete(k)
+      new_key = k.to_s.to_underscore!
+      self[new_key] = v
+      v.rubyify_keys! if v.is_a?(Hash)
+      v.each{|p| p.rubyify_keys! if p.is_a?(Hash)} if v.is_a?(Array)
+    }
+    self
+  end
+ 
+end
+
+class String
+  
+  # converts a camel_cased string to a underscore string
+  # Same way ActiveSupport does string.underscore
+  def to_underscore!
+    self.to_s.gsub(/::/, '/').
+      gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+      gsub(/([a-z\d])([A-Z])/,'\1_\2').
+      tr("-", "_").
+      downcase
+  end
+  
+end
+
+module Hashie
+  
+  class Rash < Mash
+    
+    def initialize(source_hash = nil, default = nil, &blk)
+      if source_hash
+        source_hash.rubyify_keys!
+        deep_update(source_hash)
+      end
+      default ? super(default) : super(&blk)
+    end
+    
+    def initializing_reader(key)
+      ck = convert_key(key)
+      regular_writer(ck, Hashie::Rash.new) unless key?(ck)
+      regular_reader(ck)
+    end
+    
+    protected
+    
+    def convert_value(val, duping=false) #:nodoc:
+      case val
+        when ::Hashie::Rash
+          val.dup
+        when ::Hash
+          val = val.dup if duping
+          self.class.new(val)
+        when Array
+          val.collect{ |e| convert_value(e) }
+        else
+          val
+      end
+    end
+    
+  end
+  
+end

data/lib/schoolfinder.rb

@@ -0,0 +1,8 @@
+require 'rubygems'
+require 'httparty'
+require 'hashie'
+require 'rash'
+
+require 'schoolfinder/client'
+require 'schoolfinder/response'
+require 'schoolfinder/error'

data/lib/schoolfinder/client.rb

@@ -0,0 +1,73 @@
+module Schoolfinder
+  class Client
+    
+    include HTTParty
+    base_uri 'api.education.com'
+    format :json
+    
+    def initialize(api_key)
+      self.class.default_params :key  => api_key
+      self.class.default_params :sn   => 'sf'
+      self.class.default_params :resf => 'json'
+      self.class.default_params :v    => '3'
+    end
+    
+    def school_search(optional_params = {})
+      params = {:f => 'schoolSearch'}
+      make_request(params, optional_params)
+    end
+    
+    def test_rating(options)
+      params = {:f => 'getTestRating'}
+      make_request(params, options)
+    end
+    
+    def student_diversity(options)
+      params = {:f => 'getStudentDiversity'}
+      make_request(params, options)
+    end
+    
+    def test_scores(options)
+      params = {:f => 'getTestScores'}
+      make_request(params, options)
+    end
+    
+    def teacher_stats(options)
+      params = {:f => 'getTeacherStats'}
+      make_request(params, options)
+    end
+    
+    def student_stats(options)
+      params = {:f => 'getStudentStats'}
+      make_request(params, options)
+    end
+    
+    def reviews(options)
+      params = {:f => 'getReviews'}
+      make_request(params, options)
+    end
+    
+    def number_of(city, state)
+      params = {:f => 'numberOf', :city => city, :state => state}
+      make_request(params)
+    end
+    
+    def district_search(options)
+      params = {:f => 'districtSearch'}
+      make_request(params, options)
+    end
+    
+    def branding_data(optional_params = {})
+      params = {:f => 'gbd'}
+      make_request(params, optional_params)
+    end
+    
+    private
+    
+    def make_request(params, options = {})
+      params.merge!(options) unless options.blank?
+      Schoolfinder::Response.new(self.class.get('/service/service.php', :query => params))
+    end
+    
+  end
+end

data/lib/schoolfinder/error.rb

@@ -0,0 +1,17 @@
+module Schoolfinder
+  class Error < Exception
+    
+    attr_reader :code, :error
+    
+    def initialize(code, error)
+      @code = code
+      @error = error
+      super(message)
+    end
+    
+    def message
+      "Schoolfinder Error: #{@error} (code: #{@code})"
+    end
+    
+  end
+end

data/lib/schoolfinder/response.rb

@@ -0,0 +1,33 @@
+module Schoolfinder
+  class Response
+    
+    attr_accessor :body
+    
+    def initialize(response)
+      self.body = rash_response(response)
+      if self.body.respond_to?('fault_string')
+        raise Schoolfinder::Error.new(self.body.fault_code, self.body.fault_string)
+      end
+    end
+    
+    private
+    
+    def rash_response(response)
+      if response.is_a?(Array)
+        self.body = []
+        response.each do |b|
+          if b.is_a?(Hash)
+            self.body << Hashie::Rash.new(b)
+          else
+            self.body << b
+          end
+        end
+      elsif response.is_a?(Hash)
+        self.body = Hashie::Rash.new(response)
+      else
+        self.body = response
+      end
+    end
+    
+  end
+end

data/spec/rash_spec.rb

@@ -0,0 +1,63 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Rash" do
+  
+  context "string extensions" do
+    before do
+      @camel_case_strings = ["camelCase", "CamelCase", "stringTwoHumps", "StringHasThreeHumps"]
+      @underscore_strings = ["camel_case", "camel_case", "string_two_humps", "string_has_three_humps"]
+    end
+    
+    it "should convert camelcase strings to underscored strings" do
+      @camel_case_strings.collect{|s| s.to_underscore!}.should == @underscore_strings
+    end
+  end
+  
+  context "hash extensions" do
+    before do
+      @hash1 = {"testOne" => "1", "TestTwo" => "2", :testThree => 3, :TestFour => 4, :testFiveSix => 56}
+      @hash1.rubyify_keys!
+      @hash2 = {"test_one" => "1", "test_two" => "2", "test_three" => 3, "test_four" => 4, "test_five_six" => 56}
+    end
+    
+    it "should convert camel case-ed keys to underscore-ed keys" do
+      @hash1.should == @hash2
+    end
+  end
+  
+  context "rash" do
+    before do 
+      @original_hash = {
+        "varOne" => 1, 
+        "two" => 2, 
+        :three => 3, 
+        :varFour => 4, 
+        "fiveHumpHumps" => 5, 
+        :nested => {
+          "NestedOne" => "One", 
+          :two => "two",
+          "nested_three" => "three"
+        },
+        "nestedTwo" => {
+          "nested_two" => 22,
+          :nestedThree => 23
+        }
+      }
+      @rash = Hashie::Rash.new(@original_hash)
+    end
+    
+    it "should create a new rash where all the keys are underscored instead of camelcased" do
+      @rash.var_one.should == 1
+      @rash.two.should == 2
+      @rash.three.should == 3
+      @rash.var_four.should == 4
+      @rash.five_hump_humps.should == 5
+      @rash.nested.nested_one.should == "One"
+      @rash.nested.two.should == "two"
+      @rash.nested.nested_three.should == "three"
+      @rash.nested_two.nested_two.should == 22
+      @rash.nested_two.nested_three.should == 23
+    end
+  end
+  
+end

data/spec/responses/branding_data.json

@@ -0,0 +1 @@
+{"logosrc":"http:\/\/www.education.com\/i\/logo\/edu-logo-75x31.jpg","disclaimer":"&#169;Education.com, Inc. 2008.  Use is subject to <a href=\"http:\/\/www.education.com\/webservice\/terms\" target=\"_blank\">Terms of Service.<\/a>","lsp":"http:\/\/www.education.com\/schoolfinder\/us\/south-carolina\/greenville\/greenville-senior-high-academy\/","lsc":"http:\/\/www.education.com\/schoolfinder\/us\/south-carolina\/greenville\/","lsrs":"http:\/\/www.education.com\/schoolfinder\/us\/south-carolina\/greenville\/greenville-senior-high-academy\/reviews\/","lsr":"http:\/\/www.education.com\/schoolfinder\/us\/south-carolina\/greenville\/greenville-senior-high-academy\/reviews\/","ld":null}

data/spec/responses/district_search.json

@@ -0,0 +1 @@
+[{"district":{"districtid":"15076","districtname":"Anderson 1","state":"SC","districtleaid":"4500780","address":"P O BOX 99","city":"WILLIAMSTON","gradesserved":"PK-12","zip":"23219","phonenumber":"8648477344"}},{"district":{"districtid":"15031","districtname":"Greenville","state":"SC","districtleaid":"4502310","address":"BOX 2848","city":"GREENVILLE","gradesserved":"PK-12","zip":"23219","phonenumber":"8643553162"}},{"district":{"districtid":"15102","districtname":"Governor's Schools","state":"SC","districtleaid":null,"address":"","city":null,"gradesserved":null,"zip":null,"phonenumber":null}}]

data/spec/responses/failure.json

@@ -0,0 +1 @@
+{"faultCode":3,"faultString":"invalid api key","faultType":"error"}

data/spec/responses/number_of.json

@@ -0,0 +1 @@
+[{"school":"All","total":129},{"gradelevel":"Elementary","total":44},{"gradelevel":"Middle","total":25},{"gradelevel":"High","total":21},{"gradelevel":"Preschool","total":61},{"schooltype":"Charter","total":5},{"schooltype":"Magnet","total":12},{"schooltype":"Preschool","total":49},{"schooltype":"Private","total":19},{"schooltype":"Private, Alternative","total":2},{"schooltype":"Private, Early Childhood Program\/Day Care Center","total":10},{"schooltype":"Private, Montessori","total":1},{"schooltype":"Public","total":27},{"schooltype":"Special Education","total":1},{"schooltype":"Vocational\/Technical","total":3},{"district":"All","total":4}]

data/spec/responses/reviews.json

@@ -0,0 +1 @@
+{"rating":{"count":1,"total":5,"average":5},"review":[{"comment":"This is an outstanding school.  The accademic standards are demanding and the teaching staff is super."}]}

data/spec/responses/school_search.json

@@ -0,0 +1 @@
+[{"school":{"schoolid":"85302","schoolname":"Greenville Senior HI High School","zip":"29601","address":"1 Vardry Street","city":"Greenville","districtid":"15031","districtleaid":"4502310","AYPResult":"no","AYPResultYear":"2009","APIGrowth":{"total":""},"APIGrowthYear":"","MetSchoolwideGrowthTarget":null,"distance":0,"enrollment":{"total":1289},"gradelevel":"High","gradesserved":"9-12","latitude":34.840229,"longitude":-82.4064713,"phonenumber":"(864) 355-5500","schooldistrictname":"Greenville School District","schooltype":"Magnet","state":"SC","studentteacherratio":{"total":16},"website":"http:\/\/www.greenville.k12.sc.us\/gvilleh\/","nces_id":"450231000564","url":"http:\/\/www.education.com\/schoolfinder\/us\/south-carolina\/greenville\/greenville-senior-high-academy\/"}},{"school":{"schoolid":"85381","schoolname":"Fuller Normal Advanced Charter School","zip":"29601","address":"Box 102","city":"Greenville","districtid":"15031","districtleaid":"4502310","AYPResult":"yes","AYPResultYear":"2009","APIGrowth":{"total":""},"APIGrowthYear":"","MetSchoolwideGrowthTarget":null,"distance":0,"enrollment":{"total":161},"gradelevel":"Elementary","gradesserved":"K-6","latitude":34.852623,"longitude":-82.3981018,"phonenumber":"(864) 271-3698","schooldistrictname":"Greenville School District","schooltype":"Charter","state":"SC","studentteacherratio":{"total":12},"website":"http:\/\/www.fnatcs.org","nces_id":"450231000962","url":"http:\/\/www.education.com\/schoolfinder\/us\/south-carolina\/greenville\/fuller-normal-advanced-charter-school\/"}},{"school":{"schoolid":"85990","schoolname":"Governor's School - Arts & Humanities","zip":"29601","address":"15 University Street","city":"Greenville","districtid":"15102","districtleaid":null,"AYPResult":null,"AYPResultYear":null,"APIGrowth":{"total":""},"APIGrowthYear":"","MetSchoolwideGrowthTarget":null,"distance":0,"enrollment":{"total":0},"gradelevel":"High","gradesserved":"9-12","latitude":34.8540382,"longitude":-82.3976288,"phonenumber":"(864) 282-3777","schooldistrictname":"Governor's Schools School District","schooltype":"Public","state":"SC","studentteacherratio":{"total":0},"website":"http:\/\/www.scgsah.state.sc.us","nces_id":null,"url":"http:\/\/www.education.com\/schoolfinder\/us\/south-carolina\/greenville\/governors-school--arts-and-humanities\/"}},{"school":{"schoolid":"105063","schoolname":"St Marys School","zip":"29601","address":"101 Hampton Ave","city":"Greenville","districtid":"16587","districtleaid":null,"AYPResult":null,"AYPResultYear":null,"APIGrowth":{"total":""},"APIGrowthYear":"","MetSchoolwideGrowthTarget":null,"distance":0,"enrollment":{"total":293},"gradelevel":"Elementary,Middle","gradesserved":"PK, K-8","latitude":34.8535957,"longitude":-82.4024353,"phonenumber":"(864) 271-3870","schooldistrictname":"SC Private Schools","schooltype":"Private","state":"SC","studentteacherratio":{"total":18},"website":"www.stmarysgvl.org\/theschool","nces_id":"01262779","url":"http:\/\/www.education.com\/schoolfinder\/us\/south-carolina\/greenville\/st-marys-school\/"}},{"school":{"schoolid":"105113","schoolname":"Haynsworth School","zip":"29601","address":"228 E Park Ave","city":"Greenville","districtid":"16587","districtleaid":null,"AYPResult":null,"AYPResultYear":null,"APIGrowth":{"total":""},"APIGrowthYear":"","MetSchoolwideGrowthTarget":null,"distance":0,"enrollment":{"total":40},"gradelevel":"Elementary","gradesserved":"PK, K-2","latitude":34.8574028,"longitude":-82.3923035,"phonenumber":"(864) 235-3010","schooldistrictname":"SC Private Schools","schooltype":"Private","state":"SC","studentteacherratio":{"total":3},"website":null,"nces_id":"01264018","url":"http:\/\/www.education.com\/schoolfinder\/us\/south-carolina\/greenville\/haynsworth-school\/"}},{"school":{"schoolid":"125062","schoolname":"First Presbyterian Academy","zip":"29601","address":"200 W Washington St","city":"Greenville","districtid":"16587","districtleaid":null,"AYPResult":null,"AYPResultYear":null,"APIGrowth":{"total":""},"APIGrowthYear":"","MetSchoolwideGrowthTarget":null,"distance":0,"enrollment":{"total":209},"gradelevel":"Elementary","gradesserved":"PK, K-1","latitude":34.851284,"longitude":-82.4006958,"phonenumber":"(864) 235-0122","schooldistrictname":"SC Private Schools","schooltype":"Private","state":"SC","studentteacherratio":{"total":5},"website":null,"nces_id":"K9305758","url":"http:\/\/www.education.com\/schoolfinder\/us\/south-carolina\/greenville\/first-presbyterian-church-kind\/"}}]

data/spec/responses/student_diversity.json

@@ -0,0 +1 @@
+{"school":{"gender":[{"name":"Female","percentage":50,"total":645,"year":2008},{"name":"Male","percentage":50,"total":642,"year":2008}],"ethnicity":[{"name":"White","percentage":49,"total":633,"year":2008},{"name":"Black","percentage":45,"total":573,"year":2008},{"name":"Hispanic","percentage":5,"total":70,"year":2008},{"name":"Asian\/Pacific Islander","percentage":1,"total":10,"year":2008},{"name":"American Indian\/Alaskan Native","percentage":0,"total":1,"year":2008}]},"city":{"gender":[{"name":"Female","percentage":48,"total":12685,"average":295,"year":2006},{"name":"Female","percentage":48,"total":13313,"average":303,"year":2008},{"name":"Male","percentage":51,"total":13282,"average":309,"year":2006},{"name":"Male","percentage":52,"total":14076,"average":320,"year":2008}],"ethnicity":[{"name":"American Indian\/Alaskan Native","percentage":0,"total":0,"average":0,"year":2004},{"name":"American Indian\/Alaskan Native","percentage":0,"total":69,"average":1,"year":2006},{"name":"American Indian\/Alaskan Native","percentage":0,"total":53,"average":1,"year":2008},{"name":"Asian","percentage":2,"total":133,"average":5,"year":2008},{"name":"Asian\/Pacific Islander","percentage":1,"total":33,"average":1,"year":2004},{"name":"Asian\/Pacific Islander","percentage":2,"total":542,"average":8,"year":2006},{"name":"Asian\/Pacific Islander","percentage":2,"total":628,"average":15,"year":2008},{"name":"Black","percentage":14,"total":288,"average":10,"year":2004},{"name":"Black","percentage":26,"total":10082,"average":146,"year":2006},{"name":"Black","percentage":26,"total":10271,"average":145,"year":2008},{"name":"Hispanic","percentage":1,"total":51,"average":2,"year":2004},{"name":"Hispanic","percentage":8,"total":2762,"average":40,"year":2006},{"name":"Hispanic","percentage":9,"total":3671,"average":52,"year":2008},{"name":"White","percentage":86,"total":4083,"average":146,"year":2004},{"name":"White","percentage":62,"total":16897,"average":241,"year":2006},{"name":"White","percentage":63,"total":17650,"average":249,"year":2008}]}}

data/spec/responses/student_stats.json

@@ -0,0 +1 @@
+{"school":[{"stat_type":"Student Gender","data":[{"stat_name":"Female","year":2008,"percentage":50,"total":645},{"stat_name":"Male","year":2008,"percentage":50,"total":642}]},{"stat_type":"Student Ethnicity","data":[{"stat_name":"White","year":2008,"percentage":49,"total":633},{"stat_name":"Black","year":2008,"percentage":45,"total":573},{"stat_name":"Hispanic","year":2008,"percentage":5,"total":70},{"stat_name":"Asian\/Pacific Islander","year":2008,"percentage":1,"total":10},{"stat_name":"American Indian\/Alaskan Native","year":2008,"percentage":0,"total":1}]},{"stat_type":"Student Economic Level","data":[{"stat_name":"Students Eligible for Free or Reduced-Price Lunch","year":2008,"percentage":18,"total":236}]},{"stat_type":"Student Enrollment","data":[{"stat_name":"Total Enrollment","year":2008,"percentage":0,"total":1289}]}],"city":[{"stat_type":"Student Ethnicity","data":[{"stat_name":"American Indian\/Alaskan Native","year":2004,"percentage":0,"total":0},{"stat_name":"American Indian\/Alaskan Native","year":2006,"percentage":0,"total":69},{"stat_name":"American Indian\/Alaskan Native","year":2008,"percentage":0,"total":53},{"stat_name":"Asian","year":2008,"percentage":2,"total":133},{"stat_name":"Asian\/Pacific Islander","year":2004,"percentage":1,"total":33},{"stat_name":"Asian\/Pacific Islander","year":2006,"percentage":2,"total":541},{"stat_name":"Asian\/Pacific Islander","year":2008,"percentage":2,"total":628},{"stat_name":"Black","year":2004,"percentage":12,"total":279},{"stat_name":"Black","year":2006,"percentage":27,"total":10078},{"stat_name":"Black","year":2008,"percentage":26,"total":10271},{"stat_name":"Hispanic","year":2004,"percentage":2,"total":51},{"stat_name":"Hispanic","year":2006,"percentage":8,"total":2759},{"stat_name":"Hispanic","year":2008,"percentage":9,"total":3671},{"stat_name":"White","year":2004,"percentage":89,"total":4013},{"stat_name":"White","year":2006,"percentage":61,"total":16833},{"stat_name":"White","year":2008,"percentage":63,"total":17650}]},{"stat_type":"Student Gender","data":[{"stat_name":"Female","year":2006,"percentage":48,"total":12685},{"stat_name":"Female","year":2008,"percentage":48,"total":13313},{"stat_name":"Male","year":2006,"percentage":51,"total":13282},{"stat_name":"Male","year":2008,"percentage":52,"total":14076}]},{"stat_type":"Student Completion","data":[{"stat_name":"Students Attending 4 Year Colleges","year":2008,"percentage":81,"total":0}]},{"stat_type":"Student Economic Level","data":[{"stat_name":"Students Eligible for Free or Reduced-Price Lunch","year":2006,"percentage":46,"total":12366},{"stat_name":"Students Eligible for Free or Reduced-Price Lunch","year":2008,"percentage":51,"total":13115}]},{"stat_type":"Student Enrollment","data":[{"stat_name":"Total Enrollment","year":2004,"percentage":0,"total":6950},{"stat_name":"Total Enrollment","year":2006,"percentage":0,"total":32719},{"stat_name":"Total Enrollment","year":2008,"percentage":0,"total":34436}]}]}

data/spec/responses/teacher_stats.json

@@ -0,0 +1 @@
+{"school":[{"stat_type":"Student-Teacher Ratio","stat_name":"Students per Full-Time Teacher","year":2008,"value":null,"total":16}]}

data/spec/responses/test_rating.json

@@ -0,0 +1 @@
+[{"school":{"schoolname":"Chester W. Nimitz Elementary School","testrating_text":"Education.com TestRating 6","testrating_image_large":"http:\/\/www.education.com\/themes\/sky\/i\/schoolfinder\/images\/school-rating6.png","testrating_image_small":"http:\/\/www.education.com\/themes\/sky\/i\/schoolfinder\/images\/small-school-rating6.png","testrating_year":2009,"lsp":"http:\/\/www.education.com\/schoolfinder\/us\/california\/sunnyvale\/chester-w-nimitz-elementary\/"}}]

data/spec/responses/test_scores.json

@@ -0,0 +1 @@
+{"school":[{"grade":"Grade 10","testname":"High School Assessment Program (HSAP) Results","subject":"Language Arts","score":{"percentage":84},"year":2009,"max_score":{"total":100},"description":"The High School Assessment Program (HSAP) are annual tests used to measure a student's mastery of the state's grade-level academic standards."},{"grade":"Grade 10","testname":"High School Assessment Program (HSAP) Results","subject":"Math","score":{"percentage":80},"year":2009,"max_score":{"total":100},"description":"The High School Assessment Program (HSAP) are annual tests used to measure a student's mastery of the state's grade-level academic standards."},{"grade":"Grade 12","testname":"ACT Results","subject":"Composite","score":{"total":22},"year":2009,"max_score":{"total":36},"description":"The ACT is a national college admissions test used to assess student performance in high school curriculum areas. "},{"grade":"Grade 12","testname":"ACT Results","subject":"English","score":{"total":22},"year":2009,"max_score":{"total":36},"description":"The ACT is a national college admissions test used to assess student performance in high school curriculum areas. "},{"grade":"Grade 12","testname":"ACT Results","subject":"Math","score":{"total":21},"year":2009,"max_score":{"total":36},"description":"The ACT is a national college admissions test used to assess student performance in high school curriculum areas. "},{"grade":"Grade 12","testname":"ACT Results","subject":"Reading","score":{"total":22},"year":2009,"max_score":{"total":36},"description":"The ACT is a national college admissions test used to assess student performance in high school curriculum areas. "},{"grade":"Grade 12","testname":"ACT Results","subject":"Science","score":{"total":21},"year":2009,"max_score":{"total":36},"description":"The ACT is a national college admissions test used to assess student performance in high school curriculum areas. "},{"grade":"Grade 12","testname":"SAT Results","subject":"Average Critical Reading Score","score":{"total":492},"year":2009,"max_score":{"total":800},"description":"The SAT Reasoning Test is a voluntary college admissions test used to assess critical thinking skills and student ability to analyze and solve problems."},{"grade":"Grade 12","testname":"SAT Results","subject":"Average Mathematics Score","score":{"total":493},"year":2009,"max_score":{"total":800},"description":"The SAT Reasoning Test is a voluntary college admissions test used to assess critical thinking skills and student ability to analyze and solve problems."},{"grade":"Grade 12","testname":"SAT Results","subject":"Average Writing Score","score":{"total":471},"year":2009,"max_score":{"total":800},"description":"The SAT Reasoning Test is a voluntary college admissions test used to assess critical thinking skills and student ability to analyze and solve problems."},{"grade":"Grade 12","testname":"SAT Results","subject":"Overall Score","score":{"total":1457},"year":2009,"max_score":{"total":800},"description":"The SAT Reasoning Test is a voluntary college admissions test used to assess critical thinking skills and student ability to analyze and solve problems."},{"grade":"Grade 12","testname":"SAT Results","subject":"SAT Mean Score","score":{"total":1482},"year":2008,"max_score":{"total":2400},"description":"The SAT Reasoning Test is a voluntary college admissions test used to assess critical thinking skills and student ability to analyze and solve problems."}],"state":[{"grade":"Grade 3","testname":"Palmetto Assessment of State Standards (PASS) Results","subject":"English Language Arts","score":{"percentage":78},"year":2009,"max_score":{"total":100},"description":"The Palmetto Assessment of State Standards (PASS) are annual tests used to measure a student's mastery of the state's grade-level academic standards."},{"grade":"Grade 3","testname":"Palmetto Assessment of State Standards (PASS) Results","subject":"Mathematics","score":{"percentage":67},"year":2009,"max_score":{"total":100},"description":"The Palmetto Assessment of State Standards (PASS) are annual tests used to measure a student's mastery of the state's grade-level academic standards."},{"grade":"Grade 3","testname":"Palmetto Assessment of State Standards (PASS) Results","subject":"Science","score":{"percentage":61.5},"year":2009,"max_score":{"total":100},"description":"The Palmetto Assessment of State Standards (PASS) are annual tests used to measure a student's mastery of the state's grade-level academic standards."},{"grade":"Grade 3","testname":"Palmetto Assessment of State Standards (PASS) Results","subject":"Social Studies","score":{"percentage":74.4},"year":2009,"max_score":{"total":100},"description":"The Palmetto Assessment of State Standards (PASS) are annual tests used to measure a student's mastery of the state's grade-level academic standards."},{"grade":"Grade 3","testname":"Palmetto Assessment of State Standards (PASS) Results","subject":"Writing","score":{"percentage":68.9},"year":2009,"max_score":{"total":100},"description":"The Palmetto Assessment of State Standards (PASS) are annual tests used to measure a student's mastery of the state's grade-level academic standards."},{"grade":"Grade 4","testname":"Palmetto Assessment of State Standards (PASS) Results","subject":"English Language Arts","score":{"percentage":75.7},"year":2009,"max_score":{"total":100},"description":"The Palmetto Assessment of State Standards (PASS) are annual tests used to measure a student's mastery of the state's grade-level academic standards."},{"grade":"Grade 4","testname":"Palmetto Assessment of State Standards (PASS) Results","subject":"Mathematics","score":{"percentage":76.8},"year":2009,"max_score":{"total":100},"description":"The Palmetto Assessment of State Standards (PASS) are annual tests used to measure a student's mastery of the state's grade-level academic standards."},{"grade":"Grade 4","testname":"Palmetto Assessment of State Standards (PASS) Results","subject":"Science","score":{"percentage":68.7},"year":2009,"max_score":{"total":100},"description":"The Palmetto Assessment of State Standards (PASS) are annual tests used to measure a student's mastery of the state's grade-level academic standards."},{"grade":"Grade 4","testname":"Palmetto Assessment of State Standards (PASS) Results","subject":"Social Studies","score":{"percentage":79.8},"year":2009,"max_score":{"total":100},"description":"The Palmetto Assessment of State Standards (PASS) are annual tests used to measure a student's mastery of the state's grade-level academic standards."},{"grade":"Grade 4","testname":"Palmetto Assessment of State Standards (PASS) Results","subject":"Writing","score":{"percentage":70.1},"year":2009,"max_score":{"total":100},"description":"The Palmetto Assessment of State Standards (PASS) are annual tests used to measure a student's mastery of the state's grade-level academic standards."},{"grade":"Grade 5","testname":"Palmetto Assessment of State Standards (PASS) Results","subject":"English Language Arts","score":{"percentage":80},"year":2009,"max_score":{"total":100},"description":"The Palmetto Assessment of State Standards (PASS) are annual tests used to measure a student's mastery of the state's grade-level academic standards."},{"grade":"Grade 5","testname":"Palmetto Assessment of State Standards (PASS) Results","subject":"Mathematics","score":{"percentage":73.5},"year":2009,"max_score":{"total":100},"description":"The Palmetto Assessment of State Standards (PASS) are annual tests used to measure a student's mastery of the state's grade-level academic standards."},{"grade":"Grade 5","testname":"Palmetto Assessment of State Standards (PASS) Results","subject":"Science","score":{"percentage":68.3},"year":2009,"max_score":{"total":100},"description":"The Palmetto Assessment of State Standards (PASS) are annual tests used to measure a student's mastery of the state's grade-level academic standards."},{"grade":"Grade 5","testname":"Palmetto Assessment of State Standards (PASS) Results","subject":"Social Studies","score":{"percentage":70},"year":2009,"max_score":{"total":100},"description":"The Palmetto Assessment of State Standards (PASS) are annual tests used to measure a student's mastery of the state's grade-level academic standards."},{"grade":"Grade 5","testname":"Palmetto Assessment of State Standards (PASS) Results","subject":"Writing","score":{"percentage":73.2},"year":2009,"max_score":{"total":100},"description":"The Palmetto Assessment of State Standards (PASS) are annual tests used to measure a student's mastery of the state's grade-level academic standards."},{"grade":"Grade 6","testname":"Palmetto Assessment of State Standards (PASS) Results","subject":"English Language Arts","score":{"percentage":71.7},"year":2009,"max_score":{"total":100},"description":"The Palmetto Assessment of State Standards (PASS) are annual tests used to measure a student's mastery of the state's grade-level academic standards."},{"grade":"Grade 6","testname":"Palmetto Assessment of State Standards (PASS) Results","subject":"Mathematics","score":{"percentage":70.3},"year":2009,"max_score":{"total":100},"description":"The Palmetto Assessment of State Standards (PASS) are annual tests used to measure a student's mastery of the state's grade-level academic standards."},{"grade":"Grade 6","testname":"Palmetto Assessment of State Standards (PASS) Results","subject":"Science","score":{"percentage":63.9},"year":2009,"max_score":{"total":100},"description":"The Palmetto Assessment of State Standards (PASS) are annual tests used to measure a student's mastery of the state's grade-level academic standards."},{"grade":"Grade 6","testname":"Palmetto Assessment of State Standards (PASS) Results","subject":"Social Studies","score":{"percentage":79.6},"year":2009,"max_score":{"total":100},"description":"The Palmetto Assessment of State Standards (PASS) are annual tests used to measure a student's mastery of the state's grade-level academic standards."},{"grade":"Grade 6","testname":"Palmetto Assessment of State Standards (PASS) Results","subject":"Writing","score":{"percentage":70.3},"year":2009,"max_score":{"total":100},"description":"The Palmetto Assessment of State Standards (PASS) are annual tests used to measure a student's mastery of the state's grade-level academic standards."},{"grade":"Grade 7","testname":"Palmetto Assessment of State Standards (PASS) Results","subject":"English Language Arts","score":{"percentage":68.7},"year":2009,"max_score":{"total":100},"description":"The Palmetto Assessment of State Standards (PASS) are annual tests used to measure a student's mastery of the state's grade-level academic standards."},{"grade":"Grade 7","testname":"Palmetto Assessment of State Standards (PASS) Results","subject":"Mathematics","score":{"percentage":69.5},"year":2009,"max_score":{"total":100},"description":"The Palmetto Assessment of State Standards (PASS) are annual tests used to measure a student's mastery of the state's grade-level academic standards."},{"grade":"Grade 7","testname":"Palmetto Assessment of State Standards (PASS) Results","subject":"Science","score":{"percentage":71.2},"year":2009,"max_score":{"total":100},"description":"The Palmetto Assessment of State Standards (PASS) are annual tests used to measure a student's mastery of the state's grade-level academic standards."},{"grade":"Grade 7","testname":"Palmetto Assessment of State Standards (PASS) Results","subject":"Social Studies","score":{"percentage":60.3},"year":2009,"max_score":{"total":100},"description":"The Palmetto Assessment of State Standards (PASS) are annual tests used to measure a student's mastery of the state's grade-level academic standards."},{"grade":"Grade 7","testname":"Palmetto Assessment of State Standards (PASS) Results","subject":"Writing","score":{"percentage":70.1},"year":2009,"max_score":{"total":100},"description":"The Palmetto Assessment of State Standards (PASS) are annual tests used to measure a student's mastery of the state's grade-level academic standards."},{"grade":"Grade 8","testname":"Palmetto Assessment of State Standards (PASS) Results","subject":"English Language Arts","score":{"percentage":67.5},"year":2009,"max_score":{"total":100},"description":"The Palmetto Assessment of State Standards (PASS) are annual tests used to measure a student's mastery of the state's grade-level academic standards."},{"grade":"Grade 8","testname":"Palmetto Assessment of State Standards (PASS) Results","subject":"Mathematics","score":{"percentage":62.6},"year":2009,"max_score":{"total":100},"description":"The Palmetto Assessment of State Standards (PASS) are annual tests used to measure a student's mastery of the state's grade-level academic standards."},{"grade":"Grade 8","testname":"Palmetto Assessment of State Standards (PASS) Results","subject":"Science","score":{"percentage":62.3},"year":2009,"max_score":{"total":100},"description":"The Palmetto Assessment of State Standards (PASS) are annual tests used to measure a student's mastery of the state's grade-level academic standards."},{"grade":"Grade 8","testname":"Palmetto Assessment of State Standards (PASS) Results","subject":"Social Studies","score":{"percentage":69.6},"year":2009,"max_score":{"total":100},"description":"The Palmetto Assessment of State Standards (PASS) are annual tests used to measure a student's mastery of the state's grade-level academic standards."},{"grade":"Grade 8","testname":"Palmetto Assessment of State Standards (PASS) Results","subject":"Writing","score":{"percentage":68.1},"year":2009,"max_score":{"total":100},"description":"The Palmetto Assessment of State Standards (PASS) are annual tests used to measure a student's mastery of the state's grade-level academic standards."},{"grade":"Grade 10","testname":"High School Assessment Program (HSAP) Results","subject":"Language Arts","score":{"percentage":84.9},"year":2009,"max_score":{"total":100},"description":"The High School Assessment Program (HSAP) are annual tests used to measure a student's mastery of the state's grade-level academic standards."},{"grade":"Grade 10","testname":"High School Assessment Program (HSAP) Results","subject":"Math","score":{"percentage":80.2},"year":2009,"max_score":{"total":100},"description":"The High School Assessment Program (HSAP) are annual tests used to measure a student's mastery of the state's grade-level academic standards."},{"grade":"Grade 12","testname":"ACT Results","subject":"Composite","score":{"total":19.8},"year":2009,"max_score":{"total":36},"description":"The ACT is a national college admissions test used to assess student performance in high school curriculum areas. "},{"grade":"Grade 12","testname":"ACT Results","subject":"English","score":{"total":19.2},"year":2009,"max_score":{"total":36},"description":"The ACT is a national college admissions test used to assess student performance in high school curriculum areas. "},{"grade":"Grade 12","testname":"ACT Results","subject":"Math","score":{"total":20},"year":2009,"max_score":{"total":36},"description":"The ACT is a national college admissions test used to assess student performance in high school curriculum areas. "},{"grade":"Grade 12","testname":"ACT Results","subject":"Reading","score":{"total":19.9},"year":2009,"max_score":{"total":36},"description":"The ACT is a national college admissions test used to assess student performance in high school curriculum areas. "},{"grade":"Grade 12","testname":"ACT Results","subject":"Science","score":{"total":19.8},"year":2009,"max_score":{"total":36},"description":"The ACT is a national college admissions test used to assess student performance in high school curriculum areas. "},{"grade":"Grade 12","testname":"SAT Results","subject":"Average Critical Reading Score","score":{"total":501},"year":2009,"max_score":{"total":800},"description":"The SAT Reasoning Test is a voluntary college admissions test used to assess critical thinking skills and student ability to analyze and solve problems."},{"grade":"Grade 12","testname":"SAT Results","subject":"Average Mathematics Score","score":{"total":515},"year":2009,"max_score":{"total":800},"description":"The SAT Reasoning Test is a voluntary college admissions test used to assess critical thinking skills and student ability to analyze and solve problems."},{"grade":"Grade 12","testname":"SAT Results","subject":"Average Writing Score","score":{"total":493},"year":2009,"max_score":{"total":800},"description":"The SAT Reasoning Test is a voluntary college admissions test used to assess critical thinking skills and student ability to analyze and solve problems."},{"grade":"Grade 12","testname":"SAT Results","subject":"Overall Score","score":{"total":1509},"year":2009,"max_score":{"total":800},"description":"The SAT Reasoning Test is a voluntary college admissions test used to assess critical thinking skills and student ability to analyze and solve problems."},{"grade":"Grade 3","testname":"Palmetto Achievement Challenge Tests (PACT) Results","subject":"English Language Arts","score":{"percentage":86.7},"year":2008,"max_score":{"total":100},"description":"The Palmetto Achievement Challenge Tests (PACT) are annual tests used to measure a student's mastery of the state's grade-level academic standards."},{"grade":"Grade 3","testname":"Palmetto Achievement Challenge Tests (PACT) Results","subject":"Mathematics","score":{"percentage":77.2},"year":2008,"max_score":{"total":100},"description":"The Palmetto Achievement Challenge Tests (PACT) are annual tests used to measure a student's mastery of the state's grade-level academic standards."},{"grade":"Grade 3","testname":"Palmetto Achievement Challenge Tests (PACT) Results","subject":"Science","score":{"percentage":71.1},"year":2008,"max_score":{"total":100},"description":"The Palmetto Achievement Challenge Tests (PACT) are annual tests used to measure a student's mastery of the state's grade-level academic standards."},{"grade":"Grade 3","testname":"Palmetto Achievement Challenge Tests (PACT) Results","subject":"Social Studies","score":{"percentage":83.9},"year":2008,"max_score":{"total":100},"description":"The Palmetto Achievement Challenge Tests (PACT) are annual tests used to measure a student's mastery of the state's grade-level academic standards."},{"grade":"Grade 4","testname":"Palmetto Achievement Challenge Tests (PACT) Results","subject":"English Language Arts","score":{"percentage":80.8},"year":2008,"max_score":{"total":100},"description":"The Palmetto Achievement Challenge Tests (PACT) are annual tests used to measure a student's mastery of the state's grade-level academic standards."},{"grade":"Grade 4","testname":"Palmetto Achievement Challenge Tests (PACT) Results","subject":"Mathematics","score":{"percentage":79},"year":2008,"max_score":{"total":100},"description":"The Palmetto Achievement Challenge Tests (PACT) are annual tests used to measure a student's mastery of the state's grade-level academic standards."},{"grade":"Grade 4","testname":"Palmetto Achievement Challenge Tests (PACT) Results","subject":"Science","score":{"percentage":68.9},"year":2008,"max_score":{"total":100},"description":"The Palmetto Achievement Challenge Tests (PACT) are annual tests used to measure a student's mastery of the state's grade-level academic standards."},{"grade":"Grade 4","testname":"Palmetto Achievement Challenge Tests (PACT) Results","subject":"Social Studies","score":{"percentage":76.3},"year":2008,"max_score":{"total":100},"description":"The Palmetto Achievement Challenge Tests (PACT) are annual tests used to measure a student's mastery of the state's grade-level academic standards."},{"grade":"Grade 5","testname":"Palmetto Achievement Challenge Tests (PACT) Results","subject":"English Language Arts","score":{"percentage":77.6},"year":2008,"max_score":{"total":100},"description":"The Palmetto Achievement Challenge Tests (PACT) are annual tests used to measure a student's mastery of the state's grade-level academic standards."},{"grade":"Grade 5","testname":"Palmetto Achievement Challenge Tests (PACT) Results","subject":"Mathematics","score":{"percentage":78},"year":2008,"max_score":{"total":100},"description":"The Palmetto Achievement Challenge Tests (PACT) are annual tests used to measure a student's mastery of the state's grade-level academic standards."},{"grade":"Grade 5","testname":"Palmetto Achievement Challenge Tests (PACT) Results","subject":"Science","score":{"percentage":61.4},"year":2008,"max_score":{"total":100},"description":"The Palmetto Achievement Challenge Tests (PACT) are annual tests used to measure a student's mastery of the state's grade-level academic standards."},{"grade":"Grade 5","testname":"Palmetto Achievement Challenge Tests (PACT) Results","subject":"Social Studies","score":{"percentage":66.3},"year":2008,"max_score":{"total":100},"description":"The Palmetto Achievement Challenge Tests (PACT) are annual tests used to measure a student's mastery of the state's grade-level academic standards."},{"grade":"Grade 6","testname":"Palmetto Achievement Challenge Tests (PACT) Results","subject":"English Language Arts","score":{"percentage":74.8},"year":2008,"max_score":{"total":100},"description":"The Palmetto Achievement Challenge Tests (PACT) are annual tests used to measure a student's mastery of the state's grade-level academic standards."},{"grade":"Grade 6","testname":"Palmetto Achievement Challenge Tests (PACT) Results","subject":"Mathematics","score":{"percentage":75.7},"year":2008,"max_score":{"total":100},"description":"The Palmetto Achievement Challenge Tests (PACT) are annual tests used to measure a student's mastery of the state's grade-level academic standards."},{"grade":"Grade 6","testname":"Palmetto Achievement Challenge Tests (PACT) Results","subject":"Science","score":{"percentage":56.5},"year":2008,"max_score":{"total":100},"description":"The Palmetto Achievement Challenge Tests (PACT) are annual tests used to measure a student's mastery of the state's grade-level academic standards."},{"grade":"Grade 6","testname":"Palmetto Achievement Challenge Tests (PACT) Results","subject":"Social Studies","score":{"percentage":77.8},"year":2008,"max_score":{"total":100},"description":"The Palmetto Achievement Challenge Tests (PACT) are annual tests used to measure a student's mastery of the state's grade-level academic standards."},{"grade":"Grade 7","testname":"Palmetto Achievement Challenge Tests (PACT) Results","subject":"English Language Arts","score":{"percentage":73},"year":2008,"max_score":{"total":100},"description":"The Palmetto Achievement Challenge Tests (PACT) are annual tests used to measure a student's mastery of the state's grade-level academic standards."},{"grade":"Grade 7","testname":"Palmetto Achievement Challenge Tests (PACT) Results","subject":"Mathematics","score":{"percentage":77.8},"year":2008,"max_score":{"total":100},"description":"The Palmetto Achievement Challenge Tests (PACT) are annual tests used to measure a student's mastery of the state's grade-level academic standards."},{"grade":"Grade 7","testname":"Palmetto Achievement Challenge Tests (PACT) Results","subject":"Science","score":{"percentage":69.8},"year":2008,"max_score":{"total":100},"description":"The Palmetto Achievement Challenge Tests (PACT) are annual tests used to measure a student's mastery of the state's grade-level academic standards."},{"grade":"Grade 7","testname":"Palmetto Achievement Challenge Tests (PACT) Results","subject":"Social Studies","score":{"percentage":56.4},"year":2008,"max_score":{"total":100},"description":"The Palmetto Achievement Challenge Tests (PACT) are annual tests used to measure a student's mastery of the state's grade-level academic standards."},{"grade":"Grade 8","testname":"Palmetto Achievement Challenge Tests (PACT) Results","subject":"English Language Arts","score":{"percentage":71},"year":2008,"max_score":{"total":100},"description":"The Palmetto Achievement Challenge Tests (PACT) are annual tests used to measure a student's mastery of the state's grade-level academic standards."},{"grade":"Grade 8","testname":"Palmetto Achievement Challenge Tests (PACT) Results","subject":"Mathematics","score":{"percentage":69.7},"year":2008,"max_score":{"total":100},"description":"The Palmetto Achievement Challenge Tests (PACT) are annual tests used to measure a student's mastery of the state's grade-level academic standards."},{"grade":"Grade 8","testname":"Palmetto Achievement Challenge Tests (PACT) Results","subject":"Science","score":{"percentage":63.4},"year":2008,"max_score":{"total":100},"description":"The Palmetto Achievement Challenge Tests (PACT) are annual tests used to measure a student's mastery of the state's grade-level academic standards."},{"grade":"Grade 8","testname":"Palmetto Achievement Challenge Tests (PACT) Results","subject":"Social Studies","score":{"percentage":68.7},"year":2008,"max_score":{"total":100},"description":"The Palmetto Achievement Challenge Tests (PACT) are annual tests used to measure a student's mastery of the state's grade-level academic standards."},{"grade":"Grade 12","testname":"SAT Results","subject":"SAT Mean Score","score":{"total":1511},"year":2008,"max_score":{"total":2400},"description":"The SAT Reasoning Test is a voluntary college admissions test used to assess critical thinking skills and student ability to analyze and solve problems."}]}

data/spec/schoolfinder/client_spec.rb

@@ -0,0 +1,148 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe "Schoolfinder::Client" do
+  before(:each) do
+    @schoolfinder = new_schoolfinder
+  end
+  
+  context "school_search" do
+    before do
+      mock_get({"f" => "schoolSearch", "zip" => "29601"}, 'school_search.json')
+    end
+    
+    it { lambda {@schoolfinder.school_search(:zip => "29601")}.should_not raise_exception }
+    
+    it "should return a response" do
+      @response = @schoolfinder.school_search(:zip => "29601")
+      @response.should_not be_nil
+      @response.body.should be_kind_of(Array)
+    end
+  end
+  
+  context "test_rating" do
+    before do
+      mock_get({"f" => "getTestRating", "nces_id" => "061029001146"}, 'test_rating.json')
+    end
+    
+    it { lambda {@schoolfinder.test_rating(:nces_id => "061029001146")}.should_not raise_exception }
+    
+    it "should return a response" do
+      @response = @schoolfinder.test_rating(:nces_id => "061029001146")
+      @response.should_not be_nil
+      @response.body.should be_kind_of(Array)
+    end
+  end
+  
+  context "student_diversity" do
+    before do
+      mock_get({"f" => "getStudentDiversity", "nces_id" => "450231000564"}, 'student_diversity.json')
+    end
+    
+    it { lambda {@schoolfinder.student_diversity(:nces_id => "450231000564")}.should_not raise_exception }
+    
+    it "should return a response" do
+      @response = @schoolfinder.student_diversity(:nces_id => "450231000564")
+      @response.should_not be_nil
+      @response.body.should be_kind_of(Hashie::Rash)
+    end
+  end
+  
+  context "test_scores" do
+    before do
+      mock_get({"f" => "getTestScores", "nces_id" => "450231000564"}, 'test_scores.json')
+    end
+    
+    it { lambda {@schoolfinder.test_scores(:nces_id => "450231000564")}.should_not raise_exception }
+    
+    it "should return a response" do
+      @response = @schoolfinder.test_scores(:nces_id => "450231000564")
+      @response.should_not be_nil
+      @response.body.should be_kind_of(Hashie::Rash)
+    end
+  end
+  
+  context "teacher_stats" do
+    before do
+      mock_get({"f" => "getTeacherStats", "nces_id" => "450231000564", "districtleaid" => "4502310"}, 'teacher_stats.json')
+    end
+    
+    it { lambda {@schoolfinder.teacher_stats(:nces_id => "450231000564", :districtleaid => "4502310")}.should_not raise_exception }
+    
+    it "should return a response" do
+      @response = @schoolfinder.teacher_stats(:nces_id => "450231000564", :districtleaid => "4502310")
+      @response.should_not be_nil
+      @response.body.should be_kind_of(Hashie::Rash)
+    end
+  end
+  
+  context "student_stats" do
+    before do
+      mock_get({"f" => "getStudentStats", "nces_id" => "450231000564", "districtleaid" => "4502310", "city" => "Greenville", "state" => "SC"}, 'student_stats.json')
+    end
+    
+    it { lambda {@response = @schoolfinder.student_stats(:nces_id => "450231000564", :districtleaid => "4502310", :city => "Greenville", :state => "SC")}.should_not raise_exception }
+    
+    it "should return a response" do
+      @response = @schoolfinder.student_stats(:nces_id => "450231000564", :districtleaid => "4502310", :city => "Greenville", :state => "SC")
+      @response.should_not be_nil
+      @response.body.should be_kind_of(Hashie::Rash)
+    end
+  end
+  
+  context "reviews" do
+    before do
+      mock_get({"f" => "getReviews", "schoolid" => "25381"}, 'reviews.json')
+    end
+    
+    it { lambda {@schoolfinder.reviews(:schoolid => "25381")}.should_not raise_exception }
+    
+    it "should return a response" do
+      @response = @schoolfinder.reviews(:schoolid => "25381")
+      @response.should_not be_nil
+      @response.body.should be_kind_of(Hashie::Rash)
+    end
+  end
+  
+  context "number_of" do
+    before do
+      mock_get({"f" => "numberOf", "city" => "Greenville", "state" => "SC"}, 'number_of.json')
+    end
+    
+    it { lambda {@schoolfinder.number_of("Greenville", "SC")}.should_not raise_exception }
+    
+    it "should return a response" do
+      @response = @schoolfinder.number_of("Greenville", "SC")
+      @response.should_not be_nil
+      @response.body.should be_kind_of(Array)
+    end
+  end
+  
+  context "district_search" do
+    before do
+      mock_get({"f" => "districtSearch", "city" => "Greenville", "state" => "SC"}, 'district_search.json')
+    end
+    
+    it { lambda {@schoolfinder.district_search(:city => "Greenville", :state => "SC")}.should_not raise_exception }
+    
+    it "should return a response" do
+      @response = @schoolfinder.district_search(:city => "Greenville", :state => "SC")
+      @response.should_not be_nil
+      @response.body.should be_kind_of(Array)
+    end
+  end
+  
+  context "branding_data" do
+    before do
+      mock_get({"f" => "gbd", "nces_id" => "450231000564"}, 'branding_data.json')
+    end
+    
+    it { lambda {@schoolfinder.branding_data(:nces_id => "450231000564")}.should_not raise_exception }
+    
+    it "should return a response" do
+      @response = @schoolfinder.branding_data(:nces_id => "450231000564")
+      @response.should_not be_nil
+      @response.body.should be_kind_of(Hashie::Rash)
+    end
+  end
+  
+end

data/spec/schoolfinder/error_spec.rb

@@ -0,0 +1,16 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe "Schoolfinder::Error" do
+  
+  before do
+    mock_get({"f" => "getTestScores", "nces_id" => "450231000564"}, 'failure.json')
+    @schoolfinder = new_schoolfinder
+  end
+  
+  it "should return an error" do
+    lambda {
+      @response = @schoolfinder.test_scores(:nces_id => "450231000564")
+    }.should raise_exception(Schoolfinder::Error, "Schoolfinder Error: invalid api key (code: 3)")
+  end
+  
+end

data/spec/schoolfinder_api_key.example.yml

@@ -0,0 +1 @@
+api_key: put_your_key_kere

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,28 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'schoolfinder'
+require 'spec'
+require 'spec/autorun'
+require 'webmock/rspec'
+
+SCHOOLFINDER_API_KEY = YAML.load_file(File.join(File.dirname(__FILE__), 'schoolfinder_api_key.yml'))["api_key"]
+
+Spec::Runner.configure do |config|
+  config.include WebMock
+end
+
+def new_schoolfinder
+  Schoolfinder::Client.new(SCHOOLFINDER_API_KEY)
+end
+
+def default_params
+  {"v" => "3", "key" => SCHOOLFINDER_API_KEY, "resf" => "json", "sn" => "sf"}
+end
+
+def mock_get(params, response_fixture)
+  stub_http_request(:get, "api.education.com/service/service.php").with(:query => default_params.merge(params)).to_return(:body => mocked_response(response_fixture))
+end
+
+def mocked_response(response_fixture)
+  File.read(File.join(File.dirname(__FILE__), 'responses', response_fixture))
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification 
+name: schoolfinder
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- tcocca
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-08-25 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: httparty
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.6.1
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hashie
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.3.1
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.9
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: webmock
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.3.4
+    version: 
+description: api wrapper for the education.com schoolfinder
+email: tom.cocca@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/rash.rb
+- lib/schoolfinder.rb
+- lib/schoolfinder/client.rb
+- lib/schoolfinder/error.rb
+- lib/schoolfinder/response.rb
+- spec/rash_spec.rb
+- spec/responses/branding_data.json
+- spec/responses/district_search.json
+- spec/responses/failure.json
+- spec/responses/number_of.json
+- spec/responses/reviews.json
+- spec/responses/school_search.json
+- spec/responses/student_diversity.json
+- spec/responses/student_stats.json
+- spec/responses/teacher_stats.json
+- spec/responses/test_rating.json
+- spec/responses/test_scores.json
+- spec/schoolfinder/client_spec.rb
+- spec/schoolfinder/error_spec.rb
+- spec/schoolfinder_api_key.example.yml
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/tcocca/schoolfinder
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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.3.5
+signing_key: 
+specification_version: 3
+summary: api wrapper for the education.com schoolfinder
+test_files: 
+- spec/rash_spec.rb
+- spec/schoolfinder/client_spec.rb
+- spec/schoolfinder/error_spec.rb
+- spec/spec_helper.rb