zhima 0.2.6 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4a1c5288c76c7dd21f7afcc4d9ac792a17638cff
-  data.tar.gz: 36748ae8e31b45ecc09c20247ff36c7c4d00726a
+  metadata.gz: 5ae4098fe5acc3b45025e6cd8603676362d4c7c3
+  data.tar.gz: b64c2616fa053692d59d8e86a30c3d256e2167e4
 SHA512:
-  metadata.gz: d9938d6e8a7ebadfcbe8e432650159c3e0658a38060286129e475812df805ebcf3c27ce78bb4c97d59f4216dc849285c50514d3731ff2e2343e9825dc103d4cf
-  data.tar.gz: 125fe0b745c1f1c6d864e4dc61179e6bf41bd6affefa5325d1488878890f36020b3a604330c720490d897f6705d8b62420824d0520ae8dc6af131ef2dcad586d
+  metadata.gz: 7c0ed4896d352c4302ca8dbcf640f8fedbf4c2e4123c67d600eaa952cd292196917b1108554ae0d9da5f70141d58fde4084b3da53d758aa8ceabc43f11784f52
+  data.tar.gz: 2602e39b06060ba1d44970b8d9e50ebde5aa63b8e929f542045779ad4acef5e1a6bb7eb8c6c538479ae7ebb17672ec5ffd3c506032de6f97d1db62e72739fdf2

data/README.md

@@ -21,8 +21,37 @@ Or install it yourself as:
     $ gem install zhima
 
 ## Usage
+配置(config/initializers/zhima.rb)：
+```ruby
+Zhima.configure do |config|
+  config.app_id = 'xxxxxxx' # 应用id
+  config.private_key = private_key # 自己的私钥
+  config.public_key = public_key # 芝麻给的公钥
+end
+```
+
+芝麻信用分，调用方法如下(请自行查阅芝麻文档的业务参数组织params)：
+```ruby
+# 认证url  业务参数请参考 https://b.zmxy.com.cn/technology/openDoc.htm?id=67
+Zhima::Score.auth_url(params)  # 第二个参数可hash传入芝麻需要的系统参数，不传亦可（下同，省略）
+
+# 获取芝麻分
+# https://b.zmxy.com.cn/technology/openDoc.htm?relInfo=zhima.credit.score.get@1.0@1.4&relType=API_DOC&type=API_INFO_DOC&LEFT_MENU_MODEnull#Seq_1
+Zhima::Score.get(params)
 
-TODO: Write usage instructions here
+# auth_query
+# https://b.zmxy.com.cn/technology/openDoc.htm?id=453
+Zhima::Score.auth_query(params)
+
+# 芝麻callback url中的params参数解密
+Zhima::Score.param_decrypt(params_str)
+```
+
+反欺诈信息验证：
+```ruby
+# 参数 https://b.zmxy.com.cn/technology/openDoc.htm?relInfo=zhima.credit.ivs.detail.get@1.0@1.2&relType=API_DOC&type=API_INFO_DOC&LEFT_MENU_MODEnull
+Zhima::Ivs.get(params)
+```
 
 ## Development
 
@@ -32,7 +61,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/zhima. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/zhchsf/zhima. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 
 ## License

data/lib/zhima/ivs.rb

@@ -0,0 +1,11 @@
+module Zhima
+  # 反欺诈信息验证
+  class Ivs
+    METHOD = 'zhima.credit.ivs.detail.get'
+
+    # https://b.zmxy.com.cn/technology/openDoc.htm?relInfo=zhima.credit.ivs.detail.get@1.0@1.2&relType=API_DOC&type=API_INFO_DOC&LEFT_MENU_MODEnull
+    def self.get(params, sys_options = {})
+      Request.new(params, sys_options.merge(method: METHOD)).execute
+    end
+  end
+end

data/lib/zhima/request.rb

@@ -0,0 +1,36 @@
+module Zhima
+  class Request
+    GATEWAY = 'https://zmopenapi.zmxy.com.cn/openapi.do'
+    SYSTEM_OPTIONS = {charset: 'UTF-8', version: '1.0', channel: 'app'}
+
+    attr_accessor :biz_params, :sys_options
+
+    def initialize(biz_params, sys_options)
+      @biz_params = biz_params
+      @sys_options = SYSTEM_OPTIONS.merge(sys_options)
+    end
+
+    def url
+      params_value, sign = Param.encrypt(biz_params)
+      opts = SYSTEM_OPTIONS.merge(sys_options)
+             .merge(params: params_value, sign: sign, app_id: Config.app_id)
+      query_str = Util.to_query(opts)
+      [GATEWAY, query_str].join('?')
+    end
+
+    def execute
+      response = RestClient.get url
+      parse_response(response.body)
+    end
+
+    private
+    # 芝麻返回的json数据解析，结果为真正的业务参数
+    # TODO verify sign
+    def parse_response(response_str)
+      response_hash = JSON.parse(response_str)
+      biz_response = response_hash["biz_response"]
+      biz_response = Param.decrypt(biz_response) if response_hash["encrypted"]
+      JSON.parse(biz_response)
+    end
+  end
+end

data/lib/zhima/score.rb

@@ -2,8 +2,6 @@ require "rest-client"
 
 module Zhima
   class Score
-    GATEWAY = 'https://zmopenapi.zmxy.com.cn/openapi.do'
-    SYSTEM_OPTIONS = {charset: 'UTF-8', version: '1.0', channel: 'app'}
     AUTHORIZE_METHOD = 'zhima.auth.info.authorize'
     SCORE_METHOD = 'zhima.credit.score.get'
     AUTH_QUERY_METHOD = 'zhima.auth.info.authquery'
@@ -11,22 +9,17 @@ module Zhima
     # params参数 请参考 https://b.zmxy.com.cn/technology/openDoc.htm?id=67
     # 系统参数 SYSTEM_OPTIONS，可自己传入，一般只需要配置channel参数（与auth_code不对应芝麻信用会报错）
     def self.auth_url(params, sys_options = {})
-      url_by(params, sys_options.merge(method: AUTHORIZE_METHOD))
+      Request.new(params, sys_options.merge(method: AUTHORIZE_METHOD)).url
     end
 
     # https://b.zmxy.com.cn/technology/openDoc.htm?relInfo=zhima.credit.score.get@1.0@1.4&relType=API_DOC&type=API_INFO_DOC&LEFT_MENU_MODEnull#Seq_1
-    # TODO verify sign
     def self.get(params, sys_options = {})
-      score_url = url_by(params, sys_options.merge(method: SCORE_METHOD))
-      response = RestClient.get score_url
-      parse_response(response.body)
+      Request.new(params, sys_options.merge(method: SCORE_METHOD)).execute
     end
 
     # https://b.zmxy.com.cn/technology/openDoc.htm?id=453
     def self.auth_query(params, sys_options = {})
-      query_url = url_by(params, sys_options.merge(method: AUTH_QUERY_METHOD))
-      response = RestClient.get query_url
-      parse_response(response.body)
+      Request.new(params, sys_options.merge(method: AUTH_QUERY_METHOD)).execute
     end
 
     # 芝麻callback url中的params参数解密方法
@@ -34,20 +27,5 @@ module Zhima
       decrypted_str = Param.decrypt(params_str)
       URI.decode_www_form(URI.decode URI.escape(decrypted_str)).to_h
     end
-
-    def self.url_by(params, sys_options)
-      params_value, sign = Param.encrypt(params)
-      opts = SYSTEM_OPTIONS.merge(sys_options)
-             .merge(params: params_value, sign: sign, app_id: Config.app_id)
-      query_str = Util.to_query(opts)
-      [GATEWAY, query_str].join('?')
-    end
-
-    def self.parse_response(response_str)
-      response_hash = JSON.parse(response_str)
-      biz_response = response_hash["biz_response"]
-      biz_response = Param.decrypt(biz_response) if response_hash["encrypted"]
-      JSON.parse(biz_response)
-    end
   end
 end

data/lib/zhima/version.rb

@@ -1,3 +1,3 @@
 module Zhima
-  VERSION = "0.2.6"
+  VERSION = "0.3.0"
 end

data/lib/zhima.rb

@@ -11,8 +11,10 @@ module Zhima
   end
 end
 
+require_relative "zhima/config"
 require_relative "zhima/score"
+require_relative "zhima/ivs"
+require_relative "zhima/request"
 require_relative "zhima/param"
 require_relative "zhima/sign"
 require_relative "zhima/util"
-require_relative "zhima/config"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zhima
 version: !ruby/object:Gem::Version
-  version: 0.2.6
+  version: 0.3.0
 platform: ruby
 authors:
 - sam
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-10-20 00:00:00.000000000 Z
+date: 2016-10-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -85,7 +85,9 @@ files:
 - bin/setup
 - lib/zhima.rb
 - lib/zhima/config.rb
+- lib/zhima/ivs.rb
 - lib/zhima/param.rb
+- lib/zhima/request.rb
 - lib/zhima/score.rb
 - lib/zhima/sign.rb
 - lib/zhima/util.rb