DataDotGov 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e1e5b43f0aa359795e8a8aede1b4868ad2722163
+  data.tar.gz: a2e34091b85c3c191d91f0e818bbd841201af2b6
+SHA512:
+  metadata.gz: 29d25f5f3e1489b135a7fa26352f56e80862428af47e2071e1e52fd6baed3a45a9a5aaa89c959d29242fb6f45ed227af4dec839dbbcccb0c7b571acf7a8fa3ce
+  data.tar.gz: bc1179b242195a6ef2a647575a0411de59f8ea5ee32b3b82909b534fd97ebdd8a6cbc81d3079b4176018d9fadb66b6eb8cf1943eff2e48ab8bd517c49207a95e

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.byebug_history

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+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. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/DataDotGov.gemspec

@@ -0,0 +1,39 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'DataDotGov/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'DataDotGov'
+  spec.version       = DataDotGov::VERSION
+  spec.authors       = ['Colin Young']
+  spec.email         = ['cyoung@moneythink.org']
+
+  spec.summary       = 'Search and query the Data.gov CKAN APIs in Ruby'
+  spec.description   = 'Search and query the Data.gov CKAN APIs in Ruby'
+  spec.homepage      = 'https://github.com/moneythink/data.gov'
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+  else
+    fail 'RubyGems 2.0 or newer is required to protect against public gem pushes.'
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+  spec.required_ruby_version = '~> 2.0'
+
+  spec.add_dependency 'oj', '~> 2.15'
+
+  spec.add_development_dependency 'bundler', '~> 1.9'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'vcr', '~> 3.0'
+  spec.add_development_dependency 'webmock'
+  spec.add_development_dependency 'codeclimate-test-reporter'
+  spec.add_development_dependency 'byebug'
+end

data/Gemfile

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

data/README.md

@@ -0,0 +1,45 @@
+# DataDotGov
+
+[![Circle CI](https://circleci.com/gh/moneythink/data.gov.svg?style=svg)](https://circleci.com/gh/moneythink/data.gov) [![Code Climate](https://codeclimate.com/repos/5716a309ec824e00920037de/badges/f9f006b036c05bbbc3cd/gpa.svg)](https://codeclimate.com/repos/5716a309ec824e00920037de/feed) [![Test Coverage](https://codeclimate.com/repos/5716a309ec824e00920037de/badges/f9f006b036c05bbbc3cd/coverage.svg)](https://codeclimate.com/repos/5716a309ec824e00920037de/coverage)
+
+This gem can be used to easily search and query the Data.gov CKAN APIs. For example, those located at:
+
+- http://www.ed.gov/developer
+- (Not an exhaustive list)
+
+Any resource that can be found on [data.gov](http://www.data.gov/) should be searchable via its `resource_id`. These generally adhere to a format like `c95fae96-ce4a-459c-a935-ba2a37767ac9`, and can be found on Inventory pages [(example)](https://inventory.data.gov/dataset/032e19b4-5a90-41dc-83ff-6e4cd234f565/resource/38625c3d-5388-4c16-a30f-d105432553a4) and are found in the final portion of the URL path.
+
+## Installation
+
+```ruby
+gem 'DataDotGov', github: 'moneythink/data.gov'
+```
+
+## Usage
+
+```ruby
+# use predefined resources
+resource = DataDotGov::Resources::Ed::PostSecondary::DIRECTORY_LISTING
+client = DataDotGov::Client.new(resource)
+client.search('depaul') #=> [#<DataDotGov::Objects::PostSecondary:0x007ff8c5904cf8 @_id=1104, @institution_name="DePaul University", @state="IL", ... ]
+
+# use whatever resource_id you like (obtain from Data.gov):
+client = DataDotGov::Client.new(resource_id: '6d2a0324-5964-44c3-97be-061c0eb5fcc9')
+results = client.search('Child Care Provider/Assistant')
+results.last.program_title # => 'Child Card Provider/Assistant'
+results.first.award_level # => 'Associate's degree'
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment. Run `bundle exec DataDotGov` to use the code located in this directory, ignoring other installed copies of this gem.
+
+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` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/DataDotGov/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'DataDotGov'
+
+# 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

data/bin/setup

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

data/circle.yml

@@ -0,0 +1,3 @@
+machine:
+  ruby:
+    version: 2.0.0

data/config/defaults.yml

@@ -0,0 +1,2 @@
+---
+endpoint: https://inventory.data.gov/api/3

data/lib/DataDotGov.rb

@@ -0,0 +1,9 @@
+require 'DataDotGov/version'
+relpath = __FILE__.chomp('.rb') + '/objects/*'
+Dir[relpath].each { |f| require f }
+
+require 'DataDotGov/client'
+require 'DataDotGov/resources'
+
+module DataDotGov
+end

data/lib/DataDotGov/client.rb

@@ -0,0 +1,66 @@
+require 'yaml'
+require 'uri'
+require 'open-uri'
+require 'oj'
+
+module DataDotGov
+  class Client
+    DEFAULTS = YAML.load_file(File.dirname(__FILE__) + '/../../config/defaults.yml')
+
+    def initialize(options = {})
+      options = stringify_hash(options)
+
+      if options.key?('link')
+        options['resource_id'] = options['link'].split('/').last
+      end
+
+      options['type'] ||= DataDotGov::Objects::Base
+
+      @options = DEFAULTS.merge(stringify_hash(options))
+    end
+
+    def search(value, _offset = 0, _limit = @options['limit'])
+      preflight!
+
+      params = {
+        q: value,
+        resource_id: resource_id
+      }
+      query = URI.encode_www_form(params)
+      uri = URI.parse(endpoint + '/action/datastore_search' + '?' + query)
+      parse_response uri.read
+    end
+
+    def endpoint
+      @options['endpoint']
+    end
+
+    def resource_id
+      @options['resource_id']
+    end
+
+    private
+
+    def parse_response(response)
+      payload = Oj.load(response)
+      result = payload['result']
+      return unless result
+
+      type = @options['type']
+      result['records'].map { |record| type.new(record) }
+    end
+
+    def preflight!
+      missing_key!('endpoint') unless endpoint
+      missing_key!('resource_id') unless resource_id
+    end
+
+    def missing_key!(key)
+      fail ArgumentError.new("Required key '#{key}' not defined in #{self.class.name}.new().")
+    end
+
+    def stringify_hash(hash)
+      Hash[hash.map { |k, v| [k.to_s, v] }]
+    end
+  end
+end

data/lib/DataDotGov/objects/base.rb

@@ -0,0 +1,28 @@
+module DataDotGov
+  module Objects
+    DEFAULT_ALIASES = {
+      'COUNTYNM' => 'county_name',
+      'STABBR' => 'state',
+      'WEBADDR' => 'web_address',
+      'LONGITUD' => 'longitude',
+      'LATITUDE' => 'latitude',
+      'ZIP' => 'zip_code'
+    }
+
+    class Base
+      def initialize(attributes = {}, aliases = {})
+        aliases = DEFAULT_ALIASES.merge(aliases)
+        attributes.each do |key, value|
+          # https://github.com/ohler55/oj#options
+          key = aliases[key] if aliases[key]
+          instance_variable_set(:"@#{key}", value)
+        end
+      end
+
+      def method_missing(*args)
+        name = args.shift
+        instance_variable_get("@#{name}") || instance_variable_get("@#{name.upcase}")
+      end
+    end
+  end
+end

data/lib/DataDotGov/objects/post_secondary.rb

@@ -0,0 +1,19 @@
+module DataDotGov
+  module Objects
+    class PostSecondary < Base
+      def initialize(attributes = {}, _aliases = {})
+        super(
+          attributes,
+          # Aliases
+          'INSTNM' =>  'institution_name',
+          'CHFTITLE' => 'chairman_title',
+          'CHFNM' => 'chairman_name',
+          'ADMINURL' => 'admin_url',
+          'FAIDURL' => 'financial_aid_url',
+          'GENTELE' => 'telephone',
+          'LANDGRNT' => 'land_grant'
+        )
+      end
+    end
+  end
+end

data/lib/DataDotGov/resources.rb

@@ -0,0 +1,39 @@
+module Inspectable
+  def inspect
+    constants.inspect
+  end
+end
+
+module DataDotGov
+  module Resources
+    # Department of Education: ed.gov/developer
+    module Ed
+      extend Inspectable
+
+      # PostSecondary (Colleges and Universities)
+      module PostSecondary
+        extend Inspectable
+
+        DIRECTORY_LISTING = {
+          link: 'https://inventory.data.gov/dataset/032e19b4-5a90-41dc-83ff-6e4cd234f565/resource/38625c3d-5388-4c16-a30f-d105432553a4',
+          type: DataDotGov::Objects::PostSecondary
+        }
+        CIP_2000 = {
+          link: 'https://inventory.data.gov/dataset/b06ca923-ec64-4000-a9e1-86216bb3907d/resource/6fa1786f-ef01-4471-b033-aea7a7169e6c'
+        }
+        AWARDS_DEGREES_CONFERRED_BY_PROGRAM = {
+          link: 'https://inventory.data.gov/dataset/1e63afca-9587-4b72-aa05-a7f597e9305b/resource/6d2a0324-5964-44c3-97be-061c0eb5fcc9'
+        }
+        AWARDS_DEGREES_CONFERRED_ADV = {
+          link: 'https://inventory.data.gov/dataset/c44c10ef-4dff-4f15-a3bb-2847f5d70a59/resource/ec830504-afb7-499e-bb97-406388bc6078'
+        }
+        EDUCATIONAL_OFFERINGS__ATHLETIC_ASSOCIATIONS = {
+          link: 'https://inventory.data.gov/dataset/fb384d70-fff0-4bed-802c-935875500206/resource/8a656436-59e7-4f4d-bd16-a7fd58cfbb60'
+        }
+        FINAID_AND_NET_PRICE = {
+          link: 'https://inventory.data.gov/dataset/d3c1aa87-e6ba-4963-9d8d-43f2417d3925/resource/2384aff0-e30f-4e92-8ea4-1f1127a91912'
+        }
+      end
+    end
+  end
+end

data/lib/DataDotGov/version.rb

@@ -0,0 +1,3 @@
+module DataDotGov
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,174 @@
+--- !ruby/object:Gem::Specification
+name: DataDotGov
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Colin Young
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-04-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: oj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.15'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.15'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !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: 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: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  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: codeclimate-test-reporter
+  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: byebug
+  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'
+description: Search and query the Data.gov CKAN APIs in Ruby
+email:
+- cyoung@moneythink.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- DataDotGov.gemspec
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- circle.yml
+- config/defaults.yml
+- lib/DataDotGov.rb
+- lib/DataDotGov/client.rb
+- lib/DataDotGov/objects/base.rb
+- lib/DataDotGov/objects/post_secondary.rb
+- lib/DataDotGov/resources.rb
+- lib/DataDotGov/version.rb
+homepage: https://github.com/moneythink/data.gov
+licenses: []
+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: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Search and query the Data.gov CKAN APIs in Ruby
+test_files: []