octoprint 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (122) hide show
  1. checksums.yaml +7 -0
  2. data/CHANGELOG.md +10 -0
  3. data/LICENSE.txt +21 -0
  4. data/README.md +336 -0
  5. data/lib/octoprint/access/group.rb +88 -0
  6. data/lib/octoprint/access/groups.rb +166 -0
  7. data/lib/octoprint/access/login_response.rb +63 -0
  8. data/lib/octoprint/access/permission.rb +71 -0
  9. data/lib/octoprint/access/permissions.rb +29 -0
  10. data/lib/octoprint/access/user.rb +95 -0
  11. data/lib/octoprint/access/users.rb +347 -0
  12. data/lib/octoprint/auto_initializable.rb +219 -0
  13. data/lib/octoprint/base_resource.rb +139 -0
  14. data/lib/octoprint/client.rb +151 -0
  15. data/lib/octoprint/connection/options.rb +44 -0
  16. data/lib/octoprint/connection/settings.rb +35 -0
  17. data/lib/octoprint/connection.rb +74 -0
  18. data/lib/octoprint/deserializable.rb +483 -0
  19. data/lib/octoprint/exceptions.rb +30 -0
  20. data/lib/octoprint/files/file.rb +55 -0
  21. data/lib/octoprint/files/folder.rb +29 -0
  22. data/lib/octoprint/files/operation_result.rb +37 -0
  23. data/lib/octoprint/files/refs.rb +19 -0
  24. data/lib/octoprint/files.rb +238 -0
  25. data/lib/octoprint/job/information.rb +42 -0
  26. data/lib/octoprint/job/progress.rb +46 -0
  27. data/lib/octoprint/job.rb +140 -0
  28. data/lib/octoprint/languages/language_pack.rb +31 -0
  29. data/lib/octoprint/languages.rb +102 -0
  30. data/lib/octoprint/location.rb +23 -0
  31. data/lib/octoprint/logs/log_file.rb +59 -0
  32. data/lib/octoprint/logs/references.rb +28 -0
  33. data/lib/octoprint/logs.rb +98 -0
  34. data/lib/octoprint/printer/bed.rb +32 -0
  35. data/lib/octoprint/printer/chamber.rb +29 -0
  36. data/lib/octoprint/printer/command.rb +129 -0
  37. data/lib/octoprint/printer/custom_control/input.rb +45 -0
  38. data/lib/octoprint/printer/custom_control.rb +119 -0
  39. data/lib/octoprint/printer/error_information.rb +104 -0
  40. data/lib/octoprint/printer/heater.rb +113 -0
  41. data/lib/octoprint/printer/history_query.rb +25 -0
  42. data/lib/octoprint/printer/printhead.rb +105 -0
  43. data/lib/octoprint/printer/sd.rb +97 -0
  44. data/lib/octoprint/printer/state.rb +41 -0
  45. data/lib/octoprint/printer/state_flags.rb +70 -0
  46. data/lib/octoprint/printer/temperature_attributes.rb +70 -0
  47. data/lib/octoprint/printer/temperature_data.rb +53 -0
  48. data/lib/octoprint/printer/temperature_data_point.rb +73 -0
  49. data/lib/octoprint/printer/temperature_reading.rb +47 -0
  50. data/lib/octoprint/printer/temperature_state.rb +67 -0
  51. data/lib/octoprint/printer/tool.rb +154 -0
  52. data/lib/octoprint/printer.rb +126 -0
  53. data/lib/octoprint/printer_profiles/printer_profile.rb +40 -0
  54. data/lib/octoprint/printer_profiles.rb +158 -0
  55. data/lib/octoprint/server_information.rb +51 -0
  56. data/lib/octoprint/server_version.rb +52 -0
  57. data/lib/octoprint/settings/webcam.rb +135 -0
  58. data/lib/octoprint/settings.rb +133 -0
  59. data/lib/octoprint/slicing/profile.rb +65 -0
  60. data/lib/octoprint/slicing/slicer.rb +83 -0
  61. data/lib/octoprint/slicing.rb +227 -0
  62. data/lib/octoprint/system_commands/command.rb +41 -0
  63. data/lib/octoprint/system_commands.rb +110 -0
  64. data/lib/octoprint/timelapse/config.rb +68 -0
  65. data/lib/octoprint/timelapse/file_attributes.rb +50 -0
  66. data/lib/octoprint/timelapse/rendered.rb +51 -0
  67. data/lib/octoprint/timelapse/unrendered.rb +43 -0
  68. data/lib/octoprint/timelapse.rb +221 -0
  69. data/lib/octoprint/types.rb +140 -0
  70. data/lib/octoprint/util.rb +151 -0
  71. data/lib/octoprint/version.rb +7 -0
  72. data/lib/octoprint/wizard.rb +57 -0
  73. data/lib/octoprint.rb +57 -0
  74. data/rbi/octoprint/access/group.rbi +46 -0
  75. data/rbi/octoprint/access/login_response.rbi +22 -0
  76. data/rbi/octoprint/access/permission.rbi +34 -0
  77. data/rbi/octoprint/access/user.rbi +43 -0
  78. data/rbi/octoprint/connection/options.rbi +28 -0
  79. data/rbi/octoprint/connection/settings.rbi +19 -0
  80. data/rbi/octoprint/connection.rbi +13 -0
  81. data/rbi/octoprint/files/file.rbi +61 -0
  82. data/rbi/octoprint/files/folder.rbi +22 -0
  83. data/rbi/octoprint/files/operation_result.rbi +22 -0
  84. data/rbi/octoprint/files/refs.rbi +16 -0
  85. data/rbi/octoprint/job/information.rbi +22 -0
  86. data/rbi/octoprint/job/progress.rbi +25 -0
  87. data/rbi/octoprint/job.rbi +22 -0
  88. data/rbi/octoprint/languages/language_pack.rbi +19 -0
  89. data/rbi/octoprint/languages.rbi +13 -0
  90. data/rbi/octoprint/logs/log_file.rbi +19 -0
  91. data/rbi/octoprint/logs/references.rbi +13 -0
  92. data/rbi/octoprint/logs.rbi +13 -0
  93. data/rbi/octoprint/printer/bed.rbi +22 -0
  94. data/rbi/octoprint/printer/chamber.rbi +22 -0
  95. data/rbi/octoprint/printer/custom_control/input.rbi +22 -0
  96. data/rbi/octoprint/printer/custom_control.rbi +67 -0
  97. data/rbi/octoprint/printer/error_information.rbi +25 -0
  98. data/rbi/octoprint/printer/sd.rbi +13 -0
  99. data/rbi/octoprint/printer/state.rbi +19 -0
  100. data/rbi/octoprint/printer/state_flags.rbi +43 -0
  101. data/rbi/octoprint/printer/temperature_data.rbi +19 -0
  102. data/rbi/octoprint/printer/temperature_data_point.rbi +22 -0
  103. data/rbi/octoprint/printer/temperature_reading.rbi +19 -0
  104. data/rbi/octoprint/printer/temperature_state.rbi +22 -0
  105. data/rbi/octoprint/printer/tool.rbi +22 -0
  106. data/rbi/octoprint/printer.rbi +19 -0
  107. data/rbi/octoprint/printer_profiles/printer_profile.rbi +46 -0
  108. data/rbi/octoprint/printer_profiles.rbi +13 -0
  109. data/rbi/octoprint/server_information.rbi +16 -0
  110. data/rbi/octoprint/server_version.rbi +19 -0
  111. data/rbi/octoprint/settings/webcam.rbi +34 -0
  112. data/rbi/octoprint/slicing/profile.rbi +28 -0
  113. data/rbi/octoprint/slicing/slicer.rbi +31 -0
  114. data/rbi/octoprint/system_commands/command.rbi +25 -0
  115. data/rbi/octoprint/system_commands.rbi +16 -0
  116. data/rbi/octoprint/timelapse/config.rbi +31 -0
  117. data/rbi/octoprint/timelapse/rendered.rbi +31 -0
  118. data/rbi/octoprint/timelapse/unrendered.rbi +34 -0
  119. data/rbi/octoprint/timelapse.rbi +22 -0
  120. data/rbi/octoprint/util.rbi +19 -0
  121. data/rbi/octoprint.rbi +1848 -0
  122. metadata +264 -0
metadata ADDED
@@ -0,0 +1,264 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: octoprint
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - Sophie Déziel
8
+ bindir: bin
9
+ cert_chain: []
10
+ date: 2026-11-16 00:00:00.000000000 Z
11
+ dependencies:
12
+ - !ruby/object:Gem::Dependency
13
+ name: activesupport
14
+ requirement: !ruby/object:Gem::Requirement
15
+ requirements:
16
+ - - ">="
17
+ - !ruby/object:Gem::Version
18
+ version: '7.1'
19
+ - - "<"
20
+ - !ruby/object:Gem::Version
21
+ version: '9'
22
+ type: :runtime
23
+ prerelease: false
24
+ version_requirements: !ruby/object:Gem::Requirement
25
+ requirements:
26
+ - - ">="
27
+ - !ruby/object:Gem::Version
28
+ version: '7.1'
29
+ - - "<"
30
+ - !ruby/object:Gem::Version
31
+ version: '9'
32
+ - !ruby/object:Gem::Dependency
33
+ name: faraday
34
+ requirement: !ruby/object:Gem::Requirement
35
+ requirements:
36
+ - - ">="
37
+ - !ruby/object:Gem::Version
38
+ version: '2.2'
39
+ - - "<"
40
+ - !ruby/object:Gem::Version
41
+ version: '2.15'
42
+ type: :runtime
43
+ prerelease: false
44
+ version_requirements: !ruby/object:Gem::Requirement
45
+ requirements:
46
+ - - ">="
47
+ - !ruby/object:Gem::Version
48
+ version: '2.2'
49
+ - - "<"
50
+ - !ruby/object:Gem::Version
51
+ version: '2.15'
52
+ - !ruby/object:Gem::Dependency
53
+ name: faraday-multipart
54
+ requirement: !ruby/object:Gem::Requirement
55
+ requirements:
56
+ - - ">="
57
+ - !ruby/object:Gem::Version
58
+ version: 1.0.3
59
+ - - "<"
60
+ - !ruby/object:Gem::Version
61
+ version: 1.3.0
62
+ type: :runtime
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - ">="
67
+ - !ruby/object:Gem::Version
68
+ version: 1.0.3
69
+ - - "<"
70
+ - !ruby/object:Gem::Version
71
+ version: 1.3.0
72
+ - !ruby/object:Gem::Dependency
73
+ name: sorbet-runtime
74
+ requirement: !ruby/object:Gem::Requirement
75
+ requirements:
76
+ - - ">="
77
+ - !ruby/object:Gem::Version
78
+ version: 0.5.10908
79
+ - - "<"
80
+ - !ruby/object:Gem::Version
81
+ version: 0.7.0
82
+ type: :runtime
83
+ prerelease: false
84
+ version_requirements: !ruby/object:Gem::Requirement
85
+ requirements:
86
+ - - ">="
87
+ - !ruby/object:Gem::Version
88
+ version: 0.5.10908
89
+ - - "<"
90
+ - !ruby/object:Gem::Version
91
+ version: 0.7.0
92
+ - !ruby/object:Gem::Dependency
93
+ name: zeitwerk
94
+ requirement: !ruby/object:Gem::Requirement
95
+ requirements:
96
+ - - "~>"
97
+ - !ruby/object:Gem::Version
98
+ version: '2.6'
99
+ type: :runtime
100
+ prerelease: false
101
+ version_requirements: !ruby/object:Gem::Requirement
102
+ requirements:
103
+ - - "~>"
104
+ - !ruby/object:Gem::Version
105
+ version: '2.6'
106
+ description: Ruby client for OctoPrint's REST API covering files, jobs, printer state
107
+ and commands, printer and slicing profiles, connection, access control, settings,
108
+ timelapse, logs, system commands and more. Typed with Sorbet; API errors map to
109
+ typed exceptions.
110
+ email:
111
+ - courrier@sophiedeziel.com
112
+ executables: []
113
+ extensions: []
114
+ extra_rdoc_files: []
115
+ files:
116
+ - CHANGELOG.md
117
+ - LICENSE.txt
118
+ - README.md
119
+ - lib/octoprint.rb
120
+ - lib/octoprint/access/group.rb
121
+ - lib/octoprint/access/groups.rb
122
+ - lib/octoprint/access/login_response.rb
123
+ - lib/octoprint/access/permission.rb
124
+ - lib/octoprint/access/permissions.rb
125
+ - lib/octoprint/access/user.rb
126
+ - lib/octoprint/access/users.rb
127
+ - lib/octoprint/auto_initializable.rb
128
+ - lib/octoprint/base_resource.rb
129
+ - lib/octoprint/client.rb
130
+ - lib/octoprint/connection.rb
131
+ - lib/octoprint/connection/options.rb
132
+ - lib/octoprint/connection/settings.rb
133
+ - lib/octoprint/deserializable.rb
134
+ - lib/octoprint/exceptions.rb
135
+ - lib/octoprint/files.rb
136
+ - lib/octoprint/files/file.rb
137
+ - lib/octoprint/files/folder.rb
138
+ - lib/octoprint/files/operation_result.rb
139
+ - lib/octoprint/files/refs.rb
140
+ - lib/octoprint/job.rb
141
+ - lib/octoprint/job/information.rb
142
+ - lib/octoprint/job/progress.rb
143
+ - lib/octoprint/languages.rb
144
+ - lib/octoprint/languages/language_pack.rb
145
+ - lib/octoprint/location.rb
146
+ - lib/octoprint/logs.rb
147
+ - lib/octoprint/logs/log_file.rb
148
+ - lib/octoprint/logs/references.rb
149
+ - lib/octoprint/printer.rb
150
+ - lib/octoprint/printer/bed.rb
151
+ - lib/octoprint/printer/chamber.rb
152
+ - lib/octoprint/printer/command.rb
153
+ - lib/octoprint/printer/custom_control.rb
154
+ - lib/octoprint/printer/custom_control/input.rb
155
+ - lib/octoprint/printer/error_information.rb
156
+ - lib/octoprint/printer/heater.rb
157
+ - lib/octoprint/printer/history_query.rb
158
+ - lib/octoprint/printer/printhead.rb
159
+ - lib/octoprint/printer/sd.rb
160
+ - lib/octoprint/printer/state.rb
161
+ - lib/octoprint/printer/state_flags.rb
162
+ - lib/octoprint/printer/temperature_attributes.rb
163
+ - lib/octoprint/printer/temperature_data.rb
164
+ - lib/octoprint/printer/temperature_data_point.rb
165
+ - lib/octoprint/printer/temperature_reading.rb
166
+ - lib/octoprint/printer/temperature_state.rb
167
+ - lib/octoprint/printer/tool.rb
168
+ - lib/octoprint/printer_profiles.rb
169
+ - lib/octoprint/printer_profiles/printer_profile.rb
170
+ - lib/octoprint/server_information.rb
171
+ - lib/octoprint/server_version.rb
172
+ - lib/octoprint/settings.rb
173
+ - lib/octoprint/settings/webcam.rb
174
+ - lib/octoprint/slicing.rb
175
+ - lib/octoprint/slicing/profile.rb
176
+ - lib/octoprint/slicing/slicer.rb
177
+ - lib/octoprint/system_commands.rb
178
+ - lib/octoprint/system_commands/command.rb
179
+ - lib/octoprint/timelapse.rb
180
+ - lib/octoprint/timelapse/config.rb
181
+ - lib/octoprint/timelapse/file_attributes.rb
182
+ - lib/octoprint/timelapse/rendered.rb
183
+ - lib/octoprint/timelapse/unrendered.rb
184
+ - lib/octoprint/types.rb
185
+ - lib/octoprint/util.rb
186
+ - lib/octoprint/version.rb
187
+ - lib/octoprint/wizard.rb
188
+ - rbi/octoprint.rbi
189
+ - rbi/octoprint/access/group.rbi
190
+ - rbi/octoprint/access/login_response.rbi
191
+ - rbi/octoprint/access/permission.rbi
192
+ - rbi/octoprint/access/user.rbi
193
+ - rbi/octoprint/connection.rbi
194
+ - rbi/octoprint/connection/options.rbi
195
+ - rbi/octoprint/connection/settings.rbi
196
+ - rbi/octoprint/files/file.rbi
197
+ - rbi/octoprint/files/folder.rbi
198
+ - rbi/octoprint/files/operation_result.rbi
199
+ - rbi/octoprint/files/refs.rbi
200
+ - rbi/octoprint/job.rbi
201
+ - rbi/octoprint/job/information.rbi
202
+ - rbi/octoprint/job/progress.rbi
203
+ - rbi/octoprint/languages.rbi
204
+ - rbi/octoprint/languages/language_pack.rbi
205
+ - rbi/octoprint/logs.rbi
206
+ - rbi/octoprint/logs/log_file.rbi
207
+ - rbi/octoprint/logs/references.rbi
208
+ - rbi/octoprint/printer.rbi
209
+ - rbi/octoprint/printer/bed.rbi
210
+ - rbi/octoprint/printer/chamber.rbi
211
+ - rbi/octoprint/printer/custom_control.rbi
212
+ - rbi/octoprint/printer/custom_control/input.rbi
213
+ - rbi/octoprint/printer/error_information.rbi
214
+ - rbi/octoprint/printer/sd.rbi
215
+ - rbi/octoprint/printer/state.rbi
216
+ - rbi/octoprint/printer/state_flags.rbi
217
+ - rbi/octoprint/printer/temperature_data.rbi
218
+ - rbi/octoprint/printer/temperature_data_point.rbi
219
+ - rbi/octoprint/printer/temperature_reading.rbi
220
+ - rbi/octoprint/printer/temperature_state.rbi
221
+ - rbi/octoprint/printer/tool.rbi
222
+ - rbi/octoprint/printer_profiles.rbi
223
+ - rbi/octoprint/printer_profiles/printer_profile.rbi
224
+ - rbi/octoprint/server_information.rbi
225
+ - rbi/octoprint/server_version.rbi
226
+ - rbi/octoprint/settings/webcam.rbi
227
+ - rbi/octoprint/slicing/profile.rbi
228
+ - rbi/octoprint/slicing/slicer.rbi
229
+ - rbi/octoprint/system_commands.rbi
230
+ - rbi/octoprint/system_commands/command.rbi
231
+ - rbi/octoprint/timelapse.rbi
232
+ - rbi/octoprint/timelapse/config.rbi
233
+ - rbi/octoprint/timelapse/rendered.rbi
234
+ - rbi/octoprint/timelapse/unrendered.rbi
235
+ - rbi/octoprint/util.rbi
236
+ homepage: https://github.com/sophiedeziel/octoprint
237
+ licenses:
238
+ - MIT
239
+ metadata:
240
+ allowed_push_host: https://rubygems.org
241
+ homepage_uri: https://github.com/sophiedeziel/octoprint
242
+ source_code_uri: https://github.com/sophiedeziel/octoprint/tree/v0.1.0
243
+ changelog_uri: https://github.com/sophiedeziel/octoprint/blob/v0.1.0/CHANGELOG.md
244
+ bug_tracker_uri: https://github.com/sophiedeziel/octoprint/issues
245
+ documentation_uri: https://rubydoc.info/gems/octoprint/0.1.0
246
+ rubygems_mfa_required: 'true'
247
+ rdoc_options: []
248
+ require_paths:
249
+ - lib
250
+ required_ruby_version: !ruby/object:Gem::Requirement
251
+ requirements:
252
+ - - ">="
253
+ - !ruby/object:Gem::Version
254
+ version: '3.3'
255
+ required_rubygems_version: !ruby/object:Gem::Requirement
256
+ requirements:
257
+ - - ">="
258
+ - !ruby/object:Gem::Version
259
+ version: '0'
260
+ requirements: []
261
+ rubygems_version: 3.6.9
262
+ specification_version: 4
263
+ summary: Type-safe Ruby client for the OctoPrint REST API, with Sorbet signatures.
264
+ test_files: []