kmdata 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 236a165a8c4edf1cc467f6dadc62486a63d21d9f
+  data.tar.gz: 1a63a97001f8ac2aea3bd9b1e5626899e4dff599
+SHA512:
+  metadata.gz: fcf8241c81a4ccb4e5289061ffde05ac3ab899820834cf6529d338e007e1f8d0e18a9beac753c86e4b578b5cd32eac44d03e4760a729006ee6fd33b3df956fd5
+  data.tar.gz: f5b35c143e81d1746fe47c3a2a021d5a445552e0f24f5088734c4d58fa52a255824f2c59c7f2a0cea68f9599a0f9b4092a00fa371a11a51daf62c543645bf392

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Kyle Decot
+
+MIT License
+
+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,36 @@
+# KMData
+
+A simple API wrapper for interacting with the [KMData](https://kmdata.osu.edu/) Project.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'kmdata'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install kmdata
+
+## Usage
+
+    terms = KMData.get('terms')
+    terms.each do |term|
+      puts term.description
+    end
+
+    resource_id = KMData.get('people', { q: 'Decot' }).first.resource_id
+    person = KMData.get("people/#{resource_id}")
+    puts person.display_name
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+require "rspec/core"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.fail_on_error = false
+  spec.rspec_opts = "--color --format documentation"
+  spec.pattern = FileList["spec/**/*_spec.rb"]
+end
+
+task default: :spec

data/kmdata.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "kmdata/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "kmdata"
+  spec.version       = KMData::VERSION
+  spec.authors       = ["Kyle Decot", "Mike Butsko", "Ryan Stocker"]
+  spec.email         = ["decot.7@osu.edu", "butsko.7@osu.edu", "stocker.19@osu.edu"]
+  spec.description   = %q{A simple API wrapper for interacting with the KMData Project}
+  spec.summary       = %q{A simple API wrapper for interacting with the KMData Project}
+  spec.homepage      = "https://github.com/ASCTech/kmdata-ruby"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "rspec"
+
+  spec.add_runtime_dependency "json"
+end

data/lib/kmdata/version.rb

@@ -0,0 +1,3 @@
+module KMData
+  VERSION = "0.0.1"
+end

data/lib/kmdata.rb

@@ -0,0 +1,36 @@
+%w[kmdata/version net/http json ostruct].each { |f| require f }
+
+module KMData
+  ENDPOINT = "kmdata.osu.edu"
+
+  def self.get(path, params = {})
+    path = "/api/#{path}.json?#{URI.encode_www_form(params)}"
+    response = request(path)
+    process(JSON.parse(response.body)) if response.code == "200"
+  rescue Exception => exception
+  end
+
+  private
+
+  def self.request(path)
+    http.request(Net::HTTP::Get.new(path))
+  end
+
+  def self.http
+    @http ||= begin
+      http = Net::HTTP.new(ENDPOINT, 443)
+      http.use_ssl = true
+      http
+    end
+  end
+
+  def self.process(json)
+    if json.is_a? Array
+      json.map { |element| process(element) }
+    elsif json.is_a? Hash
+      OpenStruct.new(Hash[json.map { |key, value| [key, process(value)] }])
+    else
+      json
+    end
+  end
+end

data/spec/fixtures/terms.json

@@ -0,0 +1 @@
+[{"description":"Summer 2012","id":1,"term_code":"1124"},{"description":"Autumn 2012","id":2,"term_code":"1128"},{"description":"Spring 2013","id":3,"term_code":"1132"},{"description":"Summer 2013","id":4,"term_code":"1134"},{"description":"Autumn 2013","id":5,"term_code":"1138"}]

data/spec/kmdata_spec.rb

@@ -0,0 +1,65 @@
+require "spec_helper"
+require "kmdata"
+
+describe KMData do
+  describe '.get' do
+    let(:json) { File.read(File.join('spec', 'fixtures', 'terms.json')) }
+
+    context 'success' do
+      it 'returns an array of terms' do
+        response = double()
+        response.stub!(:code) { "200" }
+        response.stub!(:body) { json }
+
+        KMData.stub!(:path_with_params).with("/api/terms.json", {})
+        KMData.stub!(:request).with(anything).and_return(response)
+        KMData.get('terms').should == KMData.send(:process, JSON.parse(json))
+      end
+    end
+
+    context 'failure' do
+      it 'returns nil' do
+        response = double()
+        response.stub!(:code) { "500" }
+        response.stub!(:body) { nil }
+
+        KMData.stub!(:path_with_params).with("/api/terms.json", {})
+        KMData.stub!(:request).with(anything).and_return(response)
+        KMData.get('terms').should be_nil
+      end
+    end
+
+  end
+
+  describe '.process' do
+    let(:data) { [1, 2, { foo: 'bar', baz: true }] }
+    subject { KMData.send :process, data }
+    it 'transforms json' do
+      subject[0].should eql 1
+      subject[2].foo.should eql 'bar'
+      subject[2].baz.should be_true
+    end
+  end
+
+  describe '.http' do
+    subject { KMData.send :http }
+    it { should respond_to(:request) }
+  end
+
+  describe '.request' do
+    let(:response) do
+      response = double()
+      response.stub!(:body).and_return('')
+      response.stub!(:code).and_return('200')
+      response
+    end
+    subject { KMData.send(:request, '/api/terms.json') }
+    it 'should respond to body and code' do
+      http = double()
+      http.stub!(:request).and_return(response)
+      KMData.stub!(:http).and_return(http)
+
+      subject.should respond_to(:body, :code)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+RSpec.configure do |config|
+  config.mock_with :rspec
+  config.order = "random"
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: kmdata
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Kyle Decot
+- Mike Butsko
+- Ryan Stocker
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-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.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: 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: 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: json
+  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: A simple API wrapper for interacting with the KMData Project
+email:
+- decot.7@osu.edu
+- butsko.7@osu.edu
+- stocker.19@osu.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- kmdata.gemspec
+- lib/kmdata.rb
+- lib/kmdata/version.rb
+- spec/fixtures/terms.json
+- spec/kmdata_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/ASCTech/kmdata-ruby
+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.0.3
+signing_key: 
+specification_version: 4
+summary: A simple API wrapper for interacting with the KMData Project
+test_files:
+- spec/fixtures/terms.json
+- spec/kmdata_spec.rb
+- spec/spec_helper.rb