spotify-ruby-kev 0.2.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 052e7b0ae6c4d5b62e7732748a0e1c7e217a33557b447ef0baedd23f33d6aaa7
+  data.tar.gz: f981008c955f23c8651a2b854687ad41dcaa64588d20560c6bf67d916721d600
+SHA512:
+  metadata.gz: 1898406732975c2cfceed39a7f86ed5b1f74a818c1dc745182b9f2478e58252d211d7ebd3a36c505917dd2b5f0b9b41668da020f6bba44a03248c996544e7536
+  data.tar.gz: cd047de9bd23771464e4d2456c12676981702d6155804cd728aa8d04714343e319092884e242fe700dbbecbb0d1c2d4cff170dd85b1c42679e57688c79450ce1

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/.gitignore

@@ -0,0 +1,24 @@
+/.yardoc
+/Gemfile.lock
+/.bundle/
+/_yardoc/
+/coverage/
+/doc/
+/html/
+/pkg/
+/spec/reports/
+/tmp/
+/.local/
+
+# local console
+/bin/console_local
+
+# jekyll rendered site
+/docs/_site
+/docs/.sass-cache
+/docs/.jekyll-metadata
+
+# rspec failure tracking
+.rspec_status
+.coveralls.yml
+.DS_Store

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,161 @@
+AllCops:
+  Exclude:
+    - 'bin/console'
+    - 'bin/console_local'
+    - 'bin/generate_model'
+    - 'bin/generate_component'
+
+# Commonly used screens these days easily fit more than 80 characters.
+Metrics/LineLength:
+  Max: 120
+  Exclude:
+    - 'spec/**/*.rb'
+
+# 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: 25
+
+# The guiding principle of classes is SRP, SRP can't be accurately measured by LoC
+Metrics/ClassLength:
+  Max: 1500
+  Exclude:
+    - 'spec/**/*.rb'
+
+# The size of a block for a method.
+Metrics/BlockLength:
+  CountComments: false
+  Max: 25
+  ExcludedMethods: []
+  Exclude:
+    - '*.gemspec'
+    - 'spec/**/*.rb'
+
+# No space makes the method definition shorter and differentiates
+# from a regular assignment.
+Layout/SpaceAroundEqualsInParameterDefault:
+  EnforcedStyle: no_space
+
+# Single quotes being faster is hardly measurable and only affects parse time.
+# Enforcing double quotes reduces the times where you need to change them
+# when introducing an interpolation. Use single quotes only if their semantics
+# are needed.
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+# We do not need to support Ruby 1.9, so this is good to use.
+Style/SymbolArray:
+  Enabled: true
+
+# Most readable form.
+Layout/AlignHash:
+  EnforcedHashRocketStyle: table
+  EnforcedColonStyle: table
+
+# Mixing the styles looks just silly.
+Style/HashSyntax:
+  EnforcedStyle: ruby19_no_mixed_keys
+
+# has_key? and has_value? are far more readable than key? and value?
+Style/PreferredHashMethods:
+  Enabled: false
+
+# String#% is by far the least verbose and only object oriented variant.
+Style/FormatString:
+  EnforcedStyle: percent
+
+Style/CollectionMethods:
+  Enabled: true
+  PreferredMethods:
+    # inject seems more common in the community.
+    reduce: "inject"
+
+
+# Either allow this style or don't. Marking it as safe with parenthesis
+# is silly. Let's try to live without them for now.
+Style/ParenthesesAroundCondition:
+  AllowSafeAssignment: false
+Lint/AssignmentInCondition:
+  AllowSafeAssignment: false
+
+# A specialized exception class will take one or more arguments and construct the message from it.
+# So both variants make sense.
+Style/RaiseArgs:
+  Enabled: false
+
+# Indenting the chained dots beneath each other is not supported by this cop,
+# see https://github.com/bbatsov/rubocop/issues/1633
+Layout/MultilineOperationIndentation:
+  Enabled: false
+
+# Fail is an alias of raise. Avoid aliases, it's more cognitive load for no gain.
+# The argument that fail should be used to abort the program is wrong too,
+# there's Kernel#abort for that.
+Style/SignalException:
+  EnforcedStyle: only_raise
+
+# Use of alias_method in a class body context.
+Style/Alias:
+  Enabled: false
+
+# Suppressing exceptions can be perfectly fine, and be it to avoid to
+# explicitly type nil into the rescue since that's what you want to return,
+# or suppressing LoadError for optional dependencies
+Lint/HandleExceptions:
+  Enabled: false
+
+Layout/SpaceInsideBlockBraces:
+  # The space here provides no real gain in readability while consuming
+  # horizontal space that could be used for a better parameter name.
+  # Also {| differentiates better from a hash than { | does.
+  SpaceBeforeBlockParameters: false
+
+# No trailing space differentiates better from the block:
+# foo} means hash, foo } means block.
+Layout/SpaceInsideHashLiteralBraces:
+  EnforcedStyle: no_space
+
+# { ... } for multi-line blocks is okay, follow Weirichs rule instead:
+# https://web.archive.org/web/20140221124509/http://onestepback.org/index.cgi/Tech/Ruby/BraceVsDoEnd.rdoc
+Style/BlockDelimiters:
+  Enabled: false
+
+# do / end blocks should be used for side effects,
+# methods that run a block for side effects and have
+# a useful return value are rare, assign the return
+# value to a local variable for those cases.
+Style/MethodCalledOnDoEndBlock:
+  Enabled: true
+
+# Enforcing the names of variables? To single letter ones? Just no.
+Style/SingleLineBlockParams:
+  Enabled: false
+
+# Shadowing outer local variables with block parameters is often useful
+# to not reinvent a new name for the same thing, it highlights the relation
+# between the outer variable and the parameter. The cases where it's actually
+# confusing are rare, and usually bad for other reasons already, for example
+# because the method is too long.
+Lint/ShadowingOuterLocalVariable:
+  Enabled: false
+
+# Check with yard instead.
+Style/Documentation:
+  Enabled: false
+
+# This is just silly. Calling the argument `other` in all cases makes no sense.
+Naming/BinaryOperatorParameterName:
+  Enabled: false
+
+# There are valid cases, for example debugging Cucumber steps,
+# also they'll fail CI anyway
+Lint/Debugger:
+  Enabled: false
+
+# Style preference
+Style/MethodDefParentheses:
+  Enabled: false
+
+# Disable annotated tokens
+Style/FormatStringToken:
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+2.6.3

data/.rvm-version

@@ -0,0 +1 @@
+2.6.3

data/.travis.yml

@@ -0,0 +1,17 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.0
+  - 2.4.1
+  - 2.5.0
+  - 2.5.1
+before_install: >
+  gem install bundler -v 2.1.4
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
+script:
+  - rake ci
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at bil@spotify.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/COVERAGE.md

@@ -0,0 +1,148 @@
+# Spotify API Coverage
+
+This covers all the Spotify API endpoints that are covered.
+
+### Albums Endpoints
+
+| Endpoint                   | Description           | Coverage Status |
+| -------------------------- | --------------------- | --------------- |
+| GET /v1/albums             | Get Several Albums    | × Not Started   |
+| GET /v1/albums/{id}/tracks | Get an Album's Tracks | × Not Started   |
+
+### Artists Endpoints
+
+| Endpoint                             | Description                     | Coverage Status |
+| ------------------------------------ | ------------------------------- | --------------- |
+| GET /v1/artists                      | Get Several Artists             | × Not Started   |
+| GET /v1/artists/{id}/albums          | Get an Artist's Albums          | × Not Started   |
+| GET /v1/artists/{id}/top-tracks      | Get an Artist's Top Tracks      | × Not Started   |
+| GET /v1/artists/{id}/related-artists | Get an Artist's Related Artists | × Not Started   |
+
+### Tracks Endpoints
+
+| Endpoint       | Description        | Coverage Status |
+| -------------- | ------------------ | --------------- |
+| GET /v1/tracks | Get Several Tracks | × Not Started   |
+
+### Audio Features Endpoints
+
+| Endpoint                    | Description                           | Coverage Status |
+| --------------------------- | ------------------------------------- | --------------- |
+| GET /v1/audio-features/{id} | Get Audio Features for a Track        | × Not Started   |
+| GET /v1/audio-features      | Get Audio Features for Several Tracks | × Not Started   |
+
+### Analysis Endpoints
+
+| Endpoint                    | Description                    | Coverage Status |
+| --------------------------- | ------------------------------ | --------------- |
+| GET /v1/audio-analysis/{id} | Get Audio Analysis for a Track | × Not Started   |
+
+### Search Endpoints
+
+| Endpoint       | Description        | Coverage Status |
+| -------------- | ------------------ | --------------- |
+| GET /v1/search | Search for an Item | × Not Started   |
+
+### Users Endpoints
+
+| Endpoint                | Description                | Coverage Status |
+| ----------------------- | -------------------------- | --------------- |
+| GET /v1/users/{user_id} | Get a User's Profile       | ×               |
+| GET /v1/me              | Get Current User's Profile | [me/info.rb]    |
+
+### Saved Content Endpoints
+
+| Endpoint                   | Description                       | Coverage Status |
+| -------------------------- | --------------------------------- | --------------- |
+| GET /v1/me/tracks          | Get Current User's Saved Tracks   | × Not Started   |
+| GET /v1/me/tracks/contains | Check Current User's Saved Tracks | × Not Started   |
+| PUT /v1/me/tracks          | Save Tracks for Current User      | × Not Started   |
+| DELETE /v1/me/tracks       | Remove Tracks for Current User    | × Not Started   |
+| GET /v1/me/albums          | Get Current User's Saved Albums   | × Not Started   |
+| GET /v1/me/albums/contains | Check Current User's Saved Albums | × Not Started   |
+| PUT /v1/me/albums          | Save Albums for Current User      | × Not Started   |
+| DELETE /v1/me/albums       | Remove Albums for Current User    | × Not Started   |
+
+### Discovery Endpoints
+
+| Endpoint                          | Description                      | Coverage Status |
+| --------------------------------- | -------------------------------- | --------------- |
+| GET /v1/browse/new-releases       | Get a List of New Releases       | × Not Started   |
+| GET /v1/browse/featured-playlists | Get a List of Featured Playlists | × Not Started   |
+
+### Categories Endpoints
+
+| Endpoint                                          | Description                     | Coverage Status |
+| ------------------------------------------------- | ------------------------------- | --------------- |
+| GET /v1/browse/categories                         | Get a List of Browse Categories | × Not Started   |
+| GET /v1/browse/categories/{category_id}           | Get a Single Browse Category    | × Not Started   |
+| GET /v1/browse/categories/{category_id}/playlists | Get a Category's playlists      | × Not Started   |
+
+### Recommendation Endpoints
+
+| Endpoint                                      | Description                        | Coverage Status |
+| --------------------------------------------- | ---------------------------------- | --------------- |
+| GET /v1/recommendations                       | Get Recommendations Based on Seeds | × Not Started   |
+| GET /v1/recommendations/available-genre-seeds | Get Available Genre Seeds          | × Not Started   |
+
+### Follow Endpoints
+
+| Endpoint                                                           | Description                                    | Coverage Status                                                      |
+| ------------------------------------------------------------------ | ---------------------------------------------- | -------------------------------------------------------------------- |
+| GET /v1/me/following                                               | Get Followed Artists                           | [me.rb]                                                              |
+| GET /v1/me/following/contains                                      | Check if Current User Follows Artists or Users | [me.rb]                                                              |
+| PUT /v1/me/following                                               | Follow Artists or Users                        | [🔘 Partial Support][artist.rb] (Following multiple not supported)   |
+| DELETE /v1/me/following                                            | Unfollow Artists or Users                      | [🔘 Partial Support][artist.rb] (Unfollowing multiple not supported) |
+| GET /v1/users/{user_id}/playlists/{playlist_id}/followers/contains | Check if Users Follow a Playlist               | × Not Started                                                        |
+| PUT /v1/users/{user_id}/playlists/{playlist_id}/followers          | Follow a Playlist                              | × Not Started                                                        |
+| DELETE /v1/users/{user_id}/playlists/{playlist_id}/followers       | Unfollow a Playlist                            | × Not Started                                                        |
+
+### Playlists Endpoints
+
+| Endpoint                                                  | Description                            | Coverage Status |
+| --------------------------------------------------------- | -------------------------------------- | --------------- |
+| GET /v1/users/{user_id}/playlists                         | Get a List of a User's Playlists       | × Not Started   |
+| GET /v1/me/playlists                                      | Get a List of Current User's Playlists | × Not Started   |
+| GET /v1/users/{user_id}/playlists/{playlist_id}           | Get a Playlist                         | × Not Started   |
+| GET /v1/users/{user_id}/playlists/{playlist_id}/tracks    | Get a Playlist's Tracks                | × Not Started   |
+| POST /v1/users/{user_id}/playlists                        | Create a Playlist                      | × Not Started   |
+| POST /v1/users/{user_id}/playlists/{playlist_id}/tracks   | Add Tracks to a Playlist               | × Not Started   |
+| DELETE /v1/users/{user_id}/playlists/{playlist_id}/tracks | Remove Tracks from a Playlist          | × Not Started   |
+| PUT /v1/users/{user_id}/playlists/{playlist_id}/tracks    | Reorder or replace a Playlist's Tracks | × Not Started   |
+| PUT /v1/users/{user_id}/playlists/{playlist_id}           | Change a Playlist's Details            | × Not Started   |
+
+### History Endpoints
+
+| Endpoint                          | Description                                   | Coverage Status         |
+| --------------------------------- | --------------------------------------------- | ----------------------- |
+| GET /v1/me/top/{type}             | Get User's Top Artists and Tracks             | × Not Started           |
+| GET /v1/me/player/recently-played | Get the Current User's Recently Played Tracks | [Full support ✔][me.rb] |
+
+### Connect Endpoints
+
+| Endpoint                  | Description                                       | Coverage Status                             |
+| ------------------------- | ------------------------------------------------- | ------------------------------------------- |
+| GET /v1/me/player         | Get Information About The User's Current Playback | [Full support ✔][connect/playback_state.rb] |
+| GET /v1/me/player/devices | Get a User's Available Devices                    | [Full support ✔][connect.rb]                |
+| PUT /v1/me/player         | Transfer a User's Playback                        | [Full support ✔][connect/device.rb]         |
+
+### Player Endpoints
+
+| Endpoint                            | Description                                 | Coverage Status                     |
+| ----------------------------------- | ------------------------------------------- | ----------------------------------- |
+| GET /v1/me/player/currently-playing | Get the User's Currently Playing Track      | × Not implementing                  |
+| PUT /v1/me/player/play              | Start/Resume a User's Playback              | [Full support ✔][connect/device.rb] |
+| PUT /v1/me/player/pause             | Pause a User's Playback                     | [Full support ✔][connect/device.rb] |
+| POST /v1/me/player/next             | Skip User's Playback To Next Track          | [Full support ✔][connect/device.rb] |
+| POST /v1/me/player/previous         | Skip User's Playback To Previous Track      | [Full support ✔][connect/device.rb] |
+| PUT /v1/me/player/seek              | Seek To Position In Currently Playing Track | [Full support ✔][connect/device.rb] |
+| PUT /v1/me/player/repeat            | Set Repeat Mode On User's Playback          | [Full support ✔][connect/device.rb] |
+| PUT /v1/me/player/volume            | Set Volume For User's Playback              | [Full support ✔][connect/device.rb] |
+| PUT /v1/me/player/shuffle           | Toggle Shuffle For User's Playback          | [Full support ✔][connect/device.rb] |
+
+[connect.rb]: /lib/spotify/sdk/connect.rb
+[connect/playback_state.rb]: /lib/spotify/sdk/connect/playback_state.rb
+[connect/device.rb]: /lib/spotify/sdk/connect/device.rb
+[artist.rb]: /lib/spotify/sdk/artist.rb
+[me.rb]: /lib/spotify/sdk/me.rb
+[me/info.rb]: /lib/spotify/sdk/me/info.rb