spotify-ruby 0.2.3 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 118af1b2f6ab08785aa78c8028bf7927003154a1
-  data.tar.gz: 2d655193db96272b01a9f90aef9964c5a482e324
+  metadata.gz: 75f97a2dfbc52f0a0aced0874048df14cf32f1d2
+  data.tar.gz: 2071351feb0057354dd40bbc2a44d9d4c5054cff
 SHA512:
-  metadata.gz: b6f4a4f4018790a020e3ebd1b926b6ceda2ce0fe8a5fc3d807cd2da87b81489ae19a68d1b3236eb59cb9bf1ecdbb74b51fe1a71900486b93719eaa490df63714
-  data.tar.gz: b2e0da362c7786da52a7eee27f1a1277f5f953fa499c82b7d615b97745f27e9aaf043229cbdfea02ba3d91c896e06caa4375e75b9049aff2cbb385084b27fe10
+  metadata.gz: b73965a3d6c73490ceaf513921596f7c8cac65b5a849bfc6d4345841331ac493fdc0b2fff9a7f11023a8eba3e472040271b6c8832bfd6e1b6f9848b1b51f0e36
+  data.tar.gz: b9646f1e3222f601010059a1330c7d31b18c9baac520460d1696d3ea5ea1f33d7cabe633223b609a47a2195c9211df3b2e96d9eae8cc067dd1af09b3718dfc0c

data/.github/CONTRIBUTING.md

@@ -0,0 +1,3 @@
+👍🎉 First off, thanks for taking the time to contribute! 🎉👍
+
+Please refer to these [guidelines](https://bih.github.io/spotify-ruby/documentation/contributing/) for details.

data/.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,27 @@
+*Before you log an issue, please, make sure
+that the problem you're reporting
+hasn't been reported (and potentially fixed) already.*
+
+*Please provide an unambiguous title for the issue.
+Be clear and precise in your description of the problem.
+Use the template below when reporting bugs*
+
+*Before filing the ticket you should replace all text above the horizontal
+rule with your own words.*
+
+--------
+
+## Expected behavior
+
+Describe here how you expected spotify-ruby to behave in this particular situation.
+
+## Actual behavior
+
+Describe here what actually happened.
+
+## Steps to reproduce the problem
+
+This is extremely important! Providing us with a reliable way to reproduce
+a problem will expedite its solution.
+
+## Spotify-ruby version

data/.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:

data/lib/spotify/sdk/connect/device.rb

@@ -76,37 +76,65 @@ module Spotify
         #
         #   # 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.

data/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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: spotify-ruby
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.2.4
 platform: ruby
 authors:
 - Bilawal Hameed
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-06 00:00:00.000000000 Z
+date: 2018-09-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -226,6 +226,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/CONTRIBUTING.md"
+- ".github/ISSUE_TEMPLATE.md"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -282,4 +284,3 @@ signing_key:
 specification_version: 4
 summary: The developer-friendly, opinionated Ruby SDK for Spotify.
 test_files: []
-has_rdoc: