Initial skeleton structure.

CHANGELOG.md

@@ -0,0 +1,11 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## Unreleased
+
+### Added
+- Initial version

LICENSE

@@ -0,0 +1,19 @@
+Copyright (C) 2024 by OpenAPI Clients Factory
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

Makefile

@@ -0,0 +1,237 @@
+################################################################
+# Swaggy C: A Makefile for generating API clients using OpenAPI Generator
+# https://github.com/cliffano/swaggy-c
+################################################################
+
+# The version of Swaggy C
+SWAGGY_C_VERSION = 4.5.0
+
+# The version of OpenAPI Generator (https://openapi-generator.tech/) used for generating the API clients
+OPENAPI_GENERATOR_VERSION = 7.6.0
+
+# LANGS_ALL lists the languages supported by the given OPENAPI_GENERATOR_VERSION
+LANGS_ALL = ada ada-server android apache2 apex asciidoc aspnetcore avro-schema bash crystal c clojure cwiki cpp-qt-client cpp-qt-qhttpengine-server cpp-pistache-server cpp-restbed-server cpp-restbed-server-deprecated cpp-restsdk cpp-tiny cpp-tizen cpp-ue4 csharp csharp-functions dart dart-dio eiffel elixir elm erlang-client erlang-proper erlang-server fsharp-functions fsharp-giraffe-server go go-echo-server go-server go-gin-server graphql-schema graphql-nodejs-express-server groovy kotlin kotlin-server kotlin-spring kotlin-vertx ktorm-schema haskell-http-client haskell haskell-yesod java jaxrs-cxf-client java-helidon-client java-helidon-server java-inflector java-micronaut-client java-micronaut-server java-msf4j java-pkmst java-play-framework java-undertow-server java-vertx java-vertx-web java-camel jaxrs-cxf jaxrs-cxf-extended jaxrs-cxf-cdi jaxrs-jersey jaxrs-resteasy jaxrs-resteasy-eap jaxrs-spec javascript javascript-apollo-deprecated javascript-flowtyped javascript-closure-angular java-wiremock jetbrains-http-client jmeter julia-client julia-server k6 lua markdown mysql-schema n4js nim nodejs-express-server objc ocaml openapi openapi-yaml plantuml perl php php-nextgen php-laravel php-lumen php-slim4 php-symfony php-mezzio-ph php-dt postman-collection powershell protobuf-schema python python-pydantic-v1 python-fastapi python-flask python-aiohttp python-blueplanet r ruby ruby-on-rails ruby-sinatra rust rust-server scalatra scala-akka scala-pekko scala-akka-http-server scala-finch scala-gatling scala-http4s-server scala-lagom-server scala-play-server scala-sttp scala-sttp4 scalaz spring dynamic-html html html2 swift5 swift-combine typescript typescript-angular typescript-aurelia typescript-axios typescript-fetch typescript-inversify typescript-jquery typescript-nestjs typescript-node typescript-redux-query typescript-rxjs wsdl-schema xojo-client zapier rust-axum
+
+# LANGS_PRIMARY lists the languages which will be built and published to public package registries
+LANGS_PRIMARY = javascript python ruby
+
+# The location where OpenAPI specification file will be placed within the project
+LOCAL_SPEC_PATH = stage/specification.yml
+
+################################################################
+# User configuration variables
+# These variables should be stored in swaggy-c.yml config file,
+# and they will be parsed using yq https://github.com/mikefarah/yq
+# Example:
+# ---
+# spec_uri: specification/someapp.yml
+# version:1.2.3
+# base_dir:
+#   github_actions: /home/runner/work/someapp/someapp
+#   local: /home/someuser/someapp
+
+# SPEC_URI is the file path or URL where the OpenAPI specification is located, for example:
+# - local file path: spec/some-app.yaml
+# - remote URL: https://some-app.com/some-app.yaml
+SPEC_URI=$(shell yq .spec_uri swaggy-c.yml)
+
+# APP_VERSION is version of the application using Swaggy C
+APP_VERSION ?= $(shell yq .version swaggy-c.yml)
+
+# Contact details to be amended to the OpenAPI specification .info.contact.* properties
+CONTACT_NAME ?= $(shell yq .contact.name swaggy-c.yml)
+CONTACT_URL ?= $(shell yq .contact.url swaggy-c.yml)
+CONTACT_EMAIL ?= $(shell yq .contact.email swaggy-c.yml)
+
+# SCM details to be amended to the OpenAPI Generator configuration .git_* properties
+SCM_GIT_USER ?= $(shell yq .scm.git_user swaggy-c.yml)
+SCM_GIT_REPO ?= $(shell yq .scm.git_repo swaggy-c.yml)
+
+# APP_BASE_DIR is the absolute path where the application base directory is located, for example:
+# - MacOS user workspace as a local directory: /Users/some-user/some-path/some-app
+#   This is used when no environment variable is specified.
+# - GitHub Actions workspace directory: /home/runner/work/some-app/some-app
+#   This is used when GITHUB_ACTIONS environment variable is specified.
+# - Custom directory to overwrite the other directories: /any/path/to/some-app
+#   This is used when CUSTOM environment variable is specified.
+ifdef GITHUB_ACTIONS
+APP_BASE_DIR=$(shell yq .base_dir.github_actions swaggy-c.yml)
+else
+  ifdef CUSTOM
+	APP_BASE_DIR=$(shell yq .base_dir.custom swaggy-c.yml)
+	else
+  APP_BASE_DIR=$(shell yq .base_dir.local swaggy-c.yml)
+	endif
+endif
+
+$(info ################################################################)
+$(info Building Swaggy C application with user configurations:)
+$(info - OpenAPI specification URI: ${SPEC_URI})
+$(info - Application version: ${APP_VERSION})
+$(info - Application base directory: ${APP_BASE_DIR})
+
+################################################################
+# Base targets
+
+# CI target to be executed by CI/CD tool
+ci: clean deps init-spec generate build-javascript build-python build-ruby test-javascript test-python test-ruby doc
+
+# Ensure stage directory exists
+stage:
+	mkdir -p stage
+
+# Remove all generated API clients code
+clean:
+	rm -rf stage/ clients/*/generated
+
+# Retrieve the OpenAPI Generator Docker image and npm modules
+deps:
+	docker pull openapitools/openapi-generator-cli:v$(OPENAPI_GENERATOR_VERSION)
+	npm install -g bootprint bootprint-openapi gh-pages mocha
+
+# Initialise OpenAPI specification from either a local file path or a remote URL
+# This target requires the following parameters to be supplied by user
+# - SPEC_URI parameter
+# - CONTACT_NAME parameter
+# - CONTACT_ parameter
+# - CONTACT_NAME parameter
+init-spec: stage
+	if test $(findstring https, $(SPEC_URI)); then \
+	  curl $(SPEC_URI) --output $(LOCAL_SPEC_PATH); \
+	else \
+	  cp $(SPEC_URI) $(LOCAL_SPEC_PATH); \
+	fi
+	yq -i '.info.contact.name = "$(CONTACT_NAME)" | .info.contact.url = "$(CONTACT_URL)" | .info.contact.email = "$(CONTACT_EMAIL)"' "$(LOCAL_SPEC_PATH)"
+
+# Initialise basic configuration file for all languages
+init-langs-config:
+	for lang in ${LANGS_ALL} ; do \
+	  mkdir -p clients/$$lang/; \
+		echo "{\n  \"gitUserId\": \"$(SCM_GIT_USER)\",\n  \"gitRepoId\": \"$(SCM_GIT_REPO)\"\n}" > clients/$$lang/conf.json; \
+	done
+
+# Update Makefile to the latest version on origin's main branch
+update-to-latest:
+	curl https://raw.githubusercontent.com/cliffano/swaggy-c/main/src/Makefile-swaggy-c -o Makefile
+
+# Update Makefile to the version defined in TARGET_SWAGGY_C_VERSION parameter
+update-to-version:
+	curl https://raw.githubusercontent.com/cliffano/swaggy-c/v$(TARGET_SWAGGY_C_VERSION)/src/Makefile-swaggy-c -o Makefile
+
+################################################################
+# API clients generate targets
+
+# Alias for generate-all target
+generate: generate-all
+
+# Generate API clients for all languages, this is separate from generate-primary target in order to
+# reduce the build time when processing primary languages
+# This target requires APP_BASE_DIR parameter to be supplied by user
+generate-all:
+	for lang in ${LANGS_ALL} ; do \
+	  docker \
+		  run \
+		  --rm \
+		  -v $(APP_BASE_DIR):/local openapitools/openapi-generator-cli:v$(OPENAPI_GENERATOR_VERSION) \
+		  generate \
+		  --input-spec /local/$(LOCAL_SPEC_PATH) \
+		  --config /local/clients/$$lang/conf.json \
+		  --generator-name $$lang \
+		  --output /local/clients/$$lang/generated; \
+	done
+
+# Generate API clients for primary languages only
+# This target requires APP_BASE_DIR parameter to be supplied by user
+generate-primary:
+	for lang in ${LANGS_PRIMARY} ; do \
+	  docker \
+		  run \
+		  --rm \
+		  -v $(APP_BASE_DIR):/local openapitools/openapi-generator-cli:v$(OPENAPI_GENERATOR_VERSION) \
+		  generate \
+		  --input-spec /local/$(LOCAL_SPEC_PATH) \
+		  --config /local/clients/$$lang/conf.json \
+		  --generator-name $$lang \
+		  --output /local/clients/$$lang/generated; \
+	done
+
+################################################################
+# API clients building targets for primary languages
+
+build-javascript:
+	npm install -g babel-cli
+	cd clients/javascript/generated/ && \
+	  npm install && \
+	  npm link && \
+	  npm run build
+	cd test/javascript/ && \
+	  npm link ../../clients/javascript/generated/
+
+build-python:
+	sudo apt-get install -y python-setuptools
+	pip install twine wheel pytest
+	cd clients/python/generated/ && \
+	  pip install -r requirements.txt && \
+	  python3 setup.py sdist bdist_wheel && \
+	  python3 setup.py install
+
+build-ruby:
+	cd clients/ruby/generated/ && \
+	  find . -name '*.gem' -delete && \
+	  gem install bundler --version=1.17.3 && \
+	  bundle install --binstubs && \
+	  gem build *.gemspec && \
+	  gem install ./*.gem
+
+################################################################
+# API clients testing targets for primary languages
+
+test-javascript: build-javascript
+	cd clients/javascript/generated/ && \
+	  npm run test
+	mocha --timeout 5000 test/javascript/
+
+test-python: build-python
+	cd clients/python/generated/ && \
+	  twine check dist/*
+	pytest -v test/python/*.py --capture=no
+
+test-ruby: build-ruby
+
+################################################################
+# API clients package publishing targets for primary languages
+
+publish-javascript: build-javascript
+	cd clients/javascript/generated/ && \
+	  npm publish
+
+publish-python: build-python
+	cd clients/python/generated/ && \
+	  twine upload dist/*
+
+publish-ruby: build-ruby
+	cd clients/ruby/generated/ && \
+	  gem push `ls *.gem`
+
+################################################################
+# Documentation targets
+
+# Alias for doc-latest target
+doc: doc-latest
+
+# Generate API documentation locally as the latest version
+doc-latest:
+	bootprint openapi $(LOCAL_SPEC_PATH) doc/api/latest/
+
+# Generate API documentation locally as the application's version
+# This target requires APP_VERSION parameter to be supplied by user
+doc-version:
+	bootprint openapi $(LOCAL_SPEC_PATH) doc/api/$(APP_VERSION)/
+
+# Publish documentation via GitHub Pages
+doc-publish:
+	CACHE_DIR=/tmp gh-pages --dist doc/
+
+################################################################
+
+.PHONY: all test ci stage clean deps init-spec init-langs-config generate generate-all generate-primary build-javascript build-python build-ruby test-javascript test-python test-ruby publish-javascript publish-python publish-ruby doc doc-latest doc-version doc-publish

README.md

@@ -1,2 +1,49 @@
-# minecraft-versions
-TODO
+<img align="right" src="https://raw.github.com/oapicf/minecraft-versions/master/avatar.jpg" alt="Avatar"/>
+
+[![Build Status](https://github.com/oapicf/minecraft-versions/actions/workflows/ci-workflow.yaml/badge.svg)](https://github.com/oapicf/minecraft-versions/actions/workflows/ci-workflow.yaml)
+<br/>
+
+Minecraft Versions
+------------------
+
+Minecraft Versions is SDK for Minecraft versions info .
+
+Published packages
+------------------
+
+| Language | Package | Status | Documentation |
+|----------|---------|--------|---------------|
+| JavaScript | [minecraft-versions]((http://www.npmjs.com/package/minecraft-versions)) | [![Published Version](https://img.shields.io/npm/v/minecraft-versions.svg)](http://www.npmjs.com/package/minecraft-versions) | [README](https://github.com/oapicf/minecraft-versions/blob/main/clients/javascript/generated/README.md) |
+| Python | [minecraft-versions]((https://pypi.python.org/pypi/minecraft-versions)) | [![Published Version](https://img.shields.io/pypi/v/minecraft-versions.svg)](https://pypi.python.org/pypi/minecraft-versions) | [README](https://github.com/oapicf/minecraft-versions/blob/main/clients/python/generated/README.md) |
+| Ruby | [minecraft_versions]((https://rubygems.org/gems/minecraft_versions)) | [![Published Version](https://img.shields.io/gem/v/minecraft_versions.svg)](https://rubygems.org/gems/minecraft_versions) | [README](https://github.com/oapicf/minecraft-versions/blob/main/clients/ruby/generated/README.md) |
+
+Version matrix
+--------------
+
+| Minecraft Versions Version | OpenAPI Version | OpenAPI Generator Version |
+|----------------------------|-----------------|---------------------------|
+| ... | ... | ... |
+
+Installation
+------------
+
+You can either use the generated clients from `clients/<lang>/generated/` directory.
+
+Or you can use the published packages like below:
+
+Install JavaScript client:
+
+    npm install minecraft-versions
+
+Install Python client:
+
+    pip install minecraftversions
+
+Install Ruby client:
+
+    gem install minecraft_versions
+
+Colophon
+--------
+
+* [API Documentation](https://oapicf.github.io/minecraft-versions/api/latest/)