great_schools 0.1.0

data/spec/great_schools/rank_spec.rb

@@ -0,0 +1,33 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'spec_helper'))
+
+describe GreatSchools::Score do
+  describe '#for_school' do
+    it 'should populate score models from the returned XML, through score' do
+      xml = File.read(File.expand_path(
+        File.join(File.dirname(__FILE__), '..', 'fixtures', 'school_test_scores.xml')
+      ))
+      FakeWeb.register_uri(:get, 'http://api.greatschools.org/school/tests/AZ/1?key=0123456789ABCDEF', body: xml)
+
+      score = GreatSchools::Score.for_school('AZ', 1)
+      rank = score.rank
+
+      rank.name.should eql('AZ GS Rating')
+      rank.scale.should eql('1-10')
+      rank.year.should eql('2008')
+      rank.score.should eql('9.0')
+      rank.description.should eql(<<-TEXT.squish)
+        GreatSchools Ratings for Arizona are based on the 2007-2008 Arizona's
+        Instrument to Measure Standards (AIMS) reading, writing and math results.
+        GreatSchools compared the test results for each grade and subject across
+        all Arizona schools and divided them into 1 through 10 ratings (10 is
+        the best). Please note, private schools are not required to release test
+        results, so ratings are available only for public schools. GreatSchools
+        Ratings cannot be compared across states, because of differences in the
+        states' standardized testing programs. Keep in mind that when comparing
+        schools using GreatSchools Ratings it's important to factor in other
+        information, including the quality of each school's teachers, the school
+        culture, special programs, etc.
+      TEXT
+    end
+  end
+end

data/spec/great_schools/result_spec.rb

@@ -0,0 +1,26 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'spec_helper'))
+
+describe GreatSchools::Score do
+  describe '#for_school' do
+    it 'should populate score models from the returned XML, through test (through score)' do
+      xml = File.read(File.expand_path(
+        File.join(File.dirname(__FILE__), '..', 'fixtures', 'school_test_scores.xml')
+      ))
+      FakeWeb.register_uri(:get, 'http://api.greatschools.org/school/tests/AZ/1?key=0123456789ABCDEF', body: xml)
+
+      score = GreatSchools::Score.for_school('AZ', 1)
+      results = score.tests.first.results
+
+      results.size.should eql(2)
+      results[0].subject_name.should eql('Writing')
+      results[1].subject_name.should eql('Reading')
+
+      result = results.first
+      result.grade_name.should eql('10')
+      result.score.should eql('81.0')
+      result.subject_name.should eql('Writing')
+      result.test_id.should eql('AZ00137')
+      result.year.should eql('2008')
+    end
+  end
+end

data/spec/great_schools/review_spec.rb

@@ -0,0 +1,72 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'spec_helper'))
+
+describe GreatSchools::Review do
+  describe '#for_city' do
+    it 'should populate review models from the returned XML' do
+      xml = File.read(File.expand_path(
+        File.join(File.dirname(__FILE__), '..', 'fixtures', 'school_reviews.xml')
+      ))
+      FakeWeb.register_uri(:get, 'http://api.greatschools.org/reviews/city/CA/Alameda?limit=2&key=0123456789ABCDEF', body: xml)
+
+      reviews = GreatSchools::Review.for_city('CA', 'Alameda', limit: 2)
+
+      reviews.size.should eql(2)
+      reviews[0].submitter.should eql('former student')
+      reviews[1].submitter.should eql('parent')
+
+      review = reviews.first
+      review.school_name.should eql('Alameda High School')
+      review.school_address.should eql('2201 Encinal Ave., Alameda, CA  94501')
+      review.review_link.should eql('http://www.greatschools.org/school/parentReviews.page?state=CA&id=1&s_cid=gsapi&lr=true#ps398220')
+      review.rating.should eql('3')
+      review.submitter.should eql('former student')
+      review.posted_date.should eql('2006/06/06')
+      review.comments.should eql('The staff gets on the level of the students and everything is kaotic.')
+    end
+  end
+
+  describe '#for_school' do
+    it 'should populate review models from the returned XML' do
+      xml = File.read(File.expand_path(
+        File.join(File.dirname(__FILE__), '..', 'fixtures', 'school_reviews.xml')
+      ))
+      FakeWeb.register_uri(:get, 'http://api.greatschools.org/reviews/school/CA/1?limit=2&key=0123456789ABCDEF', body: xml)
+
+      reviews = GreatSchools::Review.for_school('CA', 1, limit: 2)
+
+      reviews.size.should eql(2)
+      reviews[0].submitter.should eql('former student')
+      reviews[1].submitter.should eql('parent')
+
+      review = reviews.first
+      review.school_name.should eql('Alameda High School')
+      review.school_address.should eql('2201 Encinal Ave., Alameda, CA  94501')
+      review.review_link.should eql('http://www.greatschools.org/school/parentReviews.page?state=CA&id=1&s_cid=gsapi&lr=true#ps398220')
+      review.rating.should eql('3')
+      review.submitter.should eql('former student')
+      review.posted_date.should eql('2006/06/06')
+      review.comments.should eql('The staff gets on the level of the students and everything is kaotic.')
+    end
+  end
+
+  it 'should populate review models from the returned XML, through a school profile' do
+    xml = File.read(File.expand_path(
+      File.join(File.dirname(__FILE__), '..', 'fixtures', 'school_profile.xml')
+    ))
+    FakeWeb.register_uri(:get, 'http://api.greatschools.org/schools/CA/1?key=0123456789ABCDEF', body: xml)
+
+    school = GreatSchools::School.profile('CA', 1)
+    reviews = school.parent_reviews
+
+    reviews.size.should eql(5)
+
+    review = reviews.first
+    review.school_name.should eql('Alameda High School')
+    review.school_address.should eql('2201 Encinal Ave., Alameda, CA  94501')
+    review.review_link.should eql('http://www.greatschools.org/school/parentReviews.page?state=CA&id=1&s_cid=gsapi&lr=true#ps398220')
+    review.rating.should eql('3')
+    review.submitter.should eql('former student')
+    review.posted_date.should eql('2006/06/06')
+    review.comments.should eql('The staff gets on the level of the students and everything is kaotic.')
+  end
+end

data/spec/great_schools/school_spec.rb

@@ -0,0 +1,167 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'spec_helper'))
+
+describe GreatSchools::School do
+  describe '#browse' do
+    it 'should populate school models from the returned XML' do
+      xml = File.read(File.expand_path(
+        File.join(File.dirname(__FILE__), '..', 'fixtures', 'browse_schools.xml')
+      ))
+      FakeWeb.register_uri(:get, 'http://api.greatschools.org/schools/CA/Truckee?limit=2&key=0123456789ABCDEF', body: xml)
+
+      schools = GreatSchools::School.browse('CA', 'Truckee', limit: 2)
+
+      schools.size.should eql(2)
+      schools[0].name.should eql('Alder Creek Middle School')
+      schools[1].name.should eql('Cold Stream Alternative School')
+
+      school = schools.first
+      school.id.should eql('13978')
+      school.name.should eql('Alder Creek Middle School')
+      school.type.should eql('public')
+      school.grade_range.should eql('6-8')
+      school.enrollment.should eql('598')
+      school.city.should eql('Truckee')
+      school.state.should eql('CA')
+      school.district_id.should eql('509')
+      school.district.should eql('Tahoe-Truckee Joint Unified School District')
+      school.district_nces_id.should eql('0638770')
+      school.address.should eql('10931 Alder Dr., Truckee, CA  96161')
+      school.phone.should eql('(530) 582-2750')
+      school.fax.should eql('(530) 582-7640')
+      school.website.should eql('http://www.ttusd.org')
+      school.nces_id.should eql('063877011005')
+      school.latitude.should eql('39.3454')
+      school.longitude.should eql('-120.1735')
+      school.overview_link.should eql('http://www.greatschools.org/modperl/browse_school/ca/13978?s_cid=gsapi')
+      school.ratings_link.should eql('http://www.greatschools.org/school/rating.page?state=CA&id=13978&s_cid=gsapi')
+      school.reviews_link.should eql('http://www.greatschools.org/school/parentReviews.page?state=CA&id=13978&s_cid=gsapi')
+    end
+  end
+
+  describe '#nearby' do
+    it 'should populate school models from the returned XML' do
+      xml = File.read(File.expand_path(
+        File.join(File.dirname(__FILE__), '..', 'fixtures', 'nearby_schools.xml')
+      ))
+      FakeWeb.register_uri(:get, 'http://api.greatschools.org/schools/nearby?state=CA&zip=94105&limit=2&key=0123456789ABCDEF', body: xml)
+
+      schools = GreatSchools::School.nearby('CA', zip_code: 94105, limit: 2)
+
+      schools.size.should eql(2)
+      schools[0].name.should eql('Youth Chance High School')
+      schools[1].name.should eql('Notre Dame des Victoires School')
+
+      school = schools.first
+      school.id.should eql('11536')
+      school.name.should eql('Youth Chance High School')
+      school.type.should eql('private')
+      school.grade_range.should eql('10-12')
+      school.enrollment.should eql('25')
+      school.city.should eql('San Francisco')
+      school.state.should eql('CA')
+      school.address.should eql('169 Steuart Street, San Francisco, CA  94105')
+      school.phone.should eql('(415) 615-1337')
+      school.nces_id.should eql('A9900759')
+      school.latitude.should eql('37.7924')
+      school.longitude.should eql('-122.3921')
+      school.overview_link.should eql('http://www.greatschools.org/cgi-bin/ca/private/11536?s_cid=gsapi')
+      school.ratings_link.should eql('http://www.greatschools.org/school/rating.page?state=CA&id=11536&s_cid=gsapi')
+      school.reviews_link.should eql('http://www.greatschools.org/school/parentReviews.page?state=CA&id=11536&s_cid=gsapi')
+    end
+  end
+
+  describe '#profile' do
+    it 'should populate school models from the returned XML' do
+      xml = File.read(File.expand_path(
+        File.join(File.dirname(__FILE__), '..', 'fixtures', 'school_profile.xml')
+      ))
+      FakeWeb.register_uri(:get, 'http://api.greatschools.org/schools/CA/1?key=0123456789ABCDEF', body: xml)
+
+      school = GreatSchools::School.profile('CA', 1)
+
+      school.id.should eql('1')
+      school.name.should eql('Alameda High School')
+      school.type.should eql('public')
+      school.grade_range.should eql('9-12')
+      school.enrollment.should eql('1938')
+      school.city.should eql('Alameda')
+      school.state.should eql('CA')
+      school.district_id.should eql('1')
+      school.district.should eql('Alameda City Unified School District')
+      school.district_nces_id.should eql('0601770')
+      school.address.should eql('2201 Encinal Ave., Alameda, CA  94501')
+      school.phone.should eql('(510) 337-7022')
+      school.fax.should eql('(510) 521-4740')
+      school.website.should eql('http://ahs.alameda.k12.ca.us/')
+      school.nces_id.should eql('060177000041')
+      school.latitude.should eql('37.764267')
+      school.longitude.should eql('-122.24818')
+      school.overview_link.should eql('http://www.greatschools.org/modperl/browse_school/ca/1?s_cid=gsapi')
+      school.ratings_link.should eql('http://www.greatschools.org/school/rating.page?state=CA&id=1&s_cid=gsapi')
+      school.reviews_link.should eql('http://www.greatschools.org/school/parentReviews.page?state=CA&id=1&s_cid=gsapi')
+
+      school.parent_reviews.each do |review|
+        review.should be_a(GreatSchools::Review)
+      end
+    end
+  end
+
+  describe '#search' do
+    it 'should populate school models from the returned XML' do
+      xml = File.read(File.expand_path(
+        File.join(File.dirname(__FILE__), '..', 'fixtures', 'school_search.xml')
+      ))
+      FakeWeb.register_uri(:get, 'http://api.greatschools.org/search/schools?limit=2&q=Alameda%20Christian&state=CA&key=0123456789ABCDEF', body: xml)
+
+      schools = GreatSchools::School.search('CA', 'Alameda Christian', limit: 2)
+
+      schools.size.should eql(2)
+      schools[0].name.should eql('Alameda Christian School')
+      schools[1].name.should eql('Chinese Christian Schools-Alameda')
+
+      school = schools.first
+      school.id.should eql('8485')
+      school.name.should eql('Alameda Christian School')
+      school.type.should eql('private')
+      school.grade_range.should eql('K-8')
+      school.enrollment.should eql('52')
+      school.parent_rating.should eql('5')
+      school.city.should eql('Alameda')
+      school.state.should eql('CA')
+      school.address.should eql('2226 Pacific Ave, Alameda, CA 94501')
+      school.phone.should eql('(510) 523-1000')
+      school.nces_id.should eql('00079445')
+      school.latitude.should eql('37.768623')
+      school.longitude.should eql('-122.243965')
+      school.overview_link.should eql('http://www.greatschools.org/cgi-bin/ca/private/8485?s_cid=gsapi')
+      school.ratings_link.should eql('http://www.greatschools.org/school/rating.page?state=CA&id=8485&s_cid=gsapi')
+      school.reviews_link.should eql('http://www.greatschools.org/school/parentReviews.page?state=CA&id=8485&s_cid=gsapi')
+    end
+  end
+
+  let(:school) { GreatSchools::School.new(state: 'CA', gs_id: 1) }
+
+  describe '.census' do
+    it 'should make a GreatSchools::Census#for_school call using state/gs_id attributes' do
+      GreatSchools::Census.should_receive(:for_school).with('CA', 1)
+
+      school.census
+    end
+  end
+
+  describe '.reviews' do
+    it 'should make a GreatSchools::Review#for_school call using state/gs_id attributes' do
+      GreatSchools::Review.should_receive(:for_school).with('CA', 1, {})
+
+      school.reviews
+    end
+  end
+
+  describe '.score' do
+    it 'should make a GreatSchools::Score#for_school call using state/gs_id attributes' do
+      GreatSchools::Score.should_receive(:for_school).with('CA', 1)
+
+      school.score
+    end
+  end
+end

data/spec/great_schools/score_spec.rb

@@ -0,0 +1,20 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'spec_helper'))
+
+describe GreatSchools::Score do
+  describe '#for_school' do
+    it 'should populate score models from the returned XML' do
+      xml = File.read(File.expand_path(
+        File.join(File.dirname(__FILE__), '..', 'fixtures', 'school_test_scores.xml')
+      ))
+      FakeWeb.register_uri(:get, 'http://api.greatschools.org/school/tests/AZ/1?key=0123456789ABCDEF', body: xml)
+
+      score = GreatSchools::Score.for_school('AZ', 1)
+
+      score.school_name.should eql('Flagstaff High School')
+      score.rank.should be_a(GreatSchools::Rank)
+      score.tests.each do |test|
+        test.should be_a(GreatSchools::Test)
+      end
+    end
+  end
+end

data/spec/great_schools/test_spec.rb

@@ -0,0 +1,35 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'spec_helper'))
+
+describe GreatSchools::Test do
+  it 'should populate score models from the returned XML, through score' do
+    xml = File.read(File.expand_path(
+      File.join(File.dirname(__FILE__), '..', 'fixtures', 'school_test_scores.xml')
+    ))
+    FakeWeb.register_uri(:get, 'http://api.greatschools.org/school/tests/AZ/1?key=0123456789ABCDEF', body: xml)
+
+    score = GreatSchools::Score.for_school('AZ', 1)
+    tests = score.tests
+
+    tests.size.should eql(1)
+
+    test = tests.first
+    test.name.should eql('Arizona\'s Instrument to Measure Standards')
+    test.id.should eql('AZ00137')
+    test.abbreviation.should eql('AIMS')
+    test.scale.should eql('% meeting or exceeding standards')
+    test.level_code.should eql('e,m,h')
+    test.description.should eql(<<-TEXT.squish)
+      In 2007-2008 Arizona's Instrument to Measure Standards (AIMS) was used to
+      test students in reading, writing and mathematics in grades 3 through 8
+      and 10, and in science in grades 4, 8 and high school. AIMS is a
+      standards-based test, which means that it measures how well students have
+      mastered Arizona's learning standards. Students must pass the grade 10
+      AIMS in order to graduate. The goal is for all students to meet or exceed
+      state standards on the test.
+    TEXT
+
+    test.results.each do |result|
+      result.should be_a(GreatSchools::Result)
+    end
+  end
+end

data/spec/great_schools_spec.rb

@@ -0,0 +1,14 @@
+require File.expand_path(File.join(File.dirname(__FILE__), 'spec_helper'))
+
+describe GreatSchools::API do
+  it 'should raise an error when our key is rejected' do
+    xml = File.read(File.expand_path(
+      File.join(File.dirname(__FILE__), 'fixtures', 'error.xml')
+    ))
+    FakeWeb.register_uri(:get, 'http://api.greatschools.org/reviews/city/CA/Foster-City?key=0123456789ABCDEF', body: xml, status: [401, 'Unauthorized'])
+
+    expect {
+      GreatSchools::API.get('reviews/city/CA/Foster-City')
+    }.to raise_error(GreatSchools::Error)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require 'active_support/core_ext/string/filters'
+require 'fakeweb'
+
+require 'great_schools'
+
+RSpec.configure do |config|
+  config.before(:suite) do
+    FakeWeb.allow_net_connect = false
+    GreatSchools::API.key = '0123456789ABCDEF'
+  end
+
+  config.after(:suite) do
+    FakeWeb.allow_net_connect = true
+  end
+end

metadata

@@ -0,0 +1,195 @@
+--- !ruby/object:Gem::Specification
+name: great_schools
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Michael J. Sepcot
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: fakeweb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.12.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.12.0
+description: The GreatSchools API allows access to School Profiles, Test Scores, School
+  Reviews, GreatSchools Ratings, School Districts, and City Profiles.
+email:
+- developer@sepcot.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- great_schools.gemspec
+- lib/great_schools.rb
+- lib/great_schools/census.rb
+- lib/great_schools/city.rb
+- lib/great_schools/district.rb
+- lib/great_schools/error.rb
+- lib/great_schools/ethnicity.rb
+- lib/great_schools/model.rb
+- lib/great_schools/rank.rb
+- lib/great_schools/result.rb
+- lib/great_schools/review.rb
+- lib/great_schools/school.rb
+- lib/great_schools/score.rb
+- lib/great_schools/test.rb
+- lib/great_schools/version.rb
+- spec/fixtures/browse_districts.xml
+- spec/fixtures/browse_schools.xml
+- spec/fixtures/city_overview.xml
+- spec/fixtures/error.xml
+- spec/fixtures/nearby_cities.xml
+- spec/fixtures/nearby_schools.xml
+- spec/fixtures/school_census_data.xml
+- spec/fixtures/school_profile.xml
+- spec/fixtures/school_reviews.xml
+- spec/fixtures/school_search.xml
+- spec/fixtures/school_test_scores.xml
+- spec/great_schools/census_spec.rb
+- spec/great_schools/city_spec.rb
+- spec/great_schools/district_spec.rb
+- spec/great_schools/ethnicity_spec.rb
+- spec/great_schools/rank_spec.rb
+- spec/great_schools/result_spec.rb
+- spec/great_schools/review_spec.rb
+- spec/great_schools/school_spec.rb
+- spec/great_schools/score_spec.rb
+- spec/great_schools/test_spec.rb
+- spec/great_schools_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/msepcot/great_schools
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: A Ruby interface to the GreatSchools API.
+test_files:
+- spec/fixtures/browse_districts.xml
+- spec/fixtures/browse_schools.xml
+- spec/fixtures/city_overview.xml
+- spec/fixtures/error.xml
+- spec/fixtures/nearby_cities.xml
+- spec/fixtures/nearby_schools.xml
+- spec/fixtures/school_census_data.xml
+- spec/fixtures/school_profile.xml
+- spec/fixtures/school_reviews.xml
+- spec/fixtures/school_search.xml
+- spec/fixtures/school_test_scores.xml
+- spec/great_schools/census_spec.rb
+- spec/great_schools/city_spec.rb
+- spec/great_schools/district_spec.rb
+- spec/great_schools/ethnicity_spec.rb
+- spec/great_schools/rank_spec.rb
+- spec/great_schools/result_spec.rb
+- spec/great_schools/review_spec.rb
+- spec/great_schools/school_spec.rb
+- spec/great_schools/score_spec.rb
+- spec/great_schools/test_spec.rb
+- spec/great_schools_spec.rb
+- spec/spec_helper.rb