relax 0.1.1 → 0.1.2

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
 :major: 0
 :minor: 1
-:patch: 1
+:patch: 2

data/lib/relax/action.rb

@@ -14,10 +14,10 @@ module Relax
       context.evaluate(&block) if block_given?
     end
 
-    def execute(values, credentials, *args)
+    def execute(values, options, *args)
       args.unshift(values) if values
-      instance = Instance.new(*args)
-      response = performer(instance, credentials).perform
+      instance = Instance.new(options, *args)
+      response = performer(instance, options).perform
       context.parse(response)
     end
 
@@ -31,9 +31,9 @@ module Relax
     end
     private :url
 
-    def performer(instance, credentials)
+    def performer(instance, options)
       values = instance.values(context)
-      Performer.new(method, url, values, credentials)
+      Performer.new(method, url, values, options)
     end
     private :performer
 

data/lib/relax/context.rb

@@ -11,7 +11,7 @@ module Relax
     end
 
     def parameter(name, options={})
-      unless @parameters.find { |parameter| parameter.name == name }
+      unless @parameters.find { |parameter| parameter.named?(name) }
         @parameters << Parameter.new(name, options)
       else
         raise ArgumentError.new("Duplicate parameter '#{name}'.")
@@ -19,14 +19,19 @@ module Relax
     end
 
     def set(name, value)
-      if parameter = @parameters.find { |parameter| parameter.name == name }
+      if parameter = @parameters.find { |parameter| parameter.named?(name) }
         parameter.value = value
       end
     end
 
     def parser(root, options={}, &block) # :nodoc:
-      @parser ||= root.kind_of?(Class) ?  root.new(options, &block) : 
-                                          Relief::Parser.new(root, options, &block)
+      @parser ||= begin
+        if root.kind_of?(Class)
+          root.new(options, &block)
+        else
+          Relief::Parser.new(root, options, &block)
+        end
+      end
     end
 
     def parse(response) # :nodoc:

data/lib/relax/instance.rb

@@ -1,6 +1,8 @@
 module Relax
   class Instance # :nodoc:
-    def initialize(*args)
+    def initialize(options, *args)
+      @options = options
+
       @values = args.inject({}) do |values, arg|
         arg.is_a?(Hash) ? values.merge(arg) : values
       end
@@ -8,12 +10,12 @@ module Relax
 
     def values(context)
       context.parameters.inject({}) do |values, parameter|
-        name = parameter.name
+        name = parameter.options[:as] || parameter.name
 
-        if value = @values[parameter.name] || parameter.value
+        if (value = @values[name] || parameter.value) || @options[:include_blank_values]
           values[parameter.name] = value
         elsif parameter.required?
-          raise ArgumentError.new("Missing value for '#{parameter.name}'.")
+          raise ArgumentError.new("Missing value for '#{name}'.")
         end
 
         values

data/lib/relax/parameter.rb

@@ -8,6 +8,10 @@ module Relax
       @options = options
     end
 
+    def named?(name)
+      name == (@options[:as] || @name)
+    end
+
     def value
       @value || @options[:default]
     end

data/lib/relax/performer.rb

@@ -1,15 +1,19 @@
 module Relax
   class Performer
-    def initialize(method, url, values, credentials)
+    def initialize(method, url, values, options={})
       @method = method
       @url = url
       @values = values
-      @credentials = credentials
+      @credentials = options.delete(:credentials)
+      @proxy = options.delete(:proxy)
+      @options = options
 
       parse_url_tokens
     end
 
     def perform
+      RestClient.proxy = @proxy if @proxy
+
       case @method
         when :delete, :get, :head then RestClient.send(@method, url)
         when :post, :put then RestClient.send(@method, url, query)
@@ -30,13 +34,15 @@ module Relax
 
     def query
       @values.collect do |name, value|
-        "#{name}=#{value}" if value
+        "#{name}=#{value}" if value || @options[:include_blank_values]
       end.compact.join('&')
     end
     private :query
 
     def parse_url_tokens
-      @url_values = @url.scan(/(?:\:)([a-z_]+)/).flatten.inject({}) do |values, name|
+      tokens = @url.scan(/(?:\:)([a-z_]+)/).flatten
+
+      @url_values = tokens.inject({}) do |values, name|
         name = name.to_sym
         values[name] = @values.delete(name) if @values.key?(name)
         values

data/lib/relax/service.rb

@@ -1,11 +1,22 @@
 module Relax
   class Service
-    def initialize(values={})
+    def initialize(values={}, options={})
       @values = values
+      @options = options
     end
 
     def authenticate(*args)
-      @credentials = args
+      @options[:credentials] = args
+      self
+    end
+
+    def proxy(url)
+      @options[:proxy] = url
+      self
+    end
+
+    def include_blank_values(value)
+      @options[:include_blank_values] = value
       self
     end
 
@@ -23,7 +34,7 @@ module Relax
           @actions[action.name] = action.name
 
           define_method(action.name) do |*args|
-            action.execute(@values, @credentials, *args)
+            action.execute(@values, @options, *args)
           end
         else
           raise ArgumentError.new("Duplicate action '#{action.name}'.") 

data/spec/relax/context_spec.rb

@@ -1,10 +1,18 @@
 require File.join(File.dirname(__FILE__), '..', 'spec_helper')
 
 describe Relax::Context do
-  
   it "utilizes a custom parser for Class parsers" do
-    service = ServiceWithCustomParser.new
+    service = CustomParserService.new
     service.test.should == 'parsed'
   end
-  
+
+  it "allows parameters with aliases" do
+    service = ParameterAliasService.new
+    service.test(:api_key => 'secret')[:stat].should == 'ok'
+  end
+
+  it "allows blank parameters values" do
+    service = BlankValuesService.new({}, :include_blank_values => true)
+    service.test[:stat].should == 'ok'
+  end
 end

data/spec/services/blank_values_service.rb

@@ -0,0 +1,19 @@
+class BlankValuesService < Relax::Service
+  endpoint 'http://example.com/' do
+    action :test do
+      parameter :one
+      parameter :two
+      parameter :three
+
+      parser :response do
+        attribute :stat
+      end
+    end
+  end
+end
+
+FakeWeb.register_uri(:get, 'http://example.com/?one=&two=&three=', :string => <<-RESPONSE)
+  <?xml version="1.0" encoding="utf-8" ?>
+  <response stat="ok">
+  </response>
+RESPONSE

data/spec/services/{service_with_custom_parser.rb → custom_parser_service.rb}

@@ -1,23 +1,19 @@
 class TestCustomParser
-  
   def initialize(options = {}, &block)
   end
-  
+
   def parse(input)
     'parsed'
   end
-  
 end
 
-class ServiceWithCustomParser < Relax::Service
+class CustomParserService < Relax::Service
   endpoint "http://test.local/rest" do
-
     action :test do
       parser TestCustomParser do
         element :status, :attribute => :stat
       end
     end
-
   end
 end
 

data/spec/services/parameter_alias_service.rb

@@ -0,0 +1,17 @@
+class ParameterAliasService < Relax::Service
+  endpoint 'http://example.com/' do
+    action :test do
+      parameter :APIKey, :as => :api_key, :required => true
+
+      parser :response do
+        attribute :stat
+      end
+    end
+  end
+end
+
+FakeWeb.register_uri(:get, 'http://example.com/?APIKey=secret', :string => <<-RESPONSE)
+  <?xml version="1.0" encoding="utf-8" ?>
+  <response stat="ok">
+  </response>
+RESPONSE

data/spec/spec_helper.rb

@@ -10,4 +10,6 @@ require 'fakeweb'
 
 require File.join(File.dirname(__FILE__), '..', 'lib', 'relax')
 require File.join(File.dirname(__FILE__), 'services', 'flickr')
-require File.join(File.dirname(__FILE__), 'services', 'service_with_custom_parser')
+require File.join(File.dirname(__FILE__), 'services', 'custom_parser_service')
+require File.join(File.dirname(__FILE__), 'services', 'parameter_alias_service')
+require File.join(File.dirname(__FILE__), 'services', 'blank_values_service')

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: relax
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors: 
 - Tyler Hunt
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-06-03 00:00:00 -04:00
+date: 2009-06-30 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -89,8 +89,10 @@ files:
 - spec/relax/endpoint_spec.rb
 - spec/relax/integration_spec.rb
 - spec/relax/service_spec.rb
+- spec/services/blank_values_service.rb
+- spec/services/custom_parser_service.rb
 - spec/services/flickr.rb
-- spec/services/service_with_custom_parser.rb
+- spec/services/parameter_alias_service.rb
 - spec/spec_helper.rb
 has_rdoc: true
 homepage: http://github.com/tylerhunt/relax
@@ -123,6 +125,8 @@ test_files:
 - spec/relax/endpoint_spec.rb
 - spec/relax/integration_spec.rb
 - spec/relax/service_spec.rb
+- spec/services/blank_values_service.rb
+- spec/services/custom_parser_service.rb
 - spec/services/flickr.rb
-- spec/services/service_with_custom_parser.rb
+- spec/services/parameter_alias_service.rb
 - spec/spec_helper.rb