insights-api-common 3.0.0

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

@@ -0,0 +1,48 @@
+module Insights
+  module API
+    module Common
+      class IdentityError < StandardError; end
+
+      class User
+        def initialize(identity)
+          @identity = identity
+        end
+
+        %w[
+          username
+          email
+          first_name
+          is_active
+          is_org_admin
+          is_internal
+          last_name
+          locale
+        ].each do |m|
+          define_method(m.start_with?("is_") ? "#{m[3..-1]}?" : m) do
+            find_user_key(m)
+          end
+        end
+
+        def tenant
+          find_tenant_key
+        end
+
+        private
+
+        attr_reader :identity
+
+        def find_user_key(key)
+          result = identity.dig('identity', 'user', key.to_s)
+          raise IdentityError, "#{key} doesn't exist" if result.nil?
+          result
+        end
+
+        def find_tenant_key
+          result = identity.dig('identity', 'account_number')
+          raise IdentityError, "Tenant key doesn't exist" if result.nil?
+          result
+        end
+      end
+    end
+  end
+end

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

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

data/lib/tasks/insights/api/common_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :insights_api_common do
+#   # Task goes here
+# end

data/spec/support/default_as_json.rb

@@ -0,0 +1,17 @@
+module DefaultAsJson
+  extend ActiveSupport::Concern
+
+  included do
+    let(:default_as) { :json }
+    prepend RequestHelpersCustomized
+  end
+
+  module RequestHelpersCustomized
+    %w[patch post put].each do |method|
+      define_method(method) do |path, **kwargs|
+        kwargs[:as] ||= default_as if default_as
+        super(path, kwargs)
+      end
+    end
+  end
+end

data/spec/support/rbac_shared_contexts.rb

@@ -0,0 +1,44 @@
+RSpec.shared_context "rbac_objects" do
+  let(:app_name) { 'catalog' }
+  let(:resource) { "portfolios" }
+  let(:permissions) { ["#{app_name}:#{resource}:read"] }
+  let(:resource_id1) { "1" }
+  let(:resource_id2) { "2" }
+  let(:resource_id3) { "3" }
+  let(:group1) { instance_double(RBACApiClient::GroupOut, :name => 'group1', :uuid => "123") }
+  let(:group2) { instance_double(RBACApiClient::GroupOut, :name => 'group2', :uuid => "12345") }
+  let(:group3) { instance_double(RBACApiClient::GroupOut, :name => 'group3', :uuid => "45665") }
+  let(:role1) { instance_double(RBACApiClient::RoleOut, :name => "#{app_name}-#{resource}-#{resource_id1}-group-#{group1.uuid}", :uuid => "67899") }
+  let(:role2) { instance_double(RBACApiClient::RoleOut, :name => "#{app_name}-#{resource}-#{resource_id2}-group-#{group1.uuid}", :uuid => "55555") }
+  let(:role1_detail) { instance_double(RBACApiClient::RoleWithAccess, :name => role1.name, :uuid => role1.uuid, :access => [access1]) }
+  let(:role2_detail) { instance_double(RBACApiClient::RoleWithAccess, :name => role2.name, :uuid => role2.uuid, :access => []) }
+  let(:role1_detail_updated) { instance_double(RBACApiClient::RoleWithAccess, :name => role1.name, :uuid => role1.uuid, :access => []) }
+  let(:groups) { [group1, group2, group3] }
+  let(:roles) { [role1] }
+  let(:policies) { [instance_double(RBACApiClient::PolicyIn, :group => group1, :roles => roles)] }
+  let(:filter1) { instance_double(RBACApiClient::ResourceDefinitionFilter, :key => 'id', :operation => 'equal', :value => resource_id1) }
+  let(:resource_def1) { instance_double(RBACApiClient::ResourceDefinition, :attribute_filter => filter1) }
+  let(:filter2) { instance_double(RBACApiClient::ResourceDefinitionFilter, :key => 'id', :operation => 'equal', :value => resource_id2) }
+  let(:resource_def2) { instance_double(RBACApiClient::ResourceDefinition, :attribute_filter => filter2) }
+  let(:filter3) { instance_double(RBACApiClient::ResourceDefinitionFilter, :key => 'id', :operation => 'equal', :value => resource_id3) }
+  let(:resource_def3) { instance_double(RBACApiClient::ResourceDefinition, :attribute_filter => filter3) }
+  let(:filter4) { instance_double(RBACApiClient::ResourceDefinitionFilter, :key => 'id', :operation => 'equal', :value => '*') }
+  let(:resource_def4) { instance_double(RBACApiClient::ResourceDefinition, :attribute_filter => filter4) }
+  let(:access1) { instance_double(RBACApiClient::Access, :permission => "#{app_name}:#{resource}:read", :resource_definitions => [resource_def1]) }
+  let(:access2) { instance_double(RBACApiClient::Access, :permission => "#{app_name}:#{resource}:write", :resource_definitions => [resource_def2]) }
+  let(:access3) { instance_double(RBACApiClient::Access, :permission => "#{app_name}:#{resource}:order", :resource_definitions => []) }
+  let(:admin_access) { instance_double(RBACApiClient::Access, :permission => "#{app_name}:#{resource}:read", :resource_definitions => [resource_def4]) }
+  let(:group_uuids) { [group1.uuid, group2.uuid, group3.uuid] }
+  let(:api_instance) { double }
+  let(:rs_class) { class_double("Insights::API::Common::RBAC::Service").as_stubbed_const(:transfer_nested_constants => true) }
+  let(:current_user) { '{{username}}' }
+  let(:id_value) { '*' }
+  let(:owner_filter) { instance_double(RBACApiClient::ResourceDefinitionFilter, :key => 'owner', :operation => 'equal', :value => current_user) }
+  let(:owner_resource_def) { instance_double(RBACApiClient::ResourceDefinition, :attribute_filter => owner_filter) }
+  let(:id_filter) { instance_double(RBACApiClient::ResourceDefinitionFilter, :key => 'id', :operation => 'equal', :value => id_value) }
+  let(:id_resource_def) { instance_double(RBACApiClient::ResourceDefinition, :attribute_filter => id_filter) }
+  let(:owner_resource) { 'orders' }
+  let(:owner_permission) { "#{app_name}:#{owner_resource}:read" }
+  let(:owner_access) { instance_double(RBACApiClient::Access, :permission => owner_permission, :resource_definitions => [owner_resource_def]) }
+  let(:all_access) { instance_double(RBACApiClient::Access, :permission => owner_permission, :resource_definitions => [id_resource_def]) }
+end

data/spec/support/requests_spec_helper.rb

@@ -0,0 +1,7 @@
+require_relative "default_as_json"
+
+module RequestSpecHelper
+  RSpec.configure do |config|
+    config.include DefaultAsJson, :type => :request
+  end
+end

data/spec/support/service_spec_helper.rb

@@ -0,0 +1,26 @@
+module ServiceSpecHelper
+  RSpec.configure do |config|
+    config.around(:example, :type => :service) do |example|
+      default_tenant = Tenant.first_or_create!(:external_tenant => default_account_number)
+
+      ActsAsTenant.with_tenant(default_tenant) do
+        example.call
+      end
+
+      Tenant.delete_all
+    end
+  end
+
+  def default_headers
+    { 'x-rh-identity'            => encoded_user_hash,
+      'x-rh-insights-request-id' => 'gobbledygook' }
+  end
+
+  def original_url
+    "http://example.com"
+  end
+
+  def default_request
+    { :headers => default_headers, :original_url => original_url }
+  end
+end

data/spec/support/user_header_spec_helper.rb

@@ -0,0 +1,68 @@
+module UserHeaderSpecHelper
+  DEFAULT_USER = {
+    "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"           => "User",
+      "user"     =>  {
+        "username"     => "jdoe",
+        "email"        => "jdoe@acme.com",
+        "first_name"   => "John",
+        "last_name"    => "Doe",
+        "is_active"    => true,
+        "is_org_admin" => false,
+        "is_internal"  => false,
+        "locale"       => "en_US"
+      },
+      "internal" => {
+        "org_id"    => "3340851",
+        "auth_type" => "basic-auth",
+        "auth_time" => 6300
+      }
+    }
+  }.freeze
+
+  def default_account_number
+    default_user_hash["identity"]["account_number"]
+  end
+
+  def default_username
+    default_user_hash["identity"]["user"]["username"]
+  end
+
+  def encode(val)
+    if val.kind_of?(Hash)
+      hashed = val.stringify_keys
+      Base64.strict_encode64(hashed.to_json)
+    else
+      raise StandardError, "Must be a Hash"
+    end
+  end
+
+  def encoded_user_hash(hash = nil)
+    encode(hash || DEFAULT_USER)
+  end
+
+  def default_user_hash
+    Marshal.load(Marshal.dump(DEFAULT_USER))
+  end
+end

metadata

@@ -0,0 +1,403 @@
+--- !ruby/object:Gem::Specification
+name: insights-api-common
+version: !ruby/object:Gem::Version
+  version: 3.0.0
+platform: ruby
+authors:
+- Insights Authors
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-11-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: acts_as_tenant
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: manageiq-password
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.1.1
+- !ruby/object:Gem::Dependency
+  name: manageiq-loggers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: cloudwatchlogger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: prometheus_exporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.5
+- !ruby/object:Gem::Dependency
+  name: more_core_extensions
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: openapi_parser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.1
+- !ruby/object:Gem::Dependency
+  name: graphql
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: graphql-batch
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: graphql-preload
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: query_relation
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: factory_bot
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-mocks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Header, Encryption, RBAC, Serialization, Pagination and other common
+  behavior for Insights microservices built with Rails
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- Rakefile
+- app/models/authentication.rb
+- app/models/concerns/encryption_concern.rb
+- app/models/encryption.rb
+- lib/generators/shared_utilities/migration_generator.rb
+- lib/generators/shared_utilities/orm_helper.rb
+- lib/generators/shared_utilities/templates/migration.rb
+- lib/generators/shared_utilities/templates/migration_existing.rb
+- lib/insights.rb
+- lib/insights/api/common.rb
+- lib/insights/api/common/application_controller_mixins/api_doc.rb
+- lib/insights/api/common/application_controller_mixins/common.rb
+- lib/insights/api/common/application_controller_mixins/exception_handling.rb
+- lib/insights/api/common/application_controller_mixins/openapi_enabled.rb
+- lib/insights/api/common/application_controller_mixins/parameters.rb
+- lib/insights/api/common/application_controller_mixins/request_body_validation.rb
+- lib/insights/api/common/application_controller_mixins/request_parameter_validation.rb
+- lib/insights/api/common/application_controller_mixins/request_path.rb
+- lib/insights/api/common/engine.rb
+- lib/insights/api/common/entitlement.rb
+- lib/insights/api/common/error_document.rb
+- lib/insights/api/common/filter.rb
+- lib/insights/api/common/graphql.rb
+- lib/insights/api/common/graphql/associated_records.rb
+- lib/insights/api/common/graphql/association_loader.rb
+- lib/insights/api/common/graphql/generator.rb
+- lib/insights/api/common/graphql/templates/model_type.erb
+- lib/insights/api/common/graphql/templates/query_type.erb
+- lib/insights/api/common/graphql/templates/schema.erb
+- lib/insights/api/common/graphql/types/big_int.rb
+- lib/insights/api/common/graphql/types/date_time.rb
+- lib/insights/api/common/graphql/types/query_filter.rb
+- lib/insights/api/common/graphql/types/query_sort_by.rb
+- lib/insights/api/common/inflections.rb
+- lib/insights/api/common/logging.rb
+- lib/insights/api/common/metrics.rb
+- lib/insights/api/common/middleware/web_server_metrics.rb
+- lib/insights/api/common/open_api.rb
+- lib/insights/api/common/open_api/docs.rb
+- lib/insights/api/common/open_api/docs/component_collection.rb
+- lib/insights/api/common/open_api/docs/doc_v3.rb
+- lib/insights/api/common/open_api/docs/object_definition.rb
+- lib/insights/api/common/open_api/generator.rb
+- lib/insights/api/common/open_api/serializer.rb
+- lib/insights/api/common/option_redirect_enhancements.rb
+- lib/insights/api/common/paginated_response.rb
+- lib/insights/api/common/rbac/access.rb
+- lib/insights/api/common/rbac/acl.rb
+- lib/insights/api/common/rbac/policies.rb
+- lib/insights/api/common/rbac/query_shared_resource.rb
+- lib/insights/api/common/rbac/roles.rb
+- lib/insights/api/common/rbac/seed.rb
+- lib/insights/api/common/rbac/service.rb
+- lib/insights/api/common/rbac/share_resource.rb
+- lib/insights/api/common/rbac/unshare_resource.rb
+- lib/insights/api/common/rbac/utilities.rb
+- lib/insights/api/common/request.rb
+- lib/insights/api/common/routing.rb
+- lib/insights/api/common/user.rb
+- lib/insights/api/common/version.rb
+- lib/tasks/insights/api/common_tasks.rake
+- spec/support/default_as_json.rb
+- spec/support/rbac_shared_contexts.rb
+- spec/support/requests_spec_helper.rb
+- spec/support/service_spec_helper.rb
+- spec/support/user_header_spec_helper.rb
+homepage: https://github.com/RedHatInsights/insights-api-common-rails.git
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.6
+signing_key: 
+specification_version: 4
+summary: Common Utilites for Insights microservices
+test_files: []