apipie-bindings 0.2.0 → 0.2.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/doc/release_notes.md +5 -0
- data/lib/apipie_bindings/action.rb +1 -1
- data/lib/apipie_bindings/api.rb +3 -0
- data/lib/apipie_bindings/version.rb +1 -1
- data/test/dummy/app/controllers/comments_controller.rb +12 -0
- data/test/dummy/config/routes.rb +2 -0
- data/test/unit/action_test.rb +18 -4
- data/test/unit/data/dummy.json +1 -1
- metadata +7 -7
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA1:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 22699882d9cdf4fda651003accd5214a7a86aa00
|
|
4
|
+
data.tar.gz: 975d9242e56f0199a8e0c8c436b9eb6e7b111028
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: e763a0800451813b2d6cbdb58e9b1b1dde52b7c99b6d93d7c541d41c0df40367b60b6776ae316bb4b0376b71eb16d31b03a1e9a8d8eb0b8b757993691c3a9034
|
|
7
|
+
data.tar.gz: 1e21f5d9696cbaaa432f0b570a550c0a7880bb271b25266c404f8270a5488c7a03e603b72d6b597fdf28fab41fa0a648878b1c5d8dd46933eb1c7876a6fd1552
|
data/doc/release_notes.md
CHANGED
|
@@ -1,6 +1,11 @@
|
|
|
1
1
|
Release notes
|
|
2
2
|
=============
|
|
3
3
|
|
|
4
|
+
### 0.2.1 (2018-01-06)
|
|
5
|
+
* Do not allow NIL as a route parameter ([PR #70](https://github.com/Apipie/apipie-bindings/pull/70)) ([#22009](http://projects.theforeman.org/issues/22009))
|
|
6
|
+
* update cache on error responses ([PR #67](https://github.com/Apipie/apipie-bindings/pull/67))
|
|
7
|
+
* pin oauth to support ruby < 2.0.0 ([PR #69](https://github.com/Apipie/apipie-bindings/pull/69))
|
|
8
|
+
|
|
4
9
|
### 0.2.0 (2017-04-24)
|
|
5
10
|
* Support for overriding exceptions from authorizers ([PR #64](https://github.com/Apipie/apipie-bindings/pull/64))
|
|
6
11
|
* Use ssl_ca_file with ssl_ca_path (rest-client < 1.7.0) ([PR #63](https://github.com/Apipie/apipie-bindings/pull/63)) ([#62](https://github.com/Apipie/apipie-bindings/issues/62))
|
|
@@ -48,7 +48,7 @@ module ApipieBindings
|
|
|
48
48
|
sorted_routes = routes.sort_by { |r| [-1 * r.params_in_path.count, r.path] }
|
|
49
49
|
|
|
50
50
|
suitable_route = sorted_routes.find do |route|
|
|
51
|
-
route.params_in_path.all? { |path_param| params.
|
|
51
|
+
route.params_in_path.all? { |path_param| !params[path_param.to_sym].nil? || !params[path_param].nil? }
|
|
52
52
|
end
|
|
53
53
|
|
|
54
54
|
suitable_route ||= sorted_routes.last
|
data/lib/apipie_bindings/api.rb
CHANGED
|
@@ -242,6 +242,9 @@ module ApipieBindings
|
|
|
242
242
|
rescue => e
|
|
243
243
|
log.error e.message
|
|
244
244
|
log.debug inspect_data(e)
|
|
245
|
+
if e.respond_to?(:response) && e.response.respond_to?(:headers)
|
|
246
|
+
update_cache(e.response.headers[:apipie_checksum])
|
|
247
|
+
end
|
|
245
248
|
override_e = @authenticator.error(e) if authenticate && @authenticator
|
|
246
249
|
raise override_e.is_a?(StandardError) ? override_e : e
|
|
247
250
|
end
|
|
@@ -1,6 +1,18 @@
|
|
|
1
1
|
class CommentsController < ApplicationController
|
|
2
2
|
include Concerns::DummyConcern
|
|
3
3
|
|
|
4
|
+
api!
|
|
5
|
+
api :GET, "archive/comments/:id/"
|
|
6
|
+
api :GET, "archive/users/:user_id/comments/:id/"
|
|
7
|
+
param :id, Integer, :required => true
|
|
8
|
+
param :user_id, Integer
|
|
9
|
+
param :post_id, Integer
|
|
10
|
+
def archive
|
|
11
|
+
params[:user_id] ||= 1
|
|
12
|
+
params[:post_id] ||= 1
|
|
13
|
+
render :json => Dummy::Store.show(base_path)
|
|
14
|
+
end
|
|
15
|
+
|
|
4
16
|
protected
|
|
5
17
|
|
|
6
18
|
def base_path
|
data/test/dummy/config/routes.rb
CHANGED
data/test/unit/action_test.rb
CHANGED
|
@@ -2,8 +2,9 @@ require File.join(File.dirname(__FILE__), 'test_helper')
|
|
|
2
2
|
|
|
3
3
|
describe ApipieBindings::Action do
|
|
4
4
|
|
|
5
|
-
let(:
|
|
6
|
-
:apidoc_cache_name => 'dummy'})
|
|
5
|
+
let(:dummy_api) { ApipieBindings::API.new({:apidoc_cache_dir => 'test/unit/data',
|
|
6
|
+
:apidoc_cache_name => 'dummy'}) }
|
|
7
|
+
let(:resource) { dummy_api.resource(:users)}
|
|
7
8
|
|
|
8
9
|
it "should allow user to call the action" do
|
|
9
10
|
params = { :a => 1 }
|
|
@@ -16,8 +17,21 @@ describe ApipieBindings::Action do
|
|
|
16
17
|
resource.action(:index).routes.first.must_be_kind_of ApipieBindings::Route
|
|
17
18
|
end
|
|
18
19
|
|
|
19
|
-
|
|
20
|
-
resource.action(:
|
|
20
|
+
describe "#find_route" do
|
|
21
|
+
let(:archive_action) { dummy_api.resource(:comments).action(:archive) }
|
|
22
|
+
|
|
23
|
+
it "should find suitable route" do
|
|
24
|
+
resource.action(:index).find_route.path.must_equal "/users"
|
|
25
|
+
end
|
|
26
|
+
|
|
27
|
+
it "should find longest matching route" do
|
|
28
|
+
archive_action.find_route(:id => 1, :user_id => 1).path.must_equal "/archive/users/:user_id/comments/:id"
|
|
29
|
+
end
|
|
30
|
+
|
|
31
|
+
it "should find longest matching route ignoring nil params in the path" do
|
|
32
|
+
archive_action.find_route(:id => 1, :user_id => nil).path.must_equal "/archive/comments/:id"
|
|
33
|
+
end
|
|
34
|
+
|
|
21
35
|
end
|
|
22
36
|
|
|
23
37
|
it "should return params" do
|
data/test/unit/data/dummy.json
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"docs":{"name":"Dummy","info":"
|
|
1
|
+
{"docs":{"name":"Dummy","info":"\n\u003cp\u003eAnother API description\u003c/p\u003e\n","copyright":null,"doc_url":"./apipie/1.0","api_url":"/","resources":{"posts":{"doc_url":"./apipie/1.0/posts","api_url":"/","name":"Posts","short_description":null,"full_description":null,"version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"./apipie/1.0/posts/index","name":"index","apis":[{"api_url":"/users/:user_id/posts","http_method":"GET","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"./apipie/1.0/posts/show","name":"show","apis":[{"api_url":"/users/:user_id/posts/:id","http_method":"GET","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"./apipie/1.0/posts/create","name":"create","apis":[{"api_url":"/users/:user_id/posts","http_method":"POST","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"./apipie/1.0/posts/update","name":"update","apis":[{"api_url":"/users/:user_id/posts/:id","http_method":"PATCH","short_description":null,"deprecated":null},{"api_url":"/users/:user_id/posts/:id","http_method":"PUT","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"./apipie/1.0/posts/destroy","name":"destroy","apis":[{"api_url":"/users/:user_id/posts/:id","http_method":"DELETE","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"users":{"doc_url":"./apipie/1.0/users","api_url":"/","name":"Users","short_description":null,"full_description":null,"version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"./apipie/1.0/users/index","name":"index","apis":[{"api_url":"/users","http_method":"GET","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"examples":["GET /users\n200\n[ {\"user\":{\"name\":\"John Doe\" }} ]\n"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"./apipie/1.0/users/show","name":"show","apis":[{"api_url":"/users/:id","http_method":"GET","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"./apipie/1.0/users/create","name":"create","apis":[{"api_url":"/users","http_method":"POST","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"user","full_name":"user","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"user[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"vip","full_name":"user[vip]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"address","full_name":"user[address]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"city","full_name":"user[address][city]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"street","full_name":"user[address][street]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]},{"name":"contacts","full_name":"user[contacts]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"contact","full_name":"user[contacts][contact]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"kind","full_name":"user[contacts][kind]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"./apipie/1.0/users/update","name":"update","apis":[{"api_url":"/users/:id","http_method":"PATCH","short_description":null,"deprecated":null},{"api_url":"/users/:id","http_method":"PUT","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"./apipie/1.0/users/destroy","name":"destroy","apis":[{"api_url":"/users/:id","http_method":"DELETE","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"./apipie/1.0/users/create_unnested","name":"create_unnested","apis":[{"api_url":"/users/create_unnested","http_method":"POST","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"comments":{"doc_url":"./apipie/1.0/comments","api_url":"/","name":"Comments","short_description":null,"full_description":null,"version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"./apipie/1.0/comments/index","name":"index","apis":[{"api_url":"/users/:user_id/posts/:post_id/comments","http_method":"GET","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"./apipie/1.0/comments/show","name":"show","apis":[{"api_url":"/users/:user_id/posts/:post_id/comments/:id","http_method":"GET","short_description":null,"deprecated":null},{"api_url":"/archive/users/:user_id/comment/:id","http_method":"GET","short_description":null,"deprecated":null},{"api_url":"/archive/comment/:id","http_method":"GET","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"./apipie/1.0/comments/create","name":"create","apis":[{"api_url":"/users/:user_id/posts/:post_id/comments","http_method":"POST","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"./apipie/1.0/comments/update","name":"update","apis":[{"api_url":"/users/:user_id/posts/:post_id/comments/:id","http_method":"PATCH","short_description":null,"deprecated":null},{"api_url":"/users/:user_id/posts/:post_id/comments/:id","http_method":"PUT","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"./apipie/1.0/comments/destroy","name":"destroy","apis":[{"api_url":"/users/:user_id/posts/:post_id/comments/:id","http_method":"DELETE","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"./apipie/1.0/comments/archive","name":"archive","apis":[{"api_url":"/archive/comments/:id","http_method":"GET","short_description":null,"deprecated":null},{"api_url":"/archive/users/:user_id/comments/:id","http_method":"GET","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"user_id","full_name":"user_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"post_id","full_name":"post_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null}},"link_extension":".html"}}
|
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: apipie-bindings
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.2.
|
|
4
|
+
version: 0.2.1
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Martin Bačovský
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date:
|
|
11
|
+
date: 2018-01-06 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: json
|
|
@@ -48,16 +48,16 @@ dependencies:
|
|
|
48
48
|
name: oauth
|
|
49
49
|
requirement: !ruby/object:Gem::Requirement
|
|
50
50
|
requirements:
|
|
51
|
-
- - "
|
|
51
|
+
- - "<"
|
|
52
52
|
- !ruby/object:Gem::Version
|
|
53
|
-
version:
|
|
53
|
+
version: 0.5.2
|
|
54
54
|
type: :runtime
|
|
55
55
|
prerelease: false
|
|
56
56
|
version_requirements: !ruby/object:Gem::Requirement
|
|
57
57
|
requirements:
|
|
58
|
-
- - "
|
|
58
|
+
- - "<"
|
|
59
59
|
- !ruby/object:Gem::Version
|
|
60
|
-
version:
|
|
60
|
+
version: 0.5.2
|
|
61
61
|
- !ruby/object:Gem::Dependency
|
|
62
62
|
name: rake
|
|
63
63
|
requirement: !ruby/object:Gem::Requirement
|
|
@@ -256,7 +256,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
|
256
256
|
version: '0'
|
|
257
257
|
requirements: []
|
|
258
258
|
rubyforge_project:
|
|
259
|
-
rubygems_version: 2.
|
|
259
|
+
rubygems_version: 2.6.14
|
|
260
260
|
signing_key:
|
|
261
261
|
specification_version: 4
|
|
262
262
|
summary: The Ruby bindings for Apipie documented APIs
|