yunpian-captcha 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9f7bdd8215548f166170b031bff70fc47f69307b5be0ea26fef0127a7e90d2de
+  data.tar.gz: c601a9cce96a56685a18a516bd84df266804527412dd8f72d830780a0d33f7f5
+SHA512:
+  metadata.gz: e5aff6299b16c75c9e96edb1d5ade4b9f6c43923713e86a7d13dee000d35cd4734a7f18b0567f224230dcb8f1e9e28df670c1778971d97bab68495314646738c
+  data.tar.gz: 4a9edecefb116184d6ae31299539bfc1b27314af889c45de892cd377519fdada1078b920736dbb17a4e22e865501ac038fcef25d5984b680b3453c2b211445f4

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,4 @@
+--format documentation
+--color
+--require pry
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.5
+before_install: gem install bundler -v 2.0.2

data/Gemfile

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in yunpian-captcha.gemspec
+gemspec
+
+gem "pry", "~> 0.12.2"
+gem 'vcr', '~> 5.0'
+gem 'webmock', '~> 3.7', '>= 3.7.6'

data/Gemfile.lock

@@ -0,0 +1,55 @@
+PATH
+  remote: .
+  specs:
+    yunpian-captcha (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    coderay (1.1.2)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.3)
+    hashdiff (1.0.0)
+    method_source (0.9.2)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    public_suffix (4.0.1)
+    rake (10.5.0)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.0)
+      rspec-support (~> 3.9.0)
+    rspec-expectations (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.0)
+    safe_yaml (1.0.5)
+    vcr (5.0.0)
+    webmock (3.7.6)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  pry (~> 0.12.2)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  vcr (~> 5.0)
+  webmock (~> 3.7, >= 3.7.6)
+  yunpian-captcha!
+
+BUNDLED WITH
+   2.0.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 xiaohui
+
+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,56 @@
+# YunPian Captcha
+
+Ruby Client for YunPian.com Captcha service https://www.yunpian.com/doc/zh_CN/captcha/captcha_service.html
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'yunpian-captcha'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install yunpian-captcha
+
+## Usage
+
+```ruby
+# config/initializers/yunpian.rb
+Yunpian::Captcha.configure do |config|
+  config.app_id = ENV['YUNPIAN_CAPTCHA_APP_ID']
+  config.secret_id = ENV['YUNPIAN_CAPTCHA_SECRET_ID']
+  config.secret_key = ENV['YUNPIAN_CAPTCHA_SECRET_KEY']
+end
+
+# app/controllers/sessions_controller.rb
+
+def create
+  if Yunpian::Captcha.verify(params[:captcha_token], params[:captcha_authenticate])
+    # verify username/password
+    # sign_in!
+  else
+    flash[:alert] = 'invalid captcha'
+    render :new
+  end
+end
+```
+
+## 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/xiaohui-zhangxh/yunpian-captcha.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://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 "yunpian/captcha"
+
+# 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/exampes/index.html

@@ -0,0 +1,68 @@
+<html>
+
+<head>
+    <meta charset="utf-8">
+    <!--依赖-->
+    <script src="https://www.yunpian.com/static/official/js/libs/riddler-sdk-0.2.2.js"></script>
+    <script>
+        window.onload = function () {
+            // 初始化
+            new YpRiddler({
+                expired: 10,
+                mode: 'dialog',
+                winWidth: 500,
+                lang: 'zh-cn', // 界面语言, 目前支持: 中文简体 zh-cn, 英语 en
+                // langPack: LANG_OTHER, // 你可以通过该参数自定义语言包, 其优先级高于lang
+                container: document.getElementById('cbox'),
+                appId: '450c5c58b47f423d9eb0d2412760d20e',
+                version: 'v1',
+                onError: function (param) {
+                        if (!param.code) {
+                            console.error('错误请求');
+                        }
+                        else if (parseInt(param.code / 100) == 5) {
+                            // 服务不可用时，开发者可采取替代方案
+                            console.error('验证服务暂不可用');
+                        }
+                        else if (param.code == 429) {
+                            console.warn('请求过于频繁，请稍后再试');
+                        }
+                        else if (param.code == 403) {
+                            console.warn('请求受限，请稍后再试');
+                        }
+                        else if (param.code == 400) {
+                            console.warn('非法请求，请检查参数');
+                        }
+                    // 异常回调
+                    console.error('验证服务异常')
+                },
+                onSuccess: function (validInfo, close, useDefaultSuccess) {
+                    // 成功回调
+                    alert('验证通过! token=' + validInfo.token + ', authenticate=' + validInfo.authenticate)
+                    // 验证成功默认样式
+                    useDefaultSuccess(true)
+                    close()
+                },
+                onFail: function (code, msg, retry) {
+                    // 失败回调
+                    alert('出错啦：' + msg + ' code: ' + code)
+                    retry()
+                },
+                beforeStart: function (next) {
+                    console.log('验证马上开始')
+                    next()
+                },
+                onExit: function () {
+                    // 退出验证 （仅限dialog模式有效）
+                    console.log('退出验证')
+                }
+            })
+        }
+    </script>
+</head>
+
+<body>
+    <div id="cbox"></div>
+</body>
+
+</html>

data/lib/yunpian/captcha.rb

@@ -0,0 +1,22 @@
+require "yunpian/captcha/version"
+require 'yunpian/captcha/auth_service'
+module Yunpian
+  module Captcha
+    Configuration = Struct.new(:app_id, :secret_id, :secret_key, :exception_recorder, :logger)
+    API_URI = URI('https://captcha.yunpian.com/v1/api/authenticate')
+
+    class << self
+      def config
+        @config ||= Configuration.new
+      end
+
+      def configure
+        yield config
+      end
+
+      def verify(token, authenticate)
+        Yunpian::Captcha::AuthService.new(token, authenticate, config).call
+      end
+    end
+  end
+end

data/lib/yunpian/captcha/auth_service.rb

@@ -0,0 +1,73 @@
+require 'digest/md5'
+require 'net/http'
+require 'json'
+module Yunpian::Captcha
+  class AuthService
+    PARAMS = %w[captchaId token authenticate secretId version user timestamp nonce signature]
+
+    attr_reader :token, :authenticate, :config
+    def initialize(token, authenticate, config = Yunpian::Captcha.config)
+      @config, @token, @authenticate = config, token, authenticate
+    end
+
+    def call
+      log :debug, 'verifying'
+      signed_params = sign(build_params)
+      valid?(signed_params)
+    end
+
+    private
+
+    def valid?(signed_params)
+      log :debug, "signed params is #{signed_params}"
+      resp = Net::HTTP.post_form(API_URI, signed_params)
+      log :debug, "API response => #{resp.body}"
+      result = JSON.parse(resp.body) rescue nil
+      return true if result && result['code'].zero?
+
+      record_exception!(result)
+      false
+    end
+
+    def sign(params)
+      params.tap do |p|
+        p[:signature] = signature(params)
+      end
+    end
+
+    def signature(params)
+      str = params.sort.inject("") { |ret, kv| ret << kv.join }
+      str << config.secret_key
+      Digest::MD5.hexdigest(str)
+    end
+
+    def build_params
+      {
+        captchaId: config.app_id,
+        token: token,
+        authenticate: authenticate,
+        secretId: config.secret_id,
+        version: '1.0',
+        timestamp: (Time.now.to_f * 1000).to_i,
+        nonce: rand(1..99_999)
+      }
+    end
+
+    def log(type, message)
+      return unless logger
+
+      logger.send type,
+                  "[YunPian Captcha][token=#{token}, " \
+                  "authenticate=#{authenticate}] " \
+                  "#{message}"
+    end
+
+    def logger
+      @logger ||= config.logger
+    end
+
+    def record_exception!(result)
+      config.exception_recorder&.call(result)
+    end
+  end
+end

data/lib/yunpian/captcha/version.rb

@@ -0,0 +1,5 @@
+module Yunpian
+  module Captcha
+    VERSION = "0.1.0"
+  end
+end

data/yunpian-captcha.gemspec

@@ -0,0 +1,31 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "yunpian/captcha/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "yunpian-captcha"
+  spec.version       = Yunpian::Captcha::VERSION
+  spec.authors       = ["xiaohui"]
+  spec.email         = ["xiaohui@tanmer.com"]
+
+  spec.summary       = %q{Captcha from YunPian.com}
+  spec.description   = %q{Captcha Client for YunPian.com}
+  spec.homepage      = "https://github.com/xiaohui-zhangxh/yunpian-captcha"
+  spec.license       = "MIT"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+
+  # 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 "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: yunpian-captcha
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- xiaohui
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-11-20 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: 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'
+description: Captcha Client for YunPian.com
+email:
+- xiaohui@tanmer.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exampes/index.html
+- lib/yunpian/captcha.rb
+- lib/yunpian/captcha/auth_service.rb
+- lib/yunpian/captcha/version.rb
+- yunpian-captcha.gemspec
+homepage: https://github.com/xiaohui-zhangxh/yunpian-captcha
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/xiaohui-zhangxh/yunpian-captcha
+  source_code_uri: https://github.com/xiaohui-zhangxh/yunpian-captcha
+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: []
+rubygems_version: 3.0.6
+signing_key: 
+specification_version: 4
+summary: Captcha from YunPian.com
+test_files: []