relax 0.0.7 → 0.1.0

data/lib/relax/service.rb

@@ -1,101 +1,32 @@
-require 'openssl'
-require 'net/https'
-require 'uri'
-require 'date'
-require 'base64'
-require 'erb'
-
 module Relax
-  # Service is the starting point for any REST consumer written with Relax. It
-  # is responsible for setting up the endpoint for the service, and issuing the
-  # HTTP requests for each call made.
-  #
-  # == Extending Service
-  #
-  # When writing consumers, you should start by extending Service by inheriting
-  # from it and calling its constructor with the endpoint for the service.
-  #
-  # === Example
-  #
-  #   class Service < Relax::Service
-  #     ENDPOINT = 'http://example.com/services/rest/'
-  #
-  #     def initialize
-  #       super(ENDPOINT)
-  #     end
-  #   end
-  #
-  # == Calling a Service
-  #
-  # Each call made to the service goes through the #call method of Service,
-  # which takes in a Request object and a Response class. The Request object is
-  # used to generate the query string that will be passed to the endpoint. The
-  # Reponse class is instantiated with the body of the response from the HTTP
-  # request.
-  #
-  # === Example
-  #
-  # This example show how to create a barebones call. This module can be then
-  # included into your Service class.
-  #
-  #   module Search
-  #     class SearchRequest < Relax::Request
-  #     end
-  #
-  #     class SearchResponse < Relax::Response
-  #     end
-  #
-  #     def search(options = {})
-  #       call(SearchRequest.new(options), SearchResponse)
-  #     end
-  #   end
-  #
   class Service
-    attr_reader :endpoint
-
-    # This constructor should be called from your Service with the endpoint URL
-    # for the REST service.
-    def initialize(endpoint)
-      @endpoint = URI::parse(endpoint)
+    def initialize(values={})
+      @values = values
     end
 
-    protected
-
-    # Calls the service using a query built from the Request object passed in
-    # as its first parameter. Once the response comes back from the service,
-    # the body of the response is used to instantiate the response class, and
-    # this response object is returned.
-    def call(request, response_class)
-      request.valid?
-      uri = @endpoint.clone
-      uri.query = query(request).to_s
-      response = request(uri)
-      puts "Response:\n#{response.body}\n\n" if $DEBUG
-      response_class.new(response.body)
+    def authenticate(*args)
+      @credentials = args
     end
 
-    private
-
-    def default_query
-      Query.new
-    end
+    class << self
+      include Contextable
 
-    def query(request)
-      Query.new(default_query.merge(request.to_query))
-    end
+      def endpoint(url, options={}, &block)
+        Endpoint.new(self, url, options, &block)
+      end
 
-    def request(uri)
-      puts "Request:\n#{uri.to_s}\n\n" if $DEBUG
-      http = Net::HTTP.new(uri.host, uri.port)
+      def register_action(action) # :nodoc:
+        @actions ||= {}
 
-      if uri.scheme == 'https'
-        http.use_ssl = true
-        http.verify_mode = OpenSSL::SSL::VERIFY_NONE
-      end
+        unless @actions[action.name]
+          @actions[action.name] = action.name
 
-      http.start do |http|
-        request = Net::HTTP::Get.new("#{uri.path}?#{uri.query}")
-        http.request(request)
+          define_method(action.name) do |*args|
+            action.execute(@values, @credentials, *args)
+          end
+        else
+          raise ArgumentError.new("Duplicate action '#{action.name}'.") 
+        end
       end
     end
   end

data/lib/relax.rb

@@ -1,13 +1,18 @@
-$:.unshift(File.dirname(__FILE__)) unless $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+require 'rubygems'
 
-require 'relax/query'
-require 'relax/parsers'
-require 'relax/request'
-require 'relax/response'
-require 'relax/service'
-require 'relax/symbolic_hash'
+gem 'relief', '~> 0.0.2'
+require 'relief'
 
-module Relax
-  class MissingParameter < ArgumentError ; end
-  class UnrecognizedParser < ArgumentError ; end
+gem 'rest-client', '~> 0.9.2'
+require 'restclient'
+
+module Relax # :nodoc:
+  autoload :Action, 'relax/action'
+  autoload :Context, 'relax/context'
+  autoload :Contextable, 'relax/contextable'
+  autoload :Endpoint, 'relax/endpoint'
+  autoload :Instance, 'relax/instance'
+  autoload :Parameter, 'relax/parameter'
+  autoload :Performer, 'relax/performer'
+  autoload :Service, 'relax/service'
 end

data/spec/relax/endpoint_spec.rb

@@ -0,0 +1,69 @@
+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 "actions 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 "actions 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 "actions 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
+  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

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

@@ -0,0 +1,21 @@
+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 ".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/flickr.rb

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

@@ -0,0 +1,12 @@
+$:.push File.join(File.dirname(__FILE__), '..', 'lib')
+
+require 'rubygems'
+
+gem 'rspec', '~> 1.2.2'
+require 'spec'
+
+gem 'fakeweb', '~> 1.2.2'
+require 'fakeweb'
+
+require File.join(File.dirname(__FILE__), '..', 'lib', 'relax')
+require File.join(File.dirname(__FILE__), 'services', 'flickr')

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: relax
 version: !ruby/object:Gem::Version 
-  version: 0.0.7
+  version: 0.1.0
 platform: ruby
 authors: 
 - Tyler Hunt
@@ -9,18 +9,58 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-04-27 00:00:00 -04:00
+date: 2009-05-07 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: hpricot
+  name: rest-client
   type: :runtime
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
-        version: "0.6"
+        version: 0.9.2
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: nokogiri
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.2.3
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: relief
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.0.3
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.11.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.2.2
     version: 
 description: 
 email: tyler@tylerhunt.com
@@ -29,29 +69,32 @@ executables: []
 extensions: []
 
 extra_rdoc_files: 
-- README
 - LICENSE
+- README
 files: 
-- lib/relax
-- lib/relax/parsers
-- lib/relax/parsers/base.rb
-- lib/relax/parsers/factory.rb
-- lib/relax/parsers/hpricot.rb
-- lib/relax/parsers/rexml.rb
-- lib/relax/parsers.rb
-- lib/relax/query.rb
-- lib/relax/request.rb
-- lib/relax/response.rb
-- lib/relax/service.rb
-- lib/relax/symbolic_hash.rb
+- LICENSE
+- Rakefile
+- VERSION.yml
 - lib/relax.rb
+- lib/relax/action.rb
+- lib/relax/context.rb
+- lib/relax/contextable.rb
+- lib/relax/endpoint.rb
+- lib/relax/instance.rb
+- lib/relax/parameter.rb
+- lib/relax/performer.rb
+- lib/relax/service.rb
+- spec/relax/endpoint_spec.rb
+- spec/relax/integration_spec.rb
+- spec/relax/service_spec.rb
+- spec/services/flickr.rb
+- spec/spec_helper.rb
 - README
-- LICENSE
 has_rdoc: true
-homepage: http://tylerhunt.com/
+homepage: http://github.com/tylerhunt/relax
 post_install_message: 
-rdoc_options: []
-
+rdoc_options: 
+- --charset=UTF-8
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -72,12 +115,10 @@ rubyforge_project: relax
 rubygems_version: 1.3.1
 signing_key: 
 specification_version: 2
-summary: A simple library for creating REST consumers.
+summary: A flexible library for creating web service consumers.
 test_files: 
-- 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
+- spec/relax/endpoint_spec.rb
+- spec/relax/integration_spec.rb
+- spec/relax/service_spec.rb
+- spec/services/flickr.rb
+- spec/spec_helper.rb

data/lib/relax/parsers/base.rb

@@ -1,30 +0,0 @@
-module Relax
-  module Parsers
-    class Base
-      attr_reader :parent
-      attr_reader :parameters
-
-      def initialize(raw, 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
-      def integer_value(value); end
-      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,29 +0,0 @@
-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
-        # +name+.
-        def get(name)
-          @@parsers ||= {}
-          @@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,
-        # 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