drum 0.1.14 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: da330d9d023cd2cab59a1e210a1363fa00569fed1c5edcf382424112ba2e5bc3
-  data.tar.gz: 7d339df36d5438a64ef33887ccfe084a350d8737cf0444fbe95adb901e1f6bd3
+  metadata.gz: 0515ca290089497d8667ed64575eb60dc604ba793812b77437ced8d27f70e6bb
+  data.tar.gz: 1da960b8dc5e79ce85328e918c43d214898824e51d544b613b58ede726666f97
 SHA512:
-  metadata.gz: f023760cc5107baf38d87c60cba3d404732d14552c50a904358abd8153d28861386e53f359f4ba3735e7e66b6566dac529706ed29b15853a18c7c3c10ba53302
-  data.tar.gz: fdd9371a7f21d5a879444f4d2c39552e5b15af27459c0126264171633a86b4c7f5c460405a9af63b3758aa130cf9cea919e9878c77b6b2d8726eccd2f3c1a439
+  metadata.gz: db118818875e8c9d0d5281697e033bcaeebb3bc204355e41ab4436ed2da1738297c703ed8aa813f32456f968851729794f3e209c0510ca1ddbf218b93af75ab0
+  data.tar.gz: 24ce2b4be59b259617cc50ba66fc35c48aeeeb89faa716a5ad457a959364ccb39cb37b7fa86c4e4f4da6593b7c753bc9eebcde02226d24a6a65402f5d2e7eca8

data/.github/workflows/test.yml

@@ -4,13 +4,18 @@ on: [push]
 
 jobs:
   test:
-    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        os: ['ubuntu-latest', 'macos-latest']
+        ruby: ['2.7.0', '3.2.0']
+
+    runs-on: '${{ matrix.os }}'
     steps:
     - uses: actions/checkout@v2
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1
       with:
-        ruby-version: 2.7.0
+        ruby-version: '${{ matrix.ruby }}'
     - name: Install dependencies
       run: |
         gem install bundler -v 2.2.0

data/Gemfile

@@ -3,6 +3,19 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in drum.gemspec
 gemspec
 
+# Install AppleScript bridge on macOS
+#
+# Note: End-users installing drum via 'gem install'
+# will need to install rb-scpt manually to use the integration.
+#
+# TODO: Investigate whether this could be done automatically
+# See https://stackoverflow.com/a/10249133 for more info.
+# Unfortunately checking the OS in the gemspec is insufficient,
+# since the file is evaluated at packaging time.
+if RUBY_PLATFORM =~ /\bdarwin/
+  gem 'rb-scpt', '~> 1.0'
+end
+
 group :development, :test do
   gem 'rake', '~> 13.0'
   gem 'yard', '~> 0.9'

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    drum (0.1.14)
+    drum (0.2.1)
       highline (~> 2.0)
       jwt (~> 2.2)
       launchy (~> 2.4)
@@ -9,55 +9,55 @@ PATH
       rest-client (~> 2.0)
       rspotify (~> 2.10)
       ruby-limiter (~> 2.1)
-      thor (~> 0.20)
+      thor (~> 1.2)
       webrick (~> 1.7)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.8.0)
-      public_suffix (>= 2.0.2, < 5.0)
-    diff-lcs (1.4.4)
+    addressable (2.8.4)
+      public_suffix (>= 2.0.2, < 6.0)
+    diff-lcs (1.5.0)
     domain_name (0.5.20190701)
       unf (>= 0.0.5, < 1.0.0)
-    faraday (2.3.0)
-      faraday-net_http (~> 2.0)
+    faraday (2.7.4)
+      faraday-net_http (>= 2.0, < 3.1)
       ruby2_keywords (>= 0.0.4)
-    faraday-net_http (2.0.2)
-    ffi (1.15.5-x64-mingw32)
+    faraday-net_http (3.0.2)
+    ffi (1.15.5)
     hashie (5.0.0)
-    highline (2.0.3)
-    http-cookie (1.0.4)
+    highline (2.1.0)
+    http-cookie (1.0.5)
       domain_name (~> 0.5)
-    jwt (2.3.0)
-    launchy (2.5.0)
-      addressable (~> 2.7)
+    jwt (2.7.0)
+    launchy (2.5.2)
+      addressable (~> 2.8)
     mime-types (3.4.1)
       mime-types-data (~> 3.2015)
-    mime-types-data (3.2022.0105)
-    multi_json (1.15.0)
+    mime-types-data (3.2023.0218.1)
     multi_xml (0.6.0)
     netrc (0.11.0)
-    oauth2 (1.4.9)
+    oauth2 (2.0.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 (2.1.0)
+      rack (>= 1.2, < 4)
+      snaky_hash (~> 2.0)
+      version_gem (~> 1.1)
+    omniauth (2.1.1)
       hashie (>= 3.4.6)
       rack (>= 2.2.3)
       rack-protection
-    omniauth-oauth2 (1.7.2)
-      oauth2 (~> 1.4)
-      omniauth (>= 1.9, < 3)
+    omniauth-oauth2 (1.8.0)
+      oauth2 (>= 1.4, < 3)
+      omniauth (~> 2.0)
     options (2.3.2)
     progress_bar (1.3.3)
       highline (>= 1.6, < 3)
       options (~> 2.3.0)
-    public_suffix (4.0.7)
-    rack (2.2.3)
-    rack-protection (2.2.0)
+    public_suffix (5.0.1)
+    rack (3.0.7)
+    rack-protection (3.0.6)
       rack
     rake (13.0.6)
     rest-client (2.0.2)
@@ -69,31 +69,35 @@ GEM
       http-cookie (>= 1.0.2, < 2.0)
       mime-types (>= 1.16, < 4.0)
       netrc (~> 0.8)
-    rspec (3.10.0)
-      rspec-core (~> 3.10.0)
-      rspec-expectations (~> 3.10.0)
-      rspec-mocks (~> 3.10.0)
-    rspec-core (3.10.1)
-      rspec-support (~> 3.10.0)
-    rspec-expectations (3.10.1)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.2)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.3)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.2)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.5)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-support (3.10.2)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
     rspotify (2.11.1)
       addressable (~> 2.8.0)
       omniauth-oauth2 (>= 1.6)
       rest-client (~> 2.0.2)
     ruby-limiter (2.2.2)
     ruby2_keywords (0.0.5)
-    thor (0.20.3)
+    snaky_hash (2.0.1)
+      hashie
+      version_gem (~> 1.1, >= 1.1.1)
+    thor (1.2.1)
     unf (0.1.4)
       unf_ext
-    unf_ext (0.0.8.1)
-    webrick (1.7.0)
-    yard (0.9.26)
+    unf_ext (0.0.8.2)
+    version_gem (1.1.2)
+    webrick (1.8.1)
+    yard (0.9.34)
 
 PLATFORMS
   ruby
@@ -107,4 +111,4 @@ DEPENDENCIES
   yard (~> 0.9)
 
 BUNDLED WITH
-   2.2.29
+   2.4.12

data/README.md

@@ -1,5 +1,8 @@
 # Drum
 
+[![Test](https://github.com/fwcd/drum/actions/workflows/test.yml/badge.svg)](https://github.com/fwcd/drum/actions/workflows/test.yml)
+[![Documentation](https://github.com/fwcd/drum/actions/workflows/documentation.yml/badge.svg)](https://fwcd.github.io/drum)
+
 A small tool for copying your playlists across music streaming services. Think `rsync`, but for playlists.
 
 ![Icon](artwork/icon128.png)
@@ -21,6 +24,7 @@ The basic usage pattern is always `drum cp [source] [destination]` where `source
   * `@spotify/playlists`
   * `@spotify/tracks`
   * `@applemusic/playlists`
+  * `@music/playlists` (referring to the local Apple Music (`Music.app`) library on macOS)
   * `@stdin`
   * `@stdout`
 * A dash `-`, synonymous with `@stdin` and `@stdout`, depending on usage
@@ -67,6 +71,8 @@ To run the application, run `bundle exec bin/drum`. You can also run `bin/consol
 
 To package the application into a gem, run `bundle exec rake build`. The built gem should then be located in `pkg`.
 
+> Note: If you wish to install `drum` using `gem install`, you may need to install additional gems such as `rb-scpt` on macOS to use platform-specific integrations. See [the `Gemfile`](Gemfile) for more information.
+
 To install the gem, run `bundle exec rake install`.
 
 To generate the documentation, run `bundle exec rake yard`.

data/drum.gemspec

@@ -23,8 +23,8 @@ Gem::Specification.new do |spec|
   spec.bindir        = 'bin'
   spec.executables   = ['drum']
   spec.require_paths = ['lib']
-  
-  spec.add_dependency 'thor', '~> 0.20'
+
+  spec.add_dependency 'thor', '~> 1.2'
   spec.add_dependency 'rspotify', '~> 2.10'
   spec.add_dependency 'launchy', '~> 2.4'
   spec.add_dependency 'ruby-limiter', '~> 2.1'

data/lib/drum/service/applemusic.rb

@@ -167,8 +167,6 @@ module Drum
         server.shutdown
       end
 
-      trap 'INT' do server.shutdown end
-
       log.info "Launching callback HTTP server on port #{port}, waiting for auth code..."
       server.start
 
@@ -186,6 +184,8 @@ module Drum
       }
 
       user_token
+    ensure
+      server&.shutdown
     end
 
     def authenticate

data/lib/drum/service/file.rb

@@ -2,6 +2,7 @@ require 'drum/model/playlist'
 require 'drum/model/ref'
 require 'drum/service/service'
 require 'drum/utils/log'
+require 'drum/utils/yaml'
 require 'pathname'
 require 'uri'
 require 'yaml'
@@ -9,7 +10,7 @@ require 'yaml'
 module Drum
   # A service that reads/writes playlists to/from YAML files.
   class FileService < Service
-    include Log
+    include Log, YAMLUtils
 
     def name
       'file'
@@ -45,12 +46,12 @@ module Drum
       if base_path.directory?
         Dir.glob("#{base_path}/**/*.{yaml,yml}").map do |p|
           path = Pathname.new(p)
-          playlist = Playlist.deserialize(YAML.load(path.read))
+          playlist = Playlist.deserialize(from_yaml(path.read))
           playlist.path = path.relative_path_from(base_path).parent.each_filename.to_a
           playlist
         end
       else
-        [Playlist.deserialize(YAML.load(base_path.read))]
+        [Playlist.deserialize(from_yaml(base_path.read))]
       end
     end
 
@@ -74,7 +75,7 @@ module Drum
           end
 
           length = 6
-          while playlist_path[length].exist? && Playlist.deserialize(YAML.load(playlist_path[length].read)).id != playlist.id
+          while playlist_path[length].exist? && Playlist.deserialize(from_yaml(playlist_path[length].read)).id != playlist.id
             length += 1
           end
 

data/lib/drum/service/music.rb

@@ -0,0 +1,117 @@
+require 'drum/model/album'
+require 'drum/model/artist'
+require 'drum/model/ref'
+require 'drum/model/playlist'
+require 'drum/model/track'
+require 'drum/service/service'
+require 'drum/utils/log'
+
+module Drum
+  # A service that uses AppleScript to interact with the local Apple Music (Music.app) library.
+  #
+  # Useful resources:
+  # - https://github.com/BrendanThompson/rb-scpt/tree/develop/sample
+  # - https://stackoverflow.com/questions/12964766/create-playlist-in-itunes-with-python-and-scripting-bridge
+  # - https://dougscripts.com/itunes/itinfo/info01.php
+  # - https://dougscripts.com/itunes/itinfo/info02.php
+  # - https://dougscripts.com/itunes/itinfo/info03.php
+  # - https://github.com/sorah/jockey/blob/master/add.rb
+  class MusicService < Service
+    include Log
+
+    def name
+      'music'
+    end
+
+    def require_rb_scpt
+      begin
+        require 'rb-scpt'
+      rescue LoadError
+        raise "Using the local Apple Music importer requires the 'rb-scpt' gem (which requires macOS)"
+      end
+    end
+
+    def get_library_proxy
+      self.require_rb_scpt
+      music = Appscript.app('Music')
+      source = music.sources[1]
+      unless source.kind.get == :library
+        raise 'Could not get music library source'
+      end
+      return source
+    end
+
+    # Ref parsing
+
+    def parse_ref(raw_ref)
+      if raw_ref.is_token
+        location = case raw_ref.text
+        when "#{self.name}/playlists" then :playlists
+        else return nil
+        end
+        Ref.new(self.name, :special, location)
+      else
+        nil
+      end
+    end
+
+    # Upload helpers
+
+    def to_track_proxy(library_proxy, playlist, track)
+      # Get track metadata
+      name = track.name
+      artists = track.artist_ids.map { |id| playlist.artists[id].name }
+
+      # Match the track with a track in the local library
+      # TODO: Don't require exact 100% matches
+      name_query = Appscript.its.name.eq(name)
+      artists_query = artists
+        .map { |a| Appscript.its.artist.contains(a) }
+        .reduce { |q1, q2| q1.or(q2) }
+      query = name_query.and(artists_query)
+
+      # Find a matching track in the track
+      # TODO: Instead of choosing the first, prefer iTunes-matched/higher bitrate ones etc.
+      track_proxy = library_proxy.tracks[query].get.first
+
+      if track_proxy.nil?
+        log.warn "No match found for '#{track.name}' by '#{artists.first}'"
+      else
+        log.info "Matched '#{track.name}' with '#{track_proxy.name.get}' by '#{track_proxy.artist.get}'"
+      end
+      track_proxy
+    end
+
+    def upload_playlist(library_proxy, playlist)
+      playlist_proxy = library_proxy.make(new: :playlist, with_properties: {
+        name: playlist.name,
+        description: playlist.description,
+      }.compact)
+      
+      playlist.tracks.each do |track|
+        track_proxy = self.to_track_proxy(library_proxy, playlist, track)
+        unless track_proxy.nil?
+          track_proxy.duplicate(to: playlist_proxy)
+        end
+      end
+    end
+
+    # Service
+
+    def download(ref)
+      raise 'Downloading is not implemented yet'
+    end
+
+    def upload(ref, playlists)
+      library_proxy = self.get_library_proxy
+
+      unless ref.resource_type == :special && ref.resource_location == :playlists
+        raise "Cannot upload to anything other than @#{self.name}/playlists yet!"
+      end
+      
+      playlists.each do |playlist|
+        self.upload_playlist(library_proxy, playlist)
+      end
+    end
+  end
+end

data/lib/drum/service/spotify.rb

@@ -137,8 +137,6 @@ module Drum
       authorize_url = "https://accounts.spotify.com/authorize?client_id=#{client_id}&response_type=code&redirect_uri=http%3A%2F%2Flocalhost:#{port}%2Fcallback&scope=#{scopes.join('%20')}&state=#{csrf_state}"
       Launchy.open(authorize_url)
 
-      trap 'INT' do server.shutdown end
-      
       log.info "Launching callback HTTP server on port #{port}, waiting for auth code..."
       server.start
       
@@ -155,6 +153,8 @@ module Drum
       })
       
       self.consume_authentication_response(auth_response)
+    ensure
+      server&.shutdown
     end
 
     def authenticate_user_via_refresh(client_id, client_secret, refresh_token)

data/lib/drum/service/stdio.rb

@@ -2,12 +2,13 @@ require 'drum/model/playlist'
 require 'drum/model/ref'
 require 'drum/service/service'
 require 'drum/utils/log'
+require 'drum/utils/yaml'
 require 'yaml'
 
 module Drum
   # A service that reads from stdin and writes to stdout.
   class StdioService < Service
-    include Log
+    include Log, YAMLUtils
 
     def name
       'stdio'
@@ -31,7 +32,7 @@ module Drum
     def download(playlist_ref)
       if playlist_ref.resource_location.include?(:stdin)
         # TODO: Support multiple, --- delimited playlists?
-        [Playlist.deserialize(YAML.load(STDIN.read))]
+        [Playlist.deserialize(from_yaml(STDIN.read))]
       else
         []
       end

data/lib/drum/utils/persist.rb

@@ -1,50 +1,58 @@
+require 'drum/utils/log'
+require 'drum/utils/yaml'
 require 'yaml'
 
-# A wrapper around a hash that stores values persistently in a YAML.
-#
-# @!attribute value
-#  @return [Hash] The wrapped hash
-class Drum::PersistentHash
-  attr_reader :value
-
-  # Creates a new persistent hash.
+module Drum
+  # A wrapper around a hash that stores values persistently in a YAML.
   #
-  # @param [String] file_path The path to the stored YAML file (may be non-existent).
-  # @param [Hash] value The initial default value, if the file doesn't exist yet or is malformed
-  def initialize(file_path, value={})
-    @file_path = file_path
-    begin
-      self.load
-    rescue StandardError => e
-      @value = value
-      self.store
+  # @!attribute value
+  #  @return [Hash] The wrapped hash
+  class PersistentHash
+    include Log, YAMLUtils
+    attr_reader :value
+
+    # Creates a new persistent hash.
+    #
+    # @param [String] file_path The path to the stored YAML file (may be non-existent).
+    # @param [Hash] value The initial default value, if the file doesn't exist yet or is malformed
+    def initialize(file_path, value={})
+      @file_path = file_path
+      begin
+        self.load
+      rescue StandardError => e
+        unless e.is_a?(Errno::ENOENT)
+          log.warn "Could not load #{file_path}: #{e.inspect}... creating from scratch"
+        end
+        @value = value
+        self.store
+      end
     end
-  end
 
-  # Loads the hash from the file.
-  def load
-    @value = YAML.load(File.read(@file_path))
-  end
+    # Loads the hash from the file.
+    def load
+      @value = from_yaml(File.read(@file_path))
+    end
 
-  # Saves the hash to the file.
-  def store
-    File.write(@file_path, @value.to_yaml)
-  end
+    # Saves the hash to the file.
+    def store
+      File.write(@file_path, @value.to_yaml)
+    end
 
-  # Writes a mapping to the hash and stores it on disk.
-  #
-  # @param [Object] key The key to use.
-  # @param [Object] value The value to map the key to.
-  def []=(key, value)
-    @value[key] = value
-    store
-  end
+    # Writes a mapping to the hash and stores it on disk.
+    #
+    # @param [Object] key The key to use.
+    # @param [Object] value The value to map the key to.
+    def []=(key, value)
+      @value[key] = value
+      store
+    end
 
-  # Reads a mapping from the hash.
-  #
-  # @param [Object] key The key to use.
-  # @return [Object] The value the key is mapped to.
-  def [](key)
-    @value[key]
+    # Reads a mapping from the hash.
+    #
+    # @param [Object] key The key to use.
+    # @return [Object] The value the key is mapped to.
+    def [](key)
+      @value[key]
+    end
   end
 end

data/lib/drum/utils/yaml.rb

@@ -0,0 +1,11 @@
+require 'date'
+require 'yaml'
+
+module Drum
+  module YAMLUtils
+    # Deserializes YAML with a number of standard permitted classes.
+    def from_yaml(yaml)
+      YAML.load(yaml, permitted_classes: [Date, DateTime, Symbol, Time])
+    end
+  end
+end

data/lib/drum/version.rb

@@ -1,3 +1,3 @@
 module Drum
-  VERSION = '0.1.14'
+  VERSION = '0.2.1'
 end

data/lib/drum.rb

@@ -2,6 +2,7 @@ require 'drum/model/raw_ref'
 require 'drum/service/applemusic'
 require 'drum/service/file'
 require 'drum/service/mock'
+require 'drum/service/music'
 require 'drum/service/service'
 require 'drum/service/spotify'
 require 'drum/service/stdio'
@@ -25,8 +26,8 @@ module Drum
 
       @hl = HighLine.new
 
-      # Set up .drum directory
-      @dot_dir = Pathname.new(Dir.home) / '.drum'
+      # Set up directory for persisted state
+      @dot_dir = Pathname.new(Dir.home) / '.local' / 'state' / 'drum'
       @dot_dir.mkdir unless @dot_dir.directory?
 
       @cache_dir = @dot_dir / 'cache'
@@ -35,6 +36,7 @@ module Drum
       # Declare services in descending order of parse priority
       @services = [
         MockService.new,
+        MusicService.new,
         StdioService.new,
         AppleMusicService.new(@cache_dir),
         SpotifyService.new(@cache_dir),
@@ -130,7 +132,6 @@ module Drum
     method_option :recase_paths,
       type: :string,
       enum: ['kebabcase', 'startcase', 'camelcase', 'pascalcase'],
-      default: false,
       desc: "Convert each playlist's path segments to a specific case."
 
     method_option :flatten,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: drum
 version: !ruby/object:Gem::Version
-  version: 0.1.14
+  version: 0.2.1
 platform: ruby
 authors:
 - fwcd
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-05-08 00:00:00.000000000 Z
+date: 2024-01-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.20'
+        version: '1.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.20'
+        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: rspotify
   requirement: !ruby/object:Gem::Requirement
@@ -171,12 +171,14 @@ files:
 - lib/drum/service/applemusic.rb
 - lib/drum/service/file.rb
 - lib/drum/service/mock.rb
+- lib/drum/service/music.rb
 - lib/drum/service/service.rb
 - lib/drum/service/spotify.rb
 - lib/drum/service/stdio.rb
 - lib/drum/utils/ext.rb
 - lib/drum/utils/log.rb
 - lib/drum/utils/persist.rb
+- lib/drum/utils/yaml.rb
 - lib/drum/version.rb
 - userdoc/playlist-format.md
 homepage: https://github.com/fwcd/drum.git