desmos 0.1.2

data/spec/desmos/utils_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+describe Desmos::Utils, '.escape' do
+  
+  it "should escape correctly" do
+    Desmos::Utils.escape("fo<o>bar").should == "fo%3Co%3Ebar"
+    Desmos::Utils.escape("a space").should == "a+space"
+    Desmos::Utils.escape("q1!2\"'w$5&7/z8)?\\").should == "q1%212%22%27w%245%267%2Fz8%29%3F%5C"
+  end
+
+  it "should escape correctly for multibyte characters" do
+    matz_name = "\xE3\x81\xBE\xE3\x81\xA4\xE3\x82\x82\xE3\x81\xA8".unpack("a*")[0] # Matsumoto
+    matz_name.force_encoding("UTF-8") if matz_name.respond_to? :force_encoding
+    Desmos::Utils.escape(matz_name).should == '%E3%81%BE%E3%81%A4%E3%82%82%E3%81%A8'
+    matz_name_sep = "\xE3\x81\xBE\xE3\x81\xA4 \xE3\x82\x82\xE3\x81\xA8".unpack("a*")[0] # Matsu moto
+    matz_name_sep.force_encoding("UTF-8") if matz_name_sep.respond_to? :force_encoding
+    Desmos::Utils.escape(matz_name_sep).should == '%E3%81%BE%E3%81%A4+%E3%82%82%E3%81%A8'
+  end
+  
+end

data/spec/desmos/whiteboard_spec.rb

@@ -0,0 +1,203 @@
+require 'spec_helper'
+
+describe Desmos::Whiteboard, '.new' do
+
+  it 'sets the instance variables based upon the options passed into the initializer' do
+    tutor      = Desmos::Tutor.new(:id => 1, :name => 'test')
+    students   = [Desmos::Student.new(:id => 2, :name => 'student')]
+    whiteboard = Desmos::Whiteboard.new(
+      :hash     => 'abcde',
+      :title    => 'Title',
+      :tutor    => tutor,
+      :students => students
+    )
+    whiteboard.hash.should eql('abcde')
+    whiteboard.title.should eql('Title')
+    whiteboard.tutor.should eql(tutor)
+    whiteboard.students.should eql(students)
+  end
+
+  it 'requires that the tutor option be either of type Desmos::Tutor or NilClass' do
+    lambda {
+      Desmos::Whiteboard.new(:tutor => 'tutor')
+    }.should raise_error(ArgumentError, ':tutor option must be either of type Desmos::Tutor or NilClass')
+  end
+
+  it 'requires that the students option be either an Array containing object of type Desmos::Student or NilClass' do
+    lambda {
+      Desmos::Whiteboard.new(:students => ['student'])
+    }.should raise_error(ArgumentError, ':students option must be either an Array containing object of type Desmos::Student or NilClass')
+
+    lambda {
+      Desmos::Whiteboard.new(:students => 'student')
+    }.should raise_error(ArgumentError, ':students option must be either an Array containing object of type Desmos::Student or NilClass')
+
+    lambda {
+      Desmos::Whiteboard.new(:students => 2)
+    }.should raise_error(ArgumentError, ':students option must be either an Array containing object of type Desmos::Student or NilClass')
+
+    lambda {
+      Desmos::Whiteboard.new(:students => [Desmos::Student.new(:id => 2, :name => 'student')])
+    }.should_not raise_error
+
+    lambda {
+      Desmos::Whiteboard.new(:students => nil)
+    }.should_not raise_error
+  end
+
+end
+
+describe Desmos::Whiteboard, '#save' do
+
+  context 'when the whiteboard does not already exist' do
+
+    before(:each) do
+      stub_request(:get, /https\:\/\/api\.tutortrove\.com\/api_v1\/whiteboard\/create/).
+        to_return(:status => 200, :body => "{\"success\": \"true\", \"hash\": \"abcde\"}")
+    
+      stub_request(:get, /https\:\/\/api\.tutortrove\.com\/api_v1\/whiteboard\/add_user/).
+        to_return(:status => 200, :body => "{\"success\": \"true\", \"hash\": \"abcde\"}")
+    end
+
+    it 'calls out to the Desmos API to save the whiteboard, tutor, and students' do
+      tutor      = Desmos::Tutor.new(:id => 1, :name => 'tutor')
+      student    = Desmos::Student.new(:id => 2, :name => 'student')
+      whiteboard = Desmos::Whiteboard.new(:tutor => tutor)
+      whiteboard.students << student
+      whiteboard.save
+    
+      assert_requested :get, /https\:\/\/api\.tutortrove\.com\/api_v1\/whiteboard\/create/, :times => 1
+      assert_requested :get, /https\:\/\/api\.tutortrove\.com\/api_v1\/whiteboard\/add_user/, :times => 2
+    end
+
+  end
+
+  context 'when the whiteboard already exists' do
+
+    before(:each) do
+      stub_request(:get, /https\:\/\/api\.tutortrove\.com\/api_v1\/whiteboard\/create/).
+        to_return(:status => 200, :body => "{\"success\": \"true\", \"hash\": \"abcde\"}").
+        to_return(:status => 200, :body => "{\"success\":\"false\",\"error_code\":1,\"error_message\":\"whiteboard already exists\"}")
+    
+      stub_request(:get, /https\:\/\/api\.tutortrove\.com\/api_v1\/whiteboard\/add_user/).
+        to_return(:status => 200, :body => "{\"success\": \"true\", \"hash\": \"abcde\"}")
+    end
+
+    it 'calls out to the Desmos API to save the whiteboard, tutor, and students' do
+      whiteboard = Desmos::Whiteboard.new
+      whiteboard.save
+      whiteboard.save
+    
+      assert_requested :get, /https\:\/\/api\.tutortrove\.com\/api_v1\/whiteboard\/create/, :times => 2
+    end
+
+  end
+
+end
+
+describe Desmos::Whiteboard, '#request_options' do
+
+  it 'builds a hash of options used to make requests from the Desmos API' do
+    whiteboard = Desmos::Whiteboard.new
+    whiteboard.request_options.should eql({})
+
+    whiteboard = Desmos::Whiteboard.new(
+      :hash  => 'abcde',
+      :title => 'Title'
+    )
+    whiteboard.request_options.should eql({
+      :hash  => 'abcde',
+      :title => 'Title'
+    })
+
+    whiteboard = Desmos::Whiteboard.new(
+      :hash  => 'abcde',
+      :title => 'Title',
+      :tutor => Desmos::Tutor.new(
+        :id   => 1,
+        :hash => 'zyxwv',
+        :name => 'Mr. Tutor'
+      )
+    )
+    whiteboard.request_options.should eql({
+      :hash       => 'abcde',
+      :title      => 'Title',
+      :tutor_id   => 1,
+      :tutor_hash => 'zyxwv',
+      :tutor_name => 'Mr. Tutor'
+    })
+  end
+
+end
+
+describe Desmos::Whiteboard, '.create' do
+
+  before(:each) do
+    stub_request(:get, /https\:\/\/api\.tutortrove\.com\/api_v1\/whiteboard\/create/).
+      to_return(:status => 200, :body => "{\"success\": \"true\", \"hash\": \"abcde\"}")
+    end
+
+  it 'returns a new instance of DesmosWhiteboard' do
+    whiteboard = Desmos::Whiteboard.create
+    whiteboard.should be_kind_of(Desmos::Whiteboard)
+    whiteboard.hash.should eql('abcde')
+    assert_requested :get, /https\:\/\/api\.tutortrove\.com\/api_v1\/whiteboard\/create/, :times => 1
+  end
+
+end
+
+describe Desmos::Whiteboard, '.find' do
+
+  context 'when the Whiteboard exists on the Desmos API' do
+
+    before(:each) do
+      stub_request(:get, /https\:\/\/api\.tutortrove\.com\/api_v1\/whiteboard\/read/).
+        to_return(:status => 200, :body => "{\"title\": \"No Title\", \"hash\": \"abcde\", \"tutor\": {\"id\": null, \"name\": null, \"hash\": null}, \"students\": []}")
+    end
+
+    it 'requests a Whiteboard from the Desmos API using its unique hash value' do
+      whiteboard = Desmos::Whiteboard.find('abcde')
+      whiteboard.should be_instance_of(Desmos::Whiteboard)
+      whiteboard.hash.should eql('abcde')
+      
+      assert_requested :get, /https\:\/\/api\.tutortrove\.com\/api_v1\/whiteboard\/read/, :times => 1
+    end
+
+  end
+
+  context 'when the Whiteboard does not exist of the Desmos API' do
+
+    before(:each) do
+      stub_request(:get, /https\:\/\/api\.tutortrove\.com\/api_v1\/whiteboard\/read/).
+        to_return(:status => 200, :body => "{\"error_code\": 1, \"error_message\": \"Whiteboard not found\", \"success\": \"false\"}")
+    end
+
+    it 'raises an error if the Whiteboard' do
+      lambda { Desmos::Whiteboard.find('abcde') }.should raise_error(Desmos::WhiteboardNotFound, 'Whiteboard with HASH=abcde could not be found')
+    end
+
+  end
+
+end
+
+describe Desmos::Whiteboard, '#build_from_hash' do
+
+  it 'builds a fresh instance using the provided hash' do
+    whiteboard = Desmos::Whiteboard.new.build_from_hash({
+      :title => 'No Title',
+      :hash  => 'abcde',
+      :tutor => {
+        :id   => 1,
+        :hash => 'zyxwv',
+        :name => 'test'
+      },
+      :students => []
+    })
+    whiteboard.should be_instance_of(Desmos::Whiteboard)
+    whiteboard.title.should eql('No Title')
+    whiteboard.hash.should eql('abcde')
+    whiteboard.tutor.should be_instance_of(Desmos::Tutor)
+    whiteboard.students.should be_empty
+  end
+
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'desmos'
+require 'rspec'
+require 'rspec/autorun'
+require 'webmock/rspec'
+
+# Requires supporting ruby files with custom matchers and macros, etc,
+# in spec/support/ and its subdirectories.
+Dir["spec/support/**/*.rb"].each { |f| require f }
+
+RSpec.configure do |config|
+  config.color_enabled = true
+end

data/spec/support/configure.rb

@@ -0,0 +1,9 @@
+RSpec.configure do |config|
+  config.before(:each) do
+    Desmos::Configuration.domain     = 'api.tutortrove.com'
+    Desmos::Configuration.version    = 1
+    Desmos::Configuration.key        = '111'
+    Desmos::Configuration.secret     = 'abcde'
+    Desmos::Configuration.debug_mode = false
+  end
+end

metadata

@@ -0,0 +1,226 @@
+--- !ruby/object:Gem::Specification 
+name: desmos
+version: !ruby/object:Gem::Version 
+  hash: 31
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 2
+  version: 0.1.2
+platform: ruby
+authors: 
+- Ryan Moran
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-09-08 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 59
+        segments: 
+        - 0
+        - 8
+        - 2
+        version: 0.8.2
+  version_requirements: *id001
+  name: yajl-ruby
+  prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency 
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 0
+        - 4
+        - 5
+        version: 0.4.5
+  version_requirements: *id002
+  name: oauth
+  prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency 
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        version: "3.0"
+  version_requirements: *id003
+  name: activesupport
+  prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency 
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  version_requirements: *id004
+  name: rspec
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency 
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  version_requirements: *id005
+  name: jeweler
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency 
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  version_requirements: *id006
+  name: autotest
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency 
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  version_requirements: *id007
+  name: awesome_print
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency 
+  requirement: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  version_requirements: *id008
+  name: webmock
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency 
+  requirement: &id009 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 1
+        - 2
+        - 9
+        version: 1.2.9
+  version_requirements: *id009
+  name: rspec
+  prerelease: false
+  type: :development
+description: Desmos API Wrapper
+email: ryan.moran@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .rvmrc
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- autotest/discover.rb
+- desmos.gemspec
+- lib/desmos.rb
+- lib/desmos/configuration.rb
+- lib/desmos/debug_mode.rb
+- lib/desmos/errors.rb
+- lib/desmos/request_support.rb
+- lib/desmos/student.rb
+- lib/desmos/tutor.rb
+- lib/desmos/user.rb
+- lib/desmos/utils.rb
+- lib/desmos/whiteboard.rb
+- spec/desmos/configuration_spec.rb
+- spec/desmos/request_support_spec.rb
+- spec/desmos/student_spec.rb
+- spec/desmos/tutor_spec.rb
+- spec/desmos/user_spec.rb
+- spec/desmos/utils_spec.rb
+- spec/desmos/whiteboard_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- spec/support/configure.rb
+homepage: http://github.com/RevolutionPrep/desmos
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.6
+signing_key: 
+specification_version: 3
+summary: Desmos API Wrapper
+test_files: []
+