oreflect 0.7.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,3 @@
+coverage
+rdoc
+pkg

data/README.md

@@ -0,0 +1,7 @@
+# OReflect
+
+Build reflections for your REST web services so that they may easily be consumed.
+
+## Synopsis
+
+Check out /examples to see how it works.

data/Rakefile

@@ -0,0 +1,49 @@
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = 'oreflect'
+    gem.summary = 'A library for building reflection endpoints to REST services and consuming them.'
+    gem.description = 'A library for building reflection endpoints to REST services and consuming them.'
+    gem.email = 'heycarsten@gmail.com'
+    gem.homepage = 'http://oreflect.org'
+    gem.author = 'Carsten Nielsen'
+    gem.add_development_dependency 'shoulda', '>= 0'
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts 'Jeweler (or a dependency) not available. Install it with: gem install jeweler'
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort 'RCov is not available. In order to run rcov, you must: sudo gem install rcov'
+  end
+end
+
+task :test => :check_dependencies
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ''
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "oreflect #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.7.0

data/examples/basic.rb

@@ -0,0 +1,10 @@
+service do
+  name 'Test'
+
+  resource '/tests' do
+    action :get
+    action :post do
+      is_authenticated!
+    end
+  end
+end

data/examples/rest_blog.rb

@@ -0,0 +1,73 @@
+service do
+  version 2
+  name 'REST Blog'
+  desc 'A blog system that conforms to the ideals of REST architecture'
+  base_uri 'http://restblog.example.com'
+
+  resource '/articles.:format' do
+    arg :format do
+      desc 'The input format'
+      accepted_values 'xml', 'json'
+    end
+
+    action :get do
+      name 'Show Articles'
+      desc 'Get all Articles matching criteria'
+
+      query :before_date do
+        desc 'Shows articles before this date or time'
+        examples '2009-09-26'
+      end
+
+      query :after_date do
+        desc 'Show articles after this date'
+        examples '2009-09-26'
+      end
+
+      query :tag do
+        is_multiparam!
+        desc 'Show articles that contain this tag or tags if many are provided.'
+        examples 'heycarsten', 'unspace', 'leftist', 'top100'
+      end
+
+      query :page do
+        desc 'Show this page of articles'
+        examples '1', '2', '3'
+      end
+
+      example do
+        path '/articles.json'
+        desc 'View the latest articles'
+      end
+
+      example do
+        path '/articles.json?page=2'
+        desc 'View page two of the latest articles'
+      end
+    end
+
+    action :post do
+      is_authenticated!
+      name 'Create Article'
+      desc 'Creates a new article'
+      body 'article[title]'
+      body 'article[author_name]'
+      body 'article[author_email]'
+      body 'article[publish_on]'
+      body 'article[body]'
+
+      example do
+        path '/articles.json'
+        body 'article[title]', 'Test Article'
+        body 'article[author_name]', 'Carsten Nielsen'
+        body 'article[author_email]', 'heycarsten@example.com'
+        body 'article[publish_on]', '2010-02-22 00:00:00 -0500'
+        body 'article[:body]', "# Title\n\nThis is a test.\n"
+      end
+    end
+  end
+
+  resource '/articles/:id.:format'
+  resource '/articles/:article_id/comments.:format'
+  resource '/articles/:article_id/comments/:id.:format'
+end

data/lib/oreflect.rb

@@ -0,0 +1,22 @@
+require 'oreflect/accessors'
+require 'oreflect/action'
+require 'oreflect/endpoint'
+require 'oreflect/error'
+require 'oreflect/example'
+require 'oreflect/param'
+require 'oreflect/service'
+
+
+module OReflect
+
+  def service(&block)
+    Service.new(&block)
+  end
+
+  def load_file(filepath)
+    class_eval File.read(filepath)
+  end
+
+  module_function :service, :load_file
+
+end

data/lib/oreflect/accessors.rb

@@ -0,0 +1,50 @@
+module OReflect
+  module Accessors
+
+    def self.included(mod)
+      mod.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      def boolean_accessor(*names)
+        names.each do |attr_name|
+          dynamic_accessor attr_name
+
+          define_method "#{attr_name}?" do
+            instance_variable_get("@#{attr_name}") ? true : false
+          end
+
+          define_method "#{attr_name}!" do
+            instance_variable_set "@#{attr_name}", true
+          end
+        end
+      end
+
+      def splat_accessor(*names)
+        names.each do |attr_name|
+          define_method attr_name do |*values|
+            instance_variable_set("@#{attr_name}", []) unless instance_variable_get("@#{attr_name}")
+            if values.empty?
+              instance_variable_get "@#{attr_name}"
+            else
+              instance_variable_get("@#{attr_name}").concat(values)
+            end
+          end
+        end
+      end
+
+      def dynamic_accessor(*names)
+        names.each do |attr_name|
+          define_method attr_name do |*args|
+            if args[0]
+              instance_variable_set "@#{attr_name}", args[0]
+            else
+              instance_variable_get "@#{attr_name}"
+            end
+          end
+        end
+      end
+    end
+
+  end
+end

data/lib/oreflect/action.rb

@@ -0,0 +1,50 @@
+module OReflect
+  class Action
+
+    include Accessors
+
+    attr_reader :form_params, :query_params, :examples, :endpoint
+    dynamic_accessor :method, :name, :description, :identifier
+    boolean_accessor :is_authenticated
+    alias_method :desc, :description
+    alias_method :id, :identifier
+
+    def initialize(method, identifier = nil, endpoint = nil, &block)
+      @method = method
+      @identifier = identifier
+      @endpoint = endpoint
+      @query_params = []
+      @form_params = []
+      @examples = []
+      instance_eval(&block) if block_given?
+    end
+
+    def example(&block)
+      @examples << Example.new(&block)
+    end
+
+    def query(key, &block)
+      @query_params << Param.new(key, &block)
+    end
+
+    def body(key, &block)
+      @form_params << Param.new(key, &block)
+    end
+
+    def as_hash
+      h = {}
+      h[:name] = name
+      h[:identifier] = identifier
+      h[:method] = method
+      h[:is_authenticated] = is_authenticated?
+      h[:description] = description
+      h[:examples] = examples.map { |example| example.as_hash }
+      h[:query_params] = query_params.inject({}) { |hsh, param|
+        hsh.merge(param.key => param.as_hash) }
+      h[:form_params] = form_params.inject({}) { |hsh, param|
+        hsh.merge(param.key => param.as_hash) }
+      h
+    end
+
+  end
+end

data/lib/oreflect/endpoint.rb

@@ -0,0 +1,44 @@
+module OReflect
+  class Endpoint
+
+    include Accessors
+
+    attr_reader :actions, :arguments
+    dynamic_accessor :name, :description, :template
+    alias_method :desc, :description
+
+    def initialize(template, is_collection = false, &block)
+      @template = template
+      @is_collection = is_collection
+      @actions = []
+      @arguments = []
+      instance_eval(&block) if block_given?
+    end
+
+    def is_collection?
+      @is_collection ? true : false
+    end
+
+    def arg(key, &block)
+      @arguments << Param.new(key, &block)
+    end
+
+    def action(method, id = nil, &block)
+      @actions << Action.new(method, id, self, &block)
+    end
+
+    def as_hash
+      h = {}
+      h[:name] = name
+      h[:description] = description
+      h[:template] = template
+      h[:is_collection] = is_collection?
+      h[:arguments] = arguments.inject({}) do |hsh, arg|
+        hsh.merge(arg.key => arg.as_hash(:is_required))
+      end
+      h[:actions] = actions.map { |action| action.as_hash }
+      h
+    end
+
+  end
+end

data/lib/oreflect/error.rb

@@ -0,0 +1,50 @@
+module OReflect
+  class Error
+
+    include Accessors
+
+    DEFAULT_ERRORS = lambda do
+      error 500 do
+        title 'Application Error'
+        desc 'An error occurred on the server'
+      end
+
+      error 503 do
+        title 'Down For Maintenance'
+        desc 'The service is temporarily unavailable due to maintenance'
+      end
+
+      error 404 do
+        title 'Resource Not Found'
+        desc 'The resource you identified does not exist on the server'
+      end
+
+      error 403 do
+        title 'Authorization Required'
+        desc 'You need to authenticate to access the resource'
+      end
+
+      error 400 do
+        title 'Invalid Request'
+        desc 'One or more params were malformed and the server has rejected the request'
+      end
+    end
+
+    dynamic_accessor :code, :desc, :title
+    alias_method :description, :desc
+
+    def initialize(code, &block)
+      @code = code
+      instance_eval(&block) if block_given?
+    end
+
+    def as_hash
+      h = {}
+      h[:code] = code
+      h[:description] = description
+      h[:title] = title
+      h
+    end
+
+  end
+end

data/lib/oreflect/example.rb

@@ -0,0 +1,30 @@
+module OReflect
+  class Example
+
+    include Accessors
+
+    attr_reader :form_values
+    dynamic_accessor :path, :description, :title, :response
+    alias_method :desc, :description
+
+    def initialize(&block)
+      @form_values = {}
+      instance_eval(&block) if block_given?
+    end
+
+    def body(key, value)
+      @form_values[key] = value
+    end
+
+    def as_hash
+      h = {}
+      h[:title] = title
+      h[:path] = path
+      h[:description] = description
+      h[:response] = response
+      h[:form_values] = form_values
+      h
+    end
+
+  end
+end

data/lib/oreflect/param.rb

@@ -0,0 +1,31 @@
+module OReflect
+  class Param
+
+    include Accessors
+
+    dynamic_accessor :key, :description
+    boolean_accessor :is_required, :is_multiparam
+    splat_accessor :excluded_params, :required_params, :accepted_values, :examples
+    alias_method :desc, :description
+
+    def initialize(key, &block)
+      @key = key
+      instance_eval(&block) if block_given?
+    end
+
+    def as_hash(*exclusions)
+      h = {}
+      h[:is_required] = is_required?
+      h[:is_multiparam] = is_multiparam?
+      h[:key] = key
+      h[:description] = description
+      h[:examples] = examples
+      h[:accepted_values] = accepted_values
+      h[:required_params] = required_params
+      h[:excluded_params] = excluded_params
+      exclusions.each { |key| h.delete(key) }
+      h
+    end
+
+  end
+end

data/lib/oreflect/service.rb

@@ -0,0 +1,63 @@
+module OReflect
+  class Service
+
+    include Accessors
+
+    DEFAULT_VERSION = 1
+
+    attr_reader :errors, :endpoints
+    dynamic_accessor :base_uri, :name, :description
+    alias_method :desc, :description
+
+    def initialize(&block)
+      @version = DEFAULT_VERSION
+      @endpoints = []
+      @errors = {}
+      instance_eval(&Error::DEFAULT_ERRORS)
+      instance_eval(&block) if block_given?
+    end
+
+    def actions
+      endpoints.map { |endpoint| endpoint.actions }.flatten
+    end
+
+    def action_by_id(action_id)
+      actions.detect { |a| a.id.to_s == action_id.to_s }
+    end
+
+    def action_by_dashed_id(dashed_action_id)
+      action_by_id dashed_action_id.gsub('-', '_')
+    end
+
+    def version(value = nil)
+      return @version unless value
+      raise ArgumentError, 'value must be an integer' unless value.is_a?(Fixnum)
+      @version = value
+    end
+
+    def resource(template, &block)
+      @endpoints << Endpoint.new(template, &block)
+    end
+
+    def resources(template, &block)
+      @endpoints << Endpoint.new(template, true, &block)
+    end
+
+    def error(code, &block)
+      @errors[code] = Error.new(code, &block)
+    end
+
+    def as_hash
+      h = {}
+      h[:version] = version
+      h[:name] = name
+      h[:description] = description
+      h[:base_uri] = base_uri
+      h[:errors] = errors.values.inject({}) { |hsh, err|
+        hsh.merge(err.code => err.as_hash) }
+      h[:endpoints] = endpoints.map { |endpoint| endpoint.as_hash }
+      h
+    end
+
+  end
+end

data/oreflect.gemspec

@@ -0,0 +1,75 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{oreflect}
+  s.version = "0.7.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Carsten Nielsen"]
+  s.date = %q{2010-05-26}
+  s.description = %q{A library for building reflection endpoints to REST services and consuming them.}
+  s.email = %q{heycarsten@gmail.com}
+  s.extra_rdoc_files = [
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "README.md",
+     "Rakefile",
+     "VERSION",
+     "examples/basic.rb",
+     "examples/rest_blog.rb",
+     "lib/oreflect.rb",
+     "lib/oreflect/accessors.rb",
+     "lib/oreflect/action.rb",
+     "lib/oreflect/endpoint.rb",
+     "lib/oreflect/error.rb",
+     "lib/oreflect/example.rb",
+     "lib/oreflect/param.rb",
+     "lib/oreflect/service.rb",
+     "oreflect.gemspec",
+     "test/helper.rb",
+     "test/test_action.rb",
+     "test/test_endpoint.rb",
+     "test/test_error.rb",
+     "test/test_example.rb",
+     "test/test_oreflect.rb",
+     "test/test_param.rb",
+     "test/test_service.rb"
+  ]
+  s.homepage = %q{http://oreflect.org}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{A library for building reflection endpoints to REST services and consuming them.}
+  s.test_files = [
+    "test/helper.rb",
+     "test/test_action.rb",
+     "test/test_endpoint.rb",
+     "test/test_error.rb",
+     "test/test_example.rb",
+     "test/test_oreflect.rb",
+     "test/test_param.rb",
+     "test/test_service.rb",
+     "examples/basic.rb",
+     "examples/rest_blog.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+    else
+      s.add_dependency(%q<shoulda>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<shoulda>, [">= 0"])
+  end
+end
+

data/test/helper.rb

@@ -0,0 +1,12 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$:.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$:.unshift(File.dirname(__FILE__))
+
+require 'oreflect'
+
+class Test::Unit::TestCase
+
+end

data/test/test_action.rb

@@ -0,0 +1,66 @@
+require 'helper'
+
+class TestAction < Test::Unit::TestCase
+
+  context 'An instance of Action' do
+    setup do
+      @action = OReflect::Action.new(:get, :get_test) do
+        is_authenticated!
+        name 'Test'
+        desc 'test desc'
+
+        body :test_param do
+          is_multiparam!
+          desc 'test desc'
+          examples 'example1', 'example2'
+          accepted_values 'test1'
+          required_params 'testfest'
+          excluded_params 'testnest'
+        end
+
+        query :q do
+          is_required!
+          desc 'test'
+          examples 'test1', 'test2'
+        end
+
+        example do
+          title 'test'
+          path '/test'
+          desc 'test desc'
+          response '{}'
+          body :key1, 'value1'
+          body :key2, 'value2'
+        end
+      end
+    end
+
+    should 'provide required accessors' do
+      assert_respond_to @action, :identifier
+      assert_respond_to @action, :form_params
+      assert_respond_to @action, :query_params
+      assert_respond_to @action, :description
+      assert_respond_to @action, :method
+      assert_respond_to @action, :examples
+      assert_respond_to @action, :name
+      assert_respond_to @action, :is_authenticated?
+    end
+
+    context '#as_hash' do
+      setup { @h = @action.as_hash }
+
+      should 'return a hash with correct keys and values' do
+        assert_equal true, @h[:is_authenticated]
+        assert_equal :get, @h[:method]
+        assert_equal :get_test, @h[:identifier]
+        assert_equal 'Test', @h[:name]
+        assert_equal 'test desc', @h[:description]
+        assert_instance_of Hash, @h[:form_params][:test_param]
+        assert_instance_of Hash, @h[:query_params][:q]
+        assert_instance_of Array, @h[:examples]
+        assert_equal '{}', @h[:examples][0][:response]
+      end
+    end
+  end
+
+end

data/test/test_endpoint.rb

@@ -0,0 +1,43 @@
+require 'helper'
+
+class TestEndpoint < Test::Unit::TestCase
+
+  context 'An instance of Endpoint' do
+    setup do
+      @endpoint = OReflect::Endpoint.new('/tests/:arg/items', true) do
+        name 'Test'
+        desc 'test desc'
+        arg :arg
+        action :get, :get_test
+        action :post
+      end
+    end
+
+    should 'provide reqired accessors' do
+      assert_respond_to @endpoint, :is_collection?
+      assert_respond_to @endpoint, :template
+      assert_respond_to @endpoint, :name
+      assert_respond_to @endpoint, :description
+      assert_respond_to @endpoint, :arguments
+      assert_respond_to @endpoint, :actions
+    end
+
+    context '#as_hash' do
+      setup { @h = @endpoint.as_hash }
+
+      should 'return a hash with correct keys and values' do
+        assert_equal true, @h[:is_collection]
+        assert_equal '/tests/:arg/items', @h[:template]
+        assert_equal 'Test', @h[:name]
+        assert_equal 'test desc', @h[:description]
+        assert_instance_of Hash, @h[:arguments]
+        assert_instance_of Array, @h[:actions]
+      end
+
+      should 'not have an is_required field in argument params' do
+        assert_nil @h[:arguments][:arg][:is_required]
+      end
+    end
+  end
+
+end

data/test/test_error.rb

@@ -0,0 +1,30 @@
+require 'helper'
+
+class TestError < Test::Unit::TestCase
+
+  context 'An instance of Error' do
+    setup do
+      @error = OReflect::Error.new(500) do
+        title 'test'
+        desc 'test desc'
+      end
+    end
+
+    should 'provide required accessors' do
+      assert_respond_to @error, :code
+      assert_respond_to @error, :title
+      assert_respond_to @error, :description
+    end
+
+    context '#as_hash' do
+      setup { @h = @error.as_hash }
+
+      should 'return appropriate values' do
+        assert_equal 500, @h[:code]
+        assert_equal 'test', @h[:title]
+        assert_equal 'test desc', @h[:description]
+      end
+    end
+  end
+
+end

data/test/test_example.rb

@@ -0,0 +1,39 @@
+require 'helper'
+
+class TestExample < Test::Unit::TestCase
+
+  context 'An instance of Example' do
+    setup do
+      @example = OReflect::Example.new do
+        title 'test'
+        path '/test'
+        desc 'test desc'
+        response '{}'
+        body :key1, 'value1'
+        body :key2, 'value2'
+      end
+    end
+
+    should 'provide required accessors' do
+      assert_respond_to @example, :title
+      assert_respond_to @example, :path
+      assert_respond_to @example, :description
+      assert_respond_to @example, :response
+      assert_respond_to @example, :form_values
+    end
+
+    context '#as_hash' do
+      setup { @h = @example.as_hash }
+
+      should 'return proper values' do
+        assert_equal 'test', @h[:title]
+        assert_equal '/test', @h[:path]
+        assert_equal 'test desc', @h[:description]
+        assert_equal '{}', @h[:response]
+        assert_equal 'value1', @h[:form_values][:key1]
+        assert_equal 'value2', @h[:form_values][:key2]
+      end
+    end
+  end
+
+end

data/test/test_oreflect.rb

@@ -0,0 +1,22 @@
+require 'helper'
+
+class TestReflector < Test::Unit::TestCase
+
+  context 'OReflect' do
+    %w[examples/rest_blog.rb examples/basic.rb].each do |file|
+      context "#load_file('#{file}')" do
+        setup { @service = OReflect.load_file(file) }
+
+        should 'be a valid instance of Service' do
+          assert_instance_of OReflect::Service, @service
+        end
+
+        should 'be able to provide a Hash representation' do
+          assert_instance_of Hash, @service.as_hash
+          assert !@service.as_hash.empty?
+        end
+      end
+    end
+  end
+
+end

data/test/test_param.rb

@@ -0,0 +1,45 @@
+require 'helper'
+
+class TestParam < Test::Unit::TestCase
+
+  context 'An instance of Param' do
+    setup do
+      @param = OReflect::Param.new(:test) do
+        is_multiparam!
+        is_required!
+        desc 'test desc'
+        examples 'example1', 'example2'
+        accepted_values 'test1'
+        required_params 'testfest'
+        excluded_params 'testnest'
+      end
+    end
+
+    should 'provide required accessors' do
+      assert_respond_to @param, :is_multiparam?
+      assert_respond_to @param, :is_required?
+      assert_respond_to @param, :key
+      assert_respond_to @param, :description
+      assert_respond_to @param, :examples
+      assert_respond_to @param, :accepted_values
+      assert_respond_to @param, :required_params
+      assert_respond_to @param, :excluded_params
+    end
+
+    context '#as_hash' do
+      setup { @h = @param.as_hash }
+
+      should 'return the correct values' do
+        assert_equal true, @h[:is_multiparam]
+        assert_equal true, @h[:is_required]
+        assert_equal :test, @h[:key]
+        assert_equal 'test desc', @h[:description]
+        assert_equal 2, @h[:examples].size
+        assert_equal 1, @h[:accepted_values].size
+        assert_equal 1, @h[:required_params].size
+        assert_equal 1, @h[:excluded_params].size
+      end
+    end
+  end
+
+end

data/test/test_service.rb

@@ -0,0 +1,116 @@
+require 'helper'
+
+class TestService < Test::Unit::TestCase
+
+  context 'Service' do
+    should 'only accept integers as version' do
+      assert_raise(ArgumentError) { OReflect::Service.new.version(1.0) }
+      assert_raise(ArgumentError) { OReflect::Service.new.version('1') }
+    end
+
+    should 'have a default version' do
+      assert_equal 1, OReflect::Service.new.version
+    end
+
+    should 'have a number of default errors' do
+      assert !OReflect::Service.new.errors.empty?
+    end
+  end
+
+  context 'An instance of Service' do
+    setup do
+      @service = OReflect::Service.new do
+        version 3
+        name 'Test'
+        desc 'test desc'
+        base_uri 'http://example.com'
+        error 900 do
+          desc 'test error'
+        end
+        resource :test do
+          action :get, :test_action
+        end
+        resources :tests do
+          action :get
+          action :put
+          action :post
+        end
+      end
+    end
+
+    should 'provide required accessors' do
+      assert_respond_to @service, :version
+      assert_respond_to @service, :name
+      assert_respond_to @service, :description
+      assert_respond_to @service, :base_uri
+      assert_respond_to @service, :errors
+      assert_respond_to @service, :endpoints
+    end
+
+    context 'adding an error' do
+      setup { @service.error(500) { title 'Crash Bang Boom' } }
+
+      should 'replace the default error' do
+        assert_equal 'Crash Bang Boom', @service.errors[500].title
+      end
+    end
+
+    context '#action_by_id' do
+      should 'return the action when given a symbol' do
+        assert_equal :test_action, @service.action_by_id('test_action').id
+      end
+
+      should 'return the action when given a string' do
+        assert_equal :test_action, @service.action_by_id(:test_action).id
+      end
+    end
+
+    context '#action_by_dashed_id' do
+      setup { @action = @service.action_by_dashed_id('test-action') }
+
+      should 'return the proper action' do
+        assert_equal :test_action, @action.id
+      end
+    end
+
+    context '#actions' do
+      setup { @actions = @service.actions }
+
+      should 'return all actions in all endpoints' do
+        assert_equal 4, @actions.size
+      end
+    end
+
+    context '#version' do
+      should 'return the current version' do
+        assert_equal 3, @service.version
+      end
+    end
+
+    context '#endpoints' do
+      should 'return available endpoints' do
+        assert_equal 2, @service.endpoints.size
+      end
+    end
+
+    context '#errors' do
+      should 'return a list of errors' do
+        assert @service.errors.values.any?
+      end
+    end
+
+    context '#as_hash' do
+      setup { @h = @service.as_hash }
+
+      should 'return the correct values' do
+        assert_equal 3, @h[:version]
+        assert_equal 'Test', @h[:name]
+        assert_equal 'test desc', @h[:description]
+        assert_equal 'http://example.com', @h[:base_uri]
+        assert_instance_of Hash, @h[:errors]
+        assert_instance_of Array, @h[:endpoints]
+      end
+    end
+  end
+
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification 
+name: oreflect
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 7
+  - 0
+  version: 0.7.0
+platform: ruby
+authors: 
+- Carsten Nielsen
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-05-26 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+description: A library for building reflection endpoints to REST services and consuming them.
+email: heycarsten@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.md
+files: 
+- .document
+- .gitignore
+- README.md
+- Rakefile
+- VERSION
+- examples/basic.rb
+- examples/rest_blog.rb
+- lib/oreflect.rb
+- lib/oreflect/accessors.rb
+- lib/oreflect/action.rb
+- lib/oreflect/endpoint.rb
+- lib/oreflect/error.rb
+- lib/oreflect/example.rb
+- lib/oreflect/param.rb
+- lib/oreflect/service.rb
+- oreflect.gemspec
+- test/helper.rb
+- test/test_action.rb
+- test/test_endpoint.rb
+- test/test_error.rb
+- test/test_example.rb
+- test/test_oreflect.rb
+- test/test_param.rb
+- test/test_service.rb
+has_rdoc: true
+homepage: http://oreflect.org
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: A library for building reflection endpoints to REST services and consuming them.
+test_files: 
+- test/helper.rb
+- test/test_action.rb
+- test/test_endpoint.rb
+- test/test_error.rb
+- test/test_example.rb
+- test/test_oreflect.rb
+- test/test_param.rb
+- test/test_service.rb
+- examples/basic.rb
+- examples/rest_blog.rb