simplespotify 0.0.1

data/lib/simplespotify/client.rb

@@ -0,0 +1,76 @@
+module SimpleSpotify
+  class Client
+
+    attr_accessor :id, :secret, :session, :market
+
+    [:Albums, :Tracks, :Artists, :Users, :Browse, :Playlists].each do |action|
+      require "simplespotify/actions/#{action.downcase}"
+      include Actions.const_get(action)
+    end
+
+    def initialize client_id, client_secret, default: true
+      @id = client_id
+      @secret = client_secret
+      @session = nil
+      @market = nil
+      SimpleSpotify.default_client = self if default
+    end
+
+    [:get, :post, :put, :delete].each do |verb|
+      define_method(verb) do |msg, data={}|
+        unless msg.is_a? SimpleSpotify::Request
+          msg = Request.new(msg, {method: verb, data: data})
+        end
+        SimpleSpotify.dispatch msg, session: session
+      end
+    end
+
+
+    def search type, term, market: nil, limit: 20, offset: 0, filters: {}
+      type = type.to_s.gsub(/s$/, '').to_sym
+      types = [:album, :artist, :playlist, :track]
+      raise "Can't search for <#{type}> only: #{types.join(',')}" unless types.include?(type)
+
+      params = {q: term}
+      params[:market] = market || @market
+      params[:limit] = limit if limit
+      params[:offset] = offset if offset
+
+      filters = filters.map { |filter, value|
+        value = value.join(',') if value.is_a?(Array)
+        value = [value.min, value.max].map(&:to_s).join('-') if value.is_a?(Range)
+        %{#{filter}:"#{value}"}
+      }
+
+      params[:q] = ([term]+filters).join(' ')
+      params[:type] = type
+
+      params = params.reject {|k,v| v.nil?}.to_h
+      response = get "search", params
+
+      Model::Collection.of(type, response.body["#{type}s".to_sym])
+    end
+
+
+    def to_h
+      {
+        client_secret: secret,
+        client_id: id
+      }
+    end
+
+
+    private
+
+    def id_for object
+      return object.id if object.is_a? Resource
+      object
+    end
+
+    def options_with_market user_market, options={}
+      options[:market] = user_market || @market
+      options.reject {|k,v| v.nil? || v=='' }.to_h
+    end
+
+  end
+end

data/lib/simplespotify/constants.rb

@@ -0,0 +1,14 @@
+module SimpleSpotify
+  #--------------
+  # Constants
+  #--------------
+
+  AUTHORIZATION_URL = 'https://accounts.spotify.com/authorize'
+  TOKEN_URL = 'https://accounts.spotify.com/api/token'
+
+  ENDPOINT = 'https://api.spotify.com/v1/'
+
+  # Upper bound when trying to refresh the authentication token
+  MAX_RETRIES = 2
+
+end

data/lib/simplespotify/errors.rb

@@ -0,0 +1,56 @@
+module SimpleSpotify
+  module Error
+
+    def self.for status_code
+      case status_code
+        when 401 then Unauthorized
+        when 404 then NotFound
+        when (500..599) then API
+        else
+          DefaultError
+      end
+    end
+
+
+    class AuthorizationError < StandardError
+      attr_reader :message
+      def initialize body
+        @message = body[:error_description]
+      end
+    end
+
+
+    class DefaultError < StandardError
+      attr_reader :code, :body, :message, :request
+      def initialize code, body, request
+        @code = code
+        @body = body
+        @request = request
+        @message = body[:error][:message] unless body.nil?
+      end
+    end
+
+    class BadResponse < StandardError
+      attr_reader :code, :message, :request, :body
+      def initialize code, body, request
+        @code = code
+        @message = 'Unreadable JSON data returned from SimpleSpotify API'
+        @request = request
+        @body = body
+      end
+    end
+
+    class API < DefaultError
+    end
+
+    class NotFound < DefaultError
+      def initialize code, body, request
+        @message = "#{request.full_url} not found"
+      end
+    end
+
+    class Unauthorized < DefaultError
+    end
+
+  end
+end

data/lib/simplespotify/models/album.rb

@@ -0,0 +1,27 @@
+module SimpleSpotify
+  module Model
+    class Album
+      include Resource
+
+      prop :type, from: :album_type
+
+      many :artists
+      prop :markets
+      prop :copyrights
+
+      merge :external_ids
+
+      prop :genres, default: []
+      many :images
+
+      prop :name
+      prop :popularity
+      prop :release_date
+      prop :release_date_precision
+
+      many :tracks, paginated: true
+
+
+    end
+  end
+end

data/lib/simplespotify/models/artist.rb

@@ -0,0 +1,42 @@
+module SimpleSpotify
+  module Model
+    class Artist
+      include Resource
+
+      merge :external_ids
+
+      prop :genres
+      many :images
+      prop :name
+      prop :popularity
+
+      prop :followers
+
+
+      def related_artists! client=nil
+        client ||= SimpleSpotify.default_client
+        @related_artists = client.related_artists(id)
+      end
+
+      def related_artists client=nil
+        @related_artists || related_artists!(client)
+      end
+
+
+      def top_tracks! client=nil
+        client ||= SimpleSpotify.default_client
+        @top_tracks = client.top_tracks(id)
+      end
+
+      def top_tracks client=nil
+        @top_tracks || top_tracks!(client)
+      end
+
+      def albums! client=nil
+        client ||= SimpleSpotify.default_client
+        @albums = client.artist_albums(id)
+      end
+
+    end
+  end
+end

data/lib/simplespotify/models/category.rb

@@ -0,0 +1,19 @@
+module SimpleSpotify
+  module Models
+    class Category
+
+      many :icons, kind: :image
+      prop :name
+
+      def playlists client=nil, country: nil, limit: 20, offset: 0
+        @playlists || playlists!(client, country: country, limit: limit, offset: offset)
+      end
+
+      def playlists! client=nil, country: nil, limit: 20, offset: 0
+        client ||= SimpleSpotify.default_client
+        @playlists = client.category_playlists(id, country: country, limit: limit, offset: offset)
+      end
+
+    end
+  end
+end

data/lib/simplespotify/models/collection.rb

@@ -0,0 +1,52 @@
+module SimpleSpotify
+  module Model
+
+    class Collection < Array
+
+      attr_accessor :total
+
+      def self.of type, data
+        if type.is_a? Class
+          model = type;
+          prop = type.to_s.split('::').last.downcase+'s'
+        else
+          model_name = type.to_s.gsub(/s$/, '')
+          model = Model.const_get(model_name.capitalize)
+          prop = model_name+'s'
+        end
+
+        prop = prop.to_sym
+        prop = :items unless data.has_key?(prop)
+
+        data[prop].map! {|item| model.new(item) }
+        self.new(data)
+      end
+
+
+      def initialize data, property=:items
+        values = data[property]
+        super values
+        @total = data[:total] || self.count
+        @next = data[:next]
+      end
+
+
+      def total
+        @total
+      end
+
+
+      def more?
+        !@next.nil?
+      end
+
+
+      def more
+        return [] unless more?
+        req = Request.new({endpoint: @next, private: false})
+        SimpleSpotify.dispatch(req)
+      end
+    end #/class
+
+  end
+end

data/lib/simplespotify/models/image.rb

@@ -0,0 +1,16 @@
+module SimpleSpotify
+  module Model
+    class Image
+      include Resource
+
+      prop :height
+      prop :width
+      prop :url
+
+      def to_s
+        url
+      end
+
+    end
+  end
+end

data/lib/simplespotify/models/playlist.rb

@@ -0,0 +1,94 @@
+module SimpleSpotify
+  module Model
+    class Playlist
+      include Resource
+
+      prop :name
+      prop :description
+
+      prop :collaborative
+      prop :public
+
+      many :images
+      one :owner, kind: :user
+
+      prop :snapshot_id
+
+      many :tracks, kind: :playlist_track, paginated: true
+
+      def public?
+        @public == true
+      end
+
+
+      def change_details! client=nil
+        client ||= SimpleSpotify.default_client
+        client.change_details(self, name: name, public: @public)
+      end
+
+      #--------------
+      # Tracks
+      #--------------
+      def tracks! client=nil, options={}
+        client ||= SimpleSpotify.default_client
+        client.playlist_tracks(self, options)
+      end
+
+      def add_tracks tracks, position=nil, client=nil
+        client ||= SimpleSpotify.default_client
+        client.playlist_tracks_add(self, tracks: tracks, position: position)
+      end
+
+      def remove_tracks client=nil, tracks: nil, positions: nil, snapshot_id: nil
+        client ||= SimpleSpotify.default_client
+        snapshot_id ||= @snapshot_id unless positions.nil?
+        client.playlist_tracks_remove(self, tracks: tracks, positions: positions, snapshot_id: snapshot_id)
+      end
+
+      def reorder_tracks client=nil, payload
+        client ||= SimpleSpotify.default_client
+        client.playlist_tracks_reorder(self, payload)
+      end
+
+      def replace_tracks client=nil, tracks: []
+        client ||= SimpleSpotify.default_client
+        client.playlist_tracks_reorder(self, tracks: tracks)
+      end
+
+
+      #--------------
+      # Follows
+      #--------------
+      def follow client=nil, public: true
+        client ||= SimpleSpotify.default_client
+        client.playlist_follow(self, public: public)
+      end
+
+      def unfollow
+        client ||= SimpleSpotify.default_client
+        client.playlist_unfollow(self)
+      end
+
+
+      #--------------
+      # Create
+      #--------------
+      def self.create user, name, client=nil, public:true
+        client ||= SimpleSpotify.default_client
+        client.playlist_create(user, name, public: public)
+      end
+
+    end
+
+
+    class PlaylistTrack
+      include Resource
+
+      prop :added_at
+      prop :added_by
+      prop :is_local
+      one :track
+
+    end
+  end
+end

data/lib/simplespotify/models/track.rb

@@ -0,0 +1,31 @@
+module SimpleSpotify
+  module Model
+    class Track
+      include Resource
+
+      many :albums
+      many :artists
+
+      prop :markets, from: :available_markets
+      prop :disc_number
+      prop :duration_ms
+      prop :explicit
+      merge :external_ids
+      prop :playable, from: :is_playable
+
+      prop :name
+      prop :popularity
+      prop :preview_url
+      prop :track_number
+
+      def duration
+        Time.at(@duration_ms/1000).utc.strftime("%H:%M:%S")
+      end
+
+      def playable?
+        playable == true
+      end
+
+    end
+  end
+end

data/lib/simplespotify/models/user.rb

@@ -0,0 +1,91 @@
+module SimpleSpotify
+  module Model
+    class User
+      include Resource
+
+      prop :birthdate
+      prop :country
+      prop :display_name
+      prop :email
+
+      prop :external_urls
+      prop :followers
+
+      many :images
+      prop :product
+
+      def name
+        display_name
+      end
+
+      def premium?
+        @product == 'premium'
+      end
+
+
+      #--------------
+      # Saved tracks
+      #--------------
+      def save_tracks ids, client=nil
+        client ||= SimpleSpotify.default_client
+        client.save_tracks(ids)
+      end
+
+
+      def remove_tracks ids, client=nil
+        client ||= SimpleSpotify.default_client
+        client.remove_tracks(ids)
+      end
+
+
+      def saved_tracks_include? ids, client=nil
+        client ||= SimpleSpotify.default_client
+        client.saved_tracks_include?(ids)
+      end
+
+
+      #--------------
+      # Follows
+      #--------------
+      def follow type, ids, client=nil
+        client ||= SimpleSpotify.default_client
+        client.user_follow(type, ids)
+      end
+
+
+      def unfollow type, ids, client=nil
+        client ||= SimpleSpotify.default_client
+        client.user_unfollow(type, ids)
+      end
+
+
+      def following? type, ids, client=nil
+        client ||= SimpleSpotify.default_client
+        client.user_following(type, ids)
+      end
+
+
+      #--------------
+      # Playlists
+      #--------------
+
+      def playlists! client=nil, fields: {}, market: nil, limit: 20, offset: 0
+        client ||= SimpleSpotify.default_client
+        client.playlists(self, fields: fields, market: market, limit: limit, offset: offset)
+      end
+
+
+      def follow_playlist owner, playlist=nil, client=nil, public: true
+        client ||= SimpleSpotify.default_client
+        client.playlist_follow(owner, playlist, public: public)
+      end
+
+
+      def follow_playlist owner, playlist=nil, client=nil
+        client ||= SimpleSpotify.default_client
+        client.playlist_unfollow(owner, playlist)
+      end
+
+    end
+  end
+end

data/lib/simplespotify/request.rb

@@ -0,0 +1,54 @@
+module SimpleSpotify
+  class Request
+
+    attr_accessor :endpoint, :method, :json, :data, :tries
+
+    def initialize endpoint, opts = {}
+      endpoint = endpoint.join('/') if endpoint.respond_to? :join
+
+      @endpoint = endpoint
+      @headers = opts[:headers] || {}
+      @method = opts[:method] || :get
+      @json = opts[:json] || (@method != :get)
+      @tries = 0
+      @data = opts[:data]
+      @query = opts[:query]
+      @private = opts[:private] || true
+    end
+
+
+    def private?
+      @private;
+    end
+
+
+    def method
+      @method.to_sym
+    end
+
+
+    def options
+      return {} unless data
+      if method == :get
+        {query: data}
+      else
+        opts = {body: data.to_json}
+        opts[:query] = @query if @query
+        opts
+      end
+    end
+
+
+    def headers
+      h = @headers
+      h['Content-type'] = 'application/json' if json
+      h
+    end
+
+
+    def full_url
+      SimpleSpotify::ENDPOINT + endpoint.to_s.gsub(SimpleSpotify::ENDPOINT, '')
+    end
+
+  end
+end

data/lib/simplespotify/resource/class_methods.rb

@@ -0,0 +1,48 @@
+module Resource
+  module ClassMethods
+
+    def self.extended(base)
+      super base
+    end
+
+    def prop name, o={}
+      p = (o[:from] || name)
+      p = {type: :real, from: p, default: o[:default]} if o[:default]
+      @_template[name] = p
+      attr_accessor name.to_sym
+    end
+
+    def many name, o={}
+      attr_accessor name.to_sym
+      kind = o[:kind] || name
+      @_template[name] = {
+        type: :resource_collection,
+        kind: _constant(kind),
+        from: name,
+        paginated: o[:paginated] || false
+      }
+    end
+
+    def one name, o={}
+      attr_accessor name.to_sym
+      kind = o[:kind] || name
+      @_template[name] = {
+        type: :resource,
+        kind: _constant(kind),
+        from: (o[:from] || name)
+      }
+    end
+
+    def merge name
+      @_template[name] = {type: :virtual, from: name}
+    end
+
+    def _template
+      @_template
+    end
+
+    def _constant name
+      "#{name}".gsub(/s$/, '').split('_').map(&:capitalize).join.to_sym
+    end
+  end
+end