Giter VIP home page Giter VIP logo

freesound_ruby's Introduction

Freesound Ruby

Consume the Freesound.org API with Ruby.

Build Status Code Climate Gem Version

Installation

Add this line to your application's Gemfile:

gem 'freesound_ruby'

And then execute:

$ bundle

Or install it yourself as:

$ gem install freesound_ruby

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

Freesound exposes three resources: sounds, users, and packs. You can request them directly from the client:

sound = client.sound(17185)
user  = client.user("alexgenco")
pack  = client.pack(5107)

Resources will respond to any attributes returned by the API:

sound.bitrate # => 1411
user.username # => "alexgenco"
pack.name     # => "Iceland"

You can also search for sounds:

client.search("kick") # => (many sounds)

Searches can be filtered as well:

Parameter Description
p The page of the search result to get
f A filter string (see docs for info)
s How to sort the results
fields Fields to return on each sound
sounds_per_page Number of sounds to return in each page
g Group results in packs

For example, client.search("kick", p: 1, sounds_per_page: 3) will return the first 3 results of the search.

See the Freesound API docs for more information on search parameters.

More features to come!

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

You will need a Freesound.org API key to run the integration tests. Get one here and assign it to the FREESOUND_KEY environment variable.

freesound_ruby's People

Contributors

alexgenco avatar

Watchers

Mark Wise avatar James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.