[bump to 0.2.4] Added support for position_ms in Spotify::SDK::Connect::Device#play! (#61)

* Added support for position_ms in Spotify::SDK::Connect::Device#play!

* bumped version to 0.2.4

Author: bih

.rubocop.yml

@@ -14,7 +14,7 @@ Metrics/LineLength:
 # Too short methods lead to extraction of single-use methods, which can make
 # the code easier to read (by naming things), but can also clutter the class
 Metrics/MethodLength:
-  Max: 20
+  Max: 25
 
 # The guiding principle of classes is SRP, SRP can't be accurately measured by LoC
 Metrics/ClassLength:

lib/spotify/sdk/connect/device.rb

@@ -76,37 +76,65 @@ def playback
         #
         #   # Play from a playlist, album from a specific index in that list.
         #   # For example, play the 9th item on X playlist.
-        #   device.play!(index: 5, context: "spotify:album:5ht7ItJgpBH7W6vJ5BqpPr")
+        #   device.play!(
+        #     index: 5,
+        #     context: "spotify:album:5ht7ItJgpBH7W6vJ5BqpPr",
+        #     position_ms: 0
+        #   )
         #
         #   # Play any Spotify URI. Albums, artists, tracks, playlists, and more.
-        #   device.play!(uri: "spotify:track:5MqkZd7a7u7N7hKMqquL2U")
+        #   device.play!(
+        #     uri: "spotify:track:5MqkZd7a7u7N7hKMqquL2U",
+        #     position_ms: 0
+        #   )
         #
         #   # Similar to just uri, but you can define the context.
         #   # Useful for playing a track that is part of a playlist, and you want the next
         #   # songs to play from that particular context.
-        #   device.play!(uri: "spotify:track:5MqkZd7a7u7N7hKMqquL2U", context: "spotify:album:5ht7ItJgpBH7W6vJ5BqpPr")
+        #   device.play!(
+        #     uri: "spotify:track:5MqkZd7a7u7N7hKMqquL2U",
+        #     context: "spotify:album:5ht7ItJgpBH7W6vJ5BqpPr",
+        #     position_ms: 0
+        #   )
+        #
+        #   # Play a track, and immediately seek to 60 seconds.
+        #   device.play!(
+        #     index: 5,
+        #     context: "spotify:album:5ht7ItJgpBH7W6vJ5BqpPr",
+        #     position_ms: 60 * 1000
+        #   )
         #
         # @see https://developer.spotify.com/console/put-play/
         #
         # @param [Hash] config The play config you'd like to set. See code examples.
         # @return [Spotify::SDK::Connect::Device] self Return itself, so chained methods can be supported.
         #
+        # rubocop:disable AbcSize
         def play!(config)
           payload = case config.keys
-                    when %i[index context]
-                      {context_uri: config[:context], offset: {position: config[:index]}}
-                    when %i[uri]
-                      {uris: [config[:uri]]}
-                    when %i[uri context]
-                      {context_uri: config[:context], offset: {uri: config[:uri]}}
+                    when %i[index context position_ms]
+                      {context_uri: config[:context],
+                       offset:      {position: config[:index]},
+                       position_ms: config[:position_ms]}
+                    when %i[uri position_ms]
+                      {uris:        [config[:uri]],
+                       position_ms: config[:position_ms]}
+                    when %i[uri context position_ms]
+                      {context_uri: config[:context],
+                       offset:      {uri: config[:uri]},
+                       position_ms: config[:position_ms]}
                     else
-                      raise "Unrecognized play instructions. See documentation for details."
+                      raise <<-ERROR.strip_heredoc.strip
+                        Unrecognized play instructions.
+                        See https://www.rubydoc.info/github/bih/spotify-ruby/Spotify/SDK/Connect/Device#play!-instance_method for details.
+                      ERROR
                     end
 
           parent.send_http_request(:put, "/v1/me/player/play?device_id=%s" % id, http_options: {expect_nil: true},
                                                                                  body:         payload.to_json)
           self
         end
+        # rubocop:enable AbcSize
 
         ##
         # Resume the currently playing track on device.

lib/spotify/version.rb

@@ -12,5 +12,5 @@ module Spotify
   # MINOR version when you add functionality in a backwards-compatible manner, and
   # PATCH version when you make backwards-compatible bug fixes.
   #
-  VERSION = "0.2.3"
+  VERSION = "0.2.4"
 end

spec/lib/spotify/sdk/connect/device_spec.rb

@@ -55,33 +55,39 @@
   end
 
   describe "#play!" do
-    it "from context and an index, should make an api call" do
+    it "from context, an index, and playback_ms, should make an api call" do
       stub = stub_request(:put, "https://api.spotify.com/v1/me/player/play?device_id=#{raw_data[:id]}")
-             .with(body:    {context_uri: "spotify:album:5ht7ItJgpBH7W6vJ5BqpPr", offset: {position: 5}}.to_json,
+             .with(body:    {context_uri: "spotify:album:5ht7ItJgpBH7W6vJ5BqpPr", offset: {position: 5}, position_ms: 0}.to_json,
                    headers: {Authorization: "Bearer access_token"})
 
-      subject.play!(index: 5, context: "spotify:album:5ht7ItJgpBH7W6vJ5BqpPr")
+      subject.play!(index: 5, context: "spotify:album:5ht7ItJgpBH7W6vJ5BqpPr", position_ms: 0)
       expect(stub).to have_been_requested
     end
 
-    it "from a uri, should make an api call" do
+    it "from a uri and playback_ms, should make an api call" do
       stub = stub_request(:put, "https://api.spotify.com/v1/me/player/play?device_id=#{raw_data[:id]}")
-             .with(body:    {uris: ["spotify:track:5MqkZd7a7u7N7hKMqquL2U"]}.to_json,
+             .with(body:    {uris: ["spotify:track:5MqkZd7a7u7N7hKMqquL2U"], position_ms: 123}.to_json,
                    headers: {Authorization: "Bearer access_token"})
 
-      subject.play!(uri: "spotify:track:5MqkZd7a7u7N7hKMqquL2U")
+      subject.play!(uri: "spotify:track:5MqkZd7a7u7N7hKMqquL2U", position_ms: 123)
       expect(stub).to have_been_requested
     end
 
-    it "from a context and uri, should make an api call" do
+    it "from a context, uri, and playback_ms, should make an api call" do
       stub = stub_request(:put, "https://api.spotify.com/v1/me/player/play?device_id=#{raw_data[:id]}")
              .with(body:    {
                context_uri: "spotify:album:5ht7ItJgpBH7W6vJ5BqpPr",
-               offset:      {uri: "spotify:track:5MqkZd7a7u7N7hKMqquL2U"}
+               offset:      {uri: "spotify:track:5MqkZd7a7u7N7hKMqquL2U"},
+               position_ms: 456
              }.to_json,
                    headers: {Authorization: "Bearer access_token"})
 
-      subject.play!(uri: "spotify:track:5MqkZd7a7u7N7hKMqquL2U", context: "spotify:album:5ht7ItJgpBH7W6vJ5BqpPr")
+      subject.play!(
+        uri:         "spotify:track:5MqkZd7a7u7N7hKMqquL2U",
+        context:     "spotify:album:5ht7ItJgpBH7W6vJ5BqpPr",
+        position_ms: 456
+      )
+
       expect(stub).to have_been_requested
     end