openagent 0.7.1

data/openagent.gemspec

@@ -0,0 +1,33 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'openagent/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "openagent"
+  gem.summary      = "OpenAgent is a SIF Agent Development Kit"
+  gem.description  = "OpenAgent - SIF ADK (SIF Agent Development Kit)"
+  gem.homepage     = "http://github.com/cwhiteley/openagent"
+  gem.authors      = ['Christopher Whiteley', 'Duane Johnson', 'Eric Adams']
+  gem.email        = ['hello@openzis.org', 'duane@instructure.com', 'eadams@instructure.com']
+
+  gem.files = %w[openagent.gemspec README.md]
+  gem.files += Dir.glob("lib/**/*.rb")
+  gem.files += Dir.glob("spec/**/*")
+
+  gem.test_files    = Dir.glob("spec/**/*")
+  gem.require_paths = ["lib"]
+  gem.version       = OpenAgent::VERSION
+  gem.required_ruby_version = '>= 1.9.0'
+
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "webmock"
+  gem.add_development_dependency "bundler", ">= 1.0.0"
+  gem.add_development_dependency "rspec", "~> 2.6"
+  gem.add_development_dependency "debugger"
+  gem.add_development_dependency "pry"
+
+  gem.add_dependency "uuid"
+  gem.add_dependency "representable", "~> 1.7.2"
+  gem.add_dependency "virtus", "~> 1.0.0"
+end

data/spec/agent_spec.rb

@@ -0,0 +1,32 @@
+require_relative "spec_helper"
+require "openagent/agent"
+require "yaml"
+
+describe OpenAgent::Agent do
+  context "new object" do
+    let(:agent) { OpenAgent::Agent.new(:name => "SOURCEID") }
+
+    it "sets instance variables from config" do
+      agent.name.should == "SOURCEID"
+    end
+
+    it ":version has a default value" do
+      agent.version.should == "2.0r1"
+    end
+
+    it ":source_id uses :name as default value" do
+      agent.source_id.should == "SOURCEID"
+      agent.source_id.should == agent.name
+    end
+  end
+
+  context "object from yaml" do
+    let(:agent) { OpenAgent::Agent.new(YAML.load(File.read(fixture("agent.yaml")))) }
+
+    it "sets instance variables from yaml file" do
+      agent.source_id.should == "canvas"
+      agent.instance_variable_get("@source_id").should == "canvas"
+      agent.name.should == "Canvas by Instructure"
+    end
+  end
+end

data/spec/client_spec.rb

@@ -0,0 +1,96 @@
+require_relative "spec_helper"
+require "openagent/client"
+
+describe OpenAgent::Client do
+
+  context "agent options" do
+    let(:agent)  { OpenAgent::Agent.new(YAML::load(File.read(fixture('agent.yaml')))) }
+    let(:zone)   { OpenAgent::Zone.new(YAML::load(File.read(fixture('zone.yaml')))) }
+  end
+
+  subject(:client) { OpenAgent::Client.new( :name => "canvas", :url => "http://localhost:8765" ) }
+
+  it "initializes" do
+    client.name.should == "canvas"
+    client.url.should == "http://localhost:8765"
+  end
+
+  it "initializes the agent" do
+    client.agent.tap do |a|
+      a.name.should == "canvas"
+      a.source_id.should == "canvas"
+      a.msg_version.should == "2.0r1"
+    end
+  end
+
+  it "initializes the zone" do
+    client.zone.tap do |z|
+      z.url.host.should == "localhost"
+    end
+  end
+
+  context "given a response message" do
+    let(:message) do
+      SIF::Infra::Common::Message.new(
+        :ack => SIF::Infra::Message::Ack.new(
+          :header => SIF::Infra::Common::Header.new(
+            :msg_id => "D72C57",
+            :timestamp => "2013-10-09T10:42:16-06:00",
+            :source_id => "canvas"
+          ),
+          :original_source_id => "canvas",
+          :original_msg_id => "088E68",
+          :status => SIF::Infra::Common::Status.new(
+            :code => 0
+          )
+        )
+      )
+    end
+
+    it "checks for errors" do
+      lambda { client.send(:check_for_errors, message) }.should_not \
+        raise_error
+    end
+
+    it "raises error on status code" do
+      message.ack.status.code = 7
+      lambda { client.send(:check_for_errors, message) }.should \
+        raise_error(OpenAgent::SIFCodeError)
+    end
+
+    it "raises error if SIF_Error present" do
+      message.ack.error = SIF::Infra::Common::Error.new(
+        :category => 0,
+        :code => 1,
+        :desc => "Unknown SIF_Error error"
+      )
+      lambda { client.send(:check_for_errors, message) }.should \
+        raise_error(OpenAgent::SIFError)
+    end
+  end
+
+  # it "acks" do
+  #   stub_request(:post, "http://localhost:8765/").
+  #        with(:body => "<SIF_Message xmlns=\"http://www.sifinfo.org/infrastructure/2.x\" Version=\"2.0r1\">\n  <SIF_Ack>\n    <SIF_OriginalSourceId>ORIG_SRC_ID</SIF_OriginalSourceId>\n    <SIF_OriginalMsgId>ORIG_MSG_ID</SIF_OriginalMsgId>\n    <SIF_Header>\n      <SIF_MsgId>MSG_ID</SIF_MsgId>\n      <SIF_Timestamp>TIMESTAMP</SIF_Timestamp>\n      <SIF_SourceId>canvas</SIF_SourceId>\n    </SIF_Header>\n    <SIF_Status>\n      <SIF_Code>1</SIF_Code>\n    </SIF_Status>\n  </SIF_Ack>\n</SIF_Message>",
+  #             :headers => {'Accept'=>'*/*', 'Content-Type'=>'application/xml', 'User-Agent'=>'Ruby'}).
+  #        to_return(:status => 200, :body => "", :headers => {})
+
+  #   client.builder.guuid = "MSG_ID"
+  #   client.builder.timestamp = "TIMESTAMP"
+  #   client.ack("ORIG_SRC_ID", "ORIG_MSG_ID") do |*args|
+  #     p args
+  #   end
+  #   # xml.should == "<SIF_Message Version=\"2.0r1\" xmlns=\"http://www.sifinfo.org/infrastructure/2.x\">\n  <SIF_Register>\n    <SIF_Header>\n      <SIF_MsgId>DD39ED00127F01313D6F14109FD501C1</SIF_MsgId>\n      <SIF_Timestamp>2013-10-08T13:43:44</SIF_Timestamp>\n      <SIF_SourceId>TEST_SOURCEID</SIF_SourceId>\n    </SIF_Header>\n    <SIF_Name>TEST_SIF_NAME</SIF_Name>\n    <SIF_Version>2.0r1</SIF_Version>\n    <SIF_MaxBufferSize>64000</SIF_MaxBufferSize>\n    <SIF_Mode>Pull</SIF_Mode>\n  </SIF_Register>\n</SIF_Message>"
+  # end
+
+  # it "sends a request" do
+  #   sif.guuid = "DD39ED00127F01313D6F14109FD501C1"
+  #   sif.timestamp = "2013-10-08T13:43:44"
+  #   xml, i = activity.create_xml('register')
+  #   stub_request(:post, "http://test.zone.url/zone").
+  #     with(:body => "<SIF_Message Version=\"2.0r1\" xmlns=\"http://www.sifinfo.org/infrastructure/2.x\">\n  <SIF_Register>\n    <SIF_Header>\n      <SIF_MsgId>DD39ED00127F01313D6F14109FD501C1</SIF_MsgId>\n      <SIF_Timestamp>2013-10-08T13:43:44</SIF_Timestamp>\n      <SIF_SourceId>TEST_SOURCEID</SIF_SourceId>\n    </SIF_Header>\n    <SIF_Name>TEST_SIF_NAME</SIF_Name>\n    <SIF_Version>2.0r1</SIF_Version>\n    <SIF_MaxBufferSize>64000</SIF_MaxBufferSize>\n    <SIF_Mode>Pull</SIF_Mode>\n  </SIF_Register>\n</SIF_Message>",
+  #          :headers => {'Accept'=>'*/*', 'Content-Type'=>'application/xml', 'User-Agent'=>'Ruby'}).
+  #     to_return(:status => 200, :body => "", :headers => {})
+  #   response = zone.send_message(xml)
+  # end
+end

data/spec/fixtures/agent.yaml

@@ -0,0 +1,31 @@
+---
+source_id: canvas
+name: Canvas by Instructure
+version: 2.0r1
+max_buffer_size: 64000
+mode: Pull
+msg_version: 2.0r1
+msg_xmlns: http://www.sifinfo.org/infrastructure/2.x
+provide:
+subscribe:
+- LEAInfo
+- SchoolInfo
+- TermInfo
+- SchoolCourseInfo
+- SectionInfo
+- StudentPersonal
+- StaffPersonal
+- StudentSectionInfo
+publish_add:
+publish_change:
+publish_delete:
+request:
+- LEAInfo
+- SchoolInfo
+- TermInfo
+- SchoolCourseInfo
+- SectionInfo
+- StudentPersonal
+- StaffPersonal
+- StudentSectionInfo
+respond:

data/spec/fixtures/messages/event.xml

@@ -0,0 +1,72 @@
+<SIF_Message xmlns="http://www.sifinfo.org/infrastructure/2.x" Version="2.0r1">
+  <SIF_Ack>
+    <SIF_Header>
+      <SIF_MsgId>44353D742D7F42F6A5AEEDCF4F661710</SIF_MsgId>
+      <SIF_Timestamp>2013-10-08T13:19:15-06:00</SIF_Timestamp>
+      <SIF_SourceId>canvas</SIF_SourceId>
+    </SIF_Header>
+    <SIF_OriginalSourceId>canvas</SIF_OriginalSourceId>
+    <SIF_OriginalMsgId>CBAEC920127C01319D7D48E0EB1826A1</SIF_OriginalMsgId>
+    <SIF_Status>
+      <SIF_Code>0</SIF_Code>
+      <SIF_Data>
+        <SIF_Message Version="2.0r1" xmlns="http://www.sifinfo.org/infrastructure/2.x">
+          <SIF_Event>
+            <SIF_Header>
+              <SIF_MsgId>1BD67F9593DC4867AD8A341F0EC7886C</SIF_MsgId>
+              <SIF_Timestamp>2013-10-08T11:36:06-06:00</SIF_Timestamp>
+              <SIF_SourceId>test</SIF_SourceId>
+              <SIF_DestinationId>canvas</SIF_DestinationId>
+            </SIF_Header>
+            <SIF_ObjectData>
+              <SIF_EventObject Action="Add" ObjectName="StudentPersonal">
+                <StudentPersonal RefId="D3E34B359D75101A8C3D00AA001A1652">
+                  <AlertMessages>
+                    <AlertMessage Type="Legal">This is the Legal Alert for Joe Student</AlertMessage>
+                  </AlertMessages>
+                  <LocalId>P00001</LocalId>
+                  <StateProvinceId>WB0025</StateProvinceId>
+                  <ElectronicIdList>
+                    <ElectronicId Type="Barcode">206654</ElectronicId>
+                  </ElectronicIdList>
+                  <Name Type="04">
+                    <LastName>Student</LastName>
+                    <FirstName>Joe</FirstName>
+                    <MiddleName/>
+                    <PreferredName>Joe</PreferredName>
+                  </Name>
+                  <Demographics>
+                    <Gender>M</Gender>
+                  </Demographics>
+                  <AddressList>
+                    <Address Type="0123">
+                      <Street>
+                        <Line1>6799 33rd Ave.</Line1>
+                        <StreetNumber>6799</StreetNumber>
+                        <StreetName>33rd</StreetName>
+                        <StreetType>Ave.</StreetType>
+                      </Street>
+                      <City>Chicago</City>
+                      <StateProvince>IL</StateProvince>
+                      <Country>US</Country>
+                      <PostalCode>60660</PostalCode>
+                    </Address>
+                  </AddressList>
+                  <PhoneNumberList>
+                    <PhoneNumber Type="0096">
+                      <Number>(312) 555-1234</Number>
+                    </PhoneNumber>
+                  </PhoneNumberList>
+                  <EmailList>
+                    <Email Type="Primary">Joe.Student@anyschool.com</Email>
+                  </EmailList>
+                  <OnTimeGraduationYear>2007</OnTimeGraduationYear>
+                </StudentPersonal>
+              </SIF_EventObject>
+            </SIF_ObjectData>
+          </SIF_Event>
+        </SIF_Message>
+      </SIF_Data>
+    </SIF_Status>
+  </SIF_Ack>
+</SIF_Message>

data/spec/fixtures/messages/response.xml

@@ -0,0 +1,107 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+
+<SIF_Message xmlns="http://www.sifinfo.org/infrastructure/2.x" Version="2.0r1">
+   <SIF_Ack>
+      <SIF_Header>
+         <SIF_MsgId>D72C57D4EE0D4E0AB68BD2393B12E51D</SIF_MsgId>
+         <SIF_Timestamp>2013-10-09T10:42:16-06:00</SIF_Timestamp>
+         <SIF_SourceId>canvas</SIF_SourceId>
+      </SIF_Header>
+      <SIF_OriginalSourceId>canvas</SIF_OriginalSourceId>
+      <SIF_OriginalMsgId>088E6810133001313D9314109FD501C1</SIF_OriginalMsgId>
+      <SIF_Status>
+         <SIF_Code>0</SIF_Code>
+         <SIF_Data>
+            <SIF_Message xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" Version="2.0r1">
+               <SIF_Response>
+                  <SIF_Header>
+                     <SIF_MsgId>026340A188BA4EAF97C0D42E37F1302C</SIF_MsgId>
+                     <SIF_Timestamp>2013-10-09T10:19:20-06:00</SIF_Timestamp>
+                     <SIF_Security>
+                        <SIF_SecureChannel>
+                           <SIF_AuthenticationLevel>0</SIF_AuthenticationLevel>
+                           <SIF_EncryptionLevel>0</SIF_EncryptionLevel>
+                        </SIF_SecureChannel>
+                     </SIF_Security>
+                     <SIF_SourceId>PowerSchool</SIF_SourceId>
+                     <SIF_DestinationId>canvas</SIF_DestinationId>
+                  </SIF_Header>
+                  <SIF_RequestMsgId>6B05EF70132C01319D9348E0EB1826A1</SIF_RequestMsgId>
+                  <SIF_PacketNumber>209</SIF_PacketNumber>
+                  <SIF_MorePackets>Yes</SIF_MorePackets>
+                  <SIF_ObjectData>
+                     <StudentPersonal RefId="140A051A0D2B360A1E1F0E251FBA175A">
+                        <LocalId>24939</LocalId>
+                        <StateProvinceId>1877331</StateProvinceId>
+                        <OtherIdList>
+                           <OtherId Type="9999">SCHOOL:304</OtherId>
+                        </OtherIdList>
+                        <Name Type="04">
+                           <LastName>Ellis</LastName>
+                           <FirstName>Karl</FirstName>
+                           <MiddleName>E</MiddleName>
+                           <FullName>Ellis, Karl E</FullName>
+                        </Name>
+                        <Demographics>
+                           <RaceList>
+                              <Race>
+                                 <Code>1002</Code>
+                                 <OtherCodeList>
+                                    <OtherCode Codeset="Local">C</OtherCode>
+                                 </OtherCodeList>
+                              </Race>
+                           </RaceList>
+                           <HispanicLatino>No</HispanicLatino>
+                           <Gender>M</Gender>
+                           <BirthDate>1997-08-02</BirthDate>
+                        </Demographics>
+                        <AddressList>
+                           <Address Type="0765">
+                              <Street>
+                                 <Line1>123 Love Ln</Line1>
+                              </Street>
+                              <City>Ruraltown</City>
+                              <StateProvince>UT</StateProvince>
+                              <Country>US</Country>
+                              <PostalCode>84612</PostalCode>
+                           </Address>
+                           <Address Type="0123">
+                              <Street>
+                                 <Line1>123 Love Ln</Line1>
+                              </Street>
+                              <City>Ruraltown</City>
+                              <StateProvince>UT</StateProvince>
+                              <Country>US</Country>
+                              <PostalCode>84612</PostalCode>
+                           </Address>
+                        </AddressList>
+                        <PhoneNumberList>
+                           <PhoneNumber Type="0096">
+                              <Number>801-123-1234</Number>
+                           </PhoneNumber>
+                           <PhoneNumber Type="0350">
+                              <Number>858-123-5678</Number>
+                           </PhoneNumber>
+                        </PhoneNumberList>
+                        <EmailList>
+                           <Email Type="Primary">karl@gmail.com,karlsdad@gmail.com</Email>
+                        </EmailList>
+                        <ProjectedGraduationYear>2017</ProjectedGraduationYear>
+                        <OnTimeGraduationYear>2017</OnTimeGraduationYear>
+                        <MostRecent>
+                           <SchoolLocalId>304</SchoolLocalId>
+                           <GradeLevel>
+                              <Code>09</Code>
+                           </GradeLevel>
+                        </MostRecent>
+                        <SIF_ExtendedElements>
+                           <SIF_ExtendedElement Name="StudentEthnicity">1002</SIF_ExtendedElement>
+                        </SIF_ExtendedElements>
+                     </StudentPersonal>
+                  </SIF_ObjectData>
+               </SIF_Response>
+            </SIF_Message>
+         </SIF_Data>
+      </SIF_Status>
+   </SIF_Ack>
+</SIF_Message>

data/spec/fixtures/sif/attendance_code_info.xml

@@ -0,0 +1,9 @@
+<AttendanceCodeInfo RefId="64A309DA063A2E35B359D75101A8C3D0" SchoolInfoRefId="CE0674A8BB8247669DE348F113D2316A">
+  <AttendanceCode>AE</AttendanceCode>
+  <AttendanceType>Absent</AttendanceType>
+  <AttendanceStatus>Excused</AttendanceStatus>
+  <Description>Child is absent with appropriate, legal excuse.</Description>
+  <AbsenceValue>1.0</AbsenceValue>
+  <UsedForDailyAttendance>Yes</UsedForDailyAttendance>
+  <UsedForPeriodAttendance>Yes</UsedForPeriodAttendance>
+</AttendanceCodeInfo>

data/spec/fixtures/sif/calendar_date.xml

@@ -0,0 +1,22 @@
+<CalendarDate Date="2007-08-31" CalendarSummaryRefId="B5739375800AC4CC63850BB2754114AA" SchoolInfoRefId="B7A34E561C97345C0A4E11BB112B2753" SchoolYear="2007">
+  <CalendarDateType>
+    <Code>0845</Code>
+    <OtherCodeList>
+      <OtherCode Codeset="StateProvince">20</OtherCode>
+      <OtherCode Codeset="Local">10</OtherCode>
+    </OtherCodeList>
+  </CalendarDateType>
+  <CalendarDateNumber>1</CalendarDateNumber>
+  <StudentAttendance>
+    <CountsTowardAttendance>No</CountsTowardAttendance>
+    <AttendanceValue>0.0</AttendanceValue>
+  </StudentAttendance>
+  <TeacherAttendance>
+    <CountsTowardAttendance>Yes</CountsTowardAttendance>
+    <AttendanceValue>1.0</AttendanceValue>
+  </TeacherAttendance>
+  <AdministratorAttendance>
+    <CountsTowardAttendance>Yes</CountsTowardAttendance>
+    <AttendanceValue>1.0</AttendanceValue>
+  </AdministratorAttendance>
+</CalendarDate>

data/spec/fixtures/sif/calendar_summary.xml

@@ -0,0 +1,21 @@
+<CalendarSummary RefId="B5739375800AC4CC63850BB2754114AA" SchoolInfoRefId="B7A34E561C97345C0A4E11BB112B2753" SchoolYear="2005">
+  <LocalId>123321A</LocalId>
+  <Description>Elementary School Calendar</Description>
+  <DaysInSession>180</DaysInSession>
+  <FirstInstructionDate>2006-09-05</FirstInstructionDate>
+  <LastInstructionDate>2007-06-10</LastInstructionDate>
+  <GraduationDate>2007-06-11</GraduationDate>
+  <InstructionalMinutes>64800</InstructionalMinutes>
+  <MinutesPerDay>360</MinutesPerDay>
+  <GradeLevels>
+    <GradeLevel>
+      <Code>03</Code>
+    </GradeLevel>
+    <GradeLevel>
+      <Code>04</Code>
+    </GradeLevel>
+    <GradeLevel>
+      <Code>05</Code>
+    </GradeLevel>
+  </GradeLevels>
+</CalendarSummary>

data/spec/fixtures/sif/demographics.xml

@@ -0,0 +1,33 @@
+<Demographics>
+  <RaceList>
+    <Race>
+      <Code>1002</Code>
+    </Race>
+  </RaceList>
+  <Gender>M</Gender>
+  <BirthDate>1990-09-26</BirthDate>
+  <BirthDateVerification>1004</BirthDateVerification>
+  <PlaceOfBirth>Miami</PlaceOfBirth>
+  <CountyOfBirth>Dade</CountyOfBirth>
+  <StateOfBirth>FL</StateOfBirth>
+  <CountryOfBirth>US</CountryOfBirth>
+  <CountriesOfCitizenship>
+    <CountryOfCitizenship>US</CountryOfCitizenship>
+  </CountriesOfCitizenship>
+  <CountriesOfResidency>
+    <CountryOfResidency>US</CountryOfResidency>
+  </CountriesOfResidency>
+  <CitizenshipStatus>1017</CitizenshipStatus>
+  <EnglishProficiency>
+    <Code>1633</Code>
+  </EnglishProficiency>
+  <LanguageList>
+    <Language>
+      <Code>eng</Code>
+    </Language>
+  </LanguageList>
+  <DwellingArrangement>
+    <Code>1674</Code>
+  </DwellingArrangement>
+  <MaritalStatus>1042</MaritalStatus>
+</Demographics>