userlist-rails 0.5.3 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5c07d01a265094da4cbd48cf116bb6f883e22a2d3c4f6f70f36866ee02081f28
-  data.tar.gz: 2f6c5bf68403019e08188ce1cd7aeea7bda6233634633d7025161ffd54dee6f2
+  metadata.gz: 1541bb4907f73b3f85ffd2a97ca5d3040cb5128ee4dfbf6a8c5dfc1bf05c5afe
+  data.tar.gz: 4e0212563099467fa99ea690fde210dd947ec89995f095e95a7df72b6f84171a
 SHA512:
-  metadata.gz: a009f824dbc922c3dca025e0fccc6e162d19fa23f87b15d6bfd65747a155e1307666a62c04b4266778f631c6a79c0167dfc19ce490ecc91f36c5d4c8d811de94
-  data.tar.gz: 950db541f0a4715430319f116eebd90a1fdca6dbf4cadb2d15d75e384b6fe24796dc3cd43c55eb26dae2fe3f680e968b8eaedf9ee70cb55f5d44267070dd6fc0
+  metadata.gz: 83520dc930b013536d4a3278326ee07f37fdae4a303e0ea2d935ca38d168358eb2d9011eeb08902850ac88b4ac0ae6f337c3133826a1eeeaa6ca0d0740ca5c3a
+  data.tar.gz: eedce9ed77e9464da3da6c6f00306b252c69bd39ac95cc2cbf43247a852c9a29d763198e4ad69fcc179a10008e079d9889d953a41188131c837550a93132aec5

data/README.md

@@ -151,7 +151,7 @@ end
 To manually send company data into Userlist, use the `Userlist::Push.companies.push` method.
 
 ```ruby
-Userlist::Push.companies.push(user)
+Userlist::Push.companies.push(company)
 ```
 
 It's also possible to customize the payload sent to Userlist by passing a hash instead of the company object.
@@ -166,14 +166,14 @@ Userlist::Push.companies.push(identifier: company.id, name: company.name, proper
 For cases where you don't want to send specific company to Userlist you can add a `userlist_push?` method. Whenever this method doesn't return a falsey value, this company will not be sent to Userlist. This also applies to any events or relationships this company is involved in.
 
 ```ruby
-class User < ApplicationRecord
+class Account < ApplicationRecord
   def userlist_push?
-    !deleted? && !guest?
+    !deleted? && active_subscription?
   end
 end
 ```
 
-#### Deleting users
+#### Deleting companies
 
 It's also possible to delete a company from Userlist, using the `Userlist::Push.companies.delete` method.
 
@@ -233,6 +233,20 @@ class User < ApplicationRecord
 end
 ```
 
+If you don't have a dedicated model describing the relationship, you can return a hash including both the user and the company model.
+
+```ruby
+class User < ApplicationRecord
+  def userlist_relationships
+    [
+      {
+        user: self,
+        company: account
+      }
+    ]
+  end
+end
+```
 
 #### Ignoring relationships
 

data/lib/userlist/rails.rb

@@ -59,6 +59,12 @@ module Userlist
       from.reflect_on_all_associations.find { |r| r.class_name == to.to_s }
     end
 
+    def self.find_association_between(from, to)
+      return unless association = Userlist::Rails.find_reflection(from, to)
+
+      association.through_reflection || association
+    end
+
     def self.setup_callbacks(model, scope)
       return if model.instance_variable_get(:@userlist_callbacks_registered)
 

data/lib/userlist/rails/transform.rb

@@ -11,7 +11,7 @@ module Userlist
       end
 
       def [](name)
-        public_send(name) if key?(name)
+        model.try("userlist_#{name}") || public_send("default_#{name}") if key?(name)
       end
 
       def key?(name)

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

@@ -1,9 +1,12 @@
 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,
@@ -14,26 +17,37 @@ module Userlist
           ]
         end
 
-        def identifier
-          model.try(:userlist_identifier) || "#{model.class.name}-#{model.id}".parameterize
+        def default_identifier
+          "#{model.class.name}-#{model.id}".parameterize
         end
 
-        def properties
-          model.try(:userlist_properties) || {}
+        def default_properties
+          {}
         end
 
-        def relationships
-          relationships_method = Userlist::Rails.find_reflection(config.company_model, config.relationship_model)&.name
+        def default_name
+          model.try(:name)
+        end
 
-          model.try(:userlist_relationships) || (relationships_method && model.try(relationships_method))
+        def default_signed_up_at
+          model.try(:created_at)
         end
 
-        def name
-          model.try(:userlist_name) || model.try(:name)
+      private
+
+        def build_relationship(record)
+          {
+            user: record,
+            company: model
+          }
         end
 
-        def signed_up_at
-          model.try(:created_at)
+        def relationship_from
+          config.company_model
+        end
+
+        def relationship_to
+          config.user_model
         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

@@ -12,20 +12,20 @@ module Userlist
           ]
         end
 
-        def properties
-          model.try(:userlist_properties) || {}
+        def default_properties
+          {}
         end
 
-        def user
+        def default_user
           user_method = Userlist::Rails.find_reflection(config.relationship_model, config.user_model)&.name
 
-          model.try(:userlist_user) || (user_method && model.try(user_method))
+          user_method && model.try(user_method)
         end
 
-        def company
+        def default_company
           company_method = Userlist::Rails.find_reflection(config.relationship_model, config.company_model)&.name
 
-          model.try(:userlist_company) || (company_method && model.try(company_method))
+          company_method && model.try(company_method)
         end
       end
     end

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

@@ -1,9 +1,12 @@
 require 'userlist/rails/transform'
+require 'userlist/rails/transforms/has_relationships'
 
 module Userlist
   module Rails
     module Transforms
       class User < Userlist::Rails::Transform
+        include HasRelationships
+
         def self.attributes
           @attributes ||= [
             :identifier,
@@ -14,26 +17,37 @@ module Userlist
           ]
         end
 
-        def identifier
-          model.try(:userlist_identifier) || "#{model.class.name}-#{model.id}".parameterize
+        def default_identifier
+          "#{model.class.name}-#{model.id}".parameterize
         end
 
-        def properties
-          model.try(:userlist_properties) || {}
+        def default_properties
+          {}
         end
 
-        def relationships
-          relationships_method = Userlist::Rails.find_reflection(config.user_model, config.relationship_model)&.name
+        def default_email
+          model.try(:email)
+        end
 
-          model.try(:userlist_relationships) || (relationships_method && model.try(relationships_method))
+        def default_signed_up_at
+          model.try(:created_at)
         end
 
-        def email
-          model.try(:userlist_email) || model.try(:email)
+      private
+
+        def build_relationship(record)
+          {
+            user: model,
+            company: record
+          }
         end
 
-        def signed_up_at
-          model.try(:created_at)
+        def relationship_from
+          config.user_model
+        end
+
+        def relationship_to
+          config.company_model
         end
       end
     end

data/lib/userlist/rails/version.rb

@@ -1,5 +1,5 @@
 module Userlist
   module Rails
-    VERSION = '0.5.3'.freeze
+    VERSION = '0.6.0'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: userlist-rails
 version: !ruby/object:Gem::Version
-  version: 0.5.3
+  version: 0.6.0
 platform: ruby
 authors:
 - Benedikt Deicke
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-04-15 00:00:00.000000000 Z
+date: 2021-05-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -189,6 +189,7 @@ files:
 - lib/userlist/rails/tasks/userlist.rake
 - lib/userlist/rails/transform.rb
 - lib/userlist/rails/transforms/company.rb
+- lib/userlist/rails/transforms/has_relationships.rb
 - lib/userlist/rails/transforms/relationship.rb
 - lib/userlist/rails/transforms/user.rb
 - lib/userlist/rails/version.rb