Skip to content

[WIP] Refactor and API Redesign#70

Open
adammw wants to merge 109 commits intoTooTallNate:masterfrom
adammw:api-redesign
Open

[WIP] Refactor and API Redesign#70
adammw wants to merge 109 commits intoTooTallNate:masterfrom
adammw:api-redesign

Conversation

@adammw
Copy link
Collaborator

@adammw adammw commented Feb 14, 2014

🚧

Ref: #56

Loosely based off this design proposal.

⚠️ Expect breaking changes ⚠️

📝 comments welcome 📝

Classes

  • SpotifyUri
  • Connection
  •   Request
  •   Response
  •   HermesRequest
  •   HermesResponse
  • Metadata
  •   Album
  •   Artists
  •   Tracks
  •   PlaySession
  • Playlists
  •   Playlist
  •   PlaylistAttributes
  •   PlaylistChange
  •   PlaylistContents
  •   PlaylistItem
  •   PlaylistRevision
  • Radio
  • Users

TODOs / Wishlist

  • Move connection-related code to Connection class
  • Move request-related code to Request/HermesRequest/Response/HermesResponse class
  • Pluggable command handling API would be nice, otherwise eventemitter is fine, just have to not warn about unhandled events. (think think)
  • Request Queueing and auto-reconnection on disconnection (handle the 'disconnect' command)
  • Automatic subscribe / unsubscribe on Playlist events
  • Support playlist events
  • Make playlist class work with rootlists
  • Playlist add/move/delete methods
  • Remove old code from spotify.js
  • Support caching of Hermes calls
  • Work out how to share state between objects (e.g. two playlist instances for the same url shouldn't have to make two calls, two subscriptions, etc. - although subscriptions should have code to stop this being a real problem)
  • jslint / jshint
  • Backwards compatibility stubs
  • Remove debugging logspew
  • Test everything manually
  • Docs
  • Automated testing (e.g. Travis CI - would be nice, but is probably asking too much)

adammw added 30 commits February 14, 2014 20:05
@adammw
Add Request / Response classes
cce3a49
@adammw
Add HermesRequest / HermesResponse classes
ac7c11e
@adammw
Move request / response classes to "connection" folder
42f0392
@adammw
Create Connection class to handle the WebSocket connection
0584a37
@adammw
error: move to connection folder
069b533
@adammw
connection: add missing event handlers
ed2d245
@adammw
spotify: use SpotifyConnection
eb3e5b7
@adammw
connection: fix typos
08312e9
@adammw
util: add export decorator
41610c9
@adammw
connection: use export decorator
417ec36
@adammw
request: handle multiple callbacks
3bba62f
@adammw
connection: separate sending request from flushing queue
3ede1a2
@adammw
connection: fix bugs preventing connection completing
a95558b
@adammw
request: add missing require()
58cb89d
@adammw
Merge remote-tracking branch 'origin/ping_flash_2' into api-redesign
035cb1b 
Conflicts:
	lib/spotify.js
@adammw
remove unintentionally committed file
fc74bea
@adammw
request: add debugging call and fix hasCallback function
31dfafb
@adammw
connection: fix _startHeartbeat function
4872677
@adammw
connection: add debugging message for connect event
b1153eb
@adammw
Add SpotifyUri class
8a2dc06
@adammw
util: use uri conversion functions from SpotifyUri
4304a67
@adammw
util: export what is exported by export()
bae1392
@adammw
util: add caveat to export() function comment
6b4a547
@adammw
util: fix bug in export()
acc006f
@adammw
util: more export tweaks
fe3b313
@adammw
connection: specify $inject
6807948
@adammw
spotify: re-export all classes off SpotifyConnection with util.recurs…
2c6785c 
…iveExport
@adammw
util: add warning about the order of calls for export()
c43dc0d
@adammw
Move track, artist and album to metadata folder
3710b99
@adammw
metadata
7fcaf0c
@miklschmidt
Copy link

miklschmidt commented Apr 1, 2014

I really hope you have time to finish this, i started using it because of the User prototype, and it works really well. I did run into the 403 forbidden issue while playing tracks though. Dno if it would've happened using master. Need to do some more testing.

Update: Looks like just hitting track.play() again after a 403 works fine.

JChapman202 and others added 25 commits April 18, 2014 10:36
@JChapman202 @adammw
Added Spotify.Web.App.initialize() noop Function
b65c445 
Recently Spotify Web started calling the initialize() function in the
authentication script which causes an exception to be thrown while
connecting node-spotify-web.  This NOOP operation allows authentication
to complete successfully.

Conflicts:
	lib/spotify.js
@adammw
Add initial support for special playlists
b78e3d7
@adammw
Add more supported types to Spotify#get
d44c6a4
@adammw
Remove Spotify#playlist, modify Spotify#rootlist
c618a70
@adammw
Emit errors from Playlist#_performDiff
943ab62
@adammw
Fix custom header field parsing
fe2cc33
@adammw
Move rootlist method to User object
fedf382
@adammw
Parse and cache playlist attributes on contents
e195147
@adammw
Remove Spotify#similar
b9f5f39 
No longer needed now we have Track#similar
@adammw
example: add playlistEvents
8d6f1ae 
This example script demonstrates how to listen for events on the
playlist instance.
@adammw
user: add missing SpotifyUri require()
c562504
@adammw
spotify: create User object on login
03bcc31
@adammw
user: fix typo in User#rootlist
3848063
@adammw
playlist: fix scope in Playlist#contents callback
1d69693
@adammw
user: use Spotify#get in User#rootlist
a943558
@adammw
user: implement User#starred
8868c3c
@adammw
example: Update rootlist for new API
23dff23
@adammw
playlist: Make attributes optional upon creation
dde084d
@adammw
playlist: Add method to update playlist attributes
84eb34b
@adammw
playlist-contents: set index and revision on items
0a76a3b
@adammw
playlist: set index and revision on diff items
8c1166a
@adammw
playlist: add Playlist#add method
fa5bc9a
@adammw
playlist: add remove methods
df5fc9b
@adammw
playlist: automatically add created to rootlist
584a8ce
@adammw
spotify: new flash key, moved sp_log and sp_user_info commands after …
6a5e5e8 
…login_complete

Squashed commit of the following:

commit 0498c45
Author: Brandt Abbott <brandt.abbott@readytalk.com>
Date:   Sat Apr 26 07:36:26 2014 -0600

    Issue TooTallNate#81 forgot to remove calls from _onconnect, it was late at night

commit 9268e2f
Author: Brandt Abbott <brandt.abbott@readytalk.com>
Date:   Fri Apr 25 23:25:48 2014 -0600

    Issue TooTallNate#81 - New flash key.  Moved sp_log and sp_user_info commands after login_complete

Fixes TooTallNate#81.
Closes TooTallNate#82.

Conflicts:
	lib/spotify.js
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

enhancement refactor wip

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@adammw @techwraith @miklschmidt @JChapman202