knockapi 0.4.11 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0ddc00df3cb669fa52a54e7e26232a07667b7206b7ebe79b9df585ca23c4ddae
-  data.tar.gz: 9a96083148d5c5c822782643a8d3e8b86f7baf7ea9e2e38802b6a4c7ad1dcccb
+  metadata.gz: d2393f1d0c19c88f4969519059063b0b71a4f5a936f40abb6e7521e519830e1b
+  data.tar.gz: 2f6f91ec95d57f8dd8c52c74bbd6506d4d978626ff17f4d77c0bb4acfabff6d2
 SHA512:
-  metadata.gz: 9759c24b6bb7b3625832e4eb820ab63522dac55c65a42c7e81dc196dd5ccaad2db1ab90013e25d109bc94692c52ee83b3826955bd2a26f21dcb1677f0cff64eb
-  data.tar.gz: 3c790e4b2cefbb69c5cb7c2b856ad651b0ffe525b4f48cc0b4807537998c643abef5bf74e73491b71df421f21184efd3e20777032a0465d1fefe3bf75ba88e02
+  metadata.gz: 3348c75410ed7a5b26522243eb7a41a54aec41e1750d9afe5f401ba34efb4284b3fd16f6ad7b42195ef08da98d2b04a9df6eae28b9ac118b81fb89dba28feeba
+  data.tar.gz: c0b60143532820fa86dbca11bb81b3f030253158edd5dd998198d11235a6fe2c3f8cbf3106ad56f7064a1741822037a0b2f9a448dcaa05684abafecb76d2d6c3

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    knockapi (0.4.11)
+    knockapi (0.5.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -26,7 +26,10 @@ Or, you may set the key yourself in an initializer:
 
 ```ruby
 # /config/initializers/knock.rb
-Knock.key = 'sk_12345'
+Knock.configure do |config|
+  config.key = '[your api key]'
+  config.timeout = 120
+end
 ```
 
 ## Usage
@@ -34,10 +37,6 @@ Knock.key = 'sk_12345'
 ### Identifying users
 
 ```ruby
-require "knock"
-
-Knock.key = "sk_12345"
-
 Knock::Users.identify(
   id: "jhammond",
   data: {
@@ -50,10 +49,6 @@ Knock::Users.identify(
 ### Sending notifies (triggering workflows)
 
 ```ruby
-require "knock"
-
-Knock.key = "sk_12345"
-
 # The key of the workflow (from Knock dashboard)
 Knock::Workflows.trigger(
   key: "dinosaurs-loose",
@@ -74,29 +69,18 @@ Knock::Workflows.trigger(
 ### Retrieving users
 
 ```ruby
-require "knock"
-
-Knock.key = "sk_12345"
-
 Knock::Users.get(id: "jhammond")
 ```
 
 ### Deleting users
 
 ```ruby
-require "knock"
-
-Knock.key = "sk_12345"
-
 Knock::Users.delete(id: "jhammond")
 ```
 
 ### Preferences
 
 ```ruby
-require "knock"
-Knock.key = "sk_12345"
-
 # Set an entire preference set
 Knock::Users.set_preferences(
   user_id: "jhammond",
@@ -115,9 +99,6 @@ Knock::Users.get_preferences(user_id: "jhammond")
 ### Getting and setting channel data
 
 ```ruby
-require "knock"
-Knock.key = "sk_12345"
-
 # Set channel data for an APNS
 Knock::Users.set_channel_data(
   id: "jhammond",
@@ -134,9 +115,6 @@ Knock::Users.get_channel_data(user_id: "jhammond", channel_id: KNOCK_APNS_CHANNE
 ### Cancelling workflows
 
 ```ruby
-require "knock"
-Knock.key = "sk_12345"
-
 Knock::Workflows.cancel(
   key: "dinosaurs-loose",
   cancellation_key: trigger_alert.id,

data/lib/knock/bulk_operations.rb

@@ -7,7 +7,6 @@ module Knock
   # Provides convienience methods for working with bulk operations
   module BulkOperations
     class << self
-      include Base
       include Client
 
       # Retrieves the given bulk operation

data/lib/knock/client.rb

@@ -2,20 +2,27 @@
 
 module Knock
   # A Net::HTTP based API client for interacting with the Knock API
+  # rubocop:disable Metrics/ModuleLength
   module Client
     include Kernel
 
     def client
-      return @client if defined?(@client)
-
-      @client = Net::HTTP.new(Knock::API_HOSTNAME, 443)
-      @client.use_ssl = true
-
-      @client
+      Net::HTTP.new(Knock.config.api_hostname, 443).tap do |http_client|
+        http_client.use_ssl = true
+        http_client.open_timeout = Knock.config.timeout
+        http_client.read_timeout = Knock.config.timeout
+        http_client.write_timeout = Knock.config.timeout if RUBY_VERSION >= '2.6.0'
+      end
     end
 
     def execute_request(request:)
-      response = client.request(request)
+      begin
+        response = client.request(request)
+      rescue Net::OpenTimeout, Net::ReadTimeout, Net::WriteTimeout
+        raise TimeoutError.new(
+          message: 'API Timeout Error'
+        )
+      end
 
       http_status = response.code.to_i
       handle_error_response(response: response) if http_status >= 400
@@ -32,7 +39,7 @@ module Knock
         'Content-Type' => 'application/json'
       )
 
-      request['Authorization'] = "Bearer #{access_token || Knock.key!}" if auth
+      request['Authorization'] = "Bearer #{access_token || Knock.config.key!}" if auth
       request['User-Agent'] = user_agent
       request
     end
@@ -40,7 +47,7 @@ module Knock
     def post_request(path:, auth: false, idempotency_key: nil, body: nil)
       request = Net::HTTP::Post.new(path, 'Content-Type' => 'application/json')
       request.body = body.to_json if body
-      request['Authorization'] = "Bearer #{Knock.key!}" if auth
+      request['Authorization'] = "Bearer #{Knock.config.key!}" if auth
       request['User-Agent'] = user_agent
       request['Idempotency-Key'] = idempotency_key if idempotency_key
       request
@@ -56,7 +63,7 @@ module Knock
       )
 
       request.body = body.to_json if body
-      request['Authorization'] = "Bearer #{Knock.key!}" if auth
+      request['Authorization'] = "Bearer #{Knock.config.key!}" if auth
       request['User-Agent'] = user_agent
       request
     end
@@ -64,7 +71,7 @@ module Knock
     def put_request(path:, auth: false, idempotency_key: nil, body: nil)
       request = Net::HTTP::Put.new(path, 'Content-Type' => 'application/json')
       request.body = body.to_json if body
-      request['Authorization'] = "Bearer #{Knock.key!}" if auth
+      request['Authorization'] = "Bearer #{Knock.config.key!}" if auth
       request['User-Agent'] = user_agent
       request['Idempotency-Key'] = idempotency_key if idempotency_key
       request
@@ -122,4 +129,5 @@ module Knock
       end.join('; ')
     end
   end
+  # rubocop:enable Metrics/ModuleLength
 end

data/lib/knock/configuration.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+# typed: true
+
+module Knock
+  # Configuration class sets config initializer
+  class Configuration
+    attr_accessor :api_hostname, :timeout, :key
+
+    def initialize
+      @timeout = 60
+    end
+
+    def key!
+      key or raise '`Knock.config.key` not set'
+    end
+  end
+end

data/lib/knock/errors.rb

@@ -42,4 +42,7 @@ module Knock
   # InvalidRequestError is raised when a request is initiated with invalid
   # parameters.
   class InvalidRequestError < KnockError; end
+
+  # TimeoutError is raised when the HTTP request to the API times out
+  class TimeoutError < KnockError; end
 end

data/lib/knock/messages.rb

@@ -8,7 +8,6 @@ module Knock
   # Methods for interacting with messages in Knock
   module Messages
     class << self
-      include Base
       include Client
 
       # Retrieves a paginated list of messages for the provided environment

data/lib/knock/objects.rb

@@ -9,7 +9,6 @@ module Knock
   # rubocop:disable Metrics/ModuleLength
   module Objects
     class << self
-      include Base
       include Client
 
       DEFAULT_PREFERENCE_SET_ID = 'default'
@@ -333,6 +332,7 @@ module Knock
       # - page_size: size of page to be returned (max: 50)
       # - after:  after cursor for pagination
       # - before: before cursor for pagination
+      # - recipients: list of recipient identifiers to filter subscribers of the object
       #
       # @return [Hash] Paginated subscriptions response
       def list_subscriptions(collection:, id:, options: {})

data/lib/knock/preferences.rb

@@ -7,7 +7,6 @@ module Knock
   # Provides convienience methods for working with preferences (deprecated)
   module Preferences
     class << self
-      include Base
       include Client
 
       # Returns all preference sets for the user

data/lib/knock/tenants.rb

@@ -7,7 +7,6 @@ module Knock
   # Methods for interacting with tenants in Knock
   module Tenants
     class << self
-      include Base
       include Client
 
       # Retrieves all Tenants in environment

data/lib/knock/users.rb

@@ -9,7 +9,6 @@ module Knock
   # rubocop:disable Metrics/ModuleLength
   module Users
     class << self
-      include Base
       include Client
 
       DEFAULT_PREFERENCE_SET_ID = 'default'

data/lib/knock/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Knock
-  VERSION = '0.4.11'
+  VERSION = '0.5.0'
 end

data/lib/knock/workflows.rb

@@ -7,7 +7,6 @@ module Knock
   # Methods for interacting with workflows in Knock
   module Workflows
     class << self
-      include Base
       include Client
 
       # Triggers the workflow with the given key
@@ -18,12 +17,12 @@ module Knock
       # @param [Hash] data The data to pass to the workflow
       # @param [String] cancellation_key An optional key to identify this workflow
       #  invocation for cancelling
-      # @param [String] tenant An optional tenant identifier
+      # @param [String, Hash] tenant An optional tenant identifier or a set of tenant attributes
       # @param [String] idempotency_key An optional idempotency key to prevent
       #  duplicate workflow invocations
       #
       # @return [Hash] A workflow trigger result
-      def trigger(key:, actor:, recipients:, data: {}, cancellation_key: nil, tenant: nil, idempotency_key: nil)
+      def trigger(key:, recipients:, data: {}, actor: nil, cancellation_key: nil, tenant: nil, idempotency_key: nil)
         attrs = {
           actor: actor,
           recipients: recipients,
@@ -72,7 +71,7 @@ module Knock
       # @param [Array<String, Hash>] recipients The recipient identifiers
       # @param [Array<Hash>] repeats The repeat rules for when to schedule the workflow run
       # @param [Hash] data Parameters to be used as variables on the workflow run
-      # @param [String] tenant An optional tenant identifier
+      # @param [String, Hash] tenant An optional tenant identifier or a set of tenant attributes
 
       def create_schedules(key:, recipients:, repeats:, scheduled_at: nil, data: {}, actor: nil, tenant: nil)
         attrs = {

data/lib/knock.rb

@@ -2,25 +2,39 @@
 
 require 'knock/version'
 require 'json'
+require 'knock/configuration'
 
 # Setup for Knock client
 module Knock
-  API_HOSTNAME = ENV['KNOCK_API_HOSTNAME'] || 'api.knock.app'
+  def self.default_config
+    Configuration.new.tap do |config|
+      config.api_hostname = ENV['KNOCK_API_HOSTNAME'] || 'api.knock.app'
+      config.key = ENV['KNOCK_API_KEY']
+    end
+  end
 
-  def self.key=(value)
-    Base.key = value
+  def self.config
+    @config ||= default_config
   end
 
-  def self.key
-    Base.key
+  def self.configure
+    yield(config)
   end
 
-  def self.key!
-    key || raise('Knock.key not set')
+  def self.key=(value)
+    warn '`Knock.key=` is deprecated. Use `Knock.configure` instead.'
+
+    config.key = value
+  end
+
+  def self.key
+    warn '`Knock.key` is deprecated. Use `Knock.configure` instead.'
+    config.key
   end
 
   autoload :Base, 'knock/base'
   autoload :Client, 'knock/client'
+  autoload :Configuration, 'knock/configuration'
 
   # Resources
   autoload :Preferences, 'knock/preferences'
@@ -35,9 +49,7 @@ module Knock
   autoload :APIError, 'knock/errors'
   autoload :AuthenticationError, 'knock/errors'
   autoload :InvalidRequestError, 'knock/errors'
-
-  key = ENV['KNOCK_API_KEY']
-  Knock.key = key unless key.nil?
+  autoload :TimeoutError, 'knock/errors'
 
   # Triggers the workflow with the given key
   #

data/spec/configuration_spec.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+# typed: false
+require_relative '../lib/knock'
+
+describe Knock do
+  describe '.configure' do
+    context 'with key and no timeout' do
+      before do
+        Knock.configure do |config|
+          config.key = 'example_api_key'
+        end
+      end
+
+      it 'sets the key and default timeout configuration' do
+        expect(Knock.config.key).to eq('example_api_key')
+        expect(Knock.config.timeout).to eq(60)
+      end
+    end
+
+    context 'with key and timeout' do
+      before do
+        Knock.configure do |config|
+          config.key = 'example_api_key'
+          config.timeout = 120
+        end
+      end
+
+      it 'sets the key and timeout configuration' do
+        expect(Knock.config.key).to eq('example_api_key')
+        expect(Knock.config.timeout).to eq(120)
+      end
+    end
+  end
+end
+
+describe Knock::Configuration do
+  describe '.key!' do
+    context 'with key set' do
+      before do
+        Knock.config.key = 'example_api_key'
+      end
+
+      it 'returns the key' do
+        expect(Knock.config.key!).to eq('example_api_key')
+      end
+    end
+
+    context 'with key not set' do
+      before do
+        Knock.config.key = nil
+      end
+
+      it 'throws an error' do
+        expect do
+          Knock.config.key!
+        end.to raise_error(
+          '`Knock.config.key` not set'
+        )
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: knockapi
 version: !ruby/object:Gem::Version
-  version: 0.4.11
+  version: 0.5.0
 platform: ruby
 authors:
 - Knock Labs, Inc.
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-09-11 00:00:00.000000000 Z
+date: 2024-05-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -76,9 +76,9 @@ files:
 - bin/publish
 - knockapi.gemspec
 - lib/knock.rb
-- lib/knock/base.rb
 - lib/knock/bulk_operations.rb
 - lib/knock/client.rb
+- lib/knock/configuration.rb
 - lib/knock/errors.rb
 - lib/knock/messages.rb
 - lib/knock/objects.rb
@@ -87,6 +87,7 @@ files:
 - lib/knock/users.rb
 - lib/knock/version.rb
 - lib/knock/workflows.rb
+- spec/configuration_spec.rb
 - spec/tenants_spec.rb
 homepage: https://github.com/knocklabs/knock-ruby
 licenses:
@@ -108,9 +109,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.5.9
 signing_key:
 specification_version: 4
 summary: API client for Knock
 test_files:
+- spec/configuration_spec.rb
 - spec/tenants_spec.rb

data/lib/knock/base.rb

@@ -1,12 +0,0 @@
-# frozen_string_literal: true
-
-module Knock
-  ## The Base class handles setting and reading the Knock API Key for authentication
-  module Base
-    attr_accessor :key
-
-    class << self
-      attr_accessor :key
-    end
-  end
-end