zoom_rb 0.10.0 → 0.11.0

data/lib/zoom/constants/account/settings/permitted_settings.rb

@@ -0,0 +1,125 @@
+module Zoom
+  module Constants
+    module Account
+      module Settings
+        PERMITTED_OPTIONS = %i[meeting_authentication recording_authentication]
+
+        PERMITTED_KEYS = {
+          schedule_meeting: %i[
+            host_video
+            participant_video
+            audio_type
+            join_before_host
+            enforce_login
+            enforce_login_with_domains
+            enforce_login_domains
+            not_store_meeting_topic
+            force_pmi_jbh_password
+            require_password_for_scheduling_new_meetings
+            require_password_for_scheduled_meetings
+            require_password_for_instant_meetings
+            require_password_for_pmi_meetings
+            use_pmi_for_scheduled_meetings
+            use_pmi_for_instant_meetings
+          ],
+          in_meeting: %i[
+            e2e_encryption
+            chat
+            private_chat
+            auto_saving_chat
+            feedback
+            post_meeting_feedback
+            co_host
+            polling
+            attendee_on_hold
+            show_meeting_control_toolbar
+            allow_show_zoom_windows
+            annotation
+            whiteboard
+            webinar_question_answer
+            anonymous_question_answer
+            breakout_room
+            closed_caption
+            far_end_camera_control
+            group_hd
+            virtual_background
+            watermark
+            alert_guest_join
+            auto_answer
+            p2p_connetion
+            p2p_ports
+            ports_range
+            sending_default_email_invites
+            use_html_format_email
+            dscp_marking
+            dscp_audio
+            dscp_video
+            stereo_audio
+            original_audio
+            screen_sharing
+            remote_control
+          ],
+          email_notification: %i[
+            cloud_recording_avaliable_reminder
+            jbh_reminder
+            cancel_meeting_reminder
+            low_host_count_reminder
+            alternative_host_reminder
+          ],
+          zoom_rooms: %i[
+            upcoming_meeting_alert
+            start_airplay_manually
+            weekly_system_restart
+            list_meetings_with_calendar
+            zr_post_meeting_feedback
+            ultrasonic
+            force_private_meeting
+            hide_host_information
+            cmr_for_instant_meeting
+            auto_start_stop_scheduled_meetings
+          ],
+          security: %i[
+            admin_change_name_pic
+            import_photos_from_devices
+            hide_billing_info
+          ],
+          recording: %i[
+            local_recording
+            cloud_recording
+            record_speaker_view
+            record_gallery_view
+            record_audio_file
+            save_chat_text
+            show_timestamp
+            recording_audio_transcript
+            auto_recording
+            cloud_recording_download
+            cloud_recording_download_host
+            account_user_access_recording
+            auto_delete_cmr
+            auto_delete_cmr_days
+          ],
+          telephony: %i[
+            third_party_audio
+            audio_conference_info
+          ],
+          tsp: [
+            :call_out,
+            :show_international_numbers_link,
+            :display_toll_free_numbers,
+            { call_out_countries: [] }
+          ],
+          integration: %i[
+            google_calendar
+            google_drive
+            dropbox
+            box
+            microsoft_one_drive
+            kubi
+          ],
+          feature: :meeting_capacity
+        }.freeze
+      end
+    end
+  end
+end

data/lib/zoom/constants/constants.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require_relative 'account/options/pay_modes'
+require_relative 'account/settings/permitted_settings'
+require_relative 'meeting/approval_types'
+require_relative 'meeting/audio_type'
+require_relative 'meeting/auto_recording'
+require_relative 'meeting/registration_types'
+require_relative 'meeting/types'
+require_relative 'recurrence/monthly_weeks'
+require_relative 'recurrence/types'
+require_relative 'recurrence/weekly_days'
+require_relative 'user/create_types'
+require_relative 'user/types'
+require_relative 'webinar/approval_types'
+require_relative 'webinar/audio_type'
+require_relative 'webinar/auto_recording'
+require_relative 'webinar/registration_types'
+require_relative 'webinar/types'
+
+module Zoom
+  module Constants
+    IM_GROUP_TYPES = {
+      'normal' => 'Only members can see the group automatically. Other people can search members in the group.', # default
+      'shared' => 'All people in the account can see the group and members automatically',
+      'restricted' => 'Nobody can see the group or search members except the members in the group'
+    }.freeze
+
+    REGISTRANT_STATUS_ACTIONS = {
+      'Approve registrant' => 'approve',
+      'Cancel registrant' => 'cancel',
+      'Deny registrant' => 'deny'
+    }.freeze # no default
+  end
+end

data/lib/zoom/constants/meeting/approval_types.rb

@@ -0,0 +1,11 @@
+module Zoom
+  module Constants
+    module Meeting
+      APPROVAL_TYPES = {
+        'Automatically Approve' => 0,
+        'Manually Approve' => 1,
+        'No Registration Required' => 2 # default
+      }.freeze
+    end
+  end
+end

data/lib/zoom/constants/meeting/audio_type.rb

@@ -0,0 +1,11 @@
+module Zoom
+  module Constants
+    module Meeting
+      AUDIO_TYPE = {
+        'Both Telephony and VoIP' => 'both', # default
+        'Telephony only' => 'telephony',
+        'VoIP only' => 'voip'
+      }.freeze
+    end
+  end
+end

data/lib/zoom/constants/meeting/auto_recording.rb

@@ -0,0 +1,11 @@
+module Zoom
+  module Constants
+    module Meeting
+      AUTO_RECORDING = {
+        'Record to local device' => 'local',
+        'Record to cloud' => 'cloud',
+        'No Recording' => 'none' # default
+      }.freeze
+    end
+  end
+end

data/lib/zoom/constants/meeting/registration_types.rb

@@ -0,0 +1,11 @@
+module Zoom
+  module Constants
+    module Meeting
+      REGISTRATION_TYPES = {
+        'Attendees register once and can attend any of the occurrences' => 1, # default
+        'Attendees need to register for each occurrence to attend' => 2,
+        'Attendees register once and can choose one or more occurrences to attend' => 3
+      }.freeze
+    end
+  end
+end

data/lib/zoom/constants/meeting/types.rb

@@ -0,0 +1,12 @@
+module Zoom
+  module Constants
+    module Meeting
+      TYPES = {
+        1 => 'Instant Meeting',
+        2 => 'Scheduled Meeting', # default
+        3 => 'Recurring Meeting with no fixed time',
+        8 => 'Recurring Meeting with fixed time'
+      }.freeze
+    end
+  end
+end

data/lib/zoom/constants/recurrence/monthly_weeks.rb

@@ -0,0 +1,13 @@
+module Zoom
+  module Constants
+    module Recurrence
+      MONTHLY_WEEKS = {
+        -1 => 'Last week',
+        1 => 'First week',
+        2 => 'Second week',
+        3 => 'Third week',
+        4 => 'Fourth week'
+      }.freeze # no default
+    end
+  end
+end

data/lib/zoom/constants/recurrence/types.rb

@@ -0,0 +1,11 @@
+module Zoom
+  module Constants
+    module Recurrence
+      TYPES = {
+        1 => 'Daily',
+        2 => 'Weekly',
+        3 => 'Monthly'
+      }.freeze # no default
+    end
+  end
+end

data/lib/zoom/constants/recurrence/weekly_days.rb

@@ -0,0 +1,15 @@
+module Zoom
+  module Constants
+    module Recurrence
+      WEEKLY_DAYS = {
+        1 => 'Sunday',
+        2 => 'Monday',
+        3 => 'Tuesday',
+        4 => 'Wednesday',
+        5 => 'Thursday',
+        6 => 'Friday',
+        7 => 'Saturday'
+      }.freeze # no default
+    end
+  end
+end

data/lib/zoom/constants/user/create_types.rb

@@ -0,0 +1,12 @@
+module Zoom
+  module Constants
+    module User
+      CREATE_TYPES = {
+        'create' => 'User will get an email sent from Zoom. There is a confirmation link in this email. User will then need to click this link to activate their account to the Zoom service. The user can set or change their password in Zoom.',
+        'autoCreate' => 'This action is provided for enterprise customer who has a managed domain. This feature is disabled by default because of the security risk involved in creating a user who does not belong to your domain without notifying the user.',
+        'custCreate' => 'This action is provided for API partner only. User created in this way has no password and is not able to log into the Zoom web site or client.',
+        'ssoCreate' => 'This action is provided for enabled “Pre-provisioning SSO User” option. User created in this way has no password. If it is not a basic user, will generate a Personal Vanity URL using user name (no domain) of the provisioning email. If user name or pmi is invalid or occupied, will use random number/random personal vanity URL.'
+      }.freeze # no default
+    end
+  end
+end

data/lib/zoom/constants/user/types.rb

@@ -0,0 +1,11 @@
+module Zoom
+  module Constants
+    module User
+      TYPES = {
+        'basic' => 1,
+        'pro' => 2,
+        'corp' => 3
+      }.freeze # no default
+    end
+  end
+end

data/lib/zoom/constants/webinar/approval_types.rb

@@ -0,0 +1,11 @@
+module Zoom
+  module Constants
+    module Webinar
+      APPROVAL_TYPES = {
+        0 => 'Automatically Approve',
+        1 => 'Manually Approve',
+        2 => 'No Registration Required' # default
+      }.freeze
+    end
+  end
+end

data/lib/zoom/constants/webinar/audio_type.rb

@@ -0,0 +1,11 @@
+module Zoom
+  module Constants
+    module Webinar
+      AUDIO_TYPE = {
+        'Both Telephony and VoIP' => 'both', # default
+        'Telephony only' => 'telephony',
+        'VoIP only' => 'voip'
+      }.freeze
+    end
+  end
+end

data/lib/zoom/constants/webinar/auto_recording.rb

@@ -0,0 +1,11 @@
+module Zoom
+  module Constants
+    module Webinar
+      AUTO_RECORDING = {
+        'Record to local device' => 'local',
+        'Record to cloud' => 'cloud',
+        'No Recording' => 'none' # default
+      }.freeze
+    end
+  end
+end

data/lib/zoom/constants/webinar/registration_types.rb

@@ -0,0 +1,11 @@
+module Zoom
+  module Constants
+    module Webinar
+      REGISTRATION_TYPES = {
+        1 => 'Attendees register once and can attend any of the occurrences', # default
+        2 => 'Attendees need to register for each occurrence to attend',
+        3 => 'Attendees register once and can choose one or more occurrences to attend'
+      }.freeze
+    end
+  end
+end

data/lib/zoom/constants/webinar/types.rb

@@ -0,0 +1,11 @@
+module Zoom
+  module Constants
+    module Webinar
+      TYPES = {
+        5 => 'Webinar', # default
+        6 => 'Recurring Webinar with no fixed time',
+        9 => 'Recurring Webinar with fixed time'
+      }.freeze
+    end
+  end
+end

data/lib/zoom/error.rb

@@ -1,10 +1,18 @@
 # frozen_string_literal: true
 
 module Zoom
-  class Error < StandardError; end
+  class Error < StandardError
+    attr_reader :error_hash
+
+    def initialize(msg, error_hash={})
+      @error_hash = error_hash
+      super(msg)
+    end
+  end
   class GatewayTimeout < StandardError; end
   class NotImplemented < StandardError; end
   class ParameterMissing < StandardError; end
   class ParameterNotPermitted < StandardError; end
   class ParameterValueNotPermitted < StandardError; end
+  class AuthenticationError < StandardError; end
 end

data/lib/zoom/params.rb

@@ -1,24 +1,30 @@
 # frozen_string_literal: true
+require 'delegate'
 
 module Zoom
   class Params < SimpleDelegator
-    # delegate :keys, :key?, :has_key?, :values, :has_value?, :value?, :empty?,
-    #          :include?, :as_json, :to_s, :each_key, to: :@parameters
-
     def initialize(parameters = {})
       @parameters = parameters
       super
     end
 
+    def require(*entries)
+      missing_entries = find_missing_entries(entries)
+      return filter_required(entries.flatten) if missing_entries.empty?
+      raise Zoom::ParameterMissing, missing_entries.to_s
+    end
 
-    def require(*keys)
-      missing_keys = find_missing_keys(keys.flatten)
-      return self.class.new(except(keys)) if missing_keys.empty?
-      raise Zoom::ParameterMissing, missing_keys.to_s
+    def require_one_of(*keys)
+      required_keys = keys
+      keys = find_matching_keys(keys.flatten)
+      unless keys.any?
+        message = required_keys.length > 1 ? "You are missing atleast one of #{required_keys}" : required_keys
+        raise Zoom::ParameterMissing, message
+      end
     end
 
     def permit(*filters)
-      permitted_keys = filters.flatten.each_with_object([]) do |filter, array|
+      permitted_keys = filters.flatten.each.with_object([]) do |filter, array|
                          case filter
                          when Symbol, String
                            array << filter
@@ -55,15 +61,48 @@ module Zoom
       filter.keys
     end
 
-    def find_missing_keys(keys)
-      keys.each_with_object([]) do |k, array|
-        array << k if self[k].nil?
+    def filter_required(filters)
+      # Unless value is a hash, filter
+      filters.each.with_object(self.class.new(except(filters.flatten))) do |filter, params|
+        case filter
+        when Symbol, String
+          params.delete(filter)
+        when Hash
+          filter.each do |k, v|
+            nested_filter = self.class.new(self[k]).filter_required(v)
+            if nested_filter.empty?
+              params.delete(k)
+            else
+              params[k] = nested_filter
+            end
+          end
+        end
+      end
+    end
+
+    def find_missing_entries(*entries)
+      entries.flatten.each.with_object([]) do |entry, array|
+        if entry.is_a?(Hash)
+          entry.keys.each do |k|
+            array << k && next if self[k].nil?
+            missing_entries = self.class.new(self[k]).find_missing_entries(*entry[k])
+            array << { k => missing_entries } unless missing_entries.empty?
+          end
+        elsif self[entry].nil?
+          array << entry
+        end
+      end
+    end
+
+    def find_matching_keys(keys)
+      keys.flatten.each_with_object([]) do |key, array|
+        array << key if self[key]
       end
     end
 
     def permit_value(key, values)
       value = @parameters[key]
-      if !values.include?(value)
+      unless !value || values.include?(value)
         raise Zoom::ParameterValueNotPermitted, "#{key}: #{value}"
       end
     end