rpaste 0.0.9 → 0.1.0

data/History.txt

@@ -1,6 +1,19 @@
+== 0.1.0 / 2008-01-15
+
+* Renamed RPaste.http_agent to RPaste.web_agent.
+* Added RPaste.proxy to provide proxy settings for RPaste.open_uri and
+  RPaste.web_agent.
+* Renamed RPaste.open to RPaste.open_uri.
+* Added RPaste.open_page.
+* Added ResultSet#select, which returns a new ResultSet.
+* Added ResultSet#names, ResultSet#authors, NoPaste::ResultSet#dates,
+  NoPaste::ResultSet#syntaxes and NoPaste::ResultSet#descriptions.
+* Fixed a file-requirement typo in lib/rpaste/nopaste/result_set.rb.
+* Various typo fixes.
+
 == 0.0.9 / 2008-01-09
 
- * Initial release.
- * Supports NoPaste paste board.
- * Semi-support for PasteBin.
+* Initial release.
+* Supports NoPaste paste board.
+* Semi-support for PasteBin.
 

data/Manifest.txt

@@ -2,6 +2,7 @@ History.txt
 LICENSE.txt
 Manifest.txt
 README.txt
+TODO.txt
 Rakefile
 lib/rpaste.rb
 lib/rpaste/version.rb

data/README.txt

@@ -9,14 +9,15 @@ RPaste supports NoPaste and PasteBin.
 
 == FEATURES/PROBLEMS:
   
-* Supports posting and retrieving from NoPaste.
+* Supports posting and retrieving pastes from NoPaste.
 * Supports retrieving from PasteBin.
 * Provides HTTP access with custom User-Agent strings.
+* Provides proxy settings for HTTP access.
 
 == REQUIREMENTS:
 
 * Hpricot
-* Mechanize
+* WWW::Mechanize
 
 == INSTALL:
 

data/TODO.txt

@@ -0,0 +1,4 @@
+== 0.1.0
+
+* Add more examples to README.txt.
+

data/lib/rpaste/nopaste/metadata.rb

@@ -30,11 +30,10 @@ module RPaste
 
       #
       # Returns the NoPaste Paste object associated with the Metadata
-      # object. If _opts_ are given they will be used in accessing
-      # the NoPaste website.
+      # object.
       #
-      def paste(opts={})
-        Paste.paste(name,opts)
+      def paste
+        Paste.paste(name)
       end
 
       #

data/lib/rpaste/nopaste/nopaste.rb

@@ -6,48 +6,60 @@ require 'hpricot'
 
 module RPaste
   module NoPaste
+    # The NoPaste post URL
+    POST_URL = 'http://rafb.net/paste/index.html'
+
     #
     # Returns the list of all recent pastes on NoPaste. See Recent.get.
     #
-    def NoPaste.recent(opts={},&block)
-      Recent.get(opts,&block)
+    def NoPaste.recent(&block)
+      Recent.get(&block)
     end
 
     #
     # Retrieves the NoPaste Paste object associated with the specified
     # _name_. See Paste.paste.
     #
-    def NoPaste.paste(name,opts={})
-      Paste.paste(name,opts)
+    def NoPaste.paste(name)
+      Paste.paste(name)
     end
 
     #
-    # Submits a new paste to NoPaste. If a _block_ is given, then it will be
-    # passed the Paste object before it is submitted to NoPaste.
+    # Submits a new paste to NoPaste with the specified _options_.
+    # If a _block_ is given, then it will be passed the Paste object
+    # before it is submitted to NoPaste.
+    #
+    # _options_ may contain the following keys:
+    # <tt>:author</tt>:: The author of the paste.
+    # <tt>:syntax</tt>:: The syntax of the paste.
+    # <tt>:description</tt>:: The description for the paste.
+    # <tt>:text</tt>:: The text to paste.
+    # <tt>:convert_tabs</tt>:: Indicates that tabs will be converted to
+    #                          spaces.
     #
     #   NoPaste.post(:author => 'briefcase man') do |paste|
     #     paste.description = 'todays key'
     #     paste.text = 'is brought to you by the letter S, for symmetric'
     #   end
     #
-    def NoPaste.post(opts={},&block)
-      author = opts[:author]
-      syntax = opts[:syntax]
-      description = opts[:description]
-      text = opts[:text]
+    def NoPaste.post(options={},&block)
+      author = options[:author]
+      syntax = options[:syntax]
+      description = options[:description]
+      text = options[:text]
 
       paste = Paste.new(nil,author,nil,syntax,description,text,&block)
 
-      agent = RPaste.http_agent(opts)
-      page = agent.get('http://rafb.net/paste/index.html')
+      agent = RPaste.web_agent
+      page = agent.get(POST_URL)
       form = page.forms.first
 
       form.lang = paste.syntax if paste.syntax
       form.nick = paste.author if paste.author
       form.desc = paste.description if paste.description
 
-      if opts[:convert_tabs]
-        form.cvt_tabs = opts[:convert_tabs]
+      if options[:convert_tabs]
+        form.cvt_tabs = options[:convert_tabs]
       end
 
       form.text = paste.text

data/lib/rpaste/nopaste/paste.rb

@@ -31,11 +31,10 @@ module RPaste
 
       #
       # Retrieves the NoPaste Paste object associated with the specified
-      # _name_. If _opts_ are given they will be used in accessing the
-      # NoPaste website.
+      # _name_.
       #
-      def self.paste(name,opts={})
-        page = Hpricot(RPaste.open("#{PREFIX_URL}#{name}.html",opts))
+      def self.paste(name)
+        page = RPaste.open_page("#{PREFIX_URL}#{name}.html")
 
         return Paste.new(name) do |paste|
           paste.syntax = page.search('//table[1]/tr[1]/td/small/b[1]').inner_text

data/lib/rpaste/nopaste/recent.rb

@@ -10,12 +10,15 @@ module RPaste
       URL = 'http://www.rafb.net/paste/results.html'
 
       #
-      # Returns the list of recent pastes on NoPaste. If _opts_ are
+      # Returns the list of recent pastes on NoPaste. If _options_ are
       # given they will be used in accessing the NoPaste website. If a
       # _block_ is given, it will be passed the list of recent pastes.
       #
-      def self.get(opts={},&block)
-        len = opts[:length]
+      # _options_ may also contain the following keys:
+      # <tt>:length</tt>:: The maximum number of results to return.
+      #
+      def self.get(options={},&block)
+        len = options[:length]
 
         if len.nil? || len==0
           len = -1
@@ -23,7 +26,7 @@ module RPaste
           len = len.to_i+1
         end
 
-        page = Hpricot(RPaste.open(URL,opts))
+        page = RPaste.open_page(URL,options)
         rows = page.search('//div.filelist/table/tr')[1..len]
 
         metadata = rows.map do |row|

data/lib/rpaste/nopaste/result_set.rb

@@ -1,10 +1,31 @@
 require 'rpaste/nopaste/metadata'
-require 'rpaste/resultset'
+require 'rpaste/result_set'
 
 module RPaste
   module NoPaste
     class ResultSet < RPaste::ResultSet
 
+      #
+      # Returns an +Array+ containing the metadata dates.
+      #
+      def dates
+        self.map { |data| data.date }
+      end
+
+      #
+      # Returns an +Array+ containing the metadata syntaxes.
+      #
+      def syntaxes
+        self.map { |data| data.syntax }
+      end
+
+      #
+      # Returns an +Array+ containing the metadata descriptions.
+      #
+      def descriptions
+        self.map { |data| data.description }
+      end
+
       #
       # Selects the metadata with dates in between _start_ and _stop_.
       #

data/lib/rpaste/pastebin/paste.rb

@@ -30,15 +30,14 @@ module RPaste
 
       #
       # Retrieves the PasteBin Paste object associated with the specified
-      # _name_. If _opts_ is given they will be used in accessing the
-      # PasteBin website.
+      # _name_.
       #
-      def self.paste(name,opts={})
-        page = Hpricot(RPaste.open("#{PREFIX_URL}#{name}",opts))
+      def self.paste(name)
+        page = RPaste.open_page("#{PREFIX_URL}#{name}")
 
         return Paste.new(name) do |paste|
           paste.text = page.search('//div.text/ol/li').inner_text
-          paste.author = page.search('#content/h1[1]'.inner_text.gsub(/Posted by /,'').split(' on ')
+          paste.author = page.search('#content/h1[1]').inner_text.gsub(/Posted by /,'').split(' on ')
         end
       end
 

data/lib/rpaste/pastebin/pastebin.rb

@@ -6,16 +6,28 @@ require 'hpricot'
 
 module RPaste
   module PasteBin
+    # The PasteBin post URL
+    POST_URL = 'http://pastebin.com/pastebin.php'
+
     #
     # Returns the list of all recent pastes on PasteBin. See Recent.get.
     #
-    def PasteBin.recent(opts={},&block)
-      Recent.get(opts,&block)
+    def PasteBin.recent(options={},&block)
+      Recent.get(options,&block)
     end
 
     #
-    # Submits a new paste to PasteBin. If a _block_ is given, then it will be
-    # passed the Paste object before it is submitted to PasteBin.
+    # Submits a new paste to PasteBin with the given _options_. If a
+    # _block_ is given, then it will be passed the Paste object before
+    # it is submitted to PasteBin.
+    #
+    # _options_ may contain the following keys:
+    # <tt>:author</tt>:: The author of the paste.
+    # <tt>:syntax</tt>:: The syntax of the paste.
+    # <tt>:retained</tt>:: Indicates when the paste should expire,
+    #                      which can be either <tt>:day</tt>,
+    #                      <tt>:month</tt> or <tt>:year</tt>.
+    # <tt>:text</tt>:: The text to paste.
     #
     #   PasteBin.post(:author => 'xyz') do |paste|
     #     paste.description = 'test'
@@ -28,11 +40,16 @@ module RPaste
     #     }
     #   end
     #
-    def PasteBin.post(opts={},&block)
-      paste = Paste.new(opts,&block)
+    def PasteBin.post(options={},&block)
+      author = options[:author]
+      syntax = options[:syntax]
+      retained = options[:retained]
+      text = options[:text]
+
+      paste = Paste.new(nil,author,nil,syntax,retained,text,&block)
 
-      agent = RPaste.http_agent(opts)
-      page = agent.get('http://pastebin.com/pastebin.php')
+      agent = RPaste.web_agent
+      page = agent.get(POST_URL)
       form = page.forms.first
 
       form.format = paste.syntax if paste.syntax

data/lib/rpaste/pastebin/recent.rb

@@ -12,12 +12,15 @@ module RPaste
       MAX_LENGTH = 10
 
       #
-      # Returns the list of recent pastes on PasteBin. If _opts_ are
+      # Returns the list of recent pastes on PasteBin. If _options_ are
       # given they will be used in accessing the PasteBin website. If a
       # _block_ is given, it will be passed the list of recent pastes.
       #
-      def self.get(opts={},&block)
-        len = opts[:length]
+      # _options_ may also contain the following keys:
+      # <tt>:length</tt>:: The maximum number of results to return.
+      #
+      def self.get(options={},&block)
+        len = options[:length]
 
         if (len.nil? || len>MAX_LENGTH)
           len = MAX_LENGTH
@@ -25,7 +28,7 @@ module RPaste
           len = len.to_i
         end
 
-        page = Hpricot(RPaste.open(URL,opts))
+        page = RPaste.open_page(URL,options))
         rows = page.search('#menu/ul/li')[0...len]
 
         metadata = rows.map do |row|

data/lib/rpaste/result_set.rb

@@ -10,6 +10,29 @@ module RPaste
       super(results,&block)
     end
 
+    #
+    # Selects the metadata which match the given _block_.
+    #
+    #   results.select { |result| result.date > Time.today }
+    #
+    def select(&block)
+      self.class.new(super(&block))
+    end
+
+    #
+    # Returns an +Array+ containing the metadata names.
+    #
+    def names
+      self.map { |data| data.name }
+    end
+
+    #
+    # Returns an +Array+ containing the metadata authors.
+    #
+    def authors
+      self.map { |data| data.author }
+    end
+
     #
     # Selects metadata with the matching _name_.
     #

data/lib/rpaste/rpaste.rb

@@ -2,30 +2,79 @@ require 'mechanize'
 require 'open-uri'
 
 module RPaste
+  # Common proxy port.
+  COMMON_PROXY_PORT = 8080
+
+  #
+  # Returns the +Hash+ of proxy information.
+  #
+  def RPaste.proxy
+    @@rpaste_proxy ||= {:host => nil, :port => COMMON_PROXY_PORT, :user => nil, :pass => nil}
+  end
+
+  #
+  # Creates a HTTP URI based from the given _proxy_info_ +Hash+. The
+  # _proxy_info_ hash defaults to Web.proxy, if not given.
+  #
+  # _proxy_info_ may contain the following keys:
+  # <tt>:host</tt>:: The proxy host.
+  # <tt>:port</tt>:: The proxy port. Defaults to COMMON_PROXY_PORT,
+  #                  if not specified.
+  # <tt>:user</tt>:: The user-name to login as.
+  # <tt>:password</tt>:: The password to login with.
   #
-  # Returns the RPaste user-agent
+  def RPaste.proxy_uri(proxy_info=RPaste.proxy)
+    if RPaste.proxy[:host]
+      return URI::HTTP.build(:host => RPaste.proxy[:host],
+                             :port => RPaste.proxy[:port] || COMMON_PROXY_PORT,
+                             :userinfo => "#{RPaste.proxy[:user]}:#{RPaste.proxy[:password]}",
+                             :path => '/')
+    end
+  end
+  
+  #
+  # Returns the supported Web User-Agent Aliases.
+  #
+  def RPaste.user_agent_aliases
+    WWW::Mechanize::AGENT_ALIASES
+  end
+
+  #
+  # Returns the RPaste User-Agent
   #
   def RPaste.user_agent
-    @user_agent
+    @@rpaste_user_agent ||= nil
   end
 
   #
   # Sets the RPaste user-agent to the specified _agent_.
   #
   def RPaste.user_agent=(agent)
-    @user_agent = agent
+    @@rpaste_user_agent = agent
   end
 
   #
-  # Opens the _uri_ with the given _opts_. The contents of the _uri_ will
-  # be returned.
+  # Opens the _uri_ with the given _options_. The contents of the _uri_
+  # will be returned.
+  #
+  # _options_ may contain the following keys:
+  # <tt>:user_agent_alias</tt>:: The User-Agent Alias to use.
+  # <tt>:user_agent</tt>:: The User-Agent String to use.
+  # <tt>:proxy</tt>:: A +Hash+ of proxy information which may
+  #                   contain the following keys:
+  #                   <tt>:host</tt>:: The proxy host.
+  #                   <tt>:port</tt>:: The proxy port.
+  #                   <tt>:user</tt>:: The user-name to login as.
+  #                   <tt>:password</tt>:: The password to login with.
+  #
+  #   RPaste.open_uri('http://www.hackety.org/')
   #
-  #   RPaste.open('http://www.hackety.org/')
-  #   RPaste.open('http://tenderlovemaking.com/',
+  #   RPaste.open_uri('http://tenderlovemaking.com/',
   #     :user_agent_alias => 'Linux Mozilla')
-  #   RPaste.open('http://www.wired.com/', :user_agent => 'the future')
+  #   RPaste.open_uri('http://www.wired.com/',
+  #     :user_agent => 'the future')
   #
-  def RPaste.open(uri,opts={})
+  def RPaste.open_uri(uri,options={})
     headers = {}
 
     if opts[:user_agent_alias]
@@ -36,17 +85,39 @@ module RPaste
       headers['User-Agent'] = RPaste.user_agent
     end
 
+    proxy = (options[:proxy] || GScraper.proxy)
+    if proxy[:host]
+      headers[:proxy] = GScraper.proxy_uri(proxy)
+    end
+
     return Kernel.open(uri,headers)
   end
 
   #
-  # Creates a new Mechanize agent with the given _opts_.
+  # Similar to RPaste.open_uri but returns an Hpricot document.
+  #
+  def RPaste.open_page(uri,options={})
+    Hpricot(RPaste.open_uri(uri,options))
+  end
+
+  #
+  # Creates a new Mechanize agent with the given _options_.
   #
-  #   RPaste.http_agent
-  #   RPaste.http_agent(:user_agent_alias => 'Linux Mozilla')
-  #   RPaste.http_agent(:user_agent => 'wooden pants')
+  # _options_ may contain the following keys:
+  # <tt>:user_agent_alias</tt>:: The User-Agent Alias to use.
+  # <tt>:user_agent</tt>:: The User-Agent String to use.
+  # <tt>:proxy</tt>:: A +Hash+ of proxy information which may
+  #                   contain the following keys:
+  #                   <tt>:host</tt>:: The proxy host.
+  #                   <tt>:port</tt>:: The proxy port.
+  #                   <tt>:user</tt>:: The user-name to login as.
+  #                   <tt>:password</tt>:: The password to login with.
   #
-  def RPaste.http_agent(opts={})
+  #   RPaste.web_agent
+  #   RPaste.web_agent(:user_agent_alias => 'Linux Mozilla')
+  #   RPaste.web_agent(:user_agent => 'wooden pants')
+  #
+  def RPaste.web_agent(options={})
     agent = WWW::Mechanize.new
 
     if opts[:user_agent_alias]
@@ -57,6 +128,11 @@ module RPaste
       agent.user_agent = RPaste.user_agent
     end
 
+    proxy = (options[:proxy] || GScraper.proxy)
+    if proxy[:host]
+      agent.set_proxy(proxy[:host],proxy[:port],proxy[:user],proxy[:password])
+    end
+
     return agent
   end
 end

data/lib/rpaste/version.rb

@@ -1,3 +1,3 @@
 module RPaste
-  VERSION = '0.0.9'
+  VERSION = '0.1.0'
 end

metadata

@@ -1,38 +1,62 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.9.4
-specification_version: 1
 name: rpaste
 version: !ruby/object:Gem::Version 
-  version: 0.0.9
-date: 2008-01-09 00:00:00 -08:00
-summary: RPaste provides access to many of the online paste services
-require_paths: 
-- lib
-email: postmodern.mod3@gmail.com
-homepage: "    by Postmodern Modulus III"
-rubyforge_project: rpaste
-description: "== FEATURES/PROBLEMS:  * Supports posting and retrieving from NoPaste. * Supports retrieving from PasteBin. * Provides HTTP access with custom User-Agent strings.  == REQUIREMENTS:  * Hpricot * Mechanize  == INSTALL:"
-autorequire: 
-default_executable: 
-bindir: bin
-has_rdoc: true
-required_ruby_version: !ruby/object:Gem::Version::Requirement 
-  requirements: 
-  - - ">"
-    - !ruby/object:Gem::Version 
-      version: 0.0.0
-  version: 
+  version: 0.1.0
 platform: ruby
-signing_key: 
-cert_chain: 
-post_install_message: 
 authors: 
 - Postmodern Modulus III
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-03-15 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hpricot
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: mechanize
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.5.1
+    version: 
+description: "== FEATURES/PROBLEMS:  * Supports posting and retrieving pastes from NoPaste. * Supports retrieving from PasteBin. * Provides HTTP access with custom User-Agent strings. * Provides proxy settings for HTTP access.  == REQUIREMENTS:  * Hpricot * WWW::Mechanize  == INSTALL:"
+email: postmodern.mod3@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- LICENSE.txt
+- Manifest.txt
+- README.txt
+- TODO.txt
 files: 
 - History.txt
 - LICENSE.txt
 - Manifest.txt
 - README.txt
+- TODO.txt
 - Rakefile
 - lib/rpaste.rb
 - lib/rpaste/version.rb
@@ -53,47 +77,32 @@ files:
 - lib/rpaste/pastebin/pastebin.rb
 - lib/rpaste/pastebin.rb
 - test/test_rpaste.rb
-test_files: 
-- test/test_rpaste.rb
+has_rdoc: true
+homepage: "    by Postmodern Modulus III"
+post_install_message: 
 rdoc_options: 
 - --main
 - README.txt
-extra_rdoc_files: 
-- History.txt
-- LICENSE.txt
-- Manifest.txt
-- README.txt
-executables: []
-
-extensions: []
-
+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: []
 
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: hpricot
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Version::Requirement 
-    requirements: 
-    - - ">"
-      - !ruby/object:Gem::Version 
-        version: 0.0.0
-    version: 
-- !ruby/object:Gem::Dependency 
-  name: mechanize
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Version::Requirement 
-    requirements: 
-    - - ">"
-      - !ruby/object:Gem::Version 
-        version: 0.0.0
-    version: 
-- !ruby/object:Gem::Dependency 
-  name: hoe
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Version::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: 1.4.0
-    version: 
+rubyforge_project: rpaste
+rubygems_version: 1.0.1
+signing_key: 
+specification_version: 2
+summary: RPaste provides access to many of the online paste services
+test_files: 
+- test/test_rpaste.rb