hyperdrive 0.0.5 → 0.0.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/.travis.yml +12 -4
- data/Gemfile +2 -0
- data/hyperdrive.gemspec +6 -2
- data/lib/hyperdrive/docs.rb +10 -11
- data/lib/hyperdrive/dsl/resource.rb +10 -15
- data/lib/hyperdrive/dsl.rb +49 -3
- data/lib/hyperdrive/endpoint.rb +65 -0
- data/lib/hyperdrive/errors/missing_required_param.rb +19 -0
- data/lib/hyperdrive/errors/not_acceptable.rb +18 -0
- data/lib/hyperdrive/errors.rb +13 -8
- data/lib/hyperdrive/filter.rb +20 -0
- data/lib/hyperdrive/hateoas.rb +45 -0
- data/lib/hyperdrive/middleware/accept.rb +16 -0
- data/lib/hyperdrive/middleware/content_negotiation.rb +19 -0
- data/lib/hyperdrive/middleware/cors.rb +36 -0
- data/lib/hyperdrive/middleware/error.rb +35 -0
- data/lib/hyperdrive/middleware/request_method.rb +31 -0
- data/lib/hyperdrive/middleware/required_params.rb +35 -0
- data/lib/hyperdrive/middleware/resource.rb +18 -0
- data/lib/hyperdrive/middleware/sanitize_params.rb +25 -0
- data/lib/hyperdrive/middleware.rb +10 -0
- data/lib/hyperdrive/param.rb +44 -0
- data/lib/hyperdrive/resource.rb +74 -30
- data/lib/hyperdrive/server.rb +16 -17
- data/lib/hyperdrive/utils.rb +27 -0
- data/lib/hyperdrive/values.rb +37 -3
- data/lib/hyperdrive/version.rb +1 -1
- data/lib/hyperdrive.rb +21 -7
- data/spec/hyperdrive/docs_spec.rb +14 -8
- data/spec/hyperdrive/dsl/resource_spec.rb +27 -37
- data/spec/hyperdrive/dsl_spec.rb +52 -0
- data/spec/hyperdrive/endpoint_spec.rb +22 -0
- data/spec/hyperdrive/filter_spec.rb +34 -0
- data/spec/hyperdrive/hateoas_spec.rb +42 -0
- data/spec/hyperdrive/middleware/accept_spec.rb +15 -0
- data/spec/hyperdrive/middleware/content_negotiation_spec.rb +29 -0
- data/spec/hyperdrive/middleware/cors_spec.rb +47 -0
- data/spec/hyperdrive/middleware/error_spec.rb +25 -0
- data/spec/hyperdrive/middleware/request_method_spec.rb +28 -0
- data/spec/hyperdrive/middleware/required_params_spec.rb +43 -0
- data/spec/hyperdrive/middleware/resource_spec.rb +15 -0
- data/spec/hyperdrive/middleware/sanitize_params_spec.rb +24 -0
- data/spec/hyperdrive/param_spec.rb +34 -0
- data/spec/hyperdrive/resource_spec.rb +87 -25
- data/spec/hyperdrive/server_spec.rb +48 -7
- data/spec/hyperdrive/utils_spec.rb +38 -0
- data/spec/hyperdrive/values_spec.rb +37 -0
- data/spec/spec_helper.rb +71 -12
- metadata +106 -11
- data/.coveralls.yml +0 -1
- data/lib/hyperdrive/dsl/main.rb +0 -19
- data/lib/hyperdrive/response.rb +0 -42
- data/spec/hyperdrive/dsl/main_spec.rb +0 -16
- data/spec/hyperdrive/response_spec.rb +0 -23
metadata
CHANGED
@@ -1,15 +1,43 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: hyperdrive
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.0.
|
4
|
+
version: 0.0.6
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- StyleSeek Engineering
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2014-04
|
11
|
+
date: 2014-05-04 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
|
+
- !ruby/object:Gem::Dependency
|
14
|
+
name: linguistics
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
16
|
+
requirements:
|
17
|
+
- - ">="
|
18
|
+
- !ruby/object:Gem::Version
|
19
|
+
version: '0'
|
20
|
+
type: :runtime
|
21
|
+
prerelease: false
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
23
|
+
requirements:
|
24
|
+
- - ">="
|
25
|
+
- !ruby/object:Gem::Version
|
26
|
+
version: '0'
|
27
|
+
- !ruby/object:Gem::Dependency
|
28
|
+
name: oj
|
29
|
+
requirement: !ruby/object:Gem::Requirement
|
30
|
+
requirements:
|
31
|
+
- - ">="
|
32
|
+
- !ruby/object:Gem::Version
|
33
|
+
version: '0'
|
34
|
+
type: :runtime
|
35
|
+
prerelease: false
|
36
|
+
version_requirements: !ruby/object:Gem::Requirement
|
37
|
+
requirements:
|
38
|
+
- - ">="
|
39
|
+
- !ruby/object:Gem::Version
|
40
|
+
version: '0'
|
13
41
|
- !ruby/object:Gem::Dependency
|
14
42
|
name: rack
|
15
43
|
requirement: !ruby/object:Gem::Requirement
|
@@ -25,7 +53,35 @@ dependencies:
|
|
25
53
|
- !ruby/object:Gem::Version
|
26
54
|
version: '0'
|
27
55
|
- !ruby/object:Gem::Dependency
|
28
|
-
name:
|
56
|
+
name: rack-cache
|
57
|
+
requirement: !ruby/object:Gem::Requirement
|
58
|
+
requirements:
|
59
|
+
- - ">="
|
60
|
+
- !ruby/object:Gem::Version
|
61
|
+
version: '0'
|
62
|
+
type: :runtime
|
63
|
+
prerelease: false
|
64
|
+
version_requirements: !ruby/object:Gem::Requirement
|
65
|
+
requirements:
|
66
|
+
- - ">="
|
67
|
+
- !ruby/object:Gem::Version
|
68
|
+
version: '0'
|
69
|
+
- !ruby/object:Gem::Dependency
|
70
|
+
name: rack-ssl
|
71
|
+
requirement: !ruby/object:Gem::Requirement
|
72
|
+
requirements:
|
73
|
+
- - ">="
|
74
|
+
- !ruby/object:Gem::Version
|
75
|
+
version: '0'
|
76
|
+
type: :runtime
|
77
|
+
prerelease: false
|
78
|
+
version_requirements: !ruby/object:Gem::Requirement
|
79
|
+
requirements:
|
80
|
+
- - ">="
|
81
|
+
- !ruby/object:Gem::Version
|
82
|
+
version: '0'
|
83
|
+
- !ruby/object:Gem::Dependency
|
84
|
+
name: rack-accept
|
29
85
|
requirement: !ruby/object:Gem::Requirement
|
30
86
|
requirements:
|
31
87
|
- - ">="
|
@@ -52,7 +108,7 @@ dependencies:
|
|
52
108
|
- - ">="
|
53
109
|
- !ruby/object:Gem::Version
|
54
110
|
version: '0'
|
55
|
-
description: Ruby DSL for defining self-documenting, HATEOAS™
|
111
|
+
description: Ruby DSL for defining self-documenting, HATEOAS™ compliant, Hypermedia
|
56
112
|
API endpoints.
|
57
113
|
email:
|
58
114
|
- engineering@styleseek.com
|
@@ -61,7 +117,6 @@ executables:
|
|
61
117
|
extensions: []
|
62
118
|
extra_rdoc_files: []
|
63
119
|
files:
|
64
|
-
- ".coveralls.yml"
|
65
120
|
- ".gitignore"
|
66
121
|
- ".travis.yml"
|
67
122
|
- Gemfile
|
@@ -74,28 +129,55 @@ files:
|
|
74
129
|
- lib/hyperdrive.rb
|
75
130
|
- lib/hyperdrive/docs.rb
|
76
131
|
- lib/hyperdrive/dsl.rb
|
77
|
-
- lib/hyperdrive/dsl/main.rb
|
78
132
|
- lib/hyperdrive/dsl/resource.rb
|
133
|
+
- lib/hyperdrive/endpoint.rb
|
79
134
|
- lib/hyperdrive/errors.rb
|
80
135
|
- lib/hyperdrive/errors/bad_request.rb
|
81
136
|
- lib/hyperdrive/errors/dsl/unknown_argument.rb
|
82
137
|
- lib/hyperdrive/errors/http_error.rb
|
83
138
|
- lib/hyperdrive/errors/internal_server_error.rb
|
84
139
|
- lib/hyperdrive/errors/method_not_allowed.rb
|
140
|
+
- lib/hyperdrive/errors/missing_required_param.rb
|
141
|
+
- lib/hyperdrive/errors/not_acceptable.rb
|
85
142
|
- lib/hyperdrive/errors/not_found.rb
|
86
143
|
- lib/hyperdrive/errors/not_implemented.rb
|
87
144
|
- lib/hyperdrive/errors/unauthorized.rb
|
145
|
+
- lib/hyperdrive/filter.rb
|
146
|
+
- lib/hyperdrive/hateoas.rb
|
147
|
+
- lib/hyperdrive/middleware.rb
|
148
|
+
- lib/hyperdrive/middleware/accept.rb
|
149
|
+
- lib/hyperdrive/middleware/content_negotiation.rb
|
150
|
+
- lib/hyperdrive/middleware/cors.rb
|
151
|
+
- lib/hyperdrive/middleware/error.rb
|
152
|
+
- lib/hyperdrive/middleware/request_method.rb
|
153
|
+
- lib/hyperdrive/middleware/required_params.rb
|
154
|
+
- lib/hyperdrive/middleware/resource.rb
|
155
|
+
- lib/hyperdrive/middleware/sanitize_params.rb
|
156
|
+
- lib/hyperdrive/param.rb
|
88
157
|
- lib/hyperdrive/resource.rb
|
89
|
-
- lib/hyperdrive/response.rb
|
90
158
|
- lib/hyperdrive/server.rb
|
159
|
+
- lib/hyperdrive/utils.rb
|
91
160
|
- lib/hyperdrive/values.rb
|
92
161
|
- lib/hyperdrive/version.rb
|
93
162
|
- spec/hyperdrive/docs_spec.rb
|
94
|
-
- spec/hyperdrive/dsl/main_spec.rb
|
95
163
|
- spec/hyperdrive/dsl/resource_spec.rb
|
164
|
+
- spec/hyperdrive/dsl_spec.rb
|
165
|
+
- spec/hyperdrive/endpoint_spec.rb
|
166
|
+
- spec/hyperdrive/filter_spec.rb
|
167
|
+
- spec/hyperdrive/hateoas_spec.rb
|
168
|
+
- spec/hyperdrive/middleware/accept_spec.rb
|
169
|
+
- spec/hyperdrive/middleware/content_negotiation_spec.rb
|
170
|
+
- spec/hyperdrive/middleware/cors_spec.rb
|
171
|
+
- spec/hyperdrive/middleware/error_spec.rb
|
172
|
+
- spec/hyperdrive/middleware/request_method_spec.rb
|
173
|
+
- spec/hyperdrive/middleware/required_params_spec.rb
|
174
|
+
- spec/hyperdrive/middleware/resource_spec.rb
|
175
|
+
- spec/hyperdrive/middleware/sanitize_params_spec.rb
|
176
|
+
- spec/hyperdrive/param_spec.rb
|
96
177
|
- spec/hyperdrive/resource_spec.rb
|
97
|
-
- spec/hyperdrive/response_spec.rb
|
98
178
|
- spec/hyperdrive/server_spec.rb
|
179
|
+
- spec/hyperdrive/utils_spec.rb
|
180
|
+
- spec/hyperdrive/values_spec.rb
|
99
181
|
- spec/spec_helper.rb
|
100
182
|
homepage: https://github.com/styleseek/hyperdrive
|
101
183
|
licenses:
|
@@ -123,9 +205,22 @@ specification_version: 4
|
|
123
205
|
summary: Hypermedia State Machine
|
124
206
|
test_files:
|
125
207
|
- spec/hyperdrive/docs_spec.rb
|
126
|
-
- spec/hyperdrive/dsl/main_spec.rb
|
127
208
|
- spec/hyperdrive/dsl/resource_spec.rb
|
209
|
+
- spec/hyperdrive/dsl_spec.rb
|
210
|
+
- spec/hyperdrive/endpoint_spec.rb
|
211
|
+
- spec/hyperdrive/filter_spec.rb
|
212
|
+
- spec/hyperdrive/hateoas_spec.rb
|
213
|
+
- spec/hyperdrive/middleware/accept_spec.rb
|
214
|
+
- spec/hyperdrive/middleware/content_negotiation_spec.rb
|
215
|
+
- spec/hyperdrive/middleware/cors_spec.rb
|
216
|
+
- spec/hyperdrive/middleware/error_spec.rb
|
217
|
+
- spec/hyperdrive/middleware/request_method_spec.rb
|
218
|
+
- spec/hyperdrive/middleware/required_params_spec.rb
|
219
|
+
- spec/hyperdrive/middleware/resource_spec.rb
|
220
|
+
- spec/hyperdrive/middleware/sanitize_params_spec.rb
|
221
|
+
- spec/hyperdrive/param_spec.rb
|
128
222
|
- spec/hyperdrive/resource_spec.rb
|
129
|
-
- spec/hyperdrive/response_spec.rb
|
130
223
|
- spec/hyperdrive/server_spec.rb
|
224
|
+
- spec/hyperdrive/utils_spec.rb
|
225
|
+
- spec/hyperdrive/values_spec.rb
|
131
226
|
- spec/spec_helper.rb
|
data/.coveralls.yml
DELETED
@@ -1 +0,0 @@
|
|
1
|
-
service_name: travis-ci
|
data/lib/hyperdrive/dsl/main.rb
DELETED
@@ -1,19 +0,0 @@
|
|
1
|
-
# encoding: utf-8
|
2
|
-
require 'singleton'
|
3
|
-
|
4
|
-
module Hyperdrive
|
5
|
-
module DSL
|
6
|
-
class Main
|
7
|
-
include Singleton
|
8
|
-
attr_reader :resources
|
9
|
-
|
10
|
-
def initialize(&block)
|
11
|
-
@resources = {}
|
12
|
-
end
|
13
|
-
|
14
|
-
def resource(name, &block)
|
15
|
-
@resources[name] = Resource.new(name, &block).resource
|
16
|
-
end
|
17
|
-
end
|
18
|
-
end
|
19
|
-
end
|
data/lib/hyperdrive/response.rb
DELETED
@@ -1,42 +0,0 @@
|
|
1
|
-
# encoding: utf-8
|
2
|
-
|
3
|
-
module Hyperdrive
|
4
|
-
class Response
|
5
|
-
attr_reader :resource, :env, :http_request_method, :headers
|
6
|
-
|
7
|
-
def initialize(env, resource)
|
8
|
-
@resource = resource
|
9
|
-
@env = env
|
10
|
-
@http_request_method = env['REQUEST_METHOD']
|
11
|
-
|
12
|
-
unless request_method_supported?
|
13
|
-
raise Errors::NotImplemented.new(http_request_method)
|
14
|
-
end
|
15
|
-
|
16
|
-
unless resource.request_method_allowed?(http_request_method)
|
17
|
-
raise Errors::MethodNotAllowed.new(http_request_method)
|
18
|
-
end
|
19
|
-
|
20
|
-
@headers = default_headers
|
21
|
-
end
|
22
|
-
|
23
|
-
def response
|
24
|
-
@headers.merge({ 'Content-Type' => 'application/json' })
|
25
|
-
status = (http_request_method == 'POST') ? 201 : 200
|
26
|
-
::Rack::Response.new(resource.request_handler(http_request_method).call(env), status, headers).finish
|
27
|
-
end
|
28
|
-
|
29
|
-
private
|
30
|
-
|
31
|
-
def default_headers
|
32
|
-
{
|
33
|
-
'Allow' => resource.allowed_methods,
|
34
|
-
'Content-Type' => 'application/json'
|
35
|
-
}
|
36
|
-
end
|
37
|
-
|
38
|
-
def request_method_supported?
|
39
|
-
Hyperdrive::Values.request_methods_string_map.key?(http_request_method)
|
40
|
-
end
|
41
|
-
end
|
42
|
-
end
|
@@ -1,16 +0,0 @@
|
|
1
|
-
# encoding: utf-8
|
2
|
-
|
3
|
-
require 'spec_helper'
|
4
|
-
|
5
|
-
describe Hyperdrive::DSL::Main do
|
6
|
-
it "creates a singleton instance of hyperdrive" do
|
7
|
-
hyperdrive do
|
8
|
-
end.must_be_instance_of ::Hyperdrive::DSL::Main
|
9
|
-
end
|
10
|
-
|
11
|
-
it "registers a resource" do
|
12
|
-
hyperdrive do
|
13
|
-
resource(:thing) {}
|
14
|
-
end.resources[:thing].must_be_instance_of ::Hyperdrive::Resource
|
15
|
-
end
|
16
|
-
end
|
@@ -1,23 +0,0 @@
|
|
1
|
-
# encoding: utf-8
|
2
|
-
|
3
|
-
require 'spec_helper'
|
4
|
-
|
5
|
-
describe Hyperdrive::Response do
|
6
|
-
before do
|
7
|
-
@resource = Hyperdrive::Resource.new(:things)
|
8
|
-
end
|
9
|
-
|
10
|
-
it "throws an error when the request method is unspported by hyperdrive" do
|
11
|
-
proc { Hyperdrive::Response.new({ 'REQUEST_METHOD' => 'TRACE' }, @resource) }.must_raise Hyperdrive::Errors::NotImplemented
|
12
|
-
end
|
13
|
-
|
14
|
-
it "throws an error when the request method is not allowed" do
|
15
|
-
proc { Hyperdrive::Response.new({ 'REQUEST_METHOD' => 'GET' }, @resource) }.must_raise Hyperdrive::Errors::MethodNotAllowed
|
16
|
-
end
|
17
|
-
|
18
|
-
it "responds to requests" do
|
19
|
-
@resource.define_request_handler(:get, Proc.new { return 'ok' })
|
20
|
-
response = Hyperdrive::Response.new({ 'REQUEST_METHOD' => 'GET' }, @resource)
|
21
|
-
response.response.must_equal 'ok'
|
22
|
-
end
|
23
|
-
end
|