relax 0.1.3 → 0.2.0

data/lib/relax/service.rb

@@ -1,45 +0,0 @@
-module Relax
-  class Service
-    def initialize(values={}, options={})
-      @values = values
-      @options = options
-    end
-
-    def authenticate(*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
-
-    class << self
-      include Contextable
-
-      def endpoint(url, options={}, &block)
-        Endpoint.new(self, url, options, &block)
-      end
-
-      def register_action(action) # :nodoc:
-        @actions ||= {}
-
-        unless @actions[action.name]
-          @actions[action.name] = action.name
-
-          define_method(action.name) do |*args|
-            action.execute(@values, @options, *args)
-          end
-        else
-          raise ArgumentError.new("Duplicate action '#{action.name}'.") 
-        end
-      end
-    end
-  end
-end

data/spec/relax/context_spec.rb

@@ -1,18 +0,0 @@
-require File.join(File.dirname(__FILE__), '..', 'spec_helper')
-
-describe Relax::Context do
-  it "utilizes a custom parser for Class parsers" do
-    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/relax/endpoint_spec.rb

@@ -1,99 +0,0 @@
-require File.join(File.dirname(__FILE__), '..', 'spec_helper')
-
-describe Relax::Endpoint do
-  it "provides access to the URL" do
-    service = Class.new(Relax::Service)
-    endpoint = service.endpoint("http://api.example.com/") { }
-    endpoint.url.should == "http://api.example.com/"
-  end
-
-  it "allows contextual defaults to be set" do
-    service = Class.new(Relax::Service)
-    endpoint = service.endpoint("http://api.example.com/") { }
-    endpoint.should respond_to(:defaults)
-  end
-
-  describe "actions" 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) { } }
-      end
-
-      proc {
-        service.new.fetch
-      }.should raise_error(ArgumentError, /missing.*api_key/i)
-    end
-
-    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 }
-          action(:fetch) { }
-        end
-      end
-
-      proc {
-        service.new.fetch
-      }.should raise_error(ArgumentError, /missing.*operation/i)
-    end
-
-    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 }
-        end
-      end
-
-      proc {
-        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
-    it "is callable from within an Endpoint" do
-      service = Class.new(Relax::Service)
-      endpoint = service.endpoint("http://api.example.com/") { }
-      endpoint.should respond_to(:action)
-    end
-
-    it "defines an instance method by the same name on the Service" do
-      service = Class.new(Relax::Service)
-      service.new.should_not respond_to(:fetch)
-
-      service.endpoint("http://api.example.com/") { action :fetch }
-      service.new.should respond_to(:fetch)
-    end
-  end
-end

data/spec/relax/integration_spec.rb

@@ -1,63 +0,0 @@
-require File.join(File.dirname(__FILE__), '..', 'spec_helper')
-
-describe "an example service's" do
-  describe "get_photos action" do
-    it "includes :get_photos" do
-      Flickr.new.should respond_to(:get_photos)
-    end
-
-    it "requires an API key" do
-      proc {
-        Flickr.new.get_photos
-      }.should raise_error(ArgumentError, /missing.*api_key/i)
-    end
-
-    it "requires a user ID" do
-      proc {
-        Flickr.new(:api_key => 'secret').get_photos
-      }.should raise_error(ArgumentError, /missing.*user_id/i)
-    end
-
-    it "parses the response" do
-      flickr = Flickr.new(:api_key => 'secret')
-      flickr.get_photos(:user_id => '59532755@N00', :per_page => 3).should == {
-        :status => 'ok',
-        :photos => {
-          :total => '7830',
-          :photo => [
-            { :ispublic => '1', :isfriend => '0', :owner => '59532755@N00', :isfamily => '0', :secret => '2ebe0307e3', :server => '3562', :farm => '4', :id => '3508500178', :title => 'Rich Kilmer'},
-            {:ispublic => '1', :isfriend => '0', :owner => '59532755@N00', :isfamily => '0', :secret => '10b217377b', :server => '3593', :farm => '4', :id => '3508500140', :title => 'Women In Rails'},
-            {:ispublic => '1', :isfriend => '0', :owner => '59532755@N00', :isfamily => '0', :secret => '83bc8fbf71', :server => '3620', :farm => '4', :id => '3507688713', :title => 'Obie Fernandez'}
-          ],
-          :per_page => '3',
-          :pages => '2610',
-          :page => '1'
-        }
-      }
-    end
-  end
-
-  describe "get_user_by_username action" do
-    it "includes :get_user_by_username" do
-      Flickr.new.should respond_to(:get_user_by_username)
-    end
-
-    it "requires an API key" do
-      proc {
-        Flickr.new.get_user_by_username
-      }.should raise_error(ArgumentError, /missing.*api_key/i)
-    end
-
-    it "parses the response" do
-      flickr = Flickr.new(:api_key => 'secret')
-      flickr.get_user_by_username(:username => 'duncandavidson').should == {
-        :user => {
-          :username => 'duncandavidson',
-          :nsid => '59532755@N00',
-          :id => '59532755@N00'
-        },
-        :status => 'ok'
-      }
-    end
-  end
-end

data/spec/relax/service_spec.rb

@@ -1,32 +0,0 @@
-require File.join(File.dirname(__FILE__), '..', 'spec_helper')
-
-describe Relax::Service do
-  it "allows contextual defaults to be set" 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)
-    end
-
-    it "creates a new Endpoint" do
-      Relax::Endpoint.should_receive(:new)
-
-      class Service < Relax::Service
-        endpoint "http://api.example.com/"
-      end
-    end
-  end
-end

data/spec/services/blank_values_service.rb

@@ -1,19 +0,0 @@
-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/custom_parser_service.rb

@@ -1,24 +0,0 @@
-class TestCustomParser
-  def initialize(options = {}, &block)
-  end
-
-  def parse(input)
-    'parsed'
-  end
-end
-
-class CustomParserService < 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/services/flickr.rb

@@ -1,78 +0,0 @@
-class Flickr < Relax::Service
-  defaults do
-    parameter :api_key, :required => true
-  end
-
-  endpoint "http://api.flickr.com/services/rest" do
-    defaults do
-      parameter :method, :required => true
-    end
-
-    action :get_photos do
-      set :method, "flickr.people.getPublicPhotos"
-      parameter :user_id, :required => true
-      parameter :safe_search
-      parameter :extras
-      parameter :per_page
-      parameter :page
-
-      parser :rsp do
-        element :status, :attribute => :stat
-
-        element :photos do
-          element :page, :attribute => true
-          element :pages, :attribute => true
-          element :per_page, :attribute => :perpage
-          element :total, :attribute => true
-
-          elements :photo do
-            element :id, :attribute => true
-            element :owner, :attribute => true
-            element :secret, :attribute => true
-            element :server, :attribute => true
-            element :farm, :attribute => true
-            element :title, :attribute => true
-            element :ispublic, :attribute => true
-            element :isfriend, :attribute => true
-            element :isfamily, :attribute => true
-          end
-        end
-      end
-    end
-
-    action :get_user_by_username do
-      set :method, "flickr.people.findByUsername"
-      parameter :username, :required => true
-
-      parser :rsp do
-        element :status, :attribute => :stat
-
-        element :user do
-          element :id, :attribute => true
-          element :nsid, :attribute => true
-          element :username
-        end
-      end
-    end
-  end
-end
-
-FakeWeb.register_uri(:get, 'http://api.flickr.com/services/rest?api_key=secret&method=flickr.people.findByUsername&username=duncandavidson', :string => <<-RESPONSE)
-  <?xml version="1.0" encoding="utf-8" ?>
-  <rsp stat="ok">
-    <user id="59532755@N00" nsid="59532755@N00">
-      <username>duncandavidson</username>
-    </user>
-  </rsp>
-RESPONSE
-
-FakeWeb.register_uri(:get, 'http://api.flickr.com/services/rest?user_id=59532755@N00&per_page=3&method=flickr.people.getPublicPhotos&api_key=secret', :string => <<-RESPONSE)
-<?xml version="1.0" encoding="utf-8" ?>
-<rsp stat="ok">
-  <photos page="1" pages="2610" perpage="3" total="7830">
-    <photo id="3508500178" owner="59532755@N00" secret="2ebe0307e3" server="3562" farm="4" title="Rich Kilmer" ispublic="1" isfriend="0" isfamily="0" />
-    <photo id="3508500140" owner="59532755@N00" secret="10b217377b" server="3593" farm="4" title="Women In Rails" ispublic="1" isfriend="0" isfamily="0" />
-    <photo id="3507688713" owner="59532755@N00" secret="83bc8fbf71" server="3620" farm="4" title="Obie Fernandez" ispublic="1" isfriend="0" isfamily="0" />
-  </photos>
-</rsp>
-RESPONSE

data/spec/services/parameter_alias_service.rb

@@ -1,17 +0,0 @@
-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