simple-http 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b4588e9e8c027217ca27a55496429b8c17b1bb49
+  data.tar.gz: be034b0620f7358c4e3d806ca4a0ab8b7c16e77d
+SHA512:
+  metadata.gz: 25d97c4098cdd837a45c7cf4b6377d943cd29fde1a51db79b7f52f9457658127a411f910b618d23bb42c368f1dc3ef49c47219f929b72ddd96df552a3639ac27
+  data.tar.gz: f8044c467a6f30109a21cfa2d86d5b4c9fadeec52f930375502a11a7dfa0f2a74ae932a669417e7c205e7610feb77a01cbf091e7674296dfe6fba64bf8788df9

data/README.md

@@ -0,0 +1,34 @@
+# simple-http
+
+A really simple HTTP client
+
+- GET, POST, PUT, DELETE
+
+        require "simple/http"
+        http_client = Simple::HTTP.new
+        http_client.get "http://google.com" # returns a string
+
+- Exceptions on errors: because, after all, when you consume a HTTP endpoint and don't
+  get a success (20x), then this is an error. Handle it!
+
+        require "simple/http"
+        http_client = Simple::HTTP.new
+        begin
+          http_client.get "http://google.com" # returns a string
+        rescue Simple::HTTP::Error
+          STDERR.puts "Ooops! #{$!}"
+        end
+ 
+- Caching
+
+        require "simple/http"
+        http_client = Simple::HTTP.new
+
+        require "active_support/cache"
+        require "active_support/cache/file_store"
+        http_client.cache = ActiveSupport::Cache::FileStore.new("var/cache")
+        http_client.get "http://google.com" # returns a, potentially, cached string
+
+- Automatic de/encoding of JSON payloads
+
+- Does not requires anything except core ruby classes.

data/lib/simple/http/errors.rb

@@ -0,0 +1,33 @@
+# This file is part of the simple-http ruby gem.
+#
+# Copyright (c) 2011 - 2015 @radiospiel
+# Distributed under the terms of the modified BSD license, see LICENSE.BSD
+
+module Simple; end
+class Simple::HTTP; end
+
+class Simple::HTTP::Error < RuntimeError
+  attr :method, :request, :response
+
+  def initialize(method, request, response)
+    @method, @request, @response = method, request, response
+  end
+
+  def code
+    response.code.to_i
+  end
+
+  def message
+    message = "#{method} #{response.uri} ##{response.code} #{response.message}"
+    if response.is_a?(Net::HTTPRedirection)
+      message += " To #{response["Location"]}"
+    end
+    message
+  end
+end
+
+class Simple::HTTP::TooManyRedirections < Simple::HTTP::Error
+  def message
+    "Too many redirections; after\n#{super}"
+  end
+end

data/lib/simple/http/expires_in.rb

@@ -0,0 +1,34 @@
+# This file is part of the simple-http ruby gem.
+#
+# Copyright (c) 2011 - 2015 @radiospiel
+# Distributed under the terms of the modified BSD license, see LICENSE.BSD
+
+require "net/http"
+
+class Net::HTTPResponse
+  private
+  
+  #
+  # The "max-age" value, in seconds, from the Cache-Control header.
+  def max_age
+    return unless cache_control = header["Cache-Control"]
+    cache_control.split(/, /).each do |part|
+      next unless part =~ /max-age=(\d+)/
+      return Integer($1)
+    end
+    nil
+  end
+
+  public
+  
+  #
+  # returns expiration information, in seconds from now.
+  def expires_in
+    expires_in = max_age
+    if !expires_in && expires = header["Expires"]
+      expires_in = Time.parse(expires) - Time.now
+    end
+
+    return expires_in if expires_in && expires_in > 0
+  end
+end

data/lib/simple/http/result.rb

@@ -0,0 +1,41 @@
+# This file is part of the simple-http ruby gem.
+#
+# Copyright (c) 2011 - 2015 @radiospiel
+# Distributed under the terms of the modified BSD license, see LICENSE.BSD
+
+require "net/http"
+
+class Net::HTTPResponse
+  #
+  # evaluate and potentially parse response
+  def result
+    case response.content_type
+    when "application/json"
+      JSON.parse(body) unless body.empty?
+    else
+      body_string
+    end
+  end
+
+  private
+
+  #
+  # returns a body. The resulting string is encoded in ASCII-8BIT, if the 
+  # content type is binary, and encoded in UTF8 otherwise.
+  def body_string
+    default_encoding = content_is_binary? ? "ASCII-8BIT" : "UTF-8"
+
+    body = self.body
+    if charset = type_params["charset"]
+      body = body.force_encoding(charset)
+    end
+    body.encode(default_encoding)
+  end
+
+  def content_is_binary?
+    case content_type
+    when /^image/ then true
+    else false
+    end
+  end
+end

data/lib/simple/http/version.rb

@@ -0,0 +1,9 @@
+# This file is part of the simple-http ruby gem.
+#
+# Copyright (c) 2011 - 2015 @radiospiel
+# Distributed under the terms of the modified BSD license, see LICENSE.BSD
+
+module Simple; end
+class Simple::HTTP
+  VERSION = "0.1.0"
+end

data/lib/simple/http.rb

@@ -0,0 +1,166 @@
+# Author::    radiospiel  (mailto:eno@radiospiel.org)
+# Copyright:: Copyright (c) 2011-2015 radiospiel
+# License::   Distributes under the terms  of the Modified BSD License, see LICENSE.BSD for details.
+
+require "net/http"
+require "json"
+
+module Simple; end
+class Simple::HTTP; end
+
+require_relative "http/version"
+require_relative "http/result"
+require_relative "http/expires_in"
+require_relative "http/errors"
+
+#
+# A very simple, Net::HTTP-based HTTP client. 
+#
+# Has some support for transferring JSON data: all data in PUT and POST
+# requests are jsonized, and all data in responses are parsed as JSON if
+# the Content-Type header is set to "application/json".
+class Simple::HTTP
+
+  #
+  # The base URL: when set, all requests that do not start with http: or 
+  # https: are done relative to this base URL. 
+  attr :base_url, true
+  
+  #
+  # When set (default), redirections are followed. Note: When 
+  # follows_redirections is not set, a HTTP redirection would raise an
+  # error - which is probably only useful when testing an interface.
+  attr :follows_redirections, true
+
+  #
+  # When set, appends this to all request URLs
+  attr :default_params, true
+
+  def initialize
+    self.follows_redirections = true
+  end
+
+  def get(url, headers = {});               http :GET, url, nil, headers; end
+  def post(url, body = nil, headers = {});  http :POST, url, body, headers; end
+  def put(url, body = nil, headers = {});   http :PUT, url, body, headers; end
+  def delete(url, headers = {});            http :DELETE, url, nil, headers; end
+
+  #
+  # -- Caching ----------------------------------------------------------------
+
+  # When set, and a response is cacheable (as it returns a valid expires_in 
+  # value), the cache object is used to cache responses.
+  attr :cache, true
+
+  #
+  # when does the response expire? By default, calculates expiration based
+  # on response headers. Override as needed.
+  def expires_in(response)
+    response.expires_in
+  end
+
+  private
+
+  # -- HTTP request -----------------------------------------------------------
+
+  def http(method, url, body = nil, headers)
+    #
+    # normalize url; i.e. prepend base_url if the url itself is incomplete.
+    unless url =~ /^(http|https):/
+      url = File.join(base_url, url) 
+    end
+    
+    # append default_params, if set
+    if default_params
+      url.concat(url.include?("?") ? "&" : "?")
+      url.concat default_params
+    end
+
+    # "raw" execute request
+    http_ method, url, body, headers
+  end
+
+  # 
+  # do a HTTP request, return its response or, when not successful, 
+  # raise an error.
+  def http_(method, url, body, headers, max_redirections = 10)
+    if method == :GET && cache && result = cache.read(url)
+      return result
+    end
+
+    uri = URI.parse(url)
+    http = Net::HTTP.new(uri.host, uri.port)
+
+    #
+    # build request
+    request = build_request method, uri, body, headers
+
+    #
+    # execute request
+    response = http.request(request)
+    
+    #
+    # Most of the times Net::HTTP#request returns a response with the :uri
+    # attribute set, but sometimes not. We  make sure that the uri is set 
+    # everytime.
+    response.uri = uri
+
+    #
+    # handle successful responses.
+    if response.is_a?(Net::HTTPSuccess)
+      result = response.result
+      if cache && method == :GET && expires_in = self.expires_in(response)
+        cache.write(url, result, expires_in: expires_in)
+      end
+
+      return result
+    end
+
+    #
+    # handle redirections.
+    if response.is_a?(Net::HTTPRedirection) && self.follows_redirections
+      if max_redirections <= 0
+        raise TooManyRedirections.new(method, request, respons)
+      end
+      
+      return http_(:GET, response["Location"], nil, {}, max_redirections - 1)
+    end
+
+    #
+    # raise an error in any other case.
+    raise Error.new(method, request, response)
+  end
+
+  private
+
+  REQUEST_CLASSES = {
+    :GET    =>  Net::HTTP::Get,
+    :POST   =>  Net::HTTP::Post,
+    :PUT    =>  Net::HTTP::Put,
+    :DELETE =>  Net::HTTP::Delete
+  }.freeze #:nodoc:
+
+  #
+  # build a HTTP request object.
+  def build_request(method, uri, body, headers)
+    klass = REQUEST_CLASSES.fetch(method)
+    request = klass.new(uri.request_uri)
+
+    # set request headers
+    # unless headers && !headers.empty?
+    #   # TODO: set headers
+    #   # set_request_headers request, headers
+    # end
+
+    # set request body
+    if request.request_body_permitted? && body
+      request.content_type = "application/json"
+      if body.is_a?(Hash) || body.is_a?(Array)
+        body = JSON.generate(body)
+      end
+      request.body = body
+    end
+
+    request
+  end
+end

data/test/simple_http_test.rb

@@ -0,0 +1,14 @@
+# Author::    radiospiel  (mailto:eno@radiospiel.org)
+# Copyright:: Copyright (c) 2011-2015 radiospiel
+# License::   Distributes under the terms  of the Modified BSD License, see LICENSE.BSD for details.
+
+require_relative 'test_helper'
+
+class SimpleHttpTest < Test::Unit::TestCase
+  HTTP = Simple::HTTP.new
+
+  def test_loaded
+    google = HTTP.get "http://google.com"
+    assert_match(/doctype/, google)
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,11 @@
+require 'rubygems'
+require 'bundler/setup'
+
+# require 'simplecov'
+require 'test/unit'
+
+# SimpleCov.start do
+#   add_filter "test/*.rb"
+# end
+
+require "simple/http"

metadata

@@ -0,0 +1,50 @@
+--- !ruby/object:Gem::Specification
+name: simple-http
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- radiospiel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-09-16 00:00:00.000000000 Z
+dependencies: []
+description: Simple code for simple HTTP requests
+email: eno@radiospiel.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/simple/http.rb
+- lib/simple/http/errors.rb
+- lib/simple/http/expires_in.rb
+- lib/simple/http/result.rb
+- lib/simple/http/version.rb
+- test/simple_http_test.rb
+- test/test_helper.rb
+homepage: http://github.com/radiospiel/simple-http
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: Simple code for simple HTTP requests
+test_files: []