komoju 0.0.0 → 0.0.3

data/vendor/heroics/test/schema_test.rb

@@ -0,0 +1,287 @@
+require 'helper'
+
+class SchemaTest < MiniTest::Unit::TestCase
+  # Schema.to_s returns a simple human-readable description of the schema
+  # instance with the description embedded in it.
+  def test_to_s
+    schema = Heroics::Schema.new(SAMPLE_SCHEMA)
+    assert_equal(
+      '#<Heroics::Schema description="Sample schema for use in tests.">',
+      schema.to_s)
+  end
+
+  # Schema.resource returns a ResourceSchema for the named resource.
+  def test_resource
+    schema = Heroics::Schema.new(SAMPLE_SCHEMA)
+    assert_equal('resource', schema.resource('resource').name)
+  end
+
+  # Schema.resource raises a SchemaError is an unknown resource is requested.
+  def test_resource_with_unknown_name
+    schema = Heroics::Schema.new(SAMPLE_SCHEMA)
+    error = assert_raises Heroics::SchemaError do
+      schema.resource('unknown-resource')
+    end
+    assert_equal("Unknown resource 'unknown-resource'.", error.message)
+  end
+
+  # Schema.resources returns a sequence of ResourceSchema children.
+  def test_resources
+    schema = Heroics::Schema.new(SAMPLE_SCHEMA)
+    assert_equal(['resource', 'another-resource'],
+                 schema.resources.map(&:name))
+  end
+end
+
+class ResourceSchemaTest < MiniTest::Unit::TestCase
+  # ResourceSchema.link returns a LinkSchema for the named link.
+  def test_link
+    schema = Heroics::Schema.new(SAMPLE_SCHEMA)
+    link = schema.resource('resource').link('list')
+    assert_equal('list', link.name)
+  end
+
+  # ResourceSchema.link raises a SchemaError is an unknown link is requested.
+  def test_link_with_unknown_name
+    schema = Heroics::Schema.new(SAMPLE_SCHEMA)
+    error = assert_raises Heroics::SchemaError do
+      schema.resource('resource').link('unknown-link')
+    end
+    assert_equal("Unknown link 'unknown-link'.", error.message)
+  end
+
+  # ResourceSchema.links returns an array of LinkSchema children.
+  def test_links
+    schema = Heroics::Schema.new(SAMPLE_SCHEMA)
+    assert_equal(
+      ['list', 'info', 'identify_resource', 'create', 'submit', 'update', 'delete'],
+      schema.resource('resource').links.map { |link| link.name })
+  end
+end
+
+class LinkSchemaTest < MiniTest::Unit::TestCase
+  # LinkSchema.name returns the sanitized link name.
+  def test_name
+    schema = Heroics::Schema.new(SAMPLE_SCHEMA)
+    assert_equal('list', schema.resource('resource').link('list').name)
+  end
+
+  # LinkSchema.resource_name returns the parent resource name.
+  def test_resource_name
+    schema = Heroics::Schema.new(SAMPLE_SCHEMA)
+    assert_equal('resource',
+                 schema.resource('resource').link('list').resource_name)
+  end
+
+  # LinkSchema.description returns the link description.
+  def test_description
+    schema = Heroics::Schema.new(SAMPLE_SCHEMA)
+    assert_equal('Show all sample resources',
+                 schema.resource('resource').link('list').description)
+  end
+
+  # LinkSchema.parameters returns an empty array if the link doesn't require
+  # parameters.
+  def test_parameters_without_parameters
+    schema = Heroics::Schema.new(SAMPLE_SCHEMA)
+    link = schema.resource('resource').link('list')
+    assert_equal([], link.parameters)
+  end
+
+  # LinkSchema.parameters returns an array of named parameter required to
+  # invoke the link correctly.
+  def test_parameters
+    schema = Heroics::Schema.new(SAMPLE_SCHEMA)
+    link = schema.resource('resource').link('info')
+    assert_equal(['uuid_field'], link.parameters)
+  end
+
+  # LinkSchema.parameters returns a parameter name for multiple parameters
+  # when the parameter contains a 'oneOf' element that references more than
+  # one parameter.
+  def test_parameters_with_one_of_field
+    schema = Heroics::Schema.new(SAMPLE_SCHEMA)
+    link = schema.resource('resource').link('identify_resource')
+    assert_equal(['uuid_field|email_field'], link.parameters)
+  end
+
+  # LinkSchema.parameter_details returns an empty array if the link doesn't
+  # require parameters.
+  def test_parameter_details_without_parameters
+    schema = Heroics::Schema.new(SAMPLE_SCHEMA)
+    link = schema.resource('another-resource').link('create')
+    assert_equal([], link.parameter_details)
+  end 
+
+  # LinkSchema.parameter_details returns an options parameter if the
+  # link is for a collection of instances.
+  def test_parameter_details_with_collection_options_parameter
+    schema = Heroics::Schema.new(SAMPLE_SCHEMA)
+    link = schema.resource('resource').link('list')
+    parameters = link.parameter_details
+    parameter = parameters[0]
+    assert_equal('collection_options', parameter.name)
+    assert_equal('collection_options = {}', parameter.signature)
+    assert_equal('additional collection options to pass with the request', parameter.description)
+  end
+
+  # LinkSchema.parameter_details returns an array of Parameter with information
+  # about the parameters accepted by the link.
+  def test_parameter_details
+    schema = Heroics::Schema.new(SAMPLE_SCHEMA)
+    link = schema.resource('resource').link('info')
+    parameters = link.parameter_details
+    assert_equal(1, parameters.length)
+    parameter = parameters[0]
+    assert_equal('resource_uuid_field', parameter.name)
+    assert_equal('resource_uuid_field', parameter.signature)
+    assert_equal('A sample UUID field', parameter.description)
+  end
+
+  # LinkSchema.parameter_details returns an array of ParameterChoices, when
+  # more than one value may be used with a property, with information about
+  # the parameters accepted by the link.
+  def test_parameter_details_with_one_of_field
+    schema = Heroics::Schema.new(SAMPLE_SCHEMA)
+    link = schema.resource('resource').link('identify_resource')
+    parameters = link.parameter_details
+    assert_equal(1, parameters.length)
+    parameter = parameters[0]
+    assert_equal('resource_uuid_field_or_resource_email_field', parameter.name)
+    assert_equal('resource_uuid_field_or_resource_email_field', parameter.signature)
+    assert_equal('A sample UUID field or A sample email address field',
+                 parameter.description)
+  end
+
+  # LinkSchema.body returns nil if the link doesn't accept a request body.
+  def test_example_body_without_body
+    schema = Heroics::Schema.new(SAMPLE_SCHEMA)
+    link = schema.resource('resource').link('info')
+    assert_equal(nil, link.example_body)
+  end
+
+  # LinkSchema.body returns a sample body generated from the properties and
+  # embedded examples.
+  def test_example_body
+    schema = Heroics::Schema.new(SAMPLE_SCHEMA)
+    link = schema.resource('resource').link('create')
+    assert_equal({'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'},
+                 link.example_body)
+  end
+
+  # LinkSchema.format_path converts an array of parameters into a path.
+  def test_format_path
+    schema = Heroics::Schema.new(SAMPLE_SCHEMA)
+    link = schema.resource('resource').link('info')
+    assert_equal(['/resource/44724831-bf66-4bc2-865f-e2c4c2b14c78', nil],
+                 link.format_path(['44724831-bf66-4bc2-865f-e2c4c2b14c78']))
+  end
+
+  # LinkSchema.format_path escapes special URL characters in parameters.
+  def test_format_path_with_illegal_literals
+    schema = Heroics::Schema.new(SAMPLE_SCHEMA)
+    link = schema.resource('resource').link('info')
+    assert_equal(['/resource/foobar%25', nil],
+                 link.format_path(['foobar%']))
+  end
+
+  # LinkSchema.format_path correctly returns a parameter as a body if a path
+  # doesn't have any parameters.
+  def test_format_path_with_body
+    schema = Heroics::Schema.new(SAMPLE_SCHEMA)
+    link = schema.resource('resource').link('create')
+    assert_equal(['/resource', {'new' => 'resource'}],
+                 link.format_path([{'new' => 'resource'}]))
+  end
+
+  # LinkSchema.format_path correctly returns a parameter as a body if a path
+  # doesn't have any parameters.
+  def test_format_path_with_path_and_body
+    schema = Heroics::Schema.new(SAMPLE_SCHEMA)
+    link = schema.resource('resource').link('update')
+    assert_equal(['/resource/44724831-bf66-4bc2-865f-e2c4c2b14c78',
+                  {'new' => 'resource'}],
+                 link.format_path(['44724831-bf66-4bc2-865f-e2c4c2b14c78',
+                                   {'new' => 'resource'}]))
+  end
+
+  # LinkSchema.format_path raises an ArgumentError if too few parameters are
+  # provided
+  def test_format_path_with_too_few_parameters
+    schema = Heroics::Schema.new(SAMPLE_SCHEMA)
+    link = schema.resource('resource').link('info')
+    error = assert_raises ArgumentError do
+      link.format_path([])
+    end
+    assert_equal('wrong number of arguments (0 for 1)', error.message)
+  end
+
+  # LinkSchema.format_path raises an ArgumentError if too many parameters are
+  # provided
+  def test_format_path_with_too_many_parameters
+    schema = Heroics::Schema.new(SAMPLE_SCHEMA)
+    link = schema.resource('resource').link('info')
+    error = assert_raises ArgumentError do
+      link.format_path(['too', 'many', 'parameters'])
+    end
+    assert_equal('wrong number of arguments (3 for 1)', error.message)
+  end
+
+  # LinkSchema.pretty_resource_name returns the resource name in a pretty
+  # form, with underscores converted to dashes.
+  def test_pretty_resource_name
+    schema = Heroics::Schema.new(SAMPLE_SCHEMA)
+    link = schema.resource('another-resource').link('list')
+    assert_equal('another-resource', link.pretty_resource_name)
+  end
+
+  # LinkSchema.pretty_name returns the link name in a pretty form, with
+  # underscores converted to dashes.
+  def test_pretty_resource_name
+    schema = Heroics::Schema.new(SAMPLE_SCHEMA)
+    link = schema.resource('resource').link('identify_resource')
+    assert_equal('identify-resource', link.pretty_name)
+  end
+
+  # LinkSchema.content_type returns the media type associated with this
+  # resource.
+  def test_content_type
+    schema = Heroics::Schema.new(SAMPLE_SCHEMA)
+    link = schema.resource('resource').link('submit')
+    assert_equal('application/x-www-form-urlencoded', link.content_type)
+  end
+
+  # The content type should default to application/json
+  def test_default_content_type
+    schema = Heroics::Schema.new(SAMPLE_SCHEMA)
+    link = schema.resource('resource').link('identify_resource')
+    assert_equal('application/json', link.content_type)
+  end
+end
+
+class DownloadSchemaTest < MiniTest::Unit::TestCase
+  include ExconHelper
+
+  # download_schema makes a request to fetch the schema, decodes the
+  # downloaded JSON and returns a Ruby hash.
+  def test_download_schema
+    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
+
+    schema = Heroics::download_schema(
+      'https://username:token@example.com/schema',
+      default_headers: {'Accept' => 'application/vnd.heroku+json; version=3'})
+    assert_equal(SAMPLE_SCHEMA, schema.schema)
+  end
+end

data/vendor/heroics/test/version_test.rb

@@ -0,0 +1,9 @@
+require 'helper'
+
+class VersionTest < MiniTest::Unit::TestCase
+  # Heroics::VERSION defines the version for the project in MAJOR.MINOR.PATCH
+  # format.
+  def test_version
+    assert_match(/\d+.\d+.\d+/, Heroics::VERSION)
+  end
+end

data/vendor/heroics/test.rb

@@ -0,0 +1,42 @@
+require 'netrc'
+
+_, token = Netrc.read['api.heroku.com']
+
+require './lib/heroics'
+
+heroics = Heroics.new(
+  :cache => Heroics::FileCache.new(token),
+  :token => token
+)
+
+heroics.apps.list
+apps = heroics.apps.list # should use cache
+puts(apps)
+puts
+
+app = heroics.apps.info('stringer-geemus')
+puts(app)
+puts
+
+puts(heroics.apps('stringer-geemus'))
+puts
+
+collaborators = app.collaborators.list
+puts(collaborators)
+puts
+
+collaborator_id = collaborators.first.id
+collaborator = app.collaborators.info(collaborator_id)
+puts(collaborator)
+puts
+
+regions = heroics.regions.list
+puts(regions)
+puts
+
+region_id = regions.first.id
+puts(heroics.regions.info(region_id))
+puts
+
+puts(heroics.regions(region_id))
+puts

metadata

@@ -1,15 +1,85 @@
 --- !ruby/object:Gem::Specification
 name: komoju
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.0.3
 platform: ruby
 authors:
 - Richard Ramsden
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-26 00:00:00.000000000 Z
+date: 2015-11-18 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: erubis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: excon
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: moneta
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.9.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.9.2
+- !ruby/object:Gem::Dependency
+  name: netrc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -38,22 +108,79 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
-description: The easiest way to integrate all of Japan's esoteric payment options
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 4.7.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 4.7.5
+- !ruby/object:Gem::Dependency
+  name: turn
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: These are the ruby bindings for the Komoju API
 email:
-- rramsden@degica.com
-executables: []
+- richard@rramsden.ca
+executables:
+- generate-client
 extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".gitmodules"
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
+- bin/generate-client
 - komoju.gemspec
 - lib/komoju.rb
+- lib/komoju/client.rb
 - lib/komoju/version.rb
-homepage: https://github.com/komoju/komoju-ruby
+- test/client_test.rb
+- test/helper.rb
+- vendor/heroics/lib/heroics.rb
+- vendor/heroics/lib/heroics/cli.rb
+- vendor/heroics/lib/heroics/client.rb
+- vendor/heroics/lib/heroics/client_generator.rb
+- vendor/heroics/lib/heroics/command.rb
+- vendor/heroics/lib/heroics/errors.rb
+- vendor/heroics/lib/heroics/link.rb
+- vendor/heroics/lib/heroics/naming.rb
+- vendor/heroics/lib/heroics/resource.rb
+- vendor/heroics/lib/heroics/schema.rb
+- vendor/heroics/lib/heroics/version.rb
+- vendor/heroics/test.rb
+- vendor/heroics/test/cli_test.rb
+- vendor/heroics/test/client_generator_test.rb
+- vendor/heroics/test/client_test.rb
+- vendor/heroics/test/command_test.rb
+- vendor/heroics/test/helper.rb
+- vendor/heroics/test/link_test.rb
+- vendor/heroics/test/naming_test.rb
+- vendor/heroics/test/resource_test.rb
+- vendor/heroics/test/schema_test.rb
+- vendor/heroics/test/version_test.rb
+homepage: https://komoju.com
 licenses:
 - MIT
 metadata: {}
@@ -61,6 +188,7 @@ post_install_message:
 rdoc_options: []
 require_paths:
 - lib
+- vendor/heroics/lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -76,5 +204,8 @@ rubyforge_project:
 rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: Ruby bindings for the Komoju API
-test_files: []
+summary: Komoju Ruby Bindings
+test_files:
+- test/client_test.rb
+- test/helper.rb
+has_rdoc: