mpris_scrobbler 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2b86ec7868b89617a259868a94721b511963521e
+  data.tar.gz: c6f0cfe820851c6f816d18acf9c6f3d8a1e1a84d
+SHA512:
+  metadata.gz: 21ad45f00ef98e20cde5703d4cb8a730a56a5ea6d44a6312bf54faf61685423eed125da802cfbfb8681ccd153441bfeea6cfd6f81ddbdff939bff9cc93055afe
+  data.tar.gz: 3c6f5bccba90ab5688e299dc9d20d31260d5a912f31f8c42ad208d2357a091e1a7d95956cf51efeff8ee9693629e2457b3296dceed6e871bedeb25636d85a9ed

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in mpris_scrobbler.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Bruno Antunes
+
+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,34 @@
+# MPRIS Scrobbler
+
+I sometimes listen to music using Audacious (I'm a sucker for classic Winamp skins), and I've noticed the Last.fm plugin doesn't work for me on Fedora 23. But I also noticed that it supports [MPRIS], and I've always wanted to play with D-Bus.
+
+So this project scrobbles your tracks to Last.fm as long as Audacious is running concurrently, and its `MPRIS 2 Server` plugin is enabled. It's a quick and dirty hack, but I might come back to it in the future.
+
+[MPRIS]: https://specifications.freedesktop.org/mpris-spec/latest/
+
+## Installation
+
+```ruby
+gem install mpris_scrobbler
+```
+
+## Usage
+
+It's a long running binary - feel free to use whatever daemon wrapper for it.
+The first time you run it, it creates a `config.yml` file in your home folder. In it, you have to fill in your Last.fm app API key and secret (create a new app [here], no need for a callback URL). You also need to fill in your Last.fm username, in order to fetch your last scrobbled track and determine if it needs updating. Do not fill in the `session_key` key.
+
+After you fill in the API keys in the config file, you need to run the binary one more time to generate a session key. After this, subsequent runs have no output.
+
+You can try to change the `player` key to support other MPRIS 2 compliant players, but I haven't tried this. Submit an issue, and I'll have a look if it doesn't work for your player - but it should, in theory!
+
+[here]: http://www.last.fm/api/account/create
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/sardaukar/mpris_scrobbler.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/mpris_scrobbler

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "mpris_scrobbler"
+
+MprisScrobbler::Spy.new.run

data/lib/mpris_scrobbler.rb

@@ -0,0 +1,5 @@
+module MprisScrobbler
+  VERSION = "1.0.0"
+end
+
+require "mpris_scrobbler/spy"

data/lib/mpris_scrobbler/spy.rb

@@ -0,0 +1,187 @@
+module MprisScrobbler
+  require 'dbus'
+  require 'rockstar'
+  require 'yaml'
+  class Spy
+
+    CONFIG_DIR = "~/.config/mpris_scrobbler"
+    CONFIG_FILE = "config.yml"
+
+    def initialize
+      @config =
+        if File.exists?(config_file_path)
+          load_config
+        else
+          gen_config
+          puts "Config example saved to #{File.join(CONFIG_DIR, CONFIG_FILE)}"
+          puts "Refer to the README file for next steps."
+          exit(0)
+        end
+
+      init_rockstar
+      ask_auth unless session_key
+
+      @interface = get_dbus_interface
+      @queue = []
+    end
+
+    def run
+      user = Rockstar::User.new(lastfm_config["username"])
+      last_track = user.recent_tracks.first.name rescue nil
+
+      loop do
+        current_track, artist, album, length = get_dbus_metadata
+
+        if current_track != last_track
+          @queue << {
+            track: current_track,
+            artist: artist.first,
+            album: album,
+            length: length,
+            scrobbled: false
+          }
+
+          if queue.size == 1
+            update_now_playing
+          else
+            scrobble_previous_track
+            update_now_playing
+          end
+
+          last_track = current_track
+        end
+
+        trim_queue if queue.size > 5
+
+        sleep sleep_period
+      end
+    end
+
+    private
+    attr_reader :interface, :config, :queue
+
+    def trim_queue
+      @queue = @queue[-3..-1]
+    end
+
+    def scrobble_previous_track
+      track_info = queue[-2]
+      return if track_info[:scrobbled]
+
+      Rockstar::Track.scrobble(
+        session_key: session_key,
+        track: track_info[:track],
+        artist: track_info[:artist],
+        album: track_info[:album],
+        time: Time.now - (track_info[:length] / 1_000_000),
+        length: track_info[:length]
+      )
+
+      @queue[-2][:scrobbled] = true
+    end
+
+    def update_now_playing
+      track_info = queue.last
+
+      Rockstar::Track.updateNowPlaying(
+        session_key: session_key,
+        track: track_info[:track],
+        artist: track_info[:artist],
+        album: track_info[:album],
+        time: Time.now,
+        length: track_info[:length]
+      )
+    end
+
+    def get_dbus_metadata
+      interface["Metadata"].values_at(
+        "xesam:title",
+        "xesam:artist",
+        "xesam:album",
+        "mpris:length"
+      )
+    end
+
+    def config_file_path
+      File.expand_path(File.join(CONFIG_DIR, CONFIG_FILE))
+    end
+
+    def ask_auth
+      auth = Rockstar::Auth.new
+      token = auth.token
+
+      puts
+      puts "Please open http://www.last.fm/api/auth/?api_key=#{Rockstar.lastfm_api_key}&token=#{token}"
+      puts
+      puts "Press enter when done."
+
+      gets
+
+      session = auth.session(token)
+
+      save_session(session)
+    end
+
+    def save_session(session)
+      @config["lastfm"]["session_key"] = session.key
+
+      File.open(config_file_path,"w") { |f| f.write @config.to_yaml }
+    end
+
+    def session_key
+      lastfm_config["session_key"]
+    end
+
+    def sleep_period
+      mpris_config["poll_every_seconds"]
+    end
+
+    def lastfm_config
+      config["lastfm"]
+    end
+
+    def mpris_config
+      config["mpris"]
+    end
+
+    def init_rockstar
+      Rockstar.lastfm = {
+        api_key: lastfm_config["api_key"],
+        api_secret: lastfm_config["api_secret"]
+      }
+    end
+
+    def gen_config
+      require 'fileutils'
+      FileUtils.mkdir_p File.expand_path(CONFIG_DIR)
+
+      template = {
+        lastfm: {
+          username: "XXX",
+          api_key: "XXX",
+          api_secret: "XXX",
+          session_key: nil
+        },
+        mpris: {
+          player: "audacious",
+          poll_every_seconds: 10
+        }
+      }
+
+      File.open(config_file_path,"w") { |f| f.write template.to_yaml }
+    end
+
+    def load_config
+      YAML.load_file(config_file_path)
+    end
+
+    def get_dbus_interface
+      bus = DBus::SessionBus.instance
+      service = bus.service("org.mpris.MediaPlayer2.#{mpris_config["player"]}")
+      player = service.object("/org/mpris/MediaPlayer2")
+
+      player.introspect
+      player["org.mpris.MediaPlayer2.Player"]
+    end
+  end
+end

data/mpris_scrobbler.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mpris_scrobbler'
+
+Gem::Specification.new do |spec|
+  spec.name          = "mpris_scrobbler"
+  spec.version       = MprisScrobbler::VERSION
+  spec.authors       = ["Bruno Antunes"]
+  spec.email         = ["sardaukar.siet@gmail.com"]
+
+  spec.summary       = %q{Last.fm scrobbler for Linux music players that follow the MPRIS 2 specification}
+  spec.description   = ""
+  spec.homepage      = "https://github.com/sardaukar/mpris_scrobbler"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "bin"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rockstar"
+  spec.add_dependency "ruby-dbus"
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry"
+end

metadata

@@ -0,0 +1,138 @@
+--- !ruby/object:Gem::Specification
+name: mpris_scrobbler
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Bruno Antunes
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-04-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rockstar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ruby-dbus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !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: ''
+email:
+- sardaukar.siet@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/mpris_scrobbler
+- lib/mpris_scrobbler.rb
+- lib/mpris_scrobbler/spy.rb
+- mpris_scrobbler.gemspec
+homepage: https://github.com/sardaukar/mpris_scrobbler
+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.8
+signing_key: 
+specification_version: 4
+summary: Last.fm scrobbler for Linux music players that follow the MPRIS 2 specification
+test_files: []