orchestrate 0.5.1 → 0.6.0

data/test/orchestrate/api/response_test.rb

@@ -0,0 +1,36 @@
+require_relative '../../test_helper'
+
+class ResponseTest < MiniTest::Unit::TestCase
+
+  def setup
+    @client, @stubs, @basic_auth = make_client_and_artifacts
+  end
+
+  def test_collection_with_next_prev_link
+    @stubs.get("/v0/things") do |env|
+      assert_authorization @basic_auth, env
+      case env.params['offset']
+      when nil, '0'
+        nextLink = "/v0/things?offset=10"
+        [ 200, response_headers, { count: 14, next: nextLink, results: [] }.to_json ]
+      when '10'
+        prevLink = "/v0/things?offset=0"
+        [ 200, response_headers, { count: 14, prev: prevLink, results: [] }.to_json ]
+      else
+        [ 404, response_headers, '{}' ]
+      end
+    end
+    response = @client.list(:things)
+    assert response.next_link
+
+    next_page = response.next_results
+    assert_equal 200, next_page.status
+    assert_equal 14, next_page.count
+    assert_nil next_page.next_results
+
+    previous_page = next_page.previous_results
+    assert_equal 200, previous_page.status
+    assert_equal 14, previous_page.count
+    assert_nil previous_page.previous_results
+  end
+end

data/test/orchestrate/client_test.rb

@@ -3,32 +3,23 @@ require "test_helper"
 describe Orchestrate::Client do
 
   it "should initialize" do
-    client = Orchestrate::Client.new
+    client = Orchestrate::Client.new('8c3')
     client.must_be_kind_of Orchestrate::Client
-
-    client.config.must_equal Orchestrate.config
-  end
-
-  it "should initialize with config" do
-    config = Orchestrate::Configuration.new(api_key: "test-api-key")
-    client = Orchestrate::Client.new(config)
-    client.must_be_kind_of Orchestrate::Client
-    client.config.must_equal config
   end
 
   it "handles parallel requests" do
-    @client, @stubs = make_client_and_artifacts
-    @stubs.get("/v0/foo") do |env|
+    client, stubs = make_client_and_artifacts
+    stubs.get("/v0/foo") do |env|
       [ 200, response_headers, {}.to_json ]
     end
-    @stubs.get("/v0/users/mattly") do |env|
+    stubs.get("/v0/users/mattly") do |env|
       [ 200, response_headers, {}.to_json ]
     end
     responses = nil
     capture_warnings do
-      responses = @client.in_parallel do |r|
-        r[:list] = @client.list(:foo)
-        r[:user] = @client.get(:users, "mattly")
+      responses = client.in_parallel do |r|
+        r[:list] = client.list(:foo)
+        r[:user] = client.get(:users, "mattly")
       end
     end
     assert responses[:list]
@@ -37,4 +28,12 @@ describe Orchestrate::Client do
     assert_equal 200, responses[:user].status
   end
 
+  it "handles ping request" do
+    client, stubs = make_client_and_artifacts
+    stubs.get("/v0") do |env|
+      [ 200, response_headers, '' ]
+    end
+    client.ping
+  end
+
 end

data/test/test_helper.rb

@@ -5,12 +5,12 @@ require "base64"
 require "faraday"
 require "securerandom"
 require "time"
+require "logger"
 
 # Test Helpers ---------------------------------------------------------------
 
 def output_message(name, msg = nil)
   msg ||= "START TEST"
-  Orchestrate.config.logger.debug "\n======= #{msg}: #{name} ======="
 end
 
 # TODO this is a bit messy for now at least but there's a bunch of
@@ -19,15 +19,10 @@ def make_client_and_artifacts
   api_key = SecureRandom.hex(24)
   basic_auth = "Basic #{Base64.encode64("#{api_key}:").gsub(/\n/,'')}"
   stubs = Faraday::Adapter::Test::Stubs.new
-  # TODO: make it such that the client passes its optional config to the API::Request class
-  Orchestrate.configure do |config|
-    config.faraday = lambda do |faraday|
-      faraday.adapter :test, stubs
-    end
-    config.api_key = api_key
-    config.logger = Logger.new(File.join(File.dirname(__FILE__), "test.log"))
+  client = Orchestrate::Client.new(api_key) do |f|
+    f.adapter :test, stubs
+    f.response :logger, Logger.new(File.join(File.dirname(__FILE__), "test.log"))
   end
-  client = Orchestrate::Client.new
   [client, stubs, basic_auth]
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: orchestrate
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.6.0
 platform: ruby
 authors:
 - Matthew Lyon
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-29 00:00:00.000000000 Z
+date: 2014-06-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -127,6 +127,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".travis.yml"
+- ".yardopts"
 - Gemfile
 - LICENSE
 - README.md
@@ -134,17 +135,18 @@ files:
 - lib/orchestrate.rb
 - lib/orchestrate/api.rb
 - lib/orchestrate/api/errors.rb
+- lib/orchestrate/api/helpers.rb
+- lib/orchestrate/api/response.rb
 - lib/orchestrate/client.rb
-- lib/orchestrate/configuration.rb
-- lib/orchestrate/helpers.rb
 - lib/orchestrate/version.rb
 - orchestrate.gemspec
 - test/orchestrate/api/collections_test.rb
 - test/orchestrate/api/event_test.rb
+- test/orchestrate/api/exceptions_test.rb
 - test/orchestrate/api/graph_test.rb
 - test/orchestrate/api/key_value_test.rb
+- test/orchestrate/api/response_test.rb
 - test/orchestrate/client_test.rb
-- test/orchestrate/configuration_test.rb
 - test/test_helper.rb
 homepage: https://github.com/orchestrate-io/orchestrate-ruby
 licenses:
@@ -173,8 +175,10 @@ summary: Ruby client for Orchestrate.io
 test_files:
 - test/orchestrate/api/collections_test.rb
 - test/orchestrate/api/event_test.rb
+- test/orchestrate/api/exceptions_test.rb
 - test/orchestrate/api/graph_test.rb
 - test/orchestrate/api/key_value_test.rb
+- test/orchestrate/api/response_test.rb
 - test/orchestrate/client_test.rb
-- test/orchestrate/configuration_test.rb
 - test/test_helper.rb
+has_rdoc: 

data/lib/orchestrate/configuration.rb

@@ -1,53 +0,0 @@
-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

@@ -1,22 +0,0 @@
-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/test/orchestrate/configuration_test.rb

@@ -1,67 +0,0 @@
-require "test_helper"
-
-describe Orchestrate::Configuration do
-
-  before do
-    @config = Orchestrate::Configuration.new
-  end
-
-  it "should initialize" do
-    config = Orchestrate::Configuration.new
-    config.must_be_kind_of Orchestrate::Configuration
-  end
-
-  it "should initialize with arguments" do
-    logger = Logger.new(STDOUT)
-    config = Orchestrate::Configuration.new \
-      api_key: "test-key",
-      base_url: "test-url",
-      logger: logger
-    config.must_be_kind_of Orchestrate::Configuration
-    config.api_key.must_equal "test-key"
-    config.base_url.must_equal "test-url"
-    config.logger.must_equal logger
-  end
-
-  describe "#api_key" do
-
-    it "should not have a default value" do
-      @config.api_key.must_be_nil
-    end
-
-    it "should be settable and gettable" do
-      @config.api_key = "test-key"
-      @config.api_key.must_equal "test-key"
-    end
-
-  end
-
-  describe "#base_url" do
-
-    it "should default to 'https://api.orchestrate.io'" do
-      @config.base_url.must_equal "https://api.orchestrate.io"
-    end
-
-    it "should be settable and gettable" do
-      @config.base_url = "test-url"
-      @config.base_url.must_equal "test-url"
-    end
-
-  end
-
-  describe "#logger" do
-
-    it "should default to a Logger instance that outputs to STDOUT" do
-      @config.logger.must_be_kind_of Logger
-      @config.logger.instance_variable_get("@logdev").dev.must_equal STDOUT
-    end
-
-    it "should be settable and gettable" do
-      logger = Logger.new("/tmp/orchestrate-configuration-logger-test-#{rand}.log")
-      @config.logger = logger
-      @config.logger.must_equal logger
-    end
-
-  end
-
-end