unirer-dosser 0.1 → 0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5e17b4b841672f76a1372713c7b95aba7ea25e48
-  data.tar.gz: b95f4af6de1114be1d834548c0a4cbf871c59ab0
+  metadata.gz: 0e8eb9e76b69002399156854293e9423f99a5780
+  data.tar.gz: fd0f472839e91378445de58c34b163114cd41e1e
 SHA512:
-  metadata.gz: c0dc4043a64236df41bf4bf0ba9b46859c56b89f0547e852481754904b3465b4d354881c69586dd0d47dd510fe1918b35c743ae78a2f9011009ab65edb276ef0
-  data.tar.gz: 80ab42489319968c14a3e4b1ded0de6c16f1c0d6a688a2abcb179bf89c66f06a7904e6ef1c473b53dfa946166bc47bce67316c124ca9d54f5e20dae7423cae9e
+  metadata.gz: f7898ddb24bbdc92a6f7eca4df7c063a1609664d9e24e1c5e03a9690de011ec4b8a4a2979a403bd17aaad460728ec60e8f9cb1079069df93fbc2065319bc3bd7
+  data.tar.gz: 36ad88707d2f13e8fc6a767cafd34a2c35b1febb270960b5328edb4581d6805b980aa9969a7261e5cf4aae9a31c8106cb0fc3e00d98865a41df35bec48c55b7d

data/README.md

@@ -1,18 +1,25 @@
-= Dosser
+# Unirer Dosser
+
+[![License](https://img.shields.io/badge/license-MIT-green.svg)](http://opensource.org/licenses/MIT)
 
 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.
 Unirer (统一资源表现)是一系列的资源表现引擎。Dosser (领域特定语意表现) 资源表现引擎包括JSON和XML表现模版。
 
-## Usage in Gemfile:
+## Why Use Unirer Dosser
+Dosser pre-defined some glossaries for RESTful Web API, which follows the Template Method design pattern.
+Dosser 预定义了一些适用于 RESTful Web API 的词汇，并且采用了“模版方法”设计模式。
+
+## Usage in Gemfile
 ```ruby
 gem 'unirer-dosser'
 ```
 
-## Include the Concern in Controllers & Respond the Calls:
+## Include the Concern in Controllers & Respond the Calls
 ```ruby
 include Unirer::Dosser::Concerns::ResourceRepresentation
 
 def index
+  criteria = { page: params[:page] }
   render_ok [ { name: 'Topbit' }, { name: 'Roland' } ]
 end
 ```

data/app/controllers/unirer/dosser/concerns/resource_representation.rb

@@ -11,12 +11,11 @@ module Unirer::Dosser::Concerns::ResourceRepresentation
 
   self.included do |includer|
 
-    attr_accessor :meta
+    attr_writer :criteria
 
     # 200
     def render_ok(collection, size = collection.size, message = nil)
       result = {
-        meta:       meta,
         success:    true,
         code:       self.class::CODE_SUCCESS,
         message:    message||'成功。',
@@ -30,7 +29,6 @@ module Unirer::Dosser::Concerns::ResourceRepresentation
     # 201
     def render_created(collection, size = collection.size, message = nil)
       result = {
-        meta:       meta,
         success:    true,
         code:       self.class::CODE_SUCCESS,
         message:    message||'创建成功。',
@@ -44,7 +42,6 @@ module Unirer::Dosser::Concerns::ResourceRepresentation
     # 400
     def render_bad_request(errors, code = nil, message = nil, collection = [], size = 0)
       result = {
-        meta:       meta,
         success:    false,
         code:       code||self.class::CODE_FAILURE_WRONG_PARAMETER,
         message:    message||'参数出错。',
@@ -58,7 +55,6 @@ module Unirer::Dosser::Concerns::ResourceRepresentation
     # 400 bad request - blank parameter
     def render_blank_parameter(parameter_name)
       result = {
-        meta:       meta,
         success:    false,
         code:       self.class::CODE_FAILURE_WRONG_PARAMETER,
         message:    "#{parameter_name}参数不能为空。",
@@ -72,7 +68,6 @@ module Unirer::Dosser::Concerns::ResourceRepresentation
     # 404
     def render_not_found(errors, message = nil, collection = [], size = 0)
       result = {
-        meta:       meta,
         success:    false,
         code:       self.class::CODE_FAILURE_NOT_FOUND,
         message:    message||'没有找到符合条件的信息。',
@@ -86,7 +81,6 @@ module Unirer::Dosser::Concerns::ResourceRepresentation
     # 404 not found - inexistent
     def render_inexistent(parameter_name, message)
       result = {
-        meta:       meta,
         success:    false,
         code:       self.class::CODE_FAILURE_NOT_FOUND,
         message:    message,
@@ -100,7 +94,6 @@ module Unirer::Dosser::Concerns::ResourceRepresentation
     # 409
     def render_conflict(errors, message, collection = [], size = 0)
       result = {
-        meta:       meta,
         success:    false,
         code:       self.class::CODE_FAILURE_WRONG_STATE,
         message:    message,
@@ -114,7 +107,6 @@ module Unirer::Dosser::Concerns::ResourceRepresentation
     # 409 conflict - wrong parameter
     def render_wrong_parameter(errors, message, collection = [], size = 0)
       result = {
-        meta:       meta,
         success:    false,
         code:       self.class::CODE_FAILURE_WRONG_PARAMETER,
         message:    message,
@@ -126,6 +118,7 @@ module Unirer::Dosser::Concerns::ResourceRepresentation
     end
 
     def respond_result(status, result)
+      result[:meta] = { request_id: request.uuid, criteria: @criteria }
       respond_to do |format|
         format.json do render status: status, json: result end
         format.xml  do render status: status, xml:  result end

data/lib/unirer/dosser/version.rb

@@ -1,5 +1,5 @@
 module Unirer
   module Dosser
-    VERSION = '0.1'
+    VERSION = '0.2'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: unirer-dosser
 version: !ruby/object:Gem::Version
-  version: '0.1'
+  version: '0.2'
 platform: ruby
 authors:
 - Topbit Du
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-22 00:00:00.000000000 Z
+date: 2016-01-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails