tylerhunt-relax 0.0.5 → 0.1.1

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

@@ -0,0 +1,13 @@
+$:.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')
+require File.join(File.dirname(__FILE__), 'services', 'service_with_custom_parser')

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: tylerhunt-relax
 version: !ruby/object:Gem::Version 
-  version: 0.0.5
+  version: 0.1.1
 platform: ruby
 authors: 
 - Tyler Hunt
@@ -9,17 +9,58 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-10-20 00:00:00 -07:00
+date: 2009-06-03 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
@@ -28,36 +69,34 @@ executables: []
 extensions: []
 
 extra_rdoc_files: 
-- README
 - LICENSE
+- README.rdoc
 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
-- lib/relax.rb
-- 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
-- README
 - LICENSE
+- README.rdoc
+- 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/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
 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 
@@ -78,12 +117,12 @@ rubyforge_project: relax
 rubygems_version: 1.2.0
 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/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

data/README

@@ -1,171 +0,0 @@
-= 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.rb

@@ -1,13 +0,0 @@
-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/parsers/base.rb

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