endoflife_date 0.10.0

data/docs/DefaultApi.md

@@ -0,0 +1,201 @@
+# EndOfLifeDateApiClient::DefaultApi
+
+All URIs are relative to *https://endoflife.date*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_api_all_json**](DefaultApi.md#get_api_all_json) | **GET** /api/all.json | All Products |
+| [**get_api_product_cycle_json**](DefaultApi.md#get_api_product_cycle_json) | **GET** /api/{product}/{cycle}.json | Single cycle details |
+| [**get_api_product_json**](DefaultApi.md#get_api_product_json) | **GET** /api/{product}.json | Get All Details |
+
+
+## get_api_all_json
+
+> Object get_api_all_json
+
+All Products
+
+Return a list of all products. Each of these can be used for the other API endpoints.
+
+### Examples
+
+```ruby
+require 'time'
+require 'endoflife_date'
+
+api_instance = EndOfLifeDateApiClient::DefaultApi.new
+
+begin
+  # All Products
+  result = api_instance.get_api_all_json
+  p result
+rescue EndOfLifeDateApiClient::ApiError => e
+  puts "Error when calling DefaultApi->get_api_all_json: #{e}"
+end
+```
+
+#### Using the get_api_all_json_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Object, Integer, Hash)> get_api_all_json_with_http_info
+
+```ruby
+begin
+  # All Products
+  data, status_code, headers = api_instance.get_api_all_json_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Object
+rescue EndOfLifeDateApiClient::ApiError => e
+  puts "Error when calling DefaultApi->get_api_all_json_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+**Object**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_api_product_cycle_json
+
+> <Cycle> get_api_product_cycle_json(product, cycle)
+
+Single cycle details
+
+Gets details of a single cycle
+
+### Examples
+
+```ruby
+require 'time'
+require 'endoflife_date'
+
+api_instance = EndOfLifeDateApiClient::DefaultApi.new
+product = TODO # Object | Product URL as per the canonical URL on the endofife.date website
+cycle = TODO # Object | Release Cycle for which the details must be fetched
+
+begin
+  # Single cycle details
+  result = api_instance.get_api_product_cycle_json(product, cycle)
+  p result
+rescue EndOfLifeDateApiClient::ApiError => e
+  puts "Error when calling DefaultApi->get_api_product_cycle_json: #{e}"
+end
+```
+
+#### Using the get_api_product_cycle_json_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Cycle>, Integer, Hash)> get_api_product_cycle_json_with_http_info(product, cycle)
+
+```ruby
+begin
+  # Single cycle details
+  data, status_code, headers = api_instance.get_api_product_cycle_json_with_http_info(product, cycle)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Cycle>
+rescue EndOfLifeDateApiClient::ApiError => e
+  puts "Error when calling DefaultApi->get_api_product_cycle_json_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **product** | [**Object**](.md) | Product URL as per the canonical URL on the endofife.date website |  |
+| **cycle** | [**Object**](.md) | Release Cycle for which the details must be fetched |  |
+
+### Return type
+
+[**Cycle**](Cycle.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_api_product_json
+
+> Object get_api_product_json(product)
+
+Get All Details
+
+Get EoL dates of all cycles of a given product.
+
+### Examples
+
+```ruby
+require 'time'
+require 'endoflife_date'
+
+api_instance = EndOfLifeDateApiClient::DefaultApi.new
+product = TODO # Object | Product URL as per the canonical URL on the endofife.date website
+
+begin
+  # Get All Details
+  result = api_instance.get_api_product_json(product)
+  p result
+rescue EndOfLifeDateApiClient::ApiError => e
+  puts "Error when calling DefaultApi->get_api_product_json: #{e}"
+end
+```
+
+#### Using the get_api_product_json_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Object, Integer, Hash)> get_api_product_json_with_http_info(product)
+
+```ruby
+begin
+  # Get All Details
+  data, status_code, headers = api_instance.get_api_product_json_with_http_info(product)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Object
+rescue EndOfLifeDateApiClient::ApiError => e
+  puts "Error when calling DefaultApi->get_api_product_json_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **product** | [**Object**](.md) | Product URL as per the canonical URL on the endofife.date website |  |
+
+### Return type
+
+**Object**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/endoflife_date.gemspec

@@ -0,0 +1,38 @@
+# -*- encoding: utf-8 -*-
+
+=begin
+#endoflife.date
+
+#Documentation for the endoflife.date API. The API is currently in Alpha. Additional information about the API can be found on the [endoflife.date wiki](https://github.com/endoflife-date/endoflife.date/wiki)
+
+The version of the OpenAPI document: 0.0.1
+Contact: blah@cliffano.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 7.0.0
+
+=end
+
+$:.push File.expand_path("../lib", __FILE__)
+require "endoflife_date/version"
+
+Gem::Specification.new do |s|
+  s.name        = "endoflife_date"
+  s.version     = EndOfLifeDateApiClient::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Cliffano Subagio"]
+  s.email       = ["blah@cliffano.com"]
+  s.homepage    = "https://github.com/cliffano/endoflife.date-api-clients"
+  s.summary     = "endoflife.date Ruby Gem"
+  s.description = "Documentation for the endoflife.date API. The API is currently in Alpha. Additional information about the API can be found on the [endoflife.date wiki](https://github.com/endoflife-date/endoflife.date/wiki)"
+  s.license     = "MIT"
+  s.required_ruby_version = ">= 2.0"
+
+  s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
+
+  s.add_development_dependency 'rspec', '~> 3.6', '>= 3.6.0'
+
+  s.files         = `find *`.split("\n").uniq.sort.select { |f| !f.empty? }
+  s.test_files    = `find spec/*`.split("\n")
+  s.executables   = []
+  s.require_paths = ["lib"]
+end

data/git_push.sh

@@ -0,0 +1,57 @@
+#!/bin/sh
+# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/
+#
+# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com"
+
+git_user_id=$1
+git_repo_id=$2
+release_note=$3
+git_host=$4
+
+if [ "$git_host" = "" ]; then
+    git_host="github.com"
+    echo "[INFO] No command line input provided. Set \$git_host to $git_host"
+fi
+
+if [ "$git_user_id" = "" ]; then
+    git_user_id="cliffano"
+    echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
+fi
+
+if [ "$git_repo_id" = "" ]; then
+    git_repo_id="endoflife.date-api-clients"
+    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://${git_host}/${git_user_id}/${git_repo_id}.git
+    else
+        git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${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://${git_host}/${git_user_id}/${git_repo_id}.git"
+git push origin master 2>&1 | grep -v 'To https'

data/lib/endoflife_date/api/default_api.rb

@@ -0,0 +1,211 @@
+=begin
+#endoflife.date
+
+#Documentation for the endoflife.date API. The API is currently in Alpha. Additional information about the API can be found on the [endoflife.date wiki](https://github.com/endoflife-date/endoflife.date/wiki)
+
+The version of the OpenAPI document: 0.0.1
+Contact: blah@cliffano.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 7.0.0
+
+=end
+
+require 'cgi'
+
+module EndOfLifeDateApiClient
+  class DefaultApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # All Products
+    # Return a list of all products. Each of these can be used for the other API endpoints.
+    # @param [Hash] opts the optional parameters
+    # @return [Object]
+    def get_api_all_json(opts = {})
+      data, _status_code, _headers = get_api_all_json_with_http_info(opts)
+      data
+    end
+
+    # All Products
+    # Return a list of all products. Each of these can be used for the other API endpoints.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
+    def get_api_all_json_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DefaultApi.get_api_all_json ...'
+      end
+      # resource path
+      local_var_path = '/api/all.json'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # 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] || 'Object'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || []
+
+      new_options = opts.merge(
+        :operation => :"DefaultApi.get_api_all_json",
+        :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: DefaultApi#get_api_all_json\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Single cycle details
+    # Gets details of a single cycle
+    # @param product [Object] Product URL as per the canonical URL on the endofife.date website
+    # @param cycle [Object] Release Cycle for which the details must be fetched
+    # @param [Hash] opts the optional parameters
+    # @return [Cycle]
+    def get_api_product_cycle_json(product, cycle, opts = {})
+      data, _status_code, _headers = get_api_product_cycle_json_with_http_info(product, cycle, opts)
+      data
+    end
+
+    # Single cycle details
+    # Gets details of a single cycle
+    # @param product [Object] Product URL as per the canonical URL on the endofife.date website
+    # @param cycle [Object] Release Cycle for which the details must be fetched
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Cycle, Integer, Hash)>] Cycle data, response status code and response headers
+    def get_api_product_cycle_json_with_http_info(product, cycle, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DefaultApi.get_api_product_cycle_json ...'
+      end
+      # verify the required parameter 'product' is set
+      if @api_client.config.client_side_validation && product.nil?
+        fail ArgumentError, "Missing the required parameter 'product' when calling DefaultApi.get_api_product_cycle_json"
+      end
+      # verify the required parameter 'cycle' is set
+      if @api_client.config.client_side_validation && cycle.nil?
+        fail ArgumentError, "Missing the required parameter 'cycle' when calling DefaultApi.get_api_product_cycle_json"
+      end
+      # resource path
+      local_var_path = '/api/{product}/{cycle}.json'.sub('{' + 'product' + '}', CGI.escape(product.to_s)).sub('{' + 'cycle' + '}', CGI.escape(cycle.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # 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] || 'Cycle'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || []
+
+      new_options = opts.merge(
+        :operation => :"DefaultApi.get_api_product_cycle_json",
+        :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: DefaultApi#get_api_product_cycle_json\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get All Details
+    # Get EoL dates of all cycles of a given product.
+    # @param product [Object] Product URL as per the canonical URL on the endofife.date website
+    # @param [Hash] opts the optional parameters
+    # @return [Object]
+    def get_api_product_json(product, opts = {})
+      data, _status_code, _headers = get_api_product_json_with_http_info(product, opts)
+      data
+    end
+
+    # Get All Details
+    # Get EoL dates of all cycles of a given product.
+    # @param product [Object] Product URL as per the canonical URL on the endofife.date website
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
+    def get_api_product_json_with_http_info(product, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DefaultApi.get_api_product_json ...'
+      end
+      # verify the required parameter 'product' is set
+      if @api_client.config.client_side_validation && product.nil?
+        fail ArgumentError, "Missing the required parameter 'product' when calling DefaultApi.get_api_product_json"
+      end
+      # resource path
+      local_var_path = '/api/{product}.json'.sub('{' + 'product' + '}', CGI.escape(product.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # 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] || 'Object'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || []
+
+      new_options = opts.merge(
+        :operation => :"DefaultApi.get_api_product_json",
+        :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: DefaultApi#get_api_product_json\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end