about
This gem provides a clean and powerful interface for interacting with the Flickr API. It is designed to be simple to begin using, but supports advanced usage for photo uploads and integration into a web application. To get started, just configure it with a valid API key.
features
Fleakr supports:
- Retrieval of resources (e.g users, sets, photos, etc...) with finders or through associations
- Single-user authentication via Mobile authentication mode
- Multi-user authentication via Web authentication mode
- Individual and bulk uploading of photos
- Individual and bulk downloading of photos to a destination path
installation
Fleakr is available via RubyGems:
$ gem install fleakr
Or you can grab a pre-release version from Github:
$ git clone git://github.com/reagent/fleakr.git
$ cd fleakr
$ rake install
basic usage
To get started, require the gem and set your API key:
require 'rubygems'
require 'fleakr'
Fleakr.api_key = 'my_api_key'
This will give you read-only access to all the resources you have permission to view. To see what's available or to configure write access (including photo uploading), take a look at the latest documentation.
running tests
Because the development dependencies are managed with Bundler, all you need to do is install them:
$ bundle install
From there you can run rake to run all tests in the suite. If you would like to run code coverage statistics, install the rcov Gem:
$ gem install rcov
Once that is installed, the default task will run all tests and report the coverage.
contributing
If there is a feature that you would like to see, open an issue or implement the feature yourself. If you are contributing code, please:
- Fork the repository on Github.
- Make changes to the code with accompanying tests. If you need to change the version, do so in a separate commit.
- Send me a pull request.
If I include your changes I will add you to the list of contributors.
contributors
These people have given their time, code, and ideas to this project: