spotify 12.5.1 → 12.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 20694ef78fc1b426595ffabf8d655da1875060fc
-  data.tar.gz: 5b99e59242913e03a3a3c1ef5e8e8f3835fbd4a0
+  metadata.gz: 981b598f43ddd1bb8c920bc52227349cc3c38983
+  data.tar.gz: fcc1deabbf3d31c131c870edd7a08366f0267134
 SHA512:
-  metadata.gz: 042287392a9ad3ea971eb9110b8654e4e757077d6da762c5f43953632f5e99bee6a26e9f4622a73cbe97cd703df3b1e1f03cb6bd805040cc566ad7b252e796f2
-  data.tar.gz: 1bfc03fd117914dc937e3a5cb247f914287250032630aa763051db5acde55ddb0f2760720ed86ea246023567c8f57d4bb7187969106e29ba68699ba4b3ece2cb
+  metadata.gz: 8d7b1a66718c08753571a3cbd0d720fd9c34bd7692baeecf9304731ff7b0181dfda43d6c4cc050635672e8beebe9e89780cc3d86addc28b01615fb236d3a381c
+  data.tar.gz: 7876ab5a93a7316f087a949a8c32e26218a4b969d4cb0641374c610ab2cae9caa2f64fa32950a649befccf4d8794ce7ce38237c97b9f0ca3988ac31c8c0ea091

data/CHANGELOG.md

@@ -1,6 +1,14 @@
 [HEAD][]
 -----------
 
+[v12.5.2][]
+-----------
+
+- [5245d932b] #link_create_from_string now accepts non-UTF8
+- [349dfdc61] #link_create_from_string now accepts strings with NULL-bytes in them (it clips the string)
+- [349dfdc61] #link_create_from_string now accepts empty strings without crashing
+- [ef7ae9390] #link_create_from_string no longer throws a warning on UTF-8
+
 [v12.5.1][]
 -----------
 
@@ -190,8 +198,9 @@ v0.0.0
 ------
 - release to register rubygems.org name
 
-[HEAD]: https://github.com/Burgestrand/spotify/compare/v12.5.1...HEAD
+[HEAD]: https://github.com/Burgestrand/spotify/compare/v12.5.2...HEAD
 
+[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
 [v12.4.0]: https://github.com/Burgestrand/spotify/compare/v12.3.0...v12.4.0

data/README.markdown

@@ -9,7 +9,7 @@ with it in an API is awesome. libspotify itself is however written in C, making
 it unavailable or cumbersome to use for many developers.
 
 This project aims to allow Ruby developers access to all of the libspotify C API,
-without needing to reach down to C. However, to use this library to it’s full extent
+without needing to reach down to C. However, to use this library to its full extent
 you will need to learn how to use the Ruby FFI API.
 
 The Spotify gem has:

data/examples/{audio-stream.rb → audio-stream_example.rb}

@@ -1,39 +1,11 @@
 #!/usr/bin/env ruby
 # encoding: utf-8
 
-require "bundler/setup"
-require "spotify"
-require "logger"
+require_relative "example_support"
+
 require "json"
-require "pry"
 require "plaything"
 
-Thread.abort_on_exception = true
-
-# We use a logger to print some information on when things are happening.
-$logger = Logger.new($stderr)
-$logger.level = Logger::INFO
-
-# 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
-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\""
-  end
-end
-
 def play_track(uri)
   link = Spotify.link_create_from_string(uri)
   track = Spotify.link_as_track(link)
@@ -117,6 +89,7 @@ $session_callbacks = {
     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
@@ -138,7 +111,7 @@ $session_callbacks = {
 # https://developer.spotify.com/technologies/libspotify/docs/12.1.45/structsp__session__config.html
 config = Spotify::SessionConfig.new({
   api_version: Spotify::API_VERSION.to_i,
-  application_key: IO.read("./spotify_appkey.key", encoding: "BINARY"),
+  application_key: $appkey,
   cache_location: ".spotify/",
   settings_location: ".spotify/",
   tracefile: "spotify_tracefile.txt",
@@ -153,7 +126,7 @@ FFI::MemoryPointer.new(Spotify::Session) do |ptr|
 end
 
 $logger.info "Created! Logging in."
-Spotify.session_login($session, env("SPOTIFY_USERNAME"), env("SPOTIFY_PASSWORD"), false, nil)
+Spotify.session_login($session, $username, $password, false, nil)
 
 $logger.info "Log in requested. Waiting forever until logged in."
 poll($session) { Spotify.session_connectionstate($session) == :logged_in }

data/examples/console_example.rb

@@ -0,0 +1,25 @@
+#!/usr/bin/env ruby
+# encoding: utf-8
+
+require_relative "example_support"
+
+config = Spotify::SessionConfig.new({
+  api_version: Spotify::API_VERSION.to_i,
+  application_key: $appkey,
+  cache_location: ".spotify/",
+  settings_location: ".spotify/",
+  user_agent: "spotify for ruby",
+  callbacks: nil,
+})
+
+$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
+
+$logger.info "Created! Logging in."
+Spotify.session_login($session, $username, $password, false, nil)
+
+$logger.info "Logged in! Entering interactive session…"
+binding.pry

data/examples/example_support.rb

@@ -0,0 +1,46 @@
+require "bundler/setup"
+require "spotify"
+require "logger"
+require "pry"
+
+# Kill main thread if any other thread dies.
+Thread.abort_on_exception = true
+
+# We use a logger to print some information on when things are happening.
+$logger = Logger.new($stderr)
+$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)
+    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'"
+  end
+end
+
+# Ask the user for input with a prompt explaining what kind of input.
+def prompt(message)
+  print "#{message}: "
+  gets.chomp
+end
+
+# Load the configuration.
+$appkey = IO.read("./spotify_appkey.key", encoding: "BINARY")
+$username = env("SPOTIFY_USERNAME")
+$password = env("SPOTIFY_PASSWORD")

data/examples/loading-object_example.rb

@@ -0,0 +1,46 @@
+#!/usr/bin/env ruby
+# encoding: utf-8
+
+require_relative "example_support"
+
+config = Spotify::SessionConfig.new({
+  api_version: Spotify::API_VERSION.to_i,
+  application_key: $appkey,
+  cache_location: ".spotify/",
+  settings_location: ".spotify/",
+  user_agent: "spotify for ruby",
+  callbacks: nil,
+})
+
+$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
+
+$logger.info "Created! Logging in."
+Spotify.session_login($session, $username, $password, false, nil)
+
+$logger.info "Log in requested. Waiting forever until logged in."
+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")
+link = Spotify.link_create_from_string(track_uri)
+
+if link.null?
+  $logger.error "Invalid URI. Aborting."
+  abort
+elsif (link_type = Spotify.link_type(link)) != :track
+  $logger.error "Was #{link_type} URI. Needs track. Aborting."
+  abort
+else
+  track = Spotify.link_as_track(link)
+end
+
+$logger.info "Attempting to load track. Waiting forever until successful."
+poll($session) { Spotify.track_is_loaded(track) }
+$logger.info "Track loaded."
+
+puts Spotify.track_name(track)

data/examples/{logging-in.rb → logging-in_example.rb}

@@ -1,36 +1,7 @@
 #!/usr/bin/env ruby
 # encoding: utf-8
 
-require "bundler/setup"
-require "spotify"
-require "logger"
-
-# We use a logger to print some information on when things are happening.
-$logger = Logger.new($stderr)
-
-#
-# 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)
-    end
-    sleep(0.01)
-  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'"
-  end
-end
+require_relative "example_support"
 
 #
 # Global callback procs.
@@ -64,10 +35,9 @@ $session_callbacks = {
 # https://developer.spotify.com/technologies/libspotify/docs/12.1.45/structsp__session__config.html
 config = Spotify::SessionConfig.new({
   api_version: Spotify::API_VERSION.to_i,
-  application_key: IO.read('./spotify_appkey.key'),
+  application_key: $appkey,
   cache_location: ".spotify/",
   settings_location: ".spotify/",
-  tracefile: "spotify_tracefile.txt",
   user_agent: "spotify for ruby",
   callbacks: Spotify::SessionCallbacks.new($session_callbacks),
 })
@@ -81,7 +51,7 @@ FFI::MemoryPointer.new(Spotify::Session) do |ptr|
 end
 
 $logger.info "Created! Logging in."
-Spotify.session_login($session, env('SPOTIFY_USERNAME'), env('SPOTIFY_PASSWORD'), false, nil)
+Spotify.session_login($session, $username, $password, false, nil)
 
 $logger.info "Log in requested. Waiting forever until logged in."
 poll($session) { Spotify.session_connectionstate($session) == :logged_in }

data/lib/spotify/api/link.rb

@@ -1,7 +1,7 @@
 module Spotify
   class API
     # @!group Link
-    attach_function :link_create_from_string, [ UTF8String ], Link
+    attach_function :link_create_from_string, [ BestEffortString ], Link
     attach_function :link_create_from_track, [ Track, :int ], Link
     attach_function :link_create_from_album, [ Album ], Link
     attach_function :link_create_from_artist, [ Artist ], Link

data/lib/spotify/types.rb

@@ -2,3 +2,4 @@ require 'spotify/types/utf8_string'
 require 'spotify/types/utf8_string_pointer'
 require 'spotify/types/image_id'
 require 'spotify/types/byte_string'
+require 'spotify/types/best_effort_string'

data/lib/spotify/types/best_effort_string.rb

@@ -0,0 +1,21 @@
+# encoding: utf-8
+module Spotify
+  # A regular string type, ending at the first NULL byte.
+  #
+  # Regular FFI :string raises errors when it encounters NULLs.
+  module BestEffortString
+    extend FFI::DataConverter
+    native_type FFI::Type::STRING
+
+    class << self
+      # Extracts all of the string up until the first NULL byte.
+      #
+      # @param [String, nil] value
+      # @param ctx
+      # @return [String] value, up until the first NULL byte
+      def to_native(value, ctx)
+        value && value.dup.force_encoding("BINARY")[/[^\x00]*/n]
+      end
+    end
+  end
+end

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.1'
+  VERSION = '12.5.2'
 
   # @return [String] Compatible libspotify API version.
   API_VERSION = '12.1.51'

data/spec/spec_helper.rb

@@ -2,6 +2,7 @@
 require "rbgccxml"
 require "rspec"
 require "pry"
+require "stringio"
 
 require "spec/support/hook_spotify"
 require "spec/support/spotify_util"
@@ -27,4 +28,19 @@ RSpec.configure do |config|
     required_version = Gem::Requirement.new(requirement)
     ! required_version.satisfied_by?(ruby_version)
   end)
+
+  config.around(:each) do |test|
+    stderr, $stderr = $stderr, StringIO.new("")
+    begin
+      test.run
+      $stderr.rewind
+      warnings = $stderr.read
+      if warnings =~ %r"lib/spotify"
+        stderr.write(warnings)
+        raise "#{example.description.inspect} caused a warning, #{warnings.inspect}"
+      end
+    ensure
+      $stderr = stderr
+    end
+  end
 end

data/spec/spotify/types/best_effort_string_spec.rb

@@ -0,0 +1,22 @@
+# encoding: utf-8
+describe Spotify::BestEffortString do
+  describe "#to_native" do
+    it "simply reads a null-terminated string" do
+      source = "hello wörld"
+      string = Spotify::BestEffortString.to_native(source, nil)
+      string.should eq "hello wörld".force_encoding("BINARY")
+    end
+
+    it "cuts the string at the first encountered NULL-byte" do
+      source = "hello\x00wörld".force_encoding("BINARY")
+      string = Spotify::BestEffortString.to_native(source, nil)
+      string.should eq "hello".force_encoding("BINARY")
+    end
+
+    it "treats empty string as empty string, and not null" do
+      source = ""
+      string = Spotify::BestEffortString.to_native(source, nil)
+      string.should eq "".force_encoding("BINARY")
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: spotify
 version: !ruby/object:Gem::Version
-  version: 12.5.1
+  version: 12.5.2
 platform: ruby
 authors:
 - Kim Burgestrand
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-24 00:00:00.000000000 Z
+date: 2013-06-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -103,8 +103,11 @@ files:
 - Rakefile
 - examples/.gitignore
 - examples/README.md
-- examples/audio-stream.rb
-- examples/logging-in.rb
+- examples/audio-stream_example.rb
+- examples/console_example.rb
+- examples/example_support.rb
+- examples/loading-object_example.rb
+- examples/logging-in_example.rb
 - lib/spotify.rb
 - lib/spotify/api.rb
 - lib/spotify/api/album.rb
@@ -152,6 +155,7 @@ files:
 - lib/spotify/structs/subscribers.rb
 - lib/spotify/type_safety.rb
 - lib/spotify/types.rb
+- lib/spotify/types/best_effort_string.rb
 - lib/spotify/types/byte_string.rb
 - lib/spotify/types/image_id.rb
 - lib/spotify/types/utf8_string.rb
@@ -173,6 +177,7 @@ files:
 - spec/spotify/structs/subscribers_spec.rb
 - spec/spotify/structs_spec.rb
 - spec/spotify/type_safety_spec.rb
+- spec/spotify/types/best_effort_string_spec.rb
 - spec/spotify/types/byte_string_spec.rb
 - spec/spotify/types/image_id_spec.rb
 - spec/spotify/types/utf8_string_pointer_spec.rb
@@ -226,6 +231,7 @@ test_files:
 - spec/spotify/structs/subscribers_spec.rb
 - spec/spotify/structs_spec.rb
 - spec/spotify/type_safety_spec.rb
+- spec/spotify/types/best_effort_string_spec.rb
 - spec/spotify/types/byte_string_spec.rb
 - spec/spotify/types/image_id_spec.rb
 - spec/spotify/types/utf8_string_pointer_spec.rb