vayacondios-server 0.2.11 → 0.3.0

data/Rakefile

@@ -1,10 +1,93 @@
-# -*- ruby -*-
+require 'rspec/core/rake_task'
 
-require 'bundler' ; Bundler.setup
+namespace :spec do
 
-require 'configliere'
+  desc 'Run client RSpec code examples'
+  RSpec::Core::RakeTask.new(:client) do |t|
+    t.pattern = 'spec/client/**/*_spec.rb'
+  end
+  
+  desc 'Run server RSpec code examples'
+  RSpec::Core::RakeTask.new(:server) do |t|
+    t.pattern = 'spec/server/**/*_spec.rb'
+  end
+end
 
-# App-specific tasks
-Dir[File.dirname(__FILE__)+'/lib/tasks/**/*.rake'].sort.each{|f| load f }
+desc 'Run both client and server Rspec code examples'
+RSpec::Core::RakeTask.new
+
+desc 'Run spec tests with simplecov'
+task :coverage do
+  ENV['VAYACONDIOS_COV'] = 'true'
+  Rake::Task[:spec].invoke
+end
+
+def with_background_process(cmd, options = {}, &blk)
+  pr = spawn cmd
+  puts "waiting for command #{cmd} to execute fully"
+  sleep(options[:wait]) if options[:wait]
+  blk.call
+ensure 
+  Process.kill('KILL', pr)
+  Process.wait pr
+end
+
+desc 'Run spec coverage with mongo'
+task :mongo do
+  # with_background_process('mongod') do
+  ENV['WITH_MONGO'] = 'true'
+  Rake::Task[:spec].invoke
+  # end
+end
+
+desc 'Run integration tests'
+task :integration do
+  # with_background_process('mongod') do
+  with_background_process('bin/vcd-server -e test', wait: 2) do
+    Rake::Task[:features].invoke
+  end
+  # end
+end
+
+require 'cucumber/rake/task'
+Cucumber::Rake::Task.new(:features)
+
+require 'yard'
+YARD::Rake::YardocTask.new do |t|
+  t.files   = ['lib/**/*.rb', '-', 'CHANGELOG.md', 'LICENSE.md']
+  t.options = ['--readme=README.md', '--markup=markdown', '--verbose']
+end
+
+require 'vayacondios'
+Dir['*.gemspec'].each do |gemspec|
+  gem_name = gemspec.gsub(/\.gemspec/, '')
+
+  namespace :build do
+    desc "Build #{gem_name} gem into the pkg directory"
+    task gem_name do
+      system "gem build #{gemspec}"
+      FileUtils.mkdir_p('pkg')
+      FileUtils.mv(Dir['*.gem'], 'pkg')
+    end
+  end
+
+  namespace :release do
+    desc "Tags version, pushes to remote, and pushes #{gem_name} gem"
+    task gem_name => "build:#{gem_name}" do
+      sh 'git', 'tag', '-m', "releasing #{gem_name}", "#{gem_name}-v#{Vayacondios::GEM_VERSION}"
+      branch = `git branch | awk -F '/* ' '{print $2}'`.strip
+      sh "git push origin #{branch}"
+      sh "git push origin #{gem_name}-v#{Vayacondios::GEM_VERSION}"
+      sh "ls pkg/#{gem_name}*.gem | xargs -n 1 gem push"
+    end
+  end
+end
+
+desc 'Build both gems'
+task build:   ['build:vayacondios-client', 'build:vayacondios-server']
+
+desc 'Release both gems'
+task release: ['release:vayacondios-client', 'release:vayacondios-server']
+
+task default: [:mongo, :integration]
 
-task :default => :spec

data/bin/vcd

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+vayacondios_gemfile = File.expand_path('../../Gemfile', File.realdirpath(__FILE__))
+ENV['BUNDLE_GEMFILE'] = vayacondios_gemfile
+
+require 'bundler'
+Bundler.setup(:default)
+
+require 'vayacondios/client/cli'
+Vayacondios::Client::CLI.run

data/bin/vcd-server

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+vayacondios_gemfile = File.expand_path('../../Gemfile', File.realdirpath(__FILE__))
+ENV['BUNDLE_GEMFILE'] = vayacondios_gemfile
+
+require 'bundler'
+Bundler.setup(:default)
+require 'vayacondios/server/api'

data/config/database.yml

@@ -0,0 +1,6 @@
+---
+test:
+  name:   vayacondios_test
+  driver: mongo
+  host:   localhost
+  port:   27017

data/config/spec.example.yml

@@ -0,0 +1,18 @@
+# During normal operation, configuration values like the location of a
+# MongoDB server are passed to Vayacondios server via the
+# command-line.
+#
+# During integration tests (which must instantiate a Vayacondios
+# server *without* a command line) this file is used to specify the
+# location of a MongoDB to use for testing.
+#
+# *WARNING*: The database named here will be emptied of data during
+# *the running of tests.
+#
+# @see spec/spec_helper.rb for the code which reads this file
+# @see spec/support/mongo_helper.rb for the 
+---
+mongo:
+  host:         localhost
+  port:         27017
+  database:     vayacondios_development

data/config/vayacondios.example.yml

@@ -0,0 +1,15 @@
+# This is an example configuration for the Vayacondios client program
+# `vcd`.
+#
+# You can copy this file to /etc/vayacondios/vayacondios.yml or
+# ~/.vayacondios.yml to have the `vcd` program read it on startup.
+#
+# This provides a convenient way of providing shared access to a
+# Vayacondios server from a given machine.
+#
+# @see Vayacondios::CLI which reads this configuration file
+
+---
+host:         localhost
+port:         9000
+organization: example

data/config/vcd-server.rb

@@ -0,0 +1,37 @@
+# This configuration script provides several example configurations of
+# Vayacondios server.
+#
+# You can use any of these environments by specifying the
+# --environment or -e flag to `vcd-server`.
+#
+# @see Vayacondios::HttpServer for where the database connection is
+# passed to the rest of the application code.
+
+# The production environment uses EventMachine::Synchrony to define a
+# shared pool of open connections to the database. The size of this pool
+# can be on the command-line with the --database.connections option.
+Vayacondios::Server::DbConfig.overlay options[:database]
+
+environment(:production) do
+  db_options = Vayacondios::Server::DbConfig.env :production
+  driver = Vayacondios::Server::Driver.retrieve db_options[:driver]
+  logger.info("Opening #{db_options[:connections]} connections to #{db_options[:host]}:#{db_options[:port]} using #{driver}.")
+  config['db'] = EventMachine::Synchrony::ConnectionPool.new(size: db_options[:connections]) do
+    driver.connect db_options.merge(log: logger)
+  end
+end
+
+# The development environment uses a single database connection.
+environment(:development) do
+  db_options = Vayacondios::Server::DbConfig.env :development
+  driver = Vayacondios::Server::Driver.retrieve db_options[:driver]
+  logger.info("Connecting to #{db_options[:host]}:#{db_options[:port]} using #{driver}.")
+  config['db'] = driver.connect db_options.merge(log: logger)
+end
+
+environment(:test) do
+  db_options = Vayacondios::Server::DbConfig.env :test
+  driver = Vayacondios::Server::Driver.retrieve db_options[:driver]
+  logger.info("Connecting to #{db_options[:host]}:#{db_options[:port]} using #{driver}.")
+  config['db'] = driver.connect db_options.merge(log: logger)
+end

data/examples/configuration.rb

@@ -0,0 +1,56 @@
+# All examples assume a running Vayacondios server on localhost:3467
+# with a backing database.
+#
+# bundle exec ruby examples/configuration.rb
+require 'vayacondios/client'
+
+# Setting up connection options
+#
+# Vcd::Client::ConnectionOpts reads from the following in order:
+# * library defaults (Vcd::Client::ConnectionOpts.defaults
+# * /etc/vayacondios/vayacondios.yml
+# * $PWD/config/vayacondios.yml
+# * any overlays applied using ConnectionOpts.overlay
+
+# Change the base file_name from 'vayacondios.yml'
+Vcd::Client::ConnectionOpts.base_filename = 'foo.yml'
+
+# Change the config load order
+Vcd::Client::ConnectionOpts.load_order = %w[ global local ]
+
+# Load order calls methods that expect either a Hash or a String filename returned
+Vcd::Client::ConnectionOpts.define_singleton_method(:local) do
+  '/path/to/local/config_file'
+end
+
+# Override configuration for further Vcd connections
+Vcd::Client::ConnectionOpts.overlay(adapter: :net_http)
+
+# As soon as the options are used they become resolved and cannot be changed
+puts Vcd::Client::ConnectionOpts[:adapter]
+puts Vcd::Client::ConnectionOpts.resolved?
+Vcd::Client::ConnectionOpts.overlay(adapter: :em_http)
+Vcd::Client::ConnectionOpts.resolve!
+puts Vcd::Client::ConnectionOpts.resolved_settings
+
+# Create a new connection with options
+Vcd::Client::Connection.factory(host: 'foo', port: 1234)
+
+# Mixin the http modules and get access to a memoized connection and client methods
+class MyClass
+  include Vcd::Client::HttpRead
+  include Vcd::Client::HttpWrite
+  include Vcd::Client::HttpAdmin
+end
+
+my_class = MyClass.new
+puts my_class.http_connection
+
+# override memoized connection options for this instance only
+puts my_class.configure_connection(host: 'localhost')
+
+# utilize client http methods
+response = my_class.set('id', nil, foo: 'bar')
+puts response.body
+response = my_class.unset('id')
+puts response.body

data/examples/event_stream.rb

@@ -0,0 +1,19 @@
+# All examples assume a running Vayacondios server on localhost:3467
+# with a backing database.
+#
+# bundle exec ruby examples/event_stream.rb
+require 'vayacondios/client'
+
+client = Vcd::Client::HttpClient.new(organization: 'github')
+
+client.stream('commit') do |event|
+  line = "#{event['time']} | #{event['username']}: #{event['sha']} => #{event['message']}"
+  puts line
+end
+
+# In another window:
+# curl -X POST 'http://localhost:3467/v3/github/event/commit' -d '{"username":"Jack","sha":"123abc","message":"watup"}'
+# curl -X POST 'http://localhost:3467/v3/github/event/commit' -d '{"username":"Jill","sha":"abc123","message":"yoyo"}'
+#
+# To remove the event topic:
+# curl -X DELETE 'http://localhost:3467/v3/github/events/commit'

data/examples/simple.rb

@@ -0,0 +1,61 @@
+# All examples assume a running Vayacondios server on localhost:3467
+# with a backing database.
+#
+# bundle exec ruby examples/simple.rb
+require 'vayacondios/client'
+
+# Basic client usage
+client = Vcd::Client::HttpClient.new(organization: 'github')
+
+# Events
+client.announce('commit', username: 'Jack', sha: '123abc', message: 'watup')
+puts client.events('commit').body.inspect
+puts client.clear_events('commit').body.inspect
+
+# Stashes
+client.set(123, nil, user_name: 'jimbob', user_id: 123, group: 'admin')
+puts client.get(123).body
+
+# Mixin Vcd functionality
+class SimpleModel
+  extend  Vcd::Client::HttpRead
+  include Vcd::Client::HttpWrite
+  include Vcd::Client::HttpAdmin
+
+  # Must respond to organization for requests to be formed correctly
+  # default is 'vayacondios'
+  def self.organization() 'github' ; end
+
+  def self.find topic
+    data = get(topic).body
+    self.new data
+  end
+  
+  attr_accessor :user_name, :user_id, :group
+
+  def initialize(data = {})
+    @user_name = data['user_name']
+    @user_id   = data['user_id']
+    @group     = data['group']
+  end
+
+  def organization
+    self.class.organization
+  end
+
+  def to_hash
+    { user_name: user_name, user_id: user_id, group: group }
+  end
+
+  def save
+    set(user_id, nil, to_hash)
+  end
+
+  def destroy!
+    unset(user_id)
+  end
+end
+
+model = SimpleModel.find('123')
+puts model.to_hash
+model.destroy!

data/features/event.feature

@@ -0,0 +1,319 @@
+Feature: Event
+  In order to provide functionality
+  As a user of the Vayacondios Api
+  I want to document how an Event works
+
+  Scenario: Retrieving an Event without an Id
+    Given there are no Events under topic "topic" in the database
+    When  the client sends a GET request to "/v3/organization/event/topic" with no body
+    Then  the response status should be 400
+    And   the response body should be:
+    """
+    {
+      "error": "Cannot find an event without an ID"
+    }
+    """
+
+  Scenario: Retrieving a non-Existent Event with an Id
+    Given there are no Events under topic "topic" in the database
+    When  the client sends a GET request to "/v3/organization/event/topic/id" with no body
+    Then  the response status should be 404
+    And   the response body should be:
+    """
+    {
+      "error": "Event with topic <topic> and ID <id> not found"
+    }
+    """
+
+  Scenario: Retrieving an Existing Event with an Id
+    Given the following Event exists under topic "topic" in the database:
+    """
+    {
+      "_id": "id",
+      "_t": "2012-02-13T12:34:42.452Z",
+      "_d": {
+        "time": "2012-02-13T12:34:42.452Z"
+      }
+    }
+    """
+    When  the client sends a GET request to "/v3/organization/event/topic/id" with no body
+    Then  the response status should be 200
+    And   the response body should be:
+    """
+    {
+      "id": "id",
+      "time": "2012-02-13T12:34:42.452Z"
+    }
+    """
+
+  Scenario: Creating an Empty Event without an Id
+    Given there are no Events under topic "topic" in the database
+    When  the client sends a POST request to "/v3/organization/event/topic" with no body
+    Then  the response status should be 200
+    And   the response body should contain a generated timestamp
+    And   the response body should contain a randomly assigned Id
+    And   there is exactly one Event under topic "topic" in the database
+
+  Scenario: Creating a Hash Event without an Id
+    Given there are no Events under topic "topic" in the database
+    When  the client sends a POST request to "/v3/organization/event/topic" with the following body:
+    """
+    {
+      "foo": "bar"
+    }
+    """
+    Then  the response status should be 200
+    And   the response body should contain:
+    """
+    { 
+      "foo": "bar"
+    }
+    """
+    And   the response body should contain a generated timestamp
+    And   the response body should contain a randomly assigned Id
+    And   there is exactly one Event under topic "topic" in the database
+
+  Scenario: Creating a Hash Event without an Id, specifying a time
+    Given there are no Events under topic "topic" in the database
+    When  the client sends a POST request to "/v3/organization/event/topic" with the following body:
+    """
+    {
+      "foo": "bar",
+      "time": "2012-02-13T12:34:42.452Z"
+    }
+    """
+    Then  the response status should be 200
+    And   the response body should contain:
+    """
+    { 
+      "foo": "bar",
+      "time": "2012-02-13T12:34:42.452Z"
+    }
+    """
+    And   the response body should contain a randomly assigned Id
+    And   there is exactly one Event under topic "topic" in the database
+
+  Scenario: Creating a non-Hash Event without an Id
+    Given there are no Events under topic "topic" in the database
+    When  the client sends a POST request to "/v3/organization/event/topic" with the following body:
+    """
+    [
+      "foo", 
+      "bar"
+    ]
+    """
+    Then  the response status should be 400
+    And   the response body should be:
+    """
+    {
+      "error": "Events must be Hash-like to create"
+    }
+    """
+    And   there are no Events under topic "topic" in the database
+
+  Scenario: Creating an Empty Event with an Id
+    Given there are no Events under topic "topic" in the database
+    When  the client sends a POST request to "/v3/organization/event/topic/id" with no body
+    Then  the response status should be 200
+    And   the response body should contain:
+    """
+    { 
+      "id": "id"
+    }
+    """
+    And   the response body should contain a generated timestamp
+    And   there should be an Event with Id "id" under topic "topic" in the database
+
+  Scenario: Creating a Hash Event with an Id
+    Given there are no Events under topic "topic" in the database
+    When  the client sends a POST request to "/v3/organization/event/topic/id" with the following body:
+    """
+    {
+      "foo": "bar"
+    }
+    """
+    Then  the response status should be 200
+    And   the response body should contain:
+    """
+    { 
+      "foo": "bar",
+      "id": "id"
+    }
+    """
+    And   the response body should contain a generated timestamp
+    And   there should be an Event with Id "id" under topic "topic" in the database
+
+  Scenario: Creating a Hash Event with an Id, specifying a time
+    Given there are no Events under topic "topic" in the database
+    When  the client sends a POST request to "/v3/organization/event/topic/id" with the following body:
+    """
+    {
+      "foo": "bar",
+      "time": "2012-02-13T12:34:42.452Z"
+    }
+    """
+    Then  the response status should be 200
+    And   the response body should be:
+    """
+    {
+      "id": "id",
+      "foo": "bar",
+      "time": "2012-02-13T12:34:42.452Z"
+    }
+    """
+    And   the database should have the following Event under topic "topic":
+    """
+    {
+      "_id": "id",
+      "_t": "2012-02-13T12:34:42.452Z",
+      "_d": {
+        "foo": "bar"
+      }
+    }
+    """
+
+  Scenario: Creating a non-Hash Event with an Id
+    Given there are no Events under topic "topic" in the database
+    When  the client sends a POST request to "/v3/organization/event/topic/id" with the following body:
+    """
+    [
+      "foo", 
+      "bar"
+    ]
+    """
+    Then  the response status should be 400
+    And   the response body should be:
+    """
+    {
+      "error": "Events must be Hash-like to create"
+    }
+    """
+    And   there are no Events under topic "topic" in the database
+
+  Scenario: Creating an Event with an Id that Already Exists
+    Given the following Event exists under topic "topic" in the database:
+    """
+    {
+      "_id": "id",
+      "_t": "2012-02-13T12:34:42.452Z",
+      "_d": {
+        "foo": "bar"
+      }
+    }
+    """
+    When  the client sends a POST request to "/v3/organization/event/topic/id" with the following body:
+    """
+    {
+      "time": "2013-01-01T00:00:00.000Z",
+      "new": "body"      
+    }
+    """
+    Then  the response status should be 200
+    And   the response body should be:
+    """
+    {
+      "id": "id",
+      "new": "body",
+      "time": "2013-01-01T00:00:00.000Z"
+    }
+    """
+    And   the database should have the following Event under topic "topic":
+    """
+    {
+      "_id": "id",
+      "_t": "2013-01-01T00:00:00.000Z",
+      "_d": {
+        "new": "body"
+      }
+    }
+    """
+
+  Scenario: Updating an Event without an Id
+    Given the following Event exists under topic "topic" in the database:
+    """
+    {
+      "_id": "id",
+      "_t": "2012-02-13T12:34:42.452Z",
+      "_d": { }
+    }
+    """
+    When  the client sends a PUT request to "/v3/organization/event/topic" with the following body:
+    """
+    {
+      "foo": "bar"
+    }
+    """
+    Then  the response status should be 405
+    And   the response body should be:
+    """
+    {
+      "error": "Operation update not allowed for Vayacondios::Server::EventHandler. Valid operations are [\"create\", \"retrieve\", \"delete\"]"
+    }
+    """
+
+  Scenario: Updating an Event with an Id
+    Given the following Event exists under topic "topic" in the database:
+    """
+    {
+      "_id": "id",
+      "_t": "2012-02-13T12:34:42.452Z",
+      "_d": {
+        "time": "2012-02-13T12:34:42.452Z"
+      }
+    }
+    """
+    When  the client sends a PUT request to "/v3/organization/event/topic/id" with the following body:
+    """
+    {
+      "foo": "bar"
+    }
+    """
+    Then  the response status should be 405
+    And   the response body should be:
+    """
+    {
+      "error": "Operation update not allowed for Vayacondios::Server::EventHandler. Valid operations are [\"create\", \"retrieve\", \"delete\"]"
+    }
+    """
+
+  Scenario: Deleting an Event
+    Given the following Event exists under topic "topic" in the database:
+    """
+    {
+      "_id": "id",
+      "_t": "2012-02-13T12:34:42.452Z",
+      "_d": {
+        "time": "2012-02-13T12:34:42.452Z"
+      }
+    }
+    """
+    When  the client sends a DELETE request to "/v3/organization/event/topic" with no body
+    Then  the response status should be 400
+    And   the response body should be:
+    """
+    {
+      "error": "An <Id> is required to delete an Event"
+    }
+    """
+    And   there should be an Event with Id "id" under topic "topic" in the database
+
+  Scenario: Deleting an Event with an Id
+    Given the following Event exists under topic "topic" in the database:
+    """
+    {
+      "_id": "id",
+      "_t": "2012-02-13T12:34:42.452Z",
+      "_d": {
+        "time": "2012-02-13T12:34:42.452Z"
+      }
+    }
+    """
+    When  the client sends a DELETE request to "/v3/organization/event/topic/id" with no body
+    Then  the response status should be 200
+    And   the response body should be:
+    """
+    {
+      "ok": true
+    }
+    """
+    And   there are no Events under topic "topic" in the database