freesound_ruby 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c7c330090c9136df4e109206164576ffd359f6cc
+  data.tar.gz: 937d092aa4adf2e3c0f7acbba0fad50bc835c4b0
+SHA512:
+  metadata.gz: a11224e534629891ab316b28a1e51f731fb9d3a1475fbb2645d264bd226b7f2b0d33bcd0fcc9e9681408a537aba96ca1101a414c352d28df2fd67dee0130ea97
+  data.tar.gz: 695e4678310c54541367837d5050a858c1ad51af4580469ca09380eb6b79a9f1fd59298875fbc812fb898439a49d35940ab876b83d78f42353d56b49e23f5711

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.gitignore

@@ -0,0 +1,50 @@
+# rcov generated
+coverage
+
+# rdoc generated
+rdoc
+
+# yard generated
+doc
+.yardoc
+
+# bundler
+.bundle
+
+# Have editor/IDE/OS specific files you need to ignore? Consider using a global gitignore: 
+#
+# * Create a file at ~/.gitignore
+# * Include files you want ignored
+# * Run: git config --global core.excludesfile ~/.gitignore
+#
+# After doing this, these files will be ignored in all your git projects,
+# saving you from having to 'pollute' every project you touch with them
+#
+# Not sure what to needs to be ignored for particular editors/OSes? Here's some ideas to get you started. (Remember, remove the leading # of the line)
+#
+# For MacOS:
+#
+#.DS_Store
+
+# For TextMate
+#*.tmproj
+#tmtags
+
+# For emacs:
+#*~
+#\#*
+#.\#*
+
+# For vim:
+*.swp
+
+# For redcar:
+#.redcar
+
+# For rubinius:
+#*.rbc
+
+*.gem
+
+# VCR Cassettes
+spec/fixtures/vcr_cassettes

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+env:
+  global:
+    secure: GKXELm3iiiVxv3hjNKvTeesXNLRJwGQo39S1SUSG8vJWgkxlidONcgtPa4sBweXPJTMY47o3F2gYnHb4yPMRrb/zxKnKVXBjPrTQPYqDUFOOGpj78n5k/QqVVeCgR/xl12f5RVOuCHMxF73fvCb6liVOaSZ72Wu6Qc/VTbM44O0=
+rvm:
+- 1.9.3
+- 2.0.0

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in freesound_ruby.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,61 @@
+PATH
+  remote: .
+  specs:
+    freesound_ruby (0.1.0)
+      activeresource (~> 4.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (4.0.2)
+      activesupport (= 4.0.2)
+      builder (~> 3.1.0)
+    activeresource (4.0.0)
+      activemodel (~> 4.0)
+      activesupport (~> 4.0)
+      rails-observers (~> 0.1.1)
+    activesupport (4.0.2)
+      i18n (~> 0.6, >= 0.6.4)
+      minitest (~> 4.2)
+      multi_json (~> 1.3)
+      thread_safe (~> 0.1)
+      tzinfo (~> 0.3.37)
+    addressable (2.3.5)
+    atomic (1.1.14)
+    builder (3.1.4)
+    crack (0.4.1)
+      safe_yaml (~> 0.9.0)
+    diff-lcs (1.2.5)
+    i18n (0.6.9)
+    minitest (4.7.5)
+    multi_json (1.8.2)
+    rails-observers (0.1.2)
+      activemodel (~> 4.0)
+    rake (10.1.0)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.7)
+    rspec-expectations (2.14.4)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.4)
+    safe_yaml (0.9.7)
+    thread_safe (0.1.3)
+      atomic
+    tzinfo (0.3.38)
+    vcr (2.8.0)
+    webmock (1.8.11)
+      addressable (>= 2.2.7)
+      crack (>= 0.1.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  freesound_ruby!
+  rake
+  rspec
+  vcr (~> 2.8.0)
+  webmock (~> 1.8.0)

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Alex Genco
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,78 @@
+# Freesound Ruby
+
+Consume the [Freesound.org](http://www.freesound.org) API with Ruby.
+
+[![Build Status](https://travis-ci.org/alexgenco/freesound_ruby.png)](https://travis-ci.org/alexgenco/freesound_ruby)
+[![Code Climate](https://codeclimate.com/github/alexgenco/freesound_ruby.png)](https://codeclimate.com/github/alexgenco/freesound_ruby)
+
+## 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](http://www.freesound.org/api/apply) to use the Freesound gem:
+
+```ruby
+require 'freesound'
+Freesound.api_key = "your_api_key"
+```
+
+And a client object:
+
+```ruby
+client = Freesound::Client.new
+```
+
+Freesound exposes three resources: 
+[sounds](http://www.freesound.org/docs/api/resources.html#sound-resource), 
+[users](http://www.freesound.org/docs/api/resources.html#users), and 
+[packs](http://www.freesound.org/docs/api/resources.html#packs).
+You can request them directly from the client:
+
+```ruby
+sound = client.sound(17185)
+user  = client.user("alexgenco")
+pack  = client.pack(5107)
+```
+
+Resources will respond to any attributes returned by the API:
+
+```ruby
+sound.bitrate # => 1411
+user.username # => "alexgenco"
+pack.name     # => "Iceland"
+```
+
+You can also search for sounds:
+
+```ruby
+client.search("kick") # => (many sounds)
+```
+
+The Freesound API also supports pagination and robust search filters, but this
+library doesn't support them quite yet.
+
+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](http://www.freesound.org/api/apply) and assign it to the
+FREESOUND_KEY environment variable.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/freesound_ruby.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'freesound/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "freesound_ruby"
+  spec.version       = Freesound::VERSION
+  spec.authors       = ["Alex Genco"]
+  spec.email         = ["alexgenco@gmail.com"]
+  spec.summary       = "A Ruby library for consuming the Freesound.org API"
+  spec.homepage      = "https://github.com/alexgenco/freesound_ruby"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = '>= 1.9.3'
+
+  spec.add_dependency "activeresource", "~> 4.0.0"
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "webmock", "~> 1.8.0"
+  spec.add_development_dependency "vcr",     "~> 2.8.0"
+end

data/lib/freesound.rb

@@ -0,0 +1,14 @@
+require "freesound/version"
+require "freesound/client"
+require "freesound/collections"
+require "freesound/resources"
+
+module Freesound
+  class << self
+    attr_writer :api_key
+
+    def api_key
+      @api_key || raise("Freesound requires an api_key")
+    end
+  end
+end

data/lib/freesound/client.rb

@@ -0,0 +1,41 @@
+require "freesound/resources"
+
+module Freesound
+  class ResourceNotFound < RuntimeError; end
+
+  class Client
+    def sound(id)
+      begin
+        Resources::Sound.find(id, params: query_params)
+      rescue ActiveResource::BadRequest
+        raise ResourceNotFound, "Sound with id #{id} not found"
+      end
+    end
+
+    def user(username)
+      begin
+        Resources::User.find(username, params: query_params)
+      rescue ActiveResource::BadRequest
+        raise ResourceNotFound, "User with username '#{username}' not found"
+      end
+    end
+
+    def pack(id)
+      begin
+        Resources::Pack.find(id, params: query_params)
+      rescue ActiveResource::BadRequest
+        raise ResourceNotFound, "Pack with id #{id} not found"
+      end
+    end
+
+    def search(query)
+      Resources::Sound.get(:search, query_params(q: query))
+    end
+
+    private
+
+    def query_params(additional={})
+      {api_key: Freesound.api_key}.merge(additional)
+    end
+  end
+end

data/lib/freesound/collections.rb

@@ -0,0 +1,26 @@
+require "active_resource"
+
+module Freesound
+  module Collections
+    # Collections are required to tell ActiveResource how to parse JSON
+    # responses that wrap a collection of resources.
+    #
+    # The #__collection_key method determines the JSON key containing the
+    # resource data.
+    #
+    class Base < ActiveResource::Collection
+      def initialize(parsed={})
+        @elements = parsed.fetch(__collection_key)
+      end
+
+      private
+
+      def __collection_key
+        self.class.name.demodulize.underscore
+      end
+    end
+
+    class Sounds < Base; end
+    class Packs  < Base; end
+  end
+end

data/lib/freesound/resources.rb

@@ -0,0 +1,94 @@
+require "active_resource"
+require "uri"
+
+require "freesound/collections"
+
+module Freesound
+  module Resources
+    class Base < ActiveResource::Base
+      self.site = "http://www.freesound.org/api"
+      self.include_format_in_path = false
+
+      class << self
+        # The Freesound API requires URLs to have a trailing slash before their
+        # query parameters, otherwise the request will result in a redirect.
+        #
+        # These are hacks to construct the URLs correctly because ActiveResource
+        # does not append a trailing slash.
+        #
+        def element_path(id, *args)
+          super("#{id}/", *args)
+        end
+
+        def get(path, *args)
+          super("#{path}/", *args)
+        end
+
+        # Macro for establishing relationships.
+        #
+        # Resources return has_many relationships as a URL, rather than a
+        # collection of objects. For example user JSON would look like:
+        #
+        #   {
+        #     username: "alexgenco",
+        #     sounds: "http://www.freesound.org/api/people/alexgenco/sounds/"
+        #   }
+        #
+        # This macro generates methods to access these child resources by
+        # following the URL and instantiating the appropriate resource.
+        #
+        # To setup a User that has many sounds:
+        #
+        #   class User
+        #     references :sounds
+        #   end
+        #
+        def references(collection_name)
+          resource_class = collection_name.to_s.singularize.camelize
+
+          class_eval(<<-RUBY, __FILE__, __LINE__)
+            def #{collection_name}(refresh=false)
+              @#{collection_name} = nil if refresh
+
+              @#{collection_name} ||= begin
+                path = URI.parse(super).path
+                #{resource_class}.find(:all, from: path, params: query_params)
+              end
+            end
+          RUBY
+        end
+      end
+
+      private
+
+      def query_params(additional={})
+        {api_key: Freesound.api_key}.merge(additional)
+      end
+    end
+
+    class User < Base
+      self.collection_name = "people"
+
+      references :sounds
+      references :packs
+
+      # User resources are identified by their username, for example:
+      #
+      #   /api/people/alexgenco
+      #
+      def id
+        username
+      end
+    end
+
+    class Sound < Base
+      self.collection_parser = "Freesound::Collections::Sounds"
+    end
+
+    class Pack < Base
+      self.collection_parser = "Freesound::Collections::Packs"
+
+      references :sounds
+    end
+  end
+end

data/lib/freesound/version.rb

@@ -0,0 +1,3 @@
+module Freesound
+  VERSION = "0.1.0"
+end

data/spec/helper.rb

@@ -0,0 +1,2 @@
+$:.unshift File.expand_path("../lib", __FILE__)
+require "rspec/autorun"

data/spec/integration/find_pack_spec.rb

@@ -0,0 +1,28 @@
+require "integration/helper"
+
+describe "finding a pack" do
+  let(:client) { Freesound::Client.new }
+
+  context "that exists" do
+    let(:pack) do
+      VCR.use_cassette(:pack_5107) do
+        client.pack(5107)
+      end
+    end
+
+    it "returns an object with pack attributes" do
+      expect(pack.ref).to match(/packs/)
+    end
+  end
+
+  context "that doesn't exist" do
+    it "raises an exception" do
+      expect {
+        VCR.use_cassette(:pack_unknown) do
+          client.pack(123456789)
+        end
+      }.to raise_error(Freesound::ResourceNotFound,
+                       /pack with id 123456789/i)
+    end
+  end
+end

data/spec/integration/find_sound_spec.rb

@@ -0,0 +1,34 @@
+require "integration/helper"
+
+describe "finding a sound" do
+  let(:client) { Freesound::Client.new }
+
+  context "that exists" do
+    let(:sound) do
+      VCR.use_cassette(:sound_18763) do
+        client.sound(18763)
+      end
+    end
+
+    it "returns an object with sound attributes" do
+      expect(sound.id).to be(18763)
+      expect(sound.ref).to match(/\/sounds\/18763/)
+      expect(sound.tags).to respond_to(:to_ary)
+    end
+
+    it "belongs to a user" do
+      expect(sound.user.username).to be_present
+    end
+  end
+
+  context "that doesn't exist" do
+    it "raises an exception" do
+      expect {
+        VCR.use_cassette(:sound_unknown) do
+          client.sound(123456789)
+        end
+      }.to raise_error(Freesound::ResourceNotFound,
+                       /sound with id 123456789/i)
+    end
+  end
+end

data/spec/integration/find_user_spec.rb

@@ -0,0 +1,29 @@
+require "integration/helper"
+
+describe "finding a user" do
+  let(:client) { Freesound::Client.new }
+
+  context "that exists" do
+    let(:user) do
+      VCR.use_cassette(:user_alexgenco) do
+        client.user("AlexGenco")
+      end
+    end
+
+    it "returns an object with user attributes" do
+      expect(user.username).to eq("alexgenco")
+      expect(user.ref).to match(/\/people\/alexgenco/)
+    end
+  end
+
+  context "that doesn't exist" do
+    it "raises an exception" do
+      expect {
+        VCR.use_cassette(:user_unknown) do
+          client.user("LOLWHOAMI__123")
+        end
+      }.to raise_error(Freesound::ResourceNotFound,
+                       /user with username 'LOLWHOAMI__123'/i)
+    end
+  end
+end

data/spec/integration/helper.rb

@@ -0,0 +1,14 @@
+require "helper"
+require "freesound"
+require "vcr"
+
+RSpec.configure do |config|
+  config.before { Freesound.api_key = ENV.fetch("FREESOUND_KEY") }
+end
+
+VCR.configure do |config|
+  config.cassette_library_dir = "spec/fixtures/vcr_cassettes"
+  config.hook_into :webmock
+
+  config.filter_sensitive_data("<FREESOUND_KEY>") { ENV.fetch("FREESOUND_KEY") }
+end

data/spec/integration/pack_resources_spec.rb

@@ -0,0 +1,18 @@
+require "integration/helper"
+
+describe "a pack with resources" do
+  let(:client) { Freesound::Client.new }
+
+  let(:pack) do
+    VCR.use_cassette(:pack_5107) do
+      client.pack(5107)
+    end
+  end
+
+  it "has many sounds" do
+    VCR.use_cassette(:pack_5107_sounds) do
+      expect(pack.sounds).to respond_to(:to_ary)
+      expect(pack.sounds.first).to respond_to(:duration)
+    end
+  end
+end

data/spec/integration/search_sound_spec.rb

@@ -0,0 +1,12 @@
+require "integration/helper"
+
+describe "searching for a sound" do
+  let(:client) { Freesound::Client.new }
+
+  it "returns a list of sounds that match the query" do
+    sounds = VCR.use_cassette(:search_csharp) do
+      client.search("csharp")
+    end
+    expect(sounds.size).to be > 0
+  end
+end

data/spec/integration/user_resources_spec.rb

@@ -0,0 +1,25 @@
+require "integration/helper"
+
+describe "a user with resources" do
+  let(:client) { Freesound::Client.new }
+
+  let(:user) do
+    VCR.use_cassette(:user_jovica) do
+      client.user("Jovica")
+    end
+  end
+
+  it "has many sounds" do
+    VCR.use_cassette(:jovica_sounds) do
+      expect(user.sounds).to respond_to(:to_ary)
+      expect(user.sounds.first).to respond_to(:duration)
+    end
+  end
+
+  it "has many packs" do
+    VCR.use_cassette(:jovica_packs) do
+      expect(user.packs).to respond_to(:to_ary)
+      expect(user.packs.first.ref).to match(/packs/)
+    end
+  end
+end

metadata

@@ -0,0 +1,158 @@
+--- !ruby/object:Gem::Specification
+name: freesound_ruby
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Alex Genco
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activeresource
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+description: 
+email:
+- alexgenco@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .document
+- .gitignore
+- .travis.yml
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- freesound_ruby.gemspec
+- lib/freesound.rb
+- lib/freesound/client.rb
+- lib/freesound/collections.rb
+- lib/freesound/resources.rb
+- lib/freesound/version.rb
+- spec/helper.rb
+- spec/integration/find_pack_spec.rb
+- spec/integration/find_sound_spec.rb
+- spec/integration/find_user_spec.rb
+- spec/integration/helper.rb
+- spec/integration/pack_resources_spec.rb
+- spec/integration/search_sound_spec.rb
+- spec/integration/user_resources_spec.rb
+homepage: https://github.com/alexgenco/freesound_ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: A Ruby library for consuming the Freesound.org API
+test_files:
+- spec/helper.rb
+- spec/integration/find_pack_spec.rb
+- spec/integration/find_sound_spec.rb
+- spec/integration/find_user_spec.rb
+- spec/integration/helper.rb
+- spec/integration/pack_resources_spec.rb
+- spec/integration/search_sound_spec.rb
+- spec/integration/user_resources_spec.rb