Module: Flapjack::Gateways::JSONAPI::Methods::AssociationPatch

Defined in:
lib/flapjack/gateways/jsonapi/methods/association_patch.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
# File 'lib/flapjack/gateways/jsonapi/methods/association_patch.rb', line 11

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

  Flapjack::Gateways::JSONAPI::RESOURCE_CLASSES.each do |resource_class|
    resource = resource_class.short_model_name.plural

    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.patch.is_a?(TrueClass) && :singular.eql?(jd.number)
    }

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

    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}/relationships/#{link_name}" do
            operation :patch do
              key :description, link_data.descriptions[:patch]
              key :operationId, "replace_#{single}_#{link_name}"
              key :consumes, [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
              parameter do
                key :name, :data
                key :in, :body
                key :description, "#{link_name} association to replace for the #{single}"
                key :required, true
                schema do
                  key :"$ref", "#{link_type}Reference".to_sym
                end
              end
              response 204 do
                key :description, 'No Content; link update success'
              end
              response 403 do
                key :description, "Forbidden; no link id"
                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}/relationships/#{link_name}" do
            operation :patch do
              key :description, link_data.descriptions[:patch]
              key :operationId, "replace_#{single}_#{link_name}"
              key :consumes, [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
              parameter do
                key :name, :data
                key :in, :body
                key :description, "#{link_name} associations to replace for the #{single}"
                key :required, true
                schema do
                  key :type, :array
                  items do
                    key :"$ref", "#{link_type}Reference".to_sym
                  end
                end
              end
              response 204 do
                key :description, 'No Content; link update succeeded'
              end
              response 403 do
                key :description, "Forbidden; no link ids"
                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

    id_patt = if Flapjack::Data::Tag.eql?(resource_class)
      "\\S+"
    else
      Flapjack::UUID_RE
    end

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

    app.patch %r{^/#{resource}/(#{id_patt})/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)

      status 204

      assoc = jsonapi_links[assoc_name]

      assoc_ids, _ = wrapped_link_params(:association => assoc,
        :allow_nil => true)

      resource_class.lock(*assoc.lock_klasses) do
        resource = resource_class.find_by_id!(resource_id)

        if :multiple.eql?(assoc.number)
          current_assoc_ids = resource.send(assoc_name).ids.to_a
          to_remove = current_assoc_ids - assoc_ids
          to_add    = assoc_ids - current_assoc_ids
          resource.send(assoc_name).remove_ids(*to_remove) unless to_remove.empty?
          resource.send(assoc_name).add_ids(*to_add) unless to_add.empty?
        elsif :singular.eql?(assoc.number)
          if assoc_ids.nil?
            resource.send("#{assoc_name}=".to_sym, nil)
          else
            halt(err(403, "Trying to add multiple records to singular association '#{assoc_name}'")) if assoc_ids.size > 1
            value = assoc_ids.first.nil? ? nil : assoc.data_klass.find_by_id!(assoc_ids.first)
            resource.send("#{assoc_name}=".to_sym, value)
          end
        end
      end
    end
  end
end