ryantenney / untappd-java

A Java wrapper around the Untappd RESTful API and a simple DSL for easy interaction.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

untappd-java

A Java wrapper around the Untappd RESTful API and a simple DSL for easy interaction.

Remote services are grouped into local service objects which can be centrally managed by a ServiceManager instance. The manager will act as a factory for all of the services and will automatically initialize them with your credentials and API key.

Each service contains methods which correspond to a remote method. Each of these methods instantiates a class that will allow for you to build the parameters using the Java builder pattern.

Required remote method parameters will be arguments to the service method and all of the methods in the returned builder are optional.

When fully assembled, you can trigger the remote execution by calling the fire() method. This will return a native object which represents the result of the execution. All returned objects are immutable and should be handled as such.

Usage

Coming soon...

Documentation

Questions, comments, and suggestions should be posted on the Google Group for Jake Wharton's projects.

Developed By

Contributors

The overall package and class layout as well as approximately 50% of the code in the Untappd* classes are based on nabeelmukhtar's github-java-sdk library.

License

Copyright 2011 Jake Wharton

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

About

A Java wrapper around the Untappd RESTful API and a simple DSL for easy interaction.