zoom_markazuna 0.10.0

data/lib/zoom/client.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'httparty'
+
+module Zoom
+  class Client
+    include HTTParty
+    include Actions::Account
+    include Actions::Group
+    include Actions::M323Device
+    include Actions::User
+    include Actions::Meeting
+    include Actions::Metrics
+    include Actions::Webinar
+    include Actions::Report
+    include Actions::Recording
+    include Actions::IM::Chat
+    include Actions::IM::Group
+
+    base_uri 'https://api.zoom.us/v2'
+    headers 'Accept' => 'application/json'
+    headers 'Content-Type' => 'application/json'
+
+    def request_headers
+      {
+        'Accept' => 'application/json',
+        'Content-Type' => 'application/json',
+        'Authorization' => "Bearer #{access_token}"
+      }
+    end
+  end
+end
+
+require 'zoom/clients/jwt'
+require 'zoom/clients/oauth'

data/lib/zoom/clients/jwt.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+require 'jwt'
+
+module Zoom
+  class Client
+    class JWT < Zoom::Client
+
+      def initialize(config)
+        Zoom::Params.new(config).require(:api_key, :api_secret)
+        config.each { |k, v| instance_variable_set("@#{k}", v) }
+        self.class.default_timeout(@timeout || 20)
+      end
+
+      def access_token
+        ::JWT.encode({ iss: @api_key, exp: Time.now.to_i + @timeout }, @api_secret, 'HS256', { typ: 'JWT' })
+      end
+
+    end
+  end
+end
+
+

data/lib/zoom/clients/oauth.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Zoom
+  class Client
+    class OAuth < Zoom::Client
+      def initialize(config)
+        Zoom::Params.new(config).require(:access_token)
+        config.each { |k, v| instance_variable_set("@#{k}", v) }
+        self.class.default_timeout(@timeout || 20)
+      end
+
+      def access_token
+        @access_token
+      end
+    end
+  end
+end

data/lib/zoom/constants.rb

@@ -0,0 +1,103 @@
+# frozen_string_literal: true
+
+module Zoom
+  class Constants
+    ACCOUNT_OPTIONS_PAY_MODES = { 'Master account holder pays' => 'master', # default
+                                  'Sub account holder pays' => 'sub'
+                                }.freeze
+
+    IM_GROUP_TYPES = { 'Only members can see the group automatically. Other people can search members in the group.' => 'normal', # default
+                       'All people in the account can see the group and members automatically' => 'shared',
+                       'Nobody can see the group or search members except the members in the group' => 'restricted'
+                      }.freeze
+
+    RECURRENCE_TYPES = { 'Daily' => 1,
+                         'Weekly' => 2,
+                         'Monthly' => 3
+                        }.freeze # no default
+
+    RECURRENCE_WEEKLY_DAYS = { 'Sunday' => 1,
+                              'Monday' => 2,
+                              'Tuesday' => 3,
+                              'Wednesday' => 4,
+                              'Thursday' => 5,
+                              'Friday' => 6,
+                              'Saturday' => 7
+                            }.freeze # no default
+
+    RECURRENCE_MONTHLY_WEEKS = { 'Last week' => -1,
+                                 'First week' => 1,
+                                 'Second week' => 2,
+                                 'Third week' => 3,
+                                 'Fourth week' => 4
+                                }.freeze # no default
+
+    MEETING_TYPES = { 'Instant Meeting' => 1,
+                      'Scheduled Meeting' => 2, # default
+                      'Recurring Meeting with no fixed time' => 3,
+                      'Recurring Meeting with fixed time' => 8
+                    }.freeze
+
+    MEETING_APPROVAL_TYPES = { 'Automatically Approve' => 0,
+                               'Manually Approve' => 1,
+                               'No Registration Required' => 2 # default
+                              }.freeze
+
+    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
+
+    MEETING_AUDIO_TYPE = { 'Both Telephony and VoIP' => 'both', # default
+                           'Telephony only' => 'telephony',
+                           'VoIP only' => 'voip'
+                          }.freeze
+
+    MEETING_AUTO_RECORDING = { 'Record to local device' => 'local',
+                               'Record to cloud' => 'cloud',
+                               'No Recording' => 'none' # default
+                              }.freeze
+
+    REGISTRANT_STATUS_ACTIONS = { 'Approve registrant' => 'approve',
+                                  'Cancel registrant' => 'cancel',
+                                  'Deny registrant' => 'deny'
+                                }.freeze # no default
+
+    WEBINAR_TYPES = { 'Webinar' => 5, # default
+                      'Recurring Webinar with no fixed time' => 6,
+                      'Recurring Webinar with fixed time' => 9
+                    }.freeze
+
+    WEBINAR_APPROVAL_TYPES = { 'Automatically Approve' => 0,
+                               'Manually Approve' => 1,
+                               'No Registration Required' => 2 # default
+                              }.freeze
+
+    WEBINAR_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
+
+    WEBINAR_AUDIO_TYPE = { 'Both Telephony and VoIP' => 'both', # default
+                           'Telephony only' => 'telephony',
+                           'VoIP only' => 'voip'
+                          }.freeze
+
+    WEBINAR_AUTO_RECORDING = { 'Record to local device' => 'local',
+                               'Record to cloud' => 'cloud',
+                               'No Recording' => 'none' # default
+                              }.freeze
+
+    USER_TYPES = { 'basic' => 1,
+                   'pro' => 2,
+                   'corp' => 3
+                  }.freeze # no default
+
+    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

data/lib/zoom/error.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Zoom
+  class Error < StandardError; end
+  class GatewayTimeout < StandardError; end
+  class NotImplemented < StandardError; end
+  class ParameterMissing < StandardError; end
+  class ParameterNotPermitted < StandardError; end
+  class ParameterValueNotPermitted < StandardError; end
+end

data/lib/zoom/interface.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Zoom
+  module Interface
+  end
+end

data/lib/zoom/params.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+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(*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
+    end
+
+    def permit(*filters)
+      permitted_keys = filters.flatten.each_with_object([]) do |filter, array|
+                         case filter
+                         when Symbol, String
+                           array << filter
+                         when Hash
+                           array << hash_filter(filter)
+                         end
+                       end
+      non_permitted_params = @parameters.keys - permitted_keys.flatten
+      raise Zoom::ParameterNotPermitted, non_permitted_params.to_s unless non_permitted_params.empty?
+    end
+
+    def except(*keys)
+      dup.except!(keys.flatten)
+    end
+
+    def except!(keys)
+      keys.each { |key| delete(key) }
+      self
+    end
+
+    EMPTY_ARRAY = [].freeze
+    EMPTY_HASH  = {}.freeze
+
+    def hash_filter(filter)
+      # Slicing filters out non-declared keys.
+      slice(*filter.keys).each do |key, value|
+        next unless value
+        next unless key? key
+        next if filter[key] == EMPTY_ARRAY
+        next if filter[key] == EMPTY_HASH
+        # Declaration { user: :name } or { user: [:name, :age, { address: ... }] }.
+        self.class.new(value).permit(filter[key])
+      end
+      filter.keys
+    end
+
+    def find_missing_keys(keys)
+      keys.each_with_object([]) do |k, array|
+        array << k if self[k].nil?
+      end
+    end
+
+    def permit_value(key, values)
+      value = @parameters[key]
+      if !values.include?(value)
+        raise Zoom::ParameterValueNotPermitted, "#{key}: #{value}"
+      end
+    end
+  end
+end

data/lib/zoom/utils.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Zoom
+  class Utils
+    class << self
+      def argument_error(name)
+        name ? ArgumentError.new("You must provide #{name}") : ArgumentError.new
+      end
+
+      def exclude_argument_error(name)
+        name ? ArgumentError.new("Unrecognized parameter #{name}") : ArgumentError.new
+      end
+
+      def raise_if_error!(response)
+        if response&.[]('code') && response['code'] >= 300
+          error_hash = { base: response['message']}
+          raise Error, error_hash unless response['errors']
+          error_hash[response['message']] = response['errors']
+          raise Error, error_hash
+        else
+          response
+        end
+      end
+
+      def parse_response(http_response)
+        raise_if_error!(http_response.parsed_response) || http_response.code
+      end
+
+      def extract_options!(array)
+        array.last.is_a?(::Hash) ? array.pop : {}
+      end
+
+      def validate_password(password)
+        password_regex = /\A[a-zA-Z0-9@-_*]{0,10}\z/
+        raise(Error , 'Invalid Password') unless password[password_regex].nil?
+      end
+
+      def process_datetime_params!(params, options)
+        params = [params] unless params.is_a? Array
+        params.each do |param|
+          if options[param] && options[param].kind_of?(Time)
+            options[param] = options[param].strftime('%FT%TZ')
+          end
+        end
+        options
+      end
+    end
+  end
+end

data/lib/zoom/version.rb

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

data/spec/fixtures/account/list.json

@@ -0,0 +1,18 @@
+{
+  "page_count": 1,
+  "page_number": 1,
+  "page_size": 10,
+  "total_records": 1,
+  "accounts": [
+    {
+      "id": "string [uuid]",
+      "account_name": "string",
+      "owner_email": "string",
+      "account_type": "string",
+      "seats": "integer",
+      "subscription_start_time": "string [date-time]",
+      "subscription_end_time": "string [date-time]",
+      "created_at": "string [date-time]"
+    }
+  ]
+}

data/spec/fixtures/account/settings_get.json

@@ -0,0 +1,120 @@
+{
+  "schedule_meting": {
+    "host_video": false,
+    "participant_video": false,
+    "audio_type": "both",
+    "join_before_host": false,
+    "use_pmi_for_scheduled_meetings": false,
+    "use_pmi_for_instant_meetings": false,
+    "enforce_login": false,
+    "enforce_login_with_domains": false,
+    "enforce_login_domains": "example.com",
+    "not_store_meeting_topic": false,
+    "force_pmi_jbh_password": false
+  },
+  "in_meeting": {
+    "e2e_encryption": false,
+    "chat": false,
+    "private_chat": false,
+    "auto_saving_chat": false,
+    "entry_exit_chime": "host",
+    "record_play_own_voice": false,
+    "file_transfer": false,
+    "feedback": false,
+    "post_meeting_feedback": false,
+    "co_host": false,
+    "polling": false,
+    "attendee_on_hold": false,
+    "show_meeting_control_toolbar": false,
+    "allow_show_zoom_windows": false,
+    "annotation": false,
+    "whiteboard": false,
+    "webinar_question_answer": false,
+    "anonymous_question_answer": false,
+    "breakout_room": false,
+    "closed_caption": false,
+    "far_end_camera_control": false,
+    "group_hd": false,
+    "virtual_background": false,
+    "watermark": false,
+    "alert_guest_join": false,
+    "auto_answer": false,
+    "p2p_connetion": false,
+    "p2p_ports": false,
+    "ports_range": "55,56",
+    "sending_default_email_invites": false,
+    "use_html_format_email": false,
+    "dscp_marking": false,
+    "dscp_audio": 42,
+    "dscp_video": 43,
+    "stereo_audio": false,
+    "original_audio": false,
+    "screen_sharing": false,
+    "remote_control": false,
+    "attention_tracking": false
+  },
+  "email_notification": {
+    "cloud_recording_avaliable_reminder": false,
+    "jbh_reminder": false,
+    "cancel_meeting_reminder": false,
+    "low_host_count_reminder": false,
+    "alternative_host_reminder": false,
+    "schedule_for_reminder": false
+  },
+  "zoom_rooms": {
+    "upcoming_meeting_alert": false,
+    "start_airplay_manually": false,
+    "weekly_system_restart": false,
+    "list_meetings_with_calendar": false,
+    "zr_post_meeting_feedback": false,
+    "ultrasonic": false,
+    "force_private_meeting": false,
+    "hide_host_information": false,
+    "cmr_for_instant_meeting": false,
+    "auto_start_stop_scheduled_meetings": false
+  },
+  "security": {
+    "admin_change_name_pic": false,
+    "import_photos_from_devices": false,
+    "hide_billing_info": false
+  },
+  "recording": {
+    "local_recording": false,
+    "cloud_recording": false,
+    "record_speaker_view": false,
+    "record_gallery_view": false,
+    "record_audio_file": false,
+    "save_chat_text": false,
+    "show_timestamp": false,
+    "recording_audio_transcript": false,
+    "auto_recording": "local",
+    "cloud_recording_download": false,
+    "cloud_recording_download_host": false,
+    "account_user_access_recording": false,
+    "auto_delete_cmr": false,
+    "auto_delete_cmr_days": 60
+  },
+  "telephony": {
+    "third_party_audio": false,
+    "audio_conference_info": "Magic third party auto conference info"
+  },
+  "tsp": {
+    "call_out": false,
+    "call_out_countries": [
+      "US"
+    ],
+    "show_international_numbers_link": false,
+    "display_toll_free_numbers": false
+  },
+  "integration": {
+    "google_calendar": false,
+    "google_drive": false,
+    "dropbox": false,
+    "box": false,
+    "microsoft_one_drive": false,
+    "kubi": false
+  },
+  "feature": {
+    "meeting_capacity": 500
+  }
+}