http2 0.0.31 → 0.0.35

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 00dd7c4f177f2a7c84ef8f9ef463fe6f2675a400
-  data.tar.gz: 7c28395bf02c20a50d2b8633e6ddd8156c8972f3
+SHA256:
+  metadata.gz: ff94aecdfbfa493bb62b38edeef5a2bf49f9b5fb16ce5f023e6928ed77cb21c7
+  data.tar.gz: d8858f9e7daf39ed428311db9af0d561c971780d249cf0d0932a36962c921884
 SHA512:
-  metadata.gz: bdc915bf5453cb50d0d58e298f661b833d5086f370d66bfda2e5f654d01572ea4880f340d99dd3e6853abfd20e6d3a7bed5892758add2ad4c7187087f71e59b4
-  data.tar.gz: 54923d3a26cfe73698df0fbde92cd1dd517b61efaad45e77102fb469716d3efc4833b337bb2d915fb367d826e6370b5e068e6175a8ea7884b6b14bc9069f3024
+  metadata.gz: 04205c61f20290a3dec42a1c7a78b380ac749e0245ea53ba13f1a65cc983140e486a73fd26bf1e8a6ad808cde9a97d98ab9ba982f984726386d0b6db201da8d3
+  data.tar.gz: 413150d064f99e448cfcb0cca6380a6677b8e525ffcbbdaebfd957b5b7a6c263aeb105562ffcb6e8584603fd097a7fcfbda13327a662d7ba9927ad2e0d077afa

data/README.md

@@ -1,6 +1,6 @@
-[![Build Status](https://api.shippable.com/projects/540e7b9b3479c5ea8f9ec21d/badge?branchName=master)](https://app.shippable.com/projects/540e7b9b3479c5ea8f9ec21d/builds/latest)
 [![Code Climate](https://codeclimate.com/github/kaspernj/http2.png)](https://codeclimate.com/github/kaspernj/http2)
-[![Code Climate](https://codeclimate.com/github/kaspernj/http2/coverage.png)](https://codeclimate.com/github/kaspernj/http2)
+[![Build Status](https://www.peakflow.io/en/projects/http2/branch-statuses/master.svg
+)](https://www.peakflow.io/en/projects/http2/build-groups)
 
 # http2
 
@@ -36,6 +36,11 @@ You can also use SSL:
 Http2.new(host: "myhost.com", ssl: true, ssl_skip_verify: true)
 ```
 
+You can make it follow redirects like this:
+```ruby
+Http2.new(host: "myhost.com", follow_redirects: true)
+```
+
 ## Get requests
 ```ruby
 res = http.get("path/to/something")
@@ -155,6 +160,14 @@ http = Http2.new(
 )
 ```
 
+## Inspect the headers that were sent
+
+```ruby
+response = http.get("some_page")
+request = response.request
+request.headers_string #=> "GET /some_page\n..."
+```
+
 ## Contributing to http2
 
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.

data/Rakefile

@@ -1,37 +1,38 @@
-# encoding: utf-8
-
-require 'rubygems'
-require 'bundler'
+require "rubygems"
+require "bundler"
 begin
   Bundler.setup(:default, :development)
 rescue Bundler::BundlerError => e
-  $stderr.puts e.message
-  $stderr.puts "Run `bundle install` to install missing gems"
+  warn e.message
+  warn "Run `bundle install` to install missing gems"
   exit e.status_code
 end
-require 'rake'
+require "rake"
 
-require 'rspec/core'
-require 'rspec/core/rake_task'
+require "rspec/core"
+require "rspec/core/rake_task"
 RSpec::Core::RakeTask.new(:spec) do |spec|
-  spec.pattern = FileList['spec/**/*_spec.rb']
+  spec.pattern = FileList["spec/**/*_spec.rb"]
 end
 
 RSpec::Core::RakeTask.new(:rcov) do |spec|
-  spec.pattern = 'spec/**/*_spec.rb'
+  spec.pattern = "spec/**/*_spec.rb"
   spec.rcov = true
 end
 
-task :default => :spec
+task default: :spec
 
-require 'rdoc/task'
+require "rdoc/task"
 Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+  version = File.exist?("VERSION") ? File.read("VERSION") : ""
 
-  rdoc.rdoc_dir = 'rdoc'
+  rdoc.rdoc_dir = "rdoc"
   rdoc.title = "http2 #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
+  rdoc.rdoc_files.include("README*")
+  rdoc.rdoc_files.include("lib/**/*.rb")
 end
 
 Bundler::GemHelper.install_tasks
+
+require "best_practice_project"
+BestPracticeProject.load_tasks

data/lib/http2/base_request.rb

@@ -0,0 +1,22 @@
+class Http2::BaseRequest
+  attr_reader :http2, :args, :debug
+
+  VALID_ARGUMENTS_POST = [:post, :url, :default_headers, :headers, :json, :method, :cookies, :on_content, :content_type].freeze
+
+  def initialize(http2, args)
+    @http2 = http2
+    @args = http2.parse_args(args)
+    @debug = http2.debug
+    @nl = http2.nl
+
+    @args.each_key do |key|
+      raise "Invalid key: '#{key}'." unless VALID_ARGUMENTS_POST.include?(key)
+    end
+
+    @conn = @http2.connection
+  end
+
+  def path
+    @args.fetch(:url)
+  end
+end

data/{include → lib/http2}/connection.rb

@@ -1,6 +1,9 @@
 class Http2::Connection
   def initialize(http2)
-    @http2, @debug, @args, @nl = http2, http2.debug, http2.args, http2.nl
+    @http2 = http2
+    @debug = http2.debug
+    @args = http2.args
+    @nl = http2.nl
     reconnect
   end
 
@@ -23,10 +26,6 @@ class Http2::Connection
     @sock.read(length)
   end
 
-  def close
-    @sock.close
-  end
-
   def closed?
     @sock.closed?
   end
@@ -34,6 +33,7 @@ class Http2::Connection
   def sock_write(str)
     str = str.to_s
     return if str.empty?
+
     count = @sock.write(str)
     raise "Couldnt write to socket: '#{count}', '#{str}'." if count <= 0
   end
@@ -46,10 +46,13 @@ class Http2::Connection
   def write(str)
     reconnect unless socket_working?
 
+    puts "Http2: Writing: #{str}" if @debug
+
     begin
       raise Errno::EPIPE, "The socket is closed." if !@sock || @sock.closed?
+
       sock_write(str)
-    rescue Errno::EPIPE #this can also be thrown by puts.
+    rescue Errno::EPIPE # this can also be thrown by puts.
       reconnect
       sock_write(str)
     end
@@ -61,7 +64,7 @@ class Http2::Connection
   def reconnect
     puts "Http2: Reconnect." if @debug
 
-    #Open connection.
+    # Open connection.
     if @args[:proxy]
       if @args[:proxy][:connect]
         connect_proxy_connect
@@ -84,7 +87,7 @@ class Http2::Connection
   #===Examples
   # puts "Socket is working." if http.socket_working?
   def socket_working?
-    return false if !@sock or @sock.closed?
+    return false if !@sock || @sock.closed?
 
     if @keepalive_timeout && @request_last
       between = Time.now.to_i - @request_last.to_i
@@ -94,7 +97,7 @@ class Http2::Connection
       end
     end
 
-    return true
+    true
   end
 
   # Closes the current connection if any.
@@ -130,6 +133,7 @@ class Http2::Connection
 
     res = @sock_plain.gets.to_s
     raise "Couldn't connect through proxy: #{res}" unless res.match(/^http\/1\.(0|1)\s+200/i)
+
     @sock_plain.gets
 
     @proxy_connect = true
@@ -149,8 +153,15 @@ class Http2::Connection
     require "openssl" unless ::Kernel.const_defined?(:OpenSSL)
 
     ssl_context = OpenSSL::SSL::SSLContext.new
-    ssl_context.verify_mode = OpenSSL::SSL::VERIFY_PEER unless @args[:ssl_skip_verify]
+
+    if @args[:ssl_skip_verify]
+      ssl_context.verify_mode = OpenSSL::SSL::VERIFY_NONE
+    else
+      ssl_context.verify_mode = OpenSSL::SSL::VERIFY_PEER
+    end
+
     @sock_ssl = OpenSSL::SSL::SSLSocket.new(@sock_plain, ssl_context)
+    @sock_ssl.hostname = @http2.host
     @sock_ssl.sync_close = true
     @sock_ssl.connect
 

data/{include → lib/http2}/cookie.rb

@@ -2,7 +2,10 @@ class Http2::Cookie
   attr_reader :name, :value, :path, :expires_raw
 
   def initialize(args)
-    @name, @value, @path, @expires_raw = args[:name], args[:value], args[:path], args[:expires]
+    @name = args[:name]
+    @value = args[:value]
+    @path = args[:path]
+    @expires_raw = args[:expires]
   end
 
   def inspect

data/lib/http2/errors.rb

@@ -0,0 +1,18 @@
+# This class holds various classes for error-handeling.
+class Http2::Errors
+  class BaseError < RuntimeError
+    attr_accessor :response
+  end
+
+  class Noaccess < BaseError; end
+
+  class Internalserver < BaseError; end
+
+  class Notfound < BaseError; end
+
+  class Badrequest < BaseError; end
+
+  class Unauthorized < BaseError; end
+
+  class UnsupportedMediaType < BaseError; end
+end

data/lib/http2/get_request.rb

@@ -0,0 +1,33 @@
+class Http2::GetRequest < Http2::BaseRequest
+  def execute
+    @http2.mutex.synchronize do
+      @http2.connection.write(headers_string)
+
+      puts "Http2: Reading response." if @debug
+      resp = @http2.read_response(self, @args)
+
+      puts "Http2: Done with get request." if @debug
+      return resp
+    end
+  end
+
+  def headers_string
+    unless @header_str
+      @header_str = "#{method} /#{@args[:url]} HTTP/1.1#{@nl}"
+      @header_str << @http2.header_str(@http2.default_headers(@args))
+      @header_str << @nl
+    end
+
+    @header_str
+  end
+
+private
+
+  def method
+    if @args[:method]
+      @args[:method].to_s.upcase
+    else
+      "GET"
+    end
+  end
+end

data/{include → lib/http2}/post_data_generator.rb

@@ -1,6 +1,7 @@
 class Http2::PostDataGenerator
   def initialize(pdata, args = {})
-    @pdata, @args = pdata, args
+    @pdata = pdata
+    @args = args
   end
 
   def generate
@@ -14,7 +15,7 @@ class Http2::PostDataGenerator
       return @pdata.to_s
     end
 
-    return praw
+    praw
   end
 
 private
@@ -22,7 +23,7 @@ private
   def generate_for_hash(hash)
     praw = ""
 
-    @pdata.each do |key, val|
+    hash.each do |key, val|
       praw << "&" if praw != ""
       key = "#{@args[:orig_key]}[#{key}]" if @args[:orig_key]
       praw << generate_key_value(key, val)
@@ -35,7 +36,7 @@ private
     praw = ""
 
     count = 0
-    @pdata.each do |val|
+    array.each do |val|
       praw << "&" if praw != ""
 
       if @args[:orig_key]
@@ -53,10 +54,10 @@ private
 
   def generate_key_value(key, value)
     if value.is_a?(Hash) || value.is_a?(Array)
-      return ::Http2::PostDataGenerator.new(value, orig_key: key).generate
+      ::Http2::PostDataGenerator.new(value, orig_key: key).generate
     else
       data = ::Http2::PostDataGenerator.new(value).generate
-      return "#{Http2::Utils.urlenc(key)}=#{Http2::Utils.urlenc(data)}"
+      "#{Http2::Utils.urlenc(key)}=#{Http2::Utils.urlenc(data)}"
     end
   end
 end

data/{include → lib/http2}/post_multipart_request.rb

@@ -1,42 +1,44 @@
 require "tempfile"
 
-class Http2::PostMultipartRequest
+class Http2::PostMultipartRequest < Http2::BaseRequest
+  attr_reader :headers_string
+
   def initialize(http2, *args)
-    @http2, @nl, @args = http2, http2.nl, http2.parse_args(*args)
+    super
+
     @phash = @args[:post].clone
     @http2.autostate_set_on_post_hash(phash) if @http2.autostate
     @boundary = rand(36**50).to_s(36)
-    @conn = @http2.connection
   end
 
   def execute
-    generate_raw(@phash) do |helper, praw|
-      puts "Http2: Header string: #{header_string}" if @debug
-
+    generate_raw(@phash) do |_helper, praw|
       @http2.mutex.synchronize do
-        @conn.write(header_string(praw))
+        @conn.write(header_string_with_raw_post(praw))
 
         praw.rewind
         praw.each_line do |data|
           @conn.sock_write(data)
         end
 
-        return @http2.read_response(@args)
+        return @http2.read_response(self, @args)
       end
     end
   end
 
 private
 
-  def header_string(praw)
-    header_str = "POST /#{@args[:url]} HTTP/1.1#{@nl}"
-    header_str << @http2.header_str(@http2.default_headers(@args).merge(
+  def header_string_with_raw_post(praw)
+    @headers_string = "POST /#{@args[:url]} HTTP/1.1#{@nl}"
+
+    headers = @http2.default_headers(@args).merge(
       "Content-Type" => "multipart/form-data; boundary=#{@boundary}",
       "Content-Length" => praw.size
-    ), @args)
-    header_str << @nl
+    )
 
-    return header_str
+    @headers_string << @http2.header_str(headers)
+    @headers_string << @nl
+    @headers_string
   end
 
   def generate_raw(phash)
@@ -54,13 +56,11 @@ private
 
   def read_file(path, praw)
     File.open(path, "r") do |fp|
-      begin
-        while data = fp.sysread(4096)
-          praw << data
-        end
-      rescue EOFError
-        # Happens when done.
+      while (data = fp.sysread(4096))
+        praw << data
       end
+    rescue EOFError
+      # Happens when done.
     end
   end
 

data/{include → lib/http2}/post_request.rb

@@ -1,13 +1,13 @@
-class Http2::PostRequest
-  VALID_ARGUMENTS_POST = [:post, :url, :default_headers, :headers, :json, :method, :cookies, :on_content, :content_type]
-
-  def initialize(http2, args)
-    args.each do |key, val|
-      raise "Invalid key: '#{key}'." unless VALID_ARGUMENTS_POST.include?(key)
+class Http2::PostRequest < Http2::BaseRequest
+  def headers_string
+    unless @headers_string
+      @headers_string = "#{method} /#{@args[:url]} HTTP/1.1#{@nl}"
+      @headers_string << @http2.header_str(headers)
+      @headers_string << @nl
+      @headers_string << @data
     end
 
-    @http2, @args, @debug, @nl = http2, http2.parse_args(args), http2.debug, http2.nl
-    @conn = @http2.connection
+    @headers_string
   end
 
   def execute
@@ -15,10 +15,9 @@ class Http2::PostRequest
 
     @http2.mutex.synchronize do
       puts "Http2: Doing post." if @debug
-      puts "Http2: Header str: #{header_string}" if @debug
 
-      @conn.write(header_string)
-      return @http2.read_response(@args)
+      @conn.write(headers_string)
+      return @http2.read_response(self, @args)
     end
   end
 
@@ -36,7 +35,7 @@ private
     if @args[:content_type]
       @args[:content_type]
     elsif @args[:json]
-      content_type = "application/json"
+      "application/json"
     else
       "application/x-www-form-urlencoded"
     end
@@ -61,22 +60,7 @@ private
       "Content-Type" => content_type
     }
     headers_hash.merge! @http2.default_headers(@args)
-
-    unless headers_hash["Accept"]
-      if @args[:json]
-        headers_hash["Accept"] = "application/json"
-      end
-    end
-
-    return headers_hash
-  end
-
-  def header_string
-    header_str = "#{method} /#{@args[:url]} HTTP/1.1#{@nl}"
-    header_str << @http2.header_str(headers, @args)
-    header_str << @nl
-    header_str << @data
-
-    header_str
+    headers_hash["Accept"] = "application/json" if @args[:json] && !headers_hash["Accept"]
+    headers_hash
   end
 end

data/{include → lib/http2}/response.rb

@@ -1,45 +1,42 @@
-#This object will be returned as the response for each request.
+# This object will be returned as the response for each request.
 class Http2::Response
-  #All the data the response contains. Headers, body, cookies, requested URL and more.
-  attr_reader :args
-  attr_accessor :body, :charset, :code, :content_type, :http_version
-
-  #This method should not be called manually.
-  def initialize(args = {})
-    @args = args
-    @args[:headers] = {} unless @args.key?(:headers)
-    @body = args[:body] || ""
-    @debug = @args[:debug]
-  end
+  # All the data the response contains. Headers, body, cookies, requested URL and more.
+  attr_reader :headers, :request, :request_args, :requested_url
+  attr_accessor :body, :charset, :code, :http_version
+  attr_writer :content_type
 
-  #Returns headers given from the host for the result.
-  #===Examples
-  # headers_hash = res.headers
-  def headers
-    return @args[:headers]
+  # This method should not be called manually.
+  def initialize(body: "", debug: false, headers: {}, request:)
+    @body = body
+    @debug = debug
+    @headers = headers
+    @request = request
+    @requested_url = request.path
   end
 
-  #Returns a certain header by name or false if not found.
+  # Returns a certain header by name or false if not found.
   #===Examples
   # val = res.header("content-type")
   def header(key)
-    return false if !@args[:headers].key?(key)
-    return @args[:headers][key].first.to_s
+    return false unless headers.key?(key)
+
+    headers.fetch(key).first.to_s
   end
 
-  #Returns true if a header of the given string exists.
+  # Returns true if a header of the given string exists.
   #===Examples
   # print "No content-type was given." if !http.header?("content-type")
   def header?(key)
-    return true if @args[:headers].key?(key) && @args[:headers][key].first.to_s.length > 0
-    return false
+    return true if headers.key?(key) && !headers[key].first.to_s.empty?
+
+    false
   end
 
   def content_length
     if header?("content-length")
       header("content-length").to_i
     elsif @body
-      return @body.bytesize
+      @body.bytesize
     else
       raise "Couldn't calculate content-length."
     end
@@ -47,20 +44,12 @@ class Http2::Response
 
   def content_type
     if header?("content-type")
-      return header("content-type")
+      header("content-type")
     else
       raise "No content-type was given."
     end
   end
 
-  #Returns the requested URL as a string.
-  #===Examples
-  # res.requested_url #=> "?show=status&action=getstatus"
-  def requested_url
-    raise "URL could not be detected." unless @args[:request_args][:url]
-    return @args[:request_args][:url]
-  end
-
   # Checks the data that has been sat on the object and raises various exceptions, if it does not validate somehow.
   def validate!
     puts "Http2: Validating response length." if @debug
@@ -69,18 +58,42 @@ class Http2::Response
 
   # Returns true if the result is JSON.
   def json?
-    content_type == "application/json"
+    content_type&.start_with?("application/json")
   end
 
   def json
     @json ||= JSON.parse(body)
   end
 
+  def host
+    @request.http2.host
+  end
+
+  def port
+    @request.http2.port
+  end
+
+  def ssl?
+    @request.http2.ssl?
+  end
+
+  def path
+    @request.path
+  end
+
+  def to_s
+    "#<Http::Response host=\"#{host}\" port=#{port} ssl=#{ssl?} path=\"#{path}\">"
+  end
+
+  def inspect
+    to_s
+  end
+
 private
 
   # Checks that the length of the body is the same as the given content-length if given.
   def validate_body_versus_content_length!
-    unless self.header?("content-length")
+    unless header?("content-length")
       puts "Http2: No content length given - skipping length validation." if @debug
       return nil
     end