hallon 0.0.0 → 0.1.0

data/spec/hallon/session_spec.rb

@@ -0,0 +1,61 @@
+describe Hallon::Session do
+  include_context "initialized session"
+
+  describe "options" do
+    subject { session.options }
+    its([:user_agent]) { should == options[:user_agent] }
+    its([:settings_path]) { should == options[:settings_path] }
+    its([:cache_path]) { should == options[:cache_path] }
+
+    its([:load_playlists]) { should == true }
+    its([:compress_playlists]) { should == true }
+    its([:cache_playlist_metadata]) { should == true }
+  end
+
+  describe "#process_events" do
+    it "should return the timeout" do
+      session.process_events.should be_a Fixnum
+    end
+  end
+
+  describe "#process_events_on" do
+    it "should not call given block on :notify_main_thread implicitly" do
+      notified = false
+
+      session.should_receive(:process_events).twice.and_return do
+        unless notified
+          session.trigger(:notify_main_thread, :notify)
+          notified = true
+        else
+          session.trigger(:bogus, :bogus)
+        end
+      end
+
+      session.process_events_on(:bogus) { |e| e.inspect }.should eq ":bogus"
+    end
+
+    it "should time out if waiting for events too long" do
+      session.should_receive(:process_events).once.and_return { session.trigger(:whatever) }
+      session.process_events_on(:whatever) { |e| e.inspect }.should eq "nil"
+    end
+  end
+
+  describe "#logout" do
+    it "should check logged in status" do
+      session.should_receive(:logged_in?).once.and_return(false)
+      expect { session.logout }.to_not raise_error
+    end
+  end
+
+  context "when logged in", :logged_in => true do
+    it "should be logged in" do
+      session.should be_logged_in
+    end
+
+    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
+      end
+    end
+  end
+end

data/spec/hallon/synchronizable_spec.rb

@@ -0,0 +1,19 @@
+describe Hallon::Synchronizable do
+  subject do
+    Class.new { include Hallon::Synchronizable }.new
+  end
+
+  describe "#synchronize" do
+    it "should not deadlock when called recursively in itself" do
+      expect do
+        subject.synchronize { subject.synchronize {} }
+      end.to_not raise_error
+    end
+  end
+
+  describe "#new_cond" do
+    it "should give us a new condition variable" do
+      subject.new_cond.should be_a Monitor::ConditionVariable
+    end
+  end
+end

data/spec/hallon/user_spec.rb

@@ -0,0 +1,73 @@
+# coding: utf-8
+describe Hallon::User do
+  describe ".new" do
+    it "should raise ArgumentError when given an invalid link" do
+      expect { Hallon::User.new("invalid link") }.to raise_error ArgumentError
+    end
+
+    it "should raise ArgumentError when given a non-user link" do
+      expect { Hallon::User.new("spotify:search:moo") }.to raise_error ArgumentError
+    end
+  end
+
+  describe "creating a User", :logged_in => true do
+    context ".new", "from a Spotify URI" do
+      subject { Hallon::User.new("spotify:user:burgestrand") }
+      it_should_behave_like "a loadable object"
+    end
+
+    context ".new", "from a Link" do
+      subject { Hallon::User.new Hallon::Link.new("spotify:user:burgestrand") }
+      it_should_behave_like "a loadable object"
+    end
+
+    context "from Session#user" do
+      subject { session.user }
+      it_should_behave_like "a loadable object"
+    end
+  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? }
+    end
+
+    describe "#to_link" do
+      it "should return a Link for this user" do
+        user.to_link.should eq link
+      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
+      end
+
+      it "should be able to get the full name" do
+        Spotify.should_receive(:user_full_name)
+        user.name(:full).should be_a String
+      end
+
+      it "should get the canonical name when unspecified" do
+        Spotify.should_receive(:user_canonical_name)
+        user.name.should be_a String
+      end
+
+      it "should fail on invalid name types" do
+        expect { user.name(:i_am_invalid) }.to raise_error
+      end
+    end
+
+    describe "#picture" do
+      it "should retrieve the user picture" do
+        Spotify.should_receive(:user_picture)
+        user.picture.should be_a String
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,71 @@
+# coding: utf-8
+require 'hallon'
+
+# Bail on failure
+Thread.abort_on_exception = true
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+
+  def options
+    {
+      :user_agent => "Hallon (rspec)",
+      :settings_path => "tmp",
+      :cache_path => "tmp/cache"
+    }
+  end
+
+  def session
+    @session ||= Hallon::Session.instance(Hallon::APPKEY, options)
+  end
+
+  def fixture_image_path
+    File.expand_path('../fixtures/pink_cover.jpg', __FILE__)
+  end
+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_initialized_session.rb

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

data/spec/support/context_logged_in.rb

@@ -0,0 +1,16 @@
+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.should be_logged_in
+  end
+
+  before(:each) { session.should be_logged_in }
+end

data/spec/support/cover_me.rb

@@ -0,0 +1,5 @@
+CoverMe.config do |c|
+  c.project.root = Dir.pwd
+  c.at_exit      = proc {} # default hook opens coverage/ folder, ANNOYING!
+  c.file_pattern = [%r"#{c.project.root}/lib/.+\.rb"]
+end

data/spec/support/shared_for_loadable_objects.rb

@@ -0,0 +1,7 @@
+shared_examples_for "a loadable object" do
+  before(:all) do
+    session.process_events_on { subject.loaded? }
+  end
+
+  it { should be_loaded }
+end

metadata

@@ -1,143 +1,318 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: hallon
-version: !ruby/object:Gem::Version 
+version: !ruby/object:Gem::Version
+  version: 0.1.0
   prerelease: 
-  version: 0.0.0
 platform: ruby
-authors: 
+authors:
 - Kim Burgestrand
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-03-27 00:00:00 +01:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: ffi
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+date: 2011-07-18 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: spotify
+  requirement: &2153550680 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        version: "1"
+      - !ruby/object:Gem::Version
+        version: 8.0.5
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: rspec
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *2153550680
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &2153548620 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        version: "2"
+      - !ruby/object:Gem::Version
+        version: '0.8'
   type: :development
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: watchr
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: *2153548620
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2153545900 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2'
   type: :development
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: test_notifier
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: *2153545900
+- !ruby/object:Gem::Dependency
+  name: autotest-standalone
+  requirement: &2153545240 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
-  name: simplecov
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  version_requirements: *2153545240
+- !ruby/object:Gem::Dependency
+  name: autotest-growl
+  requirement: &2153543840 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        version: 0.4.0
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id005
-- !ruby/object:Gem::Dependency 
-  name: yard
   prerelease: false
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  version_requirements: *2153543840
+- !ruby/object:Gem::Dependency
+  name: cover_me
+  requirement: &2153542660 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        version: 0.6.4
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id006
-- !ruby/object:Gem::Dependency 
-  name: rdiscount
   prerelease: false
-  requirement: &id007 !ruby/object:Gem::Requirement 
+  version_requirements: *2153542660
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: &2153541100 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id007
-- !ruby/object:Gem::Dependency 
-  name: jeweler
   prerelease: false
-  requirement: &id008 !ruby/object:Gem::Requirement 
+  version_requirements: *2153541100
+- !ruby/object:Gem::Dependency
+  name: rdiscount
+  requirement: &2153530920 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        version: "1.5"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id008
-description: "This is not an actual release, but an empty placeholder gem to make sure Hallon can keep its\xE2\x80\x99 name on rubygems.org. If you are curious about the development, visit the project website on GitHub or send the author (me! \\o/) an e-mail."
-email: kim@burgestrand.se
-executables: []
+  prerelease: false
+  version_requirements: *2153530920
+description: ! 'What is Hallon?
 
-extensions: []
+  ===============
+
+  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.
+
+
+  Hallon would not have been possible if not for these people:
+
+
+  - Per Reimers, cracking synchronization bugs with me in the deep night (4 AM) and
+  correcting me when I didn’t know better
+
+  - [Spotify](http://www.spotify.com/), providing a service worth attention (and my
+  money!)
+
+  - [Linus Oleander](https://github.com/oleander), involving me with the `radiofy.se`
+  project, ultimately spawning the necessity of Hallon
+
+  - [Jesper Särnesjö][], creator of [Greenstripes][], making me think of Hallon as
+  an achievable goal
+
+
+  Code samples can be found under `examples/` directory.
+
+
+  This is awesome! I want to help!
+
+  --------------------------------
+
+  Sweet! You contribute in more than one way!
+
+
+  ### Write code!
+
+  [Fork](http://help.github.com/forking/) Hallon, [write tests for everything](http://relishapp.com/rspec)
+  you do (so I don’t break your stuff during my own development) and send a pull request.
+  If you modify existing files, please adhere to the coding standard surrounding your
+  code!
+
+
+  ### [Send me feedback and requests](http://github.com/Burgestrand/Hallon/issues)
+
+  Really, I ❤ feedback! Suggestions on how to improve the API, tell me what is delicious
+  about Hallon, tell me what is yucky about Hallon… anything! All feedback is useful
+  in one way or another.
 
-extra_rdoc_files: []
 
-files: []
+  You have any questions?
 
-has_rdoc: true
+  -----------------------
+
+  If you need to discuss issues or feature requests you can use [Hallons issue tracker](http://github.com/Burgestrand/Hallon/issues).
+  For *anything* else you have to say or ask I can also be reached via [email (found
+  on GitHub profile)](http://github.com/Burgestrand) or [@burgestrand on twitter](http://twitter.com/Burgestrand).
+
+
+  In fact, you can contact me via email or twitter even if it’s about features or
+  issues. I’ll probably put them in the issue tracker myself after the discussion
+  ;)
+
+
+  What’s the catch?
+
+  -----------------
+
+  There are several!
+
+
+  ### Hallon is unstable
+
+  The API is unstable, my code is likely unstable. Everything should be considered
+  unstable!
+
+
+  ### Hallon only supports one session per process
+
+  You can only keep one session with Spotify alive at a time in the same process,
+  due to a limitation of `libspotify`.
+
+
+  ### You still have to worry about threads
+
+  I have been doing my best at hiding the complexity in `libspotify`, but it’s still
+  a work in progress. Despite my efforts, you’ll need to be familiar with concurrent
+  programming to use Hallon properly.
+
+
+  Versioning policy
+
+  -----------------
+
+  Hallon uses [semantic versioning](http://semver.org) as of v0.0.0. As long
+
+  as Hallon stays at major version 0, no guarantees of backwards-compatibility
+
+  are made. CHANGELOG will be kept up to date with the different versions.
+
+
+  License
+
+  -------
+
+  Hallon is licensed under a 2-clause (Simplified) BSD license. More information can
+  be found in the `LICENSE.txt` file.
+
+
+  [spotify gem]: https://rubygems.org/gems/spotify
+
+  [libspotify]: http://developer.spotify.com/en/libspotify/overview/
+
+  [Greenstripes]: http://github.com/sarnesjo/greenstripes
+
+  [Jesper Särnesjö]: http://jesper.sarnesjo.org/
+
+'
+email: kim@burgestrand.se
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .autotest
+- .gemtest
+- .gitignore
+- .rspec
+- .yardopts
+- CHANGELOG
+- Gemfile
+- LICENSE.txt
+- QUIRKS
+- README.markdown
+- Rakefile
+- Termfile
+- examples/logging_in.rb
+- examples/printing_link_information.rb
+- hallon.gemspec
+- lib/hallon.rb
+- lib/hallon/error.rb
+- lib/hallon/ext/ffi.rb
+- lib/hallon/ext/spotify.rb
+- lib/hallon/image.rb
+- lib/hallon/link.rb
+- lib/hallon/linkable.rb
+- lib/hallon/observable.rb
+- lib/hallon/session.rb
+- lib/hallon/synchronizable.rb
+- lib/hallon/user.rb
+- lib/hallon/version.rb
+- spec/fixtures/example_uris.rb
+- spec/fixtures/pink_cover.jpg
+- spec/hallon/error_spec.rb
+- spec/hallon/ffi_spec.rb
+- spec/hallon/hallon_spec.rb
+- spec/hallon/image_spec.rb
+- spec/hallon/link_spec.rb
+- spec/hallon/linkable_spec.rb
+- spec/hallon/observable_spec.rb
+- spec/hallon/session_spec.rb
+- spec/hallon/synchronizable_spec.rb
+- 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
 homepage: http://github.com/Burgestrand/Hallon
-licenses: 
+licenses:
 - GNU AGPL
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
-- .
-required_ruby_version: !ruby/object:Gem::Requirement 
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
+  requirements:
   - - ~>
-    - !ruby/object:Gem::Version 
-      version: "1.9"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+    - !ruby/object:Gem::Version
+      version: '1.9'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.5.2
+rubygems_version: 1.8.5
 signing_key: 
 specification_version: 3
-summary: Delicious Ruby bindings to the official Spotify API (placeholder until release)
-test_files: []
-
+summary: Delicious Ruby bindings to the official Spotify API
+test_files:
+- spec/fixtures/example_uris.rb
+- spec/fixtures/pink_cover.jpg
+- spec/hallon/error_spec.rb
+- spec/hallon/ffi_spec.rb
+- spec/hallon/hallon_spec.rb
+- spec/hallon/image_spec.rb
+- spec/hallon/link_spec.rb
+- spec/hallon/linkable_spec.rb
+- spec/hallon/observable_spec.rb
+- spec/hallon/session_spec.rb
+- spec/hallon/synchronizable_spec.rb
+- 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