RubyGems - komoju - Versions diffs - 0.0.0 → 0.0.3 - Mend

komoju 0.0.0 → 0.0.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (37) hide show

checksums.yaml +4 -4
data/.gitignore +2 -14
data/.gitmodules +3 -0
data/Gemfile.lock +34 -0
data/LICENSE.txt +1 -1
data/README.md +14 -2
data/Rakefile +9 -0
data/bin/generate-client +11 -0
data/komoju.gemspec +15 -6
data/lib/komoju/client.rb +460 -0
data/lib/komoju/version.rb +1 -1
data/lib/komoju.rb +10 -2
data/test/client_test.rb +8 -0
data/test/helper.rb +1 -0
data/vendor/heroics/lib/heroics/cli.rb +88 -0
data/vendor/heroics/lib/heroics/client.rb +109 -0
data/vendor/heroics/lib/heroics/client_generator.rb +99 -0
data/vendor/heroics/lib/heroics/command.rb +67 -0
data/vendor/heroics/lib/heroics/errors.rb +6 -0
data/vendor/heroics/lib/heroics/link.rb +120 -0
data/vendor/heroics/lib/heroics/naming.rb +19 -0
data/vendor/heroics/lib/heroics/resource.rb +30 -0
data/vendor/heroics/lib/heroics/schema.rb +444 -0
data/vendor/heroics/lib/heroics/version.rb +3 -0
data/vendor/heroics/lib/heroics.rb +22 -0
data/vendor/heroics/test/cli_test.rb +236 -0
data/vendor/heroics/test/client_generator_test.rb +34 -0
data/vendor/heroics/test/client_test.rb +215 -0
data/vendor/heroics/test/command_test.rb +214 -0
data/vendor/heroics/test/helper.rb +204 -0
data/vendor/heroics/test/link_test.rb +398 -0
data/vendor/heroics/test/naming_test.rb +45 -0
data/vendor/heroics/test/resource_test.rb +35 -0
data/vendor/heroics/test/schema_test.rb +287 -0
data/vendor/heroics/test/version_test.rb +9 -0
data/vendor/heroics/test.rb +42 -0
metadata +139 -8

data/vendor/heroics/test/cli_test.rb ADDED Viewed

@@ -0,0 +1,236 @@
+require 'helper'
+require 'stringio'
+class CLITest < MiniTest::Unit::TestCase
+  include ExconHelper
+  # CLI.run displays usage information when no arguments are provided.
+  def test_run_without_arguments
+    schema = Heroics::Schema.new(SAMPLE_SCHEMA)
+    client = Heroics::client_from_schema(schema, 'https://example.com')
+    output = StringIO.new
+    command1 = Heroics::Command.new(
+      'cli', schema.resource('resource').link('list'), client, output)
+    command2 = Heroics::Command.new(
+      'cli', schema.resource('resource').link('info'), client, output)
+    cli = Heroics::CLI.new('cli', {'resource:list' => command1,
+                                   'resource:info' => command2}, output)
+    cli.run
+    expected = <<-USAGE
+Usage: cli <command> [<parameter> [...]] [<body>]
+Help topics, type "cli help <topic>" for more details:
+  resource:info    Show a sample resource
+  resource:list    Show all sample resources
+USAGE
+    assert_equal(expected, output.string)
+  end
+  # CLI.run displays usage information when the help command is specified.
+  def test_run_with_help_command
+    schema = Heroics::Schema.new(SAMPLE_SCHEMA)
+    client = Heroics::client_from_schema(schema, 'https://example.com')
+    output = StringIO.new
+    command1 = Heroics::Command.new(
+      'cli', schema.resource('resource').link('list'), client, output)
+    command2 = Heroics::Command.new(
+      'cli', schema.resource('resource').link('info'), client, output)
+    cli = Heroics::CLI.new('cli', {'resource:list' => command1,
+                                   'resource:info' => command2}, output)
+    cli.run('help')
+    expected = <<-USAGE
+Usage: cli <command> [<parameter> [...]] [<body>]
+Help topics, type "cli help <topic>" for more details:
+  resource:info    Show a sample resource
+  resource:list    Show all sample resources
+USAGE
+    assert_equal(expected, output.string)
+  end
+  # CLI.run displays command-specific help when a command name is included
+  # with the 'help' command.
+  def test_run_with_help_command_and_explicit_command_name
+    schema = Heroics::Schema.new(SAMPLE_SCHEMA)
+    client = Heroics::client_from_schema(schema, 'https://example.com')
+    output = StringIO.new
+    command1 = Heroics::Command.new(
+      'cli', schema.resource('resource').link('list'), client, output)
+    command2 = Heroics::Command.new(
+      'cli', schema.resource('resource').link('info'), client, output)
+    cli = Heroics::CLI.new('cli', {'resource:list' => command1,
+                                   'resource:info' => command2}, output)
+    cli.run('help', 'resource:info')
+    expected = <<-USAGE
+Usage: cli resource:info <uuid_field>
+Description:
+  Show a sample resource
+USAGE
+    assert_equal(expected, output.string)
+  end
+  # CLI.run displays an error message when no commands have been registered.
+  def test_run_without_commands
+    output = StringIO.new
+    cli = Heroics::CLI.new('cli', {}, output)
+    cli.run('help')
+    assert_equal('No commands are available.', output.string)
+  end
+  # CLI.run displays an error message when an unknown command name is used.
+  def test_run_with_unknown_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)
+    cli = Heroics::CLI.new('cli', {'resource:list' => command}, output)
+    cli.run('unknown:command')
+    assert_equal("There is no command called 'unknown:command'.\n",
+                 output.string)
+  end
+  # CLI.run runs the command matching the specified name.
+  def test_run_with_dashed_command_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('identify_resource'), client,
+      output)
+    cli = Heroics::CLI.new('cli', {'resource:identify-resource' => command},
+                           output)
+    uuid = '1ab1c589-df46-40aa-b786-60e83b1efb10'
+    Excon.stub(method: :get) do |request|
+      assert_equal("/resource/#{uuid}", request[:path])
+      Excon.stubs.pop
+      {status: 200}
+    end
+    cli.run('resource:identify-resource', uuid)
+    assert_equal('', output.string)
+  end
+  # CLI.run runs the resource matching the specified name.
+  def test_run_with_dashed_resource_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('another-resource').link('list'), client, output)
+    cli = Heroics::CLI.new('cli', {'another-resource:list' => command},
+                           output)
+    result = {'Hello' => 'World!'}
+    Excon.stub(method: :get) do |request|
+      assert_equal("/another-resource", request[:path])
+      Excon.stubs.pop
+      {status: 200, headers: {'Content-Type' => 'application/json'},
+       body: MultiJson.dump(result)}
+    end
+    cli.run('another-resource:list')
+    assert_equal(MultiJson.dump(result, pretty: true) + "\n", output.string)
+  end
+  # CLI.run runs the command matching the specified name and passes parameters
+  # to it.
+  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('update'), client, output)
+    cli = Heroics::CLI.new('cli', {'resource:update' => command}, 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
+    cli.run('resource:update', uuid, body)
+    assert_equal(MultiJson.dump(result, pretty: true) + "\n", output.string)
+  end
+end
+class CLIFromSchemaTest < MiniTest::Unit::TestCase
+  include ExconHelper
+  # cli_from_schema returns a CLI generated from the specified schema.
+  def test_cli_from_schema
+    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
+    schema = Heroics::Schema.new(SAMPLE_SCHEMA)
+    output = StringIO.new
+    cli = Heroics.cli_from_schema('cli', output, schema, 'https://example.com')
+    cli.run('resource:update', uuid, body)
+    assert_equal(MultiJson.dump(result, pretty: true) + "\n", output.string)
+  end
+  # cli_from_schema returns a CLI that can make requests to APIs mounted under
+  # a prefix, such as http://example.com/api, for example.
+  def test_client_from_schema_with_url_prefix
+    uuid = '1ab1c589-df46-40aa-b786-60e83b1efb10'
+    body = {'Hello' => 'World!'}
+    result = {'Goodbye' => 'Universe!'}
+    Excon.stub(method: :patch) do |request|
+      assert_equal("/api/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
+    schema = Heroics::Schema.new(SAMPLE_SCHEMA)
+    output = StringIO.new
+    cli = Heroics.cli_from_schema('cli', output, schema,
+                                  'https://example.com/api')
+    cli.run('resource:update', uuid, body)
+    assert_equal(MultiJson.dump(result, pretty: true) + "\n", output.string)
+  end
+  # cli_from_schema optionally accepts custom headers to pass with every
+  # request made by the generated CLI.
+  def test_cli_from_schema_with_custom_headers
+    uuid = '1ab1c589-df46-40aa-b786-60e83b1efb10'
+    body = {'Hello' => 'World!'}
+    result = {'Goodbye' => 'Universe!'}
+    Excon.stub(method: :patch) 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(result)}
+    end
+    schema = Heroics::Schema.new(SAMPLE_SCHEMA)
+    output = StringIO.new
+    cli = Heroics.cli_from_schema(
+      'cli', output, schema, 'https://example.com',
+      default_headers: {'Accept' => 'application/vnd.heroku+json; version=3'})
+    cli.run('resource:update', uuid, body)
+    assert_equal(MultiJson.dump(result, pretty: true) + "\n", output.string)
+  end
+end

data/vendor/heroics/test/client_generator_test.rb ADDED Viewed

@@ -0,0 +1,34 @@
+require 'helper'
+require 'netrc'
+require 'stringio'
+class GenerateClientTest  < MiniTest::Unit::TestCase
+  include ExconHelper
+  # generate_client takes a module, schema, API URL and options and returns a
+  # string containing generated Ruby client code.
+  def test_generate_client
+    Excon.stub(method: :get) do |request|
+      assert_equal('example.com', request[:host])
+      assert_equal('/schema', request[:path])
+      assert_equal('application/vnd.example+json; version=3',
+                   request[:headers]['Accept'])
+      Excon.stubs.pop
+      {status: 200, headers: {'Content-Type' => 'application/json'},
+       body: MultiJson.dump(SAMPLE_SCHEMA)}
+    end
+    netrc = Netrc.read
+    username, token = netrc['example.com']
+    schema_url = "https://example.com/schema"
+    options = {
+        default_headers: {'Accept' => 'application/vnd.example+json; version=3'},
+        cache: 'Moneta.new(:File, dir: "#{Dir.home}/.heroics/example")'
+    }
+    schema = Heroics.download_schema(schema_url, options)
+    client_source = Heroics.generate_client("ExampleAPI", schema,
+                                            "api.example.com", options)
+    # Ensure the generated code is syntactically valid.
+    eval(client_source)
+  end
+end

data/vendor/heroics/test/client_test.rb ADDED Viewed

@@ -0,0 +1,215 @@
+require 'helper'
+class ClientTest < MiniTest::Unit::TestCase
+  include ExconHelper
+  # Client.to_s returns a simple human-readable description of the client
+  # instance with the URL embedded in it.  A password, if present in the URL,
+  # is redacted to avoid leaking credentials.
+  def test_to_s
+    client = Heroics::Client.new({}, 'http://foo:bar@example.com')
+    assert_equal('#<Heroics::Client url="http://foo:REDACTED@example.com">',
+                 client.to_s)
+  end
+  # Client.<resource> raises a NoMethodError when a method is invoked
+  # without a matching resource.
+  def test_invalid_resource
+    client = Heroics::Client.new({}, 'http://example.com')
+    error = assert_raises NoMethodError do
+      client.unknown
+    end
+    assert_equal("undefined method `unknown' for " +
+                 '#<Heroics::Client url="http://example.com">',
+                 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},
+                                 'http://example.com')
+    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 returns a Client that can make requests to APIs mounted
+  # under a prefix, such as http://example.com/api, for example.
+  def test_client_from_schema_with_url_prefix
+    schema = Heroics::Schema.new(SAMPLE_SCHEMA)
+    client = Heroics::client_from_schema(schema, 'https://example.com/api')
+    body = {'Hello' => 'World!'}
+    Excon.stub(method: :post) do |request|
+      assert_equal('/api/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 OAuthClientFromSchemaTest < MiniTest::Unit::TestCase
+  include ExconHelper
+  # oauth_client_from_schema injects an Authorization header, built from the
+  # specified OAuth token, into the default header options.
+  def test_oauth_client_from_schema
+    body = {'Hello' => 'World!'}
+    Excon.stub(method: :get) do |request|
+      assert_equal(
+        'Bearer c55ef0d8-40b6-4759-b1bf-4a6f94190a66',
+        request[:headers]['Authorization'])
+      Excon.stubs.pop
+      {status: 200, headers: {'Content-Type' => 'application/json'},
+       body: MultiJson.dump(body)}
+    end
+    oauth_token = 'c55ef0d8-40b6-4759-b1bf-4a6f94190a66'
+    schema = Heroics::Schema.new(SAMPLE_SCHEMA)
+    client = Heroics.oauth_client_from_schema(oauth_token, schema,
+                                              'https://example.com')
+    assert_equal(body, client.resource.list)
+  end
+  # oauth_client_from_schema doesn't mutate the options object, and in
+  # particular, it doesn't mutate the :default_headers Hash in that object.
+  def test_oauth_client_from_schema_with_options
+    body = {'Hello' => 'World!'}
+    Excon.stub(method: :get) do |request|
+      assert_equal('application/vnd.heroku+json; version=3',
+                   request[:headers]['Accept'])
+      assert_equal(
+        'Bearer c55ef0d8-40b6-4759-b1bf-4a6f94190a66',
+        request[:headers]['Authorization'])
+      Excon.stubs.pop
+      {status: 200, headers: {'Content-Type' => 'application/json'},
+       body: MultiJson.dump(body)}
+    end
+    oauth_token = 'c55ef0d8-40b6-4759-b1bf-4a6f94190a66'
+    options = {
+      default_headers: {'Accept' => 'application/vnd.heroku+json; version=3'}}
+    schema = Heroics::Schema.new(SAMPLE_SCHEMA)
+    client = Heroics.oauth_client_from_schema(oauth_token, schema,
+                                              'https://example.com', options)
+    assert_equal(body, client.resource.list)
+  end
+end
+class TokenClientFromSchemaTest < MiniTest::Unit::TestCase
+  include ExconHelper
+  # token_client_from_schema injects an Authorization header, built from the
+  # specified token, into the default header options.
+  def test_token_client_from_schema
+    body = {'Hello' => 'World!'}
+    Excon.stub(method: :get) do |request|
+      assert_equal(
+        'Token token=c55ef0d8-40b6-4759-b1bf-4a6f94190a66',
+        request[:headers]['Authorization'])
+      Excon.stubs.pop
+      {status: 200, headers: {'Content-Type' => 'application/json'},
+       body: MultiJson.dump(body)}
+    end
+    token = 'c55ef0d8-40b6-4759-b1bf-4a6f94190a66'
+    schema = Heroics::Schema.new(SAMPLE_SCHEMA)
+    client = Heroics.token_client_from_schema(token, schema,
+                                              'https://example.com')
+    assert_equal(body, client.resource.list)
+  end
+  # token_client_from_schema doesn't mutate the options object, and in
+  # particular, it doesn't mutate the :default_headers Hash in that object.
+  def test_token_client_from_schema_with_options
+    body = {'Hello' => 'World!'}
+    Excon.stub(method: :get) do |request|
+      assert_equal('application/vnd.heroku+json; version=3',
+                   request[:headers]['Accept'])
+      assert_equal(
+        'Token token=c55ef0d8-40b6-4759-b1bf-4a6f94190a66',
+        request[:headers]['Authorization'])
+      Excon.stubs.pop
+      {status: 200, headers: {'Content-Type' => 'application/json'},
+       body: MultiJson.dump(body)}
+    end
+    token = 'c55ef0d8-40b6-4759-b1bf-4a6f94190a66'
+    options = {
+      default_headers: {'Accept' => 'application/vnd.heroku+json; version=3'}}
+    schema = Heroics::Schema.new(SAMPLE_SCHEMA)
+    client = Heroics.token_client_from_schema(token, schema,
+                                              'https://example.com', options)
+    assert_equal(body, client.resource.list)
+  end
+end