userlist-rails 0.4.0 → 0.6.0

data/lib/userlist/rails/config.rb

@@ -1,13 +1,21 @@
 require 'userlist/config'
 
+require 'userlist/rails/transforms/user'
+require 'userlist/rails/transforms/company'
+require 'userlist/rails/transforms/relationship'
+
 module Userlist
   module Rails
     module Config
       DEFAULT_CONFIGURATION = {
         user_model: nil,
         company_model: nil,
+        relationship_model: nil,
         auto_discover: true,
-        script_url: 'https://js.userlist.com/v1'
+        script_url: 'https://js.userlist.com/v1',
+        user_transform: Userlist::Rails::Transforms::User,
+        company_transform: Userlist::Rails::Transforms::Company,
+        relationship_transform: Userlist::Rails::Transforms::Relationship
       }.freeze
 
       def default_config
@@ -19,11 +27,15 @@ module Userlist
       end
 
       def user_model
-        super&.to_s&.constantize
+        (model = super) && model.is_a?(Class) ? model : model&.to_s&.constantize
       end
 
       def company_model
-        super&.to_s&.constantize
+        (model = super) && model.is_a?(Class) ? model : model&.to_s&.constantize
+      end
+
+      def relationship_model
+        (model = super) && model.is_a?(Class) ? model : model&.to_s&.constantize
       end
 
       Userlist::Config.send(:prepend, self)

data/lib/userlist/rails/extensions/company.rb

@@ -0,0 +1,30 @@
+module Userlist
+  module Rails
+    module Extensions
+      module Company
+        module ClassMethods
+          def from_payload(payload, config = Userlist.config)
+            company_model = config.company_model
+            company_transform = config.company_transform
+
+            payload = company_transform.new(payload, config) if company_model && payload.is_a?(company_model)
+
+            super
+          end
+        end
+
+        def self.included(base)
+          base.extend(ClassMethods)
+        end
+
+        def push?
+          super && (!payload.respond_to?(:push?) || payload.push?)
+        end
+
+        def delete?
+          super && (!payload.respond_to?(:delete?) || payload.delete?)
+        end
+      end
+    end
+  end
+end

data/lib/userlist/rails/extensions/event.rb

@@ -2,10 +2,17 @@ module Userlist
   module Rails
     module Extensions
       module Event
-        def initialize(payload)
-          payload[:user] ||= Userlist::Rails.current_user
+        module ClassMethods
+          def new(payload, config = Userlist.config)
+            payload[:user] = Userlist::Rails.current_user unless payload.key?(:user)
+            payload[:company] = Userlist::Rails.current_company unless payload.key?(:company)
 
-          super
+            super
+          end
+        end
+
+        def self.included(base)
+          base.extend(ClassMethods)
         end
       end
     end

data/lib/userlist/rails/extensions/relationship.rb

@@ -0,0 +1,30 @@
+module Userlist
+  module Rails
+    module Extensions
+      module Relationship
+        module ClassMethods
+          def from_payload(payload, config = Userlist.config)
+            relationship_model = config.relationship_model
+            relationship_transform = config.relationship_transform
+
+            payload = relationship_transform.new(payload, config) if relationship_model && payload.is_a?(relationship_model)
+
+            super
+          end
+        end
+
+        def self.included(base)
+          base.extend(ClassMethods)
+        end
+
+        def push?
+          super && (!payload.respond_to?(:push?) || payload.push?)
+        end
+
+        def delete?
+          super && (!payload.respond_to?(:delete?) || payload.delete?)
+        end
+      end
+    end
+  end
+end

data/lib/userlist/rails/extensions/user.rb

@@ -0,0 +1,30 @@
+module Userlist
+  module Rails
+    module Extensions
+      module User
+        module ClassMethods
+          def from_payload(payload, config = Userlist.config)
+            user_model = config.user_model
+            user_transform = config.user_transform
+
+            payload = user_transform.new(payload, config) if user_model && payload.is_a?(user_model)
+
+            super
+          end
+        end
+
+        def self.included(base)
+          base.extend(ClassMethods)
+        end
+
+        def push?
+          super && (!payload.respond_to?(:push?) || payload.push?)
+        end
+
+        def delete?
+          super && (!payload.respond_to?(:delete?) || payload.delete?)
+        end
+      end
+    end
+  end
+end

data/lib/userlist/rails/helpers.rb

@@ -1,7 +1,7 @@
 module Userlist
   module Rails
     module Helpers
-      def userlist_script_tag(*args)
+      def userlist_script_tag(*args) # rubocop:disable Metrics/CyclomaticComplexity
         config = Userlist.config
         logger = Userlist.logger
 
@@ -14,10 +14,8 @@ module Userlist
         options[:async] = true
 
         if user
-          identifier = user.userlist_identifier
-
           options[:data] ||= {}
-          options[:data][:userlist] = Userlist::Token.generate(identifier)
+          options[:data][:userlist] = Userlist::Token.generate(user, config)
         end
 
         script_tag = javascript_tag('window.userlist=window.userlist||function(){(userlist.q=userlist.q||[]).push(arguments)};')

data/lib/userlist/rails/railtie.rb

@@ -3,10 +3,10 @@ require 'rails/railtie'
 require 'userlist'
 require 'userlist/config'
 require 'userlist/rails/logger'
-require 'userlist/rails/user'
-require 'userlist/rails/company'
 
-require 'userlist/rails/extensions/resource'
+require 'userlist/rails/extensions/user'
+require 'userlist/rails/extensions/company'
+require 'userlist/rails/extensions/relationship'
 require 'userlist/rails/extensions/event'
 
 require 'userlist/rails/helpers'
@@ -15,13 +15,20 @@ module Userlist
   module Rails
     class Railtie < ::Rails::Railtie
       rake_tasks do
-        load 'tasks/userlist.rake'
+        load 'userlist/rails/tasks/userlist.rake'
       end
 
       initializer 'userlist.config' do
         config.userlist = Userlist.config
       end
 
+      initializer 'userlist.strategy' do
+        config.after_initialize do
+          strategy = config.userlist.push_strategy
+          Userlist::Push::Strategies.require_strategy(strategy)
+        end
+      end
+
       initializer 'userlist.logger' do
         config.after_initialize do
           Userlist.logger = Userlist::Rails::Logger.new(::Rails.logger, config.userlist)
@@ -35,8 +42,7 @@ module Userlist
       end
 
       initializer 'userlist.extensions' do
-        Userlist::Push::Resource.prepend(Userlist::Rails::Extensions::Resource)
-        Userlist::Push::Event.prepend(Userlist::Rails::Extensions::Event)
+        Userlist::Rails.setup_extensions
       end
 
       initializer 'userlist.models' do
@@ -46,18 +52,26 @@ module Userlist
           if userlist.auto_discover
             Userlist.logger.info('Automatically discovering models')
 
-            userlist.user_model ||= Userlist::Rails.detect_model('User')
-            userlist.company_model ||= Userlist::Rails.detect_model('Account', 'Company')
+            userlist.user_model = Userlist::Rails.detect_model('User')
+            userlist.company_model = Userlist::Rails.detect_model('Account', 'Company', 'Team', 'Organization')
+            userlist.relationship_model = Userlist::Rails.detect_relationship(userlist.user_model, userlist.company_model)
           end
 
           if user_model = userlist.user_model
             Userlist.logger.info("Preparing user model #{user_model}")
-            user_model.send(:include, Userlist::Rails::User)
+            Userlist::Rails.check_deprecations(user_model)
+            Userlist::Rails.setup_callbacks(user_model, :users)
           end
 
           if company_model = userlist.company_model
             Userlist.logger.info("Preparing company model #{company_model}")
-            company_model.send(:include, Userlist::Rails::Company)
+            Userlist::Rails.check_deprecations(company_model)
+            Userlist::Rails.setup_callbacks(company_model, :companies)
+          end
+
+          if relationship_model = userlist.relationship_model
+            Userlist.logger.info("Preparing relationship model #{relationship_model}")
+            Userlist::Rails.setup_callbacks(relationship_model, :relationships)
           end
         end
       end

data/lib/{tasks → userlist/rails/tasks}/userlist.rake

@@ -4,24 +4,24 @@ require 'userlist/rails/importer'
 
 namespace :userlist do
   namespace :import do
-    desc 'Import users into Userlist.io'
+    desc 'Import users into Userlist'
     task users: :environment do
       if user_model = Rails.application.config.userlist.user_model
         importer = Userlist::Rails::Importer.new
         importer.import(user_model) do |user|
-          push.user(user.send(:userlist_payload))
+          push.users.create(user)
         end
       else
         puts 'No user model defined. Skipping import.'
       end
     end
 
-    desc 'Import companies into Userlist.io'
+    desc 'Import companies into Userlist'
     task companies: :environment do
       if company_model = Rails.application.config.userlist.company_model
         importer = Userlist::Rails::Importer.new
         importer.import(company_model) do |company|
-          push.company(company.send(:userlist_payload))
+          push.companies.create(company)
         end
       else
         puts 'No company model defined. Skipping import.'
@@ -29,7 +29,7 @@ namespace :userlist do
     end
   end
 
-  desc 'Import users and companies into Userlist.io'
+  desc 'Import users and companies into Userlist'
   task import: ['userlist:import:users', 'userlist:import:companies']
 end
 

data/lib/userlist/rails/transform.rb

@@ -0,0 +1,42 @@
+module Userlist
+  module Rails
+    class Transform
+      def self.attributes
+        @attributes = []
+      end
+
+      def initialize(model, config = Userlist.config)
+        @model = model
+        @config = config
+      end
+
+      def [](name)
+        model.try("userlist_#{name}") || public_send("default_#{name}") if key?(name)
+      end
+
+      def key?(name)
+        keys.include?(name.to_sym)
+      end
+
+      def keys
+        self.class.attributes
+      end
+
+      def hash
+        model.hash
+      end
+
+      def push?
+        (!model.respond_to?(:userlist_push?) || model.userlist_push?)
+      end
+
+      def delete?
+        (!model.respond_to?(:userlist_delete?) || model.userlist_delete?)
+      end
+
+    private
+
+      attr_reader :model, :config
+    end
+  end
+end

data/lib/userlist/rails/transforms/company.rb

@@ -0,0 +1,55 @@
+require 'userlist/rails/transform'
+require 'userlist/rails/transforms/has_relationships'
+
+module Userlist
+  module Rails
+    module Transforms
+      class Company < Userlist::Rails::Transform
+        include HasRelationships
+
+        def self.attributes
+          @attributes ||= [
+            :identifier,
+            :properties,
+            :relationships,
+            :name,
+            :signed_up_at
+          ]
+        end
+
+        def default_identifier
+          "#{model.class.name}-#{model.id}".parameterize
+        end
+
+        def default_properties
+          {}
+        end
+
+        def default_name
+          model.try(:name)
+        end
+
+        def default_signed_up_at
+          model.try(:created_at)
+        end
+
+      private
+
+        def build_relationship(record)
+          {
+            user: record,
+            company: model
+          }
+        end
+
+        def relationship_from
+          config.company_model
+        end
+
+        def relationship_to
+          config.user_model
+        end
+      end
+    end
+  end
+end

data/lib/userlist/rails/transforms/has_relationships.rb

@@ -0,0 +1,35 @@
+require 'userlist/rails/transform'
+
+module Userlist
+  module Rails
+    module Transforms
+      module HasRelationships
+        def default_relationships
+          return unless association = Userlist::Rails.find_association_between(relationship_from, relationship_to)
+
+          records = model.try(association.name)
+
+          if association.klass == config.relationship_model
+            records
+          elsif association.klass == relationship_to
+            Array.wrap(records).map { |record| build_relationship(record) }
+          end
+        end
+
+      private
+
+        def build_relationship(_record)
+          raise NotImplementedError
+        end
+
+        def relationship_to
+          raise NotImplementedError
+        end
+
+        def relationship_from
+          raise NotImplementedError
+        end
+      end
+    end
+  end
+end

data/lib/userlist/rails/transforms/relationship.rb

@@ -0,0 +1,33 @@
+require 'userlist/rails/transform'
+
+module Userlist
+  module Rails
+    module Transforms
+      class Relationship < Userlist::Rails::Transform
+        def self.attributes
+          @attributes ||= [
+            :user,
+            :company,
+            :properties
+          ]
+        end
+
+        def default_properties
+          {}
+        end
+
+        def default_user
+          user_method = Userlist::Rails.find_reflection(config.relationship_model, config.user_model)&.name
+
+          user_method && model.try(user_method)
+        end
+
+        def default_company
+          company_method = Userlist::Rails.find_reflection(config.relationship_model, config.company_model)&.name
+
+          company_method && model.try(company_method)
+        end
+      end
+    end
+  end
+end