http-client 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 442016d7995b5d8e1e31886a4aaff8a34102635d
-  data.tar.gz: f7bc4ab873d2cc41abccecac5b4d46c148e88d78
+  metadata.gz: d546e0cdecec14e9d20d4b95c21bd149602b3c12
+  data.tar.gz: c564d50a791ce9244b199276c9e7b7b55e843127
 SHA512:
-  metadata.gz: 9347691549ccb5381f277597a198fd6042b3cfa3c6b3b0eafcf0f539cfd3ca7be6a6d5d7f36590d46099cbd98602757ff936754c0e3a3986dfe45085da216ca1
-  data.tar.gz: dfe32ba2b0e52035fe0572023fc34a914cc6b518cd00b746cd8779f895fa718b771094c37a51b29dd2ba0f268a6662090af82d4aaa0586b3c9634e65006e9523
+  metadata.gz: d76ba488f562a71c3335f87b59848f8ab51a5e179e9cdbd682b5e075ebf72361736aa34f620677602d8f7fda62738cbd1dd774c7d310a87839507fbd82b55c27
+  data.tar.gz: fd787d6c479ae7acf074a88a493e38c5ed6bf975a91954d1ed50772bd84c568ea2a029337a5c41c5dd912a8c9d9728f6301b7d36d4bfcc4b303ac31e1db696aa

data/CHANGELOG

@@ -1,4 +1,8 @@
-== 0.3.0 (2017-06-30
+== 0.4.0 (2017-07-05)
+
+* Cleanup error classes namespacing.
+
+== 0.3.0 (2017-06-30)
 
 * Rescue error conditions and re-raise them as HTTP::Client::Error sub-classes.
 

data/README.md

@@ -56,6 +56,7 @@ HTTP::Client::Error
   HTTP::Client::Error::Zlib
   HTTP::Client::Error::Timeout
   HTTP::Client::Error::Transport
+  HTTP::Client::Error::Argument
 ```
 
 ### Request parameters

data/lib/http/client.rb

@@ -9,7 +9,7 @@ require 'zlib'
 
 module HTTP
   module Client
-    VERSION = '0.3.0'
+    VERSION = '0.4.0'
 
     GET                     = Net::HTTP::Get
     HEAD                    = Net::HTTP::Head
@@ -22,12 +22,6 @@ module HTTP
     SSL_VERIFY_NONE         = OpenSSL::SSL::VERIFY_NONE
     SSL_VERIFY_PEER         = OpenSSL::SSL::VERIFY_PEER
 
-    class Error < StandardError;
-    end
-
-    class ArgumentError < Error;
-    end
-
     class Request
       VALID_PARAMETERS        = %w(headers files query body auth timeout open_timeout ssl_timeout read_timeout max_redirects ssl_verify jar)
       DEFAULT_HEADERS         = {'User-Agent' => 'HTTP Client API/1.0'}
@@ -54,7 +48,7 @@ module HTTP
       # @option args [Integer]         read_timeout    Read timeout in seconds.
       # @option args [Integer]         ssl_timeout     SSL handshake timeout in seconds.
       # @option args [Integer]         max_redirects   Max redirect follow, default: 0
-      # @option args [Integer]         ssl_verify      OpenSSL verification, SSL_VERIFY_PEER or SSL_VERIFY_NONE, defaults to SSL_VERIFY_PEER.
+      # @option args [Integer]         ssl_verify      OpenSSL verification, SSL_VERIFY_PEER (default) or SSL_VERIFY_NONE.
       # @option args [HTTP::CookieJar] jar             Optional cookie jar to use. Relies on HTTP::CookieJar from http-cookie gem.
       #
       # @return [HTTP::Client::Request]
@@ -71,7 +65,11 @@ module HTTP
       #   response = HTTP::Client.get("http://www.example.org/", max_redirects: 3)
       #
       # @example Upload a few files in a POST request.
-      #   request  = HTTP::Client::Request.new(:post, "http://www.example.org/", files: {"cats" => "cats.jpg", "dogs" => "dogs.jpg"}, query: {title: "cute pics"})
+      #   request  = HTTP::Client::Request.new(
+      #     :post, "http://www.example.org/",
+      #     files: {"cats" => "cats.jpg", "dogs" => "dogs.jpg"},
+      #     query: {title: "cute pics"}
+      #   )
       #   response = request.execute
       #
       # @example Pass in an external cookie jar.
@@ -81,14 +79,14 @@ module HTTP
       #
       def initialize verb, uri, args = {}
         args.each do |k, v|
-          raise ArgumentError, "unknown argument #{k}" unless VALID_PARAMETERS.include?(k.to_s)
+          raise Error::Argument, "unknown argument #{k}" unless VALID_PARAMETERS.include?(k.to_s)
         end
 
         uri       = parse_uri!(uri)
         @delegate = create_request_delegate(verb, uri, args)
 
         if body = args[:body]
-          raise ArgumentError, "#{verb} cannot have body" unless @delegate.class.const_get(:REQUEST_HAS_BODY)
+          raise Error::Argument, "#{verb} cannot have body" unless @delegate.class.const_get(:REQUEST_HAS_BODY)
           @delegate.body = body
         end
 
@@ -155,19 +153,19 @@ module HTTP
           uri = uri.kind_of?(URI) ? uri : URI.parse(uri)
           case uri
             when URI::HTTP, URI::HTTPS
-              raise ArgumentError, "Invalid URI #{uri}" if uri.host.nil?
+              raise Error::URI, "Invalid URI #{uri}" if uri.host.nil?
               uri
             when URI::Generic
               if @delegate && @delegate.uri
                 @delegate.uri.dup.tap {|s| s += uri }
               else
-                raise ArgumentError, "Invalid URI #{uri}"
+                raise Error::URI, "Invalid URI #{uri}"
               end
             else
-              raise ArgumentError, "Invalid URI #{uri}"
+              raise Error::URI, "Invalid URI #{uri}"
           end
         rescue URI::InvalidURIError => e
-          raise ArgumentError, "Invalid URI #{uri}"
+          raise Error::URI, "Invalid URI #{uri}"
         end
 
         def create_request_delegate verb, uri, args
@@ -180,7 +178,7 @@ module HTTP
           delegate = nil
 
           if files
-            raise ArgumentError, "#{verb} cannot have body" unless klass.const_get(:REQUEST_HAS_BODY)
+            raise Error::Argument, "#{verb} cannot have body" unless klass.const_get(:REQUEST_HAS_BODY)
             multipart             = Multipart.new(files, qs)
             delegate              = klass.new(uri, headers)
             delegate.content_type = multipart.content_type
@@ -264,7 +262,7 @@ module HTTP
             when /^post$/i    then POST
             when /^delete$/i  then DELETE
             else
-              raise ArgumentError, "Invalid verb #{string}"
+              raise Error::Argument, "Invalid verb #{string}"
           end
         end
     end # Request
@@ -439,6 +437,7 @@ module HTTP
       class Zlib < Error; end
       class Timeout < Error; end
       class Transport < Error; end
+      class Argument < Error; end
     end # Error
   end # Client
 end # HTTP

data/test/test_request.rb

@@ -4,17 +4,17 @@ require_relative 'helper'
 
 describe 'HTTP Client Request' do
   it 'should reject invalid arguments' do
-    assert_raises(HTTP::Client::ArgumentError, 'invalid verb') {HTTP::Client::Request.new(:foo, 'http://example.org/')}
-    assert_raises(HTTP::Client::ArgumentError, 'invalid uri')  {HTTP::Client::Request.new(:get, 'http://')}
-    assert_raises(HTTP::Client::ArgumentError, 'invalid uri')  {HTTP::Client::Request.new(:get, '/hello')}
+    assert_raises(HTTP::Client::Error::Argument, 'invalid verb') {HTTP::Client::Request.new(:foo, 'http://example.org/')}
+    assert_raises(HTTP::Client::Error::URI, 'invalid uri') {HTTP::Client::Request.new(:get, 'http://')}
+    assert_raises(HTTP::Client::Error::URI, 'invalid uri') {HTTP::Client::Request.new(:get, '/hello')}
 
-    assert_raises(HTTP::Client::ArgumentError, 'invalid argument')  do
+    assert_raises(HTTP::Client::Error::Argument, 'invalid argument')  do
       HTTP::Client::Request.new(:get, 'http://example.org/', foo: 1)
     end
   end
 
   it 'validates body based on request verb' do
-    assert_raises(HTTP::Client::ArgumentError, 'get cannot have body') do
+    assert_raises(HTTP::Client::Error::Argument, 'get cannot have body') do
       HTTP::Client::Request.new(:get, 'http://a.c', files: {test: __FILE__})
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: http-client
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Bharanee Rathna
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-30 00:00:00.000000000 Z
+date: 2017-07-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mime-types
@@ -124,7 +124,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: A client wrapper around Net::HTTP