orchestrate 0.5

data/lib/orchestrate/configuration.rb

@@ -0,0 +1,53 @@
+require "logger"
+
+module Orchestrate
+
+  #
+  # Represents the configuration for the Orchestrate library, including
+  # values for the api key, base url and other settings.
+  #
+  # An instance of this class is always available at Orchestrate.config.
+  # You should not
+  # instantiate instances of this class, instead, you should configure the
+  # library with the Orchestrate.configure method.
+  #
+  # === Example
+  #
+  #     Orchestrate.configure do |config|
+  #       config.api_key = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
+  #     end
+  #
+  class Configuration
+
+    #
+    # The api key for your app, from the Orchestrate Dashboard.
+    #
+    attr_accessor :api_key
+
+    #
+    # The url to the Orchestrate API. Defaults to \https://api.orchestrate.io/v0.
+    #
+    attr_accessor :base_url
+
+    #
+    # The logger instances to send messages to. Defaults to +STDOUT+.
+    #
+    attr_accessor :logger
+
+    # for faraday, here temporarily
+    #
+    attr_accessor :faraday
+
+    #
+    # Initialize and return a new instance of Configuration.
+    #
+    def initialize(options = {}) # :nodoc:
+      @api_key = options[:api_key]
+      @base_url = options[:base_url] || "https://api.orchestrate.io"
+      @logger = options[:logger] || Logger.new(STDOUT)
+      @faraday = options[:faraday]
+    end
+
+  end
+
+end

data/lib/orchestrate/helpers.rb

@@ -0,0 +1,22 @@
+module Orchestrate
+  module Helpers
+
+    extend self
+
+    #  * required: type, params={}
+    #
+    #  Given a params object such as { start: ..., end: ... } and a type such as 'event',
+    #  will return a hash with those parameters formatted for the Orchestrate API, f.e.:
+    #  { 'startEvent' => ..., 'endEvent' => ... }
+    def range_keys!(type, params)
+      type = type.capitalize
+      [:start, :end, :before, :after].each do |key|
+        if params[key]
+          params["#{key}#{type}"] = params[key]
+          params.delete(key)
+        end
+      end
+    end
+
+  end
+end

data/lib/orchestrate/version.rb

@@ -0,0 +1,3 @@
+module Orchestrate
+  VERSION = "0.5"
+end

data/orchestrate.gemspec

@@ -0,0 +1,27 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'orchestrate/version'
+
+Gem::Specification.new do |s|
+	s.name          = 'orchestrate'
+	s.version       = Orchestrate::VERSION
+	s.authors       = ['Matthew Lyon', 'Justin Mecham', 'James Carrasquer']
+	s.email         = ['matthew@lyonheart.us', 'justin@mecham.me', 'jimcar@aracnet.com']
+	s.summary       = 'Ruby client for Orchestrate.io'
+	s.description   = 'Client for the Orchestrate REST API'
+	s.homepage      = 'https://github.com/orchestrate-io/orchestrate-ruby'
+	s.license       = 'MIT'
+
+	s.files         = `git ls-files -z`.split("\x0")
+	s.executables   = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
+	s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+	s.require_paths = ["lib"]
+
+  s.add_dependency "faraday", "~> 0.9"
+  s.add_dependency "faraday_middleware", "~> 0.9", ">= 0.9.1"
+  s.add_development_dependency "bundler", "~> 1.6"
+  s.add_development_dependency "rake"
+  s.add_development_dependency "typhoeus"
+  s.add_development_dependency "em-http-request"
+  s.add_development_dependency "em-synchrony"
+end

data/test/orchestrate/api/collections_test.rb

@@ -0,0 +1,87 @@
+require_relative '../../test_helper'
+
+class CollectionTest < MiniTest::Unit::TestCase
+  def setup
+    @collection = 'test'
+    @client, @stubs, @basic_auth = make_client_and_artifacts
+  end
+
+  def test_deletes_collection
+    @stubs.delete("/v0/#{@collection}") do |env|
+      assert_authorization @basic_auth, env
+      assert_equal "true", env.params["force"]
+      headers = response_headers
+      headers.delete('Content-Type')
+      [204, headers, '']
+    end
+
+    response = @client.delete_collection(@collection)
+    assert_equal 204, response.status
+    assert_equal '', response.body
+  end
+
+  def test_lists_collection_without_params
+    body = {"count" => 0, "results" => [], "next" => ""}
+
+    @stubs.get("/v0/#{@collection}") do |env|
+      assert_authorization @basic_auth, env
+      assert_accepts_json env
+      [200, response_headers, body.to_json]
+    end
+
+    response = @client.list(@collection)
+    assert_equal 200, response.status
+    assert_equal body, response.body
+  end
+
+  def test_lists_collections_with_params_passes_them
+    body = {"count" => 0, "results" => [], "next" => ""}
+    @stubs.get("/v0/#{@collection}") do |env|
+      assert_authorization @basic_auth, env
+      assert_accepts_json env
+      assert_equal "1", env.params['limit']
+      assert_equal "foo", env.params['startKey']
+      assert_equal ['limit', 'startKey'], env.params.keys
+      [ 200, response_headers, body.to_json]
+    end
+
+    response = @client.list(@collection, {limit:1, start: 'foo'})
+    assert_equal 200, response.status
+    assert_equal body, response.body
+  end
+
+  def test_search_with_simple_query
+    query = 'text:"The Right Way" and go'
+    body = { "results" => [], "count" => 0, "total_count" => 10, "next" => "", "prev" => "" }
+
+    @stubs.get("/v0/#{@collection}") do |env|
+      assert_authorization @basic_auth, env
+      assert_accepts_json env
+      assert_equal query, env.params['query']
+      [ 200, response_headers, body.to_json]
+    end
+
+    response = @client.search(@collection, query)
+    assert_equal 200, response.status
+    assert_equal body, response.body
+  end
+
+  def test_search_with_extra_params
+    query = 'text:"The Right Way" and go'
+    body = { "results" => [], "count" => 0, "total_count" => 10, "next" => "", "prev" => "" }
+
+    @stubs.get("/v0/#{@collection}") do |env|
+      assert_authorization @basic_auth, env
+      assert_accepts_json env
+      assert_equal query, env.params['query']
+      assert_equal '3', env.params['offset']
+      assert_equal '10', env.params['limit']
+      [ 200, response_headers, body.to_json]
+    end
+
+    response = @client.search(@collection, query, {offset: 3, limit: 10})
+    assert_equal 200, response.status
+    assert_equal body, response.body
+  end
+
+end

data/test/orchestrate/api/event_test.rb

@@ -0,0 +1,133 @@
+require_relative '../../test_helper'
+
+class EventTest < MiniTest::Unit::TestCase
+
+  def setup
+    @collection = 'tests'
+    @key = 'instance'
+    @client, @stubs, @basic_auth = make_client_and_artifacts
+    @event_type = "commits"
+    @timestamp = (Time.now.to_f * 1000).to_i
+    @ordinal = 5
+  end
+
+  def test_get_event
+    body = { "path" => {}, "value" => {"msg" => "hello"}, "timestamp" => @timestamp, "ordinal" => @ordinal }
+    @stubs.get("/v0/#{@collection}/#{@key}/events/#{@event_type}/#{@timestamp}/#{@ordinal}") do |env|
+      assert_authorization @basic_auth, env
+      assert_accepts_json env
+      [200, response_headers, body.to_json]
+    end
+
+    response = @client.get_event(@collection, @key, @event_type, @timestamp, @ordinal)
+    assert_equal 200, response.status
+    assert_equal body, response.body
+  end
+
+  def test_post_event_without_timestamp
+    event = {"msg" => "hello"}
+    @stubs.post("/v0/#{@collection}/#{@key}/events/#{@event_type}") do |env|
+      assert_authorization @basic_auth, env
+      assert_equal event.to_json, env.body
+      [204, response_headers, '']
+    end
+
+    response = @client.post_event(@collection, @key, @event_type, event)
+    assert_equal 204, response.status
+  end
+
+  def test_post_event_with_timestamp
+    event = {"msg" => "hello"}
+    @stubs.post("/v0/#{@collection}/#{@key}/events/#{@event_type}/#{@timestamp}") do |env|
+      assert_authorization @basic_auth, env
+      assert_equal event.to_json, env.body
+      [204, response_headers, '']
+    end
+
+    response = @client.post_event(@collection, @key, @event_type, event, @timestamp)
+    assert_equal 204, response.status
+  end
+
+  def test_put_event_without_ref
+    event = {"msg" => "hello"}
+    @stubs.put("/v0/#{@collection}/#{@key}/events/#{@event_type}/#{@timestamp}/#{@ordinal}") do |env|
+      assert_authorization @basic_auth, env
+      assert_equal event.to_json, env.body
+      [204, response_headers, '']
+    end
+    response = @client.put_event(@collection, @key, @event_type, @timestamp, @ordinal, event)
+    assert_equal 204, response.status
+  end
+
+  def test_put_event_with_ref
+    event = {"msg" => "hello"}
+    ref = "12345"
+    path = ['v0', @collection, @key, 'events', @event_type, @timestamp, @ordinal]
+    @stubs.put(path.join("/")) do |env|
+      assert_authorization @basic_auth, env
+      assert_header 'If-Match', "\"#{ref}\"", env
+      assert_equal event.to_json, env.body
+      [204, response_headers, '']
+    end
+    response = @client.put_event(@collection, @key, @event_type, @timestamp, @ordinal, event, ref)
+    assert_equal 204, response.status
+  end
+
+  def test_purge_event_without_ref
+    path = ['v0', @collection, @key, 'events', @event_type, @timestamp, @ordinal]
+    @stubs.delete(path.join("/")) do |env|
+      assert_authorization @basic_auth, env
+      assert_equal 'true', env.params['purge']
+      [204, response_headers, '']
+    end
+    response = @client.purge_event(@collection, @key, @event_type, @timestamp, @ordinal)
+    assert_equal 204, response.status
+  end
+
+  def test_purge_event_with_ref
+    path = ['v0', @collection, @key, 'events', @event_type, @timestamp, @ordinal]
+    ref = "12345"
+    @stubs.delete(path.join("/")) do |env|
+      assert_authorization @basic_auth, env
+      assert_header 'If-Match', "\"#{ref}\"", env
+      assert_equal 'true', env.params['purge']
+      [204, response_headers, '']
+    end
+    response = @client.purge_event(@collection, @key, @event_type, @timestamp, @ordinal, ref)
+    assert_equal 204, response.status
+  end
+
+  def test_list_events_without_timestamp
+    body = { "results" => [], "count" => 0, "next" => "" }
+    @stubs.get("/v0/#{@collection}/#{@key}/events/#{@event_type}") do |env|
+      assert_authorization @basic_auth, env
+      assert_accepts_json env
+      [200, response_headers, body.to_json]
+    end
+
+    response = @client.list_events(@collection, @key, @event_type)
+    assert_equal 200, response.status
+    assert_equal body, response.body
+  end
+
+  def test_list_events_with_timestamp
+    end_time = Time.now
+    start_time = end_time - (24 * 3600)
+    body = { "results" => [], "count" => 0, "next" => "" }
+
+    @stubs.get("/v0/#{@collection}/#{@key}/events/#{@event_type}") do |env|
+      assert_authorization @basic_auth, env
+      assert_accepts_json env
+      assert_equal start_time.to_i.to_s, env.params['startEvent']
+      assert_equal end_time.to_i.to_s, env.params['endEvent']
+      assert_equal ['startEvent', 'endEvent'].sort, env.params.keys.sort
+      [200, response_headers, body.to_json]
+    end
+    response = @client.list_events(@collection, @key, @event_type,
+      { start: start_time.to_i, end: end_time.to_i }
+    )
+    assert_equal 200, response.status
+    assert_equal body, response.body
+  end
+
+end

data/test/orchestrate/api/graph_test.rb

@@ -0,0 +1,44 @@
+require_relative '../../test_helper'
+
+class GraphTest < MiniTest::Unit::TestCase
+  def setup
+    @collection = 'tests'
+    @key = 'instance'
+    @kind = 'link'
+    @client, @stubs, @basic_auth = make_client_and_artifacts
+    @target_collection = 'bucket'
+    @target_key = 'vez'
+  end
+
+  def test_get_graph
+    body = { "count" => 0, "results" => [] }
+    @stubs.get("/v0/#{@collection}/#{@key}/relations/#{@kind}/#{@kind}") do |env|
+      assert_authorization @basic_auth, env
+      assert_accepts_json env
+      [200, response_headers, body.to_json]
+    end
+
+    response = @client.get_relations(@collection, @key, @kind, @kind)
+    assert_equal 200, response.status
+    assert_equal body, response.body
+  end
+
+  def test_put_graph
+    @stubs.put("/v0/#{@collection}/#{@key}/relation/#{@kind}/#{@target_collection}/#{@target_key}") do |env|
+      assert_authorization @basic_auth, env
+      [ 204, response_headers, '' ]
+    end
+    response = @client.put_relation(@collection, @key, @kind, @target_collection, @target_key)
+    assert_equal 204, response.status
+  end
+
+  def test_delete_graph
+    @stubs.delete("/v0/#{@collection}/#{@key}/relation/#{@kind}/#{@target_collection}/#{@target_key}") do |env|
+      assert_authorization @basic_auth, env
+      assert_equal 'true', env.params['purge']
+      [ 204, response_headers, '' ]
+    end
+    response = @client.delete_relation(@collection, @key, @kind, @target_collection, @target_key)
+    assert_equal 204, response.status
+  end
+end

data/test/orchestrate/api/key_value_test.rb

@@ -0,0 +1,173 @@
+require_relative "../../test_helper"
+
+class KeyValueTest < MiniTest::Unit::TestCase
+  def setup
+    @collection = 'test'
+    @key = 'keyname'
+    @client, @stubs, @basic_auth = make_client_and_artifacts
+  end
+
+  def test_gets_current_value_for_key_when_exists
+    ref = SecureRandom.hex(16)
+    ref_url = "/v0/#{@collection}/#{@key}/refs/#{ref}"
+    body = { "key" => "value" }
+    @stubs.get("/v0/#{@collection}/#{@key}") do |env|
+      assert_authorization @basic_auth, env
+      assert_accepts_json env
+      headers = {
+        'Content-Location' => ref_url,
+        'ETag' => "\"#{ref}\"",
+      }.merge(chunked_encoding_header)
+      [ 200, response_headers(headers), body.to_json]
+    end
+
+    response = @client.get(@collection, @key)
+    assert_equal 200, response.status
+    assert_equal body, response.body
+
+    assert_equal "\"#{ref}\"", response.headers['Etag']
+    assert_equal ref_url, response.headers['Content-Location']
+  end
+
+  def test_gets_key_value_is_404_when_does_not_exist
+    @stubs.get("/v0/#{@collection}/#{@key}") do |env|
+      assert_authorization @basic_auth, env
+      assert_accepts_json env
+      [ 404, response_headers(), response_not_found({collection:@collection, key:@key}) ]
+    end
+
+    response = @client.get(@collection, @key)
+    assert_equal 404, response.status
+    assert_equal 'items_not_found', response.body['code']
+  end
+
+  def test_puts_key_value_without_ref
+    body={"foo" => "bar"}
+    @stubs.put("/v0/#{@collection}/#{@key}") do |env|
+      assert_authorization @basic_auth, env
+      assert_header 'Content-Type', 'application/json', env
+      assert_equal body.to_json, env.body
+      [ 201, response_headers, '' ]
+    end
+
+    response = @client.put(@collection, @key, body)
+    assert_equal 201, response.status
+  end
+
+  def test_puts_key_value_with_specific_ref
+    body = {"foo" => "bar"}
+    ref = '123456'
+
+    @stubs.put("/v0/#{@collection}/#{@key}") do |env|
+      assert_authorization @basic_auth, env
+      assert_header 'If-Match', "\"#{ref}\"", env
+      assert_header 'Content-Type', 'application/json', env
+      assert_equal body.to_json, env.body
+      [ 200, response_headers, '' ]
+    end
+
+    response = @client.put(@collection, @key, body, ref)
+    assert_equal 200, response.status
+  end
+
+  def test_puts_key_value_if_unmodified
+    body = {"foo" => "bar"}
+    ref = '123456'
+
+    @stubs.put("/v0/#{@collection}/#{@key}") do |env|
+      assert_authorization @basic_auth, env
+      assert_header 'If-Match', "\"#{ref}\"", env
+      assert_header 'Content-Type', 'application/json', env
+      assert_equal body.to_json, env.body
+      [ 200, response_headers, '' ]
+    end
+
+    response = @client.put_if_unmodified(@collection, @key, body, ref)
+    assert_equal 200, response.status
+  end
+
+  def test_puts_key_value_with_inspecific_ref
+    body = {"foo" => "bar"}
+
+    @stubs.put("/v0/#{@collection}/#{@key}") do |env|
+      assert_authorization @basic_auth, env
+      assert_header 'If-None-Match', '*', env
+      assert_header 'Content-Type', 'application/json', env
+      assert_equal body.to_json, env.body
+      [ 200, response_headers, '' ]
+    end
+
+    response = @client.put(@collection, @key, body, false)
+    assert_equal 200, response.status
+  end
+
+  def test_puts_key_value_if_absent
+    body = {"foo" => "bar"}
+    @stubs.put("/v0/#{@collection}/#{@key}") do |env|
+      assert_authorization @basic_auth, env
+      assert_header 'If-None-Match', '*', env
+      assert_header 'Content-Type', 'application/json', env
+      assert_equal body.to_json, env.body
+      [ 200, response_headers, '' ]
+    end
+
+    response = @client.put_if_absent(@collection, @key, body)
+    assert_equal 200, response.status
+  end
+
+  def test_delete_key_value
+    @stubs.delete("/v0/#{@collection}/#{@key}") do |env|
+      assert_authorization @basic_auth, env
+      [ 204, response_headers, '' ]
+    end
+    response = @client.delete(@collection, @key)
+    assert_equal 204, response.status
+  end
+
+  def test_delete_key_value_with_condition
+    ref="12345"
+    @stubs.delete("/v0/#{@collection}/#{@key}") do |env|
+      assert_authorization @basic_auth, env
+      assert_header 'If-Match', "\"#{ref}\"", env
+      [ 204, response_headers, '' ]
+    end
+    response = @client.delete(@collection, @key, ref)
+    assert_equal 204, response.status
+  end
+
+  def test_delete_key_value_with_quoted_condition
+    ref='"12345"'
+    @stubs.delete("/v0/#{@collection}/#{@key}") do |env|
+      assert_authorization @basic_auth, env
+      assert_header 'If-Match', ref, env
+      [ 204, response_headers, '' ]
+    end
+    response = @client.delete(@collection, @key, ref)
+    assert_equal 204, response.status
+  end
+
+  def test_delete_key_value_with_purge
+    @stubs.delete("/v0/#{@collection}/#{@key}") do |env|
+      assert_authorization @basic_auth, env
+      assert_equal "true", env.params["purge"]
+      [ 204, response_headers, '' ]
+    end
+    response = @client.purge(@collection, @key)
+    assert_equal 204, response.status
+  end
+
+  def test_gets_ref
+    body = {"key" => "value"}
+    ref = '123456'
+    @stubs.get("/v0/#{@collection}/#{@key}/refs/#{ref}") do |env|
+      assert_authorization @basic_auth, env
+      assert_accepts_json env
+      [ 200, response_headers, body.to_json ]
+    end
+
+    response = @client.get(@collection, @key, ref)
+    assert_equal 200, response.status
+    assert_equal body, response.body
+  end
+
+end