spotify-music-importer 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a4a972face08ca5017576c6031ebdb88b350023e
+  data.tar.gz: c63e0f32185e76dc6a8b3dad534d021ac484f7fe
+SHA512:
+  metadata.gz: ea1319db8d8ffc67541af815ed8866070474da82142702a1074659356a5175b60a60f7014e51bff63210385ac2a805c3acb0f4523b7d9c7ecf4b05307153a6c1
+  data.tar.gz: 38a91d7e42d43968f29044f20e0d315b44f3440764e619ac95122acd3efb435171140822755bfd25071ce9a43a778a431755b794b4897f1e85ad86c726a384cd

data/.gitignore

@@ -0,0 +1,35 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+.ruby-version
+.ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/Gemfile

@@ -0,0 +1,11 @@
+# A sample Gemfile
+source "https://rubygems.org"
+
+gemspec
+
+gem 'spotify-client', :github => 'X0nic/spotify-client', :branch => 'add-library'
+gem 'colorize'
+
+group :development do
+  gem 'pry'
+end

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Nathan Lee
+
+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,21 @@
+# Spotify Music Importer
+
+If you want to import your library of music into spotify, this will help. It uses CSV right now, as most library exports are in that format.
+
+## Installation
+
+    $ gem install spotify-music-importer
+
+## Usage
+
+```sh
+bundle exec ./import.rb -f CSV_FILE -t SPOTIFY_ACCESS_TOKEN
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/x0nic/spotify-music-importer/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,3 @@
+# encoding: utf-8
+
+require 'bundler/gem_tasks'

data/bin/spotify-music-importer

@@ -0,0 +1,42 @@
+#! /usr/bin/env ruby
+
+$:.unshift File.join(File.dirname(__FILE__), *%w[.. lib])
+
+require 'optparse'
+require 'spotify/music/importer'
+
+options = {}
+OptionParser.new do |opts|
+  opts.banner = "Usage: import.rb [options]"
+
+  opts.on("-f", "--file FILENAME", "The filename to import") do |filename|
+    options[:filename] = filename
+  end
+
+  opts.on("-m", "--missing MISSING.json", "The output filename of bad matches") do |missing|
+    options[:missing] = missing
+  end
+
+  opts.on("-l", "--limit LIMIT", "Limit the number of lines to import") do |limit|
+    options[:limit] = limit.to_i
+  end
+
+  opts.on("-s", "--skip SKIP", "Skip the first X lines of import") do |skip|
+    options[:skip] = skip.to_i
+  end
+
+  opts.on("-t", "--access-token ACCESS_TOKEN", "Your access token to access the Spotify API. Find one here: https://developer.spotify.com/web-api/console/") do |token|
+    options[:access_token] = token
+  end
+
+end.parse!
+
+importer = Spotify::Music::Importer::Cli.new
+importer.import(options[:filename], options)
+
+if options[:missing]
+  File.open(options[:missing], 'w') do |f|
+    puts "Writing to file #{options[:missing]}"
+    f.write(JSON.pretty_generate(importer.missing))
+  end
+end

data/lib/spotify/music/importer.rb

@@ -0,0 +1,55 @@
+require 'spotify/music/importer/spotify_library'
+require 'spotify/music/importer/collection_record'
+require 'spotify/music/importer/spotify_match'
+
+require 'colorize'
+require 'csv'
+require 'spotify-client'
+
+
+module Spotify
+  module Music
+    module Importer
+      class Cli
+        def initialize
+        end
+
+        def import(filename, options)
+          @options = options
+          @library = SpotifyLibrary.new(client)
+          limit = options.delete(:limit) { nil }
+          skip  = options.delete(:skip) { 0 }
+
+          collection = CSV.read(filename, :headers => true)
+          collection.each_with_index do |row, index|
+            next if skip && skip > index+1
+            break if limit && index+1 > limit+skip
+
+            record = CollectionRecord.new(row, :clean_album => true, :clean_track => true)
+            results = SpotifyMatch.new(client.search(:track, format_query(record)), :clean_album => true, :clean_track => true)
+            @library.find_and_add_to_library(record, results, index)
+          end
+        end
+
+        def missing
+          @library.missing
+        end
+
+        def format_query(record)
+          "track:#{record.name} artist:#{record.artist} album:#{record.album}"
+        end
+
+        def client
+          @client ||= begin
+                        if @options[:access_token]
+                          Spotify::Client.new({:raise_errors => true}.merge(@options))
+                        else
+                          Spotify::Client.new(:raise_errors => true)
+                        end
+                      end
+        end
+
+      end
+    end
+  end
+end

data/lib/spotify/music/importer/album_name_cleaner.rb

@@ -0,0 +1,32 @@
+require "spotify/music/importer/version"
+
+module Spotify::Music::Importer
+  class AlbumNameCleaner
+    def initialize(album_name)
+      @album_name = album_name
+    end
+
+    def clean
+      cleaned_album = @album_name
+
+      extraneous_album_info.each do |album_info|
+        cleaned_album = cleaned_album.gsub(album_info, '').strip
+      end
+
+      cleaned_album
+    end
+
+    def extraneous_album_info
+      [
+        '(Special Edition)',
+        '(Deluxe Edition)',
+        '(Deluxe Edition Remastered)',
+        '(Remastered)',
+        '(Canadian Version)',
+        '(Non EU Version)',
+        '(UK Version)',
+        '(Brazilian Version)'
+      ]
+    end
+  end
+end

data/lib/spotify/music/importer/collection_match.rb

@@ -0,0 +1,22 @@
+require "spotify/music/importer/version"
+
+module Spotify::Music::Importer
+  class CollectionMatch
+    def initialize(collection_record, spotify_match)
+      @collection_record = collection_record
+      @spotify_match = spotify_match
+    end
+
+    def full_match
+      name_match && album_match
+    end
+
+    def name_match
+      @collection_record.name == @spotify_match.name
+    end
+
+    def album_match
+      @collection_record.album == @spotify_match.album
+    end
+  end
+end

data/lib/spotify/music/importer/collection_record.rb

@@ -0,0 +1,45 @@
+require "spotify/music/importer/version"
+require 'spotify/music/importer/track_name_cleaner'
+require 'spotify/music/importer/album_name_cleaner'
+
+module Spotify::Music::Importer
+  class CollectionRecord
+    def initialize(row, options = {})
+      @row = row
+      @clean_album = options.delete(:clean_album) { false }
+      @clean_track = options.delete(:clean_track) { false }
+    end
+
+    def name
+      if @clean_track
+        TrackNameCleaner.new(@row['Name']).clean
+      else
+        @row['Name']
+      end
+    end
+
+    def artist
+      if @clean_album
+        @row['Artist'].gsub('(Special Edition)', '').strip
+      else
+        @row['Artist']
+      end
+    end
+
+    def album
+      if @clean_album
+        AlbumNameCleaner.new(@row['Album']).clean
+      else
+        @row['Album']
+      end
+    end
+
+    def to_s
+      "Name: #{name} Album: #{album} Artist: #{artist}"
+    end
+
+    def to_json(options = {})
+      { :name => name, :album => album, :artist => artist }.to_json(options)
+    end
+  end
+end

data/lib/spotify/music/importer/spotify_library.rb

@@ -0,0 +1,53 @@
+require "spotify/music/importer/version"
+require "spotify/music/importer/collection_match"
+
+module Spotify::Music::Importer
+  class SpotifyLibrary
+    def initialize(client)
+      @client = client
+      @missing = []
+    end
+
+    def find_and_add_to_library(record, results, index)
+      match = CollectionMatch.new(record, results)
+
+      if results.found_match?
+        print "[#{index+1}] "
+        if match.full_match
+          print results.to_s.green
+          add_to_library(results.id)
+        elsif match.name_match
+          print results.to_s.yellow
+          add_to_library(results.id)
+        elsif match.album_match
+          print results.to_s.colorize(:orange)
+          add_to_library(results.id)
+          puts "Collection Record: #{record}"
+        else
+          print results
+          add_to_library(results.id)
+          puts "Collection Record: #{record}"
+        end
+      else
+        puts "not found - #{record}".red
+        @missing << record
+      end
+    end
+
+    def missing
+      @missing
+    end
+
+    private
+
+    def add_to_library(track_id)
+      if @client.library?(track_id).first
+        puts " Ignored #{track_id}"
+      else
+        print ' Adding '
+        @client.add_library_tracks(track_id)
+        puts " Added #{track_id}"
+      end
+    end
+  end
+end

data/lib/spotify/music/importer/spotify_match.rb

@@ -0,0 +1,43 @@
+require "spotify/music/importer/version"
+
+module Spotify::Music::Importer
+  class SpotifyMatch
+    def initialize(results, options = {})
+      @results = results
+      @clean_album = options.delete(:clean_album) { false }
+      @clean_track = options.delete(:clean_track) { false }
+    end
+
+    def found_match?
+      @results['tracks']['items'].count > 0
+    end
+
+    def name
+      if @clean_track
+        TrackNameCleaner.new(@results["tracks"]["items"].first["name"]).clean
+      else
+        @results["tracks"]["items"].first["name"]
+      end
+    end
+
+    def artist
+      @results["tracks"]['items'].first['artists'].first['name']
+    end
+
+    def album
+      if @clean_album
+        AlbumNameCleaner.new(@results["tracks"]['items'].first['album']['name']).clean
+      else
+        @results["tracks"]['items'].first['album']['name']
+      end
+    end
+
+    def id
+      @results ["tracks"]["items"].first["id"]
+    end
+
+    def to_s
+      "Name: #{name} Album: #{album} Artist: #{artist} id: #{id}"
+    end
+  end
+end

data/lib/spotify/music/importer/track_name_cleaner.rb

@@ -0,0 +1,30 @@
+require "spotify/music/importer/version"
+
+module Spotify::Music::Importer
+  class TrackNameCleaner
+    def initialize(track_name)
+      @track_name = track_name
+    end
+
+    def clean
+      cleaned_track = @track_name
+
+      extraneous_track_info.each do |track_info|
+        cleaned_track = cleaned_track.gsub(track_info, '').strip
+      end
+
+      cleaned_track
+    end
+
+    def extraneous_track_info
+      [
+        '- Remastered',
+        '- Single',
+        '(Clean Album Version) (Clean)',
+        '(Album Version)',
+        '(Amended Album Version)',
+        '(Explicit Album Version)'
+      ]
+    end
+  end
+end

data/lib/spotify/music/importer/version.rb

@@ -0,0 +1,7 @@
+module Spotify
+  module Music
+    module Importer
+      VERSION = "0.0.1"
+    end
+  end
+end

data/lib/spotify_importer.rb

@@ -0,0 +1,5 @@
+
+
+
+
+

data/spotify-music-importer.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'spotify/music/importer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "spotify-music-importer"
+  spec.version       = Spotify::Music::Importer::VERSION
+  spec.authors       = ["Nathan Lee"]
+  spec.email         = ["nathan@globalphobia.com"]
+  spec.summary       = %q{A utility to import a csv into your spotify music library}
+  # spec.description   = %q{TODO: Write a longer description. Optional.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: spotify-music-importer
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Nathan Lee
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-06-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: 
+email:
+- nathan@globalphobia.com
+executables:
+- spotify-music-importer
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-gemset"
+- ".ruby-version"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/spotify-music-importer
+- lib/spotify/music/importer.rb
+- lib/spotify/music/importer/album_name_cleaner.rb
+- lib/spotify/music/importer/collection_match.rb
+- lib/spotify/music/importer/collection_record.rb
+- lib/spotify/music/importer/spotify_library.rb
+- lib/spotify/music/importer/spotify_match.rb
+- lib/spotify/music/importer/track_name_cleaner.rb
+- lib/spotify/music/importer/version.rb
+- lib/spotify_importer.rb
+- spotify-music-importer.gemspec
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.3
+signing_key: 
+specification_version: 4
+summary: A utility to import a csv into your spotify music library
+test_files: []