userlist 0.4.1 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d654ea7675fae65eaef3bd08958b6e565ad8cee82ddf8c00d25dc647bb04b047
-  data.tar.gz: 29ac435d2b7df8df2563d952c7c0f40557519e1fcd8fe035dbdd6bf61b420692
+  metadata.gz: 93b343c10d2614536619adc6ab7ecfa1ceb1f2a778e7748425f2fb7df3316a21
+  data.tar.gz: 55ad33ee9a9aef2ee81b0ffb507016bb25a8fc7844205520c7f0a48ec0de9f76
 SHA512:
-  metadata.gz: 6f725c5b9060d012eecf0bc99475687fb38df01c9111eb066a6cbdd4f3393b0aff1b0cd93d9c948c0b788f7ecdbc93f62efe525573c99ba95e8a5ee7aa3205ff
-  data.tar.gz: ee7fdc2e800edad20bdda9753b447b6da599ea14588c98247750af0ab63f3eaf74c2c3d1233c21f8e09b8e8de3e796bb9cf0068344f633ba99059944ad3a0140
+  metadata.gz: 0113f93c4b9a64c559f052900edef4677bd0ec0000e97b68daebb81b50614d7df83076d0e668d1cd8f2a65fa973600b92589db0a622ab45d8f5797cbea1e3bef
+  data.tar.gz: 8dba2559f0660836a11ef6b5b709f76399f1e8b7b2dfdfd4d4caf54ffac2c0cd6f7775bcd7ee801c4dc6bbd10698cd208b4d4b4a672f9636d846265553767f4c

data/.github/workflows/test.yml

@@ -0,0 +1,21 @@
+name: Tests
+on: [push]
+jobs:
+  build:
+    strategy:
+      matrix:
+        ruby:
+          - 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,5 +1,6 @@
 AllCops:
-  TargetRubyVersion: 2.3
+  TargetRubyVersion: 2.4
+  NewCops: enable
   Exclude:
     - 'bin/*'
     - 'Guardfile'

data/Gemfile

@@ -7,3 +7,5 @@ gemspec
 gem 'guard-rspec', '~> 4.7'
 gem 'guard-rubocop', '~> 1.3'
 gem 'rubocop', '~> 0.68'
+
+gem 'sidekiq'

data/README.md

@@ -1,8 +1,8 @@
-# Userlist [![Build Status](https://travis-ci.com/userlistio/userlist-ruby.svg?branch=master)](https://travis-ci.com/userlistio/userlist-ruby)
+# Userlist for Ruby  [![Build Status](https://github.com/userlist/userlist-ruby/workflows/Tests/badge.svg)](https://github.com/userlist/userlist-ruby)
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/userlist`. To experiment with that code, run `bin/console` for an interactive prompt.
+This gem helps with integrating [Userlist](https://userlist.com) into Ruby applications.
 
-TODO: Delete this and the text above, and describe your gem
+> To integrate Userlist into a Ruby on Rails application, please use [userlist-rails](https://github.com/userlist/userlist-rails)
 
 ## Installation
 
@@ -20,9 +20,180 @@ Or install it yourself as:
 
     $ gem install userlist
 
+## 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.com/settings/push) in your Userlist account.
+
+Configuration values can either be set via the `Userlist.configure` method or as environment variables. The environment variables take precedence over configuration values from the initializer.
+
+Configuration via environment variables:
+
+```shell
+USERLIST_PUSH_KEY=VvB7pjDrv0V2hoaOCeZ5rIiUEPbEhSUN
+USERLIST_PUSH_ID=6vPkJl44cm82y4aLBIzaOhuEHJd0Bm7b
+```
+
+Configuration via an initializer:
+
+```ruby
+Userlist.configure do |config|
+  config.push_key = 'VvB7pjDrv0V2hoaOCeZ5rIiUEPbEhSUN'
+  config.push_id = '6vPkJl44cm82y4aLBIzaOhuEHJd0Bm7b'
+end
+```
+
+The possible configuration values are listed in the table below.
+
+| Name                    | Default value                | Description                                                                                                                 |
+| ----------------------- | ---------------------------- | --------------------------------------------------------------------------------------------------------------------------- |
+| `push_key`              | `nil`                        | The push key for your account. See [Push API settings](https://app.userlist.com/settings/push).                             |
+| `push_id`               | `nil`                        | The push id for your account. See [Push API settings](https://app.userlist.com/settings/push).                              |
+| `push_endpoint`         | `https://push.userlist.com/` | The HTTP endpoint that the library will send data to.                                                                       |
+| `push_strategy`         | `:threaded`                  | The strategy to use to send data to the HTTP endpoint. Possible values are `:threaded`, `:sidekiq`, `:direct`, and `:null`. |
+| `push_strategy_options` | `{}`                         | Any additional options for the push strategy.                                                                               |
+| `log_level`             | `:warn`                      | The log level for Userlist related log messages. Possible values are `:debug`, `:error`, `:fatal`, `:info`, and `:warn`     |
+| `token_lifetime`        | `3600`                       | The lifetime of generated in-app messages tokens in seconds                                                                 |
+
+### 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
+Userlist.configure do |config|
+  config.push_strategy = :null
+end
+```
+
 ## Usage
 
-TODO: Write usage instructions here
+This library is a wrapper for Userlist's Push API. For details about the accepted payloads, please check [its documentation](https://userlist.com/docs/getting-started/integration-guide/).
+
+### Tracking Users
+
+To manually send user data into Userlist, use the `Userlist::Push.users.push` method.
+
+```ruby
+Userlist::Push.users.push(
+  identifier: 'user-1',
+  email: 'foo@example.com',
+  properties: {
+    first_name: 'Foo',
+    last_name: 'Example'
+  }
+)
+```
+
+It's also possible to delete a user from Userlist, using the `Userlist::Push.users.delete` method.
+
+```ruby
+Userlist::Push.users.delete('user-1')
+```
+
+### Tracking Companies
+
+To manually send company data into Userlist, use the `Userlist::Push.companies.push` method.
+
+```ruby
+Userlist::Push.companies.push(
+  identifier: 'company-1',
+  email: 'Example, Inc.',
+  properties: {
+    industry: 'Software Testing'
+  }
+)
+```
+
+It's also possible to delete a user from Userlist, using the `Userlist::Push.companies.delete` method.
+
+```ruby
+Userlist::Push.companies.delete('user-1')
+```
+
+### Tracking Relationships
+
+Tracking relationships can either be done using nested properties in user or company payloads or via the `Userlist::Push.relationships.push` method.
+
+```ruby
+Userlist::Push.relationships.push(
+  user: 'user-1',
+  company: 'company-1',
+  properties: {
+    role: 'owner'
+  }
+)
+```
+
+This is equivalent to specifying the relationship on the user model.
+
+```ruby
+Userlist::Push.users.push(
+  identifier: 'user-1',
+  relationships: [
+    {
+      company: 'company-1',
+      properties: {
+        role: 'owner'
+      }
+    }
+  ]
+)
+```
+
+It's also equivalent specifying the relationship on the company model.
+
+```ruby
+Userlist::Push.companies.push(
+  identifier: 'company-1',
+  relationships: [
+    {
+      user: 'user-1',
+      properties: {
+        role: 'owner'
+      }
+    }
+  ]
+)
+```
+
+### Tracking Events
+
+To track custom events use the `Userlist::Push.events.push` method.
+
+```ruby
+Userlist::Push.events.push(
+  name: 'project_created',
+  user: 'user-1',
+  properties: {
+    project_name: 'Example project'
+  }
+)
+```
+
+Instead of just sending a user or company identifier, it's also possible to expand the properties into objects. This will update the user / company record as well as trigger the event in one operation.
+
+```ruby
+Userlist::Push.events.push(
+  name: 'project_created',
+  user: {
+    identifier: 'user-1',
+    properties: {
+      projects: 5
+    }
+  },
+  properties: {
+    project_name: 'Example project'
+  }
+)
+```
+
+### Tokens for in-app messages
+
+In order to use in-app messages, you must create a JWT token for the currently signed in user on the server side. To do this, please configure both the `push_key` and the `push_id` configuration variables. Afterwards, you can use the `Userlist::Token.generate` method to get a signed token for the given user identifier.
+
+```ruby
+Userlist::Token.generate('user-1')
+# => "eyJraWQiOiI2dlBrSmw0NGNtODJ5NGFMQkl6YU9odU...kPGe8KX8JZBTQ"
+```
 
 ## Development
 
@@ -32,7 +203,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/[USERNAME]/userlist. 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-ruby>. 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
 
@@ -40,4 +211,12 @@ The gem is available as open source under the terms of the [MIT License](http://
 
 ## Code of Conduct
 
-Everyone interacting in the Userlist project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/userlist/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the Userlist project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/userlist/userlist-ruby/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/config.rb

@@ -3,8 +3,9 @@ module Userlist
     DEFAULT_CONFIGURATION = {
       push_key: nil,
       push_id: nil,
-      push_endpoint: 'https://push.userlist.io/',
+      push_endpoint: 'https://push.userlist.com/',
       push_strategy: :threaded,
+      push_strategy_options: {},
       log_level: :warn,
       token_lifetime: 3600
     }.freeze

data/lib/userlist/push/client.rb

@@ -53,7 +53,7 @@ module Userlist
         request['Accept'] = 'application/json'
         request['Authorization'] = "Push #{token}"
         request['Content-Type'] = 'application/json; charset=UTF-8'
-        request.body = JSON.dump(payload) if payload
+        request.body = JSON.generate(payload) if payload
 
         logger.debug "Sending #{request.method} to #{URI.join(endpoint, request.path)} with body #{request.body}"
 

data/lib/userlist/push/company.rb

@@ -1,13 +1,20 @@
 module Userlist
   class Push
     class Company < Resource
+      include Operations::Create
+      include Operations::Delete
+
       def self.endpoint
         '/companies'
       end
 
-      def initialize(attributes = {})
-        raise Userlist::ArgumentError, 'Missing required attributes hash' unless attributes
-        raise Userlist::ArgumentError, 'Missing required parameter :identifier' unless attributes[:identifier]
+      has_many :relationships, type: 'Userlist::Push::Relationship', inverse: :company
+      has_many :users, type: 'Userlist::Push::User'
+      has_one  :user, type: 'Userlist::Push::User'
+
+      def initialize(payload = {}, config = Userlist.config)
+        raise Userlist::ArgumentError, 'Missing required payload hash' unless payload
+        raise Userlist::ArgumentError, 'Missing required parameter :identifier' unless payload[:identifier]
 
         super
       end

data/lib/userlist/push/event.rb

@@ -1,15 +1,26 @@
 module Userlist
   class Push
     class Event < Resource
-      def initialize(attributes = {})
-        raise Userlist::ArgumentError, 'Missing required attributes hash' unless attributes
-        raise Userlist::ArgumentError, 'Missing required parameter :name' unless attributes[:name]
-        raise Userlist::ArgumentError, 'Missing required parameter :user' unless attributes[:user]
+      include Operations::Create
 
-        attributes[:occured_at] ||= Time.now
+      has_one :user, type: 'Userlist::Push::User'
+      has_one :company, type: 'Userlist::Push::Company'
+
+      def initialize(payload = {}, config = Userlist.config)
+        raise Userlist::ArgumentError, 'Missing required payload' unless payload
+        raise Userlist::ArgumentError, 'Missing required parameter :name' unless payload[:name]
+        raise Userlist::ArgumentError, 'Missing required parameter :user or :company' unless payload[:user] || payload[:company]
 
         super
       end
+
+      def occured_at
+        payload[:occured_at] || Time.now
+      end
+
+      def push?
+        (user.nil? || user.push?) && (company.nil? || company.push?)
+      end
     end
   end
 end

data/lib/userlist/push/operations/create.rb

@@ -3,17 +3,22 @@ module Userlist
     module Operations
       module Create
         module ClassMethods
-          def create(payload = {})
-            resource = from_payload(payload)
-            strategy.call(:post, endpoint, resource.attributes)
+          def create(payload = {}, config = self.config)
+            return false unless resource = from_payload(payload, config)
+
+            strategy.call(:post, endpoint, resource) if resource.create?
           end
 
           alias push create
         end
 
-        def included(base)
+        def self.included(base)
           base.extend(ClassMethods)
         end
+
+        def create?
+          push?
+        end
       end
     end
   end

data/lib/userlist/push/operations/delete.rb

@@ -3,14 +3,20 @@ module Userlist
     module Operations
       module Delete
         module ClassMethods
-          def delete(identifier)
-            strategy.call(:delete, "#{endpoint}/#{identifier}")
+          def delete(payload = {}, config = self.config)
+            return false unless resource = from_payload(payload, config)
+
+            strategy.call(:delete, resource.url) if resource.delete?
           end
         end
 
-        def included(base)
+        def self.included(base)
           base.extend(ClassMethods)
         end
+
+        def delete?
+          true
+        end
       end
     end
   end

data/lib/userlist/push/relation.rb

@@ -10,10 +10,8 @@ module Userlist
 
       attr_reader :scope, :type
 
-    private
-
-      def from_payload(payload)
-        type.new(payload)
+      def from_payload(payload, config = self.config)
+        type.from_payload(payload, config)
       end
 
       def endpoint
@@ -23,6 +21,10 @@ module Userlist
       def strategy
         scope.strategy
       end
+
+      def config
+        scope.config
+      end
     end
   end
 end

data/lib/userlist/push/relationship.rb

@@ -0,0 +1,30 @@
+module Userlist
+  class Push
+    class Relationship < Resource
+      include Operations::Create
+      include Operations::Delete
+
+      has_one :user, type: 'Userlist::Push::User'
+      has_one :company, type: 'Userlist::Push::Company'
+
+      def initialize(payload = {}, config = Userlist.config)
+        raise Userlist::ArgumentError, 'Missing required payload' unless payload
+        raise Userlist::ArgumentError, 'Missing required parameter :user' unless payload[:user]
+        raise Userlist::ArgumentError, 'Missing required parameter :company' unless payload[:company]
+
+        super
+      end
+
+      def url
+        raise Userlist::Error, "Cannot generate url for #{self.class.name} without a user" unless user
+        raise Userlist::Error, "Cannot generate url for #{self.class.name} without a company" unless company
+
+        "#{self.class.endpoint}/#{user.identifier}/#{company.identifier}"
+      end
+
+      def push?
+        user&.push? && company&.push?
+      end
+    end
+  end
+end

data/lib/userlist/push/resource.rb

@@ -9,18 +9,103 @@ module Userlist
         def endpoint
           "/#{resource_name.downcase}s"
         end
+
+        def from_payload(payload, config = Userlist.config)
+          return payload if payload.nil?
+          return payload if payload.is_a?(self)
+
+          payload = { identifier: payload } if payload.is_a?(String) || payload.is_a?(Numeric)
+
+          new(payload, config)
+        end
+
+        def relationship_names
+          @relationship_names ||= relationships.keys
+        end
+
+        def relationships
+          @relationships ||= {}
+        end
+
+      protected
+
+        def has_one(name, type:) # rubocop:disable Naming/PredicateName
+          relationships[name.to_sym] = { type: type }
+
+          generated_methods.class_eval <<-RUBY, __FILE__, __LINE__ + 1
+            def #{name}
+              #{type}.from_payload(payload[:#{name}], config)
+            end
+          RUBY
+        end
+
+        def has_many(name, **options) # rubocop:disable Naming/PredicateName
+          relationships[name.to_sym] = options
+
+          generated_methods.class_eval <<-RUBY, __FILE__, __LINE__ + 1
+            def #{name}
+              relationship = self.class.relationships[:#{name}]
+
+              ResourceCollection.new(payload[:#{name}], relationship, self, config)
+            end
+          RUBY
+        end
+
+      private
+
+        def generated_methods
+          @generated_methods ||= Module.new.tap { |mod| include mod }
+        end
       end
 
-      attr_reader :attributes
+      attr_reader :payload, :config
 
-      def initialize(attributes = {})
-        @attributes = attributes
+      def initialize(payload = {}, config = Userlist.config)
+        @payload = payload
+        @config = config
       end
 
       def respond_to_missing?(method, include_private = false)
         attribute = method.to_s.sub(/=$/, '')
+        payload.key?(attribute.to_sym) || super
+      end
+
+      def to_hash
+        Serializer.serialize(self)
+      end
+      alias to_h to_hash
+
+      def to_json(*args)
+        to_hash.to_json(*args)
+      end
+
+      def url
+        "#{self.class.endpoint}/#{identifier}"
+      end
+
+      def identifier
+        payload[:identifier]
+      end
+
+      def hash
+        self.class.hash & payload.hash
+      end
+
+      def eql?(other)
+        hash == other.hash
+      end
+      alias == eql?
+
+      def attribute_names
+        payload.keys.map(&:to_sym) - relationship_names
+      end
+
+      def relationship_names
+        self.class.relationship_names.to_a
+      end
 
-        attributes.key?(attribute.to_sym) || super
+      def push?
+        true
       end
 
     private
@@ -28,9 +113,9 @@ module Userlist
       def method_missing(method, *args, &block)
         if method.to_s =~ /=$/
           attribute = method.to_s.sub(/=$/, '')
-          attributes[attribute.to_sym] = args.first
-        elsif attributes.key?(method.to_sym)
-          attributes[method.to_sym]
+          payload[attribute.to_sym] = args.first
+        elsif payload.key?(method.to_sym)
+          payload[method.to_sym]
         else
           super
         end

data/lib/userlist/push/resource_collection.rb

@@ -0,0 +1,32 @@
+module Userlist
+  class Push
+    class ResourceCollection
+      include Enumerable
+
+      attr_reader :collection, :relationship, :owner, :config
+
+      def initialize(collection, relationship, owner, config = Userlist.config)
+        @collection = Array(collection)
+        @relationship = relationship
+        @owner = owner
+        @config = config
+      end
+
+      def each
+        collection.each do |resource|
+          resource[inverse] = owner if inverse && resource.is_a?(Hash)
+
+          yield type.from_payload(resource, config)
+        end
+      end
+
+      def type
+        Object.const_get(relationship[:type])
+      end
+
+      def inverse
+        relationship[:inverse]
+      end
+    end
+  end
+end

data/lib/userlist/push/serializer.rb

@@ -0,0 +1,66 @@
+require 'set'
+
+module Userlist
+  class Push
+    class Serializer
+      def self.serialize(resource)
+        new.serialize(resource)
+      end
+
+      def serialize(resource)
+        resource = serialize_resource(resource) if resource.is_a?(Userlist::Push::Resource)
+        resource
+      end
+
+    private
+
+      def serialize_resource(resource)
+        return resource.identifier if serialized_resources.include?(resource)
+
+        serialized_resources << resource
+
+        return unless resource.push?
+
+        serialized = {}
+
+        resource.attribute_names.each do |name|
+          serialized[name] = resource.send(name)
+        end
+
+        resource.relationship_names.each do |name|
+          next unless result = serialize_relationship(resource.send(name))
+
+          serialized[name] = result
+        end
+
+        serialized
+      end
+
+      def serialize_relationship(relationship)
+        return unless relationship
+
+        case relationship
+        when Userlist::Push::ResourceCollection
+          serialize_collection(relationship)
+        when Userlist::Push::Resource
+          serialize_resource(relationship)
+        else
+          raise "Cannot serialize relationship type: #{relationship.class}"
+        end
+      end
+
+      def serialize_collection(collection)
+        serialized = collection
+          .map(&method(:serialize_relationship))
+          .compact
+          .reject(&:empty?)
+
+        serialized unless serialized.empty?
+      end
+
+      def serialized_resources
+        @serialized_resources ||= Set.new
+      end
+    end
+  end
+end

data/lib/userlist/push/strategies/sidekiq/worker.rb

@@ -0,0 +1,18 @@
+require 'sidekiq'
+
+module Userlist
+  class Push
+    module Strategies
+      class Sidekiq
+        class Worker
+          include ::Sidekiq::Worker
+
+          def perform(method, *args)
+            client = Userlist::Push::Client.new
+            client.public_send(method, *args)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/userlist/push/strategies/sidekiq.rb

@@ -0,0 +1,45 @@
+require 'sidekiq'
+
+require 'userlist/push/strategies/sidekiq/worker'
+
+module Userlist
+  class Push
+    module Strategies
+      class Sidekiq
+        def initialize(config = {})
+          @config = Userlist.config.merge(config)
+        end
+
+        def call(*args)
+          payload = default_options
+            .merge(options)
+            .merge('args' => normalize(args))
+
+          ::Sidekiq::Client.push(payload)
+        end
+
+      private
+
+        attr_reader :config
+
+        def options
+          @options ||= begin
+            options = config.push_strategy_options || {}
+            options.each_with_object({}) { |(k, v), h| h[k.to_s] = v }
+          end
+        end
+
+        def default_options
+          {
+            'class' => 'Userlist::Push::Strategies::Sidekiq::Worker',
+            'queue' => 'default'
+          }
+        end
+
+        def normalize(args)
+          JSON.parse(JSON.generate(args))
+        end
+      end
+    end
+  end
+end

data/lib/userlist/push/strategies.rb

@@ -1,17 +1,31 @@
-require 'userlist/push/strategies/null'
-require 'userlist/push/strategies/direct'
-require 'userlist/push/strategies/threaded'
-
 module Userlist
   class Push
     module Strategies
       def self.strategy_for(strategy, config = {})
-        strategy = Userlist::Push::Strategies.const_get(strategy.to_s.capitalize) if strategy.is_a?(Symbol) || strategy.is_a?(String)
-
+        strategy = lookup_strategy(strategy)
         strategy = strategy.new(config) if strategy.respond_to?(:new)
 
         strategy
       end
+
+      def self.lookup_strategy(strategy)
+        return strategy unless strategy.is_a?(Symbol) || strategy.is_a?(String)
+
+        require_strategy(strategy)
+        const_get(strategy.to_s.capitalize, false)
+      end
+
+      def self.strategy_defined?(strategy)
+        return true unless strategy.is_a?(Symbol) || strategy.is_a?(String)
+
+        const_defined?(strategy.to_s.capitalize, false)
+      end
+
+      def self.require_strategy(strategy)
+        return unless strategy.is_a?(Symbol) || strategy.is_a?(String)
+
+        require("userlist/push/strategies/#{strategy}") unless strategy_defined?(strategy)
+      end
     end
   end
 end

data/lib/userlist/push/user.rb

@@ -1,9 +1,16 @@
 module Userlist
   class Push
     class User < Resource
-      def initialize(attributes = {})
-        raise Userlist::ArgumentError, 'Missing required attributes hash' unless attributes
-        raise Userlist::ArgumentError, 'Missing required parameter :identifier' unless attributes[:identifier]
+      include Operations::Create
+      include Operations::Delete
+
+      has_many :relationships, type: 'Userlist::Push::Relationship', inverse: :user
+      has_many :companies, type: 'Userlist::Push::Company'
+      has_one  :company, type: 'Userlist::Push::Company'
+
+      def initialize(payload = {}, config = Userlist.config)
+        raise Userlist::ArgumentError, 'Missing required payload' unless payload
+        raise Userlist::ArgumentError, 'Missing required parameter :identifier or :email' unless payload[:identifier] || payload[:email]
 
         super
       end

data/lib/userlist/push.rb

@@ -2,6 +2,7 @@ require 'userlist/push/client'
 require 'userlist/push/strategies'
 
 require 'userlist/push/resource'
+require 'userlist/push/resource_collection'
 require 'userlist/push/relation'
 
 require 'userlist/push/operations/create'
@@ -9,12 +10,15 @@ require 'userlist/push/operations/delete'
 
 require 'userlist/push/user'
 require 'userlist/push/company'
+require 'userlist/push/relationship'
 require 'userlist/push/event'
 
+require 'userlist/push/serializer'
+
 module Userlist
   class Push
     class << self
-      [:event, :track, :user, :identify, :company, :users, :events, :companies].each do |method|
+      [:event, :track, :user, :identify, :company, :users, :events, :companies, :relationships].each do |method|
         define_method(method) { |*args| default_push_instance.send(method, *args) }
       end
 
@@ -44,6 +48,10 @@ module Userlist
       @companies ||= Relation.new(self, Company, [Operations::Create, Operations::Delete])
     end
 
+    def relationships
+      @relationships ||= Relation.new(self, Relationship, [Operations::Create, Operations::Delete])
+    end
+
     def event(payload = {})
       events.create(payload)
     end

data/lib/userlist/token.rb

@@ -1,11 +1,13 @@
 module Userlist
   class Token
-    def self.generate(identifier, configuration = {})
+    def self.generate(user, configuration = {})
       config = Userlist.config.merge(configuration)
 
       raise Userlist::ConfigurationError, :push_key unless config.push_key
       raise Userlist::ConfigurationError, :push_id unless config.push_id
-      raise Userlist::ArgumentError, 'Missing required identifier' unless identifier
+      raise Userlist::ArgumentError, 'Missing required user or identifier' unless user
+
+      user = Userlist::Push::User.from_payload(user, config)
 
       now = Time.now.utc.to_i
 
@@ -15,7 +17,7 @@ module Userlist
       }
 
       payload = {
-        sub: identifier,
+        sub: user.identifier,
         exp: now + config.token_lifetime,
         iat: now
       }

data/lib/userlist/version.rb

@@ -1,3 +1,3 @@
 module Userlist
-  VERSION = '0.4.1'.freeze
+  VERSION = '0.7.1'.freeze
 end

data/lib/userlist.rb

@@ -8,16 +8,16 @@ require 'userlist/token'
 
 module Userlist
   class Error < StandardError; end
+
   class ArgumentError < Error; end
+
   class ConfigurationError < Error
     attr_reader :key
 
     def initialize(key)
       @key = key.to_sym
-    end
 
-    def message
-      <<~MESSAGE
+      super <<~MESSAGE
         Missing required configuration value for `#{key}`
 
         Please set a value for `#{key}` using an environment variable:
@@ -40,7 +40,7 @@ module Userlist
 
     def logger
       @logger ||= begin
-        logger = Logger.new(STDOUT)
+        logger = Logger.new($stdout)
         logger.progname = 'userlist'
         logger.level = Logger.const_get(config.log_level.to_s.upcase)
         logger

data/userlist.gemspec

@@ -6,9 +6,9 @@ Gem::Specification.new do |spec|
   spec.name          = 'userlist'
   spec.version       = Userlist::VERSION
   spec.authors       = ['Benedikt Deicke']
-  spec.email         = ['benedikt@userlist.io']
+  spec.email         = ['benedikt@userlist.com']
 
-  spec.summary       = 'Ruby wrapper for the Userlist.io API'
+  spec.summary       = 'Ruby wrapper for the Userlist API'
   spec.homepage      = 'http://github.com/userlistio/userlist-ruby'
   spec.license       = 'MIT'
 
@@ -19,7 +19,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.required_ruby_version = '>= 2.3'
+  spec.required_ruby_version = '>= 2.4'
 
   spec.add_development_dependency 'bundler', '>= 1.15'
   spec.add_development_dependency 'jwt', '~> 2.2'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: userlist
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.7.1
 platform: ruby
 authors:
 - Benedikt Deicke
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-03-16 00:00:00.000000000 Z
+date: 2022-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -86,17 +86,17 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.22'
-description: 
+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
@@ -115,10 +115,15 @@ files:
 - lib/userlist/push/operations/create.rb
 - lib/userlist/push/operations/delete.rb
 - lib/userlist/push/relation.rb
+- lib/userlist/push/relationship.rb
 - lib/userlist/push/resource.rb
+- lib/userlist/push/resource_collection.rb
+- lib/userlist/push/serializer.rb
 - lib/userlist/push/strategies.rb
 - lib/userlist/push/strategies/direct.rb
 - lib/userlist/push/strategies/null.rb
+- lib/userlist/push/strategies/sidekiq.rb
+- lib/userlist/push/strategies/sidekiq/worker.rb
 - lib/userlist/push/strategies/threaded.rb
 - lib/userlist/push/strategies/threaded/worker.rb
 - lib/userlist/push/user.rb
@@ -129,7 +134,7 @@ homepage: http://github.com/userlistio/userlist-ruby
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -137,15 +142,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.3'
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.4
-signing_key: 
+rubygems_version: 3.2.32
+signing_key:
 specification_version: 4
-summary: Ruby wrapper for the Userlist.io API
+summary: Ruby wrapper for the Userlist API
 test_files: []

data/.travis.yml

@@ -1,7 +0,0 @@
-language: ruby
-rvm:
-  - 2.3
-  - 2.4
-  - 2.5
-  - 2.6
-  - 2.7