zoom_rb 1.1.8 → 1.1.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 87a9e2f7848d2e669f3e022e99e0efeaba1610e3021c904b7266a0bf4269d1c8
-  data.tar.gz: 891a47c991116c9df57217bcafc443e4f077709ed87499ee270a4c365526cbd3
+  metadata.gz: eba66b57716707ef68c2b32a14fe9befae24025bbf9f86a19e6af4595200eb4a
+  data.tar.gz: c467da5f5513c6af4ab2eabdaada0ad1284ce3991fd10a69b0b0e556d07e1b29
 SHA512:
-  metadata.gz: cdd836e38abf1363e152c21c2698b0575e2ce869fd473293affd8baa3a6b16c6d4c451f442f8b37a5dfe67ce8aa1c696d022b65afd21e9ec962c2984b1c66a40
-  data.tar.gz: '0677805581c425cf3ebd7e8a30bed630b626c16c54046977168761cf6abb1a6afab86e1ca04e875845fa4f62f0110c993535f0c026139dfad885f7396a508cec'
+  metadata.gz: b8097a2372ec570dc70515fb835077becd1ef1531180b790765c53b994fcad883203da966643f41072ce36cba632d4bac40ce12fc65286ad0cf90e00be033d79
+  data.tar.gz: 67c49dc2a4b6575064991cbaa499b36d94c9ce403db4fc0c866a1c668b247cb64708c4b81e959e1d8e6ddf95e23b37804a336aa4641275ef698e7f4181b8b007

data/.github/workflows/ruby.yml

@@ -10,7 +10,7 @@ jobs:
   test:
     strategy:
       matrix:
-        ruby: ['3.0', '3.1', '3.2']
+        ruby: ['3.0', '3.1', '3.2', '3.3']
     runs-on: ubuntu-latest
 
     steps:
@@ -37,4 +37,4 @@ jobs:
         uses: coverallsapp/github-action@v2
         with:
           parallel-finished: true
-          carryforward: "ruby-3.0,ruby-3.1,ruby-3.2"
+          carryforward: "ruby-3.0,ruby-3.1,ruby-3.2,ruby-3.3"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    zoom_rb (1.1.8)
+    zoom_rb (1.1.10)
       httparty (>= 0.13)
       json (>= 1.8)
       jwt
@@ -36,9 +36,9 @@ GEM
     i18n (1.12.0)
       concurrent-ruby (~> 1.0)
     json (2.6.3)
-    jwt (2.7.0)
+    jwt (2.7.1)
     method_source (1.0.0)
-    mini_mime (1.1.2)
+    mini_mime (1.1.5)
     minitest (5.18.0)
     multi_xml (0.6.0)
     parallel (1.22.1)

data/lib/zoom/actions/meeting.rb

@@ -13,7 +13,7 @@ module Zoom
       post 'meeting_create', '/users/:user_id/meetings',
         permit: %i[
           topic type start_time duration schedule_for timezone password default_password agenda tracking_fields
-          recurrence settings template_id
+          recurrence settings template_id pre_schedule
         ]
 
       # Get a meeting on Zoom via meeting ID, return the meeting info.
@@ -49,6 +49,9 @@ module Zoom
           language occurrence_ids auto_approve
         ]
 
+      # Delete a meeting registrant.
+      delete 'meeting_delete_registrant', '/meetings/:meeting_id/registrants/:registrant_id'
+
       # Register up to 30 registrants at once for a meeting that requires registration.
       post 'batch_registrants', '/meetings/:meeting_id/batch_registrants',
         permit: %i[registrants auto_approve registrants_confirmation_email]
@@ -75,6 +78,12 @@ module Zoom
 
       # Get a meeting on Zoom via meeting ID, return the meeting info.
       get 'meeting_invitation', '/meetings/:meeting_id/invitation'
+
+      # Support for meeting surveys
+      # https://developers.zoom.us/docs/api/rest/reference/zoom-api/methods/#operation/meetingSurveyGet
+      get "meeting_survey", "/meetings/:meeting_id/survey"
+      delete "meeting_delete_survey", "/meetings/:meeting_id/survey"
+      patch "meeting_update_survey", "/meetings/:meeting_id/survey"
     end
   end
 end

data/lib/zoom/actions/recording.rb

@@ -15,6 +15,11 @@ module Zoom
 
       get 'meeting_recording_settings_get', '/meetings/:meeting_id/recordings/settings'
 
+      get 'meeting_recording_analytics_summary', '/meetings/:meeting_id/recordings/analytics_summary'
+
+      get 'meeting_recording_analytics_details', '/meetings/:meeting_id/recordings/analytics_details',
+        permit: %i[page_size next_page_token from to type]
+
       patch 'meeting_recording_settings_update', '/meetings/:meeting_id/recordings/settings',
         permit: RECORDING_SETTINGS_KEYS
 

data/lib/zoom/actions/report.rb

@@ -11,10 +11,10 @@ module Zoom
       get 'meeting_details_report', '/report/meetings/:id'
 
       get 'meeting_participants_report', '/report/meetings/:id/participants',
-        permit: %i[page_size next_page_token]
+        permit: %i[page_size next_page_token include_fields]
 
       get 'webinar_participants_report', '/report/webinars/:id/participants',
-        permit: %i[page_size next_page_token]
+        permit: %i[page_size next_page_token include_fields]
 
       get 'webinar_details_report', '/report/webinars/:webinar_id'
     end

data/lib/zoom/actions/user.rb

@@ -21,7 +21,7 @@ module Zoom
         permit: :login_type
 
       patch 'user_update', '/users/:id',
-        permit: %i[first_name last_name type pmi timezone dept vanity_name host_key cms_user_id]
+        permit: %i[first_name last_name type pmi timezone dept vanity_name host_key cms_user_id custom_attributes]
 
       delete 'user_delete', '/users/:id',
         permit: %i[action transfer_email transfer_meeting transfer_webinar transfer_recording]
@@ -69,6 +69,8 @@ module Zoom
 
       patch 'user_status_update', '/users/:id/status',
         permit: :status
+
+      get 'user_zak', '/users/me/zak'
     end
   end
 end

data/lib/zoom/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Zoom
-  VERSION = '1.1.8'
+  VERSION = '1.1.10'
 end

data/spec/fixtures/meeting/get_survey.json

@@ -0,0 +1,21 @@
+{
+  "custom_survey": {
+    "title": "Feedback on your live lecture",
+    "anonymous": false,
+    "feedback": "Thank you so much for taking the time to complete the survey. Your feedback really makes a difference.",
+    "questions": [
+      {
+        "name": "How useful was this lecture?",
+        "type": "rating_scale",
+        "answer_required": true,
+        "rating_min_value": 1,
+        "rating_max_value": 5,
+        "rating_min_label": "There is room for improvement",
+        "rating_max_label": "Very useful, I feel I learned a lot"
+      }
+    ],
+    "numbered_questions": false,
+    "show_question_type": false
+  },
+  "show_in_the_browser": true
+}

data/spec/fixtures/recording/analytics_details.json

@@ -0,0 +1,15 @@
+{
+  "from":"2023-01-01",
+  "to":"2023-01-02",
+  "next_page_token":"",
+  "page_size":30,
+  "total_records":1,
+  "analytics_details": [
+    {
+      "name":"John Doe",
+      "email":"john.doe@example.com",
+      "duration":1234,
+      "date_time":"2023-01-01T11:25:01Z"
+    }
+  ]
+}

data/spec/fixtures/recording/analytics_summary.json

@@ -0,0 +1,16 @@
+{ 
+  "from":"2023-01-01",
+  "to":"2023-01-02",
+  "analytics_summary": [
+    {
+      "date":"2023-01-01",
+      "views_total_count":8,
+      "downloads_total_count":0
+    },
+    {
+      "date":"2023-01-02",
+      "views_total_count": 13,
+      "downloads_total_count": 1
+    }
+  ]
+}

data/spec/fixtures/user/zak.json

@@ -0,0 +1,3 @@
+{
+  "token": "eyJ0eXAiOiJKV1QiLCJzdiI6IjAwMDAwMSIsInptX3NrbSI6InptX28ybSIsImFsZyI6IkhTMjU2In0.eyJhdWQiOiJjb"
+}

data/spec/lib/zoom/actions/meeting/delete_registrant_spec.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Zoom::Actions::Meeting do
+  let(:zc) { zoom_client }
+  let(:args) { { meeting_id: 1, registrant_id: 'abcdef' } }
+
+  describe '#meeting_delete_registrant action' do
+    before :each do
+      stub_request(
+        :delete,
+        zoom_url("/meetings/#{args[:meeting_id]}/registrants/#{args[:registrant_id]}")
+      ).to_return(status: 204, headers: { 'Content-Type' => 'application/json' })
+    end
+
+    it "requires a 'meeting_id' and 'registrant_id' argument" do
+      expect {
+        zc.meeting_delete_registrant(filter_key(args, :meeting_id))
+      }.to raise_error(Zoom::ParameterMissing)
+      expect {
+        zc.meeting_delete_registrant(filter_key(args, :registrant_id))
+      }.to raise_error(Zoom::ParameterMissing)
+    end
+
+    it 'returns a status code of 204' do
+      expect(zc.meeting_delete_registrant(args)).to eq(204)
+    end
+  end
+end

data/spec/lib/zoom/actions/meeting/get_survey_spec.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Zoom::Actions::Meeting do
+  let(:zc) { zoom_client }
+  let(:args) { { meeting_id: 1 } }
+
+  describe '#meeting_survey action' do
+    before :each do
+      stub_request(
+        :get,
+        zoom_url("/meetings/#{args[:meeting_id]}/survey")
+      ).to_return(body: json_response('meeting', 'get_survey'), headers: { 'Content-Type' => 'application/json' })
+    end
+
+    it 'returns a hash' do
+      expect(zc.meeting_survey(args)).to be_kind_of(Hash)
+    end
+
+    it "returns survey properties" do
+      expect(zc.meeting_survey(args)['show_in_the_browser']).to eql(true)
+    end
+  end
+end

data/spec/lib/zoom/actions/recording/analytics_details_spec.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Zoom::Actions::Recording do
+  let(:zc) { zoom_client }
+  let(:args) { { meeting_id: 91538056781 } }
+
+  describe '#meeting_recording_analytics_details action' do
+    before :each do
+      stub_request(
+        :get,
+        zoom_url("/meetings/#{args[:meeting_id]}/recordings/analytics_details")
+      ).to_return(
+        status: 200,
+        body: json_response('recording', 'analytics_details'),
+        headers: { 'Content-Type' => 'application/json' }
+      )
+    end
+
+    it "requires a 'meeting_id' argument" do
+      expect {
+        zc.meeting_recording_analytics_details(filter_key(args, :meeting_id))
+      }.to raise_error(Zoom::ParameterMissing)
+    end
+
+    it 'returns a hash' do
+      expect(zc.meeting_recording_analytics_details(args)).to be_kind_of(Hash)
+    end
+
+    it "returns 'from'" do
+      expect(zc.meeting_recording_analytics_details(args)['from']).to eq('2023-01-01')
+    end
+
+    it "returns 'to'" do
+      expect(zc.meeting_recording_analytics_details(args)['to']).to eq('2023-01-02')
+    end
+
+    it "returns 'next_page_token'" do
+      expect(zc.meeting_recording_analytics_details(args)['next_page_token']).to eq('')
+    end
+
+    it "returns 'page_size'" do
+      expect(zc.meeting_recording_analytics_details(args)['page_size']).to eq(30)
+    end
+
+    it "returns 'total_records'" do
+      expect(zc.meeting_recording_analytics_details(args)['total_records']).to eq(1)
+    end
+
+    it "returns 'analytics_details' Array" do
+      expect(zc.meeting_recording_analytics_details(args)['analytics_details']).to be_kind_of(Array)
+    end
+
+  end
+end

data/spec/lib/zoom/actions/recording/analytics_summary_spec.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Zoom::Actions::Recording do
+  let(:zc) { zoom_client }
+  let(:args) { { meeting_id: 91538056781 } }
+
+  describe '#meeting_recording_analytics_summary action' do
+    before :each do
+      stub_request(
+        :get,
+        zoom_url("/meetings/#{args[:meeting_id]}/recordings/analytics_summary")
+      ).to_return(
+        status: 200,
+        body: json_response('recording', 'analytics_summary'),
+        headers: { 'Content-Type' => 'application/json' }
+      )
+    end
+
+    it "requires a 'meeting_id' argument" do
+      expect {
+        zc.meeting_recording_analytics_summary(filter_key(args, :meeting_id))
+      }.to raise_error(Zoom::ParameterMissing)
+    end
+
+    it 'returns a hash' do
+      expect(zc.meeting_recording_analytics_summary(args)).to be_kind_of(Hash)
+    end
+
+    it "returns 'from'" do
+      expect(zc.meeting_recording_analytics_summary(args)['from']).to eq('2023-01-01')
+    end
+
+    it "returns 'to'" do
+      expect(zc.meeting_recording_analytics_summary(args)['to']).to eq('2023-01-02')
+    end
+
+    it "returns 'analytics_summary' Array" do
+      expect(zc.meeting_recording_analytics_summary(args)['analytics_summary']).to be_kind_of(Array)
+    end
+
+  end
+end

data/spec/lib/zoom/actions/user/zak_spec.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Zoom::Actions::User do
+  let(:zc) { zoom_client }
+
+  describe '#user_zak action' do
+    context 'with a valid response' do
+      before :each do
+        stub_request(
+          :get,
+          zoom_url("/users/me/zak")
+        ).to_return(status: 200,
+                    body: json_response('user', 'zak'),
+                    headers: { 'Content-Type' => 'application/json' })
+      end
+
+      it 'returns a users zak token' do
+        res = zc.user_zak
+        expected_response = JSON.parse(json_response('user', 'zak'))
+        expect(res['token']).to eq(expected_response['token'])
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zoom_rb
 version: !ruby/object:Gem::Version
-  version: 1.1.8
+  version: 1.1.10
 platform: ruby
 authors:
 - Kyle Boe
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-04-10 00:00:00.000000000 Z
+date: 2024-01-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -254,11 +254,14 @@ files:
 - spec/fixtures/meeting/add_registrant.json
 - spec/fixtures/meeting/create.json
 - spec/fixtures/meeting/get.json
+- spec/fixtures/meeting/get_survey.json
 - spec/fixtures/meeting/instances.json
 - spec/fixtures/meeting/invitation.json
 - spec/fixtures/meeting/list.json
 - spec/fixtures/meeting/live_stream/errors/meeting_not_found.json
 - spec/fixtures/meeting/live_stream/errors/missing_field.json
+- spec/fixtures/recording/analytics_details.json
+- spec/fixtures/recording/analytics_summary.json
 - spec/fixtures/recording/get.json
 - spec/fixtures/recording/list.json
 - spec/fixtures/recording/settings/get.json
@@ -308,6 +311,7 @@ files:
 - spec/fixtures/user/update_password.json
 - spec/fixtures/user/update_status.json
 - spec/fixtures/user/vanity_name.json
+- spec/fixtures/user/zak.json
 - spec/fixtures/webinar/create.json
 - spec/fixtures/webinar/delete.json
 - spec/fixtures/webinar/list.json
@@ -382,13 +386,17 @@ files:
 - spec/lib/zoom/actions/ma/account/plan/update_spec.rb
 - spec/lib/zoom/actions/meeting/add_registrant_spec.rb
 - spec/lib/zoom/actions/meeting/create_spec.rb
+- spec/lib/zoom/actions/meeting/delete_registrant_spec.rb
 - spec/lib/zoom/actions/meeting/delete_spec.rb
 - spec/lib/zoom/actions/meeting/get_spec.rb
+- spec/lib/zoom/actions/meeting/get_survey_spec.rb
 - spec/lib/zoom/actions/meeting/invitation_spec.rb
 - spec/lib/zoom/actions/meeting/list_spec.rb
 - spec/lib/zoom/actions/meeting/livestream_spec.rb
 - spec/lib/zoom/actions/meeting/registrants/update_status_spec.rb
 - spec/lib/zoom/actions/meeting/update_spec.rb
+- spec/lib/zoom/actions/recording/analytics_details_spec.rb
+- spec/lib/zoom/actions/recording/analytics_summary_spec.rb
 - spec/lib/zoom/actions/recording/file_delete_spec.rb
 - spec/lib/zoom/actions/recording/get_spec.rb
 - spec/lib/zoom/actions/recording/list_spec.rb
@@ -446,6 +454,7 @@ files:
 - spec/lib/zoom/actions/user/update_spec.rb
 - spec/lib/zoom/actions/user/update_status_spec.rb
 - spec/lib/zoom/actions/user/vanity_name_spec.rb
+- spec/lib/zoom/actions/user/zak_spec.rb
 - spec/lib/zoom/actions/webinar/attendees_list_spec.rb
 - spec/lib/zoom/actions/webinar/create_spec.rb
 - spec/lib/zoom/actions/webinar/delete_spec.rb
@@ -482,7 +491,7 @@ homepage: https://github.com/hintmedia/zoom_rb
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -497,8 +506,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
-signing_key: 
+rubygems_version: 3.5.4
+signing_key:
 specification_version: 4
 summary: zoom.us API wrapper
 test_files:
@@ -545,11 +554,14 @@ test_files:
 - spec/fixtures/meeting/add_registrant.json
 - spec/fixtures/meeting/create.json
 - spec/fixtures/meeting/get.json
+- spec/fixtures/meeting/get_survey.json
 - spec/fixtures/meeting/instances.json
 - spec/fixtures/meeting/invitation.json
 - spec/fixtures/meeting/list.json
 - spec/fixtures/meeting/live_stream/errors/meeting_not_found.json
 - spec/fixtures/meeting/live_stream/errors/missing_field.json
+- spec/fixtures/recording/analytics_details.json
+- spec/fixtures/recording/analytics_summary.json
 - spec/fixtures/recording/get.json
 - spec/fixtures/recording/list.json
 - spec/fixtures/recording/settings/get.json
@@ -599,6 +611,7 @@ test_files:
 - spec/fixtures/user/update_password.json
 - spec/fixtures/user/update_status.json
 - spec/fixtures/user/vanity_name.json
+- spec/fixtures/user/zak.json
 - spec/fixtures/webinar/create.json
 - spec/fixtures/webinar/delete.json
 - spec/fixtures/webinar/list.json
@@ -673,13 +686,17 @@ test_files:
 - spec/lib/zoom/actions/ma/account/plan/update_spec.rb
 - spec/lib/zoom/actions/meeting/add_registrant_spec.rb
 - spec/lib/zoom/actions/meeting/create_spec.rb
+- spec/lib/zoom/actions/meeting/delete_registrant_spec.rb
 - spec/lib/zoom/actions/meeting/delete_spec.rb
 - spec/lib/zoom/actions/meeting/get_spec.rb
+- spec/lib/zoom/actions/meeting/get_survey_spec.rb
 - spec/lib/zoom/actions/meeting/invitation_spec.rb
 - spec/lib/zoom/actions/meeting/list_spec.rb
 - spec/lib/zoom/actions/meeting/livestream_spec.rb
 - spec/lib/zoom/actions/meeting/registrants/update_status_spec.rb
 - spec/lib/zoom/actions/meeting/update_spec.rb
+- spec/lib/zoom/actions/recording/analytics_details_spec.rb
+- spec/lib/zoom/actions/recording/analytics_summary_spec.rb
 - spec/lib/zoom/actions/recording/file_delete_spec.rb
 - spec/lib/zoom/actions/recording/get_spec.rb
 - spec/lib/zoom/actions/recording/list_spec.rb
@@ -737,6 +754,7 @@ test_files:
 - spec/lib/zoom/actions/user/update_spec.rb
 - spec/lib/zoom/actions/user/update_status_spec.rb
 - spec/lib/zoom/actions/user/vanity_name_spec.rb
+- spec/lib/zoom/actions/user/zak_spec.rb
 - spec/lib/zoom/actions/webinar/attendees_list_spec.rb
 - spec/lib/zoom/actions/webinar/create_spec.rb
 - spec/lib/zoom/actions/webinar/delete_spec.rb