collegiate_directories 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 69e65c52fd53b190297060d4351612f2d046e010
+  data.tar.gz: 5226a6ddec70cb2b370408d5ba664cc3281ef26f
+SHA512:
+  metadata.gz: 3599f2ed51a5f4fadbf8b8aff27796db06e4607484228a1ba44faa6a5dab35f61e0d8f99ed665fac1af25c2abb9ee197b7fec92aee55ce5f99152a9f407a5803
+  data.tar.gz: 811d46fbf2259e63b63390211c1d3d4e5a6498d7b57548998e5113aab713217dd4f3c0adc398a39074a8673dd33b5136ccebf117afab535b49712b9a21c9002b

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/spec/examples.txt
+/.env
+/*.gem

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,13 @@
+require: rubocop-rspec
+
+AllCops:
+  DisplayCopNames: true
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/NumericLiterals:
+  MinDigits: 6
+
+Style/TrivialAccessors:
+  AllowPredicates: true

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,19 @@
+Copyright (c) 2016 Locker Room Talk
+
+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,43 @@
+# CollegiateDirectories
+
+Interact with the https://www.collegiatedirectories.com API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'collegiate_directories'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install collegiate_directories
+
+## Usage
+
+```ruby
+require "collegiate_directories"
+
+directory = CollegiateDirectories.new("my-api-token")
+directory.sports
+#=> {"Sports"=>[{"Name"=>"Archery", "IsTraditional"=>false, "Id"=>1}, ... }
+directory.coaches_for(:archery)
+#=> {"Coaches"=>[{"School"=>{"Name"=>"Univ. of the Cumberlands", "AlphaName"=>"CUMBERLANDS, UNIVERSITY OF THE", ... }
+directory.coaches_for(:rollerball)
+#=> CollegiateDirectories::SportNotFound: rollerball is an invalid sport
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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/lockerroomtalk/collegiate_directories.

data/Rakefile

@@ -0,0 +1,13 @@
+require "bundler/gem_tasks"
+
+begin
+  require "rspec/core/rake_task"
+  require "rubocop/rake_task"
+rescue LoadError
+  abort "Run `bundle install` before using Rake!"
+end
+
+RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new
+
+task default: %i(spec rubocop)

data/bin/console

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

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "collegiate_directories/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "collegiate_directories"
+  spec.version       = CollegiateDirectories::VERSION
+  spec.authors       = ["Paul Stengel"]
+  spec.email         = ["paul.stengel@lockerroomtalk.com"]
+  spec.license       = "MIT"
+
+  # rubocop:disable Metrics/LineLength
+  spec.summary       = "Gem for interacting with the https://www.collegiatedirectories.com API"
+  spec.homepage      = "https://github.com/lockerroomtalk/collegiate_directories"
+  # rubocop:enable Metrics/LineLength
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.files.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.add_runtime_dependency "httparty", "~> 0.14"
+
+  spec.add_development_dependency "bundler",       "~> 1.12"
+  spec.add_development_dependency "dotenv",        "~> 2.1"
+  spec.add_development_dependency "rake",          "~> 10.0"
+  spec.add_development_dependency "rspec",         "~> 3.5"
+  spec.add_development_dependency "rubocop",       "~> 0.43"
+  spec.add_development_dependency "rubocop-rspec", "~> 1.4"
+end

data/lib/collegiate_directories.rb

@@ -0,0 +1,78 @@
+require "collegiate_directories/version"
+
+require "json"
+require "httparty"
+
+# Public: Interact with the Collegiate Directories API.
+class CollegiateDirectories
+  include HTTParty
+
+  class ApiError < StandardError; end
+  class SportNotFound < StandardError; end
+
+  base_uri "https://www.collegiatedirectories.com/data/api"
+  format   :json
+  headers  "Content-Type" => "application/json"
+
+  # Public: Check a response for validity.
+  #
+  # response - Object representing the response.
+  #
+  # Raises ApiError on error.
+  CHECK_RESPONSE = lambda do |response|
+    begin
+      response.fetch("ResultCode").nonzero? &&
+        raise(ApiError, response["Message"])
+    rescue KeyError, NoMethodError
+      raise ApiError, "Incomplete response"
+    end
+  end
+
+  # Public: Initialize the API client.
+  #
+  # token - A String containing the API token (default:
+  #         COLLEGIATE_DIRECTORIES_TOKEN environment variable).
+  def initialize(token: ENV["COLLEGIATE_DIRECTORIES_TOKEN"])
+    @default_opts = { body: token.to_json }
+  end
+
+  # Public: Return the coaches for a specific sport.
+  #
+  # sport - The Integer ID of the sport or the String name of the sport.
+  #
+  # Returns Hash.
+  # Raises CollegiateDirectories::ApiError on error.
+  def coaches_for(sport)
+    sport = sport_to_api(sport)
+
+    response = self.class.post("/Coaches?sportId=#{sport}", @default_opts)
+    response.parsed_response.tap(&CHECK_RESPONSE)
+  end
+
+  # Public: Return the sports the directory supports.
+  #
+  # Returns Hash.
+  # Raises CollegiateDirectories::ApiError on error.
+  def sports
+    response = self.class.post("/Sports", @default_opts)
+    response.parsed_response.tap(&CHECK_RESPONSE)
+  end
+
+  private
+
+  # Private: Convert a String representation of a sport to the correct Integer
+  # ID.
+  #
+  # sport - The Integer ID of the sport or the String name of the sport.
+  #
+  # Returns Integer.
+  # Raises CollegiateDirectories::SportNotFound on error.
+  def sport_to_api(sport)
+    return sport if sport.is_a?(Integer)
+
+    found = sports["Sports"].find { |o| o["Name"].casecmp(sport.to_s).zero? }
+    raise SportNotFound, "#{sport} is an invalid sport" if found.nil?
+
+    found["Id"]
+  end
+end

data/lib/collegiate_directories/version.rb

@@ -0,0 +1,3 @@
+class CollegiateDirectories
+  VERSION = "0.1.0".freeze
+end

metadata

@@ -0,0 +1,155 @@
+--- !ruby/object:Gem::Specification
+name: collegiate_directories
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Paul Stengel
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-10-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !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: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.43'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.43'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+description: 
+email:
+- paul.stengel@lockerroomtalk.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- collegiate_directories.gemspec
+- lib/collegiate_directories.rb
+- lib/collegiate_directories/version.rb
+homepage: https://github.com/lockerroomtalk/collegiate_directories
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Gem for interacting with the https://www.collegiatedirectories.com API
+test_files: []
+has_rdoc: