vayacondios-server 0.2.11 → 0.3.0

data/features/stashes.feature

@@ -0,0 +1,492 @@
+Feature: Stashes
+  In order to provide functionality
+  As a user of the Vayacondios Api
+  I want to document how Stashes work
+
+  Scenario: Retrieving Missing Stashes
+    Given there are no matching Stashes in the database
+    When  the client sends a GET request to "/v3/organization/stashes" with no body
+    Then  the response status should be 200
+    And   the response body should be:
+    """
+    [
+    ]
+    """
+
+  Scenario: Retrieving Existing Stashes
+    Given the following Stash exists in the database:
+    """
+    {
+      "_id": "topic",
+      "foo": "bar"
+    }
+    """
+    And   the following Stash exists in the database:
+    """
+    {
+      "_id": "un_topic",
+      "baz": "qix"
+    }
+    """
+    When  the client sends a GET request to "/v3/organization/stashes" with no body
+    Then  the response status should be 200
+    And   the response body should be:
+    """
+    [
+      {
+        "topic": "topic",
+        "foo":"bar"
+      },
+      {
+        "topic": "un_topic",
+        "baz": "qix"
+      }
+    ]
+    """
+
+  Scenario: Retrieving Nested Stashes
+    Given the following Stash exists in the database:
+    """
+    {
+      "_id": "topic",
+      "root": { 
+        "b": 1
+      }
+    }
+    """
+    When  the client sends a GET request to "/v3/organization/stashes" with the following body:
+    """
+    { 
+      "root.b": 1 
+    }
+    """
+    Then  the response status should be 200
+    And   the response body should be:
+    """
+    [ 
+      {
+        "topic": "topic",
+        "root": {
+          "b": 1
+        }
+      }
+    ]
+    """
+
+  Scenario: Retrieving Nested Stashes using Projection
+    Given the following Stash exists in the database:
+    """
+    {
+      "_id": "topic",
+      "root": {
+        "a": {
+          "foo": "bar"
+        },
+        "b": 1
+      }
+    }
+    """
+    When  the client sends a GET request to "/v3/organization/stashes" with the following body:
+    """
+    { 
+      "root.b": 1,
+      "fields": ["root.a"]
+    }
+    """
+    Then  the response status should be 200
+    And   the response body should be:
+    """
+    [
+      {
+        "topic": "topic",
+        "root": {
+          "a": {
+            "foo": "bar"
+          }
+        }
+      }
+    ]
+    """
+
+  Scenario: Creating Stashes without a Query
+    Given there are no matching Stashes in the database
+    When  the client sends a POST request to "/v3/organization/stashes" with no body
+    Then  the response status should be 405
+    And   the response body should be:
+    """
+    {
+      "error": "Operation create not allowed for Vayacondios::Server::StashesHandler. Valid operations are [\"retrieve\", \"delete\"]"
+    }
+    """
+    And   there are no Stashes in the database
+    # Then  the response status should be 400
+    # And   the response body should be:
+    # """
+    # {
+    #   "error": "Query cannot be empty"
+    # }
+    # """
+    # And   there are no Stashes in the database
+
+  Scenario: Creating Stashes with a Malformed Query
+    Given there are no matching Stashes in the database
+    When  the client sends a POST request to "/v3/organization/stashes" with the following body:
+    """
+    {
+      "query": "busted"
+    }
+    """
+    Then  the response status should be 405
+    And   the response body should be:
+    """
+    {
+      "error": "Operation create not allowed for Vayacondios::Server::StashesHandler. Valid operations are [\"retrieve\", \"delete\"]"
+    }
+    """
+    And   there are no Stashes in the database
+    # Then  the response status should be 400
+    # And   the response body should be:
+    # """
+    # {
+    #   "error": "Query must be a Hash"
+    # }
+    # """
+    # And   there are no Stashes in the database
+
+  Scenario: Creating Stashes with an Empty Query
+    Given there are no matching Stashes in the database
+    When  the client sends a POST request to "/v3/organization/stashes" with the following body:
+    """
+    {
+      "query": { }
+    }
+    """
+    Then  the response status should be 405
+    And   the response body should be:
+    """
+    {
+      "error": "Operation create not allowed for Vayacondios::Server::StashesHandler. Valid operations are [\"retrieve\", \"delete\"]"
+    }
+    """
+    And   there are no Stashes in the database
+    # Then  the response status should be 400
+    # And   the response body should be:
+    # """
+    # {
+    #   "error": "Query cannot be empty"
+    # }
+    # """
+    # And   there are no Stashes in the database
+
+  Scenario: Creating Stashes when the Query does not Match
+    Given the following Stash exists in the database:
+    """
+    {
+      "_id": "topic",
+      "foo": "bar"
+    }
+    """
+    When  the client sends a POST request to "/v3/organization/stashes" with the following body:
+    """
+    {
+      "query": {
+        "foo": "baz"
+      },
+      "update": {
+        "foo": "qix"
+      }
+    }
+    """
+    Then  the response status should be 405
+    And   the response body should be:
+    """
+    {
+      "error": "Operation create not allowed for Vayacondios::Server::StashesHandler. Valid operations are [\"retrieve\", \"delete\"]"
+    }
+    """
+    # Then  the response status should be 200
+    # And   the response body should be:
+    # """
+    # {
+    # }
+    # """
+    # And   the database should have the following Stash:
+    # """
+    # {
+    #   "_id": "topic"
+    #   "foo": "bar"
+    # }
+    # """
+
+  Scenario: Creating Stashes when the Query does Match
+    Given the following Stash exists in the database:
+    """
+    {
+      "_id": "topic",
+      "foo": "bar"
+    }
+    """
+    When  the client sends a POST request to "/v3/organization/stashes" with the following body:
+    """
+    {
+      "query": {
+        "foo": "bar"
+      },
+      "update": {
+        "foo": "qix"
+      }
+    }
+    """
+    Then  the response status should be 405
+    And   the response body should be:
+    """
+    {
+      "error": "Operation create not allowed for Vayacondios::Server::StashesHandler. Valid operations are [\"retrieve\", \"delete\"]"
+    }
+    """
+    # Then  the response status should be 200
+    # And   the response body should be:
+    # """
+    # {
+    # }
+    # """
+    # And   the database should have the following Stash:
+    # """
+    # {
+    #   "_id": "topic"
+    #   "foo": "qix"
+    # }
+    # """
+
+  Scenario: Updating a non-Existent Stash with an Empty Hash
+    Given there are no matching Stashes in the database
+    When  the client sends a PUT request to "/v3/organization/stashes" with no body
+    Then  the response status should be 405
+    And   the response body should be:
+    """
+    {
+      "error": "Operation update not allowed for Vayacondios::Server::StashesHandler. Valid operations are [\"retrieve\", \"delete\"]"
+    }
+    """
+    # Then  the response status should be 200
+    # And   the response body should be:
+    # """
+    # {
+    # }
+    # """
+    # And   the database should have the following Stash:
+    # """
+    # {
+    #   "_id": "topic"
+    # }
+    # """
+
+  Scenario: Updating non-Existent Stashes without a Query
+    Given there are no matching Stashes in the database
+    When  the client sends a PUT request to "/v3/organization/stashes" with no body
+    Then  the response status should be 405
+    And   the response body should be:
+    """
+    {
+      "error": "Operation update not allowed for Vayacondios::Server::StashesHandler. Valid operations are [\"retrieve\", \"delete\"]"
+    }
+    """
+    # Then  the response status should be 400
+    # And   the response body should be:
+    # """
+    # {
+    #   "error": "Query cannot be empty"
+    # }
+    # """
+    # And   there are no Stashes in the database
+
+  Scenario: Updating non-Existent Stashes with a Malformed Query
+    Given there are no matching Stashes in the database
+    When  the client sends a PUT request to "/v3/organization/stashes" with the following body:
+    """
+    {
+      "query": "busted"
+    }
+    """
+    Then  the response status should be 405
+    And   the response body should be:
+    """
+    {
+      "error": "Operation update not allowed for Vayacondios::Server::StashesHandler. Valid operations are [\"retrieve\", \"delete\"]"
+    }
+    """
+    # Then  the response status should be 400
+    # And   the response body should be:
+    # """
+    # {
+    #   "error": "Query must be a Hash"
+    # }
+    # """
+    # And   there are no Stashes in the database
+
+  Scenario: Updating non-Existent Stashes with an Empty Query
+    Given there are no matching Stashes in the database
+    When  the client sends a PUT request to "/v3/organization/stashes" with the following body:
+    """
+    {
+      "query": { }
+    }
+    """
+    Then  the response status should be 405
+    And   the response body should be:
+    """
+    {
+      "error": "Operation update not allowed for Vayacondios::Server::StashesHandler. Valid operations are [\"retrieve\", \"delete\"]"
+    }
+    """
+    # Then  the response status should be 400
+    # And   the response body should be:
+    # """
+    # {
+    #   "error": "Query cannot be empty"
+    # }
+    # """
+    # And   there are no Stashes in the database
+
+  Scenario: Updating Existent Stashes when the Query does not Match
+    Given the following Stash exists in the database:
+    """
+    {
+      "_id": "topic",
+      "foo": "bar"
+    }
+    """
+    When  the client sends a PUT request to "/v3/organization/stashes" with the following body:
+    """
+    {
+      "query": {
+        "foo": "baz"
+      },
+      "update": {
+        "foo": "qix"
+      }
+    }
+    """
+    Then  the response status should be 405
+    And   the response body should be:
+    """
+    {
+      "error": "Operation update not allowed for Vayacondios::Server::StashesHandler. Valid operations are [\"retrieve\", \"delete\"]"
+    }
+    """
+    # Then  the response status should be 200
+    # And   the response body should be:
+    # """
+    # {
+    # }
+    # """
+    # And   the database should have the following Stash:
+    # """
+    # {
+    #   "_id": "topic"
+    #   "foo": "bar"
+    # }
+    # """
+
+  Scenario: Updating Existing Stashes when the Query does Match
+    Given the following Stash exists in the database:
+    """
+    {
+      "_id": "topic",
+      "foo": "bar"
+    }
+    """
+    When  the client sends a PUT request to "/v3/organization/stashes" with the following body:
+    """
+    {
+      "query": {
+        "foo": "bar"
+      },
+      "update": {
+        "foo": "qix"
+      }
+    }
+    """
+    Then  the response status should be 405
+    And   the response body should be:
+    """
+    {
+      "error": "Operation update not allowed for Vayacondios::Server::StashesHandler. Valid operations are [\"retrieve\", \"delete\"]"
+    }
+    """
+    # Then  the response status should be 200
+    # And   the response body should be:
+    # """
+    # {
+    # }
+    # """
+    # And   the database should have the following Stash:
+    # """
+    # {
+    #   "_id": "topic"
+    #   "foo": "qix"
+    # }
+    # """
+
+  Scenario: Deleting Stashes with an Empty Query
+    Given there are no matching Stashes in the database
+    When  the client sends a DELETE request to "/v3/organization/stashes" with no body
+    Then  the response status should be 400
+    And   the response body should be:
+    """
+    {
+      "error": "Query cannot be empty"
+    }
+    """
+
+  Scenario: Deleting Stashes when the Query Does Not Match
+    Given the following Stash exists in the database:
+    """
+    {
+      "_id": "topic",
+      "foo": "bar"
+    }
+    """
+    When  the client sends a DELETE request to "/v3/organization/stashes" with the following body:
+    """
+    {
+      "foo": "baz"
+    }
+    """
+    Then  the response status should be 200
+    And   the response body should be:
+    """
+    {
+      "ok": true
+    }
+    """
+    And   the database should have the following Stash:
+    """
+    {
+      "_id": "topic",
+      "foo": "bar"
+    }
+    """
+
+  Scenario: Deleting Stashes when the Query Does Match
+    Given the following Stash exists in the database:
+    """
+    {
+      "_id": "topic",
+      "foo": "bar"
+    }
+    """
+    When  the client sends a DELETE request to "/v3/organization/stashes" with the following body:
+    """
+    {
+      "foo": "bar"
+    }
+    """
+    Then  the response status should be 200
+    And   the response body should be:
+    """
+    {
+      "ok": true
+    }
+    """
+    And   there are no Stashes in the database

data/features/step_definitions/stash_steps.rb

@@ -0,0 +1,113 @@
+require_relative '../../spec/support/database_helper'
+require_relative '../../spec/support/log_helper'
+require 'em-synchrony/em-http'
+
+include DatabaseHelper
+include LogHelper
+
+def make_request(verb, path, body = nil)
+  EM::Synchrony.sleep(0.1) # Make sure the db call is complete
+  params = { path: path }
+  params[:body] = MultiJson.dump(body) if body
+  EM::HttpRequest.new('http://localhost:3467').send(verb.to_s.downcase, params)
+end
+
+def stash_location()      'organization.stash'           ; end
+def event_location(topic) "organization.#{topic}.events" ; end
+
+Before do
+  db_reset!
+end
+
+Given(/^there are no matching Stashes in the database$/) do
+  database_count(stash_location).should == 0
+end
+
+Given(/^the following Stash exists in the database:$/) do |json|
+  insert_record(stash_location, MultiJson.load(json))
+end
+
+Given(/^there are no Events under topic "(.*?)" in the database$/) do |topic|
+  database_count(event_location topic).should == 0
+end
+
+Given(/^the following Event exists under topic "(.*?)" in the database:$/) do |topic, json|
+  event = MultiJson.load json
+  event['_t'] = Time.parse(event['_t']).round(3).utc if event.has_key?('_t')
+  insert_record(event_location(topic), event)
+end
+
+When(/^the client sends a (GET|POST|PUT|DELETE) request to "(.*?)" with no body$/) do |verb, path|
+  @response = make_request(verb, path)
+end
+
+When(/^the client sends a (GET|POST|PUT|DELETE) request to "(.*?)" with the following body:$/) do |verb, path, json|
+  @response = make_request(verb, path, MultiJson.load(json))
+end
+
+When(/^the client open a stream request to "(.*?)" with the following body:$/) do |path, json|
+  @queue = []
+  @response = make_request('GET', path, MultiJson.load(json))
+  @response.stream{ |chunk| @queue << chunk }
+end
+
+Then(/^the response status should be (\d+)$/) do |status|
+  @response.response_header.status.to_s.should == status
+end
+
+Then(/^the response body should be:$/) do |json|
+  MultiJson.load(@response.response).should == MultiJson.load(json)
+end
+
+Then(/^the response body should contain:$/) do |json|
+  MultiJson.load(@response.response).should include(MultiJson.load json)
+end
+
+Then(/^the response body should contain a randomly assigned Id$/) do
+  body = MultiJson.load @response.response
+  body.should have_key('id')
+  body['id'].should be_a(String)
+  body['id'].size.should_not be_zero
+end
+
+Then(/^the response body should contain a generated timestamp$/) do
+  body = MultiJson.load @response.response
+  body.should have_key('time')
+  body['time'].should be_a(String)
+  Time.parse(body['time']).should be_within(1).of(Time.now)
+end
+
+Then(/^the stream response body should be:$/) do |json|
+  MultiJson.load(@queue.shift).should eq(MultiJson.load json)
+end
+
+Then(/^the database should have the following Stash:$/) do |json|
+  retrieve_record(stash_location).should == MultiJson.load(json)
+end
+
+Then(/^there are no Stashes in the database$/) do
+  database_count('organization.stash').should == 0
+end
+
+Then(/^there is exactly one Event under topic "(.*?)" in the database$/) do |topic|
+  database_count(event_location topic).should == 1
+end
+
+Then(/^the database should have the following Event under topic "(.*?)":$/) do |topic, json|
+  db_event = retrieve_record(event_location topic)
+  db_event["_t"] = db_event["_t"].iso8601(3)
+  db_event.should == MultiJson.load(json)
+end
+
+Then(/^there (should|should not) be an Event with Id "(.*?)" under topic "(.*?)" in the database$/) do |assert, id, topic|
+  result = retrieve_record(event_location(topic), { _id: id })
+  if assert =~ /not/
+    result.should be_nil
+  else
+    result.should_not be_nil
+  end
+end
+
+After do
+  db_reset!
+end

data/features/stream.feature

@@ -0,0 +1,30 @@
+Feature: Stash
+  In order to provide functionality
+  As a user of the Vayacondios Api
+  I want to document how the Stream works
+
+  Scenario: Retrieving Events as a stream
+    Given the following Event exists under topic "topic" in the database:
+    """
+    {
+      "_id": "id1",
+      "_t": "2012-02-13T12:34:42.452Z",
+      "_d": {
+        "time": "2012-02-13T12:34:42.452Z"
+      }
+    }
+    """
+    # When  the client open a stream request to "/v2/organization/stream/topic" with the following body:
+    # """
+    # {
+    #   "from":"2012-01-01T00:00:00.000Z"
+    # }
+    # """
+    # Then  the response status should be 200
+    # And   the stream response body should be:
+    # """
+    # {
+    #   "id":"id1",
+    #   "time": "2012-02-13T12:34:42.452Z"      
+    # }    
+    # """

data/features/support/em.rb

@@ -0,0 +1,14 @@
+module Cucumber
+  module Ast
+    class TreeWalker
+      alias_method :visit_features_alias, :visit_features
+ 
+      def visit_features(features)
+        EM.synchrony do
+          visit_features_alias features
+          EM.stop
+        end
+      end
+    end
+  end
+end

data/features/support/env.rb

@@ -0,0 +1,13 @@
+require 'vayacondios-server'
+# can automate the server start if necessary
+# start the vayacondios server
+# api = spawn 'bundle exec vcd-server -e test'
+# puts 'Waiting for Vayacondios Server to start'
+# sleep 2
+
+# # stop the vayacondios server
+# at_exit do
+#   Process.kill('KILL', api)
+#   Process.wait api
+# end
+