clickmeetings 0.1.4 → 0.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (7) hide show
  1. checksums.yaml +5 -5
  2. data/.github/workflows/run-tests.yml +26 -0
  3. data/README.md +26 -24
  4. data/clickmeetings.gemspec +23 -21
  5. data/lib/clickmeetings/version.rb +1 -1
  6. metadata +55 -70
  7. data/.travis.yml +0 -5
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
- SHA1:
3
- metadata.gz: 3c6dc86356e5371ae714c4ccdfa1b6da535c8392
4
- data.tar.gz: 0ba188ae455975bf735040758d5e2f065f59bf99
2
+ SHA256:
3
+ metadata.gz: c7957e3d0dec3844222ff970c64a81872eacc270078d53a8655991c494903b19
4
+ data.tar.gz: 19fc5201e2b1f29c5aaf3dbf526a633d69b378a9c722112cb7cc5b828dcfa184
5
5
  SHA512:
6
- metadata.gz: ce8baf7a35fc42529657d1acfbbc78416dc80f5f4e1dc35246389f8bf258fa12fb93521ed4a83b7cbd7b481601f2fbe2fd89842621c559afffec14d4fc9f7f6e
7
- data.tar.gz: fa10dc0f39ff2565aa1f16233a5a3671450cb38962c1d3343be7b445e494d452c9818833caf5116fb4db0b22d019388f7518f124272c6e8ac4c044b022f9d49f
6
+ metadata.gz: b524e4c4f0162aa8d53e40884113b38bdda1518f828fd144f46c5b77ba8fe1408fc5a28b61fddd8ebcce445310cbb49417028e2fe6d13dcaf0c0a43983da8710
7
+ data.tar.gz: fb323a5b723b5ff3d7790d9366db536a59687a64fb72e7b0d1ea0c376ca8f3ad045e502506f54d1835118b1aa9c35b50e98be9b0d4612ac33f38d68e8c378f2c
data/.github/workflows/run-tests.yml ADDED
@@ -0,0 +1,26 @@
1
+ name: Ruby CI
2
+
3
+ on:
4
+ push:
5
+ branches: [master]
6
+ pull_request:
7
+ branches: [master]
8
+
9
+ jobs:
10
+ test:
11
+ runs-on: ubuntu-latest
12
+
13
+ strategy:
14
+ matrix:
15
+ ruby-version: [2.7.3, 2.6.7, 2.5.9]
16
+
17
+ steps:
18
+ - uses: actions/checkout@v2
19
+ - name: Set up Ruby ${{ matrix.ruby-version }}
20
+ uses: ruby/setup-ruby@v1
21
+ with:
22
+ ruby-version: ${{ matrix.ruby-version }}
23
+ - name: Install dependencies
24
+ run: bundle install
25
+ - name: Run tests
26
+ run: bundle exec rspec
data/README.md CHANGED
@@ -1,3 +1,5 @@
1
+ [![Ruby CI](https://github.com/teachbase/clickmeetings/actions/workflows/run-tests.yml/badge.svg)](https://github.com/teachbase/clickmeetings/actions/workflows/run-tests.yml/badge.svg)
2
+
1
3
  # Clickmeetings
2
4
 
3
5
  Simple REST API client to interact with [Clickmeeting](https://clickmeeting.com) open and Privatelabel API.
@@ -33,7 +35,7 @@ clickmeetings:
33
35
  api_key: your_open_api_key
34
36
  locale: es # default language (uses e.g. in invitations)
35
37
  ```
36
- + in `config/clickmeetings.yml`:
38
+ + in `config/clickmeetings.yml`:
37
39
  ```yml
38
40
  privatelabel_host: https://api.clickmeetings.com/privatelabel/v1 # or http://api.anysecond.com/privatelabel/v1
39
41
  privatelabel_api_key: your_privatelabel_api_key
@@ -70,7 +72,7 @@ end
70
72
  # => updated Clickmeetings::PrivateLabel::Account object
71
73
  # see specification to know what params you can provide
72
74
  account = account.disable # sets account's status to 'disabled'
73
- account = account.enable # sets account's status to 'active'
75
+ account = account.enable # sets account's status to 'active'
74
76
  account.destroy # => deleted account
75
77
  Clickmeetings::PrivateLabel::Account.all # => array of accounts
76
78
  Clickmeetings::PrivateLabel::Account.find(1) # => account details with id = 1 or
@@ -92,19 +94,19 @@ end
92
94
  # there Clickmeetings::PrivateLabel::Conference.account_id equals to 1
93
95
  end
94
96
  # and there Clickmeetings::PrivateLabel::Conference.account_id equals to nil
95
-
97
+
96
98
  Clickmeetings::PrivateLabel::Conference.by_account(account_id: 1).new
97
99
  # => #<Clickmeetings::PrivateLabel::Conference:0x... @account_id=1>
98
100
  ```
99
101
  + Do anything
100
102
  ```ruby
101
103
  Clickmeetings::PrivateLabel::Conference.by_account(account_id: 1) do
102
- # use Clickmeetings::PrivateLabel::Conference.create, .all and .find methods+
104
+ # use Clickmeetings::PrivateLabel::Conference.create, .all and .find methods+
103
105
  # to create conference, get list of conferences for account or get conference
104
106
  # details
105
-
107
+
106
108
  # and #update and #destroy instance methods to change or delete any conference
107
-
109
+
108
110
  # params same as in Open API (see below)
109
111
  end
110
112
  ```
@@ -116,7 +118,7 @@ end
116
118
  # do anything in another account
117
119
  end
118
120
  ```
119
- + Сonference
121
+ + Сonference
120
122
  ```ruby
121
123
  Clickmeetings::Open::Conference.active # => list of active conferences
122
124
  Clickmeetings::Open::Conference.inactive # => list of inactive conferences
@@ -137,7 +139,7 @@ end
137
139
  + duration (String "h:mm"): duration of conference, between 0:05 and 3:00
138
140
  + timezone (String): Time zone of conference (e.g. “America/New_York”)
139
141
  + skin_id (integer): Skin identifier
140
- + registration (Hash):
142
+ + registration (Hash):
141
143
  + enabled (Boolean)
142
144
  + template (Integer): registration template, between 1 and 3
143
145
  + status (String): "active" or "inactive"
@@ -148,7 +150,7 @@ end
148
150
  Clickmeetings::Open::Conference.find(1).create_tokens(10)
149
151
  # creates tokens for confereces with access_type = 3;
150
152
  # param specifies how many tokens will be created (default is 1)
151
-
153
+
152
154
  Clickmeetings::Open::Conference.new(id: 1).send_invites(
153
155
  attendees: [
154
156
  {email: "first@teachbase.ru"},
@@ -159,13 +161,13 @@ end
159
161
  )
160
162
  # send invites to emails in attendees for specified role. Template means view of email
161
163
  # .new(id: 1) specifies id of conference. Unlike .find(1) it doesn't request to clickmeetings
162
-
164
+
163
165
  Clickmeetings::Open::Conference.new(id: 1).files # => files for conference
164
166
  Clickmeetings::Open::Conference.new(id: 1).tokens # => tokens for conference (if access_type is 3)
165
167
  Clickmeetings::Open::Conference.new(id: 1).sessions # => sessions for conference
166
168
  Clickmeetings::Open::Conference.new(id: 1).registrations # => registrations for conference
167
169
  Clickmeetings::Open::Conference.new(id: 1).recordings # => recordings for conference
168
-
170
+
169
171
  Clickmeetings::Open::Conference.new(id: 1).register(
170
172
  registration: {
171
173
  1 => "firstname",
@@ -261,21 +263,21 @@ end
261
263
  If contact with passed email exists, it will be updated
262
264
   
263
265
  + TimeZone
264
-
266
+
265
267
  Only `.all` method with optional param `:country`. Returns array of strings.
266
268
  ```ruby
267
269
  Clickmeetings::Open::TimeZone.all country: :ru # => time zones in Russia
268
270
  Clickmeetings::Open::TimeZone.all # => all time zones
269
271
  ```
270
-
272
+
271
273
  + PhoneGateway
272
-
274
+
273
275
  ```ruby
274
276
  Clickmeetings::Open::PhoneGateway.all # => array of phone gateways
275
277
  ```
276
-
278
+
277
279
  + Registration
278
-
280
+
279
281
  ```ruby
280
282
  Clickmeetings::Open::Registration.by_conference(conference_id: 1) do
281
283
  Clickmeetings::Open::Registration.all # => array of registrations
@@ -286,9 +288,9 @@ end
286
288
  # => registrations for session with id 1
287
289
  end
288
290
  ```
289
-
291
+
290
292
  + FileLibrary
291
-
293
+
292
294
  ```ruby
293
295
  Clickmeetings::Open::FileLibrary.create(path: '/path/to/file.pdf')
294
296
  # => FileLibrary instance; creates file in your library
@@ -304,15 +306,15 @@ end
304
306
  ```
305
307
 
306
308
  + Recording
307
-
309
+
308
310
  `Clickmeetings::Open::Recordings` interacts with recordings. Specify a conference with `by_conference` (as above) method and use `.all`, `.find`, and `.destroy_all` (to destroy all recordings of conference) methods.
309
-
311
+
310
312
  + Chat
311
-
313
+
312
314
  `Clickmeetings::Open::Chat` interacts with chats. Use `.all` to get info about chats. `.find` returns content of zip-archive with a chat.
313
-
315
+
314
316
  + Other
315
-
317
+
316
318
  Use `.ping` with any class to check API status.
317
319
 
318
320
  ## Development
@@ -320,7 +322,7 @@ end
320
322
  + Fork repo
321
323
  + Create new branch
322
324
  + install dependencies
323
-
325
+
324
326
  $ bundle install
325
327
 
326
328
  + Commit your changes (do not forget about specs)
data/clickmeetings.gemspec CHANGED
@@ -1,34 +1,36 @@
1
- # coding: utf-8
2
- lib = File.expand_path('../lib', __FILE__)
1
+ # frozen_string_literal: true
2
+
3
+ lib = File.expand_path('lib', __dir__)
3
4
  $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
5
  require 'clickmeetings/version'
5
6
 
6
7
  Gem::Specification.new do |spec|
7
- spec.name = "clickmeetings"
8
+ spec.name = 'clickmeetings'
8
9
  spec.version = Clickmeetings::VERSION
9
- spec.authors = ["Sergei Alekseenko", "Makar Ermokhin"]
10
- spec.email = ["alekseenkoss@gmail.com", "ermak95@gmail.com"]
11
- spec.summary = %q{Simple REST API client for ClickMeetings Private Label and Open API}
12
- spec.description = %q{Simple REST API client for ClickMeetings Private Label and Open API}
13
- spec.homepage = "https://github.com/teachbase/clickmeetings"
14
- spec.license = "MIT"
10
+ spec.authors = ['Sergei Alekseenko', 'Makar Ermokhin']
11
+ spec.email = ['alekseenkoss@gmail.com', 'ermak95@gmail.com']
12
+ spec.summary = 'Simple REST API client for ClickMeetings Private Label and Open API'
13
+ spec.description = 'Simple REST API client for ClickMeetings Private Label and Open API'
14
+ spec.homepage = 'https://github.com/teachbase/clickmeetings'
15
+ spec.license = 'MIT'
15
16
 
16
17
  spec.files = `git ls-files -z`.split("\x0")
17
18
  spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
18
19
  spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
19
- spec.require_paths = ["lib"]
20
+ spec.require_paths = ['lib']
21
+
22
+ spec.required_ruby_version = '>= 2.5'
20
23
 
21
- spec.add_development_dependency "bundler", "~> 1.12"
22
- spec.add_development_dependency "rake", "~> 10.0"
23
- spec.add_development_dependency "rspec", "~> 3.0"
24
- spec.add_development_dependency "webmock", "~> 2"
25
- spec.add_development_dependency 'pry', "~> 0.10"
24
+ spec.add_development_dependency 'pry', '~> 0.10'
25
+ spec.add_development_dependency 'pry-byebug'
26
+ spec.add_development_dependency 'rake', '~> 12.0'
27
+ spec.add_development_dependency 'rspec', '~> 3.0'
26
28
  spec.add_development_dependency 'simplecov'
27
- spec.add_development_dependency "simplecov-gem-profile"
28
- spec.add_development_dependency "pry-byebug"
29
- spec.add_dependency "anyway_config", "~> 0", ">= 0.3"
30
- spec.add_dependency "faraday", "~> 0.9"
31
- spec.add_dependency "faraday_middleware", "~> 0.10"
32
- spec.add_dependency 'activemodel', ">= 4.1", "< 6"
29
+ spec.add_development_dependency 'simplecov-gem-profile'
30
+ spec.add_development_dependency 'webmock', '~> 2'
31
+ spec.add_dependency 'activemodel', '>= 4.1', '< 6'
32
+ spec.add_dependency 'anyway_config', '>= 0.3'
33
+ spec.add_dependency 'faraday', '>= 1.0', '< 2'
34
+ spec.add_dependency 'faraday_middleware', '>= 1.0'
33
35
  spec.add_dependency 'json', '~> 1.0'
34
36
  end
data/lib/clickmeetings/version.rb CHANGED
@@ -1,3 +1,3 @@
1
1
  module Clickmeetings
2
- VERSION = "0.1.4"
2
+ VERSION = "0.2.0"
3
3
  end
metadata CHANGED
@@ -1,86 +1,72 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: clickmeetings
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.1.4
4
+ version: 0.2.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Sergei Alekseenko
8
8
  - Makar Ermokhin
9
- autorequire:
9
+ autorequire:
10
10
  bindir: bin
11
11
  cert_chain: []
12
- date: 2018-10-16 00:00:00.000000000 Z
12
+ date: 2021-11-20 00:00:00.000000000 Z
13
13
  dependencies:
14
14
  - !ruby/object:Gem::Dependency
15
- name: bundler
16
- requirement: !ruby/object:Gem::Requirement
17
- requirements:
18
- - - "~>"
19
- - !ruby/object:Gem::Version
20
- version: '1.12'
21
- type: :development
22
- prerelease: false
23
- version_requirements: !ruby/object:Gem::Requirement
24
- requirements:
25
- - - "~>"
26
- - !ruby/object:Gem::Version
27
- version: '1.12'
28
- - !ruby/object:Gem::Dependency
29
- name: rake
15
+ name: pry
30
16
  requirement: !ruby/object:Gem::Requirement
31
17
  requirements:
32
18
  - - "~>"
33
19
  - !ruby/object:Gem::Version
34
- version: '10.0'
20
+ version: '0.10'
35
21
  type: :development
36
22
  prerelease: false
37
23
  version_requirements: !ruby/object:Gem::Requirement
38
24
  requirements:
39
25
  - - "~>"
40
26
  - !ruby/object:Gem::Version
41
- version: '10.0'
27
+ version: '0.10'
42
28
  - !ruby/object:Gem::Dependency
43
- name: rspec
29
+ name: pry-byebug
44
30
  requirement: !ruby/object:Gem::Requirement
45
31
  requirements:
46
- - - "~>"
32
+ - - ">="
47
33
  - !ruby/object:Gem::Version
48
- version: '3.0'
34
+ version: '0'
49
35
  type: :development
50
36
  prerelease: false
51
37
  version_requirements: !ruby/object:Gem::Requirement
52
38
  requirements:
53
- - - "~>"
39
+ - - ">="
54
40
  - !ruby/object:Gem::Version
55
- version: '3.0'
41
+ version: '0'
56
42
  - !ruby/object:Gem::Dependency
57
- name: webmock
43
+ name: rake
58
44
  requirement: !ruby/object:Gem::Requirement
59
45
  requirements:
60
46
  - - "~>"
61
47
  - !ruby/object:Gem::Version
62
- version: '2'
48
+ version: '12.0'
63
49
  type: :development
64
50
  prerelease: false
65
51
  version_requirements: !ruby/object:Gem::Requirement
66
52
  requirements:
67
53
  - - "~>"
68
54
  - !ruby/object:Gem::Version
69
- version: '2'
55
+ version: '12.0'
70
56
  - !ruby/object:Gem::Dependency
71
- name: pry
57
+ name: rspec
72
58
  requirement: !ruby/object:Gem::Requirement
73
59
  requirements:
74
60
  - - "~>"
75
61
  - !ruby/object:Gem::Version
76
- version: '0.10'
62
+ version: '3.0'
77
63
  type: :development
78
64
  prerelease: false
79
65
  version_requirements: !ruby/object:Gem::Requirement
80
66
  requirements:
81
67
  - - "~>"
82
68
  - !ruby/object:Gem::Version
83
- version: '0.10'
69
+ version: '3.0'
84
70
  - !ruby/object:Gem::Dependency
85
71
  name: simplecov
86
72
  requirement: !ruby/object:Gem::Requirement
@@ -110,87 +96,87 @@ dependencies:
110
96
  - !ruby/object:Gem::Version
111
97
  version: '0'
112
98
  - !ruby/object:Gem::Dependency
113
- name: pry-byebug
99
+ name: webmock
114
100
  requirement: !ruby/object:Gem::Requirement
115
101
  requirements:
116
- - - ">="
102
+ - - "~>"
117
103
  - !ruby/object:Gem::Version
118
- version: '0'
104
+ version: '2'
119
105
  type: :development
120
106
  prerelease: false
121
107
  version_requirements: !ruby/object:Gem::Requirement
122
108
  requirements:
123
- - - ">="
109
+ - - "~>"
124
110
  - !ruby/object:Gem::Version
125
- version: '0'
111
+ version: '2'
126
112
  - !ruby/object:Gem::Dependency
127
- name: anyway_config
113
+ name: activemodel
128
114
  requirement: !ruby/object:Gem::Requirement
129
115
  requirements:
130
- - - "~>"
131
- - !ruby/object:Gem::Version
132
- version: '0'
133
116
  - - ">="
134
117
  - !ruby/object:Gem::Version
135
- version: '0.3'
118
+ version: '4.1'
119
+ - - "<"
120
+ - !ruby/object:Gem::Version
121
+ version: '6'
136
122
  type: :runtime
137
123
  prerelease: false
138
124
  version_requirements: !ruby/object:Gem::Requirement
139
125
  requirements:
140
- - - "~>"
141
- - !ruby/object:Gem::Version
142
- version: '0'
143
126
  - - ">="
144
127
  - !ruby/object:Gem::Version
145
- version: '0.3'
128
+ version: '4.1'
129
+ - - "<"
130
+ - !ruby/object:Gem::Version
131
+ version: '6'
146
132
  - !ruby/object:Gem::Dependency
147
- name: faraday
133
+ name: anyway_config
148
134
  requirement: !ruby/object:Gem::Requirement
149
135
  requirements:
150
- - - "~>"
136
+ - - ">="
151
137
  - !ruby/object:Gem::Version
152
- version: '0.9'
138
+ version: '0.3'
153
139
  type: :runtime
154
140
  prerelease: false
155
141
  version_requirements: !ruby/object:Gem::Requirement
156
142
  requirements:
157
- - - "~>"
143
+ - - ">="
158
144
  - !ruby/object:Gem::Version
159
- version: '0.9'
145
+ version: '0.3'
160
146
  - !ruby/object:Gem::Dependency
161
- name: faraday_middleware
147
+ name: faraday
162
148
  requirement: !ruby/object:Gem::Requirement
163
149
  requirements:
164
- - - "~>"
150
+ - - ">="
165
151
  - !ruby/object:Gem::Version
166
- version: '0.10'
152
+ version: '1.0'
153
+ - - "<"
154
+ - !ruby/object:Gem::Version
155
+ version: '2'
167
156
  type: :runtime
168
157
  prerelease: false
169
158
  version_requirements: !ruby/object:Gem::Requirement
170
159
  requirements:
171
- - - "~>"
160
+ - - ">="
172
161
  - !ruby/object:Gem::Version
173
- version: '0.10'
162
+ version: '1.0'
163
+ - - "<"
164
+ - !ruby/object:Gem::Version
165
+ version: '2'
174
166
  - !ruby/object:Gem::Dependency
175
- name: activemodel
167
+ name: faraday_middleware
176
168
  requirement: !ruby/object:Gem::Requirement
177
169
  requirements:
178
170
  - - ">="
179
171
  - !ruby/object:Gem::Version
180
- version: '4.1'
181
- - - "<"
182
- - !ruby/object:Gem::Version
183
- version: '6'
172
+ version: '1.0'
184
173
  type: :runtime
185
174
  prerelease: false
186
175
  version_requirements: !ruby/object:Gem::Requirement
187
176
  requirements:
188
177
  - - ">="
189
178
  - !ruby/object:Gem::Version
190
- version: '4.1'
191
- - - "<"
192
- - !ruby/object:Gem::Version
193
- version: '6'
179
+ version: '1.0'
194
180
  - !ruby/object:Gem::Dependency
195
181
  name: json
196
182
  requirement: !ruby/object:Gem::Requirement
@@ -215,9 +201,9 @@ executables:
215
201
  extensions: []
216
202
  extra_rdoc_files: []
217
203
  files:
204
+ - ".github/workflows/run-tests.yml"
218
205
  - ".gitignore"
219
206
  - ".rspec"
220
- - ".travis.yml"
221
207
  - Gemfile
222
208
  - LICENSE.txt
223
209
  - README.md
@@ -326,7 +312,7 @@ homepage: https://github.com/teachbase/clickmeetings
326
312
  licenses:
327
313
  - MIT
328
314
  metadata: {}
329
- post_install_message:
315
+ post_install_message:
330
316
  rdoc_options: []
331
317
  require_paths:
332
318
  - lib
@@ -334,16 +320,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
334
320
  requirements:
335
321
  - - ">="
336
322
  - !ruby/object:Gem::Version
337
- version: '0'
323
+ version: '2.5'
338
324
  required_rubygems_version: !ruby/object:Gem::Requirement
339
325
  requirements:
340
326
  - - ">="
341
327
  - !ruby/object:Gem::Version
342
328
  version: '0'
343
329
  requirements: []
344
- rubyforge_project:
345
- rubygems_version: 2.5.2
346
- signing_key:
330
+ rubygems_version: 3.2.22
331
+ signing_key:
347
332
  specification_version: 4
348
333
  summary: Simple REST API client for ClickMeetings Private Label and Open API
349
334
  test_files:
data/.travis.yml DELETED
@@ -1,5 +0,0 @@
1
- sudo: false
2
- language: ruby
3
- rvm:
4
- - 2.3.1
5
- before_install: gem install bundler -v 1.13.6