spotify 12.5.2 → 12.5.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 981b598f43ddd1bb8c920bc52227349cc3c38983
-  data.tar.gz: fcc1deabbf3d31c131c870edd7a08366f0267134
+  metadata.gz: 4d9e97a03f155c02b4b189899d152e51acc80c21
+  data.tar.gz: 43731fc0330043a6885b08c669c2fb13418efb68
 SHA512:
-  metadata.gz: 8d7b1a66718c08753571a3cbd0d720fd9c34bd7692baeecf9304731ff7b0181dfda43d6c4cc050635672e8beebe9e89780cc3d86addc28b01615fb236d3a381c
-  data.tar.gz: 7876ab5a93a7316f087a949a8c32e26218a4b969d4cb0641374c610ab2cae9caa2f64fa32950a649befccf4d8794ce7ce38237c97b9f0ca3988ac31c8c0ea091
+  metadata.gz: 519bd5a79bb4a76dd63cb2ad884cb42da3a7bc142cf851db490bdc6f35f21be15fc224911f80650a437e7152db3cd0ad4901ce25e0d62f414aea8aec900447cf
+  data.tar.gz: f0b4bc4da8b176121aa4cb62c276142086084e8d8334fc291d76a740693ec218f170c6cf478023d0a971b04a27c68fab07b80f7a14c1c6625f66fbe00f1c5fbb

data/CHANGELOG.md

@@ -1,6 +1,14 @@
 [HEAD][]
 -----------
 
+[v12.5.3][]
+-----------
+
+- [e09f64cc7] Add initial windows support
+
+I’ve noticed callbacks cause libspotify to segfault. Not sure why; could
+have something to do with with FFI callback support.
+
 [v12.5.2][]
 -----------
 
@@ -198,8 +206,9 @@ v0.0.0
 ------
 - release to register rubygems.org name
 
-[HEAD]: https://github.com/Burgestrand/spotify/compare/v12.5.2...HEAD
+[HEAD]: https://github.com/Burgestrand/spotify/compare/v12.5.3...HEAD
 
+[v12.5.2]: https://github.com/Burgestrand/spotify/compare/v12.5.2...v12.5.3
 [v12.5.2]: https://github.com/Burgestrand/spotify/compare/v12.5.1...v12.5.2
 [v12.5.1]: https://github.com/Burgestrand/spotify/compare/v12.5.0...v12.5.1
 [v12.5.0]: https://github.com/Burgestrand/spotify/compare/v12.4.0...v12.5.0

data/Gemfile

@@ -1,4 +1,5 @@
-source :rubygems
+source 'https://rubygems.org/'
+
 gemspec
 
 gem 'pry'

data/README.markdown

@@ -1,5 +1,9 @@
-Ruby bindings for [libspotify][] ([![Build Status](https://secure.travis-ci.org/Burgestrand/spotify.png?branch=master)](http://travis-ci.org/Burgestrand/spotify))
-================================
+Low-level Ruby bindings for [libspotify][], the official Spotify C API
+======================================================================
+[![Build Status](https://secure.travis-ci.org/Burgestrand/spotify.png?branch=master)](http://travis-ci.org/Burgestrand/spotify)
+[![Dependency Status](https://gemnasium.com/Burgestrand/spotify.png)](https://gemnasium.com/Burgestrand/spotify)
+[![Code Climate](https://codeclimate.com/github/Burgestrand/spotify.png)](https://codeclimate.com/github/Burgestrand/spotify)
+[![Gem Version](https://badge.fury.io/rb/spotify.png)](http://badge.fury.io/rb/spotify)
 
     The libspotify C API package allows third party developers to write
     applications that utilize the Spotify music streaming service.
@@ -16,7 +20,7 @@ The Spotify gem has:
 
 - [100% API coverage][], including callback support. You’ll be able to use any function from the libspotify library.
 - [Automatic garbage collection][]. Piggybacking on Ruby’s GC to manage pointer lifecycle.
-- [Parallell function call protection][]. libspotify is not thread-safe, but Spotify protects you.
+- [Parallell function call protection][]. libspotify is not thread-safe, but Spotify protects you by providing a re-entrant mutex around function calls.
 - [Type conversion and type safety][]. Special pointers for every Spotify type, protecting you from accidental mix-ups.
 - [Support for JRuby and Rubinius][]. Thanks to FFI, the gem runs fine on the main three Ruby implementations!
 
@@ -26,7 +30,14 @@ The Spotify gem has:
 [Type conversion and type safety]: http://rdoc.info/github/Burgestrand/spotify/master/Spotify/ManagedPointer
 [Support for JRuby and Rubinius]: https://github.com/Burgestrand/spotify/blob/master/.travis.yml
 
-The Spotify gem is aimed at experienced developers
+Contact details
+---------------
+
+- __Got questions?__ Ask on the mailing list: [ruby-hallon@googlegroups.com][] (<https://groups.google.com/d/forum/ruby-hallon>)
+- __Found a bug?__ Report an issue: <https://github.com/Burgestrand/spotify/issues/new>
+- __Have feedback?__ I ❤ feedback! Please send it to the mailing list.
+
+Spotify API is best used with a supporting library
 --------------------------------------------------
 As the raw libspotify API is exposed, the Spotify gem is best coupled with a supporting
 library. This library would take a more focused approach to which kind of applications
@@ -88,6 +99,6 @@ THE SOFTWARE.
 
 [semantic versioning (semver.org)]: http://semver.org/
 [ruby-hallon@googlegroups.com]: mailto:ruby-hallon@googlegroups.com
-[libspotify]: http://developer.spotify.com/en/libspotify/overview/
+[libspotify]: https://developer.spotify.com/technologies/libspotify/
 [Spotify]: https://www.spotify.com/
 [Hallon]: https://github.com/Burgestrand/Hallon

data/examples/audio-stream_example.rb

@@ -9,7 +9,7 @@ require "plaything"
 def play_track(uri)
   link = Spotify.link_create_from_string(uri)
   track = Spotify.link_as_track(link)
-  poll($session) { Spotify.track_is_loaded(track) }
+  Support.poll($session) { Spotify.track_is_loaded(track) }
   Spotify.try(:session_player_play, $session, false)
   Spotify.try(:session_player_load, $session, track)
   Spotify.try(:session_player_play, $session, true)
@@ -84,12 +84,12 @@ $session_callbacks = {
 
   music_delivery: proc do |session, format, frames, num_frames|
     if num_frames == 0
-      plaything.stop
       $logger.debug("session (player)") { "music delivery audio discontuity" }
+      plaything.stop
+      0
     else
       frames = FrameReader.new(format[:channels], format[:sample_type], num_frames, frames)
       consumed_frames = plaything.stream(frames, format.to_h)
-      $logger.info("session (player)") { "#{format.to_h}" }
       $logger.debug("session (player)") { "music delivery #{consumed_frames} of #{num_frames}" }
       consumed_frames
     end
@@ -120,21 +120,17 @@ config = Spotify::SessionConfig.new({
 })
 
 $logger.info "Creating session."
-FFI::MemoryPointer.new(Spotify::Session) do |ptr|
-  Spotify.try(:session_create, config, ptr)
-  $session = Spotify::Session.new(ptr.read_pointer)
-end
+$session = Support.create_session(config)
 
 $logger.info "Created! Logging in."
-Spotify.session_login($session, $username, $password, false, nil)
+Spotify.session_login($session, $username, $password, false, $blob)
 
 $logger.info "Log in requested. Waiting forever until logged in."
-poll($session) { Spotify.session_connectionstate($session) == :logged_in }
+Support.poll($session) { Spotify.session_connectionstate($session) == :logged_in }
 
 $logger.info "Logged in as #{Spotify.session_user_name($session)}."
 
-print "Spotify track URI: "
-play_track gets.chomp
+play_track Support.prompt("Spotify track URI")
 
 $logger.info "Playing track until end. Use ^C to exit."
-poll($session) { $end_of_track }
+Support.poll($session) { $end_of_track }

data/examples/console_example.rb

@@ -13,10 +13,7 @@ config = Spotify::SessionConfig.new({
 })
 
 $logger.info "Creating session."
-FFI::MemoryPointer.new(Spotify::Session) do |ptr|
-  Spotify.try(:session_create, config, ptr)
-  $session = Spotify::Session.new(ptr.read_pointer)
-end
+$session = Support.create_session(config)
 
 $logger.info "Created! Logging in."
 Spotify.session_login($session, $username, $password, false, nil)

data/examples/example_support.rb

@@ -7,6 +7,7 @@ require "pry"
 Thread.abort_on_exception = true
 
 # We use a logger to print some information on when things are happening.
+$stderr.sync = true
 $logger = Logger.new($stderr)
 $logger.level = Logger::INFO
 
@@ -14,33 +15,52 @@ $logger.level = Logger::INFO
 # Some utility.
 #
 
-# libspotify supports callbacks, but they are not useful for waiting on
-# operations (how they fire can be strange at times, and sometimes they
-# might not fire at all). As a result, polling is the way to go.
-def poll(session)
-  until yield
-    FFI::MemoryPointer.new(:int) do |ptr|
-      Spotify.session_process_events(session, ptr)
+module Support
+  module_function
+
+  def logger
+    $logger
+  end
+
+  # libspotify supports callbacks, but they are not useful for waiting on
+  # operations (how they fire can be strange at times, and sometimes they
+  # might not fire at all). As a result, polling is the way to go.
+  def poll(session)
+    until yield
+      FFI::MemoryPointer.new(:int) do |ptr|
+        Spotify.session_process_events(session, ptr)
+      end
+      sleep(0.1)
     end
-    sleep(0.1)
   end
-end
 
-# For making sure fetching configuration options fail with a useful error
-# message when running the examples.
-def env(name)
-  ENV.fetch(name) do
-    raise "Missing ENV['#{name}']. Please: export #{name}='your value'"
+  # For making sure fetching configuration options fail with a useful error
+  # message when running the examples.
+  def env(name)
+    ENV.fetch(name) do
+      raise "Missing ENV['#{name}']. Please: export #{name}='your value'"
+    end
   end
-end
 
-# Ask the user for input with a prompt explaining what kind of input.
-def prompt(message)
-  print "#{message}: "
-  gets.chomp
+  # Ask the user for input with a prompt explaining what kind of input.
+  def prompt(message)
+    print "#{message}: "
+    gets.chomp
+  end
+
+  def create_session(config)
+    FFI::MemoryPointer.new(Spotify::Session) do |ptr|
+      Spotify.try(:session_create, config, ptr)
+      return Spotify::Session.new(ptr.read_pointer)
+    end
+  end
 end
 
 # Load the configuration.
 $appkey = IO.read("./spotify_appkey.key", encoding: "BINARY")
-$username = env("SPOTIFY_USERNAME")
-$password = env("SPOTIFY_PASSWORD")
+$username = Support.env("SPOTIFY_USERNAME")
+if ENV.has_key?("SPOTIFY_BLOB")
+  $blob = ENV["SPOTIFY_BLOB"]
+else
+  $password = Support.env("SPOTIFY_PASSWORD")
+end

data/examples/loading-object_example.rb

@@ -13,20 +13,17 @@ config = Spotify::SessionConfig.new({
 })
 
 $logger.info "Creating session."
-FFI::MemoryPointer.new(Spotify::Session) do |ptr|
-  Spotify.try(:session_create, config, ptr)
-  $session = Spotify::Session.new(ptr.read_pointer)
-end
+$session = Support.create_session(config)
 
 $logger.info "Created! Logging in."
-Spotify.session_login($session, $username, $password, false, nil)
+Spotify.session_login($session, $username, $password, false, $blob)
 
 $logger.info "Log in requested. Waiting forever until logged in."
-poll($session) { Spotify.session_connectionstate($session) == :logged_in }
+Support.poll($session) { Spotify.session_connectionstate($session) == :logged_in }
 
 $logger.info "Logged in as #{Spotify.session_user_name($session)}."
 
-track_uri = prompt("Please enter an track URI")
+track_uri = Support.prompt("Please enter an track URI")
 link = Spotify.link_create_from_string(track_uri)
 
 if link.null?
@@ -40,7 +37,7 @@ else
 end
 
 $logger.info "Attempting to load track. Waiting forever until successful."
-poll($session) { Spotify.track_is_loaded(track) }
+Support.poll($session) { Spotify.track_is_loaded(track) }
 $logger.info "Track loaded."
 
 puts Spotify.track_name(track)

data/examples/logging-in_example.rb

@@ -24,6 +24,10 @@ $session_callbacks = {
   logged_out: lambda do |session|
     $logger.info('session (logged out)') { 'logged out!' }
   end,
+
+  credentials_blob_updated: lambda do |session, blob|
+    $logger.info('session (blob)') { blob }
+  end
 }
 
 #
@@ -43,17 +47,12 @@ config = Spotify::SessionConfig.new({
 })
 
 $logger.info "Creating session."
-FFI::MemoryPointer.new(Spotify::Session) do |ptr|
-  # Spotify.try is a special method. It raises a ruby exception if the returned spotify
-  # error code is an error.
-  Spotify.try(:session_create, config, ptr)
-  $session = Spotify::Session.new(ptr.read_pointer)
-end
+$session = Support.create_session(config)
 
 $logger.info "Created! Logging in."
-Spotify.session_login($session, $username, $password, false, nil)
+Spotify.session_login($session, $username, $password, false, $blob)
 
 $logger.info "Log in requested. Waiting forever until logged in."
-poll($session) { Spotify.session_connectionstate($session) == :logged_in }
+Support.poll($session) { Spotify.session_connectionstate($session) == :logged_in }
 
 $logger.info "Logged in as #{Spotify.session_user_name($session)}."

data/lib/spotify.rb

@@ -30,6 +30,7 @@ module Spotify
 
     begin
       ffi_lib [LIBSPOTIFY_BIN, 'spotify', 'libspotify', '/Library/Frameworks/libspotify.framework/libspotify']
+      ffi_convention :stdcall if FFI::Platform.windows?
     rescue LoadError
       puts <<-ERROR.gsub(/^ */, '')
         Failed to load the `libspotify` library. It is possible that the libspotify gem

data/lib/spotify/monkey_patches/ffi_pointer.rb

@@ -1,6 +1,8 @@
 require "ffi"
 
+# @see http://github.com/ffi/ffi
 module FFI
+  # Superclass for FFI::Pointer.
   class AbstractMemory
     unless method_defined?(:read_size_t)
       type = FFI.find_type(:size_t)

data/lib/spotify/structs/subscribers.rb

@@ -13,6 +13,9 @@ module Spotify
     include Enumerable
 
     class << self
+      # Releases the given subscribers structure if it is not null.
+      #
+      # @param [FFI::Pointer] pointer pointing to a subscribers struct
       def release(pointer)
         unless pointer.null?
           pointer = type_class.new(pointer)

data/lib/spotify/type_safety.rb

@@ -1,4 +1,6 @@
 module Spotify
+  # Spotify::TypeSafety checks all values coming in and makes sure
+  # they are of an instance of the correct {#type_class}.
   module TypeSafety
     # Convert given value to native value, with type checking.
     #

data/lib/spotify/types/byte_string.rb

@@ -1,4 +1,7 @@
 module Spotify
+  # ByteStrings are for strings that store any binary data, not
+  # just regular NULL-terminated strings. It is used for the Spotify
+  # application key.
   module ByteString
     extend FFI::DataConverter
     native_type FFI::Type::POINTER

data/lib/spotify/util.rb

@@ -9,25 +9,29 @@ class << Spotify::API
   # @example failing to retrieve a value
   #    Spotify.enum_value!(:moo, "connection rule") # => ArgumentError, invalid connection rule: :moo
   #
+  # @api public
   # @param [Symbol] symbol
   # @param [#to_s] type used as error message when the symbol does not resolve
   # @raise [ArgumentError] when the symbol does not exist as an enum value
+  # @return [Integer]
   def enum_value!(symbol, type)
     enum_value(symbol) or raise ArgumentError, "invalid #{type}: #{symbol}"
   end
 
   # @see platform
+  # @api public
   # @return [Boolean] true if on Linux
   def linux?
     platform == :linux
   end
 
+  # @api public
   # @return [Symbol] platform as either :mac, :windows, or :linux
   def platform
     case FFI::Platform::OS
     when /darwin/ then :mac
     when /linux/  then :linux
-    when /mswin/  then :windows
+    when /windows/  then :windows
     else
       $stderr.puts "[WARN] You are running the Spotify gem on an unknown platform. (#{__FILE__}:#{__LINE__})"
       $stderr.puts "[WARN] Platform: #{FFI::Platform::OS}"

data/lib/spotify/version.rb

@@ -1,7 +1,7 @@
 module Spotify
   # @note See README for versioning policy.
   # @return [String] Spotify gem version.
-  VERSION = '12.5.2'
+  VERSION = '12.5.3'
 
   # @return [String] Compatible libspotify API version.
   API_VERSION = '12.1.51'

data/spec/spotify/managed_pointer_spec.rb

@@ -75,6 +75,7 @@ describe Spotify::ManagedPointer do
   describe "garbage collection", :engine => "ruby" do
     module Spotify
       class << API
+        # Required by all ManagedPointers.
         def bogus_add_ref(pointer)
         end
 
@@ -89,14 +90,12 @@ describe Spotify::ManagedPointer do
     let(:my_pointer) { FFI::Pointer.new(1) }
 
     it "should work" do
-      api.stub(:bogus_add_ref)
-
       # GC tests are a bit funky, but as long as we garbage_release at least once, then
       # we can assume our GC works properly, but up the stakes just for the sake of it
       api.should_receive(:bogus_release).at_least(1).times
 
-      5.times { Spotify::Bogus.retaining_class.new(FFI::Pointer.new(1)) }
-      5.times { GC.start; sleep 0.01 }
+      10.times { Spotify::Bogus.new(FFI::Pointer.new(1)) }
+      10.times { GC.start; sleep 0.01 }
     end
   end
 

data/spotify.gemspec

@@ -3,7 +3,7 @@ require './lib/spotify/version'
 
 Gem::Specification.new do |gem|
   gem.name        = 'spotify'
-  gem.summary     = 'Low-level Ruby bindings for libspotify'
+  gem.summary     = 'Low-level Ruby bindings for libspotify, the official Spotify C API'
 
   gem.homepage    = 'https://github.com/Burgestrand/spotify'
   gem.authors     = ["Kim Burgestrand"]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: spotify
 version: !ruby/object:Gem::Version
-  version: 12.5.2
+  version: 12.5.3
 platform: ruby
 authors:
 - Kim Burgestrand
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-25 00:00:00.000000000 Z
+date: 2013-11-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -211,10 +211,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.1.10
 signing_key: 
 specification_version: 4
-summary: Low-level Ruby bindings for libspotify
+summary: Low-level Ruby bindings for libspotify, the official Spotify C API
 test_files:
 - spec/bench_helper.rb
 - spec/benchmarks/managed_pointer_bench.rb