hallon 0.2.1 → 0.3.0

data/CHANGELOG

@@ -1,6 +1,13 @@
 Hallon’s Changelog
 ==================
 
+v0.3.0
+------------------
+- Don’t use bundler for :spec and :test rake tasks
+- Add Error.table
+- Add Track subsystem
+- Fix spec:cov and spotify:coverage rake tasks
+
 v0.2.1
 ------------------
 - Fix compatibility with v1.8

data/QUIRKS

@@ -1,5 +1,9 @@
 # Quirks, oddities and general notes about libspotify
 
+- HTTP links with track offset (spotify:track:7N2Vc8u56VGA4KUrGbikC2#1:40) don’t
+  work, even if you URL encode the hash: http://open.spotify.com/track/7N2Vc8u56VGA4KUrGbikC2%231:40
+  this appears to have worked at least 7 months ago
+
 ## Session
 - `sp_session_release` will segfault (rare)
 - `login` callback fires even if the login fails; instead,
@@ -9,3 +13,6 @@
 
 ## Link
 - segfaults if created before a session
+
+## Track
+- `sp_link_as_track_and_offset` operate in milliseconds, but documentation states seconds

data/README.markdown

@@ -1,5 +1,8 @@
 What is Hallon?
 ===============
+
+> [Hallon, delicious Ruby bindings for libspotify](http://burgestrand.se/articles/hallon-delicious-ruby-bindings-to-libspotify.html)
+
 We rubyists have this awesome [spotify gem][] allowing us to use [libspotify][] from within Ruby, but it has a significant drawback: the `libspotify` API is very hard to use. Now, we can’t have that, so what do we do? We make Hallon!
 
 Hallon is Swedish for “Raspberry”, and has been written to satisfy my needs for API simplicity. It provides you with a wrapper around the spotify gem, making the experience of using `libspotify` from Ruby much more enjoyable.

data/Rakefile

@@ -9,11 +9,12 @@ YARD::Rake::YardocTask.new
 
 require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new('spec') do |task|
+  task.skip_bundler = true
   task.ruby_opts = '-W2'
 end
 
 desc "Run the full test suite and generate a coverage report"
-task 'spec:cov' => ['clean', 'spec:full'] do
+task 'spec:cov' => ['clean', 'spec'] do
   require 'cover_me'
   require './spec/support/cover_me'
 
@@ -26,9 +27,21 @@ task 'spotify:coverage' do
   require 'set'
   require 'spotify'
 
-  methods = Spotify.methods(false).map(&:to_s)
+  dynamicly_used = []
+  dynamicly_used << "link_create_from_track" # lib/hallon/track.rb
+  dynamicly_used << "track_add_ref"          # lib/ext/spotify.rb
+  dynamicly_used << "track_release"          # lib/ext/spotify.rb
+  dynamicly_used << "link_create_from_image" # lib/hallon/image.rb
+  dynamicly_used << "image_release"          # lib/ext/spotify.rb
+  dynamicly_used << "link_create_from_user"  # lib/hallon/user.rb
+  dynamicly_used << "user_add_ref"           # lib/ext/spotify.rb
+  dynamicly_used << "user_release"           # lib/ext/spotify.rb
+  dynamicly_used << "link_as_track"          # IGNORE
+  dynamicly_used << "link_release"           # lib/ext/spotify.rb
+
+  methods = Spotify.methods(false).map(&:to_s) - dynamicly_used
   covered = Set.new(methods)
-  matcher = /Spotify::([\w_]+)[ \(]/
+  matcher = /Spotify(?:::|\.)([\w_]+)[ \(]/
 
   FileList['lib/**/*.rb'].each do |file|
     File.read(file).scan(matcher) { |method, _| covered.delete(method) }

data/examples/logging_in.rb

@@ -9,18 +9,10 @@ session = Hallon::Session.instance IO.read(ENV['HALLON_APPKEY']) do
 end
 
 session.login ENV['HALLON_USERNAME'], ENV['HALLON_PASSWORD']
-logged_in  = session.process_events_on(:logged_in) { |error| error }
 
-unless logged_in == :ok
-  abort "[ERROR] (:logged_in) #{Hallon::Error.explain(logged_in)}"
-end
-
-conn_error = session.process_events_on(:connection_error) do |error|
-  session.logged_in? or error
-end
-
-unless conn_error == true
-  abort "[ERROR] (:connection_error) #{Hallon::Error.explain(conn_error)}"
+session.process_events_on(:logged_in) { |error| Hallon::Error.maybe_raise(error) }
+session.process_events_on(:connection_error) do |error|
+  session.logged_in? or Hallon::Error.maybe_raise(error)
 end
 
 puts "Successfully logged in!"

data/hallon.gemspec

@@ -19,7 +19,7 @@ Gem::Specification.new do |gem|
   gem.required_ruby_version = '~> 1.8'
 
   gem.add_dependency 'spotify', '~> 8.0.5'
-  gem.add_development_dependency 'mockspotify', '~> 0.1.4'
+  gem.add_development_dependency 'mockspotify', '~> 0.1.7'
   gem.add_development_dependency 'rake', '~> 0.8'
   gem.add_development_dependency 'rspec', '~> 2'
   gem.add_development_dependency 'autotest-standalone'

data/lib/hallon.rb

@@ -14,6 +14,7 @@ require 'hallon/session'
 require 'hallon/link'
 require 'hallon/user'
 require 'hallon/image'
+require 'hallon/track'
 
 # The Hallon module wraps around all Hallon objects to avoid polluting
 # the global namespace. To start using Hallon, you most likely want to

data/lib/hallon/error.rb

@@ -5,6 +5,13 @@ module Hallon
   # @see http://developer.spotify.com/en/libspotify/docs/group__error.html
   class Error < RuntimeError
     class << self
+      # Hash of error (Symbol) to code (Integer).
+      #
+      # @return [Hash<Symbol, Integer>]
+      def table
+        Spotify::enum_type(:error).to_hash
+      end
+
       # Given a number or a symbol, find both the symbol and the error
       # number it represents.
       #

data/lib/hallon/ext/object.rb

@@ -1,11 +1,14 @@
+# Extension of Object for Ruby 1.8 compatibility.
 class Object
-  unless defined?(singleton_class)
+  unless method_defined?(:singleton_class)
+    # Singleton class of object.
     def singleton_class
       class << self; self; end
     end
   end
 
   unless method_defined?(:define_singleton_method)
+    # Defines a method on the singleton class of object.
     def define_singleton_method(*args, &b)
       singleton_class.send(:define_method, *args, &b)
     end

data/lib/hallon/linkable.rb

@@ -44,7 +44,9 @@ module Hallon
         Hallon::Link.new(link)
       end
 
-      define_method(:to_link) { |*args, &block| self.class.to_link(@pointer, *args, &block) }
+      define_method(:to_link) do |*args, &block|
+        self.class.to_link(@pointer, *args, &block)
+      end
     end
   end
 end

data/lib/hallon/track.rb

@@ -0,0 +1,120 @@
+# coding: utf-8
+module Hallon
+  # Tracks are an essential part to the Spotify service. They
+  # are browsable entities that can also be played by streaming.
+  #
+  # @see http://developer.spotify.com/en/libspotify/docs/group__track.html
+  class Track
+    extend Linkable
+
+    from_link(:track) { |link, ptr| Spotify.link_as_track_and_offset(link, ptr) }
+    to_link(:track)
+
+    # Create a Link to the current track and offset in seconds.
+    #
+    # @param [Float] offset offset into track in seconds
+    # @return [Hallon::Link]
+    def to_link(offset = offset)
+      self.class.to_link(@pointer, (offset * 1000).to_i)
+    end
+
+    # Offset into track in seconds this track was created with.
+    #
+    # @return [Rational]
+    attr_reader :offset
+
+    # Underlying Spotify pointer.
+    #
+    # @private
+    # @return [FFI::Pointer]
+    attr_reader :pointer
+
+    # Construct a new Track instance.
+    #
+    # @param [String, Link, FFI::Pointer] link
+    def initialize(link)
+      FFI::MemoryPointer.new(:int) do |ptr|
+        @pointer = Spotify::Pointer.new from_link(link, ptr), :track, true
+        @offset  = Rational(ptr.read_int, 1000)
+      end
+    end
+
+    # Create a new local track.
+    #
+    # @param [String] title
+    # @param [String] artist
+    # @param [String] album
+    # @param [Integer] length
+    # @return [Track]
+    def self.local(title, artist, album = nil, length = nil)
+      track = Spotify.localtrack_create(artist, title, album || "", length || -1)
+      new(track)
+    end
+
+    # @note This’ll be an empty string unless the track is loaded.
+    # @return [String]
+    def name
+      Spotify.track_name(@pointer)
+    end
+
+    # Duration of the track in seconds.
+    #
+    # @note This’ll be `0` unless the track is loaded.
+    # @return [Rational]
+    def duration
+      Rational(Spotify.track_duration(@pointer), 1000)
+    end
+
+    # Track popularity, between 0 and 1.
+    #
+    # @note This’ll be `0` unless the track is loaded.
+    # @return [Rational]
+    def popularity
+      Rational(Spotify.track_popularity(@pointer), 100)
+    end
+
+    # Disc number this track appears in.
+    #
+    # @note This function is a bit special. See libspotify docs for details.
+    def disc
+      Spotify.track_disc(@pointer)
+    end
+
+    # Position of track on its’ disc.
+    #
+    # @note This function is a bit special. See libspotify docs for details.
+    def index
+      Spotify.track_index(@pointer)
+    end
+
+    # Retrieve track error status.
+    #
+    # @return [Symbol]
+    def status
+      Spotify.track_error(@pointer)
+    end
+
+    # True if the track is loaded
+    #
+    # @return [Boolean]
+    def loaded?
+      Spotify.track_is_loaded(@pointer)
+    end
+
+    # Album this track belongs to.
+    #
+    # @note This’ll be `nil` unless the track is loaded.
+    # @return [Hallon::Album]
+    def album
+      album = Spotify.track_album(@pointer)
+      Hallon::Album.new(album) unless album.null?
+    end
+
+    # TODO: available?(session)
+    # TODO: local?(session)
+    # TODO: autolinked?(session)
+    # TODO: starred?(session)
+    # TODO: starred = true (session, array of tracks)
+    # TODO: artists (count, by index)
+  end
+end

data/lib/hallon/version.rb

@@ -3,5 +3,5 @@ module Hallon
   # Current release version of Hallon
   #
   # @see http://semver.org/
-  VERSION = [0, 2, 1].join('.')
+  VERSION = [0, 3, 0].join('.')
 end

data/spec/fixtures/example_uris.rb

@@ -7,5 +7,6 @@ def example_uris
     "spotify:user:burgestrand:playlist:4nQnbGi4kALbME9csEqdW2" => :playlist,
     "spotify:user:burgestrand" => :profile,
     "spotify:user:burgestrand:starred" => :starred,
+    "spotify:track:7N2Vc8u56VGA4KUrGbikC2#1:40" => :track
   }
 end

data/spec/hallon/error_spec.rb

@@ -36,4 +36,10 @@ describe Hallon::Error do
       subject.maybe_raise(0).should eq :ok
     end
   end
+
+  describe "::table" do
+    it "should return a hash of symbol to integer" do
+      Hallon::Error.table[:ok].should eq 0
+    end
+  end
 end

data/spec/hallon/track_spec.rb

@@ -0,0 +1,89 @@
+# coding: utf-8
+describe Hallon::Track, :session => true do
+  let(:artist) { Spotify.mock_artist("Artist", true) }
+  let(:album)  { Spotify.mock_album("Album", artist, 2011, nil, :unknown, true, true) }
+
+  subject do
+    artists = FFI::MemoryPointer.new(:pointer)
+    artists.write_pointer artist
+
+    track = Spotify.mock_track(
+      "Elucteene", # name
+      1, artists, # num_artists, artists
+      album, # album
+      123_456, # duration
+      42,  # popularity
+      2, 7, # disc, index
+      0, true  # error, loaded
+    )
+
+    artists.free
+
+    Hallon::Track.new(track)
+  end
+
+  its(:name)   { should eq "Elucteene" }
+  its(:disc)   { should be 2 }
+  its(:index)  { should be 7 }
+  its(:status) { should be :ok }
+
+  its(:duration) { should eq 123.456 }
+  its(:popularity) { should eq 0.42 }
+
+  xit("artist.name") { should eq "Artist" }
+  xit("album.name")  { should eq "Album"  }
+
+  it { should be_loaded }
+
+  describe "album" do
+    it "should be an album when there is one" do
+
+    end
+
+    it "should be nil when there isn’t one" do
+      Spotify.should_receive(:track_album).and_return(FFI::Pointer.new(0))
+
+      subject.album.should be_nil
+    end
+  end
+
+  describe "to_link" do
+    it "should pass the current offset by default" do
+      subject.should_receive(:offset).and_return(10)
+      described_class.should_receive(:to_link).with(subject.pointer, 10_000)
+
+      subject.to_link
+    end
+
+    it "should accept offset as parameter" do
+      subject.should_not_receive(:offset)
+      described_class.should_receive(:to_link).with(subject.pointer, 1_337_000)
+
+      subject.to_link(1337)
+    end
+  end
+
+  describe "offset" do
+    let(:without_offset) { 'spotify:track:7N2Vc8u56VGA4KUrGbikC2' }
+    let(:with_offset) { without_offset + '#1:00' }
+
+    specify "with offset" do
+      Hallon::Track.new(with_offset).offset.should eq 60
+    end
+
+    specify "without offset" do
+      Hallon::Track.new(without_offset).offset.should eq 0
+    end
+  end
+
+  describe "a local track" do
+    subject do
+      Hallon::Track.local "Title", "Artist", "Coolio", 100
+    end
+
+    its(:name) { should eq "Title" }
+    pending("artist.name") { should eq "Artist" }
+    pending("album.name") { should eq "Album" }
+    its(:duration) { should eq 0.1 }
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hallon
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-07-22 00:00:00.000000000Z
+date: 2011-07-25 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: spotify
-  requirement: &2157240440 !ruby/object:Gem::Requirement
+  requirement: &2161051120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,21 +21,21 @@ dependencies:
         version: 8.0.5
   type: :runtime
   prerelease: false
-  version_requirements: *2157240440
+  version_requirements: *2161051120
 - !ruby/object:Gem::Dependency
   name: mockspotify
-  requirement: &2157239880 !ruby/object:Gem::Requirement
+  requirement: &2161050620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.1.4
+        version: 0.1.7
   type: :development
   prerelease: false
-  version_requirements: *2157239880
+  version_requirements: *2161050620
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &2157239180 !ruby/object:Gem::Requirement
+  requirement: &2161050020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: '0.8'
   type: :development
   prerelease: false
-  version_requirements: *2157239180
+  version_requirements: *2161050020
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2157232320 !ruby/object:Gem::Requirement
+  requirement: &2161049380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: '2'
   type: :development
   prerelease: false
-  version_requirements: *2157232320
+  version_requirements: *2161049380
 - !ruby/object:Gem::Dependency
   name: autotest-standalone
-  requirement: &2157231660 !ruby/object:Gem::Requirement
+  requirement: &2161048660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2157231660
+  version_requirements: *2161048660
 - !ruby/object:Gem::Dependency
   name: autotest-growl
-  requirement: &2157230760 !ruby/object:Gem::Requirement
+  requirement: &2161047680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2157230760
+  version_requirements: *2161047680
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &2157230240 !ruby/object:Gem::Requirement
+  requirement: &2161046920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,10 +87,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2157230240
+  version_requirements: *2161046920
 - !ruby/object:Gem::Dependency
   name: rdiscount
-  requirement: &2157229660 !ruby/object:Gem::Requirement
+  requirement: &2161044780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -98,7 +98,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2157229660
+  version_requirements: *2161044780
 description: 
 email: kim@burgestrand.se
 executables: []
@@ -131,6 +131,7 @@ files:
 - lib/hallon/observable.rb
 - lib/hallon/session.rb
 - lib/hallon/synchronizable.rb
+- lib/hallon/track.rb
 - lib/hallon/user.rb
 - lib/hallon/version.rb
 - spec/fixtures/example_uris.rb
@@ -144,6 +145,7 @@ files:
 - spec/hallon/observable_spec.rb
 - spec/hallon/session_spec.rb
 - spec/hallon/synchronizable_spec.rb
+- spec/hallon/track_spec.rb
 - spec/hallon/user_spec.rb
 - spec/spec_helper.rb
 - spec/support/.gitkeep
@@ -187,6 +189,7 @@ test_files:
 - spec/hallon/observable_spec.rb
 - spec/hallon/session_spec.rb
 - spec/hallon/synchronizable_spec.rb
+- spec/hallon/track_spec.rb
 - spec/hallon/user_spec.rb
 - spec/spec_helper.rb
 - spec/support/.gitkeep