unirer-dosser 0.1 → 0.2
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +10 -3
- data/app/controllers/unirer/dosser/concerns/resource_representation.rb +2 -9
- data/lib/unirer/dosser/version.rb +1 -1
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 0e8eb9e76b69002399156854293e9423f99a5780
|
4
|
+
data.tar.gz: fd0f472839e91378445de58c34b163114cd41e1e
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: f7898ddb24bbdc92a6f7eca4df7c063a1609664d9e24e1c5e03a9690de011ec4b8a4a2979a403bd17aaad460728ec60e8f9cb1079069df93fbc2065319bc3bd7
|
7
|
+
data.tar.gz: 36ad88707d2f13e8fc6a767cafd34a2c35b1febb270960b5328edb4581d6805b980aa9969a7261e5cf4aae9a31c8106cb0fc3e00d98865a41df35bec48c55b7d
|
data/README.md
CHANGED
@@ -1,18 +1,25 @@
|
|
1
|
-
|
1
|
+
# Unirer Dosser
|
2
|
+
|
3
|
+
[![License](https://img.shields.io/badge/license-MIT-green.svg)](http://opensource.org/licenses/MIT)
|
2
4
|
|
3
5
|
Unirer (UNIfied REsource Representation) is a series of resource representation engines. The Dosser (DOmain-Specific SEmantic Representation) resource representation engine includes JSON and XML resource representation templates.
|
4
6
|
Unirer (统一资源表现)是一系列的资源表现引擎。Dosser (领域特定语意表现) 资源表现引擎包括JSON和XML表现模版。
|
5
7
|
|
6
|
-
##
|
8
|
+
## Why Use Unirer Dosser
|
9
|
+
Dosser pre-defined some glossaries for RESTful Web API, which follows the Template Method design pattern.
|
10
|
+
Dosser 预定义了一些适用于 RESTful Web API 的词汇,并且采用了“模版方法”设计模式。
|
11
|
+
|
12
|
+
## Usage in Gemfile
|
7
13
|
```ruby
|
8
14
|
gem 'unirer-dosser'
|
9
15
|
```
|
10
16
|
|
11
|
-
## Include the Concern in Controllers & Respond the Calls
|
17
|
+
## Include the Concern in Controllers & Respond the Calls
|
12
18
|
```ruby
|
13
19
|
include Unirer::Dosser::Concerns::ResourceRepresentation
|
14
20
|
|
15
21
|
def index
|
22
|
+
criteria = { page: params[:page] }
|
16
23
|
render_ok [ { name: 'Topbit' }, { name: 'Roland' } ]
|
17
24
|
end
|
18
25
|
```
|
@@ -11,12 +11,11 @@ module Unirer::Dosser::Concerns::ResourceRepresentation
|
|
11
11
|
|
12
12
|
self.included do |includer|
|
13
13
|
|
14
|
-
|
14
|
+
attr_writer :criteria
|
15
15
|
|
16
16
|
# 200
|
17
17
|
def render_ok(collection, size = collection.size, message = nil)
|
18
18
|
result = {
|
19
|
-
meta: meta,
|
20
19
|
success: true,
|
21
20
|
code: self.class::CODE_SUCCESS,
|
22
21
|
message: message||'成功。',
|
@@ -30,7 +29,6 @@ module Unirer::Dosser::Concerns::ResourceRepresentation
|
|
30
29
|
# 201
|
31
30
|
def render_created(collection, size = collection.size, message = nil)
|
32
31
|
result = {
|
33
|
-
meta: meta,
|
34
32
|
success: true,
|
35
33
|
code: self.class::CODE_SUCCESS,
|
36
34
|
message: message||'创建成功。',
|
@@ -44,7 +42,6 @@ module Unirer::Dosser::Concerns::ResourceRepresentation
|
|
44
42
|
# 400
|
45
43
|
def render_bad_request(errors, code = nil, message = nil, collection = [], size = 0)
|
46
44
|
result = {
|
47
|
-
meta: meta,
|
48
45
|
success: false,
|
49
46
|
code: code||self.class::CODE_FAILURE_WRONG_PARAMETER,
|
50
47
|
message: message||'参数出错。',
|
@@ -58,7 +55,6 @@ module Unirer::Dosser::Concerns::ResourceRepresentation
|
|
58
55
|
# 400 bad request - blank parameter
|
59
56
|
def render_blank_parameter(parameter_name)
|
60
57
|
result = {
|
61
|
-
meta: meta,
|
62
58
|
success: false,
|
63
59
|
code: self.class::CODE_FAILURE_WRONG_PARAMETER,
|
64
60
|
message: "#{parameter_name}参数不能为空。",
|
@@ -72,7 +68,6 @@ module Unirer::Dosser::Concerns::ResourceRepresentation
|
|
72
68
|
# 404
|
73
69
|
def render_not_found(errors, message = nil, collection = [], size = 0)
|
74
70
|
result = {
|
75
|
-
meta: meta,
|
76
71
|
success: false,
|
77
72
|
code: self.class::CODE_FAILURE_NOT_FOUND,
|
78
73
|
message: message||'没有找到符合条件的信息。',
|
@@ -86,7 +81,6 @@ module Unirer::Dosser::Concerns::ResourceRepresentation
|
|
86
81
|
# 404 not found - inexistent
|
87
82
|
def render_inexistent(parameter_name, message)
|
88
83
|
result = {
|
89
|
-
meta: meta,
|
90
84
|
success: false,
|
91
85
|
code: self.class::CODE_FAILURE_NOT_FOUND,
|
92
86
|
message: message,
|
@@ -100,7 +94,6 @@ module Unirer::Dosser::Concerns::ResourceRepresentation
|
|
100
94
|
# 409
|
101
95
|
def render_conflict(errors, message, collection = [], size = 0)
|
102
96
|
result = {
|
103
|
-
meta: meta,
|
104
97
|
success: false,
|
105
98
|
code: self.class::CODE_FAILURE_WRONG_STATE,
|
106
99
|
message: message,
|
@@ -114,7 +107,6 @@ module Unirer::Dosser::Concerns::ResourceRepresentation
|
|
114
107
|
# 409 conflict - wrong parameter
|
115
108
|
def render_wrong_parameter(errors, message, collection = [], size = 0)
|
116
109
|
result = {
|
117
|
-
meta: meta,
|
118
110
|
success: false,
|
119
111
|
code: self.class::CODE_FAILURE_WRONG_PARAMETER,
|
120
112
|
message: message,
|
@@ -126,6 +118,7 @@ module Unirer::Dosser::Concerns::ResourceRepresentation
|
|
126
118
|
end
|
127
119
|
|
128
120
|
def respond_result(status, result)
|
121
|
+
result[:meta] = { request_id: request.uuid, criteria: @criteria }
|
129
122
|
respond_to do |format|
|
130
123
|
format.json do render status: status, json: result end
|
131
124
|
format.xml do render status: status, xml: result end
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: unirer-dosser
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: '0.
|
4
|
+
version: '0.2'
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Topbit Du
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2016-01-
|
11
|
+
date: 2016-01-28 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: rails
|