tylerhunt-relax 0.0.5

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2007-2008 Tyler Hunt
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README

@@ -0,0 +1,171 @@
+= Relax
+
+Relax is a simple library that provides a foundation for writing REST consumer
+APIs, including the logic to handle the HTTP requests, build URLs with query
+parameters, and parse XML responses.
+
+It provides a basic set of functionality common to most REST consumers:
+
+- building HTTP queries (Relax::Request)
+- issuing HTTP requests (Relax::Service)
+- parsing XML responses (Relax::Response)
+
+
+== Tutorial
+
+This short tutorial will walk you through the basic steps of creating a simple Flickr API that supports a single call to search for photos by tags.
+
+=== Step 1
+
+In the first step we're going to simply include Relax, and define the basis for
+our Service class.
+
+  require 'rubygems'
+  require 'relax'
+
+  module Flickr
+    class Service < Relax::Service
+      ENDPOINT = 'http://api.flickr.com/services/rest/'
+
+      def initialize
+        super(ENDPOINT)
+      end
+    end
+  end
+
+
+=== Step 2
+
+Next we're going to define common Request and Response classes for use
+throughout our API. This gives us a single point to add any shared
+functionality. For Flickr, this means that each request will have a "method"
+parameter, and each response will have a "stat" attribute that will equal "ok"
+when the response comes back without any errors.
+
+  module Flickr
+    class Request < Relax::Request
+      parameter :method
+    end
+
+    class Response < Relax::Response
+      def successful?
+        root[:stat] == 'ok'
+      end
+    end
+  end
+
+While we're at it, we're also going to add a new line to the constructor from
+our service to make sure that our Flickr API key gets passed along with each
+request as well.
+
+  module Flickr
+    class Service < Relax::Service
+      ENDPOINT = 'http://api.flickr.com/services/rest/'
+      
+      def initialize(api_key)
+        super(ENDPOINT)
+        Request[:api_key] = api_key
+      end
+    end
+  end
+
+When we call our Request class as we have here, we're basically setting up a
+value on our request that acts like a template. Each request we create now will
+have the api_key property prepopulated for us.
+
+
+=== Step 3
+
+Next, we're going to need a basic Photo class to represent photos that Flickr
+returns to us.
+
+  module Flickr
+    class Photo < Response
+      parameter :id, :attribute => true, :type => :integer
+      parameter :title, :attribute => true
+    end
+  end
+
+Here we're creating a Response class that extends our Flickr::Response, which
+has two parameters: "id" and "title." By setting the attribute option to true,
+we're telling Relax to look for an attribute by that name on the XML root
+instead of checking for an element by that name. The type options can be used
+to specify what type of data we're expecting the response to give us. The
+default type is string.
+
+
+=== Step 4
+
+Now we arrive at the final piece of the puzzle: a service call module. To keep
+things contained, a Relax best practice is to create a module for each call
+on your service. The one we're creating here is the PhotoSearch module for the
+"flickr.photos.search" call on the Flickr API.
+
+There are three main pieces to every service call module:
+
+1. a Relax::Request object
+2. a Relax::Response object
+3. a call method that calls Relax::Service#call
+
+Here's what the PhotoSearch module looks like:
+
+  module Flickr
+    module PhotoSearch
+      class PhotoSearchRequest < Flickr::Request
+        parameter :per_page
+        parameter :tags
+
+        def initialize(options = {})
+          super
+          @method = 'flickr.photos.search'
+        end
+      end
+
+      class PhotoSearchResponse < Flickr::Response
+        parameter :photos, :element => 'photos/photo', :collection => Photo
+      end
+
+      def search(options = {})
+        call(PhotoSearchRequest.new(options), PhotoSearchResponse)
+      end
+
+      def find_by_tag(tags, options = {})
+        search(options.merge(:tags => tags))
+      end
+    end
+  end
+
+As you can see, we have our request (PhotoSearchRequest), response
+(PhotoSearchResponse), and call method (actually, two in this case: search and
+ find_by_tag). This now needs to be included into our Flickr::Service class,
+and then we'll be able to use it by calling either of the call methods.
+
+  module Flickr
+    class Service < Relax::Service
+      include Flickr::PhotoSearch
+
+      ENDPOINT = 'http://api.flickr.com/services/rest/'
+      
+      def initialize(api_key)
+        super(ENDPOINT)
+        Request[:api_key] = api_key
+      end
+    end
+  end
+
+Now we're ready to make a call against the API:
+
+  flickr = Flickr::Service.new(ENV['FLICKR_API_KEY'])
+  relax = flickr.find_by_tag('relax', :per_page => 10)
+
+  if relax.successful?
+    relax.photos.each do |photo|
+      puts "[#{photo.id}] #{photo.title}"
+    end
+  end
+
+This will output the IDs and titles for the first 10 photos on Flickr that have
+the tag "relax."
+
+
+Copyright (c) 2007-2008 Tyler Hunt, released under the MIT license

data/lib/relax/parsers/base.rb

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

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

data/lib/relax/parsers/hpricot.rb

@@ -0,0 +1,145 @@
+require 'rubygems'
+require 'hpricot'
+
+module Relax
+  module Parsers
+    
+    ##
+    # Parses the server's raw response using the Hpricot library.
+    # 
+    class Hpricot < Base
+      
+      FACTORY_NAME = :hpricot
+      
+      def initialize(raw, parent)
+        @xml = ::Hpricot.XML(raw)
+        super(raw, parent)
+      end
+      
+      def parse!
+        if parameters
+          parameters.each do |parameter, options|
+            begin
+              element = options[:element] || parameter
+
+              if attribute = options[:attribute] and attribute == true
+                node = attribute(root, element)
+              elsif attribute
+                node = attribute(element(element), attribute)
+              elsif options[:collection]
+                node = elements(element)
+              else
+                node = element(element)
+              end
+
+              if options[:collection]
+                value = node.collect do |element|
+                  options[:collection].new(element)
+                end
+              else
+                case type = options[:type]
+                  when Response
+                    value = type.new(node)
+
+                  when :date
+                    value = date_value(node)
+
+                  when :time
+                    value = time_value(node)
+
+                  when :float
+                    value = float_value(node)
+
+                  when :integer
+                    value = integer_value(node)
+
+                  when :text
+                  else
+                    value = text_value(node)
+                end
+              end
+
+              parent.instance_variable_set("@#{parameter}", value)
+            rescue ::Hpricot::Error
+              raise Relax::MissingParameter if options[:required]
+            end
+          end
+        end
+      end
+      
+      # Returns the root of the XML document.
+      def root
+        @xml.root
+      end
+      
+      # Checks the name of the root node.
+      def is?(name)
+        root.name.gsub(/.*:(.*)/, '\1') == node_name(name)
+      end
+      
+      # Returns a set of elements matching name.
+      def elements(name)
+        root.search(root_path(name))
+      end
+      
+      # Returns an element of the specified name.
+      def element(name)
+        root.at(root_path(name))
+      end
+      alias :has? :element
+      
+      # Returns an attribute on an element.
+      def attribute(element, name)
+        element[name]
+      end
+
+      # Gets the value of an element or attribute.
+      def value(value)
+        value.is_a?(::Hpricot::Elem) ? value.inner_text : value.to_s
+      end
+      
+      # Gets a text value.
+      def text_value(value)
+        value(value)
+      end
+
+      # Gets an integer value.
+      def integer_value(value)
+        value(value).to_i
+      end
+
+      # Gets a float value.
+      def float_value(value)
+        value(value).to_f
+      end
+
+      # Gets a date value.
+      def date_value(value)
+        Date.parse(value(value))
+      end
+
+      # Gets a time value.
+      def time_value(value)
+        Time.parse(value(value))
+      end
+      
+      
+      private
+      
+      
+      # Converts a name to a node name.
+      def node_name(name)
+        name.to_s
+      end
+
+      # Gets the XPath expression representing the root node.
+      def root_path(name)
+        "/#{node_name(name)}"
+      end
+      
+    end
+    
+    Factory.register(Hpricot::FACTORY_NAME, Hpricot)
+    
+  end
+end

data/lib/relax/parsers/rexml.rb

@@ -0,0 +1,158 @@
+require 'rubygems'
+require 'rexml/document'
+
+module Relax
+  module Parsers
+    
+    ##
+    # Parsers the server's response using the REXML library.
+    # 
+    # Benefits:
+    #
+    # * XML Namespace support (parameter :foo, :namespace => 'bar')
+    # 
+    # Drawbacks:
+    #
+    # * Case sensitive field names (<Status>..</> != parameter :status)
+    # 
+    class REXML < Base
+      
+      FACTORY_NAME = :rexml
+      
+      def initialize(raw, parent)
+        @xml = ::REXML::Document.new(raw)
+        super(raw, parent)
+      end
+      
+      def parse!
+        if parameters
+          parameters.each do |parameter, options|
+            begin
+              element = options[:element] || parameter
+              namespace = options[:namespace]
+            
+              if attribute = options[:attribute] and attribute == true
+                node = attribute(root, element, namespace)
+              elsif attribute
+                node = attribute(element(element), attribute, namespace)
+              elsif options[:collection]
+                node = elements(element, namespace)
+              else
+                node = element(element, namespace)
+              end
+              
+              if options[:collection]
+                value = node.collect do |element|
+                  options[:collection].new(element.deep_clone)
+                end
+              else
+                case type = options[:type]
+                  when Response
+                    value = type.new(node)
+            
+                  when :date
+                    value = date_value(node)
+            
+                  when :time
+                    value = time_value(node)
+            
+                  when :float
+                    value = float_value(node)
+            
+                  when :integer
+                    value = integer_value(node)
+            
+                  when :text
+                  else
+                    value = text_value(node)
+                end
+              end
+            
+              parent.instance_variable_set("@#{parameter}", value)
+            rescue
+              raise(Relax::MissingParameter) if node.nil? && options[:required]
+            end
+          end
+        end
+      end
+      
+      # Returns the root of the XML document.
+      def root
+        @xml.root
+      end
+      
+      # Checks the name of the root node.
+      def is?(name, namespace = nil)
+        root.name == node_name(name, nil)
+      end
+      
+      # Returns a set of elements matching name.
+      def elements(name, namespace = nil)
+        root.get_elements(node_path(name, namespace))
+      end
+      
+      # Returns an element of the specified name.
+      def element(name, namespace = nil)
+        root.elements[node_path(name, namespace)]
+      end
+      alias :has? :element
+      
+      # Returns an attribute on an element.
+      def attribute(element, name, namespace = nil)
+        element.attribute(name)
+      end
+
+      # Gets the value of an element or attribute.
+      def value(value)
+        value.is_a?(::REXML::Element) ? value.text : value.to_s
+      end
+      
+      # Gets a text value.
+      def text_value(value)
+        value(value)
+      end
+
+      # Gets an integer value.
+      def integer_value(value)
+        value(value).to_i
+      end
+
+      # Gets a float value.
+      def float_value(value)
+        value(value).to_f
+      end
+
+      # Gets a date value.
+      def date_value(value)
+        Date.parse(value(value))
+      end
+
+      # Gets a time value.
+      def time_value(value)
+        Time.parse(value(value))
+      end
+      
+      
+      private
+      
+      
+      # Converts a name to a node name.
+      def node_name(name, namespace = nil)
+        "#{namespace.to_s + ':' if namespace}#{name}"
+      end
+
+      # Gets the XPath expression representing the root node.
+      def root_path(name)
+        "/#{node_name(name)}"
+      end
+      
+      def node_path(name, namespace = nil)
+        "#{node_name(name, namespace)}"
+      end
+      
+    end
+    
+    Factory.register(REXML::FACTORY_NAME, REXML)
+    
+  end
+end

data/lib/relax/parsers.rb

@@ -0,0 +1,13 @@
+require 'date'
+require 'time'
+
+require 'relax/parsers/factory'
+require 'relax/parsers/base'
+
+require 'relax/parsers/hpricot'
+require 'relax/parsers/rexml'
+
+module Relax
+  module Parsers
+  end
+end

data/lib/relax/query.rb

@@ -0,0 +1,46 @@
+require 'cgi'
+require 'uri'
+
+require 'relax/symbolic_hash'
+
+module Relax
+  # Query is used to represent the query portion of a URL. It's basically just
+  # a hash, where each key/value pair is a query parameter.
+  class Query < SymbolicHash
+    # Converts the Query to a query string for use in a URL.
+    def to_s
+      keys.sort { |a, b| a.to_s <=> b.to_s }.collect do |key|
+        "#{key.to_s}=#{self.class.escape_value(fetch(key))}"
+      end.join('&')
+    end
+
+    class << self
+      # Parses a URL and returns a Query with its query portion.
+      def parse(uri)
+        query = uri.query.split('&').inject({}) do |query, parameter|
+          key, value = parameter.split('=', 2)
+          query[unescape_value(key)] = unescape_value(value)
+          query
+        end
+        self.new(query)
+      end
+
+      # Escapes a query parameter value.
+      def escape_value(value)
+        CGI.escape(value.to_s).gsub('%20', '+')
+      end
+
+      # Unescapes a query parameter value.
+      def unescape_value(value)
+        CGI.unescape(value)
+      end
+    end
+
+    protected
+
+    # Converts each value of the Query to a string as it's added.
+    def convert_value(value)
+      value.to_s
+    end
+  end
+end