zoom_rb 0.10.0 → 1.0.2

data/lib/zoom/actions/webinar.rb

@@ -3,113 +3,66 @@
 module Zoom
   module Actions
     module Webinar
+      extend Zoom::Actions
+
       RECURRENCE_KEYS = %i[type repeat_interval weekly_days monthly_day monthly_week
                            monthly_week_day end_times end_date_time].freeze
-      SETTINGS_KEYS = %i[panelists_video practice_session hd_video approval_type
+      SETTINGS_KEYS = %i[host_video panelists_video practice_session hd_video approval_type
                          registration_type audio auto_recording enforce_login
                          enforce_login_domains alternative_hosts close_registration
-                         show_share_button allow_multiple_devices registrants_confirmation_email].freeze
-      def webinar_list(*args)
-        params = Zoom::Params.new(Utils.extract_options!(args))
-        params.require(:host_id).permit(:page_size, :page_number)
-        Utils.parse_response self.class.get("/users/#{params[:host_id]}/webinars", query: params, headers: request_headers)
-      end
-
-      def webinar_create(*args)
-        params = Zoom::Params.new(Utils.extract_options!(args))
-        params.require(:host_id).permit(:topic, :type, :start_time, :duration,
-                                        :timezone, :password, :agenda,
-                                        recurrence: RECURRENCE_KEYS,
-                                        settings: SETTINGS_KEYS)
-        # process recurrence keys based on constants
-        # process settings keys based on constants
-        Utils.parse_response self.class.post("/users/#{params[:host_id]}/webinars", body: params.except(:host_id).to_json, headers: request_headers)
-      end
+                         show_share_button allow_multiple_devices on_demand
+                         request_permission_to_unmute_participants global_dial_in_countries
+                         contact_name contact_email registrants_restrict_number
+                         post_webinar_survey survey_url registrants_email_notification
+                         meeting_authentication authentication_option
+                         authentication_domains registrants_confirmation_email question_answer].freeze
 
-      def webinar_get(*args)
-        params = Zoom::Params.new(Utils.extract_options!(args))
-        params.require(:id)
-        Utils.parse_response self.class.get("/webinars/#{params[:id]}", headers: request_headers)
-      end
+      get 'webinar_list', '/users/:host_id/webinars',
+        permit: %i[page_size page_number]
 
-      def webinar_update(*args)
-        params = Zoom::Params.new(Utils.extract_options!(args))
-        params.require(:id).permit(:topic, :type, :start_time, :duration,
-                                   :timezone, :password, :agenda,
-                                   recurrence: RECURRENCE_KEYS,
-                                   settings: SETTINGS_KEYS)
-        Utils.parse_response self.class.patch("/webinars/#{params[:id]}", body: params.except(:id).to_json, headers: request_headers)
-      end
+      # TODO: process recurrence keys based on constants
+      # TODO: process settings keys based on constants
+      post 'webinar_create', '/users/:host_id/webinars',
+        permit: [
+          :topic, :type, :start_time, :duration, :timezone, :password, :agenda,
+          { recurrence: RECURRENCE_KEYS, settings: SETTINGS_KEYS }
+        ]
 
-      def webinar_delete(*args)
-        params = Zoom::Params.new(Utils.extract_options!(args))
-        params.require(:id).permit(:occurrence_id)
-        Utils.parse_response self.class.delete("/webinars/#{params[:id]}", query: params.except(:id), headers: request_headers)
-      end
+      get 'webinar_get', '/webinars/:id'
 
-      def webinar_status_update(*args)
-        # TODO: implement webinar_panelists_list
-        # options = Utils.extract_options!(args)
-        raise Zoom::NotImplemented, 'webinar_status_update is not yet implemented'
-      end
+      patch 'webinar_update', '/webinars/:id',
+        permit: [
+          :topic, :type, :start_time, :duration, :timezone, :password, :agenda,
+          { recurrence: RECURRENCE_KEYS, settings: SETTINGS_KEYS }
+        ]
 
-      def webinar_panelists_list(*args)
-        # TODO: implement webinar_panelists_list
-        # options = Utils.extract_options!(args)
-        raise Zoom::NotImplemented, 'webinar_panelists_list is not yet implemented'
-      end
+      delete 'webinar_delete', '/webinars/:id',
+        permit: :occurrence_id
 
-      def webinar_panelist_add(*args)
-        # TODO: implement webinar_panelist_add
-        # options = Utils.extract_options!(args)
-        raise Zoom::NotImplemented, 'webinar_panelist_add is not yet implemented'
-      end
+      get 'webinar_registrants_list', '/webinars/:id/registrants',
+        permit: %i[occurrence_id status page_size page_number]
 
-      def webinar_panelists_delete_all(*args)
-        # TODO: implement webinar_panelists_delete_all
-        # options = Utils.extract_options!(args)
-        raise Zoom::NotImplemented, 'webinar_panelists_delete_all is not yet implemented'
-      end
+      post 'webinar_registrant_add', '/webinars/:id/registrants',
+        require: %i[email first_name last_name],
+        permit: %i[
+          occurrence_ids address city country zip state phone industry org job_title
+          purchasing_time_frame role_in_purchase_process no_of_employees comments custom_questions
+        ]
 
-      def webinar_panelist_delete(*args)
-        # TODO: implement webinar_panelist_delete
-        # options = Utils.extract_options!(args)
-        raise Zoom::NotImplemented, 'webinar_panelist_delete is not yet implemented'
-      end
+      put 'webinar_registrants_status_update', '/webinars/:id/registrants/status',
+        require: :action,
+        permit: [ :occurrence_id, registrants: [] ]
 
-      def webinar_registrants_list(*args)
-        params = Zoom::Params.new(Utils.extract_options!(args))
-        params.require(:id).permit(%i[occurrence_id status page_size page_number])
-        Utils.parse_response self.class.get("/webinars/#{params[:id]}/registrants", query: params.except(:id), headers: request_headers)
-      end
+      get 'past_webinar_list', '/past_webinars/:id/instances'
 
-      def webinar_registrant_add(*args)
-        params = Zoom::Params.new(Utils.extract_options!(args))
-        params.require(:id, :email, :first_name, :last_name)
-              .permit(%i[occurrence_ids address city country zip state phone
-                         industry org job_title purchasing_time_frame role_in_purchase_process
-                         no_of_employees comments custom_questions])
-        Utils.parse_response self.class.post("/webinars/#{params[:id]}/registrants", body: params.except(:id, :occurrence_ids).to_json, query: params.slice(:occurrence_ids), headers: request_headers)
-      end
+      get 'webinar_registrant_get', '/webinars/:webinar_id/registrants/:id',
+        permit: :occurrence_id
 
-      def webinar_registrants_status_update(*args)
-        params = Zoom::Params.new(Utils.extract_options!(args))
-        params.require(:id, :action)
-              .permit(:occurrence_id, registrants: [])
-        Utils.parse_response self.class.put("/webinars/#{params[:id]}/registrants/status", body: params.except(:id, :occurrence_ids).to_json, query: params.slice(:occurrence_ids), headers: request_headers)
-      end
+      get 'webinar_polls_list', '/webinars/:webinar_id/polls'
 
-      def past_webinar_list(*args)
-        params = Zoom::Params.new(Utils.extract_options!(args))
-        params.require(:id)
-        Utils.parse_response self.class.get("/past_webinars/#{params[:id]}/instances", headers: request_headers)
-      end
+      get 'webinar_poll_get', '/webinars/:webinar_id/polls/:poll_id'
 
-      def webinar_registrant_get(*args)
-        params = Zoom::Params.new(Utils.extract_options!(args))
-        params.require(:webinar_id, :id).permit(:occurrence_id)
-        Utils.parse_response self.class.get("/webinars/#{params[:webinar_id]}/registrants/#{params[:id]}", query: params.except(:webinar_id, :id), headers: request_headers)
-      end
+      get 'webinar_panelist_list', '/webinars/:webinar_id/panelists'
     end
   end
 end

data/lib/zoom/actions.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module Zoom
+  module Actions
+    def self.extract_path_keys(path)
+      path.scan(/:\w+/).map { |match| match[1..].to_sym }
+    end
+
+    def self.parse_path(path, path_keys, params)
+      parsed_path = path.dup
+      path_keys.each do |key|
+        value        = params[key].to_s
+        parsed_path  = parsed_path.sub(":#{key}", value)
+      end
+      parsed_path
+    end
+
+    def self.determine_request_options(client, oauth)
+      if oauth
+        {
+          headers: client.oauth_request_headers,
+          base_uri: 'https://zoom.us/'
+        }
+      else
+        { headers: client.request_headers }
+      end
+    end
+
+    def self.make_request(client, method, parsed_path, params, request_options)
+      case method
+      when :get
+        request_options[:query] = params
+      when :post, :put, :patch
+        request_options[:body] = params.to_json
+      end
+      client.class.public_send(method, parsed_path, **request_options)
+    end
+
+    [:get, :post, :patch, :put, :delete].each do |method|
+      define_method(method) do |name, path, options={}|
+        required, permitted, oauth = options.values_at :require, :permit, :oauth
+        required = Array(required) unless required.is_a?(Hash)
+        permitted = Array(permitted) unless permitted.is_a?(Hash)
+
+        define_method(name) do |*args|
+          path_keys = Zoom::Actions.extract_path_keys(path)
+          params = Zoom::Params.new(Utils.extract_options!(args))
+          parsed_path = Zoom::Actions.parse_path(path, path_keys, params)
+          request_options = Zoom::Actions.determine_request_options(self, oauth)
+          params = params.require(path_keys) unless path_keys.empty?
+          params_without_required = required.empty? ? params : params.require(required)
+          params_without_required.permit(permitted) unless permitted.empty?
+          response = Zoom::Actions.make_request(self, method, parsed_path, params, request_options)
+          Utils.parse_response(response)
+        end
+      end
+    end
+  end
+end

data/lib/zoom/client.rb

@@ -6,14 +6,19 @@ module Zoom
   class Client
     include HTTParty
     include Actions::Account
-    include Actions::Group
+    include Actions::Billing
+    include Actions::Dashboard
+    include Actions::Groups
     include Actions::M323Device
-    include Actions::User
     include Actions::Meeting
-    include Actions::Metrics
-    include Actions::Webinar
-    include Actions::Report
+    include Actions::Phone
     include Actions::Recording
+    include Actions::Report
+    include Actions::Roles
+    include Actions::SipAudio
+    include Actions::Token
+    include Actions::User
+    include Actions::Webinar
     include Actions::IM::Chat
     include Actions::IM::Group
 
@@ -21,13 +26,28 @@ module Zoom
     headers 'Accept' => 'application/json'
     headers 'Content-Type' => 'application/json'
 
-    def request_headers
+    def headers
       {
         'Accept' => 'application/json',
         'Content-Type' => 'application/json',
-        'Authorization' => "Bearer #{access_token}"
       }
     end
+
+    def oauth_request_headers
+      {
+        'Authorization' => "Basic #{auth_token}"
+      }.merge(headers)
+    end
+
+    def request_headers
+      {
+        'Authorization' => "Bearer #{access_token}"
+      }.merge(headers)
+    end
+
+    def auth_token
+      Base64.encode64("#{Zoom.configuration.api_key}:#{Zoom.configuration.api_secret}").delete("\n")
+    end
   end
 end
 

data/lib/zoom/clients/oauth.rb

@@ -3,14 +3,57 @@
 module Zoom
   class Client
     class OAuth < Zoom::Client
+      attr_reader :access_token, :refresh_token, :expires_in, :expires_at
+
+      # Auth_token is sent in the header
+      # (auth_code, auth_token, redirect_uri) -> oauth API
+      # Returns (access_token, refresh_token)
+      #
+      # (auth_token, refresh_token) -> oauth refresh API
+      # Returns (access_token, refresh_token)
+      #
       def initialize(config)
-        Zoom::Params.new(config).require(:access_token)
+        Zoom::Params.new(config).permit( %i[auth_token auth_code redirect_uri access_token refresh_token timeout])
+        Zoom::Params.new(config).require_one_of(%i[access_token refresh_token auth_code])
+        if (config.keys & [:auth_code, :redirect_uri]).any?
+          Zoom::Params.new(config).require( %i[auth_code redirect_uri])
+        end
+
         config.each { |k, v| instance_variable_set("@#{k}", v) }
         self.class.default_timeout(@timeout || 20)
       end
 
-      def access_token
-        @access_token
+      def auth
+        refresh_token ? refresh : oauth
+      end
+
+      def refresh
+        response = refresh_tokens(refresh_token: @refresh_token)
+        set_tokens(response)
+        response
+      end
+
+      def oauth
+        response = access_tokens(auth_code: @auth_code, redirect_uri: @redirect_uri)
+        set_tokens(response)
+        response
+      end
+
+      def revoke
+        response = revoke_tokens(access_token: @access_token)
+        set_tokens(response)
+        response
+      end
+
+      private
+
+      def set_tokens(response)
+        if response.is_a?(Hash) && !response.key?(:error)
+          @access_token = response["access_token"]
+          @refresh_token = response["refresh_token"]
+          @expires_in = response["expires_in"]
+          @expires_at = @expires_in ? (Time.now + @expires_in).to_i : nil
+        end
       end
     end
   end

data/lib/zoom/constants/account/options/pay_modes.rb

@@ -0,0 +1,12 @@
+module Zoom
+  module Constants
+    module Account
+      module Options
+        PAY_MODES = {
+          'master' => 'Master account holder pays', # default
+          'sub' => 'Sub account holder pays'
+        }.freeze
+      end
+    end
+  end
+end

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