fetcher 0.3.0 → 0.4.0

data/README.markdown

@@ -7,9 +7,6 @@
 * forum :: [groups.google.com/group/webslideshow](https://groups.google.com/group/webslideshow)
 
 
-## Description
-
-
 ## Usage
 
 ### Copy (to File)
@@ -31,6 +28,45 @@ or
     worker = Fetcher::Worker.new
     txt = worker.read( 'https://raw.github.com/openfootball/at-austria/master/2013_14/bl.txt' )
 
+Note: The method `read` will return a string.
+
+
+### Get (HTTP Response)
+
+    response = Fetcher.get( 'https://raw.github.com/openfootball/at-austria/master/2013_14/bl.txt' )
+
+or
+
+    worker = Fetcher::Worker.new
+    response = worker.get( 'https://raw.github.com/openfootball/at-austria/master/2013_14/bl.txt' )
+
+Note: The method `get` will return a `Net::HTTPResponse` object
+(lets you use code, headers, body, etc.).
+
+    puts response.code             # => '404' 
+                                   #  Note: Returned (status) code is a string e.g. '404'
+    puts response.message          # => 'Not Found'
+    puts response.body
+    puts response.content_type     # => 'text/html; charset=UTF-8'
+    puts response['content-type']  # => 'text/html; charset=UTF-8'
+                                   #  Note: Headers are always downcased
+                                   #        e.g. use 'content-type' not 'Content-Type'
+
+
+## Command Line
+
+~~~
+fetch version 0.7.0 - Lets you fetch text documents or binary blobs via HTTP, HTTPS.
+
+Usage: fetch [options] URI
+    -o, --output PATH                Output Path (default is '.')
+    -v, --verbose                    Show debug trace
+
+
+Examples:
+  fetch https://raw.github.com/openfootball/at-austria/master/2013_14/bl.txt
+  fetch -o downloads https://raw.github.com/openfootball/at-austria/master/2013_14/bl.txt
+~~~
 
 
 ## Install
@@ -51,6 +87,9 @@ The [`sportdb`](https://github.com/geraldb/sport.db.ruby) gem that lets you read
 and more in plain text
 ships with the `fetcher` gem.
 
+The [`pluto`](https://github.com/geraldb/pluto) gem that lets you build web pages
+from published web feeds
+ships with the `fetcher` gem.
 
 
 ## License

data/lib/fetcher.rb

@@ -54,7 +54,7 @@ module Fetcher
   end
 
   # convenience shortcuts
-  
+
   def self.copy( src, dest )
     Worker.new.copy( src, dest )
   end
@@ -63,6 +63,10 @@ module Fetcher
     Worker.new.read( src )
   end
 
+  def self.get( src )
+    Worker.new.get( src )
+  end
+
 end  # module Fetcher
 
 

data/lib/fetcher/cli/opts.rb

@@ -2,17 +2,13 @@
 module Fetcher
 
   class Opts
-  
-    def initialize
-      @output_path  = ''
-    end
 
     def output_path=( value )
       @output_path = value
-    end    
-  
+    end
+
     def output_path
-      @output_path
+      @output_path || '.'
     end
 
   end # class Opts

data/lib/fetcher/cli/runner.rb

@@ -25,15 +25,13 @@ module Fetcher
     def run( args )
       opt=OptionParser.new do |cmd|
 
-        cmd.banner = "Usage: fetch [options] uri"
+        cmd.banner = "Usage: fetch [options] URI"
 
         cmd.on( '-o', '--output PATH', "Output Path (default is '#{opts.output_path}')" ) { |s| opts.output_path = s }
 
         # todo: find different letter for debug trace switch (use v for version?)
         cmd.on( '-v', '--verbose', 'Show debug trace' )  do
-           # todo/fix: use/change to logutils settings for level
-           # logger.datetime_format = "%H:%H:%S"
-           # logger.level = Logger::DEBUG
+           LogUtils::Logger.root.level = :debug
         end
 
       usage =<<EOS
@@ -50,7 +48,8 @@ Further information:
   https://github.com/geraldb/fetcher
 
 EOS
- 
+
+        ## todo: also add -?  if possible as alternative
         cmd.on_tail( '-h', '--help', 'Show this message' ) do
            puts usage
            exit
@@ -69,13 +68,11 @@ EOS
         logger.debug "uri.host=<#{uri.host}>, uri.path=<#{uri.path}>"
         
         if uri.path == '/' || uri.path == ''
-          dest = "#{uri.host}"
+          dest = "#{opts.output_path}/#{uri.host}"
         else
-          dest = "#{uri.host}@#{uri.path.gsub( /[ \-]/, '_').gsub( /[\/\\]/, '-')}"
+          dest = "#{opts.output_path}/#{uri.host}@#{uri.path.gsub( /[ \-]/, '_').gsub( /[\/\\]/, '-')}"
         end
-        
-        ## todo: use output path option
-        
+
         Worker.new.copy( src, dest )
 
       end # each arg

data/lib/fetcher/version.rb

@@ -1,7 +1,7 @@
 
 module Fetcher
 
-  VERSION = '0.3.0'
+  VERSION = '0.4.0'
 
 end  # module Fetcher
 

data/lib/fetcher/worker.rb

@@ -17,14 +17,22 @@ module Fetcher
     end
 
 
+    def get( src )
+      # return HTTPResponse (code,message,body,etc.)
+      logger.debug "fetch - get(_response) src: #{src}"
+
+      get_response( src )
+    end
+
+
     def read( src )
       # return contents (response body) a string
       logger.debug "fetch - copy src: #{src} into string"
       
       response = get_response( src )
       
-      # on error return empty string  - check: better return nil- why? why not??
-      return ''  if response.nil?
+      # on error return empty string; - check: better return nil- why? why not??
+      return ''  if response.code != '200'
 
       response.body.dup  # return string copy
     end
@@ -34,9 +42,9 @@ module Fetcher
       logger.debug "fetch - copy src: #{src} to dest: #{dest}"
 
       response = get_response( src )
-      
+
       # on error return; do NOT copy file; sorry
-      return  if response.nil?
+      return  if response.code != '200'
 
       # check for content type; use 'wb' for images
       if response.content_type =~ /image/
@@ -97,7 +105,8 @@ module Fetcher
   
         if response.code == '200'
           logger.debug "#{response.code} #{response.message}"
-          break
+          logger.debug "  content_type: #{response.content_type}, content_length: #{response.content_length}"
+          break  # will return response
         elsif (response.code == '301' || response.code == '302' || response.code == '303' || response.code == '307' )
           # 301 = moved permanently
           # 302 = found
@@ -111,15 +120,12 @@ module Fetcher
           end
           uri = newuri
         else
-          msg = "#{response.code} #{response.message}" 
-          puts "*** error: #{msg}"
-          return nil  # todo: throw StandardException?  
+          puts "*** error - fetch HTTP - #{response.code} #{response.message}"
+          break  # will return response
         end
       end
 
-      logger.debug "  content_type: #{response.content_type}, content_length: #{response.content_length}"
-
-      response # return respone or nil if error
+      response
     end # method copy
 
   end # class Worker

metadata

@@ -1,57 +1,49 @@
 --- !ruby/object:Gem::Specification
 name: fetcher
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
+  prerelease: 
 platform: ruby
 authors:
 - Gerald Bauer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-27 00:00:00.000000000 Z
+date: 2013-09-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logutils
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &75519830 !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0.6'
   type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0.6'
+  version_requirements: *75519830
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &75537890 !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '3.10'
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '4.0'
+  version_requirements: *75537890
 - !ruby/object:Gem::Dependency
   name: hoe
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &75536950 !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '3.6'
+        version: '3.3'
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '3.6'
+  version_requirements: *75536950
 description: fetcher - Fetch Text Documents or Binary Blobs via HTTP, HTTPS
 email: webslideshow@googlegroups.com
 executables:
@@ -73,7 +65,6 @@ files:
 homepage: https://github.com/geraldb/fetcher
 licenses:
 - Public Domain
-metadata: {}
 post_install_message: 
 rdoc_options:
 - --main
@@ -81,19 +72,21 @@ rdoc_options:
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: 1.9.2
 required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: fetcher
-rubygems_version: 2.0.6
+rubygems_version: 1.8.17
 signing_key: 
-specification_version: 4
+specification_version: 3
 summary: fetcher - Fetch Text Documents or Binary Blobs via HTTP, HTTPS
 test_files: []

checksums.yaml

@@ -1,7 +0,0 @@
----
-SHA1:
-  metadata.gz: ef1b964e3b4a79b13b008147f894244610851bb9
-  data.tar.gz: 84815891771fe636ecf09891451dca80bb4fd83f
-SHA512:
-  metadata.gz: 01df88051ef004d00c25e9dcbdb1fb363737f1862106af02c4f74ad6712894960eb47c152853be0a29689c41aa47db7ebb57b00ef9154ff8564e92dafb4d213e
-  data.tar.gz: 13a9c6a495483b07a0fc4b693cec8cc205aa7de48333f95884535d4ac2ab61cd3e4d5e85b4b24c41f477fcee3a971d125381bae36d872b319d12a18dfb240d3c