kadmin 0.9.5 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4fe19731662c1c3be0fe40ae260211da22ee4d960c04b74f513b25bfa1f76899
-  data.tar.gz: fbab4e93dfecdbc818936066913eaad08300afd88ab9e98d001e4aaf10f2ef47
+  metadata.gz: de1ca63ba054b938124830cf649096a45bbc9c424542fde3e51348ca88464c0e
+  data.tar.gz: 03b59bedf32d3146915436c061836c2b9532ac878f41837ca83e04b76129729e
 SHA512:
-  metadata.gz: 7ebda4f9ce3cfd49e1583e4a19172a9822cf401afabecaa30a44ac17508d7651842c01459d725bbb8a9c856cf9f62b328035a747a40dbf94fa117249aeccc2d5
-  data.tar.gz: febc8329c9c3cab522d7502f758edbbfd11b93b2cbab1c03b7d947994926a75fbb9822047731e921c20dbde9df3713ad63ee67865a7392570a39bba9dd2f5e0b
+  metadata.gz: 950a0431e91b2e86f8fc9fe0fbe5042cf8f3aa769c92a47799faeb9a0a63525af026c06b18888d98f1c41a8d4bc1b0dd3aaf58a195151796f18ec3bc1d7b57a6
+  data.tar.gz: 4fcce405b35d4d90ba39ced35aaf22599532c8b534668feeebae15c5d3ffdab102fb25a4a2995756b2d86bef488a6d16fe4c147444de5fc21c10020bc1c6f60f

data/app/controllers/kadmin/application_controller.rb

@@ -12,6 +12,7 @@ module Kadmin
 
     before_action :authorize
     before_action :set_default_format
+    before_action :organization
 
     # Each controller should specify which navbar section they
     # belong to, if any. By default, each controller is setup to
@@ -51,6 +52,45 @@ module Kadmin
 
     # @!endgroup
 
+    # returns organization_scoped_ar object(s) by id (or array of ids) or throw RecordNotFound in case
+    # id(s) does not exist or is not visible in scope
+    #
+    # organization_scoped_ar is an ActiveRecord that has organization_scope(Organization) scope defined
+    def scoped_find_by!(organization_scoped_ar, id)
+      if authorized_user.admin?
+        if id.is_a?(Array)
+          return organization_scoped_ar.find(id)
+        else
+          return organization_scoped_ar.find_by!(id: id)
+        end
+      else
+        if id.is_a?(Array)
+          return organization_scoped_ar.organization_scope(@organization).find(id)
+        else
+          return organization_scoped_ar.organization_scope(@organization).find_by!(id: id)
+        end
+      end
+    end
+
+    # returns all organization_scoped_ar object(s) that are of the user's organization. admin user gets all.
+    # you can chain scopes, e.g. scoped_all(Segments.my_scope) is valid
+    # organization_scoped_ar is an ActiveRecord that has organization_scope(Organization) scope defined
+    def scoped_all(organization_scoped_ar)
+      if authorized_user.admin?
+        organization_scoped_ar.all
+      else
+        organization_scoped_ar.organization_scope(organization).all
+      end
+    end
+
+    def organization
+      if authorized_user.present?
+        @organization ||= Kadmin::Organization.find_by!(name: authorized_user.organization)
+      end
+    rescue ActiveRecord::RecordNotFound
+      render plain: "Forbidden - organization #{authorized_user.organization} not found in DB", status: :forbidden
+    end
+
     # @!group Helpers
 
     protected

data/app/models/kadmin/organization.rb

@@ -0,0 +1,4 @@
+module Kadmin
+  class Organization < ApplicationRecord
+  end
+end

data/config/locales/en.yml

@@ -14,7 +14,7 @@ en:
         create: Create
         filter: Filter
         out_of: out of %{total}
-    dash_message: See the top navigation bar for the different admin sections. If you are missing authorizations, or if there is any issue at all, contact the Apps & Services team!
+    dash_message: See the left navigation bar for the different admin sections. If you are missing authorizations, or if there is any issue at all, contact the Offerista Apps & Services team!
     error: Error
     errors:
       not_found: Requested object not found

data/db/migrate/20180912092525_create_organizations.rb

@@ -0,0 +1,10 @@
+class CreateOrganizations < ActiveRecord::Migration[5.2]
+
+  def change
+    create_table :kadmin_organizations do |t|
+      t.string :name
+      t.timestamps
+    end
+    add_index :kadmin_organizations, :name, unique: true
+  end
+end

data/lib/kadmin/auth/user.rb

@@ -1,15 +1,21 @@
 module Kadmin
   module Auth
     class User
-      attr_accessor :email
+      attr_accessor :email, :accept, :organization
 
-      def initialize(email)
+      def initialize(email, options = {})
         @email = email
+        @organization = options[:organization]
       end
 
       def authorized?(_request)
         return true
       end
+
+      def admin?
+        return true
+      end
+
     end
   end
 end

data/lib/kadmin/auth/user_store.rb

@@ -3,6 +3,7 @@ module Kadmin
     class UserStore
       def initialize
         @store = {}
+        load_users!
       end
 
       def get(email)
@@ -16,6 +17,26 @@ module Kadmin
       def exists?(email)
         @store.key?(email.to_s.downcase)
       end
+
+      def load_users!
+        file = Rails.root.join('config', 'admin_users.yml')
+        if File.exists?(file) && File.readable?(file)
+          definitions = YAML.load_file(file.to_s)
+          definitions.each do |definition|
+            email = definition['email']
+            options = {
+              admin: definition.fetch('admin', false),
+              accept: Array.wrap(definition.fetch('accept', [])).map(&:to_sym),
+              organization: definition.fetch('organization', 'offerista') # default organization, needs to exist in DB
+            }
+
+            set(email, Kadmin::Auth.config.user_class.new(email, **options))
+          end
+        else
+          Rails.logger.warn("Can't read admin users auth file at #{file}. Auth might not work")
+        end
+      end
+      private :load_users!
     end
   end
 end

data/lib/kadmin/engine.rb

@@ -5,8 +5,22 @@ module Kadmin
   class Engine < ::Rails::Engine
     isolate_namespace Kadmin
 
+    # push engine factory paths always at the top of the path stack
+    initializer 'kadmin.factories', after: 'factory_bot.set_factory_paths' do
+      factory_paths = File.expand_path('../../../test/factories', __FILE__) # path relative to installation location
+      FactoryBot.definition_file_paths.unshift(factory_paths) if defined?(FactoryBot)
+    end
+
     initializer 'kadmin.install' do
       Kadmin.logger = Rails.logger
     end
+
+    initializer :append_migrations do |app|
+      unless app.root.to_s.match(root.to_s)
+        config.paths['db/migrate'].expanded.each do |expanded_path|
+          app.config.paths['db/migrate'] << expanded_path
+        end
+      end
+    end
   end
 end

data/lib/kadmin/version.rb

@@ -1,3 +1,3 @@
 module Kadmin
-  VERSION = '0.9.5'.freeze
+  VERSION = '1.0.0'.freeze
 end

data/test/factories/organizations.rb

@@ -0,0 +1,13 @@
+FactoryBot.define do
+  factory :kadmin_organization, class: Kadmin::Organization do
+    initialize_with do
+      Kadmin::Organization.where(name: 'offerista').first_or_initialize # take from seeded database
+    end
+  end
+
+  factory :kadmin_organization_not_offerista, class: Kadmin::Organization do
+    initialize_with do
+      Kadmin::Organization.where(name: 'profital').first_or_initialize # take from seeded database
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kadmin
 version: !ruby/object:Gem::Version
-  version: 0.9.5
+  version: 1.0.0
 platform: ruby
 authors:
 - Nicolas Pepin-Perreault
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-28 00:00:00.000000000 Z
+date: 2018-10-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -127,6 +127,7 @@ files:
 - app/helpers/kadmin/application_helper.rb
 - app/helpers/kadmin/bootstrap_helper.rb
 - app/helpers/kadmin/charts_helper.rb
+- app/models/kadmin/organization.rb
 - app/views/kadmin/auth/login.html.erb
 - app/views/kadmin/components/_finder.html.erb
 - app/views/kadmin/components/_finder.js.erb
@@ -143,6 +144,7 @@ files:
 - config/initializers/i18n.rb
 - config/locales/en.yml
 - config/routes.rb
+- db/migrate/20180912092525_create_organizations.rb
 - lib/kadmin.rb
 - lib/kadmin/auth.rb
 - lib/kadmin/auth/configuration.rb
@@ -157,6 +159,7 @@ files:
 - lib/kadmin/presenter.rb
 - lib/kadmin/presenter/test_case.rb
 - lib/kadmin/version.rb
+- test/factories/organizations.rb
 - vendor/assets/fonts/fontawesome/fontawesome-webfont.eot
 - vendor/assets/fonts/fontawesome/fontawesome-webfont.svg
 - vendor/assets/fonts/fontawesome/fontawesome-webfont.ttf