platform-api 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 30650e1cb768ab40187de984a7758f1d4a7baf8e
-  data.tar.gz: 9986413c179ffb63979212fb2782cc76c6cc9d1f
+  metadata.gz: dc573a7f60a0a23121a4884dc04541d9fc11e47a
+  data.tar.gz: 1ebd353900700ec76f53f2df7d97795c0bbdc9b1
 SHA512:
-  metadata.gz: 343e26b799e139a176862bf955ee1bf1210dd87d474b41b686b229f6597c13b99cd070045b992ecc7d2623dda0e9625b33dde70463c9286170f84e6ac0899efa
-  data.tar.gz: 3ab6ce2a3c17a5e23dd3a2a3ccc371e16d635fb34d3438daa3d10ad9a2550496aa7010fd98e0aa31c01b0ded08bff896621f2cbf80fc9fc144075b5214fea569
+  metadata.gz: f671726d70cc5228706cb0f997021c584ce1400491e752ce7063c4be1fcd19cee2bfc82510385f732b86d2f81f41fdf90b91158b07ee03a81c52beb703e14e0d
+  data.tar.gz: 3374fc2827b622e901a7c9ab1ce1035b0e0db5a7cededf4e4e570d47e28759d8ea370090058c511118614aaaca2ab65db9fd1641101bf4da21b8f29f6d243e8d

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    platform-api (0.0.2)
+    platform-api (0.0.3)
       heroics
 
 GEM

data/README.md

@@ -36,15 +36,15 @@ information about the support actions.  For example, the [Formation](https://dev
 resource has [Info](https://devcenter.heroku.com/articles/platform-api-reference#formation-info), [List](https://devcenter.heroku.com/articles/platform-api-reference#formation-list), [Batch update](https://devcenter.heroku.com/articles/platform-api-reference#formation-batch-update), and [Update](https://devcenter.heroku.com/articles/platform-api-reference#formation-update) actions.
 
 You can easily map any resource and its related action client methods.  The
-formation actions above are accessed as `client.formation.info`,
-`client.formation.list`, `client.formation.batch_update` and
-`client.formation.update`.  When the URL for one of these actions includes
+formation actions above are accessed as `heroku.formation.info`,
+`heroku.formation.list`, `heroku.formation.batch_update` and
+`heroku.formation.update`.  When the URL for one of these actions includes
 parameters they should be passed as arguments to the method.  When the request
 expects a request payload it should be passed as a Ruby Hash in the final
 argument to the method.
 
 For example, to get information about the `web` formation on the `sushi` app
-you'd invoke `client.formation.info('sushi', 'web')` and it would return a
+you'd invoke `heroku.formation.info('sushi', 'web')` and it would return a
 Ruby object that matches the one given in the [response example](https://devcenter.heroku.com/articles/platform-api-reference#formation-info).
 
 Once you get used to these basic patterns using the client is quite easy
@@ -60,19 +60,19 @@ 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 username and
-API token.  You can find your API token by clicking the *Show API Key* on your
+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).
 
 ```ruby
 require 'platform-api'
-client = PlatformAPI.connect('username', 'token')
+heroku = PlatformAPI.connect('token')
 ```
 
 Now let's create an app:
 
 ```ruby
-client.app.create
+heroku.app.create
 => {"id"=>22979756,
     "name"=>"floating-retreat-4255",
     "dynos"=>0,
@@ -107,7 +107,7 @@ client.app.create
 We can read the same information back with the `info` method.
 
 ```ruby
-client.app.info('floating-retreat-4255')
+heroku.app.info('floating-retreat-4255')
 => {"id"=>22979756,
     "name"=>"floating-retreat-4255",
     "dynos"=>0,
@@ -142,7 +142,7 @@ client.app.info('floating-retreat-4255')
 Let's add a Heroku PostgreSQL database to our app now:
 
 ```ruby
-client.addon.create('floating-retreat-4255', {'plan' => 'heroku-postgresql:dev'})
+heroku.addon.create('floating-retreat-4255', {'plan' => 'heroku-postgresql:dev'})
 => {"config_vars"=>["HEROKU_POSTGRESQL_COBALT_URL"],
     "created_at"=>"2014-03-13T00:28:55Z",
     "id"=>"79a0c826-06be-4dcd-8bb5-f2c1b1bc2beb",
@@ -157,16 +157,15 @@ client.addon.create('floating-retreat-4255', {'plan' => 'heroku-postgresql:dev'}
 Excellent!  That will have added a config var which we can now see:
 
 ```ruby
-client.config_var.info('floating-retreat-4255')
-=> client.config_var.info('floating-retreat-4255')
-   {"HEROKU_POSTGRESQL_COBALT_URL"=>"postgres://<redacted>"}
+heroku.config_var.info('floating-retreat-4255')
+=> {"HEROKU_POSTGRESQL_COBALT_URL"=>"postgres://<redacted>"}
 ```
 
 And there we go, we have the config var.  Let's set an additional config var,
-which will also demonstrate an request that needs a payload:
+which will also demonstrate how to make a request that needs a payload:
 
 ```ruby
-client.config_var.update('floating-retreat-4255', {'MYAPP' => 'ROCKS'})
+heroku.config_var.update('floating-retreat-4255', {'MYAPP' => 'ROCKS'})
 => {"HEROKU_POSTGRESQL_COBALT_URL"=>"postgres://<redacted>",
     "MYAPP"=>"ROCKS"}
 ```
@@ -204,7 +203,7 @@ Total 489 (delta 244), reused 489 (delta 244)
 We can now use the API to see our `web` process running:
 
 ```ruby
-client.formation.list('floating-retreat-4255')
+heroku.formation.list('floating-retreat-4255')
 => [{"command"=>"coffee index.coffee",
      "created_at"=>"2014-03-13T04:13:37Z",
      "id"=>"f682b260-8089-4e18-b792-688cc02bf923",
@@ -217,7 +216,10 @@ client.formation.list('floating-retreat-4255')
 Let's change `web` process to run on a 2X dyno:
 
 ```ruby
-client.formation.batch_update('floating-retreat-4255', {"updates" => [{"process" => "web", "quantity" => 1, "size" => "2X"}]})
+heroku.formation.batch_update('floating-retreat-4255',
+                              {"updates" => [{"process" => "web",
+                                              "quantity" => 1,
+                                              "size" => "2X"}]})
 => [{"command"=>"coffee index.coffee",
      "created_at"=>"2014-03-13T04:13:37Z",
      "id"=>"f682b260-8089-4e18-b792-688cc02bf923",
@@ -232,7 +234,7 @@ command.  We can use the singular update action to modify a single formation
 type:
 
 ```ruby
-client.formation.update('floating-retreat-4255', 'web', {"size" => "1X"})
+heroku.formation.update('floating-retreat-4255', 'web', {"size" => "1X"})
 => {"command"=>"coffee index.coffee",
     "created_at"=>"2014-03-13T04:13:37Z",
     "id"=>"f682b260-8089-4e18-b792-688cc02bf923",
@@ -242,8 +244,9 @@ client.formation.update('floating-retreat-4255', 'web', {"size" => "1X"})
     "updated_at"=>"2014-03-13T04:24:46Z"}
 ```
 
-Hopefully this has given you a taste of how the client works.  If you have
-questions please feel free to file issues.
+Hopefully this has given you a taste of how the client works and an
+understanding of how resources and actions are mapped from the documentation.
+If you have questions please feel free to file issues.
 
 ### Debugging
 

data/lib/platform-api/client.rb

@@ -1,7 +1,7 @@
 module PlatformAPI
-  # Get a client configured with the specified username and token.
-  def self.connect(username, token)
-    url = "https://#{username}:#{token}@api.heroku.com"
+  # Get a client configured with the specified 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")
     options = {default_headers: default_headers, cache: cache}

data/lib/platform-api/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: platform-api
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - jkakar