ns_service_pack 0.0.19 → 0.0.21

data/CHANGELOG

@@ -0,0 +1,104 @@
+#==============History:
+* 增加service scaffold generator
+
+#==0.1.0[Note: 重大变更！]
+* 初始化配置文件copy由thor任务完成： ns_service_pack init (在rails根目录下)
+* 将ApplicationControllerModule重命名为：Ns::ControllerServicable
+* 在initializers/ns_service_pack.rb中默认只加载配置信息，不再为controller和model包含mapping的功能，由最终用户
+  决定是否使用，这样做性能和可定制性更好（后来加上scaffold功能，减少人为操作！）
+* 将原来client端的几个文件融入到该包中
+
+#==0.0.17
+* 转用jeweler包来管理本gem项目, 可用bundler，rake，git来便利化相关开发
+* 注释gem root变量的引用
+
+#==0.0.16 20111119
+* 由Gao发现load_code_hashes!时引入空.yml文件时出错，已修复
+* 修改dump_mapping文件目录从code_hashes/fields到code_hashes/mappings
+
+#==0.0.15 20111118
+* 在mapping中支持可配置的json数据(自定义属性)输出，需要：
+  1. 在<mapping>.yml文件中增加一个自定义属性
+    :some_key_name: :get_key_value_method_name
+
+  2. 在model类中增加一个获取键值的方法，如下：
+     def <get_key_value_method_name>
+       #give some value for the key
+     end
+     另一种方式：
+     def self.get_map_value(key, value)
+       #add a new when branch for the key
+       case key 
+       ...
+       when :<some_key_name>
+         #get value for the key
+       ...
+       end
+     end
+
+#==0.0.14
+* fix bug: error==>errors
+
+#==0.0.13
+* json数据打包部分增加部分成功的情况：
+  ResultPacker.improve(ok_data, errors_hash, msg)
+  返回节点情况：
+  {
+  :status=>'imperfect',
+  :msg=>'部分逻辑错误',
+  :data=>your_ok_data_part,
+  :errors=>your_error_hash_part
+  }
+
+#==0.0.12
+* Fix bug: override the original 'model_name' method, rename to '__model_clazz_name'
+
+#==0.0.11
+* 文档整理
+
+#==0.0.8
+* 支持更灵活的index查询方法
+  直接提供子类的
+  #def get_page_data(start, size, params)
+  #  [10, model_class.all[0..3]]
+  #end
+
+#==0.0.6
+* 修正query_fields接口实现
+* 修改方法名：
+  生成mapping：     ModelName.dump_mapping
+  生成示例初始数据：ModelName.dump_new
+
+#==0.0.5
+* 初步解决application controller问题
+* 添加默认index精确搜索条件
+
+#==0.0.4 
+* 同一版本号不能向rubygems上提交两次？那怎么更新那个版本呢？
+* 本地可以启用gem server，客户端通过以下指定源方式安装
+  gem install --source http://cao:8808
+
+#==0.0.3 20111116
+* 添加自动生成可配置的field_map，在控制台中运行：
+    Customer.dump_field_map
+* 自动生成为客户端new资源时的初始结构
+    Customer.dump_init_hash
+  生成到<app>/data/customer_field.yml中
+
+* 统一用建立在CodeHash基础上的GlobalConst管理常量数据
+  <app>/config/code_hashes/**/*.yml文件会被初始化时加载
+* 将对ApplicationController和ActiveRecord::Base的扩展放在
+  initializers/ns_service_pack.rb中，便于项目做定制
+
+
+#==0.0.2 
+* 增加使用指南README，测试gem更新
+
+#==0.0.1 20111116 
+发布0.0.1版本，主要实现以下内容：
+* 建立gem包基本结构，将主要代码纳入gem中
+* 更友好的CodeHash数据管理
+
+#==20111116  
+根据Shang的建议，决定将共用代码抽离成gem包形式
+

data/Gemfile

@@ -2,6 +2,8 @@ source "http://rubygems.org"
 # Add dependencies required to use your gem here.
 # Example:
 #   gem "activesupport", ">= 2.3.5"
+gem 'rest-client', '~> 1.6.7' #add runtime dependencies
+gem "thor", "~> 0.14.6"
 
 # Add dependencies to develop your gem here.
 # Include everything needed to run rake, tests, features, etc.

data/Gemfile.lock

@@ -6,9 +6,13 @@ GEM
       bundler (~> 1.0)
       git (>= 1.2.5)
       rake
+    mime-types (1.17.2)
     rake (0.9.2.2)
     rcov (0.9.11)
+    rest-client (1.6.7)
+      mime-types (>= 1.16)
     shoulda (2.11.3)
+    thor (0.14.6)
 
 PLATFORMS
   ruby
@@ -17,4 +21,6 @@ DEPENDENCIES
   bundler (~> 1.0.0)
   jeweler (~> 1.6.4)
   rcov
+  rest-client (~> 1.6.7)
   shoulda
+  thor (~> 0.14.6)

data/README.rdoc

@@ -65,103 +65,6 @@ class Customer < ActiveRecord::Base
   ...
 end
 
-
-#==============History:
-#==0.0.17
-* 转用jeweler包来管理本gem项目, 可用bundler，rake，git来便利化相关开发
-* 注释gem root变量的引用
-
-#==0.0.16 20111119
-* 由Gao发现load_code_hashes!时引入空.yml文件时出错，已修复
-* 修改dump_mapping文件目录从code_hashes/fields到code_hashes/mappings
-
-#==0.0.15 20111118
-* 在mapping中支持可配置的json数据(自定义属性)输出，需要：
-  1. 在<mapping>.yml文件中增加一个自定义属性
-    :some_key_name: :get_key_value_method_name
-
-  2. 在model类中增加一个获取键值的方法，如下：
-     def <get_key_value_method_name>
-       #give some value for the key
-     end
-     另一种方式：
-     def self.get_map_value(key, value)
-       #add a new when branch for the key
-       case key 
-       ...
-       when :<some_key_name>
-         #get value for the key
-       ...
-       end
-     end
-
-#==0.0.14
-* fix bug: error==>errors
-
-#==0.0.13
-* json数据打包部分增加部分成功的情况：
-  ResultPacker.improve(ok_data, errors_hash, msg)
-  返回节点情况：
-  {
-  :status=>'imperfect',
-  :msg=>'部分逻辑错误',
-  :data=>your_ok_data_part,
-  :errors=>your_error_hash_part
-  }
-
-#==0.0.12
-* Fix bug: override the original 'model_name' method, rename to '__model_clazz_name'
-
-#==0.0.11
-* 文档整理
-
-#==0.0.8
-* 支持更灵活的index查询方法
-  直接提供子类的
-  #def get_page_data(start, size, params)
-  #  [10, model_class.all[0..3]]
-  #end
-
-#==0.0.6
-* 修正query_fields接口实现
-* 修改方法名：
-  生成mapping：     ModelName.dump_mapping
-  生成示例初始数据：ModelName.dump_new
-
-#==0.0.5
-* 初步解决application controller问题
-* 添加默认index精确搜索条件
-
-#==0.0.4 
-* 同一版本号不能向rubygems上提交两次？那怎么更新那个版本呢？
-* 本地可以启用gem server，客户端通过以下指定源方式安装
-  gem install --source http://cao:8808
-
-#==0.0.3 20111116
-* 添加自动生成可配置的field_map，在控制台中运行：
-    Customer.dump_field_map
-* 自动生成为客户端new资源时的初始结构
-    Customer.dump_init_hash
-  生成到<app>/data/customer_field.yml中
-
-* 统一用建立在CodeHash基础上的GlobalConst管理常量数据
-  <app>/config/code_hashes/**/*.yml文件会被初始化时加载
-* 将对ApplicationController和ActiveRecord::Base的扩展放在
-  initializers/ns_service_pack.rb中，便于项目做定制
-
-
-#==0.0.2 
-* 增加使用指南README，测试gem更新
-
-#==0.0.1 20111116 
-发布0.0.1版本，主要实现以下内容：
-* 建立gem包基本结构，将主要代码纳入gem中
-* 更友好的CodeHash数据管理
-
-#==20111116  
-根据Shang的建议，决定将共用代码抽离成gem包形式
-
-
 == 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

data/VERSION

@@ -1 +1 @@
-0.0.19
+0.0.21

data/bin/ns_service_pack

@@ -0,0 +1,91 @@
+#!/usr/bin/env ruby
+#encoding: utf-8
+
+require 'thor'
+require 'pathname'
+require 'fileutils'
+
+class Cli < Thor 
+  include Thor::Actions
+  source_root File.expand_path("../../lib/templates", __FILE__) 
+
+  desc 'install', 'install ns_service_pack on your project'
+  method_options :force=>:boolean#, :aliases=>'-f'
+  def install
+    unless rails_root?
+      say("  Error: current #{cwd} is not a rails app root directory!", :red)
+      return
+    end
+    unless use_bundler?
+      say("  Error: now only support Bundler's gem managed mechanism!", :red)
+      return
+    end
+    #say "force: #{options.force?}", :red #TODO
+    if !has_installed? || options.force?
+      init_files.each {|f| copy_file(f) }
+      unless has_installed?
+        append_file 'Gemfile' do 
+          <<-Doc
+gem 'ns_service_pack' #use our service pack
+          Doc
+        end
+      end
+    else
+      say("  Has installed ns_service_pack in this project!", :yellow)
+    end
+  end
+
+  desc 'uninstall', 'uninstall ns_service_pack from your project'
+  def uninstall
+    unless has_installed?
+      if yes?("Are you sure uninstall ns_service_pack from this project?")
+        #remove_file('config/code_hashes/') TODO
+        say("This is not implemented now, please ask for caory!", :yellow)
+      end
+    else
+      say("  Not install ns_service_pack now!", :yellow)
+    end 
+  end
+
+  def self.destination_root 
+    cwd.to_s
+  end
+
+  no_tasks do 
+    def self.cwd
+      Pathname.pwd
+    end
+
+    def cwd
+      self.class.cwd
+    end
+    
+    def rails_root?
+      File.exist?("#{cwd}/config/boot.rb")
+    end
+    
+    def has_gemed?
+      use_bundler? && File.read('./Gemfile')=~/^gem 'ns_service_pack'/
+    end
+    alias :has_installed? :has_gemed?
+
+    def use_bundler?
+      File.exist?("#{cwd}/Gemfile")
+    end
+
+    def init_files
+      #files = Dir["#{self.class.source_root}/**/*"].delete_if{|f| !File.file?(f)}
+      #files.map{|f| f.gsub(self.class.source_root+'/', '')}
+
+      #for explicit control
+      [ 'config/code_hashes/code_hash.yml.sample',
+        'config/initializers/ns_service_pack.rb',
+        'config/initializers/oracle_db_config.rb',
+        'config/database.yml.sample',
+        'config/ns_services.yml'
+      ]
+    end
+  end
+end
+
+Cli.start

data/lib/generators/ns/scaffold/scaffold_generator.rb

@@ -0,0 +1,12 @@
+#encoding: utf-8
+require 'rails/generators/rails/scaffold/scaffold_generator'
+class Ns::ScaffoldGenerator < Rails::Generators::ScaffoldGenerator
+  desc "dump field mapping ..."
+  def dump_field_mapping
+    say("  Generating fieldmapping for model: #{name}...", :green)
+    the_model = Object.const_get(class_name)
+    mapping_file = the_model.dump_mapping
+    say("  Generated field mapping for model: #{name}...", :green)
+    say("  You can configure it in #{mapping_file}.", :green)
+  end
+end

data/lib/generators/try/templates/test.rb

@@ -0,0 +1,3 @@
+#encoding: utf-8
+
+puts "this is just test stub"

data/lib/generators/try/try_generator.rb

@@ -0,0 +1,17 @@
+#encoding: utf-8
+
+class TryGenerator < Rails::Generators::NamedBase
+  #source_root File.expand_path("../templates", __FILE__)
+  #def copy_test_file
+   # copy_file "test.rb", "#{file_name}.rb"
+  #end
+
+  #test model get
+  def model_test
+    puts "name:#{name}, file_name:#{file_name}, class_name:#{class_name}"
+    puts "plural_name:#{plural_name}, thor camel: #{Thor::Util.camel_case(name)}"
+    puts "==get model info: #{Object.const_get(class_name).new.attributes}"
+  end
+
+end
+

data/lib/ns_service_pack/client.rb

@@ -0,0 +1,40 @@
+#coding: utf-8
+require 'rest_client'
+
+module Ns
+  class Client
+    #delegate :new, :get, :post, :to=>RestClient::Resource TODO ??
+    def self.get(url = '', params = {})
+      #params TODO 
+      request('get', url, params)
+    end
+
+    def self.post(url = '', params = {})
+      request('post', url, params)
+    end
+
+    def self.put(url = '', params = {})
+      request('put', url, params)
+    end
+
+    def self.delete()
+    end
+
+    def self.request(action = 'get', url = '', data_params = {})
+      #TODO 网路异常处理
+      #use RestClient now
+      json_response = RestClient.send(action, url, :data=>data_params)
+      result = unpack(json_response)
+      if result.ok?
+        return result.data.symbolize_keys if result.data.is_a?(Hash)
+        result.data
+      else
+        raise ResultError.new(result)
+      end
+    end
+
+    def self.unpack(json_response_str = nil)
+      Result.new(JSON.parse(json_response_str))
+    end
+  end
+end

data/lib/ns_service_pack/controller_servicable.rb

@@ -0,0 +1,97 @@
+#coding: utf-8
+module Ns
+  module ControllerServicable
+    def index
+      @result = paginate(params) do |start, page_size|
+        get_page_data(start, page_size, params)
+      end
+      render :json=>ResultPacker.data(@result.as_json)
+    end
+
+    #return [total_count, page_data]
+    #可在子类中覆盖定制
+    def get_page_data(start = 0, size = 10, params = {})
+      where_conds = if @conds.present?
+        @conds
+      else
+        query_conditionize(params, @conds)
+      end
+      logger.debug "====>conds: #{where_conds.inspect}"
+      conds = {:conditions=>where_conds}
+      total_count = model_class.count(conds)
+      page_params = conds.merge!(:offset=>start, :limit=>size, :order=>params[:order])
+      page_data = model_class.all(page_params)
+      [total_count, page_data]
+    end
+
+    def query_conditionize(params = {}, conds = {})
+      #清除空条件
+      params.delete_if{|k, v| v.blank? }
+      #TODO 有@conds时如何融入？？？
+      #hash结构
+      conds = model_class.db_hashize(params)
+    end
+
+    #分页方法
+    def paginate(params = {})
+      current_page = params[:current_page].to_i
+      current_page = current_page < 1 ? 1 : current_page
+      page_size = params[:page_size].to_i
+      page_size = page_size <= 0 ? 10 : page_size
+      page_size = page_size > 250 ? 250 : page_size
+      offset = (current_page-1)*page_size
+      #返回总数和当前页数据           起始位置， 数量
+      total_count, page_data =  yield(offset, page_size)
+      {
+       :total_size=>total_count,
+       :page_size=>page_size,
+       :current_page=>current_page,
+       :page_from=>offset + 1,
+       :page_to=>offset + page_data.size,
+       :page_items=>page_data
+      }
+    end
+    
+    #查找单条记录
+    def show
+      @_obj = model_class.find(params[:id])
+      render :json=>ResultPacker.data(@_obj.as_json)
+    end
+    
+    #创建记录
+    def create
+      @_obj = model_class.new_from_buz(params[:data]) 
+      if @_obj.save
+        render :json=>ResultPacker.data(@_obj)
+      else
+        render :json=>ResultPacker.help(valid_errors(model_class.buz_hashize(@_obj.errors.to_hash)))
+      end
+    end
+    
+    #更新记录
+    def update
+      @_obj = model_class.find(params[:id])
+      if @_obj.update_from_buz(params[:data])
+        render :json=>ResultPacker.data(@_obj)
+      else
+        render :json=>ResultPacker.help(valid_errors(model_class.buz_hashize(@_obj.errors.to_hash)))
+      end
+    end
+   
+    #验证错误回传
+    def valid_errors(error_hash={})
+      (error_hash||{}).each{|k, v| error_hash[k] = v.join(', ') if v.is_a? Array }
+    end
+
+    #ABORTED NOW, keep here
+    def query_fields
+      @_data = model_class.buz_hashize
+      render :json=>ResultPacker.data(:fields=>@_data)
+    end
+
+    #动态查看该模块发布接口列表
+    def interfaces
+      @routes = Rails.application.routes.routes
+    end
+  end
+end