lwr-simple 0.0.1

data/History.txt

@@ -0,0 +1,4 @@
+== 0.0.1 2009-01-03
+
+* 1 major enhancement:
+  * Initial release

data/Manifest.txt

@@ -0,0 +1,14 @@
+History.txt
+Manifest.txt
+PostInstall.txt
+README.rdoc
+Rakefile
+lib/lwr-simple.rb
+lwr-simple.gemspec
+script/console
+script/destroy
+script/generate
+spec/lwr-simple_spec.rb
+spec/spec.opts
+spec/spec_helper.rb
+tasks/rspec.rake

data/PostInstall.txt

@@ -0,0 +1,6 @@
+
+For more information on lwr-simple,
+  see http://lwr-simple.rubyforge.org
+  see http://github.com/yagihiro/lwr-simple/wikis
+
+

data/README.rdoc

@@ -0,0 +1,71 @@
+= lwr-simple
+
+LWR::Simple library is yet another LWP::Simple library for ruby.
+
+== SYNOPSIS:
+
+It is an interface that assumes the scene to which LWR::Simple is taken an active part by the one liner like begin so LWP::Simple, too.
+Its interface really looks like the LWP::Simple.
+
+  # example. 1
+  $ ruby -rlwr-simple -e 'getprint "http://www.sn.no"'
+
+  # example. 2
+  $ ruby -rlwr-simple -e 'get("http://www.ruby-lang.org/ja/").scan(/<a.*href="(.+?)"/) {|refs| puts(refs[0])}'
+
+
+== FEATURES:
+
+LWR::Simple library provides 5 methods in toplevel.
+* get(url)
+* head(url)
+* getprint(url)
+* getstore(url, file)
+* mirror(url, file)
+
+All methods looks like the LWP::Simple library. Please refer to rdoc for details.
+
+== REQUIREMENTS:
+
+Self operation capabilities on ruby 1.8.6 or more.
+Probably, it operates on ruby 1.8.3. (relation of dependence on "net/http" library.)
+
+== INSTALL:
+
+It is not possible to prepare it. It is only git for a while in now.
+Sorry...
+
+Install by git, see
+
+  git clone git://github.com/yagihiro/lwr-simple.git
+  cd lwr-simple
+  rake gem
+  rake install_gem
+
+== LICENSE:
+
+Copyright (c) 2008 Hiroki Yagita
+
+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.
+
+== AUTHOR:
+
+Hiroki Yagita <yagihiro@gmail.com>
+http://d.hatena.ne.jp/clayfish/

data/Rakefile

@@ -0,0 +1,28 @@
+%w[rubygems rake rake/clean fileutils newgem rubigen].each { |f| require f }
+require File.dirname(__FILE__) + '/lib/lwr-simple'
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.new('lwr-simple', LWR::Simple::VERSION) do |p|
+  p.developer('yagita', 'yagihiro@gmail.com')
+  p.changes              = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  p.post_install_message = 'PostInstall.txt' # TODO remove if post-install message not required
+  p.rubyforge_name       = p.name # TODO this is default value
+  # p.extra_deps         = [
+  #   ['activesupport','>= 2.0.2'],
+  # ]
+  p.extra_dev_deps = [
+    ['newgem', ">= #{::Newgem::VERSION}"]
+  ]
+
+  p.clean_globs |= %w[**/.DS_Store tmp *.log]
+  path = (p.rubyforge_name == p.name) ? p.rubyforge_name : "\#{p.rubyforge_name}/\#{p.name}"
+  p.remote_rdoc_dir = File.join(path.gsub(/^#{p.rubyforge_name}\/?/,''), 'rdoc')
+  p.rsync_args = '-av --delete --ignore-errors'
+end
+
+require 'newgem/tasks' # load /tasks/*.rake
+Dir['tasks/**/*.rake'].each { |t| load t }
+
+# TODO - want other tests/tasks run by default? Add them to the list
+# task :default => [:spec, :features]

data/lib/lwr-simple.rb

@@ -0,0 +1,155 @@
+#
+# = lwr-simple.rb
+#
+# LWR::Simple library is yet another LWP::Simple library for ruby.
+#
+# == SYNOPSIS:
+#
+# It is an interface that assumes the scene to which LWR::Simple is taken an active part by the one liner like begin so LWP::Simple, too.
+# Its interface really looks like the LWP::Simple.
+#
+# # example. 1
+# $ ruby -rlwr-simple -e 'getprint "http://www.sn.no"'
+#
+# # example. 2
+# $ ruby -rlwr-simple -e 'get("http://www.ruby-lang.org/ja/").scan(/<a.*href="(.+?)"/) {|refs| puts(refs[0])}'
+#
+# == FEATURES/PROBLEMS:
+#
+# See LWR::Simple module's documents.
+#
+# == LICENSE:
+#
+# Copyright (c) 2008 Hiroki Yagita
+#
+# 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.
+#
+
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+require "net/http"
+require "time"
+require "uri"
+
+module LWR                      # :nodoc:
+
+  # This module is extend toplevel.
+  # So, in your application, see below example code.
+  #
+  #   puts get("http://www.google.com/")
+  #   mirror("http://www.ruby-lang.org/images/logo.gif", "logo.gif") #=> save "logo.gif" as local file.
+  #
+  module Simple
+    VERSION = '0.0.1'
+
+   module_function
+
+    # Fetch a resource by the given +url+, and return the resource as String.
+    def get url
+      _get(to_uri(url)).body
+    rescue
+      nil
+    end
+
+    # Get document headers - [+content_type+, +document_length+, +modified_time+, +expires+, +server+]
+    def head url
+      uri = to_uri url
+      req = Net::HTTP::Get.new uri.path
+      res = Net::HTTP.start(uri.host, uri.port) {|http| http.request(req) }
+
+      # +modified_time+ value is  provisional it using +Date+ header.
+      [res.content_type, res.content_length, res["date"], res["expires"], res["server"]]
+    rescue
+      []
+    end
+
+    # Fetch and print a resource by the given +url+.
+    def getprint url
+      uri = to_uri url
+      res = _get uri
+      puts res.body
+      res.code.to_i
+    rescue
+      code = 404
+      unless res
+        $stderr.puts "#{url} is bad URL."
+      else
+        code = res.code.to_i
+        $stderr.puts "#{url} is bad URL(#{code})."
+      end
+      code
+    end
+
+    # Fetch a resource by the given +url+ and save to +file+.
+    def getstore url, file
+      uri = to_uri url
+      res = _get uri
+      _store file, res.body
+      res.code.to_i
+    rescue
+      res ? res.code.to_i : 404
+    end
+
+    # Mirror a local file and a remote file method.
+    #
+    # +url+:: request target url as String.
+    # +file+:: mirroring file path as String.
+    #
+    # return value is http responce code.
+    def mirror url, file
+      uri = to_uri url
+      req = Net::HTTP::Get.new uri.path
+      req["If-Modified-Since"] = FileTest.exist?(file) ? File.mtime(file).httpdate : Time.at(0).httpdate
+      res = Net::HTTP.start(uri.host, uri.port) {|http| http.request(req) }
+
+      # if +code+ is +http not modified+, fetch the url resource.
+      code = res.code.to_i
+      _store(file, _get(uri).body) unless code == 304
+
+      code
+    rescue
+      res ? res.code.to_i : 404
+    end
+
+    # only internal use.
+    def to_uri url
+      uri = URI.parse url
+      uri.path = "/" if uri.path.empty?
+      uri
+    end
+
+    # only internal use.
+    def _get uri
+      req = Net::HTTP::Get.new uri.path
+      res = Net::HTTP.start(uri.host, uri.port) {|http| http.request(req) }
+      res
+    end
+
+    # only internal use.
+    def _store path, s
+      File.open(path, "wb") {|f| f.write(s) }
+    end
+
+  end
+
+end
+
+# All LWR::Simple's methods extend to Object class.
+extend LWR::Simple

data/lwr-simple.gemspec

@@ -0,0 +1,38 @@
+Gem::Specification.new do |s|
+  s.name = %q{lwr-simple}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["yagita"]
+  s.cert_chain = ["/home/yagita/.gem/gem-public_cert.pem"]
+  s.date = %q{2009-01-03}
+  s.description = %q{It is an interface that assumes the scene to which LWR::Simple is taken an active part by the one liner like begin so LWP::Simple, too. Its interface really looks like the LWP::Simple.}
+  s.email = ["yagihiro@gmail.com"]
+  s.extra_rdoc_files = ["History.txt", "Manifest.txt", "PostInstall.txt", "README.rdoc"]
+  s.files = ["History.txt", "Manifest.txt", "PostInstall.txt", "README.rdoc", "Rakefile", "lib/lwr-simple.rb", "lwr-simple.gemspec", "script/console", "script/destroy", "script/generate", "spec/lwr-simple_spec.rb", "spec/spec.opts", "spec/spec_helper.rb", "tasks/rspec.rake"]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/yagihiro/lwr-simple/tree/master}
+  s.post_install_message = %q{PostInstall.txt}
+  s.rdoc_options = ["--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{lwr-simple}
+  s.rubygems_version = %q{1.2.0}
+  s.signing_key = %q{/home/yagita/.gem/gem-private_key.pem}
+  s.summary = %q{LWR::Simple library is yet another LWP::Simple library for ruby.}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if current_version >= 3 then
+      s.add_development_dependency(%q<newgem>, [">= 1.2.1"])
+      s.add_development_dependency(%q<hoe>, [">= 1.8.0"])
+    else
+      s.add_dependency(%q<newgem>, [">= 1.2.1"])
+      s.add_dependency(%q<hoe>, [">= 1.8.0"])
+    end
+  else
+    s.add_dependency(%q<newgem>, [">= 1.2.1"])
+    s.add_dependency(%q<hoe>, [">= 1.8.0"])
+  end
+end

data/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/lwr-simple.rb'}"
+puts "Loading lwr-simple gem"
+exec "#{irb} #{libs} --simple-prompt"

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)

data/spec/lwr-simple_spec.rb

@@ -0,0 +1,98 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+def successed? code
+  200 <= code and code < 400
+end
+
+# This spec quotes from the LWP::Simple documents.
+describe LWR::Simple do
+
+  describe "get()" do
+    it "should be going to fetch the document identified by the given URL and return it." do
+      doc = LWR::Simple.get("http://www.google.com/")
+      doc.should_not be_nil
+      doc.should_not be_empty
+      doc.should be_an_instance_of(String)
+      doc.should match(/google/)
+    end
+    it "should nil if this method fails." do
+      LWR::Simple.get("http://www.notexists.com/").should be_nil
+    end
+    it "should URL argument can be either a String's instance." do
+      LWR::Simple.get(nil).should be_nil
+      LWR::Simple.get(URI("http://www.google.com/")).should be_nil
+    end
+  end
+
+  describe "head()" do
+    it "should get document headers. Returns the following 5 values if successful: ($content_type, $document_length, $modified_time, $expires, $server)" do
+      h = LWR::Simple.head("http://www.google.com/")
+      h.should_not be_nil
+      h.should_not be_empty
+      h.should be_an_instance_of(Array)
+      h.should have(5).items
+    end
+    it "should returns an empty list if this method fails." do
+      LWR::Simple.head("http://www.notexists.com/").should have(0).items
+    end
+  end
+
+  describe "getprint()" do
+    before do
+      @stdout = $>
+      @stderr = $stderr
+    end
+    after do
+      $> = @stdout
+      $stderr = @stderr
+    end
+    it "should get and print a document identified by a URL. The document is printed to the selected default filehandle for output (normally STDOUT) as data is received from the network." do
+      m = mock("out")
+      m.should_receive(:write) do |arg|
+        # +arg+ is printed a document as String instance.
+        arg.should be_an_instance_of(String)
+        arg.should_not be_empty
+      end
+      $> = m
+      code = LWR::Simple.getprint("http://www.google.com/")
+      successed?(code).should be_true
+    end
+    it "should if the request fails, then the status code and message are printed on STDERR. The return value is the HTTP response code." do
+      m = mock("err")
+      m.should_receive(:write).any_number_of_times # $stderr object requires #write method. (In fact, it is not called.)
+      m.should_receive(:puts) do |arg|
+        # +arg+ is printed a document as String instance.
+        arg.should be_an_instance_of(String)
+        arg.should_not be_empty
+      end
+      $stderr = m
+      LWR::Simple.getprint("http://www.notexists.com/").should == 404
+    end
+  end
+
+  describe "getstore()" do
+    after do
+      File.delete("g.html") if FileTest.exist?("g.html")
+    end
+    it "should gets a document identified by a URL and stores it in the file. The return value is the HTTP response code." do
+      code = LWR::Simple.getstore("http://www.google.com/", "g.html")
+      File.open("g.html") {|f| f.read.should match(/google/) }
+      successed?(code).should be_true
+    end
+  end
+
+  describe "mirror()" do
+    after do
+      File.delete("logo.gif") if FileTest.exist?("logo.gif")
+    end
+    it "should get and store a document identified by a URL, using If-modified-since, and checking the Content-Length. Returns the HTTP response code." do
+      code = LWR::Simple.mirror("http://www.ruby-lang.org/images/logo.gif", "logo.gif")
+      FileTest.exist?("logo.gif").should be_true
+      successed?(code).should be_true
+      code = LWR::Simple.mirror("http://www.ruby-lang.org/images/logo.gif", "logo.gif")
+      FileTest.exist?("logo.gif").should be_true
+      successed?(code).should be_true
+    end
+  end
+
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--colour

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems'
+  gem 'rspec'
+  require 'spec'
+end
+
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+require 'lwr-simple'

data/tasks/rspec.rake

@@ -0,0 +1,21 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems'
+  require 'spec'
+end
+begin
+  require 'spec/rake/spectask'
+rescue LoadError
+  puts <<-EOS
+To use rspec for testing you must install rspec gem:
+    gem install rspec
+EOS
+  exit(0)
+end
+
+desc "Run the specs under spec/models"
+Spec::Rake::SpecTask.new do |t|
+  t.spec_opts = ['--options', "spec/spec.opts"]
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification 
+name: lwr-simple
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- yagita
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-01-03 00:00:00 +09:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: newgem
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.3
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.8.0
+    version: 
+description: ""
+email: 
+- yagihiro@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- PostInstall.txt
+- README.rdoc
+files: 
+- History.txt
+- Manifest.txt
+- PostInstall.txt
+- README.rdoc
+- Rakefile
+- lib/lwr-simple.rb
+- lwr-simple.gemspec
+- script/console
+- script/destroy
+- script/generate
+- spec/lwr-simple_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- tasks/rspec.rake
+has_rdoc: true
+homepage: LWR::Simple library is yet another LWP::Simple library for ruby.
+post_install_message: PostInstall.txt
+rdoc_options: 
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: lwr-simple
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: ""
+test_files: []
+