rflow-components-http 0.0.7 → 1.0.0a1

data/.travis.yml

@@ -0,0 +1,21 @@
+language: ruby
+
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+
+before_install:
+  - sudo apt-get install libtool autoconf automake uuid-dev build-essential
+  - wget http://download.zeromq.org/zeromq-3.2.4.tar.gz && tar zxvf zeromq-3.2.4.tar.gz && cd zeromq-3.2.4 && ./configure && make && sudo make install && cd ..
+# Only has 4.0.4, need 3.2 version due to old em-zeromq
+#  - sudo add-apt-repository -y ppa:chris-lea/zeromq
+#  - sudo apt-get update
+#  - sudo apt-get install libzmq3 libzmq3-dev
+
+script: bundle exec rspec spec
+
+notifications:
+  hipchat:
+    rooms:
+      secure: ZVFjNSjLq8mbEaEHTqKZWovWMR17Q8cs4q3spt2Q9Q7QJp+oRz4yFVKYZCRYPsh0+mnSo2Hl8qHn/JGhxI2HsiLQVHK/9tf4TNXmT3DL//fQPTSMEHUn5D0M0CNCAWFBIbUh2PocRJxhIdUEl3PS7U4mca2nDoA+V+r+HToTZpw=

data/LICENSE

@@ -0,0 +1,190 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2014 RedJack LLC
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,73 @@
+# RFlow-Components-HTTP
+
+[![Build Status](https://travis-ci.org/redjack/rflow-components-http.png?branch=master)](https://travis-ci.org/redjack/rflow-components-http)
+
+A gem containing HTTP-specific components and data types for RFlow
+(https://github.com/redjack/rflow).
+
+## Data Types
+
+* `RFlow::Message::Data::HTTP::Response` - an HTTP request RFlow message
+* `RFlow::Message::Data::HTTP::Request` - an HTTP response RFlow message
+
+## Server
+
+The server component (`RFlow::Components::HTTP::Server`) implements a
+HTTP server based on
+[`eventmachine_httpserver`](https://github.com/eventmachine/evma_httpserver).
+The component accepts incoming HTTP connections (according to its
+configuration, see below), marshals the HTTP request into an RFlow
+message, annotates the message with a bit of provenance (see below)
+and then sends the message out its `request_port`.  When a HTTP
+response message is received on its `response_port`, the component
+checks the provenance to see if it matches an underlying TCP/HTTP
+connection and, if so, creates an actual HTTP response from the
+incoming message and send it to the client.
+
+The HTTP request message sent from the HTTP server component utilizes
+the `RFlow::Message` provenance feature to annotate a request message
+with a bit of metadata that allows subsequent response messages to be
+matched to their underlying TCP/HTTP connections.  This means that any
+component that processes HTTP request messages to generate response
+messages *must copy the provenance from the request message to the
+response message*.
+
+### Configuration
+
+* `listen` - the IP address on which to listen, defaults to '127.0.0.1'
+* `port` - the port on which to listen, defaults to '8000'
+
+### Examples
+
+### Limitations
+
+The underlying eventmachine_httpserver has two limitations that we've
+run across:
+
+* Max 20 MB HTTP request Content-Length:
+  https://github.com/eventmachine/evma_httpserver/blob/master/ext/http.h#L78
+
+* No support for HTTP chunked transfer encoding, mostly because it
+  does not sent a Content-Length HTTP header.
+
+
+## Client
+
+Not yet implemented completely
+
+
+## License
+
+   Copyright 2014 RedJack LLC
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/Rakefile

@@ -9,7 +9,7 @@ RSpec::Core::RakeTask.new(:spec) do |t|
 end
 
 Rake::RDocTask.new do |rd|
-  rd.main = "README"
-  rd.rdoc_files.include("README", "lib/**/*.rb")
+  rd.main = "README.md"
+  rd.rdoc_files.include("README.md", "lib/**/*.rb")
   rd.rdoc_dir = File.join('doc', 'html')
 end

data/lib/rflow/components/http/version.rb

@@ -1,7 +1,7 @@
 class RFlow
   module Components
     module HTTP
-      VERSION = "0.0.7"
+      VERSION = "1.0.0a1"
     end
   end
 end

data/rflow-components-http.gemspec

@@ -10,6 +10,7 @@ Gem::Specification.new do |s|
   s.authors     = ["Michael L. Artz"]
   s.email       = ["michael.artz@redjack.com"]
   s.homepage    = "https://github.com/redjack/rflow-components-http"
+  s.license     = "Apache-2.0"
   s.summary     = %q{HTTP client and server components for the RFlow FBP framework}
   s.description = %q{HTTP client and server components for the RFlow FBP framework.  Also includes the necessary HTTP::Request and HTTP::Response message types}
 
@@ -20,7 +21,7 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  s.add_dependency 'rflow', '~> 0.0'
+  s.add_dependency 'rflow', '~> 1.0.0a1'
   s.add_dependency 'eventmachine_httpserver', '~> 0.2'
 
   s.add_development_dependency 'rspec', '~> 2.6'

data/spec/http_server_spec.rb

@@ -2,10 +2,45 @@ require 'spec_helper'
 
 describe RFlow::Components::HTTP::Server do
 
-  it "should do stuff" do
+  it "should return a default HTTP response" do
     c = RFlow::Components::HTTP::Server::Connection.new('a')
     m = RFlow::Message.new("RFlow::Message::Data::HTTP::Response")
+
+    expected_header = "HTTP/1.1 200 ...\r\nContent-Type: text/html\r\nContent-length: 0\r\nServer: Apache\r\n\r\n"
+    expected_body = ""
+
+    c.should_receive(:send_data) do |header|
+      header.should == expected_header
+    end
+    c.should_receive(:send_data) do |body|
+      body.should == expected_body
+    end
+    c.should_receive(:close_connection).any_number_of_times
+
+    c.send_http_response(m)
+  end
+
+  it "should return a fully configured HTTP response" do
+    c = RFlow::Components::HTTP::Server::Connection.new('a')
+
+    m = RFlow::Message.new("RFlow::Message::Data::HTTP::Response")
+    m.data.status_code = 1337
+    m.data.status_reason_phrase = "JUST BECAUSE"
     m.data.headers['Boom'] = 'Town'
+    m.data.content = 'boom'
+
+    expected_header = "HTTP/1.1 1337 ...\r\nBoom: Town\r\nContent-Type: text/html\r\nContent-length: 4\r\nServer: Apache\r\n\r\n"
+    expected_body = "boom"
+
+    c.should_receive(:send_data) do |header|
+      header.should == expected_header
+    end
+    c.should_receive(:send_data) do |body|
+      body.should == expected_body
+    end
+    c.should_receive(:close_connection).any_number_of_times
+
     c.send_http_response(m)
   end
+
 end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: rflow-components-http
 version: !ruby/object:Gem::Version
-  version: 0.0.7
-  prerelease: 
+  version: 1.0.0a1
+  prerelease: 5
 platform: ruby
 authors:
 - Michael L. Artz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-17 00:00:00.000000000 Z
+date: 2014-04-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rflow
@@ -18,7 +18,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '0.0'
+        version: 1.0.0a1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '0.0'
+        version: 1.0.0a1
 - !ruby/object:Gem::Dependency
   name: eventmachine_httpserver
   requirement: !ruby/object:Gem::Requirement
@@ -84,7 +84,10 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
 - Gemfile
+- LICENSE
+- README.md
 - Rakefile
 - lib/rflow-components-http.rb
 - lib/rflow/components/http.rb
@@ -100,7 +103,8 @@ files:
 - spec/schema_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/redjack/rflow-components-http
-licenses: []
+licenses:
+- Apache-2.0
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -114,9 +118,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>='
+  - - ! '>'
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: rflow-components-http
 rubygems_version: 1.8.24