spotify 12.2.0 → 12.3.0

data/spec/spotify/types/utf8_string_spec.rb

@@ -0,0 +1,24 @@
+# encoding: utf-8
+describe Spotify::UTF8String do
+  module C
+    extend FFI::Library
+    ffi_lib [FFI::CURRENT_PROCESS, 'c']
+
+    attach_function :strncpy, [ :pointer, Spotify::UTF8String, :size_t ], Spotify::UTF8String
+  end
+
+  let(:char) do
+    char = "\xC4"
+    char.force_encoding('ISO-8859-1')
+    char
+  end
+
+  it "should convert any strings to UTF-8 before reading and writing" do
+    dest   = FFI::MemoryPointer.new(:char, 3) # two bytes for the ä, one for the NULL
+    result = C.strncpy(dest, char, 3)
+
+    result.encoding.should eq Encoding::UTF_8
+    result.should eq "Ä"
+    result.bytesize.should eq 2
+  end
+end

data/spec/support/hook_spotify.rb

@@ -0,0 +1,37 @@
+#
+# Hooks into FFI for extra introspection during testing.
+#
+require 'ffi'
+
+$attached_methods ||= {}
+
+module SpotifyHook
+  # stores function information that we can assert on later
+  def attach_function(name, func, arguments, returns, options)
+    args  = [name, func, arguments.dup, returns, options]
+    hargs = [:name, :func, :args, :returns].zip args
+    $attached_methods[name.to_s] = hash = Hash[hargs]
+
+    super
+  end
+end
+
+module Spotify
+  class API
+    # so that Spotify cannot extend again
+    extend FFI::Library
+    extend SpotifyHook
+
+    # allows us to test for Mac/Linux independently
+    FFI::Platform::OS.replace(ENV.fetch('RUBY_PLATFORM') do
+      puts "[WARN] Tests running with default ruby platform, #{::FFI::Platform::OS}, please be"
+      puts "[WARN] specific in which platform to target by setting ENV[RUBY_PLATFORM]"
+      puts "(warnings coming from #{__FILE__}:#{__LINE__})"
+      puts
+      ::FFI::Platform::OS
+    end)
+  end
+end
+
+# All is in place, load it up
+require 'spotify'

data/spec/support/spotify_util.rb

@@ -0,0 +1,17 @@
+module Spotify
+  # used to find the actual type of a thing
+  def self.resolve_type(type)
+    if type.is_a?(Class) and type <= Spotify::ManagedPointer
+      type
+    else
+      type = Spotify::API.find_type(type)
+      type = type.type if type.respond_to?(:type)
+      type
+    end
+  end
+
+  # @return [Array<FFI::Struct>] all structs in Spotify namespace
+  def self.structs
+    constants.select { |x| const_get(x).is_a?(Class) && const_get(x) < FFI::Struct }
+  end
+end

data/spotify.gemspec

@@ -3,14 +3,9 @@ require './lib/spotify/version'
 
 Gem::Specification.new do |gem|
   gem.name        = 'spotify'
-  gem.summary     = 'Bare-bones Ruby bindings for libspotify'
-  gem.description = <<-DESC
-    Spotify for Ruby is a primitive wrapper around libspotify using Ruby FFI.
-    If all you want is libspotify for Ruby, you should probably use at Hallon
-    instead: https://rubygems.org/gems/hallon
-  DESC
+  gem.summary     = 'Low-level Ruby bindings for libspotify'
 
-  gem.homepage    = 'https://github.com/Burgestrand/libspotify-ruby'
+  gem.homepage    = 'https://github.com/Burgestrand/spotify'
   gem.authors     = ["Kim Burgestrand"]
   gem.email       = ['kim@burgestrand.se']
   gem.license     = 'X11 License'
@@ -20,13 +15,13 @@ Gem::Specification.new do |gem|
   gem.executables   = []
   gem.require_paths = ["lib"]
 
-  gem.version     = Spotify::VERSION
-  gem.platform    = Gem::Platform::RUBY
+  gem.version = Spotify::VERSION
+  gem.platform = Gem::Platform::RUBY
   gem.required_ruby_version = '>= 1.9'
 
   gem.add_dependency 'ffi', ['~> 1.0', '>= 1.0.11']
+  gem.add_dependency 'libspotify', '~> 12.1.51'
   gem.add_development_dependency 'rake'
-  gem.add_development_dependency 'yard'
   gem.add_development_dependency 'rbgccxml'
-  gem.add_development_dependency 'minitest', '~> 3.0'
+  gem.add_development_dependency 'rspec'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: spotify
 version: !ruby/object:Gem::Version
-  version: 12.2.0
+  version: 12.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-02 00:00:00.000000000 Z
+date: 2012-08-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -34,23 +34,23 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 1.0.11
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: libspotify
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+        version: 12.1.51
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 12.1.51
 - !ruby/object:Gem::Dependency
-  name: yard
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -82,24 +82,22 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: '3.0'
-description: ! "    Spotify for Ruby is a primitive wrapper around libspotify using
-  Ruby FFI.\n    If all you want is libspotify for Ruby, you should probably use at
-  Hallon\n    instead: https://rubygems.org/gems/hallon\n"
+        version: '0'
+description: 
 email:
 - kim@burgestrand.se
 executables: []
@@ -108,6 +106,7 @@ extra_rdoc_files: []
 files:
 - .gemtest
 - .gitignore
+- .rspec
 - .travis.yml
 - CHANGELOG.md
 - Gemfile
@@ -115,20 +114,78 @@ files:
 - README.markdown
 - Rakefile
 - lib/spotify.rb
-- lib/spotify/error_wrappers.rb
-- lib/spotify/functions.rb
-- lib/spotify/gc_wrappers.rb
+- lib/spotify/api.rb
+- lib/spotify/api/album.rb
+- lib/spotify/api/album_browse.rb
+- lib/spotify/api/artist.rb
+- lib/spotify/api/artist_browse.rb
+- lib/spotify/api/error.rb
+- lib/spotify/api/image.rb
+- lib/spotify/api/inbox.rb
+- lib/spotify/api/link.rb
+- lib/spotify/api/playlist.rb
+- lib/spotify/api/playlist_container.rb
+- lib/spotify/api/search.rb
+- lib/spotify/api/session.rb
+- lib/spotify/api/toplist_browse.rb
+- lib/spotify/api/track.rb
+- lib/spotify/api/user.rb
+- lib/spotify/defines.rb
+- lib/spotify/error.rb
+- lib/spotify/managed_pointer.rb
+- lib/spotify/objects.rb
+- lib/spotify/objects/album.rb
+- lib/spotify/objects/album_browse.rb
+- lib/spotify/objects/artist.rb
+- lib/spotify/objects/artist_browse.rb
+- lib/spotify/objects/image.rb
+- lib/spotify/objects/inbox.rb
+- lib/spotify/objects/link.rb
+- lib/spotify/objects/playlist.rb
+- lib/spotify/objects/playlist_container.rb
+- lib/spotify/objects/search.rb
+- lib/spotify/objects/session.rb
+- lib/spotify/objects/toplist_browse.rb
+- lib/spotify/objects/track.rb
+- lib/spotify/objects/user.rb
+- lib/spotify/structs.rb
+- lib/spotify/structs/audio_buffer_stats.rb
+- lib/spotify/structs/audio_format.rb
+- lib/spotify/structs/offline_sync_status.rb
+- lib/spotify/structs/playlist_callbacks.rb
+- lib/spotify/structs/playlist_container_callbacks.rb
+- lib/spotify/structs/session_callbacks.rb
+- lib/spotify/structs/session_config.rb
+- lib/spotify/structs/subscribers.rb
+- lib/spotify/types.rb
 - lib/spotify/types/image_id.rb
-- lib/spotify/types/pointer.rb
+- lib/spotify/types/nul_string.rb
 - lib/spotify/types/utf8_string.rb
+- lib/spotify/util.rb
 - lib/spotify/version.rb
 - spec/api-linux.h
+- spec/api-linux.xml
 - spec/api-mac.h
+- spec/api-mac.xml
 - spec/linux-platform.rb
 - spec/mac-platform.rb
-- spec/spotify_spec.rb
+- spec/spec_helper.rb
+- spec/spotify/api_spec.rb
+- spec/spotify/defines_spec.rb
+- spec/spotify/enums_spec.rb
+- spec/spotify/managed_pointer_spec.rb
+- spec/spotify/spotify_spec.rb
+- spec/spotify/structs/session_config_spec.rb
+- spec/spotify/structs/struct_spec.rb
+- spec/spotify/structs/subscribers_spec.rb
+- spec/spotify/structs_spec.rb
+- spec/spotify/types/image_id_spec.rb
+- spec/spotify/types/nul_string_spec.rb
+- spec/spotify/types/utf8_string_spec.rb
+- spec/support/hook_spotify.rb
+- spec/support/spotify_util.rb
 - spotify.gemspec
-homepage: https://github.com/Burgestrand/libspotify-ruby
+homepage: https://github.com/Burgestrand/spotify
 licenses:
 - X11 License
 post_install_message: 
@@ -149,17 +206,33 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1782095507785202137
+      hash: -1786637740749892819
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: Bare-bones Ruby bindings for libspotify
+summary: Low-level Ruby bindings for libspotify
 test_files:
 - spec/api-linux.h
+- spec/api-linux.xml
 - spec/api-mac.h
+- spec/api-mac.xml
 - spec/linux-platform.rb
 - spec/mac-platform.rb
-- spec/spotify_spec.rb
+- spec/spec_helper.rb
+- spec/spotify/api_spec.rb
+- spec/spotify/defines_spec.rb
+- spec/spotify/enums_spec.rb
+- spec/spotify/managed_pointer_spec.rb
+- spec/spotify/spotify_spec.rb
+- spec/spotify/structs/session_config_spec.rb
+- spec/spotify/structs/struct_spec.rb
+- spec/spotify/structs/subscribers_spec.rb
+- spec/spotify/structs_spec.rb
+- spec/spotify/types/image_id_spec.rb
+- spec/spotify/types/nul_string_spec.rb
+- spec/spotify/types/utf8_string_spec.rb
+- spec/support/hook_spotify.rb
+- spec/support/spotify_util.rb
 has_rdoc: 

data/lib/spotify/error_wrappers.rb

@@ -1,165 +0,0 @@
-# This file contains functions that automatically raise when
-# their libspotify function returns a non-ok error.
-
-module Spotify
-  # Raised on error-wrapped functions when the result is non-ok.
-  class Error < StandardError
-    class << self
-      # Explain a Spotify error with a descriptive message.
-      #
-      # @param [Symbol, Integer] error
-      # @return [String] a decriptive string of the error
-      def explain(error)
-        error, symbol = disambiguate(error)
-
-        message = []
-        message << "[#{symbol.to_s.upcase}]"
-        message << Spotify.error_message(error)
-        message << "(#{error})"
-
-        message.join(' ')
-      end
-
-      # Given a number or a symbol, find both the symbol and the error
-      # number it represents.
-      #
-      # @example given an integer
-      #   Spotify::Error.disambiguate(0) # => [0, :ok]
-      #
-      # @example given a symbol
-      #   Spotify::Error.disambiguate(:ok) # => [0, :ok]
-      #
-      # @example given bogus
-      #   Spotify::Error.disambiguate(:bogus) # => [-1, nil]
-      #
-      # @param [Symbol, Fixnum] error
-      # @return [[Fixnum, Symbol]] (error code, error symbol)
-      def disambiguate(error)
-        @enum ||= Spotify.enum_type(:error)
-
-        if error.is_a? Symbol
-          error = @enum[symbol = error]
-        else
-          symbol = @enum[error]
-        end
-
-        if error.nil? || symbol.nil?
-          [-1, nil]
-        else
-          [error, symbol]
-        end
-      end
-    end
-  end
-
-  # Wraps the function `function` so that it raises an error if
-  # the return error is not :ok.
-  #
-  # @note This method is removed at the bottom of this file.
-  #
-  # @param [#to_s] function
-  # @raise [NoMethodError] if `function` is not defined
-  def self.wrap_function(function)
-    method(function) # make sure it exists
-    define_singleton_method("#{function}!") do |*args, &block|
-      error = public_send(function, *args, &block)
-      raise Error, Error.explain(error) unless error == :ok
-    end
-  end
-
-  wrap_function :session_create
-  wrap_function :session_release
-  wrap_function :session_process_events
-  wrap_function :session_login
-  wrap_function :session_relogin
-  wrap_function :session_forget_me
-  wrap_function :session_logout
-  wrap_function :session_set_cache_size
-  wrap_function :session_player_load
-  wrap_function :session_player_seek
-  wrap_function :session_player_play
-  wrap_function :session_player_unload
-  wrap_function :session_player_prefetch
-  wrap_function :session_preferred_bitrate
-  wrap_function :session_set_connection_type
-  wrap_function :session_set_connection_rules
-  wrap_function :session_preferred_offline_bitrate
-  wrap_function :session_set_volume_normalization
-  wrap_function :session_flush_caches
-  wrap_function :session_set_private_session
-  wrap_function :session_set_scrobbling
-  wrap_function :session_is_scrobbling
-  wrap_function :session_is_scrobbling_possible
-  wrap_function :session_set_social_credentials
-
-  wrap_function :image_add_load_callback
-  wrap_function :image_remove_load_callback
-  wrap_function :image_error
-  wrap_function :image_add_ref
-  wrap_function :image_release
-
-  wrap_function :link_add_ref
-  wrap_function :link_release
-
-  wrap_function :track_error
-  wrap_function :track_set_starred
-  wrap_function :track_add_ref
-  wrap_function :track_release
-
-  wrap_function :album_add_ref
-  wrap_function :album_release
-
-  wrap_function :albumbrowse_error
-  wrap_function :albumbrowse_add_ref
-  wrap_function :albumbrowse_release
-
-  wrap_function :artist_add_ref
-  wrap_function :artist_release
-
-  wrap_function :artistbrowse_error
-  wrap_function :artistbrowse_add_ref
-  wrap_function :artistbrowse_release
-
-  wrap_function :search_error
-  wrap_function :search_add_ref
-  wrap_function :search_release
-
-  wrap_function :playlist_add_callbacks
-  wrap_function :playlist_remove_callbacks
-  wrap_function :playlist_track_set_seen
-  wrap_function :playlist_rename
-  wrap_function :playlist_set_collaborative
-  wrap_function :playlist_set_autolink_tracks
-  wrap_function :playlist_add_tracks
-  wrap_function :playlist_remove_tracks
-  wrap_function :playlist_reorder_tracks
-  wrap_function :playlist_subscribers_free
-  wrap_function :playlist_update_subscribers
-  wrap_function :playlist_set_in_ram
-  wrap_function :playlist_set_offline_mode
-  wrap_function :playlist_add_ref
-  wrap_function :playlist_release
-
-  wrap_function :playlistcontainer_add_callbacks
-  wrap_function :playlistcontainer_remove_callbacks
-  wrap_function :playlistcontainer_playlist_folder_name
-  wrap_function :playlistcontainer_remove_playlist
-  wrap_function :playlistcontainer_move_playlist
-  wrap_function :playlistcontainer_add_folder
-  wrap_function :playlistcontainer_add_ref
-  wrap_function :playlistcontainer_release
-
-  wrap_function :user_add_ref
-  wrap_function :user_release
-
-  wrap_function :toplistbrowse_error
-  wrap_function :toplistbrowse_add_ref
-  wrap_function :toplistbrowse_release
-
-  wrap_function :inbox_error
-  wrap_function :inbox_add_ref
-  wrap_function :inbox_release
-
-  # Clean up
-  class << self; undef :wrap_function; end
-end