nap 0.6.0 → 0.7.0pre0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5f7dc30c90be3d31f7cee006082d494ac5624471
-  data.tar.gz: 5e59d78e97e2bce1b2dd89c45d248d62583b6dd5
+  metadata.gz: a5527a10413e8432aea9467adfb300646dea6be3
+  data.tar.gz: 2398375fc37518cc416a744b5663d25fc7e708ed
 SHA512:
-  metadata.gz: 56226f0615470f7d34eadd68cee959259d93d97f1514f1545990a432bde9e6a66cb206bd70794409316c13676aee4d85eb4a5f5c49521e7aacd0670533bdfa40
-  data.tar.gz: 65780d4dc852035efd5271264994027d7812a3617d8c460dc2fa340ccc8b079df4d18bbe7e759fd7db9f088f3fc520b57c614e37b1841d4927434346b8dc8b59
+  metadata.gz: e7eb50aa2b3f1d0a32576ceb0139f6dd6060230d31c7d5424bddad3d45d59c0ab88f103303cce82c142d1591d9ff3ff9b218bbe00aba98ff84a26f00eb89496a
+  data.tar.gz: 7dd407ee2b0b4d9008f4eb879e71f87f2dd47047d0ce0eeabaa46622a1711dd63169a64889aa0b840718dffbac67bc752c0fa813d990b0977cf7040b1a59ec65

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2013 Manfred Stienstra, Fingertips <manfred@fngtps.com>
+Copyright (c) 2014 Manfred Stienstra, Fingertips <manfred@fngtps.com>
 
 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

data/README.md

@@ -1,6 +1,7 @@
 # Nap
 
-It be an extremely simple REST library, yo!
+Nap is an extremely simple REST client for Ruby. It was built to quickly
+fire off HTTP requests without having to research net/http internals.
 
 ## Example
 
@@ -23,8 +24,26 @@ It be an extremely simple REST library, yo!
       puts response.body
     end
 
+## Advanced request configuration
+
+If you need more control over the Net::HTTP request you can pass a block to
+all of the request methods. 
+
+    response = REST.get('http://google.com') do |http_request|
+      http_request.open_timeout = 15
+      http_request.set_debug_output(STDERR)
+    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
+    $ env HTTP_PROXY=http://rob:secret@192.167.1.254:665 ruby app.rb
+
+## Contributions
+
+Nap couldn't be the shining beacon in the eternal darkness without help from:
+
+* Eloy Durán
+* Joshua Sierles
+* Thijs van der Vossen

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
+  # Library version
+  VERSION = '0.7.0pre0'
+  
   # Raised when the remote server disconnects when reading the response
   class DisconnectedError < StandardError; end
   
@@ -17,8 +20,8 @@ module REST
   #   else
   #     puts "Couldn't fetch your pigeon (#{response.status_code})"
   #   end
-  def self.get(uri, headers={}, options={})
-    REST::Request.perform(:get, URI.parse(uri), nil, headers, options)
+  def self.get(uri, headers={}, options={}, &configure_block)
+    REST::Request.perform(:get, URI.parse(uri), nil, headers, options, &configure_block)
   end
   
   # Performs a HEAD on a resource. See REST::Request.new for a complete discussion of options.
@@ -31,8 +34,8 @@ module REST
   #   else
   #     puts "Couldn't fetch your pigeon (#{response.status_code})"
   #   end
-  def self.head(uri, headers={}, options={})
-    REST::Request.perform(:head, URI.parse(uri), nil, headers, options)
+  def self.head(uri, headers={}, options={}, &configure_block)
+    REST::Request.perform(:head, URI.parse(uri), nil, headers, options, &configure_block)
   end
 
   # Performs a DELETE on a resource. See REST::Request.new for a complete discussion of options.
@@ -45,8 +48,8 @@ module REST
   #   else
   #     puts "Couldn't delete your pigeon (#{response.status_code})"
   #   end
-  def self.delete(uri, headers={}, options={})
-    REST::Request.perform(:delete, URI.parse(uri), nil, headers, options)
+  def self.delete(uri, headers={}, options={}, &configure_block)
+    REST::Request.perform(:delete, URI.parse(uri), nil, headers, options, &configure_block)
   end
   
   # Performs a PATCH on a resource. See REST::Request.new for a complete discussion of options.
@@ -61,8 +64,8 @@ module REST
   #     puts "Couldn't rename your pigeon (#{response.status_code})"
   #     puts XML.parse(response.body).reason
   #   end
-  def self.patch(uri, body, headers={}, options={})
-    REST::Request.perform(:patch, URI.parse(uri), body, headers, options)
+  def self.patch(uri, body, headers={}, options={}, &configure_block)
+    REST::Request.perform(:patch, URI.parse(uri), body, headers, options, &configure_block)
   end
   
   # Performs a PUT on a resource. See REST::Request.new for a complete discussion of options.
@@ -77,8 +80,8 @@ module REST
   #     puts "Couldn't replace your pigeon (#{response.status_code})"
   #     puts XML.parse(response.body).reason
   #   end
-  def self.put(uri, body, headers={}, options={})
-    REST::Request.perform(:put, URI.parse(uri), body, headers, options)
+  def self.put(uri, body, headers={}, options={}, &configure_block)
+    REST::Request.perform(:put, URI.parse(uri), body, headers, options, &configure_block)
   end
   
   # Performs a POST on a resource. See REST::Request.new for a complete discussion of options.
@@ -93,8 +96,8 @@ module REST
   #     puts "Couldn't create your pigeon (#{response.status_code})"
   #     puts XML.parse(response.body).reason
   #   end
-  def self.post(uri, body, headers={}, options={})
-    REST::Request.perform(:post, URI.parse(uri), body, headers, options)
+  def self.post(uri, body, headers={}, options={}, &configure_block)
+    REST::Request.perform(:post, URI.parse(uri), body, headers, options, &configure_block)
   end
 end
 

data/lib/rest/request.rb

@@ -16,9 +16,12 @@ module REST
     #   * <tt>tls_verify/verify_ssl</tt>: Verify the server certificate against known CA's
     #   * <tt>tls_ca_file</tt>: Use a specific file for CA certificates instead of the built-in one
     #     this only works when <tt>:tls_verify</tt> is also set.
-    #   * <tt>tls_key_and_certificate_file</tt>: The client key and certificate file to use for this request
+    #   * <tt>tls_key_and_certificate_file</tt>: The client key and certificate file to use for this
+    #     request
     #   * <tt>tls_certificate</tt>: The client certficate to use for this request
     #   * <tt>tls_key</tt>: The client private key to use for this request
+    # * <tt>configure_block</tt>: An optional block that yields the underlying <tt>Net::HTTP</tt>
+    #   request object allowing for more fine-grained configuration
     #
     # == Examples
     #
@@ -32,6 +35,11 @@ module REST
     #     {'Accept' => 'application/json, */*', 'Content-Type' => 'application/json; charset=utf-8'}
     #   )
     #
+    #   # Pass a block to configure the underlying +Net::HTTP+ request.
+    #   request = REST::Request.new(:get, URI.parse('http://example.com/pigeons/largest')) do |http_request|
+    #     http_request.open_timeout = 15 # seconds
+    #   end
+    #
     # == Authentication example
     #
     #   request = REST::Request.new(:put,
@@ -60,12 +68,13 @@ module REST
     #     :tls_verify => true,
     #     :tls_ca_file => '/home/alice/keys/example.pem'
     #   })
-    def initialize(verb, url, body=nil, headers={}, options={})
+    def initialize(verb, url, body=nil, headers={}, options={}, &configure_block)
       @verb = verb
       @url = url
       @body = body
       @headers = headers
       @options = options
+      @configure_block = configure_block
     end
     
     # Returns the path (including the query) for the request
@@ -90,42 +99,14 @@ module REST
       end
     end
     
+    # Configures and returns a new <tt>Net::HTTP</tt> request object
     def http_request
       if http_proxy
-        http_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
-      when :get
-        self.request = Net::HTTP::Get.new(path, headers)
-      when :head
-        self.request = Net::HTTP::Head.new(path, headers)
-      when :delete
-        self.request = Net::HTTP::Delete.new(path, headers)
-      when :patch
-        self.request = Net::HTTP::Patch.new(path, headers)
-        self.request.body = body
-      when :put
-        self.request = Net::HTTP::Put.new(path, headers)
-        self.request.body = body
-      when :post
-        self.request = Net::HTTP::Post.new(path, headers)
-        self.request.body = body
+        http_request = http_proxy.new(url.host, url.port)
       else
-        raise ArgumentError, "Unknown HTTP verb `#{verb}'"
+        http_request = Net::HTTP.new(url.host, url.port)
       end
       
-      if options[:username] and options[:password]
-        request.basic_auth(options[:username], options[:password])
-      end
-      
-      http_request = http_request()
-      
       # enable SSL/TLS
       if url.scheme == 'https'
         require 'net/https'
@@ -158,6 +139,50 @@ module REST
         end
       end
       
+      if @configure_block
+        @configure_block.call(http_request)
+      end
+      
+      http_request
+    end
+    
+    def request_for_verb
+      case verb
+      when :get
+        Net::HTTP::Get.new(path, headers)
+      when :head
+        Net::HTTP::Head.new(path, headers)
+      when :delete
+        Net::HTTP::Delete.new(path, headers)
+      when :patch
+        if defined?(Net::HTTP::Patch)
+          Net::HTTP::Patch.new(path, headers)
+        else
+          raise ArgumentError, "This version of the Ruby standard library doesn't support PATCH"
+        end
+      when :put
+        Net::HTTP::Put.new(path, headers)
+      when :post
+        Net::HTTP::Post.new(path, headers)
+      else
+        raise ArgumentError, "Unknown HTTP verb `#{verb}'"
+      end
+    end
+    
+    # Performs the actual request and returns a REST::Response object with the response
+    def perform
+      self.request = request_for_verb
+      
+      if [:patch, :put, :post].include?(verb)
+        request.body = body
+      end
+      
+      if options[:username] and options[:password]
+        request.basic_auth(options[:username], options[:password])
+      end
+      
+      http_request = http_request()
+      
       begin
         response = http_request.start { |http| http.request(request) }
       rescue EOFError => error
@@ -169,9 +194,10 @@ module REST
     # Shortcut for REST::Request.new(*args).perform.
     #
     # See new for options.
-    def self.perform(*args)
-      request = new(*args)
+    def self.perform(*args, &configure_block)
+      request = new(*args, &configure_block)
       request.perform
     end
   end
 end
+

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: nap
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0pre0
 platform: ruby
 authors:
 - Manfred Stienstra
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-01 00:00:00.000000000 Z
+date: 2014-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10'
 - !ruby/object:Gem::Dependency
   name: peck
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.5'
 description: |2
       Nap is a really simple REST library. It allows you to perform HTTP requests
       with minimal amounts of code.
@@ -48,33 +48,34 @@ extra_rdoc_files:
 - README.md
 - LICENSE
 files:
+- LICENSE
+- README.md
 - lib/rest.rb
 - lib/rest/request.rb
 - lib/rest/response.rb
 - support/cacert.pem
-- README.md
-- LICENSE
-homepage: 
-licenses: []
+homepage: https://github.com/Fingertips/nap
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options:
-- --charset=utf-8
+- "--charset=utf-8"
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.2.0
 signing_key: 
 specification_version: 4
 summary: Nap is a really simple REST library.