heroics 0.0.1

data/test/client_test.rb

@@ -0,0 +1,162 @@
+require 'helper'
+
+class ClientTest < MiniTest::Unit::TestCase
+  include ExconHelper
+
+  # Client.<resource> raises a NoMethodError when a method is invoked
+  # without a matching resource.
+  def test_invalid_resource
+    client = Heroics::Client.new({})
+    error = assert_raises NoMethodError do
+      client.unknown
+    end
+    assert_match(
+      /undefined method `unknown' for #<Heroics::Client:0x[0-9a-f]{14}>/,
+      error.message)
+  end
+
+  # Client.<resource>.<link> finds the appropriate link and invokes it.
+  def test_resource
+    schema = Heroics::Schema.new(SAMPLE_SCHEMA)
+    link = Heroics::Link.new('https://username:secret@example.com',
+                             schema.resource('resource').link('list'))
+    resource = Heroics::Resource.new({'link' => link})
+    client = Heroics::Client.new({'resource' => resource})
+    Excon.stub(method: :get) do |request|
+      assert_equal('Basic dXNlcm5hbWU6c2VjcmV0',
+                   request[:headers]['Authorization'])
+      assert_equal('example.com', request[:host])
+      assert_equal(443, request[:port])
+      assert_equal('/resource', request[:path])
+      Excon.stubs.pop
+      {status: 200, body: 'Hello, world!'}
+    end
+    assert_equal('Hello, world!', client.resource.link)
+  end
+end
+
+class ClientFromSchemaTest < MiniTest::Unit::TestCase
+  include ExconHelper
+
+  # client_from_schema returns a Client generated from the specified schema.
+  def test_client_from_schema
+    schema = Heroics::Schema.new(SAMPLE_SCHEMA)
+    client = Heroics::client_from_schema(schema, 'https://example.com')
+    body = {'Hello' => 'World!'}
+    Excon.stub(method: :post) do |request|
+      assert_equal('/resource', request[:path])
+      Excon.stubs.pop
+      {status: 200, headers: {'Content-Type' => 'application/json'},
+       body: MultiJson.dump(body)}
+    end
+    assert_equal(body, client.resource.create)
+  end
+
+  # client_from_schema optionally accepts custom headers to pass with every
+  # request made by the generated client.
+  def test_client_from_schema_with_custom_headers
+    schema = Heroics::Schema.new(SAMPLE_SCHEMA)
+    client = Heroics::client_from_schema(
+      schema, 'https://example.com',
+      default_headers: {'Accept' => 'application/vnd.heroku+json; version=3'})
+    Excon.stub(method: :post) do |request|
+      assert_equal('application/vnd.heroku+json; version=3',
+                   request[:headers]['Accept'])
+      Excon.stubs.pop
+      {status: 200}
+    end
+    client.resource.create
+  end
+
+  # client_from_schema takes an optional :cache parameter which it uses when
+  # constructing Link instances.
+  def test_client_from_schema_with_cache
+    body = {'Hello' => 'World!'}
+    Excon.stub(method: :get) do |request|
+      Excon.stubs.pop
+      {status: 201, headers: {'Content-Type' => 'application/json',
+                              'ETag' => 'etag-contents'},
+       body: MultiJson.dump(body)}
+    end
+
+    schema = Heroics::Schema.new(SAMPLE_SCHEMA)
+    client = Heroics::client_from_schema(schema, 'https://example.com',
+                                         cache: Moneta.new(:Memory))
+    assert_equal(body, client.resource.list)
+
+    Excon.stub(method: :get) do |request|
+      assert_equal('etag-contents', request[:headers]['If-None-Match'])
+      Excon.stubs.pop
+      {status: 304, headers: {'Content-Type' => 'application/json'}}
+    end
+    assert_equal(body, client.resource.list)
+  end
+end
+
+class ClientFromSchemaURLTest < MiniTest::Unit::TestCase
+  include ExconHelper
+
+  # client_from_schema_url downloads a schema and returns a Client generated
+  # from it.
+  def test_client_from_schema_url
+    Excon.stub(method: :get) do |request|
+      assert_equal('example.com', request[:host])
+      assert_equal('/schema', request[:path])
+      Excon.stubs.pop
+      {status: 200, headers: {'Content-Type' => 'application/json'},
+       body: MultiJson.dump(SAMPLE_SCHEMA)}
+    end
+
+    client = Heroics::client_from_schema_url('https://example.com/schema')
+    body = {'Hello' => 'World!'}
+    Excon.stub(method: :post) do |request|
+      assert_equal('example.com', request[:host])
+      assert_equal('/resource', request[:path])
+      Excon.stubs.pop
+      {status: 200, headers: {'Content-Type' => 'application/json'},
+       body: MultiJson.dump(body)}
+    end
+    assert_equal(body, client.resource.create)
+  end
+
+  # client_from_schema_url optionally accepts custom headers to include in the
+  # request to download the schema.  The same headers are passed in requests
+  # made by the generated client.
+  def test_client_from_schema_url_with_custom_headers
+    Excon.stub(method: :get) do |request|
+      assert_equal('example.com', request[:host])
+      assert_equal('/schema', request[:path])
+      assert_equal('application/vnd.heroku+json; version=3',
+                   request[:headers]['Accept'])
+      Excon.stubs.pop
+      {status: 200, headers: {'Content-Type' => 'application/json'},
+       body: MultiJson.dump(SAMPLE_SCHEMA)}
+    end
+
+    client = Heroics::client_from_schema_url(
+      'https://example.com/schema',
+      default_headers: {'Accept' => 'application/vnd.heroku+json; version=3'})
+    body = {'Hello' => 'World!'}
+    Excon.stub(method: :post) do |request|
+      assert_equal('application/vnd.heroku+json; version=3',
+                   request[:headers]['Accept'])
+      Excon.stubs.pop
+      {status: 200, headers: {'Content-Type' => 'application/json'},
+       body: MultiJson.dump(body)}
+    end
+    assert_equal(body, client.resource.create)
+  end
+
+  # client_from_schema_url raises an Excon error when the request to download
+  # the schema fails.
+  def test_client_from_schema_url_with_failed_request
+    Excon.stub(method: :get) do |request|
+      Excon.stubs.pop
+      {status: 404}
+    end
+
+    assert_raises Excon::Errors::NotFound do
+      Heroics::client_from_schema_url('https://example.com/schema')
+    end
+  end
+end

data/test/command_test.rb

@@ -0,0 +1,214 @@
+require 'helper'
+require 'stringio'
+
+class CommandTest < MiniTest::Unit::TestCase
+  include ExconHelper
+
+  # Command.name returns the name of the command, which is made up by joining
+  # the resource name and link title with a colon.
+  def test_name
+    schema = Heroics::Schema.new(SAMPLE_SCHEMA)
+    client = Heroics::client_from_schema(schema, 'https://example.com')
+    output = StringIO.new
+    command = Heroics::Command.new(
+      'cli', schema.resource('resource').link('list'), client, output)
+    assert_equal('resource:list', command.name)
+  end
+
+  # Command.description returns a description for the command.
+  def test_description
+    schema = Heroics::Schema.new(SAMPLE_SCHEMA)
+    client = Heroics::client_from_schema(schema, 'https://example.com')
+    output = StringIO.new
+    command = Heroics::Command.new(
+      'cli', schema.resource('resource').link('list'), client, output)
+    assert_equal('Show all sample resources', command.description)
+  end
+
+  # Command.run calls the correct method on the client when no link parameters
+  # are provided.
+  def test_run_without_parameters
+    schema = Heroics::Schema.new(SAMPLE_SCHEMA)
+    client = Heroics::client_from_schema(schema, 'https://example.com')
+    output = StringIO.new
+    command = Heroics::Command.new(
+      'cli', schema.resource('resource').link('list'), client, output)
+
+    body = ['Hello', 'World!']
+    Excon.stub(method: :get) do |request|
+      assert_equal('/resource', request[:path])
+      Excon.stubs.pop
+      {status: 200, headers: {'Content-Type' => 'application/json'},
+       body: MultiJson.dump(body)}
+    end
+
+    command.run
+    assert_equal(MultiJson.dump(body, pretty: true) + "\n", output.string)
+  end
+
+  # Command.run calls the correct method on the client and passes link
+  # parameters when they're provided.
+  def test_run_with_parameters
+    schema = Heroics::Schema.new(SAMPLE_SCHEMA)
+    client = Heroics::client_from_schema(schema, 'https://example.com')
+    output = StringIO.new
+    command = Heroics::Command.new(
+      'cli', schema.resource('resource').link('info'), client, output)
+
+    uuid = '1ab1c589-df46-40aa-b786-60e83b1efb10'
+    body = {'Hello' => 'World!'}
+    Excon.stub(method: :get) do |request|
+      assert_equal("/resource/#{uuid}", request[:path])
+      Excon.stubs.pop
+      {status: 200, headers: {'Content-Type' => 'application/json'},
+       body: MultiJson.dump(body)}
+    end
+
+    command.run(uuid)
+    assert_equal(MultiJson.dump(body, pretty: true) + "\n", output.string)
+  end
+
+  # Command.run calls the correct method on the client and passes a request
+  # body to the link when it's provided.
+  def test_run_with_request_body_and_text_response
+    schema = Heroics::Schema.new(SAMPLE_SCHEMA)
+    client = Heroics::client_from_schema(schema, 'https://example.com')
+    output = StringIO.new
+    command = Heroics::Command.new(
+      'cli', schema.resource('resource').link('create'), client, output)
+
+    body = {'Hello' => 'World!'}
+    Excon.stub(method: :post) do |request|
+      assert_equal('/resource', request[:path])
+      assert_equal('application/json', request[:headers]['Content-Type'])
+      assert_equal(body, MultiJson.load(request[:body]))
+      Excon.stubs.pop
+      {status: 201}
+    end
+
+    command.run(body)
+    assert_equal('', output.string)
+  end
+
+  # Command.run calls the correct method on the client and converts the result
+  # to an array, if a range response is received, before writing it out.
+  def test_run_with_range_response
+    schema = Heroics::Schema.new(SAMPLE_SCHEMA)
+    client = Heroics::client_from_schema(schema, 'https://example.com')
+    output = StringIO.new
+    command = Heroics::Command.new(
+      'cli', schema.resource('resource').link('list'), client, output)
+
+    Excon.stub(method: :get) do |request|
+      Excon.stubs.shift
+      {status: 206, headers: {'Content-Type' => 'application/json',
+                              'Content-Range' => 'id 1..2; max=200'},
+       body: MultiJson.dump([2])}
+    end
+
+    Excon.stub(method: :get) do |request|
+      Excon.stubs.shift
+      {status: 206, headers: {'Content-Type' => 'application/json',
+                              'Content-Range' => 'id 0..1; max=200',
+                              'Next-Range' => '201'},
+       body: MultiJson.dump([1])}
+    end
+
+    command.run
+    assert_equal(MultiJson.dump([1, 2], pretty: true) + "\n", output.string)
+  end
+
+  # Command.run calls the correct method on the client and passes parameters
+  # and a request body to the link when they're provided.
+  def test_run_with_request_body_and_parameters
+    schema = Heroics::Schema.new(SAMPLE_SCHEMA)
+    client = Heroics::client_from_schema(schema, 'https://example.com')
+    output = StringIO.new
+    command = Heroics::Command.new(
+      'cli', schema.resource('resource').link('update'), client, output)
+
+    uuid = '1ab1c589-df46-40aa-b786-60e83b1efb10'
+    body = {'Hello' => 'World!'}
+    result = {'Goodbye' => 'Universe!'}
+    Excon.stub(method: :patch) do |request|
+      assert_equal("/resource/#{uuid}", request[:path])
+      assert_equal('application/json', request[:headers]['Content-Type'])
+      assert_equal(body, MultiJson.load(request[:body]))
+      Excon.stubs.pop
+      {status: 200, headers: {'Content-Type' => 'application/json'},
+       body: MultiJson.dump(result)}
+    end
+
+    command.run(uuid, body)
+    assert_equal(MultiJson.dump(result, pretty: true) + "\n", output.string)
+  end
+
+  # Command.run raises an ArgumentError if too few parameters are provided.
+  def test_run_with_too_few_parameters
+    schema = Heroics::Schema.new(SAMPLE_SCHEMA)
+    client = Heroics::client_from_schema(schema, 'https://example.com')
+    output = StringIO.new
+    command = Heroics::Command.new(
+      'cli', schema.resource('resource').link('info'), client, output)
+    assert_raises ArgumentError do
+      command.run
+    end
+  end
+
+  # Command.run raises an ArgumentError if too many parameters are provided.
+  def test_run_with_too_many_parameters
+    schema = Heroics::Schema.new(SAMPLE_SCHEMA)
+    client = Heroics::client_from_schema(schema, 'https://example.com')
+    output = StringIO.new
+    command = Heroics::Command.new(
+      'cli', schema.resource('resource').link('info'), client, output)
+    assert_raises ArgumentError do
+      command.run('too', 'many', 'parameters')
+    end
+  end
+
+  # Command.usage displays usage information.
+  def test_usage
+    schema = Heroics::Schema.new(SAMPLE_SCHEMA)
+    client = Heroics::client_from_schema(schema, 'https://example.com')
+    output = StringIO.new
+    command = Heroics::Command.new(
+      'cli', schema.resource('resource').link('update'), client, output)
+    command.usage
+    expected = <<-USAGE
+Usage: cli resource:update <uuid_field> <body>
+
+Description:
+  Update a sample resource
+
+Body example:
+  {
+    "date_field": "2013-10-19 22:10:29Z",
+    "string_field": "Sample text.",
+    "boolean_field": true,
+    "uuid_field": "44724831-bf66-4bc2-865f-e2c4c2b14c78",
+    "email_field": "username@example.com"
+  }
+USAGE
+    assert_equal(expected, output.string)
+  end
+
+  # Command.usage correctly handles parameters that are described by 'oneOf'
+  # and 'anyOf' sub-parameter lists.
+  def test_usage_with_one_of_field
+    schema = Heroics::Schema.new(SAMPLE_SCHEMA)
+    client = Heroics::client_from_schema(schema, 'https://example.com')
+    output = StringIO.new
+    command = Heroics::Command.new(
+      'cli', schema.resource('resource').link('identify_resource'), client,
+      output)
+    command.usage
+    expected = <<-USAGE
+Usage: cli resource:identify-resource <uuid_field|email_field>
+
+Description:
+  Show a sample resource
+USAGE
+    assert_equal(expected, output.string)
+  end
+end

data/test/helper.rb

@@ -0,0 +1,175 @@
+require 'minitest/autorun'
+require 'time'
+
+require 'heroics'
+
+module ExconHelper
+  def setup
+    super
+    Excon.stubs.clear
+    Excon.defaults[:mock] = true
+  end
+
+  def teardown
+    # FIXME This is a bit ugly, but Excon doesn't provide a builtin way to
+    # ensure that a request was invoked, so we have to do it ourselves.
+    # Without this, and the Excon.stubs.pop calls in the tests that use this
+    # helper, tests will pass if request logic is completely removed from
+    # application code. -jkakar
+    assert(Excon.stubs.empty?, 'Expected HTTP requests were not made.')
+    super
+  end
+end
+
+# A simple JSON schema for testing purposes.
+SAMPLE_SCHEMA = {
+  'definitions' => {
+    'resource' => {
+      'description' => 'A sample resource to use in tests.',
+      'id'          => 'schema/resource',
+      '$schema'     => 'http://json-schema.org/draft-04/hyper-schema',
+      'title'       => 'Sample resource title',
+      'type'        => ['object'],
+
+      'definitions' => {
+        'date_field' => {
+          'description' => 'A sample date field',
+          'example'     => '2013-10-19 22:10:29Z',
+          'format'      => 'date-time',
+          'readOnly'    => true,
+          'type'        => ['string']
+        },
+
+        'string_field' => {
+          'description' => 'A sample string field',
+          'example'     => 'Sample text.',
+          'readOnly'    => true,
+          'type'        => ['string']
+        },
+
+        'boolean_field' => {
+          'description' => 'A sample boolean field',
+          'example'     => true,
+          'type'        => ['boolean']
+        },
+
+        'uuid_field' => {
+          'description' => 'A sample UUID field',
+          'example'     => '44724831-bf66-4bc2-865f-e2c4c2b14c78',
+          'format'      => 'uuid',
+          'readOnly'    => true,
+          'type'        => ['string']
+        },
+
+        'email_field' => {
+          'description' => 'A sample email address field',
+          'example'     => 'username@example.com',
+          'format'      => 'email',
+          'readOnly'    => true,
+          'type'        => ['string']
+        },
+
+        'identity' => {
+          'oneOf' => [
+            {'$ref' => '#/definitions/resource/definitions/uuid_field'},
+            {'$ref' => '#/definitions/resource/definitions/email_field'}]
+        }
+      },
+
+      'properties' => {
+        'date_field' => {
+          '$ref' => '#/definitions/resource/definitions/date_field'},
+        'string_field' => {
+          '$ref' => '#/definitions/resource/definitions/string_field'},
+        'boolean_field' => {
+          '$ref' => '#/definitions/resource/definitions/boolean_field'},
+        'uuid_field' => {
+          '$ref' => '#/definitions/resource/definitions/uuid_field'},
+        'email_field' => {
+          '$ref' => '#/definitions/resource/definitions/email_field'},
+      },
+
+      'links' => [
+        {'description' => 'Show all sample resources',
+         'href'        => '/resource',
+         'method'      => 'GET',
+         'rel'         => 'instances',
+         'title'       => 'List'},
+
+        {'description' => 'Show a sample resource',
+         'href'        => '/resource/{(%23%2Fdefinitions%2Fresource%2Fdefinitions%2Fuuid_field)}',
+         'method'      => 'GET',
+         'rel'         => 'self',
+         'title'       => 'Info'},
+
+        {'description' => 'Show a sample resource',
+         'href'        => '/resource/{(%23%2Fdefinitions%2Fresource%2Fdefinitions%2Fidentity)}',
+         'method'      => 'GET',
+         'rel'         => 'self',
+         'title'       => 'Identify resource'},
+
+        {'description' => 'Create a sample resource',
+         'href'        => '/resource',
+         'method'      => 'POST',
+         'rel'         => 'create',
+         'title'       => 'Create',
+         'schema'      => {
+           'properties' => {
+             'date_field' => {
+               '$ref' => '#/definitions/resource/definitions/date_field'},
+             'string_field' => {
+               '$ref' => '#/definitions/resource/definitions/string_field'},
+             'boolean_field' => {
+               '$ref' => '#/definitions/resource/definitions/boolean_field'},
+             'uuid_field' => {
+               '$ref' => '#/definitions/resource/definitions/uuid_field'},
+             'email_field' => {
+               '$ref' => '#/definitions/resource/definitions/email_field'}}}},
+
+        {'description' => 'Update a sample resource',
+         'href'        => '/resource/{(%23%2Fdefinitions%2Fresource%2Fdefinitions%2Fuuid_field)}',
+         'method'      => 'PATCH',
+         'rel'         => 'update',
+         'title'       => 'Update',
+         'schema'      => {
+           'properties' => {
+             'date_field' => {
+               '$ref' => '#/definitions/resource/definitions/date_field'},
+             'string_field' => {
+               '$ref' => '#/definitions/resource/definitions/string_field'},
+             'boolean_field' => {
+               '$ref' => '#/definitions/resource/definitions/boolean_field'},
+             'uuid_field' => {
+               '$ref' => '#/definitions/resource/definitions/uuid_field'},
+             'email_field' => {
+               '$ref' => '#/definitions/resource/definitions/email_field'}}}},
+
+        {'description' => 'Delete an existing sample resource at specific time',
+         'href'        => '/resource/{(%23%2Fdefinitions%2Fresource%2Fdefinitions%2Fdate_field)}',
+         'method'      => 'DELETE',
+         'rel'         => 'destroy',
+         'title'       => 'Delete'}
+      ]
+    },
+
+    'another-resource' => {
+      'description' => 'Another sample resource to use in tests.',
+      'id'          => 'schema/another-resource',
+      '$schema'     => 'http://json-schema.org/draft-04/hyper-schema',
+      'title'       => 'Another sample resource title',
+      'type'        => ['object'],
+
+      'definitions' => {},
+
+      'properties' => {},
+
+      'links' => [
+        {'description' => 'Show all sample resources',
+         'href'        => '/another-resource',
+         'method'      => 'GET',
+         'rel'         => 'instances',
+         'title'       => 'List'}
+      ]
+    },
+ }
+}