Archivist::Client - an archive.org Ruby client
Create an Archivist client:
client = Archivist::Client::Base.new
Search for the books you're interested in:
books = client.search(:start_year => 1500, :end_year => 1510)
books.each do |book| puts book.download end
How you can help!
Take a look at the
reek list which is the file called
REEK and stat fixing things. Once you complete a change, run the tests:
bundle exec rspec spec
If the tests pass refresh the
bundle exec rake reek > REEK
Follow the instructions for "Contributing" below.
- Fork it
- Create your feature branch (
git checkout -b my-new-feature)
- Commit your changes (
git commit -am 'Added some feature')
- Push to the branch (
git push origin my-new-feature)
- Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
- Create new Pull Request
This library aims to adhere to Semantic Versioning 2.0.0. Violations of this scheme should be reported as bugs. Specifically, if a minor or patch version is released that breaks backward compatibility, a new version should be immediately released that restores compatibility. Breaking changes to the public API will only be introduced with new major versions.
As a result of this policy, you can (and should) specify a dependency on this gem using the Pessimistic Version Constraint with two digits of precision.
spec.add_dependency 'archivist-client', '~> 0.1.0'
- MIT License - See LICENSE file in this project
- Copyright (c) 2013 Duane Johnson & Word Tree Foundation