zoom_rb 0.10.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: efbf20752dce2d7796dd85203549f9147fb81f74c98b5f3317a2d2e3dde68ebb
-  data.tar.gz: 7e71b22ccbe081f63521fea457a010c0ea48d53cbf307fee8d63e9df716b9500
+  metadata.gz: b1cd08a56da2851062cd381b62c75bc0fe3b5c1c809699fd6fa19e268799009c
+  data.tar.gz: 0a3b24e1e9c460d226590fac97a1c9a7af199ac2db72f85e68ceab3e38527f61
 SHA512:
-  metadata.gz: f56ec4c5410d86eaa83a10c89ccd29e5d5732effa3203a79c1b3506ffd532abda14090f704f09ded594b5c14c33015a0a786304b8a243b6f561e4e584d2808a5
-  data.tar.gz: 3d213b942fd24614dd323d4d2c45076b80cc6dfff483560cbc376630e8c046cfd443c7cfb2b86c7c6d6e04554496dfa6d92c0db565dc8335a17a5888bbc9d8ea
+  metadata.gz: 95585d7404c4473f0822e208f4cf517752933331c2f3fbc55fdd3658b11ce8511a572dd5ae2aff83aca9c8f27482f79a461284fe6f053ab42e9477def1b40f56
+  data.tar.gz: 5c871ea816c82b7ce03111988317c2b47a4334381902827b376d8ecf84aa220e401bd6be1c82d6ffd5632006d2abd144a2286612f123209a91d4e1f225f7680b

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/CHANGELOG.md

@@ -0,0 +1,15 @@
+# 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.10.0)
+    zoom_rb (0.11.0)
       httparty (~> 0.13)
       json (>= 1.8)
       jwt
@@ -9,82 +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.17.1)
+    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.18.1)
       mime-types (~> 3.0)
       multi_xml (>= 0.5.2)
-    jaro_winkler (1.5.1)
-    json (2.1.0)
-    jwt (2.2.1)
-    method_source (0.9.0)
-    mime-types (3.3)
+    i18n (1.8.10)
+      concurrent-ruby (~> 1.0)
+    json (2.5.1)
+    jwt (2.2.3)
+    method_source (1.0.0)
+    mime-types (3.3.1)
       mime-types-data (~> 3.2015)
-    mime-types-data (3.2019.1009)
+    mime-types-data (3.2021.0704)
+    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)
@@ -92,4 +122,4 @@ DEPENDENCIES
   zoom_rb!
 
 BUNDLED WITH
-   1.17.2
+   2.2.24

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,7 +18,7 @@ Or install it yourself as:
 
 ## Usage
 
-The Zoom API uses OAuth or JWT to [Authenticate](https://marketplace.zoom.us/docs/api-reference/Authentication) API request. By defaut, a JWT client will be used.
+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
 require 'zoom'
@@ -31,21 +31,39 @@ end
 zoom_client = Zoom.new
 ```
 
-To create an OAuth client, create the client directly
+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
 require 'zoom'
 
+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 client, access the API
+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

@@ -5,89 +5,64 @@ module Zoom
     module Account
       def account_list(*args)
         params = Zoom::Params.new(Utils.extract_options!(args))
-        params.permit(:page_size, :page_number)
-        Utils.parse_response self.class.get("/accounts", query: params, headers: request_headers)
+        params.permit(%i[page_size page_number])
+        Utils.parse_response self.class.get('/accounts', query: params, headers: request_headers)
       end
 
       def account_create(*args)
-        # TODO: implement accounts_create
-        # options = Utils.extract_options!(args)
-        raise Zoom::NotImplemented, 'accounts_create is not yet implemented'
+        params = Zoom::Params.new(Utils.extract_options!(args))
+        params.require(%i[first_name last_name email password]).permit(options: %i[share_rc room_connectors share_mc meeting_connectors pay_mode])
+        Utils.parse_response self.class.post('/accounts', body: params.to_json, headers: request_headers)
       end
 
       def account_get(*args)
-        # TODO: implement account_get
-        # options = Utils.extract_options!(args)
-        raise Zoom::NotImplemented, 'account_get is not yet implemented'
+        params = Zoom::Params.new(Utils.extract_options!(args))
+        params.require(:account_id)
+        Utils.parse_response self.class.get("/accounts/#{params[:account_id]}", headers: request_headers)
       end
 
       def account_delete(*args)
-        # TODO: implement account_delete
-        # options = Utils.extract_options!(args)
-        raise Zoom::NotImplemented, 'account_delete is not yet implemented'
+        params = Zoom::Params.new(Utils.extract_options!(args))
+        params.require(:account_id)
+        Utils.parse_response self.class.delete("/accounts/#{params[:account_id]}", headers: request_headers)
       end
 
       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'
+        params = Zoom::Params.new(Utils.extract_options!(args))
+        params.require(:account_id).permit(%i[share_rc room_connectors share_mc meeting_connectors pay_mode])
+        Utils.parse_response self.class.patch("/accounts/#{params[:account_id]}/options", body: params.except(:account_id).to_json, headers: request_headers)
       end
 
       def account_settings_get(*args)
         params = Zoom::Params.new(Utils.extract_options!(args))
-        params.require(:id)
-        Utils.parse_response self.class.get("/accounts/#{params[:id]}/settings", query: params.except(:id), headers: request_headers)
+        params.require(:account_id).permit(:option)
+        Utils.parse_response self.class.get("/accounts/#{params[:account_id]}/settings", query: params.except(:account_id), headers: request_headers)
       end
 
       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
-
-      # Billing related API Endpoints
-
-      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
-
-      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
-
-      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'
+        params = Zoom::Params.new(Utils.extract_options!(args))
+        params.require(:account_id).permit(:option, Zoom::Constants::Account::Settings::PERMITTED_KEYS)
+        params.permit_value(:option, Zoom::Constants::Account::Settings::PERMITTED_OPTIONS)
+        Utils.parse_response self.class.patch("/accounts/#{params[:account_id]}/settings", query: params.slice(:option), body: params.except(%i[account_id option]).to_json, headers: request_headers)
       end
 
-      def some_method(*args)
-        # TODO: implement some_method
-        # options = Utils.extract_options!(args)
-        raise Zoom::NotImplemented, 'some_method is not yet implemented'
+      def account_managed_domains(*args)
+        params = Zoom::Params.new(Utils.extract_options!(args))
+        params.require(:account_id)
+        Utils.parse_response self.class.get("/accounts/#{params[:account_id]}/managed_domains", headers: request_headers)
       end
 
-      def some_method(*args)
-        # TODO: implement some_method
-        # options = Utils.extract_options!(args)
-        raise Zoom::NotImplemented, 'some_method is not yet implemented'
+      def account_get_locked_settings(*args)
+        params = Zoom::Params.new(Utils.extract_options!(args))
+        params.require(:account_id)
+        Utils.parse_response self.class.get("/accounts/#{params[:account_id]}/lock_settings", headers: request_headers)
       end
 
-      def some_method(*args)
-        # TODO: implement some_method
-        # options = Utils.extract_options!(args)
-        raise Zoom::NotImplemented, 'some_method is not yet implemented'
+      def account_trusted_domains(*args)
+        params = Zoom::Params.new(Utils.extract_options!(args))
+        params.require(:account_id)
+        Utils.parse_response self.class.get("/accounts/#{params[:account_id]}/trusted_domains", headers: request_headers)
       end
     end
   end
-end
+end

data/lib/zoom/actions/billing.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Zoom
+  module Actions
+    module Billing
+      def billing_get(*args)
+        params = Zoom::Params.new(Utils.extract_options!(args))
+        params.require(:account_id)
+        Utils.parse_response self.class.get("/accounts/#{params[:account_id]}/billing", headers: request_headers)
+      end
+
+      def billing_update(*args)
+        params = Zoom::Params.new(Utils.extract_options!(args))
+        params.require(:account_id).permit(%i[first_name last_name email phone_number address apt city state zip country])
+        Utils.parse_response self.class.patch("/accounts/#{params[:account_id]}/billing", body: params.except(:account_id).to_json, headers: request_headers)
+      end
+
+      def billing_plans_list(*args)
+        params = Zoom::Params.new(Utils.extract_options!(args))
+        params.require(:account_id)
+        Utils.parse_response self.class.get("/accounts/#{params[:account_id]}/plans", headers: request_headers)
+      end
+
+      def billing_plans_usage(*args)
+        params = Zoom::Params.new(Utils.extract_options!(args))
+        params.require(:account_id)
+        Utils.parse_response self.class.get("/accounts/#{params[:account_id]}/plans/usage", headers: request_headers)
+      end
+
+      def billing_plans_subscribe(*args)
+        params = Zoom::Params.new(Utils.extract_options!(args))
+        # TODO: Move to constants and do some data validation
+        params.require(:account_id, contact: %i[first_name last_name email phone_number address city state zip country], plan_base: %i[type hosts]).permit(:plan_recording, contact: [:apt], plan_zoom_rooms: %i[type hosts], plan_room_connector: %i[type hosts], plan_large_meeting: [], plan_webinar: [], plan_audio: %i[type tollfree_countries premium_countries callout_countries ddi_numbers], plan_phone: { plan_base: %i[type hosts], plan_calling: [], plan_number: [] })
+        Utils.parse_response self.class.post("/accounts/#{params[:account_id]}/plans", body: params.except(:account_id).to_json, headers: request_headers)
+      end
+    end
+  end
+end

data/lib/zoom/actions/dashboard.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Zoom
+  module Actions
+    module Dashboard
+      def dashboard_crc(*args)
+        params = Zoom::Params.new(Utils.extract_options!(args))
+        params.require(%i[from to])
+        Utils.process_datetime_params!(%i[from to], params)
+        Utils.parse_response self.class.get('/metrics/crc', query: params, headers: request_headers)
+      end
+
+      def dashboard_meetings(*args)
+        params = Zoom::Params.new(Utils.extract_options!(args))
+        params.require(%i[from to]).permit(%i[next_page_token page_size type])
+        Utils.process_datetime_params!(%i[from to], params)
+        Utils.parse_response self.class.get('/metrics/meetings', query: params, headers: request_headers)
+      end
+
+      def dashboard_meeting_details(*args)
+        params = Zoom::Params.new(Utils.extract_options!(args))
+        params.require(:meeting_id).permit(:type)
+        Utils.parse_response self.class.get("/metrics/meetings/#{params[:meeting_id]}", query: params.except(:meeting_id), headers: request_headers)
+      end
+
+      def dashboard_meeting_participants(*args)
+        params = Zoom::Params.new(Utils.extract_options!(args))
+        params.require(:meeting_id).permit(%i[next_page_token page_size type])
+        Utils.parse_response self.class.get("/metrics/meetings/#{params[:meeting_id]}/participants", query: params.except(:meeting_id), headers: request_headers)
+      end
+    end
+  end
+end