sketchup-api-stubs 0.7.3 → 0.7.4
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +5 -5
- data/.yardopts +9 -9
- data/lib/sketchup-api-stubs.rb +1 -1
- data/lib/sketchup-api-stubs/sketchup.rb +145 -145
- data/lib/sketchup-api-stubs/stubs/Geom/BoundingBox.rb +318 -318
- data/lib/sketchup-api-stubs/stubs/Geom/Bounds2d.rb +172 -172
- data/lib/sketchup-api-stubs/stubs/Geom/LatLong.rb +126 -126
- data/lib/sketchup-api-stubs/stubs/Geom/OrientedBounds2d.rb +102 -102
- data/lib/sketchup-api-stubs/stubs/Geom/Point2d.rb +400 -400
- data/lib/sketchup-api-stubs/stubs/Geom/Point3d.rb +661 -661
- data/lib/sketchup-api-stubs/stubs/Geom/PolygonMesh.rb +492 -492
- data/lib/sketchup-api-stubs/stubs/Geom/Transformation.rb +478 -478
- data/lib/sketchup-api-stubs/stubs/Geom/Transformation2d.rb +263 -263
- data/lib/sketchup-api-stubs/stubs/Geom/UTM.rb +141 -141
- data/lib/sketchup-api-stubs/stubs/Geom/Vector2d.rb +522 -522
- data/lib/sketchup-api-stubs/stubs/Geom/Vector3d.rb +691 -691
- data/lib/sketchup-api-stubs/stubs/Layout.rb +25 -25
- data/lib/sketchup-api-stubs/stubs/Layout/AngularDimension.rb +573 -573
- data/lib/sketchup-api-stubs/stubs/Layout/AutoTextDefinition.rb +411 -411
- data/lib/sketchup-api-stubs/stubs/Layout/AutoTextDefinitions.rb +174 -186
- data/lib/sketchup-api-stubs/stubs/Layout/ConnectionPoint.rb +70 -70
- data/lib/sketchup-api-stubs/stubs/Layout/Document.rb +514 -514
- data/lib/sketchup-api-stubs/stubs/Layout/Ellipse.rb +29 -29
- data/lib/sketchup-api-stubs/stubs/Layout/Entities.rb +143 -155
- data/lib/sketchup-api-stubs/stubs/Layout/Entity.rb +353 -353
- data/lib/sketchup-api-stubs/stubs/Layout/FormattedText.rb +349 -349
- data/lib/sketchup-api-stubs/stubs/Layout/Grid.rb +311 -311
- data/lib/sketchup-api-stubs/stubs/Layout/Group.rb +261 -261
- data/lib/sketchup-api-stubs/stubs/Layout/Image.rb +91 -91
- data/lib/sketchup-api-stubs/stubs/Layout/Label.rb +371 -371
- data/lib/sketchup-api-stubs/stubs/Layout/Layer.rb +218 -218
- data/lib/sketchup-api-stubs/stubs/Layout/LayerInstance.rb +128 -128
- data/lib/sketchup-api-stubs/stubs/Layout/Layers.rb +220 -232
- data/lib/sketchup-api-stubs/stubs/Layout/LinearDimension.rb +567 -567
- data/lib/sketchup-api-stubs/stubs/Layout/LockedEntityError.rb +10 -10
- data/lib/sketchup-api-stubs/stubs/Layout/LockedLayerError.rb +11 -11
- data/lib/sketchup-api-stubs/stubs/Layout/Page.rb +183 -183
- data/lib/sketchup-api-stubs/stubs/Layout/PageInfo.rb +387 -387
- data/lib/sketchup-api-stubs/stubs/Layout/Pages.rb +204 -216
- data/lib/sketchup-api-stubs/stubs/Layout/Path.rb +344 -344
- data/lib/sketchup-api-stubs/stubs/Layout/Rectangle.rb +174 -174
- data/lib/sketchup-api-stubs/stubs/Layout/SketchUpModel.rb +694 -694
- data/lib/sketchup-api-stubs/stubs/Layout/Style.rb +1519 -1519
- data/lib/sketchup-api-stubs/stubs/Layout/Table.rb +290 -290
- data/lib/sketchup-api-stubs/stubs/Layout/TableCell.rb +149 -149
- data/lib/sketchup-api-stubs/stubs/Layout/TableColumn.rb +139 -139
- data/lib/sketchup-api-stubs/stubs/Layout/TableRow.rb +135 -135
- data/lib/sketchup-api-stubs/stubs/Sketchup/Animation.rb +140 -140
- data/lib/sketchup-api-stubs/stubs/Sketchup/AppObserver.rb +157 -157
- data/lib/sketchup-api-stubs/stubs/Sketchup/ArcCurve.rb +209 -209
- data/lib/sketchup-api-stubs/stubs/Sketchup/AttributeDictionaries.rb +152 -152
- data/lib/sketchup-api-stubs/stubs/Sketchup/AttributeDictionary.rb +281 -281
- data/lib/sketchup-api-stubs/stubs/Sketchup/Axes.rb +149 -149
- data/lib/sketchup-api-stubs/stubs/Sketchup/Behavior.rb +328 -328
- data/lib/sketchup-api-stubs/stubs/Sketchup/Camera.rb +577 -577
- data/lib/sketchup-api-stubs/stubs/Sketchup/ClassificationSchema.rb +63 -63
- data/lib/sketchup-api-stubs/stubs/Sketchup/Classifications.rb +122 -122
- data/lib/sketchup-api-stubs/stubs/Sketchup/Color.rb +281 -281
- data/lib/sketchup-api-stubs/stubs/Sketchup/ComponentDefinition.rb +562 -562
- data/lib/sketchup-api-stubs/stubs/Sketchup/ComponentInstance.rb +593 -593
- data/lib/sketchup-api-stubs/stubs/Sketchup/Console.rb +76 -76
- data/lib/sketchup-api-stubs/stubs/Sketchup/ConstructionLine.rb +257 -257
- data/lib/sketchup-api-stubs/stubs/Sketchup/ConstructionPoint.rb +32 -32
- data/lib/sketchup-api-stubs/stubs/Sketchup/Curve.rb +194 -194
- data/lib/sketchup-api-stubs/stubs/Sketchup/DefinitionList.rb +329 -329
- data/lib/sketchup-api-stubs/stubs/Sketchup/DefinitionObserver.rb +72 -72
- data/lib/sketchup-api-stubs/stubs/Sketchup/DefinitionsObserver.rb +102 -102
- data/lib/sketchup-api-stubs/stubs/Sketchup/Dimension.rb +165 -165
- data/lib/sketchup-api-stubs/stubs/Sketchup/DimensionLinear.rb +312 -312
- data/lib/sketchup-api-stubs/stubs/Sketchup/DimensionObserver.rb +38 -38
- data/lib/sketchup-api-stubs/stubs/Sketchup/DimensionRadial.rb +87 -87
- data/lib/sketchup-api-stubs/stubs/Sketchup/Drawingelement.rb +390 -390
- data/lib/sketchup-api-stubs/stubs/Sketchup/Edge.rb +508 -508
- data/lib/sketchup-api-stubs/stubs/Sketchup/EdgeUse.rb +211 -211
- data/lib/sketchup-api-stubs/stubs/Sketchup/Entities.rb +1119 -1119
- data/lib/sketchup-api-stubs/stubs/Sketchup/EntitiesObserver.rb +125 -125
- data/lib/sketchup-api-stubs/stubs/Sketchup/Entity.rb +544 -544
- data/lib/sketchup-api-stubs/stubs/Sketchup/EntityObserver.rb +59 -59
- data/lib/sketchup-api-stubs/stubs/Sketchup/ExtensionsManager.rb +125 -125
- data/lib/sketchup-api-stubs/stubs/Sketchup/Face.rb +750 -750
- data/lib/sketchup-api-stubs/stubs/Sketchup/FrameChangeObserver.rb +104 -104
- data/lib/sketchup-api-stubs/stubs/Sketchup/Group.rb +697 -697
- data/lib/sketchup-api-stubs/stubs/Sketchup/Http.rb +27 -27
- data/lib/sketchup-api-stubs/stubs/Sketchup/Http/Request.rb +285 -285
- data/lib/sketchup-api-stubs/stubs/Sketchup/Http/Response.rb +62 -62
- data/lib/sketchup-api-stubs/stubs/Sketchup/Image.rb +409 -409
- data/lib/sketchup-api-stubs/stubs/Sketchup/ImageRep.rb +226 -226
- data/lib/sketchup-api-stubs/stubs/Sketchup/Importer.rb +190 -190
- data/lib/sketchup-api-stubs/stubs/Sketchup/InputPoint.rb +393 -393
- data/lib/sketchup-api-stubs/stubs/Sketchup/InstanceObserver.rb +82 -82
- data/lib/sketchup-api-stubs/stubs/Sketchup/InstancePath.rb +303 -303
- data/lib/sketchup-api-stubs/stubs/Sketchup/Layer.rb +285 -280
- data/lib/sketchup-api-stubs/stubs/Sketchup/Layers.rb +244 -231
- data/lib/sketchup-api-stubs/stubs/Sketchup/LayersObserver.rb +136 -136
- data/lib/sketchup-api-stubs/stubs/Sketchup/Licensing.rb +48 -48
- data/lib/sketchup-api-stubs/stubs/Sketchup/Licensing/ExtensionLicense.rb +86 -86
- data/lib/sketchup-api-stubs/stubs/Sketchup/LineStyle.rb +24 -24
- data/lib/sketchup-api-stubs/stubs/Sketchup/LineStyles.rb +112 -123
- data/lib/sketchup-api-stubs/stubs/Sketchup/Loop.rb +137 -137
- data/lib/sketchup-api-stubs/stubs/Sketchup/Material.rb +416 -416
- data/lib/sketchup-api-stubs/stubs/Sketchup/Materials.rb +311 -311
- data/lib/sketchup-api-stubs/stubs/Sketchup/MaterialsObserver.rb +141 -141
- data/lib/sketchup-api-stubs/stubs/Sketchup/Menu.rb +95 -95
- data/lib/sketchup-api-stubs/stubs/Sketchup/Model.rb +1638 -1601
- data/lib/sketchup-api-stubs/stubs/Sketchup/ModelObserver.rb +356 -356
- data/lib/sketchup-api-stubs/stubs/Sketchup/OptionsManager.rb +132 -132
- data/lib/sketchup-api-stubs/stubs/Sketchup/OptionsProvider.rb +284 -284
- data/lib/sketchup-api-stubs/stubs/Sketchup/OptionsProviderObserver.rb +58 -58
- data/lib/sketchup-api-stubs/stubs/Sketchup/Page.rb +770 -770
- data/lib/sketchup-api-stubs/stubs/Sketchup/Pages.rb +353 -353
- data/lib/sketchup-api-stubs/stubs/Sketchup/PagesObserver.rb +76 -76
- data/lib/sketchup-api-stubs/stubs/Sketchup/PickHelper.rb +456 -456
- data/lib/sketchup-api-stubs/stubs/Sketchup/RegionalSettings.rb +43 -43
- data/lib/sketchup-api-stubs/stubs/Sketchup/RenderingOptions.rb +364 -364
- data/lib/sketchup-api-stubs/stubs/Sketchup/RenderingOptionsObserver.rb +44 -44
- data/lib/sketchup-api-stubs/stubs/Sketchup/SectionPlane.rb +150 -150
- data/lib/sketchup-api-stubs/stubs/Sketchup/Selection.rb +454 -454
- data/lib/sketchup-api-stubs/stubs/Sketchup/SelectionObserver.rb +115 -115
- data/lib/sketchup-api-stubs/stubs/Sketchup/Set.rb +212 -212
- data/lib/sketchup-api-stubs/stubs/Sketchup/ShadowInfo.rb +257 -257
- data/lib/sketchup-api-stubs/stubs/Sketchup/ShadowInfoObserver.rb +57 -57
- data/lib/sketchup-api-stubs/stubs/Sketchup/Style.rb +69 -69
- data/lib/sketchup-api-stubs/stubs/Sketchup/Styles.rb +211 -211
- data/lib/sketchup-api-stubs/stubs/Sketchup/Text.rb +262 -262
- data/lib/sketchup-api-stubs/stubs/Sketchup/Texture.rb +225 -225
- data/lib/sketchup-api-stubs/stubs/Sketchup/TextureWriter.rb +237 -237
- data/lib/sketchup-api-stubs/stubs/Sketchup/Tool.rb +829 -829
- data/lib/sketchup-api-stubs/stubs/Sketchup/Tools.rb +132 -132
- data/lib/sketchup-api-stubs/stubs/Sketchup/ToolsObserver.rb +154 -154
- data/lib/sketchup-api-stubs/stubs/Sketchup/UVHelper.rb +61 -61
- data/lib/sketchup-api-stubs/stubs/Sketchup/Vertex.rb +142 -142
- data/lib/sketchup-api-stubs/stubs/Sketchup/View.rb +1301 -1301
- data/lib/sketchup-api-stubs/stubs/Sketchup/ViewObserver.rb +43 -43
- data/lib/sketchup-api-stubs/stubs/UI/Command.rb +310 -310
- data/lib/sketchup-api-stubs/stubs/UI/HtmlDialog.rb +356 -356
- data/lib/sketchup-api-stubs/stubs/UI/Notification.rb +229 -229
- data/lib/sketchup-api-stubs/stubs/UI/Toolbar.rb +240 -240
- data/lib/sketchup-api-stubs/stubs/UI/WebDialog.rb +633 -633
- data/lib/sketchup-api-stubs/stubs/_top_level.rb +311 -311
- data/lib/sketchup-api-stubs/stubs/array.rb +741 -741
- data/lib/sketchup-api-stubs/stubs/geom.rb +348 -348
- data/lib/sketchup-api-stubs/stubs/languagehandler.rb +92 -92
- data/lib/sketchup-api-stubs/stubs/length.rb +278 -278
- data/lib/sketchup-api-stubs/stubs/numeric.rb +249 -249
- data/lib/sketchup-api-stubs/stubs/sketchup.rb +1310 -1310
- data/lib/sketchup-api-stubs/stubs/sketchupextension.rb +353 -353
- data/lib/sketchup-api-stubs/stubs/string.rb +24 -24
- data/lib/sketchup-api-stubs/stubs/ui.rb +667 -667
- metadata +3 -4
@@ -1,27 +1,27 @@
|
|
1
|
-
# Copyright:: Copyright 2020 Trimble Inc.
|
2
|
-
# License:: The MIT License (MIT)
|
3
|
-
|
4
|
-
# The {Sketchup::Http} module provides interfaces to create asynchronous HTTP
|
5
|
-
# requests. This is an alternative to the Net::Http module that comes with
|
6
|
-
# Ruby StdLib - which is known to have issues within SketchUp.
|
7
|
-
#
|
8
|
-
# @version SketchUp 2017
|
9
|
-
module Sketchup::Http
|
10
|
-
|
11
|
-
# Constants
|
12
|
-
|
13
|
-
DELETE = nil # Stub value.
|
14
|
-
GET = nil # Stub value.
|
15
|
-
HEAD = nil # Stub value.
|
16
|
-
OPTIONS = nil # Stub value.
|
17
|
-
PATCH = nil # Stub value.
|
18
|
-
POST = nil # Stub value.
|
19
|
-
PUT = nil # Stub value.
|
20
|
-
|
21
|
-
STATUS_CANCELED = nil # Stub value.
|
22
|
-
STATUS_FAILED = nil # Stub value.
|
23
|
-
STATUS_PENDING = nil # Stub value.
|
24
|
-
STATUS_SUCCESS = nil # Stub value.
|
25
|
-
STATUS_UNKNOWN = nil # Stub value.
|
26
|
-
|
27
|
-
end
|
1
|
+
# Copyright:: Copyright 2020 Trimble Inc.
|
2
|
+
# License:: The MIT License (MIT)
|
3
|
+
|
4
|
+
# The {Sketchup::Http} module provides interfaces to create asynchronous HTTP
|
5
|
+
# requests. This is an alternative to the Net::Http module that comes with
|
6
|
+
# Ruby StdLib - which is known to have issues within SketchUp.
|
7
|
+
#
|
8
|
+
# @version SketchUp 2017
|
9
|
+
module Sketchup::Http
|
10
|
+
|
11
|
+
# Constants
|
12
|
+
|
13
|
+
DELETE = nil # Stub value.
|
14
|
+
GET = nil # Stub value.
|
15
|
+
HEAD = nil # Stub value.
|
16
|
+
OPTIONS = nil # Stub value.
|
17
|
+
PATCH = nil # Stub value.
|
18
|
+
POST = nil # Stub value.
|
19
|
+
PUT = nil # Stub value.
|
20
|
+
|
21
|
+
STATUS_CANCELED = nil # Stub value.
|
22
|
+
STATUS_FAILED = nil # Stub value.
|
23
|
+
STATUS_PENDING = nil # Stub value.
|
24
|
+
STATUS_SUCCESS = nil # Stub value.
|
25
|
+
STATUS_UNKNOWN = nil # Stub value.
|
26
|
+
|
27
|
+
end
|
@@ -1,285 +1,285 @@
|
|
1
|
-
# Copyright:: Copyright 2020 Trimble Inc.
|
2
|
-
# License:: The MIT License (MIT)
|
3
|
-
|
4
|
-
# Http::Request objects allows you to send HTTP request to HTTP servers.
|
5
|
-
#
|
6
|
-
# @version SketchUp 2017
|
7
|
-
class Sketchup::Http::Request
|
8
|
-
|
9
|
-
# Instance Methods
|
10
|
-
|
11
|
-
# Gets the http body that is going to be used when sending the request.
|
12
|
-
#
|
13
|
-
# @example
|
14
|
-
# request = Sketchup::Http::Request.new("http://localhost:8080")
|
15
|
-
#
|
16
|
-
# request.start do |request, response|
|
17
|
-
# puts "body: #{request.body}"
|
18
|
-
# end
|
19
|
-
#
|
20
|
-
# @return [String]
|
21
|
-
#
|
22
|
-
# @version SketchUp 2017
|
23
|
-
def body
|
24
|
-
end
|
25
|
-
|
26
|
-
# Sets the http body that is going to be used when sending the request.
|
27
|
-
#
|
28
|
-
# @example
|
29
|
-
# request = Sketchup::Http::Request.new("http://localhost:8080")
|
30
|
-
# request.body = "Hello World"
|
31
|
-
#
|
32
|
-
# request.start do |request, response|
|
33
|
-
# puts "body: #{request.body}"
|
34
|
-
# end
|
35
|
-
#
|
36
|
-
# @param [String] body
|
37
|
-
# A String containing the body.
|
38
|
-
#
|
39
|
-
# @return [String]
|
40
|
-
#
|
41
|
-
# @version SketchUp 2017
|
42
|
-
def body=(body)
|
43
|
-
end
|
44
|
-
|
45
|
-
# Cancels the request.
|
46
|
-
#
|
47
|
-
# @example
|
48
|
-
# request = Sketchup::Http::Request.new("http://localhost:8080")
|
49
|
-
# request.start do |request, response|
|
50
|
-
# puts "body: #{response.body}"
|
51
|
-
# end
|
52
|
-
#
|
53
|
-
# request.cancel
|
54
|
-
#
|
55
|
-
# @return [true]
|
56
|
-
#
|
57
|
-
# @version SketchUp 2017
|
58
|
-
def cancel
|
59
|
-
end
|
60
|
-
|
61
|
-
# Returns the http headers that are going to be used when sending the request.
|
62
|
-
#
|
63
|
-
# @example
|
64
|
-
# request = Sketchup::Http::Request.new("http://localhost:8080")
|
65
|
-
# request.headers = { :key1 => "value1", :key2 => "value2" }
|
66
|
-
#
|
67
|
-
# request.headers.each do |key, value|
|
68
|
-
# puts "#{key}: #{value}"
|
69
|
-
# end
|
70
|
-
#
|
71
|
-
# @return [Hash]
|
72
|
-
#
|
73
|
-
# @version SketchUp 2017
|
74
|
-
def headers
|
75
|
-
end
|
76
|
-
|
77
|
-
# Sets the http headers that are going to be used when sending the request.
|
78
|
-
#
|
79
|
-
# @example
|
80
|
-
# request = Sketchup::Http::Request.new("http://localhost:8080")
|
81
|
-
# request.headers = { :key1 => "value1", :key2 => "value2" }
|
82
|
-
#
|
83
|
-
# request.headers.each do |key, value|
|
84
|
-
# puts "#{key}: #{value}"
|
85
|
-
# end
|
86
|
-
#
|
87
|
-
# @param [Hash] headers
|
88
|
-
# A key/value pair hash.
|
89
|
-
#
|
90
|
-
# @return [Boolean]
|
91
|
-
#
|
92
|
-
# @version SketchUp 2017
|
93
|
-
def headers=(headers)
|
94
|
-
end
|
95
|
-
|
96
|
-
# The new method is used to create a new Sketchup::Http::Request.
|
97
|
-
#
|
98
|
-
# The default port is 80, to use a different port define it in the URL when
|
99
|
-
# creating a new Http::Request
|
100
|
-
#
|
101
|
-
# Keeping a reference to the request is necessary in order to ensure the use of
|
102
|
-
# the response.
|
103
|
-
#
|
104
|
-
# The +method+ parameter accepts any custom http method or one of the
|
105
|
-
# following:
|
106
|
-
# * +Sketchup::Http::GET+
|
107
|
-
# * +Sketchup::Http::POST+
|
108
|
-
# * +Sketchup::Http::PUT+
|
109
|
-
# * +Sketchup::Http::DELETE+
|
110
|
-
# * +Sketchup::Http::HEAD+
|
111
|
-
# * +Sketchup::Http::OPTIONS+
|
112
|
-
#
|
113
|
-
# @example
|
114
|
-
# request = Sketchup::Http::Request.new("http://localhost:8080", Sketchup::Http::GET)
|
115
|
-
#
|
116
|
-
# request.start do |request, response|
|
117
|
-
# puts "body: #{response.body}"
|
118
|
-
# end
|
119
|
-
#
|
120
|
-
# @param [String] url
|
121
|
-
# The targetted URL.
|
122
|
-
#
|
123
|
-
# @param [String] method
|
124
|
-
# Optionally, the request method to use, the
|
125
|
-
# default is Sketchup::Http::GET
|
126
|
-
#
|
127
|
-
# @return [Request]
|
128
|
-
#
|
129
|
-
# @version SketchUp 2017
|
130
|
-
def initialize(url, method)
|
131
|
-
end
|
132
|
-
|
133
|
-
# Returns the http method that is going to be used when sending the request.
|
134
|
-
#
|
135
|
-
# @example
|
136
|
-
# request = Sketchup::Http::Request.new("http://localhost:8080")
|
137
|
-
#
|
138
|
-
# request.start do |request, response|
|
139
|
-
# puts "request.method: #{request.method}"
|
140
|
-
# end
|
141
|
-
#
|
142
|
-
# @return [String]
|
143
|
-
#
|
144
|
-
# @version SketchUp 2017
|
145
|
-
def method
|
146
|
-
end
|
147
|
-
|
148
|
-
# Sets the http method that is going to be used when sending the request.
|
149
|
-
# The value can be any custom http method or one of the following:
|
150
|
-
# * +Sketchup::Http::GET+
|
151
|
-
# * +Sketchup::Http::POST+
|
152
|
-
# * +Sketchup::Http::PUT+
|
153
|
-
# * +Sketchup::Http::DELETE+
|
154
|
-
# * +Sketchup::Http::HEAD+
|
155
|
-
# * +Sketchup::Http::OPTIONS+
|
156
|
-
#
|
157
|
-
# @example
|
158
|
-
# request = Sketchup::Http::Request.new("http://localhost:8080")
|
159
|
-
# request.method = Sketchup::Http::POST
|
160
|
-
#
|
161
|
-
# request.start do |request, response|
|
162
|
-
# puts "request.method: #{request.method}"
|
163
|
-
# end
|
164
|
-
#
|
165
|
-
# @param [String] method
|
166
|
-
# A string containing the http method name.
|
167
|
-
#
|
168
|
-
# @return [Boolean]
|
169
|
-
#
|
170
|
-
# @version SketchUp 2017
|
171
|
-
def method=(method)
|
172
|
-
end
|
173
|
-
|
174
|
-
# Adds a download progress callback block that will get called everytime we
|
175
|
-
# have received data from the server until the download finishes.
|
176
|
-
#
|
177
|
-
# @example
|
178
|
-
# request = Sketchup::Http::Request.new("http://localhost:8080")
|
179
|
-
#
|
180
|
-
# request.set_download_progress_callback do |current, total|
|
181
|
-
# puts "download current: #{current}"
|
182
|
-
# puts "download total: #{total}"
|
183
|
-
# end
|
184
|
-
#
|
185
|
-
# request.start
|
186
|
-
#
|
187
|
-
# @return [Boolean]
|
188
|
-
#
|
189
|
-
# @version SketchUp 2017
|
190
|
-
#
|
191
|
-
# @yield A block to be invoked everytime data is downloaded from the server.
|
192
|
-
#
|
193
|
-
# @yieldparam [Integer] current
|
194
|
-
# Current bytes transferred.
|
195
|
-
#
|
196
|
-
# @yieldparam [Integer] total
|
197
|
-
# Total bytes to transfer.
|
198
|
-
def set_download_progress_callback
|
199
|
-
end
|
200
|
-
|
201
|
-
# Adds a upload progress callback block that will get called everytime we have
|
202
|
-
# uploaded data to the server until the upload finishes.
|
203
|
-
#
|
204
|
-
# @example
|
205
|
-
# request = Sketchup::Http::Request.new("http://localhost:8080")
|
206
|
-
#
|
207
|
-
# request.set_upload_progress_callback do |current, total|
|
208
|
-
# puts "upload current: #{current}"
|
209
|
-
# puts "upload total: #{total}"
|
210
|
-
# end
|
211
|
-
#
|
212
|
-
# request.start
|
213
|
-
#
|
214
|
-
# @return [Boolean]
|
215
|
-
#
|
216
|
-
# @version SketchUp 2017
|
217
|
-
#
|
218
|
-
# @yield A block to be invoked everytime data is sent to the server.
|
219
|
-
#
|
220
|
-
# @yieldparam [Integer] current
|
221
|
-
# Current bytes transferred.
|
222
|
-
#
|
223
|
-
# @yieldparam [Integer] total
|
224
|
-
# Total bytes to transfer.
|
225
|
-
def set_upload_progress_callback
|
226
|
-
end
|
227
|
-
|
228
|
-
# Starts the request and optionally add a callback block.
|
229
|
-
#
|
230
|
-
# @example
|
231
|
-
# request = Sketchup::Http::Request.new("http://localhost:8080")
|
232
|
-
#
|
233
|
-
# request.start do |request, response|
|
234
|
-
# puts "body: #{response.body}"
|
235
|
-
# end
|
236
|
-
#
|
237
|
-
# @return [Boolean]
|
238
|
-
#
|
239
|
-
# @version SketchUp 2017
|
240
|
-
#
|
241
|
-
# @yield A block that is invoked when the request has finished.
|
242
|
-
#
|
243
|
-
# @yieldparam [Request] request
|
244
|
-
# The request object.
|
245
|
-
#
|
246
|
-
# @yieldparam [Response] response
|
247
|
-
# The response object, use this to read the
|
248
|
-
# server response.
|
249
|
-
def start
|
250
|
-
end
|
251
|
-
|
252
|
-
# Returns the internal status code. It can be one of the following:
|
253
|
-
# * +Sketchup::Http::STATUS_UNKNOWN+
|
254
|
-
# * +Sketchup::Http::STATUS_SUCCESS+
|
255
|
-
# * +Sketchup::Http::STATUS_PENDING+
|
256
|
-
# * +Sketchup::Http::STATUS_CANCELED+
|
257
|
-
# * +Sketchup::Http::STATUS_FAILED+
|
258
|
-
#
|
259
|
-
# @example
|
260
|
-
# request = Sketchup::Http::Request.new("http://localhost:8080")
|
261
|
-
# request.start
|
262
|
-
# puts "response.status: #{request.status}"
|
263
|
-
#
|
264
|
-
# @return [int]
|
265
|
-
#
|
266
|
-
# @version SketchUp 2017
|
267
|
-
def status
|
268
|
-
end
|
269
|
-
|
270
|
-
# Returns a copy of the Request's URL.
|
271
|
-
#
|
272
|
-
# @example
|
273
|
-
# request = Sketchup::Http::Request.new("http://localhost:8080")
|
274
|
-
#
|
275
|
-
# request.start do |request, response|
|
276
|
-
# puts "url: #{request.url}"
|
277
|
-
# end
|
278
|
-
#
|
279
|
-
# @return [String]
|
280
|
-
#
|
281
|
-
# @version SketchUp 2017
|
282
|
-
def url
|
283
|
-
end
|
284
|
-
|
285
|
-
end
|
1
|
+
# Copyright:: Copyright 2020 Trimble Inc.
|
2
|
+
# License:: The MIT License (MIT)
|
3
|
+
|
4
|
+
# Http::Request objects allows you to send HTTP request to HTTP servers.
|
5
|
+
#
|
6
|
+
# @version SketchUp 2017
|
7
|
+
class Sketchup::Http::Request
|
8
|
+
|
9
|
+
# Instance Methods
|
10
|
+
|
11
|
+
# Gets the http body that is going to be used when sending the request.
|
12
|
+
#
|
13
|
+
# @example
|
14
|
+
# request = Sketchup::Http::Request.new("http://localhost:8080")
|
15
|
+
#
|
16
|
+
# request.start do |request, response|
|
17
|
+
# puts "body: #{request.body}"
|
18
|
+
# end
|
19
|
+
#
|
20
|
+
# @return [String]
|
21
|
+
#
|
22
|
+
# @version SketchUp 2017
|
23
|
+
def body
|
24
|
+
end
|
25
|
+
|
26
|
+
# Sets the http body that is going to be used when sending the request.
|
27
|
+
#
|
28
|
+
# @example
|
29
|
+
# request = Sketchup::Http::Request.new("http://localhost:8080")
|
30
|
+
# request.body = "Hello World"
|
31
|
+
#
|
32
|
+
# request.start do |request, response|
|
33
|
+
# puts "body: #{request.body}"
|
34
|
+
# end
|
35
|
+
#
|
36
|
+
# @param [String] body
|
37
|
+
# A String containing the body.
|
38
|
+
#
|
39
|
+
# @return [String]
|
40
|
+
#
|
41
|
+
# @version SketchUp 2017
|
42
|
+
def body=(body)
|
43
|
+
end
|
44
|
+
|
45
|
+
# Cancels the request.
|
46
|
+
#
|
47
|
+
# @example
|
48
|
+
# request = Sketchup::Http::Request.new("http://localhost:8080")
|
49
|
+
# request.start do |request, response|
|
50
|
+
# puts "body: #{response.body}"
|
51
|
+
# end
|
52
|
+
#
|
53
|
+
# request.cancel
|
54
|
+
#
|
55
|
+
# @return [true]
|
56
|
+
#
|
57
|
+
# @version SketchUp 2017
|
58
|
+
def cancel
|
59
|
+
end
|
60
|
+
|
61
|
+
# Returns the http headers that are going to be used when sending the request.
|
62
|
+
#
|
63
|
+
# @example
|
64
|
+
# request = Sketchup::Http::Request.new("http://localhost:8080")
|
65
|
+
# request.headers = { :key1 => "value1", :key2 => "value2" }
|
66
|
+
#
|
67
|
+
# request.headers.each do |key, value|
|
68
|
+
# puts "#{key}: #{value}"
|
69
|
+
# end
|
70
|
+
#
|
71
|
+
# @return [Hash]
|
72
|
+
#
|
73
|
+
# @version SketchUp 2017
|
74
|
+
def headers
|
75
|
+
end
|
76
|
+
|
77
|
+
# Sets the http headers that are going to be used when sending the request.
|
78
|
+
#
|
79
|
+
# @example
|
80
|
+
# request = Sketchup::Http::Request.new("http://localhost:8080")
|
81
|
+
# request.headers = { :key1 => "value1", :key2 => "value2" }
|
82
|
+
#
|
83
|
+
# request.headers.each do |key, value|
|
84
|
+
# puts "#{key}: #{value}"
|
85
|
+
# end
|
86
|
+
#
|
87
|
+
# @param [Hash] headers
|
88
|
+
# A key/value pair hash.
|
89
|
+
#
|
90
|
+
# @return [Boolean]
|
91
|
+
#
|
92
|
+
# @version SketchUp 2017
|
93
|
+
def headers=(headers)
|
94
|
+
end
|
95
|
+
|
96
|
+
# The new method is used to create a new Sketchup::Http::Request.
|
97
|
+
#
|
98
|
+
# The default port is 80, to use a different port define it in the URL when
|
99
|
+
# creating a new Http::Request
|
100
|
+
#
|
101
|
+
# Keeping a reference to the request is necessary in order to ensure the use of
|
102
|
+
# the response.
|
103
|
+
#
|
104
|
+
# The +method+ parameter accepts any custom http method or one of the
|
105
|
+
# following:
|
106
|
+
# * +Sketchup::Http::GET+
|
107
|
+
# * +Sketchup::Http::POST+
|
108
|
+
# * +Sketchup::Http::PUT+
|
109
|
+
# * +Sketchup::Http::DELETE+
|
110
|
+
# * +Sketchup::Http::HEAD+
|
111
|
+
# * +Sketchup::Http::OPTIONS+
|
112
|
+
#
|
113
|
+
# @example
|
114
|
+
# request = Sketchup::Http::Request.new("http://localhost:8080", Sketchup::Http::GET)
|
115
|
+
#
|
116
|
+
# request.start do |request, response|
|
117
|
+
# puts "body: #{response.body}"
|
118
|
+
# end
|
119
|
+
#
|
120
|
+
# @param [String] url
|
121
|
+
# The targetted URL.
|
122
|
+
#
|
123
|
+
# @param [String] method
|
124
|
+
# Optionally, the request method to use, the
|
125
|
+
# default is Sketchup::Http::GET
|
126
|
+
#
|
127
|
+
# @return [Request]
|
128
|
+
#
|
129
|
+
# @version SketchUp 2017
|
130
|
+
def initialize(url, method)
|
131
|
+
end
|
132
|
+
|
133
|
+
# Returns the http method that is going to be used when sending the request.
|
134
|
+
#
|
135
|
+
# @example
|
136
|
+
# request = Sketchup::Http::Request.new("http://localhost:8080")
|
137
|
+
#
|
138
|
+
# request.start do |request, response|
|
139
|
+
# puts "request.method: #{request.method}"
|
140
|
+
# end
|
141
|
+
#
|
142
|
+
# @return [String]
|
143
|
+
#
|
144
|
+
# @version SketchUp 2017
|
145
|
+
def method
|
146
|
+
end
|
147
|
+
|
148
|
+
# Sets the http method that is going to be used when sending the request.
|
149
|
+
# The value can be any custom http method or one of the following:
|
150
|
+
# * +Sketchup::Http::GET+
|
151
|
+
# * +Sketchup::Http::POST+
|
152
|
+
# * +Sketchup::Http::PUT+
|
153
|
+
# * +Sketchup::Http::DELETE+
|
154
|
+
# * +Sketchup::Http::HEAD+
|
155
|
+
# * +Sketchup::Http::OPTIONS+
|
156
|
+
#
|
157
|
+
# @example
|
158
|
+
# request = Sketchup::Http::Request.new("http://localhost:8080")
|
159
|
+
# request.method = Sketchup::Http::POST
|
160
|
+
#
|
161
|
+
# request.start do |request, response|
|
162
|
+
# puts "request.method: #{request.method}"
|
163
|
+
# end
|
164
|
+
#
|
165
|
+
# @param [String] method
|
166
|
+
# A string containing the http method name.
|
167
|
+
#
|
168
|
+
# @return [Boolean]
|
169
|
+
#
|
170
|
+
# @version SketchUp 2017
|
171
|
+
def method=(method)
|
172
|
+
end
|
173
|
+
|
174
|
+
# Adds a download progress callback block that will get called everytime we
|
175
|
+
# have received data from the server until the download finishes.
|
176
|
+
#
|
177
|
+
# @example
|
178
|
+
# request = Sketchup::Http::Request.new("http://localhost:8080")
|
179
|
+
#
|
180
|
+
# request.set_download_progress_callback do |current, total|
|
181
|
+
# puts "download current: #{current}"
|
182
|
+
# puts "download total: #{total}"
|
183
|
+
# end
|
184
|
+
#
|
185
|
+
# request.start
|
186
|
+
#
|
187
|
+
# @return [Boolean]
|
188
|
+
#
|
189
|
+
# @version SketchUp 2017
|
190
|
+
#
|
191
|
+
# @yield A block to be invoked everytime data is downloaded from the server.
|
192
|
+
#
|
193
|
+
# @yieldparam [Integer] current
|
194
|
+
# Current bytes transferred.
|
195
|
+
#
|
196
|
+
# @yieldparam [Integer] total
|
197
|
+
# Total bytes to transfer.
|
198
|
+
def set_download_progress_callback
|
199
|
+
end
|
200
|
+
|
201
|
+
# Adds a upload progress callback block that will get called everytime we have
|
202
|
+
# uploaded data to the server until the upload finishes.
|
203
|
+
#
|
204
|
+
# @example
|
205
|
+
# request = Sketchup::Http::Request.new("http://localhost:8080")
|
206
|
+
#
|
207
|
+
# request.set_upload_progress_callback do |current, total|
|
208
|
+
# puts "upload current: #{current}"
|
209
|
+
# puts "upload total: #{total}"
|
210
|
+
# end
|
211
|
+
#
|
212
|
+
# request.start
|
213
|
+
#
|
214
|
+
# @return [Boolean]
|
215
|
+
#
|
216
|
+
# @version SketchUp 2017
|
217
|
+
#
|
218
|
+
# @yield A block to be invoked everytime data is sent to the server.
|
219
|
+
#
|
220
|
+
# @yieldparam [Integer] current
|
221
|
+
# Current bytes transferred.
|
222
|
+
#
|
223
|
+
# @yieldparam [Integer] total
|
224
|
+
# Total bytes to transfer.
|
225
|
+
def set_upload_progress_callback
|
226
|
+
end
|
227
|
+
|
228
|
+
# Starts the request and optionally add a callback block.
|
229
|
+
#
|
230
|
+
# @example
|
231
|
+
# request = Sketchup::Http::Request.new("http://localhost:8080")
|
232
|
+
#
|
233
|
+
# request.start do |request, response|
|
234
|
+
# puts "body: #{response.body}"
|
235
|
+
# end
|
236
|
+
#
|
237
|
+
# @return [Boolean]
|
238
|
+
#
|
239
|
+
# @version SketchUp 2017
|
240
|
+
#
|
241
|
+
# @yield A block that is invoked when the request has finished.
|
242
|
+
#
|
243
|
+
# @yieldparam [Request] request
|
244
|
+
# The request object.
|
245
|
+
#
|
246
|
+
# @yieldparam [Response] response
|
247
|
+
# The response object, use this to read the
|
248
|
+
# server response.
|
249
|
+
def start
|
250
|
+
end
|
251
|
+
|
252
|
+
# Returns the internal status code. It can be one of the following:
|
253
|
+
# * +Sketchup::Http::STATUS_UNKNOWN+
|
254
|
+
# * +Sketchup::Http::STATUS_SUCCESS+
|
255
|
+
# * +Sketchup::Http::STATUS_PENDING+
|
256
|
+
# * +Sketchup::Http::STATUS_CANCELED+
|
257
|
+
# * +Sketchup::Http::STATUS_FAILED+
|
258
|
+
#
|
259
|
+
# @example
|
260
|
+
# request = Sketchup::Http::Request.new("http://localhost:8080")
|
261
|
+
# request.start
|
262
|
+
# puts "response.status: #{request.status}"
|
263
|
+
#
|
264
|
+
# @return [int]
|
265
|
+
#
|
266
|
+
# @version SketchUp 2017
|
267
|
+
def status
|
268
|
+
end
|
269
|
+
|
270
|
+
# Returns a copy of the Request's URL.
|
271
|
+
#
|
272
|
+
# @example
|
273
|
+
# request = Sketchup::Http::Request.new("http://localhost:8080")
|
274
|
+
#
|
275
|
+
# request.start do |request, response|
|
276
|
+
# puts "url: #{request.url}"
|
277
|
+
# end
|
278
|
+
#
|
279
|
+
# @return [String]
|
280
|
+
#
|
281
|
+
# @version SketchUp 2017
|
282
|
+
def url
|
283
|
+
end
|
284
|
+
|
285
|
+
end
|