insights-api-common 3.4.2 → 3.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ad258a742daa759f81a9742e6a291ffdf8bca15172e8a763cb52948bf7253faf
-  data.tar.gz: f755ea957e54bdad59182ea343718f499e7e277bf478286ffcf6658cb59ec0d2
+  metadata.gz: f7c6702af3cef107f81d349b3995a33cb1fb29b1384bfa9c76ea18e997e9c418
+  data.tar.gz: 42a9b71481b07c97bbb8d327c98b21d9008786e5ebd8886cfc88dc498ec34f98
 SHA512:
-  metadata.gz: 9d9a280507a0298454ccbac04c07b19c4134cd6c5715196f5d6827ebeecdc7a09fe2bc02306615b3f4ad8fba2752c81eeb51c9cbba962d637d13842c66665656
-  data.tar.gz: ca2748daae7519f0e6b8d7ee82f215b4c3acbeda3c2727d30a85cef72c1d2fbe990e251e80db635200e1d40596cbed8d066fbd9c8d3e873f9416494e16973ef1
+  metadata.gz: 327d4de25378b3fc553af5989d8e922f07a8085dc9f0f73793154648bd93312144f10ccbe7c0b3ed9544febc14d3643c9e2dbd0a873abf085576299c71af7138
+  data.tar.gz: 3b79d627f4848aa40010e341fd77c3a828b2ca0d23c624f31a01fe6359cbdf6b46b0a1b96600da80df07a6518862102437e84fa1bde389b17ecb0525f2f933e5

data/app/models/concerns/insights/api/common/act_as_taggable_on.rb

@@ -0,0 +1,66 @@
+module Insights
+  module API
+    module Common
+      module ActAsTaggableOn
+        def acts_as_taggable_on
+          class_eval do
+            def self.tagging_relation_name
+              "#{name.underscore}_tags".to_sym
+            end
+
+            has_many tagging_relation_name
+            has_many :tags, :through => tagging_relation_name
+
+            def self.taggable?
+              true
+            end
+
+            def tag_list
+              tags.pluck(:name)
+            end
+
+            def tag_add(tag_list, options = {})
+              Tag.transaction do
+                model_tag_class.transaction do
+                  Array(tag_list).each do |tag_name|
+                    next if tagged_with?(tag_name, options)
+                    tag_params = {:name => tag_name, :tenant_id => tenant.id}
+                    tag_params.merge!(options)
+                    tag = Tag.find_or_create_by(tag_params)
+                    tagging_params = {self.class.name.underscore.to_sym => self, :tag_id => tag.id}
+                    public_send(self.class.tagging_relation_name).create(tagging_params)
+                  end
+                end
+              end
+            end
+
+            def tagged_with?(tag_name, options = {})
+              options[:value] ||= ""
+              options[:namespace] ||= ""
+              model_tag_class.joins(:tag)
+                             .exists?(:tags => {:name => tag_name, :namespace => options[:namespace], :value => options[:value]}, self.class.name.underscore.to_sym => self)
+            end
+
+            def tag_remove(tag_list, options = {})
+              options[:value] ||= ""
+              options[:namespace] ||= ""
+              Tag.joins(self.class.tagging_relation_name)
+                 .where(:name => Array(tag_list), :namespace => options[:namespace], :value => options[:value], self.class.tagging_relation_name => {self.class.name.underscore.to_sym => self})
+                 .destroy_all
+            end
+
+            def model_tag_class
+              self.class.tagging_relation_name.to_s.classify.constantize
+            end
+          end
+        end
+
+        def tagged_with(tag_name, options = {})
+          options[:value] ||= ""
+          options[:namespace] ||= ""
+          joins(tagging_relation_name => :tag).where(:tags => {:name => tag_name, :namespace => options[:namespace], :value => options[:value]})
+        end
+      end
+    end
+  end
+end

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

@@ -5,6 +5,7 @@ module Insights
         isolate_namespace Insights::API::Common
 
         config.autoload_paths << root.join("lib").to_s
+        config.autoload_paths << root.join("app/models/concerns").to_s
 
         initializer :load_inflections do
           Insights::API::Common::Inflections.load_inflections

data/lib/insights/api/common/open_api/docs/doc_v3.rb

@@ -66,8 +66,8 @@ module Insights
               end
             end
 
-            def base_path
-              @base_path ||= @content.fetch_path("servers", 0, "variables", "basePath", "default")
+            def server_base_path
+              @server_base_path ||= @content.fetch_path("servers", 0, "variables", "basePath", "default")
             end
 
             def paths
@@ -82,7 +82,7 @@ module Insights
               @routes ||= begin
                 paths.flat_map do |path, hash|
                   hash.collect do |verb, _details|
-                    p = File.join(base_path, path).gsub(/{\w*}/, ":id")
+                    p = File.join(server_base_path, path).gsub(/{\w*}/, ":id")
                     {:path => p, :verb => verb.upcase}
                   end
                 end

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

@@ -44,18 +44,18 @@ module Insights
           end
 
           def initialize
-            app_prefix, app_name = base_path.match(/\A(.*)\/(.*)\/v\d+.\d+\z/).captures
+            app_prefix, app_name = server_base_path.match(/\A(.*)\/(.*)\/v\d+.\d+\z/).captures
             ENV['APP_NAME'] = app_name
             ENV['PATH_PREFIX'] = app_prefix
             Rails.application.reload_routes!
           end
 
-          def base_path
+          def server_base_path
             openapi_contents["servers"].first["variables"]["basePath"]["default"]
           end
 
           def applicable_rails_routes
-            rails_routes.select { |i| i.path.start_with?(base_path) }
+            rails_routes.select { |i| i.path.start_with?(server_base_path) }
           end
 
           def schemas
@@ -520,7 +520,7 @@ module Insights
           def build_paths
             applicable_rails_routes.each_with_object({}) do |route, expected_paths|
               without_format     = route.path.split("(.:format)").first
-              sub_path           = without_format.split(base_path).last.sub(/:[_a-z]*id/, "{id}")
+              sub_path           = without_format.split(server_base_path).last.sub(/:[_a-z]*id/, "{id}")
               route_destination  = route.controller.split("/").last.camelize
               controller         = "Api::V#{api_version.sub(".", "x")}::#{route_destination}Controller".safe_constantize
               klass_name         = controller.try(:presentation_name) || route_destination.singularize

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

@@ -72,10 +72,22 @@ module Insights
           raise IdentityError, "x-rh-identity not found"
         end
 
+        def tenant
+          @tenant ||= Insights::API::Common::Tenant.new(identity).tenant
+        end
+
         def user
           @user ||= User.new(identity)
         end
 
+        def system
+          @system ||= System.new(identity) if identity.dig("identity", "system").present?
+        end
+
+        def auth_type
+          identity.dig("identity", "auth_type")
+        end
+
         def entitlement
           @entitlement ||= Entitlement.new(identity)
         end

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

@@ -0,0 +1,19 @@
+module Insights
+  module API
+    module Common
+      class System
+        def initialize(identity)
+          @system = identity.dig("identity", "system")
+        end
+
+        def cn
+          system["cn"]
+        end
+
+        private
+
+        attr_reader :system
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+module Insights
+  module API
+    module Common
+      class Tenant
+        def initialize(identity)
+          @identity = identity["identity"]
+        end
+
+        def tenant
+          result = identity&.dig("account_number")
+          raise IdentityError, "Tenant key doesn't exist" if result.nil?
+          result
+        end
+
+        private
+
+        attr_reader :identity
+      end
+    end
+  end
+end

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

@@ -24,6 +24,7 @@ module Insights
         end
 
         def tenant
+          ActiveSupport::Deprecation.warn("Please switch to request.tenant, request.user.tenant will be removed in a future release.")
           find_tenant_key
         end
 

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

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

data/spec/support/user_header_spec_helper.rb

@@ -23,7 +23,8 @@ module UserHeaderSpecHelper
     "identity" => {
       "account_number" => "0369233",
       "type"           => "User",
-      "user"     =>  {
+      "auth_type"      => "basic-auth",
+      "user"           =>  {
         "username"     => "jdoe",
         "email"        => "jdoe@acme.com",
         "first_name"   => "John",
@@ -33,9 +34,43 @@ module UserHeaderSpecHelper
         "is_internal"  => false,
         "locale"       => "en_US"
       },
-      "internal" => {
+      "internal"       => {
+        "org_id"    => "3340851",
+        "auth_time" => 6300
+      }
+    }
+  }.freeze
+
+  DEFAULT_SYSTEM = {
+    "entitlements" => {
+      "ansible"          => {
+        "is_entitled" => true
+      },
+      "hybrid_cloud"     => {
+        "is_entitled" => true
+      },
+      "insights"         => {
+        "is_entitled" => true
+      },
+      "migrations"       => {
+        "is_entitled" => true
+      },
+      "openshift"        => {
+        "is_entitled" => true
+      },
+      "smart_management" => {
+        "is_entitled" => true
+      }
+    },
+    "identity" => {
+      "account_number" => "0369233",
+      "type"           => "System",
+      "auth_type"      => "cert-auth",
+      "system"         => {
+        "cn" => "certificate"
+      },
+      "internal"       => {
         "org_id"    => "3340851",
-        "auth_type" => "basic-auth",
         "auth_time" => 6300
       }
     }
@@ -49,6 +84,14 @@ module UserHeaderSpecHelper
     default_user_hash["identity"]["user"]["username"]
   end
 
+  def default_auth_type
+    default_user_hash["identity"]["auth_type"]
+  end
+
+  def default_system_cn
+    default_system_hash["identity"]["system"]["cn"]
+  end
+
   def encode(val)
     if val.kind_of?(Hash)
       hashed = val.stringify_keys
@@ -62,7 +105,15 @@ module UserHeaderSpecHelper
     encode(hash || DEFAULT_USER)
   end
 
+  def encoded_system_hash(hash = nil)
+    encode(hash || DEFAULT_SYSTEM)
+  end
+
   def default_user_hash
     Marshal.load(Marshal.dump(DEFAULT_USER))
   end
+
+  def default_system_hash
+    Marshal.load(Marshal.dump(DEFAULT_SYSTEM))
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: insights-api-common
 version: !ruby/object:Gem::Version
-  version: 3.4.2
+  version: 3.5.0
 platform: ruby
 authors:
 - Insights Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-13 00:00:00.000000000 Z
+date: 2020-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: acts_as_tenant
@@ -315,6 +315,7 @@ files:
 - app/controllers/concerns/insights/api/common/tagging_methods.rb
 - app/models/authentication.rb
 - app/models/concerns/encryption_concern.rb
+- app/models/concerns/insights/api/common/act_as_taggable_on.rb
 - app/models/encryption.rb
 - lib/generators/shared_utilities/migration_generator.rb
 - lib/generators/shared_utilities/orm_helper.rb
@@ -367,6 +368,8 @@ files:
 - lib/insights/api/common/request.rb
 - lib/insights/api/common/routing.rb
 - lib/insights/api/common/status.rb
+- lib/insights/api/common/system.rb
+- lib/insights/api/common/tenant.rb
 - lib/insights/api/common/user.rb
 - lib/insights/api/common/version.rb
 - lib/tasks/insights/api/common_tasks.rake