hallon 0.4.0 → 0.8.0

data/spec/hallon/toplist_spec.rb

@@ -0,0 +1,40 @@
+describe Hallon::Toplist do
+  subject do
+    mock_session do
+      Spotify.should_receive(:toplistbrowse_create).and_return(mock_toplistbrowse)
+      Hallon::Toplist.new(:artists)
+    end
+  end
+
+  it { should be_a Hallon::Observable }
+  it { should be_loaded }
+  its(:error) { should eq :ok }
+
+  its('artists.size') { should eq 2 }
+  its('artists.to_a') { should eq instantiate(Hallon::Artist, mock_artist, mock_artist_two) }
+
+  its('albums.size') { should eq 1 }
+  its('albums.to_a') { should eq instantiate(Hallon::Album, mock_album) }
+
+  its('tracks.size') { should eq 2 }
+  its('tracks.to_a') { should eq instantiate(Hallon::Track, mock_track, mock_track_two) }
+
+  describe ".new" do
+    around { |test| mock_session(&test) }
+
+    it "should fail given an invalid type" do
+      expect { Hallon::Toplist.new(:invalid_type) }.to raise_error(ArgumentError, /invalid enum value/)
+    end
+
+    it "should pass the username given a string to libspotify" do
+      Spotify.should_receive(:toplistbrowse_create).with(anything, anything, :user, "Kim", anything, nil).and_return(null_pointer)
+      Hallon::Toplist.new(:artists, "Kim")
+    end
+
+    it "should pass the correct region to libspotify" do
+      sweden = 21317
+      Spotify.should_receive(:toplistbrowse_create).with(anything, anything, sweden, anything, anything, nil).and_return(null_pointer)
+      Hallon::Toplist.new(:artists, :se)
+    end
+  end
+end

data/spec/hallon/track_spec.rb

@@ -1,19 +1,49 @@
 # coding: utf-8
-describe Hallon::Track, :session => true do
+describe Hallon::Track do
   subject { Hallon::Track.new(mock_track) }
 
+  it { should be_loaded }
   its(:name)   { should eq "They" }
   its(:disc)   { should be 2 }
   its(:index)  { should be 7 }
   its(:status) { should be :ok }
-
-  its(:duration) { should eq 123.456 }
+  its(:duration)   { should eq 123.456 }
   its(:popularity) { should eq 0.42 }
+  its(:album) { should eq Hallon::Album.new(mock_album) }
+  its(:artist) { should eq Hallon::Artist.new(mock_artist) }
+  its('artists.size') { should eq 2 }
+  its('artists.to_a') { should eq [mock_artist, mock_artist_two].map{ |p| Hallon::Artist.new(p) } }
 
-  its("album.name")  { should eq "Finally Woken"  }
-  pending("artist.name") { should eq "Jem" }
+  describe "#starred=" do
+    around { |test| mock_session(&test) }
 
-  it { should be_loaded }
+    it "should delegate to session to unstar" do
+      session.should_receive(:unstar).with(subject)
+      subject.starred = false
+    end
+
+
+    it "should delegate to session to star" do
+      session.should_receive(:star).with(subject)
+      subject.starred = true
+    end
+
+    it "should change starred status of track" do
+      subject.should be_starred
+      subject.starred = false
+      subject.should_not be_starred
+    end
+  end
+
+  describe "session bound queries" do
+    subject { Hallon::Track.new(mock_track) }
+    around  { |test| mock_session(&test) }
+
+    it { should be_available }
+    it { should_not be_local }
+    it { should be_autolinked }
+    it { should be_starred }
+  end
 
   describe "album" do
     it "should be an album when there is one" do
@@ -46,7 +76,7 @@ describe Hallon::Track, :session => true do
 
   describe "offset" do
     let(:without_offset) { 'spotify:track:7N2Vc8u56VGA4KUrGbikC2' }
-    let(:with_offset) { without_offset + '#1:00' }
+    let(:with_offset)    { without_offset + '#1:00' }
 
     specify "with offset" do
       Hallon::Track.new(with_offset).offset.should eq 60
@@ -64,7 +94,12 @@ describe Hallon::Track, :session => true do
 
     its(:name) { should eq "Nissy" }
     its("album.name") { should eq "Coolio" }
-    pending("artist.name") { should eq "Emmy" }
+    its("artist.name") { should eq "Emmy" }
     its(:duration) { should eq 0.1 }
+
+    it do
+      Hallon::Session.should_receive(:instance).and_return(session)
+      should be_local
+    end
   end
 end

data/spec/mockspotify.rb

@@ -0,0 +1,47 @@
+require 'ffi'
+require 'rbconfig'
+
+module Spotify
+  module Mock
+    # @return [String] path to the libmockspotify C extension binary.
+    def self.path
+      File.expand_path('../mockspotify/libmockspotify.', __FILE__) << Config::MAKEFILE_CONFIG['DLEXT']
+    end
+
+    # Overridden to always ffi_lib the mock path.
+    def ffi_lib(*)
+      super(Mock.path)
+    end
+
+    # Overriden to not throw an error on missing functions.
+    def attach_function(*)
+      super
+    rescue FFI::NotFoundError => e
+      warn "#{e.message}" if $VERBOSE
+    end
+  end
+
+  extend FFI::Library
+  extend Mock
+  require 'spotify'
+
+  old_verbose, $VERBOSE = $VERBOSE, true
+
+  attach_function :registry_find, [:string], :pointer
+  attach_function :registry_add, [:string, :pointer], :void
+
+  attach_function :mock_session, :mocksp_session_create, [:pointer, :connectionstate, :int, :array, :int, Spotify::OfflineSyncStatus, :int, :int], :session
+  attach_function :mock_user, :mocksp_user_create, [:string, :string, :string, :string, :relation_type, :bool], :user
+  attach_function :mock_track, :mocksp_track_create, [:string, :int, :array, :album, :int, :int, :int, :int, :error, :bool, :bool, :bool, :bool, :bool], :track
+  attach_function :mock_image, :mocksp_image_create, [:image_id, :imageformat, :size_t, :buffer_in, :error], :image
+  attach_function :mock_artist, :mocksp_artist_create, [:string, :bool], :artist
+  attach_function :mock_album, :mocksp_album_create, [:string, :artist, :int, :image_id, :albumtype, :bool, :bool], :album
+
+  attach_function :mock_albumbrowse, :mocksp_albumbrowse_create, [:error, :album, :artist, :int, :array, :int, :array, :string, :albumbrowse_complete_cb, :pointer], :albumbrowse
+  attach_function :mock_artistbrowse, :mocksp_artistbrowse_create, [:error, :artist, :int, :array, :int, :array, :int, :array, :int, :array, :string, :artistbrowse_complete_cb, :pointer], :artistbrowse
+  attach_function :mock_toplistbrowse, :mocksp_toplistbrowse_create, [:error, :int, :array, :int, :array, :int, :array], :toplistbrowse
+
+  attach_function :mock_search, :mocksp_search_create, [:error, :string, :string, :int, :int, :array, :int, :int, :array, :int, :int, :array, :search_complete_cb, :pointer], :search
+
+  $VERBOSE = old_verbose
+end

data/spec/mockspotify/.gitignore

@@ -0,0 +1,5 @@
+[^.]*
+!.gitignore
+!extconf.rb
+!libmockspotify
+!mockspotify_spec.rb

data/spec/mockspotify/extconf.rb

@@ -0,0 +1,5 @@
+require 'mkmf'
+
+$CFLAGS << ' -O0 -ggdb -Wextra '
+
+create_makefile 'libmockspotify', 'libmockspotify/src'

data/spec/mockspotify/mockspotify_spec.rb

@@ -0,0 +1,41 @@
+describe Spotify::Mock do
+  it "should have injected itself into Spotify's ancestor chain" do
+    ancestors = (class << Spotify; self; end).ancestors
+    mock_index = ancestors.index(Spotify::Mock)
+    ffi_index  = ancestors.index(FFI::Library)
+
+    mock_index.should < ffi_index # [Mock, FFI, BasicObject]
+  end
+
+  describe "hextoa" do
+    it "should convert a hexidecimal string properly" do
+      Spotify.attach_function :hextoa, [:string, :int], :string
+      Spotify.hextoa("3A3A", 4).should eq "::"
+    end
+  end
+
+  describe "atohex" do
+    it "should convert a byte string to a hexadecimal string" do
+      Spotify.attach_function :atohex, [:buffer_out, :buffer_in, :int], :void
+
+      FFI::Buffer.alloc_out(8) do |b|
+        Spotify.atohex(b, "\x3A\x3A\x0F\xF1", b.size)
+        b.get_string(0, b.size).should eq "3a3a0ff1"
+      end
+    end
+  end
+
+  describe "the registry" do
+    it "should find previously added entries" do
+      Spotify.registry_add("i_exist", FFI::Pointer.new(1))
+      Spotify.registry_add("i_exist_too", FFI::Pointer.new(2))
+
+      Spotify.registry_find("i_exist").should eq FFI::Pointer.new(1)
+      Spotify.registry_find("i_exist_too").should eq FFI::Pointer.new(2)
+    end
+
+    it "should return nil for entries not in the registry" do
+      Spotify.registry_find("i_do_not_exist").should be_null
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,4 +1,5 @@
 # coding: utf-8
+require 'bundler/setup'
 
 begin
   require 'cover_me'
@@ -23,6 +24,25 @@ RSpec.configure do |config|
     appkey = valid_appkey ? 'appkey_good' : 'appkey_bad'
     Hallon::Session.send(:new, appkey, options)
   end
+
+  def instantiate(klass, *pointers)
+    pointers.map { |x| klass.new(x) }
+  end
+
+  def mock_session
+    Hallon::Session.should_receive(:instance).at_least(1).times.and_return(session)
+    yield
+  end
+
+  def pointer_array_with(*args)
+    ary = FFI::MemoryPointer.new(:pointer, args.size)
+    ary.write_array_of_pointer args
+    def ary.length
+      size / type_size
+    end
+
+    ary
+  end
 end
 
 RSpec::Core::ExampleGroup.instance_eval do

data/spec/support/common_objects.rb

@@ -1,18 +1,95 @@
+# coding: utf-8
 RSpec::Core::ExampleGroup.instance_eval do
   let(:mock_artist) { Spotify.mock_artist("Jem", true) }
+  let(:mock_artist_two) { Spotify.mock_artist("Maroon 5", true) }
+
   let(:mock_album)  { Spotify.mock_album("Finally Woken", mock_artist, 2004, "DEADBEEFDEADBEEFDEAD", :single, true, true) }
   let(:mock_user)   { Spotify.mock_user("burgestrand", "Burgestrand", "Kim Burgestrand", "https://secure.gravatar.com/avatar/b67b73b5b1fd84119ec788b1c3df02ad", :none, true) }
   let(:mock_image)  { Spotify.mock_image(mock_image_id, :jpeg, File.size(fixture_image_path), File.read(fixture_image_path), :ok) }
+
   let(:mock_track) do
-    track = nil
-    FFI::MemoryPointer.new(:pointer) do |ary|
-      ary.write_pointer mock_artist
-      track = Spotify.mock_track("They", 1, ary, mock_album, 123_456, 42, 2, 7, 0, true)
-    end
-    track
+    artists = pointer_array_with(mock_artist, mock_artist_two)
+    Spotify.mock_track("They", artists.length, artists, mock_album, 123_456, 42, 2, 7, 0, true, true, false, true, true)
+  end
+
+  let(:mock_track_two) do
+    artists = pointer_array_with(mock_artist)
+    Spotify.mock_track("Amazing", artists.length, artists, mock_album, 123_456, 42, 2, 7, 0, true, true, false, true, true)
+  end
+
+  let(:mock_albumbrowse) do
+    copyrights = %w[Kim Elin].map { |x| FFI::MemoryPointer.from_string(x) }
+    copyrights = pointer_array_with(*copyrights)
+    tracks     = pointer_array_with(mock_track, mock_track_two)
+    review     = "This album is AWESOME"
+    Spotify.mock_albumbrowse(:ok, mock_album, mock_artist, 2, copyrights, 2, tracks, review, nil, nil)
+  end
+
+  let(:mock_artistbrowse) do
+    artistbrowse = nil
+
+    mock_image_pointer = FFI::MemoryPointer.from_string(mock_image_id)
+    similar_artists    = pointer_array_with(mock_artist, mock_artist_two)
+    portraits = pointer_array_with(mock_image_pointer, mock_image_pointer)
+    tracks    = pointer_array_with(mock_track, mock_track_two)
+    albums    = pointer_array_with(mock_album)
+
+    Spotify.mock_artistbrowse(:ok, mock_artist, portraits.length, portraits, tracks.length, tracks, albums.length, albums, similar_artists.length, similar_artists, "grew up in DA BLOCK", nil, nil)
+  end
+
+  let(:mock_toplistbrowse) do
+    artists = pointer_array_with(mock_artist, mock_artist_two)
+    albums  = pointer_array_with(mock_album)
+    tracks  = pointer_array_with(mock_track, mock_track_two)
+    Spotify.mock_toplistbrowse(:ok, artists.length, artists, albums.length, albums, tracks.length, tracks)
+  end
+
+  let(:mock_search) do
+    artists = pointer_array_with(mock_artist, mock_artist_two)
+    albums  = pointer_array_with(mock_album)
+    tracks  = pointer_array_with(mock_track, mock_track_two)
+
+    Spotify.mock_search(:ok, "my query", "another thing", 1337, tracks.length, tracks, 42, albums.length, albums, 81104, artists.length, artists, nil, nil)
   end
 
   let(:mock_image_hex) { "3ad93423add99766e02d563605c6e76ed2b0e450" }
-  let(:mock_image_id)  { ":\xD94#\xAD\xD9\x97f\xE0-V6\x05\xC6\xE7n\xD2\xB0\xE4P" }
+  let(:mock_image_id)  { ":\xD94#\xAD\xD9\x97f\xE0-V6\x05\xC6\xE7n\xD2\xB0\xE4P".force_encoding("BINARY") }
   let(:null_pointer)   { FFI::Pointer.new(0) }
+
+  let(:mock_offline_sync_status) do
+    sync = Spotify::OfflineSyncStatus.new
+    mock_offline_sync_status_hash.each_pair do |key, value|
+      sync[key] = value
+    end
+    sync
+  end
+
+  let(:mock_offline_sync_status_hash) do
+    {
+      :queued_tracks => 1,
+      :queued_bytes  => 2,
+      :done_tracks   => 3,
+      :done_bytes    => 4,
+      :copied_tracks => 5,
+      :copied_bytes  => 6,
+      :error_tracks  => 8,
+      :syncing       => false,
+      :willnotcopy_tracks => 7
+    }
+  end
+
+  let(:mock_session_object) do
+    session = Hallon::Session.send(:allocate)
+    friends = pointer_array_with(mock_user)
+    sstatus = mock_offline_sync_status
+    session.instance_eval do
+      @pointer = Spotify.mock_session(nil, :undefined, friends.length, friends, 60 * 60 * 24 * 30, sstatus, 7, 3)
+    end
+    session
+  end
+end
+
+RSpec::Core::ExampleGroup.new.instance_eval do
+  Spotify.registry_add 'spotify:track:7N2Vc8u56VGA4KUrGbikC2', mock_track
+  Spotify.registry_add 'spotify:user:burgestrand', mock_user
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hallon
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.8.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,33 +9,33 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-07-27 00:00:00.000000000Z
+date: 2011-10-01 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: spotify
-  requirement: &2156138200 !ruby/object:Gem::Requirement
+  requirement: &2156044680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 8.0.5
+        version: 9.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *2156138200
+  version_requirements: *2156044680
 - !ruby/object:Gem::Dependency
-  name: mockspotify
-  requirement: &2156137500 !ruby/object:Gem::Requirement
+  name: bundler
+  requirement: &2156043420 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.1.8
+        version: '1.0'
   type: :development
   prerelease: false
-  version_requirements: *2156137500
+  version_requirements: *2156043420
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &2156136740 !ruby/object:Gem::Requirement
+  requirement: &2156041620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: '0.8'
   type: :development
   prerelease: false
-  version_requirements: *2156136740
+  version_requirements: *2156041620
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2156136060 !ruby/object:Gem::Requirement
+  requirement: &2156039900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: '2'
   type: :development
   prerelease: false
-  version_requirements: *2156136060
+  version_requirements: *2156039900
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &2156135380 !ruby/object:Gem::Requirement
+  requirement: &2156038000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2156135380
+  version_requirements: *2156038000
 - !ruby/object:Gem::Dependency
   name: rdiscount
-  requirement: &2156134600 !ruby/object:Gem::Requirement
+  requirement: &2156036440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,7 +76,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2156134600
+  version_requirements: *2156036440
 description: 
 email: kim@burgestrand.se
 executables: []
@@ -86,7 +86,9 @@ files:
 - .autotest
 - .gemtest
 - .gitignore
+- .gitmodules
 - .rspec
+- .travis.yml
 - .yardopts
 - CHANGELOG
 - Gemfile
@@ -97,26 +99,37 @@ files:
 - Termfile
 - examples/logging_in.rb
 - examples/printing_link_information.rb
+- examples/show_published_playlists_of_user.rb
 - hallon.gemspec
 - lib/hallon.rb
 - lib/hallon/album.rb
+- lib/hallon/album_browse.rb
+- lib/hallon/artist.rb
+- lib/hallon/artist_browse.rb
 - lib/hallon/base.rb
+- lib/hallon/enumerator.rb
 - lib/hallon/error.rb
 - lib/hallon/ext/ffi.rb
-- lib/hallon/ext/object.rb
 - lib/hallon/ext/spotify.rb
 - lib/hallon/image.rb
 - lib/hallon/link.rb
 - lib/hallon/linkable.rb
 - lib/hallon/observable.rb
+- lib/hallon/player.rb
+- lib/hallon/search.rb
 - lib/hallon/session.rb
 - lib/hallon/synchronizable.rb
+- lib/hallon/toplist.rb
 - lib/hallon/track.rb
 - lib/hallon/user.rb
 - lib/hallon/version.rb
 - spec/fixtures/example_uris.rb
 - spec/fixtures/pink_cover.jpg
+- spec/hallon/album_browse_spec.rb
 - spec/hallon/album_spec.rb
+- spec/hallon/artist_browse_spec.rb
+- spec/hallon/artist_spec.rb
+- spec/hallon/enumerator_spec.rb
 - spec/hallon/error_spec.rb
 - spec/hallon/ffi_spec.rb
 - spec/hallon/hallon_spec.rb
@@ -124,19 +137,47 @@ files:
 - spec/hallon/link_spec.rb
 - spec/hallon/linkable_spec.rb
 - spec/hallon/observable_spec.rb
+- spec/hallon/player_spec.rb
+- spec/hallon/search_spec.rb
 - spec/hallon/session_spec.rb
 - spec/hallon/synchronizable_spec.rb
+- spec/hallon/toplist_spec.rb
 - spec/hallon/track_spec.rb
 - spec/hallon/user_spec.rb
+- spec/mockspotify.rb
+- spec/mockspotify/.gitignore
+- spec/mockspotify/extconf.rb
+- spec/mockspotify/mockspotify_spec.rb
 - spec/spec_helper.rb
 - spec/support/.gitkeep
 - spec/support/common_objects.rb
 - spec/support/context_logged_in.rb
 - spec/support/cover_me.rb
 - spec/support/shared_for_loadable_objects.rb
+- spec/mockspotify/libmockspotify/src/Makefile.am
+- spec/mockspotify/libmockspotify/src/album.c
+- spec/mockspotify/libmockspotify/src/albumbrowse.c
+- spec/mockspotify/libmockspotify/src/artist.c
+- spec/mockspotify/libmockspotify/src/artistbrowse.c
+- spec/mockspotify/libmockspotify/src/error.c
+- spec/mockspotify/libmockspotify/src/image.c
+- spec/mockspotify/libmockspotify/src/libmockspotify.c
+- spec/mockspotify/libmockspotify/src/libmockspotify.h
+- spec/mockspotify/libmockspotify/src/libspotify/api.h
+- spec/mockspotify/libmockspotify/src/link.c
+- spec/mockspotify/libmockspotify/src/player.c
+- spec/mockspotify/libmockspotify/src/playlist.c
+- spec/mockspotify/libmockspotify/src/playlistcontainer.c
+- spec/mockspotify/libmockspotify/src/search.c
+- spec/mockspotify/libmockspotify/src/session.c
+- spec/mockspotify/libmockspotify/src/toplistbrowse.c
+- spec/mockspotify/libmockspotify/src/track.c
+- spec/mockspotify/libmockspotify/src/user.c
+- spec/mockspotify/libmockspotify/src/util.c
+- spec/mockspotify/libmockspotify/src/util.h
 homepage: http://github.com/Burgestrand/Hallon
 licenses:
-- GNU AGPL
+- X11 License
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -155,14 +196,18 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.5
+rubygems_version: 1.8.6
 signing_key: 
 specification_version: 3
 summary: Delicious Ruby bindings to the official Spotify API
 test_files:
 - spec/fixtures/example_uris.rb
 - spec/fixtures/pink_cover.jpg
+- spec/hallon/album_browse_spec.rb
 - spec/hallon/album_spec.rb
+- spec/hallon/artist_browse_spec.rb
+- spec/hallon/artist_spec.rb
+- spec/hallon/enumerator_spec.rb
 - spec/hallon/error_spec.rb
 - spec/hallon/ffi_spec.rb
 - spec/hallon/hallon_spec.rb
@@ -170,10 +215,17 @@ test_files:
 - spec/hallon/link_spec.rb
 - spec/hallon/linkable_spec.rb
 - spec/hallon/observable_spec.rb
+- spec/hallon/player_spec.rb
+- spec/hallon/search_spec.rb
 - spec/hallon/session_spec.rb
 - spec/hallon/synchronizable_spec.rb
+- spec/hallon/toplist_spec.rb
 - spec/hallon/track_spec.rb
 - spec/hallon/user_spec.rb
+- spec/mockspotify.rb
+- spec/mockspotify/.gitignore
+- spec/mockspotify/extconf.rb
+- spec/mockspotify/mockspotify_spec.rb
 - spec/spec_helper.rb
 - spec/support/.gitkeep
 - spec/support/common_objects.rb