relax 0.0.3 → 0.0.4

data/lib/relax/request.rb

@@ -4,21 +4,37 @@ module Relax
   # Request is intended to be a parent class for requests passed to
   # Service#call.
   class Request
-    def initialize(options = {})
-      self.class.class_variables.each do |variable|
-        instance_variable_set(variable.slice(1..-1), self.class.send(:class_variable_get, variable))
-      end
+    @parameters = {}
+
+    # 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 = {})
+      # initialize default parameter values
+      self.class.parameters.each do |parameter, options|
+        if defaults.has_key?(parameter)
+          value = defaults[parameter]
+        elsif options[:value]
+          value = options[:value]
+        end
 
-      options.each do |key, value|
-        instance_variable_set "@#{key}", value
+        instance_variable_set("@#{parameter}", value) if value
       end
     end
 
     # Converts this request into a Query object.
     def to_query
-      keys.inject(Query.new) do |parameters, key|
-        parameters[convert_key(key)] = send(key)
-        parameters
+      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]
+          options[:type].parameters.each do |parameter, options|
+            query[convert_complex_key(key, parameter)] = value.send(parameter) if value
+          end
+        end
+        query
       end
     end
 
@@ -27,14 +43,40 @@ module Relax
       to_query.to_s
     end
 
+    # Converts a key when the Request is converted to a query. By default, no
+    # conversion actually takes place, but this method can be overridden by
+    # child classes to perform standard manipulations, such as replacing
+    # underscores.
+    def convert_key(key)
+      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
+    # overridden by child classes.
+    def convert_complex_key(key, parameter)
+      "#{key}.#{parameter}"
+    end
+    protected :convert_complex_key
+
     class << self
+      # Create the parameters hash for the subclass.
+      def inherited(subclass) #:nodoc:
+        subclass.instance_variable_set('@parameters', {})
+      end
+
       # Specifies a parameter to create on the request class.
       #
       # Options:
+      # - <tt>:type</tt>: An optional custom data type for the parameter.
+      #   This must be a class that is a descendent of Request.
       # - <tt>:value</tt>: The default value for this parameter.
       def parameter(name, options = {})
         attr_accessor name
-        class_variable_set("@@#{name}", options.delete(:value)) if options[:value]
+        options = @parameters[name].merge(options) if @parameters.has_key?(name)
+        @parameters[name] = options
       end
 
       # Adds a template value to a request class. Equivalent to creating a
@@ -42,21 +84,12 @@ module Relax
       def []=(key, value)
         parameter(key, {:value => value})
       end
-    end
-
-    protected
 
-    # Returns an array of the parameter names for this request.
-    def keys
-      instance_variables.collect { |v| v.sub('@', '') }
-    end
-
-    # Converts a key when the Request is converted to a query. By default, no
-    # conversion actually takes place, but this method can be overridden by
-    # child classes to perform standard manipulations, such as replacing
-    # underscores.
-    def convert_key(key)
-      key
+      # Returns a hash of all of the parameters for this request, including
+      # those that are inherited.
+      def parameters #:nodoc:
+        (superclass.respond_to?(:parameters) ? superclass.parameters : {}).merge(@parameters)
+      end
     end
   end
 end

data/lib/relax/response.rb

@@ -131,7 +131,7 @@ module Relax
     end
 
     class << self
-      # When a Response is extended, the superclasses parameters are copied
+      # When a Response is extended, the superclass's 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

data/spec/query_spec.rb

@@ -11,13 +11,13 @@ describe 'a query' do
   it 'should convert to a query string' do
     @query[:action] = 'Search'
     @query[:query] = 'strings'
-    @query.to_s.should == 'action=Search&query=strings'
+    @query.to_s.should eql('action=Search&query=strings')
   end
 
   it 'should convert its values to strings' do
     date = Date.today
     @query[:date] = date
-    @query.to_s.should == "date=#{date.to_s}"
+    @query.to_s.should eql("date=#{date.to_s}")
   end
 
   it 'should escape its values using "+" instead of "%20"' do
@@ -28,18 +28,18 @@ describe 'a query' do
     @query[:charlie] = 3
     @query[:alpha] = 1
     @query[:bravo] = 2
-    @query.to_s.should == 'alpha=1&bravo=2&charlie=3'
+    @query.to_s.should eql('alpha=1&bravo=2&charlie=3')
   end
 
   it 'should encode its parameter values' do
     @query[:spaces] = 'two words'
     @query[:url] = 'http://example.com/'
-    @query.to_s.should == 'spaces=two+words&url=http%3A%2F%2Fexample.com%2F'
+    @query.to_s.should eql('spaces=two+words&url=http%3A%2F%2Fexample.com%2F')
   end
 
   it 'should be able to parse query strings' do
     parsed_query = Relax::Query.parse(@uri)
-    parsed_query[:action].should == 'search'
-    parsed_query[:query].should == 'keyword'
+    parsed_query[:action].should eql('search')
+    parsed_query[:query].should eql('keyword')
   end
 end

data/spec/request_spec.rb

@@ -2,10 +2,16 @@ require File.dirname(__FILE__) + '/spec_helper'
 
 require 'relax/request'
 
+class Amount < Relax::Request
+  parameter :amount
+  parameter :currency
+end
+
 class TestRequest < Relax::Request
   parameter :action
   parameter :token_id
   parameter :user_id
+  parameter :amount, :type => Amount
 end
 
 class ChildRequest < TestRequest
@@ -30,12 +36,14 @@ describe 'a request that converts to a query', :shared => true do
     @query[:action].should eql('Search')
     @query[:token_id].should eql('123')
     @query[:user_id].should be_nil
+    @query[:amount].should be_nil
   end
 
   it 'should only include parameters in the query if they are set' do
     @query.key?(:action).should be_true
     @query.key?(:token_id).should be_true
     @query.key?(:user_id).should be_false
+    @query.key?(:amount).should be_false
   end
 end
 
@@ -49,6 +57,7 @@ describe 'a template request' do
   it_should_behave_like 'an option initialized request'
 
   before(:each) do
+    # this syntax may need to go away unless we can find a way to make it work 
     TestRequest[:api_key] = '123456'
     TestRequest[:secret] = 'shhh!'
   end
@@ -84,3 +93,16 @@ describe 'a template request' do
     parent.respond_to?(:query).should be_false
   end
 end
+
+describe 'a request with a custom type' do
+  before(:each) do
+    request = TestRequest.new(:action => 'Pay', :token_id => 123)
+    request.amount = Amount.new(:amount => 3.50, :currency => 'USD')
+    @query = request.to_query
+  end
+
+  it 'should add the type parameters to the query' do
+    @query.key?(:"amount.amount").should be_true
+    @query.key?(:"amount.currency").should be_true
+  end
+end

metadata

@@ -1,10 +1,10 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.9.0
+rubygems_version: 0.9.4
 specification_version: 1
 name: relax
 version: !ruby/object:Gem::Version 
-  version: 0.0.3
-date: 2007-11-01 00:00:00 -04:00
+  version: 0.0.4
+date: 2007-11-17 00:00:00 -05:00
 summary: A simple library for creating REST consumers.
 require_paths: 
 - lib
@@ -30,12 +30,12 @@ authors:
 - Tyler Hunt
 files: 
 - lib/relax
-- lib/relax.rb
 - lib/relax/query.rb
 - lib/relax/request.rb
 - lib/relax/response.rb
 - lib/relax/service.rb
 - lib/relax/symbolic_hash.rb
+- lib/relax.rb
 - README
 - LICENSE
 test_files: