repres-dosser 1.7 → 1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d91b4f4bd6317ee0705ee588c10f3482334d823e
-  data.tar.gz: d81637a87e719a06fcb8ac2c5944114e5a609b0d
+  metadata.gz: 17689051bfd88e10055fbbd422d843489de7d2e3
+  data.tar.gz: b73a7a1b231ff41e878aea8dbc9b1c7a0f871c51
 SHA512:
-  metadata.gz: 90e6e11ac85ae4c215275f182a2f7e9048b6c2bdd22e610e620e36ba29ba87dfa417b31c9fb00a18ec6878e06eec93bd103d8bb2e0f1f5352b9c8d11165778d9
-  data.tar.gz: 494226bd6200c0830bd33a7997a91d0e3dc9f3f12eef7fdf7a62ddb881f098ab6ff82190c1c0fe8f9c8dab4327ee19b42318ebadb4a1364058b035aabdf473a1
+  metadata.gz: c33194a418ecf6d6d71673ff51b2dff498833e6403f279c4ff3fd24c4d32a044593ed0dc1b7fb06d17f860f57aa10da372f008c762f59588764986992af2cefc
+  data.tar.gz: ec373d379cc1f663e2cb6ca2aa7d5bd7226f830d6a22e5a8eb3566739c7661cbac730705eb82189b8a1db914dc8a0b6e0b1b6470e13c6241e03c3a6160a906ec

data/README.md

@@ -2,24 +2,37 @@
 
 [![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)
+[![Dependency Status](https://gemnasium.com/badges/github.com/topbitdu/repres-dosser.svg)](https://gemnasium.com/github.com/topbitdu/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
 
@@ -41,7 +54,57 @@ The following responding methods are supported:
 - 409 render_conflict
 - 500 render_internal_server_error
 
+The Resource Presentation supports JSONP automatically. Which means ``GET /resources/id.json`` returns a standard JSON:
+```json
+{
+  "success": true,
+  "code":    "success",
+  "message": "成功",
+  "size":    1,
+  "errors":  {},
+  "collection":
+  [
+    {
+      "name": "My Name",
+      "links": []
+    }
+  ],
+  "meta":
+  {
+    "criteria":   null,
+    "request_id": "54fc3aa3-d062-4bad-b544-a08c7df5ef0c",
+    "timestamp":  1479114866
+  }
+}
+```
+If a callback parameter is given as ``GET /resources/id.json?callback=onResourceLoaded``, the following JSON is returned:
+```json
+onResourceLoaded(
+  {
+    "success": true,
+    "code":    "success",
+    "message": "成功",
+    "size":    1,
+    "errors":  {},
+    "collection":
+    [
+      {
+        "name": "My Name",
+        "links": []
+      }
+    ],
+    "meta":
+    {
+      "criteria":   null,
+      "request_id": "54fc3aa3-d062-4bad-b544-a08c7df5ef0c",
+      "timestamp":  1479114866
+    }
+  }
+);
+```
+
 ### Pagination
+
 ```ruby
 include Repres::Dosser::Concerns::ResourcePresentation
 
@@ -68,8 +131,6 @@ onIndexResourceSuccess: function(data, textStatus, jqXHR)
 
 ## Generators
 
-
-
 ### Platform generator
 
 ```shell
@@ -89,8 +150,6 @@ app/controllers/administration/dosser/v2/presentation_controller.rb
 app/controllers/administration/dosser/v2/portals_controller.rb
 ```
 
-
-
 ### Swagger generator
 
 ```shell

data/Rakefile

@@ -10,7 +10,7 @@ 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('README.md')
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
@@ -20,5 +20,5 @@ load 'rails/tasks/statistics.rake'
 
 
 
-Bundler::GemHelper.install_tasks
+require 'bundler/gem_tasks'
 

data/app/assets/config/repres-dosser_manifest.js

@@ -0,0 +1,2 @@
+//= link_directory ../javascripts/repres/dosser .js
+//= link_directory ../stylesheets/repres/dosser .css

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

@@ -5,7 +5,7 @@
 // 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.
+// compiled file. JavaScript code in this file should be added after the last require_* statement.
 //
 // Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
 // about supported directives.

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

@@ -6,9 +6,9 @@
  * 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.
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
  *
  *= require_self
  */

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

@@ -1,2 +1,3 @@
 class Repres::Dosser::ApplicationController < ActionController::Base
+  protect_from_forgery with: :exception
 end

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

@@ -226,7 +226,7 @@ module Repres::Dosser::Concerns::ResourcePresentation
       result[:meta] = { criteria: @criteria, request_id: request.uuid, timestamp: Time.now.to_i }
       result[:meta][:pagination] = @pagination if @pagination.present?
       respond_to do |format|
-        format.json do render status: status, json: result end
+        format.json do render status: status, json: result, callback: params[:callback] end
         format.xml  do render status: status, xml:  result end
       end
     end

data/app/jobs/repres/dosser/application_job.rb

@@ -0,0 +1,2 @@
+class Repres::Dosser::ApplicationJob < ActiveJob::Base
+end

data/app/mailers/repres/dosser/application_mailer.rb

@@ -0,0 +1,4 @@
+class Repres::Dosser::ApplicationMailer < ActionMailer::Base
+  default from: 'from@example.com'
+  layout 'mailer'
+end

data/app/models/repres/dosser/application_record.rb

@@ -0,0 +1,3 @@
+class Repres::Dosser::ApplicationRecord < ActiveRecord::Base
+  self.abstract_class = true
+end

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

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

data/lib/repres/dosser/version.rb

@@ -1,5 +1,5 @@
 module Repres
   module Dosser
-    VERSION = '1.7'.freeze
+    VERSION = '1.8'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: repres-dosser
 version: !ruby/object:Gem::Version
-  version: '1.7'
+  version: '1.8'
 platform: ruby
 authors:
 - Topbit Du
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-27 00:00:00.000000000 Z
+date: 2016-11-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -37,11 +37,15 @@ files:
 - MIT-LICENSE
 - README.md
 - Rakefile
+- app/assets/config/repres-dosser_manifest.js
 - 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/jobs/repres/dosser/application_job.rb
+- app/mailers/repres/dosser/application_mailer.rb
+- app/models/repres/dosser/application_record.rb
 - app/views/layouts/repres/dosser/application.html.erb
 - config/routes.rb
 - lib/generators/repres/dosser/platform/USAGE