nap 0.4 → 0.5

data/README.md

@@ -0,0 +1,30 @@
+# Nap
+
+It be an extremely simple REST library, yo!
+
+## Example
+
+    gem 'nap'
+    require 'rest'
+    require 'json'
+    
+    response = REST.get('http://twitter.com/statuses/friends_timeline.json', {},
+      {:username => '_evan', :password => 'buttonscat'}
+    )
+    if response.ok?
+      timeline = JSON.parse(response.body)
+      puts(timeline.map do |item|
+        "#{item['user']['name']}\n\n#{item['text']}"
+      end.join("\n\n--\n\n"))
+    elsif response.forbidden?
+      puts "Are you sure you're `_evan' and your password is the name of your cat?"
+    else
+      puts "Something went wrong (#{response.status_code})"
+      puts response.body
+    end
+
+## Proxy support
+
+To enable the proxy settings in Nap, you can either use the HTTP\_PROXY or http\_proxy enviroment variable.
+
+    $ env HTTP_PROXY=http://rob:secret@192.167.1.254:665 ruby app.rb

data/lib/rest.rb

@@ -3,6 +3,9 @@ require 'uri'
 # REST is basically a convenience wrapper around Net::HTTP. It defines a simple and consistant API for doing REST-style
 # HTTP calls.
 module REST
+  # Raised when the remote server disconnects when reading the response
+  class DisconnectedError < StandardError; end
+  
   # Performs a HEAD on a resource. See REST::Request.new for a complete discussion of options.
   #
   #   response = REST.get('http://example.com/pigeons/12',

data/lib/rest/request.rb

@@ -44,19 +44,19 @@ module REST
     # == TLS / SSL examples
     #
     #   # Use a client key and certificate
-    #   request = REST::Request.new(:get, URI.parse('https://example.com/pigeons/1'), {}, {}, {
+    #   request = REST::Request.new(:get, URI.parse('https://example.com/pigeons/1'), nil, {}, {
     #     :tls_key_and_certificate_file => '/home/alice/keys/example.pem'
     #   })
     #
     #   # Use a client certificate and key from a specific location
     #   key_and_certificate = File.read('/home/alice/keys/example.pem')
-    #   request = REST::Request.new(:get, URI.parse('https://example.com/pigeons/1'), {}, {}, {
+    #   request = REST::Request.new(:get, URI.parse('https://example.com/pigeons/1'), nil, {}, {
     #     :tls_key => OpenSSL::PKey::RSA.new(key_and_certificate),
     #     :tls_certificate => OpenSSL::X509::Certificate.new(key_and_certificate)
     #   })
     #
     #   # Verify the server certificate against a specific certificate
-    #   request = REST::Request.new(:get, URI.parse('https://example.com/pigeons/1'), {}, {}, {
+    #   request = REST::Request.new(:get, URI.parse('https://example.com/pigeons/1'), nil, {}, {
     #     :tls_verify => true,
     #     :tls_ca_file => '/home/alice/keys/example.pem'
     #   })
@@ -73,6 +73,26 @@ module REST
       [url.path, url.query].compact.join('?')
     end
     
+    def http_proxy
+      ENV['HTTP_PROXY'] || ENV['http_proxy']
+    end
+    
+    def proxy_settings
+      http_proxy ? URI.parse(http_proxy) : nil
+    end
+    
+    def proxy
+      @proxy ||= Net::HTTP.Proxy(proxy_settings.host, proxy_settings.port, proxy_settings.user, proxy_settings.password)
+    end
+    
+    def http_request
+      if proxy_settings
+        proxy.new(url.host, url.port)
+      else
+        Net::HTTP.new(url.host, url.port)
+      end
+    end
+    
     # Performs the actual request and returns a REST::Response object with the response
     def perform
       case verb
@@ -95,8 +115,8 @@ module REST
       if options[:username] and options[:password]
         request.basic_auth(options[:username], options[:password])
       end
-            
-      http_request = Net::HTTP.new(url.host, url.port)
+      
+      http_request = http_request()
       
       # enable SSL/TLS
       if url.scheme == 'https'
@@ -130,7 +150,11 @@ module REST
         end
       end
       
-      response = http_request.start { |http| http.request(request) }
+      begin
+        response = http_request.start { |http| http.request(request) }
+      rescue EOFError => error
+        raise REST::DisconnectedError, error.message
+      end
       REST::Response.new(response.code, response.instance_variable_get('@header'), response.body)
     end
     

metadata

@@ -1,7 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: nap
 version: !ruby/object:Gem::Version 
-  version: "0.4"
+  hash: 1
+  prerelease: 
+  segments: 
+  - 0
+  - 5
+  version: "0.5"
 platform: ruby
 authors: 
 - Manfred Stienstra
@@ -9,27 +14,66 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-06-03 00:00:00 +02:00
-default_executable: 
-dependencies: []
-
-description: "    Nap is a really simple REST API.\n"
+date: 2012-03-12 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: test-spec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+description: "    Nap is a really simple REST library. It allows you to perform HTTP requests\n    with minimal amounts of code.\n"
 email: manfred@fngtps.com
 executables: []
 
 extensions: []
 
 extra_rdoc_files: 
-- README
+- README.md
 - LICENSE
 files: 
 - lib/rest.rb
 - lib/rest/request.rb
 - lib/rest/response.rb
 - support/cacert.pem
-- README
+- README.md
 - LICENSE
-has_rdoc: true
 homepage: 
 licenses: []
 
@@ -39,23 +83,29 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.8.18
 signing_key: 
 specification_version: 3
-summary: Nap is a really simple REST API.
+summary: Nap is a really simple REST library.
 test_files: []
 

data/README

@@ -1,24 +0,0 @@
-= Nap
-
-It be an extremely simple REST library, yo!
-
-== Example
-
-  gem 'nap'
-  require 'rest'
-  require 'json'
-  
-  response = REST.get('http://twitter.com/statuses/friends_timeline.json', {},
-    {:username => '_evan', :password => 'buttonscat'}
-  )
-  if response.ok?
-    timeline = JSON.parse(response.body)
-    puts(timeline.map do |item|
-      "#{item['user']['name']}\n\n#{item['text']}"
-    end.join("\n\n--\n\n"))
-  elsif response.forbidden?
-    puts "Are you sure you're `_evan' and your password is the name of your cat?"
-  else
-    puts "Something went wrong (#{response.status_code})"
-    puts response.body
-  end