image_downloader 0.1.0

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Malykh Oleg
+
+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,19 @@
+= image_downloader
+
+Description goes here.
+
+== Contributing to image_downloader
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2011 Malykh Oleg. See LICENSE.txt for
+further details.
+

data/bin/download_any_images

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+require 'image_downloader'
+
+downloader = ImageDownloader::Process.new(ARGV[0],ARGV[1])
+
+downloader.parse(:any_looks_like_image => true)
+
+downloader.download()

data/bin/download_icon

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+require 'image_downloader'
+
+downloader = ImageDownloader::Process.new(ARGV[0],ARGV[1])
+
+downloader.parse(:collect => {:link_icon => true})
+
+downloader.download()

data/bin/download_images

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+require 'image_downloader'
+
+downloader = ImageDownloader::Process.new(ARGV[0],ARGV[1])
+
+downloader.parse()
+
+downloader.download()

data/lib/image_downloader.rb

@@ -0,0 +1,82 @@
+# gems
+require 'nokogiri'
+# core lib
+require 'open-uri'
+require 'thread'
+require 'uri'
+require 'net/http'
+require 'optparse'
+# local lib
+require 'image_downloader/images'
+require 'image_downloader/url'
+require 'image_downloader/arguments'
+require 'image_downloader/parser'
+require 'image_downloader/download'
+
+module ImageDownloader
+
+  options = {}
+  OptionParser.new do |opts|
+    opts.on("-d", "--debug", "Run debug mode") do |d|
+      options[:debug] = d
+      $debug_option = true
+    end
+  end.parse!
+  
+  class Process
+    attr_accessor :argument, :images
+
+    def initialize(url, path)
+      @argument = Arguments.new(url, path)
+      @argument.check
+      @argument.normalize
+      @images = []
+    end
+
+    # :any_looks_like_image => true
+    # :ignore_without => {:(extension|image_extension) => true}
+    # Nokogiri gem is required:
+    # :collect => {:all => true, :(img_src|a_href|style_url|link_icon) => true},
+    def parse(h={:collect => {}, :ignore_without => {}})
+      self.rebuild_collect_hash(h)
+
+      parser = Parser.new(self.argument.url)
+      if h[:any_looks_like_image]
+        parser.get_content_raw
+        parser.get_images_raw(self.argument.path, h[:collect])
+      else
+        parser.get_content
+        parser.get_images(self.argument.path, h[:collect])
+      end
+
+      parser.ignore_file_without(h[:ignore_without])
+
+      self.images = parser.images
+    end
+
+    # :(parallel|consequentially)
+    def download(*args)
+      if !args.first || args.first == :parallel
+        Download.parallel(self.images)
+      elsif args.first == :consequentially
+        Download.consequentially(self.images)
+      end
+    end
+
+    protected
+
+    def rebuild_collect_hash(h={})
+      if !h[:collect] || h[:collect].empty? || h[:collect][:all]
+        h[:collect] = Parser.all_image_places
+      else
+        collect_new = {}
+        h[:collect].each_key{|k|
+          collect_new[(Parser::COLLECT_METHODS_PREFIX + k.to_s).to_sym] = true
+        }
+        h[:collect].merge!(collect_new)
+        h[:collect].delete_if{|k,v| !Parser.all_image_places.has_key?(k)}
+      end
+    end
+
+  end
+end

data/lib/image_downloader/arguments.rb

@@ -0,0 +1,27 @@
+module ImageDownloader
+  class Arguments
+    attr_accessor :url, :path
+
+    def initialize(url, path)
+      @url = url
+      @path = path
+    end
+
+    def check
+      if !self.url
+        p "Not specified url"
+        exit
+      end
+      if !self.path
+        p "Not specified path"
+        exit
+      end
+    end
+
+    def normalize
+      self.url = URL.normalize(self.url)
+      self.path = self.path.gsub(/\/+$/,'')
+    end
+
+  end
+end

data/lib/image_downloader/download.rb

@@ -0,0 +1,23 @@
+module ImageDownloader
+  class Download
+
+    def self.parallel(images)
+      threads = []
+      for image in images
+        threads << Thread.new(image) {|local_image|
+          p "upload from url #{local_image.absolute_src} to file #{local_image.file_name}" if $debug_option
+          local_image.download
+        }
+      end
+      threads.each { |aThread|  aThread.join }
+    end
+
+    def self.consequentially(images)
+      for image in images
+        p "upload from url #{image.absolute_src} to file #{image.file_name}" if $debug_option
+        image.download
+      end
+    end
+
+  end
+end

data/lib/image_downloader/images.rb

@@ -0,0 +1,61 @@
+module ImageDownloader
+  class Images
+    attr_accessor :src, :file_name, :page_host, :absolute_src, :file_path_name
+
+    MAX_FILE_NAME_LENGTH_ALLOWED = 200
+    IMAGE_EXTENSIONS = ["jpg","jpeg","png","gif","ico","svg","bmp"]
+    EMPTY_FILE_NAME = 'EMPTY_'
+
+    def initialize(page_host,src,h = {})
+      @page_host = page_host
+      @src = src
+
+      # for fix Errno::ENAMETOOLONG & empty file name
+      file_name_suffix = @src.sub(/.*\//,'')
+      file_name_suffix = EMPTY_FILE_NAME + rand(100000).to_s if !file_name_suffix || file_name_suffix.empty?
+      if file_name_suffix.size > MAX_FILE_NAME_LENGTH_ALLOWED
+        file_name_suffix = file_name_suffix[-MAX_FILE_NAME_LENGTH_ALLOWED..file_name_suffix.size]
+      end
+
+      @file_name = h[:file_name_prefix] + file_name_suffix
+      @file_path_name = h[:catalog_path] + '/' + @file_name
+      @absolute_src = ((@src =~ /http/) ? @src : ('http://' + page_host + '/' +  @src))
+    end
+
+    def download
+      url = URI.parse(self.absolute_src)
+      request = Net::HTTP::Get.new(url.path)
+      Net::HTTP.start(url.host) {|http|
+        # for exclude 403 and 404 errors from web servers (e.g. detect current client as script)
+        # you can use:
+        # - watir (with js support and other ...), but vary vary slow
+        # - mechanize (main web client), slow
+        # - wget, quick, but cannot support some ability (403, 404 responses)
+        # - sockets, independent request, quick, but low-level (many lines of code)
+        self.download_by_segment(http,request)
+        # self.download_simple(http,request)
+      }
+    end
+
+    def download_by_segment(http,request)
+      file = open(self.file_path_name, "wb")
+      begin
+        http.request_get(request.path, "User-Agent"=> "Mozilla/5.0") do |response|
+          response.read_body do |segment|
+            file.write(segment)
+          end
+        end
+      ensure
+        file.close()
+      end
+    end
+
+    def download_simple(http,request)
+      response = http.get(request.path, "User-Agent"=> "Mozilla/5.0")
+      open(self.file_path_name, "wb") { |file|
+        file.write(response.body)
+      }
+    end
+
+  end
+end

data/lib/image_downloader/parser.rb

@@ -0,0 +1,111 @@
+class Array
+  def to_hash_keys(&block)
+    Hash[*self.collect { |v|
+        [v, block.call(v)]
+      }.flatten]
+  end
+
+  def to_hash_values(&block)
+    Hash[*self.collect { |v|
+        [block.call(v), v]
+      }.flatten]
+  end
+end
+
+module ImageDownloader
+  class Parser
+    attr_accessor :url, :argument_url, :content, :images, :images_hash
+
+    A_HREF_IMAGE_PREFIX = '_a_href_'
+    STYLE_URL_IMAGE_PREFIX = '_style_url_'
+    LINK_ICON_IMAGE_PREFIX = '_link_icon_'
+    COLLECT_METHODS_PREFIX = 'collect_from_'
+
+    def initialize(url)
+      @argument_url = url
+      @url = URI.parse(url)
+      @images = []
+      @images_hash = {}
+    end
+
+    def get_content_raw
+      @content = open(self.argument_url).read
+      @content.gsub!(/[\n\r\t]+/,' ')
+    end
+
+    def get_images_raw(path,h={})
+      self.content.scan(/['"]+[^'"]+\.(?:#{Images::IMAGE_EXTENSIONS.join('|')})['"]+/).map{|src|
+        src.gsub!(/['"]/,'')
+        self.push_to_images(path,src)
+      }
+    end
+
+    def get_content
+      @content = Nokogiri::HTML(open(self.argument_url))
+    end
+
+    def get_images(path,h={})
+      h.each_key{|key| self.send(key, path)}
+    end
+
+    def collect_from_img_src(path)
+      self.content.xpath('//img').each do |img|
+        src = img[:src]
+        URL.remove_new_line_symbols!(src)
+        self.push_to_images(path,src)
+      end
+    end
+
+    def collect_from_a_href(path)
+      self.content.xpath('//a').each do |a|
+        href = a[:href]
+        URL.remove_new_line_symbols!(href)
+        next if href !~ /\.(?:#{Images::IMAGE_EXTENSIONS.join('|')})/i
+        self.push_to_images(path,href,{:file_name_prefix => A_HREF_IMAGE_PREFIX})
+      end
+    end
+
+    def collect_from_style_url(path)
+      self.content.xpath("//*[@style]").each do |element|
+        style = element[:style]
+        next if style !~ /(?:background|background-image):\s*url\(['"]?(.*?)['"]?\)/i
+        src = $1
+        next if !src
+        URL.remove_new_line_symbols!(src)
+        self.push_to_images(path,src,{:file_name_prefix => STYLE_URL_IMAGE_PREFIX})
+      end
+    end
+
+    def collect_from_link_icon(path)
+      self.content.xpath('//link[@rel="shortcut icon"]').each do |link|
+        src = link[:href]
+        URL.remove_new_line_symbols!(src)
+        self.push_to_images(path,src,{:file_name_prefix => LINK_ICON_IMAGE_PREFIX})
+      end
+    end
+
+    def push_to_images(path,src,h={})
+      if !self.images_hash.has_key?(src)
+        self.images_hash[src] = 1
+        self.images.push Images.new(self.url.host,URI.escape(src), {
+            :catalog_path => path,
+            :file_name_prefix =>  (h[:file_name_prefix] || '')})
+      end
+    end
+
+    def ignore_file_without(h={})
+      return if !h
+      self.images.delete_if {|image| image.file_name !~ /\.[a-z]{0,5}$/i } if h[:extension]
+      self.images.delete_if {|image| image.file_name !~ /\.(?:#{Images::IMAGE_EXTENSIONS.join('|')})$/i } if h[:image_extension]
+    end
+
+    def self.all_collect_from_methods
+      Parser.instance_methods.select{|m| m =~ /#{COLLECT_METHODS_PREFIX}/}.map{|m| m.to_sym}.to_hash_keys{true}
+    end
+
+    class << self
+      alias all_image_places all_collect_from_methods
+    end
+
+  end
+end

data/lib/image_downloader/url.rb

@@ -0,0 +1,18 @@
+module ImageDownloader
+  class URL
+
+    def self.contain_http?(url)
+      url =~ /^(http|https)/i ? true : false
+    end
+
+    def self.normalize(url)
+      contain_http?(url) ? url : 'http://' + url
+    end
+
+    def self.remove_new_line_symbols!(str)
+      str.gsub!(/\r/,'') if str
+      str.gsub!(/\n/,'') if str
+    end
+
+  end
+end

metadata

@@ -0,0 +1,155 @@
+--- !ruby/object:Gem::Specification 
+name: image_downloader
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Malykh Oleg
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-07-15 00:00:00 +04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: shoulda
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id001
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: bundler
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  requirement: *id002
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: jeweler
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 6
+        - 4
+        version: 1.6.4
+  requirement: *id003
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: rcov
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id004
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: nokogiri
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 1
+        - 4
+        - 4
+        version: 1.4.4
+  requirement: *id005
+description: Detailed description for image-downloader
+email: malykholeg@gmail.com
+executables: 
+- download_any_images
+- download_images
+- download_icon
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- lib/image_downloader.rb
+- lib/image_downloader/arguments.rb
+- lib/image_downloader/download.rb
+- lib/image_downloader/images.rb
+- lib/image_downloader/parser.rb
+- lib/image_downloader/url.rb
+- LICENSE.txt
+- README.rdoc
+- bin/download_any_images
+- bin/download_images
+- bin/download_icon
+has_rdoc: true
+homepage: http://github.com/Fotom/image_downloader
+licenses: 
+- MIT
+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.3.7
+signing_key: 
+specification_version: 3
+summary: Parsing web page, finding images in specified locations and downloading them simultaneously or sequentially
+test_files: []
+