zhima_auth 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 72c6022d4ec7ad10934852d37960bb357b2ab091
+  data.tar.gz: 5f84fb04bd7dfe979934a63f6cab99c42b904dd0
+SHA512:
+  metadata.gz: 6bb8167eb89b62dc30abfaabcbedd564c39b17a42d1e74e7e9fda30efb4c469608f9c338c91fc852c8a79fdaa2daa67a434d86ed3a6addad7ea7738d53327b0e
+  data.tar.gz: 2c29257fa3673bc9a935adef2075a93fec5791e07a3650ef0d108f1cba67eb52754d326fb886105f5d551bae42474e58cc2c958ea5cff879dab9109128cee0ea

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rake_tasks~

@@ -0,0 +1,7 @@
+build
+clean
+clobber
+install
+install:local
+release[remote]
+spec

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.13.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at lby89757@hotmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in zhima_auth.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 BranLiang
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,41 @@
+# 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.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'zhima_auth'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install zhima_auth
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+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.
+
+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.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "zhima_auth"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/zhima_auth/configuration.rb

@@ -0,0 +1,15 @@
+module ZhimaAuth
+  class Configuration
+    attr_accessor :app_id, :private_key, :sign_type, :format, :charset, :version, :biz_code
+
+    def initialize
+      @app_id = "app_id"
+      @private_key = "private_key"
+      @sign_type = "RSA2"
+      @format = "JSON"
+      @charset = "utf-8"
+      @version = "1.0"
+      @biz_code = "FACE"
+    end
+  end
+end

data/lib/zhima_auth/error.rb

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

data/lib/zhima_auth/request.rb

@@ -0,0 +1,131 @@
+module ZhimaAuth
+  class BaseRequest
+    REQUEST_GATEWAY = 'https://openapi.alipay.com/gateway.do'
+
+    def url
+      REQUEST_GATEWAY
+    end
+
+    def base_params
+      @base_params ||= {
+        app_id: ZhimaAuth.configuration.app_id,
+        charset: ZhimaAuth.configuration.charset,
+        format: ZhimaAuth.configuration.format,
+        sign_type: ZhimaAuth.configuration.sign_type,
+        version: ZhimaAuth.configuration.version,
+      }
+    end
+
+    def params_with_sign
+      params.merge({sign: Sign.encode(params)})
+    end
+  end
+
+  class InitializeRequest < BaseRequest
+    attr_accessor :cert_name, :cert_no, :transaction_id
+    # { cert_name: "Bran", cert_no: "3543563267268", transaction_id: "AIHEHUO20170101000000001" }
+    def initialize(biz_params)
+      Validation.check_initialize_params(biz_params)
+
+      @cert_name = biz_params[:cert_name]
+      @cert_no = biz_params[:cert_no]
+      @transaction_id = biz_params[:transaction_id]
+    end
+
+    def excute
+      @response ||= RestClient.post url_with_params, {}
+    end
+
+    def get_biz_no
+      res = JSON.parse(excute)
+      Validation.check_initialize_response res
+      res["zhima_customer_certification_initialize_response"]["biz_no"]
+    end
+
+    private
+
+    def params
+      @params ||= base_params.merge({
+        method: "zhima.customer.certification.initialize",
+        timestamp: Time.now.strftime("%Y-%m-%d %H:%M:%S"),
+        biz_content: {
+          transaction_id: @transaction_id,
+          product_code: "w1010100000000002978",
+          biz_code: ZhimaAuth.configuration.biz_code,
+          identity_param: {
+            identity_type: "CERT_INFO",
+            cert_type: "IDENTITY_CARD",
+            cert_name: @cert_name,
+            cert_no: @cert_no
+          }
+        }.to_json
+      })
+    end
+
+    def url_with_params
+      [url, WebUtil.to_query(params_with_sign)].join("?")
+    end
+
+  end
+
+  class CertifyRequest < BaseRequest
+
+    # { biz_no: "MK62873648327468", return_url: "https://www.google.com" }
+    def initialize(biz_params)
+      Validation.check_certify_params biz_params
+
+      @biz_no = biz_params[:biz_no]
+      @return_url = biz_params[:return_url]
+    end
+
+    def generate_url
+      [url, URI.encode_www_form(params_with_sign)].join("?")
+    end
+
+    private
+
+    def params
+      @params ||= base_params.merge({
+        method: "zhima.customer.certification.certify",
+        return_url: @return_url,
+        timestamp: Time.now.strftime("%Y-%m-%d %H:%M:%S"),
+        biz_content: {
+          biz_no: @biz_no
+        }.to_json
+      })
+    end
+
+  end
+
+  class QueryRequest < BaseRequest
+
+    def initialize(biz_no)
+      Validation.check_biz_no biz_no
+
+      @biz_no = biz_no
+    end
+
+    def excute
+      @response ||= RestClient.post url, params_with_sign
+    end
+
+    def get_certify_result
+      res = JSON.parse(excute)
+      Validation.check_query_response res
+      res["zhima_customer_certification_query_response"]["passed"]
+    end
+
+    private
+
+    def params
+      @params ||= base_params.merge({
+        method: "zhima.customer.certification.query",
+        timestamp: Time.now.strftime("%Y-%m-%d %H:%M:%S"),
+        biz_content: {
+          biz_no: @biz_no
+        }.to_json
+      })
+    end
+
+  end
+end

data/lib/zhima_auth/sign.rb

@@ -0,0 +1,18 @@
+module ZhimaAuth
+  class Sign
+    class << self
+      def encode params
+        digest = OpenSSL::Digest::SHA256.new
+        signature = ZhimaAuth.mech_rsa.sign(digest, transform(params))
+        Base64.strict_encode64(signature)
+      end
+
+      def transform params
+        params.sort.map do |k, v|
+          "#{k}=#{v}"
+        end.join("&")
+      end
+
+    end
+  end
+end

data/lib/zhima_auth/validation.rb

@@ -0,0 +1,63 @@
+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
+        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"
+        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
+        unless biz_params[:biz_no] && biz_params[:return_url]
+          raise ZhimaAuthInvalidParams, "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
+      end
+
+      def check_initialize_response response
+        raise ZhimaAuthInvalidResponse, "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}"
+        end
+        true
+      end
+
+      def check_query_response response
+        raise ZhimaAuthInvalidResponse, "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}"
+        end
+        true
+      end
+
+      private
+
+      def check_url url
+        raise ZhimaAuthInvalidParams, "Invalid return url" unless url =~ URI::regexp
+      end
+
+      def check_name name
+        raise ZhimaAuthInvalidParams, "Invalid name" if (name.length > 5 || 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)
+        true
+      end
+    end
+  end
+end

data/lib/zhima_auth/version.rb

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

data/lib/zhima_auth/web_util.rb

@@ -0,0 +1,11 @@
+module ZhimaAuth
+  class WebUtil
+    class << self
+
+      def to_query hash
+        hash.map{ |k, v| [k, URI.encode_www_form_component(v)].join("=") }.join("&")
+      end
+
+    end
+  end
+end

data/lib/zhima_auth.rb

@@ -0,0 +1,39 @@
+require "openssl"
+require "base64"
+require "uri"
+require "rest-client"
+require "json"
+
+module ZhimaAuth
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration)
+  end
+
+  def self.mech_rsa
+    @mech_rsa ||= OpenSSL::PKey::RSA.new configuration.private_key
+  end
+
+  # expected biz_params { cert_name: "王大锤", cert_no: "32099999999999999X", transaction_id(optional): "789789", return_url: "http://www.liangboyuan.pub" }
+  def self.certify biz_params
+    params = biz_params[:transaction_id] ? biz_params : biz_params.merge({transaction_id: SecureRandom.uuid})
+    biz_no = InitializeRequest.new(params).get_biz_no
+    url = CertifyRequest.new({biz_no: biz_no, return_url: biz_params[:return_url]}).generate_url
+    return {
+      biz_no: biz_no,
+      certify_url: url
+    }
+  end
+end
+
+require_relative "zhima_auth/version"
+require_relative "zhima_auth/configuration"
+require_relative "zhima_auth/sign"
+require_relative "zhima_auth/request"
+require_relative "zhima_auth/web_util"
+require_relative "zhima_auth/error"
+require_relative "zhima_auth/validation"

data/zhima_auth.gemspec

@@ -0,0 +1,39 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'zhima_auth/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "zhima_auth"
+  spec.version       = ZhimaAuth::VERSION
+  spec.authors       = ["BranLiang"]
+  spec.email         = ["lby89757@hotmail.com"]
+
+  spec.summary       = %q{芝麻认证}
+  spec.description   = %q{芝麻认证 for ruby}
+  spec.homepage      = "http://www.liangboyuan.pub"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rest-client"
+  spec.add_development_dependency "pry-byebug", "~> 3.4.2"
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "webmock", "~> 2.0"
+end

metadata

@@ -0,0 +1,149 @@
+--- !ruby/object:Gem::Specification
+name: zhima_auth
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- BranLiang
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-04-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.2
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: 芝麻认证 for ruby
+email:
+- lby89757@hotmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rake_tasks~"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/zhima_auth.rb
+- lib/zhima_auth/configuration.rb
+- lib/zhima_auth/error.rb
+- lib/zhima_auth/request.rb
+- lib/zhima_auth/sign.rb
+- lib/zhima_auth/validation.rb
+- lib/zhima_auth/version.rb
+- lib/zhima_auth/web_util.rb
+- zhima_auth.gemspec
+homepage: http://www.liangboyuan.pub
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: 芝麻认证
+test_files: []