http2 0.0.31 → 0.0.32

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 00dd7c4f177f2a7c84ef8f9ef463fe6f2675a400
-  data.tar.gz: 7c28395bf02c20a50d2b8633e6ddd8156c8972f3
+  metadata.gz: 5a6f33cdd27db12f717a7364f0b01e003fa136f4
+  data.tar.gz: e5db49475ea7e1d94d3637273098d3e5fa3c40ba
 SHA512:
-  metadata.gz: bdc915bf5453cb50d0d58e298f661b833d5086f370d66bfda2e5f654d01572ea4880f340d99dd3e6853abfd20e6d3a7bed5892758add2ad4c7187087f71e59b4
-  data.tar.gz: 54923d3a26cfe73698df0fbde92cd1dd517b61efaad45e77102fb469716d3efc4833b337bb2d915fb367d826e6370b5e068e6175a8ea7884b6b14bc9069f3024
+  metadata.gz: d1502af03635d87d6c13253a5f160fb697cf83f5489a99e0b2de1ed7ce3a59b38cc11c970a4848fedc8ab6ddb88c24af31d2d651360b3081ee23a12bf6700770
+  data.tar.gz: f4ac8597f0752a57342e0166a1bf017fc1f320d1eda7b093e7706eec8320827a5f895b320fc6bfe9e55b19dee6e58a59c62a0710a90b9cc0a177be1d5176b5f2

data/README.md

@@ -1,4 +1,4 @@
-[![Build Status](https://api.shippable.com/projects/540e7b9b3479c5ea8f9ec21d/badge?branchName=master)](https://app.shippable.com/projects/540e7b9b3479c5ea8f9ec21d/builds/latest)
+[![Build Status](https://img.shields.io/shippable/540e7b9b3479c5ea8f9ec21d.svg)](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)
 
@@ -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,7 +1,7 @@
 # encoding: utf-8
 
-require 'rubygems'
-require 'bundler'
+require "rubygems"
+require "bundler"
 begin
   Bundler.setup(:default, :development)
 rescue Bundler::BundlerError => e
@@ -9,29 +9,32 @@ rescue Bundler::BundlerError => e
   $stderr.puts "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.rb

@@ -3,7 +3,7 @@ require "uri"
 require "monitor" unless ::Kernel.const_defined?(:Monitor)
 require "string-cases"
 
-#This class tries to emulate a browser in Ruby without any visual stuff. Remember cookies, keep sessions alive, reset connections according to keep-alive rules and more.
+# This class tries to emulate a browser in Ruby without any visual stuff. Remember cookies, keep sessions alive, reset connections according to keep-alive rules and more.
 #===Examples
 # Http2.new(host: "www.somedomain.com", port: 80, ssl: false, debug: false) do |http|
 #  res = http.get("index.rhtml?show=some_page")
@@ -17,8 +17,8 @@ require "string-cases"
 class Http2
   # Autoloader for subclasses.
   def self.const_missing(name)
-    require "#{File.dirname(__FILE__)}/../include/#{::StringCases.camel_to_snake(name)}.rb"
-    return Http2.const_get(name)
+    require "#{File.dirname(__FILE__)}/http2/#{::StringCases.camel_to_snake(name)}.rb"
+    Http2.const_get(name)
   end
 
   # Converts a URL to "is.gd"-short-URL.
@@ -45,17 +45,21 @@ class Http2
       begin
         yield(self)
       ensure
-        self.destroy
+        destroy
       end
     end
   end
 
   def host
-    @args[:host]
+    @args.fetch(:host)
   end
 
   def port
-    @args[:port]
+    @args.fetch(:port)
+  end
+
+  def ssl?
+    @args[:ssl] ? true : false
   end
 
   def reconnect
@@ -68,7 +72,7 @@ class Http2
     builder.port = port
     builder.protocol = @args[:protocol]
 
-    return builder
+    builder
   end
 
   # Closes current connection if any, changes the arguments on the object and reconnects keeping all cookies and other stuff intact.
@@ -104,9 +108,9 @@ class Http2
       raise "Invalid arguments: '#{args.class.name}'"
     end
 
-    raise "Invalid URL: '#{args[:url]}'" unless args[:url].to_s.split("\n").length == 1
+    raise "Invalid URL: '#{args[:url]}'" if args[:url] != "" && args[:url].to_s.split("\n").length != 1
 
-    return args
+    args
   end
 
   # Returns a result-object based on the arguments.
@@ -154,7 +158,7 @@ class Http2
 
     headers.merge!(@args[:extra_headers]) if @args[:extra_headers]
     headers.merge!(args[:headers]) if args[:headers]
-    return headers
+    headers
   end
 
   # Posts to a certain page.
@@ -172,7 +176,7 @@ class Http2
   end
 
   # Returns a header-string which normally would be used for a request in the given state.
-  def header_str(headers_hash, args = {})
+  def header_str(headers_hash)
     headers_hash["Cookie"] = cookie_header_string
 
     headers_str = ""
@@ -180,21 +184,21 @@ class Http2
       headers_str << "#{key}: #{val}#{@nl}"
     end
 
-    return headers_str
+    headers_str
   end
 
   def cookie_header_string
     cstr = ""
 
     first = true
-    @cookies.each do |cookie_name, cookie|
+    @cookies.each do |_cookie_name, cookie|
       cstr << "; " unless first
       first = false if first
       ensure_single_lines([cookie.name, cookie.value])
       cstr << "#{Http2::Utils.urlenc(cookie.name)}=#{Http2::Utils.urlenc(cookie.value)}"
     end
 
-    return cstr
+    cstr
   end
 
   def cookie(name)
@@ -216,8 +220,8 @@ class Http2
   # Reads the response after posting headers and data.
   #===Examples
   # res = http.read_response
-  def read_response(args = {})
-    ::Http2::ResponseReader.new(http2: self, sock: @sock, args: args).response
+  def read_response(request, args = {})
+    ::Http2::ResponseReader.new(http2: self, sock: @sock, args: args, request: request).response
   end
 
   def to_s
@@ -231,13 +235,13 @@ class Http2
 private
 
   def host_header
-    #Possible to give custom host-argument.
+    # Possible to give custom host-argument.
     host = args[:host] || self.host
     port = args[:port] || self.port
 
     host_header_string = "#{host}" # Copy host string to avoid changing the original string if port has been given!
     host_header_string << ":#{port}" if port && ![80, 443].include?(port.to_i) && !@args[:skip_port_in_host_header]
-    return host_header_string
+    host_header_string
   end
 
   # Registers the states from a result.
@@ -247,7 +251,6 @@ private
 
     res.body.to_s.scan(/<input type="hidden" name="__(EVENTTARGET|EVENTARGUMENT|VIEWSTATE|LASTFOCUS)" id="(.*?)" value="(.*?)" \/>/) do |match|
       name = "__#{match[0]}"
-      id = match[1]
       value = match[2]
 
       puts "Http2: Registered autostate-value with name '#{name}' and value '#{value}'." if @debug
@@ -266,14 +269,14 @@ private
     args = {host: args} if args.is_a?(String)
     raise "Arguments wasnt a hash." unless args.is_a?(Hash)
 
-    args.each do |key, val|
+    args.each do |key, _val|
       raise "Invalid key: '#{key}'." unless VALID_ARGUMENTS_INITIALIZE.include?(key)
     end
 
     args[:proxy][:connect] = true if args[:proxy] && !args[:proxy].key?(:connect) && args[:ssl]
 
     raise "No host was given." unless args[:host]
-    return args
+    args
   end
 
   def set_default_values
@@ -281,7 +284,7 @@ private
     @autostate_values = {} if autostate
     @nl = @args[:nl] || "\r\n"
 
-    if !@args[:port]
+    unless @args[:port]
       if @args[:ssl]
         @args[:port] = 443
       else

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]
+
+  def initialize(http2, args)
+    @http2 = http2
+    @args = http2.parse_args(args)
+    @debug = http2.debug
+    @nl = http2.nl
+
+    @args.each do |key, _val|
+      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
@@ -46,10 +45,12 @@ 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 +62,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 +85,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 +95,7 @@ class Http2::Connection
       end
     end
 
-    return true
+    true
   end
 
   # Closes the current connection if any.

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/{include → lib/http2}/errors.rb

@@ -1,4 +1,4 @@
-#This class holds various classes for error-handeling.
+# This class holds various classes for error-handeling.
 class Http2::Errors
   class Http2error < RuntimeError
     attr_accessor :response

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]

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)
@@ -55,10 +57,12 @@ private
   def read_file(path, praw)
     File.open(path, "r") do |fp|
       begin
-        while data = fp.sysread(4096)
+        while (data = fp.sysread(4096))
           praw << data
         end
+      # rubocop:disable Lint/HandleExceptions
       rescue EOFError
+        # rubocop:enable Lint/HandleExceptions
         # Happens when done.
       end
     end