umd 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 86745c0e6eaed649177f9ccd604052018bf94c9f
+  data.tar.gz: 75ddf91acfd01f8b7724109301c76198054ad015
+SHA512:
+  metadata.gz: 68886b7081fa38091fc3cbceab13da59028231fc5981ca8cb975263950a883309e05417f912ebb9dee397e01df5e7f404ac2743b7d4b77a60874cf04014d5477
+  data.tar.gz: 18bd39353ba040e5991bbcb4dc2022bd5d615833dff4abc248e86aeca8c90705f1a7d371d2d9fa2e11cd3eb467cc9fff46cd4e44f78025b2a23ed545525775f3

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.13.7

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 the best of our ability to make
+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, political belief, and sexual identity or 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 jp@jpteti.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,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in umd.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,25 @@
+The ABRMS License (ABRMS)
+
+Copyright (c) 2017 J-P Teti
+
+This software is licensed under the "Anyone But Richard M Stallman"
+(ABRMS) license, described below. No other licenses may apply.
+
+--------------------------------------------
+The "Anyone But Richard M Stallman" license
+--------------------------------------------
+
+Do anything you want with this program, with the exceptions listed
+below under "EXCEPTIONS".
+
+THIS SOFTWARE IS PROVIDED "AS IS" WITH NO WARRANTY OF ANY KIND.
+
+In the unlikely event that you happen to make a zillion bucks off of
+this, then good for you; consider buying a homeless person a meal.
+
+
+EXCEPTIONS
+----------
+
+Richard M Stallman (the guy behind GNU, etc.) may not make use of or
+redistribute this program or any of its derivatives.

data/README.md

@@ -0,0 +1,53 @@
+# UMD
+
+This is a wrapper for the [umd.io](http://umd.io) API for data about the University of Maryland, College Park. Currently it's basically just some
+niceties through [HTTParty](https://github.com/jnunemaker/httparty). Relying on this right now is a *bad* idea, as it's under development and there
+almost certainly will be API-breaking changes.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'umd'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install umd
+
+## Usage
+
+TODO: Write this up.
+
+## Security details
+
+UMD is cryptographically signed. To be sure the gem you install hasn’t been tampered with:
+
+Add my public key (if you haven’t already) as a trusted certificate
+
+`gem cert --add <(curl -Ls https://raw.github.com/jpteti/umd/master/certs/jpteti.pem)`
+
+`gem install umd -P MediumSecurity`
+
+The MediumSecurity trust profile will verify signed gems, but allow the installation of unsigned dependencies.
+This is necessary because not all of UMD's dependencies are signed, so we cannot use HighSecurity.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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/jpteti/umd. 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 [ABRMS License](http://www.dadhacker.com/blog/?p=2106#comments). In short, you can do whatever you'd like with this software, as long as you're not Richard M. Stallman.

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 "umd"
+
+# 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/certs/jpteti.pem

@@ -0,0 +1,20 @@
+-----BEGIN CERTIFICATE-----
+MIIDXDCCAkSgAwIBAgIBATANBgkqhkiG9w0BAQUFADA6MQswCQYDVQQDDAJqcDEW
+MBQGCgmSJomT8ixkARkWBmpwdGV0aTETMBEGCgmSJomT8ixkARkWA2NvbTAeFw0x
+NzAzMjUxNTUzNTFaFw0xODAzMjUxNTUzNTFaMDoxCzAJBgNVBAMMAmpwMRYwFAYK
+CZImiZPyLGQBGRYGanB0ZXRpMRMwEQYKCZImiZPyLGQBGRYDY29tMIIBIjANBgkq
+hkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAv7x0rNoQqBZq9/LEwEKN/8277Criv7C5
+P6+z1MCmeLNlYIKgKjhexVbm+Ghkhocd285blqXSZwANDHNY5+WJ7v+pITcMdTWk
+IRWXMAdruOde3yVumMxpcUJcTPbSK41UFINMeN3pmM/DluhI6R8y++1ODkH23lzX
+8Y8YbCKR7OW1TsxtMTzR3mOy0VPZTpx1dFB4HDVVx2YKhpWt5lp0h911bvvMwjgM
+8BdllcdA9ZVX7c2aPVkXKBvrJcGvcPrzb5nPSGkoSJ36aJBpdGFdi0eDIstZLQFI
+ooc76icn35wybWkuUxqcF04cnWHW3UVUbDM1z1E26dvxKja/HjlJeQIDAQABo20w
+azAJBgNVHRMEAjAAMAsGA1UdDwQEAwIEsDAdBgNVHQ4EFgQU03U/S5NN9gwp+aRO
+HOWxLryJEE8wGAYDVR0RBBEwD4ENanBAanB0ZXRpLmNvbTAYBgNVHRIEETAPgQ1q
+cEBqcHRldGkuY29tMA0GCSqGSIb3DQEBBQUAA4IBAQC7kDLIMB9yUNaEYmfQIKbb
+JyXc9BXy4YBWyzQIhim0P0h5nSakYssH780Ck8e9Kt5TEQJ+R+Dke/QcuqLGQMG3
+/TVLWUAoJpy49cJxA5c6xKUL3ru7MBEok7oSsFDdj6W0vhCGop96DiTFMmFfThRD
+lcd2lqANIwXG3GcPOlsFI7E7k3EP2ufNaLtPg2SW4gXHF6KePR6z/y0VyK+N4kec
+zR3zJSO7GY2ZbHOT+25MKH4TeMngbqaXhGTq+fLliXrDw/Ty3/L976alxPs0IXga
+gB9NVl7Y7VVZBfE0ENaw43MAPflZI84j4uWLxShgDDh0OIXWEpckNOEHzhuRTtY/
+-----END CERTIFICATE-----

data/lib/umd.rb

@@ -0,0 +1,106 @@
+require "umd/version"
+require "umd/constants"
+require "httparty"
+
+module Umd
+  class UMD
+    include HTTParty
+    base_uri(Umd::API_V0_ROOT)
+
+    def self.corrected_options_hash(opts)
+      options_hash = opts
+
+      if options_hash[:departments].is_a?(Array)
+        options_hash[:departments] = options_hash[:departments].join(',')
+      end
+
+      # This must remain beneath the flattening of the array into a string
+      if options_hash[:departments].is_a?(String)
+        options_hash[:departments].upcase!
+      end
+
+      if options_hash[:sort]
+        options_hash[:sort] = self.formatted_sort_hash(options_hash[:sort])
+      end
+
+      options_hash
+    end
+
+    def self.formatted_sort_hash(sort_hash)
+      final_string = ""
+
+      if sort_hash[:asc]
+        final_string = sort_hash[:asc].map { |attribute| attribute.to_s }.join(',') + ","
+      end
+
+      if sort_hash[:desc]
+        final_string = final_string + sort_hash[:desc].map { |attribute| "-#{attribute}" }.join(',')
+      end
+
+      final_string
+    end
+
+    # def self.courses
+    #   self.courses(nil)
+    # end
+    #
+    # # def self.courses(options = {})
+    # #   final_options = corrected_options_hash(options)
+    # #
+    # #   self.get('/courses', {query: final_options})
+    # # end
+
+    def self.courses(course_ids=nil, options={})
+      if course_ids.is_a?(Hash)
+        options = course_ids
+        course_ids = nil
+      end
+
+      final_options = corrected_options_hash(options)
+
+      path = '/courses'
+
+      if !course_ids.nil?
+        path = '/courses/'
+
+        if course_ids.is_a?(Array)
+          path = path + course_ids.map { |s| s.to_s.downcase }.join(',')
+        else
+          path = path + course_ids.downcase
+        end
+      end
+
+      self.get(path, {query: final_options})
+    end
+
+    def self.course_list(options={})
+      final_options = corrected_options_hash(options)
+
+      self.get('/courses/list', {query: final_options})
+    end
+
+    def self.sections(section_ids, options={})
+      final_options = corrected_options_hash(options)
+
+      path = '/sections/'
+
+      if section_ids.is_a?(Array)
+        path = path + section_ids.map { |s| s.to_s.downcase }.join(',')
+      else
+        path = path + section_ids.downcase
+      end
+
+      self.get(path, {query: final_options})
+    end
+
+    def self.departments(options={})
+      self.get('/courses/departments', {query: corrected_options_hash(options)})
+    end
+
+    def self.professors(options={})
+      final_options = corrected_options_hash(options)
+
+      self.get('/professors', {query: final_options})
+    end
+  end
+end

data/lib/umd/constants.rb

@@ -0,0 +1,3 @@
+module Umd
+  API_V0_ROOT = "http://api.umd.io/v0"
+end

data/lib/umd/version.rb

@@ -0,0 +1,3 @@
+module Umd
+  VERSION = "0.1.0"
+end

data/umd.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'umd/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "umd"
+  spec.version       = Umd::VERSION
+  spec.authors       = ["J-P Teti"]
+  spec.email         = ["jp@jpteti.com"]
+
+  spec.summary       = %q{Ruby API wrapper for umd.io.}
+  spec.description   = %q{A Ruby API wrapper for umd.io}
+  spec.homepage      = "https://github.com/jpteti/umd"
+  spec.license       = "Nonstandard"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |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.cert_chain  = ['certs/jpteti.pem']
+  spec.signing_key = File.expand_path("~/.ssh/gem-private_key.pem") if $0 =~ /gem\z/
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "httparty", "~> 0.14.0"
+end

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification
+name: umd
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- J-P Teti
+autorequire: 
+bindir: exe
+cert_chain:
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIDXDCCAkSgAwIBAgIBATANBgkqhkiG9w0BAQUFADA6MQswCQYDVQQDDAJqcDEW
+  MBQGCgmSJomT8ixkARkWBmpwdGV0aTETMBEGCgmSJomT8ixkARkWA2NvbTAeFw0x
+  NzAzMjUxNTUzNTFaFw0xODAzMjUxNTUzNTFaMDoxCzAJBgNVBAMMAmpwMRYwFAYK
+  CZImiZPyLGQBGRYGanB0ZXRpMRMwEQYKCZImiZPyLGQBGRYDY29tMIIBIjANBgkq
+  hkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAv7x0rNoQqBZq9/LEwEKN/8277Criv7C5
+  P6+z1MCmeLNlYIKgKjhexVbm+Ghkhocd285blqXSZwANDHNY5+WJ7v+pITcMdTWk
+  IRWXMAdruOde3yVumMxpcUJcTPbSK41UFINMeN3pmM/DluhI6R8y++1ODkH23lzX
+  8Y8YbCKR7OW1TsxtMTzR3mOy0VPZTpx1dFB4HDVVx2YKhpWt5lp0h911bvvMwjgM
+  8BdllcdA9ZVX7c2aPVkXKBvrJcGvcPrzb5nPSGkoSJ36aJBpdGFdi0eDIstZLQFI
+  ooc76icn35wybWkuUxqcF04cnWHW3UVUbDM1z1E26dvxKja/HjlJeQIDAQABo20w
+  azAJBgNVHRMEAjAAMAsGA1UdDwQEAwIEsDAdBgNVHQ4EFgQU03U/S5NN9gwp+aRO
+  HOWxLryJEE8wGAYDVR0RBBEwD4ENanBAanB0ZXRpLmNvbTAYBgNVHRIEETAPgQ1q
+  cEBqcHRldGkuY29tMA0GCSqGSIb3DQEBBQUAA4IBAQC7kDLIMB9yUNaEYmfQIKbb
+  JyXc9BXy4YBWyzQIhim0P0h5nSakYssH780Ck8e9Kt5TEQJ+R+Dke/QcuqLGQMG3
+  /TVLWUAoJpy49cJxA5c6xKUL3ru7MBEok7oSsFDdj6W0vhCGop96DiTFMmFfThRD
+  lcd2lqANIwXG3GcPOlsFI7E7k3EP2ufNaLtPg2SW4gXHF6KePR6z/y0VyK+N4kec
+  zR3zJSO7GY2ZbHOT+25MKH4TeMngbqaXhGTq+fLliXrDw/Ty3/L976alxPs0IXga
+  gB9NVl7Y7VVZBfE0ENaw43MAPflZI84j4uWLxShgDDh0OIXWEpckNOEHzhuRTtY/
+  -----END CERTIFICATE-----
+date: 2017-03-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+description: A Ruby API wrapper for umd.io
+email:
+- jp@jpteti.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- certs/jpteti.pem
+- lib/umd.rb
+- lib/umd/constants.rb
+- lib/umd/version.rb
+- umd.gemspec
+homepage: https://github.com/jpteti/umd
+licenses:
+- Nonstandard
+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: Ruby API wrapper for umd.io.
+test_files: []