school_digger 0.9.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: cdc63e25d6a7e09bad5986836812ac8d9b50f0bed660c3ae42211c0b66746115
+  data.tar.gz: '0984596957ef0e4d0f4b4d0400efb778b35be1511a5a664ec4041f220eff172b'
+SHA512:
+  metadata.gz: d737ea7ed92abe6060373b629e3d8a41eb729486921ca116163c41cb3a99c32acbf3230bcd642530d94ac724d79c4a8962781269175093f2ee401ab96c5c4640
+  data.tar.gz: d1ce1fbc0348cf4fa55777ae4f9db04b566b914ec9895149afdb22e741b3ccd3e9c7e64daf3e99735e167daaf8cec01b72d3f91d71bf8e16db46c4ab6a1d5c67

data/.env.sample

@@ -0,0 +1,4 @@
+SCHOOL_DIGGER_BASE_URL: "https://api.schooldigger.com"
+SCHOOL_DIGGER_API_VERSION: "1.1"
+SCHOOL_DIGGER_APP_ID: ""
+SCHOOL_DIGGER_APP_KEY: ""

data/.gitignore

@@ -0,0 +1,21 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+*.sublime-project
+*.sublime-workspace
+
+.DS_Store
+.env
+.ruby-version
+.ruby-gemset

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.3
+before_install: gem install bundler -v 1.16.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at beneggett@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in school_digger.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Ben Eggett
+
+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.md

@@ -0,0 +1,93 @@
+# SchoolDigger
+
+Fully Implements the SchoolDigger API in Ruby
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+```ruby
+gem 'school_digger'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install school_digger
+
+## Usage
+
+There are 7 primary APIs that are wrapped. Below you will see basic examples of how to use them. For more information about what optional query parameters are available, please consult the [SchoolDigger API Docs](https://developer.schooldigger.com/docs#/)
+
+
+#### Autocomplete
+```
+SchoolDigger::Api.new.autocomplete('San Die', st: "CA")
+```
+
+#### Search Districts
+```
+SchoolDigger::Api.new.districts('CA')
+SchoolDigger::Api.new.schools('CA', q: "Los Angeles")
+```
+
+#### Find a District
+```
+SchoolDigger::Api.new.district("0600001")
+```
+
+#### Show District Rankings by State
+```
+SchoolDigger::Api.new.district_rankings('CA')
+```
+
+#### Search Schools
+```
+SchoolDigger::Api.new.schools('CA')
+SchoolDigger::Api.new.schools('CA', q: "East High")
+```
+
+#### Find a School
+```
+SchoolDigger::Api.new.school("490003601072")
+```
+
+#### Show School Rankings by State
+```
+SchoolDigger::Api.new.school_rankings('CA')
+```
+
+## Features
+
+Implemented APIs from [SchoolDigger API Docs](https://developer.schooldigger.com/docs#/)
+
+| API |  Description | Implemented? |
+| --- | --- | --- |
+| Autocomplete | Returns a simple and quick list of schools for use in a client-typed autocomplete | 👍 |
+| Search Districts | Returns a list of districts | 👍 |
+| Find District | Returns a detailed record for one district | 👍 |
+| Search Schools | Returns a list of schools | 👍 |
+| Find School | Returns a detailed record for one school | 👍 |
+| School Rankings | Returns a SchoolDigger School Rankings list | 👍 |
+| District Rankings | Returns a SchoolDigger School Rankings list | 👍 |
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/school_digger. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the SchoolDigger project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/school_digger/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+require "dotenv"
+Dotenv.load
+require "bundler/setup"
+require "school_digger"
+
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+require "pry"
+Pry.start
+
+# require "irb"
+# IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/school_digger.rb

@@ -0,0 +1,12 @@
+
+# require "active_support/all"
+require "httparty"
+require "ostruct"
+
+require "school_digger/api"
+require "school_digger/version"
+
+
+module SchoolDigger
+  # Your code goes here...
+end

data/lib/school_digger/api.rb

@@ -0,0 +1,98 @@
+module SchoolDigger
+  class Api
+    URL_ENDPOINT = ENV.fetch("SCHOOL_DIGGER_BASE_URL", "https://api.schooldigger.com")
+    API_VERSION = ENV.fetch("SCHOOL_DIGGER_API_VERSION", "1.1")
+    URL_BASE = "#{URL_ENDPOINT}/v#{API_VERSION}"
+    include HTTParty
+
+    def get(path, query = {})
+      response = self.class.get(URL_BASE + path, query: modify_query(query), timeout: 30)
+    end
+
+    # # SchoolDigger::Api.new.autocomplete('San Die', st: "CA")
+    def autocomplete(query, options = {} )
+      available_options = %w(q st level boxLatitudeNW boxLongitudeNW boxLatitudeSE boxLongitudeSE returnCount)
+      options = options.select {|k,v| available_options.include?(k.to_s)}
+      options[:q] = query
+      get "/autocomplete/schools", options
+    end
+
+    # # SchoolDigger::Api.new.districts('CA')
+    def districts(state, options = {} )
+      available_options = %w(st q city zip nearLatitude nearLongitude boundaryAddress distanceMiles isInBoundaryOnly boxLatitudeNW boxLongitudeNW boxLatitudeSE boxLongitudeSE page perPage sortBy)
+      options = options.select {|k,v| available_options.include?(k.to_s)}
+      options[:st] = state
+      options[:perPage] ||= 50
+      options[:page] ||= 1
+      get "/districts", options
+    end
+
+    # # SchoolDigger::Api.new.district("0600001")
+    def district(district_id)
+      response = get "/districts/#{district_id}"
+      return "Not Found" if response.code == 404
+      response
+    end
+
+    # # SchoolDigger::Api.new.district_rankings('CA')
+    def district_rankings(state, options = {} )
+      available_options = %w(st year page perPage)
+      options = options.select {|k,v| available_options.include?(k.to_s)}
+      options[:perPage] ||= 50
+      options[:page] ||= 1
+      get "/rankings/districts/#{state}", options
+    end
+
+
+    # # SchoolDigger::Api.new.schools('CA')
+    # # SchoolDigger::Api.new.schools('CA', q: "East High")
+    def schools(state, options = {} )
+      available_options = %w(st q districtID level city zip isMagnet isCharter isVirtual isTitleI isTitleISchoolwide nearLatitude nearLongitude boundaryAddress distanceMiles isInBoundaryOnly boxLatitudeNW boxLongitudeNW boxLatitudeSE boxLongitudeSE page perPage sortBy)
+      options = options.select {|k,v| available_options.include?(k.to_s)}
+      options[:st] = state
+      options[:perPage] ||= 50
+      options[:page] ||= 1
+      get "/schools", options
+    end
+
+    # # SchoolDigger::Api.new.school("490003601072")
+    def school(school_id)
+      response = get "/schools/#{school_id}"
+      return "Not Found" if response.code == 404
+      response
+    end
+
+    # # SchoolDigger::Api.new.school_rankings('CA')
+    def school_rankings(state, options = {} )
+      available_options = %w(st year level page perPage)
+      options = options.select {|k,v| available_options.include?(k.to_s)}
+      options[:perPage] ||= 50
+      options[:page] ||= 1
+      get "/rankings/schools/#{state}", options
+    end
+
+    ## response = SchoolDigger::Api.new.districts('CA')
+    ## response = SchoolDigger::Api.new.next_page(response)
+    def next_page(response)
+      max_pages = response["numberOfPages"]
+      original_query  = response.request.options[:query]
+      current_page = original_query[:page]
+      next_page = current_page.to_i + 1
+      raise "Already at Last Page" if current_page >= max_pages
+
+      query = original_query.merge({page: next_page})
+      SchoolDigger::Api.get( response.request.path, query: query, timeout: 30)
+    end
+
+    private
+
+    def modify_query(query)
+      default_params = {
+        appID: ENV.fetch("SCHOOL_DIGGER_APP_ID", 'not-implemented'),
+        appKey:  ENV.fetch("SCHOOL_DIGGER_APP_KEY", 'not-implemented')
+      }
+      default_params.merge query
+    end
+
+  end
+end

data/lib/school_digger/version.rb

@@ -0,0 +1,3 @@
+module SchoolDigger
+  VERSION = "0.9.0"
+end

data/school_digger.gemspec

@@ -0,0 +1,50 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "school_digger/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "school_digger"
+  spec.version       = SchoolDigger::VERSION
+  spec.authors       = ["Ben Eggett"]
+  spec.email         = ["beneggett@gmail.com"]
+
+  spec.summary       = %q{SchoolDigger API wrapper}
+  spec.description   = %q{Fully implements SchoolDigger API}
+  spec.homepage      = "https://github.com/beneggett/school_digger"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  # spec.add_development_dependency "vcr"
+  # spec.add_development_dependency "webmock"
+  spec.add_development_dependency "pry"
+  # spec.add_development_dependency "guard"
+  # spec.add_development_dependency "guard-minitest"
+  # spec.add_development_dependency "coveralls"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "dotenv"
+  spec.add_dependency "httparty", ">= 0.14.0"
+  # spec.add_dependency "activesupport"
+  spec.add_dependency "builder"
+end

metadata

@@ -0,0 +1,171 @@
+--- !ruby/object:Gem::Specification
+name: school_digger
+version: !ruby/object:Gem::Version
+  version: 0.9.0
+platform: ruby
+authors:
+- Ben Eggett
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-02-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: simplecov
+  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: dotenv
+  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: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+- !ruby/object:Gem::Dependency
+  name: builder
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Fully implements SchoolDigger API
+email:
+- beneggett@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".env.sample"
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/school_digger.rb
+- lib/school_digger/api.rb
+- lib/school_digger/version.rb
+- school_digger.gemspec
+homepage: https://github.com/beneggett/school_digger
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.7.8
+signing_key: 
+specification_version: 4
+summary: SchoolDigger API wrapper
+test_files: []