repres-dosser 1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fb97dc4a3abaf0e284039001f0109caad69abad5
+  data.tar.gz: 424747fa8803fb1ca26f57556f5f3787bc2b269d
+SHA512:
+  metadata.gz: d8d4304c26fe93ca8c7df9346cbac2b0a78e78e57f18f6419cc62bb06ea3ddbd4bfaa654df0594f7bc615f19d6cd8aef80326ba77c8a2e939891af5893271169
+  data.tar.gz: 8d0fafe8985be64dbd52ec1f418ca26f30e05e2301455e64d2e08a6c142fe12c73330fc4e1963f0efdc091898c978b69c9f9e3f099532c819722fa0da1a728f1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2016 Topbit Du
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,30 @@
+# Repres Dosser 领域特定语意表现引擎
+
+[![License](https://img.shields.io/badge/license-MIT-green.svg)](http://opensource.org/licenses/MIT)
+[![Gem Version](https://badge.fury.io/rb/repres-dosser.svg)](https://badge.fury.io/rb/repres-dosser)
+
+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 (领域特定语意表现) 资源表现引擎包括JSON和XML表现模版。
+
+## Why Use Repres Dosser
+Dosser pre-defined some glossaries for RESTful Web API, which follows the Template Method design pattern.
+Dosser 预定义了一些适用于 RESTful Web API 的词汇，并且采用了“模版方法”设计模式。
+
+## Recent Update
+Check out the [Road Map](ROADMAP.md) to find out what's the next.
+Check out the [Change Log](CHANGELOG.md) to find out what's new.
+
+## Usage in Gemfile
+```ruby
+gem 'repres-dosser'
+```
+
+## Include the Concern in Controllers & Respond the Calls
+```ruby
+include Repres::Dosser::Concerns::ResourcePresentation
+
+def index
+  self.criteria = { page: params[:page] }
+  render_ok [ { name: 'Topbit' }, { name: 'Roland' } ]
+end
+```

data/Rakefile

@@ -0,0 +1,24 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Repres Dosser'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+load 'rails/tasks/statistics.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+

data/app/assets/javascripts/repres/dosser/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/app/assets/stylesheets/repres/dosser/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/controllers/repres/dosser/application_controller.rb

@@ -0,0 +1,2 @@
+class Repres::Dosser::ApplicationController < ActionController::Base
+end

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

@@ -0,0 +1,132 @@
+module Repres::Dosser::Concerns::ResourcePresentation
+
+  extend ActiveSupport::Concern
+
+  CODE_SUCCESS = 'success'.freeze
+  CODE_FAILURE = 'failure'.freeze
+
+  CODE_FAILURE_NOT_FOUND       = 'failure-not-found'.freeze
+  CODE_FAILURE_WRONG_PARAMETER = 'failure-wrong-parameter'.freeze
+  CODE_FAILURE_WRONG_STATE     = 'failure-wrong-state'.freeze
+
+  self.included do |includer|
+
+    attr_writer :criteria
+
+    # 200
+    def render_ok(collection, size = collection.size, message = nil)
+      result = {
+        success:    true,
+        code:       self.class::CODE_SUCCESS,
+        message:    message||'成功。',
+        collection: collection,
+        size:       size,
+        errors:     {}
+      }
+      respond_result :ok, result
+    end
+
+    # 201
+    def render_created(collection, size = collection.size, message = nil)
+      result = {
+        success:    true,
+        code:       self.class::CODE_SUCCESS,
+        message:    message||'创建成功。',
+        collection: collection,
+        size:       size,
+        errors:     {}
+      }
+      respond_result :created, result
+    end
+
+    # 400
+    def render_bad_request(errors, code = nil, message = nil, collection = [], size = 0)
+      result = {
+        success:    false,
+        code:       code||self.class::CODE_FAILURE_WRONG_PARAMETER,
+        message:    message||'参数出错。',
+        collection: collection,
+        size:       size,
+        errors:     errors
+      }
+      respond_result :bad_request, result
+    end
+
+    # 400 bad request - blank parameter
+    def render_blank_parameter(parameter_name)
+      result = {
+        success:    false,
+        code:       self.class::CODE_FAILURE_WRONG_PARAMETER,
+        message:    "#{parameter_name}参数不能为空。",
+        collection: [],
+        size:       0,
+        errors:     { parameter_name => [ '不能为空' ] }
+      }
+      respond_result :bad_request, result
+    end
+
+    # 404
+    def render_not_found(errors, message = nil, collection = [], size = 0)
+      result = {
+        success:    false,
+        code:       self.class::CODE_FAILURE_NOT_FOUND,
+        message:    message||'没有找到符合条件的信息。',
+        collection: collection,
+        size:       size,
+        errors:     errors
+      }
+      respond_result :not_found, result
+    end
+
+    # 404 not found - inexistent
+    def render_inexistent(parameter_name, message)
+      result = {
+        success:    false,
+        code:       self.class::CODE_FAILURE_NOT_FOUND,
+        message:    message,
+        collection: [],
+        size:       0,
+        errors:     { parameter_name => [ '不存在' ] }
+      }
+      respond_result :not_found, result
+    end
+
+    # 409
+    def render_conflict(errors, message, collection = [], size = 0)
+      result = {
+        success:    false,
+        code:       self.class::CODE_FAILURE_WRONG_STATE,
+        message:    message,
+        collection: collection,
+        size:       size,
+        errors:     errors
+      }
+      respond_result :conflict, result
+    end
+
+    # 409 conflict - wrong parameter
+    def render_wrong_parameter(errors, message, collection = [], size = 0)
+      result = {
+        success:    false,
+        code:       self.class::CODE_FAILURE_WRONG_PARAMETER,
+        message:    message,
+        collection: collection,
+        size:       size,
+        errors:     errors
+      }
+      respond_result :conflict, result
+    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
+      end
+    end
+
+    private :respond_result
+
+  end
+
+end

data/app/helpers/repres/dosser/application_helper.rb

@@ -0,0 +1,2 @@
+module Repres::Dosser::ApplicationHelper
+end

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

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dosser</title>
+  <%= stylesheet_link_tag    "dosser/application", media: "all" %>
+  <%= javascript_include_tag "dosser/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,2 @@
+Repres::Dosser::Engine.routes.draw do
+end

data/lib/repres/dosser.rb

@@ -0,0 +1,6 @@
+require 'repres/dosser/engine'
+
+module Repres
+  module Dosser
+  end
+end

data/lib/repres/dosser/engine.rb

@@ -0,0 +1,23 @@
+module Repres
+  module Dosser
+
+    class Engine < ::Rails::Engine
+
+      config.autoload_paths += %W(
+        #{config.root}/lib
+        #{config.root}/app/controllers/repres/dosser/concerns
+        #{config.root}/app/models/repres/dosser/concerns
+      )
+
+      config.eager_load_paths += %W(
+        #{config.root}/lib
+        #{config.root}/app/controllers/repres/dosser/concerns
+        #{config.root}/app/models/repres/dosser/concerns
+      )
+
+      isolate_namespace Repres::Dosser
+
+    end
+
+  end
+end

data/lib/repres/dosser/version.rb

@@ -0,0 +1,5 @@
+module Repres
+  module Dosser
+    VERSION = '1.0'.freeze
+  end
+end

data/lib/tasks/dosser_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :dosser do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: repres-dosser
+version: !ruby/object:Gem::Version
+  version: '1.0'
+platform: ruby
+authors:
+- Topbit Du
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-04-04 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'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+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
+  (领域特定语意表现) 资源表现引擎包括JSON和XML表现模版。
+email:
+- topbit.du@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/javascripts/repres/dosser/application.js
+- app/assets/stylesheets/repres/dosser/application.css
+- app/controllers/repres/dosser/application_controller.rb
+- app/controllers/repres/dosser/concerns/resource_presentation.rb
+- app/helpers/repres/dosser/application_helper.rb
+- app/views/layouts/repres/dosser/application.html.erb
+- config/routes.rb
+- lib/repres/dosser.rb
+- lib/repres/dosser/engine.rb
+- lib/repres/dosser/version.rb
+- lib/tasks/dosser_tasks.rake
+homepage: https://github.com/topbitdu/repres-dosser
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: Dosser Resource Presentation Engine 领域特定语意表现资源表现引擎
+test_files: []