platform-api 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d92f219cfa928a250924c521ec4ab95fbc14c81f
-  data.tar.gz: f59e2fe52912929d67292bbc1d981a6156b8387f
+  metadata.gz: 55cb2a8539f3f2c2125ca1d37f11c004b5c6acd7
+  data.tar.gz: c24292d90bb59ed473f42349e0bea60ab10cb0d0
 SHA512:
-  metadata.gz: 4097c473d0bdd1863e6b9d9b6058a5d5b351f112444a5252f2d3b2e4cea988372c2c452a3b2b9db1db8f4cda94c9771b7b439dfbe0f69ce53b312127373d0299
-  data.tar.gz: aeb2695535f24e9068f7c67c05f8b5d0036ac93d96377377580a34e40808c4b02f57d197b9ec99fcacd40b39df88c409ad737bdd1a5a9e869b1e7fd944b16e60
+  metadata.gz: c5f4f716094a9e9622e2e5e286633961dc029629852df9b207aa950d3eae73594e61654d7af0192d0516db2f9d74a94ee64e9b8712a4fd67c483d48d57e8378a
+  data.tar.gz: 9db71e470f1c78921d7609f132d448885d2a3cb1d7228a56161207ce376fd41c30f07804f42030fc802326db2709b2da826a6e6ab5b36d80365fc175d7272eb5

data/README.md

@@ -60,15 +60,29 @@ raises `Excon::Error` exceptions when errors occur.  You can catch specific
 ### A real world example
 
 Let's go through an example of creating an app and using the API to work with
-it.  The first thing you need is a client that's setup with your API token.
-You can find your API token by clicking the *Show API Key* on your
-[account page](https://dashboard.heroku.com/account).
+it.  The first thing you need is a client setup with an OAuth token.  You can
+create an OAuth token using the `heroku-oauth` toolbelt plugin:
+
+```bash
+$ heroku plugins:install git@github.com:heroku/heroku-oauth.git
+$ heroku authorizations:create -d "Platform API example token"
+Created OAuth authorization.
+  ID:          2f01aac0-e9d3-4773-af4e-3e510aa006ca
+  Description: Platform API example token
+  Scope:       global
+  Token:       e7dd6ad7-3c6a-411e-a2be-c9fe52ac7ed2
+```
+
+Use the `Token` value when instantiating a client:
 
 ```ruby
 require 'platform-api'
-heroku = PlatformAPI.connect('token')
+heroku = PlatformAPI.connect_oauth('e7dd6ad7-3c6a-411e-a2be-c9fe52ac7ed2')
 ```
 
+The [OAuth article]()https://devcenter.heroku.com/articles/oauth has more information about OAuth tokens, including how to
+create tokens with specific scopes.
+
 Now let's create an app:
 
 ```ruby

data/lib/platform-api/client.rb

@@ -1,6 +1,20 @@
 module PlatformAPI
-  # Get a client configured with the specified token.
-  def self.connect( token)
+  # Get a client configured with the specified OAuth token.
+  def self.connect_oauth(oauth_token)
+    url = "https://api.heroku.com"
+    default_headers = {'Accept' => 'application/vnd.heroku+json; version=3'}
+    cache = Moneta.new(:File, dir: "#{Dir.home}/.heroku/platform-api")
+    options = {default_headers: default_headers, cache: cache}
+    schema_json = File.read("#{File.dirname(__FILE__)}/schema.json")
+    schema = Heroics::Schema.new(MultiJson.decode(schema_json))
+    Heroics.oauth_client_from_schema(oauth_token, schema, url, options)
+  end
+
+  # Get a client configured with the specified API token.
+  #
+  # Always prefer `connect_oauth` unless there's a very good reason you must
+  # use a non-OAuth API token.
+  def self.connect(token)
     url = "https://:#{token}@api.heroku.com"
     default_headers = {'Accept' => 'application/vnd.heroku+json; version=3'}
     cache = Moneta.new(:File, dir: "#{Dir.home}/.heroku/platform-api")

data/lib/platform-api/version.rb

@@ -1,3 +1,3 @@
 module PlatformAPI
-  VERSION = '0.0.5'
+  VERSION = '0.0.6'
 end

data/platform-api.gemspec

@@ -22,5 +22,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler', '~> 1.3'
   spec.add_development_dependency 'rake'
 
-  spec.add_dependency 'heroics', '~> 0.0.4'
+  spec.add_dependency 'heroics', '~> 0.0.5'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: platform-api
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - jkakar
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-18 00:00:00.000000000 Z
+date: 2014-03-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.0.4
+        version: 0.0.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.0.4
+        version: 0.0.5
 description: Ruby HTTP client for the Heroku API.
 email:
 - jkakar@kakar.ca