insights-api-common 3.1.0 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b6498652170c68a06887694e324b8864d318390fc8e5f86f827cb310111c0c71
-  data.tar.gz: 36bf35a644fca5018e0e4a9870bf17d7db4e4b0bf6dde2edaf9e94d17730f653
+  metadata.gz: a539b3339e7b65eb26ab1920ab25bc151125250f80a7d03e856981685323149d
+  data.tar.gz: 1f72cb479407b8407fc802d668641bcf6a05bdab3bc250dcab339694a8388e61
 SHA512:
-  metadata.gz: 1b7e883f0a2d5b617892e880ad061c044afa56644e0a2e4da05e7069b45adec29e1a027e9215c001e086dc7d0fddeec0c62d3a110a63e358cb8bdea321ce9155
-  data.tar.gz: c12ce153ce3acfcf141a51609f93f62209c954305070b8fa24574190080e27f032f5b5ca42dbe04e88fbc3109d871570d48522f31b6d98d0077ee0531ee62c9d
+  metadata.gz: 5b6c6bc264eff66c71a00e9147217c93cf4681d97d1694c3145e78b9f3576f70bfec6f1a7c40f1baa94573970bd4250e07eb5bd1fe55b6239142559f21c8fc8a
+  data.tar.gz: 7922ce22df6e493ca3b45d2853450f887fc2679011c1d23542d8519d0f531d273ba29b9c27e6ca3f4ad3a0353497fb544f0de8340ba815634cfde9f734f9704f

data/lib/insights/api/common/application_controller_mixins/request_body_validation.rb

@@ -17,10 +17,13 @@ module Insights
           private
 
           def body_params
-            @body_params ||= begin
-              raw_body    = request.body.read
-              parsed_body = raw_body.blank? ? {} : JSON.parse(raw_body)
-              ActionController::Parameters.new(parsed_body).permit!
+            @body_params ||= ActionController::Parameters.new(parsed_body).permit!
+          end
+
+          def parsed_body
+            @parsed_body ||= begin
+              request_body = request.body.read
+              request_body.blank? ? {} : JSON.parse(request_body)
             rescue JSON::ParserError
               raise Insights::API::Common::ApplicationControllerMixins::RequestBodyValidation::BodyParseError, "Failed to parse request body, expected JSON"
             end
@@ -38,7 +41,7 @@ module Insights
               request.method,
               request.path,
               api_version,
-              body_params.as_json
+              parsed_body
             )
           end
         end

data/lib/insights/api/common/open_api/generator.rb

@@ -304,20 +304,59 @@ module Insights
             }
           end
 
+          def openapi_tag_description(klass_name)
+            {
+              "summary"     => "Tag a #{klass_name}",
+              "operationId" => "tag#{klass_name}",
+              "description" => "Tags a #{klass_name} object",
+              "parameters"  => [
+                { "$ref" => build_parameter("ID") }
+              ],
+              "requestBody" => request_body("Tag", "add", :single => false),
+              "responses"   => {
+                "201" => {
+                  "description" => "#{klass_name} tagged successful",
+                  "content"     => {
+                    "application/json" => {
+                      "schema" => {
+                        "type"  => "array",
+                        "items" => {
+                          "$ref" => build_schema("Tag")
+                        }
+                      }
+                    }
+                  }
+                },
+                "304" => {
+                  "description" => "Not modified"
+                }
+              }
+            }
+          end
+
+          def openapi_untag_description(klass_name)
+            {
+              "summary"     => "Untag a #{klass_name}",
+              "operationId" => "untag#{klass_name}",
+              "description" => "Untags a #{klass_name} object",
+              "parameters"  => [
+                { "$ref" => build_parameter("ID") }
+              ],
+              "requestBody" => request_body("Tag", "removed", :single => false),
+              "responses"   => {
+                "204" => {
+                  "description" => "#{klass_name} untagged successfully",
+                }
+              }
+            }
+          end
+
           def openapi_create_description(klass_name)
             {
               "summary"     => "Create a new #{klass_name}",
               "operationId" => "create#{klass_name}",
               "description" => "Creates a #{klass_name} object",
-              "requestBody" => {
-                "content"     => {
-                  "application/json" => {
-                    "schema" => { "$ref" => build_schema(klass_name) }
-                  }
-                },
-                "description" => "#{klass_name} attributes to create",
-                "required"    => true
-              },
+              "requestBody" => request_body(klass_name, "create"),
               "responses"   => {
                 "201" => {
                   "description" => "#{klass_name} creation successful",
@@ -331,6 +370,20 @@ module Insights
             }
           end
 
+          def request_body(klass_name, action, single: true)
+            schema = single ? { "$ref" => build_schema(klass_name) } : {"type" => "array", "items" => {"$ref" => build_schema(klass_name)}}
+
+            {
+              "content"     => {
+                "application/json" => {
+                  "schema" => schema
+                }
+              },
+              "description" => "#{klass_name} attributes to #{action}",
+              "required"    => true
+            }
+          end
+
           def openapi_update_description(klass_name, verb)
             action = verb == "patch" ? "Update" : "Replace"
             {
@@ -340,15 +393,7 @@ module Insights
               "parameters"  => [
                 { "$ref" => build_parameter("ID") }
               ],
-              "requestBody" => {
-                "content"     => {
-                  "application/json" => {
-                    "schema" => { "$ref" => build_schema(klass_name) }
-                  }
-                },
-                "description" => "#{klass_name} attributes to update",
-                "required"    => true
-              },
+              "requestBody" => request_body(klass_name, "update"),
               "responses"   => {
                 "204" => { "description" => "Updated, no content" },
                 "400" => { "description" => "Bad request"         },
@@ -490,6 +535,8 @@ module Insights
                 when "destroy" then openapi_destroy_description(klass_name)
                 when "create"  then openapi_create_description(klass_name)
                 when "update"  then openapi_update_description(klass_name, verb)
+                when "tag"     then openapi_tag_description(primary_collection)
+                when "untag"   then openapi_untag_description(primary_collection)
                 else handle_custom_route_action(route.action.camelize, verb, primary_collection)
                 end
 

data/lib/insights/api/common/version.rb

@@ -1,7 +1,7 @@
 module Insights
   module API
     module Common
-      VERSION = "3.1.0".freeze
+      VERSION = "3.2.0".freeze
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: insights-api-common
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.2.0
 platform: ruby
 authors:
 - Insights Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-13 00:00:00.000000000 Z
+date: 2019-12-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: acts_as_tenant