fadada 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e33af833d5f5c2548f193f9ef47bc0c46e8a3f4f74c96115162284eb76452cc4
+  data.tar.gz: ef6b7df502b0b8bef1f74dc21cc115b47c33d4b824068f10c96458a2f1bd1621
+SHA512:
+  metadata.gz: 7452866a9181a3ddc390a510a78ef5b47fa68bc039b3447d82f60b9f3938d9443a048264748c4b42e618257f52dbd5cd27bf139c6182209d42012104b73ab906
+  data.tar.gz: 8f8bea3062babea4c7b95552ebd173c5e1aafac2e860eebe7efbd76ecf4d0492f1d6deba8197853c20dd804678af39b9784b52b654717738cceb16fc4aaa3a03

data/.gitignore

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

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 402399938@qq.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 fadada.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 wangrui
+
+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,45 @@
+# 法大大实名存证电子合同Ruby SDK
+
+## 法大大电子合同分为实名认证版和实名存证版
+
+1. `实名认证`版中客户的实名认证是在法大大侧，需要人工审核
+2. `实名存证`版中客户的实名认证是在调用方侧，实时性高
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'fadada'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fadada
+
+## Usage
+
+    $ rails generate fadada:install
+
+## Development
+
+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.
+
+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]/fadada. 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](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Fadada project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/fadada/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "fadada"
+
+# 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(__FILE__)

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/fadada.gemspec

@@ -0,0 +1,42 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "fadada/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "fadada"
+  spec.version       = Fadada::VERSION
+  spec.authors       = ["wangrui"]
+  spec.email         = ["402399938@qq.com"]
+
+  spec.summary       = %q{法大大实名认证电子合同}
+  spec.description   = %q{法大大实名认证电子合同Ruby SDK}
+  spec.homepage      = "https://github.com/wangrui438/fadada"
+  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"
+
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = "https://github.com/wangrui438/fadada"
+    spec.metadata["changelog_uri"] = "https://github.com/wangrui438/fadada/blob/master/CHANGELOG.md"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |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_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency 'httparty', '~> 0.17.0'
+end

data/lib/examples/auth.rb

@@ -0,0 +1,45 @@
+# 法大大实名认证接口调用顺序（二）
+
+file = File.open('xxx')
+
+# 个人实名信息存证
+options = {
+  customer_id: customer_id,
+  preservation_name: '个人实名信息存证', # 存证名称
+  preservation_data_provider: 'XX网络科技有限公司', # 存证提供方
+  name: '张三',
+  idcard: 'xxx', # 证件号
+  idcard_positive_file: '', # 证件照正面
+  idcard_negative_file: '', # 证件照反面
+  verified_time: DateTime.now.strftime('%Y-%m-%d %H:%M:%S'),
+  verified_type: 'Z', # 实名认证类型，Z 其他
+  cert_flag: '0'
+}
+evidence_no = Fadada::Authentication.person_deposit(options)
+
+# 企业实名信息存证
+options = {
+  customer_id: customer_id,
+  preservation_name: '企业实名信息存证',
+  preservation_data_provider: 'XX网络科技有限公司',
+  company_name: 'XX公司',
+  document_type: '1', # 证件类型 1:三证合一 2:旧版营业执照
+  credit_code: '91827364817263', # 统一社会信用代码
+  credit_code_file: file, # 统一社会信用代码电子版
+  verified_time: DateTime.now.strftime('%Y-%m-%d %H:%M:%S'), # 实名时间
+  verified_mode: '1', # 实名认证方式 1:授权委托书 2:银行对公打款
+  power_attorney_file: file, # 授权委托书电子版
+  company_principal_type: '1', # 企业负责人身份:1. 法人，2 代理人
+  company_principal_verified_msg: { # 企业负责人实名存证信息
+    customer_id: '671C6CC93D9F4C0630911735795666A2',
+    preservation_name: '个人实名信息存证',
+    preservation_data_provider: 'XX网络科技有限公司', # 存证提供方
+    name: '张三',
+    idcard: 'xxx', # 证件号
+    verified_time: DateTime.now.strftime('%Y-%m-%d %H:%M:%S'),
+    verified_type: 'Z' # 实名认证类型，Z 其他
+  }.to_json,
+  transaction_id: '127635172637217', # 交易号
+  cert_flag: '0'
+}
+evidence_no = Fadada::Authentication.company_deposit(options)

data/lib/examples/cert.rb

@@ -0,0 +1,5 @@
+# 法大大实名认证接口调用顺序（三）
+# 编号证书申请
+customer_id = 'xxx' # 客户编号
+evidence_no = 'xxx' # 存证编号
+cert = Fadada::Certificate.apply(customer_id: customer_id, evidence_no: evidence_no)

data/lib/examples/contract.rb

@@ -0,0 +1,57 @@
+# 法大大实名认证接口调用顺序（五）
+
+contract_id = "19273648172364987165"
+doc_title = "这是一个测试合同"
+contract_file = File.open('xxx')
+
+# 上传合同
+options = {
+  contract_id: contract_id, # 合同编号
+  doc_title: doc_title,
+  file: contract_file
+}
+Fadada::Contract.upload_doc(options)
+
+# 上传合同模板
+options = {
+  template_id: '9769867876876876',
+  file: contract_file
+}
+Fadada::Contract.upload_template(options)
+
+# 模板填充
+options = {
+
+}
+Fadada::Contract.generate(options)
+
+# 自动签署合同
+options = {
+  transaction_id: 'A1028374019287342342',
+  contract_id: contract_id,
+  doc_title: doc_title,
+}
+Fadada::Contract.auto_sign(options)
+
+# 手动签署合同
+options = {
+  transaction_id: 'B1028374019287341114',
+  contract_id: contract_id,
+  customer_id: '926064BA49FB4EAA0F1323A0B000DA22',
+  doc_title: doc_title,
+  sign_keyword: '甲方（盖章）：',
+  keyword_strategy: '2',
+  customer_name: 'xx',
+  customer_ident_no: 'xx',
+  return_url: 'http://baidu.com'
+}
+Fadada::Contract.sign(options)
+
+# 查看合同
+Fadada::Contract.show(contract_id)
+
+# 下载合同
+Fadada::Contract.download(contract_id)
+
+# 合同归档
+Fadada::Contract.filing(contract_id)

data/lib/examples/register.rb

@@ -0,0 +1,6 @@
+# 法大大实名认证接口调用顺序（一）
+# 个人开户
+customer_id = Fadada::Account.person_register('N12345678901')
+
+# 企业开户
+customer_id = Fadada::Account.company_register('N09876543211')

data/lib/examples/sign.rb

@@ -0,0 +1,10 @@
+# 法大大实名认证接口调用顺序（四）
+# 上传签章
+customer_id = '' # 客户编号
+path = 'xx' # 签章图片 base64
+sign = Fadada::Signature.upload(customer_id: customer_id, image: path, type: 'path')
+
+# 自定义签章
+customer_id = '' # 客户编号
+content = '测试测试' # 印章展示的内容，可以是企业名称或者客户名称
+sign = Fadada::Signature.custom(customer_id: customer_id, content: content)

data/lib/fadada.rb

@@ -0,0 +1,25 @@
+require "fadada/version"
+require "fadada/configuration"
+require "fadada/http_client"
+
+# resources
+require "fadada/account"
+require "fadada/authentication"
+require "fadada/certificate"
+require "fadada/contract"
+require "fadada/signature"
+
+# exceptions
+require "fadada/api_service_exception"
+
+module Fadada
+  class << self
+    def setup
+      yield config
+    end
+
+    def config
+      @config ||= Configuration.new
+    end
+  end
+end

data/lib/fadada/account.rb

@@ -0,0 +1,39 @@
+# 法大大账户相关接口
+module Fadada
+  class Account
+
+    # 注册账号
+    #
+    #   此接口针对接入平台已有账号体系，判断 open_id 是否存在
+    #   存在则返回对应账号，否则随机生成账号并返回账号
+    #
+    #   open_id => 用户在接入方的唯一标识，length <= 64
+    #
+    #   返回 法大大的账号
+    def self.person_register(open_id)
+      options = {
+        open_id: open_id,
+        account_type: 1 # 账户类型，1 个人；2 企业，默认 1
+      }
+      response = Fadada::HttpClient.request(:post, 'account_register.api', options)
+      response['data']
+    end
+
+    # 注册账号
+    #
+    #   此接口针对接入平台已有账号体系，判断 open_id 是否存在
+    #   存在则返回对应账号，否则随机生成账号并返回账号
+    #
+    #   open_id => 用户在接入方的唯一标识，length <= 64
+    #
+    #   返回 法大大的账号
+    def self.company_register(open_id)
+      options = {
+        open_id: open_id,
+        account_type: 2 # 账户类型，1 个人；2 企业，默认 1
+      }
+      response = Fadada::HttpClient.request(:post, 'account_register.api', options)
+      response['data']
+    end
+  end
+end

data/lib/fadada/api_service_exception.rb

@@ -0,0 +1,12 @@
+# 法大大接口层面异常类
+module Fadada
+  class ApiServiceException < StandardError
+    attr_reader :code, :message
+
+    def initialize(code, message)
+      @code = code
+      @message = message
+      super(message)
+    end
+  end
+end

data/lib/fadada/authentication.rb

@@ -0,0 +1,47 @@
+# 法大大实名认证相关接口
+# 实名认证分为在调用方处做实名认证和在法大大处做实名认证
+# 在调用方处做实名认证需要调用法大大的实名信息存证接口
+# 实名存证方式有以下两种：
+#   1. 实名信息哈希存证是将用户的信息放在一份文档里将这份文件进行sha256算法，将文件hash值传入到法大大这边进行存证。
+#   2.（企业 or 个人）实名信息存证是将对应的信息以明文的方式通过参数传输到法大大这边进行存证。
+# 建议使用方式2实名信息存证，资料尽量全一些，这是对调用方有利的。资料越齐全，以后举证越容易被采信
+module Fadada
+  class Authentication
+
+    # 个人实名信息存证
+    def self.person_deposit(params = {})
+      _basic = %i(bank_essential_factor cert_flag customer_id document_type idcard live_detection mobile
+      mobile_and_bank_essential_factor mobile_essential_factor name preservation_data_provider preservation_desc
+      preservation_name public_security_essential_factor verified_time verified_type)
+      _normal = %i(idcard_positive_file idcard_negative_file live_detection_file)
+      options = params.slice(*(_basic + _normal))
+      digest_params = { _params: params.slice(*_basic) }
+      response = Fadada::HttpClient.request(:post, 'person_deposit.api', options, digest_params)
+      response['data']
+    end
+
+    # 企业实名信息存证
+    def self.company_deposit(params = {})
+      _basic = %i(amount_or_random_code cert_flag company_name company_principal_type company_principal_verified_msg
+      credit_code customer_bank customer_bank_account customer_branch_bank customer_id document_type legal_idcard
+      legal_name licence organization pay_type preservation_data_provider preservation_desc preservation_name
+      public_bank_account public_branch_bank transaction_id user_back_fill_amount_or_random_code verified_mode verified_time)
+      _normal = %i(credit_code_file licence_file organization_file power_attorney_file idcard_positive_file idcard_negative_file
+      live_detection_file)
+      options = params.slice(*(_basic + _normal))
+      digest_params = { _params: params.slice(*_basic) }
+      response = Fadada::HttpClient.request(:post, 'company_deposit.api', options, digest_params)
+      response['data']
+    end
+
+    # 获取企业实名认证地址
+    def self.company_url
+
+    end
+
+    # 获取个人实名认证地址
+    def self.person_url
+
+    end
+  end
+end

data/lib/fadada/certificate.rb

@@ -0,0 +1,19 @@
+# 法大大证书相关接口
+module Fadada
+  class Certificate
+
+    # 编号证书申请
+    # 调用此接口可以给相关账号颁发编号证书
+    #
+    #   customer_id => 客户编号 注册账号时返回
+    #   evidence_no => 存证编号 实名信息存证时返回
+    #
+    def self.apply(customer_id:, evidence_no:)
+      options = {
+        customer_id: customer_id,
+        evidence_no: evidence_no
+      }
+      response = Fadada::HttpClient.request(:post, 'apply_client_numcert.api', options)
+    end
+  end
+end

data/lib/fadada/configuration.rb

@@ -0,0 +1,66 @@
+module Fadada
+  class Configuration
+    # 接口地址
+    def server
+      @server ||= 'https://testapi.fadada.com:8443/api/'
+    end
+
+    def server=(server)
+      @server = server
+    end
+
+    # app_id
+    def app_id
+      @app_id
+    end
+
+    def app_id=(app_id)
+      @app_id = app_id
+    end
+
+    # app_secret
+    def app_secret
+      @app_secret
+    end
+
+    def app_secret=(app_secret)
+      @app_secret = app_secret
+    end
+
+    # 平台方客户编号
+    def customer_id
+      @customer_id
+    end
+
+    def customer_id=(customer_id)
+      @customer_id = customer_id
+    end
+
+    # 平台方客户名称
+    def customer_name
+      @customer_name
+    end
+
+    def customer_name=(customer_name)
+      @customer_name = customer_name
+    end
+
+    # logger
+    def logger
+      @logger ||= Logger.new(STDOUT)
+    end
+
+    def logger=(logger)
+      @logger = logger
+    end
+
+    # logger format
+    def logger_format
+      @logger_format ||= :curl
+    end
+
+    def logger_format=(logger_format)
+      @logger_format = logger_format.to_sym
+    end
+  end
+end

data/lib/fadada/contract.rb

@@ -0,0 +1,100 @@
+# 法大大合同相关接口
+module Fadada
+  class Contract
+    # 上传合同
+    # 接入平台生成 PDF 文档后通过此接口将文档传输到法大大，供签署时使用。
+    # 非 PDF 文档请使用合同模板功能(参考合同模板传输接口和合同生成接口)
+    # 该接口只支持PDF文件
+    def self.upload_doc(params = {})
+      options = params.slice(:contract_id, :doc_title, :doc_url, :file).merge(doc_type: '.pdf')
+      digest_params = { _params: params.slice(:contract_id) }
+      response = Fadada::HttpClient.request(:post, 'uploaddocs.api', options, digest_params)
+    end
+
+    # 上传合同模板
+    # 此接口与模板填充接口配合使用，接入方预先将制作好的 PDF 模板通过此接口上传到法大大，
+    # 后续如需要签署合同时只需要将需填充的内容通过合同生成接口传入，即可生成合同供签署操作，提高效率，
+    # 并可防止接入方自己生成的合同出现一些不兼容或文档签署异常等情况。
+    def self.upload_template(params = {})
+      options = params.slice(:template_id, :doc_url, :file)
+      digest_params = { _params: params.slice(:template_id) }
+      response = Fadada::HttpClient.request(:post, 'uploadtemplate.api', options, digest_params)
+    end
+
+    # 模板填充
+    # 将需填充的内容通过模板填充接口传入，即可生成合同供签署操作，提高效率，
+    # 并可防止接入方自己生成的合同出现一些不兼容或文档签署异常等情况。
+    def self.generate(params = {})
+      _basic = %i(template_id contract_id)
+      _extend = %i(parameter_map)
+      _normal = %i(doc_title font_size font_type dynamic_tables)
+      options = params.slice(*(_basic + _extend + _normal))
+      digest_params = { _params: params.slice(*_basic), _extend_params: params.slice(*_extend) }
+      response = Fadada::HttpClient.request(:post, 'generate_contract.api', options, digest_params)
+    end
+
+    # 自动签署合同
+    # 自动签接口不需要用户亲自操作，当接入平台调用此接口时，就会在指定的电子合同上签上指定用户的电子章，
+    # 省略了用户交互的步骤。因此如果需要使用此接口的能力， 需要接入平台联系法大大商务签署补充协议。
+    #
+    # 默认情况下只需要传入如下参数
+    # {
+    #   transaction_id: '',
+    #   contract_id: '',
+    #   doc_title: ''
+    # }
+    #
+    def self.auto_sign(params = {})
+      _options = {
+        customer_id: Fadada::config.customer_id, # 接入平台客户编号
+        client_role: '1', # 客户角色 1-接入平台
+        position_type: '0', # 定位类型 0-关键字(默认)
+        sign_keyword: Fadada::config.customer_name, # 定位关键字，默认按照接入平台方的名称定位
+        keyword_strategy: '2', # 关键字签章策略 2:最后一个关键字签章;
+      }
+      _basic = %i(customer_id)
+      _md5 = %i(transaction_id)
+      _normal = %i(contract_id client_role doc_title position_type sign_keyword keyword_strategy signature_positions notify_url)
+      options = _options.merge(params.slice(*(_basic + _md5 + _normal)))
+      digest_params = { _params: options.slice(*_basic), _md5_params: options.slice(*_md5) }
+      response = Fadada::HttpClient.request(:post, 'extsign_auto.api', options, digest_params)
+    end
+
+    # 手动签署合同
+    # 该接口为页面接口，接入方平台可以在合适的业务场景嵌入该接口链接，引导客户至法大大进行文档签署
+    # (比如可以在接入方平台网站上放置一个按钮，该按钮触发跳转至法大大或将法大大签章页面嵌入接入方流程)。
+    # 法大大根据浏览器 UA 信息，自动加载签 章界面对应的 PC web 版本或移动 HTML5 版本。
+    # 用户在法大大的签署页面中进行签署操作。
+    def self.sign(params = {})
+      _basic = %i(customer_id)
+      _md5 = %i(transaction_id)
+      _normal = %i(contract_id doc_title sign_keyword keyword_strategy return_url notify_url customer_mobile customer_name customer_ident_no)
+      options = params.slice(*(_basic + _md5 + _normal))
+      digest_params = { _params: params.slice(*_basic), _md5_params: params.slice(*_md5) }
+      response = Fadada::HttpClient.request(:get, 'extsign.api', options, digest_params)
+    end
+
+    # 合同查看
+    # 页面接口，返回签署页面，根据浏览器 UA 信息返回 pc 或 H5 页面.
+    def self.show(contract_id)
+      options = { contract_id: contract_id }
+      response = Fadada::HttpClient.request(:get, 'viewContract.api', options)
+    end
+
+    # 合同下载
+    # 通过合同编号下载文档(PDF 格式)，可通过 Content-Length 取文件大小。
+    # 正常时直接返回 PDF 文档(MIME:application/pdf)，异常时返回 JSON 报文
+    def self.download(contract_id)
+      options = { contract_id: contract_id }
+      response = Fadada::HttpClient.request(:get, 'downLoadContract.api', options)
+    end
+
+    # 合同归档
+    # 接入平台更新合同签署状态为-签署完成，法大大将把合同所有相关操作记录进行归档存证。
+    # 归档后将不能再对文档再进行签署操作。
+    def self.filing(contract_id)
+      options = { contract_id: contract_id }
+      response = Fadada::HttpClient.request(:post, 'contractFiling.api', options)
+    end
+  end
+end

data/lib/fadada/http_client.rb

@@ -0,0 +1,91 @@
+module Fadada
+  class HttpClient
+    class << self
+      # HTTP 请求
+      # digest_params 示例：
+      # {
+      #   _params: { a: 1, b: 2 },
+      #   _md5_params: { a: 1, b: 2 },
+      #   _extend_params: { a: 1, b: 2 }
+      # }
+      #
+      def request(method, action, params = {}, digest_params = nil)
+        _method = method.to_s.downcase
+        _digest_params = digest_params || { _params: params }
+        payload = build_basic_params(_digest_params).merge(params)
+        if _method == 'post'
+          response = HTTParty.post(
+            url(action),
+            body: payload,
+            header: form_header,
+            logger: Fadada::config.logger,
+            log_format: Fadada::config.logger_format
+          ).parsed_response
+          hander_exception(response)
+        else
+          "#{url(action)}?#{URI.encode_www_form(payload)}"
+        end
+      end
+
+      private
+
+      def url(action)
+        Fadada::config.server + action
+      end
+
+      # 处理参数
+      def params_transform(options)
+        _options = options || {}
+        _options.delete_if { |key, value| value.blank? }.sort.map { |k,v| v }.join
+      end
+
+      def form_header
+        { 'Content-Type' => 'application/x-www-form-urlencoded;charset=utf8' }
+      end
+
+      # 构建基础请求参数
+      def build_basic_params(options)
+        _timestamp = DateTime.now.strftime("%Y%m%d%H%M%S")
+        {
+          app_id: Fadada::config.app_id,
+          timestamp: _timestamp,
+          v: '2.0',
+          msg_digest: digest(_timestamp, options)
+        }
+      end
+
+      # 摘要计算
+      # Base64(SHA1(app_id + MD5(timestamp + 参数集合1) + SHA1(app_secret + 参数集合) + 参数集合2 ))
+      # 示例：
+      # options = {
+      #   _params: { a: 1, b: 2 },
+      #   _md5_params: { a: 1, b: 2 },
+      #   _extend_params: { a: 1, b: 2 }
+      # }
+      #
+      # params 需要排序后使用
+      #
+      def digest(timestamp, options = {})
+        _biz_data = Fadada::config.app_secret + params_transform(options[:_params])
+        _sha1_biz_data = Digest::SHA1.hexdigest(_biz_data).upcase
+        _md5 = Digest::MD5.hexdigest(params_transform(options[:_md5_params]) + timestamp).upcase
+        _extend = params_transform(options[:_extend_params])
+        _data = Digest::SHA1.hexdigest(::Fadada::config.app_id + _md5 + _sha1_biz_data + _extend).upcase
+        Base64.strict_encode64(_data)
+      end
+
+      # 处理异常
+      def hander_exception(response)
+        code = response['code'].to_s
+        return response if code == '1' || code == '1000'
+        message = response['msg']
+        if %w(0 1004).include?(code)
+          message = response['data'] || response['msg']
+        elsif code == '2'
+          message = '重复请求'
+        end
+        raise Fadada::ApiServiceException.new(code, message)
+      end
+    end
+  end
+end

data/lib/fadada/signature.rb

@@ -0,0 +1,44 @@
+# 法大大签章相关接口
+module Fadada
+  class Signature
+    # 签章上传
+    # 新增用户签章图片
+    #
+    #   customer_id => 客户编号
+    #   image => 签章图片地址或者base64图片数据
+    #   type => image 类型，base64 或者 path
+    #
+    #   返回签章图片ID
+    #
+    def self.upload(customer_id:, type: 'base64', image:)
+      options = {
+        customer_id: customer_id,
+        signature_img_base64: type == 'base64' ? image : image_to_base64(image)
+      }
+      response = Fadada::HttpClient.request(:post, 'add_signature.api', options)
+      response['data']
+    end
+
+    # 自定义印章
+    # 获取用户自定义签章图片
+    #
+    #   customer_id => 客户编号
+    #   content => 印章展示的内容，可以是企业名称或者客户名称
+    def self.custom(customer_id:, content:)
+      options = {
+        customer_id: customer_id,
+        content: content
+      }
+      response = Fadada::HttpClient.request(:post, 'custom_signature.api', options)
+      response['data']['signature_img_base64']
+    end
+
+    private
+
+    def self.image_to_base64(path)
+      File.open(path, 'rb') do |img|
+        Base64.strict_encode64(img.read)
+      end
+    end
+  end
+end

data/lib/fadada/version.rb

@@ -0,0 +1,3 @@
+module Fadada
+  VERSION = "0.1.0"
+end

data/lib/generators/fadada/install_generator.rb

@@ -0,0 +1,9 @@
+module Fadada
+  class InstallGenerator < Rails::Generators::Base
+    source_root File.expand_path('../templates', __FILE__)
+
+    def create_initializer_file
+      template 'initializer.rb', 'config/initializers/fadada.rb'
+    end
+  end
+end

data/lib/generators/fadada/templates/initializer.rb

@@ -0,0 +1,10 @@
+logger = Logger.new(STDOUT)
+Fadada.setup do |config|
+  config.server = "https://testapi.fadada.com:8443"
+  config.app_id = ""
+  config.app_secret = ""
+  config.customer_id = "" # 平台方客户编号
+  config.customer_name = "" # 平台方客户名称
+  config.logger = logger
+  config.logger_format = :curl
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: fadada
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- wangrui
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-06-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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'
+- !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: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.0
+description: 法大大实名认证电子合同Ruby SDK
+email:
+- 402399938@qq.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- fadada.gemspec
+- lib/examples/auth.rb
+- lib/examples/cert.rb
+- lib/examples/contract.rb
+- lib/examples/register.rb
+- lib/examples/sign.rb
+- lib/fadada.rb
+- lib/fadada/account.rb
+- lib/fadada/api_service_exception.rb
+- lib/fadada/authentication.rb
+- lib/fadada/certificate.rb
+- lib/fadada/configuration.rb
+- lib/fadada/contract.rb
+- lib/fadada/http_client.rb
+- lib/fadada/signature.rb
+- lib/fadada/version.rb
+- lib/generators/fadada/install_generator.rb
+- lib/generators/fadada/templates/initializer.rb
+homepage: https://github.com/wangrui438/fadada
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/wangrui438/fadada
+  source_code_uri: https://github.com/wangrui438/fadada
+  changelog_uri: https://github.com/wangrui438/fadada/blob/master/CHANGELOG.md
+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.7.9
+signing_key: 
+specification_version: 4
+summary: 法大大实名认证电子合同
+test_files: []