true-conf 0.2.0 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 00ff9c51d74805eb57bf177b08b9e1756aebe22657f63b305d8367496e7e2bfa
-  data.tar.gz: e1593f9f88add18b5603ca84c0e5d7006c6f4f585195cd787e7ef20e711f036e
+  metadata.gz: 3229994ae56f8e147da589145beb40c4b9b4d92b34ef24e977b04fa49703f299
+  data.tar.gz: a9b95791b3bb3ee75befae3c2049ce76800f2a35bf2228fc9922370bcd0951f2
 SHA512:
-  metadata.gz: d495a41c2efbf4383833006ae42ac12c766f50f40d21e529fc377d5bb2d23caa930d6c1b43103cf43b0673500ded6e91821e1a911a9cfaade5bd395fe709b8b8
-  data.tar.gz: e28f7951f0fe8f1b84d2e6d796af1ed290d2a6e3dabfac2063159187abb4cd929881d3225bb2cff23435f15f81ab82e6dc5e4c5e9498cb55bbec23db7783ef95
+  metadata.gz: ca9807bc3c3a0927d88abacfb658e72fe7a324042e3801dbbff5644563abeee948b5a31bd23363c11cdbe9ff97401720f24da6feb02a694bab9174295f4ccaa1
+  data.tar.gz: 55fdba5292239545083fc73b7b742fd1d3b232d89bbb32d1bee2c711af976b688a0647dc387c564103d32f4343f630047797f95a444fe2a2b320432f4cc33b6f

data/README.md

@@ -22,60 +22,60 @@ Or install it yourself as:
     $ gem install true-conf
 
 ## Usage
-The TrueConf API uses OAuth2 or Token to authenticate API request. By defaut, a OAuth2 client will be used.
+The TrueConf API uses OAuth2 or API Key to authenticate API request. By defaut, a OAuth2 client will be used.
 
 ```ruby
 # 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
-client.success?
-client.error?
+response = 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
+
+# API Key
+response = TrueConf::Client.new auth_method:   'api_key',
+                                api_key:       '<api_key>', # required
+                                api_server:    '<server_name>', # required
+                                version:       '3.2' # optional, default: 3.2
+
+# => TrueConf::Client
+response.success?
+response.error?
 ```
 
 ### Conferences
+https://developers.trueconf.ru/api/server/#api-Conferences
 
+```ruby
+params = {
+    topic: "My first conference"
+    owner: "andy@example.com",
+    type: 0,
+    schedule: { type: -1 }
+}
 
-### Users
-https://developers.trueconf.ru/api/server/#api-Users
+conference = client.conferences.create(**params)
+# => TrueConf::Entity::Conference
 
-**Entities**
+conference = client.by_conference(conference_id: 12345).get
+# => TrueConf::Entity::Conference
 
-```ruby
-TrueConf::Entity::User
+conference = client.by_conference(conference_id: 12345).update(**params)
+# => TrueConf::Entity::Conference
 
-user = client.by_user(id: "andy").get
-user.disabled?   # false
-user.enabled?    # true
-user.not_active? # false
-user.invalid?    # false
-user.offline?    # false
-user.online?     # true
-user.busy?       # false
-user.multihost?  # false
+conference = client.by_conference(conference_id: 12345).delete
+# => TrueConf::Entity::ConferenceSimple
 
-```
-```ruby
-TrueConf::Entity::UserList
+conference = client.by_conference(conference_id: 12345).start
+# => TrueConf::Entity::ConferenceSimple
 
+conference = client.by_conference(conference_id: 12345).stop
+# => TrueConf::Entity::ConferenceSimple
 ```
 
-```ruby
-TrueConf::Entity::UserSimple
+### Users
+https://developers.trueconf.ru/api/server/#api-Users
 
-```
-**Actions**
 ```ruby
 users = client.users.all url_type:      "dynamic",     # optional
                          page_id:       1,             # optional
@@ -92,6 +92,14 @@ user = client.users.create(**params)
 
 user = client.by_user(id: "andy").get
 # => TrueConf::Entity::User
+user.disabled?   # false
+user.enabled?    # true
+user.not_active? # false
+user.invalid?    # false
+user.offline?    # false
+user.online?     # true
+user.busy?       # false
+user.multihost?  # false
 
 user = client.by_user(id: "andy").update(**params)
 # => TrueConf::Entity::User
@@ -106,29 +114,6 @@ user = client.by_user(id: "andy").disconnect
 ### Invitations
 https://developers.trueconf.ru/api/server/#api-Conferences_Invitations
 
-**Entities**
-
-```ruby
-TrueConf::Entity::Invitation
-
-invitation = client.by_conference(conference_id: "3390770247")
-                   .by_invitation(id: "user")
-                   .get
-
-invitation.owner?   # true
-invitation.user?    # true
-invitation.custom?  # false
-
-```
-```ruby
-TrueConf::Entity::InvitationList
-```
-
-```ruby
-TrueConf::Entity::InvitationSimple
-```
-
-**Actions**
 ```ruby
 # Add Invitation
 invitation = client.by_conference(conference_id: "3390770247")
@@ -148,6 +133,10 @@ invitation = client.by_conference(conference_id: "3390770247")
                    .get
 # => TrueConf::Entity::Invitation
 
+invitation.owner?   # true
+invitation.user?    # true
+invitation.custom?  # false
+
 # Update Invitation
 invitation = client.by_conference(conference_id: "3390770247")
                    .by_invitation(id: "user")
@@ -161,13 +150,39 @@ invitation = client.by_conference(conference_id: "3390770247")
 # => TrueConf::Entity::InvitationSimple
 ```
 
-### Error
+### Records
+https://developers.trueconf.ru/api/server/#api-Conferences_Records
+```ruby
+records = client.by_conference(conference_id: "3390770247").records.all
+# => TrueConf::Entity::RecordList
+
+record = client.by_conference(conference_id: "3390770247").by_record(id: 12345).get
+# => TrueConf::Entity::Record
 
+record = client.by_conference(conference_id: "3390770247").by_record(id: 12345).download
+# => TrueConf::Entity::Record
+```
+### Calls
+https://developers.trueconf.ru/api/server/#api-Logs
 
+```ruby
+calls = client.logs.calls.all()
+# => TrueConf::Entity::CallList
+
+call = client.logs.by_call(id: "3390770247").get
+# => TrueConf::Entity::Call
+
+participants = client.logs.by_call(id: "3390770247").participants
+# => TrueConf::Entity::CallParticipantList
+```
 
 ## Contributing
+Everyone is encouraged to help improve this project. Here are a few ways you can help:
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/true-conf. 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.
+- [Report bugs](https://github.com/paderinandrey/true-conf/issues)
+- Fix bugs and [submit pull requests](https://github.com/paderinandrey/true-conf/pulls)
+- Write, clarify, or fix documentation
+- Suggest or add new features
 
 ## License
 

data/lib/true-conf/call.rb

@@ -33,7 +33,7 @@ module TrueConf
     scope :by_call do
       option :id, proc(&:to_s)
 
-      path { "/calls/#{id}" }
+      path { "/calls/#{URI.encode_www_form_component(id)}" }
       format "json"
 
       operation :get do

data/lib/true-conf/client.rb

@@ -10,7 +10,7 @@ module TrueConf
     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_key, 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" }
@@ -20,7 +20,7 @@ module TrueConf
 
       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 :apikey_missed if auth_method.api_key? && api_key.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) }
@@ -41,7 +41,7 @@ module TrueConf
     end
 
     security do
-      token = auth_method.oauth? ? access_token(client_id, client_secret) : client_token
+      token = auth_method.oauth? ? access_token(client_id, client_secret) : api_key
       token_auth(token, inside: :query)
     end
   end

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

@@ -4,8 +4,8 @@ en:
     client:
       errors:
         true_conf/client:
-          invalid_auth_method: "Invalid auth method"
-          token_missed: API token missed
+          invalid_auth_method: Invalid Auth method
+          apikey_missed: API key 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/date_time.rb

@@ -8,6 +8,10 @@ module TrueConf
       option :date, proc(&:to_s)
       option :timezone_type, proc(&:to_i)
       option :timezone, proc(&:to_s)
+
+      def as_time
+        Time.parse(date)
+      end
     end
   end
 end

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

@@ -4,7 +4,7 @@ module TrueConf
   class AuthMethodType < String
     extend TrueConf::Callable
 
-    METHODS = %w[oauth token].freeze
+    METHODS = %w[oauth api_key].freeze
 
     METHODS.each do |method|
       define_method("#{method}?") do

data/lib/true-conf/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: true-conf
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.3
 platform: ruby
 authors:
 - Andrey Paderin
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-11-30 00:00:00.000000000 Z
+date: 2020-12-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: evil-client