hallon 0.1.1 → 0.2.0

data/Rakefile

@@ -8,21 +8,7 @@ require 'yard'
 YARD::Rake::YardocTask.new
 
 require 'rspec/core/rake_task'
-
-desc "Run all specs (even those requiring logging in to Spotify)"
-RSpec::Core::RakeTask.new('spec:full')
-
-desc "Run all specs like spec:full, but with debug mode and full warnings enabled"
-RSpec::Core::RakeTask.new('spec:debug') do |task|
-  task.skip_bundler = true
-  task.ruby_opts    = '-d -W2'
-end
-
-desc "Run all offline specs"
-RSpec::Core::RakeTask.new('spec') do |task|
-  task.pattern = 'spec/hallon/*_spec.rb'
-  task.rspec_opts = '--tag ~logged_in'
-end
+RSpec::Core::RakeTask.new('spec')
 
 desc "Run the full test suite and generate a coverage report"
 task 'spec:cov' => ['clean', 'spec:full'] do

data/hallon.gemspec

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

data/lib/hallon/error.rb

@@ -40,14 +40,13 @@ module Hallon
       # @return [nil]
       def maybe_raise(error)
         error, symbol = disambiguate(error)
+        return symbol if symbol == :ok
 
-        unless symbol == :ok
-          message = []
-          message << "[#{symbol.upcase}]"
-          message << explain(error)
-          message << "(#{error})"
-          raise Hallon::Error, message.join(' ')
-        end
+        message = []
+        message << "[#{symbol.upcase}]"
+        message << explain(error)
+        message << "(#{error})"
+        raise Hallon::Error, message.join(' ')
       end
     end
   end

data/lib/hallon/session.rb

@@ -121,6 +121,7 @@ module Hallon
         end
       end
     end
+    alias :wait_for :process_events_on
 
     # Log into Spotify using the given credentials.
     #

data/lib/hallon/version.rb

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

data/spec/fixtures/example_uris.rb

@@ -8,4 +8,4 @@ def example_uris
     "spotify:user:burgestrand" => :profile,
     "spotify:user:burgestrand:starred" => :starred,
   }
-end
+end

data/spec/hallon/error_spec.rb

@@ -1,30 +1,39 @@
 describe Hallon::Error do
   subject { described_class }
-  
+
   it { should <= RuntimeError }
-  
+
   describe "::disambiguate" do
     it "should not fail on invalid numbers" do
       subject.disambiguate(10000).should eq [-1, nil]
     end
-    
+
     it "should not fail on invalid symbols" do
       subject.disambiguate(:fail).should eq [-1, nil]
     end
   end
-  
+
   describe "::explain" do
-    it { subject.explain(0).should eq 'No error' }
-    it { subject.explain(-1).should eq 'invalid error code' }
+    it "should work properly given an integer" do
+      subject.explain(0).should eq 'sp_error: 0'
+    end
+
+    it "should work properly given a symbol" do
+      subject.explain(:bad_api_version).should eq 'sp_error: 1'
+    end
   end
-  
+
   describe "::maybe_raise" do
     it "should not raise error when given 0 as error code" do
       expect { subject.maybe_raise(0) }.to_not raise_error
     end
-    
+
     it "should raise error when given non-0 as error code" do
       expect { subject.maybe_raise(1) }.to raise_error(Hallon::Error)
     end
+
+    it "should return the error symbol if it's ok" do
+      subject.maybe_raise(0).should eq :ok
+    end
   end
-end
+end

data/spec/hallon/hallon_spec.rb

@@ -1,6 +1,6 @@
 describe Hallon do
   describe "VERSION" do
-    specify { Hallon::VERSION.should == "0.0.0" }
+    specify { Hallon::VERSION.should be_a String }
   end
 
   describe "API_VERSION" do

data/spec/hallon/image_spec.rb

@@ -1,37 +1,44 @@
 # coding: utf-8
-describe Hallon::Image, :logged_in => true do
-  context "created from a Spotify URI" do
-    before(:all) do
-      @uri   = "spotify:image:3ad93423add99766e02d563605c6e76ed2b0e450"
-      @image = Hallon::Image.new @uri
-      @image.status.should eq :is_loading
-      session.process_events_on { @image.loaded? }
-    end
+require 'ostruct'
 
-    subject { @image }
+describe Hallon::Image, :session => true do
+  let(:session) { double.stub(:pointer).and_return(nil) }
+  let(:image) do
+    Hallon::Session.should_receive(:instance).and_return double.stub(:pointer => nil)
 
-    its(:status) { should be :ok }
-    its(:format) { should be :jpeg }
+    image = Spotify.mock_image(
+      "3ad93423add99766e02d563605c6e76ed2b0e450".gsub(/../) { |x| x.to_i(16).chr },
+      :jpeg,
+      File.size(fixture_image_path),
+      File.read(fixture_image_path),
+      :ok
+    )
 
-    specify "its #id should match its’ spotify uri" do
-      @uri.should match @image.id
-    end
+    Hallon::Image.new(image)
+  end
+
+  subject { image }
 
-    describe "#data" do
-      it "should correspond to the fixture image" do
-        @image.data.should eq File.read(fixture_image_path, :encoding => 'binary')
-      end
+  its(:status) { should be :ok }
+  its(:format) { should be :jpeg }
+  its(:id) { should eq "3ad93423add99766e02d563605c6e76ed2b0e450" }
 
-      it "should have a binary encoding" do
-        @image.data.encoding.name.should eq 'ASCII-8BIT'
-      end
+  describe "#data" do
+    it "should correspond to the fixture image" do
+      image.data.should eq File.read(fixture_image_path, :encoding => 'binary')
+    end
+
+    it "should have a binary encoding" do
+      image.data.encoding.name.should eq 'ASCII-8BIT'
     end
   end
 
   describe "callbacks" do
     it "should trigger :load when loaded" do
+      pending "waiting for mockspotify event system"
+
       uri = "spotify:image:c78f091482e555bd2ffacfcd9cbdc0714b221663"
-      image = Hallon::Image.new(uri)
+      image = Hallon::Image.new(uri, session)
       image.should_not be_loaded
       image.should_receive(:trigger).with(:load).once
 

data/spec/hallon/link_spec.rb

@@ -1,4 +1,4 @@
-describe Hallon::Link, :session => true do
+describe Hallon::Link do
   subject { Hallon::Link.new("spotify:user:burgestrand") }
 
   context "class methods" do

data/spec/hallon/session_spec.rb

@@ -1,5 +1,26 @@
+# coding: utf-8
 describe Hallon::Session do
-  include_context "initialized session"
+  it { Hallon::Session.should_not respond_to :new }
+
+  describe "#instance" do
+    it "should require an application key" do
+      expect { Hallon::Session.send(:new) }.to raise_error(ArgumentError)
+    end
+  end
+
+  describe "#new" do
+    it "should fail on an invalid application key" do
+      expect { create_session(false) }.to raise_error(Hallon::Error, /BAD_APPLICATION_KEY/)
+    end
+
+    it "should fail on a small user-agent of multibyte chars (> 255 characters)" do
+      expect { create_session(true, :user_agent => 'ö' * 128) }.to raise_error(ArgumentError)
+    end
+
+    it "should fail on a huge user agent (> 255 characters)" do
+      expect { create_session(true, :user_agent => 'a' * 256) }.to raise_error(ArgumentError)
+    end
+  end
 
   describe "options" do
     subject { session.options }
@@ -54,7 +75,7 @@ describe Hallon::Session do
 
     describe "#relation_type?" do
       it "should retrieve the relation between the current user and given user" do
-        session.relation_type?(session.user).should eq :unknown
+        session.relation_type?(session.user).should eq :none
       end
     end
   end

data/spec/hallon/user_spec.rb

@@ -28,34 +28,34 @@ describe Hallon::User do
   end
 
   describe "an instance", :logged_in => true do
-    let(:link) { Hallon::Link.new("spotify:user:burgestrand") }
-    let(:user) { Hallon::User.new(link) }
-    subject { user }
-
-    before(:all) do
-      session.process_events_on(:userinfo_updated) { user.loaded? }
+    let(:user) do
+      user = Spotify.mock_user(
+        "burgestrand", "Burgestrand", "Kim Burgestrand",
+        "https://secure.gravatar.com/avatar/b67b73b5b1fd84119ec788b1c3df02ad",
+        :none, true
+      )
+      Hallon::User.new(user)
     end
 
+    subject { user }
+
     describe "#to_link" do
       it "should return a Link for this user" do
-        user.to_link.should eq link
+        user.to_link.should eq "spotify:user:burgestrand"
       end
     end
 
     describe "#name" do
       it "should be able to get the display name" do
-        Spotify.should_receive(:user_display_name)
-        user.name(:display).should be_a String
+        user.name(:display).should eq "Burgestrand"
       end
 
       it "should be able to get the full name" do
-        Spotify.should_receive(:user_full_name)
-        user.name(:full).should be_a String
+        user.name(:full).should eq "Kim Burgestrand"
       end
 
       it "should get the canonical name when unspecified" do
-        Spotify.should_receive(:user_canonical_name)
-        user.name.should be_a String
+        user.name.should eq "burgestrand"
       end
 
       it "should fail on invalid name types" do
@@ -65,8 +65,7 @@ describe Hallon::User do
 
     describe "#picture" do
       it "should retrieve the user picture" do
-        Spotify.should_receive(:user_picture)
-        user.picture.should be_a String
+        user.picture.should eq "https://secure.gravatar.com/avatar/b67b73b5b1fd84119ec788b1c3df02ad"
       end
     end
   end

data/spec/spec_helper.rb

@@ -1,4 +1,5 @@
 # coding: utf-8
+require 'mockspotify'
 require 'hallon'
 
 # Bail on failure
@@ -7,65 +8,28 @@ Thread.abort_on_exception = true
 RSpec.configure do |config|
   config.treat_symbols_as_metadata_keys_with_true_values = true
 
-  def options
+  def fixture_image_path
+    File.expand_path('../fixtures/pink_cover.jpg', __FILE__)
+  end
+
+  def create_session(valid_appkey = true, options = options)
+    appkey = valid_appkey ? 'appkey_good' : 'appkey_bad'
+    Hallon::Session.send(:new, appkey, options)
+  end
+end
+
+RSpec::Core::ExampleGroup.instance_eval do
+  let(:options) do
     {
       :user_agent => "Hallon (rspec)",
       :settings_path => "tmp",
-      :cache_path => "tmp/cache"
+      :cache_path => ""
     }
   end
 
-  def session
-    @session ||= Hallon::Session.instance(Hallon::APPKEY, options)
-  end
-
-  def fixture_image_path
-    File.expand_path('../fixtures/pink_cover.jpg', __FILE__)
-  end
+  let(:session) { create_session }
 end
 
 # Requires supporting files in ./support/ and ./fixtures/
 Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
 Dir["#{File.dirname(__FILE__)}/fixtures/**/*.rb"].each {|f| require f}
-
-unless ENV.values_at(*%w(HALLON_APPKEY HALLON_USERNAME HALLON_PASSWORD)).all?
-  abort <<-ERROR
-    You must supply a valid Spotify username, password and application
-    key in order to run Hallons specs. This is done by setting these
-    environment variables:
-
-    - HALLON_APPKEY (path to spotify_appkey.key)
-    - HALLON_USERNAME (your spotify username)
-    - HALLON_PASSWORD (your spotify password)
-  ERROR
-end
-
-module Hallon
-  APPKEY ||= IO.read File.expand_path(ENV['HALLON_APPKEY'])
-end
-
-# Hallon::Session#instance requires that a Session object have not been created
-# so test it here instead. This assures it is tested before anything else!
-describe Hallon::Session do
-  it { Hallon::Session.should_not respond_to :new }
-
-  describe "#instance" do
-    it "should require an application key" do
-      expect { Hallon::Session.instance }.to raise_error(ArgumentError)
-    end
-
-    it "should fail on an invalid application key" do
-      expect { Hallon::Session.instance('invalid') }.to raise_error(Hallon::Error, /BAD_APPLICATION_KEY/)
-    end
-
-    it "should fail on a small user-agent of multibyte chars (> 255 characters)" do
-      expect { Hallon::Session.send(:new, Hallon::APPKEY, :user_agent => 'ö' * 128) }.
-        to raise_error(ArgumentError)
-    end
-
-    it "should fail on a huge user agent (> 255 characters)" do
-      expect { Hallon::Session.send(:new, Hallon::APPKEY, :user_agent => 'a' * 256) }.
-        to raise_error(ArgumentError)
-    end
-  end
-end

data/spec/support/context_logged_in.rb

@@ -1,16 +1,11 @@
 shared_context "logged in", :logged_in do
   before(:all) do
-    unless session.logged_in?
-      session.login ENV['HALLON_USERNAME'], ENV['HALLON_PASSWORD']
-      logged_in = session.process_events_on(:logged_in) { |error| error }
-      logged_in.should eq :ok
-
-      finished = session.process_events_on(:connection_error) { |error| session.logged_in? or error }
-      finished.should be_true
-    end
-
+    session.login 'username', 'password'
     session.should be_logged_in
   end
 
-  before(:each) { session.should be_logged_in }
+  after(:all) do
+    session.logout
+    session.should_not be_logged_in
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hallon
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-07-18 00:00:00.000000000Z
+date: 2011-07-21 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: spotify
-  requirement: &2152996240 !ruby/object:Gem::Requirement
+  requirement: &2153174180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,21 @@ dependencies:
         version: 8.0.5
   type: :runtime
   prerelease: false
-  version_requirements: *2152996240
+  version_requirements: *2153174180
+- !ruby/object:Gem::Dependency
+  name: mockspotify
+  requirement: &2153173600 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.2
+  type: :development
+  prerelease: false
+  version_requirements: *2153173600
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &2152995280 !ruby/object:Gem::Requirement
+  requirement: &2153172780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +43,10 @@ dependencies:
         version: '0.8'
   type: :development
   prerelease: false
-  version_requirements: *2152995280
+  version_requirements: *2153172780
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2152994340 !ruby/object:Gem::Requirement
+  requirement: &2153171860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +54,10 @@ dependencies:
         version: '2'
   type: :development
   prerelease: false
-  version_requirements: *2152994340
+  version_requirements: *2153171860
 - !ruby/object:Gem::Dependency
   name: autotest-standalone
-  requirement: &2152993140 !ruby/object:Gem::Requirement
+  requirement: &2153171320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2152993140
+  version_requirements: *2153171320
 - !ruby/object:Gem::Dependency
   name: autotest-growl
-  requirement: &2152992000 !ruby/object:Gem::Requirement
+  requirement: &2153170600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +76,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2152992000
+  version_requirements: *2153170600
 - !ruby/object:Gem::Dependency
   name: cover_me
-  requirement: &2152989700 !ruby/object:Gem::Requirement
+  requirement: &2153169940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +87,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2152989700
+  version_requirements: *2153169940
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &2152979360 !ruby/object:Gem::Requirement
+  requirement: &2153169300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,10 +98,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2152979360
+  version_requirements: *2153169300
 - !ruby/object:Gem::Dependency
   name: rdiscount
-  requirement: &2152978740 !ruby/object:Gem::Requirement
+  requirement: &2153168620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -98,7 +109,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2152978740
+  version_requirements: *2153168620
 description: 
 email: kim@burgestrand.se
 executables: []
@@ -146,7 +157,6 @@ files:
 - spec/hallon/user_spec.rb
 - spec/spec_helper.rb
 - spec/support/.gitkeep
-- spec/support/context_initialized_session.rb
 - spec/support/context_logged_in.rb
 - spec/support/cover_me.rb
 - spec/support/shared_for_loadable_objects.rb
@@ -190,7 +200,6 @@ test_files:
 - spec/hallon/user_spec.rb
 - spec/spec_helper.rb
 - spec/support/.gitkeep
-- spec/support/context_initialized_session.rb
 - spec/support/context_logged_in.rb
 - spec/support/cover_me.rb
 - spec/support/shared_for_loadable_objects.rb

data/spec/support/context_initialized_session.rb

@@ -1,3 +0,0 @@
-shared_context "initialized session", :session do
-  before(:all) { @session = session }
-end