ns_service_pack 0.1.1 → 0.1.2

data/CHANGELOG

@@ -1,10 +1,12 @@
 #==============History:
 
+#==0.1.2
+* 测试和添加部分文档
+
 #==0.1.1
 * 将该gem升级为rails项目中的engine
 * 增加了一个默认的info_controller，反射出当前应用发布的api接口（仅可在非产品模式访问）
 
-
 #==0.1.0[Note: 重大变更！]
 * 增加service scaffold generator: rake generator ns:scaffold
 * 初始化配置文件copy由thor任务完成： ns_service_pack install (在rails根目录下)

data/README.rdoc

@@ -1,44 +1,55 @@
 = ns_service_pack
 
-  实现REST架构（ROA）中Service层部分基础代码抽取
+  实现REST架构（ROA）中Service层基础代码抽取
 
-== 功能列表：
+== 功能列表
 
 * 支持自定义json格式的资源crud操作
 * 提供全局字典常量/转换管理
 * 提供数据库层-业务层字段自动转换
+* 宿主应用的发布接口管理和测试
 
-== TODO TASK LIST 
+== TODO LIST
+
+* REST接口测试平台开发
+    如何用get请求模拟post请求？
 * 规划文档和内容调整
 * 写完整测试
 * index默认查询条件加入，传入条件的merge（目前已提供传入条件的精确搜索）
-* 如何用get请求模拟post请求
 
-#==NS Service Pack使用指南
+== 使用指南
 
 *1 在rails3项目中使用，命令行执行：
    gem install ns_service_pack
-   ns_service_pack install
+   nsp install
    bundle install
   
 *2 为某资源生成有service支持的scaffold，命令行：
    rake g ns:scaffold
 
-*3 提示：
-   常量的使用：GlobalConst.ns_statuses[key_or_value]
+*提示：
+   常量引用和转换：GlobalConst.ns_statuses[key_or_value]
+   内置接口: /interfaces, /mappings, /constants
 
-== Contributing to ns_service_pack
- 
-* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
-* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
-* Fork the project
-* Start a feature/bugfix branch
-* Commit and push until you are happy with your contribution
-* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
-* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+== 项目引用0.0.x到0.1.x升级帮助（仅需四步，5～10分钟，绝对无痛哦！）
 
-== Copyright
+* 获取最新版本:       gem install ns_service_pack
+* rails项目根目录下： nsp install && bundle install(此步检查下Gemfile，确保引用最新，或gem 'ns_service_pack', '~>0.1')
+* Models中明确引用： include FieldMapping
+* ApplicationController或！子类！中添加引用： include ControllerServicable
+= 验证是否成功？
+* 访问： http://xxx/，非生产环境会重定向到/interfaces, 点击示例中的链接（动态生成）
+= 相关背景
+* 已停止支持 nclient gem, 相关功能会融合在nsp中
+* 扩展为rails的engine，包含自己的生成器等
+* 以后有时间时，可以开发内部接口测试和性能监控平台，进行有效的集中管理和共有问题处理；对数据库层进行更好的封装
+
+== 相关问题更新和反馈
 
-Copyright (c) 2011 caory. See LICENSE.txt for
-further details.
+== 版本历史
+
+ref: CHANGELOG
+
+== Copyright
 
+Copyright (c) 2011 caory and ns. Please let me know in advance if you plan to refer this codebase. Thanks!

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.1.2

data/app/controllers/ns/info_controller.rb

@@ -5,7 +5,7 @@ class Ns::InfoController < ApplicationController
   def interfaces
     @routes = Rails.application.routes.routes
     #删除一些无需关注的路由: /assets, /rails/info/properties, /interfaces
-    @routes.delete_if{|r| r.path =~ /\/assets|\/rails\/info|\/interfaces/}
+    @routes.delete_if{|r| r.path =~ /\/assets|\/rails\/info|\/interfaces|\/$/}
     #验证接口是否改变的校验码
     @version_code = @routes.join(';').hash
     respond_to do |format|

data/app/views/ns/info/interfaces.html.erb

@@ -1,12 +1,13 @@
-<p>模块发布接口列表(版本码：<%=@version_code%>  获取日期:<%= Time.now.to_s(:db)%>)：</p>
-
+<p><%=Rails.root.basename.to_s.humanize%>发布接口列表
+(内容版本码：<%=@version_code%>  获取日期:<%= Time.now.to_s(:db)%>)：
+</p>
 <table border='1'>
   <tr>
     <th>No.</th>
-    <th>HttpMethod</th>
+    <th>Request</th>
     <th>Path</th>
     <th>Sample</th>
-    <th>Requirements  </th>
+    <th>Responsor</th>
   </tr>
   <%@routes.each_with_index do |r, i|%>
     <tr>
@@ -22,13 +23,14 @@
       <td>
         <%#= link_to r.name || "示例", "#{r.path.sub('(.:format)', '.json').sub(':id', '1')}}" %> 
         <%if r.verb.to_s.upcase == 'GET' %>
-          <%=link_to r.name || "示例", "#{r.path.sub('(.:format)', '.json').sub(':id', '1')}" %> 
+          <%=link_to r.name || "示例", "#{r.path.sub('(.:format)', '').sub(':id', '1')}" %> 
         <%else%>
           <%= "#{r.path.sub('(.:format)', '').sub(':id', '1')}" %> 
         <%end%>
       </td>
       <td>
-        <%= r.requirements%>
+        <%req = r.requirements%>
+        <%= "#{req[:controller]}-->#{req[:action]}"%>
       </td>
     </tr>
   <%end%>

data/config/routes.rb

@@ -3,6 +3,7 @@
 # 发布的接口仅在非生产模式可访问
 unless Rails.env.production?
   Rails.application.routes.draw do
+    root :to=>"ns/info#interfaces"
     get 'interfaces', :to=>"ns/info#interfaces"
     get 'constants', :to=>"ns/info#constants"
     get 'mappings', :to=>"ns/info#mappings"

data/lib/generators/ns/scaffold/templates/active_record/model/model.rb

@@ -4,6 +4,8 @@ class <%= class_name %> < <%= parent_class_name.classify %>
 <% attributes.select {|attr| attr.reference? }.each do |attribute| -%>
   belongs_to :<%= attribute.name %>
 <% end -%>
+  #Make your model have buz-db mapping (configurable)
   include Ns::FieldMapping
+
 end
 <% end -%>

data/lib/generators/ns/scaffold/templates/rails/scaffold_controller/controller.rb

@@ -1,9 +1,11 @@
 #encoding: utf-8
 <% module_namespacing do -%>
 class <%= controller_class_name %>Controller < ApplicationController
+  #Make your controller servicable
   include Ns::ControllerServicable
   def model_class
     <%= class_name %>
   end
+
 end
 <% end -%>

data/lib/templates/config/ns_services.yml

@@ -13,7 +13,7 @@ production:
   :customer_service_base_url: http://customer.api.ilining.cn
 
 #==依赖于前面值的共有设置
-#如：开发模式下， AppConfig.services[:customers]==>http://localhost:5000/customers
+#如：开发模式下， NsServices[:customers]==>http://localhost:5000/customers
 #语法： 键: [依赖键（字符串形式）, 附加字串]
 common:
   :customers: [customer_service_base_url, customers]

data/ns_service_pack.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = "ns_service_pack"
-  s.version = "0.1.1"
+  s.version = "0.1.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Caory, Shang, Geogeous"]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ns_service_pack
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2011-12-01 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
-  requirement: &80545720 !ruby/object:Gem::Requirement
+  requirement: &88082070 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 1.6.7
   type: :runtime
   prerelease: false
-  version_requirements: *80545720
+  version_requirements: *88082070
 - !ruby/object:Gem::Dependency
   name: thor
-  requirement: &80545480 !ruby/object:Gem::Requirement
+  requirement: &88081830 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 0.14.6
   type: :runtime
   prerelease: false
-  version_requirements: *80545480
+  version_requirements: *88081830
 - !ruby/object:Gem::Dependency
   name: shoulda
-  requirement: &80545240 !ruby/object:Gem::Requirement
+  requirement: &88081570 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *80545240
+  version_requirements: *88081570
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &80545000 !ruby/object:Gem::Requirement
+  requirement: &88081310 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *80545000
+  version_requirements: *88081310
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &80544760 !ruby/object:Gem::Requirement
+  requirement: &88081070 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +65,10 @@ dependencies:
         version: 1.6.4
   type: :development
   prerelease: false
-  version_requirements: *80544760
+  version_requirements: *88081070
 - !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &80544520 !ruby/object:Gem::Requirement
+  requirement: &88080830 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,7 +76,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *80544520
+  version_requirements: *88080830
 description: abstract some common pattern to service pack
 email: cao7113@hotmail.com
 executables:
@@ -139,7 +139,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 373915261
+      hash: -792238463
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: