Project

freesound

0.0
No commit activity in last 3 years
No release in over 3 years
A Ruby library for consuming the Freesound.org API
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

>= 0
>= 0
>= 0
>= 0
>= 0
 Project Readme

Freesound Ruby

Consume the Freesound.org API with Ruby.

Note: This repository previously contained the freesound_ruby gem. To see the last snapshot of that gem's source, see the freesound_ruby-archive branch.

Build Status Gem Version

Installation

Add this line to your application's Gemfile:

gem 'freesound'

And then execute:

$ bundle

Or install it yourself as:

$ gem install freesound

Usage

You will need an API key to use the Freesound gem:

require 'freesound'
Freesound.api_key = "your_api_key"

And a client object:

client = Freesound::Client.new

See the specs for usage examples.

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request

Integration tests use VCR to record/playback responses. If you add/change a test, or re-record a test using VCR_RECORD_MODE=all, you will need to set FREESOUND_KEY to a valid API key.