best_image 0.0.1

data/.gitignore

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

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Scott Johnson
+
+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,37 @@
+# BestImage
+
+This gem accepts a url and returns the *best image* found on that page.  Best is determined by largest at this time, but in the future I would like to look for FaceBook meta tags that allow the publisher to set the best image.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'best_image'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install best_image
+
+## Usage
+    require 'best_image'
+
+    image_selector = BestImage::ImageSelector.new("http://www.path/to/page")
+
+    if image_selector.best_image   
+      @best_image = image_selector.best_image   
+    else   
+      # do defalut action in case network is down etc.   
+      image_selector.errors   
+    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,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/best_image.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/best_image/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Scott Johnson"]
+  gem.email         = ["7.scott.j@gmail.com"]
+  gem.description   = %q{Returns the *Best Image* found from a passed url}
+  gem.summary       = %q{This gem scrapes a passed web page and returns the url of the *best image* found on that page.}
+  gem.homepage      = "https://github.com/itchy/best_image"
+
+  gem.add_development_dependency "rspec"
+  gem.add_dependency('image_size', '>= 1.1.1')
+  gem.add_dependency('nokogiri', '>= 1.5.2')
+  # gem.add_dependency('net/http')
+
+  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          = "best_image"
+  gem.require_paths = ["lib"]
+  gem.version       = BestImage::VERSION
+end

data/lib/best_image.rb

@@ -0,0 +1,9 @@
+require "net/http"
+require "open-uri"
+require "nokogiri"
+require "image_size"
+
+require "best_image/version"
+require "best_image/image_finder"
+require "best_image/image_reference"
+require "best_image/image_selector"

data/lib/best_image/image_finder.rb

@@ -0,0 +1,70 @@
+module BestImage
+  class ImageFinder
+    attr_accessor :images, :errors, :messages
+    
+    def initialize
+      @errors = [];  @messages = []; @images = []
+    end
+    
+    def parse(path)
+      set_uri(path)
+      set_response
+      set_doc
+      set_images
+      rescue IOError => e
+        self
+    end
+    
+    def best_image
+      @best_image ||= calculate_best_image
+    end
+    
+    private
+    
+      def calculate_best_image
+        return nil unless @errors.empty?
+        return nil if @images.empty?
+        best_image = self.images.sort.last
+        return nil unless best_image.size > 0
+        best_image.url
+      end
+      
+      def set_uri(path)
+        @uri = URI.parse(path)
+      end
+      
+      def set_response
+        @response = Net::HTTP.get_response(@uri)
+        rescue Timeout::Error => e
+          self.errors << e
+          self.messages << "A Timeout error occured while trying to access #{@uri}"
+          raise IOError
+        rescue SocketError => e
+          self.errors << e
+          self.messages << "An error occured trying to access #{@uri}"
+          raise IOError
+      end
+      
+      def set_doc
+        return unless @response
+        @doc = Nokogiri::HTML(@response.body)
+      end
+      
+      def set_images
+        return unless @doc
+        image_links = @doc.css('img')
+        self.images = image_links.map do |link| 
+          src = full_path(link[:src]) 
+          ImageReference.new(src)
+        end
+      end
+      
+      def full_path(image)
+        if image[/^\//]
+          "http://#{@uri.host}#{image}"
+        else
+          image
+        end
+      end
+  end
+end

data/lib/best_image/image_reference.rb

@@ -0,0 +1,30 @@
+module BestImage
+  class ImageReference
+    attr_accessor :errors
+    attr_reader :url
+    
+    def initialize(url)
+      @errors = []
+      @url = url
+    end
+    
+    def size
+      @size ||= calculate_file_size
+    end
+    
+    def <=>(other)
+      self.size <=> other.size
+    end
+    
+    private
+      def calculate_file_size
+        open(URI.encode(@url), 'rb') do |fh|
+          h,w = ImageSize.new(fh).size
+          h*w
+        end
+        rescue OpenURI::HTTPError => e
+          self.errors << e
+          0
+      end
+  end
+end

data/lib/best_image/image_selector.rb

@@ -0,0 +1,11 @@
+# This class is created as a convience class for creating and parsing at the same time
+# seperating these functions in ImageFinder provided a conviencience for testing
+
+module BestImage
+  class ImageSelector < ImageFinder
+    def initialize(path)
+      super()
+      parse(path)
+    end
+  end
+end

data/lib/best_image/version.rb

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

data/spec/best_image/image_finder_spec.rb

@@ -0,0 +1,70 @@
+require 'spec_helper'
+
+module BestImage
+  describe ImageFinder do 
+    let(:good_url) { "http://www.google.com" }
+    let(:bad_url) { "http://www.some-url-that-should-never-be-findable.com" }
+    let(:good_image_url) { "http://www.google.com/intl/en_ALL/images/srpr/logo1w.png" }
+    
+    it "should fail gracefully and set an error message if it cannot access url" do
+      best = BestImage::ImageFinder.new
+      best.parse(bad_url)
+      best.errors.should_not be_empty
+    end
+    
+    it "should parse the passed url into a uri" do
+      best = BestImage::ImageFinder.new
+      best.send :set_uri, good_url
+      best.send :set_response
+      best.errors.empty?.should be_true
+    end
+    
+    it "should collect an array of images found on the page" do
+      best = BestImage::ImageFinder.new
+      best.parse(good_url)
+      best.images.should_not be_empty
+    end
+    
+    it "should return the best image on a page" do
+      test_url_match = "large"
+      small = ImageReference.new(bad_url)
+      small.stub!(:size).and_return(1)
+      small.stub!(:url).and_return("small")
+      medium = ImageReference.new(bad_url)
+      medium.stub!(:size).and_return(2)
+      medium.stub!(:url).and_return("medium")
+      large = ImageReference.new(bad_url)
+      large.stub!(:size).and_return(3)
+      large.stub!(:url).and_return(test_url_match)
+      
+      best = BestImage::ImageFinder.new
+      best.images << small
+      best.images << large
+      best.images << medium
+      
+      best.best_image.should eq(test_url_match)
+    end
+    
+    it "should return nil for best_image if it has errors" do
+      best = BestImage::ImageFinder.new
+      best.instance_variable_set("@errors", ["not being nil"])
+      best.best_image.should be_nil
+    end
+    
+    it "should return nil for best_image if it has no images" do
+      best = BestImage::ImageFinder.new
+      best.stub!(:images).and_return([])
+      best.best_image.should be_nil
+    end
+    
+    it "should return nil for best_image if the largest image is <= 0" do
+      small = ImageReference.new(bad_url)
+      small.stub!(:size).and_return(0)
+      
+      best = BestImage::ImageFinder.new
+      best.stub!(:images).and_return([small])
+      best.best_image.should be_nil
+    end
+
+  end
+end

data/spec/best_image/image_reference_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+
+module BestImage
+  describe ImageReference do 
+    let(:good_url) { "http://www.google.com/intl/en_ALL/images/srpr/logo1w.png" }
+    let(:bad_url) { "http://www.google.com/an/image/that/dosent/exist/logo1w.png" }
+    
+    it "should fail gracefully if it cannot get the image and return 0 for the size" do
+      image = ImageReference.new(bad_url)
+      image.size.should == 0
+      image.errors.should_not be_empty
+    end
+    
+    it "should calculate the size of the image and store it in the instance variable" do
+      image = ImageReference.new(good_url)
+      image.size.should_not == 0
+      image.instance_variable_get("@size").should_not == 0
+      image.errors.should be_empty, image.errors.inspect
+    end
+    
+    
+    it "should sort by size, smallest to largest" do
+      small = ImageReference.new(bad_url)
+      small.stub!(:size).and_return(1)
+      medium = ImageReference.new(bad_url)
+      medium.stub!(:size).and_return(2)
+      large = ImageReference.new(bad_url)
+      large.stub!(:size).and_return(3)
+      
+      (2 <=> 1).should == 1 
+      (medium <=> (small)).should == 1
+      (large <=> (small)).should == 1
+      (large <=> (medium)).should == 1
+      (large <=> (large)).should == 0
+    end
+    
+  end
+end
+  

data/spec/best_image/image_selector_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+module BestImage
+  describe ImageSelector do 
+    let(:good_url) { "http://www.google.com" }
+    
+    it "should create a new ImageFinder and call parse with the passed parameter" do
+      ImageFinder.should_receive(:new).with(good_url)
+      ImageSelector.new(good_url)
+    end
+  end
+end
+  

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'best_image'
+RSpec.configure do |config|
+  # some (optional) config here
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification 
+name: best_image
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Scott Johnson
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-10-30 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: image_size
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 17
+        segments: 
+        - 1
+        - 1
+        - 1
+        version: 1.1.1
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: nokogiri
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 5
+        - 2
+        version: 1.5.2
+  type: :runtime
+  version_requirements: *id003
+description: Returns the *Best Image* found from a passed url
+email: 
+- 7.scott.j@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- best_image.gemspec
+- lib/best_image.rb
+- lib/best_image/image_finder.rb
+- lib/best_image/image_reference.rb
+- lib/best_image/image_selector.rb
+- lib/best_image/version.rb
+- spec/best_image/image_finder_spec.rb
+- spec/best_image/image_reference_spec.rb
+- spec/best_image/image_selector_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/itchy/best_image
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: This gem scrapes a passed web page and returns the url of the *best image* found on that page.
+test_files: 
+- spec/best_image/image_finder_spec.rb
+- spec/best_image/image_reference_spec.rb
+- spec/best_image/image_selector_spec.rb
+- spec/spec_helper.rb