userlist-rails 0.5.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9fe4b336d98e1d3015aa44aa9a261c37bf160747573d6507f44f533a14e6e4dd
-  data.tar.gz: 77261e5a6972ce2b0f0d0ea43e141c3d4c33011790c01a8fd32749743c35b342
+  metadata.gz: c4361f8f73c39543b0250633d22c4d758ac4b43cb073d160bce946ac14390c39
+  data.tar.gz: 59e21c2a6579d36c4b50545f858dbb30c1a63e9e1dc7de69dacfbf87201707cf
 SHA512:
-  metadata.gz: a3843cb90d6f4868179c43972e3b0877f8d1cd2e02637b03799f9778571d1115c44ee6c7dc320407d50e0cea7305d1b019d6bb63526b42f8dd109d180b015834
-  data.tar.gz: 5147105865f3bfccc0750823f69889e76c34d7cd2f18b149fc6cd4ffc8bb7e80a3103cccd88dc14a2f3520bf9747b1cfbceaee1cf313ae37ecec3cf2a5fcc406
+  metadata.gz: 776f506a31ac8db648d2e8fb6ccdf846abba9fe4d8c04f4b6b0143ebd5a6711719b6c627a7191016d529ed76c3c8ab880da797823d85b6846e767a89ff473e68
+  data.tar.gz: 1984ab2272f68b9b6dddea36cac787ec1bd278da08630b4c168fd25a3aa6fca1fead8936415f28d80c58532cc866cc9b1ea13512ad4cb4c5a202bcf84c598f11

data/README.md

@@ -47,6 +47,7 @@ In addition to the configuration options of the [userlist](http://github.com/use
 | --------------- | ---------------------------- | -------------------------------------------------------------------------------------------------------------------- |
 | `user_model`    | `nil`                        | The user model to use. Will be automatically set when `auto_discover` is `true`                                      |
 | `company_model` | `nil`                        | The company model to use. Will be automatically set when `auto_discover` is `true`                                   |
+| `relationship_model` | `nil`                        | The relationship model to use. Will be automatically infered from the user and company models                                   |
 | `auto_discover` | `true`                       | The gem will try to automatically identify your `User` and `Company` models. Possible values are `true` and `false`. |
 | `script_url`    | `https://js.userlist.com/v1` | The script url to load the Userlist in-app messages script from.                                                     |
 
@@ -101,36 +102,167 @@ It's also possible to customize the payload sent to Userlist by passing a hash i
 Userlist::Push.users.push(identifier: user.id, email: user.email, properties: { first_name: user.first_name, last_name: user.last_name })
 ```
 
+#### Ignoring users
+
+For cases where you don't want to send specific user to Userlist you can add a `userlist_push?` method. Whenever this method doesn't return a falsey value, this user will not be sent to Userlist. This also applies to any events or relationships this user is involved in.
+
+```ruby
+class User < ApplicationRecord
+  def userlist_push?
+    !deleted? && !guest?
+  end
+end
+```
+
+#### Deleting users
+
 It's also possible to delete a user from Userlist, using the `Userlist::Push.users.delete` method.
 
 ```ruby
 Userlist::Push.users.delete(user)
 ```
 
-### Tracking Events
 
-To track custom events use the `Userlist::Push.events.push` method.
+### Tracking Companies
+
+#### Sending company data automatically
+
+By default, this gem will automatically detect your company model (like `Account`, `Company`, `Team`, `Organization`) and create, update, and delete the corresponding company inside of Userlist. To customize the `identifier`, `name`, or `properties` transmitted for a company, you can overwrite the according methods in your company model.
+
+```ruby
+class Account < ApplicationRecord
+  def userlist_properties
+    { projects: projects.count }
+  end
+
+  def userlist_identifier
+    "account-#{id}"
+  end
+
+  def userlist_name
+    name
+  end
+end
+```
+
+
+#### Sending company data manually
+
+To manually send company data into Userlist, use the `Userlist::Push.companies.push` method.
+
+```ruby
+Userlist::Push.companies.push(user)
+```
+
+It's also possible to customize the payload sent to Userlist by passing a hash instead of the company object.
+
+```ruby
+Userlist::Push.companies.push(identifier: company.id, name: company.name, properties: { projects: company.projects.count })
+```
+
+
+#### Ignoring companies
+
+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
+  def userlist_push?
+    !deleted? && !guest?
+  end
+end
+```
+
+#### Deleting users
+
+It's also possible to delete a company from Userlist, using the `Userlist::Push.companies.delete` method.
+
+```ruby
+Userlist::Push.companies.delete(company)
+```
+
+### Tracking relationships
+
+Userlist supports n:m relationships between users and companies. This gem will try to figure out the model your application uses to describe these relationships by looking at the associations defined in your user and company models. When sending a user to Userlist, this gem will try to automatically include the user's relationships as well. This includes information about the relationships and companies this user is associated with, but not information about other users associated with any of the companies. This works the other way around as well. When sending a company, it'll try to automatically include the company's relationships, but not any information about the associated users' other companies.
 
 ```ruby
-Userlist::Push.events.push(name: 'project_created', user: current_user, properties: { project_name: project.name })
+user = User.create(email: 'foo@example.com')
+user.companies.create(name: 'Example, Inc.')
+
+Userlist::Push.users.push(user)
+
+# Payload sent to Userlist
+{
+  identifier: 'user-1',
+  email: 'foo@example.com',
+  relationships: [
+    {
+      user: 'user-identifier',
+      company: {
+        identifier: 'company-identifier',
+        name: 'Example, Inc.',
+      }
+    }
+  ]
+}
 ```
 
-It is possible to make the `user` property optional by setting it for the entire request using an `around_action` callback in your `ApplicationController`.
+Similar to users and events, these relationships may define a `userlist_properties` method to provide addition properties that describe the relationship.
 
 ```ruby
-class ApplicationController < ActionController::Base
-  around_action :setup_userlist_current_user
+class Membership < ApplicationRecord
+  belongs_to :user
+  belongs_to :account
 
-  def setup_userlist_current_user(&block)
-    Userlist::Rails.with_current_user(current_user, &block)
+  def userlist_properties
+    { role: role }
   end
 end
 ```
 
-This simplifies the tracking call for the current request.
+
+#### Customizing relationship lookup
+
+It's possible to customize the way this gem looks up relationships for users and companies by specifying a `userlist_relationships` method on the user and/or company model.  
+
+```ruby
+class User < ApplicationRecord
+  def userlist_relationships
+    memberships.where(role: 'owner')
+  end
+end
+```
+
+
+#### Ignoring relationships
+
+This gem automatically ignore relationship if either the user or the company is ignored. However, in some cases it might be desirable to ignore relationships even when they connect to valid objects. A typical example for this are pending invitations. To support this use case, you can provide a `userlist_push?` method. Whenever this method doesn't return a falsey value, this relationship will not be sent to Userlist.
+
+```ruby
+class Membership < ApplicationRecord
+  belongs_to :user
+  belongs_to :account
+
+  def userlist_push?
+    pending?
+  end
+end
+```
+
+#### Deleting relationships
+
+It's also possible to delete a relationship from Userlist, using the `Userlist::Push.relationship.delete` method.
+
+```ruby
+Userlist::Push.relationship.delete(membership)
+```
+
+### Tracking Events
+
+To track custom events use the `Userlist::Push.events.push` method. Events can be related to a user, a company, or both.
 
 ```ruby
-Userlist::Push.events.push(name: 'project_created', properties: { project_name: project.name })
+Userlist::Push.events.push(name: 'project_created', user: current_user, company: current_account, properties: { project_name: project.name })
 ```
 
 ### Enabling in-app messages

data/lib/userlist/rails.rb

@@ -3,6 +3,14 @@ require 'userlist/rails/railtie'
 
 module Userlist
   module Rails
+    DEPRECATED_MODEL_METHODS = [
+      :userlist_push,
+      :userlist_delete,
+      :userlist_payload,
+      :userlist_company,
+      :userlist_user
+    ].freeze
+
     def self.with_current_user(user)
       Thread.current[:userlist_current_user] = user
       yield
@@ -80,5 +88,37 @@ module Userlist
       Userlist::Push::Relationship.include(Userlist::Rails::Extensions::Relationship)
       Userlist::Push::Event.include(Userlist::Rails::Extensions::Event)
     end
+
+    def self.check_deprecations(type)
+      deprecated_methods = (type.instance_methods + type.private_instance_methods) & DEPRECATED_MODEL_METHODS
+
+      if deprecated_methods.any?
+        raise <<~MESSAGE
+          Deprecation warning for userlist-rails
+
+          Customizing the way userlist-rails works has changed.
+
+          Using the #{deprecated_methods.to_sentence} method(s) on your #{type.name} model is not supported anymore.
+
+          For details on how to customize the gem's behavior, please see https://github.com/userlist/userlist-rails or reach out to support@userlist.com
+        MESSAGE
+      end
+
+      deprecated_methods = type.private_instance_methods.grep(/userlist_/)
+
+      if deprecated_methods.any?
+        raise <<~MESSAGE
+          Deprecation warning for userlist-rails
+
+          Customizing the way userlist-rails works has changed.
+
+          Using private methods (like #{deprecated_methods.to_sentence}) on your #{type.name} model is not supported anymore. Please use public methods instead.
+
+          For details on how to customize the gem's behavior, please see https://github.com/userlist/userlist-rails or reach out to support@userlist.com
+        MESSAGE
+      end
+
+      true
+    end
   end
 end

data/lib/userlist/rails/config.rb

@@ -34,6 +34,10 @@ module Userlist
         (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)
     end
   end

data/lib/userlist/rails/railtie.rb

@@ -53,17 +53,19 @@ module Userlist
             Userlist.logger.info('Automatically discovering models')
 
             userlist.user_model = Userlist::Rails.detect_model('User')
-            userlist.company_model = Userlist::Rails.detect_model('Account', 'Company')
+            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}")
+            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}")
+            Userlist::Rails.check_deprecations(company_model)
             Userlist::Rails.setup_callbacks(company_model, :companies)
           end
 

data/lib/userlist/rails/version.rb

@@ -1,5 +1,5 @@
 module Userlist
   module Rails
-    VERSION = '0.5.0'.freeze
+    VERSION = '0.5.1'.freeze
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: userlist-rails
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Benedikt Deicke