vayacondios-server 0.0.4

data/.gitignore

@@ -0,0 +1,61 @@
+## OS
+.DS_Store
+Icon
+nohup.out
+.bak
+
+*.pem
+
+## EDITORS
+\#*
+.\#*
+\#*\#
+*~
+*.swp
+REVISION
+TAGS*
+tmtags
+*_flymake.*
+*_flymake
+*.tmproj
+.project
+.settings
+
+## COMPILED
+a.out
+*.o
+*.pyc
+*.so
+
+## OTHER SCM
+.bzr
+.hg
+.svn
+
+## PROJECT::GENERAL
+
+log/*
+tmp/*
+pkg/*
+
+coverage
+rdoc
+doc
+pkg
+.rake_test_cache
+.bundle
+.yardoc
+
+.vendor
+
+## PROJECT::SPECIFIC
+
+Gemfile.lock
+.rvmrc
+.rbenv-version
+
+public/stylesheets/compiled/*
+public/system/*
+.sass-cache
+
+.rbx

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 1.9.2
+  - jruby-19mode # JRuby in 1.9 mode
+  - rbx-19mode
+
+bundler_args: --without docs support
+
+notifications:
+  email: false

data/.yardopts

@@ -0,0 +1,10 @@
+--readme   README.md
+--markup   markdown
+--verbose
+-
+VERSION
+CHANGELOG.md
+LICENSE.md
+README.md
+notes/*.md
+features/**/*.feature

data/Gemfile

@@ -0,0 +1,4 @@
+source 'http://rubygems.org'
+
+gemspec name: 'vayacondios-server'
+gemspec name: 'vayacondios-client'

data/Guardfile

@@ -0,0 +1,41 @@
+# -*- ruby -*-
+
+# More info at https://github.com/guard/guard#readme
+
+# guard 'yard' do
+#   watch(%r{lib/.+\.rb})
+#   watch(%r{notes/.+\.(md|txt)}) { "notes" }
+# end
+
+rspec_opts = '--format progress'
+# rspec_opts = '--format doc'
+
+guard 'rspec', :version => 2, :cli => rspec_opts do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})            { |m| "spec/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')         { "spec" }
+  watch(/spec\/support\/(.+)\.rb/)     { "spec" }
+  watch(%r{^examples/(\w+)\.rb$})      { |m| "spec/examples/#{m[1]}_spec.rb" }
+  watch(%r{^examples/(\w+)/(.+)\.rb$}) { |m| "spec/examples/#{m[1]}_spec.rb" }
+end
+
+# # This is an example with all options that you can specify for guard-process
+# Dir['examples/**/*.rb'].each do |file|
+#   next unless File.file?(file) && File.executable?(file)
+#   guard 'process', :name => file, :command => file do
+#     watch('Gemfile.lock')
+#     watch(file)
+#     watch('examples/examples_helper.rb')
+#   end
+# end
+
+graph_output_dir = File.expand_path("/tmp/wukong-#{ENV['USER']}/graphs")
+FileUtils.mkdir_p(graph_output_dir)
+
+Dir['examples/**/*.gv'].each do |file|
+  graph_output_file = File.join(graph_output_dir, File.basename(file, '.gv')+".png")
+  cmd = "dot -Tpng -o #{graph_output_file} #{file}"
+  guard 'process', :name => "dot on #{file}", :command => cmd do
+    watch(file)
+  end
+end

data/LICENSE.md

@@ -0,0 +1,99 @@
+# License for Ironfan Toolset
+
+The ironfan code is __Copyright (c) 2011, 2012 Infochimps, Inc__
+
+This code is 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.
+
+__________________________________________________________________________
+
+Some code has been incorporated from outside projects. Terms for these appear in an explicit license statement within that portion of the code tree.
+
+__________________________________________________________________________
+
+# Apache License
+
+
+                              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_
+
+## APPENDIX: How to apply the Apache License to your work.
+
+To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets `[]` replaced with your own identifying information. (Don't include the brackets!)  The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives.
+
+> Copyright [yyyy] [name of copyright owner]
+> 
+> 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/Procfile

@@ -0,0 +1,2 @@
+listener:   ./app/http_shim.rb -sv -p 8000 -c $PWD/config/http_shim.rb
+mongod:     mongod

data/README.md

@@ -0,0 +1,183 @@
+# Vaya con Dios
+
+> "Data goes in. The right thing happens."
+
+Simple enough to use in a shell script, performant enough to use everywhere.
+
+You can chuck the following into Vaya con Dios from Ruby, the shell, over HTTP, or in a repeated polling loop:
+
+* *value*   -- 'there are 3 cups of coffee remaining':
+* *timing*  -- 'this response took 100ms'
+* *count*   -- 'I just served a 404 response code'
+* *fact*    -- 'here's everything to know about the coffee machine: `{"cups_remaining":3,"uptime":127,room:"hyrule"}`' -- an arbitrary JSON hash
+
+### Design goals
+
+* *Decentralized* -- Any (authorized) system can dispatch facts or metrics using an arbitrary namespace and schema. Nothing needs to be created in advance.
+* *Bulletproof* -- UDP clients will never fail because of network loss or timeout.
+* *Fast* -- UDP clients are non-blocking and happily dispatch thousands of requests per second.
+* *Minimal Dependency* -- Ruby clients uses nothing outside of the standard libraries.
+* *Ubiquitous* -- Can send facts from the shell (with nothing besides `curl`)
+* *writes are simple, reads are clever* -- A writer gets to chuck things in according to its conception of the world.
+
+See also [Coda Hale's metrics](https://github.com/codahale/metrics/).
+
+## Namespacing
+
+The first path segment defines a collection, and the remainder defines a [materialized path](http://www.mongodb.org/display/DOCS/Trees+in+MongoDB#TreesinMongoDB-MaterializedPaths%28FullPathinEachNode%29).
+All hashes within a given path should always have the same structure. Writes to an overlapping key will overwrite.
+
+A full Vaya con Dios path is broken down into specific segments.
+
+`/:organization/(event|config)/:topic.format`
+
+* `:organization` is the top level collection that all info is contained in.
+* `(event|config)` changes the context of the message. Events are timestamped and scope destructive. Config is merged with the current configuration.
+* `topic` is the materialized path we referred to that specifies its unique location.
+* `format` will change the serialization format for the data. Only JSON is currently supported.
+
+### Events
+
+Events are the primary piece of information stored. An event is anything that happened that you'd want to write down.
+
+
+For example a `POST` to `http://vayacondios.whatever.com/v1/code/commit` with the
+```
+{
+  "_id":     "f93f2f08a0e39648fe64",     # commit SHA as unique id
+  "_path":   "code.commit",              # materialized path
+  "_ts":     "20110614104817",           # utc flat time
+  "repo":    "infochimps/wukong"
+  "message": "...",
+  "lines":   69,
+  "author":  "mrflip"
+}
+```
+
+Will write the hash as shown into the `code` collection. Vaya con Dios fills in the _path always, and the _id and _ts if missing. This can be queried with path of "^commit/infochimps" or "^commit/.*".
+
+The hash will contain:
+
+* `_id` -- unique _id
+* `_ts` -- timestamp, set if blank
+* `_path` -- `name.spaced.path.fact_name`, omits the collection part
+
+
+### Writes
+
+* value
+* count
+* timing
+* fact
+
+`echo 'bob.dobolina.mr.bob.dobolina:320|ms:320' | netcat -c -u 127.0.0.1 8125`
+
+`http://vayacondios:9000/bob/dobolina/mr/bob/dobolina?_count=1`
+
+`http://vayacondios:9000/bob/dobolina/mr/bob/dobolina?_count=1&_sampling=0.1`
+
+`http://vayacondios:9000/bob/dobolina/mr/bob/dobolina?_timing=320`
+
+### also
+
+* Path components must be ASCII strings matching `[a-z][a-z0-9_]+` -- that is,  start with [a-z] and contain only lowercase alphanumeric or underscore. Components starting with a '_' have reserved meanings. The only valid underscored fields that a request can fill in are _id, _ts and _path.
+
+* Vaya con Dios reserves the right to read and write paths in `/vayacondios`, and the details of those paths will be documented; it will never read or write other paths unless explicitly asked to.
+
+* tree_merge rules:
+
+  - hash1 + hash = hash1.merge(hash)
+  - arr1 + arr2  = arr1 + arr2
+  - val1 + val2  = val2
+
+  - hsh1 + nil   = hsh1
+  - arr1 + nil   = arr1
+  - val1 + nil   = val1
+
+  - nil  + hs## = hsh2
+  - nil  + arr2  = arr2
+  - nil  + val2  = val2
+
+  - otherwise, exception
+
+  types: Hash, Array, String, Time, Integer, Float, Nil
+
+    mongo: string, int, double, boolean, date, bytearray, object, array, others
+    couch: string,number,boolean,array,object
+
+#### add (set? send?)
+
+GET  http://vayacondios:9099/f/{clxn}/{arbitrary/name/space}.{ext}?auth=token&query=predicate
+
+  db.collection(collection).save
+
+
+get
+
+
+#### get
+
+POST http://vayacondios:9099/f/arbitrary/name/space  with JSON body
+
+#### Increment
+
+#### Add to set
+
+what do we need to provide the 'I got next' feature (to distribute resources uniquely from a set)?
+
+#### Auth
+
+`/vayacondios/_auth/` holds one hash giving public key.
+* walk down the hash until you see _tok
+* can only auth at first or second level?
+* or by wildcard?
+* access is read or read_write; by default allows read_write
+
+## Others
+
+GET latest
+GET all
+GET next
+
+## Configuration
+
+All organizations have a special topic called, "config" that allows for storage and retrieval of configuration data via standard [CRUD requests](http://en.wikipedia.org/wiki/Create,_read,_update_and_delete).
+
+### Writing config data
+
+A `POST` request can be made to a full URL such as: `http://vayacondios:9000/organization/topic/some/deep/key`
+
+Vaya con Dios stores configuration data in special collections (`"#{organization}.config"`). The topic acts as the primary key while `/some/deep/key` acts as a materialized path for selection.
+
+## Notes
+
+### When to use HTTP vs UDP
+
+#### HTTP is connectionful
+
+* you get acknowledgement that a metric was recorded (this is good).
+* if the network is down, your code will break (this is bad). (Well, usually. For some accounting and auditing metrics one might rather serve nothing at all than something unrecorded. Vayacondios doesn't address this use case.)
+
+#### UDP has Packet Size limitations
+
+If you're using UDP for facts, you need to be *very* careful about payload size.
+
+From the [EventMachine docs](http://eventmachine.rubyforge.org/EventMachine/Connection.html#M000298)
+
+> You may not send an arbitrarily-large data packet because your operating system will enforce a platform-specific limit on the size of the outbound packet. (Your kernel will respond in a platform-specific way if you send an overlarge packet: some will send a truncated packet, some will complain, and some will silently drop your request). On LANs, it’s usually OK to send datagrams up to about 4000 bytes in length, but to be really safe, send messages smaller than the Ethernet-packet size (typically about 1400 bytes). Some very restrictive WANs will either drop or truncate packets larger than about 500 bytes.
+
+## Colophon
+
+### Contributing to vayacondios
+
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+### Copyright
+
+Copyright (c) 2011, 2012 Infochimps. See [LICENSE.md](LICENSE.md) for further details.

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler' ; Bundler.setup
+
+# App-specific tasks
+Dir[File.dirname(__FILE__)+'/lib/tasks/**/*.rake'].sort.each{|f| load f }
+
+task :default => :spec

data/app/http_shim.rb

@@ -0,0 +1,67 @@
+#!/usr/bin/env ruby
+
+require 'vayacondios-server'
+require 'time'
+
+class HttpShim < Goliath::API
+  use Goliath::Rack::Heartbeat          # respond to /status with 200, OK (monitoring, etc)
+  use Goliath::Rack::Tracer, 'X-Tracer' # log trace statistics
+  use Goliath::Rack::Params             # parse & merge query and body parameters
+
+  use Goliath::Rack::DefaultMimeType    # cleanup accepted media types
+  use Goliath::Rack::Render, 'json'     # auto-negotiate response format
+
+  def response(env)
+    path_params = parse_path(env[Goliath::Request::REQUEST_PATH])
+
+    if path_params.present?
+      klass = ('vayacondios/' + path_params[:type] + '_handler').camelize.constantize
+
+      if method_name == :get && !path_params[:topic].present?
+        return [400, {}, {error: "Bad Request"}]
+      end
+      begin
+      if method_name == :update
+        record = klass.new(mongo).update(env.params, path_params)
+      elsif method_name == :get
+        record = klass.find(mongo, path_params)
+      end
+
+      rescue Exception => ex
+        puts ex
+        ex.backtrace.each{|l| puts l}
+      end
+
+      if record.present?
+        [200, {}, record]
+      else
+        [404, {}, {error: "Not Found"}]
+      end
+    else
+      [400, {}, {error: "Bad Request"}]
+    end
+  end
+
+  private
+
+  # Determine the organization, type of action (config or event), the topic,
+  # id, and format for the request.
+  def parse_path path
+    path_regex = /^\/v1\/(?<organization>[a-z]\w+)\/(?<type>config|event)(\/(?<topic>\w+)(\/(?<id>(\w+\/?)+))?)?(\/|\.(?<format>json))?$/i
+    if (match = path_regex.match(path))
+      {}.tap do |segments|
+        match.names.each do |segment|
+          segments[segment.to_sym] = match[segment]
+        end
+      end
+    end
+  end
+
+  def method_name
+    if %{PUT POST}.include?(env['REQUEST_METHOD'].upcase)
+      :update
+    elsif env['REQUEST_METHOD'].downcase == 'get'
+      :get
+    end
+  end
+end