repres-dosser 1.9 → 2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 6225ace816757924b0affa10b971289536da5842
-  data.tar.gz: 936f844a42e192bec54e3b55bf1d7864052ca664
+SHA256:
+  metadata.gz: 38dd3e21bae4516608b6615d6450f603b31a176d2e79930a71928a04d70262bb
+  data.tar.gz: 1b88c040c9289b231cb89782f1ff2dfdc76b768e5ac6d4fa00d21713c97d50da
 SHA512:
-  metadata.gz: 0fa35156c795e372b4d71a3858413f7d954c7631264bf686e0c895ace7b83c2dd7cc28ee1bf4481e82cc69d98d953f039abbb60895b6027aa446393a9c267bd2
-  data.tar.gz: 529ff9d1c7ed8c6cfa40d2e9f1a5e56ad4b474ca605448f88f9f988eb5b3e5b7b73c38f959405d2d61b38b2cdbc6ff80f725ad207f5c7cdcf7fd8f7da5c6f45e
+  metadata.gz: 7fb70cddbb1f1f53aefee5a0a5d8b0149dee901e6f7ac9a3ad8b7f5c77c981eda4883694b8595dcafd981ab1d9955307856d675d0ec3d90077b3dd09592a887d
+  data.tar.gz: fc56d86c9757fefd47af674fae896216a309de406a86642a3fe5cb39c4e0f032d5be17e01186b302e4df68891d4e8cf5cab638de12f76782a22567c269d39264

data/app/controllers/repres/dosser/concerns/resource_presentation.rb

@@ -22,7 +22,7 @@ module Repres::Dosser::Concerns::ResourcePresentation
     attr_writer :criteria
 
     ##
-    # 返回 HTTP 状态码 200 ok 。
+    # 返回 HTTP 状态码 200 OK 。
     def render_ok(
       success:    true,
       code:       self.class::CODE_SUCCESS,
@@ -40,7 +40,7 @@ module Repres::Dosser::Concerns::ResourcePresentation
     end
 
     ##
-    # 返回 HTTP 状态码 201 。
+    # 返回 HTTP 状态码 201 Created 。
     def render_created(
       success:    true,
       code:       self.class::CODE_SUCCESS,
@@ -58,7 +58,7 @@ module Repres::Dosser::Concerns::ResourcePresentation
     end
 
     ##
-    # 返回 HTTP 状态码 202 。
+    # 返回 HTTP 状态码 202 Accepted 。
     def render_accepted(
       success:    true,
       code:       self.class::CODE_SUCCESS,
@@ -76,7 +76,7 @@ module Repres::Dosser::Concerns::ResourcePresentation
     end
 
     ##
-    # 返回 HTTP 状态码 204 。
+    # 返回 HTTP 状态码 204 No Content 。
     def render_no_content(
       success:    true,
       code:       self.class::CODE_SUCCESS,
@@ -94,7 +94,7 @@ module Repres::Dosser::Concerns::ResourcePresentation
     end
 
     ##
-    # 返回 HTTP 状态码 400 。
+    # 返回 HTTP 状态码 400 Bad Request 。
     def render_bad_request(
       success:    false,
       code:       self.class::CODE_FAILURE_WRONG_PARAMETER,
@@ -112,7 +112,7 @@ module Repres::Dosser::Concerns::ResourcePresentation
     end
 
     ##
-    # 返回 HTTP 状态码 401 。
+    # 返回 HTTP 状态码 401 Unauthorized 。
     def render_unauthorized(
       success:    false,
       code:       self.class::CODE_FAILURE,
@@ -130,7 +130,7 @@ module Repres::Dosser::Concerns::ResourcePresentation
     end
 
     ##
-    # 返回 HTTP 状态码 403 forbidden 。
+    # 返回 HTTP 状态码 403 Forbidden 。
     def render_forbidden(
       success:    false,
       code:       self.class::CODE_FAILURE_FORBIDDEN,
@@ -148,7 +148,7 @@ module Repres::Dosser::Concerns::ResourcePresentation
     end
 
     ##
-    # 返回 HTTP 状态码 404 。
+    # 返回 HTTP 状态码 404 Not Found 。
     def render_not_found(
       success:    false,
       code:       self.class::CODE_FAILURE_NOT_FOUND,
@@ -181,7 +181,7 @@ module Repres::Dosser::Concerns::ResourcePresentation
 =end
 
     ##
-    # 返回 HTTP 状态码 409 。
+    # 返回 HTTP 状态码 409 Conflict 。
     def render_conflict(
       success:    false,
       code:       self.class::CODE_FAILURE_WRONG_STATE,
@@ -199,7 +199,8 @@ module Repres::Dosser::Concerns::ResourcePresentation
     end
 
     ##
-    # 返回 HTTP 状态码 500 。
+    # 返回 HTTP 状态码 500 Internal Server Error 。如：
+    # render_internal_server_error
     def render_internal_server_error(
       success:    false,
       code:       self.class::CODE_FAILURE,
@@ -216,6 +217,11 @@ module Repres::Dosser::Concerns::ResourcePresentation
         errors:     errors
     end
 
+    ##
+    # 根据参数，计算分页结果。如：
+    # paginate total_items: 88, per_page: 10, current_page: 9
+    # 返回
+    # { total_items: 88, per_page: 10, current_page: 9, total_pages: 9, min_item_on_current_page: 80, max_item_on_current_page: 87, items_on_current_page: 8 }
     def paginate(total_items: 0, per_page: 0, current_page: 1)
       total_items  = total_items.to_i
       per_page     = per_page.to_i
@@ -235,6 +241,15 @@ module Repres::Dosser::Concerns::ResourcePresentation
 
     end
 
+    ##
+    # 按照给定的参数响应结果。此为内部方法。如：
+    # respond_result :ok,
+    #   success:    true,
+    #   code:       'success',
+    #   message:    '成功',
+    #   collection: [ { id: 'id-1', name: 'name-1' }, { id: 'id-2', name: 'name-2' } ],
+    #   size:       2,
+    #   errors:     {}
     def respond_result(status, result)
       result[:meta] = { criteria: @criteria, request_id: request.uuid, timestamp: Time.now.to_i }
       result[:meta][:pagination] = @pagination if @pagination.present?

data/app/views/layouts/repres/dosser/application.html.erb

@@ -2,7 +2,7 @@
 <html>
 <head>
   <title>Repres Dosser</title>
-  <%= stylesheet_link_tag 'repres/dosser/application', media: "all" %>
+  <%= stylesheet_link_tag 'repres/dosser/application', media: 'all' %>
   <%= csrf_meta_tags %>
 </head>
 <body>

data/lib/repres/dosser/version.rb

@@ -1,5 +1,5 @@
 module Repres
   module Dosser
-    VERSION = '1.9'.freeze
+    VERSION = '2.0'.freeze
   end
 end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: repres-dosser
 version: !ruby/object:Gem::Version
-  version: '1.9'
+  version: '2.0'
 platform: ruby
 authors:
 - Topbit Du
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-27 00:00:00.000000000 Z
+date: 2020-04-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '6.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '6.0'
 description: Repres (REsource PRESentation) is a series of resource presentation engines.
   The Dosser (DOmain-Specific SEmantic Representation) resource presentation engine
   includes JSON and XML resource presentation templates. Repres (资源表现)是一系列的资源表现引擎。Dosser
@@ -84,8 +84,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.4
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Dosser Resource Presentation Engine 领域特定语意表现资源表现引擎