hippie 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 82c5deb0ce5f8c497fade22b08b618fe56079c34
-  data.tar.gz: 44c5511dab804cc882a7a2d5597dc34a1bbd0093
+  metadata.gz: 26fcf855feebd6241785015a3171ff6a2c1d3d3d
+  data.tar.gz: d93ced984c7eaf59f8806c2c393ed673f438e0e2
 SHA512:
-  metadata.gz: 37ee47fe5c1ce78a799a0473aea5eebe81a31c617262508aa0361ab8da3bf870ca5a2d4af4bce1d40381f993547f0cdae98c392301a6f14384344e00d156ead9
-  data.tar.gz: 49f8d631d06da861ffb83b8374bcb5e2561fa46970452dc7dcb62f87d4719a171829711c3bffed7ea9bdb4229afcb967b05fbe9b4925340703352d446366c9db
+  metadata.gz: 2f985d283e1e55552b262de5f0cb16ad9e35c851fcdba049f197619d4e36d990ba1a5872b102b1f7c903afbb0877ea706c630ebc7170f5436cf30a1fefe23409
+  data.tar.gz: f0e1e7bf89aa8568bb96ed15de29233e0f993bcad952d808710cf3f68353ac370de2da50a72fc6b966052f557a179ed4071fc330cdf79b1d867bea9fd5a39b38

data/README.md

@@ -1,4 +1,10 @@
-# Hippie: Simple HTTP wrapper for Net::HTTP
+# Hippie
+### _Simple HTTP client for ruby_
+---
+
+## Installation
+
+    $ gem install hippie
 
 ## Usage
 Here's an example of a GET request:
@@ -6,36 +12,50 @@ Here's an example of a GET request:
 ```ruby
 require 'hippie'
 
-response = Hippie.get("http://example.com")
+response = Hippie.get('http://example.com')
+response.class #=> Hippie::Response
 
-# Now you have these methods available
 response.status  #=> Number with the status code
 response.headers #=> Hash with the response headers
 response.body    #=> String with the response body
-response.error?  #=> true / false
-response.valid?  #=> true / false
+response.json    #=> String with the response body parsed to json
+
+response.information?  #=> 1xx response
+response.success?      #=> 2xx response
+response.redirection?  #=> 3xx response
+response.client_error? #=> 4xx response
+response.server_error? #=> 5xx response
+response.error?        #=> 4xx or 5xx
 ```
 
 You can also pass parameters with a query string:
 
 ```ruby
-# GET http://example.com?foo=bar
-Hippie.get("http://example.com", params: { foo: "bar" })
+Hippie.get('http://example.com', params: { foo: 'bar' })
 ```
 
-If you want to send data with a POST request, you can add a `data`
-option with the value.
+If you want to send data with a POST request, you can add a `data` option with the value.
 
 ```ruby
-Hippie.post("http://example.com", data: "hello world")
+Hippie.post('http://example.com', data: 'hello world')
 ```
 
 For Basic Authentication, you can provide the option `auth`, which
 should contain an array with the username and password:
 
 ```ruby
-Hippie.get("http://example.com", auth: ["username", "password"])
+Hippie.get('http://example.com', auth: ['username', 'password'])
 ```
 
-# Disclaimer
+## Available methods
+- GET
+- POST
+- PUT
+- DELETE
+- HEAD
+- OPTIONS
+- PATCH
+- TRACE
+
+### Disclaimer
 This is a fork of the awesome 'requests' gem from cyx (https://github.com/cyx/requests)

data/hippie.gemspec

@@ -1,8 +1,8 @@
 Gem::Specification.new do |s|
   s.name          = 'hippie'
-  s.version       = '0.5.0'
+  s.version       = '0.6.0'
   s.summary       = 'Simple HTTP'
-  s.description   = 'Simple wrapper for Net::HTTP'
+  s.description   = 'Simple HTTP client for Ruby'
   s.author        = 'Martin Manelli'
   s.email         = 'manelli.ml@gmail.com'
   s.homepage      = 'http://github.com/manelli/hippie'
@@ -12,12 +12,12 @@ Gem::Specification.new do |s|
   s.files = Dir[
     'LICENSE',
     'README.md',
-    'makefile',
     'lib/hippie.rb',
     'lib/cacert.pem',
+    'lib/hippie/response.rb',
     'tests/hippie_test.rb',
     'hippie.gemspec'
   ]
 
-  s.add_development_dependency 'cutest', '~> 1.2', '>= 1.2.0'
+  s.add_development_dependency 'minitest', '>= 2.5', '< 5.0'
 end

data/lib/hippie/response.rb

@@ -0,0 +1,43 @@
+# encoding: utf-8
+
+require 'json'
+
+module Hippie
+  class Response
+    attr_reader :status, :headers, :body
+
+    def initialize(status, headers, body)
+      @status   = status.to_i
+      @headers  = headers
+      @body     = body.to_s
+    end
+
+    def json
+      JSON.parse(@body)
+    end
+
+    def information?
+      @status.between?(100, 199)
+    end
+
+    def success?
+      @status.between?(200, 299)
+    end
+
+    def redirection?
+      @status.between?(300, 399)
+    end
+
+    def client_error?
+      @status.between?(400, 499)
+    end
+
+    def server_error?
+      @status.between?(500, 599)
+    end
+
+    def error?
+      !success?
+    end
+  end
+end

data/lib/hippie.rb

@@ -1,36 +1,13 @@
-require 'uri'
+# encoding: utf-8
+
 require 'net/http'
 require 'openssl'
-require 'json'
+require_relative 'hippie/response'
 
 module Hippie
-  class Response
-    attr_reader :status, :headers, :body
-
-    def initialize(status, headers, body)
-      @status   = status.to_i
-      @headers  = headers
-      @body     = body || ''
-    end
-
-    def json
-      JSON.parse(@body)
-    end
-
-    def encoding
-      @body.encoding
-    end
-
-    def valid?
-      @status.between?(200, 299)
-    end
-
-    def error?
-      !valid?
-    end
-  end
-
-  CA_FILE = ENV.fetch('REQUESTS_CA_FILE') { File.expand_path('../cacert.pem', __FILE__) }
+  CA_FILE = ENV.fetch('REQUESTS_CA_FILE') {
+    File.expand_path('../cacert.pem', __FILE__)
+  }
 
   def self.get(url, **kwargs)
     request('GET', url, **kwargs)
@@ -67,10 +44,12 @@ module Hippie
   private
 
   def self.request(method, url, headers: {}, data: nil, params: nil, auth: nil)
-    fail "No HTTP(S) scheme in: #{url}" unless url =~ /^https?:\/\//i
-
     uri = URI.parse(URI.encode(url))
 
+    unless ['http', 'https'].include? uri.scheme
+      fail URI::InvalidURIError, "No HTTP(S) scheme in: #{url}"
+    end
+
     uri.query = URI.encode_www_form(params) if params
     body = process_params(headers: headers, data: data) if data
     basic_auth(headers, *auth) if auth
@@ -83,7 +62,7 @@ module Hippie
       end
     end
 
-    Response.new(response.code, response.to_hash, response.body)
+    Hippie::Response.new(response.code, response.to_hash, response.body)
   end
 
   def self.opts(uri)

data/tests/hippie_test.rb

@@ -1,90 +1,81 @@
-require 'hippie'
+# encoding: utf-8
 
-test 'GET' do
-  r = Hippie.get('http://httpbin.org/get', params: { foo: 'bar' })
+require 'minitest/autorun'
+require_relative '../lib/hippie'
 
-  assert_equal 200, r.status
-  assert_equal ['application/json'], r.headers['content-type']
-  assert_equal 'UTF-8', r.encoding.to_s
+class TestHippie < Minitest::Test
+  def test_get
+    r = Hippie.get('http://httpbin.org/get', params: { foo: 'bar' })
 
-  assert(r.json['args'] && r.json['args']['foo'] == 'bar')
-end
-puts 'GET'
-
-test 'POST' do
-  r = Hippie.post('http://httpbin.org/post', data: { "plan" => "test" })
-
-  assert_equal 200, r.status
-  assert_equal ['application/json'], r.headers['content-type']
-  assert_equal 'UTF-8', r.encoding.to_s
+    assert_equal true, r.success?
+    assert_equal ['application/json'], r.headers['content-type']
+    assert(r.json['args'] && r.json['args']['foo'] == 'bar')
+  end
 
-  assert(r.json['form'] && r.json['form'] == { 'plan' => 'test' })
-end
-puts 'POST'
-
-test 'PUT' do
-  r = Hippie.put('http://httpbin.org/put', data: { 'plan' => 'test' })
+  def test_post
+    r = Hippie.post('http://httpbin.org/post', data: { 'plan' => 'test' })
 
-  assert_equal 200, r.status
-  assert_equal ['application/json'], r.headers['content-type']
-  assert_equal 'UTF-8', r.encoding.to_s
+    assert_equal true, r.success?
+    assert_equal ['application/json'], r.headers['content-type']
+    assert(r.json['form'] && r.json['form'] == { 'plan' => 'test' })
+  end
 
-  assert(r.json['form'] && r.json['form'] == { 'plan' => 'test' })
-end
-puts 'PUT'
+  def test_put
+    r = Hippie.put('http://httpbin.org/put', data: { 'plan' => 'test' })
 
-test 'DELETE' do
-  r = Hippie.delete('http://httpbin.org/delete', data: { 'plan' => 'test' })
+    assert_equal true, r.success?
+    assert_equal ['application/json'], r.headers['content-type']
+    assert(r.json['form'] && r.json['form'] == { 'plan' => 'test' })
+  end
 
-  assert_equal 200, r.status
-  assert_equal ['application/json'], r.headers['content-type']
-  assert_equal 'UTF-8', r.encoding.to_s
+  def test_delete
+    r = Hippie.delete('http://httpbin.org/delete', data: { 'plan' => 'test' })
 
-  assert(r.json['form'] && r.json['form'] == { 'plan' => 'test' })
-end
-puts 'DELETE'
+    assert_equal true, r.success?
+    assert_equal ['application/json'], r.headers['content-type']
+    assert(r.json['form'] && r.json['form'] == { 'plan' => 'test' })
+  end
 
-test 'HEAD' do
-  r = Hippie.head('http://httpbin.org/headers')
+  def test_head
+    r = Hippie.head('http://httpbin.org/headers')
 
-  assert_equal 200, r.status
-  assert_equal ['application/json'], r.headers['content-type']
-  assert_equal 'UTF-8', r.encoding.to_s
-end
-puts 'HEAD'
+    assert_equal true, r.success?
+    assert_equal ['application/json'], r.headers['content-type']
+  end
 
-test 'OPTIONS' do
-  # TODO
-end
-puts 'OPTIONS'
+  def test_options
+    # TODO
+  end
 
-test 'PATCH' do
-  r = Hippie.patch('http://httpbin.org/patch', data: { 'plan' => 'test' })
+  def test_patch
+    r = Hippie.patch('http://httpbin.org/patch', data: { 'plan' => 'test' })
 
-  assert_equal 200, r.status
-  assert_equal ['application/json'], r.headers['content-type']
-  assert_equal 'UTF-8', r.encoding.to_s
+    assert_equal true, r.success?
+    assert_equal ['application/json'], r.headers['content-type']
+    assert(r.json['form'] && r.json['form'] == { 'plan' => 'test' })
+  end
 
-  assert(r.json['form'] && r.json['form'] == { 'plan' => 'test' })
-end
-puts 'PATCH'
+  def test_trace
+    # TODO
+  end
 
-test 'TRACE' do
-  # TODO
-end
-puts 'TRACE'
+  def test_basic_auth
+    r = Hippie.get('http://httpbin.org/basic-auth/u/p', auth: ['u', 'p'])
 
-test 'Basic Auth' do
-  r = Hippie.get('http://httpbin.org/basic-auth/u/p', auth: ['u', 'p'])
+    assert_equal true, r.success?
+    assert_equal true, r.json['authenticated']
+    assert_equal  'u', r.json['user']
+  end
 
-  assert_equal r.json['authenticated'], true
-  assert_equal r.json['user'], 'u'
-end
-puts 'Basic Auth'
+  def test_ssl
+    r = Hippie.get('https://httpbin.org/get')
 
-test 'SSL' do
-  response = Hippie.get('https://httpbin.org/get')
+    assert_equal true, r.success?
+  end
 
-  assert_equal 200, response.status
+  def test_raises_invalid_uri
+    assert_raises(URI::InvalidURIError) {
+      Hippie.get('www.httpbin.org/get')
+    }
+  end
 end
-puts 'SSL'

metadata

@@ -1,36 +1,36 @@
 --- !ruby/object:Gem::Specification
 name: hippie
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Martin Manelli
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-29 00:00:00.000000000 Z
+date: 2015-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: cutest
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.2'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.2.0
+        version: '2.5'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.2'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.2.0
-description: Simple wrapper for Net::HTTP
+        version: '2.5'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: Simple HTTP client for Ruby
 email: manelli.ml@gmail.com
 executables: []
 extensions: []
@@ -41,7 +41,7 @@ files:
 - hippie.gemspec
 - lib/cacert.pem
 - lib/hippie.rb
-- makefile
+- lib/hippie/response.rb
 - tests/hippie_test.rb
 homepage: http://github.com/manelli/hippie
 licenses:

data/makefile

@@ -1,2 +0,0 @@
-test:
-	RUBYLIB=./lib cutest tests/*_test.rb