image_downloader 0.1.0 → 0.2.0

data/README.rdoc

@@ -1,19 +1,82 @@
-= image_downloader
+= Image Downloader
 
-Description goes here.
+Quite often there is a need to collect pictures from one or another page on the Internet. This plugin solves this particular task.
 
-== Contributing to image_downloader
+== Installation
+
+sudo gem install image_downloader
+
+== Requirements
+
+* ruby 1.8 or 1.9
+* gem nokogiri
+
+== Description
+
+Image Downloader is a rather simple library which does the following:
+* get web page (with Net::HTTP)
+* parse html page (use regexp or nokogiri)
+* download images (in one or multi-threads)
+
+== Example usage
+After installation, you can use the following code as an example:
  
-* 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.
+  require 'rubygems'
+  require 'image_downloader'
+  
+  page_url = 'www.test.com'
+  target_path = 'img_dir/'
+  downloader = ImageDownloader::Process.new(page_url,target_path)
+
+  #####
+  # download all images on page in any place (by regexp, all that look like url with image)
+  downloader.parse(:any_looks_like_image => true)
+
+  #####
+  # download images from all elements where usually images placed (<img...>, <a...>, ...)
+  downloader.parse()
+
+  #####
+  # download image from exect places in page
+  downloader.parse(:collect => {:link_icon => true})
+
+  downloader.download()
+
+For parse method available following options:
+:any_looks_like_image => true
+(find all url which contain image extansion)
+
+:collect => {:all => true, :(img_src|a_href|style_url|link_icon) => true}
+(find images in):
+* img_src - <img src="url">
+* a_href - <a href="url">
+* style_url - <element style="(background|background-image): url('url')">
+* link_icon - <link rel="shortcut icon" href="url">
+
+:ignore_without => {:(extension|image_extension) => true}
+(ignore URLs with images according to given parameters)
+
+== Executables
+You can simply use the executed shell commands:
+
+For any looks like image download
+  download_any_images url dir/
+
+For download favicon only
+  download_icon url dir/
+
+For download all, that is located in the places for pictures
+  download_images url dir/
 
 == Copyright
 
 Copyright (c) 2011 Malykh Oleg. See LICENSE.txt for
 further details.
 
+== License
+
+The MIT License
+
+== Authors
+
+Personal blog author: {Malykh Oleg}[http://malyh.com/] - blog in russian

data/lib/image_downloader.rb

@@ -36,7 +36,7 @@ module ImageDownloader
     # :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},
+    # :collect => {:all => true, :(img_src|a_href|style_url|link_icon) => true}
     def parse(h={:collect => {}, :ignore_without => {}})
       self.rebuild_collect_hash(h)
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: image_downloader
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 23
   prerelease: false
   segments: 
   - 0
-  - 1
+  - 2
   - 0
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Malykh Oleg
@@ -19,10 +19,25 @@ date: 2011-07-15 00:00:00 +04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  type: :development
+  name: nokogiri
   prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 1
+        - 4
+        - 4
+        version: 1.4.4
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
   name: shoulda
-  version_requirements: &id001 !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -31,12 +46,12 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  requirement: *id001
-- !ruby/object:Gem::Dependency 
   type: :development
-  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
   name: bundler
-  version_requirements: &id002 !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -47,12 +62,12 @@ dependencies:
         - 0
         - 0
         version: 1.0.0
-  requirement: *id002
-- !ruby/object:Gem::Dependency 
   type: :development
-  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
   name: jeweler
-  version_requirements: &id003 !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -63,12 +78,12 @@ dependencies:
         - 6
         - 4
         version: 1.6.4
-  requirement: *id003
-- !ruby/object:Gem::Dependency 
   type: :development
-  prerelease: false
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
   name: rcov
-  version_requirements: &id004 !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -77,24 +92,9 @@ dependencies:
         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
+  version_requirements: *id005
+description: A simple lib for downloading pictures from web pages. It can get and parse page with different options and receive images from specified locations. It is possible to download images simultaneously in multiple threads or sequentially.
 email: malykholeg@gmail.com
 executables: 
 - download_any_images
@@ -150,6 +150,6 @@ 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
+summary: Lib for parsing web pages to find images in specified locations and downloading them simultaneously or sequentially
 test_files: []