musix_match 0.1.8 → 0.1.9

data/lib/musix_match/api/feedback.rb

@@ -0,0 +1,19 @@
+module MusixMatch  
+  module API
+    class Feedback < Base
+      class InvalidFeedbackTypeException < Exception; end
+      
+      VALID_TYPES = %w(wrong_attribution bad_characters lines_too_long wrong_verses wrong_formatting)
+      
+      def post_feedback(track_id, lyrics_id, feedback)
+        raise InvalidFeedbackTypeException.new("Invalid feedback type. Try one of the following: #{VALID_TYPES.join(", ")}") unless VALID_TYPES.include?(feedback.to_s)
+        response = get('track.lyrics.feedback.post', {:track_id => track_id, :lyrics_id => lyrics_id, :feedback => feedback})
+        FeedbackResult.new(response)
+      end
+      
+      def self.post_feedback(track_id, lyrics_id, feedback)
+        Feedback.new.post_feedback(track_id, lyrics_id, feedback)
+      end
+    end
+  end
+end

data/lib/musix_match/feedback_result.rb

@@ -0,0 +1,21 @@
+module MusixMatch
+  class FeedbackResult
+    attr_reader :status_code, :execute_time
+    
+    def initialize(response)
+      parse_response(response)
+    end      
+  
+  protected
+    
+    def parse_response(response)
+      parse_response_header(response)
+    end
+
+    def parse_response_header(response)
+      [:status_code, :execute_time].each do |key|
+        instance_variable_set "@#{key}", response['message']['header'][key.to_s]
+      end
+    end  
+  end
+end

data/lib/musix_match.rb

@@ -18,8 +18,10 @@ musix_match_path = File.dirname(__FILE__)
 'api/search',
 'lyrics_find_result',
 'track_find_result',
+'feedback_result',
 'api/finder',
 'api/track_chart',
+'api/feedback',
 'models/track',
 'instant_lyrics'].each do |lib|
   require musix_match_path + '/musix_match/' + lib
@@ -49,5 +51,9 @@ module MusixMatch
   def self.i_m_feeling_lucky(q)
     result = MusixMatch::InstantLyrics::Search.search(q)
     result.found? ? result.lyrics.lyrics_body : 'Lyrics not found'
-  end    
+  end
+  
+  def self.post_feedback(*args)
+    API::Feedback.post_feedback(*args)
+  end
 end

data/spec/api/base_spec.rb

@@ -2,12 +2,12 @@ require 'spec_helper'
 
 describe MusixMatch::API::Base do
   it "should always use JSON as format" do    
-    expected_url = MusixMatch::API::Base::API_URL + '/lyrics.get?apikey=&format=json'
+    expected_url = MusixMatch::API::Base::API_URL + '/lyrics.get?format=json&apikey='
     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'
+    expected_url = MusixMatch::API::Base::API_URL + '/lyrics.get?format=json&apikey='
     MusixMatch::API::Base.url_for('lyrics.get', 'format' => 'xml').should == expected_url
   end
   

data/spec/api/feedback_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+
+describe MusixMatch::API::Feedback do
+  it "should raise an exception for bad feedback type" do
+    lambda do
+      MusixMatch::API::Feedback.post_feedback(1, 1, "invalid-feedback-type")
+    end.should raise_error(MusixMatch::API::Feedback::InvalidFeedbackTypeException)
+  end    
+  
+  it "should call get with track.lyrics.feedback.post" do
+    track_id = 1
+    lyrics_id = 1
+    feedback_type = 'wrong_attribution'
+    feedback = MusixMatch::API::Feedback.new
+    feedback.should_receive(:get).with('track.lyrics.feedback.post', {:track_id => track_id, :lyrics_id => lyrics_id, :feedback => feedback_type}).and_return(load_fixture('track.lyrics.feedback.post'))
+    feedback.post_feedback(track_id, lyrics_id, feedback_type)
+  end
+  
+  it "should initialize a new Feedback object" do
+    track_id = 1
+    lyrics_id = 1
+    feedback_type = 'wrong_attribution'
+    feedback = mock(MusixMatch::API::Feedback)
+    MusixMatch::API::Feedback.should_receive(:new).and_return(feedback)
+    feedback.should_receive(:post_feedback).with(track_id, lyrics_id, feedback_type)
+    MusixMatch::API::Feedback.post_feedback(track_id, lyrics_id, feedback_type)
+  end
+  
+  it "should initialize a FeedbackResult" do
+    track_id = 1
+    lyrics_id = 1
+    feedback_type = 'wrong_attribution'
+    feedback = MusixMatch::API::Feedback.new
+    feedback_response = load_fixture('track.lyrics.feedback.post')
+    feedback.should_receive(:get).with('track.lyrics.feedback.post', {:track_id => track_id, :lyrics_id => lyrics_id, :feedback => feedback_type}).and_return(feedback_response)
+    MusixMatch::FeedbackResult.should_receive(:new).with(feedback_response)
+    feedback.post_feedback(track_id, lyrics_id, feedback_type)
+  end
+end

data/spec/feedback_result_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe MusixMatch::FeedbackResult do
+  it 'should set status_code' do
+    response = load_fixture('track.lyrics.feedback.post')
+    result = MusixMatch::FeedbackResult.new(response)
+    result.status_code.should == 200
+  end
+  
+  it 'should set execute_time' do
+    response = load_fixture('track.lyrics.feedback.post')
+    result = MusixMatch::FeedbackResult.new(response)
+    result.execute_time.should == 0.137812137604
+  end  
+end

data/spec/musix_match_spec.rb

@@ -41,4 +41,12 @@ describe MusixMatch do
     MusixMatch::InstantLyrics::Search.should_receive(:search).with(q).and_return(result)
     MusixMatch.i_m_feeling_lucky(q)
   end
+  
+  it "should call post_feedback on Feedback" do
+    track_id = 1
+    lyrics_id = 1
+    feedback_type = 'wrong_attribution'
+    MusixMatch::API::Feedback.should_receive(:post_feedback).with(track_id, lyrics_id, feedback_type)
+    MusixMatch.post_feedback(track_id, lyrics_id, feedback_type)
+  end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: musix_match
 version: !ruby/object:Gem::Version 
-  hash: 11
+  hash: 9
   prerelease: false
   segments: 
   - 0
   - 1
-  - 8
-  version: 0.1.8
+  - 9
+  version: 0.1.9
 platform: ruby
 authors: 
 - Andrea Franz
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-17 00:00:00 -05:00
+date: 2010-11-27 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -63,9 +63,11 @@ files:
 - Rakefile
 - lib/musix_match.rb
 - lib/musix_match/api/base.rb
+- lib/musix_match/api/feedback.rb
 - lib/musix_match/api/finder.rb
 - lib/musix_match/api/search.rb
 - lib/musix_match/api/track_chart.rb
+- lib/musix_match/feedback_result.rb
 - lib/musix_match/instant_lyrics.rb
 - lib/musix_match/lyrics_find_result.rb
 - lib/musix_match/lyrics_search_result.rb
@@ -76,9 +78,11 @@ files:
 - lib/musix_match/track_find_result.rb
 - lib/musix_match/track_search_result.rb
 - spec/api/base_spec.rb
+- spec/api/feedback_spec.rb
 - spec/api/finder_spec.rb
 - spec/api/search_spec.rb
 - spec/api/track_chart_spec.rb
+- spec/feedback_result_spec.rb
 - spec/lyrics_find_result_spec.rb
 - spec/lyrics_search_result_spec.rb
 - spec/models/lyrics_spec.rb
@@ -124,9 +128,11 @@ specification_version: 3
 summary: API wrapper for musixmatch.com API's
 test_files: 
 - spec/api/base_spec.rb
+- spec/api/feedback_spec.rb
 - spec/api/finder_spec.rb
 - spec/api/search_spec.rb
 - spec/api/track_chart_spec.rb
+- spec/feedback_result_spec.rb
 - spec/lyrics_find_result_spec.rb
 - spec/lyrics_search_result_spec.rb
 - spec/models/lyrics_spec.rb