heroku-api 0.4.2 → 0.4.3

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: ff47960667059be3d094e328dd563baac8ce8405
4
+ data.tar.gz: bc0d4419f419d5ecbf4dfd36edac034e34f5a6f4
5
+ SHA512:
6
+ metadata.gz: c0deb2825a0f59f66da06f967a17483b2158a05e81da505b6927663b9223e3d78ee9d2b72aa926f655d585065019d759f19a97a7606090af69053c0e75e1604b
7
+ data.tar.gz: a64144434d73d3d62effd7e50e5d140b3016f3ebc2b83e70f2c3a4616e7b4c1a6b1850ce071091fe4edd38da86efca507ddd97e960a0c879f077b1a5cd3546ff
data/README.md CHANGED
@@ -1,128 +1,9 @@
1
1
  Heroku Ruby Client
2
2
  ==================
3
3
 
4
- The Heroku Ruby Client is used to interact with the [Heroku Legacy API](http://legacy-api-docs.herokuapp.com) from Ruby.
4
+ :bangbang: **THIS GEM WILL NOT WORK. [The Legacy Platform API has been Sunset.](https://devcenter.heroku.com/changelog-items/1181)** :bangbang:
5
5
 
6
- Where possible we recommend interacting instead with the [Heroku Platform API](https://devcenter.heroku.com/articles/platform-api-reference). You can use the [Ruby client](https://github.com/heroku/platform-api) with the Platform API (or just install the [gem](https://rubygems.org/gems/platform-api)).
7
-
8
- [![Build Status](https://travis-ci.org/heroku/heroku.rb.png)](https://travis-ci.org/heroku/heroku.rb)
9
-
10
- Usage
11
- -----
12
-
13
- Start by creating a connection to Heroku with your credentials:
14
-
15
- require 'heroku-api'
16
-
17
- heroku = Heroku::API.new(:api_key => API_KEY) # use API Key
18
- heroku = Heroku::API.new(:username => USERNAME, :password => PASSWORD) # use username and password
19
- heroku = Heroku::API.new(:headers => {'User-Agent' => 'custom'}) # use custom header
20
-
21
- NOTE: You can leave out the `:api_key` if `ENV['HEROKU_API_KEY']` is set instead.
22
-
23
- Now you can make requests to the api.
24
-
25
- Requests
26
- --------
27
-
28
- What follows is an overview of commands you can run for the client.
29
-
30
- For additional details about any of the commands, see the [API docs](http://legacy-api-docs.heroku.com).
31
-
32
- ### Add-ons
33
-
34
- heroku.delete_addon(APP, ADD_ON) # remove the ADD_ON add-on from the app named APP
35
- heroku.post_addon(APP, ADD_ON) # add ADD_ON add-on to an the app named APP
36
- heroku.put_addon(APP, ADD_ON) # update the ADD_ON add-on on the app named APP
37
- heroku.get_addons # see a listing of all available add-ons
38
- heroku.get_addons(APP) # see listing of installed add-ons for the app named APP
39
-
40
- ### Apps
41
-
42
- heroku.delete_app(APP) # delete the app named APP
43
- heroku.get_apps # get a list of your apps
44
- heroku.get_app(APP) # get info about the app named APP
45
- heroku.get_dyno_types(APP) # get dyno types for the app named APP
46
- heroku.post_app # create an app with a generated name and the default stack
47
- heroku.post_app_maintenance(APP, '1') # toggle maintenance mode for the app named APP
48
- heroku.post_app('name' => 'app') # create an app with a specified name, APP
49
- heroku.put_app('name' => 'myapp') # update an app to have a different name
50
-
51
- ### Collaborators
52
-
53
- heroku.delete_collaborator(APP, 'email@example.com') # remove 'email@example.com' collaborator from APP app
54
- heroku.get_collaborators(APP) # list collaborators for APP app
55
- heroku.post_collaborator(APP, 'email@example.com') # add 'email@example.com' collaborator to APP app
56
-
57
- ### Config Variables
58
-
59
- heroku.delete_config_var(APP, KEY) # remove KEY key from APP app
60
- heroku.get_config_vars(APP) # get list of config vars for APP app
61
- heroku.put_config_vars(APP, KEY => 'value') # set KEY key to 'value' for APP app
62
-
63
- ### Domains
64
-
65
- heroku.delete_domain(APP, 'example.com') # remove the 'example.com' domain from the APP app
66
- heroku.get_domains(APP) # list configured domains for the APP app
67
- heroku.post_domain(APP, 'example.com') # add 'example.com' domain to the APP app
68
-
69
- ### Keys
70
-
71
- heroku.delete_key('user@hostname.local') # remove the 'user@hostname.local' key
72
- heroku.delete_keys # remove all keys
73
- heroku.get_keys # list configured keys
74
- heroku.post_key('key data') # add key defined by 'key data'
75
-
76
- ### Logs
77
-
78
- heroku.get_logs(APP) # return logs information for APP app
79
-
80
- ### Processes
81
-
82
- heroku.get_ps(APP) # list current dynos for APP app
83
- heroku.post_ps(APP, 'command') # run 'command' command in context of APP app
84
- heroku.post_ps_restart(APP) # restart all dynos for APP app
85
- heroku.post_ps_scale(APP, TYPE, QTY) # scale TYPE type dynos to QTY for APP app
86
- heroku.post_ps_stop(APP, 'ps' => 'web.1') # stop 'web.1' dyno for APP app
87
- heroku.post_ps_stop(APP, 'type' => 'web') # stop all 'web' dynos for APP app
88
- heroku.post_ps_restart(APP, 'ps' => 'web.1') # restart 'web.1' dyno for APP app
89
- heroku.put_dynos(APP, DYNOS) # set number of dynos for bamboo app APP to DYNOS
90
- heroku.put_workers(APP, WORKERS) # set number of workers for bamboo app APP to WORKERS
91
- heroku.post_ps_scale(APP, 'worker', WORKERS) # set number of workers for cedar app APP to WORKERS
92
- heroku.put_formation(APP, 'web' => '2X') # set dyno size to '2X' for all 'web' dynos for APP app
93
-
94
- ### Releases
95
-
96
- heroku.get_releases(APP) # list of releases for the APP app
97
- heroku.get_release(APP, 'v#') # get details of 'v#' release for APP app
98
- heroku.post_release(APP, 'v#') # rollback APP app to 'v#' release
99
-
100
- ### Stacks
101
-
102
- heroku.get_stack(APP) # list available stacks
103
- heroku.put_stack(APP, STACK) # migrate APP app to STACK stack
104
-
105
- ### User
106
-
107
- heroku.get_user # list user info
108
-
109
- Mock
110
- ----
111
-
112
- For testing (or practice) you can also use a simulated Heroku account:
113
-
114
- require 'heroku-api'
115
-
116
- heroku = Heroku::API.new(:api_key => API_KEY, :mock => true)
117
-
118
- Commands will now behave as normal, however, instead of interacting with your actual Heroku account you'll be interacting with a **blank** test account. Note: test accounts will have NO apps to begin with. You'll need to create one:
119
-
120
- heroku.post_app(:name => 'my-test-app')
121
-
122
- Tests
123
- -----
124
-
125
- To run tests, first set `ENV['HEROKU_API_KEY']` to your api key. Then use `bundle exec rake` to run mock tests or `MOCK=false bundle exec rake` to run integration tests.
6
+ We recommend interacting instead with the [Heroku Platform API](https://devcenter.heroku.com/articles/platform-api-reference). You can use the [Ruby client](https://github.com/heroku/platform-api) with the Platform API (or just install the [gem](https://rubygems.org/gems/platform-api)).
126
7
 
127
8
  Meta
128
9
  ----
@@ -1,7 +1,3 @@
1
- 0.4.2 03/02/2016
2
- ================
3
- Rethrow json parsing errors when application/json
4
-
5
1
  0.4.1 02/05/2016
6
2
  ================
7
3
  Move login parameters from query to post body
@@ -11,6 +11,11 @@ Gem::Specification.new do |s|
11
11
  s.license = 'MIT'
12
12
  s.summary = %q{Ruby Client for the Heroku API}
13
13
  s.description = %q{Ruby Client for the Heroku API}
14
+ s.post_install_message = "
15
+ ‼️ The heroku-api gem will not work.
16
+ ‼️ You must instead use the platform-api gem.
17
+ ‼️ The heroku-api gem communicated with the Legacy API which has been disabled.
18
+ ‼️ https://devcenter.heroku.com/changelog-items/118"
14
19
 
15
20
  s.files = `git ls-files`.split("\n")
16
21
  s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
@@ -1,5 +1,5 @@
1
1
  module Heroku
2
2
  class API
3
- VERSION = "0.4.2"
3
+ VERSION = "0.4.3"
4
4
  end
5
5
  end
metadata CHANGED
@@ -1,8 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: heroku-api
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.4.2
5
- prerelease:
4
+ version: 0.4.3
6
5
  platform: ruby
7
6
  authors:
8
7
  - geemus (Wesley Beary)
@@ -10,70 +9,62 @@ authors:
10
9
  autorequire:
11
10
  bindir: bin
12
11
  cert_chain: []
13
- date: 2016-03-02 00:00:00.000000000 Z
12
+ date: 2017-08-04 00:00:00.000000000 Z
14
13
  dependencies:
15
14
  - !ruby/object:Gem::Dependency
16
15
  name: excon
17
16
  requirement: !ruby/object:Gem::Requirement
18
- none: false
19
17
  requirements:
20
- - - ~>
18
+ - - "~>"
21
19
  - !ruby/object:Gem::Version
22
20
  version: '0.45'
23
21
  type: :runtime
24
22
  prerelease: false
25
23
  version_requirements: !ruby/object:Gem::Requirement
26
- none: false
27
24
  requirements:
28
- - - ~>
25
+ - - "~>"
29
26
  - !ruby/object:Gem::Version
30
27
  version: '0.45'
31
28
  - !ruby/object:Gem::Dependency
32
29
  name: multi_json
33
30
  requirement: !ruby/object:Gem::Requirement
34
- none: false
35
31
  requirements:
36
- - - ~>
32
+ - - "~>"
37
33
  - !ruby/object:Gem::Version
38
34
  version: '1.8'
39
35
  type: :runtime
40
36
  prerelease: false
41
37
  version_requirements: !ruby/object:Gem::Requirement
42
- none: false
43
38
  requirements:
44
- - - ~>
39
+ - - "~>"
45
40
  - !ruby/object:Gem::Version
46
41
  version: '1.8'
47
42
  - !ruby/object:Gem::Dependency
48
43
  name: minitest
49
44
  requirement: !ruby/object:Gem::Requirement
50
- none: false
51
45
  requirements:
52
- - - ! '>='
46
+ - - ">="
53
47
  - !ruby/object:Gem::Version
54
48
  version: '0'
55
49
  type: :development
56
50
  prerelease: false
57
51
  version_requirements: !ruby/object:Gem::Requirement
58
- none: false
59
52
  requirements:
60
- - - ! '>='
53
+ - - ">="
61
54
  - !ruby/object:Gem::Version
62
55
  version: '0'
63
56
  - !ruby/object:Gem::Dependency
64
57
  name: rake
65
58
  requirement: !ruby/object:Gem::Requirement
66
- none: false
67
59
  requirements:
68
- - - ! '>='
60
+ - - ">="
69
61
  - !ruby/object:Gem::Version
70
62
  version: '0'
71
63
  type: :development
72
64
  prerelease: false
73
65
  version_requirements: !ruby/object:Gem::Requirement
74
- none: false
75
66
  requirements:
76
- - - ! '>='
67
+ - - ">="
77
68
  - !ruby/object:Gem::Version
78
69
  version: '0'
79
70
  description: Ruby Client for the Heroku API
@@ -84,8 +75,8 @@ executables: []
84
75
  extensions: []
85
76
  extra_rdoc_files: []
86
77
  files:
87
- - .gitignore
88
- - .travis.yml
78
+ - ".gitignore"
79
+ - ".travis.yml"
89
80
  - Gemfile
90
81
  - README.md
91
82
  - Rakefile
@@ -155,27 +146,28 @@ files:
155
146
  homepage: http://github.com/heroku/heroku.rb
156
147
  licenses:
157
148
  - MIT
158
- post_install_message:
149
+ metadata: {}
150
+ post_install_message: "\n‼️\tThe heroku-api gem will not work.\n‼️\tYou must instead
151
+ use the platform-api gem.\n‼️\tThe heroku-api gem communicated with the Legacy API
152
+ which has been disabled.\n‼️\thttps://devcenter.heroku.com/changelog-items/118"
159
153
  rdoc_options: []
160
154
  require_paths:
161
155
  - lib
162
156
  required_ruby_version: !ruby/object:Gem::Requirement
163
- none: false
164
157
  requirements:
165
- - - ! '>='
158
+ - - ">="
166
159
  - !ruby/object:Gem::Version
167
160
  version: '0'
168
161
  required_rubygems_version: !ruby/object:Gem::Requirement
169
- none: false
170
162
  requirements:
171
- - - ! '>='
163
+ - - ">="
172
164
  - !ruby/object:Gem::Version
173
165
  version: '0'
174
166
  requirements: []
175
167
  rubyforge_project:
176
- rubygems_version: 1.8.23.2
168
+ rubygems_version: 2.6.11
177
169
  signing_key:
178
- specification_version: 3
170
+ specification_version: 4
179
171
  summary: Ruby Client for the Heroku API
180
172
  test_files:
181
173
  - test/data/site.crt