userlist-rails 0.2.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ef228cf5cb636af878d4c252b272ad9cdb4bd6ab462ddcb9ad0cfacc71a191fb
-  data.tar.gz: e9577e9c3db7171665106a8b10977adeff7a05a90e6a892521667891701e9ec3
+  metadata.gz: 9fe4b336d98e1d3015aa44aa9a261c37bf160747573d6507f44f533a14e6e4dd
+  data.tar.gz: 77261e5a6972ce2b0f0d0ea43e141c3d4c33011790c01a8fd32749743c35b342
 SHA512:
-  metadata.gz: 5b197cf9e6078baa517cd15a6cb8ee156164f37e154378b915bf024767adcdc155ffdb4323be007de9617e6f5194ce92b2e38d314c49513056650c4e2b2d08fe
-  data.tar.gz: 3f2f7a0c82ae87ec3c66f8595bdd9a994d5c33ea2e806764bc29770248b93931d820ac10caeceafde4469b234e342d5c6d4465ab99f47467ae5c66c30bfb5a01
+  metadata.gz: a3843cb90d6f4868179c43972e3b0877f8d1cd2e02637b03799f9778571d1115c44ee6c7dc320407d50e0cea7305d1b019d6bb63526b42f8dd109d180b015834
+  data.tar.gz: 5147105865f3bfccc0750823f69889e76c34d7cd2f18b149fc6cd4ffc8bb7e80a3103cccd88dc14a2f3520bf9747b1cfbceaee1cf313ae37ecec3cf2a5fcc406

data/.github/workflows/test.yml

@@ -0,0 +1,22 @@
+name: Tests
+on: [push]
+jobs:
+  build:
+    strategy:
+      matrix:
+        ruby:
+          - 2.4
+          - 2.4
+          - 2.5
+          - 2.6
+          - 2.7
+          - 3.0
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - name: RSpec
+        run: bundle exec rake

data/.rubocop.yml

@@ -1,10 +1,12 @@
 AllCops:
-  TargetRubyVersion: 2.2
+  TargetRubyVersion: 2.4
+  NewCops: enable
+  SuggestExtensions: false
   Exclude:
     - 'bin/*'
     - 'Guardfile'
 
-Metrics/LineLength:
+Layout/LineLength:
   Enabled: false
 
 Metrics/ModuleLength:
@@ -32,13 +34,10 @@ Layout/ElseAlignment:
 Lint/AssignmentInCondition:
   Enabled: false
 
-Lint/EndAlignment:
-  EnforcedStyleAlignWith: start_of_line
-
 Layout/AccessModifierIndentation:
   EnforcedStyle: outdent
 
-Layout/AlignParameters:
+Layout/ParameterAlignment:
   EnforcedStyle: with_fixed_indentation
 
 Style/FrozenStringLiteralComment:

data/CODE_OF_CONDUCT.md

@@ -55,7 +55,7 @@ further defined and clarified by project maintainers.
 ## Enforcement
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting the project team at benedikt@benediktdeicke.com. All
+reported by contacting the project team at support@userlist.com. All
 complaints will be reviewed and investigated and will result in a response that
 is deemed necessary and appropriate to the circumstances. The project team is
 obligated to maintain confidentiality with regard to the reporter of an incident.

data/Gemfile

@@ -4,7 +4,7 @@ git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 gemspec
 
-gem 'userlist', github: 'userlistio/userlist-ruby', branch: 'master'
+gem 'userlist', github: 'userlist/userlist-ruby', branch: 'master'
 
 gem 'guard-rspec', '~> 4.7'
 gem 'guard-rubocop', '~> 1.3'

data/README.md

@@ -1,6 +1,6 @@
-# Userlist::Rails
+# Userlist for Ruby on Rails [![Build Status](https://github.com/userlist/userlist-rails/workflows/Tests/badge.svg)](https://github.com/userlist/userlist-rails)
 
-This gem helps with integrating [Userlist.io](http://userlist.io) into Ruby on Rails applications.
+This gem helps with integrating [Userlist](http://userlist.com) into Ruby on Rails applications.
 
 ## Installation
 
@@ -20,14 +20,15 @@ Or install it yourself as:
 
 ## Configuration
 
-The only required configuration is the Push API key. You can get your Push API key via the [Push API settings](https://app.userlist.io/settings/push) in your Userlist.io account.
+The only required configuration is the Push API key. You can get your Push API key via the [Push API settings](https://app.userlist.com/settings/push) in your Userlist account.
 
-Configuration values can either be set via an initializer or as environment variables. The environment take precedence over configuration values from the initializer. Please refer to the [userlist-ruby](http://github.com/userlistio/userlist-ruby) gem for additional configuration options.
+Configuration values can either be set via an initializer or as environment variables. The environment take precedence over configuration values from the initializer. Please refer to the [userlist](http://github.com/userlist/userlist-ruby) gem for additional configuration options.
 
 Configuration via environment variables:
 
 ```shell
-USERLIST_PUSH_KEY=401e5c498be718c0a38b7da7f1ce5b409c56132a49246c435ee296e07bf2be39
+USERLIST_PUSH_KEY=VvB7pjDrv0V2hoaOCeZ5rIiUEPbEhSUN
+USERLIST_PUSH_ID=6vPkJl44cm82y4aLBIzaOhuEHJd0Bm7b
 ```
 
 Configuration via an initializer:
@@ -35,17 +36,40 @@ Configuration via an initializer:
 ```ruby
 # config/initializer/userlist.rb
 Userlist.configure do |config|
-  config.push_key = '401e5c498be718c0a38b7da7f1ce5b409c56132a49246c435ee296e07bf2be39'
+  config.push_key = 'VvB7pjDrv0V2hoaOCeZ5rIiUEPbEhSUN'
+  config.push_id = '6vPkJl44cm82y4aLBIzaOhuEHJd0Bm7b'
+end
+```
+
+In addition to the configuration options of the [userlist](http://github.com/userlist/userlist-ruby#configuration) gem, the following options are available.
+
+| Name            | Default value                | Description                                                                                                          |
+| --------------- | ---------------------------- | -------------------------------------------------------------------------------------------------------------------- |
+| `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`                                   |
+| `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.                                                     |
+
+### Disabling in development and test environments
+
+As sending test and development data into data into Userlist isn't very desirable, you can disable transmissions by setting the push strategy to `:null`.
+
+```ruby
+# config/initializer/userlist.rb
+Userlist.configure do |config|
+  config.push_strategy = :null unless Rails.env.production?
 end
 ```
 
 ## Usage
 
+> ⚠️ **Important:** If you're using [Segment](https://segment.com) in combination with this gem, please make sure that both are using the same user identifier. By default, this gem will send `"user-#{id}"` (a combination of the user's primary key in the database and the `user-` prefix) as identifier. Either customize the `userlist_identifier` method on your User model, or ensure that you use the same identifier in your Segment integration.
+
 ### Tracking Users
 
 #### Sending user data automatically
 
-By default, this gem will automatically detect your `User` model and create and update the corresponding user inside of Userlist. To customize the `identifier`, `email`, or `properties` transmitted for a user, you can overwrite the according methods in your `User` model.
+By default, this gem will automatically detect your `User` model and create, update, and delete the corresponding user inside of Userlist. To customize the `identifier`, `email`, or `properties` transmitted for a user, you can overwrite the according methods in your `User` model.
 
 ```ruby
 class User < ApplicationRecord
@@ -65,18 +89,30 @@ end
 
 #### Sending user data manually
 
-To manually send user data into Userlist, use the `Userlist::Push.user` method.
+To manually send user data into Userlist, use the `Userlist::Push.users.push` method.
+
+```ruby
+Userlist::Push.users.push(user)
+```
+
+It's also possible to customize the payload sent to Userlist by passing a hash instead of the user object.
 
 ```ruby
-Userlist::Push.event(identifier: user.id, email: user.email, properties: { first_name: user.first_name, last_name: user.last_name })
+Userlist::Push.users.push(identifier: user.id, email: user.email, properties: { first_name: user.first_name, last_name: user.last_name })
+```
+
+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.event` method.
+To track custom events use the `Userlist::Push.events.push` method.
 
 ```ruby
-Userlist::Push.event(name: 'project_created', user: current_user, properties: { project_name: project.name })
+Userlist::Push.events.push(name: 'project_created', user: current_user, properties: { project_name: project.name })
 ```
 
 It is possible to make the `user` property optional by setting it for the entire request using an `around_action` callback in your `ApplicationController`.
@@ -94,7 +130,21 @@ end
 This simplifies the tracking call for the current request.
 
 ```ruby
-Userlist::Push.event(name: 'project_created', properties: { project_name: project.name })
+Userlist::Push.events.push(name: 'project_created', properties: { project_name: project.name })
+```
+
+### Enabling in-app messages
+
+In order to use in-app messages, please set both the `push_key` and `push_id` configuration variables. Afterwards, include the `userlist_script_tag` helper into your application's layout for signed in users.
+
+```erb
+<%= userlist_script_tag %>
+```
+
+By default, the helper will try to use the `current_user` helper to read the currently signed in user. You can change the default bebahvior by passing a different user. The passed object must respond to the `userlist_identifier` method.
+
+```erb
+<%= userlist_script_tag(user) %>
 ```
 
 ### Batch importing
@@ -113,7 +163,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/userlistio/userlist-rails. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at <https://github.com/userlist/userlist-rails>. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## License
 
@@ -121,4 +171,12 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the Userlist::Rails project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/userlistio/userlist-rails/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the Userlist::Rails project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/userlist/userlist-rails/blob/master/CODE_OF_CONDUCT.md).
+
+## What is Userlist?
+
+[![Userlist](https://userlist.com/images/external/userlist-logo-github.svg)](https://userlist.com/)
+
+[Userlist](https://userlist.com/) allows you to onboard and engage your SaaS users with targeted behavior-based campaigns using email or in-app messages.
+
+Userlist was started in 2017 as an alternative to bulky enterprise messaging tools. We believe that running SaaS products should be more enjoyable. Learn more [about us](https://userlist.com/about-us/).

data/lib/userlist/rails.rb

@@ -14,6 +14,17 @@ module Userlist
       Thread.current[:userlist_current_user]
     end
 
+    def self.with_current_company(company)
+      Thread.current[:userlist_current_company] = company
+      yield
+    ensure
+      Thread.current[:userlist_current_company] = nil
+    end
+
+    def self.current_company
+      Thread.current[:userlist_current_company]
+    end
+
     def self.detect_model(*names)
       names.each do |name|
         begin
@@ -25,5 +36,49 @@ module Userlist
 
       nil
     end
+
+    def self.detect_relationship(from, to)
+      return unless reflection = find_reflection(from, to)
+
+      reflection.through_reflection.klass if reflection.through_reflection?
+    end
+
+    def self.find_reflection(from, to)
+      return unless from && to
+
+      from.reflect_on_all_associations.find { |r| r.class_name == to.to_s }
+    end
+
+    def self.setup_callbacks(model, scope)
+      return if model.instance_variable_get(:@userlist_callbacks_registered)
+
+      setup_callback(:create,  model, scope, :push)
+      setup_callback(:update,  model, scope, :push)
+      setup_callback(:destroy, model, scope, :delete)
+
+      model.instance_variable_set(:@userlist_callbacks_registered, true)
+    end
+
+    def self.setup_callback(type, model, scope, method)
+      return unless callback_method = [:after_commit, :"after_#{type}"].find { |m| model.respond_to?(m) }
+
+      callback = lambda do
+        begin
+          relation = Userlist::Push.public_send(scope)
+          relation.public_send(method, self)
+        rescue Userlist::Error => e
+          Userlist.logger.error "Failed to #{method} #{method.to_s.singularize}: #{e.message}"
+        end
+      end
+
+      model.public_send(callback_method, callback, on: type)
+    end
+
+    def self.setup_extensions
+      Userlist::Push::User.include(Userlist::Rails::Extensions::User)
+      Userlist::Push::Company.include(Userlist::Rails::Extensions::Company)
+      Userlist::Push::Relationship.include(Userlist::Rails::Extensions::Relationship)
+      Userlist::Push::Event.include(Userlist::Rails::Extensions::Event)
+    end
   end
 end

data/lib/userlist/rails/config.rb

@@ -1,12 +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,
-        auto_discover: true
+        relationship_model: nil,
+        auto_discover: true,
+        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
@@ -18,13 +27,11 @@ module Userlist
       end
 
       def user_model
-        model = super
-        model && model.to_s.constantize
+        (model = super) && model.is_a?(Class) ? model : model&.to_s&.constantize
       end
 
       def company_model
-        model = super
-        model && model.to_s.constantize
+        (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

@@ -0,0 +1,20 @@
+module Userlist
+  module Rails
+    module Extensions
+      module Event
+        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
+          end
+        end
+
+        def self.included(base)
+          base.extend(ClassMethods)
+        end
+      end
+    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

@@ -0,0 +1,31 @@
+module Userlist
+  module Rails
+    module Helpers
+      def userlist_script_tag(*args) # rubocop:disable Metrics/CyclomaticComplexity
+        config = Userlist.config
+        logger = Userlist.logger
+
+        options = args.extract_options!
+
+        user = args.first
+        user ||= current_user if respond_to?(:current_user)
+        user ||= Userlist::Rails.current_user
+
+        options[:async] = true
+
+        if user
+          options[:data] ||= {}
+          options[:data][:userlist] = Userlist::Token.generate(user, config)
+        end
+
+        script_tag = javascript_tag('window.userlist=window.userlist||function(){(userlist.q=userlist.q||[]).push(arguments)};')
+        include_tag = javascript_include_tag(config.script_url, options)
+
+        script_tag + include_tag
+      rescue Userlist::Error => e
+        logger.error(e.message)
+        raw("<!-- #{e.class}: #{e.message} -->") unless ::Rails.env.production?
+      end
+    end
+  end
+end

data/lib/userlist/rails/railtie.rb

@@ -3,29 +3,46 @@ require 'rails/railtie'
 require 'userlist'
 require 'userlist/config'
 require 'userlist/rails/logger'
-require 'userlist/rails/push'
-require 'userlist/rails/user'
-require 'userlist/rails/company'
+
+require 'userlist/rails/extensions/user'
+require 'userlist/rails/extensions/company'
+require 'userlist/rails/extensions/relationship'
+require 'userlist/rails/extensions/event'
+
+require 'userlist/rails/helpers'
 
 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)
         end
       end
 
+      initializer 'userlist.helpers' do
+        ActiveSupport.on_load :action_view do
+          include Userlist::Rails::Helpers
+        end
+      end
+
       initializer 'userlist.extensions' do
-        Userlist::Push.send(:prepend, Userlist::Rails::Push)
+        Userlist::Rails.setup_extensions
       end
 
       initializer 'userlist.models' do
@@ -35,18 +52,24 @@ 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')
+            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.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.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)
+        public_send(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?(:push?) || model.push?)
+      end
+
+      def delete?
+        (!model.respond_to?(:delete?) || model.delete?)
+      end
+
+    private
+
+      attr_reader :model, :config
+    end
+  end
+end

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

@@ -0,0 +1,41 @@
+require 'userlist/rails/transform'
+
+module Userlist
+  module Rails
+    module Transforms
+      class Company < Userlist::Rails::Transform
+        def self.attributes
+          @attributes ||= [
+            :identifier,
+            :properties,
+            :relationships,
+            :name,
+            :signed_up_at
+          ]
+        end
+
+        def identifier
+          model.try(:userlist_identifier) || "#{model.class.name}-#{model.id}".parameterize
+        end
+
+        def properties
+          model.try(:userlist_properties) || {}
+        end
+
+        def relationships
+          relationships_method = Userlist::Rails.find_reflection(config.company_model, config.relationship_model)&.name
+
+          model.try(:userlist_relationships) || (relationships_method && model.try(relationships_method))
+        end
+
+        def name
+          model.try(:userlist_name) || model.try(:name)
+        end
+
+        def signed_up_at
+          model.try(:created_at)
+        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 properties
+          model.try(:userlist_properties) || {}
+        end
+
+        def user
+          user_method = Userlist::Rails.find_reflection(config.relationship_model, config.user_model)&.name
+
+          model.try(:userlist_user) || (user_method && model.try(user_method))
+        end
+
+        def company
+          company_method = Userlist::Rails.find_reflection(config.relationship_model, config.company_model)&.name
+
+          model.try(:userlist_company) || (company_method && model.try(company_method))
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,41 @@
+require 'userlist/rails/transform'
+
+module Userlist
+  module Rails
+    module Transforms
+      class User < Userlist::Rails::Transform
+        def self.attributes
+          @attributes ||= [
+            :identifier,
+            :properties,
+            :relationships,
+            :email,
+            :signed_up_at
+          ]
+        end
+
+        def identifier
+          model.try(:userlist_identifier) || "#{model.class.name}-#{model.id}".parameterize
+        end
+
+        def properties
+          model.try(:userlist_properties) || {}
+        end
+
+        def relationships
+          relationships_method = Userlist::Rails.find_reflection(config.user_model, config.relationship_model)&.name
+
+          model.try(:userlist_relationships) || (relationships_method && model.try(relationships_method))
+        end
+
+        def email
+          model.try(:userlist_email) || model.try(:email)
+        end
+
+        def signed_up_at
+          model.try(:created_at)
+        end
+      end
+    end
+  end
+end

data/lib/userlist/rails/version.rb

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

data/userlist-rails.gemspec

@@ -7,9 +7,9 @@ Gem::Specification.new do |spec|
   spec.name        = 'userlist-rails'
   spec.version     = Userlist::Rails::VERSION
   spec.authors     = ['Benedikt Deicke']
-  spec.email       = ['benedikt@userlist.io']
+  spec.email       = ['benedikt@userlist.com']
   spec.homepage    = 'https://github.com/userlistio/userlist-rails'
-  spec.summary     = 'Rails integration for Userlist.io'
+  spec.summary     = 'Rails integration for Userlist'
   spec.license     = 'MIT'
 
   spec.files       = `git ls-files -z`.split("\x0").reject do |f|
@@ -19,13 +19,17 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'activesupport', '>= 3.0'
-  spec.add_dependency 'railties', '>= 3.0'
-  spec.add_dependency 'userlist', '~> 0.2'
+  spec.required_ruby_version = '>= 2.4'
 
-  spec.add_development_dependency 'bundler', '~> 1.15'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_dependency 'activesupport', '>= 5.0'
+  spec.add_dependency 'railties', '>= 5.0'
+  spec.add_dependency 'userlist', '~> 0.5'
+
+  spec.add_development_dependency 'actionpack', '>= 5.0'
+  spec.add_development_dependency 'activerecord', '>= 5.0'
+  spec.add_development_dependency 'bundler', '>= 1.15'
+  spec.add_development_dependency 'rake', '~> 12.3', '>= 12.3.3'
   spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'sqlite3'
-  spec.add_development_dependency 'webmock', '~> 1.22'
+  spec.add_development_dependency 'rspec-rails', '~> 3.0'
+  spec.add_development_dependency 'sqlite3', '>= 1.4'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: userlist-rails
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Benedikt Deicke
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2018-11-21 00:00:00.000000000 Z
+date: 2021-01-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -16,54 +16,82 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: railties
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: userlist
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '0.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.15'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.15'
 - !ruby/object:Gem::Dependency
@@ -72,14 +100,20 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -95,44 +129,44 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: sqlite3
+  name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: webmock
+  name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.22'
+        version: '1.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.22'
-description: 
+        version: '1.4'
+description:
 email:
-- benedikt@userlist.io
+- benedikt@userlist.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/test.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
-- ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Guardfile
@@ -142,22 +176,28 @@ files:
 - bin/console
 - bin/setup
 - bin/test
-- lib/tasks/userlist.rake
 - lib/userlist/rails.rb
-- lib/userlist/rails/company.rb
 - lib/userlist/rails/config.rb
+- lib/userlist/rails/extensions/company.rb
+- lib/userlist/rails/extensions/event.rb
+- lib/userlist/rails/extensions/relationship.rb
+- lib/userlist/rails/extensions/user.rb
+- lib/userlist/rails/helpers.rb
 - lib/userlist/rails/importer.rb
 - lib/userlist/rails/logger.rb
-- lib/userlist/rails/push.rb
 - lib/userlist/rails/railtie.rb
-- lib/userlist/rails/user.rb
+- lib/userlist/rails/tasks/userlist.rake
+- lib/userlist/rails/transform.rb
+- lib/userlist/rails/transforms/company.rb
+- lib/userlist/rails/transforms/relationship.rb
+- lib/userlist/rails/transforms/user.rb
 - lib/userlist/rails/version.rb
 - userlist-rails.gemspec
 homepage: https://github.com/userlistio/userlist-rails
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -165,16 +205,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.3
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
-summary: Rails integration for Userlist.io
+summary: Rails integration for Userlist
 test_files: []

data/.travis.yml

@@ -1,7 +0,0 @@
----
-sudo: false
-language: ruby
-cache: bundler
-rvm:
-  - 2.5.0
-before_install: gem install bundler -v 1.17.1

data/lib/userlist/rails/company.rb

@@ -1,42 +0,0 @@
-require 'active_support/concern'
-require 'userlist/push'
-
-module Userlist
-  module Rails
-    module Company
-      extend ActiveSupport::Concern
-
-      included do
-        block = lambda do
-          Userlist::Push.company(userlist_payload)
-        end
-
-        if respond_to?(:after_commit)
-          after_commit(&block)
-        elsif respond_to?(:after_save)
-          after_save(&block)
-        end
-      end
-
-      def userlist_identifier
-        "#{self.class.name}-#{id}".parameterize
-      end
-
-      def userlist_properties
-        {}
-      end
-
-      def userlist_payload
-        {
-          identifier: userlist_identifier,
-          name: userlist_name,
-          properties: userlist_properties
-        }
-      end
-
-      def userlist_name
-        return name if respond_to?(:name)
-      end
-    end
-  end
-end

data/lib/userlist/rails/push.rb

@@ -1,39 +0,0 @@
-module Userlist
-  module Rails
-    module Push
-      def event(payload = {})
-        payload[:user] ||= Userlist::Rails.current_user
-
-        super(transform_payload(payload))
-      end
-      alias track event
-
-      def user(payload = {})
-        super(transform_payload(payload))
-      end
-      alias identify user
-
-    private
-
-      def transform_payload(payload)
-        payload = transform_value(payload)
-
-        return payload unless payload.is_a?(Hash)
-
-        payload.transform_values do |value|
-          result = transform_value(value)
-          result = transform_payload(result) if result.is_a?(Hash)
-          result
-        end
-      end
-
-      def transform_value(value)
-        if value.respond_to?(:userlist_payload)
-          value.send(:userlist_payload)
-        else
-          value
-        end
-      end
-    end
-  end
-end

data/lib/userlist/rails/user.rb

@@ -1,48 +0,0 @@
-require 'active_support/concern'
-require 'userlist/push'
-
-module Userlist
-  module Rails
-    module User
-      extend ActiveSupport::Concern
-
-      included do
-        block = lambda do
-          Userlist::Push.user(userlist_payload)
-        end
-
-        if respond_to?(:after_commit)
-          after_commit(&block)
-        elsif respond_to?(:after_save)
-          after_save(&block)
-        end
-      end
-
-      def userlist_identifier
-        "#{self.class.name}-#{id}".parameterize
-      end
-
-      def userlist_properties
-        {}
-      end
-
-      def userlist_email
-        return email if respond_to?(:email)
-      end
-
-      def userlist_company
-        nil
-      end
-
-      def userlist_payload
-        {
-          identifier: userlist_identifier,
-          email: userlist_email,
-          company: userlist_company,
-          properties: userlist_properties,
-          signed_up_at: created_at
-        }
-      end
-    end
-  end
-end