scrobbler2 0.0.4

data/test/acceptance/user/shouts_test.rb

@@ -0,0 +1,14 @@
+require File.dirname(__FILE__) + '/../test_helper.rb'
+
+describe "shouts for user gingerhendrix" do
+  
+  before(:all) do #We only want to hit the webservice once.
+    @user = Scrobbler2::User.new "gingerhendrix"
+    @shouts = @user.shouts
+  end 
+  
+  it "should be hash" do
+    @shouts.should be_kind_of Hash
+  end
+  
+end

data/test/acceptance/user/top_albums_test.rb

@@ -0,0 +1,14 @@
+require File.dirname(__FILE__) + '/../test_helper.rb'
+
+describe "top_albums for user gingerhendrix" do
+  
+  before(:all) do #We only want to hit the webservice once.
+    @user = Scrobbler2::User.new "gingerhendrix"
+    @top_albums = @user.top_albums
+  end 
+  
+  it "should be hash" do
+    @top_albums.should be_kind_of Hash
+  end
+  
+end

data/test/acceptance/user/top_artists_test.rb

@@ -0,0 +1,14 @@
+require File.dirname(__FILE__) + '/../test_helper.rb'
+
+describe "top_artists for user gingerhendrix" do
+  
+  before(:all) do #We only want to hit the webservice once.
+    @user = Scrobbler2::User.new "gingerhendrix"
+    @top_artists = @user.top_artists
+  end 
+  
+  it "should be hash" do
+    @top_artists.should be_kind_of Hash
+  end
+  
+end

data/test/acceptance/user/top_tags_test.rb

@@ -0,0 +1,14 @@
+require File.dirname(__FILE__) + '/../test_helper.rb'
+
+describe "top_tags for user gingerhendrix" do
+  
+  before(:all) do #We only want to hit the webservice once.
+    @user = Scrobbler2::User.new "gingerhendrix"
+    @top_tags = @user.top_tags
+  end 
+  
+  it "should be hash" do
+    @top_tags.should be_kind_of Hash
+  end
+  
+end

data/test/acceptance/user/top_tracks_test.rb

@@ -0,0 +1,14 @@
+require File.dirname(__FILE__) + '/../test_helper.rb'
+
+describe "top_tracks for user gingerhendrix" do
+  
+  before(:all) do #We only want to hit the webservice once.
+    @user = Scrobbler2::User.new "gingerhendrix"
+    @top_tracks = @user.top_tracks
+  end 
+  
+  it "should be hash" do
+    @top_tracks.should be_kind_of Hash
+  end
+  
+end

data/test/acceptance/user/weekly_album_chart_test.rb

@@ -0,0 +1,14 @@
+require File.dirname(__FILE__) + '/../test_helper.rb'
+
+describe "weekly_album_chart for user gingerhendrix" do
+  
+  before(:all) do #We only want to hit the webservice once.
+    @user = Scrobbler2::User.new "gingerhendrix"
+    @weekly_album_chart = @user.weekly_album_chart
+  end 
+  
+  it "should be hash" do
+    @weekly_album_chart.should be_kind_of Hash
+  end
+  
+end

data/test/acceptance/user/weekly_artist_chart_test.rb

@@ -0,0 +1,14 @@
+require File.dirname(__FILE__) + '/../test_helper.rb'
+
+describe "weekly_artist_chart for user gingerhendrix" do
+  
+  before(:all) do #We only want to hit the webservice once.
+    @user = Scrobbler2::User.new "gingerhendrix"
+    @weekly_artist_chart = @user.weekly_artist_chart
+  end 
+  
+  it "should be hash" do
+    @weekly_artist_chart.should be_kind_of Hash
+  end
+  
+end

data/test/acceptance/user/weekly_chart_list_test.rb

@@ -0,0 +1,14 @@
+require File.dirname(__FILE__) + '/../test_helper.rb'
+
+describe "weekly_chart_list for user gingerhendrix" do
+  
+  before(:all) do #We only want to hit the webservice once.
+    @user = Scrobbler2::User.new "gingerhendrix"
+    @weekly_chart_list = @user.weekly_chart_list
+  end 
+  
+  it "should be hash" do
+    @weekly_chart_list.should be_kind_of Hash
+  end
+  
+end

data/test/acceptance/user/weekly_track_chart_test.rb

@@ -0,0 +1,14 @@
+require File.dirname(__FILE__) + '/../test_helper.rb'
+
+describe "weekly_track_chart for user gingerhendrix" do
+  
+  before(:all) do #We only want to hit the webservice once.
+    @user = Scrobbler2::User.new "gingerhendrix"
+    @weekly_track_chart = @user.weekly_track_chart
+  end 
+  
+  it "should be hash" do
+    @weekly_track_chart.should be_kind_of Hash
+  end
+  
+end

data/test/acceptance/venue/events_test.rb

@@ -0,0 +1,14 @@
+require File.dirname(__FILE__) + '/../test_helper.rb'
+
+describe "events for venue 8929268 (The Menagerie)" do
+  
+  before(:all) do #We only want to hit the webservice once.
+    @venue = Scrobbler2::Venue.new "8929268"
+    @events = @venue.events
+  end 
+  
+  it "should be hash" do
+    @events.should be_kind_of Hash
+  end
+  
+end

data/test/acceptance/venue/past_events_test.rb

@@ -0,0 +1,14 @@
+require File.dirname(__FILE__) + '/../test_helper.rb'
+
+describe "past_events for venue 8929268 (The Menagerie)" do
+  
+  before(:all) do #We only want to hit the webservice once.
+    @venue = Scrobbler2::Venue.new "8929268"
+    @past_events = @venue.past_events
+  end 
+  
+  it "should be hash" do
+    @past_events.should be_kind_of Hash
+  end
+  
+end

data/test/generators/test_acceptance_test_generator.rb

@@ -0,0 +1,46 @@
+require File.join(File.dirname(__FILE__), "test_generator_helper.rb")
+
+
+class TestAcceptanceTestGenerator < Test::Unit::TestCase
+  include RubiGen::GeneratorTestHelper
+
+  def setup
+    bare_setup
+  end
+
+  def teardown
+    bare_teardown
+  end
+
+  # Some generator-related assertions:
+  #   assert_generated_file(name, &block) # block passed the file contents
+  #   assert_directory_exists(name)
+  #   assert_generated_class(name, &block)
+  #   assert_generated_module(name, &block)
+  #   assert_generated_test_for(name, &block)
+  # The assert_generated_(class|module|test_for) &block is passed the body of the class/module within the file
+  #   assert_has_method(body, *methods) # check that the body has a list of methods (methods with parentheses not supported yet)
+  #
+  # Other helper methods are:
+  #   app_root_files - put this in teardown to show files generated by the test method (e.g. p app_root_files)
+  #   bare_setup - place this in setup method to create the APP_ROOT folder for each test
+  #   bare_teardown - place this in teardown method to destroy the TMP_ROOT or APP_ROOT folder after each test
+
+  def test_generator_without_options
+    resource = "resource"
+    method = "method"
+    run_generator('acceptance_test', [resource, method], sources)
+    assert_directory_exists "test/acceptance/#{resource}"
+    assert_generated_file   "test/acceptance/#{resource}/#{method}_test.rb"
+  end
+
+  private
+  def sources
+    [RubiGen::PathSource.new(:test, File.join(File.dirname(__FILE__),"../..", generator_path))
+    ]
+  end
+
+  def generator_path
+    "generators"
+  end
+end

data/test/generators/test_generator_helper.rb

@@ -0,0 +1,29 @@
+begin
+  require File.dirname(__FILE__) + '/test_helper'
+rescue LoadError
+  require 'test/unit'
+end
+require 'fileutils'
+
+# Must set before requiring generator libs.
+TMP_ROOT = File.dirname(__FILE__) + "/tmp" unless defined?(TMP_ROOT)
+PROJECT_NAME = "myproject" unless defined?(PROJECT_NAME)
+app_root = File.join(TMP_ROOT, PROJECT_NAME)
+if defined?(APP_ROOT)
+  APP_ROOT.replace(app_root)
+else
+  APP_ROOT = app_root
+end
+if defined?(RAILS_ROOT)
+  RAILS_ROOT.replace(app_root)
+else
+  RAILS_ROOT = app_root
+end
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/helpers/generator_test_helper'

data/test/generators/test_resource_generator.rb

@@ -0,0 +1,71 @@
+require File.join(File.dirname(__FILE__), "test_generator_helper.rb")
+
+
+class TestResourceGenerator < Test::Unit::TestCase
+  include RubiGen::GeneratorTestHelper
+
+  def setup
+    bare_setup
+  end
+
+  def teardown
+    bare_teardown
+  end
+
+  # Some generator-related assertions:
+  #   assert_generated_file(name, &block) # block passed the file contents
+  #   assert_directory_exists(name)
+  #   assert_generated_class(name, &block)
+  #   assert_generated_module(name, &block)
+  #   assert_generated_test_for(name, &block)
+  # The assert_generated_(class|module|test_for) &block is passed the body of the class/module within the file
+  #   assert_has_method(body, *methods) # check that the body has a list of methods (methods with parentheses not supported yet)
+  #
+  # Other helper methods are:
+  #   app_root_files - put this in teardown to show files generated by the test method (e.g. p app_root_files)
+  #   bare_setup - place this in setup method to create the APP_ROOT folder for each test
+  #   bare_teardown - place this in teardown method to destroy the TMP_ROOT or APP_ROOT folder after each test
+
+  def test_generator_without_options
+    resource = "resource"
+    funcs = ["method1", "method2"]
+    run_generator('resource', funcs.unshift(resource), sources)
+    assert_generated_file   "lib/scrobbler2/resource.rb" do |file|
+      assert file.include?("class Resource < Base")
+      assert file.include?("has_resource :method1, :root => \"method1\"")
+      assert file.include?("has_resource :method2, :root => \"method2\"")
+    end
+    
+    assert_generated_file   "test/unit/resource_spec.rb" do |file|
+       assert file.include?("describe \"Resource\"")
+       
+       assert file.include?("@resource = Scrobbler2::Resource.new \"...\"")
+       assert file.include?("@resource.class.stub!(:get).and_return Hash.new")
+       
+       assert file.include?("it \"should have a default query {TODO}\" do")
+       assert file.include?("@resource.instance_variable_get(:@query).should == {}")
+       
+       assert file.include?("it \"method1 should call get with 'resource.getmethod1'\" do")
+       assert file.include?("@resource.class.should_receive(:get).with('resource.getmethod1', anything(), anything()).and_return Hash.new")
+       assert file.include?("@resource.method1")
+       
+       assert file.include?("it \"method2 should call get with 'resource.getmethod2'\" do")
+       assert file.include?("@resource.class.should_receive(:get).with('resource.getmethod2', anything(), anything()).and_return Hash.new")
+       assert file.include?("@resource.method2")
+    end
+
+    assert_directory_exists("test/acceptance/resource")
+    assert_generated_file   "test/acceptance/resource/method1_test.rb"
+    assert_generated_file   "test/acceptance/resource/method2_test.rb"
+  end
+
+  private
+  def sources
+    [RubiGen::PathSource.new(:test, File.join(File.dirname(__FILE__),"../..", generator_path))
+    ]
+  end
+
+  def generator_path
+    "generators"
+  end
+end

data/test/unit/album_spec.rb

@@ -0,0 +1,17 @@
+require File.dirname(__FILE__) + "/spec_helper.rb"
+
+describe "Album" do
+  before(:each) do
+    @album = Scrobbler2::Album.new "Metallica", "Ride The Lightning"
+    @album.class.stub!(:get).and_return Hash.new
+  end
+  
+  it "should have a default query {:artist => 'Metallica', :album => 'Ride The Lightning'}" do
+    @album.instance_variable_get(:@query).should == {:artist => 'Metallica', :album => 'Ride The Lightning'}  
+  end
+  
+  it "info should call get with 'album.getInfo' with query params :artist => @artist, :album => @album" do
+    @album.class.should_receive(:get).with('album.getinfo', {:artist => "Metallica", :album => "Ride The Lightning"}, {}).and_return Hash.new
+    @album.info
+  end
+end

data/test/unit/artist_spec.rb

@@ -0,0 +1,62 @@
+require File.dirname(__FILE__) + "/spec_helper.rb"
+
+describe "Artist" do
+  before(:each) do
+    @artist = Scrobbler2::Artist.new "Metallica"
+    @artist.class.stub!(:get).and_return Hash.new
+  end
+  
+  it "should have a default query {:artist => 'Metallica'}" do
+    @artist.instance_variable_get(:@query).should == {:artist => 'Metallica'}  
+  end
+  
+  it "info should call get with 'artist.getInfo' with query params :artist => @name" do
+    @artist.class.should_receive(:get).with('artist.getinfo', {:artist => "Metallica"}, {}).and_return Hash.new
+    @artist.info
+  end
+  
+  it "similar should call get with 'artist.getSimilar' with query params :artist => @name" do
+    @artist.class.should_receive(:get).with('artist.getsimilar', {:artist => "Metallica"}, {}).and_return Hash.new
+    @artist.similar
+  end
+  
+  it "top_albums should call get with 'artist.getTopAlbums' with query params :artist => @name" do
+    @artist.class.should_receive(:get).with('artist.gettopalbums', {:artist => "Metallica"}, {}).and_return Hash.new
+    @artist.top_albums
+  end
+  
+  it "events should call get with 'artist.getEvents' with query params :artist => @name" do
+    @artist.class.should_receive(:get).with('artist.getevents', {:artist => "Metallica"}, {}).and_return Hash.new
+    @artist.events
+  end
+
+  it "shouts should call get with 'artist.getShouts' with query params :artist => @name" do
+    @artist.class.should_receive(:get).with('artist.getshouts', {:artist => "Metallica"}, {}).and_return Hash.new
+    @artist.shouts
+  end
+  
+  it "top_fans should call get with 'artist.getTopFans' with query params :artist => @name" do
+    @artist.class.should_receive(:get).with('artist.gettopfans', {:artist => "Metallica"}, {}).and_return Hash.new
+    @artist.top_fans
+  end
+  
+  it "top_tags should call get with 'artist.getTopTags' with query params :artist => @name" do
+    @artist.class.should_receive(:get).with('artist.gettoptags', {:artist => "Metallica"}, {}).and_return Hash.new
+    @artist.top_tags
+  end
+  
+  it "top_tracks should call get with 'artist.getTopTrakcs' with query params :artist => @name" do
+    @artist.class.should_receive(:get).with('artist.gettoptracks', {:artist => "Metallica"}, {}).and_return Hash.new
+    @artist.top_tracks
+  end
+  
+  it "tags should call get_with_auth with 'artist.getTags', and query params :artist => @name" do
+    @artist.class.should_receive(:get_with_auth).with('artist.gettags', {:artist => "Metallica"}).and_return Hash.new :tags => []
+    @artist.tags
+  end
+  
+  it "add tags should post_with_auth with 'artist.addTags', and query params :artist => @name, :tags => 'test1, test2'" do
+    @artist.class.should_receive(:post_with_auth).with('artist.addtags', {:artist => "Metallica", :tags => "test1,test2"}).and_return Hash.new
+    @artist.add_tags ["test1", "test2"]
+  end
+end

data/test/unit/auth_spec.rb

@@ -0,0 +1,22 @@
+require File.dirname(__FILE__) + "/spec_helper.rb"
+
+
+describe "Auth" do
+  before(:each) do
+    @auth = Scrobbler2::Auth.new 
+    @artist.class.stub!(:get_with_auth).and_return Hash.new
+  end
+  
+  it "token should call get_with_auth with auth.gettoken" do
+    @auth.class.should_receive(:get_with_auth).with('auth.gettoken').and_return Hash.new :lfm => {} 
+    @auth.token
+  end
+  
+  it "session should call get_with_auth with auth.getsession and token=token" do
+    @auth.should_receive(:token).and_return :test_token
+    @auth.class.should_receive(:get_with_auth).with('auth.getsession', {:token => :test_token}).and_return Hash.new :lfm => {} 
+    @auth.session
+  end
+  
+
+end

data/test/unit/base_spec.rb

@@ -0,0 +1,193 @@
+require File.dirname(__FILE__) + "/spec_helper.rb"
+
+class TestBaseImplementation < Scrobbler2::Base
+end
+
+describe "Base" do
+
+  before(:each) do
+    HTTParty.stub!(:get)
+    Scrobbler2::Base.api_key = "api_key"
+    Scrobbler2::Base.api_secret = "api_secret"
+  end
+
+  it "should have attribute api key" do
+    Scrobbler2::Base.api_key = "blah"
+    Scrobbler2::Base.api_key.should == "blah"
+  end
+
+  it "should have attribute session_key" do
+    Scrobbler2::Base.session_key = "blah"
+    Scrobbler2::Base.session_key.should == "blah"
+  end
+  
+  it "should have attribute api secret" do
+    Scrobbler2::Base.api_secret = "blah"
+    Scrobbler2::Base.api_secret.should == "blah"
+  end
+  
+  describe "has_resource" do
+    
+    before(:each) do
+      TestBaseImplementation.module_eval("has_resource :test_info, :root => :test");
+      TestBaseImplementation.stub!(:get).and_return({})
+      @test = TestBaseImplementation.new
+    end
+    
+    it "should create a named method" do
+      @test.method(:test_info).should_not be_nil
+    end
+    
+    describe "the method" do
+      it "the method should call self.get" do
+        TestBaseImplementation.should_receive(:get)
+        @test.test_info
+      end
+    
+      it "should call get with resource name got from the class name and the method name" do
+        TestBaseImplementation.should_receive(:get).with("testbaseimplementation.gettestinfo", an_instance_of(Hash), an_instance_of(Hash))
+        @test.test_info
+      end
+      
+      it "should get with query options from @query" do
+        @test.instance_variable_set(:@query, {:name => "test"})
+        TestBaseImplementation.should_receive(:get).with("testbaseimplementation.gettestinfo", {:name => "test"}, an_instance_of(Hash))
+        @test.test_info
+      end
+      
+      it "should return the root element" do
+        TestBaseImplementation.should_receive(:get).and_return({:test=>:root_element});
+        @test.test_info.should == :root_element              
+      end
+   end
+    
+  end
+  
+  describe "has_resource with options = {:resource_name => resource.method}" do
+    before(:each) do
+      TestBaseImplementation.module_eval("has_resource :test_info, :root => :test, :resource_name => 'resource.method'");
+      TestBaseImplementation.stub!(:get).and_return({})
+      @test = TestBaseImplementation.new
+    end
+  
+    it "should call get with resource name got from options" do
+      TestBaseImplementation.should_receive(:get).with("resource.method", an_instance_of(Hash), an_instance_of(Hash))
+      @test.test_info
+    end
+  end
+  
+  describe "sign" do
+    it "should return an md5 digest of the 'query_signature'" do
+      Scrobbler2::Base.should_receive(:query_signature).with(:query).and_return('query_signature')
+      Scrobbler2::Base.sign(:query).should == '4987b19cfbded59cd717b8ffd9f1a6bf'
+    end
+  end
+  
+  describe "query_signature" do
+    it "should return an unencoded api_signature" do
+      query = {:method => "artist.getInfo", :api_key => "api_key", :format => "json"}
+      Scrobbler2::Base.query_signature(query).should == "api_keyapi_keyformatjsonmethodartist.getInfoapi_secret"
+    end
+    
+  end
+  
+  describe "get" do 
+    it "should call HTTParty.get" do
+      HTTParty.should_receive(:get).with('http://ws.audioscrobbler.com/2.0/', {:query => {:method=>'artist.getInfo', :format=>'json', :api_key => 'api_key'}})
+      Scrobbler2::Base.get('artist.getInfo', {})
+    end
+  end
+
+  
+  describe "auth_request", :shared => true do
+  
+    it "should set the query method" do
+      HTTParty.should_receive(http_method) do |url, options|
+        options[options_param][:method].should == 'artist.getInfo'
+      end
+      action
+    end
+    
+    it "should set the api_key" do
+      HTTParty.should_receive(http_method) do |url, options|
+        options[options_param][:api_key].should == 'api_key'
+      end
+      action
+    end
+    
+    it "should set the api_sginature" do
+      Scrobbler2::Base.should_receive(:sign).with(an_instance_of(Hash)).and_return('signature')
+      HTTParty.should_receive(http_method) do |url, options|
+        options[options_param][:api_sig].should == 'signature'
+      end
+      action
+    end
+    
+    it "should set the session_key, if available" do
+      Scrobbler2::Base.should_receive(:session_key).at_least(1).and_return("SESSIONKEY");      
+      HTTParty.should_receive(http_method) do |url, options|
+        options[options_param][:sk].should == 'SESSIONKEY'
+      end
+      action
+    end
+    
+    it "should not set the session_key, if unavailable" do
+      Scrobbler2::Base.should_receive(:session_key).at_least(1).and_return(nil);      
+      HTTParty.should_receive(http_method) do |url, options|
+        options[options_param].should_not have_key(:sk)
+      end
+      action
+    end
+  
+  end
+  
+  
+  describe "get_with_auth" do
+    it "should call HTTParty.get" do
+      HTTParty.should_receive(:get).with('http://ws.audioscrobbler.com/2.0/', an_instance_of(Hash))
+      Scrobbler2::Base.get_with_auth('artist.getInfo', {})
+    end
+    
+    def action
+      Scrobbler2::Base.get_with_auth('artist.getInfo', {})
+    end
+    
+    def http_method
+      :get
+    end 
+    
+    def options_param
+      :query
+    end
+    
+    it_should_behave_like "auth_request"
+  end
+  
+  
+  describe "post_with_auth" do
+    it "should call HTTParty.post" do
+      HTTParty.should_receive(:post).with('http://ws.audioscrobbler.com/2.0/', an_instance_of(Hash))
+      Scrobbler2::Base.post_with_auth('artist.getInfo', {})
+    end
+
+    def action
+      Scrobbler2::Base.post_with_auth('artist.getInfo', {})
+    end
+    
+    def http_method
+      :post
+    end 
+    
+    def options_param
+      :body
+    end
+
+    
+    it_should_behave_like "auth_request"
+
+  
+  end
+
+end
+
+