getclever-ruby 0.0.1

data/spec/endpoints/teachers_spec.rb

@@ -0,0 +1,85 @@
+require 'spec_helper'
+require 'clever/api'
+
+describe 'API' do
+  before do
+    Clever.configure do |config|
+      config.api_key = 'DEMO_KEY'
+    end
+
+    @api = Clever::API.new
+    @api.http = Clever::FakeServer.new({:api_key => Clever.config.api_key})
+  end
+
+  it "can get a list of teachers" do
+    teachers = @api.teachers({:limit => 4})
+
+    teachers[:data].length.should eq(4)
+
+    teachers[:data][0].id.should eq('4fee004dca2e43cf270007d5')
+    teachers[:data][0].name['first'].should eq('Nadia')
+    teachers[:data][0].name['middle'].should eq('H')
+    teachers[:data][0].name['last'].should eq('Mitchell')
+  end
+
+  it "can get a specific teacher" do
+    teacher = @api.teacher('4fee004dca2e43cf270007d5')
+
+    teacher.id.should eq('4fee004dca2e43cf270007d5')
+    teacher.name['first'].should eq('Nadia')
+    teacher.name['middle'].should eq('H')
+    teacher.name['last'].should eq('Mitchell')
+  end
+
+  it "can get a list of sections for a given teacher" do
+    sections = @api.teacher_sections('4fee004dca2e43cf270007fd', {:limit => 2})
+
+    unless sections[:paging].nil?
+      sections[:paging][:current].should eq(1)
+      sections[:paging][:total].should eq(2)
+      sections[:paging][:count].should eq(3)
+    end
+
+    sections[:data].length.should eq(2)
+
+    sections[:data][0].id.should eq('4fee004dca2e43cf2700081a')
+    sections[:data][0].name.should eq('Earth Arithmetic 4(B)')
+  end
+
+  it "can get a school for a given teacher" do
+    school = @api.teacher_school('4fee004dca2e43cf270007d5')
+
+    school.id.should eq('4fee004cca2e43cf27000003')
+    school.name.should eq('Clever High School')
+  end
+
+  it "can get a district for a given teacher" do
+    district = @api.teacher_district('4fee004dca2e43cf270007fd')
+
+    district.id.should eq('4fd43cc56d11340000000005')
+    district.name.should eq('Demo District')
+  end
+
+  it "can get a list of students for a given teacher" do
+    students = @api.teacher_students('4fee004dca2e43cf270007fd', {:limit => 5})
+
+    unless students[:paging].nil?
+      students[:paging][:current].should eq(1)
+      students[:paging][:total].should eq(17)
+      students[:paging][:count].should eq(81)
+    end
+
+    students[:data].length.should eq(5)
+    students[:data][0].id.should eq('4fee004cca2e43cf2700000d')
+  end
+
+  it "can get a list of grade levels for a given teacher" do
+    grade_levels = @api.teacher_grade_levels('4fee004dca2e43cf270007fd')
+
+    grade_levels.length.should eq(3)
+
+    grade_levels[0].should eq(6)
+    grade_levels[1].should eq(7)
+    grade_levels[2].should eq(8)
+  end
+end

data/spec/models/contact_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+require 'clever/models/contact'
+
+describe Clever::Models::Contact do
+  it 'requires initialization parameters' do
+    expect {Clever::Models::Contact.new}.to raise_error(ArgumentError)
+  end
+
+  context "valid values" do
+    id = '4fee004dca2e43cf27000931'
+    name = 'Issac Roob'
+    email = 'Samanta.Schaefer@mailinator.com'
+    phone = '597.747.8259'
+    phone_type = 'home'
+    type = 'guardian'
+    student_id = '4fee004dca2e43cf27000931'
+
+    let(:params) {{
+        :id => id,
+        :name => name,
+        :email => email,
+        :phone => phone,
+        :phone_type => phone_type,
+        :type => type,
+        :student_id => student_id
+    }}
+
+    subject { Clever::Models::Contact.new params }
+
+    its(:id)              { should == id }
+    its(:name)            { should == name }
+    its(:email)           { should == email }
+    its(:phone)           { should == phone }
+    its(:phone_type)      { should == phone_type }
+    its(:type)            { should == type }
+    its(:student_id)      { should == student_id }
+  end
+end

data/spec/models/district_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+require 'clever/models/district'
+
+describe Clever::Models::District do
+  it 'requires an id and name' do
+    expect { Clever::Models::District.new }.to raise_error(ArgumentError)
+  end
+
+  context "valid values" do
+
+    id = '4fd43cc56d11340000000005'
+    name = 'Test District'
+
+    let(:params) { {
+        :id => id,
+        :name => name
+    } }
+
+    subject { Clever::Models::District.new params }
+
+    its(:id) { should == id }
+    its(:name) { should == name }
+  end
+end

data/spec/models/photo_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+require 'clever/models/photo'
+
+describe Clever::Models::Photo do
+  it 'requires initialization parameters' do
+    expect {Clever::Models::Photo.new}.to raise_error(ArgumentError)
+  end
+
+  context "valid values" do
+    id = '4fee004cca2e43cf27000001'
+    data = 'lots of bytes'
+
+    let(:params) {{
+        :id => id,
+        :data => data
+    }}
+
+    subject { Clever::Models::Photo.new params }
+
+    its(:id)              { should == id }
+    its(:data)            { should == data }
+  end
+end

data/spec/models/school_spec.rb

@@ -0,0 +1,53 @@
+require 'spec_helper'
+require 'clever/models/school'
+
+describe Clever::Models::School do
+  it 'requires initialization parameters' do
+    expect {Clever::Models::School.new}.to raise_error(ArgumentError)
+  end
+
+  context "valid values" do
+    id = '4fee004cca2e43cf27000001'
+    name = 'Clever Academy'
+    high_grade = '8'
+    low_grade = '6'
+    nces_id = '17065379'
+    phone = '1-755-019-5442'
+    school_number = '214'
+    sis_id = '9255'
+    location = { :address => "18828 Kutch Court", :city => "Dessiemouth", :state => "IA", :zip => "37471-9969" }
+    principal = { :name => "Colleen Gottlieb", :email => "Eda_Barrows@mailinator.com" }
+    last_modified = '2012-06-29T19:21:50.592Z'
+    district_id = '4fd43cc56d11340000000005'
+
+    let(:params) {{
+        :id => id,
+        :name => name,
+        :high_grade => high_grade,
+        :low_grade => low_grade,
+        :nces_id => nces_id,
+        :phone => phone,
+        :school_number => school_number,
+        :sis_id => sis_id,
+        :location => location,
+        :principal => principal,
+        :last_modified => last_modified,
+        :district_id => district_id
+    }}
+
+    subject { Clever::Models::School.new params }
+
+    its(:id)              { should == id }
+    its(:name)            { should == name }
+    its(:high_grade)      { should == high_grade }
+    its(:low_grade)       { should == low_grade }
+    its(:nces_id)         { should == nces_id }
+    its(:phone)           { should == phone }
+    its(:school_number)   { should == school_number }
+    its(:sis_id)          { should == sis_id }
+    its(:location)        { should == location }
+    its(:principal)       { should == principal }
+    its(:last_modified)   { should == last_modified }
+
+  end
+end

data/spec/models/section_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+require 'clever/models/section'
+
+describe Clever::Models::Section do
+  it 'requires initialization parameters' do
+    expect {Clever::Models::Section.new}.to raise_error(ArgumentError)
+  end
+
+  context "valid values" do
+    id = '4fee004dca2e43cf27000807'
+    district_id = '4fd43cc56d11340000000005'
+    name = 'Advanced Arithmetic 8(A)'
+    grade = '7'
+    school_id = '4fee004cca2e43cf27000003'
+    section_number = '73'
+    sis_id = '1783'
+    subject = 'math'
+    teacher_id = '4fee004dca2e43cf270007f4'
+    last_modified = '2012-06-29T19:22:17.766Z'
+    students = %w(4fee004dca2e43cf2700069f 4fee004dca2e43cf270004ed)
+
+    let(:params) {{
+        :id => id,
+        :name => name,
+        :sis_id => sis_id,
+        :last_modified => last_modified,
+        :district_id => district_id,
+        :school_id => school_id,
+        :section_number => section_number,
+        :subject => subject,
+        :teacher_id => teacher_id,
+        :students => students
+    }}
+
+    subject { Clever::Models::Section.new params }
+
+    its(:id)                      { should == id }
+    its(:name)                    { should == name }
+    its(:sis_id)                  { should == sis_id }
+    its(:last_modified)           { should == last_modified }
+    its(:district_id)             { should == district_id }
+    its(:school_id)               { should == school_id }
+    its(:section_number)          { should == section_number }
+    its(:subject)                 { should == subject }
+    its(:teacher_id)              { should == teacher_id }
+    its(:students)                { should == students }
+  end
+end

data/spec/models/student_spec.rb

@@ -0,0 +1,73 @@
+require 'spec_helper'
+require 'clever/models/student'
+
+describe Clever::Models::Student do
+  it 'requires initialization parameters' do
+    expect {Clever::Models::Student.new}.to raise_error(ArgumentError)
+  end
+
+  context "valid values" do
+    id = '4fee004cca2e43cf27000005'
+    district_id = '4fd43cc56d11340000000005'
+    dob = '12/12/1998'
+    frl_status = 'Y'
+    gender = 'M'
+    grade = '7'
+    hispanic_ethnicity = 'N'
+    race = 'Asian'
+    school_id = '4fee004cca2e43cf27000003'
+    sis_id = '1783'
+    state_id = '2237504'
+    student_number = '24772'
+    location = {
+        :address => '9272 Ratke Haven',
+        :city => 'North Maurinetown',
+        :state => 'AP',
+        :zip => '22505-3577',
+        :lat => '-21.901449509896338',
+        :lon => '114.23126022331417'
+    }
+    name = {
+        :first => 'Constance',
+        :middle => '',
+        :last => 'Roob'
+    }
+    last_modified = '2012-06-29T19:21:50.709Z'
+
+    let(:params) {{
+        :id => id,
+        :name => name,
+        :sis_id => sis_id,
+        :location => location,
+        :last_modified => last_modified,
+        :district_id => district_id,
+        :school_id => school_id,
+        :state_id => state_id,
+        :dob => dob,
+        :frl_status => frl_status,
+        :gender => gender,
+        :grade => grade,
+        :hispanic_ethnicity => hispanic_ethnicity,
+        :race => race,
+        :student_number => student_number
+    }}
+
+    subject { Clever::Models::Student.new params }
+
+    its(:id)                      { should == id }
+    its(:name)                    { should == name }
+    its(:sis_id)                  { should == sis_id }
+    its(:location)                { should == location }
+    its(:last_modified)           { should == last_modified }
+    its(:district_id)             { should == district_id }
+    its(:school_id)               { should == school_id }
+    its(:state_id)                { should == state_id }
+    its(:dob)                     { should == dob }
+    its(:frl_status)              { should == frl_status }
+    its(:gender)                  { should == gender }
+    its(:grade)                   { should == grade }
+    its(:hispanic_ethnicity)      { should == hispanic_ethnicity }
+    its(:race)                    { should == race }
+    its(:student_number)          { should == student_number }
+  end
+end

data/spec/models/teacher_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+require 'clever/models/teacher'
+
+describe Clever::Models::Teacher do
+  it 'requires initialization parameters' do
+    expect { Clever::Models::Teacher.new }.to raise_error(ArgumentError)
+  end
+
+  context "valid values" do
+    district_id = '4fd43cc56d11340000000005',
+    email = 'ashlee@mailinator.com',
+    school_id = '4fee004cca2e43cf27000003',
+    sis_id = '1720',
+    title = 'Orchestrate Visionary Technologies Manager',
+    name = {
+        :first => 'Nadia',
+        :middle => 'H',
+        :last => 'Mitchell'
+    },
+    last_modified = '2012-06-29T19:22:16.552Z',
+    id = '4fee004dca2e43cf270007d5'
+
+    let(:params) {{
+        :id => id,
+        :name => name,
+        :email => email,
+        :title => title,
+        :sis_id => sis_id,
+        :last_modified => last_modified,
+        :school_id => school_id,
+        :district_id => district_id
+    }}
+
+    subject { Clever::Models::Teacher.new params }
+
+    its(:id)                  { should == id }
+    its(:name)                { should == name }
+    its(:email)               { should == email }
+    its(:title)               { should == title }
+    its(:sis_id)              { should == sis_id }
+    its(:last_modified)       { should == last_modified }
+    its(:school_id)           { should == school_id }
+    its(:district_id)         { should == district_id }
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+require 'rubygems'
+require 'spork'
+
+Spork.prefork do
+
+end
+
+Spork.each_run do
+
+end
+
+lib_dir = File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(lib_dir) unless $LOAD_PATH.include?(lib_dir)
+
+require 'clever'
+require 'clever/fake_server'

metadata

@@ -0,0 +1,201 @@
+--- !ruby/object:Gem::Specification
+name: getclever-ruby
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Lexim
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-08-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  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: activesupport
+  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: spork
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.0.rc
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.0.rc
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+- !ruby/object:Gem::Dependency
+  name: terminal-notifier-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'
+description: 
+email:
+- hello@getlexim.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- getclever-ruby.gemspec
+- lib/clever.rb
+- lib/clever/api.rb
+- lib/clever/configuration.rb
+- lib/clever/error.rb
+- lib/clever/fake_response.rb
+- lib/clever/fake_server.rb
+- lib/clever/models/contact.rb
+- lib/clever/models/district.rb
+- lib/clever/models/photo.rb
+- lib/clever/models/school.rb
+- lib/clever/models/section.rb
+- lib/clever/models/student.rb
+- lib/clever/models/teacher.rb
+- lib/clever/version.rb
+- lib/generators/clever/install_generator.rb
+- lib/generators/clever/templates/clever.yml
+- lib/generators/clever/templates/initializer.rb
+- lib/generators/crocodoc.rb
+- spec/api_spec.rb
+- spec/configuration_spec.rb
+- spec/endpoints/districts_spec.rb
+- spec/endpoints/schools_spec.rb
+- spec/endpoints/sections_spec.rb
+- spec/endpoints/students_spec.rb
+- spec/endpoints/teachers_spec.rb
+- spec/error_spec.rb
+- spec/fake_server_spec.rb
+- spec/models/contact_spec.rb
+- spec/models/district_spec.rb
+- spec/models/photo_spec.rb
+- spec/models/school_spec.rb
+- spec/models/section_spec.rb
+- spec/models/student_spec.rb
+- spec/models/teacher_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/lexim/getclever-ruby
+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.24
+signing_key: 
+specification_version: 3
+summary: Ruby library for interacting with the Clever API
+test_files:
+- spec/api_spec.rb
+- spec/configuration_spec.rb
+- spec/endpoints/districts_spec.rb
+- spec/endpoints/schools_spec.rb
+- spec/endpoints/sections_spec.rb
+- spec/endpoints/students_spec.rb
+- spec/endpoints/teachers_spec.rb
+- spec/error_spec.rb
+- spec/fake_server_spec.rb
+- spec/models/contact_spec.rb
+- spec/models/district_spec.rb
+- spec/models/photo_spec.rb
+- spec/models/school_spec.rb
+- spec/models/section_spec.rb
+- spec/models/student_spec.rb
+- spec/models/teacher_spec.rb
+- spec/spec_helper.rb