repres-dosser 1.5 → 1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 232b89400fa5b292d47c11b04180d4189793a9f8
-  data.tar.gz: cd9291a3e4fb5d31850ef40896c11ea30676e6aa
+  metadata.gz: e0b1d905f477b752c5cfcc27c1c0e88963cd14bd
+  data.tar.gz: fd1a3124526d4bb596371169e335acef5c07af33
 SHA512:
-  metadata.gz: 3f04925a73b936ff5099bb3fe8c2fe046e64158dd408fc43461fa672ca1fa5958da6531672c260dede3c6793e312d28b6e104217fe7b356e60541868cc95288c
-  data.tar.gz: 5e162d288aa1ac41e221d26cea101ee1d4844173f2b86f1b29a04a39509e32a52e083198f7c797f81404df2c31eb7cff57d8da9211424aaf5d98a995bd0e59af
+  metadata.gz: d500648a0b6e31a235ecf2f6901b4ed1f3382e1cc79a40bff325628b2e833f2ec2fe1aa3b14333c28c368674944aa42c6f6e186e28b96e7e3d0c4c023860a6f8
+  data.tar.gz: 9b743cd575964bfda3c6859777abb126f3e9d874505167887223477b586bfc583a7c884e724219f7f8e7a934733ff45f33fd61a60120d3ab023b2ab0156bfd17

data/README.md

@@ -62,3 +62,46 @@ onIndexResourceSuccess: function(data, textStatus, jqXHR)
   console.info('The item index is from '+pagination.min_item_on_current_page+' to '+pagination.max_item_on_current_page+' on the current page.');
 }
 ```
+
+
+
+## Generators
+
+
+
+### Platform generator
+
+```shell
+rails generate repres:dosser:platform administration --version 2
+```
+
+This will insert the following routings into the config/routes.rb file:
+```ruby
+scope '/administration-api/v2', module: 'administration/dosser/v2', as: 'administration_dosser_v2' do
+  resources :portals, only: :show
+end
+```
+
+and create the following files:
+```shell
+app/controllers/administration/dosser/v2/presentation_controller.rb
+app/controllers/administration/dosser/v2/portals_controller.rb
+```
+
+
+
+### Swagger generator
+
+```shell
+rails generate repres:dosser:swagger administration --version 2
+```
+
+This will call the following command:
+```shell
+rails generate repres:dosser:platform administration --version 2
+```
+
+before insert the swagger_engine & the latest repres-dosser gem into the Gemfile file and will create the following file:
+```shell
+lib/swagger/administration_api_v2.json
+```

data/lib/generators/repres/dosser/platform/USAGE

@@ -0,0 +1,18 @@
+Description:
+
+    Generates the Dosser platform scaffold.
+
+Example:
+
+    rails generate repres:dosser:platform administration --version 2
+
+    This will insert the following routings into the config/routes.rb file:
+
+        scope '/administration-api/v2', module: 'administration/dosser/v2', as: 'administration_dosser_v2' do
+          resources :portals, only: :show
+        end
+
+    and create the following files:
+
+        app/controllers/administration/dosser/v2/presentation_controller.rb
+        app/controllers/administration/dosser/v2/portals_controller.rb

data/lib/generators/repres/dosser/platform/platform_generator.rb

@@ -0,0 +1,84 @@
+# rails generate repres:dosser:platform administration --version 2
+
+class Repres::Dosser::PlatformGenerator < Rails::Generators::NamedBase
+
+  # https://github.com/erikhuda/thor/blob/master/lib/thor/base.rb#L273
+  class_option :version, type: :numeric, required: false, default: 1, desc: 'a positive integer, the default value is 1'
+
+  source_root File.expand_path('../templates', __FILE__)
+
+  def produce
+
+    @platform_name  = file_name.downcase
+    @version_number = options['version'].to_i
+
+    generate_controller
+    generate_route
+
+  end
+
+  def define_namespace(content)
+    content.gsub! /PlatformModuleName/, platform_module_name
+    content.gsub! /VersionModuleName/,  version_module_name
+    content.gsub! /platform_name/,      platform_name
+    content.gsub! /version_name/,       version_name
+    content.gsub! /version_number/,     version_number.to_s
+    content
+  end
+
+  # controller
+  #
+  #   app/controllers/platform/version/presentation_controller.rb
+  #   app/controllers/platform/version/portals_controller.rb
+  #
+  def generate_controller
+    copy_file('app/controllers/presentation_controller.rb', "app/controllers/#{platform_name}/dosser/#{version_name}/presentation_controller.rb") { |content| define_namespace content }
+    copy_file('app/controllers/portals_controller.rb',      "app/controllers/#{platform_name}/dosser/#{version_name}/portals_controller.rb"     ) { |content| define_namespace content }
+  end
+
+  # route
+  #
+  #   config/routes.rb
+  #
+  def generate_route
+    source = File.expand_path find_in_source_paths('config/routes.rb')
+    File.open(source, 'rb') { |f| route define_namespace(f.read.to_s.strip) }
+  end
+
+  # Administration
+  def platform_module_name
+    #@platform_name.capitalize
+    @platform_name.camelize
+  end
+
+  # administration
+  def platform_name
+    @platform_name
+  end
+
+  # Administration::V1
+  def platform_version_module_name
+    "#{platform_module_name}::Dosser::#{version_module_name}"
+  end
+
+  # V1
+  def version_module_name
+    "V#{version_number}"
+  end
+
+  # v1
+  def version_name
+    "v#{version_number}"
+  end
+
+  # 1
+  def version_number
+    @version_number
+  end
+
+  private :define_namespace,
+    :generate_controller,  :generate_route,
+    :platform_module_name, :platform_name,  :platform_version_module_name,
+    :version_module_name,  :version_name,   :version_number
+
+end

data/lib/generators/repres/dosser/platform/templates/app/controllers/portals_controller.rb

@@ -0,0 +1,16 @@
+class PlatformModuleName::Dosser::VersionModuleName::PortalsController < PlatformModuleName::Dosser::VersionModuleName::PresentationController
+
+  def show
+    render_ok collection: [
+      {
+        name: 'PlatformModuleName API version_name',
+        links: [
+          { rel: 'self',      href: platform_name_dosser_version_name_portal_url(Unidom::Common::SELF, format: request.format.symbol) },
+          { rel: 'canonial',  href: platform_name_dosser_version_name_portal_url(Unidom::Common::SELF, format: :json                ) },
+          { rel: 'alternate', href: platform_name_dosser_version_name_portal_url(Unidom::Common::SELF, format: :xml                 ) }
+        ]
+      }
+    ]
+  end
+
+end

data/lib/generators/repres/dosser/platform/templates/app/controllers/presentation_controller.rb

@@ -0,0 +1,17 @@
+require 'unidom'
+
+class PlatformModuleName::Dosser::VersionModuleName::PresentationController < ActionController::Base
+
+  clear_helpers
+
+  include Repres::Dosser::Concerns::ResourcePresentation
+
+  layout nil
+
+  before_action :load_unidom
+
+  def load_unidom
+    initialize_unidom
+  end
+
+end

data/lib/generators/repres/dosser/platform/templates/config/routes.rb

@@ -0,0 +1,3 @@
+  scope '/platform_name-api/version_name', module: 'platform_name/dosser/version_name', as: 'platform_name_dosser_version_name' do
+    resources :portals, only: :show
+  end

data/lib/generators/repres/dosser/swagger/USAGE

@@ -0,0 +1,15 @@
+Description:
+
+    Generates the Dosser Swagger scaffold.
+
+Example:
+
+    rails generate repres:dosser:swagger administration --version 2
+
+    This will call the following command:
+
+        rails generate repres:dosser:platform administration --version 2
+
+    before insert the swagger_engine & the latest repres-dosser gem into the Gemfile file and will create the following file:
+
+        lib/swagger/administration_api_v2.json

data/lib/generators/repres/dosser/swagger/swagger_generator.rb

@@ -0,0 +1,84 @@
+# rails generate repres:dosser:swagger administration --version 2
+
+class Repres::Dosser::SwaggerGenerator < Rails::Generators::NamedBase
+
+  # https://github.com/erikhuda/thor/blob/master/lib/thor/base.rb#L273
+  class_option :version, type: :numeric, required: false, default: 1, desc: 'a positive integer, the default value is 1'
+
+  source_root File.expand_path('../templates', __FILE__)
+
+  def produce
+
+    @platform_name  = file_name.downcase
+    @version_number = options['version'].to_i
+
+    generate 'repres:dosser:platform', "#{@platform_name} --version #{@version_number}"
+
+    generate_gemfile
+    generate_swagger
+
+  end
+
+  def define_namespace(content)
+    content.gsub! /PlatformModuleName/, platform_module_name
+    content.gsub! /VersionModuleName/,  version_module_name
+    content.gsub! /platform_name/,      platform_name
+    content.gsub! /version_name/,       version_name
+    content.gsub! /version_number/,     version_number.to_s
+    content
+  end
+
+  # gemfile
+  #
+  #   Gemfile
+  #
+  def generate_gemfile
+    gem 'swagger_engine'
+    gem 'repres-dosser', ">= #{Repres::Dosser::VERSION}"
+  end
+
+  # swagger
+  #
+  #   lib/swagger/administration_api_v1.json
+  #
+  def generate_swagger
+    copy_file('lib/swagger/api.json', "lib/swagger/#{platform_name}_api_#{version_name}.json") { |content| define_namespace content }
+  end
+
+  # Administration
+  def platform_module_name
+    #@platform_name.capitalize
+    @platform_name.camelize
+  end
+
+  # administration
+  def platform_name
+    @platform_name
+  end
+
+  # Administration::V1
+  def platform_version_module_name
+    "#{platform_module_name}::Dosser::#{version_module_name}"
+  end
+
+  # V1
+  def version_module_name
+    "V#{version_number}"
+  end
+
+  # v1
+  def version_name
+    "v#{version_number}"
+  end
+
+  # 1
+  def version_number
+    @version_number
+  end
+
+  private :define_namespace,
+    :generate_gemfile,     :generate_swagger,
+    :platform_module_name, :platform_name,    :platform_version_module_name,
+    :version_module_name,  :version_name,     :version_number
+
+end

data/lib/generators/repres/dosser/swagger/templates/lib/swagger/api.json

@@ -0,0 +1,118 @@
+{
+  "swagger": "2.0",
+  "info": {
+    "title":       "PlatformModuleName Web API",
+    "description": "PlatformModuleName RESTful Web API version_name",
+    "contact":     { "name": "Your Name", "email": "user@company.com" },
+    "version":     "version_number"
+  },
+  "schemes":  [ "https", "http" ],
+  "basePath": "/platform_name-api/version_name",
+  "produces": [ "application/json" ],
+  "consumes": [ "application/json" ],
+  "paths":    {
+
+
+
+    "/portals/~": {
+      "get": {
+        "summary":     "Platform Portal",
+        "description": "The Mobile client or Browsers should access this Web API before get the links of the other resources.",
+        "tags":        [ "元数据" ],
+        "parameters":  [
+          {
+            "name":        "open_id",
+            "in":          "query",
+            "description": "Open ID of the current user",
+            "required":    false,
+            "type":        "string",
+            "format":      "uuid"
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "移动端应用获取其他Web API链接的返回。",
+            "schema":      { "$ref": "#/definitions/LoadPortalResponseBody" }
+          },
+          "default": {
+            "description": "出现错误。",
+            "schema":      { "$ref": "#/definitions/ErrorResponseBody" }
+          }
+        }
+      }
+    }
+
+
+
+  },
+
+  "definitions": {
+
+    "Date":   { "type": "string",  "format": "date"  },
+    "Second": { "type": "integer", "format": "int64" },
+
+    "LinkList": { "type":  "array", "items": { "type": "object", "properties": { "rel":  { "type": "string" }, "href": { "type": "string" }, "title": { "type": "string" } } } },
+
+    "ResponseBodyCommonProperties": {
+      "type": "object",
+      "properties": {
+
+        "success": { "type": "boolean"                    },
+        "code":    { "type": "string"                     },
+        "message": { "type": "string"                     },
+        "size":    { "type": "integer", "format": "int32" },
+        "errors":  { "type": "string",  "additionalProperties": { "type": "array", "items": { "type": "string" } } },
+
+        "meta": {
+          "type": "object",
+          "properties": {
+            "timestamp":  { "type": "integer", "format":               "int32"              },
+            "request_id": { "type": "string",  "format":               "uuid"               },
+            "criteria":   { "type": "object",  "additionalProperties": { "type": "string" } },
+            "pagination": { "type": "object",
+              "properties": {
+                "total_items":              { "type": "integer", "format": "int32" },
+                "per_page":                 { "type": "integer", "format": "int32" },
+                "current_page":             { "type": "integer", "format": "int32" },
+                "total_pages":              { "type": "integer", "format": "int32" },
+                "min_item_on_current_page": { "type": "integer", "format": "int32" },
+                "max_item_on_current_page": { "type": "integer", "format": "int32" },
+                "items_on_current_page":    { "type": "integer", "format": "int32" }
+              }
+            }
+          }
+        }
+
+      }
+    },
+
+    "ErrorResponseBody": {
+      "description": "出现错误时的响应体",
+      "allOf": [
+        { "$ref": "#/definitions/ResponseBodyCommonProperties" },
+        { "type": "object", "properties": { "collection": { "type": "array", "items": { "type": "object",  "additionalProperties": { "type": "string" } } } } }
+      ]
+    },
+
+
+
+    "LoadPortalResponseBody": {
+      "description": "元数据的响应体",
+      "allOf": [
+        { "$ref": "#/definitions/ResponseBodyCommonProperties" },
+        { "type": "object", "properties": { "collection": { "type": "array", "items": { "$ref": "#/definitions/LoadPortalResponseItem" } } } }
+      ]
+    },
+
+    "LoadPortalResponseItem": {
+      "type": "object",
+      "properties": {
+        "name":  { "type": "string" },
+        "links": { "$ref": "#/definitions/LinkList" }
+      }
+    }
+
+
+
+  }
+}

data/lib/repres/dosser/version.rb

@@ -1,5 +1,5 @@
 module Repres
   module Dosser
-    VERSION = '1.5'.freeze
+    VERSION = '1.6'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: repres-dosser
 version: !ruby/object:Gem::Version
-  version: '1.5'
+  version: '1.6'
 platform: ruby
 authors:
 - Topbit Du
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-19 00:00:00.000000000 Z
+date: 2016-08-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -44,6 +44,14 @@ files:
 - app/helpers/repres/dosser/application_helper.rb
 - app/views/layouts/repres/dosser/application.html.erb
 - config/routes.rb
+- lib/generators/repres/dosser/platform/USAGE
+- lib/generators/repres/dosser/platform/platform_generator.rb
+- lib/generators/repres/dosser/platform/templates/app/controllers/portals_controller.rb
+- lib/generators/repres/dosser/platform/templates/app/controllers/presentation_controller.rb
+- lib/generators/repres/dosser/platform/templates/config/routes.rb
+- lib/generators/repres/dosser/swagger/USAGE
+- lib/generators/repres/dosser/swagger/swagger_generator.rb
+- lib/generators/repres/dosser/swagger/templates/lib/swagger/api.json
 - lib/repres/dosser.rb
 - lib/repres/dosser/engine.rb
 - lib/repres/dosser/version.rb