flapjack 1.6.0 → 2.0.0b1

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

@@ -0,0 +1,116 @@
+#!/usr/bin/env ruby
+
+require 'sinatra/base'
+
+module Flapjack
+  module Gateways
+    class JSONAPI < Sinatra::Base
+      module Methods
+        module AssociationPost
+
+          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
+
+              post_links = jsonapi_links.select {|n, jd|
+                jd.post.is_a?(TrueClass) && jd.link.is_a?(TrueClass) && :multiple.eql?(jd.number)
+              }
+
+              unless post_links.empty?
+                app.class_eval do
+
+                  single = resource.singularize
+
+                  post_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 :post do
+                        key :description, link_data.descriptions[:post]
+                        key :operationId, "add_#{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} to associate with 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 creation success'
+                        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.post %r{^/#{resource}/(#{id_patt})/relationships/(#{assoc_patt})$} do
+                resource_id = params[:captures][0]
+                assoc_name  = params[:captures][1].to_sym
+
+                halt(404) unless post_links.has_key?(assoc_name)
+
+                status 204
+
+                assoc = post_links[assoc_name.to_sym]
+
+                assoc_ids, _ = wrapped_link_params(:association => assoc)
+
+                halt(err(403, 'No link ids')) if assoc_ids.empty?
+                resource_class.lock(*assoc.lock_klasses) do
+                  # Not checking for duplication on adding existing to a multiple
+                  # association, the JSONAPI spec doesn't ask for it
+                  resource_obj = resource_class.find_by_id!(resource_id)
+                  resource_obj.send(assoc_name.to_sym).add_ids(*assoc_ids)
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,71 @@
+#!/usr/bin/env ruby
+
+require 'sinatra/base'
+
+require 'flapjack/data/metrics'
+
+module Flapjack
+  module Gateways
+    class JSONAPI < Sinatra::Base
+      module Methods
+        module Metrics
+
+          # 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::Methods::Metrics::Helpers
+
+            app.class_eval do
+
+              swagger_path "/metrics" do
+                operation :get do
+                  key :description, "Get metrics"
+                  key :operationId, "get_metrics"
+                  key :produces, [Flapjack::Gateways::JSONAPI.media_type_produced]
+                  parameter do
+                    key :name, :fields
+                    key :in, :query
+                    key :description, 'Comma-separated list of fields to return'
+                    key :required, false
+                    key :type, :string
+                  end
+                  response 200 do
+                    key :description, "GET metrics response"
+                    schema do
+                      key :'$ref', :data_Metrics
+                    end
+                  end
+                end
+              end
+            end
+
+            app.get %r{^/metrics$} do
+              fields = params[:fields]
+              fields = [fields] unless fields.nil? || fields.is_a?(Array)
+
+              whitelist = Flapjack::Data::Metrics.jsonapi_methods[:get].attributes
+
+              jsonapi_fields = if fields.nil?
+                whitelist
+              else
+                Set.new(fields).keep_if {|f| whitelist.include?(f.to_sym) }.to_a
+              end
+
+              metrics = Flapjack::Data::Metrics.new
+              result = Hash[ *(jsonapi_fields.collect{|f| [f, metrics.send(f.to_sym)]}.flatten) ]
+              Flapjack.dump_json(:data => {
+                :id => SecureRandom.uuid,
+                :type => 'metrics',
+                :attributes => result
+              })
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,119 @@
+#!/usr/bin/env ruby
+
+require 'sinatra/base'
+
+module Flapjack
+  module Gateways
+    class JSONAPI < Sinatra::Base
+      module Methods
+        module ResourceDelete
+
+          module Helpers
+            def resource_delete(klass, id)
+              resources_data, _ = wrapped_params(:allow_nil => !id.nil?)
+
+              ids = resources_data.nil? ? [id] : resources_data.map {|d| d['id']}
+
+              klass.jsonapi_lock_method(:delete) do
+                if id.nil?
+                  resources = klass.intersect(:id => ids)
+                  halt(err(404, "Could not find all records to delete")) unless resources.count == ids.size
+                  resources.destroy_all
+                else
+                  klass.find_by_id!(id).destroy
+                end
+              end
+
+              true
+            end
+          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::ResourceDelete::Helpers
+
+            Flapjack::Gateways::JSONAPI::RESOURCE_CLASSES.each do |resource_class|
+
+              jsonapi_method = resource_class.jsonapi_methods[:delete]
+
+              unless jsonapi_method.nil?
+                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
+
+                  swagger_path "/#{resource}/{#{single}_id}" do
+                    operation :delete do
+                      key :description, jsonapi_method.descriptions[:singular]
+                      key :operationId, "delete_#{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
+                      response 204 do
+                        key :description, "No Content; #{model_type} deletion success"
+                      end
+                      response 404 do
+                        key :description, "Not Found"
+                        schema do
+                          key :'$ref', :Errors
+                        end
+                      end
+                    end
+                  end
+
+                  swagger_path "/#{resource}" do
+                    operation :delete do
+                      key :description, jsonapi_method.descriptions[:multiple]
+                      key :operationId, "delete_#{resource}"
+                      key :consumes, [JSONAPI_MEDIA_TYPE_BULK]
+                      parameter do
+                        key :name, :data
+                        key :in, :body
+                        key :description, "#{resource} to delete"
+                        key :required, true
+                        schema do
+                          key :type, :array
+                          items do
+                            key :"$ref", "#{model_type}Reference".to_sym
+                          end
+                        end
+                      end
+                      response 204 do
+                        key :description, "No Content; #{resource} deletion succeeded"
+                      end
+                      response 404 do
+                        key :description, "Not Found"
+                        schema do
+                          key :'$ref', :Error
+                        end
+                      end
+                    end
+                  end
+                end
+
+                app.delete %r{^/#{resource}(?:/(.+))?$} do
+                  resource_id = params[:captures].nil? ? nil :
+                                  params[:captures].first
+                  status 204
+
+                  resource_delete(resource_class, resource_id)
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,186 @@
+#!/usr/bin/env ruby
+
+require 'sinatra/base'
+
+module Flapjack
+  module Gateways
+    class JSONAPI < Sinatra::Base
+      module Methods
+        module ResourceGet
+
+          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[:get]
+
+              unless jsonapi_method.nil?
+                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_data = "data_#{model_type}".to_sym
+                  model_type_data_plural = "data_#{model_type_plural}".to_sym
+
+                  swagger_path "/#{resource}" do
+                    operation :get do
+                      key :description, jsonapi_method.descriptions[:multiple]
+                      key :operationId, "get_all_#{resource}"
+                      key :produces, [Flapjack::Gateways::JSONAPI.media_type_produced]
+                      parameter do
+                        key :name, :fields
+                        key :in, :query
+                        key :description, 'Comma-separated list of fields to return'
+                        key :required, false
+                        key :type, :string
+                      end
+                      parameter do
+                        key :name, :sort
+                        key :in, :query
+                        key :description, ''
+                        key :required, false
+                        key :type, :string
+                      end
+                      parameter do
+                        key :name, :filter
+                        key :in, :query
+                        key :description, ''
+                        key :required, false
+                        key :type, :array
+                        key :collectionFormat, :multi
+                        items do
+                          key :type, :string
+                          key :format, :filter
+                        end
+                      end
+                      parameter do
+                        key :name, :include
+                        key :in, :query
+                        key :description, ''
+                        key :required, false
+                        key :type, :string
+                      end
+                      parameter do
+                        key :name, :page
+                        key :in, :query
+                        key :description, 'Page number'
+                        key :required, false
+                        key :type, :integer
+                      end
+                      parameter do
+                        key :name, :per_page
+                        key :in, :query
+                        key :description, "Number of #{resource} per page"
+                        key :required, false
+                        key :type, :integer
+                      end
+                      response 200 do
+                        key :description, "GET #{resource} success"
+                        schema do
+                          key :'$ref', model_type_data_plural
+                        end
+                      end
+                    end
+                  end
+
+                  swagger_path "/#{resource}/{#{single}_id}" do
+                    operation :get do
+                      key :description, jsonapi_method.descriptions[:singular]
+                      key :operationId, "get_#{single}"
+                      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
+                        key :format, :uuid
+                      end
+                      parameter do
+                        key :name, :fields
+                        key :in, :query
+                        key :description, 'Comma-separated list of fields to return'
+                        key :required, false
+                        key :type, :string
+                      end
+                      response 200 do
+                        key :description, "GET #{single} response"
+                        schema do
+                          key :'$ref', model_type_data
+                        end
+                      end
+                      response 404 do
+                        key :description, "Not Found"
+                        schema do
+                          key :'$ref', :Errors
+                        end
+                      end
+                    end
+                  end
+                end
+
+                # FIXME return 400 if any 'include' param path not recognised
+
+                app.get %r{^/#{resource}(?:/(.+))?$} do
+                  resource_id = params[:captures].nil? ? nil :
+                                  params[:captures].first
+                  incl = params[:include].nil? ? nil : params[:include].split(',')
+
+                  locks = (incl.nil? || incl.empty?) ? [] :
+                    lock_for_include_clause(resource_class, :include => incl.dup)
+
+                  status 200
+
+                  json_data = {}
+
+                  resource_class.jsonapi_lock_method(:get, locks) do
+                    resources, links, meta = if resource_id.nil?
+                      scoped = resource_filter_sort(resource_class,
+                       :filter => params[:filter], :sort => params[:sort])
+                      paginate_get(scoped, :page => params[:page],
+                        :per_page => params[:per_page])
+                    else
+                      [resource_class.intersect(:id => Set.new([resource_id])), {}, {}]
+                    end
+
+                    links[:self] = request_url
+
+                    json_data[:links] = links
+
+                    if resources.empty?
+                      if resource_id.nil?
+                        json_data[:data] = []
+                      else
+                        raise ::Zermelo::Records::Errors::RecordNotFound.new(resource_class, resource_id)
+                      end
+                    else
+                      d = as_jsonapi(resource_class, resources,
+                                     (resource_id.nil? ? resources.ids : Set.new([resource_id])),
+                                     :fields => params[:fields], :include => incl,
+                                     :unwrap => !resource_id.nil?, :query_type => :resource)
+
+                      json_data[:data] = d[:data]
+                      unless d[:included].nil? || d[:included].empty?
+                        json_data[:included] = d[:included]
+                      end
+                      json_data[:meta] = meta unless meta.nil? || meta.empty?
+                    end
+                  end
+                  Flapjack.dump_json(json_data)
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end