The AngelList API Ruby Gem
gem install angellist_api
AngellistApi.configure do |config| config.access_token = '<your token here>' end
As bearer tokens are used, this library makes all requests over SSL. AngelList does permit unauthenticated requests over plain HTTP, but we make no distinction in this regard.
bundle to install development dependencies, then run all specs with
rake -T for other possibilities.
Integration Tests for Authenticated Endpoints
Integration tests should run against the VCR cassettes included in the
repository out of the box. However, if you need to add new specs or change
existing ones, you'll need to use your own private OAuth token. To do so, you
can set an
ANGELLIST_ACCESS_TOKEN environment variable, or set this variable
through a Foreman-style
.env file in the project directory. VCR's
sensitive data filtering feature is used to prevent recording your private
This means, though, that endpoints returning data specific to the
authenticated user, such as messages or the
/me endpoint, will require
fixtures to be manually edited and maintained so that tests do not rely on
real private information stored in the repository. The suggested workflow is
to simply record a request once, then edit the body of the response in the
cassette file, and set
:record => :none for the spec(s) to prevent
accidental overwrites when fixtures are updated en masse in the future.
Submitting a Pull Request
- Fork the project.
- Create a topic branch.
- Implement your feature or bug fix.
- Add documentation for your feature or bug fix.
bundle exec rake doc:yard. If your changes are not 100% documented, go back to step 4.
- Add specs for your feature or bug fix.
bundle exec rake spec. If your changes are not 100% covered, go back to step 6.
- Commit and push your changes.
- Submit a pull request. Please do not include changes to the gemspec, version, or history file. (If you want to create your own version for some reason, please do so in a separate commit.)