minver 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3d4c1636a148271f9102e1c53bbb4eb9c6404523
+  data.tar.gz: 6d8aee43656fb56755daecf1e51c83ff49cc94a0
+SHA512:
+  metadata.gz: 9d63a5e430c927c335d5693206a928f6055b1d46869e1cffe739c47cf4216e2d21d030082351b944872636432aa5cda2844699218957d4898354b40397505ebf
+  data.tar.gz: fe2978bf5237e338584c54210d06a1dace55f5360b8ee94b2b7707812e0ae8eb07180eab00284c58119a8616b973adc5604c0d008a21c2c360f0000a8d1f85cc

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Danyel Bayraktar
+
+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

@@ -0,0 +1,85 @@
+# Minver
+
+This gem provides a minimal HTTP server solution with two key features:
+
+1. Graceful shutdown of the server
+2. The caller can retrieve a value that is generated from the route handler
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'minver'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install minver
+
+## Usage
+
+This gem allows you to wait for user input via HTTP requests. For example:
+
+```ruby
+require 'minver'
+
+# initialize server. default port is 18167, default bind is '::'
+server = Minver::Base.new port: 3000
+
+# Define your routes:
+
+server.post "/name" do |request|
+  name = request.params["name"]
+  # pass this param to the caller
+  pass name: name
+  "Thanks, #{name}, your personal information was submitted."
+end
+
+server.post "/age" do |request|
+  age = request.params["age"].to_i
+  # pass this param to the caller
+  if age < 5
+    [400, {}, "Hey there, fella. You better ask your parents to use this app instead."]
+  else
+    pass age: age
+    "Thank you, your age has been submitted!"
+  end
+end
+
+# We're ready to go! Instantiate the hash where we store the info:
+
+personal_info = {}
+
+# And listen for requests!
+
+loop do
+  $stdout.puts "Provide your personal information over http://localhost:3000/name and /age"
+  personal_info.merge!(server.run)
+  break if personal_info.key?(:name) && personal_info.key?(:age)
+end
+
+# Now go to your terminal and make a request!
+# e.g.:
+# curl -XPOST -H"Content-Type: application/json" -d'{"name": "Danyel Bayraktar"}' localhost:3000/name
+# or:
+# curl -XPOST -d'age=3' localhost:3000/age
+
+
+# Do something with this information!
+puts "Hey #{personal_info[:name]}, #{personal_info[:age]} years is the best age to be starring my repo!"
+
+# Don't forget to shut down the server
+# (you can also call `stop` instead of `pass` from the route handler while still providing a value):
+server.stop
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/minver/fork )
+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 a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/minver/base.rb

@@ -0,0 +1,145 @@
+require 'socket'
+require 'minver/request'
+require 'minver/response'
+require 'minver/request_error'
+
+module Minver
+  class Base
+
+    HTTP_VERSION = "1.1"
+    HTTP_METHODS = %w(GET POST PATCH PUT DELETE HEAD)
+    HTTP_CODES = {
+      100 => "Continue",
+      101 => "Switching Protocols",
+      103 => "Checkpoint",
+      200 => "OK",
+      201 => "Created",
+      202 => "Accepted",
+      203 => "Non-Authoritative Information",
+      204 => "No Content",
+      205 => "Reset Content",
+      206 => "Partial Content",
+      300 => "Multiple Choices",
+      301 => "Moved Permanently",
+      302 => "Found",
+      303 => "See Other",
+      304 => "Not Modified",
+      306 => "Switch Proxy",
+      307 => "Temporary Redirect",
+      308 => "Resume Incomplete",
+      400 => "Bad Request",
+      401 => "Unauthorized",
+      402 => "Payment Required",
+      403 => "Forbidden",
+      404 => "Not Found",
+      405 => "Method Not Allowed",
+      406 => "Not Acceptable",
+      407 => "Proxy Authentication Required",
+      408 => "Request Timeout",
+      409 => "Conflict",
+      410 => "Gone",
+      411 => "Length Required",
+      412 => "Precondition Failed",
+      413 => "Request Entity Too Large",
+      414 => "Request-URI Too Long",
+      415 => "Unsupported Media Type",
+      416 => "Requested Range Not Satisfiable",
+      417 => "Expectation Failed",
+      422 => "Unprocessable Entity",
+      423 => "Locked",
+      424 => "Failed Dependency",
+      500 => "Internal Server Error",
+      501 => "Not Implemented",
+      502 => "Bad Gateway",
+      503 => "Service Unavailable",
+      504 => "Gateway Timeout",
+      505 => "HTTP Version Not Supported",
+      511 => "Network Authentication Required"
+    }
+
+    def initialize(**options, &block)
+      @bind = options.fetch(:bind, '::')
+      @port = options.fetch(:port, 18167)
+      @clients = []
+      instance_eval(&block) if block_given?
+    end
+
+    def server
+      @server ||= TCPServer.new @bind, @port
+    end
+
+    def on(method, uri, &block)
+      triggers[method][normalize_path(uri)] = block
+    end
+
+    HTTP_METHODS.each do |method|
+      define_method method.downcase do |uri, &block|
+        on(method, uri, &block)
+      end
+    end
+
+    def run(**options)
+      $stderr.puts "Listening on #{@bind}:#{@port}." if $DEBUG
+      loop do
+        result = IO.select([server, *@clients], *([nil, nil, 0] if options[:nonblock]))
+        return unless result
+        result.first.each do |client|
+          # it's possible that "client" here is the server so we extract the client from it.
+          @clients << (client = client.accept) if client.respond_to?(:accept)
+          if client.eof?
+            @clients.delete(client).close
+            next
+          end
+          begin
+            request = Request.new(client)
+            $stderr.puts request.data.lines.map{|l| "< #{l}"} if $DEBUG
+            block = triggers[request.http_method][normalize_path(request.path)]
+            response = if block
+              begin
+                Response.from(instance_exec(request, &block))
+              rescue => e
+                raise RequestError.new(
+                  "An error occurred. Check the logs or ask the administrator.",
+                  500,
+                  cause: e
+                )
+              end
+            else
+              raise RequestError.new("The resource you were looking for does not exist.", 404)
+            end
+            if @should_pass
+              @should_pass = false
+              return @return_value
+            end
+          rescue RequestError => e
+            response = Response.from([e.code, e.headers, e.message])
+            raise e.cause || e if (500..599).include? e.code
+          ensure
+            $stderr.puts response.data.lines.map{|l| "> #{l}"} if $DEBUG
+            client.write(response.data)
+          end
+        end
+      end
+    end
+
+    def stop return_value=nil
+      pass return_value
+      server.close
+    end
+
+    def pass return_value
+      @should_pass = true
+      @return_value = return_value
+    end
+
+  protected
+
+    def normalize_path(path)
+      path.squeeze("/").chomp "/"
+    end
+
+    def triggers
+      @triggers ||= HTTP_METHODS.inject({}){ |h, m| h.merge(m => {}) }
+    end
+  end
+end

data/lib/minver/parser.rb

@@ -0,0 +1,72 @@
+require 'stringio'
+
+module Minver
+  class Parser
+    def initialize(stream_or_string)
+      @stream = if stream_or_string.is_a? String
+        StringIO.new(stream_or_string)
+      else
+        stream_or_string
+      end
+    end
+
+    def http_method
+      @http_method ||= request_match[1]
+    end
+
+    def request_url
+      @request_url ||= request_match[2]
+    end
+
+    def request_http_version
+      @request_http_version ||= request_match[3]
+    end
+
+    def headers
+      @headers ||= header_lines.inject({}) do |h, line|
+        h.merge(Hash[[line.rstrip.split(': ', 2)]])
+      end
+    end
+
+    def [](key)
+      headers[key]
+    end
+
+    def data
+      @data ||= [*head, body].join
+    end
+
+    def body
+      @body ||= @stream.read(headers["Content-Length"].to_i)
+    end
+
+    def path
+      @path ||= request_url.split('?')[0]
+    end
+
+    def query_string
+      @query_string ||= request_url.split('?')[1] || ''
+    end
+
+  protected
+    def request_match
+      @request_match ||= request_line.match(/(\S+)\s+(\S+)(?:\s+HTTP\/(\S+)?)/)
+    end
+
+    def request_line
+      @request_line ||= head.lines.first
+    end
+
+    def header_lines
+      @header_lines ||= head.lines[1...-1]
+    end
+
+    def head
+      @head ||= "".tap do |h|
+        begin
+          h << line = @stream.readline # TODO: non-blocking
+        end until ["\r\n", "\n"].include? line
+      end
+    end
+  end
+end

data/lib/minver/request.rb

@@ -0,0 +1,43 @@
+require 'minver/parser'
+require 'uri'
+require 'yaml'
+
+module Minver
+  class Request
+    attr_reader :params
+
+    def initialize(client)
+      @client = client
+      @params = Hash[URI.decode_www_form(parser.query_string)].tap do |params|
+        begin
+          puts headers.to_yaml if $DEBUG
+          params.merge! case type = headers["Content-Type"]
+          when 'application/json'
+            require 'json'
+            JSON.parse(body)
+          when 'application/x-www-form-urlencoded'
+            Hash[URI.decode_www_form(body)]
+          else
+            {}
+          end
+        rescue => e
+          raise RequestError.new(
+            "The given content-type is not recognized or the content data is malformed.",
+            400,
+            cause: e
+          )
+        end
+      end
+    end
+
+    [:http_method, :headers, :[], :path, :data, :body].each do |method|
+      define_method method do
+        parser.public_send(method)
+      end
+    end
+
+    def parser
+      @parser ||= Minver::Parser.new(@client)
+    end
+  end
+end

data/lib/minver/request_error.rb

@@ -0,0 +1,13 @@
+module Minver
+  class RequestError < StandardError
+    attr_reader :code, :message, :headers, :cause
+
+    def initialize(message, code, headers: {}, cause: nil)
+      super(message)
+      @code = code
+      @message = message
+      @headers = headers
+      @cause = cause
+    end
+  end
+end

data/lib/minver/response.rb

@@ -0,0 +1,43 @@
+class Minver::Response
+  DEFAULT_HEADERS = {
+    "Content-Type" => "text/html; charset=utf-8",
+    "Server" => "Minver/1.0",
+    "Connection" => "close"
+  }
+
+  def initialize status, headers, body
+    headers["Content-Length"] = body.length
+    @status = status
+    @headers = DEFAULT_HEADERS.merge(
+      "Date" => Time.now.strftime("%a, %d %b %Y %H:%M:%S %Z")
+    ).merge(headers)
+    @body = body
+  end
+
+  def body
+    @body
+  end
+
+  def data
+    [status_line, *header_lines, '', body].join("\n")
+  end
+
+  def status_line
+    ["HTTP/#{Minver::Base::HTTP_VERSION}", @status, Minver::Base::HTTP_CODES[@status]].join(' ')
+  end
+
+  def header_lines
+    @headers.map do |k, v|
+      [k, v].join(": ")
+    end
+  end
+
+  def self.from var
+    case var
+    when String
+      new(200, {}, var)
+    when Array
+      new(*var)
+    end
+  end
+end

data/lib/minver/version.rb

@@ -0,0 +1,3 @@
+module Minver
+  VERSION = "0.1.0"
+end

data/lib/minver.rb

@@ -0,0 +1,4 @@
+module Minver; end
+
+require 'minver/base'
+require 'minver/version'

data/minver.gemspec

@@ -0,0 +1,22 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'minver/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "minver"
+  spec.version       = Minver::VERSION
+  spec.authors       = ["Danyel Bayraktar"]
+  spec.email         = ["cydrop@gmail.com"]
+  spec.summary       = %q{Minimal HTTP server with graceful shutdown & value passing}
+  spec.homepage      = "https://github.com/muja/minver"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: minver
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Danyel Bayraktar
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-11-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- cydrop@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/minver.rb
+- lib/minver/base.rb
+- lib/minver/parser.rb
+- lib/minver/request.rb
+- lib/minver/request_error.rb
+- lib/minver/response.rb
+- lib/minver/version.rb
+- minver.gemspec
+homepage: https://github.com/muja/minver
+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: Minimal HTTP server with graceful shutdown & value passing
+test_files: []