userlist 0.2.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 366ff35750f8111ac69fba96a4f08f63b8f70a6328db3d36162f3d7b92d7250f
-  data.tar.gz: '05969b9adf2194fdaa571ca9f110229ffe9f414bb709c792a199dae7da497e6d'
+  metadata.gz: a76254952c47cc9014e31019550491b96b1a8f46814cb6e44750ddf4c4d966f1
+  data.tar.gz: 17eabd156ef0d1eda09a7480c9eb3f5822098f045123d2a2d9f33351630493d6
 SHA512:
-  metadata.gz: 6796685aeb36076ae0bdd821d6d185b9e83dd4118612ede2eae793dca67b40ae3f4eb0079f886e62423f464bcc327a32fc4f0ea7b56743adfc7f3537065bbd32
-  data.tar.gz: b34097b284e2db292f8ad84fc36d69eab34abcafc59a452305e72fcfb4722cba58f4981e9fe2d93a6bee5e21577dbca258a9597dcb1726a38f84d19304ded3bc
+  metadata.gz: 7d3311432655c8b7758d59733845558f526208874f31fee9034dbbb8a75bca653dc39b8b18007928b7fae7d2cf3efae449126c2c355bd6f3b3e5d0e82f2a24a7
+  data.tar.gz: 8531012b1ec1824c2ff60b537c641b17b534e60ea4665e476b66055f1f623ed51787c4a336402fb1adb63b1645e238008bb94ec64a2c7caf87cb21956d35111c

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/.gitignore

@@ -10,3 +10,4 @@
 
 # rspec failure tracking
 .rspec_status
+/.env

data/.rubocop.yml

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

data/Gemfile

@@ -6,3 +6,6 @@ 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
+# 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.rb

@@ -4,8 +4,35 @@ require 'userlist/version'
 require 'userlist/config'
 require 'userlist/logging'
 require 'userlist/push'
+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
+
+      super <<~MESSAGE
+        Missing required configuration value for `#{key}`
+
+        Please set a value for `#{key}` using an environment variable:
+
+          USERLIST_#{key.to_s.upcase}=some-value-here
+
+        or via the `Userlist.configure` method:
+
+          Userlist.configure do |config|
+            config.#{key} = 'some-value-here'
+          end
+      MESSAGE
+    end
+  end
+
   class << self
     def config
       @config ||= Userlist::Config.new
@@ -13,9 +40,9 @@ module Userlist
 
     def logger
       @logger ||= begin
-        logger = Logger.new(STDOUT)
+        logger = Logger.new($stdout)
         logger.progname = 'userlist'
-        logger.level = config.log_level
+        logger.level = Logger.const_get(config.log_level.to_s.upcase)
         logger
       end
     end

data/lib/userlist/config.rb

@@ -2,9 +2,12 @@ module Userlist
   class Config
     DEFAULT_CONFIGURATION = {
       push_key: nil,
-      push_endpoint: 'https://push.userlist.io/',
+      push_id: nil,
+      push_endpoint: 'https://push.userlist.com/',
       push_strategy: :threaded,
-      log_level: :warn
+      push_strategy_options: {},
+      log_level: :warn,
+      token_lifetime: 3600
     }.freeze
 
     def initialize(config_from_initialize = {})
@@ -36,6 +39,10 @@ module Userlist
       config == other.config && parent == other.parent
     end
 
+    def token_lifetime
+      self[:token_lifetime]&.to_i
+    end
+
   protected
 
     attr_reader :config, :parent
@@ -52,11 +59,11 @@ module Userlist
     end
 
     def key?(key)
-      config.key?(key) || parent && parent.key?(key)
+      config.key?(key) || parent&.key?(key)
     end
 
     def [](key)
-      config[key] || parent && parent[key]
+      config.key?(key) ? config[key] : parent && parent[key]
     end
 
     def []=(key, value)

data/lib/userlist/push.rb

@@ -1,10 +1,24 @@
 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'
+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].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
 
@@ -15,53 +29,42 @@ module Userlist
       end
     end
 
-    def initialize(config = {})
-      @config = Userlist.config.merge(config)
-      @mutex = Mutex.new
+    def initialize(configuration = {})
+      @config = Userlist.config.merge(configuration)
+      @strategy = Userlist::Push::Strategies.strategy_for(config.push_strategy, config)
     end
 
-    def event(payload = {})
-      with_mutex do
-        raise ArgumentError, 'Missing required payload hash' unless payload
-        raise ArgumentError, 'Missing required parameter :name' unless payload[:name]
-        raise ArgumentError, 'Missing required parameter :user' unless payload[:user]
-
-        payload[:occured_at] ||= Time.now
+    attr_reader :config, :strategy
 
-        strategy.call(:post, '/events', payload)
-      end
+    def events
+      @events ||= Relation.new(self, Event, [Operations::Create])
     end
-    alias track event
-
-    def user(payload = {})
-      with_mutex do
-        raise ArgumentError, 'Missing required payload hash' unless payload
-        raise ArgumentError, 'Missing required parameter :identifier' unless payload[:identifier]
 
-        strategy.call(:post, '/users', payload)
-      end
+    def users
+      @users ||= Relation.new(self, User, [Operations::Create, Operations::Delete])
     end
-    alias identify user
 
-    def company(payload = {})
-      with_mutex do
-        raise ArgumentError, 'Missing required payload hash' unless payload
-        raise ArgumentError, 'Missing required parameter :identifier' unless payload[:identifier]
-
-        strategy.call(:post, '/companies', payload)
-      end
+    def companies
+      @companies ||= Relation.new(self, Company, [Operations::Create, Operations::Delete])
     end
 
-  private
+    def relationships
+      @relationships ||= Relation.new(self, Relationship, [Operations::Create, Operations::Delete])
+    end
 
-    attr_reader :config
+    def event(payload = {})
+      events.create(payload)
+    end
 
-    def strategy
-      @strategy ||= Userlist::Push::Strategies.strategy_for(config.push_strategy, config)
+    def user(payload = {})
+      users.create(payload)
     end
 
-    def with_mutex(&block)
-      @mutex.synchronize(&block)
+    def company(payload = {})
+      companies.create(payload)
     end
+
+    alias track event
+    alias identify user
   end
 end

data/lib/userlist/push/client.rb

@@ -10,10 +10,25 @@ module Userlist
 
       def initialize(config = {})
         @config = Userlist.config.merge(config)
+
+        raise Userlist::ConfigurationError, :push_key unless @config.push_key
+        raise Userlist::ConfigurationError, :push_endpoint unless @config.push_endpoint
+      end
+
+      def get(endpoint)
+        request(Net::HTTP::Get, endpoint)
+      end
+
+      def post(endpoint, payload = nil)
+        request(Net::HTTP::Post, endpoint, payload)
+      end
+
+      def put(endpoint, payload = nil)
+        request(Net::HTTP::Put, endpoint, payload)
       end
 
-      def post(endpoint, payload = {})
-        request(endpoint, payload)
+      def delete(endpoint)
+        request(Net::HTTP::Delete, endpoint)
       end
 
     private
@@ -33,12 +48,12 @@ module Userlist
         end
       end
 
-      def request(path, payload = {})
-        request = Net::HTTP::Post.new(path)
+      def request(method, path, payload = nil)
+        request = method.new(path)
         request['Accept'] = 'application/json'
         request['Authorization'] = "Push #{token}"
         request['Content-Type'] = 'application/json; charset=UTF-8'
-        request.body = JSON.dump(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

@@ -0,0 +1,23 @@
+module Userlist
+  class Push
+    class Company < Resource
+      include Operations::Create
+      include Operations::Delete
+
+      def self.endpoint
+        '/companies'
+      end
+
+      has_many :relationships, type: 'Userlist::Push::Relationship'
+      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
+    end
+  end
+end

data/lib/userlist/push/event.rb

@@ -0,0 +1,26 @@
+module Userlist
+  class Push
+    class Event < Resource
+      include Operations::Create
+
+      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

@@ -0,0 +1,25 @@
+module Userlist
+  class Push
+    module Operations
+      module Create
+        module ClassMethods
+          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 self.included(base)
+          base.extend(ClassMethods)
+        end
+
+        def create?
+          push?
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+module Userlist
+  class Push
+    module Operations
+      module Delete
+        module ClassMethods
+          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 self.included(base)
+          base.extend(ClassMethods)
+        end
+
+        def delete?
+          true
+        end
+      end
+    end
+  end
+end

data/lib/userlist/push/relation.rb

@@ -0,0 +1,30 @@
+module Userlist
+  class Push
+    class Relation
+      def initialize(scope, type, operations = [])
+        @scope = scope
+        @type = type
+
+        operations.each { |operation| singleton_class.send(:include, operation::ClassMethods) }
+      end
+
+      attr_reader :scope, :type
+
+      def from_payload(payload, config = self.config)
+        type.from_payload(payload, config)
+      end
+
+      def endpoint
+        type.endpoint
+      end
+
+      def strategy
+        scope.strategy
+      end
+
+      def config
+        scope.config
+      end
+    end
+  end
+end

data/lib/userlist/push/relationship.rb

@@ -0,0 +1,29 @@
+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 or :company' unless payload[:user] || 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

@@ -0,0 +1,119 @@
+module Userlist
+  class Push
+    class Resource
+      class << self
+        def resource_name
+          name.split('::')[-1]
+        end
+
+        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 ||= Set.new
+        end
+
+      protected
+
+        def has_one(name, type:) # rubocop:disable Naming/PredicateName
+          relationship_names << name.to_sym
+
+          generated_methods.class_eval <<-RUBY, __FILE__, __LINE__ + 1
+            def #{name}
+              #{type}.from_payload(payload[:#{name}], config)
+            end
+          RUBY
+        end
+
+        def has_many(name, type:) # rubocop:disable Naming/PredicateName
+          relationship_names << name.to_sym
+
+          generated_methods.class_eval <<-RUBY, __FILE__, __LINE__ + 1
+            def #{name}
+              ResourceCollection.new(payload[:#{name}], #{type}, config)
+            end
+          RUBY
+        end
+
+      private
+
+        def generated_methods
+          @generated_methods ||= Module.new.tap { |mod| include mod }
+        end
+      end
+
+      attr_reader :payload, :config
+
+      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
+
+      def push?
+        true
+      end
+
+    private
+
+      def method_missing(method, *args, &block)
+        if method.to_s =~ /=$/
+          attribute = method.to_s.sub(/=$/, '')
+          payload[attribute.to_sym] = args.first
+        elsif payload.key?(method.to_sym)
+          payload[method.to_sym]
+        else
+          super
+        end
+      end
+    end
+  end
+end

data/lib/userlist/push/resource_collection.rb

@@ -0,0 +1,21 @@
+module Userlist
+  class Push
+    class ResourceCollection
+      include Enumerable
+
+      attr_reader :collection, :type, :config
+
+      def initialize(collection, type, config = Userlist.config)
+        @collection = Array(collection)
+        @type = type
+        @config = config
+      end
+
+      def each
+        collection.each do |resource|
+          yield type.from_payload(resource, config)
+        end
+      end
+    end
+  end
+end

data/lib/userlist/push/serializer.rb

@@ -0,0 +1,64 @@
+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.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/strategies/sidekiq.rb

@@ -0,0 +1,37 @@
+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)
+          ::Sidekiq::Client.push(default_options.merge(options).merge('args' => args))
+        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
+      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/threaded.rb

@@ -20,7 +20,7 @@ module Userlist
         attr_reader :queue, :worker
 
         def stop_worker
-          worker && worker.stop
+          worker&.stop
         end
       end
     end

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

@@ -19,12 +19,12 @@ module Userlist
 
             loop do
               begin
-                method, url, payload = *queue.pop
+                method, *args = *queue.pop
                 break if method == :stop
 
-                client.public_send(method, url, payload)
-              rescue StandardError => exception
-                logger.error "Failed to deliver payload: [#{exception.class.name}] #{exception.message}"
+                client.public_send(method, *args)
+              rescue StandardError => e
+                logger.error "Failed to deliver payload: [#{e.class.name}] #{e.message}"
               end
             end
 

data/lib/userlist/push/user.rb

@@ -0,0 +1,19 @@
+module Userlist
+  class Push
+    class User < Resource
+      include Operations::Create
+      include Operations::Delete
+
+      has_many :relationships, type: 'Userlist::Push::Relationship'
+      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' unless payload[:identifier]
+
+        super
+      end
+    end
+  end
+end

data/lib/userlist/token.rb

@@ -0,0 +1,68 @@
+module Userlist
+  class Token
+    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 user or identifier' unless user
+
+      user = Userlist::Push::User.from_payload(user, config)
+
+      now = Time.now.utc.to_i
+
+      header = {
+        kid: config.push_id,
+        alg: 'HS256'
+      }
+
+      payload = {
+        sub: user.identifier,
+        exp: now + config.token_lifetime,
+        iat: now
+      }
+
+      new(payload: payload, header: header, key: config.push_key).to_s
+    end
+
+    def initialize(payload:, header:, key:, algorithm: 'HS256')
+      @payload = payload
+      @header = header
+      @algorithm = algorithm
+      @key = key
+    end
+
+    def encoded_header
+      encode(header)
+    end
+
+    def encoded_payload
+      encode(payload)
+    end
+
+    def encoded_header_and_payload
+      "#{encoded_header}.#{encoded_payload}"
+    end
+
+    def signature
+      digest = OpenSSL::Digest.new(algorithm.sub('HS', 'SHA'))
+      signature = OpenSSL::HMAC.digest(digest, key, encoded_header_and_payload)
+
+      encode(signature)
+    end
+
+    def to_s
+      "#{encoded_header_and_payload}.#{signature}"
+    end
+
+  private
+
+    attr_reader :payload, :header, :algorithm, :key
+
+    def encode(payload)
+      payload = JSON.generate(payload) unless payload.is_a?(String)
+
+      Base64.urlsafe_encode64(payload).tr('=', '')
+    end
+  end
+end

data/lib/userlist/version.rb

@@ -1,3 +1,3 @@
 module Userlist
-  VERSION = '0.2.1'.freeze
+  VERSION = '0.5.0'.freeze
 end

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,10 +19,11 @@ 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 'rake', '~> 10.0'
+  spec.add_development_dependency 'bundler', '>= 1.15'
+  spec.add_development_dependency 'jwt', '~> 2.2'
+  spec.add_development_dependency 'rake', '~> 12.3', '>= 12.3.3'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'webmock', '~> 1.22'
 end

metadata

@@ -1,43 +1,63 @@
 --- !ruby/object:Gem::Specification
 name: userlist
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Benedikt Deicke
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2019-03-13 00:00:00.000000000 Z
+date: 2021-01-22 00:00:00.000000000 Z
 dependencies:
 - !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
+  name: jwt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     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
@@ -66,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
@@ -90,18 +110,31 @@ files:
 - lib/userlist/logging.rb
 - lib/userlist/push.rb
 - lib/userlist/push/client.rb
+- lib/userlist/push/company.rb
+- lib/userlist/push/event.rb
+- 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
+- lib/userlist/token.rb
 - lib/userlist/version.rb
 - userlist.gemspec
 homepage: http://github.com/userlistio/userlist-ruby
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -109,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.3
-signing_key: 
+rubygems_version: 3.1.4
+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,5 +0,0 @@
-sudo: false
-language: ruby
-rvm:
-  - 2.4.1
-before_install: gem install bundler -v 1.15.4