spotify-wrapper-tdd-course

Spotify Wrapper

A wrapper to work with the Spotify Web API

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Browser Support

This library relies on Fetch API. And this API is supported in the following browsers.

39+ ✔	42+ ✔	29+ ✔	10.1+ ✔	Nope ✘

Dependencies

This library depends on fetch to make requests to the Spotify Web API. For envirioments tha don't support fetch, you'll need to provide a pollyfill to browser or pollyfill to Node.

Installing

$ npm install spotify-wrapper-tdd-course --save

How to use

ES

// Import
import SpotifyWrapper from 'spotify-wrapper-tdd-course';

const spotify = new SpotifyWrapper({
  token: 'YOUR_TOKEN_HERE'
});

// Using his methods
spotify.search.artists('Pearl Jam');

CommonJS

var spotifyWrapper = require("spotify-wrapper-tdd-course");

const spotify = new SpotifyWrapper({
  token: 'YOUR_TOKEN_HERE'
});

// Using his methods
spotify.search.artists('Pearl Jam');

UMD in Browser

<!-- to import non-minified version -->
<script src="spotifyWrapper.umd.js"></script>
<!-- to import minified version -->
<script src="spotifyWrapper.umd.min.js"></script>

After that the library will be available to the Global as SpotifyWrapper. Follow an example:

const spotify = new SpotifyWrapper({
  token: 'YOUR_TOKEN_HERE'
});

// Using his methods
spotify.search.artists('Pearl Jam');

const albums = spotify.search.albums('Choosen Artist');

Methods

Follow the methods that the library provides.

spotify.search exmples:

albums(query)

Search for informations about Albums with provided query. Test in Spotify Web Console with type defined as album.

Arguments

Argument	Type	Options
query	string	'Any search query'

Example

spotify.search.albums('Incubus')
  .then(data => {
    // do what you want with the data
  })

artists(query)

Search for informations about Artists with provided query. Test in Spotify Web Console with type defined as artist.

Arguments

Argument	Type	Options
query	string	'Any search query'

Example

spotify.search.artists('Incubus')
  .then(data => {
    // do what you want with the data
  })

tracks(query)

Search for informations about Tracks with provided query. Test in Spotify Web Console with type defined as track.

Arguments

Argument	Type	Options
query	string	'Any search query'

Example

spotify.search.tracks('Drive')
  .then(data => {
    // do what you want with the data
  })

playLists(query)

Search for informations about Playlist with provided query. Test in Spotify Web Console with type defined as playlist.

Arguments

Argument	Type	Options
query	string	'Any search query'

Example

spotify.search.playLists('Happy Day')
  .then(data => {
    // do what you want with the data
  })

spotify.album exmples:

getAlbum(id)

Search for informations about a specific Album with provided id. Test in Spotify Web Console.

Arguments

Argument	Type	Options
id	string	'Specific id'

Example

spotify.album.getAlbum('4aawyAB9vmqN3uQ7FjRGTy')
  .then(data => {
    // do what you want with the data
  })

getAlbums(ids)

Search for informations about some Albums with all id's. Test in Spotify Web Console.

Arguments

Argument	Type	Options
ids	Array of strings	['id1', 'id2']

Example

spotify.album.getAlbum(['4aawyAB9vmqN3uQ7FjRGTy', '1A2GTWGtFfWp7KSQTwWOyo'])
  .then(data => {
    // do what you want with the data
  })

getAlbumTracks(id)

Search for all tracks in a specific Album with provided id. Test in Spotify Web Console.

Arguments

Argument	Type	Options
id	string	'Specific id'

Example

spotify.album.getAlbum('4aawyAB9vmqN3uQ7FjRGTy')
  .then(data => {
    // do what you want with the data
  })

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

Mateus Fernando

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE.md file for details