md-validator-client 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 87924755757ddb12b4b98cd442d52d23608366dddc3ddf8d25c408851fe82203
+  data.tar.gz: c585a69dadd03bc376bc7c53054300ae3b22d6aab1b57ff2f891839e4729cdf1
+SHA512:
+  metadata.gz: 48f113221d7046ca7e310bb31284f0dad868c4de48e5ac699751169af09c8e10f85ceb0f5a8d880880de01d65c2e741aaaa7008b8a3500f599a18ab8d0117a69
+  data.tar.gz: 327ad5785c2221fca37165226cd29a5e8cb331787f2e823449d0d4b6bfd30b22a0be29920fa2c206ad21147fe53821167b0c71adeaef0238ef3faa6474353e61

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'rake', '~> 12.3.3'
+end

data/README.md

@@ -0,0 +1,89 @@
+# md-validator-client
+
+ValidatorClient - the Ruby gem for the Metadata Validation API
+
+API for the metadata validation service.
+
+This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
+
+- API version: 1.0.0
+- Package version: 1.0.1
+- Build package: io.swagger.codegen.languages.RubyClientCodegen
+
+## Installation
+
+### Build a gem
+
+To build the Ruby code into a gem:
+
+```shell
+gem build md-validator-client.gemspec
+```
+
+Then either install the gem locally:
+
+```shell
+gem install ./md-validator-client-1.0.1.gem
+```
+(for development, run `gem install --dev ./md-validator-client-1.0.1.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 'md-validator-client', '~> 1.0.1'
+
+### Install from Git
+
+If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:
+
+    gem 'md-validator-client', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
+
+### 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 'md-validator-client'
+
+api_instance = ValidatorClient::ValidationApi.new
+
+begin
+  #lists available validators
+  result = api_instance.get_validators
+  p result
+rescue ValidatorClient::ApiError => e
+  puts "Exception when calling ValidationApi->get_validators: #{e}"
+end
+
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *http://localhost*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*ValidatorClient::ValidationApi* | [**get_validators**](docs/ValidationApi.md#get_validators) | **GET** /validators | lists available validators
+*ValidatorClient::ValidationApi* | [**validate**](docs/ValidationApi.md#validate) | **POST** /validators/{validator_id}/validate | performs a validation
+
+
+## Documentation for Models
+
+ - [ValidatorClient::InlineResponse404](docs/InlineResponse404.md)
+ - [ValidatorClient::Status](docs/Status.md)
+ - [ValidatorClient::Validator](docs/Validator.md)
+
+
+## Documentation for Authorization
+
+ All endpoints do not require authorization.
+

data/Rakefile

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

data/docs/InlineResponse404.md

@@ -0,0 +1,9 @@
+# ValidatorClient::InlineResponse404
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**foo** | **String** |  | 
+**bar** | **String** |  | 
+
+

data/docs/Status.md

@@ -0,0 +1,10 @@
+# ValidatorClient::Status
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | **String** | the subclass of `StatusMetadata` | 
+**component_id** | **String** | the component identifier (bean ID) of the component that created the `StatusMetadata` object  | 
+**message** | **String** |  | 
+
+

data/docs/ValidationApi.md

@@ -0,0 +1,99 @@
+# ValidatorClient::ValidationApi
+
+All URIs are relative to *http://localhost*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_validators**](ValidationApi.md#get_validators) | **GET** /validators | lists available validators
+[**validate**](ValidationApi.md#validate) | **POST** /validators/{validator_id}/validate | performs a validation
+
+
+# **get_validators**
+> Array<Validator> get_validators
+
+lists available validators
+
+Lists all of the available validator pipelines. 
+
+### Example
+```ruby
+# load the gem
+require 'md-validator-client'
+
+api_instance = ValidatorClient::ValidationApi.new
+
+begin
+  #lists available validators
+  result = api_instance.get_validators
+  p result
+rescue ValidatorClient::ApiError => e
+  puts "Exception when calling ValidationApi->get_validators: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**Array<Validator>**](Validator.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **validate**
+> Array<Status> validate(validator_id, metadata)
+
+performs a validation
+
+### Example
+```ruby
+# load the gem
+require 'md-validator-client'
+
+api_instance = ValidatorClient::ValidationApi.new
+
+validator_id = 'validator_id_example' # String | An identifier for the validation to be performed. 
+
+metadata = 'metadata_example' # String | The metadata to be validated.
+
+
+begin
+  #performs a validation
+  result = api_instance.validate(validator_id, metadata)
+  p result
+rescue ValidatorClient::ApiError => e
+  puts "Exception when calling ValidationApi->validate: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **validator_id** | **String**| An identifier for the validation to be performed.  | 
+ **metadata** | **String**| The metadata to be validated. | 
+
+### Return type
+
+[**Array<Status>**](Status.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/xml+samlmetadata
+ - **Accept**: application/json
+
+
+

data/docs/Validator.md

@@ -0,0 +1,9 @@
+# ValidatorClient::Validator
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**validator_id** | **String** |  | 
+**description** | **String** |  | 
+
+

data/git_push.sh

@@ -0,0 +1,55 @@
+#!/bin/sh
+#
+# Generated by: https://github.com/swagger-api/swagger-codegen.git
+#
+# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/
+#
+# Usage example: /bin/sh ./git_push.sh wing328 swagger-petstore-perl "minor update"
+
+git_user_id=$1
+git_repo_id=$2
+release_note=$3
+
+if [ "$git_user_id" = "" ]; then
+    git_user_id="GIT_USER_ID"
+    echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
+fi
+
+if [ "$git_repo_id" = "" ]; then
+    git_repo_id="GIT_REPO_ID"
+    echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id"
+fi
+
+if [ "$release_note" = "" ]; then
+    release_note="Minor update"
+    echo "[INFO] No command line input provided. Set \$release_note to $release_note"
+fi
+
+# Initialize the local directory as a Git repository
+git init
+
+# Adds the files in the local repository and stages them for commit.
+git add .
+
+# Commits the tracked changes and prepares them to be pushed to a remote repository.
+git commit -m "$release_note"
+
+# Sets the new remote
+git_remote=`git remote`
+if [ "$git_remote" = "" ]; then # git remote not defined
+
+    if [ "$GIT_TOKEN" = "" ]; then
+        echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment."
+        git remote add origin https://github.com/${git_user_id}/${git_repo_id}.git
+    else
+        git remote add origin https://${git_user_id}:${GIT_TOKEN}@github.com/${git_user_id}/${git_repo_id}.git
+    fi
+
+fi
+
+git pull origin master
+
+# Pushes (Forces) the changes in the local repository up to the remote repository
+echo "Git pushing to https://github.com/${git_user_id}/${git_repo_id}.git"
+git push origin master 2>&1 | grep -v 'To https'
+

data/lib/md-validator-client.rb

@@ -0,0 +1,43 @@
+=begin
+#Metadata Validation API
+
+#API for the metadata validation service.
+
+OpenAPI spec version: 1.0.0
+Contact: ian@iay.org.uk
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.15
+
+=end
+
+# Common files
+require 'md-validator-client/api_client'
+require 'md-validator-client/api_error'
+require 'md-validator-client/version'
+require 'md-validator-client/configuration'
+
+# Models
+require 'md-validator-client/models/inline_response_404'
+require 'md-validator-client/models/status'
+require 'md-validator-client/models/validator'
+
+# APIs
+require 'md-validator-client/api/validation_api'
+
+module ValidatorClient
+  class << self
+    # Customize default settings for the SDK using block.
+    #   ValidatorClient.configure do |config|
+    #     config.username = "xxx"
+    #     config.password = "xxx"
+    #   end
+    # If no block given, return the default Configuration object.
+    def configure
+      if block_given?
+        yield(Configuration.default)
+      else
+        Configuration.default
+      end
+    end
+  end
+end

data/lib/md-validator-client/api/validation_api.rb

@@ -0,0 +1,127 @@
+=begin
+#Metadata Validation API
+
+#API for the metadata validation service.
+
+OpenAPI spec version: 1.0.0
+Contact: ian@iay.org.uk
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.15
+
+=end
+
+require 'uri'
+
+module ValidatorClient
+  class ValidationApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # lists available validators
+    # Lists all of the available validator pipelines. 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<Validator>]
+    def get_validators(opts = {})
+      data, _status_code, _headers = get_validators_with_http_info(opts)
+      data
+    end
+
+    # lists available validators
+    # Lists all of the available validator pipelines. 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Array<Validator>, Fixnum, Hash)>] Array<Validator> data, response status code and response headers
+    def get_validators_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ValidationApi.get_validators ...'
+      end
+      # resource path
+      local_var_path = '/validators'
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = []
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'Array<Validator>')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ValidationApi#get_validators\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # performs a validation
+    # @param validator_id An identifier for the validation to be performed. 
+    # @param metadata The metadata to be validated.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<Status>]
+    def validate(validator_id, metadata, opts = {})
+      data, _status_code, _headers = validate_with_http_info(validator_id, metadata, opts)
+      data
+    end
+
+    # performs a validation
+    # @param validator_id An identifier for the validation to be performed. 
+    # @param metadata The metadata to be validated.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Array<Status>, Fixnum, Hash)>] Array<Status> data, response status code and response headers
+    def validate_with_http_info(validator_id, metadata, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ValidationApi.validate ...'
+      end
+      # verify the required parameter 'validator_id' is set
+      if @api_client.config.client_side_validation && validator_id.nil?
+        fail ArgumentError, "Missing the required parameter 'validator_id' when calling ValidationApi.validate"
+      end
+      # verify the required parameter 'metadata' is set
+      if @api_client.config.client_side_validation && metadata.nil?
+        fail ArgumentError, "Missing the required parameter 'metadata' when calling ValidationApi.validate"
+      end
+      # resource path
+      local_var_path = '/validators/{validator_id}/validate'.sub('{' + 'validator_id' + '}', validator_id.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/xml+samlmetadata'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(metadata)
+      auth_names = []
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'Array<Status>')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ValidationApi#validate\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end