url 0.1.0.1 → 0.1.1

data/README.rdoc

@@ -2,8 +2,26 @@
 
 A simple url object to allow for object oriented based manipulation and usage of a url
 
+== Usage
 
-=== TODO
+=== Basic Usage
+
+You can easily extract or change any part of the url
+
+  url = URL.new('https://mail.google.com/mail/?shva=1#mbox')
+  url.params # => {:shva => '1'}
+  url.scheme # => 'https'
+  url.host   # => 'mail.google.com'
+  url.domain # => 'google.com'
+  url.subdomain # => ['mail']
+  url.path   # => '/mail/'
+  url.hash   # => 'mbox'
+  
+  url.subdomain = ['my','mail']
+  url.params[:foo] = 'bar'
+  url.to_s   # => 'https://my.mail.google.com/mail/?foo=bar&shva=1#mbox'
+
+== TODO
 * More Documentation
 * More specs
 

data/Rakefile

@@ -42,3 +42,12 @@ Rake::RDocTask.new do |rdoc|
   rdoc.rdoc_files.include('README*')
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
+
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new
+rescue LoadError
+  task :yardoc do
+    abort "YARD is not available. In order to run yardoc, you must: sudo gem install yard"
+  end
+end

data/VERSION.yml

@@ -1,5 +1,5 @@
 ---
 :major: 0
 :minor: 1
-:patch: 0
-:build: 1
+:patch: 1
+:build: 

data/lib/url.rb

@@ -55,6 +55,8 @@ class URL
   end
   
   # Outputs the full current url
+  # @param [Hash<Symbol,false>,#whatever] ops Prevent certain parts of the object from being shown by setting `:scheme`,`:port`,`:path`,`:params`, or `:hash` to `false`
+  # @return [String]
   def to_s ops={}
     ret = String.new
     ret << %{#{scheme}://} if scheme && ops[:scheme] != false
@@ -73,6 +75,7 @@ class URL
   end
   
   # Returns the parsed URI object for the string
+  # @return [URI]
   def to_uri
     URI.parse(to_s)
   end
@@ -86,24 +89,31 @@ class URL
   end
   
   # Performs a get request for the current URL
+  # @return [URL::Response] A subclass of string which also repsonds to a few added mthods storing more information
   def get(*args)
     req_handler.get(*args)
   end
   
   # Performs a post request for the current URL
+  # @return [URL::Response] A subclass of string which also repsonds to a few added mthods storing more information
   def post(*args)
     req_handler.post(*args)
   end
   
   # Performs a delete request for the current URL
+  # @return [URL::Response] A subclass of string which also repsonds to a few added mthods storing more information
   def delete(*args)
     req_handler.delete(*args)
   end
   
+  def inspect #:nodoc:
+    "#<URL #{to_s}>"
+  end
+  
   if defined?(Typhoeus)
-    self.req_handler = TyHandler
+    URL.req_handler = TyHandler
   else
-    self.req_handler = NetHandler
+    URL.req_handler = NetHandler
   end
 end
 

data/lib/url/handlers.rb

@@ -1,13 +1,13 @@
 class URL
   
-  class Handler #:nodoc: all
+  class Handler
     attr_reader :url
     def initialize(url)
       @url = url
     end
   end
   
-  class TyHandler < Handler #:nodoc: all
+  class TyHandler < Handler
     
     def get(args={})
       resp = Typhoeus::Request.get(url.to_s)
@@ -42,7 +42,7 @@ class URL
     
   end
   
-  class NetHandler < Handler #:nodoc: all
+  class NetHandler < Handler
     def get(args={})
       puts 'net'
       http = http_obj

data/lib/url/helper_classes.rb

@@ -2,7 +2,14 @@ require "delegate"
 
 class URL
   
-  class Response < DelegateClass(String) #:nodoc: all
+  # The Response class is a deleegate to string which also contains metadata about the request.
+  # These methods are also available
+  # * body
+  # * code - http code
+  # * response - the original response object from whatever handler you chose
+  # * time - time taken to make call
+  # * success? - whether the http code is 200
+  class Response < DelegateClass(String)
     attr_reader :body,:time,:code,:response
     def initialize(str,args={})
       if str.is_a?(Hash)

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: url
 version: !ruby/object:Gem::Version 
-  hash: 69
+  hash: 25
   prerelease: false
   segments: 
   - 0
   - 1
-  - 0
   - 1
-  version: 0.1.0.1
+  version: 0.1.1
 platform: ruby
 authors: 
 - Tal Atlas