gooru 0.0.2

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Passion Dragon
+
+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,96 @@
+# Gooru
+
+The gooru gem allows your Ruby app to talk to the [Gooru API](http://developers.goorulearning.org)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'gooru'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install gooru
+    
+## Setup
+
+### Gooru API key
+
+Some areas of the Gooru API require sign in via an API key.
+
+You may want to [request an API key](http://developers.goorulearning.org/request-a-key) from Gooru before you get started.
+
+### Environment variables
+
+If you're using an API key, you may want to store it in an environment variable.
+
+Environment variables can be a way to store sensitive data you don't want in source control.
+
+Consider using a tool like [Dotenv](https://github.com/bkeepers/dotenv) to manage these variables across different developer and server environments.
+
+You'll see the environment variable approach used in the examples below.
+
+## Usage
+
+### Sign In
+
+The Sign In call takes your API key and returns a session token.
+
+If you're using the signed in areas of the Gooru API, you'll need to hang on to the returned session token and use it in later requests.
+
+The Sign In call is not needed if you're only using the public areas of the API.
+
+    response = Gooru::SignIn.post(
+      apiKey:   ENV["GOORU_API_KEY"],
+      userName: ENV["GOORU_USER_NAME"],
+      password: ENV["GOORU_PASSWORD"])
+      
+    if response.success?
+      puts "You've been authenticated!"
+      puts "Your session token is #{response.data['token']}"
+    else
+      puts "You were unable to be authenticated…"
+      puts "The error message was: #{response.data['error']}"
+    end
+    
+*Required parameters*
+
+* `apiKey`
+* `userName`
+* `password`
+
+### Resources
+
+The Resources call takes a query and returns a list of matching resources.
+
+You can optionally pass a session token if you're signed in, but it is not required.
+
+    response = Gooru::Resources.get(
+      query: "algebra")
+      
+    if response.success?
+      results = response.data["searchResults"]
+      puts "We found #{results.length} resources matching 'algebra'"
+    else
+      puts "The error message was: #{response.data['error']}"
+    end    
+
+*Required parameters*
+
+* `query`
+
+*Optional parameters*
+
+* `sessionToken`
+
+## 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,8 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.libs << ["lib", "test"]
+  t.pattern = "test/**/*_test.rb"
+  t.verbose = true
+end

data/gooru.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'gooru/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "gooru"
+  gem.version       = Gooru::VERSION
+  gem.authors       = ["Brandon Beacher"]
+  gem.email         = ["brandon.beacher@gmail.com"]
+  gem.description   = %q{}
+  gem.summary       = %q{The gooru gem allows your Ruby app to talk to the Gooru API}
+  gem.homepage      = "https://github.com/highgroove/gooru"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency "weary"
+
+  gem.add_development_dependency "dotenv"
+  gem.add_development_dependency "rake"
+end

data/lib/gooru.rb

@@ -0,0 +1,14 @@
+require "stringio"
+require "weary"
+
+require "gooru/client"
+require "gooru/client/resources"
+require "gooru/client/sign_in"
+require "gooru/request"
+require "gooru/resources"
+require "gooru/response"
+require "gooru/sign_in"
+require "gooru/version"
+
+module Gooru
+end

data/lib/gooru/client.rb

@@ -0,0 +1,4 @@
+module Gooru
+  class Client < Weary::Client    
+  end
+end

data/lib/gooru/client/resources.rb

@@ -0,0 +1,18 @@
+module Gooru
+  class Client
+    class Resources < Gooru::Client
+      domain ENV["GOORU_URL"]
+      
+      get :get, "gooru-search/rest/search/resource.json" do |resource|
+        resource.required \
+          :query
+
+        resource.optional \
+          :pageNum,
+          :pageSize,
+          :sessionToken
+      end
+
+    end
+  end
+end

data/lib/gooru/client/sign_in.rb

@@ -0,0 +1,15 @@
+module Gooru
+  class Client
+    class SignIn < Gooru::Client
+      domain ENV["GOORU_URL"]
+      
+      post :post, "gooruapi/rest/account/signin.json" do |resource|
+        resource.required \
+          :apiKey,
+          :password,
+          :userName
+      end
+
+    end
+  end
+end

data/lib/gooru/request.rb

@@ -0,0 +1,21 @@
+module Gooru
+  class Request
+
+    def self.get(options = {})
+      response = client.new.get(options).perform
+      Gooru::Response.new(response)
+    end
+
+    def self.post(options = {})
+      response = client.new.post(options).perform
+      Gooru::Response.new(response)
+    end
+
+  private
+
+    def self.client
+      raise NotImplementedError
+    end
+
+  end
+end

data/lib/gooru/resources.rb

@@ -0,0 +1,11 @@
+module Gooru
+  class Resources < Gooru::Request
+
+  private
+
+    def self.client
+      Gooru::Client::Resources
+    end
+
+  end
+end

data/lib/gooru/response.rb

@@ -0,0 +1,49 @@
+module Gooru
+  class Response
+    attr_reader :data
+    attr_reader :status
+
+    def initialize(weary_response)
+      @data = parse(weary_response.body)
+      @status = weary_response.status
+    end
+
+    def error?
+      has_error_key? ||
+      internal_server_error?
+    end
+
+    def error_message
+      if has_error_key?
+        data["error"]
+      elsif internal_server_error?
+        data["status"]
+      else
+        ""
+      end
+    end
+
+    def success?
+      !error?
+    end
+
+  private
+
+    def has_error_key?
+      data.has_key?("error")
+    end
+
+    def internal_server_error?
+      status == 500
+    end
+
+    def parse(body)
+      if body.match(/^error:(.*)/)
+        { "error" => Regexp.last_match[1] }
+      else
+        MultiJson.decode(body)
+      end
+    end
+
+  end
+end

data/lib/gooru/sign_in.rb

@@ -0,0 +1,11 @@
+module Gooru
+  class SignIn < Gooru::Request
+
+  private
+
+    def self.client
+      Gooru::Client::SignIn
+    end
+
+  end
+end

data/lib/gooru/version.rb

@@ -0,0 +1,3 @@
+module Gooru
+  VERSION = "0.0.2"
+end

data/test/resources_test.rb

@@ -0,0 +1,20 @@
+require "test_helper"
+
+class ResourcesTest < MiniTest::Unit::TestCase
+
+  def test_get
+    response = Gooru::Resources.get(
+      query: "all")
+
+    assert(response.data.has_key?("searchResults"))
+  end
+
+  def test_get_with_pagination
+    response = Gooru::Resources.get(
+      query:    "all",
+      pageNum:  2,
+      pageSize: 5)
+
+    assert(response.data["searchResults"].count == 5)
+  end
+end

data/test/sign_in_test.rb

@@ -0,0 +1,23 @@
+require "test_helper"
+
+class SignInTest < MiniTest::Unit::TestCase
+
+  def test_post
+    response = Gooru::SignIn.post(
+      apiKey:   ENV["GOORU_API_KEY"],
+      userName: ENV["GOORU_USER_NAME"],
+      password: ENV["GOORU_PASSWORD"])
+    
+    assert(response.data.has_key?("token"))
+  end
+
+  def test_unsuccessful_post
+    response = Gooru::SignIn.post(
+      apiKey:   "invalid-api-key",
+      userName: "invalid-username",
+      password: "invalid-password")
+    
+    assert(response.data.has_key?("error"))
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,6 @@
+require "dotenv"
+Dotenv.load
+
+require "gooru"
+require "minitest/autorun"
+

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: gooru
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- Brandon Beacher
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: weary
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ''
+email:
+- brandon.beacher@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- gooru.gemspec
+- lib/gooru.rb
+- lib/gooru/client.rb
+- lib/gooru/client/resources.rb
+- lib/gooru/client/sign_in.rb
+- lib/gooru/request.rb
+- lib/gooru/resources.rb
+- lib/gooru/response.rb
+- lib/gooru/sign_in.rb
+- lib/gooru/version.rb
+- test/resources_test.rb
+- test/sign_in_test.rb
+- test/test_helper.rb
+homepage: https://github.com/highgroove/gooru
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: The gooru gem allows your Ruby app to talk to the Gooru API
+test_files:
+- test/resources_test.rb
+- test/sign_in_test.rb
+- test/test_helper.rb