lark-sdk 1.0.16 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a82be7af90cd299952cb37cca92382748d3d01f4e51c2c5feece94044336e265
-  data.tar.gz: 48d5996a439d6edf9b223643752c37e7b4b91426efdb24c736a8826ec8c09ef8
+  metadata.gz: 7f85b0fe40fd06b6433cc6e3d5d2dfb324fc8587054e3e5338a0bcc255eae20d
+  data.tar.gz: 978dffe16def339df6de1459bb8a7ea21adea598cee7b864b649c21a051549f1
 SHA512:
-  metadata.gz: 0cba05e3b6e79e88709904978b5d4adfa337dbeb70bdd12ed5477d232a321a28a6db71b3615ed224e94c56c4d6f141db8c2e00c53cd7e0f3575b6264bc8300d3
-  data.tar.gz: e0b8f6e09949bdba969e15b05d63b822467ca7071266f757924c8860cdeabed67425bc4b39396eab60ed41de54f090ea06bb2ac8df903a37b2fd46413593b005
+  metadata.gz: 5379f843398ca53a26fdd905bbff9a4f1a98872c8f655ca574881da048c56334832965424d8339986ec96718de0ab6f3e8b8b3581deee32ff2c27604be72e499
+  data.tar.gz: b23e6499d47d352caa05eeef4de1baa1943347fce24b65143c369eff59b274a472e5f966b0a2ac0c4e2770aef6f2b45b1fd433af6a2d7650ef94b999f5f30a48

data/README.md

@@ -12,13 +12,13 @@ gem 'lark-sdk'
 
 And then execute:
 
-	$ bundle install
+  $ bundle install
 
 Or install it yourself as:
 
-	$ gem install lark-sdk
+  $ gem install lark-sdk
 
-	require 'lark/sdk'
+  require 'lark/sdk'
 
 ## 使用
 
@@ -32,6 +32,7 @@ Lark.configure do |config|
   config.default_app_id = 'xxx'       # 应用 app ID
   config.default_app_secret = 'xxx'   # 应用 app secret
   config.default_isv = true           # 自建应用: false, 应用商店应用: true
+  config.api_base_url = 'https://open.feishu.cn/open-apis/' # API 地址，默认：https://open.feishu.cn/open-apis/
   # ...
 end
 ```
@@ -40,10 +41,10 @@ end
 
 ```ruby
 api = Lark::Api.new(
-	app_id: 'xxx',        # default: Lark.config.default_app_id
-	app_secret: 'xxx',    # default: Lark.config.default_app_secret
-	isv: false/true,      # default: Lark.config.default_app_secret
-	tenant_key: 'xxx'     # required while internal app
+  app_id: 'xxx',        # default: Lark.config.default_app_id
+  app_secret: 'xxx',    # default: Lark.config.default_app_secret
+  isv: false/true,      # default: Lark.config.default_app_secret
+  tenant_key: 'xxx'     # required while internal app
 )
 ```
 
@@ -60,7 +61,7 @@ cipher.decrypt(message)
 cipher.encrypt(message)
 ```
 
-[Api 列表](https://github.com/mycolorway/lark-ruby-sdk/wiki/API-List)
+[Api 列表](https://github.com/seandong/lark-ruby-sdk/wiki/apis)
 
 
 ## 贡献

data/Rakefile

@@ -8,3 +8,7 @@ Rake::TestTask.new(:test) do |t|
 end
 
 task :default => :test
+
+task :console do
+  sh 'irb -I lib -r lark.rb'
+end

data/lark.gemspec

@@ -8,15 +8,15 @@ Gem::Specification.new do |spec|
 
   spec.summary       = %q{Lark(飞书) API SDKs for ruby}
   spec.description   = %q{Lark(飞书) API SDKs for ruby https://open.feishu.cn}
-  spec.homepage      = "https://github.com/mycolorway/lark-ruby-sdk"
+  spec.homepage      = "https://github.com/seandong/lark-ruby-sdk"
   spec.license       = "MIT"
   spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
 
   spec.metadata["allowed_push_host"] = "https://rubygems.org/"
 
   spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = "https://github.com/mycolorway/lark-ruby-sdk"
-  spec.metadata["changelog_uri"] = "https://github.com/mycolorway/lark-ruby-sdk"
+  spec.metadata["source_code_uri"] = "https://github.com/seandong/lark-ruby-sdk"
+  spec.metadata["changelog_uri"] = "https://github.com/seandong/lark-ruby-sdk"
 
   # 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.

data/lib/lark.rb

@@ -11,8 +11,6 @@ Dir["#{lib_path}/apis/**/*.rb",  "#{lib_path}/token_store/*.rb"].each { |path| r
 require 'lark/api'
 
 module Lark
-  API_BASE_URL = 'https://open.feishu.cn/open-apis/'.freeze
-
   # Exceptions
   class RedisNotConfigException < RuntimeError; end
   class AppNotConfigException < RuntimeError; end

data/lib/lark/api.rb

@@ -8,6 +8,7 @@ module Lark
     api_mount :authen
     api_mount :contact
     api_mount :user
+    api_mount :search
     api_mount :application
     api_mount :pay
     api_mount :chat
@@ -23,7 +24,7 @@ module Lark
 
     attr_reader :app_id, :app_secret, :tenant_key, :isv, :options
 
-    def initialize options={}
+    def initialize(options = {})
       @app_id = options.delete(:app_id) || Lark.config.default_app_id
       @app_secret = options.delete(:app_secret) || Lark.config.default_app_secret
       raise AppNotConfigException if @app_id.nil? || @app_id.empty?
@@ -38,29 +39,29 @@ module Lark
     end
 
     def request
-      @request ||= Lark::Request.new(false)
+      @request ||= Lark::Request.new
     end
 
-    def get(path, headers={})
-      with_token(headers) do |headers|
-        request.get path, headers
+    def get(path, headers = {})
+      with_token(headers) do |headers_with_token|
+        request.get path, headers_with_token
       end
     end
 
-    def post(path, payload, headers={})
-      with_token(headers) do |headers|
-        request.post path, payload, headers
+    def post(path, payload, headers = {})
+      with_token(headers) do |headers_with_token|
+        request.post path, payload, headers_with_token
       end
     end
 
-    def post_file(path, file, headers={})
-      with_token(headers) do |headers|
-        request.post_file path, file, headers
+    def post_file(path, file, headers = {})
+      with_token(headers) do |headers_with_token|
+        request.post_file path, file, headers_with_token
       end
     end
 
-    def app_ticket= ticket
-      Lark.redis.set "APP_TICKET_#{app_id}", ticket
+    def app_ticket=(new_ticket)
+      Lark.redis.set "APP_TICKET_#{app_id}", new_ticket
     end
 
     def app_ticket
@@ -91,7 +92,7 @@ module Lark
       @tenant_token_store = klass.new(self)
     end
 
-    def with_token(headers, tries=2)
+    def with_token(headers, tries = 2)
       token = headers[:access_token]
       if token.nil?
         via = headers[:via] || 'tenant'

data/lib/lark/apis/application.rb

@@ -2,7 +2,7 @@ module Lark
   module Apis
     module Application
       def app_admin_user_list
-        get '/user/v4/app_admin_user/list'
+        get 'user/v4/app_admin_user/list'
       end
 
       def is_user_admin(params={})

data/lib/lark/apis/authen.rb

@@ -5,7 +5,7 @@ module Lark
     module Authen
       def index(redirect_uri, state)
         uri = ERB::Util.url_encode(redirect_uri)
-        "#{URI::join(API_BASE_URL, 'authen/v1/index')}?redirect_uri=#{uri}&app_id=#{app_id}&state=#{state}"
+        "#{URI.join(Lark.api_base_url, 'authen/v1/index')}?redirect_uri=#{uri}&app_id=#{app_id}&state=#{state}"
       end
 
       def access_token(code)
@@ -25,8 +25,8 @@ module Lark
       end
 
       def user_info(user_access_token)
-        request.get 'authen/v1/user_info', {access_token: user_access_token}
+        request.get 'authen/v1/user_info', { access_token: user_access_token }
       end
     end
   end
-end
+end

data/lib/lark/apis/image.rb

@@ -5,8 +5,8 @@ module Lark
         post_file 'image/v4/put/', image, params: { image_type: image_type }
       end
 
-      def download(image_key)
-        get 'image/v4/get', params: { image_key: image_key }, as: :file
+      def download(image_key, params = {})
+        get 'image/v4/get', params: params.merge(image_key: image_key), as: :file
       end
     end
   end

data/lib/lark/apis/pay.rb

@@ -9,11 +9,11 @@ module Lark
       end
 
       def order_list(params={})
-        get 'pay/v1/order/list', via: 'app', params: params
+        get 'pay/v1/order/list', params: params
       end
 
       def order_get(order_id)
-        get 'pay/v1/order/get', via: 'app', params: {order_id: order_id}
+        get 'pay/v1/order/get', params: {order_id: order_id}
       end
     end
   end

data/lib/lark/apis/search.rb

@@ -0,0 +1,16 @@
+module Lark
+  module Apis
+    module Search
+      def user(query:, user_access_token:, page_size: 20, page_token: nil)
+        get 'search/v1/user', {
+          access_token: user_access_token,
+          params: {
+            query: query,
+            page_size: page_size,
+            page_token: page_token
+          }.compact
+        }
+      end
+    end
+  end
+end

data/lib/lark/config.rb

@@ -23,11 +23,17 @@ module Lark
     end
 
     def http_timeout_options
-      config.http_timeout_options || {write: 2, connect: 5, read: 10}
+      config.http_timeout_options || { write: 2, connect: 5, read: 10 }
+    end
+
+    def api_base_url
+      return @api_base_url if defined?(@api_base_url)
+
+      @api_base_url = config.api_base_url || 'https://open.feishu.cn/open-apis/'.freeze
     end
   end
 
   class Config
-    attr_accessor :default_app_id, :default_app_secret, :default_isv, :redis, :http_timeout_options, :logger
+    attr_accessor :default_app_id, :default_app_secret, :default_isv, :redis, :http_timeout_options, :logger, :api_base_url
   end
 end

data/lib/lark/request.rb

@@ -4,14 +4,14 @@ module Lark
   class Request
     attr_reader :ssl_context, :http
 
-    def initialize(skip_verify_ssl=true)
+    def initialize(skip_verify_ssl = true)
       @http = HTTP.timeout(**Lark.http_timeout_options)
       @ssl_context = OpenSSL::SSL::SSLContext.new
-      @ssl_context.ssl_version = :TLSv1
+      #@ssl_context.ssl_version = :TLSv1_2
       @ssl_context.verify_mode = OpenSSL::SSL::VERIFY_NONE if skip_verify_ssl
     end
 
-    def get(path, get_header={})
+    def get(path, get_header = {})
       request(path, get_header) do |url, header|
         params = header.delete(:params)
         http.headers(header).get(url, params: params, ssl_context: ssl_context)
@@ -19,7 +19,7 @@ module Lark
     end
     alias delete get
 
-    def post(path, post_body, post_header={})
+    def post(path, post_body, post_header = {})
       request(path, post_header) do |url, header|
         Lark.logger.info "payload: #{post_body}"
         params = header.delete(:params)
@@ -27,7 +27,7 @@ module Lark
       end
     end
 
-    def post_file(path, file, post_header={})
+    def post_file(path, file, post_header = {})
       request(path, post_header) do |url, header|
         params = header.delete(:params)
         http.headers(header).post(
@@ -44,13 +44,18 @@ module Lark
 
     private
 
-    def request(path, header={}, &_block)
-      url = URI::join(API_BASE_URL, path)
-      Lark.logger.info "request url(#{url}) with headers: #{header}"
+    def request(path, header = {}, &_block)
+      url = URI.join(Lark.api_base_url, path)
+      request_uuid = SecureRandom.uuid
+      Lark.logger.info "[#{request_uuid}] request url(#{url}) with headers: #{header}"
       as = header.delete(:as)
       header['Accept'] = 'application/json'
+      header['X-Request-ID'] = request_uuid
       response = yield(url, header)
-      raise ResponseError.new(response.status) unless response.status.success?
+      unless response.status.success?
+        Lark.logger.error "request #{url} happen error: #{response.body}"
+        raise ResponseError.new(response.status, response.body)
+      end
       handle_response(response, as || :json)
     end
 
@@ -76,7 +81,8 @@ module Lark
       Lark.logger.info "response body: #{body}"
       data = JSON.parse body.to_s
       result = Result.new(data)
-      raise ::Lark::AccessTokenExpiredError if [99991663, 99991664].include?(result.code)
+      raise ::Lark::AccessTokenExpiredError if [99_991_663, 99_991_664].include?(result.code)
+
       result
     end
 
@@ -99,7 +105,7 @@ module Lark
     end
 
     def success?
-      code == 0
+      code.zero?
     end
   end
 end

data/lib/lark/version.rb

@@ -1,3 +1,3 @@
 module Lark
-  VERSION = '1.0.16'.freeze
+  VERSION = '1.2.1'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lark-sdk
 version: !ruby/object:Gem::Version
-  version: 1.0.16
+  version: 1.2.1
 platform: ruby
 authors:
 - Sean Dong
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-10-20 00:00:00.000000000 Z
+date: 2021-03-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http
@@ -128,6 +128,7 @@ files:
 - lib/lark/apis/mina.rb
 - lib/lark/apis/notify.rb
 - lib/lark/apis/pay.rb
+- lib/lark/apis/search.rb
 - lib/lark/apis/user.rb
 - lib/lark/cipher.rb
 - lib/lark/config.rb
@@ -140,14 +141,14 @@ files:
 - lib/lark/token_store/isv_tenant_token.rb
 - lib/lark/token_store/tenant_token.rb
 - lib/lark/version.rb
-homepage: https://github.com/mycolorway/lark-ruby-sdk
+homepage: https://github.com/seandong/lark-ruby-sdk
 licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org/
-  homepage_uri: https://github.com/mycolorway/lark-ruby-sdk
-  source_code_uri: https://github.com/mycolorway/lark-ruby-sdk
-  changelog_uri: https://github.com/mycolorway/lark-ruby-sdk
+  homepage_uri: https://github.com/seandong/lark-ruby-sdk
+  source_code_uri: https://github.com/seandong/lark-ruby-sdk
+  changelog_uri: https://github.com/seandong/lark-ruby-sdk
 post_install_message: 
 rdoc_options: []
 require_paths: