spotifyexporter 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 90f4fca8c67b5e0521ccefa47c8745cf58779b50dcdf5a7ceac73b12a939e354
+  data.tar.gz: 53e47966eacae888046c5f84115b78c2e77759a343b5b48bd0db56a72698b4c8
+SHA512:
+  metadata.gz: b616ff7bbabdc1eac578d9ae0707c405e42625a3b3b4b3ebb76413c8ff7101f9e95212cfac4f2571747ed40e219ed53ad01f6c7e5476e8342549ef0b79ae0e3e
+  data.tar.gz: ce35290bf8c7ec6fa6135100126893b3ae91112591dec12d58ba47c6e308439830af2e0328b2a17a451ebf2627753c60ab643e931c0060d9d27623615b6a370b

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 2.6
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2022-05-18
+
+- Initial release

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in spotifyexporter.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rubocop", "~> 1.21"

data/Gemfile.lock

@@ -0,0 +1,108 @@
+PATH
+  remote: .
+  specs:
+    spotifyexporter (0.1.0)
+      addressable (~> 2.8.0)
+      rspotify (~> 2.1.1)
+      thor (~> 1.2.1)
+      tty-prompt (~> 0.23.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    ast (2.4.2)
+    coderay (1.1.3)
+    domain_name (0.5.20190701)
+      unf (>= 0.0.5, < 1.0.0)
+    faraday (2.3.0)
+      faraday-net_http (~> 2.0)
+      ruby2_keywords (>= 0.0.4)
+    faraday-net_http (2.0.3)
+    hashie (5.0.0)
+    http-cookie (1.0.4)
+      domain_name (~> 0.5)
+    jwt (2.3.0)
+    method_source (1.0.0)
+    mime-types (3.4.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2022.0105)
+    multi_json (1.15.0)
+    multi_xml (0.6.0)
+    netrc (0.11.0)
+    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)
+      hashie (>= 3.4.6)
+      rack (>= 1.6.2, < 3)
+    omniauth-oauth2 (1.3.1)
+      oauth2 (~> 1.0)
+      omniauth (~> 1.2)
+    parallel (1.22.1)
+    parser (3.1.2.0)
+      ast (~> 2.4.1)
+    pastel (0.8.0)
+      tty-color (~> 0.5)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    public_suffix (4.0.7)
+    rack (2.2.3)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.4.0)
+    rest-client (2.0.2)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 4.0)
+      netrc (~> 0.8)
+    rexml (3.2.5)
+    rspotify (2.1.1)
+      omniauth-oauth2 (~> 1.3.1)
+      rest-client (~> 2.0.2)
+    rubocop (1.29.1)
+      parallel (~> 1.10)
+      parser (>= 3.1.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.17.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.18.0)
+      parser (>= 3.1.1.0)
+    ruby-progressbar (1.11.0)
+    ruby2_keywords (0.0.5)
+    thor (1.2.1)
+    tty-color (0.6.0)
+    tty-cursor (0.7.1)
+    tty-prompt (0.23.1)
+      pastel (~> 0.8)
+      tty-reader (~> 0.8)
+    tty-reader (0.9.0)
+      tty-cursor (~> 0.7)
+      tty-screen (~> 0.8)
+      wisper (~> 2.0)
+    tty-screen (0.8.1)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.8.1)
+    unicode-display_width (2.1.0)
+    wisper (2.0.1)
+
+PLATFORMS
+  arm64-darwin-21
+  ruby
+
+DEPENDENCIES
+  pry
+  rake (~> 13.0)
+  rubocop (~> 1.21)
+  spotifyexporter!
+
+BUNDLED WITH
+   2.3.7

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 aquaflamingo
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,61 @@
+# SpotifyExporter
+
+Export Spotify Playlists
+
+Currently only supports Ruby < 2.7
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'spotifyexporter'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install spotifyexporter
+
+## Usage
+
+You will need to authenticate the CLI before you can use it.
+
+You can generate a Spotify API Key at: https://developer.spotify.com/dashboard/applications/6b96bdf7b9224f109aa65ebda1429522
+
+After you have an API Key available, run the `auth` command and enter your credentials:
+
+```bash
+
+spotifyexporter auth
+
+```
+
+The CLI will persist these credentials on your file system within the `.config` directory.
+
+Next, you can run the `export` command to get a full list of songs in each playlist for a particular user.
+
+```bash
+
+# Create an output directory
+mkdir output_dir
+
+spotifyexporter export -u username -o output_dir
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/aquaflamingo/spotifyexporter.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+
+task default: :build

data/exe/spotifyexporter

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "spotifyexporter"
+
+SpotifyExporter::CLI.start(ARGV)

data/lib/spotifyexporter/auth.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require "tty-prompt"
+require_relative "./config"
+
+module SpotifyExporter
+  class AuthWorkflow
+
+    # 
+    # Starts auth flow 
+    #
+    def start
+      auth = prompt_for_auth
+
+      ConfigManager.instance.save_credentials(
+        client_id: auth[:spotify_client_id],
+        secret: auth[:spotify_client_secret]
+      )
+    end
+
+    private
+
+    # Creates an interactive prompt for user input
+    #
+    # @returns [Hash]
+    def prompt_for_auth
+      prompt = TTY::Prompt.new
+
+      prompt.collect do |_p|
+        # Project name
+        key(:spotify_client_id).ask("Enter Spotify Client ID: ") do |q|
+          q.required true
+        end
+
+        # Project description
+        key(:spotify_client_secret).ask("Enter Spotify Client Secret: ") do |q|
+          q.required true
+        end
+      end
+    end
+  end
+end

data/lib/spotifyexporter/cli.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require "thor"
+require_relative "version"
+require_relative "command/playlists"
+require_relative "auth"
+
+module SpotifyExporter
+  #
+  # The CLI spotify exporter
+  #
+  class CLI < Thor
+    package_name "spotifyexporter"
+
+    # Returns exit with non zero status when an exception occurs
+    def self.exit_on_failure?
+      true
+    end
+
+    #
+    # Returns version of the cli
+    #
+    desc "version", "Prints the current version"
+    def version
+      puts SpotifyExporter::VERSION
+    end
+
+    desc "auth", "Authorizes the CLI with Spotify API"
+    def auth
+      workflow = AuthWorkflow.new
+      workflow.start
+    end
+
+    desc "playlists", "List playlists"
+    subcommand 'playlists', Playlists
+  end
+end

data/lib/spotifyexporter/command/playlists.rb

@@ -0,0 +1,67 @@
+require "thor"
+require "fileutils"
+require_relative '../config.rb'
+require_relative '../lib/spotify.rb'
+
+module SpotifyExporter
+  class Playlists < Thor
+    include ConfigDependant
+
+    desc "ls", "Lists playlist"
+    option :user, required: true, aliases: "-u"
+    option :url, required: false, aliases: "-l"
+    def ls 
+      pl = spotify.get_user_playlists(options.user)
+
+      results = pl.map do |p| 
+        r = p.name
+
+        r << " | #{p.external_urls["spotify"]}" unless options.url.nil?
+
+        r
+      end
+
+      puts results
+    end
+
+    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 
+      FileUtils.mkdir_p(options.output_directory) unless Dir.exist? options.output_directory
+
+      pl = spotify.get_user_playlists(options.user)
+
+      # For each playlist 
+      pl.each do |p|
+        # Remove non-alphanumeric characters
+        sanitized_name = p.name.gsub(/[^[:alnum:]]/, "")
+        playlist_file_name = File.join(options.output_directory, sanitized_name)
+
+        # Create a file for the playlist 
+        File.open(playlist_file_name, "w") do |f|
+
+          # Write the name of each artist and song 
+          p.tracks.each do |t| 
+            artists = t.artists.map(&:name).join(", ")
+
+            f.puts "#{artists} - #{t.name}"
+          end
+        end
+      end
+    end
+
+    private
+    #
+    # SpotifyClient
+    #
+    def spotify
+      return @spotify unless @spotify.nil?
+
+      @spotify = SpotifyClient.new(config)
+
+      @spotify
+    end
+  end
+end

data/lib/spotifyexporter/config.rb

@@ -0,0 +1,132 @@
+# frozen_string_literal: true
+
+require "fileutils"
+require "yaml"
+require "singleton"
+require "pry"
+require_relative './lib/injectable.rb'
+
+module SpotifyExporter
+  module ConfigDependant
+    include Injectable
+
+    inject :config, -> { ConfigManager.instance.config } 
+  end
+
+  class AppConfig
+    attr_accessor :spotify_client_id, :spotify_client_secret
+
+    def initialize(id, secret)
+      @spotify_client_id = id
+      @spotify_client_secret = secret
+    end
+
+    def to_yaml
+      to_h.to_yaml
+    end
+
+    def credentials?
+      !@spotify_client_secret.nil? && !@spotify_client_id.nil?
+    end
+
+    def self.new_empty
+      new("", "")
+    end
+
+    private
+
+    def to_h
+      { spotify_client_id: @spotify_client_id, spotify_client_secret: @spotify_client_secret }
+    end
+  end
+
+  class ConfigManager
+    include Singleton
+
+    attr_reader :config_path
+
+    DEFAULT_CONFIG_DIR = ".config/spotifyexporter"
+
+    FILE_CLI_CONFIG = "config.yml"
+
+    # 
+    # Loads and saves the credentials to the main configuration
+    #
+    # @return [Boolean]
+    #
+    def save_credentials(client_id:, secret:)
+      load_config_file unless config_loaded?
+
+      @app_config.spotify_client_id = client_id
+      @app_config.spotify_client_secret = secret
+
+      save_config!
+    end
+
+    # 
+    # Retrieves the AppConfig
+    #
+    # @return [AppConfig]
+    #
+    def config
+      load_config_file unless config_loaded?
+
+      @app_config
+    end
+
+    private
+
+    #
+    # Saves the currently in-memory configuration
+    # 
+    # @return success [Boolean]
+    #
+    def save_config!
+      File.open(config_file_path, "w") do |f|
+        f.puts @app_config.to_yaml
+      end
+
+      true
+    end
+
+    def config_loaded?
+      !@app_config.nil?
+    end
+
+    def config_dir_path
+      @config_dir_path ||= File.join Dir.home, DEFAULT_CONFIG_DIR
+    end
+
+    def config_file_path
+      @config_file_path ||= File.join(config_dir_path, FILE_CLI_CONFIG)
+    end
+
+    #
+    # Reads the user file system configurations into the in-memory AppConfig 
+    #
+    def load_config_file
+      initialize_config_file unless config_file_exists?
+
+      config_yaml = YAML.load_file(config_file_path)
+
+      @app_config = if config_yaml.nil?
+                      AppConfig.new_empty
+                    else
+                      AppConfig.new(config_yaml[:spotify_client_id], config_yaml[:spotify_client_secret])
+                    end
+    end
+
+    def config_file_exists?
+      return false unless File.exist? config_file_path
+    end
+
+    #
+    # Initializes the configuration directory if non exists
+    #
+    def initialize_config_file
+      FileUtils.mkdir_p(config_dir_path) unless Dir.exist? config_dir_path
+
+      FileUtils.touch(config_file_path) unless File.exist? config_file_path
+    end
+  end
+end

data/lib/spotifyexporter/lib/injectable.rb

@@ -0,0 +1,15 @@
+module SpotifyExporter
+  module Injectable
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+      # Dynamically defines a private method in the included class
+      def inject(name, source)
+        define_method(name.to_sym) { source.call }
+        private name.to_sym
+      end
+    end
+  end
+end

data/lib/spotifyexporter/lib/spotify.rb

@@ -0,0 +1,47 @@
+require 'rspotify' 
+require 'addressable'
+
+class SpotifyClient
+  def initialize(conf)
+    RSpotify.authenticate(
+      conf.spotify_client_id, 
+      conf.spotify_client_secret 
+    )
+  end
+  # 
+  # GETs a user
+  #
+  # @param uname [String] 
+  #
+  def get_user(uname)
+    RSpotify::User.find(uname)
+  end
+
+  # 
+  # GETs all playlists for a user
+  #
+  # @param uname [String] 
+  #
+  def get_user_playlists(uname)
+    u = get_user(uname)
+
+    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
+      p = u.playlists(limit: 50, offset: offset)
+
+      playlists << p
+
+      offset += 50
+
+      last_pull_count = p.count
+    end
+
+    playlists.compact.flatten
+  end
+end

data/lib/spotifyexporter/version.rb

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

data/lib/spotifyexporter.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative "spotifyexporter/cli"

data/sig/spotifyexporter.rbs

@@ -0,0 +1,4 @@
+module SpotifyExporter
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

data/spotifyexporter.gemspec

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require_relative "lib/spotifyexporter/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "spotifyexporter"
+  spec.version = SpotifyExporter::VERSION
+  spec.authors = ["aquaflamingo"]
+  spec.email = ["16901597+aquaflamingo@users.noreply.github.com"]
+
+  spec.summary = "Export your Spotify playlists"
+  spec.description = "Export your Spotify playlists"
+  spec.homepage = "https://github.com/aquaflamingo/spotify-exporter"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/aquaflamingo/spotify-exporter"
+  spec.metadata["changelog_uri"] = "https://github.com/aquaflamingo/spotify-exporter/releases"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  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 "thor", "~> 1.2.1"
+  spec.add_dependency "tty-prompt", "~> 0.23.1"
+
+  spec.add_development_dependency "pry"
+end

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification
+name: spotifyexporter
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- aquaflamingo
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-05-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspotify
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.1
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.1
+- !ruby/object:Gem::Dependency
+  name: tty-prompt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.23.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.23.1
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Export your Spotify playlists
+email:
+- 16901597+aquaflamingo@users.noreply.github.com
+executables:
+- spotifyexporter
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- exe/spotifyexporter
+- lib/spotifyexporter.rb
+- lib/spotifyexporter/auth.rb
+- lib/spotifyexporter/cli.rb
+- lib/spotifyexporter/command/playlists.rb
+- lib/spotifyexporter/config.rb
+- lib/spotifyexporter/lib/injectable.rb
+- lib/spotifyexporter/lib/spotify.rb
+- lib/spotifyexporter/version.rb
+- sig/spotifyexporter.rbs
+- spotifyexporter.gemspec
+homepage: https://github.com/aquaflamingo/spotify-exporter
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/aquaflamingo/spotify-exporter
+  source_code_uri: https://github.com/aquaflamingo/spotify-exporter
+  changelog_uri: https://github.com/aquaflamingo/spotify-exporter/releases
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: Export your Spotify playlists
+test_files: []