featuredimage 0.9.0

data/lib/featuredimage/converter.rb

@@ -0,0 +1,64 @@
+require 'RMagick'
+
+module FeaturedImage
+	class Converter
+		attr_accessor :width, :height, :opts
+
+		def self.convert(image, w, h, opts = {})
+			converter = Converter.new(w, h, opts)
+			converter.convert(image)
+		end
+
+		def initialize(width, height, opts = {})
+			@width, @height = width, height
+
+			# default convert options
+			@opts = {
+				:format => "JPG",
+				:quality => 60
+			}
+			@opts.merge!(opts)
+		end
+
+		def convert(image)
+			target_size = {w:@width, h:@height}
+			original_size = {w:image.columns, h:image.rows}
+
+			resized_size = get_resized_size(original_size, target_size)
+			resized_image = image.resize(resized_size[:w], resized_size[:h])
+
+			offset = get_offset(target_size, resized_size)
+			cropped_image = resized_image.crop(offset[:x], offset[:y], target_size[:w], target_size[:h])
+
+			image_to_blob(cropped_image)
+		end
+
+		private
+		def get_resized_size(src, dst)
+			w_ratio = dst[:w].to_f / src[:w]
+			h_ratio = dst[:h].to_f / src[:h]
+			ratio = 0
+			if w_ratio > h_ratio
+				ratio = w_ratio
+			else
+				ratio = h_ratio
+			end
+			{w:(src[:w] * ratio).to_i, h:(src[:h] * ratio).to_i}
+		end
+
+		def get_offset(target_size, resized_size)
+			offset_x = (resized_size[:w] - target_size[:w]) / 2
+			offset_y = (resized_size[:h] - target_size[:h]) / 2
+			{:x => offset_x, :y => offset_y}
+		end
+
+		def image_to_blob(image)
+			opts = @opts
+			image.to_blob{
+				opts.each{|k, v|
+					self.send(k.to_s + '=', v)
+				}
+			}
+		end
+	end
+end

data/lib/featuredimage/finder.rb

@@ -0,0 +1,187 @@
+require "mechanize"
+require "RMagick"
+
+module FeaturedImage
+	class Finder
+		# Find first featured image that is matching criteria from web page.
+		# And return it as Magick::ImageList.
+		# If the featured image does not exist return nil.
+		def self.first(url, *args)
+			finder = Finder.new
+			cond = Criteria.new(*args)
+			finder.first(url, cond)
+		end
+
+		# Find the biggest featured image that is matching criteria from web page.
+		# And return it as Magick::ImageList.
+		# If the featured image does not exist return nil.
+		def self.biggest(url, *args)
+			finder = Finder.new
+			cond = Criteria.new(*args)
+			finder.biggest(url, cond)
+		end
+
+		# Find all featured images that are matching criteria from web page.
+		# And return them as Array of Magick::ImageList.
+		# If the featured image does not exist return empty Array.
+		def self.all(url, *args)
+			finder = Finder.new
+			cond = Criteria.new(*args)
+			finder.all(url, cond)
+		end
+
+		def first(url, cond)
+			agent = Mechanize.new
+			page = agent.get(url)
+			page.search("img").each{|elm|
+				src = elm.attributes["src"].value
+				begin
+					data = download_image(agent, src)
+
+					imagelist = Magick::ImageList.new
+					imagelist.from_blob(data)
+
+					size = Size.new(imagelist.columns, imagelist.rows)
+					if featured_image?(cond, size)
+						return imagelist
+					end
+				rescue Mechanize::ResponseCodeError
+					# ignore Mechanize::ResponseCodeError
+				end
+			}
+			nil
+		end
+
+		def biggest(url, cond)
+			agent = Mechanize.new
+			page = agent.get(url)
+
+			max_size = Size.new(0, 0)
+			max_imagelist = nil
+
+			page.search("img").each{|elm|
+				src = elm.attributes["src"].value
+				begin
+					data = download_image(agent, src)
+
+					imagelist = Magick::ImageList.new
+					imagelist.from_blob(data)
+
+					size = Size.new(imagelist.columns, imagelist.rows)
+					if featured_image?(cond, size)
+						if max_size < size
+							max_size = size
+							max_imagelist = imagelist
+						end
+					end
+				rescue Mechanize::ResponseCodeError
+					# ignore Mechanize::ResponseCodeError
+				end
+			}
+
+			max_imagelist
+		end
+
+		def all(url, cond)
+			agent = Mechanize.new
+			page = agent.get(url)
+
+			max_size = Size.new(0, 0)
+			max_imagelist = nil
+
+			results = []
+			page.search("img").each{|elm|
+				src = elm.attributes["src"].value
+				begin
+					data = download_image(agent, src)
+
+					imagelist = Magick::ImageList.new
+					imagelist.from_blob(data)
+
+					size = Size.new(imagelist.columns, imagelist.rows)
+					results << imagelist if featured_image?(cond, size)
+				rescue Mechanize::ResponseCodeError
+					# ignore Mechanize::ResponseCodeError
+				end
+			}
+			results
+		end
+
+		private
+		def download_image(agent, src)
+			agent.get(src).body
+		end
+
+		def featured_image?(cond, size)
+			cond.check(size)
+		end
+	end
+
+	class Criteria
+		attr_accessor :min_width, :max_width, :min_height, :max_height, :aspect_range
+
+		def initialize(*args)
+			# default criteria size 0x0 to 4096x4096
+			@min_width = 0
+			@max_width = 4096
+			@min_height = 0
+			@max_height = 4096
+			@aspect_range = 0..4096
+
+			case args.length
+			when 0
+				# default criteria
+			when 1
+				@aspect_range = args[0]
+			when 2
+				@min_width = args[0]
+				@min_height = args[1]
+			when 3
+				@min_width = args[0]
+				@min_height = args[1]
+				@aspect_range = args[2]
+			when 4
+				@min_width = args[0]
+				@max_width = args[1]
+				@min_height = args[2]
+				@max_height = args[3]
+			when 5
+				@min_width = args[0]
+				@max_width = args[1]
+				@min_height = args[2]
+				@max_height = args[3]
+				@aspect_range = args[4]
+			else
+				raise ArgumentError.new
+			end
+		end
+
+		def check(size)
+			if @min_width < size.width and
+				 size.width < @max_width and
+				 @min_height < size.height and
+				 size.height < @max_height and
+				 @aspect_range.include?(size.aspect)
+				true
+			else
+				false
+			end
+		end
+	end
+
+	class Size
+		attr_accessor :width, :height
+
+		def initialize(width, height)
+			@width, @height = width, height
+		end
+
+		def aspect
+			width.to_f / height.to_f # ;-)
+		end
+
+		def <(size)
+			@width * @height < size.width * size.height ? true : false
+		end
+	end
+end

data/lib/featuredimage.rb

@@ -0,0 +1,2 @@
+require 'featuredimage/finder'
+require 'featuredimage/converter'

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: featuredimage
+version: !ruby/object:Gem::Version
+  version: 0.9.0
+  prerelease: 
+platform: ruby
+authors:
+- xmisao
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mechanize
+  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: ! 'FeaturedImage is the finder that extract featured image from a web
+  page.
+
+  FeaturedImage::Finder accesses and analyses a web page using Mechanize, download
+  images which are referenced by IMG tag in HTML, and specify a featured image based
+  on size of image using RMagick.
+
+  Furthermore, FeaturedImage contains pretty good thumbnail generating function too.
+  FeaturedImage::Converter crops centered area of image, resizes, and convert to arbitrary
+  format automatically.
+
+'
+email: mail@xmisao.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/featuredimage.rb
+- lib/featuredimage/finder.rb
+- lib/featuredimage/converter.rb
+homepage: https://github.com/xmisao/featuredimage
+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'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: FeaturedImage is the finder that extract featured image from a web page.
+test_files: []