dance 0.1.0 → 0.1.1

data/.gitignore

@@ -2,3 +2,4 @@
 .bundle
 Gemfile.lock
 pkg/*
+.DS_Store

data/Gemfile

@@ -1,4 +1,3 @@
 source "http://rubygems.org"
 
-# Specify your gem's dependencies in dance.gemspec
 gemspec

data/README.markdown

@@ -2,6 +2,8 @@
 
 Dance is a Gem for communicating with the [Console.fm API](http://console.fm/api).
 
+You'll need an API Key. You can get one [here](http://consolefm.wufoo.com/forms/api-beta/).
+
 ## Usage
 
     dance = Dance::Client.new("KEY")

data/dance.gemspec

@@ -4,7 +4,7 @@ require "dance"
 
 Gem::Specification.new do |s|
   s.name        = "dance"
-  s.version     = "0.1.0"
+  s.version     = "0.1.1"
   s.authors     = ["Ethan Turkeltaub"]
   s.email       = ["ethan.turkeltaub@gmail.com"]
   s.homepage    = "http://github.com/eturk/dance"
@@ -20,6 +20,8 @@ Gem::Specification.new do |s|
   
   s.add_dependency "httparty"
   s.add_development_dependency "rspec"
+  s.add_development_dependency "webmock"
+  s.add_development_dependency "vcr"
   
   # s.add_runtime_dependency "rest-client"
 end

data/lib/dance.rb

@@ -1,9 +1,10 @@
 require 'httparty'
 
 require 'dance/client'
+require 'dance/errors'
 require 'dance/artists'
 require 'dance/genres'
-require 'dance/users'
+require 'dance/user'
 require 'dance/tracks'
 
 module Dance

data/lib/dance/artists.rb

@@ -1,9 +1,17 @@
 module Dance
   class Artists < Client
     
+    # Returns information on the given artist.
+    # GET /artists/:id
     def self.info(id)
       get('/artists/' + id.to_s)
     end
     
+    # Returns a list of tracks by the given artist.
+    # GET /artists/:id/tracks
+    def self.tracks(id)
+    	get('/artists/' + id.to_s + '/tracks')
+    end
+    
   end
 end

data/lib/dance/client.rb

@@ -1,12 +1,11 @@
 module Dance
   class Client
     include HTTParty
-  
-    base_uri 'console.fm/api/v1'
-    default_params :api_key => @key
+    
+    base_uri 'console.fm/api/v2'
     
     def initialize(key)
-      @key = key
+      self.class.default_params :api_key => key
     end
     
     def artists
@@ -24,7 +23,5 @@ module Dance
     def tracks
       Tracks
     end
-    
   end
-  
 end

data/lib/dance/errors.rb

@@ -0,0 +1,34 @@
+module Dance
+  class Error < StandardError
+    attr_reader :http_Headers
+    
+    def initialize(message, http_headers)
+      @http_headers = Hash[http_headers]
+      super(message)
+    end
+  end
+  
+  class VerifyAuthentic < Error
+  end
+  
+  class CheckParams < Error
+  end
+  
+  class NoRecord < Error
+  end
+  
+  class Deprecated < Error
+  end
+  
+  class VersionNotAllowed < Error
+  end
+  
+  class NotAuthorized < Error
+  end
+  
+  class NotAuthenticated < Error
+  end
+  
+  class InvalidRequest < Error
+  end
+end

data/lib/dance/genres.rb

@@ -1,13 +1,29 @@
 module Dance
   class Genres < Client
-  
+    
+    # Returns a list of all of the genres.
+    # GET /genres
     def self.all
       get('/genres')
     end
     
+    # Returns information on the given genre.
+    # GET /genres/:id
     def self.info(id)
       get('/genres/' + id.to_s)
     end
+    
+    # Returns a list of tracks under the given genre.
+    # GET /genres/:id/tracks
+    def self.tracks(id)
+      get('/genres/' + id.to_s + '/tracks')
+    end
+    
+    # Returns a list of artists that have tracks under the given genre.
+    # GET /genres/:id/artists
+    def self.artists(id)
+      get('/genres/' + id.to_s + '/artists')
+    end
   
   end
 end

data/lib/dance/tracks.rb

@@ -1,6 +1,9 @@
 module Dance
   class Tracks < Client
     
+    # Returns information on the given track.
+    # Parameters: id
+    # GET /tracks/:id
     def self.info(id)
       get('/tracks/' + id.to_s)
     end

data/lib/dance/user.rb

@@ -0,0 +1,35 @@
+module Dance
+  class User < Client
+    
+    # Authenticates a user based on a Facebook token and the user's ID.
+    # POST /user/authenticate
+    def self.authenticate(options={})
+      post('/user/authenticate', options)
+    end
+    
+    # Returns information on the authenticated user.
+    # GET /user/current
+    def self.current
+      get('/user/current')
+    end
+    
+    # Returns the Facebook information of the authenticated user.
+    # GET /user/current/facebook
+    def self.facebook
+      get('/user/current/facebook')
+    end
+    
+    # Returns the favorites of the authenticated user.
+    # GET /user/current/favorites
+    def self.favorites
+      get('/user/current/favorites')
+    end
+    
+    # Returns the history of the authenticated user.
+    # GET /user/current/history
+    def self.history
+      get('/user/current/history')
+    end
+    
+  end
+end

data/lib/dance/version.rb

@@ -1,3 +1,3 @@
 module Dance
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/spec/spec_helper.rb

@@ -0,0 +1,48 @@
+$:.unshift File.expand_path('../../lib', __FILE__)
+
+require 'dance'
+require 'rspec'
+require 'webmock/rspec'
+require 'vcr'
+
+endpoint = 'console.fm/api/v2'
+
+def a_delete(path)
+  a_request(:delete, endpoint + path)
+end
+
+def a_get(path)
+  a_request(:get, endpoint + path)
+end
+
+def a_post(path)
+  a_request(:post, endpoint + path)
+end
+
+def a_put(path)
+  a_request(:put, endpoint + path)
+end
+
+def stub_delete(path)
+  stub_request(:delete, endpoint + path)
+end
+
+def stub_get(path)
+  stub_request(:get, endpoint + path)
+end
+
+def stub_post(path)
+  stub_request(:post, endpoint + path)
+end
+
+def stub_put(path)
+  stub_request(:put, endpoint + path)
+end
+
+def fixture_path
+  File.expand_path("../fixtures", __FILE__)
+end
+
+def fixture(file)
+  File.new(fixture_path + '/' + file)
+end

data/spec/support/vcr.rb

@@ -0,0 +1,8 @@
+require 'vcr'
+
+VCR.config do |c|
+  c.cassette_library_dir = 'fixtures/cassettes'
+  c.stub_with :webmock
+  c.ignore_localhost = true
+  c.default_cassette_options = { :record => :none }
+end

metadata

@@ -2,7 +2,7 @@
 name: dance
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors: 
 - Ethan Turkeltaub
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-10-16 00:00:00 Z
+date: 2011-11-08 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: httparty
@@ -34,6 +34,28 @@ dependencies:
         version: "0"
   type: :development
   version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: webmock
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: vcr
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id004
 description: A library for communicating with the Console.fm API.
 email: 
 - ethan.turkeltaub@gmail.com
@@ -52,10 +74,13 @@ files:
 - lib/dance.rb
 - lib/dance/artists.rb
 - lib/dance/client.rb
+- lib/dance/errors.rb
 - lib/dance/genres.rb
 - lib/dance/tracks.rb
-- lib/dance/users.rb
+- lib/dance/user.rb
 - lib/dance/version.rb
+- spec/spec_helper.rb
+- spec/support/vcr.rb
 homepage: http://github.com/eturk/dance
 licenses: []
 

data/lib/dance/users.rb

@@ -1,25 +0,0 @@
-module Dance
-  class Users < Client
-    
-    def self.all
-      get('/users')
-    end
-    
-    def self.current
-      get('/users/current')
-    end
-    
-    def self.favorites
-      get('/users/current/favorites')
-    end
-    
-    def self.facebook
-      get('/users/current/facebook')
-    end
-    
-    def self.twitter
-      get('/users/current/twitter')
-    end
-    
-  end
-end