scrobbler2 0.0.4

data/.gitignore

@@ -0,0 +1 @@
+pkg

data/README.rdoc

@@ -0,0 +1,155 @@
+= Scrobbler2
+
+Scrobbler2 is a wrapper for the Last.fm web services (http://www.last.fm/api), inspired by Jnunemaker's Original Scrobbler Gem (http://github.com/jnunemaker/scrobbler).
+
+== Installation
+
+Install via ruby-gems
+  sudo gem install gingerhendrix-scrobbler2 --source http://gems.github.com
+
+== Requirements
+
+Scrobbler2 requires 
+* HTTParty (http://github.com/jnunemaker/httparty) 
+* ActiveSupport (http://rubyforge.org/projects/activesupport/).
+
+= Usage
+
+== API Key
+
+All last.fm requests require an API Key. Register for an API key at http://www.last.fm/api
+
+  Scrobbler2::Base.api_key = "abcdefghijklmnopqrstuvwxyz123456"
+
+== Authentication
+
+Some requests (eg. write requests) require authentication.  Authenticated request require an api secret (provided with your api key) and a session key.  
+
+  Scrobbler2::Base.api_secret = "9876543210zyxwvutsrqponmlkjihgfe"
+  Scrobbler2::Base.session_key = "qwertyuioplkjhgfdsamnbvcxz"
+
+=== Obtaining a session key
+
+scrobbler2 currently supports last.fm's desktop authentication protocol.  In this process
+1. The app requests a authentication token
+2. The app sends the user to a last.fm authentication page
+3. The user agrees to allow the the app acess to their data.
+4. The app requests a session key. 
+5. The app makes an authenticated request with the session key.
+
+    auth = Scrobbler2::Auth.new
+    token = auth.token
+    puts "Auth Token #{token} \n" 
+    token.should_not be_nil
+    puts "Now go to #{auth.url} and authorise\n"
+
+    gets #Wait for enter
+    
+    session = auth.session
+    puts "Session: #{session.inspect} \n"
+    session.should be_kind_of(Hash)
+    session['key'].should_not be_nil  
+    
+    Scrobbler2::Base.session_key = session['key']
+  	user = Scrobbler2::User.new(username)
+  	user.info
+  
+== Users
+
+	username = 'gingerhendrix'
+	user = Scrobbler2::User.new(username)
+
+	puts "#{username}'s Recent Tracks"
+	puts "=" * (username.length + 16)
+	user.recent_tracks["track"].each { |t| puts t["name"] }
+
+	puts
+	puts
+
+	puts "#{username}'s Top Tracks"
+	puts "=" * (username.length + 13)
+	user.top_tracks["track"].each { |t| puts "(#{t["playcount"]} plays) #{t["name"]}" }
+	
+== Albums
+	
+	album = Scrobbler2::Album.new('Carrie Underwood', 'Some Hearts')
+
+	puts "Album: #{album.info["name"]}"
+	puts "Artist: #{album.info["artist"]}"
+	puts "Listeners: #{album.info["listeners"]}"
+	puts "URL: #{album.info["url"]}"
+	puts "Release Date: #{album.info["releasedate"]}"
+
+	puts
+	puts
+
+	puts "Album Tags"
+	longest_tag_name = album.info["toptags"]["tag"].collect {|t| t["name"] }.sort {|x, y| y.length <=> x.length }.first.length
+	puts "=" * longest_tag_name
+	album.info["toptags"]["tag"].each { |t| puts t["name"] }
+	
+== Artists
+	
+	artist = Scrobbler2::Artist.new('Carrie Underwood')
+
+	puts 'Top Tracks'
+	puts "=" * 10
+	artist.top_tracks["track"].each { |t| puts "(#{t["playcount"]} plays) #{t["name"]}" }
+
+	puts
+
+	puts 'Similar Artists'
+	puts "=" * 15
+	artist.info["similar"]["artist"].each { |a| puts "#{a["name"]}" }
+	
+== Tags	
+	
+	tag = Scrobbler2::Tag.new('country')
+
+	puts 'Top Albums'
+	tag.top_albums["album"].each { |a| puts "(#{a["tagcount"]} tags) '#{a["name"]}' by #{a["artist"]["name"]}" }
+
+	puts
+
+	puts 'Top Tracks'
+	tag.top_tracks.each { |t| puts "(#{t["tagcount"]} tags) '#{t["name"]}' by #{t["artist"]["name"]}" }
+	
+== Tracks
+	
+	track = Scrobbler2::Track.new('Carrie Underwood', 'Before He Cheats')
+	puts 'Fans'
+	puts "=" * 4
+	puts track.info["listeners"]
+
+= Development
+
+Scrobbler2 is still in development.  If you want to help out please feel free to fork the project on github (http://github.com/gingerhendrix/scrobbler2).
+
+== Build and install
+The scrobbler2 gem can be built and installed via rake.
+  
+  rake build    # builds the gem (in pkg/)
+  rake install  # builds and installs the gem (using sudo gem install)
+  
+== Tests
+
+Scrobbler2 has unit and acceptance tests written using RSpec.  The tests can be run using rake.
+
+  rake test:unit        # runs the unit tests
+  rake test:acceptance  # runs the acceptance tests
+
+The acceptance tests run against the live last.fm api.  You will need to set the api_key and authentication parameters in test/acceptance/test_helper.rb before 
+running these tests.  You can obtain a session key by running the auth_test, this test is not invoked with the rest of the acceptance suite.
+  
+  ruby test/acceptance/auth/auth_test.rb
+
+== Internals
+
+Scrobbler2 api methods use a simple set of macros to implement the api.  All the hard work goes on in Scrobbler2::Base.
+  
+== TODO
+
+* Write requests.
+* Submissions
+* Radio API
+	  

data/Rakefile

@@ -0,0 +1,8 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+require 'spec/rake/spectask'
+
+Dir['tasks/**/*.rake'].each { |rake| load rake }
+
+task :default => 'test:unit'

data/TODO

@@ -0,0 +1,23 @@
+0.0.5 Release
+  Add README
+    Merge from VxJasonxV
+    Copy examples to /examples
+    Add a development section with info about rake tasks etc.
+  Look at api_key and secret_key
+  Simple website
+  Release
+0.0.6 Release
+  Fix auth (so user.getInfo works at least)
+0.1.0 Release
+  Finish API
+    Post and Auth Requests
+      user.{getInfo|getRemommendedArtists|getRecommendedEvents}
+      {artist|album|track}.{get|add|remove}Tag
+      {artist|track|event}.share
+      track.{love|ban}
+      library.add{Artist|Album|Track}
+      playlist.{create|addTrack}
+      event.attend
+    Search Requests
+      {album|artist|tag|track|venue}.search
+  Release

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:patch: 4
+:major: 0
+:minor: 0

data/generators/acceptance_test/USAGE

@@ -0,0 +1,9 @@
+Description:
+  Generate a scrobbler2 acceptance test
+  
+Usage:
+  ./script/generate acceptance_test resource func
+  
+  * resource is a last.fm api resource (eg. user, track etc)
+  * func is a last.fm api method (eg. info, similar, top_tags etc)
+

data/generators/acceptance_test/acceptance_test_generator.rb

@@ -0,0 +1,57 @@
+class AcceptanceTestGenerator < RubiGen::Base
+
+#  default_options :author => nil
+
+  attr_reader :resource
+  attr_reader :func
+
+  def initialize(runtime_args, runtime_options = {})
+    super
+    usage if args.empty?  || args.length < 2
+    @resource = args.shift
+    @func = args.shift
+    extract_options
+  end
+
+  def manifest
+    record do |m|
+      # Ensure appropriate folder(s) exists
+      m.directory "test/acceptance/#{@resource}"
+
+      # Create stubs
+      m.template  "acceptance_test.rb.erb", "test/acceptance/#{@resource}/#{@func}_test.rb"
+      # m.template_copy_each ["template.rb", "template2.rb"]
+      # m.template_copy_each ["template.rb", "template2.rb"], "some/path"
+      # m.file           "file", "some_file_copied"
+      # m.file_copy_each ["path/to/file", "path/to/file2"]
+      # m.file_copy_each ["path/to/file", "path/to/file2"], "some/path"
+    end
+  end
+
+  protected
+    def banner
+      <<-EOS
+Creates a scrobbler2 acceptance test
+
+USAGE: #{$0} #{spec.name} resource func
+EOS
+    end
+
+    def add_options!(opts)
+      # opts.separator ''
+      # opts.separator 'Options:'
+      # For each option below, place the default
+      # at the top of the file next to "default_options"
+      # opts.on("-a", "--author=\"Your Name\"", String,
+      #         "Some comment about this option",
+      #         "Default: none") { |options[:author]| }
+      # opts.on("-v", "--version", "Show the #{File.basename($0)} version number and quit.")
+    end
+
+    def extract_options
+      # for each option, extract it into a local variable (and create an "attr_reader :author" at the top)
+      # Templates can access these value via the attr_reader-generated methods, but not the
+      # raw instance variable value.
+      # @author = options[:author]
+    end
+end

data/generators/acceptance_test/templates/acceptance_test.rb.erb

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

data/generators/resource/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Generate a scrobbler2 resource
+  
+Usage:
+  ./script/generate resource resource [funcs]
+  
+  * resource is a last.fm api resource (eg. user, track etc)
+  * funcs are a list of last.fm get api method (eg. info, similar, top_tags etc)

data/generators/resource/resource_generator.rb

@@ -0,0 +1,47 @@
+class ResourceGenerator < RubiGen::Base
+
+  default_options :author => nil
+
+  attr_reader :name
+  attr_reader :funcs
+
+  def initialize(runtime_args, runtime_options = {})
+    super
+    usage if args.empty?
+    @name = args.shift
+    @funcs = args
+    extract_options
+  end
+
+  def manifest
+    record do |m|
+      # Ensure appropriate folder(s) exists
+      m.directory 'lib/scrobbler2'
+      m.directory 'test/unit'
+      
+      # Create stubs
+      m.template "resource.rb.erb", "lib/scrobbler2/#{name}.rb"
+      m.template "spec.rb.erb", "test/unit/#{name}_spec.rb"
+      
+      # Create acceptance tests
+      funcs.each do |func|
+        m.dependency "acceptance_test", [name, func]
+      end
+    end
+  end
+
+  protected
+    def banner
+      <<-EOS
+Creates a scrobbler2 resource
+
+USAGE: #{$0} #{spec.name} name funcs
+EOS
+    end
+
+    def add_options!(opts)
+    end
+
+    def extract_options
+    end
+end

data/generators/resource/templates/resource.rb.erb

@@ -0,0 +1,11 @@
+module Scrobbler2
+  class <%= name.classify %> < Base
+    
+    def initialize()
+      @query = {}#TODO eg. {:artist => artist, :track => track}
+    end
+    <% funcs.each do |func| %>
+     has_resource :<%=func%>, :root => "<%=func.camelize.downcase%>"
+   <% end %>
+  end
+end

data/generators/resource/templates/spec.rb.erb

@@ -0,0 +1,22 @@
+require File.dirname(__FILE__) + "/spec_helper.rb"
+
+describe "<%=name.classify%>" do
+  before(:each) do
+    @<%=name%> = Scrobbler2::<%=name.classify%>.new "..."
+    @<%=name%>.class.stub!(:get).and_return Hash.new
+  end
+  
+  it "should have a default query {TODO}" do
+    @<%=name%>.instance_variable_get(:@query).should == {}  
+  end
+  
+  <% funcs.each do |func| %>
+  
+  it "<%=func%> should call get with '<%=name%>.get<%=func%>'" do
+    @<%=name%>.class.should_receive(:get).with('<%=name%>.get<%=func%>', anything(), anything()).and_return Hash.new
+    @<%=name%>.<%=func%>
+  end
+  
+  <% end %>
+
+end

data/lib/scrobbler2.rb

@@ -0,0 +1,23 @@
+require 'rubygems'
+require 'activesupport'
+require 'httparty'
+$: << File.dirname(__FILE__)
+
+module Scrobbler2
+
+end
+
+require 'scrobbler2/base.rb'
+require 'scrobbler2/auth.rb'
+require 'scrobbler2/album.rb'
+require 'scrobbler2/artist.rb'
+require 'scrobbler2/event.rb'
+require 'scrobbler2/geo.rb'
+require 'scrobbler2/group.rb'
+require 'scrobbler2/library.rb'
+require 'scrobbler2/playlist.rb'
+require 'scrobbler2/tag.rb'
+require 'scrobbler2/track.rb'
+require 'scrobbler2/user.rb'
+require 'scrobbler2/venue.rb'
+

data/lib/scrobbler2/album.rb

@@ -0,0 +1,11 @@
+module Scrobbler2
+  class Album < Base
+    
+    def initialize(artist, album)
+      @query = {:artist => artist, :album => album}
+    end
+    
+     has_resource :info, :root => 'album'
+   
+  end
+end

data/lib/scrobbler2/artist.rb

@@ -0,0 +1,26 @@
+
+module Scrobbler2
+  class Artist < Base
+    
+    def initialize(artist)
+      @query = {:artist => artist}
+    end
+
+    has_resource :events, :root => 'events'
+    has_resource :info, :root => 'artist'
+    has_resource :shouts, :root => 'shouts'
+    has_resource :similar, :root => 'similarartists'
+    has_resource :top_albums, :root => 'topalbums'
+    has_resource :top_fans, :root => 'topfans'
+    has_resource :top_tags, :root => 'toptags'
+    has_resource :top_tracks, :root => 'toptracks'
+    
+    has_resource :tags, :root=> "tags", :auth => true
+
+    def add_tags(tags)
+      query = @query.merge :tags => tags.join(",")
+      self.class.post_with_auth("artist.addtags", query)
+    end
+    
+  end
+end