zoom_rb 0.9.0 → 1.0.0

data/spec/lib/zoom/actions/billing/plans_usage_spec.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Zoom::Actions::Billing do
+  let(:zc) { zoom_client }
+  let(:args) { { account_id: '1' } }
+
+  describe '#billing_plans_usage action' do
+    context 'with a valid response' do
+      before :each do
+        stub_request(
+          :get,
+          zoom_url("/accounts/#{args[:account_id]}/plans/usage")
+        ).to_return(body: json_response('billing', 'plans_usage'),
+                    headers: { 'Content-Type' => 'application/json' })
+      end
+
+      it 'makes the request' do
+        zc.billing_plans_usage(args)
+        expect(WebMock).to have_requested(:get, zoom_url("/accounts/#{args[:account_id]}/plans/usage")).with(headers: request_headers)
+      end
+
+      it 'returns a hash' do
+        expect(zc.billing_plans_usage(args)).to be_kind_of(Hash)
+      end
+
+      it 'raises an error when missing a required param' do
+        expect { zc.billing_plans_usage }.to raise_error(Zoom::ParameterMissing, [:account_id].to_s)
+      end
+    end
+
+    context 'with a 4xx response' do
+      before :each do
+        stub_request(
+          :get,
+          zoom_url("/accounts/#{args[:account_id]}/plans/usage")
+        ).to_return(status: 400,
+                    body: json_response('error', 'not_found'),
+                    headers: { 'Content-Type' => 'application/json' })
+      end
+
+      it 'raises Zoom::Error exception' do
+        expect { zc.billing_plans_usage(args) }.to raise_error(Zoom::Error)
+      end
+    end
+  end
+end

data/spec/lib/zoom/actions/billing/update_spec.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Zoom::Actions::Billing do
+  let(:zc) { zoom_client }
+  let(:required_args) { { account_id: '1' } }
+  let(:permitted_args) {
+    {
+      first_name: 'Foo',
+      last_name: 'Bar',
+      email: 'foo@bar.com',
+      phone_number: '1234567890',
+      address: '123 Test Street',
+      apt: '',
+      city: 'Vancouver',
+      state: 'WA',
+      zip: '98660',
+      country: 'US'
+    }
+  }
+  let(:args) { required_args.merge(permitted_args) }
+
+  describe '#billing_update action' do
+    context 'with a valid response' do
+      before :each do
+        stub_request(
+          :patch,
+          zoom_url("/accounts/#{args[:account_id]}/billing")
+          ).to_return(status: 204,
+                      body: json_response('billing', 'update'),
+                      headers: { 'Content-Type' => 'application/json' })
+      end
+
+      it 'makes the request' do
+        zc.billing_update(args)
+        expect(WebMock).to have_requested(:patch, zoom_url("/accounts/#{args[:account_id]}/billing")).with(body: permitted_args.to_json, headers: request_headers)
+      end
+
+      it 'requires id param' do
+        expect { zc.billing_update }.to raise_error(Zoom::ParameterMissing, [:account_id].to_s)
+      end
+
+      it 'returns a success response' do
+        expect(zc.billing_update(args)).to eql(204)
+      end
+    end
+
+    context 'with a 4xx response' do
+      before :each do
+        stub_request(
+          :patch,
+          zoom_url("/accounts/#{args[:account_id]}/billing")
+        ).to_return(status: 404,
+                    body: json_response('error', 'validation'),
+                    headers: { 'Content-Type' => 'application/json' })
+      end
+
+      it 'raises Zoom::Error exception' do
+        expect { zc.billing_update(args) }.to raise_error(Zoom::Error)
+      end
+    end
+  end
+end

data/spec/lib/zoom/actions/dashboard/crc_spec.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Zoom::Actions::Dashboard do
+  let(:zc) { zoom_client }
+  let(:args) { { from: '2013-04-05T15:50:47Z', to: '2013-04-09T19:00:00Z' } }
+  let(:response) { zc.dashboard_crc(args) }
+
+  describe '#dashboard_crc get' do
+    before :each do
+      stub_request(
+        :get,
+        zoom_url('/metrics/crc')
+      ).to_return(status: 200,
+                  body: json_response('dashboard','crc'),
+                  headers: { 'Content-Type' => 'application/json' })
+    end
+
+    it "requires a 'from' argument" do
+      expect { zc.dashboard_crc(filter_key(args, :from)) }.to raise_error(Zoom::ParameterMissing)
+    end
+
+    it "requires a 'to' argument" do
+      expect { zc.dashboard_crc(filter_key(args, :to)) }.to raise_error(Zoom::ParameterMissing)
+    end
+
+    it 'returns a hash' do
+      expect(response).to be_kind_of(Hash)
+    end
+  end
+
+end

data/spec/lib/zoom/actions/dashboard/meeting_details_spec.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Zoom::Actions::Dashboard do
+
+  let(:zc) { zoom_client }
+  let(:args) { { meeting_id: 't13b6hjVQXybvGKyeHC96w==', type: 1 } }
+  let(:response) { zc.dashboard_meeting_details(args) }
+
+  describe '#dashboard_meeting_details action' do
+    context 'with 200 response' do
+      before :each do
+        stub_request(
+          :get,
+          zoom_url("/metrics/meetings/#{args[:meeting_id]}")
+        ).to_return(status: 200,
+                    body: json_response('dashboard','meeting', 'detail'),
+                    headers: { 'Content-Type' => 'application/json' })
+      end
+
+      it "requires a 'meeting_id' argument" do
+        expect { zc.dashboard_meeting_details(filter_key(args, :meeting_id)) }.to raise_error(Zoom::ParameterMissing)
+      end
+
+      it 'returns a hash' do
+        expect(response).to be_kind_of(Hash)
+      end
+    end
+
+    context 'with 300 response' do
+      before :each do
+        stub_request(
+          :get,
+          zoom_url("/metrics/meetings/#{args[:meeting_id]}")
+        ).to_return(status: 300,
+                    body: '{ "code": 1001, "message": "The next page token is invalid or expired." }',
+                    headers: { 'Content-Type' => 'application/json' })
+      end
+
+      it 'raises Zoom::Error exception' do
+        expect { response }.to raise_error(Zoom::Error)
+      end
+    end
+
+    context 'with 404 response' do
+      before :each do
+        stub_request(
+          :get,
+          zoom_url("/metrics/meetings/#{args[:meeting_id]}")
+        ).to_return(status: 404,
+                    body: '{ "code": 3001, "message": "Meeting ID is invalid or the meeting has not ended yet. This meeting’s details are not available." }',
+                    headers: { 'Content-Type' => 'application/json' })
+      end
+
+      it 'raises Zoom::Error exception' do
+        expect { response }.to raise_error(Zoom::Error)
+      end
+    end
+  end
+
+end

data/spec/lib/zoom/actions/dashboard/meeting_participants_spec.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Zoom::Actions::Dashboard do
+
+  let(:zc) { zoom_client }
+  let(:args) { { meeting_id: 't13b6hjVQXybvGKyeHC96w==', type: 1 } }
+  let(:response) { zc.dashboard_meeting_participants(args) }
+
+  describe '#dashboard_meeting_participants action' do
+    context 'with 200 response' do
+      before :each do
+        stub_request(
+          :get,
+          zoom_url("/metrics/meetings/#{args[:meeting_id]}/participants")
+        ).to_return(status: 200,
+                    body: json_response('dashboard','meeting', 'participants'),
+                    headers: { 'Content-Type' => 'application/json' })
+      end
+
+      it "requires a 'meeting_id' argument" do
+        expect { zc.dashboard_meeting_participants(filter_key(args, :meeting_id)) }.to raise_error(Zoom::ParameterMissing)
+      end
+
+      it 'returns a hash' do
+        expect(response).to be_kind_of(Hash)
+      end
+
+      it "returns 'next_page_token'" do
+        expect(response['next_page_token']).to be_kind_of(String)
+      end
+
+      it "returns 'total_records'" do
+        expect(response['total_records']).to eq(2)
+      end
+
+      it "returns 'participants' Array" do
+        expect(response['participants']).to be_kind_of(Array)
+      end
+    end
+
+    context 'with 300 response' do
+      before :each do
+        stub_request(
+          :get,
+          zoom_url("/metrics/meetings/#{args[:meeting_id]}/participants")
+        ).to_return(status: 300,
+                    body: '{ "code": 1001, "message": "Can not access webinar info. {meetingId} or the next page token is either invalid or expired." }',
+                    headers: { 'Content-Type' => 'application/json' })
+      end
+
+      it 'raises Zoom::Error exception' do
+        expect { response }.to raise_error(Zoom::Error)
+      end
+    end
+
+    context 'with 404 response' do
+      before :each do
+        stub_request(
+          :get,
+          zoom_url("/metrics/meetings/#{args[:meeting_id]}/participants")
+        ).to_return(status: 404,
+                    body: '{ "code": 3001, "message": "Meeting ID is invalid or not ended yet." }',
+                    headers: { 'Content-Type' => 'application/json' })
+      end
+
+      it 'raises Zoom::Error exception' do
+        expect { response }.to raise_error(Zoom::Error)
+      end
+    end
+  end
+
+end

data/spec/lib/zoom/actions/dashboard/meetings_spec.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Zoom::Actions::Dashboard do
+  let(:zc) { zoom_client }
+  let(:args) { { type: 1, from: '2013-04-05T15:50:47Z', to: '2013-04-09T19:00:00Z' } }
+  let(:response) { zc.dashboard_meetings(args) }
+
+  describe '#dashboard_meetings action' do
+    context 'with 200 response' do
+      before :each do
+        stub_request(
+          :get,
+          zoom_url('/metrics/meetings')
+        ).to_return(status: 200,
+                    body: json_response('dashboard','meetings'),
+                    headers: { 'Content-Type' => 'application/json' })
+      end
+
+      it "requires a 'from' argument" do
+        expect { zc.dashboard_meetings(filter_key(args, :from)) }.to raise_error(Zoom::ParameterMissing)
+      end
+
+      it "requires a 'to' argument" do
+        expect { zc.dashboard_meetings(filter_key(args, :to)) }.to raise_error(Zoom::ParameterMissing)
+      end
+
+      it 'returns a hash' do
+        expect(zc.dashboard_meetings(args)).to be_kind_of(Hash)
+      end
+
+      it "returns 'next_page_token'" do
+        expect(response['next_page_token']).to be_kind_of(String)
+      end
+
+      it "returns 'total_records'" do
+        expect(response['total_records']).to eq(1)
+      end
+
+      it "returns 'meetings' Array" do
+        expect(response['meetings']).to be_kind_of(Array)
+      end
+    end
+
+    context 'with 300 response' do
+      before :each do
+        stub_request(
+          :get,
+          zoom_url('/metrics/meetings')
+        ).to_return(status: 300,
+                    body: '{ "code": 300, "message": "Can not access webinar info, {meetingId}" }',
+                    headers: { 'Content-Type' => 'application/json' })
+      end
+
+      it 'raises an error' do
+        expect { response }.to raise_error(Zoom::Error)
+      end
+    end
+
+  end
+
+end

data/spec/lib/zoom/actions/groups/create_spec.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Zoom::Actions::Groups do
+  let(:zc) { zoom_client }
+  let(:args) { { name: 'Zoom Group Name' } }
+  let(:response) { zc.group_create(args) }
+
+  describe '#group_create action' do
+    context 'with 201 response' do
+      before :each do
+        stub_request(
+          :post,
+          zoom_url("/groups")
+        ).to_return(
+          status: 201,
+          body: json_response('groups','create'),
+          headers: { 'Content-Type' => 'application/json' }
+        )
+      end
+
+      it 'returns a hash' do
+        expect(response).to be_kind_of(Hash)
+      end
+
+      it 'returns the set params' do
+        expect(response['name']).to eq(args[:name])
+      end
+
+      it "returns 'start_url' and 'join_url'" do
+        expect(response['name']).to_not be_nil
+      end
+    end
+
+    context 'with 409 response' do
+      before :each do
+        stub_request(
+          :post,
+          zoom_url("/groups")
+        ).to_return(status: 409,
+                    body: '{ "code": 409, "message": "Group name Zoom Group Name is already in use." }',
+                    headers: { 'Content-Type' => 'application/json' })
+      end
+
+      it 'raises an error' do
+        expect { response }.to raise_error(Zoom::Error)
+      end
+    end
+
+    context 'with 429 response' do
+      before :each do
+        stub_request(
+          :post,
+          zoom_url("/groups")
+        ).to_return(status: 429,
+                    body: '{ "code": 429, "message": "You have exceeded the daily rate limit (1) of Create a Group API request for this account. This limit resets at GMT 00:00:00." }',
+                    headers: { 'Content-Type' => 'application/json' })
+      end
+
+      it 'raises an error' do
+        expect { response }.to raise_error(Zoom::Error)
+      end
+    end
+
+    context 'with 300 response' do
+      before :each do
+        stub_request(
+          :post,
+          zoom_url("/groups")
+        ).to_return(status: 300,
+                    body: '{ "code": 300, "message": "Missing field: name." }',
+                    headers: { 'Content-Type' => 'application/json' })
+      end
+
+      it 'raises an error' do
+        expect { response }.to raise_error(Zoom::Error)
+      end
+    end
+
+    context 'with 404 response' do
+      before :each do
+        stub_request(
+          :post,
+          zoom_url("/groups")
+        ).to_return(
+          status: 404,
+          body: json_response('error', 'group_not_exist'),
+          headers: { 'Content-Type' => 'application/json' }
+        )
+      end
+
+      it 'raises an error' do
+        expect { response }.to raise_error(Zoom::Error)
+      end
+    end
+  end
+end

data/spec/lib/zoom/actions/groups/get_spec.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Zoom::Actions::Groups do
+  let(:zc) { zoom_client }
+  let(:args) { { group_id: 2 } }
+  let(:wrong_args) { { group_id: 999999 } }
+
+  describe '#groups_get action' do
+    context 'with valid response' do
+      before :each do
+        stub_request(
+          :get,
+          zoom_url("/groups/#{args['group_id']}")
+        ).to_return(body: json_response('groups', 'get'), headers: { 'Content-Type' => 'application/json' })
+      end
+
+      it 'returns a hash' do
+        expect(zc.groups_get(args)).to be_kind_of(Hash)
+      end
+
+      it "return 'name' parameter" do
+        expect(zc.groups_get(args)['name']).not_to be_nil
+      end
+    end
+
+    context 'with a 404 response' do
+      before :each do
+        stub_request(
+          :get,
+          zoom_url("/groups/#{wrong_args['group_id']}")
+        ).to_return(status: 404,
+                    body: json_response('error', 'group_does_not_exist'),
+                    headers: { 'Content-Type' => 'application/json' })
+      end
+
+      it 'raises Zoom::Error exception with text' do
+        expect { zc.groups_get(wrong_args) }.to raise_error(Zoom::Error, {
+          base: 'A group with this 999999 does not exist.'
+        }.to_s)
+      end
+    end
+
+    context 'with a 400 response' do
+      before :each do
+        stub_request(
+          :get,
+          zoom_url("/groups/#{wrong_args['group_id']}")
+        ).to_return(status: 400,
+                    body: json_response('error', 'group_not_belong_to_account'),
+                    headers: { 'Content-Type' => 'application/json' })
+      end
+
+      it 'raises Zoom::Error exception with text' do
+        expect { zc.groups_get(wrong_args) }.to raise_error(Zoom::Error, {
+          base: 'Group does not belong to your account.'
+        }.to_s)
+      end
+    end
+  end
+end

data/spec/lib/zoom/actions/groups/list_spec.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Zoom::Actions::Groups do
+  let(:zc) { zoom_client }
+
+  describe '#groups_list action' do
+    context 'with valid response' do
+      before :each do
+        stub_request(
+          :get,
+          zoom_url('/groups')
+        ).to_return(body: json_response('groups', 'list'), headers: { 'Content-Type' => 'application/json' })
+      end
+
+      it 'returns a hash' do
+        expect(zc.groups_list).to be_kind_of(Hash)
+      end
+
+      it "returns 'total_records'" do
+        expect(zc.groups_list['total_records']).to eq(2)
+      end
+
+      it "returns 'groups' Array" do
+        expect(zc.groups_list['groups']).to be_kind_of(Array)
+      end
+    end
+
+    context 'with a 404 response' do
+      before :each do
+        stub_request(
+          :get,
+          zoom_url("/groups")
+        ).to_return(status: 404,
+                    body: json_response('error', 'group_does_not_exist'),
+                    headers: { 'Content-Type' => 'application/json' })
+      end
+
+      it 'raises Zoom::Error exception with text' do
+        expect { zc.groups_list }.to raise_error(Zoom::Error, {
+          base: 'A group with this 999999 does not exist.'
+        }.to_s)
+      end
+    end
+  end
+end

data/spec/lib/zoom/actions/groups/update_spec.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Zoom::Actions::Groups do
+  let(:zc) { zoom_client }
+  let(:args) { { group_id: '555' } }
+
+  describe '#group_update' do
+    context 'with a valid response' do
+      before :each do
+        stub_request(
+          :patch,
+          zoom_url("/groups/#{args[:group_id]}")
+        ).to_return(status: 204,
+                    body: json_response('groups', 'update'),
+                    headers: { 'Content-Type' => 'application/json' })
+      end
+
+      it 'requires id param' do
+        expect { zc.group_update(filter_key(args, :group_id)) }.to raise_error(Zoom::ParameterMissing, [:group_id].to_s)
+      end
+
+      it 'returns the http status code as a number' do
+        expect(zc.group_update(args)).to eql(204)
+      end
+    end
+
+    context 'with a 404 response' do
+      before :each do
+        stub_request(
+          :patch,
+          zoom_url("/groups/#{args[:group_id]}")
+        ).to_return(status: 404,
+                    body: json_response('error', 'group_not_exist'),
+                    headers: { 'Content-Type' => 'application/json' })
+      end
+
+      it 'raises an error' do
+        expect { zc.group_update(args) }.to raise_error(Zoom::Error)
+      end
+    end
+
+    context 'with 409 response' do
+      before :each do
+        stub_request(
+          :patch,
+          zoom_url("/groups/#{args[:group_id]}")
+        ).to_return(status: 409,
+                    body: '{ "code": 409, "message": "Group name Zoom Group Name is already in use." }',
+                    headers: { 'Content-Type' => 'application/json' })
+      end
+
+      it 'raises an error' do
+        expect { zc.group_update(args) }.to raise_error(Zoom::Error)
+      end
+    end
+  end
+end