captured 0.2.3 → 0.2.4

data/README.markdown

@@ -10,10 +10,10 @@ While I would love to tinker with this to make it easy to install (it is really
 
 So, I am making some assumptions about the environment that captured runs in. In particular it expects:
 
- * A decent understanding of scp and ssh
+ * A decent understanding of installing ruby gems
  * That [Growl](http://growl.info/) (and the [growlnotify](http://growl.info/documentation/growlnotify.php) command-line tool) are installed
 
-With that said, once things are installed and configured it really is handy. 
+With that said, once things are installed and configured it really is handy.
 
 Install
 =======
@@ -28,7 +28,19 @@ Then you will need to exit that config file with the appropriate settings for yo
 
 When you install it will copy an example config file to ~/.captured.yml, which has a few examples of possible configuration types.
 
-The simplest of this is to the scp type:
+Install Type: Imageshack
+------------------------
+The easiest way to do this is to use the image shack service. This service is a little slower, but is free and easy.
+
+<pre>
+	upload:
+	  type: scp
+</pre>
+
+Install Type: scp
+-----------------
+
+If you have you own web server scp is a very handy way to host your own captures.
 
  * user - optional if your remote user is the same as your local user
  * password - optional if you have setup key pair authentication
@@ -46,14 +58,11 @@ The simplest of this is to the scp type:
 	  url: "http://example.com/captured/"
 </pre>
 
-
-
 Icons
 =====
 
 Icons from the [Crystal Clear](http://www.everaldo.com/crystal/) icon set by [Everaldo Coelho](http://en.wikipedia.org/wiki/Everaldo_Coelho). – The icons are [licensed](http://www.everaldo.com/crystal/?action=license) under the [GNU Lesser General Public License (LGPL)](http://en.wikipedia.org/wiki/GNU_Lesser_General_Public_License).
 
-
 Copyright
 =========
 

data/etc/captured.yml-example

@@ -1,11 +1,40 @@
 # Example captured configuration file
 #
-# Eval
-# ====
+#  Standard upload type: Image Shack
+#  =================================
 #
-# Complete control for the complete nerd. This allows you to execute arbtrary 
-# ruby code when a matching file is found. Normally this would be used to 
-# invoke a command line upload (such as scp, curl, etc). 
+#  The default option is to post your images to imageshack.us, if you want to
+#  use one of the more advances and felxable types simply comment this out.
+
+upload:
+  type: imageshack
+
+#
+#  Powerful upload type: scp
+#  =========================
+#
+#  Standard scp, using the ruby net/ssh library.
+#
+#  * user - optinal if your remote user is the same as your local user
+#  * password - optional if you have setup key pair authentication
+#  * host - the remote host name
+#  * url - the public url to the remote host+path
+#  * path - the remote path to upload to
+
+#upload:
+#  type: scp
+#  user: user
+#  host: example.com
+#  path: example.com/captured/
+#  url: "http://example.com/captured/"
+
+#
+# Advanced upload type: Eval
+# ==========================
+#
+# Complete control for the complete nerd. This allows you to execute arbtrary
+# ruby code when a matching file is found. Normally this would be used to
+# invoke a command line upload (such as scp, curl, etc).
 #
 # One advantage with calling scp this way is it will be aware of all the custom
 # settings made in ~/.ssh/config.
@@ -30,21 +59,3 @@
 #    remote_path="http://twitter.com/user"
 #    system "curl -F media='@#{file}' -F username=user -F password=secret -F message=Captured http://twitpic.com/api/uploadAndPost"
 #
-#  scp
-#  ===
-#
-#  Standard scp, using the ruby net/ssh library.
-#
-#  * user - optinal if your remote user is the same as your local user
-#  * password - optional if you have setup key pair authentication
-#  * host - the remote host name
-#  * url - the public url to the remote host+path
-#  * path - the remote path to upload to
-
-#upload:
-#  type: scp
-#  user: user
-#  host: example.com
-#  path: example.com/captured/
-#  url: "http://example.com/captured/"
-

data/lib/captured.rb

@@ -21,6 +21,7 @@ class Captured
     end
   end
 
+  # Depricated this is now handeled by launchd
   def self.run_and_watch!(options)
     require 'captured/fs_events'
     watch_path = options[:watch_path] || "#{ENV['HOME']}/Desktop/"

data/lib/captured/file_uploader.rb

@@ -12,42 +12,19 @@ class FileUploader
     @config = YAML.load_file(options[:config_file])
     case @config['upload']['type']
     when"eval"
-      @upload_proc = eval_proc
+      require File.expand_path(File.dirname(__FILE__) + '/uploaders/eval_uploader')
+      @uploader = EvalUploader.new(@config)
     when"scp"
-      @upload_proc = scp_proc
-    when"ftp"
+      require File.expand_path(File.dirname(__FILE__) + '/uploaders/scp_uploader')
+      @uploader = ScpUploader.new(@config)
+    when"imageshack"
+      require File.expand_path(File.dirname(__FILE__) + '/uploaders/imageshack_uploader')
+      @uploader = ImageshackUploader.new(@config)
     else
       raise "Invalid Type"
     end
   end
 
-  def eval_proc
-    lambda do |file, remote_name|
-      remote_path = nil
-      unless eval @config['upload']['command']
-        raise "Upload failed: Bad Eval in config file"
-      end
-      # if the eval defines remote_path we will copy that to the clipboard
-      # otherwise we compute it ouselves
-      remote_path || "#{@config['upload']['url']}#{remote_name}"
-    end
-  end
-
-  def scp_proc
-    require 'net/scp'
-    require 'etc'
-    settings = @config['upload']
-    lambda do |file, remote_name|
-      Net::SCP.upload!(settings['host'],
-                       settings['user'] || Etc.getlogin,
-                       file,
-                       settings['path']+remote_name,
-                       :password => settings['password'])
-
-      "#{@config['upload']['url']}#{remote_name}"
-    end
-  end
-
   def pbcopy(str)
     system "ruby -e \"print '#{str}'\" | pbcopy"
     # I prefer the following method but it was being intermitant about actually
@@ -62,7 +39,8 @@ class FileUploader
   def process_upload(file)
     remote_name = Digest::MD5.hexdigest(file+Time.now.to_i.to_s) +  File.extname(file)
     growl("Processing Upload", "#{File.dirname(File.expand_path(__FILE__))}/../../resources/action_run.png")
-    remote_path = @upload_proc.call(file, remote_name)
+    @uploader.upload(file)
+    remote_path = @uploader.url
     puts "Uploaded '#{file}' to '#{remote_path}'"
     pbcopy remote_path
     growl("Upload Succeeded", "#{File.dirname(File.expand_path(__FILE__))}/../../resources/green_check.png")

data/lib/captured/uploaders/eval_uploader.rb

@@ -0,0 +1,23 @@
+class EvalUploader
+  attr_accessor :url
+
+  def initialize(config = {})
+    @config = config
+  end
+
+  def gen_remote_name(file)
+    Digest::MD5.hexdigest(file+Time.now.to_i.to_s) + File.extname(file)
+  end
+
+  def upload(file)
+    remote_path = nil
+    remote_name = gen_remote_name(file)
+    unless eval @config['upload']['command']
+      raise "Upload failed: Bad Eval in config file"
+    end
+    # if the eval defines remote_path we will copy that to the clipboard
+    # otherwise we compute it ouselves
+    @url = remote_path || "#{@config['upload']['url']}#{remote_name}"
+    @url
+  end
+end

data/lib/captured/uploaders/imageshack_uploader.rb

@@ -0,0 +1,126 @@
+require 'net/http'
+require 'uri'
+require 'cgi'
+require 'mime/types'
+
+# Adapted from http://codesnippets.joyent.com/posts/show/1156
+class ImageshackUploader
+  attr_reader :url
+  USER_AGENT = "Mozilla/5.0 (Macintosh; U; Intel Mac OS X; en) AppleWebKit/419 (KHTML, like Gecko) Safari/419.3"
+  BOUNDARY = '----------PuSHerInDaBUSH_$'
+
+  def initialize(config = {})
+    @config = config
+    @shack_id = config['upload']['shackid'] || "captured"
+  end
+
+  def upload(file_name)
+    unless file_name =~ /jpe?g|png|gif|bmp|tif|tiff|swf$/
+      raise(NonImageTypeError, 'Expected image file.')
+    end
+    @img = file_name
+    @posted_url, @hosturi, @res = "","",""
+    @header, @params = {}, {}
+    @header['Cookie'] = "myimages=#{@shack_id}"
+    @header['User-Agent'] = USER_AGENT
+    @params['uploadtype'] = 'on'  
+    @params['brand'] = ''
+    @params['refer'] = ''
+    @params['MAX_FILE_SIZE'] = '13145728'
+    @params['optimage'] = '0'
+    @params['rembar'] = '1'
+    transfer
+    getdirect
+    @url = @posted_url.gsub("content.php?page=done&l=", "")
+  end
+
+  def prepare_multipart ( params )
+    fp = []
+    params.each do |k,v|
+      if v.respond_to?(:read)
+        fp.push(FileParam.new(k,v.path,v.read))
+      else fp.push(Param.new(k,v)) 
+      end
+    end
+    query = fp.collect {|p| "--" + BOUNDARY + "\r\n" + p.to_multipart }.join("") + "--" + BOUNDARY + "--"
+    return query
+  end
+
+  def prepFile(path_to_file)
+    file = File.new(path_to_file)
+    @header['Content-Type'] = "multipart/form-data, boundary=" + BOUNDARY + " "
+    @params['url'] = 'paste image url here'
+    @params['fileupload'] = file
+    $query = prepare_multipart(@params)
+    file.close
+  end
+
+  def locate(path)
+    path !~ /^http/ ? "local" : "remote"
+  end
+
+  def process_upload( query, headers={} )
+    Net::HTTP.start(@hosturi.host) do | http |
+      http.post(@hosturi.path, query, headers);
+    end
+  end
+
+  def transload(url)
+    @header['Content-Type'] = 'form-data'
+    @params['url'] = url
+    @params['fileupload'] = ''
+    postreq = Net::HTTP::Post.new(@hosturi.path, @header)
+    postreq.set_form_data(@params)
+    return Net::HTTP.new(@hosturi.host, @hosturi.port).start { |http| http.request(postreq) }
+  end
+
+  def transfer
+    case locate(@img)
+    when "local"
+      @hosturi = URI.parse('http://load.imageshack.us/index.php')
+      prepFile(@img)
+      @res = process_upload($query,@header)
+    when "remote"
+      @hosturi = URI.parse('http://imageshack.us/transload.php')
+      @res = transload(@img)
+    end
+  end
+
+  def getdirect
+    puts @res.header
+    puts @res.body
+    @posted_url = @res.header['location']
+  end
+
+end
+
+class Param
+  attr_accessor :k, :v
+
+  def initialize(k,v)
+    @k = k
+    @v = v
+  end
+
+  def to_multipart
+    return "Content-Disposition: form-data; name=\"#{CGI::escape(k)}\"\r\n\r\n#{v}\r\n"
+  end
+end
+
+class FileParam
+  attr_accessor :k, :filename, :content
+
+  def initialize(k, filename, content)
+    @k = k
+    @filename = filename
+    @content = content
+  end
+
+  def to_multipart
+    return "Content-Disposition: form-data; name=\"#{CGI::escape(k)}\"; filename=\"#{filename}\"\r\n" +
+      "Content-Type: #{MIME::Types.type_for(@filename)}\r\n\r\n" + content + "\r\n"
+  end
+end
+
+
+

data/lib/captured/uploaders/scp_uploader.rb

@@ -0,0 +1,30 @@
+class ScpUploader
+  attr_accessor :url
+
+  def initialize(config = {})
+    @config = config
+  end
+
+  def gen_remote_name(file)
+    Digest::MD5.hexdigest(file+Time.now.to_i.to_s) +  File.extname(file)
+  end
+
+  def upload(file)
+    puts "Uploading #{file}"
+    # TODO: This needs to be called from file upload
+    # and this calss needs to be completed
+    # maybe some tests
+    require 'net/scp'
+    require 'etc'
+    settings = @config['upload']
+    remote_name = gen_remote_name(file)
+    puts Net::SCP.upload!(settings['host'],
+                     settings['user'] || Etc.getlogin,
+                     file,
+                     settings['path']+remote_name,
+                     :password => settings['password'])
+
+    @url = "#{@config['upload']['url']}#{remote_name}"
+    @url
+  end
+end

data/spec/bin/mockgrowlnotify

@@ -0,0 +1,74 @@
+#!/usr/bin/env ruby
+require 'optparse'
+
+def red(s); colorize(s, "\e[0m\e[31m"); end
+def green(s); colorize(s, "\e[0m\e[32m"); end
+def dark_green(s); colorize(s, "\e[32m"); end
+def yellow(s); colorize(s, "\e[0m\e[33m"); end
+def blue(s); colorize(s, "\e[0m\e[34m"); end
+def dark_blue(s); colorize(s, "\e[34m"); end
+def pur(s); colorize(s, "\e[0m\e[35m"); end
+def colorize(text, color_code)  "#{color_code}#{text}\e[0m" end
+
+def log(msg)
+  puts yellow "  #{msg}"
+end
+
+options = {}
+OptionParser.new do |opts|
+  #    -h,--help       Display this help
+  #    -v,--version    Display version number
+  #    -n,--name       Set the name of the application that sends the notification
+  #                    [Default: growlnotify]
+  #    -s,--sticky     Make the notification sticky
+  #    -a,--appIcon    Specify an application name to take the icon from
+  #    -i,--icon       Specify a file type or extension to look up for the
+  #                    notification icon
+  #    -I,--iconpath   Specify a file whose icon will be the notification icon
+  #       --image      Specify an image file to be used for the notification icon
+
+  opts.on('--image IMAGE', "Specify an image file to be used for the notification icon") do |img|
+    options[:image] = true
+    if !File.exists? img
+      log "GROWL ERROR: Image file does not exist"
+      exit 1
+    end
+  end
+
+  #    -m,--message    Sets the message to be used instead of using stdin
+  opts.on('-m', '--message MSG', "Specify an image file to be used for the notification icon") do |msg|
+    options[:message] = true
+    if !msg
+      log "GROWL ERROR: No message"
+      exit 1
+    else
+      log "growl: #{msg}"
+    end
+  end
+    #                    Passing - as the argument means read from stdin
+    #    -p,--priority   Specify an int or named key (default is 0)
+    #    -d,--identifier Specify a notification identifier (used for coalescing)
+    #    -H,--host       Specify a hostname to which to send a remote notification.
+    #    -P,--password   Password used for remote notifications.
+    #    -u,--udp        Use UDP instead of DO to send a remote notification.
+    #       --port       Port number for UDP notifications.
+    #    -A,--auth       Specify digest algorithm for UDP authentication.
+    #                    Either MD5 [Default], SHA256 or NONE.
+    #    -c,--crypt      Encrypt UDP notifications.
+    #    -w,--wait       Wait until the notification has been dismissed.
+    #       --progress   Set a progress value for this notification.
+
+    #    -t,--title      Does nothing. Any text following will be treated as the
+    #                    title because that's the default argument behaviour
+    opts.on('-t', "Does nothing") do |msg|
+      options[:title] = true
+      if !msg
+        log "GROWL ERROR: No title"
+        exit 1
+      end
+      log "growl: #{msg}"
+    end
+
+    #puts "  Grrrr! #{ARGV.inspect}"
+end.parse!
+

data/spec/captured_spec.rb

@@ -1,7 +1,30 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
-describe "Captured" do
-  it "fails" do
-    fail "hey buddy, you should probably rename this file and start specing for real"
+describe "File Uploader" do
+  before(:all) do
+    # This is run once and only once, before all of the examples
+
+    #Make a backup of the clipboard
+    $pb_backup = `pbpaste`
+
+    system "mkdir -p #{File.dirname(__FILE__) + '/../tmp/watch_path'}"
+    @options = {:config_file => File.dirname(__FILE__) + '/fixtures/scp_config.yml',
+      :watch_path => File.dirname(__FILE__) + '/../tmp/watch_path',
+      :watch_pattern => Captured.guess_watch_path,
+      :growl_path => "/usr/local/bin/growlnotify" }
+  end
+
+  after(:all) do
+    # This is run once and only once, after all of the examples
+    # Restore the clipboard contents
+    FileUploader.new(@options).pbcopy $pb_backup
+  end
+
+
+  it "should copy text to the system clipboard" do
+    fu = FileUploader.new @options
+    str = "Testing captured is fun for you"
+    fu.pbcopy str
+    `pbpaste`.should == str
   end
 end

data/spec/file_uploader_spec.rb

@@ -0,0 +1,35 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "File Uploader" do
+  before(:all) do
+    # This is run once and only once, before all of the examples
+
+    #Make a backup of the clipboard
+    $pb_backup = `pbpaste`
+
+    system "mkdir -p #{File.dirname(__FILE__) + '/../tmp/watch_path'}"
+    @options = {:config_file => File.dirname(__FILE__) + '/fixtures/scp_config.yml',
+      :watch_path => File.dirname(__FILE__) + '/../tmp/watch_path',
+      :watch_pattern => Captured.guess_watch_path,
+      :growl_path => File.dirname(__FILE__) + '/bin/mockgrowlnotify'}
+  end
+
+  after(:all) do
+    # This is run once and only once, after all of the examples
+    # Restore the clipboard contents
+    FileUploader.new(@options).pbcopy $pb_backup
+  end
+
+
+  it "should copy text to the system clipboard" do
+    fu = FileUploader.new @options
+    str = "Testing captured is fun for you"
+    fu.pbcopy str
+    `pbpaste`.should == str
+  end
+  it "should call growl" do
+    fu = FileUploader.new @options
+    str = "Testing captured is fun for you"
+    fu.growl str
+  end
+end

data/spec/fixtures/scp_config.yml

@@ -0,0 +1,7 @@
+upload:
+  type: scp
+  user: user
+  host: example.com
+  path: example.com/captured/
+  url: "http://example.com/captured/"
+

data/spec/spec_helper.rb

@@ -1,3 +1,4 @@
+require 'rubygems'
 require 'spec'
 
 $LOAD_PATH.unshift(File.dirname(__FILE__))

data/spec/uploader_specs/imageshack_uploader_spec.rb

@@ -0,0 +1,14 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+require File.expand_path(File.dirname(__FILE__) + '/../../lib/captured/uploaders/imageshack_uploader')
+
+describe "SCP File Uploader" do
+  it "should upload to the server" do
+    config = {"upload"=>{"url"=>"http://fuzzymonk.com/captured/",
+      "type"=>"imageshack",
+      "shackid"=>"capturedspec"}}
+
+    @uploader = ImageshackUploader.new(config)
+    @uploader.upload(File.expand_path(File.dirname(__FILE__) + '/../../resources/captured.png'))
+    system "open #{@uploader.url}"
+  end
+end

data/spec/uploader_specs/scp_uploader_spec.rb

@@ -0,0 +1,13 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+require File.expand_path(File.dirname(__FILE__) + '/../../lib/captured/uploaders/scp_uploader')
+
+describe "SCP File Uploader" do
+  it "should upload to the server" do
+    # This spec requires a scp_spec section in the config file with the
+    # scp settings
+    config = YAML.load_file("#{ENV['HOME']}/.captured.yml")['scp_spec']
+    @uploader = ScpUploader.new(config)
+    @uploader.upload(File.expand_path(File.dirname(__FILE__) + '/../../resources/captured.png'))
+    system "open #{@uploader.url}"
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: captured
 version: !ruby/object:Gem::Version 
-  version: 0.2.3
+  version: 0.2.4
 platform: ruby
 authors: 
 - Christopher Sexton
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-10-28 00:00:00 -04:00
+date: 2009-11-02 00:00:00 -05:00
 default_executable: captured
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -22,7 +22,7 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: "0"
     version: 
-description: 
+description: Because <shift>-<command>-4 is the single most useful shorcut in Macdom
 email: csexton@gmail.com
 executables: 
 - captured
@@ -40,6 +40,9 @@ files:
 - lib/captured/file_tracker.rb
 - lib/captured/file_uploader.rb
 - lib/captured/fs_events.rb
+- lib/captured/uploaders/eval_uploader.rb
+- lib/captured/uploaders/imageshack_uploader.rb
+- lib/captured/uploaders/scp_uploader.rb
 - resources/2uparrow.png
 - resources/action_run.png
 - resources/captured.png
@@ -47,8 +50,13 @@ files:
 - resources/red_star.png
 - resources/red_x.png
 - resources/ruby.png
+- spec/bin/mockgrowlnotify
 - spec/captured_spec.rb
+- spec/file_uploader_spec.rb
+- spec/fixtures/scp_config.yml
 - spec/spec_helper.rb
+- spec/uploader_specs/imageshack_uploader_spec.rb
+- spec/uploader_specs/scp_uploader_spec.rb
 - LICENSE
 has_rdoc: true
 homepage: http://github.com/csexton/captured
@@ -80,4 +88,7 @@ specification_version: 3
 summary: Quick screenshot sharing for OS X
 test_files: 
 - spec/captured_spec.rb
+- spec/file_uploader_spec.rb
 - spec/spec_helper.rb
+- spec/uploader_specs/imageshack_uploader_spec.rb
+- spec/uploader_specs/scp_uploader_spec.rb