hyperdrive 0.0.15 → 0.0.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4b7cbd700b539127c3ecf2e78907a8c3eae46d0a
-  data.tar.gz: b8f3dda138e2148b538a2a49e6e91297c83e5504
+  metadata.gz: b111cd2840e4210416ca5edbe340199dd206c1bb
+  data.tar.gz: 3b3ecb7863fbf7006e6584cbb7250ef261e49d67
 SHA512:
-  metadata.gz: 6eeb1f397b297a8a8a2c0c2418b74a354973ab700ccf853e46d2dde4d51bcd5aa788856615d684a21247a9e37a503eeef34920f501419ef42f4a3078f99c08a6
-  data.tar.gz: f6b738d8f4f0e9dc588449d891cfd1a9794e2c83b0e994b88a48fee4196d23a91c8d998ab02dd1eac218161d2dfe3096fb5dd214be8bc04f5a4630e10f438407
+  metadata.gz: 9e461cd608d77b6cbbfb09c9851971c5bd4acdcb1ee4d25b1550db03a0b70c0ed996e104d2179331d91c9012b4eda73a9fda122ead6e5ca53bfaa42fcc38831c
+  data.tar.gz: f8d2e7ea4e3307596a1641d0e80d9275bb356e105fb15eb282cc7819568225fe0c1734eea337ae486391ca603c2916d12ea29da67db1150b6929c41c750fa052

data/README.md

@@ -1,6 +1,6 @@
 # Hyperdrive
 
-[![Gem Version](https://badge.fury.io/rb/hyperdrive.png)](http://badge.fury.io/rb/hyperdrive) [![Build Status](https://secure.travis-ci.org/styleseek/hyperdrive.png?branch=master)](https://travis-ci.org/styleseek/hyperdrive) [![Code Climate](https://codeclimate.com/github/styleseek/hyperdrive.png)](https://codeclimate.com/github/styleseek/hyperdrive) [![Test Coverage](https://codeclimate.com/github/styleseek/hyperdrive/coverage.png)](https://codeclimate.com/github/styleseek/hyperdrive) [![Dependency Status](https://gemnasium.com/styleseek/hyperdrive.png)](https://gemnasium.com/styleseek/hyperdrive)
+[![Gem Version](https://badge.fury.io/rb/hyperdrive.png)](http://badge.fury.io/rb/hyperdrive) [![Build Status](https://travis-ci.org/styleseek/hyperdrive.svg?branch=master)](https://travis-ci.org/styleseek/hyperdrive) [![Code Climate](https://codeclimate.com/github/styleseek/hyperdrive.png)](https://codeclimate.com/github/styleseek/hyperdrive) [![Test Coverage](https://codeclimate.com/github/styleseek/hyperdrive/coverage.png)](https://codeclimate.com/github/styleseek/hyperdrive) [![Dependency Status](https://gemnasium.com/styleseek/hyperdrive.svg)](https://gemnasium.com/styleseek/hyperdrive)
 
 
 Ruby DSL for defining self-documenting, HATEOAS™ complaint, Hypermedia endpoints.

data/lib/hyperdrive/dsl/resource.rb

@@ -26,11 +26,17 @@ module Hyperdrive
         resource.register_filter(*args)
       end
 
-      def request(request_method)
+      def request(request_method, version = 'v1')
         unless definable_request_methods.include? request_method
           raise Errors::DSL::UnknownArgument.new(request_method, 'request')
         end
-        resource.register_request_handler(request_method, Proc.new)
+        resource.register_request_handler(request_method, Proc.new, version)
+      end
+
+      def before(request_methods = [:get, :post, :put, :patch, :delete], version = 'v1')
+        Array(request_methods).each do |request_method|
+          resource.register_callback(:before, request_method, Proc.new, version)
+        end
       end
     end
   end

data/lib/hyperdrive/dsl.rb

@@ -14,8 +14,13 @@ module Hyperdrive
       self
     end
 
+    def instrument(*args)
+      @config[:instrumenter] = @config[:instrumenter] || Hyperdrive::Instrumenters::Noop
+      @config[:instrumenter].instrument(*args)
+    end
+
     private
-    
+
     def name(name)
       @config[:name] = name
     end
@@ -39,7 +44,17 @@ module Hyperdrive
     end
 
     def per_page(per_page)
-      @config[:per_page] = per_page.to_i
+      per_page = per_page.to_i
+      per_page = default_config[:per_page] if per_page == 0
+      @config[:per_page] = per_page
+    end
+
+    def ssl(force_ssl)
+      @config[:ssl] = force_ssl
+    end
+
+    def instrumenter(instrumenter)
+      @config[:instrumenter] = instrumenter || Hyperdrive::Instrumenters::Noop
     end
 
     def resource(name)

data/lib/hyperdrive/endpoint.rb

@@ -11,7 +11,7 @@ module Hyperdrive
       @resource = env['hyperdrive.resource']
       @headers = Hyperdrive::Values.default_headers.dup
       @headers.merge!('Allow' => resource.allowed_methods.join(', '), 'Content-Type' => @media_type)
-
+      before_response
       response.finish
     end
 
@@ -23,11 +23,16 @@ module Hyperdrive
     end
 
     def self.json?
-      media_type =~ /json$/
+      media_type =~ /json$/ ? true : false
     end
 
     def self.xml?
-      media_type =~ /xml$/
+      media_type =~ /xml$/ ? true : false
+    end
+
+    def self.requested_version
+      regex = /.*\/vnd.#{hyperdrive.config[:vendor]}\..*\.(.*)\+.*$/
+      regex.match(media_type) { |version| version.captures.first } or resource.latest_version(env['REQUEST_METHOD'])
     end
 
     def self.page
@@ -44,13 +49,13 @@ module Hyperdrive
         if json?
           MultiJson.dump(body)
         else
-          env.logger.error "ENDPOINT: Can't serialize response automatically"
+          puts "Hyperdrive::Endpoint: Can't serialize response automatically"
           raise Errors::NoResponse.new
         end
       when String
         body
       else
-        env.logger.debug "ENDPOINT: Coerceing response to string. Probably not what you want"
+        puts "Hyperdrive::Endpoint: Coerceing response to string. Probably not what you want"
         body.to_s
       end
     end
@@ -59,6 +64,16 @@ module Hyperdrive
       raise Errors::HTTPError.new(message, status)
     end
 
+    def self.instrument(*args)
+      hyperdrive.instrument(*args)
+    end
+
+    def self.before_response
+      if @resource.has_callback?(:before, env['REQUEST_METHOD'], requested_version)
+        instance_eval(&@resource.callback(:before, env['REQUEST_METHOD'], requested_version))
+      end
+    end
+
     def self.status
       case env['REQUEST_METHOD']
       when 'POST'
@@ -71,7 +86,7 @@ module Hyperdrive
     end
 
     def self.body
-      body = instance_eval(&resource.request_handler(env['REQUEST_METHOD']))
+      body = instance_eval(&resource.request_handler(env['REQUEST_METHOD'], requested_version))
       body = '' if env['REQUEST_METHOD'] == 'DELETE'
       body
     end

data/lib/hyperdrive/hateoas.rb

@@ -5,41 +5,57 @@ module Hyperdrive
     extend Hyperdrive::Values
 
     def self.call(env)
+      @env = env
       if hyperdrive.resources.empty? || env['PATH_INFO'] != '/'
         raise Hyperdrive::Errors::NotFound
       end
 
-      endpoints = hyperdrive.resources.map do |_,resource|
-        resource.to_hash
-      end
+      [200, headers, [body]]
+    end
 
-      api = {
-              _links: { self: { href: '/' } },
-              name: hyperdrive.config[:name],
-              description: hyperdrive.config[:description],
-              vendor: hyperdrive.config[:vendor],
-              resources: endpoints
-            }
+    private
 
-      media_types = %w(hal+json json).map do |media_type|
+    def self.media_types
+      %w(hal+json json).map do |media_type|
         "application/vnd.#{hyperdrive.config[:vendor]}+#{media_type}"
+      end + %w(application/hal+json application/json)
+    end
+
+    def self.content_type
+      @env['hyperdrive.accept'].best_of(media_types)
+    end
+
+    def self.headers
+      {
+        'Access-Control-Allow-Origin' => '*',
+        'Access-Control-Allow-Methods' => 'GET, HEAD, OPTIONS',
+        'Allow' => 'GET, HEAD, OPTIONS',
+        'Content-Type' => content_type
+      }
+    end
+
+    def self.endpoints
+      hyperdrive.resources.map do |_,resource|
+        resource.to_hash
       end
+    end
 
-      media_types += %w(application/hal+json application/json)
-      content_type = env['hyperdrive.accept'].best_of(media_types)
-      body = if content_type =~ /json$/
-                MultiJson.dump(api)
-              else
-                raise Errors::NotAcceptable.new(env['HTTP_ACCEPT'])
-              end
-
-      status = 200
-      headers = {}
-      headers['Access-Control-Allow-Origin'] = '*'
-      headers['Access-Control-Allow-Methods'] = 'GET, HEAD, OPTIONS'
-      headers['Allow'] = 'GET, HEAD, OPTIONS'
-      headers['Content-Type'] = content_type
-      [status, headers, [body]]
+    def self.response
+      {
+        _links: { self: { href: '/' } },
+        name: hyperdrive.config[:name],
+        description: hyperdrive.config[:description],
+        vendor: hyperdrive.config[:vendor],
+        resources: endpoints
+      }
+    end
+
+    def self.body
+      if content_type =~ /json$/
+        MultiJson.dump(response)
+      else
+        raise Errors::NotAcceptable.new(@env['HTTP_ACCEPT'])
+      end
     end
   end
 end

data/lib/hyperdrive/instrumenters/memory.rb

@@ -0,0 +1,27 @@
+# encoding: utf-8
+
+module Hyperdrive
+  module Instrumenters
+    class Memory
+      Event = Struct.new(:name, :payload, :result)
+
+      attr_reader :events
+
+      def initialize
+        @events = []
+      end
+
+      def instrument(name, payload = {})
+        result = if block_given?
+          yield payload
+        else
+          payload
+        end
+
+        @events << Event.new(name, payload, result)
+
+        result
+      end
+    end
+  end
+end

data/lib/hyperdrive/instrumenters/noop.rb

@@ -0,0 +1,15 @@
+# encoding: utf-8
+
+module Hyperdrive
+  module Instrumenters
+    class Noop
+      def self.instrument(name, payload = {})
+        if block_given?
+          yield payload
+        else
+          payload
+        end
+      end
+    end
+  end
+end

data/lib/hyperdrive/resource.rb

@@ -3,7 +3,7 @@
 module Hyperdrive
   class Resource
     include Hyperdrive::Values
-    attr_reader :id, :namespace, :endpoint, :params, :filters, :request_handlers, :version
+    attr_reader :id, :namespace, :endpoint, :params, :filters, :request_handlers, :callbacks, :version
     attr_accessor :name, :description
 
     def initialize(resource, options = {})
@@ -14,6 +14,7 @@ module Hyperdrive
       @params = default_params
       @filters = default_filters
       @request_handlers = default_request_handlers
+      @callbacks = { before: {} }
       @config = hyperdrive.config
       @id = [@config[:vendor], @namespace].join(':')
     end
@@ -26,6 +27,29 @@ module Hyperdrive
       @filters[filter] = Filter.new(filter, description, options)
     end
 
+    def register_callback(callback_type, request_method, callback, version = 'v1')
+      @callbacks[callback_type] ||={}
+      @callbacks[callback_type][request_method] ||= {}
+      @callbacks[callback_type][request_method].merge!({ version => callback })
+      if request_method == :get
+        @callbacks[callback_type][:head] ||= {}
+        @callbacks[callback_type][:head].merge!({ version => @callbacks[callback_type][:get][version] })
+      end
+    end
+
+    def callback(callback_type, http_request_method, version = nil)
+      version ||= latest_version(http_request_method)
+      request_method = http_request_methods[http_request_method]
+      callbacks[callback_type][request_method][version]
+    end
+
+    def has_callback?(callback_type, http_request_method, version = nil)
+      version ||= latest_version(http_request_method)
+      request_method = http_request_methods[http_request_method]
+      callbacks.has_key?(callback_type) and callbacks[callback_type].has_key?(request_method) and callbacks[callback_type][request_method].has_key?(version)
+    end
+
+
     def register_request_handler(request_method, request_handler, version = 'v1')
       @request_handlers[request_method] ||= {}
       @request_handlers[request_method].merge!({ version => request_handler })
@@ -43,12 +67,12 @@ module Hyperdrive
 
     def acceptable_content_types(http_request_method)
       content_types = []
-      media_type_namepace = @resource.join('.')
+      media_type_namespace = @resource.join('-')
       @config[:media_types].each do |media_type|
         available_versions(http_request_method).each do |version|
-          content_types << "application/vnd.#{@config[:vendor]}.#{media_type_namepace}.#{version}+#{media_type}"
+          content_types << "application/vnd.#{@config[:vendor]}.#{media_type_namespace}.#{version}+#{media_type}"
         end
-        content_types << "application/vnd.#{@config[:vendor]}.#{media_type_namepace}+#{media_type}"
+        content_types << "application/vnd.#{@config[:vendor]}.#{media_type_namespace}+#{media_type}"
         content_types << "application/vnd.#{@config[:vendor]}+#{media_type}"
       end
       content_types

data/lib/hyperdrive/values.rb

@@ -53,7 +53,9 @@ module Hyperdrive
         description: "v#{Hyperdrive::VERSION}",
         vendor: 'hyperdrive',
         media_types: %w(hal+json json),
-        per_page: 20
+        per_page: 20,
+        ssl: false,
+        instrumenter: Hyperdrive::Instrumenters::Noop
       }.freeze
     end
 

data/lib/hyperdrive/version.rb

@@ -1,3 +1,3 @@
 module Hyperdrive
-  VERSION = "0.0.15"
+  VERSION = "0.0.16"
 end

data/lib/hyperdrive.rb

@@ -16,6 +16,10 @@ require 'hyperdrive/version'
 require 'hyperdrive/docs'
 require 'hyperdrive/utils'
 
+## instrumenters
+require 'hyperdrive/instrumenters/memory'
+require 'hyperdrive/instrumenters/noop'
+
 ## sugary syntax and state mangagement
 require 'hyperdrive/dsl'
 require 'hyperdrive/errors'

data/spec/hyperdrive/dsl/resource_spec.rb

@@ -10,6 +10,9 @@ describe Hyperdrive::DSL::Resource do
         description 'Thing Description'
         param :name, 'Thing Name'
         filter :parent_id, "Parent ID"
+        before do
+          'before'
+        end
         request(:get) do
           'ok'
         end
@@ -37,12 +40,16 @@ describe Hyperdrive::DSL::Resource do
     hyperdrive.resources[:thing].filters[:parent_id].description.must_equal "Parent ID"
   end
 
-  it "defines how requests are handled" do
+  it "registers requests handlers" do
     hyperdrive.resources[:thing].request_handlers[:get]['v1'].must_be :===, Proc
   end
 
-  it "throws an error if request method is unknown" do 
+  it "throws an error if request method is unknown" do
     bad_resource = -> { hyperdrive { resource(:thing) { request(:verb) } } }
-    bad_resource.must_raise Hyperdrive::Errors::DSL::UnknownArgument
+   bad_resource.must_raise Hyperdrive::Errors::DSL::UnknownArgument
+  end
+
+  it "registers a before request callback" do
+    hyperdrive.resources[:thing].callbacks[:before][:get]['v1'].must_be :===, Proc
   end
 end

data/spec/hyperdrive/dsl_spec.rb

@@ -11,6 +11,9 @@ describe Hyperdrive::DSL do
       media_types %w(json)
       cors({ origins: '*', allow_headers: %w(Accept), test: 'test'})
       resource(:thing) {}
+      per_page '0'
+      ssl true
+      instrumenter Hyperdrive::Instrumenters::Memory.new
     end
   end
 
@@ -38,7 +41,7 @@ describe Hyperdrive::DSL do
     hyperdrive.resources[:thing].must_be_instance_of ::Hyperdrive::Resource
   end
 
-  it "can configure cors options" do
+  it "configures cors options" do
     hyperdrive.config[:cors][:allow_headers].must_equal ['Accept']
   end
 
@@ -49,4 +52,21 @@ describe Hyperdrive::DSL do
   it "removes unsupported cors options" do
     hyperdrive.config[:cors].key?(:test).must_equal false
   end
+
+  it "configures the default per_page option" do
+    hyperdrive.config[:per_page].must_equal 20
+  end
+
+  it "configures ssl option" do
+    hyperdrive.config[:ssl].must_equal true
+  end
+
+  it "configures instrumenter option" do
+    hyperdrive.config[:instrumenter].must_be_instance_of Hyperdrive::Instrumenters::Memory
+  end
+
+  it "can call the instrumenter" do
+    hyperdrive.instrument('instrumentation', 'measurement') { |payload| payload + '1' }
+    hyperdrive.config[:instrumenter].events.size.must_be :>, 0
+  end
 end

data/spec/hyperdrive/endpoint_spec.rb

@@ -20,6 +20,11 @@ describe Hyperdrive::Endpoint do
     last_response.successful?.must_equal true
   end
 
+  it "runs before callbacks" do
+    get '/', {}, default_rack_env(hyperdrive.resources[:thing])
+    last_response.headers['X-Resource'].must_equal 'Thing Resource'
+  end
+
   it "can raise an HTTPError" do
     hyperdrive do
       resource(:thing) do
@@ -30,4 +35,206 @@ describe Hyperdrive::Endpoint do
     end
     ->{ get '/', {}, default_rack_env(hyperdrive.resources[:thing]) }.must_raise Hyperdrive::Errors::HTTPError
   end
+
+  it "can call the instrumenter" do
+    hyperdrive do
+      instrumenter Hyperdrive::Instrumenters::Memory.new
+      resource(:thing) do
+        request(:get) do
+          instrument('requests.GET', '1')
+        end
+      end
+    end
+    get '/', {}, default_rack_env(hyperdrive.resources[:thing])
+    hyperdrive.config[:instrumenter].events.size.must_be :>, 0
+  end
+
+  it "returns true if media type ends in json" do
+    hyperdrive do
+      resource(:thing) do
+        request(:get) do
+          json?.to_s
+        end
+      end
+    end
+    get '/', {}, default_rack_env(hyperdrive.resources[:thing]).merge('hyperdrive.media_type' => 'application/json')
+    last_response.body.must_equal 'true'
+  end
+
+  it "returns false if media type does not ends in json" do
+    hyperdrive do
+      resource(:thing) do
+        request(:get) do
+          json?.to_s
+        end
+      end
+    end
+    get '/', {}, default_rack_env(hyperdrive.resources[:thing]).merge('hyperdrive.media_type' => 'application/xml')
+    last_response.body.must_equal 'false'
+  end
+
+  it "returns true if media type ends in xml" do
+    hyperdrive do
+      resource(:thing) do
+        request(:get) do
+          xml?.to_s
+        end
+      end
+    end
+    get '/', {}, default_rack_env(hyperdrive.resources[:thing]).merge('hyperdrive.media_type' => 'application/xml')
+    last_response.body.must_equal 'true'
+  end
+
+  it "returns false if media type does not ends in xml" do
+    hyperdrive do
+      resource(:thing) do
+        request(:get) do
+          xml?.to_s
+        end
+      end
+    end
+    get '/', {}, default_rack_env(hyperdrive.resources[:thing]).merge('hyperdrive.media_type' => 'application/json')
+    last_response.body.must_equal 'false'
+  end
+
+  it "returns version if media type contains a version" do
+    hyperdrive do
+      resource(:thing) do
+        request(:get, 'v2') do
+          requested_version.to_s
+        end
+      end
+    end
+    get '/', {}, default_rack_env(hyperdrive.resources[:thing]).merge('hyperdrive.media_type' => 'application/vnd.hyperdrive.things.v2+json')
+    last_response.body.must_equal 'v2'
+  end
+
+  it "returns latest version if media type does not contain a version" do
+    hyperdrive do
+      resource(:thing) do
+        request(:get) do
+          requested_version.to_s
+        end
+      end
+    end
+    get '/', {}, default_rack_env(hyperdrive.resources[:thing]).merge('hyperdrive.media_type' => 'application/vnd.hyperdrive.things+json')
+    last_response.body.must_equal 'v1'
+  end
+
+  it "renders Arrays as json if media type is json" do
+    hyperdrive do
+      resource(:thing) do
+        request(:get) do
+          []
+        end
+      end
+    end
+    get '/', {}, default_rack_env(hyperdrive.resources[:thing]).merge('hyperdrive.media_type' => 'application/vnd.hyperdrive.things+json')
+    last_response.body.must_equal '[]'
+  end
+
+  it "throws an error if media type is not json and response is an Array" do
+    hyperdrive do
+      resource(:thing) do
+        request(:get) do
+          []
+        end
+      end
+    end
+    ->{ get '/', {}, default_rack_env(hyperdrive.resources[:thing]).merge({'hyperdrive.media_type' => 'application/xml' }) }.must_raise Hyperdrive::Errors::NoResponse
+  end
+
+  it "renders Hashes as json if media type is json" do
+    hyperdrive do
+      resource(:thing) do
+        request(:get) do
+          {}
+        end
+      end
+    end
+    get '/', {}, default_rack_env(hyperdrive.resources[:thing]).merge('hyperdrive.media_type' => 'application/vnd.hyperdrive.things+json')
+    last_response.body.must_equal '{}'
+  end
+
+  it "throws an error if media type is not json and response is a Hash" do
+    hyperdrive do
+      resource(:thing) do
+        request(:get) do
+          {}
+        end
+      end
+    end
+    ->{ get '/', {}, default_rack_env(hyperdrive.resources[:thing]).merge({'hyperdrive.media_type' => 'application/xml' }) }.must_raise Hyperdrive::Errors::NoResponse
+  end
+
+  it "renders other responses as a string" do
+    hyperdrive do
+      resource(:thing) do
+        request(:get) do
+          0
+        end
+      end
+    end
+    get '/', {}, default_rack_env(hyperdrive.resources[:thing]).merge('hyperdrive.media_type' => 'application/vnd.hyperdrive.things+json')
+    last_response.body.must_equal '0'
+  end
+
+  it "returns the current page" do
+    hyperdrive do
+      resource(:thing) do
+        request(:get) do
+          page
+        end
+      end
+    end
+    get '/', {}, default_rack_env(hyperdrive.resources[:thing]).merge('hyperdrive.page' => '2')
+    last_response.body.must_equal '2'
+  end
+
+  it "returns the number of results in each page" do
+    hyperdrive do
+      resource(:thing) do
+        request(:get) do
+          per_page
+        end
+      end
+    end
+    get '/', {}, default_rack_env(hyperdrive.resources[:thing]).merge('hyperdrive.per_page' => '20')
+    last_response.body.must_equal '20'
+  end
+
+  it "returns 200 when request is a GET" do
+    get '/', {}, default_rack_env(hyperdrive.resources[:thing])
+    last_response.status.must_equal 200
+  end
+
+  it "returns 201 when request is a POST" do
+    post '/', {}, default_rack_env(hyperdrive.resources[:thing]).merge('REQUEST_METHOD' => 'POST')
+    last_response.status.must_equal 201
+  end
+
+  it "returns 200 when request is a PUT" do
+    put '/', {}, default_rack_env(hyperdrive.resources[:thing]).merge('REQUEST_METHOD' => 'PUT')
+    last_response.status.must_equal 200
+  end
+
+  it "returns 200 when request is a PATCH" do
+    patch '/', {}, default_rack_env(hyperdrive.resources[:thing]).merge('REQUEST_METHOD' => 'PATCH')
+    last_response.status.must_equal 200
+  end
+
+  it "returns 200 when request is a OPTIONS" do
+    options '/', {}, default_rack_env(hyperdrive.resources[:thing]).merge('REQUEST_METHOD' => 'OPTIONS')
+    last_response.status.must_equal 200
+  end
+
+  it "returns 204 when request is a DELETE" do
+    delete '/', {}, default_rack_env(hyperdrive.resources[:thing]).merge('REQUEST_METHOD' => 'DELETE')
+    last_response.status.must_equal 204
+  end
+
+  it "returns an empty body when request is a DELETE" do
+    delete '/', {}, default_rack_env(hyperdrive.resources[:thing]).merge('REQUEST_METHOD' => 'DELETE')
+    last_response.body.must_equal ''
+  end
 end

data/spec/hyperdrive/filter_spec.rb

@@ -19,6 +19,10 @@ describe Hyperdrive::Filter do
     @filter.required.must_equal %w(GET HEAD)
   end
 
+  it "returns an array if only a single HTTP method is required" do
+    Hyperdrive::Filter.new(:filter, '', required: 'GET').required.must_equal ['GET']
+  end
+
   it "returns true if the param is required for the given HTTP method" do
     @filter.required?('GET').must_equal true
   end
@@ -27,7 +31,7 @@ describe Hyperdrive::Filter do
     @filter.required?('OPTIONS').must_equal false
   end
 
-  it "converts itself as a hash" do
+  it "converts itself to a hash" do
     constraints = { name: 'parent_id', description: 'Parent Identifier', type: 'String', constraints: 'Required for: GET, HEAD. Must be a valid BSON Object ID.' }
     @filter.to_hash.must_equal constraints
   end

data/spec/hyperdrive/hateoas_spec.rb

@@ -38,5 +38,9 @@ describe Hyperdrive::HATEOAS do
     it "responds with a description of all resources" do
       last_response.body.must_equal %Q({"_links":{"self":{"href":"/"}},"name":"Hyperdrive API","description":"v#{Hyperdrive::VERSION}","vendor":"hyperdrive","resources":[{"_links":{"self":{"href":"/things"}},"id":"hyperdrive:things","name":"Thing Resource","description":"Description of Thing Resource","methods":["OPTIONS","GET","HEAD","POST","PUT","PATCH","DELETE"],"params":[{"name":"id","description":"Identifier","type":"String","constraints":"Required for: PUT, PATCH, DELETE. "},{"name":"name","description":"50 Chars or less","type":"String","constraints":"Required for: POST, PUT, PATCH. "}],"filters":[{"name":"id","description":"Resource Identifier","type":"String","constraints":" "},{"name":"parent_id","description":"Parent ID of Thing","type":"String","constraints":"Required for: GET, HEAD. "}],"media_types":[["application/vnd.hyperdrive.things.v1+hal+json","application/vnd.hyperdrive.things+hal+json","application/vnd.hyperdrive+hal+json","application/vnd.hyperdrive.things.v1+json","application/vnd.hyperdrive.things+json","application/vnd.hyperdrive+json"]]}]})
     end
+
+    it "throws an error if request doesn't accept json" do
+      ->{ get '/', {}, default_hyperdrive_env.merge({ 'Accept' => 'application/xml' }) }.must_raise Hyperdrive::Errors::NotAcceptable
+    end
   end
 end

data/spec/hyperdrive/instrumenters/memory_spec.rb

@@ -0,0 +1,29 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Hyperdrive::Instrumenters::Memory do
+  before do
+    @instrumenter = Hyperdrive::Instrumenters::Memory.new
+  end
+
+  it "responds to instrument" do
+    @instrumenter.respond_to?(:instrument).must_equal true
+  end
+
+  it "returns the result" do
+    @instrumenter.instrument('instrumentation', 'measurement').must_equal 'measurement'
+  end
+
+  it "yields to the block and returns the result" do
+    @instrumenter.instrument('instrumentation', 'measurement') { |payload| payload + '1' }.must_equal 'measurement1'
+  end
+
+  it "returns events that have been instrumented" do
+    @instrumenter.instrument('instrumentation', 'measurement')
+    event = @instrumenter.events.first
+    event.name.must_equal 'instrumentation'
+    event.payload.must_equal 'measurement'
+    event.result.must_equal 'measurement'
+  end
+end

data/spec/hyperdrive/instrumenters/noop_spec.rb

@@ -0,0 +1,21 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Hyperdrive::Instrumenters::Noop do
+  before do
+    @instrumenter = Hyperdrive::Instrumenters::Noop
+  end
+
+  it "responds to instrument" do
+    @instrumenter.respond_to?(:instrument).must_equal true
+  end
+
+  it "returns the result" do
+    @instrumenter.instrument('instrumentation', 'measurement').must_equal 'measurement'
+  end
+
+  it "optionally takes a block" do
+    @instrumenter.instrument('instrumentation', 'measurement') { |payload| payload + '1' } .must_equal 'measurement1'
+  end
+end

data/spec/hyperdrive/middleware/required_params_spec.rb

@@ -23,6 +23,10 @@ describe Hyperdrive::Middleware::RequiredParams do
     it "raises an error if required filter is missing" do
       ->{ get '/', {}, @env }.must_raise Hyperdrive::Errors::MissingRequiredParam
     end
+
+    it "raises an error if required filter is missing" do
+      ->{ get '/', {}, @env.merge('hyperdrive.params' => { parent_id: '' }) }.must_raise Hyperdrive::Errors::MissingRequiredParam
+    end
   end
 
   context "Params" do

data/spec/hyperdrive/param_spec.rb

@@ -19,6 +19,10 @@ describe Hyperdrive::Param do
     @param.required.must_equal %w(PUT PATCH DELETE)
   end
 
+ it "returns an array if only a single HTTP method is required" do
+    Hyperdrive::Filter.new(:param, '', required: 'GET').required.must_equal ['GET']
+  end
+
   it "returns true if the param is required for the given HTTP method" do
     @param.required?('PUT').must_equal true
   end
@@ -27,7 +31,7 @@ describe Hyperdrive::Param do
     @param.required?('POST').must_equal false
   end
 
-  it "converts itself as a hash" do
+  it "converts itself to a hash" do
     constraints = { name: 'id', description: 'Identifier', type: 'String', constraints: 'Required for: PUT, PATCH, DELETE. Must be a valid BSON Object ID.' }
     @param.to_hash.must_equal constraints
   end

data/spec/hyperdrive/resource_spec.rb

@@ -5,6 +5,8 @@ describe Hyperdrive::Resource do
     @resource = Hyperdrive::Resource.new(:thing)
     @resource.register_param(:name, 'Thing Name')
     @resource.register_filter(:parent_id, 'Parent ID', required: true)
+    @resource.register_callback(:before, :get, Proc.new { |env| 'before v1' })
+    @resource.register_callback(:before, :get, Proc.new { |env| 'before v2' }, 'v2')
     @resource.register_request_handler(:get, Proc.new { |env| 'v1' })
     @resource.register_request_handler(:get, Proc.new { |env| 'v2' }, 'v2')
     @media_types = ["application/vnd.hyperdrive.things.v2+hal+json",
@@ -87,6 +89,26 @@ describe Hyperdrive::Resource do
     @resource.required?(:parent_id, 'DELETE').must_equal false
   end
 
+  it "registers a before callback" do
+    @resource.callbacks[:before][:get]['v1'].must_be :===, Proc
+  end
+
+  it "auto-registers HEAD before callback when GET before callback is registered" do
+    @resource.callbacks[:before][:head]['v1'].must_be :===, Proc
+  end
+
+  it "returns the specified before callback" do
+    @resource.callback(:before, 'GET').must_be :===, Proc
+  end
+
+  it "returns true if the specified before callback exists" do
+    @resource.has_callback?(:before, 'GET').must_equal true
+  end
+
+  it "returns false if the specified before callback does not exist" do
+    @resource.has_callback?(:before, 'GET', 'v3').must_equal false
+  end
+
   it "registers a request handler" do
     @resource.request_handlers[:get]['v1'].must_be :===, Proc
   end

data/spec/hyperdrive/server_spec.rb

@@ -16,37 +16,37 @@ describe Hyperdrive::Server do
   end
 
   it "responds to GET requests successfully" do
-    get '/things', { parent_id: 42 }
+    get '/things', { parent_id: 42 }, default_hyperdrive_env
     last_response.successful?.must_equal true
   end
 
   it "responds to HEAD requests successfully" do
-    head '/things', { parent_id: 42 }
+    head '/things', { parent_id: 42 }, default_hyperdrive_env
     last_response.successful?.must_equal true
   end
 
   it "responds to OPTIONS requests successfully" do
-    options '/things'
+    options '/things', {}, default_hyperdrive_env
     last_response.successful?.must_equal true
   end
 
   it "responds to POST requests successfully" do
-    post '/things', { name: 'bender' }
+    post '/things', { name: 'bender' }, default_hyperdrive_env
     last_response.successful?.must_equal true
   end
 
   it "responds to PUT requests successfully" do
-    put '/things', { id: 1, name: 'bender' }
+    put '/things', { id: 1, name: 'bender' }, default_hyperdrive_env
     last_response.successful?.must_equal true
   end
 
   it "responds to PATCH requests successfully" do
-    patch '/things', { id: 1, name: 'bender' }
+    patch '/things', { id: 1, name: 'bender' }, default_hyperdrive_env
     last_response.successful?.must_equal true
   end
 
   it "responds to DELETE requests successfully" do
-    delete '/things', { id: 1 }
+    delete '/things', { id: 1 }, default_hyperdrive_env
     last_response.successful?.must_equal true
   end
 end

data/spec/hyperdrive/utils_spec.rb

@@ -19,7 +19,7 @@ describe Hyperdrive::Utils do
 
   context '.symbolize_keys' do
     before do
-      @hash = { 'string' => 'cheese', 'collection' => [{'skylanders' => 155}], 'map' => { 'oceans' => 'blue' } }
+      @hash = { :symbol => 'symbol', 'string' => 'cheese', 'collection' => [{'skylanders' => 155}], 'map' => { 'oceans' => 'blue' } }
       @subject = Hyperdrive::Utils.symbolize_keys(@hash)
     end
 
@@ -27,6 +27,10 @@ describe Hyperdrive::Utils do
       @subject[:string].must_equal 'cheese'
     end
 
+    it "doesn't symbolize keys that aren't a string" do
+      @subject[:symbol].must_equal 'symbol'
+    end
+
     it "can symbolize the keys of nested hashes" do
       @subject[:map][:oceans].must_equal 'blue'
     end

data/spec/spec_helper.rb

@@ -29,6 +29,15 @@ include Rack::Test::Methods
 
 module Hyperdrive
   module TestData
+    def default_hyperdrive_env
+      {
+        'HTTP_ACCEPT' => 'application/vnd.hyperdrive.things+hal+json',
+        'hyperdrive.accept' => Rack::Accept::MediaType.new('HTTP_ACCEPT' => 'application/vnd.hyperdrive.things+hal+json;q=0.8'),
+        'hyperdrive.resource' => hyperdrive.resources[:things],
+        'hyperdrive.media_type' => 'application/vnd.hyperdrive.things+hal+json'
+      }
+    end
+
     def default_rack_env(resource = nil)
       default_env = {
         "rack.version" => Rack::VERSION,
@@ -41,7 +50,8 @@ module Hyperdrive
         'HTTP_ACCEPT' => 'application/vnd.hyperdrive.things+hal+json;q=0.8, application/json;q=1',
         'HTTP_ACCEPT_LANGUAGE' => 'en',
         'REQUEST_METHOD' => 'GET',
-        'QUERY_STRING' => 'id=1001'
+        'QUERY_STRING' => 'id=1001',
+        'hyperdrive.media_type' => 'application/vnd.hyperdrive.things+hal+json'
       }
       default_env.merge!('hyperdrive.accept' => Rack::Accept::MediaType.new(default_env['HTTP_ACCEPT']))
       default_env.merge!('hyperdrive.resource' => resource) if resource
@@ -72,6 +82,10 @@ module Hyperdrive
           param :name, '50 Chars or less', required: true
           filter :parent_id, 'Parent ID of Thing', required: true
 
+          before(:get) do
+            @headers.merge!('X-Resource' => resource.name)
+          end
+
           request(:get) do
             'ok'
           end
@@ -89,7 +103,7 @@ module Hyperdrive
           end
 
           request(:delete) do
-            ''
+            'ok'
           end
         end
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hyperdrive
 version: !ruby/object:Gem::Version
-  version: 0.0.15
+  version: 0.0.16
 platform: ruby
 authors:
 - StyleSeek Engineering
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-12 00:00:00.000000000 Z
+date: 2014-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: linguistics
@@ -147,6 +147,8 @@ files:
 - lib/hyperdrive/errors/unknown_error.rb
 - lib/hyperdrive/filter.rb
 - lib/hyperdrive/hateoas.rb
+- lib/hyperdrive/instrumenters/memory.rb
+- lib/hyperdrive/instrumenters/noop.rb
 - lib/hyperdrive/middleware.rb
 - lib/hyperdrive/middleware/accept.rb
 - lib/hyperdrive/middleware/content_negotiation.rb
@@ -183,6 +185,8 @@ files:
 - spec/hyperdrive/errors/unknown_error_spec.rb
 - spec/hyperdrive/filter_spec.rb
 - spec/hyperdrive/hateoas_spec.rb
+- spec/hyperdrive/instrumenters/memory_spec.rb
+- spec/hyperdrive/instrumenters/noop_spec.rb
 - spec/hyperdrive/middleware/accept_spec.rb
 - spec/hyperdrive/middleware/content_negotiation_spec.rb
 - spec/hyperdrive/middleware/cors_spec.rb
@@ -243,6 +247,8 @@ test_files:
 - spec/hyperdrive/errors/unknown_error_spec.rb
 - spec/hyperdrive/filter_spec.rb
 - spec/hyperdrive/hateoas_spec.rb
+- spec/hyperdrive/instrumenters/memory_spec.rb
+- spec/hyperdrive/instrumenters/noop_spec.rb
 - spec/hyperdrive/middleware/accept_spec.rb
 - spec/hyperdrive/middleware/content_negotiation_spec.rb
 - spec/hyperdrive/middleware/cors_spec.rb