knockapi 0.6.1 → 1.0.0

data/lib/knock/users.rb

@@ -1,420 +0,0 @@
-# frozen_string_literal: true
-
-require 'json'
-require 'net/http'
-require 'uri'
-
-module Knock
-  # Provides convienience methods for working with users
-  # rubocop:disable Metrics/ModuleLength
-  module Users
-    class << self
-      include Client
-
-      DEFAULT_PREFERENCE_SET_ID = 'default'
-
-      # Identifies the user
-      #
-      # @param [String] id The user ID
-      # @param [Hash] data The traits to attach to the user
-      #
-      # @return [Hash] The user
-      def identify(id:, data: {})
-        request = put_request(
-          auth: true,
-          path: "/v1/users/#{id}",
-          body: data
-        )
-
-        execute_request(request: request)
-      end
-
-      # Bulk identifies users
-      #
-      # @param [Array<Hash>] users The users to upsert
-      #
-      # @return [Hash] the BulkOperation
-      def bulk_identify(users: [])
-        request = post_request(
-          auth: true,
-          path: '/v1/users/bulk/identify',
-          body: { users: users }
-        )
-
-        execute_request(request: request)
-      end
-
-      # Retrieves paginated users for the provided environment
-      #
-      # @param [Hash] options Options to pass to the paginated users endpoint query.
-      # These include:
-      # - page_size: size of page to be returned (max: 50)
-      # - after:  after cursor for pagination
-      # - before: before cursor for pagination
-      def list(options: {})
-        request = get_request(
-          auth: true,
-          path: '/v1/users',
-          params: options
-        )
-
-        execute_request(request: request)
-      end
-
-      # Retrieves the given user
-      #
-      # @param [String] id The user ID
-      #
-      # @return [Hash] The user
-      def get(id:)
-        request = get_request(
-          auth: true,
-          path: "/v1/users/#{id}"
-        )
-
-        execute_request(request: request)
-      end
-
-      # Deletes the user
-      #
-      # @param [String] id the user ID
-      #
-      # @return [Hash] the user
-      def delete(id:)
-        request = delete_request(
-          auth: true,
-          path: "/v1/users/#{id}"
-        )
-
-        execute_request(request: request)
-      end
-
-      # Bulk deletes users
-      #
-      # @param [Array<String>] user_ids The users to delete
-      #
-      # @return [Hash] the BulkOperation
-      def bulk_delete(user_ids: [])
-        request = post_request(
-          auth: true,
-          path: '/v1/users/bulk/delete',
-          body: { user_ids: user_ids }
-        )
-
-        execute_request(request: request)
-      end
-
-      # Gets a feed for a user
-      #
-      # @param [String] id The user id
-      # @param [String] channel_id The feed id to retrieve
-      # @param [Hash] options Options to pass to the feed query
-      #
-      # @return [Hash] the feed response
-      def get_feed(id:, channel_id:, options: {})
-        options[:trigger_data] = JSON.generate(options[:trigger_data]) if options[:trigger_data]
-
-        request = get_request(
-          auth: true,
-          path: "/v1/users/#{id}/feeds/#{channel_id}",
-          params: options
-        )
-
-        execute_request(request: request)
-      end
-
-      # Merges the user specified with `from_user_id` into the user specified with `user_id`.
-      #
-      # @param [String] id The user id to merge into.
-      # @param [String] from_user_id The user id to merge from
-      #
-      # @return [Hash] the merged User
-      def merge(id:, from_user_id:)
-        request = post_request(
-          auth: true,
-          path: "/v1/users/#{id}/merge",
-          body: { from_user_id: from_user_id }
-        )
-
-        execute_request(request: request)
-      end
-
-      ##
-      # Preferences
-      ##
-
-      # Returns all preference sets for the user
-      #
-      # @param [String] user_id The ID of the user to retrieve preferences for
-      #
-      # @return [Hash] The preference sets
-      def get_all_preferences(user_id:)
-        endpoint = "/v1/users/#{user_id}/preferences"
-
-        request = get_request(
-          auth: true,
-          path: endpoint
-        )
-
-        execute_request(request: request)
-      end
-
-      # Gets a single preference set, defaults to the 'default' set
-      # for the user given.
-      #
-      # @param [String] user_id The ID of the user to retrieve preferences for
-      # @param [String] preference_set The preference set ID (defaults to `default`)
-      #
-      # @return [Hash] The preference set (if it exists)
-      def get_preferences(user_id:, preference_set: DEFAULT_PREFERENCE_SET_ID)
-        endpoint = "/v1/users/#{user_id}/preferences/#{preference_set}"
-
-        request = get_request(
-          auth: true,
-          path: endpoint
-        )
-
-        execute_request(request: request)
-      end
-
-      # Sets multiple preferences at once for the preference set.
-      #
-      # @param [String] user_id The ID of the user to set preferences for
-      # @param [String] preference_set The preference set ID (defaults to `default`)
-      # @param [Hash] channel_types The channel_types hash to set
-      # @param [Hash] workflows The workflows hash to set
-      # @param [Hash] categories The categories hash to set
-      #
-      # @return [Hash] The preference set
-      def set_preferences(
-        user_id:,
-        channel_types: nil,
-        workflows: nil,
-        categories: nil,
-        preference_set: DEFAULT_PREFERENCE_SET_ID
-      )
-        endpoint = "/v1/users/#{user_id}/preferences/#{preference_set}"
-
-        request = put_request(
-          auth: true,
-          path: endpoint,
-          body: {
-            channel_types: channel_types,
-            workflows: workflows,
-            categories: categories
-          }
-        )
-
-        execute_request(request: request)
-      end
-
-      # Bulk sets the preference object for the users.
-      #
-      # @param [Array<String>] user_ids The ID of the user to set preferences for
-      # @param [Hash] preferences The preferences hash to set
-      # @param [String] preference_set The preference set ID (defaults to `default`)
-      #
-      # @return [Hash] BulkOperation
-      def bulk_set_preferences(
-        user_ids: [],
-        preferences: {},
-        preference_set: DEFAULT_PREFERENCE_SET_ID
-      )
-        endpoint = '/v1/users/bulk/preferences'
-
-        # Put the preference set id if it doesn't already exist
-        preferences['id'] = preference_set unless preferences.has_key?('id')
-
-        request = post_request(
-          auth: true,
-          path: endpoint,
-          body: {
-            user_ids: user_ids,
-            preferences: preferences
-          }
-        )
-
-        execute_request(request: request)
-      end
-
-      # Sets preferences for the given channel type
-      #
-      # @param [String] user_id The ID of the user to set preferences for
-      # @param [String] preference_set The preference set ID (defaults to `default`)
-      # @param [String] channel_type The channel type to set
-      # @param [Bool] setting Whether the channel type is enabled or not
-      #
-      # @return [Hash] The preference set
-      def set_channel_type_preferences(user_id:, channel_type:, setting:, preference_set: DEFAULT_PREFERENCE_SET_ID)
-        endpoint = "/v1/users/#{user_id}/preferences/#{preference_set}/channel_types/#{channel_type}"
-
-        request = put_request(
-          auth: true,
-          path: endpoint,
-          body: { subscribed: setting }
-        )
-
-        execute_request(request: request)
-      end
-
-      # Sets preferences for the given workflow
-      #
-      # @param [String] user_id The ID of the user to set preferences for
-      # @param [String] preference_set The preference set ID (defaults to `default`)
-      # @param [String] workflow The workflow to set preferences for
-      # @param [Bool | Hash] setting Either a boolean to indicate if the type is enabled
-      #  or a hash containing channel types and settings
-      #
-      # @return [Hash] The preference set
-      def set_workflow_preferences(user_id:, workflow:, setting:, preference_set: DEFAULT_PREFERENCE_SET_ID)
-        params = setting.is_a?(Hash) ? setting : { subscribed: setting }
-        endpoint = "/v1/users/#{user_id}/preferences/#{preference_set}/workflows/#{workflow}"
-
-        request = put_request(
-          auth: true,
-          path: endpoint,
-          body: params
-        )
-
-        execute_request(request: request)
-      end
-
-      # Sets preferences for the given category
-      #
-      # @param [String] user_id The ID of the user to set preferences for
-      # @param [String] preference_set The preference set ID (defaults to `default`)
-      # @param [String] category The category to set preferences for
-      # @param [Bool | Hash] setting Either a boolean to indicate if the type is enabled
-      #  or a hash containing channel types and settings
-      #
-      # @return [Hash] The preference set
-      def set_category_preferences(user_id:, category:, setting:, preference_set: DEFAULT_PREFERENCE_SET_ID)
-        params = setting.is_a?(Hash) ? setting : { subscribed: setting }
-        endpoint = "/v1/users/#{user_id}/preferences/#{preference_set}/categories/#{category}"
-
-        request = put_request(
-          auth: true,
-          path: endpoint,
-          body: params
-        )
-
-        execute_request(request: request)
-      end
-
-      ##
-      # Channel data
-      ##
-
-      # Get user's channel data for the given channel id
-      #
-      # @param [String] id the user ID
-      # @param [String] channel_id target channel ID
-      #
-      # @return [Hash] channel data
-      def get_channel_data(id:, channel_id:)
-        request = get_request(
-          auth: true,
-          path: "/v1/users/#{id}/channel_data/#{channel_id}"
-        )
-
-        execute_request(request: request)
-      end
-
-      # Upserts user's channel data for the given channel id
-      #
-      # @param [String] id the user ID
-      # @param [String] channel_id target channel ID
-      # @param [Hash] channel_data channel data
-      #
-      # @return [Hash] channel data
-      def set_channel_data(id:, channel_id:, channel_data:)
-        request = put_request(
-          auth: true,
-          path: "/v1/users/#{id}/channel_data/#{channel_id}",
-          body: { data: channel_data }
-        )
-
-        execute_request(request: request)
-      end
-
-      # Unsets user's channel data for the given channel id
-      #
-      # @param [String] id the user ID
-      # @param [String] channel_id target channel ID
-      # @param [Hash] channel_data channel data
-      #
-      # @return [Hash] channel data
-      def unset_channel_data(id:, channel_id:)
-        request = delete_request(
-          auth: true,
-          path: "/v1/users/#{id}/channel_data/#{channel_id}"
-        )
-
-        execute_request(request: request)
-      end
-
-      ##
-      # Messages
-      ##
-
-      # Get user's messages
-      #
-      # @param [String] id the user ID
-      # @param [Hash] options Options to pass to the messages endpoint query
-      #
-      # @return [Hash] Paginated messages response
-      def get_messages(id:, options: {})
-        options[:trigger_data] = JSON.generate(options[:trigger_data]) if options[:trigger_data]
-
-        request = get_request(
-          auth: true,
-          path: "/v1/users/#{id}/messages",
-          params: options
-        )
-
-        execute_request(request: request)
-      end
-
-      ##
-      # Schedules
-      ##
-
-      # Get user's schedules
-      #
-      # @param [String] id the user ID
-      # @param [Hash] options Options to pass to the schedules endpoint query
-      #
-      # @return [Hash] Paginated schedules response
-      def get_schedules(id:, options: {})
-        request = get_request(
-          auth: true,
-          path: "/v1/users/#{id}/schedules",
-          params: options
-        )
-
-        execute_request(request: request)
-      end
-
-      ##
-      # Subscriptions
-      ##
-
-      # Get user's subscriptions
-      #
-      # @param [String] id the user ID
-      # @param [Hash] options Options to pass to the subscriptions endpoint query
-      #
-      # @return [Hash] Paginated subscriptions response
-      def get_subscriptions(id:, options: {})
-        request = get_request(
-          auth: true,
-          path: "/v1/users/#{id}/subscriptions",
-          params: options
-        )
-
-        execute_request(request: request)
-      end
-    end
-  end
-  # rubocop:enable Metrics/ModuleLength
-end

data/lib/knock/version.rb

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

data/lib/knock/workflows.rb

@@ -1,152 +0,0 @@
-# frozen_string_literal: true
-
-require 'net/http'
-require 'uri'
-
-module Knock
-  # Methods for interacting with workflows in Knock
-  module Workflows
-    class << self
-      include Client
-
-      # Triggers the workflow with the given key
-      #
-      # @param [String] key The workflow key
-      # @param [String, Hash] actor The actor identifier (optional)
-      # @param [Array<String, Hash>] recipients The recipient identifiers
-      # @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, 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:, recipients:, data: {}, actor: nil, cancellation_key: nil, tenant: nil, idempotency_key: nil)
-        attrs = {
-          actor: actor,
-          recipients: recipients,
-          data: data,
-          cancellation_key: cancellation_key,
-          tenant: tenant
-        }
-
-        request = post_request(
-          auth: true,
-          path: "/v1/workflows/#{key}/trigger",
-          body: attrs,
-          idempotency_key: idempotency_key
-        )
-
-        execute_request(request: request)
-      end
-
-      # Cancels the workflow with the given key and cancellation key
-      #
-      # @param [String] key The workflow key
-      # @param [String] cancellation_key The cancellation key
-      # @param [Array<String, Hash>] recipients The recipient identifiers
-      #
-      # @return [Hash] - Cancellation result
-      def cancel(key:, cancellation_key:, recipients: nil)
-        attrs = {
-          cancellation_key: cancellation_key,
-          recipients: recipients
-        }
-
-        request = post_request(
-          auth: true,
-          path: "/v1/workflows/#{key}/cancel",
-          body: attrs
-        )
-
-        execute_request(request: request)
-      end
-
-      # Creates schedule instances for all recipients for the given
-      # workflow.
-      #
-      # @param [String] key The workflow key
-      # @param [String, Hash] actor An optional actor identifier to be used when trigger the workflow
-      # @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, 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 = {
-          workflow: key,
-          actor: actor,
-          recipients: recipients,
-          repeats: repeats,
-          data: data,
-          tenant: tenant,
-          scheduled_at: scheduled_at
-        }
-
-        request = post_request(
-          auth: true,
-          path: '/v1/schedules',
-          body: attrs
-        )
-
-        execute_request(request: request)
-      end
-
-      # Updates schedule instances with the attributes passed as params
-      #
-      # @param [Array<String>] schedule_ids The ids of the schedules to be updated
-      # @param [Hash] schedule_attrs The attributes to be used to update the schedules
-      #   Possible attributes: actor, repeats, data and tenant
-
-      def update_schedules(schedule_ids:, schedule_attrs:)
-        attrs = {
-          schedule_ids: schedule_ids
-        }
-
-        attrs = attrs.merge(schedule_attrs)
-
-        request = put_request(
-          auth: true,
-          path: '/v1/schedules',
-          body: attrs
-        )
-
-        execute_request(request: request)
-      end
-
-      # Get paginated workflow schedules
-      #
-      # @param [String] key The workflow key
-      # @param [Hash] opts Options to filter the results: recipients, tenant and pagination params
-      def list_schedules(key:, opts: {})
-        attrs = opts.merge(workflow: key)
-
-        request = get_request(
-          auth: true,
-          path: '/v1/schedules',
-          params: attrs
-        )
-
-        execute_request(request: request)
-      end
-
-      # Delete schedule instances
-      #
-      # @param [Array<String>] schedule_ids The ids of the schedules to be deleted
-      def delete_schedules(schedule_ids:)
-        attrs = {
-          schedule_ids: schedule_ids
-        }
-
-        request = delete_request(
-          auth: true,
-          path: '/v1/schedules',
-          body: attrs
-        )
-
-        execute_request(request: request)
-      end
-    end
-  end
-end

data/lib/knock.rb

@@ -1,71 +0,0 @@
-# frozen_string_literal: true
-
-require 'knock/version'
-require 'json'
-require 'knock/configuration'
-
-# Setup for Knock client
-module Knock
-  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.config
-    @config ||= default_config
-  end
-
-  def self.configure
-    yield(config)
-  end
-
-  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'
-  autoload :Users, 'knock/users'
-  autoload :Workflows, 'knock/workflows'
-  autoload :BulkOperations, 'knock/bulk_operations'
-  autoload :Objects, 'knock/objects'
-  autoload :Tenants, 'knock/tenants'
-  autoload :Messages, 'knock/messages'
-
-  # Errors
-  autoload :APIError, 'knock/errors'
-  autoload :AuthenticationError, 'knock/errors'
-  autoload :InvalidRequestError, 'knock/errors'
-  autoload :NotFoundError, 'knock/errors'
-  autoload :RateLimitExceededError, 'knock/errors'
-  autoload :TimeoutError, 'knock/errors'
-  autoload :UnprocessableEntityError, 'knock/errors'
-
-  # Triggers the workflow with the given key
-  #
-  # @param [String] key The workflow key
-  # @param [String] actor The actor ID
-  # @param [Array<String>] recipients The recipient IDs
-  # @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
-  #
-  # @return [Hash] A workflow trigger result
-  def self.notify(**args)
-    Knock::Workflows.trigger(**args)
-  end
-end

data/spec/configuration_spec.rb

@@ -1,63 +0,0 @@
-# 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