example_fdhbiopcnmeocbr_gem_misc 1.2.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 759b11a66c70c924e8404912141f404546655b9c6bfc9fca33ed7efb80bfc7d6
+  data.tar.gz: 07206e1a7e0cbee5b05436aa3351eb40d6cb7017720c766fc5299e3f34559ab3
+SHA512:
+  metadata.gz: ce3f951b4c3f53600fe77fe607b208527282cce3de01066104f0330338eee5b71d965b4e72a362f334e442ce4ce4d32b8306471c48b8630594e98b3e645fde38
+  data.tar.gz: a1c0a6ee94f34ee2058c810dd7efb0b77fb6229e6ba4c4292a49bfc6d3572a1207702bdcdfdea3f2059ae275e050f46422d9e7d8e6af045f46a7bc5ea8f5d43d

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'rake', '~> 13.0.1'
+  gem 'pry-byebug'
+  gem 'rubocop', '~> 0.66.0'
+end

data/README.md

@@ -0,0 +1,155 @@
+# pnap_audit_api
+
+AuditApi - the Ruby gem for the Audit Log API
+
+The Audit Logs API lets you read audit log entries and track API calls or activities in the Bare Metal Cloud Portal.<br>
+<br>
+<span class='pnap-api-knowledge-base-link'>
+Knowledge base articles to help you can be found
+<a href='https://phoenixnap.com/kb/bmc-server-management-via-api#audit-log-api' target='_blank'>here</a>
+</span><br>
+<br>
+<b>All URLs are relative to (https://api.phoenixnap.com/audit/v1/)</b>
+
+
+This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
+
+- API version: 1.0
+For more information, please visit [https://phoenixnap.com/](https://phoenixnap.com/)
+
+## Installation
+
+### Build a gem
+
+To build the Ruby code into a gem:
+
+```shell
+gem build pnap_audit_api.gemspec
+```
+
+Then either install the gem locally, replacing `<VERSION>` with the actual version:
+
+```shell
+gem install ./pnap_audit_api-<VERSION>.gem
+```
+
+(for development, run `gem install --dev ./pnap_audit_api-<VERSION>.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 'pnap_audit_api', '~> <VERSION>'
+
+### Install from Git
+
+To install this Gem from this repository, you'll need to get Bundler by doing `gem install bundler`. Add the following line in your Gemfile:
+
+    gem 'pnap_audit_api', git: 'https://github.com/phoenixnap/ruby-sdk-bmc-poc', glob: 'AuditApi/*.gemspec'
+
+If you'd like the development version:
+
+    gem 'pnap_audit_api', git: 'https://github.com/phoenixnap/ruby-sdk-bmc-poc', glob: 'AuditApi/*.gemspec', branch: 'develop'
+
+Then run `bundle install`.
+
+### Include the Ruby code directly
+
+Include the Ruby code directly using `-I` as follows:
+
+```shell
+ruby -Ilib script.rb
+```
+
+## Getting Started
+
+Please follow the [installation](#installation) procedure and then run the following code:
+
+```ruby
+# Load the gem
+require 'pnap_audit_api'
+
+# Setup authorization
+AuditApi.configure do |config|
+  # Configure OAuth2 access token for authorization: OAuth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = AuditApi::EventsApi.new
+opts = {
+  from: Time.parse('2021-04-27T16:24:57.123Z'), # Time | From the date and time (inclusive) to filter event log records by.
+  to: Time.parse('2021-04-29T16:24:57.123Z'), # Time | To the date and time (inclusive) to filter event log records by.
+  limit: 10, # Integer | Limit the number of records returned.
+  order: 'ASC', # String | Ordering of the event's time. SortBy can be introduced later on.
+  username: 'johnd@phoenixnap.com', # String | The username that did the actions.
+  verb: 'POST', # String | The HTTP verb corresponding to the action.
+  uri: '/ams/v1/clients/12345' # String | The request uri.
+}
+
+begin
+  #List event logs.
+  result = api_instance.events_get(opts)
+  p result
+rescue AuditApi::ApiError => e
+  puts "Exception when calling EventsApi->events_get: #{e}"
+end
+
+```
+
+Authorization can also be setup by using the [`oauth`](https://github.com/oauth-xx/oauth2) library:
+
+```ruby
+# Load the gem
+require 'pnap_audit_api'
+require 'oauth2'
+
+# Setup variables for getting a token.
+client_id = 'YOUR_CLIENT_ID'
+client_secret = 'YOUR_CLIENT_SECRET'
+auth_url = 'https://auth.phoenixnap.com/auth/realms/BMC/protocol/openid-connect/token'
+
+
+# Setup authorization
+AuditApi.configure do |config|
+  # Retrieve the token using OAuth2.
+  client = OAuth2::Client.new(client_id, client_secret, token_url: auth_url)
+  token = client.client_credentials.get_token
+
+  # Configure OAuth2 access token for authorization: OAuth2
+  config.access_token = token.token
+end
+
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *https://api.phoenixnap.com/audit/v1*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*AuditApi::EventsApi* | [**events_get**](docs/EventsApi.md#events_get) | **GET** /events | List event logs.
+
+
+## Documentation for Models
+
+ - [AuditApi::ApiAction](docs/ApiAction.md)
+ - [AuditApi::ApiActionAllOf](docs/ApiActionAllOf.md)
+ - [AuditApi::Event](docs/Event.md)
+ - [AuditApi::Headers](docs/Headers.md)
+ - [AuditApi::Request](docs/Request.md)
+ - [AuditApi::Response](docs/Response.md)
+ - [AuditApi::UserInfo](docs/UserInfo.md)
+
+
+## Documentation for Authorization
+
+
+### OAuth2
+
+
+- **Type**: OAuth
+- **Flow**: application
+- **Authorization URL**: 
+- **Scopes**: 
+  - audit.read: Grants read only access to audit-log-api.
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end

data/VERSION

@@ -0,0 +1 @@
+1.2.3

data/docs/ApiAction.md

@@ -0,0 +1,26 @@
+# AuditApi::ApiAction
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | The name of the event. | [optional] |
+| **timestamp** | **Time** | The UTC time the event initiated. |  |
+| **user_info** | [**UserInfo**](UserInfo.md) |  |  |
+| **response** | [**Response**](Response.md) |  |  |
+| **request** | [**Request**](Request.md) |  |  |
+
+## Example
+
+```ruby
+require 'pnap_audit_api'
+
+instance = AuditApi::ApiAction.new(
+  name: API.CreateServer,
+  timestamp: null,
+  user_info: null,
+  response: null,
+  request: null
+)
+```
+

data/docs/ApiActionAllOf.md

@@ -0,0 +1,20 @@
+# AuditApi::ApiActionAllOf
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **response** | [**Response**](Response.md) |  |  |
+| **request** | [**Request**](Request.md) |  |  |
+
+## Example
+
+```ruby
+require 'pnap_audit_api'
+
+instance = AuditApi::ApiActionAllOf.new(
+  response: null,
+  request: null
+)
+```
+

data/docs/Event.md

@@ -0,0 +1,22 @@
+# AuditApi::Event
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | The name of the event. | [optional] |
+| **timestamp** | **Time** | The UTC time the event initiated. |  |
+| **user_info** | [**UserInfo**](UserInfo.md) |  |  |
+
+## Example
+
+```ruby
+require 'pnap_audit_api'
+
+instance = AuditApi::Event.new(
+  name: API.CreateServer,
+  timestamp: null,
+  user_info: null
+)
+```
+

data/docs/EventsApi.md

@@ -0,0 +1,91 @@
+# AuditApi::EventsApi
+
+All URIs are relative to *https://api.phoenixnap.com/audit/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**events_get**](EventsApi.md#events_get) | **GET** /events | List event logs. |
+
+
+## events_get
+
+> <Array<Event>> events_get(opts)
+
+List event logs.
+
+Retrieves the event logs for given time period. All date & times are in UTC.
+
+### Examples
+
+```ruby
+require 'time'
+require 'pnap_audit_api'
+# setup authorization
+AuditApi.configure do |config|
+  # Configure OAuth2 access token for authorization: OAuth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = AuditApi::EventsApi.new
+opts = {
+  from: Time.parse('2021-04-27T16:24:57.123Z'), # Time | From the date and time (inclusive) to filter event log records by.
+  to: Time.parse('2021-04-29T16:24:57.123Z'), # Time | To the date and time (inclusive) to filter event log records by.
+  limit: 10, # Integer | Limit the number of records returned.
+  order: 'ASC', # String | Ordering of the event's time. SortBy can be introduced later on.
+  username: 'johnd@phoenixnap.com', # String | The username that did the actions.
+  verb: 'POST', # String | The HTTP verb corresponding to the action.
+  uri: '/ams/v1/clients/12345' # String | The request uri.
+}
+
+begin
+  # List event logs.
+  result = api_instance.events_get(opts)
+  p result
+rescue AuditApi::ApiError => e
+  puts "Error when calling EventsApi->events_get: #{e}"
+end
+```
+
+#### Using the events_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<Event>>, Integer, Hash)> events_get_with_http_info(opts)
+
+```ruby
+begin
+  # List event logs.
+  data, status_code, headers = api_instance.events_get_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<Event>>
+rescue AuditApi::ApiError => e
+  puts "Error when calling EventsApi->events_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **from** | **Time** | From the date and time (inclusive) to filter event log records by. | [optional] |
+| **to** | **Time** | To the date and time (inclusive) to filter event log records by. | [optional] |
+| **limit** | **Integer** | Limit the number of records returned. | [optional] |
+| **order** | **String** | Ordering of the event&#39;s time. SortBy can be introduced later on. | [optional][default to &#39;ASC&#39;] |
+| **username** | **String** | The username that did the actions. | [optional] |
+| **verb** | **String** | The HTTP verb corresponding to the action. | [optional] |
+| **uri** | **String** | The request uri. | [optional] |
+
+### Return type
+
+[**Array&lt;Event&gt;**](Event.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/Headers.md

@@ -0,0 +1,18 @@
+# AuditApi::Headers
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **user_agent** | **String** | The UA String |  |
+
+## Example
+
+```ruby
+require 'pnap_audit_api'
+
+instance = AuditApi::Headers.new(
+  user_agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/90.0.4430.93 Safari/537.36
+)
+```
+

data/docs/Request.md

@@ -0,0 +1,22 @@
+# AuditApi::Request
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **headers** | [**Headers**](Headers.md) |  |  |
+| **uri** | **String** | The request URI. |  |
+| **verb** | **String** | The HTTP request verb. |  |
+
+## Example
+
+```ruby
+require 'pnap_audit_api'
+
+instance = AuditApi::Request.new(
+  headers: null,
+  uri: /v1/servers/jghf757HGhjghg,
+  verb: PATCH
+)
+```
+

data/docs/Response.md

@@ -0,0 +1,20 @@
+# AuditApi::Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **status_code** | **Integer** | The status code returned in the response sent to the API. |  |
+| **resource_id** | **String** | The ID of the resource that was created. | [optional] |
+
+## Example
+
+```ruby
+require 'pnap_audit_api'
+
+instance = AuditApi::Response.new(
+  status_code: 200,
+  resource_id: 5edf1c9b4215748ac543d721
+)
+```
+

data/docs/UserInfo.md

@@ -0,0 +1,22 @@
+# AuditApi::UserInfo
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **account_id** | **String** | The BMC account ID |  |
+| **client_id** | **String** | The client ID of the application | [optional] |
+| **username** | **String** | The logged in user or owner of the client application |  |
+
+## Example
+
+```ruby
+require 'pnap_audit_api'
+
+instance = AuditApi::UserInfo.new(
+  account_id: 1234dfgdsf,
+  client_id: e9d335b1-3aa4-4760-9bad-2595c0449035,
+  username: johnd@phoenixnap.com
+)
+```
+

data/lib/pnap_audit_api/api/events_api.rb

@@ -0,0 +1,108 @@
+=begin
+#Audit Log API
+
+#The Audit Logs API lets you read audit log entries and track API calls or activities in the Bare Metal Cloud Portal.<br> <br> <span class='pnap-api-knowledge-base-link'> Knowledge base articles to help you can be found <a href='https://phoenixnap.com/kb/bmc-server-management-via-api#audit-log-api' target='_blank'>here</a> </span><br> <br> <b>All URLs are relative to (https://api.phoenixnap.com/audit/v1/)</b> 
+
+The version of the OpenAPI document: 1.0
+Contact: support@phoenixnap.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.4.0
+
+=end
+
+require 'cgi'
+
+module AuditApi
+  class EventsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # List event logs.
+    # Retrieves the event logs for given time period. All date & times are in UTC.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Time] :from From the date and time (inclusive) to filter event log records by.
+    # @option opts [Time] :to To the date and time (inclusive) to filter event log records by.
+    # @option opts [Integer] :limit Limit the number of records returned.
+    # @option opts [String] :order Ordering of the event&#39;s time. SortBy can be introduced later on. (default to 'ASC')
+    # @option opts [String] :username The username that did the actions.
+    # @option opts [String] :verb The HTTP verb corresponding to the action.
+    # @option opts [String] :uri The request uri.
+    # @return [Array<Event>]
+    def events_get(opts = {})
+      data, _status_code, _headers = events_get_with_http_info(opts)
+      data
+    end
+
+    # List event logs.
+    # Retrieves the event logs for given time period. All date &amp; times are in UTC.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Time] :from From the date and time (inclusive) to filter event log records by.
+    # @option opts [Time] :to To the date and time (inclusive) to filter event log records by.
+    # @option opts [Integer] :limit Limit the number of records returned.
+    # @option opts [String] :order Ordering of the event&#39;s time. SortBy can be introduced later on.
+    # @option opts [String] :username The username that did the actions.
+    # @option opts [String] :verb The HTTP verb corresponding to the action.
+    # @option opts [String] :uri The request uri.
+    # @return [Array<(Array<Event>, Integer, Hash)>] Array<Event> data, response status code and response headers
+    def events_get_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: EventsApi.events_get ...'
+      end
+      allowable_values = ["ASC", "DESC"]
+      if @api_client.config.client_side_validation && opts[:'order'] && !allowable_values.include?(opts[:'order'])
+        fail ArgumentError, "invalid value for \"order\", must be one of #{allowable_values}"
+      end
+      allowable_values = ["POST", "PUT", "PATCH", "DELETE"]
+      if @api_client.config.client_side_validation && opts[:'verb'] && !allowable_values.include?(opts[:'verb'])
+        fail ArgumentError, "invalid value for \"verb\", must be one of #{allowable_values}"
+      end
+      # resource path
+      local_var_path = '/events'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'from'] = opts[:'from'] if !opts[:'from'].nil?
+      query_params[:'to'] = opts[:'to'] if !opts[:'to'].nil?
+      query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
+      query_params[:'order'] = opts[:'order'] if !opts[:'order'].nil?
+      query_params[:'username'] = opts[:'username'] if !opts[:'username'].nil?
+      query_params[:'verb'] = opts[:'verb'] if !opts[:'verb'].nil?
+      query_params[:'uri'] = opts[:'uri'] if !opts[:'uri'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Array<Event>'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['OAuth2']
+
+      new_options = opts.merge(
+        :operation => :"EventsApi.events_get",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: EventsApi#events_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end