zzlink 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f41c9374bca1241a2fa77652a9e16e368af538d0801d74b83d3e8babe1851309
+  data.tar.gz: '09ee73adeab6018d730a6744846f6a665cfa53e5a8d931114f7677ed8509fdf7'
+SHA512:
+  metadata.gz: '0591c8a12ca2f75e4901102465ecdcf34194a8636968c70326a13976d44fd803d22e45a47549fd7a60e5569f846dcfd368519508cd882cd34fdc5683155360a0'
+  data.tar.gz: e77933c97c4d21c85e7a59f174de1bf038cddf27dc1ae284da79f7eb19b8cd0756c5175d7a3bf5a1f19f2c0864726b96638176b2c8bebea1f16ececa1df9662d

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.0
+before_install: gem install bundler -v 2.1.4

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in zzlink.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+gem "minitest", "~> 5.0"

data/Gemfile.lock

@@ -0,0 +1,21 @@
+PATH
+  remote: .
+  specs:
+    zzlink (0.0.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    minitest (5.14.0)
+    rake (13.0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  minitest (~> 5.0)
+  rake (~> 13.0)
+  zzlink!
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Wu Zixing
+
+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,38 @@
+# Zzlink
+
+The ruby client of zzLink API. 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'zzlink'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install zzlink
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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://gitlab.com/zzlink/zzlink-ruby.
+
+
+## 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,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "zzlink"
+
+# 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/zzlink.rb

@@ -0,0 +1,26 @@
+require_relative 'zzlink/version'
+require_relative 'zzlink/users'
+require_relative 'zzlink/env'
+require_relative 'zzlink/auth'
+
+module Zzlink
+  class << self
+    # Get client of user service.
+    # @return [Zzlink::Users] client of zzUsers service.
+    def users
+      Zzlink::Users.instance
+    end
+
+    # Get client of Env service.
+    # @return [Zzlink::Env] client of zzEnv service.
+    def env
+      Zzlink::Env.instance
+    end
+
+    # Get helper of SSO service.
+    # @return [Zzlink::Auth] helper of SSO service.
+    def auth
+      Zzlink::Auth.instance
+    end
+  end
+end

data/lib/zzlink/auth.rb

@@ -0,0 +1,83 @@
+require 'singleton'
+require_relative 'service'
+require_relative 'session'
+
+module Zzlink
+  # Helpers of visiting SSO service.
+  class Auth < Service
+    include Singleton
+
+    # Get login URL for the local redirect URL.
+    # @param redirect_url [String]
+    # @param client_id [String] client identification. Default is a web APP.
+    # @param ttl [Integer] TTL (in seconds) of the login procedure.
+    # @return [String] login URL of SSO.
+    def url_of_login(redirect_url, client_id = 'web', ttl = 600)
+      query = URI.encode_www_form(redirect_url: redirect_url, zt: zzlink_ticket(ttl), zc: client_id)
+      sso_url + '/login?' + query
+    end
+
+    # Get login URL of Github for the local redirect URL.
+    # @param redirect_url [String]
+    # @param client_id [String] client identification. Default is a web APP.
+    # @param ttl [Integer] TTL (in seconds) of the login procedure.
+    # @return [String] login URL of SSO.
+    def url_of_login_as_github(redirect_url, client_id = 'web', ttl = 600)
+      query = URI.encode_www_form(redirect_url: redirect_url, zt: zzlink_ticket(ttl), zc: client_id)
+      sso_url + '/oauth/github?' + query
+    end
+
+    # Check in with a ticket.
+    # @param ticket [String] the SSO ticket.
+    # @return [Session] a session object if there is a valid session.
+    # @raise if check-in failed.
+    def check_in_with_ticket(ticket)
+      check_in(ticket: ticket)
+    end
+
+    # Check in with a token.
+    # @param token [String] the user token.
+    # @return [Session] a session object if there is a valid session.
+    # @raise if check-in failed.
+    def check_in_with_user_token(token)
+      check_in(user_token: token)
+    end
+
+    # Get logout URL for the local redirect URL.
+    # @param redirect_url [String]
+    # @param ttl [Integer] TTL (in seconds) of the login procedure.
+    # @return [String] logout URL of SSO.
+    def url_of_logout(redirect_url, ttl = 60)
+      query = URI.encode_www_form(redirect_url: redirect_url, zt: zzlink_ticket(ttl))
+      sso_url + '/logout?' + query
+    end
+
+    private
+
+    def sso_url
+      Zzlink.env.get_env('sso_url')
+    end
+
+    def zzlink_ticket(ttl)
+      Zzlink.env.new_ticket(ttl)
+    end
+
+    # Check session status with ticket or user token.
+    # @param param [Hash] {ticket: 'xxxx'} or {user_token: 'xxxx'}.
+    # @return [Session] a session object in case of that a session is alive.
+    # @raise if check-in failed.
+    def check_in(param)
+      query = URI.encode_www_form(param)
+      uri = URI(sso_url + '/checkin?' + query)
+      resp = Net::HTTP.start(uri.host, uri.port, nil, nil, nil, nil, uss_ssl: uri.scheme == 'https') do |http|
+        req = Net::HTTP::Put.new(uri.request_uri)
+        set_request_headers(req)
+        req['Content-Type'] = 'application/json'
+        req.body = param.to_json
+        http.request(req)
+      end
+      value = check_and_return(resp)
+      Session.new(value)
+    end
+  end
+end

data/lib/zzlink/client.rb

@@ -0,0 +1,118 @@
+require 'base64'
+require 'openssl'
+require 'net/http'
+require 'json'
+
+module Zzlink
+  # Error.
+  class Error < StandardError
+    def initialize(code, error)
+      super("#{code}: #{error}")
+    end
+  end
+
+  # The HTTP client.
+  module Client
+    class << self
+      attr_accessor :access_key, :secret_key, :api_url
+    end
+
+    # Do a GET request.
+    def get(path, query_params = {})
+      uri = uri_of(path, query_params)
+      resp = Net::HTTP.start(uri.host, uri.port, nil, nil, nil, nil, use_ssl: (uri.scheme == 'https')) do |http|
+        req = Net::HTTP::Get.new(uri.request_uri)
+        set_request_headers(req)
+        http.request(req)
+      end
+      check_and_return(resp)
+    end
+
+    def post(path, data = {})
+      uri = uri_of(path)
+      resp = Net::HTTP.start(uri.host, uri.port, nil, nil, nil, nil, use_ssl: (uri.scheme == 'https')) do |http|
+        req = Net::HTTP::Post.new(uri.request_uri)
+        set_request_headers(req)
+        unless data.empty?
+          req['Content-Type'] = 'application/json'
+          req.body = data.to_json
+        end
+        http.request(req)
+      end
+      check_and_return(resp)
+    end
+
+    def put(path, data = {})
+      uri = uri_of(path)
+      resp = Net::HTTP.start(uri.host, uri.port, nil, nil, nil, nil, use_ssl: (uri.scheme == 'https')) do |http|
+        req = Net::HTTP::Put.new(uri.request_uri)
+        set_request_headers(req)
+        unless data.empty?
+          req['Content-Type'] = 'application/json'
+          req.body = data.to_json
+        end
+        http.request(req)
+      end
+      check_and_return(resp)
+    end
+
+    def delete(path, query_params = {})
+      uri = uri_of(path, query_params)
+      resp = Net::HTTP.start(uri.host, uri.port, nil, nil, nil, nil, use_ssl: (uri.scheme == 'https')) do |http|
+        req = Net::HTTP::Delete.new(uri.request_uri)
+        set_request_headers(req)
+        http.request(req)
+      end
+      check_and_return(resp)
+    end
+
+    private
+
+    # Make URI object from request path and query parameters.
+    # @param path [String] request path (without scheme, host and port).
+    # @param query_params [Hash] optional query parameters.
+    # @return the URI object.
+    def uri_of(path, query_params = {})
+      url = Client.api_url + path
+      if query_params.empty?
+        URI(url)
+      else
+        queries = URI.encode_www_form(query_params)
+        url.include?('?') ? URI(url + '&' + queries) : URI(url + '?' + queries)
+      end
+    end
+
+    # Set headers for the HTTP request.
+    # @param request [HttpRequest] the request object.
+    def set_request_headers(request)
+      host = self.name + '.' + self.version
+      date = Time.now().gmtime.strftime('%a, %d %b %Y %H:%M:%S %Z')
+      signing_string = "host: #{host}\n#{request.method} #{request.path} HTTP/1.1\ndate: #{date}"
+      signature = Base64.strict_encode64(OpenSSL::HMAC.digest("SHA256", Client.secret_key, signing_string))
+      request['Accept'] = 'application/json'
+      request['Host'] = host
+      request['Date'] = date
+      request['Authorization'] = "hmac username=\"#{Client.access_key}\", algorithm=\"hmac-sha256\", headers=\"host request-line date\", signature=\"#{signature}\""
+    end
+
+    def check_and_return(response)
+      if response.is_a?(Net::HTTPSuccess)
+        response.body
+      else
+        raise Error.new(response.code, response.body)
+      end
+    end
+  end
+
+  class << self
+    # Initialize the ZzLink client.
+    # @param access_key [String] developer's access key.
+    # @param secret_key [String] developer's secret key.
+    # @param api_url [String] URL of zzLink API service. Default to 'https://api.zhizhi.link'.
+    def init(access_key, secret_key, api_url = nil)
+      Client.access_key = access_key
+      Client.secret_key = secret_key
+      Client.api_url = (api_url.nil? || api_url.empty?) ? 'https://api.zhizhi.link' : api_url.delete_suffix('/')
+    end
+  end
+end

data/lib/zzlink/env.rb

@@ -0,0 +1,44 @@
+require_relative 'service'
+require 'singleton'
+
+module Zzlink
+  # Client of zzEnv service.
+  class Env < Service
+    include Singleton
+
+    def name
+      'zzEnv'
+    end
+
+    def version
+      'v1.0'
+    end
+
+    # Get a environment variable's value.
+    # @param name [String] name of the environment variable.
+    # @return [String] value of the variable.
+    def get_env(name)
+      resp = get("/env/#{name}")
+      resp = JSON.parse(resp)
+      resp[name]
+    end
+
+    # Get a zzLink ticket.
+    # @param ttl_in_sec [Integer] TTL (in seconds) of the new ticket.
+    # @return [String] a ticket which is URL-safe encoded.
+    def new_ticket(ttl_in_sec = 60)
+      resp = get('/ticket', ttl: ttl_in_sec)
+      resp = JSON.parse(resp)
+      resp['ticket']
+    end
+
+    # Check a zzLink ticket.
+    # @param ticket [String] the string representation of the ticket.
+    # @return [Boolean] whether the ticket is valid.
+    def check_ticket(ticket)
+      resp = put('/ticket', ticket: ticket);
+      resp = JSON.parse(resp)
+      resp['status']
+    end
+  end
+end

data/lib/zzlink/service.rb

@@ -0,0 +1,8 @@
+require_relative 'client'
+module Zzlink
+  # Base class of zzLink service.
+  class Service
+    include Client
+    attr_accessor :name, :version
+  end
+end

data/lib/zzlink/session.rb

@@ -0,0 +1,32 @@
+module Zzlink
+  # User session.
+  class Session
+    attr_accessor :token, :user_id, :client_id, :created_at, :updated_at
+    def initialize(attributes = {})
+      from_hash(attributes)
+    end
+
+    def from_hash(attributes)
+      attributes.each_key do |k|
+        setter = case k.to_sym
+                 when :userId then :user_id=
+                 when :clientId then :client_id=
+                 when :createdAt then :created_at=
+                 when :updatedAt then :updated_at=
+                 else "#{k}=".to_sym
+                 end
+        send(setter, attributes[k]) if respond_to?(setter)
+      end
+    end
+
+    def to_hash
+      hash = {}
+      hash[:userId] = user_id unless user_id.nil?
+      hash[:clientId] = client_id unless client_id.nil?
+      hash[:token] = token unless token.nil?
+      hash[:createdAt] = created_at unless created_at.nil?
+      hash[:updatedAt] = updated_at unless updated_at.nil?
+      hash
+    end
+  end
+end

data/lib/zzlink/users.rb

@@ -0,0 +1,114 @@
+require 'singleton'
+require_relative 'service'
+require_relative 'session'
+
+module Zzlink
+  # A zzLink user.
+  class User
+    attr_accessor :id, :name, :avatar_url, :home_url, :email
+    attr_accessor :access_token, :token_type, :oauth_scope, :oauth_id, :oauth_provider
+    attr_accessor :created_at, :updated_at
+
+    # New a User object.
+    # @param attributes [Hash] attributes of the new user.
+    def initialize(attributes = {})
+      from_hash(attributes)
+    end
+
+    # Assign attributes from a Hash.
+    # @param attributes [Hash] attributes.
+    def from_hash(attributes)
+      attributes.each_pair do |k, v|
+        setter = case k.to_sym
+                 when :avatarURL then :avatar_url=
+                 when :homeURL then :home_url=
+                 when :accessToken then :access_token=
+                 when :tokenType then :token_type=
+                 when :oauthScope then :oauth_scope=
+                 when :oauthId then :oauth_id=
+                 when :oauthProvider then :oauth_provider=
+                 when :createdAt then :created_at=
+                 when :updatedAt then :created_at=
+                 else "#{k}=".to_sym
+                 end
+        send(setter, v) if respond_to?(setter)
+      end
+    end
+
+    def to_hash
+      hash = {}
+      hash['id'] = id unless id.nil?
+      hash['name'] = name unless name.nil?
+      hash['avatarURL'] = avatar_url unless avatar_url.nil?
+      hash['homeURL'] = home_url unless home_url.nil?
+      hash['email'] = email unless email.nil?
+      hash['accessToken'] = access_token unless access_token.nil?
+      hash['tokenType'] = token_type unless token_type.nil?
+      hash['oauthScope'] = oauth_scope unless oauth_scope.nil?
+      hash['oauthId'] = oauth_id unless oauth_id.nil?
+      hash['oauthProvider'] = oauth_provider unless oauth_provider.nil?
+      hash['createdAt'] = created_at unless created_at.nil?
+      hash['updatedAt'] = updated_at unless updated_at.nil?
+      hash
+    end
+  end
+
+  # The zzUser service.
+  class Users < Service
+    include Singleton
+
+    def name
+      'zzUsers'
+    end
+
+    def version
+      'v1.0'
+    end
+
+    # Create a user. If :oauth_provider and :oauth_id already exist, the existing user will be updated.
+    # @param attributes [Hash] attributes of the new user.
+    # @return [User] the created user.
+    # @raise [Error] in case of failure.
+    def create_user(attributes)
+      user = User.new(attributes)
+      resp = post('/users', user.to_hash)
+      user.from_hash(JSON.parse(resp))
+      user
+    end
+
+    # Create or reset a session.
+    # @param attributes [Hash] attributes of the new session. If the combination of user_id and client_id confilicts, the existing session will be reset.
+    # @return [Session] the created or updated session.
+    # @raise [Error] in case of failure.
+    def create_session(attributes)
+      session = Session.new(attributes)
+      resp = post('/sessions', session.to_hash)
+      session.from_hash(JSON.parse(resp))
+      session
+    end
+
+    # Find a session by its token.
+    # @param token [String] the token.
+    # @return [Session, nil] the found session or nil.
+    def find_session_by_token(token)
+      begin
+        resp = get("/sessions/#{token}")
+        Session.new(JSON.parse(resp))
+      rescue
+        nil
+      end
+    end
+
+    # Delete a session by its token.
+    # @param token [String] the token.
+    # @return [Boolean] the found session or nil.
+    def delete_session_by_token(token)
+      begin
+        delete("/sessions/#{token}")
+        true
+      rescue
+        false
+      end
+    end
+  end
+end

data/lib/zzlink/version.rb

@@ -0,0 +1,3 @@
+module Zzlink
+  VERSION = '0.0.2'
+end

data/zzlink.gemspec

@@ -0,0 +1,25 @@
+require_relative 'lib/zzlink/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "zzlink"
+  spec.version       = Zzlink::VERSION
+  spec.authors       = ["Wu Zixing"]
+  spec.email         = ["wzixing@gmail.com"]
+
+  spec.summary       = %q{Ruby client of zzLink API.}
+  spec.homepage      = "https://gitlab.com/zzlink/zzlink-ruby"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://gitlab.com/zzlink/zzlink-ruby.git"
+
+  # 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"]
+end

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification
+name: zzlink
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Wu Zixing
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-03-12 00:00:00.000000000 Z
+dependencies: []
+description: 
+email:
+- wzixing@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/zzlink.rb
+- lib/zzlink/auth.rb
+- lib/zzlink/client.rb
+- lib/zzlink/env.rb
+- lib/zzlink/service.rb
+- lib/zzlink/session.rb
+- lib/zzlink/users.rb
+- lib/zzlink/version.rb
+- zzlink.gemspec
+homepage: https://gitlab.com/zzlink/zzlink-ruby
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://gitlab.com/zzlink/zzlink-ruby
+  source_code_uri: https://gitlab.com/zzlink/zzlink-ruby.git
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Ruby client of zzLink API.
+test_files: []