Module: Flapjack::Gateways::JSONAPI::Methods::AssociationGet

Defined in:
lib/flapjack/gateways/jsonapi/methods/association_get.rb

Class Method Summary collapse

Class Method Details

.registered(app) ⇒ Object



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
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
# File 'lib/flapjack/gateways/jsonapi/methods/association_get.rb', line 11

def self.registered(app)
  app.helpers Flapjack::Gateways::JSONAPI::Helpers::Headers
  app.helpers Flapjack::Gateways::JSONAPI::Helpers::Miscellaneous
  app.helpers Flapjack::Gateways::JSONAPI::Helpers::Serialiser

  Flapjack::Gateways::JSONAPI::RESOURCE_CLASSES.each do |resource_class|

    jsonapi_links = if resource_class.respond_to?(:jsonapi_associations)
      resource_class.jsonapi_associations || {}
    else
      {}
    end

    singular_links = jsonapi_links.select {|n, jd|
      jd.link.is_a?(TrueClass) && jd.get.is_a?(TrueClass) && :singular.eql?(jd.number)
    }

    multiple_links = jsonapi_links.select {|n, jd|
      jd.link.is_a?(TrueClass) && jd.get.is_a?(TrueClass) && :multiple.eql?(jd.number)
    }

    resource = resource_class.short_model_name.plural

    unless singular_links.empty? && multiple_links.empty?

      app.class_eval do
        # GET and PATCH duplicate a lot of swagger code, but swagger-blocks
        # make it difficult to DRY things due to the different contexts in use
        single = resource.singularize

        singular_links.each_pair do |link_name, link_data|
          link_type = link_data.data_klass.short_model_name.name

          swagger_path "/#{resource}/{#{single}_id}/#{link_name}" do
            operation :get do
              key :description, link_data.descriptions[:get]
              key :operationId, "get_#{single}_#{link_name}"
              key :produces, [Flapjack::Gateways::JSONAPI.media_type_produced]
              parameter do
                key :name, "#{single}_id".to_sym
                key :in, :path
                key :description, "Id of a #{single}"
                key :required, true
                key :type, :string
              end
              response 200 do
                key :description, "GET #{resource} #{link_name} success"
                schema do
                  key :"$ref", "#{link_type}Reference".to_sym
                end
              end
              response 403 do
                key :description, "Forbidden; invalid request"
                schema do
                  key :'$ref', :Errors
                end
              end
              response 404 do
                key :description, "Not Found"
                schema do
                  key :'$ref', :Errors
                end
              end
            end
          end

          swagger_path "/#{resource}/{#{single}_id}/relationships/#{link_name}" do
            operation :get do
              key :description, link_data.descriptions[:get]
              key :operationId, "get_#{single}_#{link_name}"
              key :produces, [JSONAPI_MEDIA_TYPE]
              parameter do
                key :name, "#{single}_id".to_sym
                key :in, :path
                key :description, "Id of a #{single}"
                key :required, true
                key :type, :string
              end
              response 200 do
                key :description, "GET #{resource} success"
                schema do
                  key :"$ref", "#{link_type}Reference".to_sym
                end
              end
              response 403 do
                key :description, "Forbidden; invalid request"
                schema do
                  key :'$ref', :Errors
                end
              end
              response 404 do
                key :description, "Not Found"
                schema do
                  key :'$ref', :Errors
                end
              end
            end
          end
        end

        multiple_links.each_pair do |link_name, link_data|
          link_type = link_data.data_klass.short_model_name.name
          swagger_path "/#{resource}/{#{single}_id}/#{link_name}" do
            operation :get do
              key :description, link_data.descriptions[:get]
              key :operationId, "get_#{single}_#{link_name}"
              key :produces, [Flapjack::Gateways::JSONAPI.media_type_produced]
              parameter do
                key :name, "#{single}_id".to_sym
                key :in, :path
                key :description, "Id of a #{single}"
                key :required, true
                key :type, :string
              end
              response 200 do
                key :description, "GET #{resource} response"
                schema do
                  key :type, :array
                  items do
                    key :"$ref", "#{link_type}Reference".to_sym
                  end
                end
              end
              response 403 do
                key :description, "Forbidden; invalid request"
                schema do
                  key :'$ref', :Errors
                end
              end
              response 404 do
                key :description, "Not Found"
                schema do
                  key :'$ref', :Errors
                end
              end
            end
          end
          swagger_path "/#{resource}/{#{single}_id}/relationships/#{link_name}" do
            operation :get do
              key :description, link_data.descriptions[:get]
              key :operationId, "get_#{single}_links_#{link_name}"
              key :produces, [Flapjack::Gateways::JSONAPI.media_type_produced]
              parameter do
                key :name, "#{single}_id".to_sym
                key :in, :path
                key :description, "Id of a #{single}"
                key :required, true
                key :type, :string
              end
              response 200 do
                key :description, "GET #{resource} response"
                schema do
                  key :type, :array
                  items do
                    key :"$ref", "#{link_type}Reference".to_sym
                  end
                end
              end
              response 403 do
                key :description, "Forbidden; invalid request"
                schema do
                  key :'$ref', :Errors
                end
              end
              response 404 do
                key :description, "Not Found"
                schema do
                  key :'$ref', :Errors
                end
              end
            end
          end
        end
      end
    end

    assoc_patt = jsonapi_links.keys.map(&:to_s).join("|")

    app.get %r{^/#{resource}/(#{Flapjack::UUID_RE})/(?:relationships/)?(#{assoc_patt})(\?.+)?} do
      resource_id = params[:captures][0]
      assoc_name  = params[:captures][1].to_sym

      halt(404) unless singular_links.has_key?(assoc_name) ||
        multiple_links.has_key?(assoc_name)

      fields = params[:fields]
      incl   = params[:include].nil? ? nil : params[:include].split(',')

      assoc = jsonapi_links[assoc_name]

      extra_locks = incl.nil? ? [] : lock_for_include_clause(resource_class,
              :include => incl.dup)

      locks = assoc.lock_klasses | extra_locks
      locks.sort_by!(&:name)

      status 200

      halt(err(404, 'Unknown relationship')) if assoc.nil?

      empty = false
      included = nil
      result = nil
      meta = nil

      resource_class.lock(*locks) do
        res = resource_class.intersect(:id => resource_id)
        empty = res.empty?

        unless empty
          associated = res.all.first.send(assoc_name)

          result = case assoc.number
          when :multiple

            unless params[:filter].nil?
              unless params[:filter].is_a?(Array)
                halt(err(403, "Filter parameters must be passed as an Array"))
              end

              bad = params[:filter].detect {|f| f !~ /^#{assoc_name}\.(?:[^,]+)$/ }
              unless bad.nil?
                halt(err(403, "Filter params must start with '#{assoc_name}.', not contain comma: '#{bad}'"))
              end

              filters = params[:filter].collect do |f|
                f.sub(/^#{assoc_name}\./, '')
              end

              filter_ops = filter_params(assoc.data_klass, filters)

              associated = associated.intersect(filter_ops)
            end

            associated = associated.sort(:id => :asc)

            resources, _, meta = paginate_get(associated, :page => params[:page],
              :per_page => params[:per_page])

            result = resources.eql?([]) ? [] : resources.ids
          when :singular
            result = associated.id
          end

          unless incl.nil?
            included = as_jsonapi_included(resource_class, res,
              :include => incl, :fields => fields, :query_type => :association)
          end
        end
      end
      raise ::Zermelo::Records::Errors::RecordNotFound.new(resource_class, resource_id) if empty

      links = {
        :self    => "#{request.base_url}/#{resource}/#{resource_id}/relationships/#{assoc_name}",
        :related => "#{request.base_url}/#{resource}/#{resource_id}/#{assoc_name}"
      }

      data = case result
      when Array, Set
        result.map {|assoc_id| {:type => assoc.type, :id => assoc_id} }
      when String
        {:type => assoc.type, :id => result}
      else
        nil
      end

      ret = {:data => data, :links => links}
      ret[:included] = included unless included.nil?
      ret[:meta] = meta unless meta.nil?
      Flapjack.dump_json(ret)
    end
  end
end