zoom_rb 0.8.1

data/lib/zoom/client.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require 'httparty'
+require 'json'
+require 'jwt'
+
+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 initialize(config)
+      Utils.require_params(%i[api_key api_secret], config)
+      config.each { |k, v| instance_variable_set("@#{k}", v) }
+      self.class.default_timeout(@timeout)
+    end
+
+    def access_token
+      JWT.encode({ iss: @api_key, exp: Time.now.to_i + @timeout }, @api_secret, 'HS256', { typ: 'JWT' })
+    end
+  end
+end

data/lib/zoom/defaults.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+module Zoom
+  class Defaults
+    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
+  end
+end

data/lib/zoom/error.rb

@@ -0,0 +1,9 @@
+# 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
+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,64 @@
+# frozen_string_literal: true
+require 'pry'
+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
+  end
+end

data/lib/zoom/utils.rb

@@ -0,0 +1,74 @@
+# 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'] == 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)
+        response = http_response.parsed_response
+        response.nil? ? http_response.code : JSON.parse(response)
+      end
+
+      def require_params(params, options)
+        params = [params] unless params.is_a? Array
+        params.each do |param|
+          raise argument_error(param.to_s) unless options[param]
+        end
+      end
+
+      def permit_params(params, options)
+        params = [params] unless params.is_a? Array
+        options.keys.each do |key|
+          raise exclude_argument_error(key.to_s) unless params.include?(key)
+        end
+      end
+
+      # Dynamically defines bang methods for Actions modules
+      def define_bang_methods(klass)
+        klass.instance_methods.each do |m|
+          klass.send(:define_method, "#{m}!") do |*args|
+            response = send(m, *args)
+            Utils.raise_if_error!(response)
+          end
+        end
+      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/spec/fixtures/chat/get.json

@@ -0,0 +1,16 @@
+{
+  "session_id": "123456",
+  "group_name": "zoom",
+  "from": "2018-08-28",
+  "to": "2018-08-29",
+  "page_size": 30,
+  "page_count": 1,
+  "next_page_token": "",
+  "chat_messages": [
+    {
+      "message": "test1",
+      "sender": "",
+      "date_time": "2016-01-18T06:40:56Z"
+    }
+  ]
+}

data/spec/fixtures/chat/list.json

@@ -0,0 +1,16 @@
+{
+  "from": "2018-08-28",
+  "to": "2018-08-29",
+  "page_size": 30,
+  "page_count": 1,
+  "next_page_token": "",
+  "chat_list": [
+    {
+      "session_id": "555",
+      "type": "Group",
+      "participants": "",
+      "group_name": "zoom test1",
+      "last_message_send_time": "2016-01-18T06:40:56Z"
+    }
+  ]
+}

data/spec/fixtures/error/validation.json

@@ -0,0 +1,10 @@
+{
+  "code": 300,
+  "message": "Validation Failed.",
+  "errors": [
+    {
+      "field": "user_info.type",
+      "message": "Missing field."
+    }
+  ]
+}

data/spec/fixtures/mc_recording_list.json

@@ -0,0 +1,51 @@
+{
+"page_count": 1,
+"page_number": 1,
+"page_size": 15,
+"total_records": 1,
+"meetings": [{
+    "uuid": "j0N0YDBYSQGB4fRv444444==",
+    "meeting_number": 7565121024,
+    "host_id": "kEFomHcIRgqxZT8D086O6A",
+"account_id": "NyEqCEoYSNOr4jLMHoO2tA",
+    "topic": "Rcoky test recording delete",
+    "start_time": "2014-11-06T04:10:10Z",
+"timezone": "America/Los_Angeles",
+    "duration": 999,
+    "total_size": 4324324324,
+    "recording_count": 4,
+    "recording_files": [{
+        "id": "00401415-6783-0B14-608A-34C1DD9E3041",
+        "meeting_id": "j0N0YDBYSQGB4fRv444444==",
+        "recording_start": "2014-11-06T04:14:10Z",
+        "recording_end": "2014-11-06T04:24:10Z",
+        "file_type": "M4A",
+        "file_size": 432432,
+        "play_url": "https://brand.zoom.us/recording/play/00401415-6783-0B14-608A-34C1DD9E3041"
+    }, {
+        "id": "00401415-6783-0B14-608A-34C1DD9E3042",
+        "meeting_id": "j0N0YDBYSQGB4fRv444444==",
+        "recording_start": "2014-11-06T04:25:10Z",
+        "recording_end": "2014-11-06T04:26:10Z",
+        "file_type": "MP4",
+        "file_size": 432532465,
+        "play_url": "https://brand.zoom.us/recording/play/00401415-6783-0B14-608A-34C1DD9E3042"
+    }, {
+        "id": "00401415-6783-0B14-608A-34C1DD9E3043",
+        "meeting_id": "j0N0YDBYSQGB4fRv444444==",
+        "recording_start": "2014-11-06T04:36:10Z",
+        "recording_end": "2014-11-06T04:56:10Z",
+        "file_type": "M4A",
+        "file_size": 564,
+        "file_path": "/home/cmr-ssh/replay/2015/03/27/454289936/EDB9994C-8E0D-4688-B1CE-6460F2742A10/GMT20150327-083026_test-pmem-recording.mp4"
+    }, {
+        "id": "00401415-6783-0B14-608A-34C1DD9E3044",
+        "meeting_id": "j0N0YDBYSQGB4fRv444444==",
+        "recording_start": "2014-11-06T04:56:10Z",
+        "recording_end": "2014-11-06T04:56:12Z",
+        "file_type": "MP4",
+        "file_size": 643534,
+        "file_path": "/home/cmr-ssh/replay/2015/03/27/454289936/EDB9994C-8E0D-4688-B1CE-6460F2742A10/GMT20150327-083026_test-pmem-recording.mp4"
+    }]
+}]
+}

data/spec/fixtures/meeting/create.json

@@ -0,0 +1,24 @@
+{
+  "uuid": "unique_id",
+  "id": "123456789",
+  "start_url": "https://zoom.us/s/123456789?zak=xxxxxx",
+  "join_url": "https://zoom.us/j/123456789",
+  "created_at": "2012-11-25T12:00:00Z",
+  "host_id": "ufR93M2pRyy8ePFN92dttq",
+  "topic": "Foo",
+  "type": 2,
+  "option_jbh": false,
+  "option_start_type": "video",
+  "start_time": "2012-11-25T12:00:00Z",
+  "duration": 30,
+  "timezone": "America/Los_Angeles",
+  "password": "123",
+  "h323_password": "123456",
+  "option_host_video": false,
+  "option_participants_video": false,
+  "option_audio": "both",
+  "option_enforce_login": false,
+  "option_enforce_login_domains ": "",
+  "option_alternative_hosts": "",
+  "status": 0
+}

data/spec/fixtures/meeting/delete.json

@@ -0,0 +1,4 @@
+{
+  "id": "252482092",
+  "deleted_at": "2013-04-05T15:50:47Z"
+}

data/spec/fixtures/meeting/end.json

@@ -0,0 +1,4 @@
+{
+  "id": "123456789",
+  "ended_at": "2012-11-25T12:00:00Z"
+}

data/spec/fixtures/meeting/get.json

@@ -0,0 +1,34 @@
+{
+  "uuid": "unique_id",
+  "id": "123456789",
+  "host_id": "dh23hdu23gd",
+  "topic": "Zoom Meeting",
+  "password": "",
+  "h323_password": "",
+  "status": 0,
+  "option_jbh": false,
+  "option_start_type": "video",
+  "option_host_video": true,
+  "option_participants_video": true,
+  "option_cn_meeting": false,
+  "option_enforce_login": false,
+  "option_enforce_login_domains": "",
+  "option_in_meeting": false,
+  "option_audio": "both",
+  "option_alternative_hosts": "",
+  "option_use_pmi": false,
+  "type": 8,
+  "start_time": "2012-11-25T12:00:00Z",
+  "duration": 0,
+  "timezone": "Asia/Hong_Kong",
+  "start_url": "https://zoom.us/s/123456789?zpk=hs65q23kd9sqliy612h23k",
+  "join_url": "https://zoom.us/j/123456789",
+  "created_at": "2016-12-20T02:51:42Z",
+  "occurrences": [
+    {
+      "occurrence_id": "1483210260000",
+      "start_time": "2017-01-01T02:51:00Z",
+      "duration": 60
+    }
+  ]
+}