Merge pull request #1 from watson-developer-cloud/mdk/watson-spring-boot

Initial attempt at Watson Spring support

Author: Mike Kistler

.github/CODE_OF_CONDUCT.md

@@ -0,0 +1,46 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [email protected]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

.github/CONTRIBUTING.md

@@ -0,0 +1,79 @@
+# Questions
+
+If you are having difficulties using the APIs or have a question about the IBM Watson Services,
+please ask a question on [dW Answers][dw] or [Stack Overflow][stackoverflow].
+
+# Issues
+
+If you encounter an issue with the Watson Spring Boot support, you are welcome to submit a
+[bug report](https://github.com/watson-developer-cloud/watson-spring/issues).
+Before that, please search for similar issues. It's possible somebody has encountered this issue already.
+
+# Pull Requests
+
+If you want to contribute to the repository, here's a quick guide:
+  1. Fork the repository
+  1. Create a `.config.properties` similar to [`config.properties`](https://github.com/watson-developer-cloud/java-sdk/blob/master/core/src/test/resources/config.properties).
+  2. develop and test your code changes, gradle: `gradle test`.
+    * Run `checkstyle`: `gradle checkstyle`. 🏁
+    * Create minimal diffs - disable on save actions like reformat source code or organize imports. If you feel the source code should be reformatted create a separate PR for this change.
+    * Check for unnecessary whitespace with git diff --check before committing.
+  3. Make the test pass
+  4. Commit your changes:   
+    * Use the present tense (`"Add feature"` not `"Added Feature"`)
+    * Use the imperative mood (`"Move cursor to…"` not `"Moves cursor to…"`)
+    * Include relevant Emoji from our [Emoji cheatsheet](#emoji-cheatsheet)
+  5. Push to your fork and submit a pull request to the **master** branch
+
+# Developer's Certificate of Origin 1.1
+
+By making a contribution to this project, I certify that:
+
+(a) The contribution was created in whole or in part by me and I
+   have the right to submit it under the open source license
+   indicated in the file; or
+
+(b) The contribution is based upon previous work that, to the best
+   of my knowledge, is covered under an appropriate open source
+   license and I have the right under that license to submit that
+   work with modifications, whether created in whole or in part
+   by me, under the same open source license (unless I am
+   permitted to submit under a different license), as indicated
+   in the file; or
+
+(c) The contribution was provided directly to me by some other
+   person who certified (a), (b) or (c) and I have not modified
+   it.
+
+(d) I understand and agree that this project and the contribution
+   are public and that a record of the contribution (including all
+   personal information I submit with it, including my sign-off) is
+   maintained indefinitely and may be redistributed consistent with
+   this project or the open source license(s) involved.
+
+## Emoji Cheatsheet
+
+When creating creating commits or updating the `CHANGELOG`, please **start** the commit message or update with one of the following applicable Emoji. Emoji should not be used at the start of issue or pull request titles.
+
+* :new: `:new:` when adding new functionality
+* :bug: `:bug:` when fixing a bug
+* :memo: `:memo:` when writing documentation
+* :art: `:art:` when improving the format/structure of the code
+* :fire: `:fire:` when removing code or files
+* :racehorse: `:racehorse:` when improving performance
+* :white_check_mark: `:white_check_mark:` when adding tests
+* :green_heart: `:green_heart:` when fixing the CI build
+* :lock: `:lock:` when dealing with security
+* :crystal_ball: `:crystal_ball:` when experimenting
+* :unamused: `:unamused:` when doing chore work (updating dependencies, etc…)
+* :boom: `:boom:` when changing in a non-backwards-compatible way current functionality
+* :shipit: `:shipit:` when creating a new release
+
+## Additional Resources
++ [General GitHub documentation](https://help.github.com/)
++ [GitHub pull request documentation](https://help.github.com/send-pull-requests/)
+
+[dw]: https://developer.ibm.com/answers/questions/ask/?topics=watson
+[stackoverflow]: http://stackoverflow.com/questions/ask?tags=ibm-watson
+[Maven]: https://maven.apache.org/guides/getting-started/maven-in-five-minutes.html
+[Gradle]: https://docs.gradle.org/current/userguide/installation.html

.github/issue_template.md

@@ -0,0 +1,18 @@
+Remember, an issue is not the place to ask questions. You can use [Stack Overflow](http://stackoverflow.com/questions/tagged/ibm-watson) for that, or you may want to start a discussion on the [dW Answers](https://developer.ibm.com/answers/questions/ask/?topics=watson).
+
+Before you open an issue, please check if a similar issue already exists or has been closed before.
+
+### When reporting a bug, please be sure to include the following:
+
+- [ ] Start the title with the service name in brackets:  `[speech-to-text] websockets...`
+- [ ] Steps to reproduce
+- [ ] Expected behavior
+- [ ] Actual behavior
+- [ ] JDK version
+- [ ] java-sdk version
+
+
+### When you open an issue for a feature request, please add as much detail as possible:
+- [ ] A descriptive title starting with the service name
+- [ ] A description of the problem you're trying to solve
+- [ ] A suggested solution if possible

.github/pull_request_template.md

@@ -0,0 +1,14 @@
+### Summary
+
+Provide a general description of the code changes in your pull
+request... were there any bugs you had fixed? If so, mention them. If
+these bugs have open GitHub issues, be sure to tag them here as well,
+to keep the conversation linked together.
+
+### Other Information
+
+If there's anything else that's important and relevant to your pull
+request, mention that information here.
+
+
+Thanks for contributing to the Watson Developer Cloud!

.gitignore

@@ -10,5 +10,20 @@ gradle-app.setting
 # Cache of project
 .gradletasknamecache
 
-# # Work around https://youtrack.jetbrains.com/issue/IDEA-116898
-# gradle/wrapper/gradle-wrapper.properties
+.checkstyle
+.classpath
+.codepro
+.config.properties
+.DS_Store
+.idea
+.project
+.settings
+.vscode/
+docs
+out
+target
+
+*.iml
+*.ipr
+*.iws
+

README.md

@@ -1,2 +1,85 @@
-# watson-spring
-Spring Boot support for Watson services
+# Watson Spring Boot
+
+[![Build Status](https://travis-ci.org/watson-developer-cloud/watson-spring.svg?branch=master)](https://travis-ci.org/watson-developer-cloud/watson-spring)
+[![Maven Central](https://maven-badges.herokuapp.com/maven-central/com.ibm.watson.developer_cloud/watson-spring/badge.svg)](https://maven-badges.herokuapp.com/maven-central/com.ibm.watson.developer_cloud/watson-spring)
+[![CLA assistant](https://cla-assistant.io/readme/badge/watson-developer-cloud/watson-spring)](https://cla-assistant.io/watson-developer-cloud/watson-spring)
+
+This project adds Spring Boot support for the Watson services.
+
+This means that you can now "auto-wire" any of the Watson services into your Spring Boot application
+using the standard Spring autoconfiguration framework.
+
+## Usage
+
+All you need to do is:
+
+1. Add the Watson spring-boot-starter dependency to your Spring Boot app:
+
+    In your maven `pom.xml`
+    ```
+    <dependency>
+      <groupId>com.ibm.watson.developer_cloud</groupId>
+      <artifactId>spring-boot-starter</artifactId>
+      <version>4.2.1</version>
+    </dependency>
+    ```
+
+    or in your gradle `build.gradle`, in the dependencies stanza, add
+    ```
+    compile 'com.ibm.watson.developer_cloud:spring-boot-starter:4.2.1'
+    ```
+
+2. Add your Watson service(s) credentials and version info to your application
+properties file.  The standard location for application properties is the
+`src/main/resources/application.properties` file, but your application might
+use a different location. The properties to add are:
+
+  - `watson.<service>.url`: The base URL for the service.  This can be omitted if your
+  service uses the default service url
+  - `watson.<service>.username` and `watson.<service>.password` OR `watson.<service>.apiKey`:
+  The credentials for accessing the service.
+  The credentials can be omitted from the application properties file if they are
+  supplied through the `VCAP_SERVICES` environment variable.
+  - `watson.<service>.versionDate`: Some Watson services use a `versionDate` parameter to
+  indicate the service behavior expected by the application.  For services that accept it,
+  this is a required parameter and must be specified in the application properties.
+
+    Both Eclipse and IntelliJ (Ultimate Edition) offer autocomplete support for
+    Spring Boot application properties and should show these properties, along with
+    their required type and Javadoc description, in the autocomplete menu.
+
+3. Autowire the service into your application. Autowiring is the key mechanism of the
+Spring framework for injecting dependencies.  It is accomplished by specifying the
+`@Autowired` annotation on the declaration for the service instance.
+Here's an example using the Watson Conversation service:
+  ```java
+  @Autowired
+  protected Conversation service;
+  ```
+
+The Spring framework takes care of the rest.  Your application can now simply start
+using the service instance.
+
+## Open Source @ IBM
+
+Find more open source projects on the [IBM Github Page](http://ibm.github.io/)
+
+## License
+
+This library is licensed under Apache 2.0. Full license text is
+available in [LICENSE](LICENSE).
+
+## Contributing
+
+See [CONTRIBUTING.md](.github/CONTRIBUTING.md).
+
+## Code of Conduct
+
+See [CODE_OF_CONDUCT.md](.github/CODE_OF_CONDUCT.md).
+
+### Other
+
+If you are having difficulties using the APIs or you have a question about the IBM
+Watson Services, please ask a question on
+[dW Answers](https://developer.ibm.com/answers/questions/ask/?topics=watson)
+or [Stack Overflow](http://stackoverflow.com/questions/ask?tags=ibm-watson).

VERSION

@@ -0,0 +1 @@
+4.2.1