lightside 0.0.1

data/.gitignore

@@ -0,0 +1,3 @@
+.ruby-version
+.ruby-gemset
+Gemfile.lock

data/.rspec

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

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec(:name => 'lightside')

data/Guardfile

@@ -0,0 +1,5 @@
+guard :rspec do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end

data/README.md

@@ -0,0 +1,4 @@
+lightside
+=========
+
+LightSide Ruby API

data/lib/lightside.rb

@@ -0,0 +1,6 @@
+require 'json'
+require 'ostruct'
+require 'rest_client'
+
+Gem.find_files("lightside/*.rb").each { |f| require f}
+Gem.find_files("lightside/models/*.rb").each { |f| require f}

data/lib/lightside/config.rb

@@ -0,0 +1,23 @@
+module LightSide
+
+  def self.configure
+    @configuration ||= LightSide::Config
+    yield @configuration if block_given?
+    @configuration
+  end
+
+  class Config
+    singleton_class.class_eval do
+      attr_accessor :auth_token, :base_url
+    end
+
+    def self.headers
+      { "Authorization" => "Token #{auth_token}", "Content-Type" => "application/json" }
+    end
+
+    def self.configured?
+      auth_token && base_url
+    end
+  end
+
+end

data/lib/lightside/exceptions.rb

@@ -0,0 +1,12 @@
+module LightSide
+
+  class ResourceNotFound < StandardError; end
+  class ResourceNotCreated < StandardError; end
+
+  class NotConfigured < StandardError
+    def to_s
+      "one ore more configuration settings is missing"
+    end
+  end
+
+end

data/lib/lightside/models/answer.rb

@@ -0,0 +1,12 @@
+module LightSide
+  class Answer
+    include LightSide::Resources
+
+    setup do
+      self.resource_base        = "answers"
+      self.readonly_attributes  = %w( url predicted prediction_results created modified )
+      self.writable_attributes  = %w( parent author answer_set text author_comments reviewer_commentss submission viewed auth_token )
+    end
+
+  end
+end

data/lib/lightside/models/answer_set.rb

@@ -0,0 +1,12 @@
+module LightSide
+  class AnswerSet
+    include LightSide::Resources
+
+    setup do
+      self.resource_base        = "answer-sets"
+      self.readonly_attributes  = %w( url owner answers prediction_tasks created modified )
+      self.writable_attributes  = %w( prompt icon tile_color auth_token trained_models tags )
+    end
+
+  end
+end

data/lib/lightside/models/assignment_icon.rb

@@ -0,0 +1,12 @@
+module LightSide
+  class AssignmentIcon
+    include LightSide::Resources
+
+    setup do
+      self.resource_base        = "assignment-icons"
+      self.readonly_attributes  = %w( url name description image created )
+      self.writable_attributes  = %w( )
+    end
+
+  end
+end

data/lib/lightside/models/assignment_tile_color.rb

@@ -0,0 +1,12 @@
+module LightSide
+  class AssignmentTileColor
+    include LightSide::Resources
+
+    setup do
+      self.resource_base        = "assignment-tile-colors"
+      self.readonly_attributes  = %w( url color )
+      self.writable_attributes  = %w( )
+    end
+
+  end
+end

data/lib/lightside/models/author.rb

@@ -0,0 +1,12 @@
+module LightSide
+  class Author
+    include LightSide::Resources
+
+    setup do
+      self.resource_base        = "authors"
+      self.readonly_attributes  = %w( url owner answers created modified )
+      self.writable_attributes  = %w( designator email auth_token active )
+    end
+
+  end
+end

data/lib/lightside/models/corpus.rb

@@ -0,0 +1,16 @@
+module LightSide
+  class Corpus
+    include LightSide::Resources
+
+    setup do
+      self.resource_base        = "corpora"
+      self.readonly_attributes  = %w( url owner training_answers created modified )
+      self.writable_attributes  = %w( prompt description active )
+    end
+
+    def training_answer_ids
+      training_answers.map { |url| url.split("/").last }
+    end
+
+  end
+end

data/lib/lightside/models/human_score.rb

@@ -0,0 +1,12 @@
+module LightSide
+  class HumanScore
+    include LightSide::Resources
+
+    setup do
+      self.resource_base        = "human-scores"
+      self.readonly_attributes  = %w( url created modified )
+      self.writable_attributes  = %w( training_answer label )
+    end
+
+  end
+end

data/lib/lightside/models/prediction_result.rb

@@ -0,0 +1,12 @@
+module LightSide
+  class PredictionResult
+    include LightSide::Resources
+
+    setup do
+      self.resource_base        = "prediction-results"
+      self.readonly_attributes  = %w( url answer prediction_task trained_model distribution label possible_labels created modified )
+      self.writable_attributes  = %w( )
+    end
+
+  end
+end

data/lib/lightside/models/prediction_task.rb

@@ -0,0 +1,25 @@
+module LightSide
+  class PredictionTask
+    include LightSide::Resources
+
+    setup do
+      self.resource_base        = "prediction-tasks"
+      self.readonly_attributes  = %w( url process task_id owner status messages prediction_results created modified )
+      self.writable_attributes  = %w( answer_set )
+    end
+
+    def process_start
+      RestClient.post(process, "", Config.headers) do |response, request, result|
+        case response.code
+        when 200, 202
+          return JSON.parse(response)
+        when 404
+          raise ResourceNotFound, "could not find #{name} with ID=#{id}"
+        else
+          raise JSON.parse(response)["detail"]
+        end
+      end
+    end
+
+  end
+end

data/lib/lightside/models/prompt.rb

@@ -0,0 +1,12 @@
+module LightSide
+  class Prompt
+    include LightSide::Resources
+
+    setup do
+      self.resource_base        = "prompts"
+      self.readonly_attributes  = %w( url owner parent corpora answer_sets created modified )
+      self.writable_attributes  = %w( title text instructions description lower upper default_models alignments tags active )
+    end
+
+  end
+end

data/lib/lightside/models/resolved_score.rb

@@ -0,0 +1,12 @@
+module LightSide
+  class ResolvedScore
+    include LightSide::Resources
+
+    setup do
+      self.resource_base        = "resolved-scores"
+      self.readonly_attributes  = %w( url created modified )
+      self.writable_attributes  = %w( training_answer label )
+    end
+
+  end
+end

data/lib/lightside/models/tag_answer_set.rb

@@ -0,0 +1,12 @@
+module LightSide
+  class TagPrompt
+    include LightSide::Resources
+
+    setup do
+      self.resource_base        = "tags/prompts"
+      self.readonly_attributes  = %w( name num_times )
+      self.writable_attributes  = %w( )
+    end
+
+  end
+end

data/lib/lightside/models/tag_prompt.rb

@@ -0,0 +1,12 @@
+module LightSide
+  class TagAnswerSet
+    include LightSide::Resources
+
+    setup do
+      self.resource_base        = "tags/answer_sets"
+      self.readonly_attributes  = %w( name num_times )
+      self.writable_attributes  = %w( )
+    end
+
+  end
+end

data/lib/lightside/models/trained_model.rb

@@ -0,0 +1,12 @@
+module LightSide
+  class TrainedModel
+    include LightSide::Resources
+
+    setup do
+      self.resource_base        = "trained-models"
+      self.readonly_attributes  = %w( url corpus learner feature_set creation_method recipe_file active created modified )
+      self.writable_attributes  = %w( name evaluations predictions )
+    end
+
+  end
+end

data/lib/lightside/models/trained_model_evaluation.rb

@@ -0,0 +1,12 @@
+module LightSide
+  class TrainedModelEvaluation
+    include LightSide::Resources
+
+    setup do
+      self.resource_base        = "trained-model-evaluations"
+      self.readonly_attributes  = %w( url trained_model accuracy entropy kappa weighted_kappa label created modified )
+      self.writable_attributes  = %w( )
+    end
+
+  end
+end

data/lib/lightside/models/training_answer.rb

@@ -0,0 +1,12 @@
+module LightSide
+  class TrainingAnswer
+    include LightSide::Resources
+
+    setup do
+      self.resource_base        = "training-answers"
+      self.readonly_attributes  = %w( url created modified )
+      self.writable_attributes  = %w( corpus text )
+    end
+
+  end
+end

data/lib/lightside/models/training_task.rb

@@ -0,0 +1,25 @@
+module LightSide
+  class TrainingTask
+    include LightSide::Resources
+
+    setup do
+      self.resource_base        = "training-tasks"
+      self.readonly_attributes  = %w( url process task_id owner status messages trained_model created modified )
+      self.writable_attributes  = %w( corpus )
+    end
+
+    def process_start
+      RestClient.post(process, "", Config.headers) do |response, request, result|
+        case response.code
+        when 200, 202
+          yield JSON.parse(response)
+        when 404
+          raise ResourceNotFound, "could not find #{name} with ID=#{id}"
+        else
+          raise JSON.parse(response)["detail"]
+        end
+      end
+    end
+
+  end
+end

data/lib/lightside/pager.rb

@@ -0,0 +1,72 @@
+module LightSide
+  class Pager
+    include Enumerable
+
+    attr_accessor :collection, :next_url, :params, :previous_url, :resource_builder, :resource_url, :url
+
+    def initialize(model_class, params={})
+      self.resource_url     = model_class.resource_url
+      self.resource_builder = lambda { |hash| model_class.new(hash) }
+      self.params           = { page: 1 }.merge(params)
+      self.collection       = []
+      self.url              = resource_path
+    end
+
+    def count
+      collection.length
+    end
+
+    def each
+      collection.each { |instance| yield instance }
+    end
+
+    def fetch
+      self.collection = []
+      fetch_page
+      self
+    end
+
+    def fetch_page
+      RestClient.get(url, Config.headers) do |response, request, result|
+        case response.code
+        when 200
+          parsed_response   = JSON.parse(response)
+          self.next_url     = parsed_response["next"]
+          self.previous_url = parsed_response["previous"]
+          parsed_response["results"].each do |resource|
+            collection << resource_builder.call(resource)
+          end
+        end
+      end
+    end
+
+    def less?
+      !!previous_url
+    end
+
+    def more?
+      !!next_url
+    end
+
+    def next
+      raise "no more results" unless more?
+      self.url = next_url
+      fetch
+    end
+
+    def page_number
+      params.fetch(:page, 1).to_i
+    end
+
+    def previous
+      raise "no more results" unless less?
+      self.url = previous_url
+      fetch
+    end
+
+    def resource_path
+      URI.join(resource_url, "?#{URI.encode_www_form(params)}").to_s
+    end
+
+  end
+end

data/lib/lightside/resources.rb

@@ -0,0 +1,171 @@
+module LightSide
+  module Resources
+
+    def initialize(hash={})
+      set_attributes_from_hash(hash)
+    end
+
+    def attributes
+      self.class.attributes.inject({}) do |memo, attr|
+        memo.merge(attr => self.__send__(attr))
+      end
+    end
+
+    def delete
+      self.class.delete_resource(id)
+    end
+
+    def id
+      url && url.split("/").last
+    end
+
+    def reload
+      self.class.resource(id) do |hash|
+        set_attributes_from_hash(hash)
+      end
+      self
+    end
+
+    def update
+      save
+    end
+
+    def save
+      json = JSON.generate(writable_attributes)
+      if id
+        self.class.update_resource(id, json) { |hash| set_attributes_from_hash(hash) }
+      else
+        self.class.create_resource(json) { |hash| set_attributes_from_hash(hash) }
+      end
+      self
+    end
+
+    def set_attributes_from_hash(hash)
+      self.class.attributes.each do |attr|
+        self.__send__("#{attr.to_s}=", hash.fetch(attr, nil))
+      end
+    end
+
+    def to_s
+      %w(id url errors).map(&:to_sym).inject("#{self.class.name}") do |memo, attr|
+        val = self.__send__(attr)
+        memo << " #{attr}:#{val}" if val
+        memo
+      end
+    end
+
+    def writable_attributes
+      self.class.writable_attributes.inject({}) do |memo, attr|
+        memo.merge(attr => self.__send__(attr))
+      end
+    end
+
+    def self.included(base)
+      base.extend(ClassMethods)
+      base.singleton_class.class_eval { attr_accessor :resource_base, :readonly_attributes, :writable_attributes }
+    end
+
+    module ClassMethods
+      def all
+        resources
+      end
+
+      def attributes
+        @readonly_attributes.to_a + @writable_attributes.to_a + ["errors"]
+      end
+
+      def create(data)
+        create_resource(data) { |hash| new(hash) }
+      end
+
+      def create_resource(data)
+        RestClient.post(resource_url, data, Config.headers) do |response, request, result|
+          case response.code
+          when 201
+            yield JSON.parse(response)
+          when 400
+            yield JSON.parse(data).merge!("errors" => JSON.parse(response))
+          else
+            raise response
+          end
+        end
+      end
+
+      def delete(id)
+        delete_resource(id)
+      end
+
+      def delete_resource(id)
+        RestClient.delete(resource_url(id), Config.headers) do |response, request, result|
+          case response.code
+          when 204
+            return true
+          when 404
+            raise ResourceNotFound, "could not find #{name} with ID=#{id}"
+          else
+            raise response
+          end
+        end
+      end
+
+      def find(id)
+        resource(id) { |hash| new(hash) }
+      end
+
+      def page(page_num)
+        LightSide::Pager.new(self, { page: Integer(page_num) }).fetch
+      end
+
+      def query(query_params)
+        resources(query_params)
+      end
+
+      def resource_url(id=nil)
+        raise LightSide::NotConfigured unless Config.configured?
+        [Config.base_url, "#{resource_base}/#{id}"].join("/")
+      end
+
+      def resources(params={})
+        LightSide::Pager.new(self, params).fetch
+      end
+
+      def resource(id)
+        RestClient.get(resource_url(id), Config.headers) do |response, request, result|
+          case response.code
+          when 200
+            yield JSON.parse(response)
+          when 404
+            raise ResourceNotFound, "could not find #{name} with ID=#{id}"
+          else
+            raise response
+          end
+        end
+      end
+
+      def setup
+        yield
+        attributes.each { |attr| attr_accessor attr.to_s }
+      end
+
+      def update(id, data)
+        update_resource(id, data) { |hash| new(hash) }
+      end
+
+      def update_resource(id, data)
+        RestClient.put(resource_url(id), data, Config.headers) do |response, request, result|
+          case response.code
+          when 200
+            yield JSON.parse(response)
+          when 400
+            yield ({"errors" => JSON.parse(response)})
+          when 404
+            raise ResourceNotFound, "could not find #{name} with ID=#{id}"
+          else
+            raise response
+          end
+        end
+      end
+    end
+
+  end
+end

data/lib/lightside/version.rb

@@ -0,0 +1,4 @@
+module LightSide
+  VERSION = '0.0.1'
+end
+

data/lightside.gemspec

@@ -0,0 +1,27 @@
+require File.expand_path('../lib/lightside/version',  __FILE__)
+
+Gem::Specification.new do |s|
+  s.name          = 'lightside'
+  s.version       = LightSide::VERSION
+  s.date          = '2013-12-02'
+  s.summary       = 'LightSide API'
+  s.description   = 'Ruby wrapper for LightSide Web API'
+  s.authors       = ['Tom Head']
+  s.email         = 'tom.head@revolutionprep.com'
+  s.homepage      = 'http://github.com/RevolutionK12/lightside'
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.homepage      = ""
+  s.license       = 'MIT'
+  s.require_paths = ["lib"]
+
+  s.add_dependency 'rest-client'
+
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'webmock'
+  s.add_development_dependency 'pry'
+  s.add_development_dependency 'pry-nav'
+  s.add_development_dependency 'guard'
+  s.add_development_dependency 'guard-rspec'
+end

data/spec/config_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+describe LightSide::Config do
+  let(:auth_token) { "abc123" }
+  let(:base_url) { "https://api.example.com/api/" }
+
+  it "can set auth_token" do
+    LightSide.configure do |config|
+      config.auth_token = auth_token
+    end
+    expect( LightSide::Config.auth_token ).to eq auth_token
+  end
+
+  it "can set base_url" do
+    LightSide.configure do |config|
+      config.base_url = base_url
+    end
+    expect( LightSide::Config.base_url ).to eq base_url
+  end
+
+  context ".configured?" do
+    context "when auth_token is missing" do
+      it "returns false" do
+        LightSide::Config.auth_token = nil
+        expect( LightSide::Config.configured? ).to be_false
+      end
+    end
+
+    context "when base_url is missing" do
+      it "returns false" do
+        LightSide::Config.base_url = nil
+        expect( LightSide::Config.configured? ).to be_false
+      end
+    end
+  end
+end

data/spec/fixtures/prompts.json

@@ -0,0 +1 @@
+{"count": 2, "next": null, "previous": null, "results": [{"url": "https://api.example.com/api/prompts/2", "owner": 2, "parent": null, "title": "ASAP Dataset #2: Persuasive Essay on Censorship", "text": "ASAP Dataset #2: Persuasive Essay on Censorship", "instructions": "", "description": "<blockquote>\"All of us can think of a book that we hope none of our children or any other children have taken off the shelf. But if I have the right to remove that book from the shelf -- that work I abhor -- then you also have exactly the same right and so does everyone else. And then we have no books left on the shelf for any of us.\" <footer>&mdash; Katherine Paterson, Author</footer></blockquote>\r\n\r\n<p>Write a persuasive essay to a newspaper reflecting your vies on censorship in libraries. Do you believe that certain materials, such as books, music, movies, magazines, etc., should be removed from the shelves if they are found offensive? Support your position with convincing arguments from your own experience, observations, and/or reading.</p>", "lower": null, "upper": null, "alignments": "", "default_models": ["https://api.example.com/api/trained-models/2", "https://api.example.com/api/trained-models/3"], "tags": [], "corpora": ["https://api.example.com/api/corpora/2"], "answer_sets": ["https://api.example.com/api/answer-sets/2"], "active": true, "created": "2013-10-03T00:00:00", "modified": "2013-10-03T00:00:00"}, {"url": "https://api.example.com/api/prompts/1", "owner": 2, "parent": null, "title": "ASAP Dataset #1: Persuasive Essay on Computers", "text": "ASAP Dataset #1: Persuasive Essay on Computers", "instructions": "", "description": "More and more people use computers, but not everyone agrees that this benefits society. Those who support advances in technology believe that computers have a positive effect on people. They teach hand-eye coordination, give people the ability to learn about faraway places and people, and even allow people to talk online with other people. Others have different ideas. Some experts are concerned that people are spending too much time on their computers and less time exercising, enjoying nature, and interacting with family and friends. \n\nWrite a letter to your local newspaper in which you state your opinion on the effects computers have on people. Persuade the readers to agree with you.", "lower": null, "upper": null, "alignments": "", "default_models": ["https://api.example.com/api/trained-models/1"], "tags": [], "corpora": ["https://api.example.com/api/corpora/1"], "answer_sets": ["https://api.example.com/api/answer-sets/1"], "active": true, "created": "2013-10-03T00:00:00", "modified": "2013-10-03T00:00:00"}]}

data/spec/fixtures/prompts/2.json

@@ -0,0 +1 @@
+{"url": "https://api.example.com/api/prompts/2", "owner": 2, "parent": null, "title": "ASAP Dataset #2: Persuasive Essay on Censorship", "text": "ASAP Dataset #2: Persuasive Essay on Censorship", "instructions": "", "description": "<blockquote>\"All of us can think of a book that we hope none of our children or any other children have taken off the shelf. But if I have the right to remove that book from the shelf -- that work I abhor -- then you also have exactly the same right and so does everyone else. And then we have no books left on the shelf for any of us.\" <footer>&mdash; Katherine Paterson, Author</footer></blockquote>\r\n\r\n<p>Write a persuasive essay to a newspaper reflecting your vies on censorship in libraries. Do you believe that certain materials, such as books, music, movies, magazines, etc., should be removed from the shelves if they are found offensive? Support your position with convincing arguments from your own experience, observations, and/or reading.</p>", "lower": null, "upper": null, "alignments": "", "default_models": ["https://api.example.com/api/trained-models/2", "https://api.example.com/api/trained-models/3"], "tags": [], "corpora": ["https://api.example.com/api/corpora/2"], "answer_sets": ["https://api.example.com/api/answer-sets/2"], "active": true, "created": "2013-10-03T00:00:00", "modified": "2013-10-03T00:00:00"}

data/spec/fixtures/prompts_1.json

@@ -0,0 +1 @@
+{"count": 2, "next": "https://api.example.com/api/prompts/?page=2", "previous": null, "results": [{"url": "https://api.example.com/api/prompts/2", "owner": 2, "parent": null, "title": "ASAP Dataset #2: Persuasive Essay on Censorship", "text": "ASAP Dataset #2: Persuasive Essay on Censorship", "instructions": "", "description": "<blockquote>\"All of us can think of a book that we hope none of our children or any other children have taken off the shelf. But if I have the right to remove that book from the shelf -- that work I abhor -- then you also have exactly the same right and so does everyone else. And then we have no books left on the shelf for any of us.\" <footer>&mdash; Katherine Paterson, Author</footer></blockquote>\r\n\r\n<p>Write a persuasive essay to a newspaper reflecting your vies on censorship in libraries. Do you believe that certain materials, such as books, music, movies, magazines, etc., should be removed from the shelves if they are found offensive? Support your position with convincing arguments from your own experience, observations, and/or reading.</p>", "lower": null, "upper": null, "alignments": "", "default_models": ["https://api.example.com/api/trained-models/2", "https://api.example.com/api/trained-models/3"], "tags": [], "corpora": ["https://api.example.com/api/corpora/2"], "answer_sets": ["https://api.example.com/api/answer-sets/2"], "active": true, "created": "2013-10-03T00:00:00", "modified": "2013-10-03T00:00:00"}, {"url": "https://api.example.com/api/prompts/1", "owner": 2, "parent": null, "title": "ASAP Dataset #1: Persuasive Essay on Computers", "text": "ASAP Dataset #1: Persuasive Essay on Computers", "instructions": "", "description": "More and more people use computers, but not everyone agrees that this benefits society. Those who support advances in technology believe that computers have a positive effect on people. They teach hand-eye coordination, give people the ability to learn about faraway places and people, and even allow people to talk online with other people. Others have different ideas. Some experts are concerned that people are spending too much time on their computers and less time exercising, enjoying nature, and interacting with family and friends. \n\nWrite a letter to your local newspaper in which you state your opinion on the effects computers have on people. Persuade the readers to agree with you.", "lower": null, "upper": null, "alignments": "", "default_models": ["https://api.example.com/api/trained-models/1"], "tags": [], "corpora": ["https://api.example.com/api/corpora/1"], "answer_sets": ["https://api.example.com/api/answer-sets/1"], "active": true, "created": "2013-10-03T00:00:00", "modified": "2013-10-03T00:00:00"}]}

data/spec/fixtures/prompts_2.json

@@ -0,0 +1 @@
+{"count": 2, "next": "https://api.example.com/api/prompts/?page=2", "previous": "https://api.example.com/api/prompts/?page=1", "results": [{"url": "https://api.example.com/api/prompts/2", "owner": 2, "parent": null, "title": "ASAP Dataset #2: Persuasive Essay on Censorship", "text": "ASAP Dataset #2: Persuasive Essay on Censorship", "instructions": "", "description": "<blockquote>\"All of us can think of a book that we hope none of our children or any other children have taken off the shelf. But if I have the right to remove that book from the shelf -- that work I abhor -- then you also have exactly the same right and so does everyone else. And then we have no books left on the shelf for any of us.\" <footer>&mdash; Katherine Paterson, Author</footer></blockquote>\r\n\r\n<p>Write a persuasive essay to a newspaper reflecting your vies on censorship in libraries. Do you believe that certain materials, such as books, music, movies, magazines, etc., should be removed from the shelves if they are found offensive? Support your position with convincing arguments from your own experience, observations, and/or reading.</p>", "lower": null, "upper": null, "alignments": "", "default_models": ["https://api.example.com/api/trained-models/2", "https://api.example.com/api/trained-models/3"], "tags": [], "corpora": ["https://api.example.com/api/corpora/2"], "answer_sets": ["https://api.example.com/api/answer-sets/2"], "active": true, "created": "2013-10-03T00:00:00", "modified": "2013-10-03T00:00:00"}, {"url": "https://api.example.com/api/prompts/1", "owner": 2, "parent": null, "title": "ASAP Dataset #1: Persuasive Essay on Computers", "text": "ASAP Dataset #1: Persuasive Essay on Computers", "instructions": "", "description": "More and more people use computers, but not everyone agrees that this benefits society. Those who support advances in technology believe that computers have a positive effect on people. They teach hand-eye coordination, give people the ability to learn about faraway places and people, and even allow people to talk online with other people. Others have different ideas. Some experts are concerned that people are spending too much time on their computers and less time exercising, enjoying nature, and interacting with family and friends. \n\nWrite a letter to your local newspaper in which you state your opinion on the effects computers have on people. Persuade the readers to agree with you.", "lower": null, "upper": null, "alignments": "", "default_models": ["https://api.example.com/api/trained-models/1"], "tags": [], "corpora": ["https://api.example.com/api/corpora/1"], "answer_sets": ["https://api.example.com/api/answer-sets/1"], "active": true, "created": "2013-10-03T00:00:00", "modified": "2013-10-03T00:00:00"}]}

data/spec/fixtures/prompts_3.json

@@ -0,0 +1 @@
+{"count": 2, "next": null, "previous": "https://api.example.com/api/prompts/?page=2", "results": [{"url": "https://api.example.com/api/prompts/2", "owner": 2, "parent": null, "title": "ASAP Dataset #2: Persuasive Essay on Censorship", "text": "ASAP Dataset #2: Persuasive Essay on Censorship", "instructions": "", "description": "<blockquote>\"All of us can think of a book that we hope none of our children or any other children have taken off the shelf. But if I have the right to remove that book from the shelf -- that work I abhor -- then you also have exactly the same right and so does everyone else. And then we have no books left on the shelf for any of us.\" <footer>&mdash; Katherine Paterson, Author</footer></blockquote>\r\n\r\n<p>Write a persuasive essay to a newspaper reflecting your vies on censorship in libraries. Do you believe that certain materials, such as books, music, movies, magazines, etc., should be removed from the shelves if they are found offensive? Support your position with convincing arguments from your own experience, observations, and/or reading.</p>", "lower": null, "upper": null, "alignments": "", "default_models": ["https://api.example.com/api/trained-models/2", "https://api.example.com/api/trained-models/3"], "tags": [], "corpora": ["https://api.example.com/api/corpora/2"], "answer_sets": ["https://api.example.com/api/answer-sets/2"], "active": true, "created": "2013-10-03T00:00:00", "modified": "2013-10-03T00:00:00"}, {"url": "https://api.example.com/api/prompts/1", "owner": 2, "parent": null, "title": "ASAP Dataset #1: Persuasive Essay on Computers", "text": "ASAP Dataset #1: Persuasive Essay on Computers", "instructions": "", "description": "More and more people use computers, but not everyone agrees that this benefits society. Those who support advances in technology believe that computers have a positive effect on people. They teach hand-eye coordination, give people the ability to learn about faraway places and people, and even allow people to talk online with other people. Others have different ideas. Some experts are concerned that people are spending too much time on their computers and less time exercising, enjoying nature, and interacting with family and friends. \n\nWrite a letter to your local newspaper in which you state your opinion on the effects computers have on people. Persuade the readers to agree with you.", "lower": null, "upper": null, "alignments": "", "default_models": ["https://api.example.com/api/trained-models/1"], "tags": [], "corpora": ["https://api.example.com/api/corpora/1"], "answer_sets": ["https://api.example.com/api/answer-sets/1"], "active": true, "created": "2013-10-03T00:00:00", "modified": "2013-10-03T00:00:00"}]}

data/spec/fixtures/prompts_4.json

@@ -0,0 +1 @@
+{"count": 2, "next": "https://api.example.com/api/prompts/?page=2&all=true", "previous": "https://api.example.com/api/prompts/?page=1&all=true", "results": [{"url": "https://api.example.com/api/prompts/2", "owner": 2, "parent": null, "title": "ASAP Dataset #2: Persuasive Essay on Censorship", "text": "ASAP Dataset #2: Persuasive Essay on Censorship", "instructions": "", "description": "<blockquote>\"All of us can think of a book that we hope none of our children or any other children have taken off the shelf. But if I have the right to remove that book from the shelf -- that work I abhor -- then you also have exactly the same right and so does everyone else. And then we have no books left on the shelf for any of us.\" <footer>&mdash; Katherine Paterson, Author</footer></blockquote>\r\n\r\n<p>Write a persuasive essay to a newspaper reflecting your vies on censorship in libraries. Do you believe that certain materials, such as books, music, movies, magazines, etc., should be removed from the shelves if they are found offensive? Support your position with convincing arguments from your own experience, observations, and/or reading.</p>", "lower": null, "upper": null, "alignments": "", "default_models": ["https://api.example.com/api/trained-models/2", "https://api.example.com/api/trained-models/3"], "tags": [], "corpora": ["https://api.example.com/api/corpora/2"], "answer_sets": ["https://api.example.com/api/answer-sets/2"], "active": true, "created": "2013-10-03T00:00:00", "modified": "2013-10-03T00:00:00"}, {"url": "https://api.example.com/api/prompts/1", "owner": 2, "parent": null, "title": "ASAP Dataset #1: Persuasive Essay on Computers", "text": "ASAP Dataset #1: Persuasive Essay on Computers", "instructions": "", "description": "More and more people use computers, but not everyone agrees that this benefits society. Those who support advances in technology believe that computers have a positive effect on people. They teach hand-eye coordination, give people the ability to learn about faraway places and people, and even allow people to talk online with other people. Others have different ideas. Some experts are concerned that people are spending too much time on their computers and less time exercising, enjoying nature, and interacting with family and friends. \n\nWrite a letter to your local newspaper in which you state your opinion on the effects computers have on people. Persuade the readers to agree with you.", "lower": null, "upper": null, "alignments": "", "default_models": ["https://api.example.com/api/trained-models/1"], "tags": [], "corpora": ["https://api.example.com/api/corpora/1"], "answer_sets": ["https://api.example.com/api/answer-sets/1"], "active": true, "created": "2013-10-03T00:00:00", "modified": "2013-10-03T00:00:00"}]}

data/spec/pager_spec.rb

@@ -0,0 +1,104 @@
+require 'spec_helper'
+
+describe LightSide::Pager do
+  let(:auth_token) { "abc123" }
+  let(:base_url) { "https://api.example.com/api" }
+  let(:headers) { {
+    "Accept"        => "*/*; q=0.5, application/xml",
+    "Accept-Encoding" => "gzip, deflate",
+    "Authorization" => "Token #{auth_token}",
+    "Content-Type"  => "application/json",
+    "User-Agent"    => "Ruby"
+  } }
+
+  before do
+    LightSide.configure do |config|
+      config.auth_token = auth_token
+      config.base_url = base_url
+    end
+  end
+
+  context "when url is not supplied" do
+    let(:page_url) { "https://api.example.com/api/prompts/?page=1" }
+    let(:pager) { LightSide::Pager.new(LightSide::Prompt) }
+
+    it "starts at page 1" do
+      expect(pager.page_number).to eq 1
+      expect(pager.resource_path).to eq page_url
+    end
+  end
+
+  context "when retrieving by page number" do
+    let(:path) { "https://api.example.com/api/prompts/" }
+    let(:pager) { LightSide::Pager.new(LightSide::Prompt, params) }
+
+    context "without query params" do
+      let(:params) { {page: 2} }
+      let(:response_body) { File.new("spec/fixtures/prompts_2.json") }
+
+      before do
+        stub_request(:get, "#{base_url}/prompts/?page=2").with(:headers => headers).
+          to_return(:status => 200, :body => response_body, :headers => {})
+      end
+
+      it "starts at page 2" do
+        expect(pager.page_number).to eq 2
+      end
+
+      it "sets the next url" do
+        pager.fetch
+        expect(pager.next_url).to eq "#{base_url}/prompts/?page=2"
+        expect(pager.collection.map(&:class)).to eq [LightSide::Prompt]*2
+      end
+    end
+
+    context "with query params" do
+      let(:params) { {page: 2, all: true} }
+      let(:response_body) { File.new("spec/fixtures/prompts_4.json") }
+
+      before do
+        stub_request(:get, "#{base_url}/prompts/?page=2&all=true").with(:headers => headers).
+          to_return(:status => 200, :body => response_body, :headers => {})
+      end
+
+      it "starts at page 2" do
+        expect(pager.page_number).to eq 2
+      end
+
+      it "sets the next url" do
+        pager.fetch
+        expect(pager.next_url).to eq "#{base_url}/prompts/?page=2&all=true"
+        expect(pager.collection.map(&:class)).to eq [LightSide::Prompt]*2
+      end
+    end
+
+    context "#next" do
+      let(:params) { {page: 2} }
+      let(:response_body) { File.new("spec/fixtures/prompts_2.json") }
+
+      context "when next_url is missing" do
+        it "raises an exception" do
+          expect(pager.page_number).to eq 2
+          expect(pager.next_url).to be_nil
+          expect { pager.next }.to raise_error("no more results")
+        end
+      end
+
+      context "when next_url is present" do
+        let(:response_body_2) { File.new("spec/fixtures/prompts_3.json") }
+        let(:page_3_url) { "#{base_url}/prompts/?page=3" }
+
+        before do
+          stub_request(:get, "#{base_url}/prompts/?page=3").with(:headers => headers).
+            to_return(:status => 200, :body => response_body_2, :headers => {})
+        end
+
+        it "fetches the next set of results" do
+          pager.next_url = page_3_url
+          pager.next
+          expect(pager.collection).not_to be_empty
+        end
+      end
+    end
+  end
+end

data/spec/resources_spec.rb

@@ -0,0 +1,228 @@
+require 'spec_helper'
+
+describe LightSide::Resources do
+  let(:auth_token) { "abc123" }
+  let(:base_url) { "https://api.example.com/api" }
+  let(:prompts) { LightSide::Prompt.all }
+  let(:prompt) { prompts.first }
+  let(:headers) { {
+    "Accept"        => "*/*; q=0.5, application/xml",
+    "Accept-Encoding" => "gzip, deflate",
+    "Authorization" => "Token #{auth_token}",
+    "Content-Type"  => "application/json",
+    "User-Agent"    => "Ruby"
+  } }
+
+  before do
+    LightSide.configure do |config|
+      config.auth_token = auth_token
+      config.base_url = base_url
+    end
+  end
+
+  context ".all" do
+    let(:response_body) { File.new("spec/fixtures/prompts.json") }
+
+    before do
+      stub_request(:get, "#{base_url}/prompts/?page=1").with(:headers => headers).
+        to_return(:status => 200, :body => response_body, :headers => {})
+    end
+
+    it "gets the first page of prompts" do
+      expect(prompts).to be_kind_of(LightSide::Pager)
+      expect(prompts.count).to eq 2
+      expect(prompt).to be_kind_of(LightSide::Prompt)
+      expect(prompt.url).to eq "https://api.example.com/api/prompts/2"
+    end
+  end
+
+  context ".page" do
+    let(:response_body) { File.new("spec/fixtures/prompts.json") }
+
+    before do
+      stub_request(:get, "#{base_url}/prompts/?page=2").with(:headers => headers).
+        to_return(:status => 200, :body => response_body, :headers => {})
+    end
+
+    context "when requesting without a page number" do
+      let(:prompts) { LightSide::Prompt.page }
+      it "raises an exception" do
+        expect { prompts }.to raise_error
+      end
+    end
+
+    context "when requesting with page number nil" do
+      let(:prompts) { LightSide::Prompt.page(nil) }
+      it "raises an exception" do
+        expect { prompts }.to raise_error
+      end
+    end
+
+    context "when requesting with page number 2" do
+      let(:prompts) { LightSide::Prompt.page(2) }
+      it "returns the second page of results" do
+        expect(prompts.collection.map(&:class)).to eq [LightSide::Prompt]*2
+      end
+    end
+  end
+
+  context ".find" do
+    context "with a valid ID" do
+      let(:response_body) { File.new("spec/fixtures/prompts/2.json") }
+      let(:prompt) { LightSide::Prompt.find(2) }
+
+      before do
+        stub_request(:get, "#{base_url}/prompts/2").
+          with(:headers => headers).
+          to_return(:status => 200, :body => response_body, :headers => {})
+      end
+
+      it "finds a prompt by its id" do
+        expect(prompt).to be_kind_of(LightSide::Prompt)
+        expect(prompt.url).to eq "https://api.example.com/api/prompts/2"
+      end
+    end
+
+    context "with an invalid ID" do
+      let(:prompt) { LightSide::Prompt.find(99) }
+
+      before do
+        stub_request(:get, "#{base_url}/prompts/99").with(:headers => headers).
+          to_return(:status => 404, :body => "", :headers => {})
+      end
+
+      it "raises an exception" do
+        expect { prompt }.to raise_error(LightSide::ResourceNotFound)
+      end
+    end
+  end
+
+  context ".create" do
+    context "with valid input" do
+      let(:response_body) { File.new("spec/fixtures/prompts/2.json") }
+      let(:data) { JSON.generate({
+        "title" => "new prompt title",
+        "text" => "This is the text of the prompt.",
+        "description" => "This prompt is an example.",
+        "lower" => nil,
+        "upper" => nil,
+        "default_models" => [],
+        "tags" => ["example", "period 2"]
+      }) }
+
+      before do
+        headers.merge!('Content-Length' => data.length)
+        stub_request(:post, "#{base_url}/prompts/").with(:headers => headers).
+          to_return(:status => 201, :body => response_body, :headers => {})
+      end
+
+      it "creates a prompt" do
+        prompt = LightSide::Prompt.create(data)
+        expect(prompt.url).to eq "https://api.example.com/api/prompts/2"
+      end
+    end
+
+    context "with invalid input" do
+      let(:error_hash) { {"text"=>["This field is required."], "title"=>["This field is required."]} }
+      let(:response_body) { JSON.generate(error_hash) }
+      let(:data) { JSON.generate({}) }
+
+      before do
+        headers.merge!('Content-Length' => data.length)
+        stub_request(:post, "#{base_url}/prompts/").with(:headers => headers).
+          to_return(:status => 400, :body => response_body, :headers => {})
+      end
+
+      it "returns an unsaved prompt and populates its error hash" do
+        prompt = LightSide::Prompt.create(data)
+        expect(prompt.errors).to eq error_hash
+      end
+    end
+  end
+
+  context ".update" do
+    context "with valid ID and input" do
+      let(:response_body) { File.new("spec/fixtures/prompts/2.json") }
+      let(:data) { JSON.generate({
+        "title" => "new prompt title",
+        "text" => "This is the text of the prompt.",
+        "description" => "This prompt is an example.",
+        "lower" => nil,
+        "upper" => nil,
+        "default_models" => [],
+        "tags" => ["example", "period 2"]
+      }) }
+
+      before do
+        headers.merge!('Content-Length' => data.length)
+        stub_request(:put, "#{base_url}/prompts/2").with(:headers => headers).
+          with(:body => data).
+          to_return(:status => 200, :body => response_body, :headers => {})
+      end
+
+      it "updates the prompt" do
+        prompt = LightSide::Prompt.update(2, data)
+        expect(prompt.url).to eq "https://api.example.com/api/prompts/2"
+      end
+    end
+
+    context "with valid ID and invalid input" do
+      let(:error_hash) { {"text"=>["This field is required."], "title"=>["This field is required."]} }
+      let(:response_body) { JSON.generate(error_hash) }
+      let(:data) { JSON.generate({}) }
+
+      before do
+        headers.merge!('Content-Length' => data.length)
+        stub_request(:put, "#{base_url}/prompts/2").with(:headers => headers).
+          with(:body => data).
+          to_return(:status => 400, :body => response_body, :headers => {})
+      end
+
+      it "return the prompt without updating and populates its error hash" do
+        prompt = LightSide::Prompt.update(2, data)
+        expect(prompt.errors).to eq error_hash
+      end
+    end
+
+    context "with invalid ID" do
+      let(:data) { JSON.generate({}) }
+      let(:prompt) { LightSide::Prompt.update(99, data) }
+
+      before do
+        headers.merge!('Content-Length' => data.length)
+        stub_request(:put, "#{base_url}/prompts/99").with(:headers => headers).
+          with(:body => data).
+          to_return(:status => 404, :body => "", :headers => {})
+      end
+
+      it "raises an exception" do
+        expect { prompt }.to raise_error(LightSide::ResourceNotFound)
+      end
+    end
+  end
+
+  context ".delete" do
+    context "with valid ID" do
+      before do
+        stub_request(:delete, "#{base_url}/prompts/2").with(:headers => headers).
+          to_return(:status => 204, :body => "", :headers => {})
+      end
+
+      it "returns true" do
+        expect(LightSide::Prompt.delete(2)).to eq true
+      end
+    end
+
+    context "with invalid ID" do
+      before do
+        stub_request(:delete, "#{base_url}/prompts/99").with(:headers => headers).
+          to_return(:status => 404, :body => "", :headers => {})
+      end
+
+      it "raises an exception" do
+        expect { LightSide::Prompt.delete(99) }.to raise_error(LightSide::ResourceNotFound)
+      end
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,22 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end
+
+require 'webmock/rspec'
+WebMock.disable_net_connect!
+
+require 'lightside'

metadata

@@ -0,0 +1,206 @@
+--- !ruby/object:Gem::Specification
+name: lightside
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Tom Head
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  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: rspec
+  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: webmock
+  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: pry
+  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: pry-nav
+  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: guard
+  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: guard-rspec
+  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: Ruby wrapper for LightSide Web API
+email: tom.head@revolutionprep.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- Guardfile
+- README.md
+- lib/lightside.rb
+- lib/lightside/config.rb
+- lib/lightside/exceptions.rb
+- lib/lightside/models/answer.rb
+- lib/lightside/models/answer_set.rb
+- lib/lightside/models/assignment_icon.rb
+- lib/lightside/models/assignment_tile_color.rb
+- lib/lightside/models/author.rb
+- lib/lightside/models/corpus.rb
+- lib/lightside/models/human_score.rb
+- lib/lightside/models/prediction_result.rb
+- lib/lightside/models/prediction_task.rb
+- lib/lightside/models/prompt.rb
+- lib/lightside/models/resolved_score.rb
+- lib/lightside/models/tag_answer_set.rb
+- lib/lightside/models/tag_prompt.rb
+- lib/lightside/models/trained_model.rb
+- lib/lightside/models/trained_model_evaluation.rb
+- lib/lightside/models/training_answer.rb
+- lib/lightside/models/training_task.rb
+- lib/lightside/pager.rb
+- lib/lightside/resources.rb
+- lib/lightside/version.rb
+- lightside.gemspec
+- spec/config_spec.rb
+- spec/fixtures/prompts.json
+- spec/fixtures/prompts/2.json
+- spec/fixtures/prompts_1.json
+- spec/fixtures/prompts_2.json
+- spec/fixtures/prompts_3.json
+- spec/fixtures/prompts_4.json
+- spec/pager_spec.rb
+- spec/resources_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+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.25
+signing_key: 
+specification_version: 3
+summary: LightSide API
+test_files:
+- spec/config_spec.rb
+- spec/fixtures/prompts.json
+- spec/fixtures/prompts/2.json
+- spec/fixtures/prompts_1.json
+- spec/fixtures/prompts_2.json
+- spec/fixtures/prompts_3.json
+- spec/fixtures/prompts_4.json
+- spec/pager_spec.rb
+- spec/resources_spec.rb
+- spec/spec_helper.rb