crx_packmgr_api_client 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2de7774280e517e404ef062a1fc73a7a5c81aa67
-  data.tar.gz: ff09078257c6c7800734cb34fae8803b6db33aa9
+  metadata.gz: d46cd66a113fac3af4cf475b7a7d90826c4293ac
+  data.tar.gz: 59a74828446f50aa1ff94ab591de3e123b8a336e
 SHA512:
-  metadata.gz: 40786cb80f52d8bdd042a952a569f197d2a777ea824f02ff05ede08bb270299d262842ef0a5e33a7efb05b5d29268abc9bd2fcb27f7cbbcd8bdbff4ed701dcd1
-  data.tar.gz: 2faccb591e04c0dfab0e7dd4affef7eddddf5e44f8e86b03d3de85ec4933399764bd615441278948fdd640810b69ab51caffecb44e709ae37eff6624e778d031
+  metadata.gz: c32b9ac0df3aec617a4a8f7b5e408b8bb0df7c68484e80a1cf04138c05b1d4718b7d4c17dfb0f87e567bbd954fa62ef11fd8d4c8c50b152c55e3e37e5852db0d
+  data.tar.gz: c321338987965101ba084816cf22380b804a1465fd386186549499b1357fe8bd6c056ba787432bc0c78e43409605b5f519d967f2a5b8e72c03dd594e5b698985

data/README.md

@@ -6,9 +6,9 @@ API for interacting with the CRX Package Manager in AEM.
 
 This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
 
-- API version: 1.0.0
-- Package version: 0.1.0
-- Build date: 2016-11-23T23:44:11.263-06:00
+- API version: 6.2.0
+- Package version: 1.0.0
+- Build date: 2016-12-17T22:39:24.217-06:00
 - Build package: class io.swagger.codegen.languages.RubyClientCodegen
 
 ## Installation
@@ -24,21 +24,21 @@ gem build crx_packmgr_api_client.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./crx_packmgr_api_client-0.1.0.gem
+gem install ./crx_packmgr_api_client-1.0.0.gem
 ```
-(for development, run `gem install --dev ./crx_packmgr_api_client-0.1.0.gem` to install the development dependencies)
+(for development, run `gem install --dev ./crx_packmgr_api_client-1.0.0.gem` to install the development dependencies)
 
 or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
 
 Finally add this to the Gemfile:
 
-    gem 'crx_packmgr_api_client', '~> 0.1.0'
+    gem 'crx_packmgr_api_client', '~> 1.0.0'
 
 ### Install from Git
 
-If the Ruby gem is hosted at a git repository: https://github.com/bstopp/crx_packmgr_api_client, then add the following in the Gemfile:
+If the Ruby gem is hosted at a git repository: https://github.com/bstopp/crx-packmgr-api-client-gem, then add the following in the Gemfile:
 
-    gem 'crx_packmgr_api_client', :git => 'https://github.com/bstopp/crx_packmgr_api_client.git'
+    gem 'crx_packmgr_api_client', :git => 'https://github.com/bstopp/crx-packmgr-api-client-gem.git'
 
 ### Include the Ruby code directly
 
@@ -65,17 +65,15 @@ end
 api_instance = CrxPackageManager::DefaultApi.new
 
 opts = { 
-  q: "q_example", # String | Term to search within package names.
-  include_versions: true, # BOOLEAN | Include versions of package in results.
-  path: "path_example" # String | The path to a specific package definition.
+  path: "path_example" # String | The path to the package to download.
 }
 
 begin
-  #List all available packages.
-  result = api_instance.list(opts)
+  #Download a package
+  result = api_instance.download(opts)
   p result
 rescue CrxPackageManager::ApiError => e
-  puts "Exception when calling DefaultApi->list: #{e}"
+  puts "Exception when calling DefaultApi->download: #{e}"
 end
 
 ```
@@ -86,14 +84,33 @@ All URIs are relative to *http://localhost:4502/crx/packmgr*
 
 Class | Method | HTTP request | Description
 ------------ | ------------- | ------------- | -------------
-*CrxPackageManager::DefaultApi* | [**list**](docs/DefaultApi.md#list) | **GET** /list.jsp | List all available packages.
+*CrxPackageManager::DefaultApi* | [**download**](docs/DefaultApi.md#download) | **GET** /download.jsp | Download a package
+*CrxPackageManager::DefaultApi* | [**groups**](docs/DefaultApi.md#groups) | **GET** /groups.jsp | List package groups
+*CrxPackageManager::DefaultApi* | [**init**](docs/DefaultApi.md#init) | **GET** /init.jsp | Metadata
+*CrxPackageManager::DefaultApi* | [**installstatus**](docs/DefaultApi.md#installstatus) | **GET** /installstatus.jsp | Package Installation Status
+*CrxPackageManager::DefaultApi* | [**list**](docs/DefaultApi.md#list) | **GET** /list.jsp | List packages
+*CrxPackageManager::DefaultApi* | [**screenshot**](docs/DefaultApi.md#screenshot) | **GET** /screenshot.jsp | Get screenshot
+*CrxPackageManager::DefaultApi* | [**service_get**](docs/DefaultApi.md#service_get) | **GET** /service.jsp | Generic operation service.
+*CrxPackageManager::DefaultApi* | [**service_post**](docs/DefaultApi.md#service_post) | **POST** /service.jsp | Generic operation service.
+*CrxPackageManager::DefaultApi* | [**thumbnail**](docs/DefaultApi.md#thumbnail) | **GET** /thumbnail.jsp | Get package thumbnail
 
 
 ## Documentation for Models
 
+ - [CrxPackageManager::Filter](docs/Filter.md)
+ - [CrxPackageManager::FilterRule](docs/FilterRule.md)
+ - [CrxPackageManager::Group](docs/Group.md)
+ - [CrxPackageManager::GroupList](docs/GroupList.md)
+ - [CrxPackageManager::InitData](docs/InitData.md)
+ - [CrxPackageManager::InstallStatus](docs/InstallStatus.md)
+ - [CrxPackageManager::InstallStatusStatus](docs/InstallStatusStatus.md)
  - [CrxPackageManager::Package](docs/Package.md)
- - [CrxPackageManager::PackageFilter](docs/PackageFilter.md)
  - [CrxPackageManager::PackageList](docs/PackageList.md)
+ - [CrxPackageManager::ServiceResponse](docs/ServiceResponse.md)
+ - [CrxPackageManager::ServiceResponseRequest](docs/ServiceResponseRequest.md)
+ - [CrxPackageManager::ServiceResponseRequestParam](docs/ServiceResponseRequestParam.md)
+ - [CrxPackageManager::ServiceResponseResponse](docs/ServiceResponseResponse.md)
+ - [CrxPackageManager::UpdateStatus](docs/UpdateStatus.md)
 
 
 ## Documentation for Authorization

data/crx_packmgr_api_client.gemspec

@@ -5,7 +5,7 @@
 
 #API for interacting with the CRX Package Manager in AEM.
 
-OpenAPI spec version: 1.0.0
+OpenAPI spec version: 6.2.0
 Contact: bryan.stopp@gmail.com
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 
@@ -32,22 +32,27 @@ Gem::Specification.new do |s|
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Swagger-Codegen"]
   s.email       = ["bryan.stopp@gmail.com"]
-  s.homepage    = "https://github.com/swagger-api/swagger-codegen"
+  s.homepage    = "https://github.com/bstopp/crx-packmgr-api-client-gem"
   s.summary     = "CRX Package Manager API Ruby Gem"
   s.description = "API for interacting with the CRX Package Manager in AEM."
-  s.license     = "Apache 2.0"
+  s.license     = "Apache-2.0"
+  s.required_ruby_version = ">= 1.9"
 
   s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
   s.add_runtime_dependency 'json', '~> 1.8', '>= 1.8.3'
 
   s.add_development_dependency 'rspec', '~> 3.4', '>= 3.4.0'
   s.add_development_dependency 'vcr', '~> 3.0', '>= 3.0.1'
-  s.add_development_dependency 'webmock', '~> 1.24', '>= 1.24.3'
+      s.add_development_dependency 'webmock', '~> 2.3', '>= 2.3.1'
   s.add_development_dependency 'autotest', '~> 4.4', '>= 4.4.6'
   s.add_development_dependency 'autotest-rails-pure', '~> 4.1', '>= 4.1.2'
   s.add_development_dependency 'autotest-growl', '~> 0.2', '>= 0.2.16'
   s.add_development_dependency 'autotest-fsevent', '~> 0.2', '>= 0.2.11'
 
+  s.add_development_dependency 'rubocop'
+  s.add_development_dependency 'simplecov'
+  s.add_development_dependency 'codeclimate-test-reporter'
+
   s.files         = `find *`.split("\n").uniq.sort.select{|f| !f.empty? }
   s.test_files    = `find spec/*`.split("\n")
   s.executables   = []

data/docs/DefaultApi.md

@@ -4,13 +4,231 @@ All URIs are relative to *http://localhost:4502/crx/packmgr*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
-[**list**](DefaultApi.md#list) | **GET** /list.jsp | List all available packages.
+[**download**](DefaultApi.md#download) | **GET** /download.jsp | Download a package
+[**groups**](DefaultApi.md#groups) | **GET** /groups.jsp | List package groups
+[**init**](DefaultApi.md#init) | **GET** /init.jsp | Metadata
+[**installstatus**](DefaultApi.md#installstatus) | **GET** /installstatus.jsp | Package Installation Status
+[**list**](DefaultApi.md#list) | **GET** /list.jsp | List packages
+[**screenshot**](DefaultApi.md#screenshot) | **GET** /screenshot.jsp | Get screenshot
+[**service_get**](DefaultApi.md#service_get) | **GET** /service.jsp | Generic operation service.
+[**service_post**](DefaultApi.md#service_post) | **POST** /service.jsp | Generic operation service.
+[**thumbnail**](DefaultApi.md#thumbnail) | **GET** /thumbnail.jsp | Get package thumbnail
+
+
+# **download**
+> File download(opts)
+
+Download a package
+
+Downloads the package at the specified path. Returns a Tempfile object.
+
+### Example
+```ruby
+# load the gem
+require 'crx_packmgr_api_client'
+# setup authorization
+CrxPackageManager.configure do |config|
+  # Configure HTTP basic authorization: basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = CrxPackageManager::DefaultApi.new
+
+opts = { 
+  path: "path_example" # String | The path to the package to download.
+}
+
+begin
+  #Download a package
+  result = api_instance.download(opts)
+  p result
+rescue CrxPackageManager::ApiError => e
+  puts "Exception when calling DefaultApi->download: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **path** | **String**| The path to the package to download. | [optional] 
+
+### Return type
+
+**File**
+
+### Authorization
+
+[basic](../README.md#basic)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/octet-stream, application/zip
+
+
+
+# **groups**
+> GroupList groups(opts)
+
+List package groups
+
+Returns a list of all package groups available.
+
+### Example
+```ruby
+# load the gem
+require 'crx_packmgr_api_client'
+# setup authorization
+CrxPackageManager.configure do |config|
+  # Configure HTTP basic authorization: basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = CrxPackageManager::DefaultApi.new
+
+opts = { 
+  compress_version: "compress_version_example", # String | Compress versions; count all versions of the same packages as a single entry.
+  include_all: true, # BOOLEAN | Return a total count of all packages. Defaults to false.
+  include_root: true, # BOOLEAN | Include the root package. Defaults to false.
+  include_my_packages: true, # BOOLEAN | Include the 'my_packages' group. Only applicable if the group has no packages. Defaults to false.
+  only_top_level: true # BOOLEAN | Only list top-level groups, ie. do not list all nested groups.
+}
+
+begin
+  #List package groups
+  result = api_instance.groups(opts)
+  p result
+rescue CrxPackageManager::ApiError => e
+  puts "Exception when calling DefaultApi->groups: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **compress_version** | **String**| Compress versions; count all versions of the same packages as a single entry. | [optional] 
+ **include_all** | **BOOLEAN**| Return a total count of all packages. Defaults to false. | [optional] 
+ **include_root** | **BOOLEAN**| Include the root package. Defaults to false. | [optional] 
+ **include_my_packages** | **BOOLEAN**| Include the 'my_packages' group. Only applicable if the group has no packages. Defaults to false. | [optional] 
+ **only_top_level** | **BOOLEAN**| Only list top-level groups, ie. do not list all nested groups. | [optional] 
+
+### Return type
+
+[**GroupList**](GroupList.md)
+
+### Authorization
+
+[basic](../README.md#basic)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **init**
+> InitData init
+
+Metadata
+
+Display metadata about this package manager.
+
+### Example
+```ruby
+# load the gem
+require 'crx_packmgr_api_client'
+# setup authorization
+CrxPackageManager.configure do |config|
+  # Configure HTTP basic authorization: basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = CrxPackageManager::DefaultApi.new
+
+begin
+  #Metadata
+  result = api_instance.init
+  p result
+rescue CrxPackageManager::ApiError => e
+  puts "Exception when calling DefaultApi->init: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**InitData**](InitData.md)
+
+### Authorization
+
+[basic](../README.md#basic)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **installstatus**
+> InstallStatus installstatus
+
+Package Installation Status
+
+Returns a status of the installation of OSGi packages.
+
+### Example
+```ruby
+# load the gem
+require 'crx_packmgr_api_client'
+# setup authorization
+CrxPackageManager.configure do |config|
+  # Configure HTTP basic authorization: basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = CrxPackageManager::DefaultApi.new
+
+begin
+  #Package Installation Status
+  result = api_instance.installstatus
+  p result
+rescue CrxPackageManager::ApiError => e
+  puts "Exception when calling DefaultApi->installstatus: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**InstallStatus**](InstallStatus.md)
+
+### Authorization
+
+[basic](../README.md#basic)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
 
 
 # **list**
 > PackageList list(opts)
 
-List all available packages.
+List packages
 
 Returns a list of all available packages defined.
 
@@ -30,11 +248,11 @@ api_instance = CrxPackageManager::DefaultApi.new
 opts = { 
   q: "q_example", # String | Term to search within package names.
   include_versions: true, # BOOLEAN | Include versions of package in results.
-  path: "path_example" # String | The path to a specific package definition.
+  null: "null_example" # String | The path to a specific package definition.
 }
 
 begin
-  #List all available packages.
+  #List packages
   result = api_instance.list(opts)
   p result
 rescue CrxPackageManager::ApiError => e
@@ -48,7 +266,7 @@ Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **q** | **String**| Term to search within package names. | [optional] 
  **include_versions** | **BOOLEAN**| Include versions of package in results. | [optional] 
- **path** | **String**| The path to a specific package definition. | [optional] 
+ **null** | **String**| The path to a specific package definition. | [optional] 
 
 ### Return type
 
@@ -60,8 +278,240 @@ Name | Type | Description  | Notes
 
 ### HTTP request headers
 
- - **Content-Type**: application/x-www-form-urlencoded, multipart/form-data
- - **Accept**: text/plain, text/html, application/json, application/xml
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **screenshot**
+> File screenshot(opts)
+
+Get screenshot
+
+Returns the screenshot at the specified path.
+
+### Example
+```ruby
+# load the gem
+require 'crx_packmgr_api_client'
+# setup authorization
+CrxPackageManager.configure do |config|
+  # Configure HTTP basic authorization: basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = CrxPackageManager::DefaultApi.new
+
+opts = { 
+  path: "path_example" # String | The path to the screenshot.
+}
+
+begin
+  #Get screenshot
+  result = api_instance.screenshot(opts)
+  p result
+rescue CrxPackageManager::ApiError => e
+  puts "Exception when calling DefaultApi->screenshot: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **path** | **String**| The path to the screenshot. | [optional] 
+
+### Return type
+
+**File**
+
+### Authorization
+
+[basic](../README.md#basic)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: image/jpg, image/jpeg, image/png
+
+
+
+# **service_get**
+> String service_get(cmd, opts)
+
+Generic operation service.
+
+Provides endpoint for executing package manipulation commands. Responses are in the format of the ServiceResponse in the defintions section.
+
+### Example
+```ruby
+# load the gem
+require 'crx_packmgr_api_client'
+# setup authorization
+CrxPackageManager.configure do |config|
+  # Configure HTTP basic authorization: basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = CrxPackageManager::DefaultApi.new
+
+cmd = "cmd_example" # String | The command to execute.
+
+opts = { 
+  name: "name_example", # String | The name of the package on which to execute the command.
+  group: "group_example", # String | The group of the package on which to execute the command.
+  strict: true # BOOLEAN | Fail on an error.
+}
+
+begin
+  #Generic operation service.
+  result = api_instance.service_get(cmd, opts)
+  p result
+rescue CrxPackageManager::ApiError => e
+  puts "Exception when calling DefaultApi->service_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **cmd** | **String**| The command to execute. | 
+ **name** | **String**| The name of the package on which to execute the command. | [optional] 
+ **group** | **String**| The group of the package on which to execute the command. | [optional] 
+ **strict** | **BOOLEAN**| Fail on an error. | [optional] 
+
+### Return type
+
+**String**
+
+### Authorization
+
+[basic](../README.md#basic)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/octet-stream, application/zip, text/plain
+
+
+
+# **service_post**
+> String service_post(file, opts)
+
+Generic operation service.
+
+Provides endpoint for executing package manipulation commands. Responses are in the format of the ServiceResponse in the defintions section.
+
+### Example
+```ruby
+# load the gem
+require 'crx_packmgr_api_client'
+# setup authorization
+CrxPackageManager.configure do |config|
+  # Configure HTTP basic authorization: basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = CrxPackageManager::DefaultApi.new
+
+file = File.new("/path/to/file.txt") # File | Package file to upload
+
+opts = { 
+  name: "name_example", # String | The hint for the package's name if the definiton doesn't have one.
+  strict: true, # BOOLEAN | Fail on an error.
+  force: true, # BOOLEAN | Force the package upload.
+  install: true # BOOLEAN | Install the package upon upload
+}
+
+begin
+  #Generic operation service.
+  result = api_instance.service_post(file, opts)
+  p result
+rescue CrxPackageManager::ApiError => e
+  puts "Exception when calling DefaultApi->service_post: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **file** | **File**| Package file to upload | 
+ **name** | **String**| The hint for the package's name if the definiton doesn't have one. | [optional] 
+ **strict** | **BOOLEAN**| Fail on an error. | [optional] 
+ **force** | **BOOLEAN**| Force the package upload. | [optional] 
+ **install** | **BOOLEAN**| Install the package upon upload | [optional] 
+
+### Return type
+
+**String**
+
+### Authorization
+
+[basic](../README.md#basic)
+
+### HTTP request headers
+
+ - **Content-Type**: multipart/form-data
+ - **Accept**: Not defined
+
+
+
+# **thumbnail**
+> File thumbnail(opts)
+
+Get package thumbnail
+
+Returns the package's thumbnail image.
+
+### Example
+```ruby
+# load the gem
+require 'crx_packmgr_api_client'
+# setup authorization
+CrxPackageManager.configure do |config|
+  # Configure HTTP basic authorization: basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = CrxPackageManager::DefaultApi.new
+
+opts = { 
+  path: "path_example" # String | The path to the package.
+}
+
+begin
+  #Get package thumbnail
+  result = api_instance.thumbnail(opts)
+  p result
+rescue CrxPackageManager::ApiError => e
+  puts "Exception when calling DefaultApi->thumbnail: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **path** | **String**| The path to the package. | [optional] 
+
+### Return type
+
+**File**
+
+### Authorization
+
+[basic](../README.md#basic)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: image/jpg, image/jpeg, image/png