heroics 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 259b6035c675a64b2a0c1243765f22f1c3358844
-  data.tar.gz: e698d60d9f9f1afb43530587b5f54e3ad5da1765
+  metadata.gz: c560efe3fc3a956cf69a67b4a9c18e635148e4de
+  data.tar.gz: daf31b6ace54f1f25a3a813976cae85c1b34526a
 SHA512:
-  metadata.gz: 93fa2f9040ad82ee8572ac916e156fe3948dc3db45248e1c875d3e808d5b4589b6d21468993a7eb4acab46c80fd6653e633e3342bc908d185ecac84c87e5ad03
-  data.tar.gz: c9baf8841b6386ec09f1cbacf12b4a6cbad2839bb09f2b176f75440e8d62cbb64aee40512f1d79d01bf34f61cfa8eeacddf3d437598d7399673ae425952e93ac
+  metadata.gz: 0db8243ab8d5176c0d50b48e0271b9cf66cebda01a1f12732f7e8ec33da3975be6d665bc61d88f20654a3b83a2e2652182e8dbb45109e27be30f93f522dbfbcc
+  data.tar.gz: 0d8c324bd42763d58e492f1cb50d54c384667192e3bb05c59e626a759cded66cf04aa40c1f5ce615e8a45b90b9f23704e384d099bcc357183ebdeff3ab4ffb93

data/README.md

@@ -19,12 +19,11 @@ Or install it yourself as:
 
 ## Usage
 
-### Instantiate a client from a JSON schema
+### Instantiate a client from a JSON schema with basic credentials
 
 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).
+default headers will also be included in all requests.
 
 ```ruby
 require 'cgi'
@@ -33,13 +32,27 @@ require 'heroics'
 
 username = CGI.escape('username')
 token = 'token'
-url = "https://#{username}:#{token}@api.heroku.com/schema"
+url = "https://#{username}:#{token}@api.heroku.com"
 options = {default_headers: {'Accept' => 'application/vnd.heroku+json; version=3'}}
 data = JSON.parse(File.read('schema.json'))
 schema = Heroics::Schema.new(data)
 client = Heroics.client_from_schema(schema, url, options)
 ```
 
+### Instantiate a client from a JSON schema with an OAuth token
+
+The client will make requests to the API using an OAuth token when one is
+provided.
+
+```ruby
+oauth_token = 'token'
+url = "https://api.heroku.com"
+options = {default_headers: {'Accept' => 'application/vnd.heroku+json; version=3'}}
+data = JSON.parse(File.read('schema.json'))
+schema = Heroics::Schema.new(data)
+client = Heroics.oauth_client_from_schema(oauth_token, schema, url, options)
+```
+
 ### Client-side caching
 
 Heroics handles ETags and will cache data on the client if you provide

data/lib/heroics.rb

@@ -1,3 +1,4 @@
+require 'base64'
 require 'excon'
 require 'moneta'
 require 'multi_json'

data/lib/heroics/client.rb

@@ -55,4 +55,29 @@ module Heroics
     end
     Client.new(resources, url)
   end
+
+  # Create an HTTP client with OAuth credentials from a JSON schema.
+  #
+  # @param oauth_token [String] The OAuth token to pass using the `Bearer`
+  #   authorization mechanism.
+  # @param schema [Schema] The JSON schema to build an HTTP client for.
+  # @param url [String] The URL the generated client should use when making
+  #   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.oauth_client_from_schema(oauth_token, schema, url, options={})
+    encoded_token = Base64.strict_encode64(":#{oauth_token}")
+    authorization = "Bearer #{encoded_token}"
+    # Don't mutate user-supplied data.
+    options = Marshal.load(Marshal.dump(options))
+    if !options.has_key?(:default_headers)
+      options[:default_headers] = {}
+    end
+    options[:default_headers].merge!({"Authorization" => authorization})
+    client_from_schema(schema, url, options)
+  end
 end

data/lib/heroics/schema.rb

@@ -33,6 +33,12 @@ module Heroics
     def resources
       @resources.values
     end
+
+    # Get a simple human-readable representation of this client instance.
+    def inspect
+      "#<Heroics::Schema description=\"#{@schema['description']}\">"
+    end
+    alias to_s inspect
   end
 
   # A wrapper around a bare resource element in a JSON schema to make it

data/lib/heroics/version.rb

@@ -1,3 +1,3 @@
 module Heroics
-  VERSION = '0.0.4'
+  VERSION = '0.0.5'
 end

data/test/client_test.rb

@@ -137,3 +137,51 @@ class ClientFromSchemaTest < MiniTest::Unit::TestCase
     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 OmM1NWVmMGQ4LTQwYjYtNDc1OS1iMWJmLTRhNmY5NDE5MGE2Ng==',
+        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 OmM1NWVmMGQ4LTQwYjYtNDc1OS1iMWJmLTRhNmY5NDE5MGE2Ng==',
+        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

data/test/helper.rb

@@ -23,6 +23,7 @@ end
 
 # A simple JSON schema for testing purposes.
 SAMPLE_SCHEMA = {
+  'description' => 'Sample schema for use in tests.',
   'definitions' => {
     'resource' => {
       'description' => 'A sample resource to use in tests.',

data/test/schema_test.rb

@@ -1,6 +1,15 @@
 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)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: heroics
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - geemus
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-14 00:00:00.000000000 Z
+date: 2014-03-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler