httprecognizer 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5d9924478ac865e8df2f2d5428e971ac75b7ba7a
+  data.tar.gz: 8a1e8f00ee817b10742b6ee833126939a14f5e84
+SHA512:
+  metadata.gz: 25a54468702ea1d913b0fd8ec237c8f0102a43005027f6b4e3904790b7f2fb987f60f3c9a3acfc0f754c24ba512e0d61b264e5bcd4c02a318d9352ae436b5d20
+  data.tar.gz: a9864fe1ff6363d6443050e1739f86d839784fbc194014512750b0ab3d4f31515e52b10e9c3c23f2d00b22e5e985338ed390ddebb3d34daaa5cab7147e7202be

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at wyhaines@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in http-no-a-parser.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Kirk Haines
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,37 @@
+# HttpRecognizer
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'httprecognizer'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install httprecognizer
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[wyhaines]/httprecognizer. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "httprecognizer"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/httprecognizer.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'httprecognizer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "httprecognizer"
+  spec.version       = HttpRecognizer::VERSION
+  spec.authors       = ["Kirk Haines"]
+  spec.email         = ["wyhaines@gmail.com"]
+
+  spec.summary       = %q{A very simple implementation of an HTTP Recognizer. Less than a parser, but more than nothing.}
+  spec.description   = %q{The HttpRecognizer receives streamed HTTP, and when it accumulates enough to identify that it's seen an HTTP header, it attempts to extract some basic information from it. This is not a parser, and it is woefully incomplete, but for many tasks it understands just enough HTTP to be useful.}
+  spec.homepage      = "http://github.com/wyhaines/httprecognizer"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.require_paths = ["lib"]
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_runtime_dependency 'deque', '~> 1.0'
+end

data/lib/httprecognizer.rb

@@ -0,0 +1,212 @@
+require 'httprecognizer/constants'
+require 'httprecognizer/version'
+require 'deque'
+
+# Parent expected to provide following API:
+#
+# default_name
+# known_name?
+# keepalive?
+# now
+# logger
+# add_client
+# remove_client
+#
+# This module implements the HTTP handling code. I call it a recognizer,
+# and not a parser because it does not parse HTTP. It is much simpler than
+# that, being designed only to recognize certain useful bits very quickly.
+
+class HttpRecognizer
+  class NotImplemented < Exception; end
+  class Http400Error < Exception; end
+  class Http404Error < Exception; end
+
+  attr_accessor :create_time, :last_action_time, :uri, :unparsed_uri, :associate, :name, :redeployable, :data_pos, :data_len, :peer_ip, :connection_header, :keepalive, :header_data
+
+  # Initialize the @data array, which is the temporary storage for blocks
+  # of data received from the web browser client, then invoke the superclass
+  # initialization.
+
+  def initialize webserver=nil
+    @data = Deque.new
+    @data_pos = 0
+    @connection_header = C_empty
+    @header_missing_pieces = @name = @uri = @unparsed_uri = @http_version = @request_method = @none_match = @done_parsing = @header_data = nil
+    @keepalive = true
+    @webserver = webserver
+  end
+
+  def done_parsing?
+    @done_parsing
+  end
+
+  def reset_state
+    @data.clear
+    @data_pos = 0
+    @connection_header = C_empty
+    @header_missing_pieces = @name = @uri = @unparsed_uri = @http_version = @request_method = @none_match = @done_parsing = @header_data = nil
+    @keepalive = true
+  end
+      
+  # States:
+  # uri
+  # name
+  # \r\n\r\n
+  #   If-None-Match
+  # Done Parsing
+  def receive_data data
+    if @done_parsing
+      @data.unshift data
+      push
+    else
+      if @header_missing_pieces
+        # Hopefully this doesn't happen often.
+        d = @data.to_s << data
+        @header_missing_pieces = false
+      else
+        d = data
+      end
+      unless @uri
+        # It's amazing how, when writing the code, the brain can be in a zone
+        # where line noise like this regexp makes perfect sense, and is clear
+        # as day; one looks at it and it reads like a sentence.  Then, one
+        # comes back to it later, and looks at it when the brain is in a
+        # different zone, and 'lo!  It looks like line noise again.
+        #
+        # data =~ /^(\w+) +(?:\w+:\/\/([^\/]+))?([^ \?]+)\S* +HTTP\/(\d\.\d)/
+        #
+        # In case it looks like line noise to you, dear reader, too:            
+        #
+        # 1) Match and save the first set of word characters.
+        #
+        #    Followed by one or more spaces.
+        #
+        #    Match but do not save the word characters followed by ://
+        #
+        #    2) Match and save one or more characters that are not a slash
+        #
+        #    And allow this whole thing to match 1 or 0 times.
+        #
+        # 3) Match and save one or more characters that are not a question
+        #    mark or a space.
+        #
+        #    Match zero or more non-whitespace characters, followed by one
+        #    or more spaces, followed by "HTTP/".
+        #
+        # 4) Match and save a digit dot digit.
+        #
+        # Thus, this pattern will match both the standard:
+        #   GET /bar HTTP/1.1
+        # style request, as well as the valid (for a proxy) but less common:
+        #   GET http://foo/bar HTTP/1.0
+        #
+        # If the match fails, then this is a bad request, and an appropriate
+        # response will be returned.
+        #
+        # http://www.w3.org/Protocols/rfc2616/rfc2616-sec3.html#sec5.1.2
+        #
+        if d =~ /^(\w+) +(?:\w+:\/\/([^ \/]+))?(([^ \?\#]*)\S*) +HTTP\/(\d\.\d)/
+          @request_method = $1
+          @unparsed_uri = $3
+          @uri = $4
+          @http_version = $5
+          if $2
+            @name = $2.intern
+            @uri = C_slash if @uri.empty?
+            # Rewrite the request to get rid of the http://foo portion.
+            
+            d.sub!(/^\w+ +\w+:\/\/[^ \/]+([^ \?]*)/,"#{@request_method} #{@uri}")
+          end
+          @uri = @uri.tr('+', ' ').gsub(/((?:%[0-9a-fA-F]{2})+)/n) {[$1.delete(C_percent)].pack('H*')} if @uri.include?(C_percent)
+        elsif d.include?(Crn)
+          raise Http400Error
+          return
+        end
+      end
+      unless @name
+        if d =~ /^Host:\s*([^\r\0:]+)\r?\n/m
+          @name = $1.intern
+        end
+      end
+      if d.include?(Crnrn)
+        @name = ( @webserver.respond_to?(:default_name) && @webserver.respond_to?(:known_name?) ) ?
+          ( @webserver.known_name?(@name) ? @name : @webserver.default_name ) :
+          @name
+        if d =~ /If-None-Match: *([^\r]+)/
+          @none_match = $1
+        end
+        @header_data = d.scan(/Cookie:.*/).collect {|c| c =~ /: ([^\r]*)/; $1}
+        @done_parsing = true
+
+        # Keep-Alive works differently on HTTP 1.0 versus HTTP 1.1
+        # HTTP 1.0 was not written to support Keep-Alive initially; it was
+        # bolted on.  Thus, for an HTTP 1.0 client to indicate that it
+        # wants to initiate a Keep-Alive session, it must send a header:
+        #
+        # Connection: Keep-Alive
+        #
+        # Then, when the server sends the response, it must likewise add:
+        #
+        # Connection: Keep-Alive
+        #
+        # to the response.
+        #
+        # For HTTP 1.1, Keep-Alive is assumed.  If a client does not want
+        # Keep-Alive, then it must send the following header:
+        #
+        # Connection: close
+        #
+        # Likewise, if the server does not want to keep the connection
+        # alive, it must send the same header:
+        #
+        # Connection: close
+        #
+        # to the client.
+        
+        if @name
+          unless @webserver.respond_to?(:keepalive) && @webserver.keepalive(@name) == false
+            if @http_version == C1_0
+              if data =~ /Connection: Keep-Alive/i
+                # Nonstandard HTTP 1.0 situation; apply keepalive header.
+                @connection_header = CConnection_KeepAlive
+              else
+                # Standard HTTP 1.0 situation; connection will be closed.
+                @keepalive = false
+                @connection_header = CConnection_close
+              end
+            else # The connection is an HTTP 1.1 connection.
+              if data =~ /Connection: [Cc]lose/
+                # Nonstandard HTTP 1.1 situation; connection will be closed.
+                @keepalive = false
+              end
+            end
+          end
+          
+          @webserver.add_client(self,@data,data) if @webserver.respond_to?(:add_client)
+        else
+          raise Http404Error
+        end           
+      else
+        @data.push data
+        @header_missing_pieces = true
+      end
+    end
+  end
+  
+  # The push method pushes data from the HttpRecognizer to whatever
+  # entity is responsible for handling it. You MUST override this with
+  # something useful.
+
+  def push
+    raise NotImplemented
+  end
+
+  def request_method; @request_method; end
+  def http_version; @http_version; end
+  def none_match; @none_match; end
+
+  def setup_for_redeployment
+    @data_pos = 0
+  end
+
+end

data/lib/httprecognizer/constants.rb

@@ -0,0 +1,14 @@
+class HttpRecognizer
+  C_slash = '/'.freeze
+  C1_0 = '1.0'.freeze
+  C1_1 = '1.1'.freeze
+  CConnection_close = "Connection: close\r\n".freeze
+  CConnection_KeepAlive = "Connection: Keep-Alive\r\n".freeze
+  Crn = "\r\n".freeze
+  Crnrn = "\r\n\r\n".freeze
+  C_empty = ''.freeze
+  C_percent = '%'.freeze
+  Cunknown_host = 'unknown host'.freeze
+  C404Header = "HTTP/1.1 404 Not Found\r\nContent-Type: text/plain\r\nConnection: close\r\n\r\n"
+  C400Header = "HTTP/1.1 400 Bad Request\r\nContent-Type: text/plain\r\nConnection: close\r\n\r\n"
+end

data/lib/httprecognizer/version.rb

@@ -0,0 +1,3 @@
+class HttpRecognizer
+  VERSION = "1.0.1"
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: httprecognizer
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Kirk Haines
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-09-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: deque
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: The HttpRecognizer receives streamed HTTP, and when it accumulates enough
+  to identify that it's seen an HTTP header, it attempts to extract some basic information
+  from it. This is not a parser, and it is woefully incomplete, but for many tasks
+  it understands just enough HTTP to be useful.
+email:
+- wyhaines@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- httprecognizer.gemspec
+- lib/httprecognizer.rb
+- lib/httprecognizer/constants.rb
+- lib/httprecognizer/version.rb
+homepage: http://github.com/wyhaines/httprecognizer
+licenses:
+- MIT
+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.5.1
+signing_key: 
+specification_version: 4
+summary: A very simple implementation of an HTTP Recognizer. Less than a parser, but
+  more than nothing.
+test_files: []