omniauth-yoyow 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b73dc35a0c92976a77405764c899008245214aac
+  data.tar.gz: b59e04416549020f2485150abc8a4aa7e05d28f2
+SHA512:
+  metadata.gz: f629c323627c61fa51687e5c0a7948da2a5be83c44acacc0bfd65f657de514dd845fe7be1d26da7401860b19e3f37eb4859b69634b9e24818cacd2f1f1433359
+  data.tar.gz: f958242347355307df26ca269febc008658552ff525f986044dbceedfbc5b305dac867c142c16d942f6a83e2615a70f99900b425b049df53b4780bf3e25778f3

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in omniauth-yoyow.gemspec
+gemspec

data/README.cn.md

@@ -0,0 +1,85 @@
+# OmniAuth YOYOW
+
+[中文](./README.cn.md) [En](./README.md)
+
+这是官方的OmniAuth YOYOW认证策略, 借助YOYOW的平台授权机制以实现账户授权认证. 在使用之前, 你需要一个平台账户[(如何成为平台)](https://github.com/yoyow-org/yoyow-node-sdk/tree/master/middleware#2-%E5%88%9B%E5%BB%BA%E5%B9%B3%E5%8F%B0), 并架设[YOYOW中间件服务](#架设中间件服务).
+
+## 安装
+
+在应用的Gemfile中添加:
+
+```ruby
+gem 'omniauth-yoyow'
+```
+
+然后执行:
+
+    $ bundle
+
+或者手动安装:
+
+    $ gem install omniauth-yoyow
+
+## 用法
+
+将下方URL修改为YOYOW中间件的服务地址:
+
+```ruby
+use OmniAuth::Builder do
+  provider :yoyow, 'http://localhost:3000'
+end
+```
+
+## 架设中间件服务
+
+将中间件代码clone到本地:
+
+```bash
+git clone https://github.com/yoyow-org/yoyow-node-sdk/tree/master/middleware
+cd middleware
+vim conf/config.js
+```
+
+在项目开发阶段, 可以借助YOYOW测试网进行测试, 待测试完成后再切换到正式网络.
+
+测试网的配置示例如下:
+
+```javascript
+module.exports = {
+    // yoyow全节点api服务器地址(测试网)
+    apiServer: "ws://47.52.155.181:10011",
+    // 请求有效时间，单位s
+    secure_ageing: 120,
+    // 平台安全请求验证key 由平台自定义
+    secure_key: "",
+    // 平台所有者active私钥(可选)
+    active_key: "",
+    // 平台所有者零钱私钥(必需)
+    secondary_key: "",
+    // 平台所有者备注私钥(可选)
+    memo_key: "",
+    // 平台id(yoyow id)
+    platform_id: "",
+    // 转账是否使用积分
+    use_csaf: true,
+    // 转账是否转到余额 否则转到零钱
+    to_balance: false,
+    // 钱包授权页URL
+    wallet_url: "http://demo.yoyow.org:8000/#/authorize-service",
+    // 允许接入的IP列表
+    allow_ip: ["localhost", "127.0.0.1"]
+};
+```
+
+正式网配置示例:
+```javascript
+module.exports = {
+    // yoyow全节点api服务器地址(正式网)
+    apiServer: "wss://wallet.yoyow.org/ws",
+    ...
+    // 钱包授权页URL
+    wallet_url: "http://wallet.yoyow.org/#/authorize-service",
+    // 允许接入的IP列表
+    allow_ip: ["localhost", "127.0.0.1"]
+};
+```

data/README.md

@@ -0,0 +1,87 @@
+# Omniauth YOYOW
+
+[中文](./README.cn.md) [En](./README.md)
+
+This is the official OmniAuth strategy for authenticating to YOYOW. To use it, a **platform** account is needed([what's platform](https://github.com/yoyow-org/yoyow-node-sdk/blob/master/middleware/README-EN.md#25-update-platform)), addtionally, you'll need to setup [yoyow-middleware](#setup-yoyow-middleware).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'omniauth-yoyow'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install omniauth-yoyow
+
+## Usage
+
+Change the url to yoyow-middleware server address in following code. 
+
+```ruby
+use OmniAuth::Builder do
+  provider :yoyow, 'http://localhost:3000'
+end
+```
+
+
+## Setup YOYOW Middleware
+
+Clone the middleware code:
+
+```bash
+git clone https://github.com/yoyow-org/yoyow-node-sdk/tree/master/middleware
+cd middleware
+vim conf/config.js
+```
+
+YOYOW test-net configuration is recommended while developing your applaction, you can switch it to main-net when production ready.
+
+Sample config for test-net:
+
+```javascript
+module.exports = {
+    // yoyow full node api(test-net)
+    apiServer: "ws://47.52.155.181:10011",
+    // seconds before requests invaild
+    secure_ageing: 120,
+    // platform specified secure key
+    secure_key: "",
+    // active key of platform(optional)
+    active_key: "",
+    // secondary key of platform(required)
+    secondary_key: "",
+    // memo key of platform(optional)
+    memo_key: "",
+    // platform id(yoyow id)
+    platform_id: "",
+    // choose to use csaf when transfer token
+    use_csaf: true,
+    // transfer token to balance, otherwise to Tipping
+    to_balance: false,
+    // authorization URL
+    wallet_url: "http://demo.yoyow.org:8000/#/authorize-service",
+    // IP list allowed to access
+    allow_ip: ["localhost", "127.0.0.1"]
+};
+```
+
+Sample config for main-net:
+
+```javascript
+module.exports = {
+    // yoyow full node api(main-net)
+    apiServer: "wss://wallet.yoyow.org/ws",
+    ...
+    // authorization URL
+    wallet_url: "http://wallet.yoyow.org/#/authorize-service",
+    // IP list allowed to access
+    allow_ip: ["localhost", "127.0.0.1"]
+};
+```

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 "omniauth/yoyow"
+
+# 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/lib/omniauth-yoyow.rb

@@ -0,0 +1,3 @@
+require "omniauth-yoyow/version"
+require "omniauth/yoyow-middleware"
+require "omniauth/strategies/yoyow"

data/lib/omniauth-yoyow/version.rb

@@ -0,0 +1,5 @@
+module Omniauth
+  module Yoyow
+    VERSION = "0.1.0"
+  end
+end

data/lib/omniauth/strategies/yoyow.rb

@@ -0,0 +1,53 @@
+module OmniAuth
+  module Strategies
+    class Yoyow
+      include OmniAuth::Strategy
+      class CallbackError < StandardError; end
+      args %i[auth_server]
+
+      option :auth_server, "http://localhost:3000"
+
+      # yoyow middleware
+      def middleware
+        @middleware ||= OmniAuth::YoyowMiddleware.new(options.auth_server)
+      end
+
+      def request_phase
+        redirect auth_url
+      end
+
+      def auth_url
+        middleware.get_auth_url(callback_url)
+      end
+
+      def callback_url
+        full_host + script_name + callback_path
+      end
+
+      def callback_phase
+        yyw_id = request.params["yoyow"]
+        time   = request.params["time"]
+        sign   = request.params["sign"]
+        if ! middleware.verify_auth(yyw_id, time, sign)
+          raise CallbackError.new("invalid credential found.")
+        end
+
+        super
+      rescue CallbackError => e
+        fail!(:invalid_credential, e)
+      end
+
+      uid do
+        request.params["yoyow"]
+      end
+
+      info do
+        account = middleware.get_account(uid)
+        {
+          name:     account[:name],
+          nickname: account[:name],
+        }
+      end
+    end
+  end
+end

data/lib/omniauth/yoyow-middleware.rb

@@ -0,0 +1,56 @@
+require 'uri'
+require 'multi_json'
+require 'faraday'
+
+module OmniAuth
+  class YoyowMiddleware
+    attr_reader :resource
+
+    class MiddlewareRequestError < StandardError; end
+    
+    def initialize(url)
+      unless url.start_with?('http')
+        url = 'http://' + url
+      end
+      @resource = Faraday.new(url)
+    end
+
+    def get_auth_url(callback_url)
+      resp      = get_platform_sign
+      auth_data = resp.slice(:sign, :time, :platform).merge({state: callback_url})
+      auth_url  = [resp[:url], '?', URI.encode_www_form(auth_data)].join('')
+    end
+
+    def get_account(uid)
+      _get '/api/v1/getAccount', uid: uid
+    end
+
+    def get_platform_sign
+      _get '/auth/sign'
+    end
+
+    def verify_auth(yyw_id, time, sign)
+      return false if yyw_id.nil? or time.nil? or sign.nil?
+
+      data = _get('/auth/verify', {
+        yoyow: yyw_id,
+        time:  time,
+        sign:  sign
+      })
+      data[:verify]
+    end
+
+    def _get(url, params={})
+      begin
+        resp = resource.get url, params
+        json = MultiJson.load resp.body, :symbolize_keys => true
+        raise MiddlewareRequestError.new(json[:message]) if json[:code] != 0
+        json[:data]
+      rescue MiddlewareRequestError => e
+        puts "Error occurs while accessing yoyow middleware: "
+        puts e.message
+        raise e
+      end
+    end
+  end
+end

data/omniauth-yoyow.gemspec

@@ -0,0 +1,30 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "omniauth-yoyow/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "omniauth-yoyow"
+  spec.version       = Omniauth::Yoyow::VERSION
+  spec.licenses      = ['MIT']
+  spec.authors       = ["Bin Chen"]
+  spec.email         = ["fengzhishuiwo@163.com"]
+
+  spec.summary       = %q{Official OmniAuth strategy for yoyow.}
+  spec.description   = %q{Official OmniAuth strategy for yoyow.}
+  spec.homepage      = "https://coding.net/u/vianull/p/omniauth-yoyow/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", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  
+  spec.add_dependency 'omniauth', '~> 1.5'
+  spec.add_dependency "multi_json"
+  spec.add_dependency "faraday"
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-yoyow
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Bin Chen
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-10-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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: omniauth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  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: faraday
+  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'
+description: Official OmniAuth strategy for yoyow.
+email:
+- fengzhishuiwo@163.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- README.cn.md
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/omniauth-yoyow.rb
+- lib/omniauth-yoyow/version.rb
+- lib/omniauth/strategies/yoyow.rb
+- lib/omniauth/yoyow-middleware.rb
+- omniauth-yoyow.gemspec
+homepage: https://coding.net/u/vianull/p/omniauth-yoyow/git
+licenses:
+- MIT
+metadata: {}
+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.6.11
+signing_key: 
+specification_version: 4
+summary: Official OmniAuth strategy for yoyow.
+test_files: []