simplespotify 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f4e69e9cf083380d99cf868d5c0a923e6317c96e
+  data.tar.gz: 5449320aa6f300cdccb61c8bb87a55e9c1eaf769
+SHA512:
+  metadata.gz: aa3794582c59de6c88cf09b043aef105715838cd0624fb2db0a1a2a893e3c4956d384f049abb058440436262ab2a2a681c6fe09361bbaf204cb2328f8eb6407c
+  data.tar.gz: 672fc08dc3ddbfebd102f9b416e835f238e86cb182a38a455fc642cf5539053987147cbbfc614b95b85845d865c0578ef77c93147a437219fed518796441f74d

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+local-test.rb

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.1

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in spotify-api.gemspec
+gemspec

data/LICENSE.md

@@ -0,0 +1,17 @@
+LICENCIA PATITO
+Versión 0.0.1; Septiembre, 2014
+
+Copyright (c) 2015, Roberto Hidalgo, Partido Surrealista Mexicano
+Todos los derechos reservados.
+
+La redistribución y uso como código fuente y/u objeto, con o sin modificaciones, está permitida siempre y cuando todas las siguientes condiciones sean respetadas:
+
+* La redistribución del código fuente debe mantener la nota de copyright antes mencionada, esta lista de condiciones y la renuncia de responsabilidades que acompaña esta licencia.
+La redistribución del código objeto debe mantener la nota de copyright antes mencionada, esta lista de condiciones y la renuncia de responsabilidades que acompaña esta licencia en la documentación y en cualquier otro material que se ofrezca con el código objeto.
+* El nombre "SimpleSpotify", ni el nombre de loas colaboradoreas originales podrá ser usado para promocionar o endosar productos derivados de este software sin un consentimiento previo por escrito de los mismos.
+* Todo uso de este código fuente y archivos relacionados, en su conjunto o de manera individual, así como el material publicitario que mencione las funciones del mismo deberá incluir la leyenda: "Este producto incluye software desarrollado por el Roberto Hidalgo, el Partido Surrealista Mexicano y Colaboradoreas", así como un enlace a esta licencia, y deberá indicar si se han hecho cambios al mismo.
+* Cualquier uso o implementación de este código fuente y archivos relacionados, en su conjunto o de manera individual, deberá extender los mismos derechos y obligaciones que menciona esta licencia.
+* Se prohibe el uso de este código cuándo el uso mismo incite o resulte en la discriminación de cualquier individuo o grupo de individuos, en función de su género, orientación sexual, educación y/o poder adquisitivo.
+* El uso de este código sugiere, más no exige, a los usuarioas del mismo a invitar al Partido Surrealista Mexicano y a cada uno de los Colaboradoreas unos mezcales ó bebidas no-alcoholicas de su elección, como muestra de compañerismo y buena voluntad.
+
+Este software se ofrece por los titulares de derechos de autor y colaboradores "tal cual", y cualquier garantía explícita o implícita, por ejemplo, de manera enunciativa más no limitativa, la garantía implícita de comercialización y aptitud para un propósito determinado son rechazadas. Bajo ninguna circunstancia serán responsables los titulares de derechos de autor ni colaboradores por cualquier daño directo, indirecto, incidental, especial, ejemplar o consecuente —incluyendo, pero no limitado a, la adquisición de bienes o servicios; la pérdida uso, datos o beneficios; o interrupción de la actividad empresarial—, o por cualquier teoría de responsabilidad estricta ó agravio (incluyendo negligencia, o cualquier otra causa) que surja de la posibilidad de tales daños.

data/Rakefile

@@ -0,0 +1,3 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "spotify"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/simplespotify/actions/albums.rb

@@ -0,0 +1,30 @@
+module SimpleSpotify
+  module Actions
+    module Albums
+
+      def album album, market: nil
+        response = get "albums/#{id_for(album)}", options_with_market(market, {})
+        Model::Album.new(response.body)
+      end
+
+
+      def albums *albums, market: nil
+        albums = albums.map {|a|
+          id_for(a)
+        }.join(',')
+
+        response = get "albums", options_with_market(market, {ids: albums})
+        Model::Collection.of(:albums, response.body)
+      end
+
+
+      def album_tracks album, limit: 20, offset: 0, market: nil
+        options = options_with_market(market, {limit: limit, offset: offset})
+        response = get "albums/#{id_for(album)}/tracks", options
+        Model::Collection.of(:tracks, response.body)
+      end
+
+
+    end
+  end
+end

data/lib/simplespotify/actions/artists.rb

@@ -0,0 +1,47 @@
+module SimpleSpotify
+  module Actions
+    module Artists
+
+
+      def artist artist
+        response = get "artist/#{id_for(artist)}"
+        Model::Artist.new(response.body)
+      end
+
+
+      def artists *artists
+        artists = artists.map {|a|
+          id_for(a)
+        }.join(',')
+
+        response = get "artists", {ids: artists}
+        Model::Collection.of(:artists, response.body)
+      end
+
+
+      def artist_albums artist, album_type: nil, market: nil, limit: 20, offset: 0
+        options = {album_type: album_type, limit: limit, offset: offset}
+        response = get "artists/#{id_for(artist)}/albums", options_with_market(market, options)
+        Model::Collection.of(:artists, response.body)
+      end
+
+
+      def top_tracks artist, market=nil
+        id = id_for(artist)
+        market = market || @market
+        raise "Market required for top tracks" unless market
+
+        response = get "artists/#{id}/top-tracks", {country: market}
+        Model::Collection.of(:tracks, response.body)
+      end
+
+
+      def related_artists artist
+        response = get "artists/#{id_for(artist)}/related-artists"
+        Model::Collection.of(:artists, response.body)
+      end
+
+
+    end
+  end
+end

data/lib/simplespotify/actions/browse.rb

@@ -0,0 +1,74 @@
+module SimpleSpotify
+  module Actions
+    module Browse
+
+
+      def featured_playlists locale: nil, country: nil, timestamp: nil, limit: 20, offset: 0
+        locale ||= ENV['LANG'].split('.').first if ENV['LANG']
+        timestamp = timestamp.to_time if timestamp.is_a Date
+        timestamp = timestamp.iso8601 if timestamp.is_a? Time
+
+        options = {
+          locale: locale,
+          country: country || @market,
+          timestamp: timestamp,
+          limit: limit,
+          offset: offset
+        }.reject {|k,v| v.nil? || v==''}.to_h
+
+        response = get "browse/featured-playlists", options
+        Model::Collection.of(:playlists, response.body[:playlists])
+      end
+
+
+      def new_releases country: nil, limit: 20, offset: 0
+        options = {limit: limit, offset: offset}
+        market = country || @market
+        options[:country] = market if market
+
+        response = get "browse/new-releases", options
+        Model::Collection.of(:albums, response.body[:albums])
+      end
+
+
+      def categories country: nil, locale: nil, limit: 20, offset: 0
+        options = {limit: limit, offset: offset}
+
+        market = country || @market
+        options[:country] = market if market
+
+        locale ||= ENV['LANG'].split('.').first if ENV['LANG']
+        options[:locale] = locale if locale
+
+        response = get "browse/categories", options
+        Model::Collection.of(Model::Category, response.body[:categories])
+      end
+
+
+      def category category, country: nil, locale: nil
+        options = {}
+        market = country || @market
+        options[:country] = market if market
+
+        locale ||= ENV['LANG'].split('.').first if ENV['LANG']
+        options[:locale] = locale if locale
+
+        response = get "browse/categories/#{id_for(category)}"
+        Model::Category.new(response)
+      end
+
+
+      def category_playlists category, country: nil, limit: 20, offset: 0
+        options = {limit: limit, offset: offset}
+
+        market = country || @market
+        options[:country] = market if market
+
+        response = get "browse/categories/#{id_for(category)}/playlists", options
+        Model::Collection.of(:playlists, response.body[:playlists])
+      end
+
+
+    end
+  end
+end

data/lib/simplespotify/actions/playlists.rb

@@ -0,0 +1,187 @@
+module SimpleSpotify
+  module Actions
+    module Playlists
+
+
+      def playlist owner, playlist=nil, fields:{}, market: nil
+        fields = fields.join(',') if fields.is_a? Array
+        options = {
+          fields: fields
+        }
+
+        if owner.is_a? Model::Playlist
+          playlist = owner
+          owner = playlist.owner
+        end
+
+        res = get "users/#{id_for(owner)}/playlists/#{id_for(playlist)}", options_with_market(market, options)
+        Model::Playlist.new(res.body)
+      end
+
+
+      def playlists owner, limit: 20, offset: 0
+        Model::Collection.for(:playlists, get("users/#{id_for(owner)}/playlists", {limit: limit, offset: offset}))
+      end
+
+
+      #--------------
+      # Creation/Update
+      #--------------
+      def playlist_create user, name, public: true
+        res = post "users/#{id_for(user)}/playlists", {name: name, public: public}
+        Model::Playlist.new(res.body)
+      end
+
+
+      def playlist_change_details owner, playlist=nil, name: nil, public: nil
+        data = {}
+        data[:name] = name if name
+        data[:public] = public if public
+
+        if owner.is_a? Model::Playlist
+          playlist = owner
+          owner = playlist.owner
+        end
+
+        put "users/#{id_for(owner)}/playlists/#{id_for(playlist)}", data
+      end
+
+
+      #--------------
+      # Tracks
+      #--------------
+      def playlist_tracks owner, playlist=nil, fields: {}, limit: 20, offset: 0, market: nil
+        fields = fields.join(',') if fields.is_a? Array
+        options = {
+          fields: fields,
+          limit: limit,
+          offset: offset
+        }
+
+        if owner.is_a? Model::Playlist
+          playlist = owner
+          owner = playlist.owner
+        end
+
+        res = get "users/#{id_for(owner)}/playlists/#{id_for(playlist)}/tracks", options_with_market(market, options)
+        Model::Playlist.new(res.body)
+      end
+
+
+      def playlist_tracks_add owner, playlist=nil, tracks: [], position: nil
+        if owner.is_a? Model::Playlist
+          playlist = owner
+          owner = playlist.owner
+        end
+
+        tracks = case tracks
+          when Array then tracks.map {|t|
+            t.is_a?(Model::Track) ? t.id : t
+          }
+          when String then tracks.split(',')
+        end.map {|t| "spotify:track:#{t.split(':').last}" }
+
+
+        data = {}
+        data[:position] = position if position
+        data[:uris] = tracks
+
+        res = post "users/#{id_for(owner)}/playlists/#{id_for(playlist)}/tracks", data
+        res.body[:snapshot_id]
+      end
+
+
+      def playlist_tracks_remove owner, playlist=nil, tracks: nil, positions: nil, snapshot_id: nil
+        if owner.is_a? Model::Playlist
+          playlist = owner
+          owner = playlist.owner
+        end
+
+        data = {}
+        tracks = case tracks
+          when Array then tracks.map {|t|
+            case t
+              when Model::Track then {uri: t.uri}
+              when String then {uri: "spotify:track:#{t.split(':').last}"}
+              when Hash
+                t[:positions] = [t[:positions]].flatten if t[:positions]
+                t[:uri] = "spotify:track:#{t[:uri].split(':').last}"
+            end
+          }
+          when String then tracks.split(',')
+          else nil
+        end
+
+        data[:tracks] = tracks if tracks
+        data[:positions] = [positions].flatten if positions
+        data[:snapshot_id] = snapshot_id if snapshot_id
+
+        puts data
+
+        res = delete "users/#{id_for(owner)}/playlists/#{id_for(playlist)}/tracks", data
+        res.body[:snapshot_id]
+      end
+
+
+      def playlist_tracks_reorder owner, playlist=nil, start: 0, length: 1, before: nil, snapshot_id: nil
+        if owner.is_a? Model::Playlist
+          playlist = owner
+          owner = playlist.owner
+        end
+
+        raise "Must set `before` option when reordering playlist tracks" unless before
+
+        data = {
+          range_start: start,
+          range_length: length,
+          insert_before: before
+        }
+        data[:snapshot_id] = snapshot_id unless snapshot_id.nil?
+
+        res = put "users/#{id_for(owner)}/playlists/#{id_for(playlist)}/tracks", data
+        res.body[:snapshot_id]
+      end
+
+
+      def playlist_tracks_replace owner, playlist=nil, tracks: []
+        if owner.is_a? Model::Playlist
+          playlist = owner
+          owner = playlist.owner
+        end
+
+        data[:uris] = tracks.map { |t|
+          case t
+            when Model::Track then t.uri
+            when String then "spotify:track:#{t.split(':').last}"
+          end
+        }
+
+        res = put "users/#{id_for(owner)}/playlists/#{id_for(playlist)}/tracks", data
+        res.body[:snapshot_id]
+      end
+
+
+
+      #--------------
+      # Follows
+      #--------------
+      def playlist_follow owner, playlist=nil, public: true
+        if owner.is_a? Model::Playlist
+          playlist = owner
+          owner = playlist.owner
+        end
+        put "users/#{id_for(owner)}/playlists/#{id_for(playlist)}/followers", {public: public}
+      end
+
+
+      def playlist_unfollow owner, playlist=nil
+        if owner.is_a? Model::Playlist
+          playlist = owner
+          owner = playlist.owner
+        end
+        delete "users/#{id_for(owner)}/playlists/#{id_for(playlist)}/followers"
+      end
+
+    end
+  end
+end

data/lib/simplespotify/actions/tracks.rb

@@ -0,0 +1,67 @@
+module SimpleSpotify
+  module Actions
+    module Tracks
+
+      def track id, market: nil
+        res = get "tracks/#{id_for(id)}", options_with_market(market)
+        Model::Track.new(res.body)
+      end
+
+
+      def tracks ids, market: nil
+        if ids.is_a? Array
+          ids.map { |i|
+            id_for(i)
+          }.join(',')
+        end
+
+        Model::Collection.of(:tracks, response.body)
+      end
+
+
+      #--------------
+      # Saved tracks
+      #--------------
+      def saved_tracks limit: 20, offset: 0, market: nil
+        response = get "me/tracks", options_with_market(market, {limit: limit, offset: offset})
+        Model::Collection.of(Model::PlaylistTrack, response.body)
+      end
+
+
+      def saved_tracks_include? ids
+        if ids.is_a? Array
+          ids.map { |i|
+            i.is_a?(Resource) ? i.id : i;
+          }.join(',')
+        end
+
+        res = get "me/tracks/contains", {ids: ids}
+        ids.zip(res.body).to_h
+      end
+
+
+      def save_tracks ids
+        if ids.is_a? Array
+          ids.map { |i|
+            i.is_a?(Resource) ? i.id : i;
+          }.join(',')
+        end
+
+        put "me/tracks", {ids: ids}
+      end
+
+
+      def remove_tracks ids
+        if ids.is_a? Array
+          ids.map { |i|
+            i.is_a?(Resource) ? i.id : i;
+          }.join(',')
+        end
+
+        delete "me/tracks", {ids: ids}
+      end
+
+
+    end
+  end
+end

data/lib/simplespotify/actions/users.rb

@@ -0,0 +1,68 @@
+module SimpleSpotify
+  module Actions
+    module Users
+
+      def me
+        Model::User.new (get :me).body
+      end
+
+
+      def user id
+        Model::User.new (get "user/#{id}").body
+      end
+
+
+      #--------------
+      # Follows
+      #--------------
+      def user_follow type, ids
+        if ids.is_a? Array
+          ids.map { |i|
+            i.is_a?(Resource) ? i.id : i;
+          }.join(',')
+        end
+
+        req = SimpleSpotify::Request.new("me/following", {
+          json: true,
+          query: {type: type},
+          data: {ids: ids},
+          method: :put
+        })
+
+        put req
+      end
+
+
+      def user_unfollow type, ids
+        if ids.is_a? Array
+          ids.map { |i|
+            i.is_a?(Resource) ? i.id : i;
+          }.join(',')
+        end
+
+        req = SimpleSpotify::Request.new("me/following", {
+          json: true,
+          query: {type: type},
+          data: {ids: ids},
+          method: :delete
+        })
+
+        delete req
+      end
+
+
+      def user_following type, ids
+        if ids.is_a? Array
+          ids.map { |i|
+            i.is_a?(Resource) ? i.id : i;
+          }.join(',')
+        end
+
+        res = get "me/following/contains", {ids: ids, type: type}
+        ids.zip(res.body).to_h
+      end
+
+
+    end
+  end
+end

data/lib/simplespotify/authorization.rb

@@ -0,0 +1,91 @@
+module SimpleSpotify
+  class Authorization
+
+    attr_accessor :access_token, :refresh_token
+    attr_reader :client_id
+
+    def self.login_uri redirect, client, state: nil, scope: nil, dialog: false
+      params = {
+        client_id: client.to_h[:client_id],
+        response_type: 'code',
+        redirect_uri: redirect,
+      }
+
+      params[:state] = state unless state.nil?
+      if scope
+        scope = scope.join(' ') if scope.is_a? Array
+        params[:scope] = scope
+      end
+      params[:show_dialog] = dialog.to_s
+
+      params_qs = params.map {|k,v|
+        "#{k}=#{URI::encode(v)}"
+      }.join('&')
+      return SimpleSpotify::AUTHORIZATION_URL + '?' + params_qs
+    end
+
+
+    def self.from_code code, client: {}, redirect: nil
+      params = {
+        grant_type: 'authorization_code',
+        redirect_uri: redirect,
+        code: code,
+      }.merge(client.to_h)
+
+      response = HTTParty.post SimpleSpotify::TOKEN_URL, query: params
+
+      body = JSON.parse(response.body, symbolize_names: true)
+      if response.code != 200
+        raise SimpleSpotify::Error::AuthorizationError.new(body)
+      end
+
+      return Authorization.new(body)
+    end
+
+
+    def initialize access_token: nil, refresh_token:nil, client: {}, token_type: nil, expires_in: nil
+      @access_token = access_token
+      @refresh_token = refresh_token
+      @client = client.to_h
+      @client_id = @client[:client_id]
+    end
+
+
+    def headers
+      {'Authorization' => "Bearer #{@access_token}"}
+    end
+
+
+    def refresh!
+      params = {
+        grant_type: 'refresh_token',
+        refresh_token: @refresh_token
+      }.merge(@client)
+
+      response = HTTParty.post SimpleSpotify::TOKEN_URL, query: params
+
+      body = JSON.parse(response.body, symbolize_names: true)
+      if response.code != 200
+        raise SimpleSpotify::Error::AuthorizationError.new(body)
+      end
+
+      @access_token = body[:access_token]
+      @callback.call(self) if @callback
+    end
+
+
+    def on_refresh &block
+      @callback = block
+    end
+
+
+    def to_h
+      {
+        access_token: access_token,
+        refresh_token: refresh_token
+      }
+    end
+
+
+  end
+end