Merge pull request #11 from OpenCageData/release/v2.0.0

Release/v2.0.0

Author: tsamaya

.github/CONTRIBUTING.md

@@ -1,51 +1,56 @@
-
 # Contributing
 
-I'm happy to accept external contributions to the project in the form of feedback, 
+We are happy to accept external contributions to the project in the form of feedback,
 bug reports and even better - pull requests
 
 ## Issues
 
-Issues are mostly used to track **bugs** and **feature requests** but you can also 
+Issues are mostly used to track **bugs** and **feature requests** but you can also
 ask questions as it's the only place I'm looking at.
 
 Before reporting a bug or requesting a feature, run a few searches to
 see if a similar issue has already been opened and ensure you’re not submitting
 a duplicate.
 
 ### Bugs
-* Choose the "Bug Report" template
-* Fill in all relevant information, especially
-* Describe steps to reproduce
-* Full error message if any
-* Your code if relevant
+
+- Choose the "Bug Report" template
+- Fill in all relevant information, especially
+- Describe steps to reproduce
+- Full error message if any
+- Your code if relevant
 
 ### Feature Requests
-* Choose the "Feature Request" template
-* Describe the feature. Be specific
-* Explain why I should implement it.
+
+- Choose the "Feature Request" template
+- Describe the feature. Be specific
+- Explain why I should implement it.
 
 ## Pull Request Guidelines
-* Please check to make sure that there aren't existing pull requests attempting to address the issue mentioned.
-* Open a single PR for each subject.
-* Develop in a topic branch, not master (feature-name).
-* Write a convincing description of your PR and why I should land it.
-* Update documentation comments where applicable.
+
+- Please check to make sure that there aren't existing pull requests attempting to address the issue mentioned.
+- Open a single PR for each subject.
+- Develop in a topic branch, not master (feature-name).
+- Write a convincing description of your PR and why I should land it.
+- Update documentation comments where applicable.
 
 ### Only touch relevant files
 
-* Make sure your PR stays focused on a single feature.
-* Don't change project configs or any files unrelated to the subject you're working.
-* Don't reformat code you don't modify.
+- Make sure your PR stays focused on a single feature.
+- Don't change project configs or any files unrelated to the subject you're working.
+- Don't reformat code you don't modify.
 
 ### Fixing a bug?
-* Mention it or create an issue if not exist
-* Do not forgot to put [Fix # in your commit message to auto close](https://help.github.com/articles/closing-issues-via-commit-messages/)
+
+- Mention it or create an issue if not exist
+- Do not forgot to put [Fix # in your commit message to auto close](https://help.github.com/articles/closing-issues-via-commit-messages/)
 
 ### Keep your commit history short and clean.
-* Keeping the history clean means making one commit per feature. (no fix of your fix)
-* I will squash every PR.
+
+- Keeping the history clean means making one commit per feature. (no fix of your fix)
+- We may squash your PR.
 
 ### Make sure tests pass (if exist)
-* Add relevant tests to cover the change.
-* Make sure test-suite passes.
+
+- Add relevant tests to cover the change.
+- Make sure test-suite passes.

.github/ISSUE_TEMPLATE/-everything-else--report.md

@@ -4,7 +4,6 @@ about: Use this if it's NOT a bug or feature request
 title: ''
 labels: ''
 assignees: ''
-
 ---
 
 <!--
@@ -14,10 +13,12 @@ ATTENTION: Only issues using a filled template will be accepted!
 ### Description
 
 ### Library version:
+
 <!-- Please remove all items that are not relevant. -->
 
+- 2.0.0
+- 1.4.1
 - 1.4.0
 - 1.3.0
 - 1.2.1
 - other: (Please fill in the version you are using.)
-

.github/ISSUE_TEMPLATE/bug-report.md

@@ -4,22 +4,25 @@ about: Template to report bugs.
 title: 'Bug: '
 labels: ''
 assignees: ''
-
 ---
 
 <!--
 ATTENTION: Only issues using a filled template will be accepted!
 -->
 
 ### Library version:
+
 <!-- Please remove all items that are not relevant. -->
 
+- 2.0.0
+- 1.4.1
 - 1.4.0
 - 1.3.0
 - 1.2.1
 - other: (Please fill in the version you are using.)
 
 ### Current Behavior
+
 <!-- Describe the bug. Be specific. I need to understand you problem. -->
 
 Your code
@@ -35,16 +38,17 @@ Add here
 ```
 
 ### Expected Behavior
-<!-- Describe what the behavior would be without the bug. -->
 
+<!-- Describe what the behavior would be without the bug. -->
 
 ### Sample Code or Sample Application Repo
-<!-- If you are able to illustrate the bug or feature request with an example, please provide sample code snippets or a sample application via a public repo. -->
 
+<!-- If you are able to illustrate the bug or feature request with an example, please provide sample code snippets or a sample application via a public repo. -->
 
 ### Reproduction Steps
-<!--  Please explain the steps required to duplicate the issue, especially if you are able to provide a sample application. -->
 
+<!--  Please explain the steps required to duplicate the issue, especially if you are able to provide a sample application. -->
 
 ### Other Information
+
 <!-- List any other information that is relevant to your issue. Stack traces, related issues, suggestions on how to fix, Stack Overflow links, forum links, etc. -->

.github/ISSUE_TEMPLATE/feature-request.md

@@ -4,24 +4,28 @@ about: Request a feature addition or change.
 title: 'Feat: '
 labels: ''
 assignees: ''
-
 ---
 
 <!--
 ATTENTION: Only issues using a filled template will be accepted!
 -->
 
 ### Describe the Feature
+
 <!-- A clear and concise description of what the feature request is. Please include if your feature request is related to a problem. -->
 
 ### Describe Preferred Solution
+
 <!-- A clear and concise description of what you want to happen. -->
 
 ### Describe Alternatives
+
 <!-- A clear and concise description of any alternative solutions or features you've considered. -->
 
 ### Related Code
+
 <!-- If you are able to illustrate the feature request with an example, please provide a sample application via an online code collaborator such as [StackBlitz](https://stackblitz.com), or [GitHub](https://github.com). -->
 
 ### Additional Context
+
 <!-- List any other information that is relevant to your issue. Stack traces, related issues, suggestions on how to add, use case, Stack Overflow links, forum links, screenshots, OS if applicable, etc. -->

.github/dependabot.yml

@@ -5,7 +5,7 @@
 
 version: 2
 updates:
-  - package-ecosystem: "gradle" # See documentation for possible values
-    directory: "/" # Location of package manifests
+  - package-ecosystem: 'gradle' # See documentation for possible values
+    directory: '/' # Location of package manifests
     schedule:
-      interval: "weekly"
+      interval: 'weekly'

CHANGELOG.md

@@ -7,6 +7,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [2.0.0] - 2023-10-10
+
+### Important
+
+- OpenCage Data is now maintaining this package
+
 ## [1.4.1] - 2023-10-04
 
 ### Changed
@@ -18,9 +24,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Fixed
 
-- [@moberwasserlechner]: Decimal numbers with large scale are converted to String using the E notation, leading to incorrect results with reverse geocoding.
-- [@moberwasserlechner]: Coerce latitude/longitude to String preventing E notation [#44](https://github.com/moberwasserlechner/jopencage/issues/44) thx [@lpellegr](https://github.com/lpellegr)
-- [@moberwasserlechner]: Fixed SSL and AllowAllHostNameVerifier [#43](https://github.com/moberwasserlechner/jopencage/pull/43) thx [@damade](https://github.com/damade)
+- [@moberwasserlechner](https://github.com/moberwasserlechner): Decimal numbers with large scale are converted to String using the E notation, leading to incorrect results with reverse geocoding.
+- [@moberwasserlechner](https://github.com/moberwasserlechner): Coerce latitude/longitude to String preventing E notation [#44](https://github.com/moberwasserlechner/jopencage/issues/44) thx [@lpellegr](https://github.com/lpellegr)
+- [@moberwasserlechner](https://github.com/moberwasserlechner): Fixed SSL and AllowAllHostNameVerifier [#43](https://github.com/moberwasserlechner/jopencage/pull/43) thx [@damade](https://github.com/damade)
 
 ## [1.4.0] - 2021-04-18
 
@@ -71,7 +77,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - Bug fix bounds on forward request (#27)
 
-[Unreleased]: https://github.com/moberwasserlechner/jopencage/compare/1.4.1...master
+[Unreleased]: https://github.com/OpenCageData/jopencage/compare/2.0.0...master
+[2.0.0]: https://github.com/moberwasserlechner/jopencage/compare/1.4.1...2.0.0
 [1.4.1]: https://github.com/moberwasserlechner/jopencage/compare/1.4.0...1.4.1
 [1.4.0]: https://github.com/moberwasserlechner/jopencage/compare/1.3.0...1.4.0
 [1.3.0]: https://github.com/moberwasserlechner/jopencage/compare/1.2.1...1.3.0

README.md

@@ -3,11 +3,19 @@
 [![Maven Central](https://img.shields.io/maven-central/v/com.opencagedata/jopencage.svg?label=Maven%20Central)](https://central.sonatype.com/artifact/com.opencagedata/jopencage)
 [![UnitTests](https://github.com/OpenCageData/jopencage/actions/workflows/unit-tests.yml/badge.svg?branch=master)](https://github.com/OpenCageData/jopencage/actions)
 
-This api provides a java client to the OpenCage geocoding service. https://opencagedata.com/api
+This package provides a Java client to the OpenCage Geocoding API: https://opencagedata.com/api
+
+## Tutorial
+
+You can find a comprehensive tutorial for using this package [on the OpenCage site](https://opencagedata.com/tutorials/geocode-in-java).
+
+## Getting started
+
+Signup for a [free-trial API Key](https://opencagedata.com/users/sign_up).
 
 ## Usage
 
-Maven
+**Maven**
 
 ```xml
   <dependency>
@@ -17,7 +25,7 @@ Maven
   </dependency>
 ```
 
-Gradle
+**Gradle**
 
 ```gradle
     implementation "com.opencagedata:jopencage:REPLACE.WITH.VERSION"

build.gradle

@@ -58,9 +58,19 @@ publishing {
 				}
 				developers {
 					developer {
+						id = 'OpenCageData'
+						name = 'OpenCage Data'
+						email = 'support@opencagedata.com'
+						organizationUrl = 'https://opencagedata.com'
+						roles = [ 'maintainer' ]
+					}
+				}
+				contributors {
+					contributor {
 						id = 'moberwasserlechner'
 						name = 'Michael Oberwasserlechner'
 						email = 'm.oberwasserlechner@byteowls.com'
+						roles = [ 'former maintainer']
 					}
 				}
 				scm {
@@ -74,22 +84,22 @@ publishing {
 	repositories {
 		maven {
 			// change URLs to point to your repos, e.g. http://my.org/repo
-			def releasesRepoUrl = "https://s01.oss.sonatype.org/service/local/staging/deploy/maven2/"
-			def snapshotsRepoUrl = "https://s01.oss.sonatype.org/content/repositories/snapshots/"
+			def releasesRepoUrl = "https://oss.sonatype.org/service/local/staging/deploy/maven2/"
+			def snapshotsRepoUrl = "https://oss.sonatype.org/content/repositories/snapshots/"
 			url = version.endsWith('SNAPSHOT') ? snapshotsRepoUrl : releasesRepoUrl
 			credentials {
-				username = project.findProperty("MAVEN_CENTRAL_USERNAME") ?: System.getenv("MAVEN_CENTRAL_USERNAME")
-				password = project.findProperty("MAVEN_CENTRAL_PASSWORD") ?: System.getenv("MAVEN_CENTRAL_PASSWORD")
+				username = project.findProperty("MAVEN_USERNAME") ?: System.getenv("MAVEN_USERNAME")
+				password = project.findProperty("MAVEN_PASSWORD") ?: System.getenv("MAVEN_PASSWORD")
 			}
 		}
 	}
 }
 
 signing {
-//	def signingKeyId = (String) project.findProperty("MAVEN_SIGNING_KEY_ID") ?: System.getenv("MAVEN_SIGNING_KEY_ID")
-//	def signingKey = (String) project.findProperty("MAVEN_SIGNING_KEY") ?: System.getenv("MAVEN_SIGNING_KEY")
-//	def signingPassword = (String) project.findProperty("MAVEN_SIGNING_PASSWORD") ?: System.getenv("MAVEN_SIGNING_PASSWORD")
-//	useInMemoryPgpKeys(signingKeyId, signingKey, signingPassword)
+	// def signingKeyId = (String) project.findProperty("OSSRH_GPG_SIGNING_KEY_ID") ?: System.getenv("OSSRH_GPG_SIGNING_KEY_ID")
+	// def signingKey = (String) project.findProperty("OSSRH_GPG_SECRET_KEY") ?: System.getenv("OSSRH_GPG_SECRET_KEY")
+	// def signingPassword = (String) project.findProperty("OSSRH_GPG_SECRET_KEY_PASSWORD") ?: System.getenv("OSSRH_GPG_SECRET_KEY_PASSWORD")
+	// useInMemoryPgpKeys(signingKeyId, signingKey, signingPassword)
 	sign publishing.publications.mavenJava
 }
 

gradle.properties

@@ -1,6 +1,6 @@
 group=com.opencagedata
 artifactId=jopencage
-version=1.4.1
+version=2.0.0
 
 # slf4jVersion=1.7.32
 httpClientVersion=5.2.1