spore 0.0.3

data/test/github1.yml

@@ -0,0 +1,14 @@
+--- 
+name: GitHub1
+methods: 
+  list_public_keys: 
+    authentication: true
+    method: GET
+    path: /:format/user/keys
+    required_params: 
+    - format
+meta: 
+  documentation: http://develop.github.com/
+base_url: http://github.com/api/v2/
+version: "0.2"
+authority: GITHUB:franckcuny

data/test/github2.yml

@@ -0,0 +1,15 @@
+--- 
+name: GitHub2
+methods: 
+  list_public_keys: 
+    authentication: true
+    method: GET
+    path: /:format/user/keys/:something_else
+    required_params: 
+    - format
+    - something_else
+meta: 
+  documentation: http://develop.github.com/
+base_url: http://github.com/api/v2/
+version: "0.2"
+authority: GITHUB:franckcuny

data/test/helper.rb

@@ -0,0 +1,12 @@
+# encoding: utf-8
+require 'rubygems'
+gem 'test-unit', '>= 2.1.0'
+require 'test/unit'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require "spore"
+require 'net/http'
+
+class Test::Unit::TestCase
+end

data/test/test_collapsing.rb

@@ -0,0 +1,13 @@
+# encoding: utf-8
+require 'helper'
+class TestCollapsing < Test::Unit::TestCase
+
+  test "Use of different api in same project" do
+    spore1 = Spore.new(File.expand_path('../github1.yml',__FILE__))
+    spore2 = Spore.new(File.expand_path('../github2.yml',__FILE__))
+    assert_nothing_raised do
+      spore1.list_public_keys(:format => :json)
+    end
+  end
+end
+

data/test/test_constructor.rb

@@ -0,0 +1,24 @@
+# encoding: utf-8
+require 'helper'
+
+class TestConstructor < Test::Unit::TestCase
+
+
+  def test_build_fail
+    assert_raise ArgumentError do
+      spore = Spore.new()
+    end
+  end
+
+  def test_build_github_json
+    github_spec = File.join(File.dirname(__FILE__), 'github.json')
+    spore = Spore.new(github_spec)
+    assert_kind_of Spore, spore
+
+    assert_equal 'http://github.com/api/v2', spore.base_url
+    assert_equal '0.2', spore.version
+    assert_equal '/:format/user/search/:search', spore.methods['user_search']['path']
+  end
+
+end
+

data/test/test_enable_if.rb

@@ -0,0 +1,37 @@
+# encoding: utf-8
+require 'helper'
+require 'spore/middleware/format'
+require 'net/http'
+
+class Spore
+  class Middleware
+    class FooBar < Spore::Middleware
+      def process_request(env)
+        [302, ['Location', 'http://www.google.com'], []]
+      end
+    end
+  end
+end
+
+class TestEnableIf < Test::Unit::TestCase
+
+
+  def test_build_github_json
+    github_spec = File.join(File.dirname(__FILE__), 'github.json')
+    spore = Spore.new(github_spec)
+    spore.enable(Spore::Middleware::Format, :format => 'json')
+
+    # user_search is not altered
+    r = spore.user_search(:format => 'json', :search => 'sukria')
+    assert_equal 'sukria', r.body['users'][0]['name']
+
+    spore.enable_if(Spore::Middleware::FooBar, {}) do |env|
+      env['spore.request_path'].match(/\/user\/search/)
+    end
+
+    # user_search is altered
+    r = spore.user_search(:format => 'json', :search => 'sukria')
+    assert_equal 302, r.code
+  end
+
+end

data/test/test_github.rb

@@ -0,0 +1,51 @@
+# encoding: utf-8
+require 'helper'
+require 'spore/middleware/format'
+
+class TestGitHub < Test::Unit::TestCase
+
+  def setup
+    json = File.expand_path( '../github.json', __FILE__)
+    yaml = File.expand_path( '../github.yml', __FILE__)
+    @specs  = [json,yaml]
+  end
+
+  def test_basic_github_search
+    @specs.each do |spec|
+      gh = Spore.new(spec)
+
+      r = gh.user_search(:format => 'json', :search => 'sukria')
+      assert_kind_of HTTP::Message, r
+      assert_equal r.status, 200
+      assert_kind_of String, r.body.content
+    end
+  end
+
+  def test_github_search_without_mandatory_param
+    @specs.each do |spec|
+      gh = Spore.new(spec)
+
+      assert_raise Spore::RequiredParameterExptected do
+        r = gh.user_search(:format => 'json')
+      end
+    end
+  end
+
+  def test_with_format_github_search
+    @specs.each do |spec|
+      gh = Spore.new(spec)
+
+      gh.enable(Spore::Middleware::Format, :format => 'json')
+
+      assert_equal 1, gh.middlewares.size
+
+      r = gh.user_search(:format => 'json', :search => 'sukria')
+      assert_kind_of HTTP::Message, r
+      assert_equal r.status, 200
+      assert_kind_of Hash, r.body
+      assert_equal 'sukria', r.body['users'][0]['name']
+    end
+  end
+
+end
+

data/test/test_middleware_runtime.rb

@@ -0,0 +1,22 @@
+# encoding: utf-8
+require 'helper'
+require 'spore/middleware/runtime'
+class TestRuntime < Test::Unit::TestCase
+
+  def test_with_format_github_search
+    github_spec = File.join(File.dirname(__FILE__), 'github.json')
+    gh = Spore.new(github_spec)
+    
+    gh.enable(Spore::Middleware::Runtime)
+    assert_equal 1, gh.middlewares.size
+
+    r = gh.user_search(:format => 'json', :search => 'sukria')
+    assert_kind_of HTTP::Message, r
+    assert_equal r.status, 200
+
+    assert_not_nil r.header['X-Spore-Runtime'][0]
+    assert r.header['X-Spore-Runtime'][0] > 0.00001
+  end
+
+end
+

data/test/test_parser.rb

@@ -0,0 +1,37 @@
+# encoding: utf-8
+require 'helper'
+require 'spore/spec_parser/yaml'
+require 'spore/spec_parser/json'
+require 'rexml/document'
+class TestParser < Test::Unit::TestCase
+
+  def test_yaml_parser
+    spec = File.expand_path('../github.yml', __FILE__)
+    specs = Spore::SpecParser::Yaml.load_file(spec)
+    assert_instance_of Hash, specs
+    assert specs.has_key?('name')
+  end
+
+  def test_json_parser
+    spec = File.expand_path('../github.json', __FILE__)
+    specs = Spore::SpecParser::Json.load_file(spec)
+    assert_instance_of Hash, specs
+    assert specs.has_key?('name')
+  end
+
+  def test_custom_parser
+    file = File.expand_path('../xml_parser.rb', __FILE__)
+    spec = File.expand_path('../github.xml',__FILE__)
+
+    begin
+      parser = Spore.load_parser(spec, :require => file, :parser => 'MyCustomParser')
+    rescue LoadError
+      warn "Can not load XmlSimple gem. Please gem install xml-simple to run this test"
+      return
+    end
+    
+    specs = parser.load_file(spec)
+    assert_instance_of Hash, specs
+    assert specs.has_key?('name')
+  end
+end

data/test/xml_parser.rb

@@ -0,0 +1,7 @@
+# encoding: utf-8
+require 'xmlsimple'
+class MyCustomParser
+  def self.load_file(spec)
+    XmlSimple.xml_in(File.read(spec))
+  end
+end

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification 
+name: spore
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 3
+  version: 0.0.3
+platform: ruby
+authors: 
+- Alexis Sukrieh <sukria@sukria.net> [sukria]
+- Hery Ramihajamalala <hery@rails-royce.org> [hallelujah]
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-12-22 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 4
+        - 6
+        version: 1.4.6
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: httpclient
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+description: Spore is a specification for describing ReST API that can be parsed and used automatically by client implementations to communicate with the descibed API
+email: <sukria@sukria.net>
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- LICENSE
+- README.rdoc
+- Rakefile
+- TODO.rdoc
+- VERSION
+- lib/spore.rb
+- lib/spore/middleware.rb
+- lib/spore/middleware/format.rb
+- lib/spore/middleware/runtime.rb
+- lib/spore/spec_parser/json.rb
+- lib/spore/spec_parser/yaml.rb
+- test/github.json
+- test/github.xml
+- test/github.yml
+- test/github1.yml
+- test/github2.yml
+- test/helper.rb
+- test/test_collapsing.rb
+- test/test_constructor.rb
+- test/test_enable_if.rb
+- test/test_github.rb
+- test/test_middleware_runtime.rb
+- test/test_parser.rb
+- test/xml_parser.rb
+has_rdoc: true
+homepage: http://github.com/sukria/Ruby-Spore
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A Ruby implementation for SPORE
+test_files: 
+- test/helper.rb
+- test/test_collapsing.rb
+- test/test_constructor.rb
+- test/test_enable_if.rb
+- test/test_github.rb
+- test/test_middleware_runtime.rb
+- test/test_parser.rb
+- test/xml_parser.rb