twitterpunch 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 96c566d4bdc10313e9efc77b92c9cfa407048617
-  data.tar.gz: 59b7a93bd2cdda89c79cc1b99f2811a77b1230e4
+  metadata.gz: c881f24bd1e7cc981175e5f5fb52f80a7725e12f
+  data.tar.gz: 7516403fe3be89a85cf8ac0a11427857a28119a7
 SHA512:
-  metadata.gz: 17cfa29c54696a7dcdecb8ee77c03b3cdbd2c2c0d30479b77abce4722a2f519159939e3d37037da74ea6dda61f235c18fb33e4a0e7261bfbf11278c733e8cf29
-  data.tar.gz: fc1a39f9a4a93b7896510d48242f3ad968a7ccf8721ee3d966195c0286ab470c706b87fa7b84ffc266d01114d71a7ba5e53feef3bc838e07cb67b58f9ef04e71
+  metadata.gz: 2e2a4303a64a59f3cee1c582b74706fdbff6f7095ea60b3b4adcbc2c3c85c404f384f07d1b94e7c9abaed2c6ee340f2dcd1f8292ccbc67602b7f19e58110ebe1
+  data.tar.gz: 6c147d09131b4393231a97d531fe029fa3101299aff4e0dc154c3223c49b9407f684020559bd1102d1f0ebbb48f7faa8a111661da831ad1045d96197b7c1b420

data/README.md

@@ -17,20 +17,20 @@ Configure the program via the `~/.twitterpunch.yaml` YAML file. This file should
 look similar to the example below.
 
     ---
-    :twitter:
+    :twitter:                               # twitter configuration
       :consumer_key: <consumer key>
       :consumer_secret: <consumer secret>
       :access_token: <access token>
       :access_token_secret: <access secret>
-    :messages:
-    - Hello there
+    :messages:                              # list of messages to attach
+    - Hello there                           # to outgoing tweets
     - I'm a posting fool
     - minimally viable product
-    :hashtag: BestHalloweenPartyEver
-    :handle: FassFord
-    :photodir: ~/Pictures/twitterpunch/
-    :logfile: /Users/ben/.twitterpunch.log
-    :sendsound: /System/Library/PrivateFrameworks/ToneLibrary.framework/Versions/A/Resources/AlertTones/tweet_sent.caf
+    :hashtag: Twitterpunch                  # The hashtag to post and listen to
+    :photodir: ~/Pictures/twitterpunch/     # Where to save downloaded images
+    :logfile: ~/.twitterpunch.log           # Where to save logs
+    :viewer:                                # Use the built-in slideshow viewer
+      :count: 5                             # How many images to have onscreen at once
 
 A skeleton configuration file, with access tokens from Twitter, can be generated
 by running the program with the `--genconfig` flag.
@@ -71,14 +71,18 @@ multiple files at once.
 
 ### Viewing the Twitter stream
 
-Currently Twitterpunch doesn't display photos directly. It simply downloads them
-and stuffs them into the configured `:photodir`. Twitterpunch will run on OS X or
-Windows equally well. Simply configure it on the computer that will act as the 
-Twitter display and then run in streaming mode. Tweets that come from any other
-user will be spoken aloud.
+Twitterpunch will run on OS X or Windows equally well. Simply configure it on the
+computer that will act as the Twitter display and then run in streaming mode.
+All images tweeted to the configured hashtag will be displayed in the slideshow
+and tweets that come from any other user will also be spoken aloud.
 
     [ben@ganymede] ~ $ twitterpunch --stream
 
+If you don't want to use the built-in slideshow viewer, you can disable it by
+removing the `:viewer` key from your `~/.twitterpunch.yaml` config file. Twitterpunch
+will then simply download the tweeted images and save them into the `:photodir`
+directory. You can then use anything you like to view them.
+
 There are currently two decent viewing options I am aware of.
 
 * Windows background image:
@@ -98,7 +102,7 @@ Limitations
 ===========
 
 * It currently requires manual setup for Folder Actions.
-* It currently requires an external viewer, such as a screensaver.
+* Rubygame is kind of a pain to set up.
 
 
 Contact

data/bin/twitterpunch

@@ -66,11 +66,14 @@ when :stream
   require 'twitterpunch/streamer'
   require 'twitterpunch/viewer'
 
-  statefile      = File.expand_path('~/.twitterpunch.state')
-  config[:state] = YAML.load_file(statefile) rescue {}
+  statefile = File.expand_path('~/.twitterpunch.state')
+  viewer    = Twitterpunch::Viewer.new(config)
+
+  config[:state]   = YAML.load_file(statefile) rescue {}
+  config[:display] = viewer
 
   Twitterpunch::Streamer.new(config).thread
-  Twitterpunch::Viewer.new(config)
+  viewer.run
 
   File.open(statefile, 'w') {|f| f.write(config[:state].to_yaml) }
 
@@ -85,7 +88,8 @@ when :view
   statefile      = File.expand_path('~/.twitterpunch.state')
   config[:state] = YAML.load_file(statefile) rescue {}
 
-  client = Twitterpunch::Viewer.new(config)
+  viewer = Twitterpunch::Viewer.new(config)
+  viewer.run
 
 when :configure
   require 'twitterpunch/configuration'

data/lib/twitterpunch.rb

@@ -1,3 +1,3 @@
 module Twitterpunch
-  VERSION = '0.0.3'
+  VERSION = '0.0.4'
 end

data/lib/twitterpunch/configuration.rb

@@ -59,10 +59,9 @@ module Twitterpunch
         :viewer    => {
           :count => 5,
         },
-        :hashtag   => "BestHalloweenPartyEver",
-        :handle    => "fassford",
+        :hashtag   => "Twitterpunch",
         :photodir  => "~/Pictures/twitterpunch/",
-        :logfile   => '/var/log/twitterpunch',
+        :logfile   => '~/.twitterpunch.log',
       }
     end
   end

data/lib/twitterpunch/logger.rb

@@ -7,7 +7,7 @@ module Twitterpunch
   class Logger
     def initialize(config)
       @options = config
-      @logger  = ::Logger.new(config[:logfile])
+      @logger  = ::Logger.new(File.expand_path(config[:logfile]))
 
       @logger.level = config[:debug] ? ::Logger::DEBUG : ::Logger::INFO
     end

data/lib/twitterpunch/sprite.rb

@@ -6,34 +6,55 @@ module Twitterpunch
     include Rubygame
     include Sprites::Sprite
 
-    def initialize(dimensions, image, text)
+    def initialize(dimensions, image, text, pop=false)
       # Invoking the base class constructor is important and yet easy to forget:
       super()
 
       @dimensions = dimensions
+      @popped     = pop
+      @text       = text
+      @original   = Surface.load(image)
 
-      @rate = rand(35..150)
-      @zoom = rand(50..100) / 100.0
-
-      # @image and @rect are expected by the Rubygame sprite code
-      @image = Surface.load(image).zoom(@zoom)
+      if pop
+        @image = @original
+        @start = Time.now
+        @stale = 10
+      else
+        @rate  = rand(35..150)
+        @zoom  = rand(50..100) / 100.0
+        @image = @original.zoom(@zoom)
+      end
 
       max_width = dimensions[0] * 0.75
       if @image.width > max_width
-        @image = @image.zoom(max_width/@image.width)
+        factor = max_width/@image.width
+        @original = @original.zoom(factor)
+        @image    = @image.zoom(factor)
+      end
+
+      if pop
+        @left = (dimensions[0] - @image.width)  / 2
+        @top  = (dimensions[1] - @image.height) / 2
+      else
+        @left = (dimensions[0] - @image.width ) * rand
+        @top  = 0 - @image.height
       end
 
-      @top  = 0 - @image.height
-      @left = (dimensions[0] - @image.width ) * rand
       @rect = @image.make_rect
 
-      if text
-        @text = $font.render_utf8(text, true, Color[:black], Color[:gray])
-        @text.alpha = 150
+      render_text
+    end
+
+    def render_text
+      if @text
+        text = $font.render_utf8(@text, true, Color[:black], Color[:gray])
+
+        # for some reason, windows doesn't deal with this properly
+        text.alpha = 150 unless RUBY_PLATFORM =~ /mingw|cygwin/
 
         # Determine the dimensions in pixels of the area used to render the text.  The
         # "topleft" of the returned rectangle is at [ 0, 0]
-        rt = @text.make_rect
+        rt = text.make_rect
 
         # Re-use the "topleft" of the rectangle to indicate where the text should
         # appear on screen ( lower left corner )
@@ -41,16 +62,34 @@ module Twitterpunch
         rt.topleft = [ 0, @image.height - rt.height]
 
         # Copy the pixels of the rendered text to the image
-        @text.blit(@image, rt)
+        text.blit(@image, rt)
       end
     end
 
-    # Animate this object.  "seconds_passed" contains the number of ( real-world)
+    # Animate this object.  "seconds_passed" contains the number of real-world
     # seconds that have passed since the last time this object was updated and is
-    # therefore useful for working out how far the object should move ( which
+    # therefore useful for working out how far the object should move (which
     # should be independent of the frame rate)
     def update(seconds_passed)
-      @top += seconds_passed * @rate
+      if @popped
+        elapsed = (Time.now - @start).to_f
+
+        if elapsed < 1
+          scale = 1 + damped_sin(elapsed, 4, 0.05)
+
+          @image = @original.zoom(scale)
+          @top  *= scale
+          @left *= scale
+
+          # We changed image size, so rebuild the rect and draw new text
+          @rect = @image.make_rect
+          render_text
+        elsif elapsed > @stale
+          @image.alpha -= 5
+        end
+      else
+        @top += seconds_passed * @rate
+      end
       @rect.topleft = [ @left, @top ]
     end
 
@@ -59,7 +98,19 @@ module Twitterpunch
     end
 
     def visible
-      @top < @dimensions[1]
+      if @popped
+        @image.alpha > 0
+      else
+        @top < @dimensions[1]
+      end
+    end
+
+    def damped_sin(input, cycles = 4, scale = 1)
+      Math.sin(input * cycles * Math::PI) * (1 - input) * scale
+    end
+
+    def popped?
+      return @popped
     end
   end
 end

data/lib/twitterpunch/streamer.rb

@@ -12,6 +12,8 @@ module Twitterpunch
       @client = Twitter::Streaming::Client.new(config[:twitter])
       @logger = Twitterpunch::Logger.new(config)
       @output = File.expand_path(config[:photodir])
+      @handle = Twitter::REST::Client.new(config[:twitter]).current_user.screen_name
+      @viewer = config[:display]
 
       FileUtils.mkdir_p(@output) unless File.directory?(@output)
     end
@@ -31,18 +33,6 @@ module Twitterpunch
 
             content = tweet.text.gsub(/ http\S*/,'').gsub(/#\S*/,'')
 
-
-            unless tweet.user.screen_name == @config[:handle]
-              message = "#{tweet.user.name} says #{content}"
-
-              case RUBY_PLATFORM
-              when /mingw|cygwin/
-                system('cscript', "#{@config[:resources]}/say.vbs", message)
-              when /darwin/
-                system('say', message)
-              end
-            end
-
             if tweet.media?
               uri      = tweet.media.first.media_uri
 
@@ -56,16 +46,33 @@ module Twitterpunch
                 file.write(response.body)
               end
 
-              unless tweet.user.screen_name == @config[:handle]
+              unless tweet.user.screen_name == @handle
                 @config[:state][image] = content
               end
 
-              # OS X screensaver doesn't reload images dynamically. This kinda sucks.
-              if RUBY_PLATFORM =~ /darwin/ and not @config.has_key? :viewer
-                system('osascript', '-e', 'tell application "System Events" to stop current screen saver')
-                system('osascript', '-e', 'tell application "System Events" to start current screen saver')
+              if @viewer
+                @viewer.pop(image, content)
+              else
+                # OS X screensaver doesn't reload images dynamically. This kinda sucks.
+                if RUBY_PLATFORM =~ /darwin/ and system('pgrep ScreenSaverEngine >/dev/null')
+                  system('osascript', '-e', 'tell application "System Events" to stop current screen saver')
+                  system('osascript', '-e', 'tell application "System Events" to start current screen saver')
+                end
               end
+
             end
+
+            unless tweet.user.screen_name == @handle
+              message = "#{tweet.user.name} says #{content}"
+
+              case RUBY_PLATFORM
+              when /mingw|cygwin/
+                system('cscript', "#{@config[:resources]}/say.vbs", message)
+              when /darwin/
+                system('say', message)
+              end
+            end
+
           end
         end
       rescue Interrupt => e

data/lib/twitterpunch/viewer.rb

@@ -9,18 +9,19 @@ module Twitterpunch
 
     def initialize(config)
       @config = config
-      @state  = YAML.load_file(File.expand_path('~/.twitterpunch.state')) rescue {}
       srand
+    end
 
+    def run
       if @config.has_key? :viewer
-        run
+        display
       else
         puts 'Press enter to exit'
         STDIN.gets
       end
     end
 
-    def run
+    def display
       onscreen = @config[:viewer][:count] || 5
 
       # Set up the TrueType Font module
@@ -30,9 +31,9 @@ module Twitterpunch
 
       #@screen = Screen.open [ 640, 480]
       default_depth = 0
-      maximum_resolution = Screen.get_resolution
+      @maximum_resolution = Screen.get_resolution
 
-      screen = Screen.open(maximum_resolution, default_depth, [ HWSURFACE, DOUBLEBUF, FULLSCREEN])
+      screen = Screen.open(@maximum_resolution, default_depth, [ HWSURFACE, DOUBLEBUF, FULLSCREEN])
 
       screen.show_cursor = false
 
@@ -45,15 +46,15 @@ module Twitterpunch
 
       # Create a new group of sprites so that all sprites in the group may be updated
       # or drawn with a single method invocation.
-      sprites = Sprites::Group.new
-      Sprites::UpdateGroup.extend_object(sprites)
+      @sprites = Sprites::Group.new
+      Sprites::UpdateGroup.extend_object(@sprites)
       onscreen.times do
-        sprites << Twitterpunch::Sprite.new(maximum_resolution, *next_image)
+        @sprites << Twitterpunch::Sprite.new(@maximum_resolution, *next_image)
       end
 
       #@background = Surface.load("background.png").zoom_to(maximum_resolution[0], maximum_resolution[1])
       # Create a background image and copy it to the screen. With no image, it's just black.
-      background = Surface.new(maximum_resolution)
+      background = Surface.new(@maximum_resolution)
       background.blit(screen, [ 0, 0])
 
       event_queue = EventQueue.new
@@ -71,26 +72,37 @@ module Twitterpunch
         end
 
         # remove all sprites who've gone out of sight
-        sprites.reject { |sprite| sprite.visible }.each do |sprite|
+        @sprites.reject { |sprite| sprite.visible }.each do |sprite|
+          sprite.undraw(screen, background)
           sprite.kill
-          sprites << Twitterpunch::Sprite.new(maximum_resolution, *next_image)
+          next if sprite.popped?
+
+          @sprites << Twitterpunch::Sprite.new(@maximum_resolution, *next_image)
         end
 
         # "undraw" all of the sprites by drawing the background image at their
         # current location ( before their location has been changed by the animation)
-        sprites.undraw(screen, background)
+        @sprites.undraw(screen, background)
 
         # Give all of the sprites an opportunity to move themselves to a new location
-        sprites.update(seconds_passed)
+        @sprites.update(seconds_passed)
 
         # Draw all of the sprites
-        sprites.draw(screen)
+        @sprites.draw(screen)
+
+        # Then redraw the popped sprite to ensure it's on top
+        @sprites.select { |sprite| sprite.popped? }.each { |popped| popped.draw(screen) }
 
         screen.flip
       end
 
     end
 
+    def pop(image, text)
+      path = File.expand_path("#{@config[:photodir]}/#{image}")
+      @sprites << Twitterpunch::Sprite.new(@maximum_resolution, path, text, true)
+    end
+
     def next_image
       image = Dir.glob(File.expand_path("#{@config[:photodir]}/*")).sample
       text  = @config[:state][File.basename(image)]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: twitterpunch
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Ben Ford
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-30 00:00:00.000000000 Z
+date: 2014-11-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: twitter
@@ -74,15 +74,19 @@ description: "Twitterpunch\n===============\n\nTwitterpunch is designed to work
   them to a specified directory. If\nthe tweet came from another user, Twitterpunch
   will speak it aloud.\n\nConfiguration\n===========\n\nConfigure the program via
   the `~/.twitterpunch.yaml` YAML file. This file should\nlook similar to the example
-  below.\n\n    ---\n    :twitter:\n      :consumer_key: <consumer key>\n      :consumer_secret:
-  <consumer secret>\n      :access_token: <access token>\n      :access_token_secret:
-  <access secret>\n    :messages:\n    - Hello there\n    - I'm a posting fool\n    -
-  minimally viable product\n    :hashtag: BestHalloweenPartyEver\n    :handle: FassFord\n
-  \   :photodir: ~/Pictures/twitterpunch/\n    :logfile: /Users/ben/.twitterpunch.log\n
-  \   :sendsound: /System/Library/PrivateFrameworks/ToneLibrary.framework/Versions/A/Resources/AlertTones/tweet_sent.caf\n\nA
-  skeleton configuration file, with access tokens from Twitter, can be generated\nby
-  running the program with the `--genconfig` flag.\n\nUsage \n==========\n\n### Using
-  OS X PhotoBooth\n\n1. Start PhotoBooth at least once to generate its library.\n1.
+  below.\n\n    ---\n    :twitter:                               # twitter configuration\n
+  \     :consumer_key: <consumer key>\n      :consumer_secret: <consumer secret>\n
+  \     :access_token: <access token>\n      :access_token_secret: <access secret>\n
+  \   :messages:                              # list of messages to attach\n    -
+  Hello there                           # to outgoing tweets\n    - I'm a posting
+  fool\n    - minimally viable product\n    :hashtag: Twitterpunch                  #
+  The hashtag to post and listen to\n    :photodir: ~/Pictures/twitterpunch/     #
+  Where to save downloaded images\n    :logfile: ~/.twitterpunch.log           # Where
+  to save logs\n    :viewer:                                # Use the built-in slideshow
+  viewer\n      :count: 5                             # How many images to have onscreen
+  at once\n\nA skeleton configuration file, with access tokens from Twitter, can be
+  generated\nby running the program with the `--genconfig` flag.\n\nUsage \n==========\n\n###
+  Using OS X PhotoBooth\n\n1. Start PhotoBooth at least once to generate its library.\n1.
   Install the Twitterpunch Folder Action\n    * `twitterpunch --install`\n    * It
   may claim that it could not be attached, fear not.\n1. Profit!\n    * _and by that,
   I mean take some shots with PhotoBooth!_\n\n#### Troubleshooting.\n\n1. Make sure
@@ -97,24 +101,27 @@ description: "Twitterpunch\n===============\n\nTwitterpunch is designed to work
   the program you are using for your photo shoot to call Twitterpunch\neach time it
   snaps a photo. Pass the name of the new photo as a command line\nargument.  Alternatively,
   you could batch them, as Twitterpunch can accept\nmultiple files at once.\n\n    [ben@ganymede]
-  ~ $ twitterpunch photo.jpg\n\n### Viewing the Twitter stream\n\nCurrently Twitterpunch
-  doesn't display photos directly. It simply downloads them\nand stuffs them into
-  the configured `:photodir`. Twitterpunch will run on OS X or\nWindows equally well.
-  Simply configure it on the computer that will act as the \nTwitter display and then
-  run in streaming mode. Tweets that come from any other\nuser will be spoken aloud.\n\n
-  \   [ben@ganymede] ~ $ twitterpunch --stream\n\nThere are currently two decent viewing
-  options I am aware of.\n\n* Windows background image:\n    * Configure the Windows
-  background to randomly cycle through photos in a directory.\n    * Hide desktop
-  icons.\n    * Hide the taskbar.\n    * Disable screensaver and power savings.\n
-  \   * Drawbacks: You're using Windows and you have to install Ruby & RubyGems manually.\n*
-  OS X screensaver:\n    * Choose one of the sexy screensavers and configure it to
-  show photos from the `:photodir`\n    * Set screensaver to a super short timeout.\n
-  \   * Disable power savings.\n    * Drawbacks: The screensaver doesn't reload dynamically,
-  so I have to kick it\n      and you'll see it reloading each time a new tweet comes
-  in.\n\nLimitations\n===========\n\n* It currently requires manual setup for Folder
-  Actions.\n* It currently requires an external viewer, such as a screensaver.\n\n\nContact\n=======\n\n*
-  Author: Ben Ford\n* Email: binford2k@gmail.com\n* Twitter: @binford2k\n* IRC (Freenode):
-  binford2k\n"
+  ~ $ twitterpunch photo.jpg\n\n### Viewing the Twitter stream\n\nTwitterpunch will
+  run on OS X or Windows equally well. Simply configure it on the\ncomputer that will
+  act as the Twitter display and then run in streaming mode.\nAll images tweeted to
+  the configured hashtag will be displayed in the slideshow\nand tweets that come
+  from any other user will also be spoken aloud.\n\n    [ben@ganymede] ~ $ twitterpunch
+  --stream\n\nIf you don't want to use the built-in slideshow viewer, you can disable
+  it by\nremoving the `:viewer` key from your `~/.twitterpunch.yaml` config file.
+  Twitterpunch\nwill then simply download the tweeted images and save them into the
+  `:photodir`\ndirectory. You can then use anything you like to view them.\n\nThere
+  are currently two decent viewing options I am aware of.\n\n* Windows background
+  image:\n    * Configure the Windows background to randomly cycle through photos
+  in a directory.\n    * Hide desktop icons.\n    * Hide the taskbar.\n    * Disable
+  screensaver and power savings.\n    * Drawbacks: You're using Windows and you have
+  to install Ruby & RubyGems manually.\n* OS X screensaver:\n    * Choose one of the
+  sexy screensavers and configure it to show photos from the `:photodir`\n    * Set
+  screensaver to a super short timeout.\n    * Disable power savings.\n    * Drawbacks:
+  The screensaver doesn't reload dynamically, so I have to kick it\n      and you'll
+  see it reloading each time a new tweet comes in.\n\nLimitations\n===========\n\n*
+  It currently requires manual setup for Folder Actions.\n* Rubygame is kind of a
+  pain to set up.\n\n\nContact\n=======\n\n* Author: Ben Ford\n* Email: binford2k@gmail.com\n*
+  Twitter: @binford2k\n* IRC (Freenode): binford2k\n"
 email: binford2k@gmail.com
 executables:
 - twitterpunch