openagent 0.9.2 → 0.9.3

data/lib/openagent/client.rb

@@ -5,6 +5,7 @@ require "openagent/xml_helpers"
 require "openagent/errors"
 require "openagent/message_builder"
 require "logger"
+require "active_support/hash_with_indifferent_access"
 
 module OpenAgent
   class Client
@@ -28,23 +29,25 @@ module OpenAgent
 
     def initialize(opts={})
       @callbacks    = {
-          :receive_message => [],
-          :each_loop => []
+        :receive_message => [],
+        :each_loop => []
       }
 
+      opts = ActiveSupport::HashWithIndifferentAccess.new(opts)
+
       @name         = opts.delete(:name)
       @url          = opts.delete(:url)
       @pretty_print = opts.has_key?(:pretty_print) ? opts.delete(:pretty_print) : true
 
-      @agent_opts = opts['agent_opts'] || {}
+      @agent_opts = opts[:agent_opts] || {}
       @agent_opts[:name] = @name if @name
 
-      @zone_opts = opts['zone_opts'] || {}
+      @zone_opts = opts[:zone_opts] || {}
       @zone_opts[:uri] = @url if @url
 
-      @log          = Logger.new(opts["log"] || STDOUT, 'daily')
-      @agent        = opts['agent'] || OpenAgent::Agent.new(@agent_opts)
-      @zone         = opts['zone'] || OpenAgent::Zone.new(@zone_opts)
+      @log          = opts[:logger] || Logger.new(opts[:logfile] || STDOUT, 'daily')
+      @agent        = opts[:agent] || OpenAgent::Agent.new(@agent_opts)
+      @zone         = opts[:zone] || OpenAgent::Zone.new(@zone_opts)
 
       @builder      = OpenAgent::MessageBuilder.new(@agent, @zone)
     end
@@ -83,49 +86,33 @@ module OpenAgent
       end
     end
 
-    def run
-      wait_short = 10
-      wait_long = 30
-      loop do
-        begin
-          trigger(:each_loop)
-
-          wait_period = wait_long
-          messages_in_queue = true
-          while messages_in_queue
-            get_message do |message, outgoing, xml|
-              if inner = message.inner_message
-                trigger(:receive_message, message, outgoing, xml)
-
-                if inner.response
-                  case message.status_code
-                  when ZIS_SUCCESS then
-                    if inner.response.more_packets?
-                      wait_period = wait_short
-                    else
-                      wait_period = wait_long
-                    end
-                  when ZIS_NO_MESSAGES then
-                    if not inner.more_packets?
-                      wait_period = wait_long
-                    end
-                  end
-                end
-
-                # We send an Ack for both an Event and a Response
-                if message.status_code == ZIS_SUCCESS
-                  ack(inner.source_id, inner.msg_id)
-                end
-              else
-                if message.status_code == ZIS_NO_MESSAGES
-                  messages_in_queue = false
-                end
-              end
+    def run_once
+      trigger(:each_loop)
+      message = nil
+      begin
+        get_message do |message, outgoing, xml|
+          if inner = message.inner_message
+            trigger(:receive_message, message, outgoing, xml)
+
+            # We send an Ack for both an Event and a Response
+            if message.status_code == ZIS_SUCCESS
+              ack(inner.source_id, inner.msg_id)
             end
           end
+        end
+      end while message && message.status_code == ZIS_SUCCESS
+    end
+
+    def run(wait_period=30)
+      loop do
+        begin
+          run_once
           sleep wait_period
         rescue ResponseError => e
           @log.error e
+        rescue Net::OpenTimeout => e
+          @log.error e
+          sleep(5)
         end
       end
     end
@@ -151,7 +138,7 @@ module OpenAgent
       @zone.send_request(req).tap do |response|
         log "Response", formatted_xml(response.body, @pretty_print)
 
-        if response.body.empty?
+        if response.body.nil? or response.body.empty?
           raise ResponseError, "Response is empty"
         else
           incoming = Message.new

data/lib/openagent/version.rb

@@ -1,3 +1,3 @@
 module OpenAgent
-  VERSION = '0.9.2' unless defined?(OpenAgent::VERSION)
+  VERSION = '0.9.3' unless defined?(OpenAgent::VERSION)
 end

data/lib/sif/representations/infra/common/query.rb

@@ -15,7 +15,7 @@ module SIF
           property :condition_group, :as => 'SIF_ConditionGroup',
                    :class => SIF::Infra::Common::ConditionGroup,
                    :decorator => ConditionGroup,
-                   :if => lambda { !condition_group.empty? }
+                   :if => lambda { !(condition_group || []).empty? }
 
           property :example, :as => 'SIF_Example'
         end

data/spec/client_spec.rb

@@ -1,6 +1,13 @@
 require_relative "spec_helper"
 require "openagent/client"
 
+def stub_rr(request, response)
+  stub_request(:post, "http://localhost:8765/").
+    with(:body => request,
+         :headers => {'Accept'=>'*/*', 'Content-Type'=>'application/xml', 'User-Agent'=>'Ruby'}).
+    to_return(:status => 200, :body => response, :headers => {})
+end
+
 describe OpenAgent::Client do
 
   context "agent options" do
@@ -8,7 +15,16 @@ describe OpenAgent::Client do
     let(:zone)   { OpenAgent::Zone.new(YAML::load(File.read(fixture('zone.yaml')))) }
   end
 
-  subject(:client) { OpenAgent::Client.new( :name => "canvas", :url => "http://localhost:8765" ) }
+  subject(:client) {
+    OpenAgent::Client.new(
+      :name => "canvas",
+      :url => "http://localhost:8765",
+      :logger => Logger.new(EmptyLogger.new)
+    ).tap do |client|
+      client.builder.guuid = "MSG_ID"
+      client.builder.timestamp = "TIMESTAMP"
+    end
+  }
 
   it "initializes" do
     client.name.should == "canvas"
@@ -29,6 +45,26 @@ describe OpenAgent::Client do
     end
   end
 
+  context "run loop" do
+    it "no message exits loop" do
+      client.stub(:get_message) { nil }
+      client.run_once
+    end
+
+    it "ZIS_NO_MESSAGES exits loop" do
+      stub_rr(File.read(fixture("messages/get_message.xml")),
+              File.read(fixture("messages/response.xml")))
+      stub_rr(File.read(fixture("messages/get_message.xml")),
+              File.read(fixture("messages/response_done.xml")))
+      client.run_once
+    end
+
+    it "empty body raises ResponseError" do
+      stub_rr(File.read(fixture("messages/get_message.xml")), "")
+      lambda { client.run_once }.should raise_error(OpenAgent::ResponseError)
+    end
+  end
+
   context "given a response message" do
     let(:message) do
       SIF::Infra::Common::Message.new(

data/spec/fixtures/messages/get_message.xml

@@ -0,0 +1,12 @@
+<SIF_Message xmlns="http://www.sifinfo.org/infrastructure/2.x" Version="2.0r1">
+  <SIF_SystemControl>
+    <SIF_Header>
+      <SIF_MsgId>MSG_ID</SIF_MsgId>
+      <SIF_Timestamp>TIMESTAMP</SIF_Timestamp>
+      <SIF_SourceId>canvas</SIF_SourceId>
+    </SIF_Header>
+    <SIF_SystemControlData>
+      <SIF_GetMessage/>
+    </SIF_SystemControlData>
+  </SIF_SystemControl>
+</SIF_Message>

data/spec/fixtures/messages/response.xml

@@ -28,7 +28,7 @@
                   </SIF_Header>
                   <SIF_RequestMsgId>6B05EF70132C01319D9348E0EB1826A1</SIF_RequestMsgId>
                   <SIF_PacketNumber>209</SIF_PacketNumber>
-                  <SIF_MorePackets>Yes</SIF_MorePackets>
+                  <SIF_MorePackets>No</SIF_MorePackets>
                   <SIF_ObjectData>
                      <StudentPersonal RefId="140A051A0D2B360A1E1F0E251FBA175A">
                         <LocalId>24939</LocalId>

data/spec/fixtures/messages/response_done.xml

@@ -0,0 +1,16 @@
+<?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>9</SIF_Code>
+      </SIF_Status>
+   </SIF_Ack>
+</SIF_Message>

data/spec/spec_helper.rb

@@ -1,7 +1,15 @@
 require "webmock/rspec"
+require "logger"
+require "stringio"
 
 $:.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 
 def fixture(file)
   File.join(File.dirname(__FILE__), 'fixtures', file)
-end
+end
+
+class EmptyLogger < StringIO
+  def write(input)
+    # do nothing
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: openagent
 version: !ruby/object:Gem::Version
-  version: 0.9.2
+  version: 0.9.3
   prerelease: 
 platform: ruby
 authors:
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-10 00:00:00.000000000 Z
+date: 2014-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -379,7 +379,9 @@ files:
 - spec/event_spec.rb
 - spec/fixtures/agent.yaml
 - spec/fixtures/messages/event.xml
+- spec/fixtures/messages/get_message.xml
 - spec/fixtures/messages/response.xml
+- spec/fixtures/messages/response_done.xml
 - spec/fixtures/sif/attendance_code_info.xml
 - spec/fixtures/sif/calendar_date.xml
 - spec/fixtures/sif/calendar_summary.xml
@@ -461,7 +463,9 @@ test_files:
 - spec/event_spec.rb
 - spec/fixtures/agent.yaml
 - spec/fixtures/messages/event.xml
+- spec/fixtures/messages/get_message.xml
 - spec/fixtures/messages/response.xml
+- spec/fixtures/messages/response_done.xml
 - spec/fixtures/sif/attendance_code_info.xml
 - spec/fixtures/sif/calendar_date.xml
 - spec/fixtures/sif/calendar_summary.xml