pictate 0.1.1

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,16 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "shoulda", ">= 0"
+  gem "rdoc", "~> 3.12"
+  gem "bundler", "~> 1.1.0"
+  gem "jeweler", "~> 1.8.3"
+  gem "simplecov", ">= 0"
+  gem "selenium-webdriver", "~> 2.20"
+  gem "choice", "~> 0.1.6"
+end

data/Gemfile.lock

@@ -0,0 +1,45 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    childprocess (0.3.1)
+      ffi (~> 1.0.6)
+    choice (0.1.6)
+    ffi (1.0.11)
+    git (1.2.5)
+    jeweler (1.8.3)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    json (1.6.6)
+    multi_json (1.2.0)
+    rake (0.9.2.2)
+    rdoc (3.12)
+      json (~> 1.4)
+    rubyzip (0.9.6.1)
+    selenium-webdriver (2.20.0)
+      childprocess (>= 0.2.5)
+      ffi (~> 1.0)
+      multi_json (~> 1.0)
+      rubyzip
+    shoulda (3.0.1)
+      shoulda-context (~> 1.0.0)
+      shoulda-matchers (~> 1.0.0)
+    shoulda-context (1.0.0)
+    shoulda-matchers (1.0.0)
+    simplecov (0.6.1)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.5.3)
+    simplecov-html (0.5.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.1.0)
+  choice (~> 0.1.6)
+  jeweler (~> 1.8.3)
+  rdoc (~> 3.12)
+  selenium-webdriver (~> 2.20)
+  shoulda
+  simplecov

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Adnan Abdulhussein
+
+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.rdoc

@@ -0,0 +1,18 @@
+= pictate
+
+Pictate is a pointless command line tool that attempts to describe a picture
+you give it. Or rather, Google search by image does. I created it because this
+was funkier as a first gem than the boring traditional "Hello World!".
+
+Usage:
+  $ pictate /path/to/image [options]
+
+== Selenium
+
+Unfortunately Google uses a lot of Javascript and as such this gem uses browser
+automation in the form of Selenium[http://seleniumhq.org/projects/webdriver/]
+to fetch the result. You may specify a path to the server, or it'll be
+downloaded and stored in the _ext_ directory of the gem.
+
+To specify the server:
+  $ pictate /path/to/image -s /path/to/server/jar

data/Rakefile

@@ -0,0 +1,46 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "pictate"
+  gem.homepage = "http://github.com/Prydonius/pictate"
+  gem.license = "MIT"
+  gem.summary = %Q{Attempts to describe a picture you give it.}
+  gem.description = %Q{Pointless command line tool that attempts to describe the image you give it by automating a google search by image.}
+  gem.email = "adnan@prydoni.us"
+  gem.authors = ["Adnan Abdulhussein"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "pictate #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+  rdoc.main = "README.rdoc"
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.1

data/bin/pictate

@@ -0,0 +1,51 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'choice'
+require 'pictate'
+
+include Pictate
+
+#
+# Command line parsing
+#
+Choice.options do
+  banner "Usage: <image> [options]"
+  option :server do
+    long "--server=SERVER"
+    short "-s"
+    desc "Location of selenium standalone server jar"
+    desc "If this isn't specified, the latest server will be downloaded " + 
+          "and used."
+  end
+end
+
+#
+# Print error and help message, then exit
+#
+def show_error str="There was an error with the parsing..."
+  puts str
+  Choice.help
+  exit
+end
+
+#
+# Check image extension
+#
+ext = File.extname Choice.rest.first || ""
+if not %w[.jpg .png .gif .bmp].include? ext
+  show_error "Please pass in the path of an image with one of the " +
+    "following extensions:\n.jpg, .png, .gif, or .bmp\n\n"
+end
+
+#
+# Check if standalone server extension is .jar
+#
+if Choice.choices[:server]
+  if not (File.extname Choice.choices[:server]) == ".jar"
+    show_error "Please specify the path of the jar standalone selenium " + 
+      "server.\n\n"
+  end
+end
+
+Pictate.pictate Choice.rest.first, Choice.choices

data/lib/pictate.rb

@@ -0,0 +1,83 @@
+require "selenium-webdriver"
+require "selenium/server"
+require "fileutils"
+
+PICTATE_ROOT = Gem.loaded_specs['pictate'].full_gem_path
+
+module Pictate
+  #
+  # Starts the server, gets the best result for the image and stops server.
+  #
+  def pictate(image_path, options = {})
+    start_server options[:server]
+    puts "I'm thinking..."
+    puts do_search image_path
+    stop_server
+  end
+
+  #
+  # Starts the server.
+  # Checks to see if you've given it a server path, if not it will check the
+  # _ext_ directory of the gem library. If it's not there, it will download it
+  # to that directory.
+  # Note:: perhaps a better directory is needed as it is overwritten when the
+  #        gem is reinstalled.
+  #
+  def start_server(server_path)
+    if server_path
+      selenium_path = server_path
+    else
+      previous_wd = FileUtils.pwd
+      FileUtils.cd(File.join PICTATE_ROOT, 'ext')
+      selenium_latest = Selenium::Server.latest
+      if not File.exists? "selenium-server-standalone-#{selenium_latest}.jar"
+        puts "Downloading latest version of selenium server standalone..."
+      end
+      selenium_path = Selenium::Server.download(selenium_latest)
+    end
+
+    puts "Starting selenium standalone server"
+    @server = Selenium::Server.new(selenium_path, :background => true)
+    @server.start
+    caps = Selenium::WebDriver::Remote::Capabilities.htmlunit(
+      :javascript_enabled => true)
+    @driver = Selenium::WebDriver.for(:remote, :desired_capabilities => caps)
+    FileUtils.cd(previous_wd)
+  end
+
+  #
+  # Stops the server
+  #
+  def stop_server
+    puts "Stopping server..."
+    @driver.quit
+    @server.stop
+    puts "Goodbye!"
+  end
+
+  #
+  # Carries out the search and retrieves the best match
+  #
+  def do_search(image_path)
+    @driver.navigate.to "http://www.google.co.uk/searchbyimage"
+    # show the upload dialog
+    @driver.execute_script("google.qb.ti(true)")
+
+    # upload image and search
+    upload = @driver.find_element(:name, 'encoded_image')
+    upload.send_keys(File.expand_path image_path)
+
+    # best result
+    wait = Selenium::WebDriver::Wait.new(:timeout => 100)
+    wait.until { @driver.find_element(:id => 'topstuff') }
+    topstuff = @driver.find_element(:id => 'topstuff')
+    best = topstuff.text.lines.to_a.last
+    if not best.match /Best(.*)/
+      result = "Can't figure it out for the life of me, sorry!"
+    else
+      best.gsub!("Best guess for this image:", "")
+      result = "I believe this is a picture of: #{best}."
+    end
+    result
+  end
+end

data/test/helper.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'pictate'
+
+class Test::Unit::TestCase
+end

data/test/test_pictate.rb

@@ -0,0 +1,5 @@
+require 'helper'
+
+class TestPictate < Test::Unit::TestCase
+  
+end

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification
+name: pictate
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+  prerelease: 
+platform: ruby
+authors:
+- Adnan Abdulhussein
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-04-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: &70316967178900 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70316967178900
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: &70316967193940 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: *70316967193940
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &70316967193140 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :development
+  prerelease: false
+  version_requirements: *70316967193140
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &70316967192420 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.3
+  type: :development
+  prerelease: false
+  version_requirements: *70316967192420
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: &70316967191780 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70316967191780
+- !ruby/object:Gem::Dependency
+  name: selenium-webdriver
+  requirement: &70316967190580 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.20'
+  type: :development
+  prerelease: false
+  version_requirements: *70316967190580
+- !ruby/object:Gem::Dependency
+  name: choice
+  requirement: &70316967189100 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.6
+  type: :development
+  prerelease: false
+  version_requirements: *70316967189100
+description: Pointless command line tool that attempts to describe the image you give
+  it by automating a google search by image.
+email: adnan@prydoni.us
+executables:
+- pictate
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.rdoc
+files:
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- bin/pictate
+- ext/.gitignore
+- lib/pictate.rb
+- test/helper.rb
+- test/test_pictate.rb
+homepage: http://github.com/Prydonius/pictate
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -908780192612818260
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: Attempts to describe a picture you give it.
+test_files: []