zoom_rb 0.9.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 711b71ce15443f695b228ee36d51501e18b2b5132ab3b2c473d1d8300ea64720
-  data.tar.gz: 4f967a6b7e73adc1450d7ea51defb7380fa6c660c83922a01ba696f91950a25f
+  metadata.gz: e9d0d18470f4f9f7f62c286725f5b30c704e1f73fb2cb543723cfbc1e36eed4a
+  data.tar.gz: 6266834d04ea88468eb40d42a30c19e15774f02b322a69eb5535c6569b88fb05
 SHA512:
-  metadata.gz: 7d57f4998d48c7999a9a404688120312173d5c613a82069717ffd414dd8ad744dc1695e085436160fc7deb96350a86e689d053fea94ed6eeec0225ac77fd5ead
-  data.tar.gz: eff852b6a1012dd45186560406d5afeb98ae77aa8a41d43c663ca1edfde5fd2f5bced5512fea05a71b1be7f14c681fdde51824009773ec468130dda437622f3b
+  metadata.gz: '028821632a4c9147d86975b00f87d1ff98b1d98cd2adb419a07f551b8f6186f2ed28699b7666e6e2d2765d736df4ece5e8c1b8c51c24cb9c87ed960ba27c8a93'
+  data.tar.gz: bb2088f723fb1f9c0b6780fb81dafe26c0a893298a1c03108dcc14d4e4c6a3070e57543f8ea7953047e2aa75435a55ec88baffb5bd39033891d2f8617694e7c8

data/.circleci/config.yml

@@ -9,7 +9,7 @@ jobs:
       CC_TEST_REPORTER_ID: c6c77975186cfe10e41d9548e9b4a4648f87b56cdbb70bd3896a5a58abf08421
     docker:
       # specify the version you desire here
-       - image: circleci/ruby:2.5.1-node-browsers
+       - image: circleci/ruby:2.7-node-browsers
 
       # Specify service dependencies here if necessary
       # CircleCI maintains a library of pre-built images

data/.gitignore

@@ -16,4 +16,5 @@ test/version_tmp
 tmp
 build_and_publish
 .rubocop*
-.DS_Store
+.DS_Store
+.ruby-version

data/CHANGELOG.md

@@ -0,0 +1,53 @@
+# 1.0.0
+
+The 1.0 release and a major refactor of all endpoint definitions.
+
+### Breaking Change
+* The `user_create` endpoint now requires its arguments to match the actual Zoom API.
+  This is done to simplify the code and encourage consistency.
+  This means that instead of passing:
+  ```
+  {
+    action: 'create',
+    email: 'foo@bar.com',
+    type: 1,
+    first_name: 'Zoomie',
+    last_name: 'Userton',
+    password: 'testerino'
+  }
+  ```
+  You will instead have to pass:
+  ```
+  {
+    action: 'create',
+    user_info: {
+      email: 'foo@bar.com',
+      type: 1,
+      first_name: 'Zoomie',
+      last_name: 'Userton',
+      password: 'testerino'
+    }
+  }
+  ```
+  Zoom API reference for user creation: https://marketplace.zoom.us/docs/api-reference/zoom-api/users/usercreate
+
+### New features
+* Greatly simplified new syntax when adding endpoints. This reduces repetition and makes it easier.
+* On `user_settings_get`, permit `option` and `custom_query_fields`.
+* Add `group_create` and `group_update`.
+
+# 0.11.0
+
+This is the first CHANGELOG entry.
+
+### New features:
+* A lot of new endpoints
+
+### Fixes:
+* Update README to say `require 'zoom'`
+* Fix a typo in the README
+
+### Misc:
+* Update gems
+* Update bundler to 2.2
+* Update Ruby to 2.7

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    zoom_rb (0.8.6)
+    zoom_rb (1.0.0)
       httparty (~> 0.13)
       json (>= 1.8)
       jwt
@@ -9,78 +9,112 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.5.2)
-      public_suffix (>= 2.0.2, < 4.0)
-    ast (2.4.0)
-    coderay (1.1.2)
-    crack (0.4.3)
-      safe_yaml (~> 1.0.0)
-    diff-lcs (1.3)
-    docile (1.3.1)
-    hashdiff (0.3.7)
-    hint-rubocop_style (0.2.5)
-      rubocop (>= 0.50.0)
-      rubocop-rspec (>= 1.17.0)
-    httparty (0.16.2)
+    activesupport (6.1.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    addressable (2.8.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    ast (2.4.2)
+    byebug (11.1.3)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.9)
+    crack (0.4.5)
+      rexml
+    diff-lcs (1.4.4)
+    docile (1.4.0)
+    hashdiff (1.0.1)
+    hint-rubocop_style (0.3.6)
+      rubocop (>= 0.78.0)
+      rubocop-performance (>= 1.3.0)
+      rubocop-rails (>= 2.0.0)
+      rubocop-rspec (>= 1.33.0)
+    httparty (0.20.0)
+      mime-types (~> 3.0)
       multi_xml (>= 0.5.2)
-    jaro_winkler (1.5.1)
-    json (2.1.0)
-    jwt (2.1.0)
-    method_source (0.9.0)
+    i18n (1.8.10)
+      concurrent-ruby (~> 1.0)
+    json (2.5.1)
+    jwt (2.3.0)
+    method_source (1.0.0)
+    mime-types (3.4.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2021.1115)
+    minitest (5.14.4)
     multi_xml (0.6.0)
-    parallel (1.12.1)
-    parser (2.5.3.0)
-      ast (~> 2.4.0)
-    powerpack (0.1.2)
-    pry (0.11.3)
-      coderay (~> 1.1.0)
-      method_source (~> 0.9.0)
-    public_suffix (3.0.3)
+    parallel (1.20.1)
+    parser (3.0.2.0)
+      ast (~> 2.4.1)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-byebug (3.9.0)
+      byebug (~> 11.0)
+      pry (~> 0.13.0)
+    public_suffix (4.0.6)
+    rack (2.2.3)
     rainbow (3.0.0)
-    rspec (3.8.0)
-      rspec-core (~> 3.8.0)
-      rspec-expectations (~> 3.8.0)
-      rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.0)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.2)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
     rspec_junit_formatter (0.4.1)
       rspec-core (>= 2, < 4, != 2.12.0)
-    rubocop (0.60.0)
-      jaro_winkler (~> 1.5.1)
+    rubocop (1.18.3)
       parallel (~> 1.10)
-      parser (>= 2.5, != 2.5.1.1)
-      powerpack (~> 0.1)
+      parser (>= 3.0.0.0)
       rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.7.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (~> 1.4.0)
-    rubocop-rspec (1.30.1)
-      rubocop (>= 0.60.0)
-    ruby-progressbar (1.10.0)
-    safe_yaml (1.0.4)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.8.0)
+      parser (>= 3.0.1.1)
+    rubocop-performance (1.11.4)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    rubocop-rails (2.11.3)
+      activesupport (>= 4.2.0)
+      rack (>= 1.1)
+      rubocop (>= 1.7.0, < 2.0)
+    rubocop-rspec (2.4.0)
+      rubocop (~> 1.0)
+      rubocop-ast (>= 1.1.0)
+    ruby-progressbar (1.11.0)
     simplecov (0.16.1)
       docile (~> 1.1)
       json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.2)
-    unicode-display_width (1.4.0)
-    webmock (3.4.2)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.0.0)
+    webmock (3.13.0)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
-      hashdiff
+      hashdiff (>= 0.4.0, < 2.0.0)
+    zeitwerk (2.4.2)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   hint-rubocop_style (~> 0)
-  pry (~> 0)
+  pry-byebug
   rspec (~> 3.8)
   rspec_junit_formatter (~> 0.4.1)
   simplecov (~> 0.16.1)
@@ -88,4 +122,4 @@ DEPENDENCIES
   zoom_rb!
 
 BUNDLED WITH
-   1.17.1
+   2.2.32

data/Makefile

@@ -2,4 +2,4 @@ help:
 	@echo "make console"
 
 console:
-	irb -rubygems -I lib -r zoom.rb
+	irb -r rubygems -I lib -r zoom.rb

data/README.md

@@ -18,20 +18,48 @@ Or install it yourself as:
 
 ## Usage
 
-```ruby
-require 'zoom'
+The Zoom API uses OAuth or JWT to [Authenticate](https://marketplace.zoom.us/docs/api-reference/Authentication) API request. By default, a JWT client will be used.
 
+```ruby
 Zoom.configure do |c|
   c.api_key = 'xxx'
   c.api_secret = 'xxx'
 end
 
 zoom_client = Zoom.new
+```
+
+To create an OAuth flow you need to make a call to auth, then create the client directly from an access token.
+
+First you need to get an auth_code externally from:
+```
+https://zoom.us/oauth/authorize?response_type=code&client_id=7lstjKqdwjett_kwjwDSEQ&redirect_uri=https://yourapp.com
+```
+
+Which will result in a redirect to your app with code in the url params
 
+then use this code to get an access token and a refresh token.
+
+```ruby
+auth = Zoom::Client::OAuth.new(auth_code: auth_code, redirect_uri: redirect_uri, timeout: 15).auth
+
+zoom_client = Zoom::Client::OAuth.new(access_token: auth['access_token'], timeout: 15)
+```
+
+You can also make a call to refresh with auth using an auth_token and a refresh_token
+```ruby
+client = Zoom::Client::OAuth.new(auth_token: auth_token, refresh_token: refresh_token).auth
+
+zoom_client = Zoom::Client::OAuth.new(access_token: 'xxx', timeout: 15)
+```
+
+With the zoom client, access the API
+
+```ruby
 user_list = zoom_client.user_list
 user_list['users'].each do |user|
   user_id = user['id']
-  puts zoom_client.meeting_list(host_id: user_id)
+  puts zoom_client.meeting_list(user_id: user_id)
 end
 
 begin

data/lib/zoom/actions/account.rb

@@ -3,91 +3,33 @@
 module Zoom
   module Actions
     module Account
-      def account_list(*args)
-        # TODO: implement accounts_list
-        # options = Utils.extract_options!(args)
-        raise Zoom::NotImplemented, 'accounts_list is not yet implemented'
-      end
+      extend Zoom::Actions
 
-      def account_create(*args)
-        # TODO: implement accounts_create
-        # options = Utils.extract_options!(args)
-        raise Zoom::NotImplemented, 'accounts_create is not yet implemented'
-      end
+      get 'account_list', '/accounts',
+        permit: %i[page_size page_number]
 
-      def account_get(*args)
-        # TODO: implement account_get
-        # options = Utils.extract_options!(args)
-        raise Zoom::NotImplemented, 'account_get is not yet implemented'
-      end
+      post 'account_create', '/accounts',
+        require: %i[first_name last_name email password],
+        permit: { options: %i[share_rc room_connectors share_mc meeting_connectors pay_mode] }
 
-      def account_delete(*args)
-        # TODO: implement account_delete
-        # options = Utils.extract_options!(args)
-        raise Zoom::NotImplemented, 'account_delete is not yet implemented'
-      end
+      get 'account_get', '/accounts/:account_id'
 
-      def account_options_update(*args)
-        # TODO: implement account_options_update
-        # options = Utils.extract_options!(args)
-        raise Zoom::NotImplemented, 'account_options_update is not yet implemented'
-      end
+      delete 'account_delete', '/accounts/:account_id'
 
-      def account_settings_get(*args)
-        # TODO: implement account_settings_get
-        # options = Utils.extract_options!(args)
-        raise Zoom::NotImplemented, 'account_settings_get is not yet implemented'
-      end
+      patch 'account_options_update', '/accounts/:account_id/options',
+        permit: %i[share_rc room_connectors share_mc meeting_connectors pay_mode]
 
-      def account_settings_update(*args)
-        # TODO: implement account_settings_update
-        # options = Utils.extract_options!(args)
-        raise Zoom::NotImplemented, 'account_settings_update is not yet implemented'
-      end
+      get 'account_settings_get', '/accounts/:account_id/settings',
+        permit: :option
 
-      # Billing related API Endpoints
+      patch 'account_settings_update', '/accounts/:account_id/settings',
+        permit: [:option, Zoom::Constants::Account::Settings::PERMITTED_KEYS]
 
-      def account_billing_get(*args)
-        # TODO: implement account_billing_get
-        # options = Utils.extract_options!(args)
-        raise Zoom::NotImplemented, 'account_billing_get is not yet implemented'
-      end
+      get 'account_managed_domains', '/accounts/:account_id/managed_domains'
 
-      def account_billing_update(*args)
-        # TODO: implement account_billing_update
-        # options = Utils.extract_options!(args)
-        raise Zoom::NotImplemented, 'account_billing_update is not yet implemented'
-      end
+      get 'account_get_locked_settings', '/accounts/:account_id/lock_settings'
 
-      def account_plans_list(*args)
-        # TODO: implement account_plans_list
-        # options = Utils.extract_options!(args)
-        raise Zoom::NotImplemented, 'account_plans_list is not yet implemented'
-      end
-
-      def some_method(*args)
-        # TODO: implement some_method
-        # options = Utils.extract_options!(args)
-        raise Zoom::NotImplemented, 'some_method is not yet implemented'
-      end
-
-      def some_method(*args)
-        # TODO: implement some_method
-        # options = Utils.extract_options!(args)
-        raise Zoom::NotImplemented, 'some_method is not yet implemented'
-      end
-
-      def some_method(*args)
-        # TODO: implement some_method
-        # options = Utils.extract_options!(args)
-        raise Zoom::NotImplemented, 'some_method is not yet implemented'
-      end
-
-      def some_method(*args)
-        # TODO: implement some_method
-        # options = Utils.extract_options!(args)
-        raise Zoom::NotImplemented, 'some_method is not yet implemented'
-      end
+      get 'account_trusted_domains', '/accounts/:account_id/trusted_domains'
     end
   end
-end
+end

data/lib/zoom/actions/billing.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Zoom
+  module Actions
+    module Billing
+      extend Zoom::Actions
+
+      get 'billing_get', '/accounts/:account_id/billing'
+
+      patch 'billing_update', '/accounts/:account_id/billing',
+        permit:  %i[first_name last_name email phone_number address apt city state zip country]
+
+      get 'billing_plans_list', '/accounts/:account_id/plans'
+
+      get 'billing_plans_usage', '/accounts/:account_id/plans/usage'
+
+      post 'billing_plans_subscribe', '/accounts/:account_id/plans',
+        require: {
+          contact: %i[first_name last_name email phone_number address city state zip country],
+          plan_base: %i[type hosts]
+        },
+        permit: [
+          :plan_recording,
+          {
+            contact: %i[apt],
+            plan_zoom_rooms: %i[type hosts],
+            plan_room_connector: %i[type hosts],
+            plan_large_meeting: %i[type hosts],
+            plan_zoom_events: %i[type hosts],
+            plan_webinar: %i[type hosts],
+            plan_audio: %i[type tollfree_countries premium_countries callout_countries ddi_numbers],
+            plan_phone: {
+              plan_base: %i[type callout_countries],
+              plan_calling: %i[type hosts],
+              plan_number: %i[type hosts]
+            }
+          }
+        ]
+    end
+  end
+end

data/lib/zoom/actions/dashboard.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Zoom
+  module Actions
+    module Dashboard
+      extend Zoom::Actions
+
+      get 'dashboard_crc', '/metrics/crc',
+        require: %i[from to]
+
+      get 'dashboard_meetings', '/metrics/meetings',
+        require: %i[from to],
+        permit: %i[next_page_token page_size type]
+
+      get 'dashboard_meeting_details', '/metrics/meetings/:meeting_id',
+        permit: :type
+
+      get 'dashboard_meeting_participants', '/metrics/meetings/:meeting_id/participants',
+        permit: %i[next_page_token page_size type]
+    end
+  end
+end

data/lib/zoom/actions/groups.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Zoom
+  module Actions
+    module Groups
+      extend Zoom::Actions
+
+      get 'groups_list', '/groups'
+
+      get 'groups_get', '/groups/:group_id'
+
+      post 'group_create', '/groups',
+        permit: :name
+
+      patch 'group_update', '/groups/:group_id',
+        permit: :name
+    end
+  end
+end

data/lib/zoom/actions/im/chat.rb

@@ -4,23 +4,22 @@ module Zoom
   module Actions
     module IM
       module Chat
+        extend Zoom::Actions
+
+        get 'get_chat_channels', '/chat/channels/:channel_id'
+
+        get 'get_chat_user_channels', '/chat/users/:user_id/channels',
+          permit: %i[next_page_token page_size]
+
         # Get chat messages for a specified period.
-        def chat_get(*args)
-          options = Utils.extract_options!(args)
-          Utils.require_params(%i[access_token session_id from to], options)
-          # TODO handle date format for `from` and `to` params
-          # TODO implement `next_page_token`, will be returned whenever the set of available chat history list exceeds 100. The expiration period is 30 minutes.
-          Utils.parse_response self.class.post('/chat/get', query: options)
-        end
+        # TODO: implement `next_page_token`, will be returned whenever the set of available chat history list exceeds 100. The expiration period is 30 minutes.
+        get 'chat_get', '/chat/get',
+          require: [ :access_token, :session_id, :from, :to ]
 
         # Get chat history list for a specified time period.
-        def chat_list(*args)
-          options = Utils.extract_options!(args)
-          Utils.require_params(%i[access_token from to], options)
-          # TODO handle date format for `from` and `to` params
-          # TODO implement `next_page_token`, will be returned whenever the set of available chat history list exceeds 100. The expiration period is 30 minutes.
-          Utils.parse_response self.class.post('/chat/list', query: options)
-        end
+        # TODO: implement `next_page_token`, will be returned whenever the set of available chat history list exceeds 100. The expiration period is 30 minutes.
+        get 'chat_list', '/chat/list',
+          require: [ :access_token, :from, :to ]
       end
     end
   end