remote_api 0.1.0

data/test/base_test.rb

@@ -0,0 +1,58 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+FakeWeb.register_uri(
+  'http://test.com/base', 
+  :string => '<server_response>The server recieved your message</server_response>'
+)
+FakeWeb.register_uri(
+  'http://test.com/base/error', 
+  :string => '<server_response>An error occurred!</server_response>'
+)
+
+class RemoteApiTest < Test::Unit::TestCase
+  
+  def setup
+    BaseApi.url = 'http://test.com/base'
+  end
+  
+  def test_initialize_should_set_hash_keys_as_instance_variables
+    result = BaseApi.new(:foo => 'bar', :baz => 'taz', :message => 'Hello')
+    
+    assert_equal('bar',   result.instance_eval { @foo })
+    assert_equal('taz',   result.instance_eval { @baz })
+    assert_equal('Hello', result.instance_eval { @message })
+  end
+  
+  def test_initialize_should_perform_api_call
+    result = BaseApi.new(:message => 'Hello World!')
+    assert_equal 'The server recieved your message', result.return_message
+  end
+  
+  def test_assert_success_should_raise_exception
+    BaseApi.url = 'http://test.com/base/error'
+    assert_raise RemoteAPI::ResponseFailure do
+      BaseApi.new(:message => 'foo')
+    end
+  end
+end
+
+
+class BaseApi < RemoteAPI
+  attr_reader :return_message
+  
+  def request
+    x = Builder::XmlMarkup.new
+    x.my_request @message
+  end
+  
+  def assert_success
+    if @response =~ %r{<server_response>(.*error.*)</server_response>}
+      raise ResponseFailure, $1
+    end
+  end
+  
+  def process
+    @return_message = @response.gsub(%r{</?server_response>}, '')
+  end
+  
+end

data/test/test_helper.rb

@@ -0,0 +1,7 @@
+require 'test/unit'
+
+require 'rubygems'
+require 'fake_web'
+require 'builder'
+
+require File.dirname(__FILE__) + '/../lib/remote_api'

data/test/xml_response_test.rb

@@ -0,0 +1,77 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class XmlResponseTest < Test::Unit::TestCase
+  
+  XML = <<XML
+<response>
+  <title>Test Title</title>
+  <items>
+    <item>
+      <name>Bob</name>
+      <id>1</id>
+    </item>
+    <item>
+      <name>Joe</name>
+      <id>2</id>
+    </item>
+    <item>
+      <name>Walter</name>
+      <id>3</id>
+    </item>
+  </items>
+</response>
+XML
+  
+  def setup
+    @xml = RemoteAPI::XML::Response.new(XML)
+  end
+  
+  def test_brace_accessor
+    assert_equal('Test Title', @xml['//title'])
+  end
+  
+  def test_bad_xpath_should_return_nil
+    assert_nil @xml['/foo/bar/baz']
+  end
+  
+  def test_each_on_bad_xpath_should_not_run_block
+    count = 0
+    @xml.each('/foo/bar/baz') { |node| count += 1 }
+    assert_equal(0, count)
+  end
+  
+  def test_each
+    expected_names = %w( Bob Joe Walter )
+    expected_ids   = %w( 1 2 3 )
+    count          = 0
+    
+    @xml.each '//items/item' do |node|
+      count += 1
+      assert_equal(expected_names.shift, node['name'])
+      assert_equal(expected_ids.shift,   node['id'])
+    end
+    
+    assert_equal(3, count)
+  end
+  
+  def test_each_without_block_should_raise_exception
+    assert_raise(ArgumentError) do
+      @xml.each('//title')
+    end
+  end
+  
+  def test_to_formatted_s
+    input = '<a><b><c>foo</c></b></a>'
+    expected = <<XML
+<a>
+  <b>
+    <c>foo</c>
+  </b>
+</a>
+XML
+    xml_response = RemoteAPI::XML::Response.new(input)
+    
+    assert_equal(expected.chomp, xml_response.to_formatted_s)
+  end
+  
+end

data/test/xml_test.rb

@@ -0,0 +1,63 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+FakeWeb.register_uri(
+  'http://test.com/xml', 
+  :string => '<foo><server_response>The server recieved your message</server_response></foo>'
+)
+FakeWeb.register_uri(
+  'http://test.com/xml/error', 
+  :string => '<server_response><error>Big fat error</error></server_response>'
+)
+
+class RemoteApiXMLTest < Test::Unit::TestCase
+  
+  def setup
+    XmlApi.url = 'http://test.com/xml'
+  end
+  
+  def test_response_should_be_xml
+    result = XmlApi.new(:message => 'foo')
+    assert_equal('The server recieved your message', result.return_message)
+  end
+  
+  def test_format_response_should_produce_pretty_xml
+    expected = <<XML
+<foo>
+  <server_response>The server recieved your message</server_response>
+</foo>
+XML
+    
+    result = XmlApi.new(:message => 'foo')
+    data = result.send(:format_response, '<foo><server_response>The server recieved your message</server_response></foo>')
+    assert_equal(expected.chomp, data)
+  end
+  
+  def test_assert_success_should_raise_exceptions
+    XmlApi.url = 'http://test.com/xml/error'
+    assert_raise RemoteAPI::ResponseFailure do
+      XmlApi.new(:message => 'foo')
+    end
+  end
+  
+end
+
+
+class XmlApi < RemoteAPI::XML
+  attr_reader :return_message
+  
+  def request
+    x = Builder::XmlMarkup.new
+    x.my_request @message
+  end
+  
+  def assert_success
+  	if error = @response['/server_response/error']
+      raise ResponseFailure, error
+    end
+  end
+  
+  def process
+    @return_message = @response['/foo/server_response']
+  end
+  
+end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.9.0
+specification_version: 1
+name: remote_api
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+date: 2007-01-15 00:00:00 -08:00
+summary: Provides a basic framework for easily creating classes that access remote APIs.
+require_paths: 
+- lib
+email: rubyonrails@beautifulpixel.com
+homepage: http://remote-api.rubyforge.org
+rubyforge_project: remote-api
+description: Provides a basic framework for easily creating classes that access remote APIs.
+autorequire: 
+default_executable: 
+bindir: bin
+has_rdoc: true
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 0.0.0
+  version: 
+platform: ruby
+signing_key: 
+cert_chain: 
+post_install_message: 
+authors: 
+- Alex Wayne
+files: 
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- setup.rb
+- lib/dsl_accessor.rb
+- lib/remote_api.rb
+- lib/remote_api/base.rb
+- lib/remote_api/xml.rb
+- lib/remote_api/xml_response.rb
+- lib/remote_api/version.rb
+- test/test_helper.rb
+- test/base_test.rb
+- test/xml_test.rb
+- test/xml_response_test.rb
+test_files: 
+- test/base_test.rb
+- test/xml_response_test.rb
+- test/xml_test.rb
+rdoc_options: []
+
+extra_rdoc_files: []
+
+executables: []
+
+extensions: []
+
+requirements: []
+
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Version::Requirement 
+    requirements: 
+    - - ">"
+      - !ruby/object:Gem::Version 
+        version: 0.0.0
+    version: