rpi_union 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ac3aa502ab23e9dbbd6b274196cd1a2702c8aab1
+  data.tar.gz: 6e5aa4820cc8175785a21381509e147b9c4059e2
+SHA512:
+  metadata.gz: 1860d286e67318a74b509cac51a323fc911fd3be4c84577b797ee878bee2d64e915a454406e7179868d4de3ba2573407576902d4e0bfbc1c99ae00a8079f03b2
+  data.tar.gz: 28acf0aa8da6a1d3d6b5f9d21ddeacef0b723d23eb8afcdd32480e7b20978166c38f79b9b25f85eac4552bb91d16fb143224307002f08b4c40565307656ef829

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.10.6

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Noah Goldman
+
+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,25 @@
+# RpiUnion
+
+A thin wrapper over the RPI Union API.  Accessing the API (and using the gem) requires a key that you recieve from being a union-recognized club.
+
+Documentation of the underlying API is at https://clubs.union.rpi.edu/?content_id=260
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rpi_union'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rpi_union
+
+## Usage
+
+See documentation at http://www.rubydoc.info/github/noahgoldman/rpi_union

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,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rpi_union"
+
+# 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/lib/rpi_union.rb

@@ -0,0 +1,113 @@
+require "rpi_union/version"
+require 'httparty'
+
+module RpiUnion
+  class Client
+    include HTTParty
+
+    API_BASE_URI = 'http://api.union.rpi.edu/query.php'
+    base_uri API_BASE_URI
+
+    GET_USER_TASK = 'GetUser'
+    LIST_ALL_ORGANIZATIONS_TASK = 'ListAllOrganizations'
+    GET_ORGANIZATION_TASK = 'GetOrganization'
+    GET_USER_ORGS_TASK = 'GetUserOrgs'
+
+    # Initialize a new Client with the specified API key
+    def initialize(api_key)
+      @api_key = api_key
+    end
+
+    # Get the properties of a specific user.
+    #
+    # @param options [Hash] Must contain one of: `:rin`, `:id` (API/database ID), or `rcsid`
+    # @return [Hash] The output of the API call.  This is of the form:
+    #   `{"name": ..., "rin": ..., "phone": ..., "class": ...}`
+    def get_user(options = {})
+      opts = {}
+      opts[:query] = {}
+
+      if options.key?(:rin)
+        opts[:query][:rin] = options[:rin]
+      elsif options.key?(:rcsid)
+        opts[:query][:rcsid] = options[:rcsid]
+      elsif options.key?(:id)
+        opts[:query][:dbid] = options[:id]
+      else
+        raise "You must pass one of the following as an option to get_user(): "+
+          "'rin', 'rcsid', or 'id'"
+      end
+
+      # Set middlename if it was pass in options
+      if options.key?(:middlename)
+        opts[:query][:middlename] = options[:middlename]
+      end
+
+      get_with_key_task(GET_USER_TASK, opts)
+    end
+
+    # Get all of the Union clubs
+    #
+    # @return [Array] An array of hashes of the form `{"club_id": ..., "club_name": ...}`
+    def list_all_organizations
+      get_with_key_task(LIST_ALL_ORGANIZATIONS_TASK)
+    end
+
+    # Get information about a club
+    #
+    # @param id [Int] The ID of the club
+    # @return [Hash] The result of the API call.  Send an example request to see the format.
+    def get_organization(id)
+      opts = { :query => { :id => id } }
+      get_with_key_task(GET_ORGANIZATION_TASK, opts)
+    end
+
+    # Get the IDs of all the clubs of which the user is an officer
+    #
+    # @param rin [Int] The RIN of the user to search for.
+    def get_user_orgs(rin)
+      opts = { :query => { :rin => rin } }
+      get_with_key_task(GET_USER_ORGS_TASK, opts)
+    end
+
+    private
+
+    def get_with_key_task(task, options = {})
+      # Add the api key to the request
+      options[:query] ||= {}
+      options[:query].merge!({ :apikey => @api_key, :task => task })
+
+      res = self.class.get('', options)
+      data = JSON.parse(res.body)
+
+      raise ApiError.new(data['status']) unless data['status']['statusCode'] == 0
+
+      data['result']
+    end
+  end
+
+  class ApiError < StandardError
+    ERROR_TYPES = {
+      2 => "Task Not Found",
+      3 => "Database Error",
+      4 => "Invalid API Key",
+      5 => "Unauthorized Origin",
+      10 => "Validation Error",
+      11 => "Data Not Found",
+    }
+
+    def initialize(status_obj)
+      @code = status_obj['code']
+      @text = status_obj['text']
+    end
+
+    def get_error_type(code)
+      return "API Error" unless ERROR_TYPES.key?(code)
+      ERROR_TYPES[code]
+    end
+
+    def message
+      return "#{get_error_type(@code)}: #{@text}"
+    end
+  end
+end

data/lib/rpi_union/version.rb

@@ -0,0 +1,3 @@
+module RpiUnion
+  VERSION = "0.2.0"
+end

data/rpi_union.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rpi_union/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rpi_union"
+  spec.version       = RpiUnion::VERSION
+  spec.authors       = ["Noah Goldman"]
+  spec.email         = ["noah@phaaze.com"]
+
+  spec.summary       = %q{A thin wrapper for the RPI Union API}
+  spec.description   = "A tiny API to access the RPI Union API for clubs. " +
+                       "Access to the API Requires a key from a union-sponsored " +
+                       "club."
+  spec.homepage      = "https://github.com/noahgoldman/rpi_union"
+  spec.license       = "MIT"
+
+  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.add_runtime_dependency "httparty", "~> 0.13"
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 0"
+  spec.add_development_dependency "webmock", "~> 0"
+end

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: rpi_union
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Noah Goldman
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-09-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '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'
+description: A tiny API to access the RPI Union API for clubs. Access to the API Requires
+  a key from a union-sponsored club.
+email:
+- noah@phaaze.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rpi_union.rb
+- lib/rpi_union/version.rb
+- rpi_union.gemspec
+homepage: https://github.com/noahgoldman/rpi_union
+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.4.8
+signing_key: 
+specification_version: 4
+summary: A thin wrapper for the RPI Union API
+test_files: []
+has_rdoc: