true-conf 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f29978dc3d4c91a159b066f4987ab87345847cbaa132ad58961800ff9d07ce0d
-  data.tar.gz: 68b055e0881cbcccdb388c92fbaa3e49c69ea2ba47046a0972f13fdfb461d931
+  metadata.gz: 00ff9c51d74805eb57bf177b08b9e1756aebe22657f63b305d8367496e7e2bfa
+  data.tar.gz: e1593f9f88add18b5603ca84c0e5d7006c6f4f585195cd787e7ef20e711f036e
 SHA512:
-  metadata.gz: 9443f207e49049cbec6d61fca3bfda2b23f0b790afd057d38346caaff610cec72c2dc2a68cc4e5fd40b33d9bf9ef9429b87122b259d015afc1b764a147ab4b3e
-  data.tar.gz: 10cfaf7451a53c10e3d1f790bb02046215c7ae36ba5a1965ce2e65c6cf38b9b75ac41532b141a95cc5032094d62a28b2bc66bbb96c05518792c3d43067f443bd
+  metadata.gz: d495a41c2efbf4383833006ae42ac12c766f50f40d21e529fc377d5bb2d23caa930d6c1b43103cf43b0673500ded6e91821e1a911a9cfaade5bd395fe709b8b8
+  data.tar.gz: e28f7951f0fe8f1b84d2e6d796af1ed290d2a6e3dabfac2063159187abb4cd929881d3225bb2cff23435f15f81ab82e6dc5e4c5e9498cb55bbec23db7783ef95

data/README.md

@@ -1,7 +1,10 @@
 # TrueConf Server API Client
 
+[![Gem Version][gem-badger]][gem]
 [![TrueConf](https://circleci.com/gh/paderinandrey/true-conf.svg?style=svg)](https://circleci.com/gh/paderinandrey/true-conf)
 
+[gem-badger]: https://img.shields.io/gem/v/true-conf.svg?style=flat&color=blue
+[gem]: https://rubygems.org/gems/true-conf
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -19,13 +22,21 @@ Or install it yourself as:
     $ gem install true-conf
 
 ## Usage
-Initialize a client with `client_id` and `client_secret`:
+The TrueConf API uses OAuth2 or Token to authenticate API request. By defaut, a OAuth2 client will be used.
 
 ```ruby
-client = TrueConf::Client.new client_id:     '<client_id>',    # required
+# OAuth
+client = TrueConf::Client.new auth_method:   'oauth', # default: oauth
+                              client_id:     '<client_id>',    # required
                               client_secret: '<client_secret>', # required
                               api_server:    '<server_name>', # required
                               version:       '3.2' # optional, default: 3.2
+
+# Token
+client = TrueConf::Client.new auth_method:   'token',
+                              client_token:  '<client_token>', # required
+                              api_server:    '<server_name>', # required
+                              version:       '3.2' # optional, default: 3.2
 ```
 
 ```ruby
@@ -161,7 +172,3 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/[USERN
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
-
-## Code of Conduct
-
-Everyone interacting in the True::Conf project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/true-conf/blob/master/CODE_OF_CONDUCT.md).

data/lib/true-conf.rb

@@ -1,13 +1,16 @@
 # frozen_string_literal: true
 
 require "evil/client"
+require "oauth2"
 require "tempfile"
 
 require "true-conf/client"
+require "true-conf/types/auth_method_type"
 require "true-conf/conference"
 require "true-conf/invitation"
 require "true-conf/participant"
 require "true-conf/record"
+require "true-conf/call"
 require "true-conf/user"
 require "true-conf/version"
 require "true-conf/response"
@@ -26,3 +29,8 @@ require "true-conf/entity/invitation_simple"
 require "true-conf/entity/invitation_list"
 require "true-conf/entity/record"
 require "true-conf/entity/record_list"
+require "true-conf/entity/call"
+require "true-conf/entity/call_list"
+require "true-conf/entity/date_time"
+require "true-conf/entity/call_participant_list"
+require "true-conf/entity/call_participant"

data/lib/true-conf/call.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module TrueConf
+  Client.scope :logs do
+    path { "/logs" }
+    format "json"
+
+    scope :calls do
+      path { "/calls" }
+      format "json"
+
+      operation :all do
+        option :timezone, proc(&:to_i), optional: true
+        option :page_size, proc(&:to_i), optional: true
+        option :page_id, proc(&:to_i), optional: true
+        option :sort_field, proc(&:to_s), optional: true
+        option :sort_order, proc(&:to_i), optional: true
+        option :date_from, proc(&:to_s), optional: true
+        option :date_to, proc(&:to_s), optional: true
+        option :named_conf_id, proc(&:to_s), optional: true
+
+        http_method :get
+        query do
+          options.slice(:timezone, :page_size, :page_id, :sort_field,
+            :sort_order, :date_from, :date_to, :named_conf_id)
+        end
+
+        response(200) { |*res| Entity::CallList.build(*res) }
+        response(400, 403) { |*res| Error.build(*res) }
+      end
+    end
+
+    scope :by_call do
+      option :id, proc(&:to_s)
+
+      path { "/calls/#{id}" }
+      format "json"
+
+      operation :get do
+        http_method :get
+
+        response(200) { |*res| Entity::Call.build(*res) }
+        response(403, 404) { |*res| Error.build(*res) }
+      end
+
+      operation :participants do
+        option :timezone, proc(&:to_i), optional: true
+        option :page_size, proc(&:to_i), optional: true
+        option :page_id, proc(&:to_i), optional: true
+        option :sort_field, proc(&:to_s), optional: true
+        option :sort_order, proc(&:to_i), optional: true
+        option :date_from, proc(&:to_s), optional: true
+        option :date_to, proc(&:to_s), optional: true
+        option :call_id, proc(&:to_s), optional: true
+
+        query do
+          options.slice(:timezone, :page_size, :page_id, :sort_field,
+            :sort_order, :date_from, :date_to, :call_id)
+        end
+        path { "/participants" }
+        http_method :get
+
+        response(200) { |*res| Entity::CallParticipantList.build(*res) }
+        response(403, 404) { |*res| Error.build(*res) }
+      end
+    end
+  end
+end

data/lib/true-conf/client.rb

@@ -1,14 +1,30 @@
 # frozen_string_literal: true
 
-require "oauth2"
+require "true-conf/callable"
+require "true-conf/types/auth_method_type"
+
+I18n.load_path += [File.expand_path("../config/locales/en.yml", __FILE__)]
+
 module TrueConf
   class Client < Evil::Client
-    option :client_id, proc(&:to_s)
-    option :client_secret, proc(&:to_s)
+    option :auth_method, AuthMethodType, default: -> { "oauth" }
+    option :client_id, proc(&:to_s), optional: true
+    option :client_secret, proc(&:to_s), optional: true
+    option :client_token, proc(&:to_s), optional: true
     option :api_server, proc(&:to_s)
     option :token_url, proc(&:to_s), default: -> { "/oauth2/v1/token" }
     option :version, proc(&:to_s), default: -> { "v3.1" }
 
+    validate do
+      return if AuthMethodType::METHODS.include?(auth_method)
+
+      errors.add :invalid_auth_method, field: "auth_method", level: "error"
+    end
+    validate { errors.add :token_missed if auth_method.token? && client_token.nil? }
+    validate { errors.add :client_id_missed if auth_method.oauth? && client_id.nil? }
+    validate { errors.add :client_secret_missed if auth_method.oauth? && client_secret.nil? }
+    validate { errors.add :unsupported_api_version unless %w[v3.1 v3.2].include?(version) }
+
     format "json"
     path { "https://#{api_server}/api/#{version}" }
 
@@ -25,7 +41,8 @@ module TrueConf
     end
 
     security do
-      token_auth(access_token(client_id, client_secret), inside: :query)
+      token = auth_method.oauth? ? access_token(client_id, client_secret) : client_token
+      token_auth(token, inside: :query)
     end
   end
 end

data/lib/true-conf/config/locales/en.yml

@@ -0,0 +1,11 @@
+---
+en:
+  evil:
+    client:
+      errors:
+        true_conf/client:
+          invalid_auth_method: "Invalid auth method"
+          token_missed: API token missed
+          client_id_missed: Client ID missed
+          client_secret_missed: Client Secret missed
+          unsupported_api_version: Unsupported api version on TrueConf server

data/lib/true-conf/entity/call.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require_relative "./date_time"
+
+module TrueConf
+  module Entity
+    class Call < TrueConf::Response
+      extend TrueConf::Callable
+
+      option :conference_id, proc(&:to_s)
+      option :named_conf_id, proc(&:to_s), optional: true
+      option :topic, proc(&:to_s)
+      option :class, proc(&:to_i)
+      option :type, proc(&:to_i)
+      option :subtype, proc(&:to_i)
+      option :owner, proc(&:to_s)
+      option :participant_count, proc(&:to_i)
+      option :start_time, Entity::DateTime, optional: true
+      option :duration, proc(&:to_i)
+      option :end_time, Entity::DateTime, optional: true
+
+      class << self
+        def build(*res)
+          body = res.last
+          new JSON.parse(body.first)
+        end
+      end
+    end
+  end
+end

data/lib/true-conf/entity/call_list.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module TrueConf
+  module Entity
+    class CallList < TrueConf::Response
+      option :cnt, proc(&:to_i)
+      option :list, [Entity::Call], as: :data
+
+      class << self
+        def build(*res)
+          body = res.last
+          new JSON.parse(body.first)
+        end
+      end
+    end
+  end
+end

data/lib/true-conf/entity/call_participant.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative "./date_time"
+
+module TrueConf
+  module Entity
+    class CallParticipant < TrueConf::Response
+      extend TrueConf::Callable
+
+      option :app_id, proc(&:to_s)
+      option :avg_cpu_load, proc(&:to_i)
+      option :avg_sent_fps, proc(&:to_i)
+      option :bitrate_in, proc(&:to_i)
+      option :bitrate_out, proc(&:to_i)
+      option :call_id, proc(&:to_s)
+      option :display_name, proc(&:to_s)
+      option :duration, proc(&:to_i)
+      option :join_time, Entity::DateTime, optional: true
+      option :leave_reason, proc(&:to_i)
+      option :leave_time, Entity::DateTime, optional: true
+      option :video_h, proc(&:to_i)
+      option :video_w, proc(&:to_i)
+
+      class << self
+        def build(*res)
+          body = res.last
+          new JSON.parse(body.first)
+        end
+      end
+    end
+  end
+end

data/lib/true-conf/entity/call_participant_list.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require_relative "./call_participant"
+
+module TrueConf
+  module Entity
+    class CallParticipantList < TrueConf::Response
+      option :cnt, proc(&:to_i)
+      option :list, [Entity::CallParticipant], as: :data
+
+      class << self
+        def build(*res)
+          body = res.last
+          new JSON.parse(body.first)
+        end
+      end
+    end
+  end
+end

data/lib/true-conf/entity/date_time.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module TrueConf
+  module Entity
+    class DateTime < TrueConf::Response
+      extend TrueConf::Callable
+
+      option :date, proc(&:to_s)
+      option :timezone_type, proc(&:to_i)
+      option :timezone, proc(&:to_s)
+    end
+  end
+end

data/lib/true-conf/error.rb

@@ -12,4 +12,6 @@ module TrueConf
     option :message, proc(&:to_s)
     option :errors, [TrueConf::ErrorDetail], optional: true
   end
+
+  class ParameterValueNotPermitted < StandardError; end
 end

data/lib/true-conf/types/auth_method_type.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module TrueConf
+  class AuthMethodType < String
+    extend TrueConf::Callable
+
+    METHODS = %w[oauth token].freeze
+
+    METHODS.each do |method|
+      define_method("#{method}?") do
+        @auth_method == method
+      end
+    end
+
+    private
+
+    def initialize(value)
+      @auth_method = value.to_s
+      super @auth_method
+    end
+  end
+end

data/lib/true-conf/user.rb

@@ -41,7 +41,7 @@ module TrueConf
       http_method :post
       body do
         options.slice(:login_name, :email, :password, :display_name, :first_name, :last_name,
-                      :company, :mobile_phone, :work_phone, :home_phone, :is_active)
+          :company, :mobile_phone, :work_phone, :home_phone, :is_active)
       end
 
       response(200) { |*res| Entity::User.build(*res) }

data/lib/true-conf/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module TrueConf
-  VERSION = "0.1.2"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: true-conf
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Andrey Paderin
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-11-09 00:00:00.000000000 Z
+date: 2020-11-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: evil-client
@@ -131,11 +131,18 @@ files:
 - LICENSE.txt
 - README.md
 - lib/true-conf.rb
+- lib/true-conf/call.rb
 - lib/true-conf/callable.rb
 - lib/true-conf/client.rb
 - lib/true-conf/conference.rb
+- lib/true-conf/config/locales/en.yml
+- lib/true-conf/entity/call.rb
+- lib/true-conf/entity/call_list.rb
+- lib/true-conf/entity/call_participant.rb
+- lib/true-conf/entity/call_participant_list.rb
 - lib/true-conf/entity/conference.rb
 - lib/true-conf/entity/conference_simple.rb
+- lib/true-conf/entity/date_time.rb
 - lib/true-conf/entity/invitation.rb
 - lib/true-conf/entity/invitation_list.rb
 - lib/true-conf/entity/invitation_simple.rb
@@ -153,6 +160,7 @@ files:
 - lib/true-conf/participant.rb
 - lib/true-conf/record.rb
 - lib/true-conf/response.rb
+- lib/true-conf/types/auth_method_type.rb
 - lib/true-conf/user.rb
 - lib/true-conf/version.rb
 homepage: https://github.com/paderinandrey/true-conf