zoom_rb 0.8.6 → 0.8.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 87d7cc4ec57a2ec29ae1f363155844a1dcab08454beb12dafa37c87b4c14d5c3
-  data.tar.gz: bce3d9b5ba1cb6da18f8d647c8f7f99aa333083360f121714ef455e1f7730818
+  metadata.gz: 9c6bdaacbf4a10b0f14d9cba48f13b9cccc9e7ed1d0aa3b5e9d20c4b7b0acefd
+  data.tar.gz: 80732724df8e317b58d7c9814db9862d429dac3ffbeff2535ab7bc28160bd5a9
 SHA512:
-  metadata.gz: 8d0cc2484ddfae76d99b745113e2376d41796f456bbff4d4bfa000086d5f5f7e5e6c30f29abacfd746aa931490620298aeadf268bf759342abea316c5ac5ccc7
-  data.tar.gz: 1bac71bc72c540a63af1929d50e28def004c9ea1c33e520a30a4f92c435384567ebfeb1b3acbcc53d3f5878172b7485f3d5bcde646f46289fc3ca929cd5aecf9
+  metadata.gz: 450e7576c8c0ff966c54dc94a7986d5025dfaaade64592c57f24ad3fc218e35d6494d01d2dea7f91872f904b2518ea651a61df306f5ae1e56d403fe2c15b1e3f
+  data.tar.gz: 8b9984d94f4dd49849a08d2416ea2fd1c952c91a744815f0b3521669bc4164d384bc4fc1a9e90532beb4e37ea60dbecde1ce98e4d50ff9b7df0d7fd9a7d21443

data/lib/zoom/actions/report.rb

@@ -3,24 +3,52 @@
 module Zoom
   module Actions
     module Report
-      def report_getaccountreport(*args)
-        options = Utils.extract_options!(args)
-        Utils.require_params(%i[from to], options)
-        Utils.process_datetime_params!(%i[from to], options)
-        Utils.parse_response self.class.post('/report/getaccountreport', query: options)
+      def daily_report(*args)
+        params = Zoom::Params.new(Utils.extract_options!(args))
+        params.permit(:year, :month)
+        Utils.parse_response self.class.get('/report/daily', query: params)
       end
 
-      def report_getuserreport(*args)
-        options = Utils.extract_options!(args)
-        Utils.require_params(%i[user_id from to], options)
-        Utils.process_datetime_params!(%i[from to], options)
-        Utils.parse_response self.class.post('/report/getuserreport', query: options)
+      def hosts_report(*args)
+        # TODO: implement hosts_report
       end
 
-      def report_getdailyreport(*args)
-        options = Utils.extract_options!(args)
-        Utils.require_params(%i[year month], options)
-        Utils.parse_response self.class.post('/report/getdailyreport', query: options)
+      def meetings_report(*args)
+        # TODO: implement meetings_report
+      end
+
+      def meeting_details_report(*args)
+        # TODO: implement meeting_details_report
+      end
+
+      def meeting_participants_report(*args)
+        # TODO: implement meeting_participants_report
+      end
+
+      def meeting_polls_report(*args)
+        # TODO: implement meeting_polls_report
+      end
+
+      def webinar_details_report(*args)
+        # TODO: implement webinar_details_report
+      end
+
+      def webinar_participants_report(*args)
+        params = Zoom::Params.new(Utils.extract_options!(args))
+        params.require(:id).permit(:page_size, :next_page_token)
+        Utils.parse_response self.class.get("/report/webinars/#{params[:id]}/participants", query: params.except(:id).merge(access_token: access_token))
+      end
+
+      def webinar_polls_report(*args)
+        # TODO: implement report_hosts
+      end
+
+      def webinar_qa_report(*args)
+        # TODO: implement report_hosts
+      end
+
+      def telephone_report(*args)
+        # TODO: implement report_hosts
       end
     end
   end

data/spec/fixtures/report/webinar/participants.json

@@ -0,0 +1,18 @@
+{
+  "page_count": 1,
+  "page_size": 1,
+  "total_records": 1,
+  "next_page_token": "test",
+  "participants": [
+    {
+      "id": "test-uuid",
+      "user_id": "test@test.com",
+      "name": "Test",
+      "user_email": "testuser@test.com",
+      "join_time": "2019-01-01T09:00:00Z",
+      "leave_time": "2019-01-01T09:00:00Z",
+      "duration": 60,
+      "attentiveness_score": "10"
+    }
+  ]
+}

data/spec/lib/zoom/actions/report/webinar_participants_report_spec.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Zoom::Actions::Report do
+  let(:zc) { zoom_client }
+  let(:args) { { id: '123456789' } }
+
+  describe '#webinar_participants_report' do
+    context 'with a valid response' do
+      before :each do
+        stub_request(
+          :get,
+          zoom_url("/report/webinars/#{args[:id]}/participants")
+        ).to_return(status: 200,
+                    body: json_response('report', 'webinar', 'participants'),
+                    headers: {"Content-Type"=> "application/json"})
+      end
+
+      it "requires a 'id' argument" do
+        expect { zc.webinar_participants_report(filter_key(args, :id)) }.to raise_error(Zoom::ParameterMissing, [:id].to_s)
+      end
+
+      it 'returns an array of participants' do
+        expect(zc.webinar_participants_report(args)['participants']).to be_kind_of(Array)
+      end
+    end
+
+    context 'with a 4xx response' do
+      before :each do
+        stub_request(
+          :get,
+          zoom_url("/report/webinars/#{args[:id]}/participants")
+        ).to_return(status: 404,
+                    body: json_response('error', 'not_found'),
+                    headers: {"Content-Type"=> "application/json"})
+      end
+
+      it 'raises an error' do
+        expect { zc.webinar_participants_report(args) }.to raise_error(Zoom::Error)
+      end
+    end
+  end
+end

data/zoom_rb.gemspec

@@ -25,5 +25,5 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.name          = 'zoom_rb'
   gem.require_paths = ['lib']
-  gem.version       = '0.8.6'
+  gem.version       = '0.8.7'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zoom_rb
 version: !ruby/object:Gem::Version
-  version: 0.8.6
+  version: 0.8.7
 platform: ruby
 authors:
 - Kyle Boe
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-30 00:00:00.000000000 Z
+date: 2019-01-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -190,10 +190,7 @@ files:
 - spec/fixtures/recording_delete.json
 - spec/fixtures/recording_get.json
 - spec/fixtures/recording_list.json
-- spec/fixtures/report/getaccountreport.json
-- spec/fixtures/report/getaudioreport.json
-- spec/fixtures/report/getdailyreport.json
-- spec/fixtures/report/getuserreport.json
+- spec/fixtures/report/webinar/participants.json
 - spec/fixtures/report_getaccountreport.json
 - spec/fixtures/report_getdailyreport.json
 - spec/fixtures/report_getuserreport.json
@@ -272,10 +269,17 @@ files:
 - spec/lib/zoom/actions/recording/get_spec.rb
 - spec/lib/zoom/actions/recording/list_spec.rb
 - spec/lib/zoom/actions/recording/mc_list_spec.rb
-- spec/lib/zoom/actions/report/getaccountreport_spec.rb
-- spec/lib/zoom/actions/report/getaudioreport_spec.rb
-- spec/lib/zoom/actions/report/getdailyreport_spec.rb
-- spec/lib/zoom/actions/report/getuserreport_spec.rb
+- spec/lib/zoom/actions/report/daily_report_spec.rb
+- spec/lib/zoom/actions/report/hosts_report_spec.rb
+- spec/lib/zoom/actions/report/meeting_details_report_spec.rb
+- spec/lib/zoom/actions/report/meeting_participants_report_spec.rb
+- spec/lib/zoom/actions/report/meeting_polls_report_spec.rb
+- spec/lib/zoom/actions/report/meetings_report_spec.rb
+- spec/lib/zoom/actions/report/telephone_report_spec.rb
+- spec/lib/zoom/actions/report/webinar_details_report_spec.rb
+- spec/lib/zoom/actions/report/webinar_participants_report_spec.rb
+- spec/lib/zoom/actions/report/webinar_polls_report_spec.rb
+- spec/lib/zoom/actions/report/webinar_qa_report_spec.rb
 - spec/lib/zoom/actions/user/activate_spec.rb
 - spec/lib/zoom/actions/user/assistant/delete_spec.rb
 - spec/lib/zoom/actions/user/assistant/set_spec.rb
@@ -362,10 +366,7 @@ test_files:
 - spec/fixtures/recording_delete.json
 - spec/fixtures/recording_get.json
 - spec/fixtures/recording_list.json
-- spec/fixtures/report/getaccountreport.json
-- spec/fixtures/report/getaudioreport.json
-- spec/fixtures/report/getdailyreport.json
-- spec/fixtures/report/getuserreport.json
+- spec/fixtures/report/webinar/participants.json
 - spec/fixtures/report_getaccountreport.json
 - spec/fixtures/report_getdailyreport.json
 - spec/fixtures/report_getuserreport.json
@@ -444,10 +445,17 @@ test_files:
 - spec/lib/zoom/actions/recording/get_spec.rb
 - spec/lib/zoom/actions/recording/list_spec.rb
 - spec/lib/zoom/actions/recording/mc_list_spec.rb
-- spec/lib/zoom/actions/report/getaccountreport_spec.rb
-- spec/lib/zoom/actions/report/getaudioreport_spec.rb
-- spec/lib/zoom/actions/report/getdailyreport_spec.rb
-- spec/lib/zoom/actions/report/getuserreport_spec.rb
+- spec/lib/zoom/actions/report/daily_report_spec.rb
+- spec/lib/zoom/actions/report/hosts_report_spec.rb
+- spec/lib/zoom/actions/report/meeting_details_report_spec.rb
+- spec/lib/zoom/actions/report/meeting_participants_report_spec.rb
+- spec/lib/zoom/actions/report/meeting_polls_report_spec.rb
+- spec/lib/zoom/actions/report/meetings_report_spec.rb
+- spec/lib/zoom/actions/report/telephone_report_spec.rb
+- spec/lib/zoom/actions/report/webinar_details_report_spec.rb
+- spec/lib/zoom/actions/report/webinar_participants_report_spec.rb
+- spec/lib/zoom/actions/report/webinar_polls_report_spec.rb
+- spec/lib/zoom/actions/report/webinar_qa_report_spec.rb
 - spec/lib/zoom/actions/user/activate_spec.rb
 - spec/lib/zoom/actions/user/assistant/delete_spec.rb
 - spec/lib/zoom/actions/user/assistant/set_spec.rb

data/spec/fixtures/report/getaccountreport.json

@@ -1,23 +0,0 @@
-{
-  "page_count": 1,
-  "page_number": 1,
-  "page_size": 30,
-  "total_records": 5,
-  "from": "2013-5-19",
-  "to": "2013-5-20",
-  "total_meetings": 50,
-  "total_participants": 100,
-  "total_meeting_minutes": 100,
-  "users": [
-    {
-      "user_id": "bNsPi5hCQ-qOzWn2EeCXJA",
-      "email": "john@sample.com",
-      "type": 2,
-      "meetings": 10,
-      "participants": 56,
-      "meeting_minutes": 300,
-      "last_client_version": "1.0.18584.0225",
-      "last_login_time": "2013-02-11T08:18:09Z"
-    }
-  ]
-}

data/spec/fixtures/report/getaudioreport.json

@@ -1,22 +0,0 @@
-{
-  "from": "2016-01-08",
-  "to": "2016-01-21",
-  "page_count": 1,
-  "page_number": 1,
-  "page_size": 30,
-  "total_records": 1,
-  "telephony_usage": [
-    {
-      "meeting_id": 2932547621,
-      "phone_number": "+86 8208",
-      "type": "call-out",
-      "host_name": "test",
-      "host_email": "zoom.test@zoom.us",
-      "department": "",
-      "start_time": "2016-01-12T02:25:34Z",
-      "end_time": "2016-01-12T02:26:48Z",
-      "duration": 2,
-      "total": 0.12
-    }
-  ]
-}

data/spec/fixtures/report/getdailyreport.json

@@ -1,13 +0,0 @@
-{
-  "year": 2013,
-  "month": 5,
-  "dates": [
-    {
-      "meetings": 0,
-      "date": "2013-05-01",
-      "new_user": 0,
-      "participants": 0,
-      "meeting_minutes": 0
-    }
-  ]
-}

data/spec/fixtures/report/getuserreport.json

@@ -1,24 +0,0 @@
-{
-  "page_count": 1,
-  "page_number": 1,
-  "page_size": 30,
-  "total_records": 5,
-  "from": "2013-5-19",
-  "to": "2013-5-20",
-  "meetings": [
-    {
-      "number": 111111111,
-      "topic": "Meeting Topic",
-      "start_time": "2013-02-11T08:18:09Z",
-      "end_time": "2013-02-11T09:18:09Z",
-      "duration": 60,
-      "participants": [
-        {
-          "name": "John",
-          "join_time": "2013-02-11T08:30:09Z",
-          "leave_time": "2013-02-11T08:50:09Z"
-        }
-      ]
-    }
-  ]
-}

data/spec/lib/zoom/actions/report/getaccountreport_spec.rb

@@ -1,57 +0,0 @@
-# frozen_string_literal: true
-
-require 'spec_helper'
-
-xdescribe Zoom::Actions::Report do
-  let(:zc) { zoom_client}
-  let(:args) { { from: '2013-04-05T15:50:47Z', to: '2013-04-09T19:00:00Z' } }
-  let(:response) { zc.report_getaccountreport(args) }
-
-  xdescribe '#report_getaccountreport action' do
-    before :each do
-      stub_request(
-        :post,
-        zoom_url('/report/getaccountreport')
-      ).to_return(body: json_response('report_getaccountreport'))
-    end
-
-    it "requires a 'from' argument" do
-      expect {
-        zc.report_getaccountreport(filter_key(args, :from))
-      }.to raise_error(ArgumentError)
-    end
-
-    it "requires a 'to' argument" do
-      expect {
-        zc.report_getaccountreport(filter_key(args, :to))
-      }.to raise_error(ArgumentError)
-    end
-
-    it 'returns a hash' do
-      expect(response).to be_kind_of(Hash)
-    end
-
-    it "returns 'total_records'" do
-      expect(response['total_records']).to eq(1)
-    end
-
-    it "returns 'users' Array" do
-      expect(response['users']).to be_kind_of(Array)
-    end
-  end
-
-  xdescribe '#report_getaccountreport! action' do
-    before :each do
-      stub_request(
-        :post,
-        zoom_url('/report/getaccountreport')
-      ).to_return(body: json_response('error'))
-    end
-
-    it 'raises Zoom::Error exception' do
-      expect {
-        zc.report_getaccountreport!(args)
-      }.to raise_error(Zoom::Error)
-    end
-  end
-end

data/spec/lib/zoom/actions/report/getaudioreport_spec.rb

@@ -1,3 +0,0 @@
-# frozen_string_literal: true
-
-require 'spec_helper'

data/spec/lib/zoom/actions/report/getdailyreport_spec.rb

@@ -1,62 +0,0 @@
-# frozen_string_literal: true
-
-require 'spec_helper'
-
-xdescribe Zoom::Actions::Report do
-  before :all do
-    @zc = zoom_client
-    @args = { year: 2017, month: 7 }
-  end
-
-  xdescribe '#report_getdailyreport action' do
-    before :each do
-      stub_request(
-        :post,
-        zoom_url('/report/getdailyreport')
-      ).to_return(body: json_response('report_getdailyreport'))
-    end
-
-    it "requires a 'year' argument" do
-      expect {
-        @zc.report_getdailyreport(filter_key(@args, :year))
-      }.to raise_error(ArgumentError)
-    end
-
-    it "requires a 'month' argument" do
-      expect {
-        @zc.report_getdailyreport(filter_key(@args, :month))
-      }.to raise_error(ArgumentError)
-    end
-
-    it 'returs a Hash' do
-      expect(@zc.report_getdailyreport(@args)).to be_kind_of(Hash)
-    end
-
-    it "returns a 'year'" do
-      expect(@zc.report_getdailyreport(@args)['year']).to eq(@args[:year])
-    end
-
-    it "returns a 'month'" do
-      expect(@zc.report_getdailyreport(@args)['month']).to eq(@args[:month])
-    end
-
-    it "returns a 'dates' Array" do
-      expect(@zc.report_getdailyreport(@args)['dates']).to be_kind_of(Array)
-    end
-  end
-
-  xdescribe '#report_getdailyreport! action' do
-    before :each do
-      stub_request(
-        :post,
-        zoom_url('/report/getdailyreport')
-      ).to_return(body: json_response('error'))
-    end
-
-    it 'raises Zoom::Error exception' do
-      expect {
-        @zc.report_getdailyreport!(@args)
-      }.to raise_error(Zoom::Error)
-    end
-  end
-end

data/spec/lib/zoom/actions/report/getuserreport_spec.rb

@@ -1,67 +0,0 @@
-# frozen_string_literal: true
-
-require 'spec_helper'
-
-xdescribe Zoom::Actions::Report do
-
-  before :all do
-    @zc = zoom_client
-    @args = { from: '2013-04-05T15:50:47Z',
-              to: '2013-04-09T19:00:00Z',
-              user_id: 'ufR93M2pRyy8ePFN92dttq' }
-  end
-
-  xdescribe '#report_getuserreport action' do
-    before :each do
-      stub_request(
-        :post,
-        zoom_url('/report/getuserreport')
-      ).to_return(body: json_response('report_getuserreport'))
-    end
-
-    it "requires a 'user_id' argument" do
-      expect {
-        @zc.report_getuserreport(filter_key(@args, :user_id))
-      }.to raise_error(ArgumentError)
-    end
-
-    it "requires a 'from' argument" do
-      expect {
-        @zc.report_getuserreport(filter_key(@args, :from))
-      }.to raise_error(ArgumentError)
-    end
-
-    it "requires a 'to' argument" do
-      expect {
-        @zc.report_getuserreport(filter_key(@args, :to))
-      }.to raise_error(ArgumentError)
-    end
-
-    it 'returns a hash' do
-      expect(@zc.report_getuserreport(@args)).to be_kind_of(Hash)
-    end
-
-    it "returns 'total_records'" do
-      expect(@zc.report_getuserreport(@args)['total_records']).to eq(1)
-    end
-
-    it "returns 'meetings' Array" do
-      expect(@zc.report_getuserreport(@args)['meetings']).to be_kind_of(Array)
-    end
-  end
-
-  xdescribe '#report_getuserreport! action' do
-    before :each do
-      stub_request(
-        :post,
-        zoom_url('/report/getuserreport')
-      ).to_return(body: json_response('error'))
-    end
-
-    it 'raises Zoom::Error exception' do
-      expect {
-        @zc.report_getuserreport!(@args)
-      }.to raise_error(Zoom::Error)
-    end
-  end
-end