musix_match 0.1.2 → 0.1.3

data/README.rdoc

@@ -4,7 +4,7 @@
     | |       _                                                            _       | |
     | |      | |                                                          | |      | |
     | | _  _ | |                                                          | | _  _ | |
-    | || || || |    MusixMatch is wrapper for the musixmatch.com API's.   | || || || |
+    | || || || |    MusixMatch is a wrapper for the musixmatch.com API's. | || || || |
     | || || || |  With this library you can search for lyrics and tracks  | || || || |
     | |  || || |        using the http://musixmatch.com service.          | |  || || |
     |          |                                                          |          |

data/lib/musix_match.rb

@@ -19,7 +19,8 @@ musix_match_path = File.dirname(__FILE__)
 'lyrics_find_result',
 'track_find_result',
 'api/finder',
-'models/track'].each do |lib|
+'models/track',
+'instant_lyrics'].each do |lib|
   require musix_match_path + '/musix_match/' + lib
 end
 
@@ -39,4 +40,9 @@ module MusixMatch
   def self.search_track(*args)
     Models::Track.search(*args)
   end
+  
+  def self.i_m_feeling_lucky(q)
+    result = MusixMatch::InstantLyrics::Search.search(q)
+    result.found? ? result.lyrics.lyrics_body : 'Lyrics not found'
+  end
 end

data/lib/musix_match/api/base.rb

@@ -1,5 +1,6 @@
 module MusixMatch
   module API
+    class AuthenticationFailedException < Exception; end
     class APIKeyNotSpecifiedException < Exception; end
     
     class Base
@@ -24,12 +25,14 @@ module MusixMatch
       def self.get(method, params={})
         raise APIKeyNotSpecifiedException.new('You must specify the API key. MusixMatch::API::Base.api_key = "YOUR_API_KEY"') if api_key.nil?
         response = HTTParty.get(url_for(method, params))
-        case response.parsed_response
+        parsed_response = case response.parsed_response
         when Hash
           response.parsed_response
         when String
           JSON.parse(response.parsed_response)
         end
+        raise AuthenticationFailedException.new('Authentication failed, probably because of a bad API key') if parsed_response['message']['header']['status_code'] == 401
+        parsed_response
       end
     
       def api_key    

data/lib/musix_match/instant_lyrics.rb

@@ -0,0 +1,45 @@
+module MusixMatch
+  module InstantLyrics
+    class Result
+      attr_reader :lyrics
+
+      def initialize(lyrics)
+        @lyrics = lyrics
+      end
+
+      def found?
+        @lyrics.is_a?(MusixMatch::Models::Lyrics)      
+      end
+    end
+
+    class Search
+      def initialize(q)
+        @q = q
+      end
+
+      def start
+        lyrics_id = search_lyrics
+        lyrics    = find_lyrics(lyrics_id) if lyrics_id
+        Result.new(lyrics)
+      end
+
+      def search_lyrics
+        result = MusixMatch.search_lyrics(:q => @q)
+        if result.status_code == 200 && lyrics = result.lyrics_list.first      
+          lyrics.lyrics_id
+        end
+      end
+
+      def find_lyrics(lyrics_id)
+        result = MusixMatch.get_lyrics(lyrics_id)
+        if result.status_code == 200 && lyrics = result.lyrics
+          lyrics
+        end
+      end
+
+      def self.search(q)
+        s = Search.new(q).start
+      end
+    end
+  end
+end

data/spec/api_base_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+
+describe 'API::Base' do
+  it "should always use JSON as format" do    
+    expected_url = MusixMatch::API::Base::API_URL + '/lyrics.get?apikey=&format=json'
+    MusixMatch::API::Base.url_for('lyrics.get', :format => 'xml').should == expected_url
+  end
+  
+  it "should use JSON as format even if the format key is a string" do    
+    expected_url = MusixMatch::API::Base::API_URL + '/lyrics.get?apikey=&format=json'
+    MusixMatch::API::Base.url_for('lyrics.get', 'format' => 'xml').should == expected_url
+  end
+  
+  it "should raise an exception if api_key is not set" do
+    lambda do
+      MusixMatch::API::Base.get('http://localhost')
+    end.should raise_error(MusixMatch::API::APIKeyNotSpecifiedException)
+  end
+  
+  it "should call get on HTTParty" do
+    MusixMatch::API::Base.api_key = 'API_KEY'
+    method = 'lyrics.search'
+    params = {:q_artist => 'artist name'}    
+    url = MusixMatch::API::Base.url_for(method, params)
+    response = mock(HTTParty::Response)
+    parsed_response = {'message' => {'header' => {'status_code' => 200}}}
+    response.should_receive(:parsed_response).twice.and_return(parsed_response)
+    HTTParty.should_receive(:get).with(url).and_return(response)
+    result = MusixMatch::API::Base.get(method, params)
+    result.should == parsed_response
+  end
+  
+  it "should raise an error" do
+    lambda do
+      MusixMatch::API::Base.api_key = 'API_KEY'
+      method = 'lyrics.search'
+      params = {:q_artist => 'artist name'}    
+      url = MusixMatch::API::Base.url_for(method, params)
+      response = mock(HTTParty::Response)
+      parsed_response = {'message' => {'header' => {'status_code' => 401}}}
+      response.should_receive(:parsed_response).twice.and_return(parsed_response)
+      HTTParty.should_receive(:get).with(url).and_return(response)
+      result = MusixMatch::API::Base.get(method, params)
+      result.should == parsed_response
+    end.should raise_error(MusixMatch::API::AuthenticationFailedException)
+  end  
+end

data/spec/musix_match_spec.rb

@@ -24,4 +24,15 @@ describe 'MusixMatch' do
     MusixMatch::Models::Track.should_receive(:search).with(params)
     MusixMatch.search_track(params)
   end
+  
+  it "should call search on InstantLyrics::Search" do
+    q = 'artist name track name'
+    result = mock(MusixMatch::InstantLyrics::Result)
+    lyrics = mock(MusixMatch::Models::Lyrics)
+    lyrics.should_receive(:lyrics_body).and_return('lyrics body')
+    result.should_receive(:found?).and_return(true)
+    result.should_receive(:lyrics).and_return(lyrics)
+    MusixMatch::InstantLyrics::Search.should_receive(:search).with(q).and_return(result)
+    MusixMatch.i_m_feeling_lucky(q)
+  end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: musix_match
 version: !ruby/object:Gem::Version 
-  hash: 31
+  hash: 29
   prerelease: false
   segments: 
   - 0
   - 1
-  - 2
-  version: 0.1.2
+  - 3
+  version: 0.1.3
 platform: ruby
 authors: 
 - Andrea Franz
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-09-20 00:00:00 +02:00
+date: 2010-09-26 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -65,6 +65,7 @@ files:
 - lib/musix_match/api/base.rb
 - lib/musix_match/api/finder.rb
 - lib/musix_match/api/search.rb
+- lib/musix_match/instant_lyrics.rb
 - lib/musix_match/lyrics_find_result.rb
 - lib/musix_match/lyrics_search_result.rb
 - lib/musix_match/models/lyrics.rb
@@ -72,7 +73,7 @@ files:
 - lib/musix_match/models/track.rb
 - lib/musix_match/track_find_result.rb
 - lib/musix_match/track_search_result.rb
-- spec/base_model_spec.rb
+- spec/api_base_spec.rb
 - spec/finder_spec.rb
 - spec/lyrics_spec.rb
 - spec/musix_match_spec.rb
@@ -115,7 +116,7 @@ signing_key:
 specification_version: 3
 summary: API wrapper for musixmatch.com API's
 test_files: 
-- spec/base_model_spec.rb
+- spec/api_base_spec.rb
 - spec/finder_spec.rb
 - spec/lyrics_spec.rb
 - spec/musix_match_spec.rb

data/spec/base_model_spec.rb

@@ -1,13 +0,0 @@
-require 'spec_helper'
-
-describe 'Base Model' do
-  it "should always use JSON as format" do    
-    expected_url = MusixMatch::API::Base::API_URL + '/lyrics.get?apikey=&format=json'
-    MusixMatch::API::Base.url_for('lyrics.get', :format => 'xml').should == expected_url
-  end
-  
-  it "should use JSON as format even if the format key is a string" do    
-    expected_url = MusixMatch::API::Base::API_URL + '/lyrics.get?apikey=&format=json'
-    MusixMatch::API::Base.url_for('lyrics.get', 'format' => 'xml').should == expected_url
-  end
-end