spotifyexporter 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 90f4fca8c67b5e0521ccefa47c8745cf58779b50dcdf5a7ceac73b12a939e354
-  data.tar.gz: 53e47966eacae888046c5f84115b78c2e77759a343b5b48bd0db56a72698b4c8
+  metadata.gz: 3eaeddae7d738d0b86f4b4d90a25f21e3e90ec2cf29c344f4251cda5c39ee905
+  data.tar.gz: d2e4ae9c034968539b29c48a400e26ca7fec3cbc73d736027874dd70140ce617
 SHA512:
-  metadata.gz: b616ff7bbabdc1eac578d9ae0707c405e42625a3b3b4b3ebb76413c8ff7101f9e95212cfac4f2571747ed40e219ed53ad01f6c7e5476e8342549ef0b79ae0e3e
-  data.tar.gz: ce35290bf8c7ec6fa6135100126893b3ae91112591dec12d58ba47c6e308439830af2e0328b2a17a451ebf2627753c60ab643e931c0060d9d27623615b6a370b
+  metadata.gz: 2354553f5a001a04cc2f47f1b1e58716eb08bfa3034abacd18f6e8377ddaeb8eb5422342f78d8a1b01025b3489b5a39efe82be130f2df0c29b240b148a9a7459
+  data.tar.gz: c36f7a0602ab953982e3212ac0704374ab224a8772997b5ff4e11f7e0a4008710f1d119ff04ee6d4f11f76c1ef3e4f76149c79d88bfb7ad384e73ef6d5508b39

data/Gemfile.lock

@@ -1,9 +1,9 @@
 PATH
   remote: .
   specs:
-    spotifyexporter (0.1.0)
-      addressable (~> 2.8.0)
-      rspotify (~> 2.1.1)
+    spotifyexporter (0.2.0)
+      playlist (~> 1.2.0)
+      rspotify (~> 2.11.1)
       thor (~> 1.2.1)
       tty-prompt (~> 0.23.1)
 
@@ -28,31 +28,43 @@ GEM
     mime-types (3.4.1)
       mime-types-data (~> 3.2015)
     mime-types-data (3.2022.0105)
+    mini_portile2 (2.8.0)
     multi_json (1.15.0)
     multi_xml (0.6.0)
     netrc (0.11.0)
+    nokogiri (1.13.6)
+      mini_portile2 (~> 2.8.0)
+      racc (~> 1.4)
+    nokogiri (1.13.6-arm64-darwin)
+      racc (~> 1.4)
     oauth2 (1.4.9)
       faraday (>= 0.17.3, < 3.0)
       jwt (>= 1.0, < 3.0)
       multi_json (~> 1.3)
       multi_xml (~> 0.5)
       rack (>= 1.2, < 3)
-    omniauth (1.9.1)
+    omniauth (2.1.0)
       hashie (>= 3.4.6)
-      rack (>= 1.6.2, < 3)
-    omniauth-oauth2 (1.3.1)
-      oauth2 (~> 1.0)
-      omniauth (~> 1.2)
+      rack (>= 2.2.3)
+      rack-protection
+    omniauth-oauth2 (1.7.2)
+      oauth2 (~> 1.4)
+      omniauth (>= 1.9, < 3)
     parallel (1.22.1)
     parser (3.1.2.0)
       ast (~> 2.4.1)
     pastel (0.8.0)
       tty-color (~> 0.5)
+    playlist (1.2.0)
+      nokogiri
     pry (0.14.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
     public_suffix (4.0.7)
+    racc (1.6.0)
     rack (2.2.3)
+    rack-protection (2.2.0)
+      rack
     rainbow (3.1.1)
     rake (13.0.6)
     regexp_parser (2.4.0)
@@ -61,8 +73,9 @@ GEM
       mime-types (>= 1.16, < 4.0)
       netrc (~> 0.8)
     rexml (3.2.5)
-    rspotify (2.1.1)
-      omniauth-oauth2 (~> 1.3.1)
+    rspotify (2.11.1)
+      addressable (~> 2.8.0)
+      omniauth-oauth2 (>= 1.6)
       rest-client (~> 2.0.2)
     rubocop (1.29.1)
       parallel (~> 1.10)

data/lib/spotifyexporter/auth.rb

@@ -5,9 +5,8 @@ require_relative "./config"
 
 module SpotifyExporter
   class AuthWorkflow
-
-    # 
-    # Starts auth flow 
+    #
+    # Starts auth flow
     #
     def start
       auth = prompt_for_auth

data/lib/spotifyexporter/cli.rb

@@ -32,6 +32,6 @@ module SpotifyExporter
     end
 
     desc "playlists", "List playlists"
-    subcommand 'playlists', Playlists
+    subcommand "playlists", Playlists
   end
 end

data/lib/spotifyexporter/command/playlists.rb

@@ -1,19 +1,24 @@
+# frozen_string_literal: true
+
 require "thor"
 require "fileutils"
-require_relative '../config.rb'
-require_relative '../lib/spotify.rb'
+require "playlist"
+require_relative "../config"
+require_relative "../lib/spotify"
 
 module SpotifyExporter
   class Playlists < Thor
     include ConfigDependant
 
+    SUPPORTED_PLAYLIST_FORMATS = %w[m3u pls xspf txt yml].freeze
+
     desc "ls", "Lists playlist"
     option :user, required: true, aliases: "-u"
     option :url, required: false, aliases: "-l"
-    def ls 
+    def ls
       pl = spotify.get_user_playlists(options.user)
 
-      results = pl.map do |p| 
+      results = pl.map do |p|
         r = p.name
 
         r << " | #{p.external_urls["spotify"]}" unless options.url.nil?
@@ -27,35 +32,138 @@ module SpotifyExporter
     desc "export", "Exports playlists"
     option :user, required: true, aliases: "-u"
     option :output_directory, required: true, aliases: "-o"
-    option :all, required: false, aliases: "-a"
-    def export 
+    option :format, required: false, aliases: "-f", default: "txt"
+    def export
       FileUtils.mkdir_p(options.output_directory) unless Dir.exist? options.output_directory
+      validate_format!(options.format)
 
-      pl = spotify.get_user_playlists(options.user)
+      spotify_playlists = spotify.get_user_playlists(options.user)
 
-      # For each playlist 
-      pl.each do |p|
+      # For each playlist
+      spotify_playlists.each do |spotify_pl|
         # Remove non-alphanumeric characters
-        sanitized_name = p.name.gsub(/[^[:alnum:]]/, "")
-        playlist_file_name = File.join(options.output_directory, sanitized_name)
+        # Replace all spaces with underscores
+        sanitized_name = spotify_pl.name.gsub(/[^[:alnum:]^[:space:]]/, "").chomp
 
-        # Create a file for the playlist 
-        File.open(playlist_file_name, "w") do |f|
+        playlist = Playlist.new(
+          title: sanitized_name,
+          description: spotify_pl.description,
+          creator: options.user,
+          # Use the first image
+          image: spotify_pl.images.first["url"]
+        )
 
-          # Write the name of each artist and song 
-          p.tracks.each do |t| 
-            artists = t.artists.map(&:name).join(", ")
+        # For each track in the Spotify playlist,
+        # create a new playlist track with title and contributors, then
+        # add it to the playlist.
+        spotify_pl.tracks.each do |spotify_track|
+          track = Playlist::Track.new(
+            title: spotify_track.name,
+            duration: spotify_track.duration_ms
+          )
 
-            f.puts "#{artists} - #{t.name}"
+          spotify_track.artists.each do |artist|
+            track.add_contributor(name: artist.name)
           end
+
+          playlist.add_track(track)
         end
+
+        # Write the playlist to disk
+        save_playlist(playlist, options.format)
       end
     end
 
     private
+
+    #
+    # Saves the playlist in the requested format to disk
+    #
+    # @param playlist [Playlist]
+    # @param format [String]
+    #
+    def save_playlist(playlist, format)
+      # Sanitize the name for file system, remove spaces and
+      # replace with underscores
+      fname = playlist.title.gsub(/\s/, "_")
+
+      suffix = format
+      playlist_file_name = File.join(options.output_directory, "#{fname}.#{suffix}")
+
+      # Create a file for the playlist
+      File.open(playlist_file_name, "wb") do |f|
+        # Use the provided format to generate a playlist
+
+        generated_playlist_blob = case format.to_sym
+                                  when :m3u
+                                    Playlist::Format::M3U.generate(playlist)
+                                  when :pls
+                                    Playlist::Format::PLS.generate(playlist)
+                                  when :xspf
+                                    Playlist::Format::XSPF.generate(playlist)
+                                  when :yml
+                                    generate_yml_playlist(playlist)
+                                  else
+                                    # Use default generation
+                                    generate_txt_playlist(playlist)
+                                  end
+
+        f.write generated_playlist_blob
+      end
+    end
+
+    #
+    # Creates a txt playlist blob
+    #
+    def generate_txt_playlist(playlist)
+      <<~EOF
+        Title: #{playlist.title}
+        Creator: #{playlist.creator}
+        Description: #{playlist.description}
+        Image: #{playlist.image}
+
+        ---
+
+        #{playlist.tracks.map { |t| "#{t.artist} - #{t.title}" }.join("\n")}
+
+      EOF
+    end
+
+    #
+    # Creates a yaml playlist blob
+    #
+    # @param playlist [Playlist]
+    # @return [YAML]
+    #
+    def generate_yml_playlist(playlist)
+      tracks = playlist.tracks.map do |t|
+        { artist: t.artist, title: t.title }
+      end
+
+      {
+        title: playlist.title,
+        creator: playlist.creator,
+        description: playlist.description,
+        image: playlist.image,
+        tracks: tracks,
+      }.to_yaml
+    end
+
+    #
+    # Raises an error if invalid format supplied
+    #
+    # @raise ArgumentError
+    #
+    def validate_format!(format)
+      err = "invalid playlist format: #{format}. Must be one of: #{SUPPORTED_PLAYLIST_FORMATS.join(", ")}"
+
+      raise ArgumentError, err unless SUPPORTED_PLAYLIST_FORMATS.include?(format)
+    end
+
     #
-    # SpotifyClient
+    # Client for Spotify Developer API
     #
+    # @return [SpotifyClient]
     def spotify
       return @spotify unless @spotify.nil?
 

data/lib/spotifyexporter/config.rb

@@ -4,13 +4,13 @@ require "fileutils"
 require "yaml"
 require "singleton"
 require "pry"
-require_relative './lib/injectable.rb'
+require_relative "./lib/injectable"
 
 module SpotifyExporter
   module ConfigDependant
     include Injectable
 
-    inject :config, -> { ConfigManager.instance.config } 
+    inject :config, -> { ConfigManager.instance.config }
   end
 
   class AppConfig
@@ -49,7 +49,7 @@ module SpotifyExporter
 
     FILE_CLI_CONFIG = "config.yml"
 
-    # 
+    #
     # Loads and saves the credentials to the main configuration
     #
     # @return [Boolean]
@@ -63,7 +63,7 @@ module SpotifyExporter
       save_config!
     end
 
-    # 
+    #
     # Retrieves the AppConfig
     #
     # @return [AppConfig]
@@ -78,7 +78,7 @@ module SpotifyExporter
 
     #
     # Saves the currently in-memory configuration
-    # 
+    #
     # @return success [Boolean]
     #
     def save_config!
@@ -102,7 +102,7 @@ module SpotifyExporter
     end
 
     #
-    # Reads the user file system configurations into the in-memory AppConfig 
+    # Reads the user file system configurations into the in-memory AppConfig
     #
     def load_config_file
       initialize_config_file unless config_file_exists?

data/lib/spotifyexporter/lib/injectable.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SpotifyExporter
   module Injectable
     def self.included(base)

data/lib/spotifyexporter/lib/spotify.rb

@@ -1,26 +1,28 @@
-require 'rspotify' 
-require 'addressable'
+# frozen_string_literal: true
+
+require "rspotify"
 
 class SpotifyClient
   def initialize(conf)
     RSpotify.authenticate(
-      conf.spotify_client_id, 
-      conf.spotify_client_secret 
+      conf.spotify_client_id,
+      conf.spotify_client_secret
     )
   end
-  # 
+
+  #
   # GETs a user
   #
-  # @param uname [String] 
+  # @param uname [String]
   #
   def get_user(uname)
     RSpotify::User.find(uname)
   end
 
-  # 
+  #
   # GETs all playlists for a user
   #
-  # @param uname [String] 
+  # @param uname [String]
   #
   def get_user_playlists(uname)
     u = get_user(uname)
@@ -28,11 +30,11 @@ class SpotifyClient
     playlists = []
     offset = 0
     last_pull_count = 0
-    
+
     # You can only pull from API in increments of 50
     # if the last pull count is a multiple of 50
     # we know we can keep pulling, if not, stop
-    while (last_pull_count % 50).zero? do
+    while (last_pull_count % 50).zero?
       p = u.playlists(limit: 50, offset: offset)
 
       playlists << p

data/lib/spotifyexporter/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SpotifyExporter
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/spotifyexporter.gemspec

@@ -29,8 +29,8 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "rspotify", "~> 2.1.1"
-  spec.add_dependency "addressable", "~> 2.8.0"
+  spec.add_dependency "playlist", "~> 1.2.0"
+  spec.add_dependency "rspotify", "~> 2.11.1"
   spec.add_dependency "thor", "~> 1.2.1"
   spec.add_dependency "tty-prompt", "~> 0.23.1"
 

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: spotifyexporter
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - aquaflamingo
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-05-21 00:00:00.000000000 Z
+date: 2022-05-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rspotify
+  name: playlist
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.1.1
+        version: 1.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.1.1
+        version: 1.2.0
 - !ruby/object:Gem::Dependency
-  name: addressable
+  name: rspotify
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.8.0
+        version: 2.11.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.8.0
+        version: 2.11.1
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement