descope 1.1.0 → 1.2.0

data/spec/lib.descope/api/v1/management/jwt_template_spec.rb

@@ -0,0 +1,103 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Descope::Api::V1::Management::JWTTemplate do
+  before(:all) do
+    dummy_instance = DummyClass.new
+    dummy_instance.extend(Descope::Api::V1::Management::JWTTemplate)
+    @instance = dummy_instance
+  end
+
+  context '.create_jwt_template' do
+    it 'should respond to .create_jwt_template' do
+      expect(@instance).to respond_to :create_jwt_template
+    end
+
+    it 'is expected to create a new JWT template' do
+      template = {
+        name: 'name-of-template',
+        description: 'description of the template',
+        template: 'the template body',
+        conformanceIssuer: true,
+        authSchema: 'default'
+      }
+      expect(@instance).to receive(:mgmt_post).with(
+        JWT_TEMPLATE_CREATE_PATH,
+        { template: template }
+      )
+      expect do
+        @instance.create_jwt_template(template: template)
+      end.not_to raise_error
+    end
+  end
+
+  context '.update_jwt_template' do
+    it 'should respond to .update_jwt_template' do
+      expect(@instance).to respond_to :update_jwt_template
+    end
+
+    it 'is expected to update an existing JWT template' do
+      template = {
+        id: 'template-id',
+        name: 'name-of-template',
+        template: 'the template body'
+      }
+      expect(@instance).to receive(:mgmt_post).with(
+        JWT_TEMPLATE_UPDATE_PATH,
+        { template: template }
+      )
+      expect do
+        @instance.update_jwt_template(template: template)
+      end.not_to raise_error
+    end
+  end
+
+  context '.delete_jwt_template' do
+    it 'should respond to .delete_jwt_template' do
+      expect(@instance).to respond_to :delete_jwt_template
+    end
+
+    it 'is expected to delete the given JWT template' do
+      expect(@instance).to receive(:mgmt_post).with(
+        JWT_TEMPLATE_DELETE_PATH,
+        { id: 'template-id' }
+      )
+      expect do
+        @instance.delete_jwt_template(id: 'template-id')
+      end.not_to raise_error
+    end
+  end
+
+  context '.list_jwt_templates' do
+    it 'should respond to .list_jwt_templates' do
+      expect(@instance).to respond_to :list_jwt_templates
+    end
+
+    it 'is expected to list all JWT templates' do
+      expect(@instance).to receive(:mgmt_post).with(
+        JWT_TEMPLATE_LIST_PATH,
+        {}
+      )
+      expect do
+        @instance.list_jwt_templates
+      end.not_to raise_error
+    end
+  end
+
+  context '.load_jwt_template' do
+    it 'should respond to .load_jwt_template' do
+      expect(@instance).to respond_to :load_jwt_template
+    end
+
+    it 'is expected to load the given JWT template' do
+      expect(@instance).to receive(:mgmt_post).with(
+        JWT_TEMPLATE_LOAD_PATH,
+        { id: 'template-id' }
+      )
+      expect do
+        @instance.load_jwt_template(id: 'template-id')
+      end.not_to raise_error
+    end
+  end
+end

data/spec/lib.descope/api/v1/management/lists_spec.rb

@@ -0,0 +1,285 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Descope::Api::V1::Management::Lists do
+  before(:all) do
+    dummy_instance = DummyClass.new
+    dummy_instance.extend(Descope::Api::V1::Management::Lists)
+    @instance = dummy_instance
+  end
+
+  context '.create_list' do
+    it 'should respond to .create_list' do
+      expect(@instance).to respond_to :create_list
+    end
+
+    it 'is expected to create a new list' do
+      expect(@instance).to receive(:mgmt_post).with(
+        LIST_CREATE_PATH,
+        {
+          name: 'test-list',
+          type: 'ip',
+          description: 'test description',
+          data: { 'foo' => 'bar' }
+        }
+      )
+      expect do
+        @instance.create_list(
+          name: 'test-list',
+          type: 'ip',
+          description: 'test description',
+          data: { 'foo' => 'bar' }
+        )
+      end.not_to raise_error
+    end
+
+    it 'is expected to create a new list without optional fields' do
+      expect(@instance).to receive(:mgmt_post).with(
+        LIST_CREATE_PATH,
+        { name: 'test-list', type: 'ip' }
+      )
+      expect do
+        @instance.create_list(name: 'test-list', type: 'ip')
+      end.not_to raise_error
+    end
+  end
+
+  context '.update_list' do
+    it 'should respond to .update_list' do
+      expect(@instance).to respond_to :update_list
+    end
+
+    it 'is expected to update an existing list' do
+      expect(@instance).to receive(:mgmt_post).with(
+        LIST_UPDATE_PATH,
+        {
+          id: 'test-id',
+          name: 'test-list',
+          type: 'ip',
+          description: 'test description',
+          data: { 'foo' => 'bar' }
+        }
+      )
+      expect do
+        @instance.update_list(
+          id: 'test-id',
+          name: 'test-list',
+          type: 'ip',
+          description: 'test description',
+          data: { 'foo' => 'bar' }
+        )
+      end.not_to raise_error
+    end
+  end
+
+  context '.delete_list' do
+    it 'should respond to .delete_list' do
+      expect(@instance).to respond_to :delete_list
+    end
+
+    it 'is expected to delete an existing list' do
+      expect(@instance).to receive(:mgmt_post).with(
+        LIST_DELETE_PATH,
+        { id: 'test-id' }
+      )
+      expect do
+        @instance.delete_list(id: 'test-id')
+      end.not_to raise_error
+    end
+  end
+
+  context '.load_list' do
+    it 'should respond to .load_list' do
+      expect(@instance).to respond_to :load_list
+    end
+
+    it 'is expected to load a list by id' do
+      expect(@instance).to receive(:mgmt_get).with("#{LIST_LOAD_PATH}/test-id")
+      expect do
+        @instance.load_list(id: 'test-id')
+      end.not_to raise_error
+    end
+  end
+
+  context '.load_list_by_name' do
+    it 'should respond to .load_list_by_name' do
+      expect(@instance).to respond_to :load_list_by_name
+    end
+
+    it 'is expected to load a list by name' do
+      expect(@instance).to receive(:mgmt_get).with("#{LIST_LOAD_BY_NAME_PATH}/test-list")
+      expect do
+        @instance.load_list_by_name(name: 'test-list')
+      end.not_to raise_error
+    end
+  end
+
+  context '.load_all_lists' do
+    it 'should respond to .load_all_lists' do
+      expect(@instance).to respond_to :load_all_lists
+    end
+
+    it 'is expected to load all lists' do
+      expect(@instance).to receive(:mgmt_get).with(LIST_LOAD_ALL_PATH)
+      expect do
+        @instance.load_all_lists
+      end.not_to raise_error
+    end
+  end
+
+  context '.import_lists' do
+    it 'should respond to .import_lists' do
+      expect(@instance).to respond_to :import_lists
+    end
+
+    it 'is expected to import the given lists' do
+      lists = [{ name: 'test-list', type: 'ip' }]
+      expect(@instance).to receive(:mgmt_post).with(
+        LIST_IMPORT_PATH,
+        { lists: }
+      )
+      expect do
+        @instance.import_lists(lists:)
+      end.not_to raise_error
+    end
+  end
+
+  context '.list_add_ips' do
+    it 'should respond to .list_add_ips' do
+      expect(@instance).to respond_to :list_add_ips
+    end
+
+    it 'is expected to add the given IPs to the list' do
+      expect(@instance).to receive(:mgmt_post).with(
+        LIST_ADD_IPS_PATH,
+        { id: 'test-id', ips: ['1.2.3.4'] }
+      )
+      expect do
+        @instance.list_add_ips(id: 'test-id', ips: ['1.2.3.4'])
+      end.not_to raise_error
+    end
+  end
+
+  context '.list_remove_ips' do
+    it 'should respond to .list_remove_ips' do
+      expect(@instance).to respond_to :list_remove_ips
+    end
+
+    it 'is expected to remove the given IPs from the list' do
+      expect(@instance).to receive(:mgmt_post).with(
+        LIST_REMOVE_IPS_PATH,
+        { id: 'test-id', ips: ['1.2.3.4'] }
+      )
+      expect do
+        @instance.list_remove_ips(id: 'test-id', ips: ['1.2.3.4'])
+      end.not_to raise_error
+    end
+  end
+
+  context '.list_check_ip' do
+    it 'should respond to .list_check_ip' do
+      expect(@instance).to respond_to :list_check_ip
+    end
+
+    it 'is expected to check whether the given IP exists in the list' do
+      expect(@instance).to receive(:mgmt_post).with(
+        LIST_CHECK_IP_PATH,
+        { id: 'test-id', ip: '1.2.3.4' }
+      )
+      expect do
+        @instance.list_check_ip(id: 'test-id', ip: '1.2.3.4')
+      end.not_to raise_error
+    end
+  end
+
+  context '.list_add_texts' do
+    it 'should respond to .list_add_texts' do
+      expect(@instance).to respond_to :list_add_texts
+    end
+
+    it 'is expected to add the given texts to the list' do
+      expect(@instance).to receive(:mgmt_post).with(
+        LIST_ADD_TEXTS_PATH,
+        { id: 'test-id', texts: ['some-text'] }
+      )
+      expect do
+        @instance.list_add_texts(id: 'test-id', texts: ['some-text'])
+      end.not_to raise_error
+    end
+  end
+
+  context '.list_remove_texts' do
+    it 'should respond to .list_remove_texts' do
+      expect(@instance).to respond_to :list_remove_texts
+    end
+
+    it 'is expected to remove the given texts from the list' do
+      expect(@instance).to receive(:mgmt_post).with(
+        LIST_REMOVE_TEXTS_PATH,
+        { id: 'test-id', texts: ['some-text'] }
+      )
+      expect do
+        @instance.list_remove_texts(id: 'test-id', texts: ['some-text'])
+      end.not_to raise_error
+    end
+  end
+
+  context '.list_check_text' do
+    it 'should respond to .list_check_text' do
+      expect(@instance).to respond_to :list_check_text
+    end
+
+    it 'is expected to check whether the given text exists in the list' do
+      expect(@instance).to receive(:mgmt_post).with(
+        LIST_CHECK_TEXT_PATH,
+        { id: 'test-id', text: 'some-text' }
+      )
+      expect do
+        @instance.list_check_text(id: 'test-id', text: 'some-text')
+      end.not_to raise_error
+    end
+  end
+
+  context '.list_check_texts' do
+    it 'should respond to .list_check_texts' do
+      expect(@instance).to respond_to :list_check_texts
+    end
+
+    it 'is expected to check whether any of the given texts exist in the list by default' do
+      expect(@instance).to receive(:mgmt_post).with(
+        LIST_CHECK_TEXT_PATH,
+        { id: 'test-id', texts: %w[text-1 text-2], matchAll: false }
+      )
+      expect do
+        @instance.list_check_texts(id: 'test-id', texts: %w[text-1 text-2])
+      end.not_to raise_error
+    end
+
+    it 'is expected to check whether all of the given texts exist in the list when match_all is set' do
+      expect(@instance).to receive(:mgmt_post).with(
+        LIST_CHECK_TEXT_PATH,
+        { id: 'test-id', texts: %w[text-1 text-2], matchAll: true }
+      )
+      expect do
+        @instance.list_check_texts(id: 'test-id', texts: %w[text-1 text-2], match_all: true)
+      end.not_to raise_error
+    end
+  end
+
+  context '.clear_list' do
+    it 'should respond to .clear_list' do
+      expect(@instance).to respond_to :clear_list
+    end
+
+    it 'is expected to clear all entries from the list' do
+      expect(@instance).to receive(:mgmt_post).with(
+        LIST_CLEAR_PATH,
+        { id: 'test-id' }
+      )
+      expect do
+        @instance.clear_list(id: 'test-id')
+      end.not_to raise_error
+    end
+  end
+end

data/spec/lib.descope/api/v1/management/management_key_spec.rb

@@ -0,0 +1,109 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Descope::Api::V1::Management::ManagementKey do
+  before(:all) do
+    dummy_instance = DummyClass.new
+    dummy_instance.extend(Descope::Api::V1::Management::ManagementKey)
+    @instance = dummy_instance
+  end
+
+  context '.create_management_key' do
+    it 'should respond to .create_management_key' do
+      expect(@instance).to respond_to :create_management_key
+    end
+
+    it 'is expected to create a management key' do
+      expect(@instance).to receive(:mgmt_put).with(
+        MGMT_KEY_CREATE_PATH, {
+          name: 'test',
+          description: 'test key',
+          expiresIn: 0,
+          permittedIps: ['1.2.3.4'],
+          reBac: { 'k1': 'v1' }
+        }
+      )
+      expect do
+        @instance.create_management_key(
+          name: 'test',
+          description: 'test key',
+          expires_in: 0,
+          permitted_ips: ['1.2.3.4'],
+          re_bac: { 'k1': 'v1' }
+        )
+      end.not_to raise_error
+    end
+  end
+
+  context '.update_management_key' do
+    it 'should respond to .update_management_key' do
+      expect(@instance).to respond_to :update_management_key
+    end
+
+    it 'is expected to update a management key' do
+      expect(@instance).to receive(:mgmt_patch).with(
+        MGMT_KEY_UPDATE_PATH, {
+          id: '123',
+          name: 'test1',
+          description: 'updated',
+          permittedIps: ['1.2.3.4'],
+          status: 'active'
+        }
+      )
+      expect do
+        @instance.update_management_key(
+          id: '123',
+          name: 'test1',
+          description: 'updated',
+          permitted_ips: ['1.2.3.4'],
+          status: 'active'
+        )
+      end.not_to raise_error
+    end
+  end
+
+  context '.get_management_key' do
+    it 'should respond to .get_management_key' do
+      expect(@instance).to respond_to :get_management_key
+    end
+
+    it 'is expected to get a management key' do
+      expect(@instance).to receive(:mgmt_get).with(
+        MGMT_KEY_GET_PATH, { id: '123' }
+      )
+      expect { @instance.get_management_key(id: '123') }.not_to raise_error
+    end
+  end
+
+  context '.delete_management_key' do
+    it 'should respond to .delete_management_key' do
+      expect(@instance).to respond_to :delete_management_key
+    end
+
+    it 'is expected to delete a management key' do
+      expect(@instance).to receive(:mgmt_post).with(
+        MGMT_KEY_DELETE_PATH, { ids: ['123'] }
+      )
+      expect { @instance.delete_management_key(id: '123') }.not_to raise_error
+    end
+  end
+
+  context '.search_management_keys' do
+    it 'should respond to .search_management_keys' do
+      expect(@instance).to respond_to :search_management_keys
+    end
+
+    it 'is expected to search management keys' do
+      expect(@instance).to receive(:mgmt_get).with(
+        MGMT_KEY_SEARCH_PATH, {
+          tenantIds: %w[123 456],
+          status: 'active'
+        }
+      )
+      expect do
+        @instance.search_management_keys(tenant_ids: %w[123 456], status: 'active')
+      end.not_to raise_error
+    end
+  end
+end