hetznercloud 1.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (47) hide show
  1. checksums.yaml +7 -0
  2. data/CHANGELOG.md +5 -0
  3. data/Gemfile +6 -0
  4. data/LICENSE.md +21 -0
  5. data/README.md +123 -0
  6. data/config/inflections.rb +19 -0
  7. data/lib/core_ext/send_wrap.rb +15 -0
  8. data/lib/hcloud/action_collection.rb +37 -0
  9. data/lib/hcloud/client.rb +38 -0
  10. data/lib/hcloud/collection.rb +77 -0
  11. data/lib/hcloud/concerns/actionable.rb +29 -0
  12. data/lib/hcloud/concerns/concerns.rb +29 -0
  13. data/lib/hcloud/concerns/creatable.rb +46 -0
  14. data/lib/hcloud/concerns/deletable.rb +20 -0
  15. data/lib/hcloud/concerns/queryable.rb +41 -0
  16. data/lib/hcloud/concerns/updatable.rb +24 -0
  17. data/lib/hcloud/entities/amount.rb +8 -0
  18. data/lib/hcloud/entities/applied_to.rb +7 -0
  19. data/lib/hcloud/entities/applied_to_resource.rb +9 -0
  20. data/lib/hcloud/entities/apply_to.rb +15 -0
  21. data/lib/hcloud/entities/datacenter_server_type.rb +9 -0
  22. data/lib/hcloud/entities/dns_pointer.rb +8 -0
  23. data/lib/hcloud/entities/error.rb +8 -0
  24. data/lib/hcloud/entities/metrics.rb +12 -0
  25. data/lib/hcloud/entities/price.rb +9 -0
  26. data/lib/hcloud/entities/protection.rb +11 -0
  27. data/lib/hcloud/entities/rule.rb +15 -0
  28. data/lib/hcloud/entity.rb +23 -0
  29. data/lib/hcloud/errors.rb +36 -0
  30. data/lib/hcloud/http.rb +100 -0
  31. data/lib/hcloud/resource.rb +42 -0
  32. data/lib/hcloud/resource_type.rb +73 -0
  33. data/lib/hcloud/resources/action.rb +49 -0
  34. data/lib/hcloud/resources/datacenter.rb +43 -0
  35. data/lib/hcloud/resources/firewall.rb +80 -0
  36. data/lib/hcloud/resources/floating_ip.rb +144 -0
  37. data/lib/hcloud/resources/image.rb +140 -0
  38. data/lib/hcloud/resources/iso.rb +36 -0
  39. data/lib/hcloud/resources/location.rb +37 -0
  40. data/lib/hcloud/resources/placement_group.rb +75 -0
  41. data/lib/hcloud/resources/server.rb +179 -0
  42. data/lib/hcloud/resources/server_type.rb +42 -0
  43. data/lib/hcloud/resources/ssh_key.rb +77 -0
  44. data/lib/hcloud/resources/volume.rb +147 -0
  45. data/lib/hcloud/version.rb +17 -0
  46. data/lib/hcloud.rb +42 -0
  47. metadata +286 -0
data/lib/hcloud/resources/volume.rb ADDED
@@ -0,0 +1,147 @@
1
+ # frozen_string_literal: true
2
+
3
+ module HCloud
4
+ ##
5
+ # Represents a volume
6
+ #
7
+ # == List all volumes
8
+ #
9
+ # HCloud::Volume.all
10
+ # # => [#<HCloud::Volume id: 1, ...>, ...]
11
+ #
12
+ # == Sort volumes
13
+ #
14
+ # HCloud::Volume.all.sort(name: :desc)
15
+ # # => [#<HCloud::Volume id: 1, ...>, ...]
16
+ #
17
+ # HCloud::Volume.all.sort(:id, name: :asc)
18
+ # # => [#<HCloud::Volume id: 1, ...>, ...]
19
+ #
20
+ # == Search volumes
21
+ #
22
+ # HCloud::Volume.all.where(name: "my_volume")
23
+ # # => #<HCloud::Volume id: 1, ...>
24
+ #
25
+ # HCloud::Volume.all.where(status: "available")
26
+ # # => #<HCloud::Volume id: 1, ...>
27
+ #
28
+ # == Find volume by ID
29
+ #
30
+ # HCloud::Volume.find(1)
31
+ # # => #<HCloud::Volume id: 1, ...>
32
+ #
33
+ # == Create volume
34
+ #
35
+ # volume = HCloud::Volume.new(name: "my_volume", size: 10, format: "ext4", automount: false, location: "fsn1")
36
+ # volume.create
37
+ # volume.created?
38
+ # # => true
39
+ #
40
+ # firewall = HCloud::Volume.create(name: "my_volume", size: 10, format: "ext4", automount: false, location: "fsn1")
41
+ # # => #<HCloud::Volume id: 1, ...>
42
+ #
43
+ # == Update volume
44
+ #
45
+ # volume = HCloud::Volume.find(1)
46
+ # volume.name = "another_volume"
47
+ # volume.update
48
+ #
49
+ # == Delete volume
50
+ #
51
+ # volume = HCloud::Volume.find(1)
52
+ # volume.delete
53
+ # volume.deleted?
54
+ # # => true
55
+ #
56
+ # = Actions
57
+ # == List actions
58
+ #
59
+ # actions = HCloud::Volume.find(1).actions
60
+ # # => [#<HCloud::Action id: 1, ...>, ...]
61
+ #
62
+ # == Sort actions
63
+ #
64
+ # HCloud::Volume.find(1).actions.sort(finished: :desc)
65
+ # # => [#<HCloud::Action id: 1, ...>, ...]
66
+ #
67
+ # HCloud::Volume.find(1).actions.sort(:command, finished: :asc)
68
+ # # => [#<HCloud::Actions id: 1, ...>, ...]
69
+ #
70
+ # == Search actions
71
+ #
72
+ # HCloud::Volume.find(1).actions.where(command: "create_volume")
73
+ # # => #<HCloud::Action id: 1, ...>
74
+ #
75
+ # HCloud::Volume.find(1).actions.where(status: "success")
76
+ # # => #<HCloud::Action id: 1, ...>
77
+ #
78
+ # == Find action by ID
79
+ #
80
+ # HCloud::Volume.find(1).actions.find(1)
81
+ # # => #<HCloud::Action id: 1, ...>
82
+ #
83
+ # = Volume-specific actions
84
+ # == Attach a volume to a server
85
+ #
86
+ # HCloud::Volume.find(1).attach(server: 1)
87
+ # # => #<HCloud::Action id: 1, ...>
88
+ #
89
+ # == Detach a volume from a server
90
+ #
91
+ # HCloud::Volume.find(1).detach
92
+ # # => #<HCloud::Action id: 1, ...>
93
+ #
94
+ # == Resize volume
95
+ #
96
+ # HCloud::Volume.find(1).resize(size: 100)
97
+ # # => #<HCloud::Action id: 1, ...>
98
+ #
99
+ # == Change protection
100
+ #
101
+ # HCloud::Volume.find(1).change_protection(delete: true)
102
+ # # => #<HCloud::Action id: 1, ...>
103
+ #
104
+ class Volume < Resource
105
+ actionable
106
+ queryable
107
+ creatable
108
+ updatable
109
+ deletable
110
+
111
+ attribute :id, :integer
112
+ attribute :name
113
+
114
+ attribute :format
115
+ attribute :size, :integer
116
+ attribute :linux_device
117
+
118
+ attribute :status
119
+
120
+ attribute :automount, :boolean
121
+
122
+ attribute :location, :location
123
+ attribute :protection, :protection
124
+
125
+ # TODO: return Server object
126
+ attribute :server, :integer
127
+
128
+ attribute :labels, default: -> { {} }
129
+
130
+ alias automount? automount
131
+
132
+ action :attach
133
+ action :detach
134
+
135
+ action :resize
136
+
137
+ action :change_protection
138
+
139
+ def creatable_attributes
140
+ [:name, :format, :size, :server, :automount, :labels, location: [:id, :name]]
141
+ end
142
+
143
+ def updatable_attributes
144
+ [:name, :labels]
145
+ end
146
+ end
147
+ end
data/lib/hcloud/version.rb ADDED
@@ -0,0 +1,17 @@
1
+ # frozen_string_literal: true
2
+
3
+ module HCloud
4
+ module Version
5
+ MAJOR = 1
6
+ MINOR = 0
7
+ PATCH = 0
8
+ PRE = nil
9
+
10
+ VERSION = [MAJOR, MINOR, PATCH].compact.join(".")
11
+
12
+ STRING = [VERSION, PRE].compact.join("-")
13
+ end
14
+
15
+ NAME = "hcloud"
16
+ VERSION = Version::STRING
17
+ end
data/lib/hcloud.rb ADDED
@@ -0,0 +1,42 @@
1
+ # frozen_string_literal: true
2
+
3
+ require "active_model"
4
+ require "active_support/all"
5
+ require "zeitwerk"
6
+
7
+ require "byebug" if ENV["ENV"] == "development"
8
+
9
+ module HCloud
10
+ class << self
11
+ # Code loader instance
12
+ attr_reader :loader
13
+
14
+ def root
15
+ @root ||= Pathname.new(File.expand_path(File.join("..", ".."), __FILE__))
16
+ end
17
+
18
+ # rubocop:disable Metrics/AbcSize
19
+ def setup
20
+ @loader = Zeitwerk::Loader.for_gem
21
+
22
+ # Register inflections
23
+ require root.join("config/inflections.rb")
24
+
25
+ # Collapse resources
26
+ loader.collapse(
27
+ root.join("lib/hcloud/entities"),
28
+ root.join("lib/hcloud/concerns"),
29
+ root.join("lib/hcloud/resources"),
30
+ )
31
+
32
+ # Load types
33
+ require root.join("lib/hcloud/resource_type")
34
+
35
+ loader.setup
36
+ loader.eager_load
37
+ end
38
+ # rubocop:enable Metrics/AbcSize
39
+ end
40
+ end
41
+
42
+ HCloud.setup
metadata ADDED
@@ -0,0 +1,286 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: hetznercloud
3
+ version: !ruby/object:Gem::Version
4
+ version: 1.0.0
5
+ platform: ruby
6
+ authors:
7
+ - Florian Dejonckheere
8
+ autorequire:
9
+ bindir: bin
10
+ cert_chain: []
11
+ date: 2022-01-16 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: activemodel
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - ">="
18
+ - !ruby/object:Gem::Version
19
+ version: '0'
20
+ type: :runtime
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - ">="
25
+ - !ruby/object:Gem::Version
26
+ version: '0'
27
+ - !ruby/object:Gem::Dependency
28
+ name: activesupport
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - ">="
32
+ - !ruby/object:Gem::Version
33
+ version: '0'
34
+ type: :runtime
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - ">="
39
+ - !ruby/object:Gem::Version
40
+ version: '0'
41
+ - !ruby/object:Gem::Dependency
42
+ name: http
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - ">="
46
+ - !ruby/object:Gem::Version
47
+ version: '0'
48
+ type: :runtime
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - ">="
53
+ - !ruby/object:Gem::Version
54
+ version: '0'
55
+ - !ruby/object:Gem::Dependency
56
+ name: zeitwerk
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - ">="
60
+ - !ruby/object:Gem::Version
61
+ version: '0'
62
+ type: :runtime
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - ">="
67
+ - !ruby/object:Gem::Version
68
+ version: '0'
69
+ - !ruby/object:Gem::Dependency
70
+ name: byebug
71
+ requirement: !ruby/object:Gem::Requirement
72
+ requirements:
73
+ - - ">="
74
+ - !ruby/object:Gem::Version
75
+ version: '0'
76
+ type: :development
77
+ prerelease: false
78
+ version_requirements: !ruby/object:Gem::Requirement
79
+ requirements:
80
+ - - ">="
81
+ - !ruby/object:Gem::Version
82
+ version: '0'
83
+ - !ruby/object:Gem::Dependency
84
+ name: dotenv
85
+ requirement: !ruby/object:Gem::Requirement
86
+ requirements:
87
+ - - ">="
88
+ - !ruby/object:Gem::Version
89
+ version: '0'
90
+ type: :development
91
+ prerelease: false
92
+ version_requirements: !ruby/object:Gem::Requirement
93
+ requirements:
94
+ - - ">="
95
+ - !ruby/object:Gem::Version
96
+ version: '0'
97
+ - !ruby/object:Gem::Dependency
98
+ name: factory_bot
99
+ requirement: !ruby/object:Gem::Requirement
100
+ requirements:
101
+ - - ">="
102
+ - !ruby/object:Gem::Version
103
+ version: '0'
104
+ type: :development
105
+ prerelease: false
106
+ version_requirements: !ruby/object:Gem::Requirement
107
+ requirements:
108
+ - - ">="
109
+ - !ruby/object:Gem::Version
110
+ version: '0'
111
+ - !ruby/object:Gem::Dependency
112
+ name: ffaker
113
+ requirement: !ruby/object:Gem::Requirement
114
+ requirements:
115
+ - - ">="
116
+ - !ruby/object:Gem::Version
117
+ version: '0'
118
+ type: :development
119
+ prerelease: false
120
+ version_requirements: !ruby/object:Gem::Requirement
121
+ requirements:
122
+ - - ">="
123
+ - !ruby/object:Gem::Version
124
+ version: '0'
125
+ - !ruby/object:Gem::Dependency
126
+ name: rake
127
+ requirement: !ruby/object:Gem::Requirement
128
+ requirements:
129
+ - - ">="
130
+ - !ruby/object:Gem::Version
131
+ version: '0'
132
+ type: :development
133
+ prerelease: false
134
+ version_requirements: !ruby/object:Gem::Requirement
135
+ requirements:
136
+ - - ">="
137
+ - !ruby/object:Gem::Version
138
+ version: '0'
139
+ - !ruby/object:Gem::Dependency
140
+ name: rspec
141
+ requirement: !ruby/object:Gem::Requirement
142
+ requirements:
143
+ - - ">="
144
+ - !ruby/object:Gem::Version
145
+ version: '0'
146
+ type: :development
147
+ prerelease: false
148
+ version_requirements: !ruby/object:Gem::Requirement
149
+ requirements:
150
+ - - ">="
151
+ - !ruby/object:Gem::Version
152
+ version: '0'
153
+ - !ruby/object:Gem::Dependency
154
+ name: rubocop
155
+ requirement: !ruby/object:Gem::Requirement
156
+ requirements:
157
+ - - ">="
158
+ - !ruby/object:Gem::Version
159
+ version: '0'
160
+ type: :development
161
+ prerelease: false
162
+ version_requirements: !ruby/object:Gem::Requirement
163
+ requirements:
164
+ - - ">="
165
+ - !ruby/object:Gem::Version
166
+ version: '0'
167
+ - !ruby/object:Gem::Dependency
168
+ name: rubocop-performance
169
+ requirement: !ruby/object:Gem::Requirement
170
+ requirements:
171
+ - - ">="
172
+ - !ruby/object:Gem::Version
173
+ version: '0'
174
+ type: :development
175
+ prerelease: false
176
+ version_requirements: !ruby/object:Gem::Requirement
177
+ requirements:
178
+ - - ">="
179
+ - !ruby/object:Gem::Version
180
+ version: '0'
181
+ - !ruby/object:Gem::Dependency
182
+ name: rubocop-rspec
183
+ requirement: !ruby/object:Gem::Requirement
184
+ requirements:
185
+ - - ">="
186
+ - !ruby/object:Gem::Version
187
+ version: '0'
188
+ type: :development
189
+ prerelease: false
190
+ version_requirements: !ruby/object:Gem::Requirement
191
+ requirements:
192
+ - - ">="
193
+ - !ruby/object:Gem::Version
194
+ version: '0'
195
+ - !ruby/object:Gem::Dependency
196
+ name: webmock
197
+ requirement: !ruby/object:Gem::Requirement
198
+ requirements:
199
+ - - ">="
200
+ - !ruby/object:Gem::Version
201
+ version: '0'
202
+ type: :development
203
+ prerelease: false
204
+ version_requirements: !ruby/object:Gem::Requirement
205
+ requirements:
206
+ - - ">="
207
+ - !ruby/object:Gem::Version
208
+ version: '0'
209
+ description: Native Ruby integration with the Hetzner Cloud API
210
+ email:
211
+ - florian@floriandejonckheere.be
212
+ executables: []
213
+ extensions: []
214
+ extra_rdoc_files: []
215
+ files:
216
+ - CHANGELOG.md
217
+ - Gemfile
218
+ - LICENSE.md
219
+ - README.md
220
+ - config/inflections.rb
221
+ - lib/core_ext/send_wrap.rb
222
+ - lib/hcloud.rb
223
+ - lib/hcloud/action_collection.rb
224
+ - lib/hcloud/client.rb
225
+ - lib/hcloud/collection.rb
226
+ - lib/hcloud/concerns/actionable.rb
227
+ - lib/hcloud/concerns/concerns.rb
228
+ - lib/hcloud/concerns/creatable.rb
229
+ - lib/hcloud/concerns/deletable.rb
230
+ - lib/hcloud/concerns/queryable.rb
231
+ - lib/hcloud/concerns/updatable.rb
232
+ - lib/hcloud/entities/amount.rb
233
+ - lib/hcloud/entities/applied_to.rb
234
+ - lib/hcloud/entities/applied_to_resource.rb
235
+ - lib/hcloud/entities/apply_to.rb
236
+ - lib/hcloud/entities/datacenter_server_type.rb
237
+ - lib/hcloud/entities/dns_pointer.rb
238
+ - lib/hcloud/entities/error.rb
239
+ - lib/hcloud/entities/metrics.rb
240
+ - lib/hcloud/entities/price.rb
241
+ - lib/hcloud/entities/protection.rb
242
+ - lib/hcloud/entities/rule.rb
243
+ - lib/hcloud/entity.rb
244
+ - lib/hcloud/errors.rb
245
+ - lib/hcloud/http.rb
246
+ - lib/hcloud/resource.rb
247
+ - lib/hcloud/resource_type.rb
248
+ - lib/hcloud/resources/action.rb
249
+ - lib/hcloud/resources/datacenter.rb
250
+ - lib/hcloud/resources/firewall.rb
251
+ - lib/hcloud/resources/floating_ip.rb
252
+ - lib/hcloud/resources/image.rb
253
+ - lib/hcloud/resources/iso.rb
254
+ - lib/hcloud/resources/location.rb
255
+ - lib/hcloud/resources/placement_group.rb
256
+ - lib/hcloud/resources/server.rb
257
+ - lib/hcloud/resources/server_type.rb
258
+ - lib/hcloud/resources/ssh_key.rb
259
+ - lib/hcloud/resources/volume.rb
260
+ - lib/hcloud/version.rb
261
+ homepage: https://github.com/floriandejonckheere/hcloud
262
+ licenses:
263
+ - MIT
264
+ metadata:
265
+ source_code_uri: https://github.com/floriandejonckheere/hcloud.git
266
+ rubygems_mfa_required: 'true'
267
+ post_install_message:
268
+ rdoc_options: []
269
+ require_paths:
270
+ - lib
271
+ required_ruby_version: !ruby/object:Gem::Requirement
272
+ requirements:
273
+ - - ">="
274
+ - !ruby/object:Gem::Version
275
+ version: '2.7'
276
+ required_rubygems_version: !ruby/object:Gem::Requirement
277
+ requirements:
278
+ - - ">="
279
+ - !ruby/object:Gem::Version
280
+ version: '0'
281
+ requirements: []
282
+ rubygems_version: 3.1.2
283
+ signing_key:
284
+ specification_version: 4
285
+ summary: Ruby library wrapping the Hetzner Cloud API
286
+ test_files: []