ronnie 0.7.6

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.DS_Store
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+ex.rb
+
+.env

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--order random

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 1.9.3

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Allen Goodman
+
+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,163 @@
+# ronnie [![Build Status](https://secure.travis-ci.org/2a6U37Nn/ronnie.png)](http://travis-ci.org/2a6U37Nn/ronnie) [![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/2a6U37Nn/ronnie)
+
+Library for accessing the Rdio API from Ruby. Chirp, chirp!
+
+## Installation
+
+    gem 'ronnie', '~> 7.6.0'
+
+## Usage
+
+    require 'ronnie'
+
+### OAuth
+
+**Note**—the following constants are examples. You’ll need to [register your application](http://developer.rdio.com) with Rdio to retrieve a unique `CONSUMER_KEY` and `CONSUMER_SECRET`. If you’d like to request authorized resources, you’ll need to create a `OAUTH_TOKEN` and `OAUTH_TOKEN_SECRET`.
+
+#### Authentication
+
+    CONSUMER_KEY    = 'q32tvp74n5hazpbr93tbjkem'
+    CONSUMER_SECRET = 'nXcryfbVDP'
+    
+    client = Ronnie::Client.new consumer_key:    CONSUMER_KEY,
+                             consumer_secret: CONSUMER_SECRET
+
+#### Authorization
+
+    OAUTH_TOKEN        = 'zd565qbzvwadxtd4fr3bpcda3ym42shwcxsbyu4t49gv6xxjhp7tjvre4xwr8gue'
+    OAUTH_TOKEN_SECRET = 'baA2KgCSAW3D'
+
+    client.token        = OAUTH_TOKEN
+    client.token_secret = OAUTH_TOKEN_SECRET
+
+## API
+
+### Albums
+
+#### Retrieve Album
+
+    client.album('a610550')
+
+#### Find Albums by Artist
+
+    client.find_albums_by_artist('r235282')
+
+#### Find Albums by Label
+
+    client.find_albums_by_label('')
+
+#### Find Albums by UPC
+
+    client.find_albums_by_upc('652637001228')
+
+#### Search Albums
+
+    client.search_albums('Clear Moon')
+
+### Artists
+
+#### Find Artists by Label
+
+    client.find_artists_by_label('l2270')
+
+#### Search Artists
+
+    client.search_artists('Mount Eerie')
+
+### Playlists
+
+#### Retrieve Playlists by User
+
+    client.playlists('s112675')
+
+#### Retrieve Playlists by Authorized User
+
+    client.playlists
+
+#### Search Playlists
+
+    client.search_playlists('AirR&B&B')
+
+#### Retrieve Playlist
+
+    client.playlist('p87188')
+
+#### Create a Playlist
+
+    client.create_playlist(
+      'Your Ecclesiastical Adolescence',
+      'Music performed by Winona Ryder as Lelaina Pierce.',
+      ['t20680151', 't20680150']
+    )
+
+##### Required Arguments 
+
+* **Name** (String): playlist name.
+* **Description** (String): playlist description.
+* **Tracks** (Array): playlist contents.
+
+#### Delete a Playlist
+
+    client.delete_playlist('p87188')
+
+### Tracks
+
+#### Find Tracks by Artist
+
+    client.find_tracks_by_artist('r235282')
+
+#### Find Tracks by ISRC
+
+    client.find_tracks_by_isrc('GBAYE0200771')
+
+#### Search Tracks
+
+    client.search_tracks('Through The Trees pt. 2')
+
+### Users
+
+#### Retrieve User
+
+    client.user('s112675')
+
+#### Retrieve Authorized User
+
+    client.user
+
+#### Find User by E-mail Address
+
+    client.find_user('allen.goodman@me.com')
+
+#### Search Users
+
+    client.search_users('Allen Goodman')
+
+#### Retrieve Followers of a User
+
+    client.followers('s112675')
+
+#### Retrieve Followers of Authorized User
+
+    client.followers
+
+#### Retrieve Users Following Another User
+
+    client.following('s112675')
+
+#### Retrieve Users Following Authorized User
+
+    client.following
+
+#### Follow a User
+
+    client.follow('s112675')
+
+#### Unfollow a User
+
+    client.unfollow('s112675')
+
+## Tests
+
+    $ bundle install
+
+    $ bundle exec foreman run rspec

data/Rakefile

@@ -0,0 +1,23 @@
+require 'bundler'
+require 'bundler/gem_tasks'
+
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task test: :spec
+task default: :spec
+
+namespace :doc do
+  require 'yard'
+  
+  YARD::Rake::YardocTask.new do |task|
+    task.files   = ['README.md', 'LICENSE', 'lib/**/*.rb']
+    task.options = [
+      '--output-dir', 'doc/yard',
+      '--markup', 'markdown',
+    ]
+  end
+end

data/lib/faraday/response/raise_dio_error.rb

@@ -0,0 +1,46 @@
+require 'faraday'
+require 'multi_json'
+
+# @api private
+module Faraday
+  class Response::RaiseDioError < Response::Middleware
+    def on_complete(response)
+      case response[:status].to_i
+      when 400
+        raise Ronnie::BadRequest, error_message(response)
+      when 401
+        raise Ronnie::Unauthorized, error_message(response)
+      when 403
+        raise Ronnie::Forbidden, error_message(response)
+      when 404
+        raise Ronnie::NotFound, error_message(response)
+      when 406
+        raise Ronnie::NotAcceptable, error_message(response)
+      when 422
+        raise Ronnie::UnprocessableEntity, error_message(response)
+      when 500
+        raise Ronnie::InternalServerError, error_message(response)
+      when 501
+        raise Ronnie::NotImplemented, error_message(response)
+      when 502
+        raise Ronnie::BadGateway, error_message(response)
+      when 503
+        raise Ronnie::ServiceUnavailable, error_message(response)
+      end
+    end
+
+    def error_message(response)
+      message = if (body = response[:body]) && !body.empty?
+        if body.is_a?(String)
+          body = MultiJson.load(body, :symbolize_keys => true)
+        end
+        
+        ": #{body[:error] || body[:message] || ''}"
+      else
+        ''
+      end
+      
+      "#{response[:method].to_s.upcase} #{response[:url].to_s}: #{response[:status]}#{message}"
+    end
+  end
+end

data/lib/ronnie/authentication.rb

@@ -0,0 +1,33 @@
+module Ronnie
+  module Authentication
+    def authenticate
+      credentials = {}
+
+      if consumer_key && consumer_secret
+        credentials[:consumer_key]    = consumer_key
+        credentials[:consumer_secret] = consumer_secret
+      end
+      
+      credentials
+    end
+
+    def authorize
+      credentials = {}
+
+      if token && token_secret
+        credentials[:token]        = token
+        credentials[:token_secret] = token_secret
+      end
+
+      authenticate.merge! credentials
+    end
+
+    def authenticated?
+      !authenticate.empty?
+    end
+
+    def authorized?
+      !token.nil?
+    end
+  end
+end

data/lib/ronnie/client/albums.rb

@@ -0,0 +1,50 @@
+module Ronnie
+  class Client
+    module Albums
+      # Retrieve Album
+      #
+      # @param album_id [String]
+      # @example
+      #   Ronnie.album('a610550')
+      def album(album_id, options={})
+        post('get', { keys: album_id })
+      end
+
+      # Find Albums by Artist
+      #
+      # @param artist_id [String]
+      # @example
+      #   Ronnie.find_albums_by_artist('r235282')
+      def find_albums_by_artist(artist_id, options={})
+        post('getAlbumsForArtist', { artist: artist_id })
+      end
+
+      # Find Albums by Label
+      #
+      # @param label_id [String]
+      # @example
+      #   Ronnie.find_albums_by_upc('r235282')
+      def find_albums_by_label(label_id, options={})
+        post('getAlbumsForLabel', { label: label_id })
+      end
+
+      # Find Albums by UPC
+      #
+      # @param upc [String]
+      # @example
+      #   Ronnie.find_albums_by_upc('r235282')
+      def find_albums_by_upc(upc, options={})
+        post('getAlbumsByUPC', { upc: upc })
+      end
+
+      # Search Albums
+      #
+      # @param query [String]
+      # @example
+      #   Ronnie.search_albums('Clear Moon')
+      def search_albums(query, options={})
+        post('search', { query: query, types: 'Album' })
+      end 
+    end
+  end
+end

data/lib/ronnie/client/artists.rb

@@ -0,0 +1,23 @@
+module Ronnie
+  class Client
+    module Artists
+      # Find Artists by Label
+      #
+      # @param label_id [String]
+      # @example
+      #   Ronnie.find_artists_by_label('l2270')
+      def find_artists_by_label(label_id, options={})
+        post('getArtistsForLabel', { label: label_id })
+      end
+
+      # Search Artists
+      #
+      # @param query [String]
+      # @example
+      #   Ronnie.search_artists('Mount Eerie')
+      def search_artists(query, options={})
+        post('search', { query: query, types: 'Artist' })
+      end     
+    end
+  end
+end

data/lib/ronnie/client/collections/albums.rb

@@ -0,0 +1,9 @@
+module Ronnie
+  class Client
+    module Collections
+      module Albums
+
+      end
+    end
+  end
+end

data/lib/ronnie/client/collections/artists.rb

@@ -0,0 +1,9 @@
+module Ronnie
+  class Client
+    module Collections
+      module Artists
+
+      end
+    end
+  end
+end

data/lib/ronnie/client/collections.rb

@@ -0,0 +1,85 @@
+module Ronnie
+  class Client
+    module Collections
+      # Add Playlists to Collection
+      #
+      # @param playlists [Array]
+      # @see http://developer.rdio.com/docs/read/rest/Methods#addToCollection
+      # @example
+      #   Ronnie.add_playlists_to_collection(['p1429320'])
+      def add_playlists_to_collection(playlists, options={})
+        post('addToCollection', { keys: playlists.join(', ') })
+      end
+
+      # Add Tracks to Collection
+      #
+      # @param tracks [Array]
+      # @see http://developer.rdio.com/docs/read/rest/Methods#addToCollection
+      # @example
+      #   Ronnie.add_tracks_to_collection(['t15940486'])
+      def add_tracks_to_collection(tracks, options={})
+        post('addToCollection', { keys: tracks.join(', ') })
+      end
+
+      # Remove Playlists from Collection
+      #
+      # @param playlists [Array]
+      # @see http://developer.rdio.com/docs/read/rest/Methods#removeFromCollection
+      # @example
+      #   Ronnie.remove_playlists_from_collection(['p1429320'])
+      def remove_playlists_from_collection(playlists, options={})
+        post('removeFromCollection', { keys: playlists.join(', ') })
+      end
+
+      # Remove Tracks from Collection
+      #
+      # @param tracks [Array]
+      # @see http://developer.rdio.com/docs/read/rest/Methods#removeFromCollection
+      # @example
+      #   Ronnie.remove_tracks_from_collection(['t15940486'])
+      def remove_tracks_from_collection(tracks, options={})
+        post('removeFromCollection', { keys: tracks.join(', ') })
+      end
+
+      # Sync Playlists
+      #
+      # @param playlists [Array]
+      # @see http://developer.rdio.com/docs/read/rest/Methods#setAvailableOffline
+      # @example
+      #   Ronnie.sync_playlists(['p1429320'])
+      def sync_playlists(playlists)
+        post('setAvailableOffline', { keys: playlists.join(', '), offline: true })
+      end
+
+      # Sync Tracks
+      #
+      # @param tracks [Array]
+      # @see http://developer.rdio.com/docs/read/rest/Methods#setAvailableOffline
+      # @example
+      #   Ronnie.sync_tracks(['t15940486'])
+      def sync_tracks(tracks)
+        post('setAvailableOffline', { keys: tracks.join(', '), offline: true })
+      end
+
+      # Unsync Playlists
+      #
+      # @param playlists [Array]
+      # @see http://developer.rdio.com/docs/read/rest/Methods#setAvailableOffline
+      # @example
+      #   Ronnie.unsync_playlists(['p1429320'])
+      def unsync_playlists(playlists)
+        post('setAvailableOffline', { keys: playlists.join(', '), offline: false })
+      end
+
+      # Unsync Tracks
+      #
+      # @param tracks [Array]
+      # @see http://developer.rdio.com/docs/read/rest/Methods#setAvailableOffline
+      # @example
+      #   Ronnie.unsync_tracks(['t15940486'])
+      def unsync_tracks(tracks)
+        post('setAvailableOffline', { keys: tracks.join(', '), offline: false })
+      end
+    end
+  end
+end

data/lib/ronnie/client/playlists.rb

@@ -0,0 +1,159 @@
+module Ronnie
+  class Client
+    module Playlists
+      # Retrieve Playlists
+      #
+      # @param playlist_id [String]
+      # @see http://developer.rdio.com/docs/read/rest/Methods#getPlaylists
+      # @example
+      #   Ronnie.playlists('s112675')
+      # @example
+      #   @client.playlist
+      def playlists(user_id=nil, options={})
+        if user_id
+          post('getPlaylists', { user: user_id })
+        else
+          post('getPlaylists')
+        end
+      end
+
+      # Search Playlists
+      #
+      # @param query [String]
+      # @example
+      #   Ronnie.search_playlists('Allen Goodman')
+      def search_playlists(query, options={})
+        post('search', { query: query, types: 'Playlist' })
+      end 
+
+      # Retrieve Playlist
+      #
+      # @param playlist_id [String]
+      # @see http://developer.rdio.com/docs/read/rest/Methods#get
+      # @example
+      #   Ronnie.playlist('p87188')
+      def playlist(playlist_id, options={})
+        post('get', { keys: playlist_id })
+      end
+
+      # Update Playlist
+      #
+      # @param playlist_id [String]
+      # @param name [String]
+      # @param description [String]
+      # @see http://developer.rdio.com/docs/read/rest/Methods#setPlaylistFields
+      # @example
+      #   Ronnie.update_playlist('p87188', 'updated name', 'updated description')
+      def update_playlist(playlist_id, name, description, options={})
+        required_options = {
+          playlist: playlist_id,
+          name: name,
+          description: description,
+        }
+
+        post('setPlaylistFields', required_options.merge!(options))
+      end
+
+      # Add Tracks to Playlist
+      #
+      # @param tracks [Array]
+      # @param playlist_id [String]
+      # @see http://developer.rdio.com/docs/read/rest/Methods#addToPlaylist
+      # @example
+      #   Ronnie.add_tracks_to_playlist(['t15940486'], 'p1429320')
+      def add_tracks_to_playlist(tracks, playlist_id, options={})
+        post('addToPlaylist', {
+          tracks:   tracks.join(', '),
+          playlist: playlist_id
+        })
+      end
+
+      # Remove Tracks from Playlist
+      #
+      # @param tracks [Array]
+      # @param index [Integer]
+      # @param count [Integer]
+      # @param playlist_id [String]
+      # @see http://developer.rdio.com/docs/read/rest/Methods#removeFromPlaylist
+      # @example
+      #   Ronnie.remove_tracks_from_playlist(['t15940486'], 'p1429320')
+      def remove_tracks_from_playlist(tracks, index, count, playlist_id, options={})
+        post('removeFromPlaylist', {
+          index: index,
+          count: count,
+          tracks: tracks.join(', '),
+          playlist: playlist_id
+        })
+      end
+
+      # Enable Public Collaboration
+      #
+      # @param playlist_id [String]
+      # @see http://developer.rdio.com/docs/read/rest/Methods#setPlaylistCollaborationMode
+      # @example
+      #   Ronnie.enable_public_collaboration('p1429320')
+      def enable_public_collaboration(playlist_id)
+        post('setPlaylistCollaborationMode', { playlist: playlist_id, mode: 1 })
+      end
+
+      # Enable Restricted Collaboration
+      #
+      # @param playlist_id [String]
+      # @see http://developer.rdio.com/docs/read/rest/Methods#setPlaylistCollaborationMode
+      # @example
+      #   Ronnie.enable_restricted_collaboration('p1429320')
+      def enable_restricted_collaboration(playlist_id)
+        post('setPlaylistCollaborationMode', { playlist: playlist_id, mode: 2 })
+      end
+
+      # Disable Collaboration
+      #
+      # @param playlist_id [String]
+      # @see http://developer.rdio.com/docs/read/rest/Methods#setPlaylistCollaborationMode
+      # @example
+      #   Ronnie.disable_collaboration('p1429320')
+      def disable_collaboration(playlist_id)
+        post('setPlaylistCollaborationMode', { playlist: playlist_id, mode: 0 })
+      end
+
+      # Create a Playlist
+      #
+      # Requires authorized client.
+      #
+      # @param name [String] playlist name.
+      # @param description [String] playlist description.
+      # @param tracks [Array] playlist contents.
+      # @return [Hashie::Mash]
+      # @see Ronnie::Client
+      # @see http://developer.rdio.com/docs/read/rest/Methods#createPlaylist
+      # @example
+      #   Ronnie.create_playlist(
+      #     'Your Ecclesiastical Adolescence',
+      #     'Music performed by Winona Ryder as Lelaina Pierce.',
+      #     't20680151'
+      #   )
+      def create_playlist(name, description, tracks, options={})
+        required_options = {
+          name: name,
+          description: description,
+          tracks: tracks.join(', ')
+        }
+
+        post('createPlaylist', required_options.merge!(options))
+      end
+      
+      # Delete a playlist.
+      #
+      # Requires authorized client.
+      #
+      # @param playlist_id [String]
+      # @return [Boolean]
+      # @see http://developer.rdio.com/docs/read/rest/Methods#deletePlaylist
+      # @example
+      #   Ronnie.delete_playlist('p87188')
+      def delete_playlist(playlist_id, options={})
+        post('deletePlaylist', { playlist: playlist_id })
+      end
+    end
+  end
+end

data/lib/ronnie/client/tracks.rb

@@ -0,0 +1,32 @@
+module Ronnie
+  class Client
+    module Tracks
+      # Find Tracks by Artist
+      #
+      # @param artist_id [String]
+      # @example
+      #   Ronnie.find_tracks_by_artist('r235282')
+      def find_tracks_by_artist(artist_id, options={})
+        post('getTracksForArtist', { artist: artist_id })
+      end
+
+      # Find Tracks by ISRC
+      #
+      # @param isrc [String]
+      # @example
+      #   Ronnie.find_tracks_by_isrc('GBAYE0200771')
+      def find_tracks_by_isrc(isrc, options={})
+        post('getTracksByISRC', { isrc: isrc })
+      end
+
+      # Search Tracks
+      #
+      # @param query [String]
+      # @example
+      #   Ronnie.search_tracks('Through The Trees pt. 2')
+      def search_tracks(query, options={})
+        post('search', { query: query, types: 'Track' })
+      end
+    end
+  end
+end