fetcher 0.1.0 → 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 930c43d21e2b74f6d413e59aef2cbdff621d9c54
+  data.tar.gz: abeb5fc3593a9f13beaba961d1fcc8c30a0cd0d3
+SHA512:
+  metadata.gz: 6ceebb4318870c02805cdf52c53ae8b9ff35c0adb004638adc0082a954662ea05201390888aaaeac3e8b60efb05cb0f1de08308087a87606f5a93fce1f5f8652
+  data.tar.gz: e3100ec244e84a23798c38b895ce5017d99582462d064f07b198e18b88cd695c8ff6752834e02275be4a6ad6404ae00e198112411557107eddc9202f2c9dc35a

data/README.markdown

@@ -1,22 +1,35 @@
 # fetcher - Fetch Text Documents or Binary Blobs via HTTP, HTTPS
 
-* [geraldb.github.com/fetcher](http://geraldb.github.com/fetcher)
+* home  :: [github.com/geraldb/fetcher](https://github.com/geraldb/fetcher)
+* bugs  :: [github.com/geraldb/fetcher/issues](https://github.com/geraldb/fetcher/issues)
+* gem   :: [rubygems.org/gems/fetcher](https://rubygems.org/gems/fetcher)
+* rdoc  :: [rubydoc.info/gems/fetcher](http://rubydoc.info/gems/fetcher)
+* forum :: [groups.google.com/group/webslideshow](https://groups.google.com/group/webslideshow)
+
 
 ## Description
 
-TBD
 
 ## Usage
 
-    require 'fetcher'
-    
-    Fetcher.copy( 'http://geraldb.github.com/rubybook/hoe.html', '/tmp/hoe.html' )
+### Copy (to File)
+
+    Fetcher.copy( 'https://raw.github.com/openfootball/at-austria/master/2013_14/bl.txt', '/tmp/bl.txt' )
 
 or
 
-    logger = Logger.new( STDOUT )
-    worker = Fetcher::Worker.new( logger )
-    worker.copy( 'http://geraldb.github.com/rubybook/hoe.html', '/tmp/hoe.html' )
+    worker = Fetcher::Worker.new
+    worker.copy( 'https://raw.github.com/openfootball/at-austria/master/2013_14/bl.txt', '/tmp/bl.txt' )
+
+
+### Read (into String)
+
+    txt = Fetcher.read( 'https://raw.github.com/openfootball/at-austria/master/2013_14/bl.txt' )
+
+or
+
+    worker = Fetcher::Worker.new
+    txt = worker.read( 'https://raw.github.com/openfootball/at-austria/master/2013_14/bl.txt' )
 
 
 
@@ -29,11 +42,16 @@ Just install the gem:
 
 ## Real World Usage
 
-The [`slideshow`](http://slideshow.rubyforge.org) (also known as Slide Show (S9)) gem
+The [`slideshow`](http://slideshow-s9.github.io) (also known as Slide Show (S9)) gem
 that lets you create slide shows
 and author slides in plain text using a wiki-style markup language that's easy-to-write and easy-to-read
 ships with the `fetcher` gem.
 
+The [`sportdb`](https://github.com/geraldb/sport.db.ruby) gem that lets you read football (soccer) fixtures
+and more in plain text
+ships with the `fetcher` gem.
+
+
 
 ## License
 

data/Rakefile

@@ -8,7 +8,7 @@ Hoe.spec 'fetcher' do
   self.summary = 'fetcher - Fetch Text Documents or Binary Blobs via HTTP, HTTPS'
   self.description = summary
 
-  self.urls    = ['http://geraldb.github.com/fetcher']
+  self.urls    = ['https://github.com/geraldb/fetcher']
   
   self.author  = 'Gerald Bauer'
   self.email   = 'webslideshow@googlegroups.com'
@@ -16,5 +16,15 @@ Hoe.spec 'fetcher' do
   # switch extension to .markdown for gihub formatting
   self.readme_file  = 'README.markdown'
   self.history_file = 'History.markdown'
+
+  self.extra_deps = [
+    ['logutils', '>= 0.6']
+  ]
+
+  self.licenses = ['Public Domain']
+
+  self.spec_extras = {
+   :required_ruby_version => '>= 1.9.2'
+  }
   
-end
+end

data/lib/fetcher.rb

@@ -19,6 +19,10 @@ require 'date'
 require 'cgi'
 
 
+# 3rd party gems
+
+require 'logutils'
+
 # our own code
 
 require 'fetcher/runner'
@@ -27,7 +31,7 @@ require 'fetcher/worker'
 
 module Fetcher
 
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 
   # version string for generator meta tag (includes ruby version)
   def self.banner
@@ -47,6 +51,16 @@ module Fetcher
     Runner.new.run(args)
   end
 
+  # convenience shortcuts
+  
+  def self.copy( src, dest )
+    Worker.new.copy( src, dest )
+  end
+
+  def self.read( src )
+    Worker.new.read( src )
+  end
+
 end  # module Fetcher
 
 

data/lib/fetcher/runner.rb

@@ -1,11 +1,6 @@
 
 module Fetcher
 
-   def self.copy( src, dest )
-      Worker.new( Logger.new(STDOUT) ).copy( src, dest )
-   end
-
-
   class Opts
   
     def initialize
@@ -24,13 +19,12 @@ module Fetcher
 
 
   class Runner
+
+    include LogUtils::Logging
     
-    attr_reader :logger
     attr_reader :opts
     
     def initialize
-      @logger       = Logger.new(STDOUT)
-      @logger.level = Logger::INFO
       @opts         = Opts.new
     end
     
@@ -43,22 +37,23 @@ module Fetcher
 
         # todo: find different letter for debug trace switch (use v for version?)
         cmd.on( "-v", "--verbose", "Show debug trace" )  do
-           logger.datetime_format = "%H:%H:%S"
-           logger.level = Logger::DEBUG
+           # todo/fix: use/change to logutils settings for level
+           # logger.datetime_format = "%H:%H:%S"
+           # logger.level = Logger::DEBUG
         end
 
       usage =<<EOS
  
-fetch - Lets you fetch text documents or binary blobs via HTTP, HTTPS.
+fetch #{VERSION} - Lets you fetch text documents or binary blobs via HTTP, HTTPS.
 
 #{cmd.help}
 
 Examples:
-  fetch http://geraldb.github.com/rubybook/hoe.html
-  fetch -o downloads http://geraldb.github.com/rubybook/hoe.html
+  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
 
 Further information:
-  http://geraldb.github.com/fetcher
+  https://github.com/geraldb/fetcher
 
 EOS
  
@@ -87,15 +82,14 @@ EOS
         
         ## todo: use output path option
         
-        Worker.new( logger ).copy( src, dest )
+        Worker.new.copy( src, dest )
 
       end # each arg
 
-      puts "Done."
+      puts 'Done.'
       
     end   # method run
     
   end # class Runner
 
 end  # module Fetcher
-

data/lib/fetcher/worker.rb

@@ -2,18 +2,57 @@ module Fetcher
 
   class Worker
 
-    attr_reader :logger
+    include LogUtils::Logging
 
-    def initialize( logger )
-      @logger = logger
+### todo/fix:
+# remove logger from c'tor
+#  use logutils instead
+
+    def initialize( old_logger_do_not_use=nil )
+      if old_logger_do_not_use != nil
+         puts "*** depreciated API call [Fetcher.initialize] - do NOT pass in logger; no longer required/needed; logger arg will get removed"
+      end
     end
 
 
-## todo: add file protocol 
+    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?
+
+      response.body.dup  # return string copy
+    end
+
 
     def copy( src, dest )
-      logger.debug "fetch( src: #{src}, dest: #{dest} )"
+      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?
 
+      # check for content type; use 'wb' for images
+      if response.content_type =~ /image/
+        logger.debug '  switching to binary'
+        flags = 'wb'
+      else
+        flags = 'w'
+      end
+  
+      File.open( dest, flags ) do |f|
+        f.write( response.body )
+      end
+    end
+
+
+## todo: add file protocol 
+
+    def get_response( src )
       uri = URI.parse( src )
   
       # new code: honor proxy env variable HTTP_PROXY
@@ -72,25 +111,15 @@ module Fetcher
         else
           msg = "#{response.code} #{response.message}" 
           puts "*** error: #{msg}"
-          return   # todo: throw StandardException?  
+          return nil  # todo: throw StandardException?  
         end
       end
 
       logger.debug "  content_type: #{response.content_type}, content_length: #{response.content_length}"
-  
-      # check for content type; use 'wb' for images
-      if response.content_type =~ /image/
-        logger.debug '  switching to binary'
-        flags = 'wb'
-      else
-        flags = 'w'
-      end
-  
-      File.open( dest, flags ) do |f|
-        f.write( response.body )
-      end
+
+      response # return respone or nil if error
     end # method copy
 
   end # class Worker
 
-end  # module Fetcher
+end  # module Fetcher

metadata

@@ -1,61 +1,65 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: fetcher
-version: !ruby/object:Gem::Version 
-  hash: 27
-  prerelease: 
-  segments: 
-  - 0
-  - 1
-  - 0
-  version: 0.1.0
+version: !ruby/object:Gem::Version
+  version: 0.2.0
 platform: ruby
-authors: 
+authors:
 - Gerald Bauer
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-06-03 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: rdoc
+date: 2013-08-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: logutils
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :runtime
   prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 19
-        segments: 
-        - 3
-        - 10
-        version: "3.10"
+      - !ruby/object:Gem::Version
+        version: '4.0'
   type: :development
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: hoe
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 7
-        segments: 
-        - 3
-        - 0
-        version: "3.0"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: hoe
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.6'
   type: :development
-  version_requirements: *id002
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.6'
 description: fetcher - Fetch Text Documents or Binary Blobs via HTTP, HTTPS
 email: webslideshow@googlegroups.com
-executables: 
+executables:
 - fetch
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - Manifest.txt
-files: 
+files:
 - History.markdown
 - Manifest.txt
 - README.markdown
@@ -64,39 +68,30 @@ files:
 - lib/fetcher.rb
 - lib/fetcher/runner.rb
 - lib/fetcher/worker.rb
-homepage: http://geraldb.github.com/fetcher
-licenses: []
-
+homepage: https://github.com/geraldb/fetcher
+licenses:
+- Public Domain
+metadata: {}
 post_install_message: 
-rdoc_options: 
+rdoc_options:
 - --main
 - README.markdown
-require_paths: 
+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"
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: fetcher
-rubygems_version: 1.8.24
+rubygems_version: 2.0.6
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: fetcher - Fetch Text Documents or Binary Blobs via HTTP, HTTPS
 test_files: []
-