doraemon 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6d9c85bd3eb87662ed6053a4e0a1e649af527a6c5455b3593df390dcf9d76c3b
-  data.tar.gz: 42fb2a77a7327bb6944224f480c282f87787f7f16bb7b7dc416a887851b5bab1
+  metadata.gz: 40d6031e236f4e0ecaad08587400227ecbc42f61eded9c4e446688ffb71e31a8
+  data.tar.gz: 42910edc1ff8273520e7c09edfd9105d243bbfa5553fd63cdacafe219d6973aa
 SHA512:
-  metadata.gz: '0183784ade8020acca838281748b34f7edf262e2ad5d89961f378ababcea3f6d1e5bd0a96f1b39b60fdc05fb5328a6d501997dfa4227e58a8a326cc6fd2ee42a'
-  data.tar.gz: 57d5383930e326d66e0164ba6019dab24f41b204b0635fbd6273ab95c8c32c57f1fce3219023a867ca59b03ee3218315ad2ac359c3604316f1ab67e901514853
+  metadata.gz: 02b10db8fc9d4c64b38a388dd52d4639c3187dc344d62f666bca6697b4bc593d16e830fb1d01bdda33ba26868154191404e21a95d3491fc3f5383f2430230210
+  data.tar.gz: 5eff94c8fc5571a4edc5743ac32173414a0b27a397c773b3170ad7c8bb5354599a890252b2c6d4e1c29cd77cfb7d0c17edaec6aeca77c5432ea35e74d0bd1c35

data/README.md

@@ -1,35 +1,124 @@
 # Doraemon
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/doraemon`. To experiment with that code, run `bin/console` for an interactive prompt.
+一个简单的 API Mock Server，让你脱离后端进行高效的接口数据测试，同时无需侵入客户端代码
 
-TODO: Delete this and the text above, and describe your gem
+## 安装
 
-## Installation
+在命令行运行: 
 
-Add this line to your application's Gemfile:
+```
+    $ [sudo] gem install doraemon
+```
+
+等待安装完成
+
+## 使用方法
+
+### 1. 创建 Mock 文件
+
+将 API 地址 path 部分中的斜杠(/)替换为下划线(_)，并追加文件扩展名(.rb / .json / .api 均可)
+
+例如：v4/homepage/recommend 接口的 Mock 文件就是 v4_homepage_recommend.rb
+
+### 2. 启动 doraemon
+
+在 Mock 文件所在目录运行
 
-```ruby
-gem 'doraemon'
+```
+    $ doraemon
 ```
 
-And then execute:
+此时可以看到 doraemon 已经将目录下所有 Mock 文件载入
+```
+[~/api]  ls
+v3_homepage_tiger_list.rb	v4_homepage_recommend.rb
+[~/api]  doraemon 
+/v4/homepage/recommend  =>  v4_homepage_recommend.rb
+/v3/homepage/tiger/list  =>  v3_homepage_tiger_list.rb
+......
+```
 
-    $ bundle
+### 3. 测试设备连接代理
 
-Or install it yourself as:
+将测试设备的代理设置到 doraemon 的默认 4000 端口上
 
-    $ gem install doraemon
+### 4. 安装 SSL 证书（如需调试 HTTPS 接口）
 
-## Usage
+打开手机浏览器，访问 doraemon 的 4001 端口，即可下载安装 SSL 证书
 
-TODO: Write usage instructions here
+## 使用案例
 
-## Development
+### 例1. 直接 Mock JSON 数据
+假设我们想测试首页搜索栏中的提示文案，涉及 v3/word/default接口
+创建 v3_word_default.rb 文件，内容如下：
+```
+{
+  "code": 0,
+  "res": {
+    "id": 2018050924,
+    "hintWord": "天王盖地虎",
+    "word": "宝塔镇河妖"
+  },
+  "msg": "请求已成功处理"
+}
+```
+切换 tab 至首页，可以看到上方搜索栏的提示文案已被 Mock 数据替代
 
-After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+### 例2. 操作请求参数
+假设我们想测试优惠券兑换相关流程，涉及 v4/activity/coupon/code/exchange 接口
+创建 v4_activity_coupon_code_exchange.rb 文件，内容如下：
+```
+# 通过 _params 变量访问请求的参数
+correct = _params['exchageCode'] == 'abc123'
+{
+  'code': correct ? 0 : -1,
+  'msg': correct ? '兑换成功' : '兑换码无效'
+}
+```
+这样，当我们输入兑换码 abc123 进行验证，将会返回成功的数据，其他情况均为失败的结果
+
+### 例3. 获取原始返回数据
+假设我们想调试个我的页面的会员信息展示，涉及 v2/users/center 接口
+创建 v2_users_center.rb 文件，内容如下：
+```
+# 通过 _result 变量访问原始的返回数据
+_result['res']['level'] = 3
+_result['res']['score'] = 666666
+_result
+```
+切换到我的页面，可以发现等级已经被改写成 3，分数被改为 66666，如果想测试其他等级的数据，直接修改保存即可。
+
+⚠️ 所有 Mock 数据文件最后一个表达式必须是这个文件的返回值，比如例3中，如果缺额少最后一行的 _result，那该文件返回的就是最后那句赋值表达式的值（即666666）
+
+## 参数
+### 指定端口
+```
+    $ doraemon --port=5000 
+```
+这时 API 监听端口就是5000，而证书下载的端口再加1也就是5001
+
+### 指定目录
+```
+    $ doraemon --root=~/api
+```
+指定工作目录为 ~/api，可以在这个目录下维护一些测试 API 文件
+
+## Tips:
+
+1. API 的修改是支持热重载的，即修改文件内容无需重启服务。但增加 API 文件是需要重启的，后期必要的话可以添加更完善的热重载机制
+
+2. iOS 端可以通过 Shadowrocket 创建一个 Today Widget 快速切换是否 Mock，不过这个工具是收费的
+
+3. 使用时可以固定一个 api 目录（假设 ~/api），这时你可以在 .bash_profile 中增加一行
+```
+alias mock='doraemon --root=~/api --port=4000'
+```
+
+然后运行以下命令
+```
+    $ source ~/.bash_profile
+```
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+以后只要打开 Terminal 执行命令 mock 就可以开始以 ~/api 为工作目录进行数据 mock 了
 
-## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/doraemon.

data/exe/doraemon

@@ -12,7 +12,7 @@ include Doraemon
 
 argv = CLAide::ARGV.new(ARGV)
 port = argv.option('port', 4000)
-root = argv.option('root', Dir.pwd)
+root = File.expand_path(argv.option('root', Dir.pwd))
 
 api_manager = Doraemon::APIManager.new(root)
 

data/lib/doraemon/version.rb

@@ -1,3 +1,3 @@
 module Doraemon
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: doraemon
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - zhuoyi
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-11-02 00:00:00.000000000 Z
+date: 2018-11-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler