hatetepe 0.5.2 → 0.6.0.pre

data/.gitignore

@@ -0,0 +1,7 @@
+*.gem
+.bundle/
+coverage/
+doc/
+.yardoc/
+measurements/
+Gemfile.lock

data/.rspec

@@ -0,0 +1,3 @@
+--order rand
+--color
+--format Fuubar

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 1.9.3
+script: bundle exec rake ci:metrics

data/.yardopts

@@ -0,0 +1 @@
+- LICENSE

data/Gemfile

@@ -1,8 +1,13 @@
-source "https://rubygems.org"
+# encoding: utf-8
 
-ruby "1.9.3"
+source 'https://rubygems.org'
 
 gemspec
 
-gem "rake"
-gem "awesome_print"
+gem 'devtools', git: 'https://github.com/rom-rb/devtools.git'
+gem 'fuubar',   git: 'https://github.com/lgierth/fuubar.git',
+                ref: 'static-percentage'
+gem 'awesome_print'
+
+# Added by devtools
+eval_gemfile 'Gemfile.devtools'

data/Gemfile.devtools

@@ -0,0 +1,55 @@
+# encoding: utf-8
+
+group :development do
+  gem 'rake',  '~> 10.1.0'
+  gem 'rspec', '~> 2.14.1'
+  gem 'yard',  '~> 0.8.7'
+end
+
+group :yard do
+  gem 'kramdown', '~> 1.2.0'
+end
+
+group :guard do
+  gem 'guard',         '~> 1.8.1'
+  gem 'guard-bundler', '~> 1.0.0'
+  gem 'guard-rspec',   '~> 3.0.2'
+  gem 'guard-rubocop', '~> 0.2.0'
+  gem 'guard-mutant',  '~> 0.0.1'
+
+  # file system change event handling
+  gem 'listen',     '~> 1.3.0'
+  gem 'rb-fchange', '~> 0.0.6', require: false
+  gem 'rb-fsevent', '~> 0.9.3', require: false
+  gem 'rb-inotify', '~> 0.9.0', require: false
+
+  # notification handling
+  gem 'libnotify',               '~> 0.8.0', require: false
+  gem 'rb-notifu',               '~> 0.0.4', require: false
+  gem 'terminal-notifier-guard', '~> 1.5.3', require: false
+end
+
+group :metrics do
+  gem 'coveralls', '~> 0.6.7'
+  gem 'flay',      '~> 2.4.0'
+  gem 'flog',      '~> 4.1.1'
+  gem 'reek',      '~> 1.3.2'
+  gem 'rubocop',   '~> 0.12.0'
+  gem 'simplecov', '~> 0.7.1'
+  gem 'yardstick', '~> 0.9.7', git: 'https://github.com/dkubb/yardstick.git'
+
+  platforms :ruby_19, :ruby_20 do
+    gem 'mutant', git: 'https://github.com/mbj/mutant.git'
+    gem 'yard-spellcheck', '~> 0.1.5'
+  end
+end
+
+group :benchmarks do
+  gem 'rbench', '~> 0.2.3'
+end
+
+platform :jruby do
+  group :jruby do
+    gem 'jruby-openssl', '~> 0.8.5'
+  end
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Lars Gierth
+
+MIT License
+
+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

@@ -1,206 +1,53 @@
-The HTTP Toolkit [![Build Status](https://secure.travis-ci.org/lgierth/hatetepe.png?branch=master)](http://travis-ci.org/lgierth/hatetepe) [![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/lgierth/hatetepe)
-================
+# Hatetepe
 
-Hatetepe is a framework for building HTTP servers, clients and proxies using the
-Ruby programming language. It makes use of EventMachine and uses a Fiber for
-each request/response cycle to ensure maximum efficiency. It has some great
-features that make it a good choice for building HTTP APIs.
+The HTTP toolkit
 
-Install it via `gem install hatetepe` or add `gem "hatetepe"` to your Gemfile.
+## Installation
 
-Hatetepe only implements core HTTP functionality. If you need stuff like
-automatic JSON or form-data encoding, have a look at
-[Faraday](https://github.com/technoweenie/faraday), there's also an
-[Hatetepe adapter](https://github.com/technoweenie/faraday/pull/108)
-for it being worked on.
+Add this line to your application's Gemfile:
 
+    gem 'hatetepe'
 
-Getting Started (Server)
-------------------------
+And then execute:
 
-Using Hatetepe as your HTTP server is easy. Simply use the CLI that ships with
-the gem:
+    $ bundle
 
-    $ hatetepe
-    We're in development
-    Booting from /home/lars/workspace/hatetepe/config.ru
-    Binding to 127.0.0.1:3000
+Or install it yourself as:
 
-You can configure the network port and interface as well as the Rackup (.ru)
-file to be used and the RACK_ENV to run in. More help is available via the
-`hatetepe help` command.
+    $ gem install hatetepe
 
+## Usage
 
-Getting Started (Client)
-------------------------
+TODO: Write usage instructions here
 
-The `Hatetepe::Client` class can be used to make requests to an HTTP server.
+## To do
 
-    client = Hatetepe::Client.start(:host => "example.org", :port => 80)
+- Next
+  - Error handling
+  - Unit tests
+  - Method/Status semantics (GET/HEAD/204/etc.)
+  - Host header
+  - Documentation
+  - Replace into hatetepe-dev
+  - Deprecate hatetepe-0.5
+- Future
+  - SSL support
+  - Webmachine adapter
+  - Request/Response pass-through
+  - Graceful shutdown
+  - Celluloid::IO backend
+  - Circuit breaker
+- Nice to have
+  - Rack handler
+  - Faraday adapter
+  - Following redirects
+  - Proxy support
+  - Client handling multipart responses
 
-    request = Hatetepe::Request.new(:post, "/search", {}, :q => "herp derp")
-    client << request
+## Contributing
 
-    request.callback do |response|
-      puts "Results:"
-      puts response.body.read
-    end
-    request.errback do |response|
-      puts "Error Code: #{response.status}"
-    end
-
-`Request` and `Response` objects are mostly the same, they offer:
-
-- `#verb` (only `Request`)
-- `#uri` (only `Request`)
-- `#status` (only `Response`)
-- `#http_version`
-- `#headers`
-- `#body`
-
-`Request` also has `#to_h` which will turn the object into something your
-app can respond to.
-
-
-Async Responses
----------------
-
-Like Thin and Goliath, Hatetepe provides `env["async.callback"]` for responding
-in an asynchronous fashion. Don't forget to synchronously indicate an
-asynchronous response by responding with a status of `-1`.
-
-    def call(env)
-      EM.add_timer(5) do
-        env["async.callback"].call [200, {"Content-Type" => "text/html"}, ["Hello!"]]
-      end
-      [-1]
-    end
-
-The reactor won't block while waiting for the timer to kick in, it will
-instead process other requests meanwhile.
-
-
-Proxying
---------
-
-You can easily proxy a request to another HTTP server. The response will be
-proxied back to the original client automatically. Remember to return an
-async response.
-
-    def call(env)
-      env["proxy.start"].call "http://intra.example.org/derp"
-      [-1]
-    end
-
-This will internally just call `env["proxy.callback"]` (which defaults to
-`env["async.callback"]`). So if you want to send the response yourself, just
-override `env["proxy.callback"]`.
-
-If you want to reuse proxy connections (e.g. when doing Connection Pooling),
-simply create a `Client` instance and pass it to `env["proxy.start"]`.
-
-    env["proxy.start"].call "http://intra.example.org/derp", pool.acquire
-
-The reactor won't block while waiting for the proxy endpoint's response,
-it will instead process other requests meanwhile.
-
-
-Response Streaming
-------------------
-
-Streaming a response is easy. Just make your Rack app return a `-1` status code
-and use the `stream.start`, `stream.send` and `stream.close` helpers.
-
-    def call(env)
-      EM.add_timer 0.5 do
-        env["stream.start"].call [200, {"Content-Type" => "text/plain"}]
-      end
-      
-      1.upto 3 do |i|
-        EM.add_timer i do
-          env["stream.send"].call "I feel alive!\n"
-          env["stream.close"].call if i == 3
-        end
-      end
-      
-      [-1]
-    end
-
-There's no limit on how long you can stream, keep in mind though that you might
-hit timeouts. You can occasionally send LFs or something similar to prevent this
-from happening.
-
-
-Sending and Receiving BLOBs
----------------------------
-
-Hatetepe provides a thin wrapper around StringIO that makes it easier to handle
-streaming of request and response bodies. That means your app will be `#call`ed
-as soon as all headers have arrived. It can then do stuff while it's still
-receiving body data. You might for example want to track upload progress.
-
-    received = nil
-    total = nil
-
-    post "/upload" do
-      total = request.headers["Content-Length"].to_i
-      request.env["rack.input"].each do |chunk|
-        received += chunk.bytesize
-      end
-      request.env["rack.input"].rewind
-    end
-    
-    get "/progress" do
-      json [received, total]
-    end
-
-`Hatetepe::Body#each` will block until the response has been received completely
-and yield each time a new chunk arrives. Calls to `#read`, `#gets` and `#length`
-will block until everything arrived and then return their normal return value
-as expected. `Body` includes `EM::Deferrable`, meaning you can attach
-callbacks to it. `#close_write` will succeed it - this is important if you
-want to make a request with a streaming body.
-
-
-Contributing
-------------
-
-1. Fork at [github.com/lgierth/hatetepe](https://github.com/lgierth/hatetepe)
-2. Create a new branch
-3. Commit, commit, commit!
-4. Open a Pull Request
-
-You can also open an issue for discussion first, if you like.
-
-
-License
--------
-
-Hatetepe is subject to an MIT-style license (see LICENSE file).
-
-
-Roadmap
--------
-
-- 0.6.0
-  - Direct recv<->send IO via EM.enable_proxy
-  - SSL/TLS
-  - HTTP proxying (in client and server)
-- later
-  - Encoding support (ref. [github.com/tmm1/http_parser.rb#1](https://github.com/tmm1/http_parser.rb/pull/1))
-  - Optimize for performance
-  - Propagate connection errors to the app
-
-Ideas
------
-
-- Support for rubygems-test
-- Code reloading
-- Preforking
-- MVM support via Thread Pool
-- Support for SPDY
-- Serving via filesystem or in-memory
-- Foreman support
-- Daemonizing and dropping privileges
-- Trailing headers
-- REPL for Server and Client
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -1,4 +1,5 @@
 task :default => :spec
 
-require "rspec/core/rake_task"
-RSpec::Core::RakeTask.new :spec
+# Added by devtools
+require 'devtools'
+Devtools.init_rake_tasks

data/bin/hatetepe

@@ -1,4 +1,37 @@
 #!/usr/bin/env ruby
+# encoding: utf-8
 
-require "hatetepe/cli"
-Hatetepe::CLI.start
+require 'ap'
+require 'hatetepe'
+
+class RequestHandler
+  def initialize(config, server, connection)
+  end
+
+  def serve(request)
+    request.finished.then do
+      puts "#{request.http_method.upcase} #{request.uri}"
+      response = build_response
+      request.served.fulfill(response)
+      response.finished.fulfill
+    end
+  end
+
+  def build_response
+    Hatetepe::Response.new(
+      200, { 'Content-Type' => 'text/plain' }, "hello, world\n")
+  end
+end
+
+address = ENV.fetch('ADDRESS', '127.0.0.1')
+port    = ENV.fetch('PORT',    3000)
+
+$stdout.sync = true
+
+EM.run do
+  puts "Listening on http://#{address}:#{port}"
+  Hatetepe::Server.start(address:  address, port: port,
+                     handlers: [Hatetepe::Server::KeepAlive,
+                                Hatetepe::Server::Timeouts,
+                                RequestHandler])
+end

data/config/devtools.yml

@@ -0,0 +1,2 @@
+---
+unit_test_timeout: 0.1

data/config/flay.yml

@@ -0,0 +1,3 @@
+---
+threshold: 10
+total_score: 160

data/config/flog.yml

@@ -0,0 +1,2 @@
+---
+threshold: 9.6

data/config/mutant.yml

@@ -0,0 +1,3 @@
+---
+name: hatetepe
+namespace: Hatetepe

data/config/reek.yml

@@ -0,0 +1,103 @@
+---
+Attribute:
+  enabled: true
+  exclude: []
+BooleanParameter:
+  enabled: true
+  exclude: []
+ClassVariable:
+  enabled: true
+  exclude: []
+ControlParameter:
+  enabled: true
+  exclude: []
+DataClump:
+  enabled: true
+  exclude: []
+  max_copies: 2
+  min_clump_size: 2
+DuplicateMethodCall:
+  enabled: true
+  exclude: []
+  max_calls: 1
+  allow_calls: []
+FeatureEnvy:
+  enabled: true
+  exclude: []
+IrresponsibleModule:
+  enabled: true
+  exclude: []
+LongParameterList:
+  enabled: true
+  exclude: []
+  max_params: 2
+  overrides:
+    initialize:
+      max_params: 3
+LongYieldList:
+  enabled: true
+  exclude: []
+  max_params: 2
+NestedIterators:
+  enabled: true
+  exclude: []
+  max_allowed_nesting: 1
+  ignore_iterators: []
+NilCheck:
+  enabled: true
+  exclude: []
+RepeatedConditional:
+  enabled: true
+  exclude: []
+  max_ifs: 1
+TooManyInstanceVariables:
+  enabled: true
+  exclude: []
+  max_instance_variables: 3
+TooManyMethods:
+  enabled: true
+  exclude: []
+  max_methods: 10
+TooManyStatements:
+  enabled: true
+  exclude:
+  - each
+  max_statements: 2
+UncommunicativeMethodName:
+  enabled: true
+  exclude: []
+  reject:
+  - !ruby/regexp /^[a-z]$/
+  - !ruby/regexp /[0-9]$/
+  - !ruby/regexp /[A-Z]/
+  accept: []
+UncommunicativeModuleName:
+  enabled: true
+  exclude: []
+  reject:
+  - !ruby/regexp /^.$/
+  - !ruby/regexp /[0-9]$/
+  accept: []
+UncommunicativeParameterName:
+  enabled: true
+  exclude: []
+  reject:
+  - !ruby/regexp /^.$/
+  - !ruby/regexp /[0-9]$/
+  - !ruby/regexp /[A-Z]/
+  accept: []
+UncommunicativeVariableName:
+  enabled: true
+  exclude: []
+  reject:
+  - !ruby/regexp /^.$/
+  - !ruby/regexp /[0-9]$/
+  - !ruby/regexp /[A-Z]/
+  accept: []
+UnusedParameters:
+  enabled: true
+  exclude: []
+UtilityFunction:
+  enabled: true
+  exclude: []
+  max_helper_calls: 0

data/config/rubocop.yml

@@ -0,0 +1,58 @@
+AllCops:
+  Includes:
+    - '**/*.rake'
+    - 'Gemfile'
+    - 'Gemfile.devtools'
+  Excludes:
+    - '**/vendor/**'
+    - '**/benchmarks/**'
+
+# Avoid parameter lists longer than five parameters.
+ParameterLists:
+  Max: 4
+  CountKeywordArgs: true
+
+# Avoid more than `Max` levels of nesting.
+BlockNesting:
+  Max: 3
+
+# Align with the style guide.
+CollectionMethods:
+  PreferredMethods:
+    collect:  'map'
+    inject:   'reduce'
+    find:     'detect'
+    find_all: 'select'
+
+# Do not force public/protected/private keyword to be indented at the same
+# level as the def keyword. My personal preference is to outdent these keywords
+# because I think when scanning code it makes it easier to identify the
+# sections of code and visually separate them. When the keyword is at the same
+# level I think it sort of blends in with the def keywords and makes it harder
+# to scan the code and see where the sections are.
+AccessControl:
+  Enabled: false
+
+# Limit line length
+LineLength:
+  Max: 79
+
+# Disable documentation checking until a class needs to be documented once
+Documentation:
+  Enabled: false
+
+# Do not favor modifier if/unless usage when you have a single-line body
+IfUnlessModifier:
+  Enabled: false
+
+# Allow case equality operator (in limited use within the specs)
+CaseEquality:
+  Enabled: false
+
+# Constants do not always have to use SCREAMING_SNAKE_CASE
+ConstantName:
+  Enabled: false
+
+# Not all trivial readers/writers can be defined with attr_* methods
+TrivialAccessors:
+  Enabled: false

data/config/yardstick.yml

@@ -0,0 +1,2 @@
+---
+threshold: 52.5

data/hatetepe.gemspec

@@ -1,31 +1,27 @@
-# -*- encoding: utf-8 -*-
-$:.push File.expand_path("../lib", __FILE__)
-require "hatetepe/version"
-require "date"
+# encoding: utf-8
 
-Gem::Specification.new do |s|
-  s.name        = "hatetepe"
-  s.version     = Hatetepe::VERSION
-  s.date        = Date.today.to_s
-  s.platform    = Gem::Platform::RUBY
-  s.authors     = ["Lars Gierth"]
-  s.email       = ["lars.gierth@gmail.com"]
-  s.homepage    = "https://github.com/lgierth/hatetepe"
-  s.summary     = %q{The HTTP toolkit}
-  #s.description = %q{TODO: write description}
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'hatetepe/version'
 
-  s.add_dependency "http_parser.rb", "~> 0.6.0.beta.2"
-  s.add_dependency "eventmachine",   "~> 1.0.0.beta.4"
-  s.add_dependency "em-synchrony",   "~> 1.0"
-  s.add_dependency "rack"
-  s.add_dependency "thor"
-  
-  s.add_development_dependency "rspec"
-  s.add_development_dependency "yard"
-  s.add_development_dependency "kramdown"
+Gem::Specification.new do |spec|
+  spec.name          = "hatetepe"
+  spec.version       = Hatetepe::VERSION
+  spec.authors       = ["Lars Gierth"]
+  spec.email         = ["lars.gierth@gmail.com"]
+  spec.description   = %q{The HTTP toolkit}
+  spec.summary       = %q{General purpose toolkit for HTTP clients and servers}
+  spec.homepage      = "https://github.com/lgierth/hatetepe"
+  spec.license       = "MIT"
 
-  s.files         = `git ls-files`.split("\n") - [".gitignore", ".rspec", ".travis.yml", ".yardopts"]
-  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
-  s.require_paths = ["lib"]
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^spec/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "eventmachine"
+  spec.add_dependency "http_parser.rb"
+  spec.add_dependency "promise.rb"
+
+  spec.add_development_dependency "rspec"
 end