relax 0.1.0 → 0.1.1

data/VERSION.yml

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

data/lib/relax/action.rb

@@ -10,6 +10,7 @@ module Relax
       @options = options
 
       extend_context(endpoint)
+      parse_url_parameters
       context.evaluate(&block) if block_given?
     end
 
@@ -35,5 +36,14 @@ module Relax
       Performer.new(method, url, values, credentials)
     end
     private :performer
+
+    def parse_url_parameters
+      url.scan(/(?:\:)([a-z_]+)/).flatten.each do |name|
+        defaults do
+          parameter name.to_sym, :required => true
+        end
+      end
+    end
+    private :parse_url_parameters
   end
 end

data/lib/relax/context.rb

@@ -25,7 +25,8 @@ module Relax
     end
 
     def parser(root, options={}, &block) # :nodoc:
-      @parser ||= Relief::Parser.new(root, options, &block)
+      @parser ||= root.kind_of?(Class) ?  root.new(options, &block) : 
+                                          Relief::Parser.new(root, options, &block)
     end
 
     def parse(response) # :nodoc:

data/lib/relax/performer.rb

@@ -5,6 +5,8 @@ module Relax
       @url = url
       @values = values
       @credentials = credentials
+
+      parse_url_tokens
     end
 
     def perform
@@ -15,7 +17,11 @@ module Relax
     end
 
     def url
-      uri = URI.parse(@url)
+      url = @url.gsub(/\:[a-z_]+/) do |name|
+        @url_values[name[1..-1].to_sym]
+      end
+
+      uri = URI.parse(url)
       uri.query = query unless query.nil? || query.empty?
       uri.userinfo = @credentials.join(':') if @credentials
       uri.to_s
@@ -28,5 +34,14 @@ module Relax
       end.compact.join('&')
     end
     private :query
+
+    def parse_url_tokens
+      @url_values = @url.scan(/(?:\:)([a-z_]+)/).flatten.inject({}) do |values, name|
+        name = name.to_sym
+        values[name] = @values.delete(name) if @values.key?(name)
+        values
+      end
+    end
+    private :parse_url_tokens
   end
 end

data/lib/relax/service.rb

@@ -6,6 +6,7 @@ module Relax
 
     def authenticate(*args)
       @credentials = args
+      self
     end
 
     class << self

data/spec/relax/context_spec.rb

@@ -0,0 +1,10 @@
+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.test.should == 'parsed'
+  end
+  
+end

data/spec/relax/endpoint_spec.rb

@@ -14,7 +14,7 @@ describe Relax::Endpoint do
   end
 
   describe "actions" do
-    it "actions should check for required values for service defaults" do
+    it "should check for required values for service defaults" do
       service = Class.new(Relax::Service) do
         defaults { parameter :api_key, :required => true }
         endpoint("http://api.example.com/") { action(:fetch) { } }
@@ -25,7 +25,7 @@ describe Relax::Endpoint do
       }.should raise_error(ArgumentError, /missing.*api_key/i)
     end
 
-    it "actions should check for required values for endpoint defaults" do
+    it "should check for required values for endpoint defaults" do
       service = Class.new(Relax::Service) do
         endpoint("http://api.example.com/") do
           defaults { parameter :operation, :required => true }
@@ -38,7 +38,7 @@ describe Relax::Endpoint do
       }.should raise_error(ArgumentError, /missing.*operation/i)
     end
 
-    it "actions should check for required values for action parameters" do
+    it "should check for required values for action parameters" do
       service = Class.new(Relax::Service) do
         endpoint("http://api.example.com/") do
           action(:fetch) { parameter :id, :required => true }
@@ -49,6 +49,36 @@ describe Relax::Endpoint do
         service.new.fetch
       }.should raise_error(ArgumentError, /missing.*id/i)
     end
+
+    it "should create required parameters from tokens in the endpoint URL" do
+      service = Class.new(Relax::Service) do
+        endpoint("http://api.example.com/:version/") do
+          action(:fetch) { parameter :id }
+        end
+      end
+
+      proc {
+        service.new.fetch
+      }.should raise_error(ArgumentError, /missing.*version/i)
+    end
+
+    it "should replace parameter tokens in the endpoint URL" do
+      service = Class.new(Relax::Service) do
+        endpoint("http://api.example.com/:version/") do
+          action(:fetch) do
+            parameter :id
+            parser(:xml) { attribute :status }
+          end
+        end
+      end
+
+      FakeWeb.register_uri(:get, 'http://api.example.com/v1/', :string => <<-RESPONSE)
+        <?xml version="1.0" encoding="utf-8" ?>
+        <response status="ok" />
+      RESPONSE
+
+      service.new(:version => 'v1').fetch.should == { :status => 'ok' }
+    end
   end
 
   describe ".action" do

data/spec/relax/service_spec.rb

@@ -5,6 +5,17 @@ describe Relax::Service do
     Relax::Service.should respond_to(:defaults)
   end
 
+  describe "#authenticate" do
+    it "is callable from within a Service" do
+      Relax::Service.new.should respond_to(:authenticate)
+    end
+
+    it "returns the service" do
+      service = Relax::Service.new
+      service.authenticate('username', 'password').should == service
+    end
+  end
+
   describe ".endpoint" do
     it "is callable from within a Service" do
       Relax::Service.should respond_to(:endpoint)

data/spec/services/service_with_custom_parser.rb

@@ -0,0 +1,28 @@
+class TestCustomParser
+  
+  def initialize(options = {}, &block)
+  end
+  
+  def parse(input)
+    'parsed'
+  end
+  
+end
+
+class ServiceWithCustomParser < Relax::Service
+  endpoint "http://test.local/rest" do
+
+    action :test do
+      parser TestCustomParser do
+        element :status, :attribute => :stat
+      end
+    end
+
+  end
+end
+
+FakeWeb.register_uri(:get, 'http://test.local/rest', :string => <<-RESPONSE)
+  <?xml version="1.0" encoding="utf-8" ?>
+  <test stat="ok">
+  </test>
+RESPONSE

data/spec/spec_helper.rb

@@ -10,3 +10,4 @@ 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')

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: relax
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors: 
 - Tyler Hunt
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-05-07 00:00:00 -07:00
+date: 2009-06-03 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -70,9 +70,10 @@ extensions: []
 
 extra_rdoc_files: 
 - LICENSE
-- README
+- README.rdoc
 files: 
 - LICENSE
+- README.rdoc
 - Rakefile
 - VERSION.yml
 - lib/relax.rb
@@ -84,12 +85,13 @@ files:
 - lib/relax/parameter.rb
 - lib/relax/performer.rb
 - lib/relax/service.rb
+- spec/relax/context_spec.rb
 - spec/relax/endpoint_spec.rb
 - spec/relax/integration_spec.rb
 - spec/relax/service_spec.rb
 - spec/services/flickr.rb
+- spec/services/service_with_custom_parser.rb
 - spec/spec_helper.rb
-- README
 has_rdoc: true
 homepage: http://github.com/tylerhunt/relax
 post_install_message: 
@@ -117,8 +119,10 @@ signing_key:
 specification_version: 2
 summary: A flexible library for creating web service consumers.
 test_files: 
+- spec/relax/context_spec.rb
 - spec/relax/endpoint_spec.rb
 - spec/relax/integration_spec.rb
 - spec/relax/service_spec.rb
 - spec/services/flickr.rb
+- spec/services/service_with_custom_parser.rb
 - spec/spec_helper.rb