punk 0.0.3 → 0.2.0

data/lib/punk/core/commander.rb

@@ -6,11 +6,11 @@ command :test do |c|
     say('Running tests...')
     unless ENV['PUNK_ENV'] == 'test'
       error('!!! PUNK_ENV should be test !!!')
-      exit 1
+      exit 1 # rubocop:disable Rails/Exit
     end
     ENV.delete_if { |name, _value| name =~ /^PUNK_/ }
     system('rubocop') &&
-#     system('quasar build -m pwa') && TODO
+      # system('quasar build -m pwa') && TODO
       system('PUNK_ENV=test rspec')
     exit $CHILD_STATUS.exitstatus # rubocop:disable Rails/Exit
   end
@@ -74,10 +74,13 @@ command 'db migrate' do |c|
     say('Migrating db...')
     PUNK.boot
     Sequel.extension :migration
-    if options.relative.nil?
-      Sequel::Migrator.run(PUNK.db, File.join(PUNK.get.app.path, 'migrations'))
-    else
-      Sequel::Migrator.run(PUNK.db, File.join(PUNK.get.app.path, 'migrations'), relative: options.relative)
+    migrations_path = File.join(PUNK.get.app.path, 'migrations')
+    if File.exist?(migrations_path)
+      if options.relative.nil?
+        Sequel::Migrator.run(PUNK.db, migrations_path)
+      else
+        Sequel::Migrator.run(PUNK.db, migrations_path, relative: options.relative)
+      end
     end
     database = File.basename(PUNK.get.db.url)
     `pg_dump #{database} --schema-only > schema.psql`

data/lib/punk/core/exec.rb

@@ -23,6 +23,7 @@ end
 
 PUNK::Interface.register(:app) do
   require_relative 'app'
+  PUNK.require_all(File.join(__dir__, '..', 'routes'))
   PUNK.require_all(File.join(PUNK.get.app.path, 'routes'))
   retval = PUNK.get.app.reloadable ? PUNK.loader : PUNK::App.freeze.app
   SemanticLogger.flush
@@ -32,6 +33,7 @@ end
 PUNK.inject :loader, :app
 
 ['actions', 'models', 'views', 'services', 'workers'].each do |dir|
+  PUNK.require_all(File.join(__dir__, '..', dir))
   PUNK.require_all(File.join(PUNK.get.app.path, dir))
 end
 

data/lib/punk/core/load.rb

@@ -4,6 +4,5 @@ PUNK.db
 
 require_relative '../helpers/all'
 require_relative '../framework/all'
-require_relative '../views/all'
 
 PUNK.store[:state] = :loaded

data/lib/punk/framework/command.rb

@@ -71,7 +71,11 @@ module PUNK
         define_method(:options) do |opt|
           punk_command = PUNK.store.commands[match]
           punk_command.instance_variable_get(:@options).each_value do |option|
-            opt.on option[:shortcut], option[:name], option[:description], argument: true, as: option[:type]
+            if option[:type].present?
+              opt.on option[:shortcut], option[:name], option[:description], argument: true, as: option[:type]
+            else
+              opt.on option[:shortcut], option[:name], option[:description]
+            end
           end
         end
         define_method(:process) do

data/lib/punk/framework/plugins/validation.rb

@@ -28,20 +28,6 @@ module PUNK
           end
         end
 
-        def validates_parse_id(atts, opts={})
-          default = { message: "is not a Parse ID" }
-          validatable_attributes(atts, default.merge(opts)) do |_name, value, message|
-            message unless /^[[:alnum:]]{10}$/.match(value)
-          end
-        end
-
-        def validates_subdomain(atts, opts={})
-          default = { message: "is not a subdomain" }
-          validatable_attributes(atts, default.merge(opts)) do |_name, value, message|
-            message unless /^[A-Za-z0-9](?:[A-Za-z0-9\-]{0,61}[A-Za-z0-9])?$/.match(value)
-          end
-        end
-
         def validates_state(name, state)
           errors.add(name, "is not in #{state} state") unless self[name].send("#{state}?")
         end

data/lib/punk/framework/runnable.rb

@@ -12,7 +12,7 @@ module PUNK
 
     def method_missing(key, *args, &block)
       val = super
-      val = val.to_h if val.class == self.class || val.class.instance_of?(self.class)
+      val = val.to_h if val.instance_of?(self.class)
       val
     end
 

data/lib/punk/helpers/loggable.rb

@@ -22,7 +22,7 @@ module PUNK
 
     def exception(e, extra={})
       if ENV.key?('SENTRY_DSN')
-        ::Raven.capture_exception(
+        ::Sentry.capture_exception(
           e,
           message: e.message,
           extra: extra,

data/lib/punk/migrations/001_punk.rb

@@ -0,0 +1,103 @@
+# frozen_string_literal: true
+
+def _tenants
+  create_table :tenants do
+    uuid :id, primary_key: true, default: Sequel.function(:gen_random_uuid)
+    punk_state :state, null: false, default: 'created'
+    String :name, null: false, text: true
+    String :icon, text: true
+    jsonb :data, default: '{}'
+    DateTime :created_at
+    DateTime :updated_at
+  end
+end
+
+def _users
+  create_table :users do
+    uuid :id, primary_key: true, default: Sequel.function(:gen_random_uuid)
+    punk_state :state, null: false, default: 'created'
+    String :name, null: false, text: true
+    String :icon, text: true
+    String :email, text: true, unique: true
+    String :phone, text: true, unique: true
+    jsonb :data, default: '{}'
+    DateTime :created_at
+    DateTime :updated_at
+  end
+end
+
+def _tenants_users
+  create_table :tenants_users do
+    primary_key [:tenant_id, :user_id]
+    foreign_key :tenant_id, :tenants, null: false, type: :uuid
+    foreign_key :user_id, :users, null: false, type: :uuid
+    index [:tenant_id, :user_id]
+  end
+end
+
+def _groups
+  create_table :groups do
+    uuid :id, primary_key: true, default: Sequel.function(:gen_random_uuid)
+    punk_state :state, null: false, default: 'created'
+    String :name, null: false, text: true
+    String :icon, text: true
+    jsonb :data, default: '{}'
+    DateTime :created_at
+    DateTime :updated_at
+    foreign_key :tenant_id, :tenants, null: false, type: :uuid
+  end
+end
+
+def _groups_users
+  create_table :groups_users do
+    primary_key [:group_id, :user_id]
+    foreign_key :group_id, :groups, null: false, type: :uuid
+    foreign_key :user_id, :users, null: false, type: :uuid
+    index [:group_id, :user_id]
+  end
+end
+
+def _identities
+  create_enum(:claim_type, %w[email phone])
+  create_table :identities do
+    uuid :id, primary_key: true, default: Sequel.function(:gen_random_uuid)
+    punk_state :state, null: false, default: 'created'
+    claim_type :claim_type, null: false
+    String :claim, text: true, null: false, unique: true
+    jsonb :data, default: '{}'
+    DateTime :created_at
+    DateTime :updated_at
+    foreign_key :user_id, :users, null: true, type: :uuid
+  end
+end
+
+def _sessions
+  create_enum(:session_state, %w[pending created active deleted expired])
+  create_table :sessions do
+    uuid :id, primary_key: true, default: Sequel.function(:gen_random_uuid)
+    uuid :slug, default: Sequel.function(:gen_random_uuid)
+    session_state :state, null: false, default: 'created'
+    File :salt, text: true
+    File :hash, text: true
+    Integer :attempt_count, null: false, default: 0
+    cidr :remote_addr, null: false, default: '127.0.0.1'
+    String :user_agent, text: true, null: false, default: 'Mozilla/5.0 (compatible; Punk!; +https://punk.kranzky.com)'
+    jsonb :data, default: '{}'
+    DateTime :created_at
+    DateTime :updated_at
+    foreign_key :identity_id, :identities, null: false, type: :uuid
+  end
+end
+
+PUNK.migration do
+  change do
+    create_enum(:punk_state, %w[created active deleted])
+    _tenants
+    _users
+    _tenants_users
+    _groups
+    _groups_users
+    _identities
+    _sessions
+  end
+end

data/lib/punk/models/group.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module PUNK
+  # @model
+  # @property id(required) [string] a unique identifier for the group
+  # @property name(required) [string] the name of the group
+  # @property icon(required) [string] an image URL
+  class Group < PUNK::Model
+    alias to_s name
+
+    many_to_one :tenant
+    many_to_many :users
+
+    def validate
+      validates_presence :tenant
+      validates_presence :name
+      validates_url :icon, allow_blank: true
+    end
+  end
+end

data/lib/punk/models/group_user_metadata.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module PUNK
+  class GroupUserMetadata < PUNK::Model(:groups_users)
+    many_to_one :group
+    many_to_one :user
+
+    def validate
+      validates_presence :group
+      validates_presence :user
+    end
+
+    def to_s
+      "#{group_id}|#{user_id}"
+    end
+  end
+end

data/lib/punk/models/identity.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module PUNK
+  class Identity < PUNK::Model
+    alias to_s claim
+
+    many_to_one :user
+    one_to_many :sessions
+
+    symbolize :claim_type
+
+    def validate
+      validates_presence :claim
+      validates_presence :claim_type
+      validates_unique :claim
+      validates_includes [:email, :phone], :claim_type
+      validates_email :claim if email?
+      validates_phone :claim if phone?
+    end
+
+    def email?
+      claim_type == :email
+    end
+
+    def phone?
+      claim_type == :phone
+    end
+  end
+end

data/lib/punk/models/session.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+module PUNK
+  # @model
+  # @property slug(required) [string] a unique identifier for the session while it is being challenged
+  # @property message(required) [string] a message to be displayed to the user to let them know what to do
+  class Session < PUNK::Model
+    alias to_s state
+
+    many_to_one :identity
+    one_through_one :user, join_table: :identities, left_key: :id, left_primary_key: :identity_id
+
+    symbolize :state
+
+    aasm :state do
+      state :created, initial: true
+      state :pending
+      state :active
+      state :expired
+      state :deleted
+
+      event :challenge do
+        transitions from: :created, to: :pending, guard: :current?
+      end
+
+      event :verify, after: :erase do
+        transitions from: :pending, to: :active, guard: :current?
+      end
+
+      event :timeout, after: :erase do
+        transitions from: [:created, :pending, :active], to: :expired
+      end
+
+      event :clear, after: :erase do
+        transitions from: :active, to: :deleted
+      end
+    end
+
+    dataset_module do
+      def created
+        where(state: 'created')
+      end
+
+      def pending
+        where(state: 'pending')
+      end
+
+      def active
+        where(state: 'active')
+      end
+
+      def expired
+        where(state: 'expired')
+      end
+
+      def deleted
+        where(state: 'deleted')
+      end
+
+      def expiring
+        where { Sequel.&({ state: ['created', 'pending'] }, (created_at < 5.minutes.ago)) }.or { Sequel.&({ state: 'active' }, ((updated_at < 1.month.ago) | (created_at < 1.year.ago))) }
+      end
+    end
+
+    def validate
+      validates_presence :identity
+      validates_includes [:created, :pending, :active, :expired, :deleted], :state
+      validates_integer :attempt_count
+      validates_includes [0, 1, 2, 3], :attempt_count
+    end
+
+    def current?
+      !timeout?
+    end
+
+    def timeout?
+      timeout! if (created? || pending?) && created_at < 5.minutes.ago || active? && (updated_at < 1.month.ago || created_at < 1.year.ago)
+      expired?
+    end
+
+    def erase
+      update(slug: nil, salt: nil, hash: nil)
+    end
+
+    def increment_attempts
+      update(attempt_count: attempt_count + 1)
+    end
+  end
+end

data/lib/punk/models/tenant.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module PUNK
+  # @model
+  # @property id(required) [string] a unique identifier for the tenant
+  # @property name(required) [string] the name of the tenant
+  # @property icon(required) [string] an image URL
+  class Tenant < PUNK::Model
+    alias to_s name
+
+    many_to_many :users
+    one_to_many :groups
+
+    def validate
+      validates_presence :name
+      validates_url :icon, allow_blank: true
+    end
+  end
+end

data/lib/punk/models/tenant_user_metadata.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module PUNK
+  class TenantUserMetadata < PUNK::Model(:tenants_users)
+    many_to_one :tenant
+    many_to_one :user
+
+    def validate
+      validates_presence :tenant
+      validates_presence :user
+    end
+
+    def to_s
+      "#{tenant_id}|#{user_id}"
+    end
+  end
+end

data/lib/punk/models/user.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module PUNK
+  # @model
+  # @property id(required) [string] a unique identifier for the user
+  # @property name(required) [string] the name of the user
+  # @property icon(required) [string] an image URL
+  class User < Model
+    alias to_s name
+
+    many_to_many :tenants
+    many_to_many :groups
+    one_to_many :identities
+    many_through_many :sessions, through: [[:identities, :user_id, :id], [:sessions, :identity_id, :id]]
+
+    def validate
+      validates_presence :name
+      validates_url :icon, allow_blank: true
+      validates_presence :email if phone.blank?
+      validates_presence :phone if email.blank?
+      validates_email :email, allow_blank: true
+      validates_phone :phone, allow_blank: true
+      validates_unique :email, allow_blank: true
+      validates_unique :phone, allow_blank: true
+    end
+
+    def active_sessions
+      sessions_dataset.where(Sequel.lit('"sessions"."state"') => 'active')
+    end
+  end
+end