relax 0.0.5 → 0.0.6

data/lib/relax/parsers/base.rb

@@ -1,25 +1,23 @@
 module Relax
   module Parsers
-    
     class Base
-      
       attr_reader :parent
       attr_reader :parameters
-      
+
       def initialize(raw, parent)
-        @parent     = parent
+        @parent = parent
         @parameters = parent.class.instance_variable_get('@parameters')
         parse!
       end
-      
+
       def parse!; end
-      
+
       def root; end
       def is?(name); end
       def has?(name); end
       def element(name); end
       def elements(name); end
-      
+
       def attribute(element, name); end
       def value(value); end
       def text_value(value); end
@@ -27,8 +25,6 @@ module Relax
       def float_value(value); end
       def date_value(value); end
       def time_value(value); end
-      
     end
-    
   end
 end

data/lib/relax/parsers/factory.rb

@@ -1,43 +1,29 @@
 module Relax
   module Parsers
-    
-    ##
     # Manages the Relax::Parsers in the library.
-    # 
     module Factory
-      
       class << self
-        
-        ##
-        # Returns the parser class which has been registered for the given 
+        # Returns the parser class which has been registered for the given
         # +name+.
-        # 
         def get(name)
           @@parsers ||= {}
-          @@parsers[name] || raise(UnrecognizedParser, "Given parser name not recognized: #{name.inspect}.  Expected one of: #{@@parsers.keys.inspect}")
+          @@parsers[name] || raise(UnrecognizedParser, "Given parser name not recognized: #{name.inspect}. Expected one of: #{@@parsers.keys.inspect}")
         end
-        
-        ##
-        # Registers a new parser with the factory.  The +name+ should be unique,
+
+        # Registers a new parser with the factory. The +name+ should be unique,
         # but if not, it will override the previously defined parser for the
         # given +name+.
-        # 
         def register(name, klass)
           @@parsers ||= {}
           @@parsers[:default] = klass if @@parsers.empty?
           @@parsers[name] = klass
         end
-        
-        ##
+
         # Removes all registered parsers from the factory.
-        # 
         def clear!
           @@parsers = {}
         end
-        
       end
-      
     end
-    
   end
 end

data/lib/relax/parsers/hpricot.rb

@@ -3,33 +3,30 @@ require 'hpricot'
 
 module Relax
   module Parsers
-    
-    ##
     # Parses the server's raw response using the Hpricot library.
-    # 
     class Hpricot < Base
-      
       FACTORY_NAME = :hpricot
-      
+
       def initialize(raw, parent)
         @xml = ::Hpricot.XML(raw)
         super(raw, parent)
       end
-      
+
       def parse!
         if 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)
+              node = case
+                when options[:attribute] && options[:attribute] == true
+                  attribute(root, element)
+                when options[:attribute]
+                  attribute(element(element), options[:attribute])
+                when options[:collection]
+                  elements(element)
+                else
+                  element(element)
               end
 
               if options[:collection]
@@ -37,25 +34,20 @@ module Relax
                   options[:collection].new(element)
                 end
               else
-                case type = options[:type]
+                value = case type = options[:type]
                   when Response
-                    value = type.new(node)
-
+                    type.new(node)
                   when :date
-                    value = date_value(node)
-
+                    date_value(node)
                   when :time
-                    value = time_value(node)
-
+                    time_value(node)
                   when :float
-                    value = float_value(node)
-
+                    float_value(node)
                   when :integer
-                    value = integer_value(node)
-
+                    integer_value(node)
                   when :text
                   else
-                    value = text_value(node)
+                    text_value(node)
                 end
               end
 
@@ -66,28 +58,28 @@ module Relax
           end
         end
       end
-      
+
       # Returns the root of the XML document.
       def root
         @xml.root
       end
-      
+
       # Checks the name of the root node.
       def is?(name)
         root.name.gsub(/.*:(.*)/, '\1') == node_name(name)
       end
-      
+
       # Returns a set of elements matching name.
       def elements(name)
         root.search(root_path(name))
       end
-      
+
       # Returns an element of the specified name.
       def element(name)
         root.at(root_path(name))
       end
       alias :has? :element
-      
+
       # Returns an attribute on an element.
       def attribute(element, name)
         element[name]
@@ -97,7 +89,7 @@ module Relax
       def value(value)
         value.is_a?(::Hpricot::Elem) ? value.inner_text : value.to_s
       end
-      
+
       # Gets a text value.
       def text_value(value)
         value(value)
@@ -122,24 +114,20 @@ module Relax
       def time_value(value)
         Time.parse(value(value))
       end
-      
-      
-      private
-      
-      
+
       # Converts a name to a node name.
       def node_name(name)
-        name.to_s
+        @parent.node_name(name)
       end
+      private :node_name
 
       # Gets the XPath expression representing the root node.
       def root_path(name)
         "/#{node_name(name)}"
       end
-      
+      private :root_path
     end
-    
+
     Factory.register(Hpricot::FACTORY_NAME, Hpricot)
-    
   end
 end

data/lib/relax/parsers/rexml.rb

@@ -3,71 +3,63 @@ require 'rexml/document'
 
 module Relax
   module Parsers
-    
-    ##
     # Parsers the server's response using the REXML library.
-    # 
+    #
     # Benefits:
     #
     # * XML Namespace support (parameter :foo, :namespace => 'bar')
-    # 
+    #
     # Drawbacks:
     #
     # * Case sensitive field names (<Status>..</> != parameter :status)
-    # 
     class REXML < Base
-      
       FACTORY_NAME = :rexml
-      
+
       def initialize(raw, parent)
         @xml = ::REXML::Document.new(raw)
         super(raw, parent)
       end
-      
+
       def parse!
         if parameters
           parameters.each do |parameter, options|
             begin
               element = options[:element] || parameter
               namespace = options[:namespace]
-            
-              if attribute = options[:attribute] and attribute == true
-                node = attribute(root, element, namespace)
-              elsif attribute
-                node = attribute(element(element), attribute, namespace)
-              elsif options[:collection]
-                node = elements(element, namespace)
-              else
-                node = element(element, namespace)
+
+              node = case
+                when options[:attribute] && options[:attribute] == true
+                  attribute(root, element, namespace)
+                when options[:attribute]
+                  attribute(element(element), options[:attribute], namespace)
+                when options[:collection]
+                  elements(element, namespace)
+                else
+                  element(element, namespace)
               end
-              
+
               if options[:collection]
                 value = node.collect do |element|
-                  options[:collection].new(element.deep_clone)
+                  options[:collection].new(element.to_s)
                 end
               else
-                case type = options[:type]
+                value = case type = options[:type]
                   when Response
-                    value = type.new(node)
-            
+                    type.new(node)
                   when :date
-                    value = date_value(node)
-            
+                    date_value(node)
                   when :time
-                    value = time_value(node)
-            
+                    time_value(node)
                   when :float
-                    value = float_value(node)
-            
+                    float_value(node)
                   when :integer
-                    value = integer_value(node)
-            
+                    integer_value(node)
                   when :text
                   else
-                    value = text_value(node)
+                    text_value(node)
                 end
               end
-            
+
               parent.instance_variable_set("@#{parameter}", value)
             rescue
               raise(Relax::MissingParameter) if node.nil? && options[:required]
@@ -75,30 +67,30 @@ module Relax
           end
         end
       end
-      
+
       # Returns the root of the XML document.
       def root
         @xml.root
       end
-      
+
       # Checks the name of the root node.
-      def is?(name, namespace = nil)
+      def is?(name, namespace=nil)
         root.name == node_name(name, nil)
       end
-      
+
       # Returns a set of elements matching name.
-      def elements(name, namespace = nil)
+      def elements(name, namespace=nil)
         root.get_elements(node_path(name, namespace))
       end
-      
+
       # Returns an element of the specified name.
-      def element(name, namespace = nil)
+      def element(name, namespace=nil)
         root.elements[node_path(name, namespace)]
       end
       alias :has? :element
-      
+
       # Returns an attribute on an element.
-      def attribute(element, name, namespace = nil)
+      def attribute(element, name, namespace=nil)
         element.attribute(name)
       end
 
@@ -106,7 +98,7 @@ module Relax
       def value(value)
         value.is_a?(::REXML::Element) ? value.text : value.to_s
       end
-      
+
       # Gets a text value.
       def text_value(value)
         value(value)
@@ -131,28 +123,25 @@ module Relax
       def time_value(value)
         Time.parse(value(value))
       end
-      
-      
-      private
-      
-      
+
       # Converts a name to a node name.
-      def node_name(name, namespace = nil)
-        "#{namespace.to_s + ':' if namespace}#{name}"
+      def node_name(name, namespace=nil)
+        @parent.node_name(name, namespace)
       end
+      private :node_name
 
       # Gets the XPath expression representing the root node.
       def root_path(name)
         "/#{node_name(name)}"
       end
-      
-      def node_path(name, namespace = nil)
+      private :root_path
+
+      def node_path(name, namespace=nil)
         "#{node_name(name, namespace)}"
       end
-      
+      private :node_path
     end
-    
+
     Factory.register(REXML::FACTORY_NAME, REXML)
-    
   end
 end

data/lib/relax/parsers.rb

@@ -10,4 +10,4 @@ require 'relax/parsers/rexml'
 module Relax
   module Parsers
   end
-end
+end

data/lib/relax/request.rb

@@ -8,8 +8,8 @@ module Relax
 
     # New takes an optional hash of default parameter values. When passed,
     # the values will be set on the request if the key exists as a valid
-    # parameter name. 
-    def initialize(defaults = {})
+    # parameter name.
+    def initialize(defaults={})
       # initialize default parameter values
       self.class.parameters.each do |parameter, options|
         if defaults.has_key?(parameter)
@@ -27,6 +27,7 @@ module Relax
       self.class.parameters.keys.inject(Query.new) do |query, key|
         value = send(key)
         options = self.class.parameters[key]
+
         if value && !options[:type]
           query[convert_key(key)] = value if value
         elsif options[:type]
@@ -34,6 +35,7 @@ module Relax
             query[convert_complex_key(key, parameter)] = value.send(parameter) if value
           end
         end
+
         query
       end
     end
@@ -51,7 +53,7 @@ module Relax
       key
     end
     protected :convert_key
-    
+
     # Converts a complex key (i.e. a parameter with a custom type) when the
     # Request is converted to a query. By default, this means the key name and
     # the parameter name separated by two underscores. This method can be
@@ -82,7 +84,7 @@ module Relax
       # Adds a template value to a request class. Equivalent to creating a
       # parameter with a default value.
       def []=(key, value)
-        parameter(key, {:value => value})
+        parameter(key, :value => value)
       end
 
       # Returns a hash of all of the parameters for this request, including

data/lib/relax/response.rb

@@ -7,20 +7,24 @@ module Relax
   # #element and #attribute.
   class Response
     attr_accessor :raw
-    
+
     # New takes in and parses the raw response.
     #
     # This will raise a MissingParameter error if a parameterd marked as
     # required is not present in the parsed response.
     def initialize(xml)
-      @raw    = xml
+      @raw = xml
       @parser = Relax::Parsers::Factory.get(parser_name).new(xml.to_s, self)
     end
-    
-    def parser_name
+
+    def parser_name #:nodoc:
       self.class.instance_variable_get('@parser') || :default
     end
-    
+
+    def node_name(name, namespace=nil) #:nodoc:
+      "#{namespace.to_s + ':' if namespace}#{name}"
+    end
+
     def method_missing(method, *args) #:nodoc:
       if @parser.respond_to?(method)
         @parser.__send__(method, *args)
@@ -39,6 +43,7 @@ module Relax
         @parameters.each do |name, options|
           subclass.parameter(name, options)
         end if @parameters
+
         subclass.parser(@parser) if @parser
       end
 
@@ -54,16 +59,16 @@ module Relax
       # - <tt>:object</tt>: A class used to instantiate an element.
       # - <tt>:type</tt>: The type of the parameter. Should be one of
       #   <tt>:text</tt>, <tt>:integer</tt>, <tt>:float</tt>, or <tt>:date</tt>.
-      def parameter(name, options = {})
+      def parameter(name, options={})
         attr_accessor name
         @parameters ||= {}
         @parameters[name] = options
       end
-      
-      # Specifies the parser to use when decoding the server response.  If 
-      # no parser is specified for the response, then the default parser will
-      # be used.
-      # 
+
+      # Specifies the parser to use when decoding the server response. If no
+      # parser is specified for the response, then the default parser will be
+      # used.
+      #
       # See Relax::Parsers for a list of available parsers.
       def parser(name)
         @parser ||= name
@@ -73,6 +78,5 @@ module Relax
         response.is_a?(Class) ? response.ancestors.include?(self) : super
       end
     end
-
   end
 end

data/lib/relax/symbolic_hash.rb

@@ -66,14 +66,14 @@ module Relax
     alias :has_key? :key?
     alias :member? :key?
 
-    protected
-
     def convert_key(key)
       !key.kind_of?(Symbol) ? key.to_sym : key
     end
+    protected :convert_key
 
     def convert_value(value)
       value
     end
+    protected :convert_value
   end
 end

data/spec/parsers/hpricot_spec.rb

@@ -1,7 +1,6 @@
 require File.dirname(__FILE__) + '/../spec_helper'
 require File.dirname(__FILE__) + '/../parser_helper'
 
-
 class HpricotTestResponse < Relax::Response
   class Token < Relax::Response
     parser :hpricot
@@ -14,7 +13,7 @@ class HpricotTestResponse < Relax::Response
     parameter :code, :type => :integer
     parameter :message
   end
-  
+
   parser :hpricot
   parameter :status, :required => true
   parameter :request_id, :element => :requestid, :type => :integer
@@ -23,13 +22,10 @@ class HpricotTestResponse < Relax::Response
   parameter :error, :type => Error
 end
 
-
 describe 'an Hpricot parser' do
-  
   before(:each) do
     @response = HpricotTestResponse.new(XML)
   end
-  
+
   it_should_behave_like 'a successfully parsed response'
-  
-end
+end

data/spec/parsers/rexml_spec.rb

@@ -1,40 +1,36 @@
 require File.dirname(__FILE__) + '/../spec_helper'
 require File.dirname(__FILE__) + '/../parser_helper'
 
-
 class RexmlTestResponse < Relax::Response
   class Token < Relax::Response
     parser :rexml
-    parameter :token_id,  :element => 'TokenId'
-    parameter :status,    :element => 'Status'
+    parameter :token_id, :element => 'TokenId'
+    parameter :status, :element => 'Status'
   end
-  
+
   class Error < Relax::Response
     parser :rexml
-    parameter :code,      :element => 'Code',         :type => :integer
-    parameter :message,   :element => 'Message'
+    parameter :code, :element => 'Code', :type => :integer
+    parameter :message, :element => 'Message'
   end
-  
+
   parser :rexml
-  parameter :status,        :element => 'Status',     :required => true
-  parameter :request_id,    :element => 'RequestId',  :type => :integer
-  parameter :valid_request, :element => 'RequestId',  :attribute => :valid
-  parameter :namespace,     :element => 'Namespace',  :namespace => 'ns1'
-  parameter :tokens,        :element => 'Tokens',     :collection => Token
-  parameter :error,         :element => 'Error',      :type => Error
+  parameter :status, :element => 'Status', :required => true
+  parameter :request_id, :element => 'RequestId', :type => :integer
+  parameter :valid_request, :element => 'RequestId', :attribute => :valid
+  parameter :namespace, :element => 'Namespace', :namespace => 'ns1'
+  parameter :tokens, :element => 'Tokens', :collection => Token
+  parameter :error, :element => 'Error', :type => Error
 end
 
-
 describe 'a REXML parser' do
-  
   before(:each) do
     @response = RexmlTestResponse.new(XML)
   end
-  
+
   it_should_behave_like 'a successfully parsed response'
-  
+
   it 'should parse namespaced parameters' do
     @response.namespace.should eql('Passed')
   end
-  
-end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: relax
 version: !ruby/object:Gem::Version 
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors: 
 - Tyler Hunt
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-10-20 00:00:00 -04:00
+date: 2009-02-03 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -45,13 +45,6 @@ files:
 - lib/relax/service.rb
 - lib/relax/symbolic_hash.rb
 - lib/relax.rb
-- spec/parsers/factory_spec.rb
-- spec/parsers/hpricot_spec.rb
-- spec/parsers/rexml_spec.rb
-- spec/query_spec.rb
-- spec/request_spec.rb
-- spec/response_spec.rb
-- spec/symbolic_hash_spec.rb
 - README
 - LICENSE
 has_rdoc: true
@@ -76,7 +69,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: relax
-rubygems_version: 1.2.0
+rubygems_version: 1.3.1
 signing_key: 
 specification_version: 2
 summary: A simple library for creating REST consumers.