twitterscrobble 0.0.1

data/History.txt

@@ -0,0 +1,4 @@
+== 0.0.1 2008-08-14
+
+* 1 major enhancement:
+  * Initial release

data/License.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Nicholas E. Rabenau
+
+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/Manifest.txt

@@ -0,0 +1,12 @@
+History.txt
+License.txt
+Manifest.txt
+PostInstall.txt
+README.txt
+Rakefile
+bin/twitterscrobble
+lib/twitterscrobble.rb
+lib/twitterscrobble/preferences.rb
+lib/twitterscrobble/status_line.rb
+lib/twitterscrobble/twitter_scrobbler.rb
+lib/twitterscrobble/version.rb

data/PostInstall.txt

@@ -0,0 +1 @@
+For more information on twitterscrobble, see http://twitterscrobble.rubyforge.org

data/README.txt

@@ -0,0 +1,82 @@
+= twitterscrobble
+
+* http://twitterscrobble.rubyforge.org
+
+== DESCRIPTION:
+
+This application posts recently played tracks from last.fm to Twitter.
+
+== SYNOPSIS:
+
+    twitterscrobble [options]
+
+For help use:
+
+    twitterscrobble -h
+
+The following command reads all most recently played tracks from a last.fm account
+and posts them to Twitter. All settings are read from the preferences file.
+
+    twitterscrobble
+
+The following command prints the status line of recent tracks to stdout (not posting to Twitter), assuming a history value of 0 and not saving state.
+
+    twitterscrobble --no-post --history 0 --no-save
+
+The following posts all recent tracks and store user names and password in the preferences file. This is suitable as the initial invocation, as it creates the preferences file for later invocation without the user detail.
+
+    twitterscrobble --scrobbler-user foo --twitter-user FooBar --twitter-password bar
+
+== REQUIREMENTS:
+
+* twitter
+* scrobbler
+* shorturl
+
+== INSTALL:
+
+* sudo gem install twitterscrobble
+
+This script is probably run best from CRON:
+
+$> crontab -l
+# m h  dom mon dow   command
+* * * * * /home/nerab/projects/atom2nntp/workspace/twitterscrobble/bin/twitterscrobble --loglevel warn --logfile /home/nerab/.twitterscrobble/twitterscrobble.log 
+
+The entry to the user's crontab can be made with
+
+	crontab -e
+
+This will invoke the default editor for making changes to the user's crontab.
+
+The library will announce itself as "twitterscrobble" on Twitter (by sending the appropriate source parameter). The twitter gem 
+still has a bug about this, so the source parameter will not work until  {this bug}[http://jnunemaker.lighthouseapp.com/projects/14843/tickets/11-source-parameter-does-not-get-through#ticket-11-1] has been fixed.
+
+= Author
+
+Nicolas E. Rabenau, nerab@gmx.at
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2008 Nicholas E. Rabenau
+
+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/Rakefile

@@ -0,0 +1,4 @@
+require 'config/requirements'
+require 'config/hoe' # setup Hoe + all gem configuration
+
+Dir['tasks/**/*.rake'].each { |rake| load rake }

data/bin/twitterscrobble

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby
+#
+#  Created by Nicholas E. Rabenau on 2008-8-14.
+#  Copyright (c) 2008. All rights reserved.
+
+begin
+  require 'rubygems'
+rescue LoadError
+  # no rubygems to load, so we fail silently
+end
+
+$:.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+require 'twitterscrobble'
+
+begin
+    prefs = Twitterscrobble::Preferences.new
+    Twitterscrobble::TwitterScrobbler.new(prefs).update
+    prefs.save
+rescue
+    $stderr.puts "\nError: #{$!}"
+end

data/lib/twitterscrobble/preferences.rb

@@ -0,0 +1,208 @@
+require 'yaml'
+require 'optparse'
+require 'logger'
+require 'active_support'
+
+module Twitterscrobble
+  
+  class SimpleLogger < Logger
+    def format_message(severity, timestamp, progname, msg)
+      "#{timestamp.to_s(:db)} #{severity} #{msg}\n" 
+    end 
+  end 
+  
+  class Preferences
+      PREFERENCES_FILE_NAME = "preferences.yaml"
+      APP_NAME = "twitterscrobble"
+      TO_BE_SAVED = [:history, :twitter_user, :scrobbler_user, :twitter_password]
+  
+      attr_reader :logger
+  
+      def initialize
+          parsed_args = parse_args
+  
+          begin
+              if !parsed_args[:stateless]
+                  @cfg = YAML.load(File.open(full_prefs_file_path))
+              else
+                  @cfg = {}
+              end
+          rescue
+              @cfg = {}
+          end
+  
+          @cfg.merge!(parsed_args) # args override cfg
+  
+          if @cfg[:logfile]
+              @logger = SimpleLogger.new(@cfg[:logfile])
+          else
+              @logger = SimpleLogger.new(STDOUT)
+          end
+  
+          if @cfg[:loglevel]
+              @logger.level = @cfg[:loglevel]
+          else
+              @logger.level = Logger::WARN
+          end
+  
+          @logger.debug("Command line preferences: #{parsed_args.reject{|k,v| k == :twitter_password}.inspect}")
+          @logger.debug("Effective preferences after merging in preferences file #{full_prefs_file_path}:")
+          @logger.debug(@cfg.reject{|k,v| k == :twitter_password}.inspect)
+  
+          if 0 < check_required_args.size
+              msg = ""
+              msg << "Required argument#{'s' if 1 < check_required_args.size} #{check_required_args.join(', ')} "
+              msg << "not found in preferences or command line parameters."
+              raise msg
+          end
+      end
+  
+      def save
+          unless @cfg[:no_save]
+              Dir.mkdir(preferences_dir) if !File.exist?(preferences_dir)
+              
+              File.open(full_prefs_file_path, 'w') do |out|
+                  save_cfg = @cfg.reject{|k, v| !TO_BE_SAVED.include?(k)}
+                  @logger.debug("Writing preferences: #{save_cfg.reject{|k,v| k == :twitter_password}.inspect}")  
+                  YAML.dump(save_cfg, out)
+              end
+              
+              File.new(full_prefs_file_path).chmod(0600)
+          end
+      end
+  
+      # delegates reading of attributes to @cfg
+      def method_missing(methodname, *args)
+          @cfg[methodname]
+      end
+  
+      def history=(history_stamp)
+          @cfg[:history] = history_stamp
+      end
+  
+  private
+      def check_required_args
+          missing = []
+          
+          if @cfg[:twitter_user].blank?
+              missing << "twitter-user"
+          end
+  
+          if @cfg[:twitter_password].blank?
+              missing << "twitter-password"
+          end
+  
+          if @cfg[:scrobbler_user].blank?
+              missing << "scrobbler-user"
+          end
+          missing
+      end
+  
+  
+      # some code taken from http://redshift.sourceforge.net/preferences/doc/classes/Preferences.src/M000002.html
+      # which is under the Ruby license (which is MIT compatible, I believe)
+      def preferences_dir
+      	dir = nil
+        app_name = APP_NAME
+        
+        case RUBY_PLATFORM
+        when /win32/
+      		dir =
+      			ENV['APPDATA'] ||	# C:\Documents and Settings\name\Application Data
+      			ENV['USERPROFILE'] || # C:\Documents and Settings\name
+      			ENV['HOME']
+      	else
+      		dir = ENV['HOME'] || File.expand_path('~')
+          app_name = "." << APP_NAME
+      	end
+  
+      	unless dir
+      		raise EnvError, "Can't determine a preferences directory."
+      	end
+  
+      	File.join(dir, app_name)
+      end
+  
+      def parse_args
+          options = {}
+  
+          op = OptionParser.new do |opts|
+  
+              #
+              # general flags
+              #
+  
+              opts.on("-h", "--help", "Prints this help text and exits") do |v|
+                  puts op.to_s
+                  exit
+              end
+  
+              opts.on("-v", "--version", "Prints the version of this script and exits") do |v|
+                  puts "#{Twitterscrobble.name}, v.#{VERSION::STRING}"
+                  exit
+              end
+  
+              opts.on("-q", "--quiet", "Don't write anything to stdout") do |v|
+                  options[:quiet] = true
+              end
+  
+              opts.on("-f <logfile>", "--logfile <logfile>", "Specify the name of the log file") do |v|
+                  options[:logfile] = v
+              end
+  
+              level_map = {:debug => Logger::DEBUG, :info => Logger::INFO, :warn => Logger::WARN, :error => Logger::ERROR, :fatal => Logger::FATAL}
+              opts.on("-l LEVEL", "--loglevel LEVEL", level_map, "Specify the log level (#{level_map.keys.join(', ')})") do |t|
+                  options[:loglevel] = t
+              end
+  
+              #
+              # user data
+              #
+  
+              opts.on("--scrobbler-user MANDATORY", "Username for which recent tracks are pulled off last.fm") do |v|
+                  options[:scrobbler_user] = v
+              end
+  
+              opts.on("--twitter-user MANDATORY", "Twitter user the recent tracks are posted to") do |v|
+                  options[:twitter_user] = v
+              end
+  
+              opts.on("--twitter-password MANDATORY", "Twitter password") do |v|
+                  options[:twitter_password] = v
+              end
+  
+              #
+              # behavioral flags
+              #
+  
+              opts.on("-n", "--no-post", "Do not post status line to Twitter, instead write it to stdout.") do |v|
+                  options[:no_post] = true
+              end
+  
+              opts.on("-HMANDATORY", "--history MANDATORY", "assume the supplied history value") do |v|
+                  options[:history] = v
+              end
+  
+              opts.on("-mMANDATORY", "--max MANDATORY", "post only the <max> most recent songs") do |v|
+                  options[:max] = v.to_i
+              end
+  
+              opts.on("-s", "--stateless", "Do not read and write preferences file, implies --no-save") do |v|
+                  options[:stateless] = true
+                  options[:no_save] = true
+              end
+  
+              opts.on("--no-save", "do not write preferences file") do |v|
+                  options[:no_save] = true
+              end
+          end
+          op.parse!
+  
+          options
+      end
+      
+      def full_prefs_file_path
+        File.join(preferences_dir, PREFERENCES_FILE_NAME)
+      end
+  end  
+end

data/lib/twitterscrobble/status_line.rb

@@ -0,0 +1,75 @@
+require 'shorturl'
+
+module Twitterscrobble
+  class StatusLine
+      TWITTER_MAX_MSG_LEN = 140
+  
+      def initialize(track)
+          @track = track
+      end
+  
+      # TODO
+      # The algorithm to use the maximum number of characters is not the best yet.
+      # We should also try to cut down single fields that are overly long in favor of
+      # not loosing another short field.
+      #
+      # Example:
+      #
+      #   track.name = "A"
+      #   track.artist = "Very long artist name that is close to the maximum length of the whole line"
+      #
+      # The algorithm below would just return "A", but a better version would return "Very long ... - A".
+      #
+      #
+      def to_s
+          status = with_name
+  
+          if with_artist.length <= TWITTER_MAX_MSG_LEN
+              status = with_artist
+          end
+  
+          if with_album.length <= TWITTER_MAX_MSG_LEN
+              status = with_album
+          end
+  
+           if with_url.length <= TWITTER_MAX_MSG_LEN
+               status = with_url
+           end
+  
+  #        if status.length > TWITTER_MAX_MSG_LEN # still too long, enforce length restriction
+  #            status = "#{status[1, 137]}..."
+  #        end
+  
+          status
+      end
+  
+  private
+      def with_name
+          "Now playing: #{CGI::escapeHTML(@track.name)}"
+      end
+  
+      def with_artist
+          if @track.artist.blank?
+              with_name
+          else
+              "Now playing: #{CGI::escapeHTML(@track.artist)} - #{CGI::escapeHTML(@track.name)}"
+          end
+      end
+  
+      def with_album
+          if @track.album.blank?
+              with_artist
+          else
+              "#{with_artist} (from #{CGI::escapeHTML(@track.album)})"
+          end
+      end
+  
+      def with_url
+          if @track.url.blank?
+              with_album
+          else
+              "#{with_album} #{ShortURL.shorten(@track.url)}"
+          end
+      end
+  end
+end

data/lib/twitterscrobble/twitter_scrobbler.rb

@@ -0,0 +1,55 @@
+require 'scrobbler'
+require 'twitter'
+
+module Twitterscrobble
+  #
+  # Read the latest tracks of a user from last.fm and post them to Twitter.
+  #
+  class TwitterScrobbler
+      TWITTER_SOURCE_PARAM = "twitterscrobble"
+
+      def initialize(prefs)
+          @prefs = prefs
+          @logger = @prefs.logger
+      end
+  
+      def update
+          @logger.info("Reading recent tracks for #{@prefs.scrobbler_user}")
+  
+          # Order by date_uts so that we can rely on tracks being steady
+          tracks = Scrobbler::User.new(@prefs.scrobbler_user).recent_tracks.sort{|x,y| x.date_uts <=> y.date_uts }
+  
+          if !@prefs.max.blank? && 0 < @prefs.max
+              @logger.info("Limiting number of posted songs to #{@prefs.max}")
+              tracks = tracks[@prefs.max * -1, @prefs.max]
+          end
+  
+          # Filter already posted tracks
+          tracks.reject!{|track|
+              if track.date_uts.to_i <= @prefs.history.to_i
+                  @logger.info("Skipping #{track.artist} - #{track.name} because #{track.date_uts.to_i} <= #{@prefs.history.to_i}")
+                  true
+              end
+          }
+  
+          @logger.info("No new tracks since #{Time.at(@prefs.history.to_i).to_s}") if 0 == tracks.size
+  
+          tracks.each{|track|
+              status = StatusLine.new(track)
+  
+              begin
+                  if @prefs.no_post
+                      puts status
+                  else
+                      @logger.info("Posting new status: '#{status}'")
+                      Twitter::Base.new(@prefs.twitter_user, @prefs.twitter_password).update(status, {:source => TWITTER_SOURCE_PARAM})
+                  end
+  
+                  @prefs.history = track.date_uts.to_i
+               rescue
+                  @logger.error("Error: #{$!}")
+              end
+          }
+      end
+  end
+end

data/lib/twitterscrobble/version.rb

@@ -0,0 +1,9 @@
+module Twitterscrobble
+  module VERSION #:nodoc:
+    MAJOR = 0
+    MINOR = 0
+    TINY  = 1
+
+    STRING = [MAJOR, MINOR, TINY].join('.')
+  end
+end

data/lib/twitterscrobble.rb

@@ -0,0 +1,4 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+Dir[File.join(File.dirname(__FILE__), 'twitterscrobble/**/*.rb')].each { |lib| require lib }

data/test/test_helper.rb

@@ -0,0 +1,2 @@
+require 'test/unit'
+require File.dirname(__FILE__) + '/../lib/twitterscrobble'

data/test/test_twitterscrobble.rb

@@ -0,0 +1,11 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class TestTwitterscrobble < Test::Unit::TestCase
+
+  def setup
+  end
+  
+  def test_truth
+    assert true
+  end
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification 
+name: twitterscrobble
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Nicholas E. Rabenau
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-08-22 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.7.0
+    version: 
+description: Posts recently played tracks from last.fm to Twitter.
+email: 
+- nerab@gmx.at
+executables: 
+- twitterscrobble
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- License.txt
+- Manifest.txt
+- PostInstall.txt
+- README.txt
+files: 
+- History.txt
+- License.txt
+- Manifest.txt
+- PostInstall.txt
+- README.txt
+- Rakefile
+- bin/twitterscrobble
+- lib/twitterscrobble.rb
+- lib/twitterscrobble/preferences.rb
+- lib/twitterscrobble/status_line.rb
+- lib/twitterscrobble/twitter_scrobbler.rb
+- lib/twitterscrobble/version.rb
+has_rdoc: true
+homepage: http://twitterscrobble.rubyforge.org
+post_install_message: |
+  For more information on twitterscrobble, see http://twitterscrobble.rubyforge.org
+
+rdoc_options: 
+- --main
+- README.txt
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: twitterscrobble
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Posts recently played tracks from last.fm to Twitter.
+test_files: 
+- test/test_helper.rb
+- test/test_twitterscrobble.rb