getclever-ruby 0.0.1

data/lib/clever/models/contact.rb

@@ -0,0 +1,7 @@
+class Clever::Models::Contact
+  attr_accessor :id, :email, :name, :phone, :phone_type, :type, :student_id
+
+  def initialize params
+    params.each { |k,v| instance_variable_set("@#{k}", v) unless v.nil? }
+  end
+end

data/lib/clever/models/district.rb

@@ -0,0 +1,7 @@
+class Clever::Models::District
+  attr_accessor :id, :name
+
+  def initialize params
+    params.each { |k,v| instance_variable_set("@#{k}", v) unless v.nil? }
+  end
+end

data/lib/clever/models/photo.rb

@@ -0,0 +1,7 @@
+class Clever::Models::Photo
+  attr_accessor :id, :data
+
+  def initialize params
+    params.each { |k,v| instance_variable_set("@#{k}", v) unless v.nil? }
+  end
+end

data/lib/clever/models/school.rb

@@ -0,0 +1,7 @@
+class Clever::Models::School
+  attr_accessor :id, :high_grade, :low_grade, :name, :nces_id, :phone, :school_number, :sis_id, :location, :principal, :last_modified
+
+  def initialize params
+    params.each { |k,v| instance_variable_set("@#{k}", v) unless v.nil? }
+  end
+end

data/lib/clever/models/section.rb

@@ -0,0 +1,7 @@
+class Clever::Models::Section
+  attr_accessor :id, :grade, :name, :school_id, :sis_id, :section_number, :subject, :students, :teacher_id, :school_id, :district_id, :last_modified
+
+  def initialize params
+    params.each { |k,v| instance_variable_set("@#{k}", v) unless v.nil? }
+  end
+end

data/lib/clever/models/student.rb

@@ -0,0 +1,7 @@
+class Clever::Models::Student
+  attr_accessor :id, :name, :dob, :frl_status, :gender, :grade, :hispanic_ethnicity, :race, :school_id, :sis_id, :state_id, :student_number, :location, :name, :district_id, :last_modified
+
+  def initialize params
+    params.each { |k,v| instance_variable_set("@#{k}", v) unless v.nil? }
+  end
+end

data/lib/clever/models/teacher.rb

@@ -0,0 +1,7 @@
+class Clever::Models::Teacher
+  attr_accessor :id, :email, :name, :title, :sis_id, :last_modified, :school_id, :district_id
+
+  def initialize params
+    params.each { |k,v| instance_variable_set("@#{k}", v) unless v.nil? }
+  end
+end

data/lib/clever/version.rb

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

data/lib/generators/clever/install_generator.rb

@@ -0,0 +1,24 @@
+module Clever
+  module Generators
+    class InstallGenerator < ::Rails::Generators::Base
+      class_option :api_key, :type => :string, :banner => 'Your Clever API key', :required => true
+
+      def create_config_file
+        template 'clever.yml', File.join('config', 'clever.yml')
+      end
+
+      def create_initializer
+        template 'initializer.rb', File.join('config', 'initializers', 'clever.rb')
+      end
+
+      desc <<DESC
+Description:
+    Copies Clever configuration file to your application's initializer directory.
+DESC
+
+      def self.source_root
+        @source_root ||= File.expand_path(File.join(File.dirname(__FILE__), 'templates'))
+      end
+    end
+  end
+end

data/lib/generators/clever/templates/clever.yml

@@ -0,0 +1,8 @@
+development:
+  token: '<%= options[:api_key] %>'
+
+test:
+  token: '<%= options[:api_key] %>'
+
+production:
+  token: '<%= options[:api_key] %>'

data/lib/generators/clever/templates/initializer.rb

@@ -0,0 +1,3 @@
+Clever.configure do |config|
+  config.api_key = YAML.load_file(Rails.root.join("config/clever.yml"))[Rails.env]['token']
+end

data/lib/generators/crocodoc.rb

@@ -0,0 +1,11 @@
+require 'rails/generators/named_base'
+
+module Clever
+  module Generators
+    class Base < ::Rails::Generators::NamedBase
+      def self.source_root
+        @_rspec_source_root ||= File.expand_path(File.join(File.dirname(__FILE__), 'clever', generator_name, 'templates'))
+      end
+    end
+  end
+end

data/spec/configuration_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe 'configuration' do
+  it 'should accept an api_key and save it' do
+    Clever.configure do |config|
+      config.api_key = 'test1234'
+    end
+
+    Clever.config.api_key.should eq('test1234')
+  end
+end

data/spec/endpoints/districts_spec.rb

@@ -0,0 +1,86 @@
+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 districts" do
+    districts = @api.districts
+
+    districts.should.respond_to? :data
+
+    # exclude paging tests if no paging data found (accommodate live server tests rather than stubbed tests)
+    unless districts[:paging].nil?
+      districts[:paging][:current].should eq(1)
+      districts[:paging][:total].should eq(1)
+      districts[:paging][:count].should eq(1)
+    end
+
+    districts[:data][0].id.should eq('4fd43cc56d11340000000005')
+    districts[:data][0].name.should eq('Demo District')
+  end
+
+  it "can get a specific district" do
+    district = @api.district('4fd43cc56d11340000000005')
+
+    district.name.should eq('Demo District')
+  end
+
+  it "can get a list of schools for a given district" do
+    schools = @api.district_schools('4fd43cc56d11340000000005')
+
+    schools[:data].length.should eq(4)
+    schools[:data][0].name.should eq('Clever Academy')
+  end
+
+  it "can get a list of teachers for a given district" do
+    teachers = @api.district_teachers('4fd43cc56d11340000000005', {:limit => 10})
+
+    # exclude paging tests if no paging data found (accommodate live server tests rather than stubbed tests)
+    unless teachers[:paging].nil?
+      teachers[:paging][:current].should eq(1)
+      teachers[:paging][:total].should eq(5)
+      teachers[:paging][:count].should eq(50)
+    end
+
+    teachers[:data].length.should eq(10)
+
+    teachers[:data][0].id.should eq('4fee004dca2e43cf270007d5')
+    teachers[:data][0].email.should eq('ashlee@mailinator.com')
+  end
+
+  it "can get a list of students for a given district" do
+    students = @api.district_students('4fd43cc56d11340000000005', {:limit => 5})
+
+    unless students[:paging].nil?
+      students[:paging][:current].should eq(1)
+      students[:paging][:total].should eq(200)
+      students[:paging][:count].should eq(1000)
+    end
+
+    students[:data].length.should eq(5)
+    students[:data][0].id.should eq('4fee004cca2e43cf27000005')
+    students[:data][0].name['first'].should eq('Constance')
+  end
+
+  it "can get a list of sections for a given district" do
+    sections = @api.district_sections('4fd43cc56d11340000000005', {:limit => 2})
+
+    unless sections[:paging].nil?
+      sections[:paging][:current].should eq(1)
+      sections[:paging][:total].should eq(37)
+      sections[:paging][:count].should eq(73)
+    end
+
+    sections[:data].length.should eq(2)
+    sections[:data][0].id.should eq('4fee004dca2e43cf27000807')
+    sections[:data][0].name.should eq('Advanced Arithmetic 8(A)')
+  end
+end

data/spec/endpoints/schools_spec.rb

@@ -0,0 +1,88 @@
+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 schools" do
+    schools = @api.schools({:limit => 2})
+
+    schools.should.respond_to?(:data)
+
+    # exclude paging tests if no paging data found (accommodate live server tests rather than stubbed tests)
+    unless schools[:paging].nil?
+      schools[:paging][:current].should eq(1)
+      schools[:paging][:total].should eq(2)
+      schools[:paging][:count].should eq(4)
+    end
+
+    schools[:data].length.should eq(2)
+
+    schools[:data][0].id.should eq('4fee004cca2e43cf27000001')
+    schools[:data][0].name.should eq('Clever Academy')
+  end
+
+  it "can get a specific school" do
+    school = @api.school('4fee004cca2e43cf27000001')
+
+    school.name.should eq('Clever Academy')
+  end
+
+  it "can get a list of teachers for a given school" do
+    teachers = @api.school_teachers('4fee004cca2e43cf27000001', {:limit => 10})
+
+    # exclude paging tests if no paging data found (accommodate live server tests rather than stubbed tests)
+    unless teachers[:paging].nil?
+      teachers[:paging][:current].should eq(1)
+      teachers[:paging][:total].should eq(2)
+      teachers[:paging][:count].should eq(12)
+    end
+
+    teachers[:data].length.should eq(10)
+
+    teachers[:data][0].id.should eq('4fee004dca2e43cf270007d8')
+    teachers[:data][0].email.should eq('adaline_kunze@mailinator.com')
+  end
+
+  it "can get a list of students for a given school" do
+    students = @api.school_students('4fee004cca2e43cf27000001', {:limit => 4})
+
+    unless students[:paging].nil?
+      students[:paging][:current].should eq(1)
+      students[:paging][:total].should eq(60)
+      students[:paging][:count].should eq(239)
+    end
+
+    students[:data].length.should eq(4)
+    students[:data][0].id.should eq('4fee004cca2e43cf27000013')
+    students[:data][0].name['first'].should eq('Jacinthe')
+  end
+
+  it "can get a list of sections for a given school" do
+    sections = @api.school_sections('4fee004cca2e43cf27000001', {:limit => 2})
+
+    unless sections[:paging].nil?
+      sections[:paging][:current].should eq(1)
+      sections[:paging][:total].should eq(9)
+      sections[:paging][:count].should eq(17)
+    end
+
+    sections[:data].length.should eq(2)
+    sections[:data][0].id.should eq('4fee004dca2e43cf27000808')
+    sections[:data][0].name.should eq('Planetary Chemistry 5(B)')
+  end
+
+  it "can get the school's district" do
+    district = @api.school_district('4fee004cca2e43cf27000001')
+
+    district.name.should eq('Demo District')
+    district.id.should eq('4fd43cc56d11340000000005')
+  end
+end

data/spec/endpoints/sections_spec.rb

@@ -0,0 +1,74 @@
+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 sections" do
+    sections = @api.sections
+
+    sections.should.respond_to? :data
+
+    # exclude paging tests if no paging data found (accommodate live server tests rather than stubbed tests)
+    unless sections[:paging].nil?
+      sections[:paging][:current].should eq(1)
+      sections[:paging][:total].should eq(15)
+      sections[:paging][:count].should eq(73)
+    end
+
+    sections[:data][0].id.should eq('4fee004dca2e43cf27000807')
+    sections[:data][0].name.should eq('Advanced Arithmetic 8(A)')
+  end
+
+  it "can get a specific section" do
+    section = @api.section('4fee004dca2e43cf27000807')
+
+    section.id.should eq('4fee004dca2e43cf27000807')
+    section.name.should eq('Advanced Arithmetic 8(A)')
+  end
+
+  it "can get a school for a given section" do
+    school = @api.section_school('4fee004dca2e43cf27000807')
+
+    school.name.should eq('Clever Memorial High')
+  end
+
+  it "can get a district for a given section" do
+    district = @api.section_district('4fee004dca2e43cf27000807')
+
+    district.name.should eq('Demo District')
+    district.id.should eq('4fd43cc56d11340000000005')
+  end
+
+  it "can get a list of students for a given section" do
+    students = @api.section_students('4fee004dca2e43cf27000807', {:limit => 4})
+
+    unless students[:paging].nil?
+      students[:paging][:current].should eq(1)
+      students[:paging][:total].should eq(6)
+      students[:paging][:count].should eq(22)
+    end
+
+    students[:data].length.should eq(4)
+    students[:data][0].id.should eq('4fee004cca2e43cf27000043')
+    students[:data][0].name['first'].should eq('Mertie')
+    students[:data][0].name['m'].should eq(nil)
+    students[:data][0].name['last'].should eq('Volkman')
+  end
+
+  it "can get a teacher for a given section" do
+    teacher = @api.section_teacher('4fee004dca2e43cf27000807')
+
+    teacher.id.should eq('4fee004dca2e43cf270007f4')
+    teacher.name['first'].should eq('Estevan')
+    teacher.name['middle'].should eq('N')
+    teacher.name['last'].should eq('Braun')
+  end
+end

data/spec/endpoints/students_spec.rb

@@ -0,0 +1,100 @@
+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 students" do
+    students = @api.students({:limit => 5})
+
+    unless students[:paging].nil?
+      students[:paging][:current].should eq(1)
+      students[:paging][:total].should eq(200)
+      students[:paging][:count].should eq(1000)
+    end
+
+    students[:data].length.should be(5)
+
+    students[:data][0].id.should eq('4fee004cca2e43cf27000005')
+    students[:data][0].name['first'].should eq('Constance')
+    students[:data][0].name['middle'].should eq('')
+    students[:data][0].name['last'].should eq('Roob')
+  end
+
+  it "can get a specific student" do
+    student = @api.student('4fee004cca2e43cf27000005')
+
+    student.id.should eq('4fee004cca2e43cf27000005')
+    student.name['first'].should eq('Constance')
+    student.name['middle'].should eq('')
+    student.name['last'].should eq('Roob')
+  end
+
+  it "can get a list of sections for a given student" do
+    sections = @api.student_sections('4fee004cca2e43cf27000005', {:limit => 2})
+
+    unless sections[:paging].nil?
+      sections[:paging][:current].should eq(1)
+      sections[:paging][:total].should eq(2)
+      sections[:paging][:count].should eq(4)
+    end
+
+    sections[:data].length.should eq(2)
+
+    sections[:data][0].id.should eq('4fee004dca2e43cf27000818')
+    sections[:data][0].name.should eq('Planetary Chemistry 1(B)')
+  end
+
+  it "can get a school for a given student" do
+    school = @api.student_school('4fee004cca2e43cf27000005')
+
+    school.id.should eq('4fee004cca2e43cf27000003')
+    school.name.should eq('Clever High School')
+  end
+
+  it "can get a district for a given student" do
+    district = @api.student_district('4fee004cca2e43cf27000005')
+
+    district.id.should eq('4fd43cc56d11340000000005')
+    district.name.should eq('Demo District')
+  end
+
+  it "can get a list of teachers for a given student" do
+    teachers = @api.student_teachers('4fee004cca2e43cf27000005', {:limit => 2})
+
+    unless teachers[:paging].nil?
+      teachers[:paging][:current].should eq(1)
+      teachers[:paging][:total].should eq(2)
+      teachers[:paging][:count].should eq(4)
+    end
+
+    teachers[:data].length.should eq(2)
+
+    teachers[:data][0].id.should eq('4fee004dca2e43cf270007d9')
+    teachers[:data][0].name['first'].should eq('Bridget')
+    teachers[:data][0].name['middle'].should eq('B')
+    teachers[:data][0].name['last'].should eq('Kulas')
+  end
+
+  it "can get a list of contacts for a given student" do
+    contacts = @api.student_contacts('4fee004cca2e43cf27000005', {:limit => 2})
+
+    contacts[:data].length.should eq(6)
+    contacts[:data][0].email.should eq('Samanta.Schaefer@mailinator.com')
+    contacts[:data][0].type.should eq('guardian')
+
+  end
+
+  it "can get a photo for a given student" do
+    photo = @api.student_photo('4fee004cca2e43cf27000005')
+
+    photo.id.should eq('4fee004cca2e43cf27000006')
+  end
+end