/
resource.rb
203 lines (180 loc) · 5.95 KB
/
resource.rb
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
require 'springboard/client/collection'
module Springboard
class Client
##
# An representation of an API resource identified by a URI. Allows
# triggering API calls via HTTP methods. Allows constructing new resources
# in a chained style by calling the methods that manipulate the URI and
# return a new resource.
#
# @example Chaining
# new_resource = resource.
# filter(:field => 'value').
# sort(:id).
# embed(:related_resource)
#
# Resources are usually constructed via the Client#[] method.
class Resource
##
# The resource's URI.
#
# @return [URI]
attr_reader :uri
##
# The underlying Springboard Client.
#
# @return [Client]
attr_reader :client
##
# @param [Springboard::Client] client
# @param [URI, #to_s] uri
def initialize(client, uri)
@client = client
@uri = URI.join(client.base_uri, client.base_uri.path + '/', uri)
end
##
# Performs a HEAD request against the resource's URI and returns the Response.
#
# @return [Response]
def head(headers=false); call_client(:head, headers); end
##
# Performs a HEAD request against the resource's URI. Returns the Response
# on success and raises a RequestFailed on failure..
#
# @raise [RequestFailed] On error response
#
# @return [Response]
def head!(headers=false); call_client(:head!, headers); end
##
# Performs a GET request against the resource's URI and returns the Response.
#
# @return [Response]
def get(headers=false); call_client(:get, headers); end
##
# Performs a GET request against the resource's URI. Returns the Response
# on success and raises a RequestFailed on failure.
#
# @raise [RequestFailed] On error response
#
# @return [Response]
def get!(headers=false); call_client(:get!, headers); end
##
# Performs a DELETE request against the resource's URI and returns the Response.
#
# @return [Response]
def delete(headers=false); call_client(:delete, headers); end
##
# Performs a DELETE request against the resource's URI. Returns the Response
# on success and raises a RequestFailed on failure.
#
# @raise [RequestFailed] On error response
#
# @return [Response]
def delete!(headers=false); call_client(:delete!, headers); end
##
# Performs a PUT request against the resource's URI and returns the Response.
#
# @return [Response]
def put(body, headers=false); call_client(:put, body, headers); end
##
# Performs a PUT request against the resource's URI. Returns the Response
# on success and raises a RequestFailed on failure.
#
# @raise [RequestFailed] On error response
#
# @return [Response]
def put!(body, headers=false); call_client(:put!, body, headers); end
##
# Performs a POST request against the resource's URI and returns the Response.
#
# @return [Response]
def post(body, headers=false); call_client(:post, body, headers); end
##
# Performs a POST request against the resource's URI. Returns the Response
# on success and raises a RequestFailed on failure.
#
# @raise [RequestFailed] On error response
#
# @return [Response]
def post!(body, headers=false); call_client(:post!, body, headers); end
##
# Returns a new subordinate resource with the given sub-path.
#
# @return [Resource]
def [](subpath)
clone(URI.join(uri, uri.path + '/', subpath))
end
##
# If called with +params+ as a +Hash+:
#
# Returns a new resource where the given query hash
# is merged with the existing query string parameters.
#
# If called with no arguments:
#
# Returns the resource's current query string parameters and values
# as a hash.
#
# @return [Resource, Hash]
##
# @overload query(params)
# Returns a new resource where the given +params+ hash of parameter
# names and values is merged with the existing query string parameters.
#
# @param [Hash] params New query string parameters
# @return [Resource]
#
# @overload query()
# Returns the resource's current query string parameters and values
# as a hash.
#
# @return [Hash]
def query(params=nil)
if params
clone(URIHelpers.merge_query_params(uri, params))
else
URIHelpers.query_to_hash(uri)
end
end
alias params query
##
# Returns a cloned copy of the resource with the same URI.
#
# @return [Resource]
def clone(uri=nil)
self.class.new(client, uri ? uri : self.uri)
end
##
# Returns a new resource with the given embeds added to the query string
# (via _include params).
#
# @return [Resource]
def embed(*embeds)
embeds = (query['_include'] || []) + embeds
query('_include' => embeds)
end
##
# Returns true if a HEAD request to the resource returns a successful response,
# false if it returns 404, otherwise raises an exception.
#
# @raise [RequestFailed] If response is not success or 404
#
# @return [Boolean]
def exists?
response = head
return true if response.success?
return false if response.status == 404
error = RequestFailed.new "Request during call to 'exists?' resulted in non-404 error."
error.response = response
raise error
end
include Collection
private
##
# Calls a client method, passing the URI as the first argument.
def call_client(method, *args, &block)
client.__send__(method, *args.unshift(uri), &block)
end
end
end
end