https://github.com/sanity/pivotal

A fluent Java 8 library to access the Pivotal Tracker API, released under the LGPL by OneSpot
https://github.com/sanity/pivotal

Last synced: about 1 month ago
JSON representation

A fluent Java 8 library to access the Pivotal Tracker API, released under the LGPL by OneSpot

• Host: GitHub
• URL: https://github.com/sanity/pivotal
• Owner: sanity
• License: lgpl-3.0
• Created: 2015-03-30T22:04:47.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2017-08-27T21:23:00.000Z (about 7 years ago)
• Last Synced: 2023-08-15T21:37:54.570Z (about 1 year ago)
• Language: Java
• Homepage:
• Size: 110 KB
• Stars: 4
• Watchers: 20
• Forks: 9
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Fluent Pivotaltracker java client

A fluent Java 8 library to access the [Pivotal Tracker API](https://www.pivotaltracker.com/help/api/rest/v5#top), initially created by [OneSpot](http://onespot.com/) and released under the LGPL, now maintained by [Ian Clarke](http://blog.locut.us/).

```java

  PivotalTracker pivotalTracker = new PivotalTracker(PIVOTAL_API_TOKEN);

  List stories = pivotalTracker.projects().id(PROJECT_ID)

                .stories()

                .withFields(owners, accepted_at, estimate)

                .acceptedAfter(now().minus(2 * 30 * 24, HOURS))

                .getAll();

  

  stories.forEach((s) -> {

      System.out.println(s.getName());

  });

```

The library is far from complete, the API is perhaps only 10% supported so far, however it is probably the most useful 10%.  Adding support for new parts of the API is very easy (see below), and pull requests will be most welcome.

### Dependency Management tools

This library is available via Gradle, Maven, SBT, Leiningen and compatible dependency management tools through the excellent JitPack:

[![Release](https://jitpack.io/v/sanity/pivotal.svg)](https://jitpack.io/#sanity/pivotal)

Note that we follow the [Semantic Versioning](http://semver.org/) convention for version numbers.

### Contributing

Contributions to support more of the API are very welcome, the basic framework is fairly nice to build upon, and you should be able to get a good idea of how to extend the API with just a few minutes looking at the codebase.

* [onespot.pivotal.api.resources](https://github.com/onespot/pivotal/tree/master/src/main/java/onespot/pivotal/api/resources) - Java POJOs that map directly to [resources](https://www.pivotaltracker.com/help/api/rest/v5#Resources) in the Pivotal API

* [onespot.pivotal.api.dao](https://github.com/onespot/pivotal/tree/master/src/main/java/onespot/pivotal/api/dao) - Classes that correspond roughly to [endpoints](https://www.pivotaltracker.com/help/api/rest/v5#Endpoints) in the Pivotal API

* [onespot.pivotal.rest](https://github.com/onespot/pivotal/tree/master/src/main/java/onespot/pivotal/rest) - The REST machinery (uses [Google Gson](https://code.google.com/p/google-gson/) for POJO-JSON mapping)

Feel free to create pull requests, however it can be easy to overlook these notifications so you may also want to email me at **pivotalpr [at] ian [dot] 33mail [dot] com** to ensure I'm aware of it so I can review and merge promptly.