heroics 0.0.2 → 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0effae3c006baa9114cb3878ae9c7fc2fdc8f9b7
+  data.tar.gz: 8f0504e1fb8b25ac738fd90cf7aadc3a8b5d281e
+SHA512:
+  metadata.gz: 3a6e38662083ef292abbee6120036e74ebc865fb02728f47e6eaf1a65fdf9b6b45333db618de163f8c1e7775b4c4dff4b54a713d230ac1946c10ea2f5dbcc0c3
+  data.tar.gz: b56f94aa12117967c28116830637e0650c5ef1b5d1b45b7d67618344400e6ba28f4f19ae77ff0e1bd0a6648edae11665ee9c76de033a3498dca42e117f61a85c

data/README.md

@@ -18,29 +18,12 @@ Or install it yourself as:
 
 ## Usage
 
-### Generate a client from a JSON schema
+### Instantiate a client from a JSON schema
 
-Heroics generates an HTTP client from a JSON schema.  The simplest way
-to get started is to provide the URL to the schema you want to base
-the client on:
-
-```ruby
-require 'cgi'
-require 'heroics'
-
-username = CGI.escape('username')
-token = 'token'
-url = "https://#{username}:#{token}@api.heroku.com/schema"
-options = {default_headers: {'Accept' => 'application/vnd.heroku+json; version=3'}}
-client = Heroics.client_from_schema_url(url, options)
-```
-
-The client will make requests to the API using the credentials from
-the URL.  The default headers will also be included in all requests
-(including the one to download the schema and all subsequent
-requests).
-
-You can also create a client from an in-memory schema object:
+Heroics instantiates an HTTP client from a JSON schema.  The client
+will make requests to the API using the credentials from the URL.  The
+default headers will also be included in all requests (including the
+one to download the schema and all subsequent requests).
 
 ```ruby
 require 'cgi'
@@ -62,12 +45,14 @@ Heroics handles ETags and will cache data on the client if you provide
 a [Moneta](https://github.com/minad/moneta) cache instance.
 
 ```ruby
-username = 'username'
+username = CGI.escape('username')
 token = 'token'
 url = "https://#{username}:#{token}@api.heroku.com/schema"
 options = {default_headers: {'Accept' => 'application/vnd.heroku+json; version=3'},
            cache: Moneta.new(:File, dir: "#{Dir.home}/.heroics/heroku-api")}
-client = Heroics.client_from_schema_url(url, options)
+data = JSON.parse(File.read('schema.json'))
+schema = Heroics::Schema.new(data)
+client = Heroics.client_from_schema(schema, url, options)
 ```
 
 ### Making requests
@@ -104,7 +89,9 @@ url = "https://#{username}:#{token}@api.heroku.com/schema"
 options = {
   default_headers: {'Accept' => 'application/vnd.heroku+json; version=3'},
   cache: Moneta.new(:File, dir: "#{Dir.home}/.heroics/heroku-api")}
-cli = Heroics.cli_from_schema_url('heroku-api', STDOUT, url, options)
+data = JSON.parse(File.read('schema.json'))
+schema = Heroics::Schema.new(data)
+cli = Heroics.cli_from_schema('heroku-api', STDOUT, schema, url, options)
 cli.run(*ARGV)
 ```
 

data/bin/heroku-api

@@ -7,11 +7,15 @@ netrc = Netrc.read
 username, token = netrc['api.heroku.com']
 if username && token
   username = username.split('@').first
-  url = "https://#{username}:#{token}@api.heroku.com/schema"
   options = {
     default_headers: {'Accept' => 'application/vnd.heroku+json; version=3'},
     cache: Moneta.new(:File, dir: "#{Dir.home}/.heroics/heroku-api")}
-  cli = Heroics.cli_from_schema_url('heroku-api', STDOUT, url, options)
+
+  schema_url = "https://#{username}:#{token}@api.heroku.com/schema"
+  schema = Heroics.download_schema(schema_url, options)
+
+  url = "https://#{username}:#{token}@heroku-api.heroku.com/prefix"
+  cli = Heroics.cli_from_schema('heroku-api', STDOUT, schema, url, options)
   cli.run(*ARGV)
 else
   puts "ERROR Couldn't find credentials for api.heroku.com in ~/.netrc."

data/heroics.gemspec

@@ -21,7 +21,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_development_dependency 'bundler', '~> 1.3'
-  spec.add_development_dependency 'minitest', '4.7.4'
+  spec.add_development_dependency 'minitest', '4.7.5'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'turn'
 

data/lib/heroics/cli.rb

@@ -75,7 +75,7 @@ USAGE
   #     is no caching.
   # @return [CLI] A CLI with commands generated from the JSON schema.
   def self.cli_from_schema(name, output, schema, url, options={})
-    client = client_from_schema(schema, URI::join(url, '/').to_s, options)
+    client = client_from_schema(schema, url, options)
     commands = {}
     schema.resources.each do |resource_schema|
       resource_schema.links.each do |link_schema|
@@ -85,21 +85,4 @@ USAGE
     end
     CLI.new(name, commands, output)
   end
-
-  # Download a JSON schema and create a CLI with it.
-  #
-  # @param name [String] The name of the CLI.
-  # @param output [IO] The stream to write to.
-  # @param url [String] The URL for the schema.  The URL will be used by the
-  #   generated CLI when it makes requests.
-  # @param options [Hash] Configuration for links.  Possible keys include:
-  #   - default_headers: Optionally, a set of headers to include in every
-  #     request made by the CLI.  Default is no custom headers.
-  #   - cache: Optionally, a Moneta-compatible cache to store ETags.  Default
-  #     is no caching.
-  # @return [CLI] A CLI with commands generated from the JSON schema.
-  def self.cli_from_schema_url(name, output, url, options={})
-    schema = download_schema(url, options)
-    cli_from_schema(name, output, schema, url, options)
-  end
 end

data/lib/heroics/client.rb

@@ -16,7 +16,7 @@ module Heroics
     # @return [Resource] The resource matching the name.
     def method_missing(name)
       name = name.to_s.gsub('_', '-')
-      resource = @resources[name.to_s]
+      resource = @resources[name]
       if resource.nil?
         # TODO(jkakar) Do we care about resource names in the schema specified
         # with underscores?  If so, we should check to make sure the name
@@ -51,19 +51,4 @@ module Heroics
     end
     Client.new(resources)
   end
-
-  # Download a JSON schema and create an HTTP client with it.
-  #
-  # @param url [String] The URL for the schema.  The URL will be used by the
-  #   generated client when it makes requests.
-  # @param options [Hash] Configuration for links.  Possible keys include:
-  #   - default_headers: Optionally, a set of headers to include in every
-  #     request made by the client.  Default is no custom headers.
-  #   - cache: Optionally, a Moneta-compatible cache to store ETags.  Default
-  #     is no caching.
-  # @return [Client] A client with resources and links from the JSON schema.
-  def self.client_from_schema_url(url, options={})
-    schema = download_schema(url, options)
-    client_from_schema(schema, URI::join(url, '/').to_s, options)
-  end
 end

data/lib/heroics/version.rb

@@ -1,3 +1,3 @@
 module Heroics
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
 end

data/test/cli_test.rb

@@ -234,72 +234,3 @@ class CLIFromSchemaTest < MiniTest::Unit::TestCase
     assert_equal(MultiJson.dump(result, pretty: true) + "\n", output.string)
   end
 end
-
-class CLIFromSchemaURLTest < MiniTest::Unit::TestCase
-  include ExconHelper
-
-  # client_from_schema_url downloads a schema and returns a Client generated
-  # from it.
-  def test_cli_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
-
-    output = StringIO.new
-    cli = Heroics.cli_from_schema_url('cli', output,
-                                      'https://example.com/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
-
-    cli.run('resource:update', uuid, body)
-    assert_equal(MultiJson.dump(result, pretty: true) + "\n", output.string)
-  end
-
-  # cli_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 CLI.
-  def test_cli_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
-
-    output = StringIO.new
-    cli = Heroics.cli_from_schema_url(
-      'cli', output, 'https://example.com/schema',
-      default_headers: {'Accept' => 'application/vnd.heroku+json; version=3'})
-
-    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
-
-    cli.run('resource:update', uuid, body)
-    assert_equal(MultiJson.dump(result, pretty: true) + "\n", output.string)
-  end
-end

data/test/client_test.rb

@@ -127,71 +127,3 @@ class ClientFromSchemaTest < MiniTest::Unit::TestCase
     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

metadata

@@ -1,8 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: heroics
 version: !ruby/object:Gem::Version
-  version: 0.0.2
-  prerelease: 
+  version: 0.0.3
 platform: ruby
 authors:
 - geemus
@@ -10,12 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-31 00:00:00.000000000 Z
+date: 2014-03-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -23,7 +21,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -31,113 +28,99 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.7.4
+        version: 4.7.5
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.7.4
+        version: 4.7.5
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: turn
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: excon
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: netrc
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: moneta
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: multi_json
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: A Ruby client for HTTP APIs described using a JSON schema
@@ -181,32 +164,25 @@ files:
 homepage: ''
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 1762076871697657264
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 1762076871697657264
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.0.14
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: A Ruby client for HTTP APIs described using a JSON schema
 test_files: []