hyperdrive 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1773ebd648b23d917073080a22cdfbdc7f1db732
-  data.tar.gz: b01991fbf7b86592e493a6001a9c3855e6d9648f
+  metadata.gz: 04f0142457c2c2727dc798316907630f2d53c828
+  data.tar.gz: b1742f5f51b354d1ada859f1b04603e1703396b8
 SHA512:
-  metadata.gz: 12fa4db2f3a29dde64ed725c164c8ba7368163f2d178518e7a67e999b5d24e889919668d99a16e8f3f89aeaadb5e467717c7990283560a514eb3c5be948ec0b2
-  data.tar.gz: 492dd95b6214f6a1a16cb9df13d1484879351984c0ca46c89a0fdb2d9e574212ccf506741d54ab00770fd74c4d7e451030cbcf53f6bfd2739bf832c63de7135e
+  metadata.gz: 165eb035a20d31e3c33c29e82dc71cd856661aa91d58f0b542e5e90bfe700f185dd1262ea6714e203cbc5db1f047b0d5f80e929ac8da491bbca6fb7fa74dd7eb
+  data.tar.gz: f2b83b37947c9b2bd3ed27c6c7db5b5deb15729714b324c68a6c28dc0520ddb13b28f5ac3f40ae9d1a98e117705b15a1aefa344b72c1fec360d856a5c279bc2d

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.gitignore

@@ -16,3 +16,6 @@ test/tmp
 test/version_tmp
 tmp
 .DS_Store
+config.ru
+# must be last
+!.gitkeep

data/Gemfile

@@ -3,6 +3,7 @@ gemspec
 
 group :development do
   gem 'gem-release', require: false
+  gem 'pry', require: false
 end
 
 group :test, :rake do
@@ -17,5 +18,5 @@ group :test do
   gem 'minitest', require: false
   gem 'minitest-spec-context', require: false
   gem 'minitest-reporters', require: false
-  #gem 'rack-test', require: false  
+  gem 'rack-test', require: false
 end

data/README.md

@@ -1,6 +1,6 @@
 # Hyperdrive
 
-Ruby DSL for defining self-documenting, HATEOS™ complaint, Hypermedia endpoints.
+Ruby DSL for defining self-documenting, HATEOAS™ complaint, Hypermedia endpoints.
 
 ## Installation
 
@@ -21,6 +21,7 @@ Or install it yourself as:
 Proposed Syntax (WIP):
 
 ```ruby
+# api.rb
 hyperdrive do
   resource(:thing) do
     name 'Thing Resource'
@@ -40,13 +41,85 @@ hyperdrive do
     # applied). Unlike allowed params, filters are not required by default.
     filter :start_date, 'Format: YYYY-MM-DD'
     filter :end_date, 'Format: YYYY-MM-DD'
-    filter :parent_id, 'Parent ID of Thing", required: true
+    filter :parent_id, 'Parent ID of Thing', required: true
+
+
+    # Handle API Requests
+    #
+    # - Simply return a string to be used as the body of the response. How you generate
+    #   that string is completely up to you.
+    # - Status Codes and Headers will be handled automatically.
+    # - Any unhandled requests will return a 405 "Method Not Supported" error
+
+    request(:get) do
+      # retrieve 1-N objects...
+      '{ ... }'
+    end
+
+    # Options and Head requests will be handled automatically and
+    # will use info from the GET request block you define, as needed.
+
+    # POST Requests should return the full object that was created during the request.
+    request(:post) do
+      # create the object...
+      '{ ... }'
+    end
+
+    # PUT Requests should return the full object that was updated during the request.
+    request(:put) do
+      # 'upsert' the object...
+      '{ ... }'
+    end
+
+    # PATCH requests should return the full object that was updated during the request.
+    request(:patch) do
+      # update the object...
+      '{ ... }'
+    end
+
+    # DELETE requests should return a simple response indicating success.
+    request(:delete) do
+      # delete the object...
+      '{"deleted":true}'
+    end
   end
 end
+
+# config.ru
+run Hyperdrive::Server
 ```
 
+## CLI
+
+### Generating Documentation
+
+`$ hyperdrive docs <option> <parameter>`
+
+__`--input` Option__
+
+Use the `--input` option and specify a file or directory as a parameter to generate documentation for your API resources.
+
+  - `$ hyperdrive docs --input api.rb`
+
+or
+
+  - `$ hyperdrive docs --input api`
+
+`-in` can be used as an alias for `--input`
+
+__`--output` Option__
+
+You can also provide a `--output` option and specify a destination for your documentation to be created.
+
+  - `$ hyperdrive docs --input api.rb --output docs/docs.md`
+
+`-out` can be used as an alias for `--output`
+
+If the `--output` option is not provided the generated documentation will be written to `docs/doc.md` by default. 
+
 ## Project Status
 
+- Version: [![Gem Version](https://badge.fury.io/rb/hyperdrive.png)](http://badge.fury.io/rb/hyperdrive)
 - Build: [![Build Status](https://secure.travis-ci.org/styleseek/hyperdrive.png?branch=master)](https://travis-ci.org/styleseek/hyperdrive)
 - Code Quality: [![Code Climate](https://codeclimate.com/github/styleseek/hyperdrive.png)](https://codeclimate.com/github/styleseek/hyperdrive)
 - Dependencies: [![Dependency Status](https://gemnasium.com/styleseek/hyperdrive.png)](https://gemnasium.com/styleseek/hyperdrive)

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+ENV['RACK_ENV'] ||= 'development'
+# load path
+lib_path = File.expand_path('../../lib', __FILE__)
+($:.unshift lib_path) unless ($:.include? lib_path)
+
+# require farm
+require 'bundler'
+Bundler.require(:default, ENV['RACK_ENV'])
+require 'pry'
+require 'hyperdrive'
+
+# fire up the ftl drive
+Pry.start

data/bin/hyperdrive

@@ -0,0 +1,42 @@
+#!/usr/bin/env ruby
+ENV['RACK_ENV'] ||= 'development'
+# load path
+lib_path = File.expand_path('../../lib', __FILE__)
+($:.unshift lib_path) unless ($:.include? lib_path)
+
+require 'thor'
+require 'hyperdrive'
+
+module Hyperdrive
+  class CLI < Thor
+    include Thor::Actions
+
+    desc "docs", "Generate docs in markdown based on your resources."
+    method_option :input,  aliases: "\--in",  desc: "Specify the directory or file to generate docs for."
+    method_option :output, aliases: "\--out", desc: "Specify the destination of the docs.", default: "docs/api.md"
+    def docs
+      input = File.expand_path(options[:input])
+      
+      if File.file?(input)
+        require input
+      elsif File.directory?(input)
+        Dir.glob("#{input}/*.rb").each do |file|
+          require file
+        end
+      else
+        raise ArgumentError, "Input is neither a file nor a directory"
+      end
+
+      if hyperdrive.resources.empty?
+        say "This API doesn't have any resources to document", :red
+        return
+      end
+
+      data = Hyperdrive::Docs.new(hyperdrive.resources).output
+      create_file(options[:output], data)
+      say "Done!"
+    end
+  end
+end
+
+Hyperdrive::CLI.start

data/hyperdrive.gemspec

@@ -9,15 +9,16 @@ Gem::Specification.new do |gem|
   gem.authors       = ['StyleSeek Engineering']
   gem.email         = ['engineering@styleseek.com']
   gem.summary       = %q{Hypermedia State Machine}
-  gem.description   = %q{Ruby DSL for defining self-documenting, HATEOS™ complaint, Hypermedia API endpoints.}
+  gem.description   = %q{Ruby DSL for defining self-documenting, HATEOAS™ complaint, Hypermedia API endpoints.}
   gem.homepage      = "https://github.com/styleseek/hyperdrive"
   gem.license       = "MIT"
 
   gem.files         = `git ls-files -z`.split("\x0")
-  gem.executables   = gem.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  gem.executables   = ['hyperdrive']
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
-
-  #gem.add_development_dependency "bundler", "~> 1.5"
-  #gem.add_development_dependency "rake"
+  
+  gem.add_dependency 'rack'
+  gem.add_dependency 'linguistics'
+  gem.add_dependency 'thor'
 end

data/lib/hyperdrive/docs.rb

@@ -0,0 +1,76 @@
+# encoding: utf-8
+
+module Hyperdrive
+  class Docs
+    attr_reader :resources
+
+    def initialize(resources)
+      @resources = resources
+    end
+
+    def output
+      out = ""
+      resources.each_value do |resource|
+        out += header(resource.name)
+        out += paragraph(resource.desc)
+        out += header("Endpoint URL", 2)
+        out += paragraph(bullet(code(resource.endpoint), 1))
+        out += header("Params", 2)
+        out += list(resource.allowed_params)
+        out += header("Filters", 2)
+        out += list(resource.filters)
+      end
+      out
+    end
+
+    def header(string, level = 1)
+      raise ArgumentError, "Header level must be between 1 and 6." unless (1..6).cover?(level)
+      header = "#" * level
+      "\n\n#{header} #{string}\n\n"
+    end
+
+    def paragraph(string)
+      "#{string}\n\n"
+    end
+
+    def bold(string)
+      "__#{string}__"
+    end
+
+    def italics(string)
+      "_#{string}_"
+    end
+
+    def code(string)
+      "`#{string}`"
+    end
+
+    def bullet(string, nest = 1)
+      raise ArgumentError, "Nest level must be between 1 and 3." unless (1..3).cover?(nest)
+      nest = "  " * nest
+      "#{nest}- #{string}\n"
+    end
+
+    def list(items)
+      list = ""
+      items.each do |key, value|
+        list += bullet(bold(key), 1)
+
+        value.each do |subkey, subvalue|
+          list += bullet(italics(subkey), 2)
+
+          if subvalue.kind_of? Array
+            list += bullet(code_options(subvalue), 3)
+          else
+            list += bullet(subvalue, 3)
+          end
+        end
+      end
+      list
+    end
+
+    def code_options(options)
+      options.map { |option| code(option) }.join(", ")
+    end
+  end
+end

data/lib/hyperdrive/dsl/main.rb

@@ -0,0 +1,19 @@
+# encoding: utf-8
+require 'singleton'
+
+module Hyperdrive
+  module DSL
+    class Main
+      include Singleton
+      attr_reader :resources
+
+      def initialize(&block)
+        @resources = {}
+      end
+
+      def resource(name, &block)
+        @resources[name] = Resource.new(name, &block).resource
+      end
+    end
+  end
+end

data/lib/hyperdrive/dsl/resource.rb

@@ -0,0 +1,42 @@
+# encoding: utf-8
+
+module Hyperdrive
+  module DSL
+    class Resource
+      attr_reader :resource
+      def initialize(key, &block)
+        @resource = ::Hyperdrive::Resource.new(key)
+        instance_eval(&block) if block_given?
+      end
+
+      def name(name)
+        resource.name = name
+      end
+
+      def desc(description)
+        resource.desc = description
+      end
+
+      def param(*args)
+        resource.register_param(*args)
+      end
+
+      def filter(*args)
+        resource.register_filter(*args)
+      end
+
+      def request(method, &block)
+        unless definable_request_methods.include? method
+          raise Errors::DSL::UnknownArgument.new(method, 'request')
+        end
+        resource.define_request_handler(method, block)
+      end
+
+      private
+
+      def definable_request_methods
+        [:get, :post, :put, :patch, :delete].freeze
+      end
+    end
+  end
+end

data/lib/hyperdrive/dsl.rb

@@ -0,0 +1,9 @@
+# encoding: utf-8
+
+require 'hyperdrive/dsl/main'
+require 'hyperdrive/dsl/resource'
+
+def hyperdrive(&block)
+  Hyperdrive::DSL::Main.instance.instance_eval(&block) if block_given?
+  Hyperdrive::DSL::Main.instance
+end

data/lib/hyperdrive/errors/bad_request.rb

@@ -0,0 +1,13 @@
+module Hyperdrive
+  module Errors
+    class BadRequest < HTTPError
+      def message
+        "The request cannot be fulfilled due to bad syntax."
+      end
+
+      def http_status_code
+        400
+      end
+    end
+  end
+end

data/lib/hyperdrive/errors/dsl/unknown_argument.rb

@@ -0,0 +1,21 @@
+module Hyperdrive
+  module Errors
+    module DSL
+      class UnknownArgument < RuntimeError
+        def initialize(argument, method_name)
+          @argument = case argument
+                      when Symbol
+                        ":#{argument}"
+                      else
+                        argument.to_s
+                      end
+          @method_name = method_name
+        end
+
+        def message
+          "#{@argument} is not supported by `#{@method_name}'."
+        end
+      end
+    end
+  end
+end

data/lib/hyperdrive/errors/http_error.rb

@@ -0,0 +1,11 @@
+# encoding: utf-8
+
+module Hyperdrive
+  module Errors 
+    class HTTPError < RuntimeError
+      def http_status_code
+        500
+      end
+    end
+  end
+end

data/lib/hyperdrive/errors/internal_server_error.rb

@@ -0,0 +1,13 @@
+module Hyperdrive
+  module Errors
+    class InternalServerError < HTTPError
+      def message
+        "The server encountered an unexpected condition which prevented it from fulfilling the request."
+      end
+
+      def http_status_code
+        500
+      end
+    end
+  end
+end

data/lib/hyperdrive/errors/method_not_allowed.rb

@@ -0,0 +1,17 @@
+module Hyperdrive
+  module Errors
+    class MethodNotAllowed < HTTPError
+      def initialize(request_method)
+        @request_method = request_method
+      end
+
+      def message
+        "A request was made using a request method (#{@request_method}) not supported by this resource."
+      end
+
+      def http_status_code
+        405
+      end
+    end
+  end
+end

data/lib/hyperdrive/errors/not_found.rb

@@ -0,0 +1,13 @@
+module Hyperdrive
+  module Errors
+    class NotFound < HTTPError
+      def message
+        "The requested resource could not be found."
+      end
+
+      def http_status_code
+        404
+      end
+    end
+  end
+end

data/lib/hyperdrive/errors/not_implemented.rb

@@ -0,0 +1,17 @@
+module Hyperdrive
+  module Errors
+    class NotImplemented < HTTPError
+      def initialize(request_method)
+        @request_method = request_method
+      end
+
+      def message
+        "The server either does not recognise the request method (#{@request_method}), or it lacks the ability to fulfill the request."
+      end
+
+      def http_status_code
+        501
+      end
+    end
+  end
+end

data/lib/hyperdrive/errors/unauthorized.rb

@@ -0,0 +1,13 @@
+module Hyperdrive
+  module Errors
+    class Unauthorized < HTTPError
+      def message
+        "The request requires user authentication."
+      end
+
+      def http_status_code
+        401
+      end
+    end
+  end
+end

data/lib/hyperdrive/errors.rb

@@ -0,0 +1,10 @@
+# encoding: utf-8
+
+require 'hyperdrive/errors/http_error'
+require 'hyperdrive/errors/bad_request'
+require 'hyperdrive/errors/internal_server_error'
+require 'hyperdrive/errors/method_not_allowed'
+require 'hyperdrive/errors/not_found'
+require 'hyperdrive/errors/not_implemented'
+require 'hyperdrive/errors/unauthorized'
+require 'hyperdrive/errors/dsl/unknown_argument'

data/lib/hyperdrive/resource.rb

@@ -2,13 +2,15 @@
 
 module Hyperdrive
   class Resource
-    attr_reader :resource, :allowed_params, :filters
+    attr_reader :endpoint, :allowed_params, :filters, :request_handlers
     attr_accessor :name, :desc
 
-    def initialize(resource)
-      @resource = resource
+    def initialize(key)
+      @key = key
+      @endpoint = "/#{@key.to_s.en.plural}"
       @allowed_params = default_allowed_params
       @filters = default_filters
+      @request_handlers = default_request_handlers
     end
 
     def register_param(key, description, options = {})
@@ -21,6 +23,26 @@ module Hyperdrive
       @filters[key] = { desc: description }.merge(options)
     end
 
+    def define_request_handler(request_method, block)
+      @request_handlers[request_method] = block
+      if request_method == :get
+        @request_handlers[:head] = block
+      end
+    end
+
+    def request_handler(http_request_method)
+      request_method = Hyperdrive::Values.request_methods_string_map[http_request_method]
+      request_handlers[request_method]
+    end
+
+    def request_method_allowed?(http_request_method)
+      allowed_methods.include?(http_request_method)
+    end
+
+    def allowed_methods
+      Hyperdrive::Values.request_methods_symbol_map.values_at(*request_handlers.keys)
+    end
+
     private
 
     def default_allowed_params
@@ -42,5 +64,9 @@ module Hyperdrive
     def default_filter_options
       { required: false }.freeze
     end
+
+    def default_request_handlers
+      { options: proc { '' } }
+    end
   end
 end

data/lib/hyperdrive/response.rb

@@ -0,0 +1,41 @@
+# encoding: utf-8
+
+module Hyperdrive
+  class Response
+    attr_reader :resource, :env, :http_request_method, :headers
+
+    def initialize(env, resource)
+      @resource = resource
+      @env = env
+      @http_request_method = env['REQUEST_METHOD']
+
+      unless request_method_supported?
+        raise Errors::NotImplemented.new(http_request_method)
+      end
+
+      unless resource.request_method_allowed?(http_request_method)
+        raise Errors::MethodNotAllowed.new(http_request_method)
+      end
+
+      @headers = default_headers
+    end
+
+    def response
+      @headers.merge({ 'Content-Type' => 'text/plain' })
+      status = (http_request_method == 'POST') ? 201 : 200
+      ::Rack::Response.new(resource.request_handler(http_request_method).call(env), status, headers).finish
+    end
+
+    private
+
+    def default_headers
+      {
+        'Allow' => resource.allowed_methods
+      }
+    end
+
+    def request_method_supported?
+      Hyperdrive::Values.request_methods_string_map.key?(http_request_method)
+    end
+  end
+end

data/lib/hyperdrive/server.rb

@@ -0,0 +1,30 @@
+# encoding: utf-8
+
+module Hyperdrive
+  class Server
+    def self.call(env)
+      server.call(env)
+    end
+
+    private
+
+    def self.server
+      Rack::Builder.new do
+        hyperdrive.resources.each do |key, resource|
+          map resource.endpoint do
+            use Rack::Runtime
+            use Rack::Lint
+            use Rack::Head
+            run ->(env) {
+              begin
+                Hyperdrive::Response.new(env, resource).response
+              rescue Hyperdrive::Errors::HTTPError => error
+                [error.http_status_code, { 'Allow' => resource.allowed_methods.join(',') }, [error.message]]
+              end
+            }
+          end
+        end
+      end.to_app
+    end
+  end
+end

data/lib/hyperdrive/values.rb

@@ -0,0 +1,31 @@
+module Hyperdrive
+  module Values
+    def self.request_methods
+      %w(GET HEAD OPTIONS POST PUT PATCH DELETE).freeze
+    end
+
+    def self.request_methods_symbol_map
+      {
+        get:     'GET',
+        head:    'HEAD',
+        options: 'OPTIONS',
+        post:    'POST',
+        put:     'PUT',
+        patch:   'PATCH',
+        delete:  'DELETE'
+      }.freeze
+    end
+
+    def self.request_methods_string_map
+      {
+        'GET'     => :get,
+        'HEAD'    => :head,
+        'OPTIONS' => :options,
+        'POST'    => :post,
+        'PUT'     => :put,
+        'PATCH'   => :patch,
+        'DELETE'  => :delete
+      }.freeze
+    end
+  end
+end

data/lib/hyperdrive/version.rb

@@ -1,3 +1,3 @@
 module Hyperdrive
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/lib/hyperdrive.rb

@@ -1,8 +1,16 @@
 # encoding: utf-8
 
+# stdlib
+require 'rack'
+require 'linguistics'
+Linguistics.use(:en)
+
+# prepare for hyperspace!
+require 'hyperdrive/docs'
+require 'hyperdrive/dsl'
+require 'hyperdrive/errors'
 require 'hyperdrive/resource'
+require 'hyperdrive/response'
+require 'hyperdrive/server'
+require 'hyperdrive/values'
 require 'hyperdrive/version'
-
-module Hyperdrive
-  # spinning up the FTL drive
-end

data/spec/hyperdrive/docs_spec.rb

@@ -0,0 +1,56 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Hyperdrive::Docs do
+  before do
+    sample_api
+    @docs = Hyperdrive::Docs.new(hyperdrive.resources)
+  end
+
+  it 'generates a header with size 1 as default' do
+    @docs.header('Thing Resource').must_equal "\n\n# Thing Resource\n\n"
+  end
+
+  it 'generates a header only between size 1 and 6' do
+    proc {@docs.header('Thing Resource', 0)}.must_raise ArgumentError
+    proc {@docs.header('Thing Resource', 8)}.must_raise ArgumentError
+  end
+
+  it 'generates a paragraph' do
+    @docs.paragraph('Description of Thing Resource').must_equal "Description of Thing Resource\n\n"
+  end 
+
+  it 'generates bold text' do
+    @docs.bold('name').must_equal '__name__'
+  end
+
+  it 'generates code formatted text' do
+    @docs.code('/things').must_equal '`/things`'
+  end
+
+  it 'generates a bullet with nest level of 1 as default' do
+    @docs.bullet('test').must_equal "  - test\n"
+  end
+
+  it 'generates a bullet with nest level between 1 and 3' do
+    proc {@docs.bullet('test', 4)}.must_raise ArgumentError
+    proc {@docs.bullet('test', 0)}.must_raise ArgumentError
+  end
+
+  it 'generates a nested bulleted list' do
+    @docs.bullet('test', 2).must_equal "    - test\n"
+  end
+
+  it 'generates a nested bullet code span' do
+    @docs.bullet('`/things`', 2).must_equal "    - `/things`\n"
+  end
+
+  it 'generates nested bulleted bold text' do
+    @docs.bullet('__id__', 3).must_equal "      - __id__\n"
+  end
+
+  it 'outputs a string of the completed doc' do
+    @docs.output.must_be_kind_of String
+  end
+end

data/spec/hyperdrive/dsl/main_spec.rb

@@ -0,0 +1,16 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Hyperdrive::DSL::Main do
+  it "creates a singleton instance of hyperdrive" do
+    hyperdrive do
+    end.must_be_instance_of ::Hyperdrive::DSL::Main
+  end
+
+  it "registers a resource" do
+    hyperdrive do
+      resource(:thing) {}
+    end.resources[:thing].must_be_instance_of ::Hyperdrive::Resource
+  end
+end

data/spec/hyperdrive/dsl/resource_spec.rb

@@ -0,0 +1,58 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Hyperdrive::DSL::Resource do
+
+  it "sets the name of the endpoint" do
+    hyperdrive do
+      resource(:thing) do
+        name "Thing Resource"
+      end
+    end.resources[:thing].name.must_equal 'Thing Resource'
+  end
+
+  it "describes the endpoint" do
+    hyperdrive do
+      resource(:thing) do
+        desc "Thing Description"
+      end
+    end.resources[:thing].desc.must_equal 'Thing Description'
+  end
+
+  it "registers an allowed param on a resource" do
+    hyperdrive do
+      resource(:thing) do
+        param :name, "Thing's Name"
+      end
+    end.resources[:thing].allowed_params[:name][:desc].must_equal "Thing's Name"
+  end
+
+  it "registers an allowed param on a resource" do
+    hyperdrive do
+      resource(:thing) do
+        filter :parent_id, "Thing's Parent ID"
+      end
+    end.resources[:thing].filters[:parent_id][:desc].must_equal "Thing's Parent ID"
+  end
+
+  it "defines how requests are handled" do
+    hyperdrive do
+      resource(:thing) do
+        request(:get) do
+          'ok'
+        end
+      end
+    end.resources[:thing].request_handlers[:get].call.must_equal 'ok'
+  end
+
+  it "raises an exception if request method argument is unknown" do
+    proc do
+      hyperdrive do
+        resource(:thing) do
+          request(:verb)
+        end
+      end
+    end.must_raise Hyperdrive::Errors::DSL::UnknownArgument
+  end
+end

data/spec/hyperdrive/resource_spec.rb

@@ -5,10 +5,6 @@ describe Hyperdrive::Resource do
     @resource = Hyperdrive::Resource.new(:thing)
   end
 
-  it "creates a new resource" do
-    @resource.resource.must_equal :thing
-  end
-
   it "has a name" do
     @resource.name = 'Thing'
     @resource.name.must_equal 'Thing'
@@ -19,6 +15,10 @@ describe Hyperdrive::Resource do
     @resource.desc.must_equal 'Description of Thing Resource'
   end
 
+  it "has an endpoint" do
+    @resource.endpoint.must_equal '/things'
+  end
+
   it "auto-registers the :id param" do
     @resource.allowed_params[:id][:desc].must_equal 'Resource Identifier'
     @resource.allowed_params[:id][:required].must_equal %w(PUT PATCH DELETE)
@@ -32,7 +32,7 @@ describe Hyperdrive::Resource do
 
   it "auto-registers the :id filter" do
     @resource.filters[:id][:desc].must_equal 'Resource Identifier'
-    @resource.filters[:id][:required].must_equal false 
+    @resource.filters[:id][:required].must_equal false
   end
 
   it "registers a filter" do
@@ -40,4 +40,28 @@ describe Hyperdrive::Resource do
     @resource.filters[:parent_id][:desc].must_equal 'Parent ID of Thing'
     @resource.filters[:parent_id][:required].must_equal true
   end
+
+  it "defines a request handler" do
+    @resource.define_request_handler(:get, Proc.new { return 'ok' })
+    @resource.request_handlers[:get].call.must_equal 'ok'
+  end
+
+  it "returns the specified request handler" do
+    @resource.define_request_handler(:get, Proc.new { return 'ok' })
+    @resource.request_handler('GET').call.must_equal 'ok'
+  end
+
+  it "returns true if the request can be handled" do
+    @resource.define_request_handler(:get, Proc.new { return 'ok' })
+    @resource.request_method_allowed?('GET').must_equal true
+  end
+
+  it "returns false if the request can not be handled" do
+    @resource.request_method_allowed?('GET').must_equal false
+  end
+
+  it "returns the request methods that can handled" do
+    @resource.define_request_handler(:get, Proc.new { return 'ok' })
+    @resource.allowed_methods.must_equal ['OPTIONS','GET','HEAD']
+  end
 end

data/spec/hyperdrive/response_spec.rb

@@ -0,0 +1,23 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Hyperdrive::Response do
+  before do
+    @resource = Hyperdrive::Resource.new(:things)
+  end
+
+  it "throws an error when the request method is unspported by hyperdrive" do
+    proc { Hyperdrive::Response.new({ 'REQUEST_METHOD' => 'TRACE' }, @resource) }.must_raise Hyperdrive::Errors::NotImplemented
+  end
+
+  it "throws an error when the request method is not allowed" do
+    proc { Hyperdrive::Response.new({ 'REQUEST_METHOD' => 'GET' }, @resource) }.must_raise Hyperdrive::Errors::MethodNotAllowed
+  end
+
+  it "responds to requests" do
+    @resource.define_request_handler(:get, Proc.new { return 'ok' })
+    response = Hyperdrive::Response.new({ 'REQUEST_METHOD' => 'GET' }, @resource)
+    response.response.must_equal 'ok'
+  end
+end

data/spec/hyperdrive/server_spec.rb

@@ -0,0 +1,11 @@
+# encoding: utf-8
+
+describe Hyperdrive::Server do
+  it "handles GET requests successfully"
+  it "handles HEAD requests successfully"
+  it "handles OPTIONS requests successfully"
+  it "handles POST requests successfully"
+  it "handles PUT requests successfully"
+  it "handles PATCH requests successfully"
+  it "handles DELETE requests successfully"
+end

data/spec/spec_helper.rb

@@ -4,13 +4,15 @@
 ENV['RACK_ENV'] = 'test'
 lib_path = File.expand_path('../lib', __FILE__)
 ($:.unshift lib_path) unless ($:.include? lib_path)
+
+# require dependencies
 require 'bundler'
 Bundler.setup(:default, ENV['RACK_ENV'])
 
-# test subject
+# our humble test subject
 require 'hyperdrive'
 
-# BDD Stack
+# Fire up the BDD Stack
 require 'minitest/autorun'
 require "minitest-spec-context"
 require 'minitest/reporters'
@@ -18,3 +20,20 @@ require 'minitest/reporters'
 #  all systems go
 MiniTest::Reporters.use! MiniTest::Reporters::SpecReporter.new
 #include Rack::Test::Methods
+
+def sample_api
+  hyperdrive do
+    resource(:thing) do
+      name 'Thing Resource'
+      desc 'Description of Thing Resource'
+
+      param :name, '50 Chars or less' 
+      param :start_date, 'Format: YYYY-MM-DD', required: false
+      param :end_date, 'Format: YYYY-MM-DD', required: false
+
+      filter :start_date, 'Format: YYYY-MM-DD'
+      filter :end_date, 'Format: YYYY-MM-DD'
+      filter :parent_id, 'Parent ID of Thing', required: true
+    end
+  end
+end

metadata

@@ -1,34 +1,101 @@
 --- !ruby/object:Gem::Specification
 name: hyperdrive
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - StyleSeek Engineering
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-13 00:00:00.000000000 Z
-dependencies: []
-description: Ruby DSL for defining self-documenting, HATEOS™ complaint, Hypermedia
+date: 2014-04-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: linguistics
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ruby DSL for defining self-documenting, HATEOAS™ complaint, Hypermedia
   API endpoints.
 email:
 - engineering@styleseek.com
-executables: []
+executables:
+- hyperdrive
 extensions: []
 extra_rdoc_files: []
 files:
+- ".coveralls.yml"
 - ".gitignore"
 - ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- bin/console
+- bin/hyperdrive
 - hyperdrive.gemspec
 - lib/hyperdrive.rb
+- lib/hyperdrive/docs.rb
+- lib/hyperdrive/dsl.rb
+- lib/hyperdrive/dsl/main.rb
+- lib/hyperdrive/dsl/resource.rb
+- lib/hyperdrive/errors.rb
+- lib/hyperdrive/errors/bad_request.rb
+- lib/hyperdrive/errors/dsl/unknown_argument.rb
+- lib/hyperdrive/errors/http_error.rb
+- lib/hyperdrive/errors/internal_server_error.rb
+- lib/hyperdrive/errors/method_not_allowed.rb
+- lib/hyperdrive/errors/not_found.rb
+- lib/hyperdrive/errors/not_implemented.rb
+- lib/hyperdrive/errors/unauthorized.rb
 - lib/hyperdrive/resource.rb
+- lib/hyperdrive/response.rb
+- lib/hyperdrive/server.rb
+- lib/hyperdrive/values.rb
 - lib/hyperdrive/version.rb
+- spec/hyperdrive/docs_spec.rb
+- spec/hyperdrive/dsl/main_spec.rb
+- spec/hyperdrive/dsl/resource_spec.rb
 - spec/hyperdrive/resource_spec.rb
+- spec/hyperdrive/response_spec.rb
+- spec/hyperdrive/server_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/styleseek/hyperdrive
 licenses:
@@ -55,5 +122,10 @@ signing_key:
 specification_version: 4
 summary: Hypermedia State Machine
 test_files:
+- spec/hyperdrive/docs_spec.rb
+- spec/hyperdrive/dsl/main_spec.rb
+- spec/hyperdrive/dsl/resource_spec.rb
 - spec/hyperdrive/resource_spec.rb
+- spec/hyperdrive/response_spec.rb
+- spec/hyperdrive/server_spec.rb
 - spec/spec_helper.rb