yxt-api 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2ef7748d9a245112f17132cc8cd3a825c616dd840085236a6e4537dec92bab68
+  data.tar.gz: 5a747af6aed46fc9c49e02926367c9c18167e91e017ad68a0d14c8edd2492edc
+SHA512:
+  metadata.gz: 193cc98a0a1a6067ccd669beb8ce939fc053ec78eab73b388e5ee566a7137828b236a2c809783a567eb692cfe8658a5dbb025ec8b33e4b3231efb263d28ba59d
+  data.tar.gz: fdeb76a0c97756c6133b251c1d7544188855aab184851715a727e28ebf281528ebc6e5edaf29c0172fbe962faf8f5e28b33cf6fed2c5c460e71eeabe185cecb3

data/.gitignore

@@ -0,0 +1,14 @@
+/.idea
+.DS_Store
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.sublime-workspace
+spec/examples.txt
+.byebug_history

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Eric-Guo @ Tianhua Architectural Design Co., Ltd
+
+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,44 @@
+yxt-api [![Gem Version][version-badge]][rubygems]
+=======
+
+An unofficial 云学堂 http://www.yxt.com/ API wrap gem.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'yxt-api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install yxt-api
+
+## Usage
+
+### Config
+
+Create `config/initializers/yxt-api.rb` and put following configurations into your Rails project.
+
+```ruby
+Yxt.apikey     = 'your_api_key'
+Yxt.secretkey  = 'your_secret_key'
+Yxt.base_url  = 'http://api.yunxuetang.com.cn' # notice no / at end
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/thape-cn/yxt-api. 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).
+
+
+[version-badge]: https://badge.fury.io/rb/yxt-api.svg

data/lib/yxt-api.rb

@@ -0,0 +1,58 @@
+require 'http'
+require 'json'
+require 'digest'
+require 'yxt-api/organization_unit'
+require 'yxt-api/position'
+require 'yxt-api/user'
+require 'yxt-api/version'
+
+module Yxt
+  class YxtAPI_Error < RuntimeError; end
+
+  class << self
+    attr_accessor :apikey
+    attr_accessor :secretkey
+
+    attr_accessor :base_url
+  end
+
+  # Make an HTTP request with the given verb to YXT API server
+  # @param resource [String]
+  # @option options [Hash]
+  # @return [HTTP::Response]
+  def self.request(resource, options = {})
+    @http ||= HTTP.persistent @base_url
+
+    json_params = with_signature(options)
+
+    res = @http.post("#{base_url}/#{resource}", json: json_params)
+
+    case res.code
+    when 40101
+      raise YxtAPI_Error, '授权码签名无效！'
+    when 50001
+      raise YxtAPI_Error, '未授权该API！'
+    when 50002
+      raise YxtAPI_Error, 'API 功能未授权！'
+    when 60100
+      raise YxtAPI_Error, '服务内部错误！'
+    when 60101
+      raise YxtAPI_Error, '业务处理错误！'
+    end
+
+    res
+  end
+
+  private_class_method
+
+  def self.with_signature(options = {})
+    salt = SecureRandom.hex(4) # like "301bccce"
+    signature = Digest::SHA256.hexdigest("#{secretkey}#{salt}")
+
+    {
+      apikey: apikey,
+      salt: salt,
+      signature: signature
+    }.merge options
+  end
+end

data/lib/yxt-api/organization_unit.rb

@@ -0,0 +1,21 @@
+module Yxt
+  def self.sync_ous(ous_hash, isBaseInfo: false)
+    request 'el/sync/ous', isBaseInfo: isBaseInfo, ouInfo: ous_hash.to_json.to_s
+  end
+
+  def self.delete_ous(ou_code_or_third_system_ids)
+    request 'el/sync/deleteous', OuCodeOrThirdSystemID: ou_code_or_third_system_ids.to_json.to_s
+  end
+
+  def self.remove_user_from_all_ous(user_names)
+    request 'el/sync/removeusersfromou', userNames: user_names.to_json.to_s
+  end
+
+  def self.batch_change_org_ou(new_ou_id, user_names)
+    request 'el/sync/batchchangeorgou', newOuID: new_ou_id, userNames: user_names.to_json.to_s
+  end
+
+  def self.get_ou_code_by_ou_name(ou_name, islink: true)
+    request 'el/sync/getoucodebyouname', islink: islink, ouname: ou_name
+  end
+end

data/lib/yxt-api/position.rb

@@ -0,0 +1,13 @@
+module Yxt
+  def self.sync_position(position_hash)
+    request 'el/sync/position', positionInfo: position_hash.to_json.to_s
+  end
+
+  def self.sync_position_for_no_pno(position_hash)
+    request 'el/sync/positionfornopno', positionInfo: position_hash.to_json.to_s
+  end
+
+  def self.update_position_name(position_no, position_name)
+    request 'el/sync/updatepositioninfo', positionNo: position_no, positionName: position_name
+  end
+end

data/lib/yxt-api/user.rb

@@ -0,0 +1,21 @@
+module Yxt
+  def self.sync_users(users_hash, islink: true)
+    request 'el/sync/users', islink: islink, users: users_hash.to_json.to_s
+  end
+
+  def self.disable_users(user_names, isClearEmailAndMobile: false)
+    request 'el/sync/disabledusers', userNames: user_names.to_json.to_s, isClearEmailAndMobile: isClearEmailAndMobile
+  end
+
+  def self.enable_users(user_names)
+    request 'el/sync/enabledusers', userNames: user_names.to_json.to_s
+  end
+
+  def self.delete_users(user_names)
+    request 'el/sync/deletedusers', userNames: user_names.to_json.to_s
+  end
+
+  def self.check_user(user_name)
+    request 'el/sync/cku', userNames: user_name
+  end
+end

data/lib/yxt-api/version.rb

@@ -0,0 +1,3 @@
+module Yxt
+  VERSION = '0.0.1'.freeze
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: yxt-api
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Eric Guo
+autorequire: 
+bindir: exe
+cert_chain:
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIEQDCCAqigAwIBAgIBATANBgkqhkiG9w0BAQsFADAlMSMwIQYDVQQDDBplcmlj
+  Lmd1b2N6L0RDPWdtYWlsL0RDPWNvbTAeFw0xODA4MjcxMDM0MjBaFw0xOTA4Mjcx
+  MDM0MjBaMCUxIzAhBgNVBAMMGmVyaWMuZ3VvY3ovREM9Z21haWwvREM9Y29tMIIB
+  ojANBgkqhkiG9w0BAQEFAAOCAY8AMIIBigKCAYEAvvuL8SAQjsNR1ij4IEo3u63M
+  OST173hPCWPwvznHnDsphHMPY9erDkWWMC4Rx9Rq0mfQoONIbr7hgVMO2+ixsMuC
+  c/sW8X3GY0WxiqCOXP7hIPycboRsb+h+dbbrzOGGsdN7jp8GQVlse75kDulGm2tz
+  c+2uzj7qx+kAvlX1M+gAtoXwBte0BNYmqszOaHNxoiAd4MiTwxvhxmVrpd6V+oP1
+  tNbZRQxRjDj3gJn/kV4qYQYUt5S7p7fIAnZ7JZicXsiffMSQGNcwijeMOQVyppl/
+  DrRNnRkZLn5yge2oclPZetbeTOGMTURv5ktuykCqSlydq3+bC7uLzPTHFM9882y4
+  +xcmWO3Ho9voGn3XtGKB5yJ+eUYTQ/Tm7bAICgi9R/0NFG01riq3RyFTFrCqmXgl
+  PC6yn7KpelWPKRQ6oKu4vweUjgZlHa3eyAgQwTcVfS4ZOM1qXgsRtVHzUlSkiZt0
+  5Rp973RN1w5ZYmC9X4IqvazoWZq+uw/Tnp4bEZwRAgMBAAGjezB5MAkGA1UdEwQC
+  MAAwCwYDVR0PBAQDAgSwMB0GA1UdDgQWBBQGmgb/xHA1sOvdHsW8OZ0ID7cR3jAf
+  BgNVHREEGDAWgRRlcmljLmd1b2N6QGdtYWlsLmNvbTAfBgNVHRIEGDAWgRRlcmlj
+  Lmd1b2N6QGdtYWlsLmNvbTANBgkqhkiG9w0BAQsFAAOCAYEAp7iNDlqk1L5zrTmD
+  E0QAEYo0wiKZ/x29kaXuG3j0hUkkwKFbhUHjsTEl307sO8yQRg/6DuVrQhUBwS9G
+  g749ybsn7pfOL+lCVUGGxWFJ8qsICQ4ECjtnKVXdQowDUzSeb5/IPaeN+RB4Rh7D
+  2msnkJhsf0IQbNNUt53tkE5KhwAkHGdY5solSLPwtUmmdW1kNt7OfGBTi5CjXwFg
+  Jh+lbxasy+KwHA6+9O5b8Qm2QSBN5bJGd2a63QE5p8cjRBnaRuiKn4wkmqMj/C0Z
+  OyM5lSs5iGML+eVE/dCsV+YFmSr6Ue8vokmKdrBDjtAkHwmVA0TpqHVmT+9bVUPn
+  Jl+EzvEfsjriqcj9+WGPo4R7XDQQnseHqzlXNedkrLFX/nTnEs5RKBZ6Ter1KRU6
+  ivoox98/nhOs6bHcSFPsxXdxUihcCfCzj+zcaHNEqpvTI/36Bnl2XW6dUJNaFQDc
+  oWOyq5ZkxqnYrYXactjW0+vcPv6WHoHXmjv4dF7iFp8r0mvK
+  -----END CERTIFICATE-----
+date: 2019-04-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.3
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.3
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+description: Helping rubyist integration with YXT API easier.
+email:
+- eric.guocz@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- LICENSE
+- README.md
+- lib/yxt-api.rb
+- lib/yxt-api/organization_unit.rb
+- lib/yxt-api/position.rb
+- lib/yxt-api/user.rb
+- lib/yxt-api/version.rb
+homepage: https://github.com/thape-cn/yxt-api
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: An unofficial 云学堂 http://www.yxt.com/ API wrap gem
+test_files: []