crx_packmgr_api_client 0.1.0 → 1.0.0

data/spec/api/groups_api_spec.rb

@@ -0,0 +1,193 @@
+require 'spec_helper'
+
+# unit tests for groups
+# List package groups
+# Returns a list of all package groups available.
+# @param [Hash] opts the optional parameters
+# @option opts [String] :compress_version Compress versions; count all versions of the same packages as a single entry.
+# @option opts [BOOLEAN] :include_all Return a total count of all packages. Default to false.
+# @option opts [BOOLEAN] :include_root Include the root package. Defaults to false.
+# @option opts [BOOLEAN] :include_my_packages Include the 'my_packages' group. Only applicable if the group has no packages. Default to false.
+# @option opts [BOOLEAN] :only_top_level Only list top-level groups, ie. do not list all nested groups.
+# @return [GroupList]
+describe 'DefaultApi#groups' do
+  before do
+    config = CrxPackageManager::Configuration.new
+    @instance = CrxPackageManager::DefaultApi.new(CrxPackageManager::ApiClient.new(config))
+  end
+
+  let(:groups) do
+    data = <<-JSON
+      {
+        "groups" : [
+          {
+            "name": "Adobe",
+            "title": "Adobe",
+            "count": 0,
+            "deepCount": 1
+          },
+          {
+            "name": "Adobe/granite",
+            "title": "Adobe/granite",
+            "count": 1,
+            "deepCount": 1
+          },
+          {
+            "name": "my_packages",
+            "title": "my_packages",
+            "count": 3,
+            "deepCount": 3
+          }
+        ]
+      }
+    JSON
+    data
+  end
+
+  it 'should work' do
+    WebMock.reset!
+    cfg = @instance.api_client.config
+    get_stub = stub_request(
+        :get, "#{cfg.scheme}://#{cfg.host}#{cfg.base_path}/groups.jsp"
+    ).to_return(status: 200, body: groups, headers: { 'Content-Type' => 'application/json' })
+
+    data = @instance.groups
+    expect(data).to be_a(CrxPackageManager::GroupList)
+    expect(data.groups).not_to be_nil
+    expect(data.groups.length).to eq(3)
+    expect(data.groups[0].name).to eq('Adobe')
+    expect(data.groups[0].title).to eq('Adobe')
+    expect(data.groups[0].count).to eq(0)
+    expect(data.groups[0].deep_count).to eq(1)
+
+    expect(get_stub).to have_been_requested
+  end
+
+  it 'should support config changes' do
+    WebMock.reset!
+    @instance.api_client.config.configure do |c|
+      c.scheme = 'https'
+      c.host = 'notlocalhost'
+      c.base_path = '/contextroot/crx/packgr'
+      c.debugging = true
+    end
+    cfg = @instance.api_client.config
+    get_stub = stub_request(
+        :get, "#{cfg.scheme}://#{cfg.host}#{cfg.base_path}/groups.jsp"
+    ).to_return(status: 200, body: groups, headers: { 'Content-Type' => 'application/json' })
+
+    data = @instance.groups
+    expect(data).to be_a(CrxPackageManager::GroupList)
+    expect(data.groups).not_to be_nil
+    expect(data.groups.length).to eq(3)
+    expect(data.groups[0].name).to eq('Adobe')
+    expect(data.groups[0].title).to eq('Adobe')
+    expect(data.groups[0].count).to eq(0)
+    expect(data.groups[0].deep_count).to eq(1)
+
+    expect(get_stub).to have_been_requested
+  end
+
+  it 'should support failures' do
+    WebMock.reset!
+    cfg = @instance.api_client.config
+    get_stub = stub_request(
+        :get, "#{cfg.scheme}://#{cfg.host}#{cfg.base_path}/groups.jsp"
+    ).to_return(status: 500)
+
+    begin
+      @instance.groups
+    rescue CrxPackageManager::ApiError => e
+      expect(e).not_to be_nil
+      expect(e.code).to eq(500)
+    end
+
+    expect(get_stub).to have_been_requested
+  end
+
+  it 'should support compressVersion' do
+    WebMock.reset!
+    cfg = @instance.api_client.config
+    get_stub = stub_request(
+        :get, "#{cfg.scheme}://#{cfg.host}#{cfg.base_path}/groups.jsp"
+    ).with(query: { compressVersion: true }
+    ).to_return(status: 200, body: groups, headers: { 'Content-Type' => 'application/json' })
+
+    data = @instance.groups(compress_version: true)
+    expect(data).to be_a(CrxPackageManager::GroupList)
+    expect(data.groups).not_to be_nil
+    expect(get_stub).to have_been_requested
+  end
+
+  it 'should support includeAll' do
+    WebMock.reset!
+    cfg = @instance.api_client.config
+    get_stub = stub_request(
+        :get, "#{cfg.scheme}://#{cfg.host}#{cfg.base_path}/groups.jsp"
+    ).with(query: { includeAll: true }
+    ).to_return(status: 200, body: groups, headers: { 'Content-Type' => 'application/json' })
+
+    data = @instance.groups(include_all: true)
+    expect(data).to be_a(CrxPackageManager::GroupList)
+    expect(data.groups).not_to be_nil
+    expect(get_stub).to have_been_requested
+  end
+
+  it 'should support includeRoot' do
+    WebMock.reset!
+    cfg = @instance.api_client.config
+    get_stub = stub_request(
+        :get, "#{cfg.scheme}://#{cfg.host}#{cfg.base_path}/groups.jsp"
+    ).with(query: { includeRoot: true }
+    ).to_return(status: 200, body: groups, headers: { 'Content-Type' => 'application/json' })
+
+    data = @instance.groups(include_root: true)
+    expect(data).to be_a(CrxPackageManager::GroupList)
+    expect(data.groups).not_to be_nil
+    expect(get_stub).to have_been_requested
+  end
+
+  it 'should support includeMyPackages' do
+    WebMock.reset!
+    cfg = @instance.api_client.config
+    get_stub = stub_request(
+        :get, "#{cfg.scheme}://#{cfg.host}#{cfg.base_path}/groups.jsp"
+    ).with(query: { includeMyPackages: true }
+    ).to_return(status: 200, body: groups, headers: { 'Content-Type' => 'application/json' })
+
+    data = @instance.groups(include_my_packages: true)
+    expect(data).to be_a(CrxPackageManager::GroupList)
+    expect(data.groups).not_to be_nil
+    expect(get_stub).to have_been_requested
+  end
+
+  it 'should support onlyTopLevel' do
+    WebMock.reset!
+    cfg = @instance.api_client.config
+    get_stub = stub_request(
+        :get, "#{cfg.scheme}://#{cfg.host}#{cfg.base_path}/groups.jsp"
+    ).with(query: { onlyTopLevel: true }
+    ).to_return(status: 200, body: groups, headers: { 'Content-Type' => 'application/json' })
+
+    data = @instance.groups(only_top_level: true)
+    expect(data).to be_a(CrxPackageManager::GroupList)
+    expect(data.groups).not_to be_nil
+    expect(get_stub).to have_been_requested
+  end
+
+  it 'should ignore other params' do
+    WebMock.reset!
+    cfg = @instance.api_client.config
+    get_stub = stub_request(
+      :get, "#{cfg.scheme}://#{cfg.host}#{cfg.base_path}/groups.jsp"
+    ).with(query: {}
+    ).to_return(status: 200, body: groups, headers: { 'Content-Type' => 'application/json' })
+
+    data = @instance.groups(other_param: 'value')
+    expect(data).to be_a(CrxPackageManager::GroupList)
+    expect(data.groups).not_to be_nil
+    expect(get_stub).to have_been_requested
+  end
+
+end
+

data/spec/api/init_api_spec.rb

@@ -0,0 +1,104 @@
+require 'spec_helper'
+
+# unit tests for init
+# Metadata
+# Display metadata about this package manager.
+# @param [Hash] opts the optional parameters
+# @return [InitData]
+describe 'DefaultApi#init' do
+  before do
+    config = CrxPackageManager::Configuration.new
+    @instance = CrxPackageManager::DefaultApi.new(CrxPackageManager::ApiClient.new(config))
+  end
+
+  let(:init_data) do
+    data = <<-JSON
+      {
+        "contextPath": "/crx",
+        "launchpadContextPath": "/",
+        "jcrVersion": "2.0",
+        "workspace": "crx.default",
+        "userID": "Administrator",
+        "workspaces": [
+          "crx.default"
+        ]
+      }
+    JSON
+    data
+  end
+
+  it 'should work' do
+    WebMock.reset!
+    cfg = @instance.api_client.config
+    get_stub = stub_request(
+        :get, "#{cfg.scheme}://#{cfg.host}#{cfg.base_path}/init.jsp"
+    ).to_return(status: 200, body: init_data, headers: { 'Content-Type' => 'application/json' })
+
+    data = @instance.init
+    expect(data).to be_a(CrxPackageManager::InitData)
+    expect(data.context_path).to eq('/crx')
+    expect(data.launchpad_context_path).to eq('/')
+    expect(data.jcr_version).to eq('2.0')
+    expect(data.workspace).to eq('crx.default')
+    expect(data.user_id).to eq('Administrator')
+    expect(data.workspaces).to eq(['crx.default'])
+    expect(get_stub).to have_been_requested
+
+  end
+
+  it 'should support config changes' do
+    WebMock.reset!
+    @instance.api_client.config.configure do |c|
+      c.scheme = 'https'
+      c.host = 'notlocalhost'
+      c.base_path = '/contextroot/crx/packgr'
+      c.debugging = true
+    end
+    cfg = @instance.api_client.config
+    get_stub = stub_request(
+        :get, "#{cfg.scheme}://#{cfg.host}#{cfg.base_path}/init.jsp"
+    ).to_return(status: 200, body: init_data, headers: { 'Content-Type' => 'application/json' })
+
+    data = @instance.init
+    expect(data).to be_a(CrxPackageManager::InitData)
+    expect(data.context_path).to eq('/crx')
+    expect(data.launchpad_context_path).to eq('/')
+    expect(data.jcr_version).to eq('2.0')
+    expect(data.workspace).to eq('crx.default')
+    expect(data.user_id).to eq('Administrator')
+    expect(data.workspaces).to eq(['crx.default'])
+    expect(get_stub).to have_been_requested
+
+  end
+
+  it 'should support failures' do
+    WebMock.reset!
+    cfg = @instance.api_client.config
+    get_stub = stub_request(
+        :get, "#{cfg.scheme}://#{cfg.host}#{cfg.base_path}/init.jsp"
+    ).to_return(status: 401)
+
+    begin
+      @instance.init
+    rescue CrxPackageManager::ApiError => e
+      expect(e).not_to be_nil
+      expect(e.code).to eq(401)
+    end
+
+    expect(get_stub).to have_been_requested
+  end
+
+  it 'should ignore params' do
+    WebMock.reset!
+    cfg = @instance.api_client.config
+    get_stub = stub_request(
+        :get, "#{cfg.scheme}://#{cfg.host}#{cfg.base_path}/init.jsp"
+    ).with(query: {}
+    ).to_return(status: 200, body: init_data, headers: { 'Content-Type' => 'application/json' })
+
+    data = @instance.init(other_param: 'value')
+    expect(data).to be_a(CrxPackageManager::InitData)
+    expect(get_stub).to have_been_requested
+  end
+
+end

data/spec/api/installstatus_api_spec.rb

@@ -0,0 +1,91 @@
+require 'spec_helper'
+
+# unit tests for init
+# Metadata
+# Display metadata about this package manager.
+# @param [Hash] opts the optional parameters
+# @return [InitData]
+describe 'DefaultApi#installstatus' do
+  before do
+    config = CrxPackageManager::Configuration.new
+    @instance = CrxPackageManager::DefaultApi.new(CrxPackageManager::ApiClient.new(config))
+  end
+
+  let(:status) do
+    data = <<-JSON
+      {
+        "status": {
+          "finished": true,
+          "itemCount": 0
+        }
+      }
+    JSON
+    data
+  end
+  it 'should work' do
+    WebMock.reset!
+    cfg = @instance.api_client.config
+    get_stub = stub_request(
+        :get, "#{cfg.scheme}://#{cfg.host}#{cfg.base_path}/installstatus.jsp"
+    ).to_return(status: 200, body: status, headers: { 'Content-Type' => 'application/json' })
+
+    data = @instance.installstatus
+    expect(data).to be_a(CrxPackageManager::InstallStatus)
+    expect(data.status.finished).to eq(true)
+    expect(data.status.item_count).to eq(0)
+    expect(get_stub).to have_been_requested
+
+  end
+
+  it 'should support config changes' do
+    WebMock.reset!
+    @instance.api_client.config.configure do |c|
+      c.scheme = 'https'
+      c.host = 'notlocalhost'
+      c.base_path = '/contextroot/crx/packgr'
+      c.debugging = true
+    end
+    cfg = @instance.api_client.config
+    get_stub = stub_request(
+        :get, "#{cfg.scheme}://#{cfg.host}#{cfg.base_path}/installstatus.jsp"
+    ).to_return(status: 200, body: status, headers: { 'Content-Type' => 'application/json' })
+
+    data = @instance.installstatus
+    expect(data).to be_a(CrxPackageManager::InstallStatus)
+    expect(data.status.finished).to eq(true)
+    expect(data.status.item_count).to eq(0)
+    expect(get_stub).to have_been_requested
+
+  end
+
+  it 'should support failures' do
+    WebMock.reset!
+    cfg = @instance.api_client.config
+    get_stub = stub_request(
+        :get, "#{cfg.scheme}://#{cfg.host}#{cfg.base_path}/installstatus.jsp"
+    ).to_return(status: 401)
+
+    begin
+      @instance.installstatus
+    rescue CrxPackageManager::ApiError => e
+      expect(e).not_to be_nil
+      expect(e.code).to eq(401)
+    end
+
+    expect(get_stub).to have_been_requested
+  end
+
+  it 'should ignore params' do
+    WebMock.reset!
+    cfg = @instance.api_client.config
+    get_stub = stub_request(
+        :get, "#{cfg.scheme}://#{cfg.host}#{cfg.base_path}/installstatus.jsp"
+    ).with(query: {}
+    ).to_return(status: 200, body: status, headers: { 'Content-Type' => 'application/json' })
+
+    data = @instance.installstatus(other_param: 'value')
+    expect(data).to be_a(CrxPackageManager::InstallStatus)
+    expect(get_stub).to have_been_requested
+  end
+
+end

data/spec/api/list_api_spec.rb

@@ -0,0 +1,130 @@
+require 'spec_helper'
+
+# unit tests for list
+# List packages
+# Returns a list of all available packages defined.
+# @param [Hash] opts the optional parameters
+# @option opts [String] :q Term to search within package names.
+# @option opts [BOOLEAN] :include_versions Include versions of package in results.
+# @option opts [String] :path The path to a specific package definition.
+# @return [PackageList]
+describe 'DefaultApi#list' do
+  before do
+    config = CrxPackageManager::Configuration.new
+    @instance = CrxPackageManager::DefaultApi.new(CrxPackageManager::ApiClient.new(config))
+  end
+
+  let(:packages) do
+    file = File.new(File.join(File.dirname(__FILE__), '..', 'files', 'list.json'))
+    data = file.read
+    data
+  end
+
+  it 'should work' do
+    WebMock.reset!
+    cfg = @instance.api_client.config
+    get_stub = stub_request(
+        :get, "#{cfg.scheme}://#{cfg.host}#{cfg.base_path}/list.jsp"
+    ).to_return(status: 200, body: packages, headers: { 'Content-Type' => 'application/json' })
+
+    data = @instance.list
+    expect(data).to be_a(CrxPackageManager::PackageList)
+    expect(data.total).to eq(4)
+    expect(data.results).not_to be_nil
+    entry = data.results[0]
+    expect(entry).to be_a(CrxPackageManager::Package)
+    expect(entry.pid).to eq('my_packages:test:1')
+    expect(entry.filter).to be_a(Array)
+    expect(entry.filter.length).to eq(2)
+    filter = entry.filter[0]
+    expect(filter).to be_a(CrxPackageManager::Filter)
+    expect(filter.root).to eq('/content/dam/site')
+    expect(filter.rules).to be_a(Array)
+    expect(filter.rules.length).to eq(1)
+    rule = filter.rules[0]
+    expect(rule.modifier).to eq('exclude')
+    expect(rule.pattern).to eq('.*/renditions/.*')
+    filter = entry.filter[1]
+    expect(filter.root).to eq('/content/site/en/errors')
+    expect(get_stub).to have_been_requested
+  end
+
+  it 'should support config changes' do
+    WebMock.reset!
+    @instance.api_client.config.configure do |c|
+      c.scheme = 'https'
+      c.host = 'notlocalhost'
+      c.base_path = '/contextroot/crx/packgr'
+      c.debugging = true
+    end
+    cfg = @instance.api_client.config
+    get_stub = stub_request(
+        :get, "#{cfg.scheme}://#{cfg.host}#{cfg.base_path}/list.jsp"
+    ).to_return(status: 200, body: packages, headers: { 'Content-Type' => 'application/json' })
+
+    data = @instance.list
+    expect(data).to be_a(CrxPackageManager::PackageList)
+    expect(data.total).to eq(4)
+    expect(get_stub).to have_been_requested
+
+  end
+
+  it 'should support failures' do
+    WebMock.reset!
+    cfg = @instance.api_client.config
+    get_stub = stub_request(
+        :get, "#{cfg.scheme}://#{cfg.host}#{cfg.base_path}/list.jsp"
+    ).to_return(status: 500)
+
+    begin
+      @instance.list
+    rescue CrxPackageManager::ApiError => e
+      expect(e).not_to be_nil
+      expect(e.code).to eq(500)
+    end
+
+    expect(get_stub).to have_been_requested
+  end
+
+  it 'should support query param' do
+    cfg = @instance.api_client.config
+    get_stub = stub_request(
+        :get, "#{cfg.scheme}://#{cfg.host}#{cfg.base_path}/list.jsp"
+    ).with(query: { q: 'adobe' }
+    ).to_return(status: 200, body: packages, headers: { 'Content-Type' => 'application/json' })
+
+    data = @instance.list(q: 'adobe')
+    expect(data).to be_a(CrxPackageManager::PackageList)
+    expect(data.total).to eq(4)
+    expect(get_stub).to have_been_requested
+
+  end
+
+  it 'should support includeVersions param' do
+    cfg = @instance.api_client.config
+    get_stub = stub_request(
+        :get, "#{cfg.scheme}://#{cfg.host}#{cfg.base_path}/list.jsp"
+    ).with(query: { includeVersions: false }
+    ).to_return(status: 200, body: packages, headers: { 'Content-Type' => 'application/json' })
+
+    data = @instance.list(include_versions: false)
+    expect(data).to be_a(CrxPackageManager::PackageList)
+    expect(data.total).to eq(4)
+    expect(get_stub).to have_been_requested
+
+  end
+
+  it 'should ignore other params' do
+    WebMock.reset!
+    cfg = @instance.api_client.config
+    get_stub = stub_request(
+        :get, "#{cfg.scheme}://#{cfg.host}#{cfg.base_path}/list.jsp"
+    ).with(query: {}
+    ).to_return(status: 200, body: packages, headers: { 'Content-Type' => 'application/json' })
+
+    data = @instance.list(other_param: 'value')
+    expect(data).to be_a(CrxPackageManager::PackageList)
+    expect(data.total).to eq(4)
+    expect(get_stub).to have_been_requested
+  end
+end