zhima_auth 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 72c6022d4ec7ad10934852d37960bb357b2ab091
-  data.tar.gz: 5f84fb04bd7dfe979934a63f6cab99c42b904dd0
+  metadata.gz: 20c07328831c323f52ed18319126106ea7db50e5
+  data.tar.gz: 42594b30d81fc95e15ac28218f5c6ffdf74a6660
 SHA512:
-  metadata.gz: 6bb8167eb89b62dc30abfaabcbedd564c39b17a42d1e74e7e9fda30efb4c469608f9c338c91fc852c8a79fdaa2daa67a434d86ed3a6addad7ea7738d53327b0e
-  data.tar.gz: 2c29257fa3673bc9a935adef2075a93fec5791e07a3650ef0d108f1cba67eb52754d326fb886105f5d551bae42474e58cc2c958ea5cff879dab9109128cee0ea
+  metadata.gz: ad8cb899a198e178f6d4ba583e886f544955891842268ba9be2c14258b9721caf405c3b5b6199314937086f7bd61adb5967b7000298d8eedd23c5a51b681bc66
+  data.tar.gz: d92bb317756319d2a361c0c2c51336d72a021718b98c5ca5e2e644ba41bb328e729d1074590e9b45b144ece82a9af5fff0fbc21ba5d8dbefbb1f6bf292b3d591

data/.gitignore

@@ -5,5 +5,6 @@
 /coverage/
 /doc/
 /pkg/
+/spec/zhima.yml
 /spec/reports/
 /tmp/

data/README.md

@@ -1,41 +1,71 @@
 # ZhimaAuth
 
-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/zhima_auth`. To experiment with that code, run `bin/console` for an interactive prompt.
+[芝麻认证](https://doc.open.alipay.com/docs/doc.htm?treeId=271&articleId=105915&docType=1)是通过人脸识别、眼纹识别、银行卡验证等手段，对用户进行实人验证，可有效地核实用户身份，防止身份冒用、欺诈等风险。简单说就是验证“张三是张三”。
+因为官方并没有发布针对Ruby的SDK同时市面上并没有现成的可用于Ruby的第三方开发包，于是这个针对该空缺的Ruby就诞生了，Yeah：D
+由于官方暂时只支持身份证 + 人脸识别的方案。所以此Gem也不列外。使用方式非常简单，具体如下，如果觉得这个Gem对你有用请别忘了点个赞，Happy coding! Everyone!
 
-TODO: Delete this and the text above, and describe your gem
+## Usage
 
-## Installation
+首先[官方文档链接](https://doc.open.alipay.com/docs/doc.htm?treeId=271&articleId=105913&docType=1), 如果遇到任何意外的问题，首先建议请一定参阅官方文档，毕竟文档才是唯一的Truth。
 
-Add this line to your application's Gemfile:
+### STEP 1
+[产品注册](https://doc.open.alipay.com/docs/doc.htm?treeId=271&articleId=105913&docType=1), 这是第一步，注册产品并获取必要的app_id, 接着[配置密钥](https://doc.open.alipay.com/docs/doc.htm?treeId=291&articleId=106103&docType=1)，其中自己的private_key是需要配置进自己的app的。完成上述两部获得相应的app_id及private_key，一切就准备就绪了。
 
+### STEP 2
+如果你用的是Rails(下面都会以此为假设)
 ```ruby
+# Gemfile
 gem 'zhima_auth'
-```
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install zhima_auth
-
-## Usage
 
-TODO: Write usage instructions here
+bundle install
+
+# config/initializers/zhima.rb
+ZhimaAuth.configure do |config|
+  config.app_id = "1223232"
+  config.private_key = private_key
+end
+
+# private_key looks like this
+private_key = <<-KEY
+-----BEGIN RSA PRIVATE KEY-----
+MIIEogIBAAKCAQEAtSq73+gTT7OI7psSTvXGvKo6PtHoJ3NX3KS/vcSMIju9A0uT
+uBZXA3Rsz/dUTlgAZOqkNWLHDoDj+pcjX1Oj99wkKDWAfui1xcrj5qgljBKPxiYo
+nJUxDrmiHwFeO6KiNs4Z+FutAposxioz1+JhHYnssuL2lm4kwc7eJxYaDls5shlg
+...many lines here...
+LMFBAoGAUAgyFOusxxcXaKdJY+LzMNyQLmbmvVxF0l5V0syE1a8Mv5YivFsXqIFT
+x+26iF4G8GcrZtejwVrkgr9i6B4CIHa90Qs8PpAuFgzspwU4ALOsBujfC1fk+iVl
+d3S+mDxT/A+hxMFsZr8CQUj/CJtG/SYcLpAWAW3akvVqacHgqOQ=
+-----END RSA PRIVATE KEY-----
+KEY
+```
 
-## Development
+### STEP 3
+配置完成之后，最简单的调用方法如下
+```ruby
+# 获取biz_no, certify_url
+params = { cert_name: "王大锤", cert_no: "32012345678901234X", return_url: "http://www.liangboyuan.pub", transanction_id: "12345" }
+# transanction_id should be given for the moment, problem will be solved in the next release
+ZhimaAuth.certify params
+
+# expected response, following response is a fake one.
+{:biz_no=>"ZM201704153000000767600024912345",
+ :certify_url=>
+  "https://openapi.alipay.com/gateway.do?app_id=2017021605123456&charset=utf-8&format=JSON&sign_type=RSA2&version=1.0&method=zhima.customer.certification.certify&return_url=http%3A%2F%2Fwww.liangboyuan.pub&timestamp=2017-04-15+14%3A37%3A30&biz_content=%7B%22biz_no%22%3A%22ZM201704153000000767600024912345%22%7D&sign=lXzkmaNfv%2FwZppNItxTBGIJK%2Fpw2sKwhofNf9UtN3RMl%2FFo2FSKY4LaA3Vf6J04VXNI6LK7Vkw0OiTVVfKwG2P%2F5AbpUxNeC2uevE%2FIBjOvq6QeQwZNcfjhc8M87umMWUqTpsDzye6W2KaRR7HAbDOeEG8iizVXwADqf842nkWyviFj7Jh8YK6726DsleZTb%2BQybNWmPgJ4Y7wLeSmhNSe8aP9vmVuXVbVshTU1I50BgoaSpvvFLwHzmKstrKkdgpVwQgMcloGMMK3z90vbdNNn85KamxwF4u2reUSYeavkKBvgQyog%3D%3D"}
+```
+获取认证结果的调用方法如下
+```ruby
+# 参数为之前一部获取的biz_no
+ZhimaAuth::QueryRequest.new("MK8789789789787978").get_certify_result
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+# expected result
+"true" or "false"
+```
 
-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).
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/zhima_auth. 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.
-
+If you find any bug or want to contribute, feel free to make a pull request or create a issue, I will try my best to work with that. Or you can live me a message to my email: lby89757@hotmail.com
 
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-

data/lib/zhima_auth/configuration.rb

@@ -1,6 +1,6 @@
 module ZhimaAuth
   class Configuration
-    attr_accessor :app_id, :private_key, :sign_type, :format, :charset, :version, :biz_code
+    attr_accessor :app_id, :private_key, :sign_type, :format, :charset, :version, :biz_code, :admittance_score
 
     def initialize
       @app_id = "app_id"
@@ -10,6 +10,7 @@ module ZhimaAuth
       @charset = "utf-8"
       @version = "1.0"
       @biz_code = "FACE"
+      @admittance_score = 650
     end
   end
 end

data/lib/zhima_auth/error.rb

@@ -1,12 +1,12 @@
 module ZhimaAuth
-  class ZhimaAuthInvalidParams < StandardError
+  class InvalidParams < StandardError
     attr_accessor :message
     def initialize(msg=nil)
       @message = msg
     end
   end
 
-  class ZhimaAuthInvalidResponse < StandardError
+  class InvalidResponse < StandardError
     attr_accessor :message
     def initialize(msg=nil)
       @message = msg

data/lib/zhima_auth/request.rb

@@ -128,4 +128,56 @@ module ZhimaAuth
     end
 
   end
+
+  class CreditRequest < BaseRequest
+
+    def initialize biz_params
+      # support cert_type: IDENTITY_CARD(身份证),PASSPORT(护照),ALIPAY_USER_ID(支付宝uid)
+      @cert_type = biz_params[:cert_type]
+      @cert_name = biz_params[:cert_name]
+      @cert_no = biz_params[:cert_no]
+      @transaction_id = biz_params[:transaction_id]
+      @admittance_score = biz_params[:admittance_score]
+    end
+
+    def excute
+      @response ||= RestClient.post url_with_params, {}
+    end
+
+    def get_result
+      res = JSON.parse(excute)
+      Validation.check_credit_response res
+      result = res["zhima_credit_score_brief_get_response"]["is_admittance"]
+      biz_no = res["zhima_credit_score_brief_get_response"]["biz_no"]
+      {
+        passed: result == "Y" ? true : false,
+        biz_no: biz_no
+      }
+    end
+
+    private
+
+    def url_with_params
+      [url, WebUtil.to_query(params_with_sign)].join("?")
+    end
+
+    def params
+      @params ||= base_params.merge({
+        method: "zhima.credit.score.brief.get",
+        timestamp: Time.now.strftime("%Y-%m-%d %H:%M:%S"),
+        biz_content: biz_content.to_json
+      })
+    end
+
+    def biz_content
+      {
+        transaction_id: @transaction_id,
+        product_code: "w1010100000000002733",
+        cert_type: @cert_type,
+        cert_no: @cert_no,
+        name: @cert_name,
+        admittance_score: @admittance_score
+      }.delete_if { |key, value| value.to_s.strip == '' }
+    end
+  end
 end

data/lib/zhima_auth/validation.rb

@@ -2,43 +2,53 @@ module ZhimaAuth
   class Validation
     class << self
       def check_initialize_params biz_params
-        raise ZhimaAuthInvalidParams, "Params should be a hash" unless biz_params.is_a? Hash
+        raise ZhimaAuth::InvalidParams, "Params should be a hash" unless biz_params.is_a? Hash
         unless biz_params[:cert_name] && biz_params[:cert_no] && biz_params[:transaction_id]
-          raise ZhimaAuthInvalidParams, "Params should include cert_name, cert_no and transaction_id"
+          raise ZhimaAuth::InvalidParams, "Params should include cert_name, cert_no and transaction_id"
         end
         check_name biz_params[:cert_name]
         check_id_no biz_params[:cert_no]
       end
 
       def check_certify_params biz_params
-        raise ZhimaAuthInvalidParams, "Params should be a hash" unless biz_params.is_a? Hash
+        raise ZhimaAuth::InvalidParams, "Params should be a hash" unless biz_params.is_a? Hash
         unless biz_params[:biz_no] && biz_params[:return_url]
-          raise ZhimaAuthInvalidParams, "Params should include biz_no and return_url"
+          raise ZhimaAuth::InvalidParams, "Params should include biz_no and return_url"
         end
         check_url biz_params[:return_url]
         check_biz_no biz_params[:biz_no]
       end
 
       def check_biz_no biz_no
-        raise ZhimaAuthInvalidParams, "Invalid biz no" unless biz_no.length == 32
+        raise ZhimaAuth::InvalidParams, "Invalid biz no" unless biz_no.length == 32
       end
 
       def check_initialize_response response
-        raise ZhimaAuthInvalidResponse, "Initialize request failed" unless (response.is_a? Hash) && response["zhima_customer_certification_initialize_response"]
+        raise ZhimaAuth::InvalidResponse, "Initialize request failed" unless (response.is_a? Hash) && response["zhima_customer_certification_initialize_response"]
         response_code = response["zhima_customer_certification_initialize_response"]["code"]
         if response_code != "10000"
           response_msg = response["zhima_customer_certification_initialize_response"]["sub_msg"]
-          raise ZhimaAuthInvalidResponse, "#{response_code}#{response_msg}"
+          raise ZhimaAuth::InvalidResponse, "#{response_code}#{response_msg}"
         end
         true
       end
 
       def check_query_response response
-        raise ZhimaAuthInvalidResponse, "Query request failed" unless (response.is_a? Hash) && response["zhima_customer_certification_query_response"]
+        raise ZhimaAuth::InvalidResponse, "Query request failed" unless (response.is_a? Hash) && response["zhima_customer_certification_query_response"]
         response_code = response["zhima_customer_certification_query_response"]["code"]
         if response_code != "10000"
           response_msg = response["zhima_customer_certification_query_response"]["sub_msg"]
-          raise ZhimaAuthInvalidResponse, "#{response_code}#{response_msg}"
+          raise ZhimaAuth::InvalidResponse, "#{response_code}#{response_msg}"
+        end
+        true
+      end
+
+      def check_credit_response response
+        raise ZhimaAuth::InvalidResponse, "Credit request failed" unless (response.is_a? Hash) && response["zhima_credit_score_brief_get_response"]
+        response_code = response["zhima_credit_score_brief_get_response"]["code"]
+        if response_code != "10000"
+          response_msg = response["zhima_credit_score_brief_get_response"]["sub_msg"]
+          raise ZhimaAuth::InvalidResponse, "#{response_code}#{response_msg}"
         end
         true
       end
@@ -46,16 +56,16 @@ module ZhimaAuth
       private
 
       def check_url url
-        raise ZhimaAuthInvalidParams, "Invalid return url" unless url =~ URI::regexp
+        raise ZhimaAuth::InvalidParams, "Invalid return url" unless url =~ URI::regexp
       end
 
       def check_name name
-        raise ZhimaAuthInvalidParams, "Invalid name" if (name.length > 5 || name.length <= 1)
+        raise ZhimaAuth::InvalidParams, "Invalid name" if (name.length > 10 || name.length <= 1)
         true
       end
 
       def check_id_no id_no
-        raise ZhimaAuthInvalidParams, "Invalid identity number" unless (id_no.length == 15 || id_no.length == 18)
+        raise ZhimaAuth::InvalidParams, "Invalid identity number" unless (id_no.length == 15 || id_no.length == 18)
         true
       end
     end

data/lib/zhima_auth/version.rb

@@ -1,3 +1,3 @@
 module ZhimaAuth
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zhima_auth
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - BranLiang
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-04-15 00:00:00.000000000 Z
+date: 2017-04-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client