userlist 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0daab0d50220fa6b5c0d48e80d7f111a8210bf056e0bc3d6a6cdfaf83eaaa3ee
-  data.tar.gz: d0affd71246a055a7d9df690e46b367d51843374fa997c8d8966b5305e0f2699
+  metadata.gz: c8436f1e9a2b5dff59fcceedbe0ce2d334c8288ce231eb0db7da388881efb099
+  data.tar.gz: 882e26f3f57562b399c43ad9e47aa16f008e1593042d490ea2b1f0611239347d
 SHA512:
-  metadata.gz: 38384feae2887a004965247299dd904e98c00171a124e6c0dd3dbdba8cf35dde5bf1bc585a00191d625232ea84b18a0efac9ac850bbde988d949b5e00d1478a0
-  data.tar.gz: 4048869ac0a9b1c5f267df46bb33bda34fb6aeb3eac7c0de2af8b88512b9fc16ed60ff2b32193a790696c71cb7285cbd3fd8794c8ceed3cb6f4a3488e6537407
+  metadata.gz: 3224339ad8347c83f530907f0a968b0e245d1082c4337becc9be5395437cf39ef6370195e9fcf7a0361d60c34f6acf112a28ca43a3ed202af157bcd192ed0e68
+  data.tar.gz: 433c0b6ee940f418f2d4de5ed6dd5cf161f1cc4f10c68a938106591e5518e8e653697cc8b625f3cee591082b528b914d937c01d331ad053cfc6ddfed90d808f5

data/.gitignore

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

data/.rubocop.yml

@@ -1,10 +1,10 @@
 AllCops:
-  TargetRubyVersion: 2.2
+  TargetRubyVersion: 2.3
   Exclude:
     - 'bin/*'
     - 'Guardfile'
 
-Metrics/LineLength:
+Layout/LineLength:
   Enabled: false
 
 Metrics/ModuleLength:
@@ -32,13 +32,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/.travis.yml

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

data/Gemfile

@@ -6,4 +6,4 @@ gemspec
 
 gem 'guard-rspec', '~> 4.7'
 gem 'guard-rubocop', '~> 1.3'
-gem 'rubocop', '= 0.68'
+gem 'rubocop', '~> 0.68'

data/lib/userlist/config.rb

@@ -2,9 +2,11 @@ module Userlist
   class Config
     DEFAULT_CONFIGURATION = {
       push_key: nil,
+      push_id: nil,
       push_endpoint: 'https://push.userlist.io/',
       push_strategy: :threaded,
-      log_level: :warn
+      log_level: :warn,
+      token_lifetime: 3600
     }.freeze
 
     def initialize(config_from_initialize = {})
@@ -36,6 +38,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,7 +58,7 @@ module Userlist
     end
 
     def key?(key)
-      config.key?(key) || parent && parent.key?(key)
+      config.key?(key) || parent&.key?(key)
     end
 
     def [](key)

data/lib/userlist/push/client.rb

@@ -10,6 +10,9 @@ 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)

data/lib/userlist/push/company.rb

@@ -6,8 +6,8 @@ module Userlist
       end
 
       def initialize(attributes = {})
-        raise ArgumentError, 'Missing required attributes hash' unless attributes
-        raise ArgumentError, 'Missing required parameter :identifier' unless attributes[:identifier]
+        raise Userlist::ArgumentError, 'Missing required attributes hash' unless attributes
+        raise Userlist::ArgumentError, 'Missing required parameter :identifier' unless attributes[:identifier]
 
         super
       end

data/lib/userlist/push/event.rb

@@ -2,9 +2,9 @@ module Userlist
   class Push
     class Event < Resource
       def initialize(attributes = {})
-        raise ArgumentError, 'Missing required attributes hash' unless attributes
-        raise ArgumentError, 'Missing required parameter :name' unless attributes[:name]
-        raise ArgumentError, 'Missing required parameter :user' unless attributes[:user]
+        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]
 
         attributes[:occured_at] ||= Time.now
 

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/user.rb

@@ -2,8 +2,8 @@ module Userlist
   class Push
     class User < Resource
       def initialize(attributes = {})
-        raise ArgumentError, 'Missing required attributes hash' unless attributes
-        raise ArgumentError, 'Missing required parameter :identifier' unless attributes[:identifier]
+        raise Userlist::ArgumentError, 'Missing required attributes hash' unless attributes
+        raise Userlist::ArgumentError, 'Missing required parameter :identifier' unless attributes[:identifier]
 
         super
       end

data/lib/userlist/token.rb

@@ -0,0 +1,66 @@
+module Userlist
+  class Token
+    def self.generate(identifier, 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
+
+      now = Time.now.utc.to_i
+
+      header = {
+        kid: config.push_id,
+        alg: 'HS256'
+      }
+
+      payload = {
+        sub: 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.3.0'.freeze
+  VERSION = '0.4.0'.freeze
 end

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
+    end
+
+    def message
+      <<~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

data/userlist.gemspec

@@ -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.2'
+  spec.required_ruby_version = '>= 2.3'
 
   spec.add_development_dependency 'bundler', '>= 1.15'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  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,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: userlist
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Benedikt Deicke
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-06-27 00:00:00.000000000 Z
+date: 2020-03-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -24,20 +24,40 @@ dependencies:
     - - ">="
       - !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
@@ -102,6 +122,7 @@ files:
 - 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
@@ -116,14 +137,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.2'
+      version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.4
 signing_key: 
 specification_version: 4
 summary: Ruby wrapper for the Userlist.io API