relax 0.0.2 → 0.0.3

data/lib/relax/response.rb

@@ -11,50 +11,65 @@ module Relax
   # stores an XML document, and provides access to it through methods like
   # #element and #attribute.
   class Response
+    attr_accessor :raw
     attr_accessor :xml
 
     # New takes in the XML from the response. For the initial response, this
     # will be the root element, but child elements may also be passed into
     # Response objects.
+    #
+    # This will raise a MissingParameter error if a parameterd marked as
+    # required is not present in the XML response.
     def initialize(xml)
+      @raw = xml
       @xml = Hpricot.XML(xml.to_s)
 
-      if parameter = self.class.instance_variable_get('@parameters')
-        parameter.each do |parameter, options|
-          element = options[:element] ? options[:element] : parameter
-
-          if attribute = options[:attribute] and attribute == true
-            node = attribute(root, element)
-          elsif attribute
-            node = attribute(element(element), attribute)
-          elsif options[:collection]
-            node = elements(element)
-          else
-            node = element(element)
-          end
-
-          if options[:collection]
-            value = node.collect do |element|
-              options[:collection].new(element)
+      if parameters = self.class.instance_variable_get('@parameters')
+        parameters.each do |parameter, options|
+          begin
+            element = options[:element] || parameter
+
+            if attribute = options[:attribute] and attribute == true
+              node = attribute(root, element)
+            elsif attribute
+              node = attribute(element(element), attribute)
+            elsif options[:collection]
+              node = elements(element)
+            else
+              node = element(element)
             end
-          else
-            case type = options[:type]
-              when Response
-                value = type.new(node)
 
-              when :float
-                value = float_value(node)
+            if options[:collection]
+              value = node.collect do |element|
+                options[:collection].new(element)
+              end
+            else
+              case type = options[:type]
+                when Response
+                  value = type.new(node)
+
+                when :date
+                  value = date_value(node)
 
-              when :integer
-                value = integer_value(node)
+                when :time
+                  value = time_value(node)
 
-              when :text
-              else
-                value = text_value(node)
+                when :float
+                  value = float_value(node)
+
+                when :integer
+                  value = integer_value(node)
+
+                when :text
+                else
+                  value = text_value(node)
+              end
             end
-          end
 
-          instance_variable_set("@#{parameter}", value)
+            instance_variable_set("@#{parameter}", value)
+          rescue Hpricot::Error
+            raise MissingParameter if options[:required]
+          end
         end
       end
     end
@@ -110,7 +125,23 @@ module Relax
       Date.parse(value(value))
     end
 
+    # Gets a time value.
+    def time_value(value)
+      Time.parse(value(value))
+    end
+
     class << self
+      # When a Response is extended, the superclasses parameters are copied
+      # into the new class. This behavior has the following side-effect: if
+      # parameters are added to the superclass after it has been extended,
+      # those new paramters won't be passed on to its children. This shouldn't
+      # be a problem in most cases.
+      def inherited(subclass)
+        @parameters.each do |name, options|
+          subclass.parameter(name, options)
+        end if @parameters
+      end
+
       # Specifes a parameter that will be automatically parsed when the
       # Response is instantiated.
       #

data/lib/relax.rb

@@ -5,3 +5,7 @@ require 'relax/request'
 require 'relax/response'
 require 'relax/service'
 require 'relax/symbolic_hash'
+
+module Relax
+  class MissingParameter < ArgumentError ; end
+end

data/spec/response_spec.rb

@@ -22,7 +22,12 @@ XML = <<EOF
 </RESTResponse>
 EOF
 
-class TestResponse < Relax::Response
+class BaseResponse < Relax::Response
+  parameter :status, :required => true
+  parameter :request_id, :element => :requestid, :type => :integer
+end
+
+class TestResponse < BaseResponse
   class Token < Relax::Response
     parameter :token_id, :element => :tokenid
     parameter :status
@@ -33,8 +38,6 @@ class TestResponse < Relax::Response
     parameter :message
   end
 
-  parameter :status
-  parameter :request_id, :element => :requestid, :type => :integer
   parameter :valid_request, :element => :requestid, :attribute => :valid
   parameter :tokens, :collection => Token
   parameter :error, :type => Error
@@ -83,8 +86,6 @@ describe 'a response' do
 
   it 'should automatically pull parameters from the XML' do
     response = TestResponse.new(XML)
-    response.status.should eql('Success')
-    response.request_id.should eql(44287)
     response.valid_request.should eql('true')
     response.tokens.length.should eql(2)
     response.tokens.first.status.should eql('Active')
@@ -92,7 +93,17 @@ describe 'a response' do
     response.error.message.should eql('Failed')
   end
 
+  it "should automatically pull its parent's parameters from the XML" do
+    response = TestResponse.new(XML)
+    response.status.should eql('Success')
+    response.request_id.should eql(44287)
+  end
+
   it 'should be relationally equivalent to its children' do
     (Relax::Response === TestResponse).should be_true
   end
+
+  it 'should raise MissingParameter if required parameters are missing' do
+    proc { TestResponse.new('') }.should raise_error(Relax::MissingParameter)
+  end
 end

metadata

@@ -1,10 +1,10 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.9.2
+rubygems_version: 0.9.0
 specification_version: 1
 name: relax
 version: !ruby/object:Gem::Version 
-  version: 0.0.2
-date: 2007-10-10 00:00:00 -04:00
+  version: 0.0.3
+date: 2007-11-01 00:00:00 -04:00
 summary: A simple library for creating REST consumers.
 require_paths: 
 - lib
@@ -29,20 +29,20 @@ post_install_message:
 authors: 
 - Tyler Hunt
 files: 
-- lib/relax.rb
 - lib/relax
-- lib/relax/response.rb
+- lib/relax.rb
+- lib/relax/query.rb
 - lib/relax/request.rb
+- lib/relax/response.rb
 - lib/relax/service.rb
-- lib/relax/query.rb
 - lib/relax/symbolic_hash.rb
 - README
 - LICENSE
 test_files: 
-- spec/request_spec.rb
-- spec/symbolic_hash_spec.rb
 - spec/query_spec.rb
+- spec/request_spec.rb
 - spec/response_spec.rb
+- spec/symbolic_hash_spec.rb
 rdoc_options: []
 
 extra_rdoc_files: