flapjack 1.6.0 → 2.0.0b1

data/lib/flapjack/gateways/jsonapi/methods/resource_patch.rb

@@ -0,0 +1,239 @@
+#!/usr/bin/env ruby
+
+require 'sinatra/base'
+
+module Flapjack
+  module Gateways
+    class JSONAPI < Sinatra::Base
+      module Methods
+        module ResourcePatch
+
+          def self.registered(app)
+            app.helpers Flapjack::Gateways::JSONAPI::Helpers::Headers
+            app.helpers Flapjack::Gateways::JSONAPI::Helpers::Miscellaneous
+            app.helpers Flapjack::Gateways::JSONAPI::Helpers::Resources
+            app.helpers Flapjack::Gateways::JSONAPI::Helpers::Serialiser
+
+            Flapjack::Gateways::JSONAPI::RESOURCE_CLASSES.each do |resource_class|
+              jsonapi_method = resource_class.jsonapi_methods[:patch]
+
+              unless jsonapi_method.nil?
+
+                jsonapi_links = resource_class.jsonapi_associations
+
+                singular_links = jsonapi_links.select {|n, jd|
+                  jd.send(:patch).is_a?(TrueClass) && :singular.eql?(jd.number)
+                }
+
+                multiple_links = jsonapi_links.select {|n, jd|
+                  jd.send(:post).is_a?(TrueClass) && :multiple.eql?(jd.number)
+                }
+
+                resource = resource_class.short_model_name.plural
+
+                app.class_eval do
+                  single = resource_class.short_model_name.singular
+
+                  model_type = resource_class.short_model_name.name
+                  model_type_plural = model_type.pluralize
+
+                  model_type_update = "#{model_type}Update".to_sym
+
+                  swagger_path "/#{resource}/{#{single}_id}" do
+                    operation :patch do
+                      key :description, jsonapi_method.descriptions[:singular]
+                      key :operationId, "update_#{single}"
+                      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
+                        key :format, :uuid
+                      end
+                      parameter do
+                        key :name, :data
+                        key :in, :body
+                        key :description, "#{model_type} to update"
+                        key :required, true
+                        schema do
+                          key :"$ref", model_type_update
+                        end
+                      end
+                      response 204 do
+                        key :description, "No Content; #{model_type} update success"
+                      end
+                      response 403 do
+                        key :description, "Forbidden; invalid data"
+                        schema do
+                          key :'$ref', :Errors
+                        end
+                      end
+                      response 404 do
+                        key :description, "Not Found"
+                        schema do
+                          key :'$ref', :Errors
+                        end
+                      end
+                      response 409 do
+                        key :description, "Conflict; request id mismatch"
+                        schema do
+                          key :'$ref', :Errors
+                        end
+                      end
+                    end
+                  end
+
+                  swagger_path "/#{resource}" do
+                    operation :patch do
+                      key :description, jsonapi_method.descriptions[:multiple]
+                      key :operationId, "update_#{resource}"
+                      key :consumes, [JSONAPI_MEDIA_TYPE_BULK]
+                      parameter do
+                        key :name, :data
+                        key :in, :body
+                        key :description, "#{resource} to update"
+                        key :required, true
+                        schema do
+                          key :type, :array
+                          items do
+                            key :"$ref", model_type_update
+                          end
+                        end
+                      end
+                      response 204 do
+                        key :description, "No Content; #{resource} update succeeded"
+                      end
+                      response 403 do
+                        key :description, "Forbidden; invalid data"
+                        schema do
+                          key :'$ref', :Errors
+                        end
+                      end
+                      response 404 do
+                        key :description, "Not Found"
+                        schema do
+                          key :'$ref', :Errors
+                        end
+                      end
+                      response 409 do
+                        key :description, "Conflict; request id mismatch"
+                        schema do
+                          key :'$ref', :Errors
+                        end
+                      end
+                    end
+                  end
+                end
+
+                app.patch %r{^/#{resource}(?:/(.+))?$} do
+                  resource_id = params[:captures].nil? ? nil :
+                                  params[:captures].first
+                  status 204
+
+                  resources_data, _ = wrapped_params
+
+                  attributes = jsonapi_method.attributes || []
+
+                  validate_data(resources_data, :attributes => attributes,
+                    :singular_links => singular_links,
+                    :multiple_links => multiple_links)
+
+                  ids = resources_data.map {|d| d['id']}
+
+                  klasses_to_lock = resources_data.inject([]) do |memo, d|
+                    next memo unless d.has_key?('relationships')
+                    d['relationships'].each_pair do |k, v|
+                      assoc = jsonapi_links[k.to_sym]
+                      next if assoc.nil?
+                      memo |= assoc.lock_klasses
+                    end
+                    memo
+                  end
+
+                  jsonapi_type = resource_class.short_model_name.singular
+
+                  resource_class.jsonapi_lock_method(:patch, klasses_to_lock) do
+
+                    resources = if resource_id.nil?
+                      resources = resource_class.find_by_ids!(*ids)
+                    else
+                      halt(err(409, "Id path/data mismatch")) unless ids.nil? || ids.eql?([resource_id])
+                      [resource_class.find_by_id!(resource_id)]
+                    end
+
+                    resources_by_id = resources.each_with_object({}) {|r, o| o[r.id] = r }
+
+                    attribute_types = resource_class.attribute_types
+
+                    resource_links = resources_data.each_with_object({}) do |d, memo|
+                      r = resources_by_id[d['id']]
+                      rd = normalise_json_data(attribute_types, d['attributes'] || {})
+
+                      type = d['type']
+                      halt(err(409, "Resource missing data type")) if type.nil?
+                      halt(err(409, "Resource data type '#{type}' does not match endpoint type '#{jsonapi_type}'")) unless jsonapi_type.eql?(type)
+
+                      rd.each_pair do |att, value|
+                        next unless attributes.include?(att.to_sym)
+                        r.send("#{att}=".to_sym, value)
+                      end
+                      halt(err(403, "Validation failed, " + r.errors.full_messages.join(', '))) if r.invalid?
+
+                      links = d['relationships']
+                      next if links.nil?
+
+                      singular_links.each_pair do |assoc, assoc_klass|
+                        next unless links.has_key?(assoc.to_s)
+                        memo[r.id] ||= {}
+                        memo[r.id][assoc.to_s] = assoc_klass.data_klass.find_by_id!(links[assoc.to_s]['data']['id'])
+                      end
+
+                      multiple_links.each_pair do |assoc, assoc_klass|
+                        next unless links.has_key?(assoc.to_s)
+                        current_assoc_ids = r.send(assoc.to_sym).ids.to_a
+                        memo[r.id] ||= {}
+
+                        link_ids = links[assoc.to_s]['data'].map {|l| l['id']}
+
+                        to_remove = current_assoc_ids - link_ids
+                        to_add    = link_ids - current_assoc_ids
+
+                        memo[r.id][assoc] = [
+                          to_remove.empty? ? [] : assoc_klass.data_klass.find_by_ids!(*to_remove),
+                          to_add.empty?    ? [] : assoc_klass.data_klass.find_by_ids!(*to_add)
+                        ]
+                      end
+                    end
+
+                    resources_by_id.each do |r_id, r|
+                      r.save!
+                      rl = resource_links[r_id]
+                      next if rl.nil?
+                      rl.each_pair do |assoc, value|
+                        case value
+                        when Array
+                          to_remove = value.first
+                          to_add    = value.last
+
+                          r.send(assoc.to_sym).remove(*to_remove) unless to_remove.empty?
+                          r.send(assoc.to_sym).add(*to_add) unless to_add.empty?
+                        else
+                          r.send("#{assoc}=".to_sym, value)
+                        end
+                      end
+                    end
+
+                  end
+
+                  true
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/flapjack/gateways/jsonapi/methods/resource_post.rb

@@ -0,0 +1,197 @@
+#!/usr/bin/env ruby
+
+require 'sinatra/base'
+
+module Flapjack
+  module Gateways
+    class JSONAPI < Sinatra::Base
+      module Methods
+        module ResourcePost
+
+          # module Helpers
+          # end
+
+          def self.registered(app)
+            app.helpers Flapjack::Gateways::JSONAPI::Helpers::Headers
+            app.helpers Flapjack::Gateways::JSONAPI::Helpers::Miscellaneous
+            app.helpers Flapjack::Gateways::JSONAPI::Helpers::Resources
+            app.helpers Flapjack::Gateways::JSONAPI::Helpers::Serialiser
+            # app.helpers Flapjack::Gateways::JSONAPI::Methods::ResourcePost::Helpers
+
+            Flapjack::Gateways::JSONAPI::RESOURCE_CLASSES.each do |resource_class|
+              jsonapi_method = resource_class.jsonapi_methods[:post]
+
+              unless jsonapi_method.nil?
+                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.send(:post).is_a?(TrueClass) && :singular.eql?(jd.number)
+                }
+
+                multiple_links = jsonapi_links.select {|n, jd|
+                  jd.send(:post).is_a?(TrueClass) && :multiple.eql?(jd.number)
+                }
+
+                app.class_eval do
+                  single = resource_class.short_model_name.singular
+
+                  model_type = resource_class.short_model_name.name
+                  model_type_create = "#{model_type}Create".to_sym
+                  model_type_data = "data_#{model_type}".to_sym
+
+                  # TODO how to include plural for same route? swagger won't overload...
+
+                  swagger_path "/#{resource}" do
+                    operation :post do
+                      key :description, jsonapi_method.descriptions[:singular]
+                      key :operationId, "create_#{single}"
+                      key :consumes, [JSONAPI_MEDIA_TYPE]
+                      key :produces, [Flapjack::Gateways::JSONAPI.media_type_produced]
+                      parameter do
+                        key :name, :data
+                        key :in, :body
+                        key :description, "#{single} to create"
+                        key :required, true
+                        schema do
+                          key :"$ref", model_type_create
+                        end
+                      end
+                      response 200 do
+                        key :description, "#{single} creation success"
+                        schema do
+                          key :'$ref', model_type_data
+                        end
+                      end
+                      response 403 do
+                        key :description, "Forbidden; invalid data"
+                        schema do
+                          key :'$ref', :Errors
+                        end
+                      end
+                      response 409 do
+                        key :description, "Conflict; bad request structure"
+                        schema do
+                          key :'$ref', :Errors
+                        end
+                      end
+                    end
+                  end
+
+                end
+
+                app.post "/#{resource}" do
+                  status 201
+
+                  resources_data, unwrap = wrapped_params
+
+                  attributes = jsonapi_method.attributes || []
+
+                  validate_data(resources_data, :attributes => attributes,
+                    :singular_links => singular_links,
+                    :multiple_links => multiple_links)
+
+                  resources = nil
+
+                  data_ids = resources_data.each_with_object([]) do |d, memo|
+                    d_id = d['id']
+                    memo << d_id.to_s unless d_id.nil?
+                  end
+
+                  klasses_to_lock = resources_data.inject([]) do |memo, d|
+                    next memo unless d.has_key?('relationships')
+                    d['relationships'].each_pair do |k, v|
+                      assoc = jsonapi_links[k.to_sym]
+                      next if assoc.nil?
+                      memo |= assoc.lock_klasses
+                    end
+                    memo
+                  end
+
+                  attribute_types = resource_class.attribute_types
+
+                  jsonapi_type = resource_class.short_model_name.singular
+
+                  resource_class.jsonapi_lock_method(:post, klasses_to_lock) do
+
+                    unless data_ids.empty? || resource_class.included_modules.include?(Zermelo::Records::Stub)
+                      conflicted_ids = resource_class.intersect(:id => data_ids).ids
+                      halt(err(409, "#{resource_class.name.split('::').last.pluralize} already exist with the following ids: " +
+                               conflicted_ids.to_a.join(', '))) unless conflicted_ids.empty?
+                    end
+                    links_by_resource = resources_data.each_with_object({}) do |rd, memo|
+                      record_data = rd['attributes'].nil? ? {} :
+                        normalise_json_data(attribute_types, rd['attributes'])
+                      type = rd['type']
+                      halt(err(409, "Resource missing data type")) if type.nil?
+                      halt(err(409, "Resource data type '#{type}' does not match endpoint '#{jsonapi_type}'")) unless jsonapi_type.eql?(type)
+                      r_id = rd['id']
+                      record_data[:id] = r_id unless r_id.nil?
+                      r = resource_class.new(record_data)
+
+                      # hacking in support for non-persisted objects
+                      case resource_class.name
+                      when Flapjack::Data::Acknowledgement.name, Flapjack::Data::TestNotification.name
+                        r.queue = config['processor_queue'] || 'events'
+                      end
+
+                      halt(err(403, "Validation failed, " + r.errors.full_messages.join(', '))) if r.invalid?
+                      memo[r] = rd['relationships']
+                    end
+
+                    # get linked objects, fail before save if we don't find them
+                    resource_links = links_by_resource.each_with_object({}) do |(r, links), memo|
+                      next if links.nil?
+
+                      singular_links.each_pair do |assoc, assoc_klass|
+                        next unless links.has_key?(assoc.to_s)
+                        memo[r.object_id] ||= {}
+                        memo[r.object_id][assoc.to_s] = assoc_klass.data_klass.find_by_id!(links[assoc.to_s]['data']['id'])
+                      end
+
+                      multiple_links.each_pair do |assoc, assoc_klass|
+                        next unless links.has_key?(assoc.to_s)
+                        memo[r.object_id] ||= {}
+                        memo[r.object_id][assoc.to_s] = assoc_klass.data_klass.find_by_ids!(*(links[assoc.to_s]['data'].map {|l| l['id']}))
+                      end
+                    end
+
+                    links_by_resource.keys.each do |r|
+                      r.save!
+                      rl = resource_links[r.object_id]
+                      next if rl.nil?
+                      rl.each_pair do |assoc, value|
+                        case value
+                        when Array
+                          r.send(assoc.to_sym).add(*value) unless value.empty?
+                        else
+                          r.send("#{assoc}=".to_sym, value)
+                        end
+                      end
+                    end
+                    resources = links_by_resource.keys
+                  end
+
+                  resource_ids = resources.map(&:id)
+
+                  response.headers['Location'] = "#{request.base_url}/#{resource}/#{resource_ids.join(',')}"
+
+                  ajs = as_jsonapi(resource_class, resources, resource_ids,
+                                   :unwrap => unwrap, :query_type => :resource)
+
+                  Flapjack.dump_json(ajs)
+                end
+              end
+
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/flapjack/gateways/jsonapi/middleware/array_param_fixer.rb

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+
+require 'rack'
+
+# Hat-tip to https://github.com/glasnt for the suggestion
+
+module Flapjack
+  module Gateways
+    class JSONAPI < Sinatra::Base
+      module Middleware
+        class ArrayParamFixer < Struct.new(:app)
+          def call(env)
+            if (env["REQUEST_METHOD"] == 'GET') && env["rack.request.query_string"].nil?
+              qs = env["QUERY_STRING"]
+              fixed_qs = qs.to_s.sub(/^filter=/, "filter[]=")
+                                .gsub(/&filter=/, "&filter[]=")
+
+              env["rack.request.query_string"] = qs # avoid Rack re-parsing it
+              env["rack.request.query_hash"]   = ::Rack::Utils.parse_nested_query(fixed_qs)
+            end
+            app.call(env)
+          end
+        end
+      end
+    end
+  end
+end