Skip to content
Ruby wrapper for the Futures, Inc. US Military Pipeline API
Ruby
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.
lib
spec
.gemtest
.gitignore
.rspec
.travis.yml
.yardopts
Gemfile
LICENSE.md
README.md
Rakefile
futures_pipeline.gemspec

README.md

Futures Pipeline Build Status

Ruby wrapper for the Futures, Inc. US Military Pipeline API

Installation

gem install futures_pipeline

Documentation

http://rdoc.info/gems/futures_pipeline

Usage Examples

require 'futures_pipeline'

@client = FuturesPipeline.new
@client.careers # Return an array of 50 careers
@client.careers.first.title # => "Chief Executives"
@client.careers.first.onet_soc_code # => "11-1011.00"
@client.career("11-1011.00") # Return detailed information about Chief Executives

Contributing

In the spirit of free software, everyone is encouraged to help improve this project.

Here are some ways you can contribute:

  • by using alpha, beta, and prerelease versions
  • by reporting bugs
  • by suggesting new features
  • by writing or editing documentation
  • by writing specifications
  • by writing code (no patch is too small: fix typos, add comments, clean up inconsistent whitespace)
  • by refactoring code
  • by fixing issues
  • by reviewing patches
  • financially

Submitting an Issue

We use the GitHub issue tracker to track bugs and features. Before submitting a bug report or feature request, check to make sure it hasn't already been submitted. When submitting a bug report, please include a Gist that includes a stack trace and any details that may be necessary to reproduce the bug, including your gem version, Ruby version, and operating system. Ideally, a bug report should include a pull request with failing specs.

Submitting a Pull Request

  1. Fork the repository.
  2. Create a topic branch.
  3. Add specs for your unimplemented feature or bug fix.
  4. Run bundle exec rake spec. If your specs pass, return to step 3.
  5. Implement your feature or bug fix.
  6. Run bundle exec rake spec. If your specs fail, return to step 5.
  7. Run open coverage/index.html. If your changes are not completely covered by your tests, return to step 3.
  8. Add documentation for your feature or bug fix.
  9. Run bundle exec rake yard. If your changes are not 100% documented, go back to step 8.
  10. Add, commit, and push your changes.
  11. Submit a pull request.

Supported Rubies

This library aims to support and is tested against the following Ruby implementations:

If something doesn't work on one of these interpreters, it should be considered a bug.

This library may inadvertently work (or seem to work) on other Ruby implementations, however support will only be provided for the versions listed above.

If you would like this library to support another Ruby version, you may volunteer to be a maintainer. Being a maintainer entails making sure all tests run and pass on that implementation. When something breaks on your implementation, you will be personally responsible for providing patches in a timely fashion. If critical issues for a particular implementation exist at the time of a major release, support for that Ruby version may be dropped.

Credits

Futures, Inc. REST API developed by Tom Harris.

Copyright

Copyright (c) 2011 Code for America. See LICENSE for details.

Code for America Tracker

Something went wrong with that request. Please try again.