smeargle 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 David Ratajczak
+
+MIT License
+
+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,71 @@
+# Smeargle
+
+Smeargle is an image collection tool that will return an object
+containing images from a given URL. Smeargle was designed to be
+a lightweight and simple solution for collecting images.
+
+This library does provide some basic logic for helping you find
+a suitable image from any given url. Smeargle uses rmagick for
+filtering images based on size.
+
+![Smeargle](http://www.toplessrobot.com/smeargle.gif)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'smeargle'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install smeargle
+
+## Usage
+
+### Getting Started
+
+When initializing a smeargle object, you're able to provide a variety of
+options to help with image selection.
+
+```
+  # Initialize a collection with a minimum image width of 200
+  Smeargle::Sketch.new 'http://mockra.com', min_width: 200
+```
+
+The available options are:
+
+```
+  Minimum images dimentions returned
+  :min_width, :min_height
+```
+
+### Images
+
+Images returned by your URL are included in the images array. Depending
+on the number of images included in the body, this could take some time
+to run. You may want to have it run in the background.
+
+```
+  s = Smeargle::Sketch.new 'google.com'
+
+  # returns an array filtered by provided options
+  s.images
+  
+  s.images.each do |img|
+    img[:url]
+    img[:width]
+    img[:height]
+  end
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,5 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)

data/lib/smeargle/image.rb

@@ -0,0 +1,49 @@
+require 'rmagick'
+
+module Smeargle
+  module Image
+
+    def images
+      @images ||= filtered_images
+    end
+
+    def image_collection
+      images = []
+      response_body.css('img').each do |img|
+        images << img['src']
+      end
+      images.uniq
+    end
+
+    def formatted_images
+      formatted_images = []
+      image_collection.each do |img|
+        image = image_format img
+        formatted_images << image_details(image)
+      end
+      formatted_images
+    end
+
+    def image_format img
+      if URI(img).relative?
+        self.safe_url + img
+      else
+        img
+      end
+    end
+
+    def image_details img
+      remote_image = open img
+      image = Magick::Image::from_blob(remote_image.read).first
+      { url: img, height: image.columns, width: image.rows }
+    end
+
+    def filtered_images
+      images = formatted_images
+      images.reject! { |x| x[:width] < min_width } if min_width
+      images.reject! { |x| x[:height] < min_height } if min_height
+      images
+    end
+
+  end
+end

data/lib/smeargle/sketch.rb

@@ -0,0 +1,32 @@
+require 'open-uri'
+require 'nokogiri'
+require "smeargle/image"
+
+module Smeargle
+  class Sketch
+
+    include Smeargle::Image
+
+    attr_accessor :url, :min_width, :min_height
+
+    def initialize url, args = {}
+      @url = url
+      args.each do |key, value|
+        send "#{key}=", value
+      end
+    end
+
+    def safe_url
+      parsed_url = URI.parse url
+      if !parsed_url.scheme
+        @safe_url ||= 'http://' + url
+      end
+      @safe_url ||= url
+    end
+
+    def response_body
+      @response_body ||= Nokogiri::HTML(open safe_url)
+    end
+
+  end
+end

data/lib/smeargle/version.rb

@@ -0,0 +1,3 @@
+module Smeargle
+  VERSION = "0.0.1"
+end

data/lib/smeargle.rb

@@ -0,0 +1,5 @@
+require "smeargle/version"
+require "smeargle/sketch"
+
+module Smeargle
+end

data/smeargle.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/smeargle/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["David Ratajczak"]
+  gem.email         = ["david@mockra.com"]
+  gem.description   = %q{Smeargle is a tool for collecting a set of images from a url.}
+  gem.summary       = %q{The smeargle library is designed to return an object with 
+                         various methods to help you traverse the collection of images 
+                         returned by a url.}
+  gem.homepage      = "http://mockra.com"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "smeargle"
+  gem.require_paths = ["lib"]
+  gem.version       = Smeargle::VERSION
+
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rspec'
+  gem.add_dependency 'nokogiri'
+  gem.add_dependency 'fakeweb'
+  gem.add_dependency 'rmagick'
+end

data/spec/smeargle/image_spec.rb

@@ -0,0 +1,56 @@
+require 'spec_helper'
+
+describe Smeargle::Image do
+
+  let(:smeargle) { Smeargle::Sketch.new 'google.com' }
+
+  before do
+    smeargle.stub!(:image_details).and_return(
+      { url: 'test.png', height: 10, width: 10 })
+
+    FakeWeb.register_uri :get, 'http://google.com',
+      body: "Google <img src='test.png' /> <img src='test.png' />"
+  end
+
+  describe 'images' do
+    it 'should return an array' do
+      smeargle.images.should be_a Array
+    end
+
+    it 'should contain the sample image' do
+      smeargle.images.first[:url].should =~ /test\.png/i
+    end
+
+    it 'should contain hashes' do
+      smeargle.images.first.should be_a Hash
+    end
+  end
+
+  describe 'image_format' do
+    it 'should format relative paths' do
+      e = smeargle.image_format '/test.png'
+      e.should == 'http://google.com/test.png'
+    end
+
+    it 'should not format absolute paths' do
+      e = smeargle.image_format 'http://google.com/test.png'
+      e.should == 'http://google.com/test.png'
+    end
+  end
+
+  describe 'image_collection' do
+    it 'should not contain duplicates' do
+      smeargle.image_collection.count.should == 1
+    end
+  end
+
+  describe 'filtered_images' do
+    it 'should filter images on height' do
+      s = Smeargle::Sketch.new 'google.com', min_width: 20
+      s.stub!(:image_details).and_return(
+        { url: 'test.png', height: 10, width: 10 })
+      s.filtered_images.count.should == 0
+    end
+  end
+
+end

data/spec/smeargle/sketch_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+
+describe Smeargle::Sketch do
+
+  let(:smeargle) { Smeargle::Sketch.new 'google.com' }
+
+  before do
+    FakeWeb.register_uri :get, 'http://google.com',
+      body: "Google <img src='test.png' />"
+  end
+
+  describe 'new' do
+    it 'should initialize url' do
+      s = Smeargle::Sketch.new 'http://google.com'
+      s.url.should == 'http://google.com'
+    end
+
+    it 'should set min width/height' do
+      s = Smeargle::Sketch.new 'http://google.com',
+        min_width: 200, min_height: 250
+      s.min_width.should == 200
+      s.min_height.should == 250
+    end
+  end
+
+  describe 'safe_url' do
+    it 'should format the url' do
+      smeargle.safe_url.should == 'http://google.com'
+    end
+
+    it 'should leave the url alone' do
+      s = Smeargle::Sketch.new 'http://google.com'
+      s.safe_url.should == 'http://google.com'
+      s.safe_url.should == s.url
+    end
+  end
+
+  describe 'response' do
+    it 'should have the correct body' do
+      smeargle.response_body.css('body').text.
+        should =~ /google/i
+    end
+  end
+
+end

data/spec/smeargle_spec.rb

@@ -0,0 +1,4 @@
+require 'spec_helper'
+
+describe Smeargle do
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+require 'smeargle'
+require 'fakeweb'
+require 'nokogiri'

metadata

@@ -0,0 +1,150 @@
+--- !ruby/object:Gem::Specification
+name: smeargle
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- David Ratajczak
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-09-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fakeweb
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rmagick
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Smeargle is a tool for collecting a set of images from a url.
+email:
+- david@mockra.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/smeargle.rb
+- lib/smeargle/image.rb
+- lib/smeargle/sketch.rb
+- lib/smeargle/version.rb
+- smeargle.gemspec
+- spec/smeargle/image_spec.rb
+- spec/smeargle/sketch_spec.rb
+- spec/smeargle_spec.rb
+- spec/spec_helper.rb
+homepage: http://mockra.com
+licenses: []
+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: 1742334504080811707
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 1742334504080811707
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: The smeargle library is designed to return an object with  various methods
+  to help you traverse the collection of images  returned by a url.
+test_files:
+- spec/smeargle/image_spec.rb
+- spec/smeargle/sketch_spec.rb
+- spec/smeargle_spec.rb
+- spec/spec_helper.rb