knockapi 0.4.1 → 0.4.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e5539a9d4052b39167c0aa22d71eb9848ab0c6ad0c2812bf72e09cc446256868
-  data.tar.gz: 7b08912b135c05a15d528527788a3f7aa8d7b67b7c14e0e5bcbac8f80fb5fe4e
+  metadata.gz: 9d0a730346c7c39ec862f160ac31fd80844b3f0907129a02ad320bf724e74888
+  data.tar.gz: bab747c80c86891e7e5d8135748deec4cd8c6bee1b20fbddf19546aefebe5646
 SHA512:
-  metadata.gz: 2e2976916846b11c9a8ccb6cdacba9f12fecb0e113f8114cb1eed77a248b53156cdf025ffd823148567675489d988f655d80fec43cdb8a2174f6d6cce5a0db02
-  data.tar.gz: 83b75fd115a9ce6905629cc20bbdf1550eb726e2e39ece0e4d4215a1203ee1b6af46877d1dd50cda0de1c1230a5f948a9e6e974cdd600ca62794a154ba9f1ab6
+  metadata.gz: a7e879b66a557daac3950155ec7429cbfe72b7f6d7f2491eb440f92cf1b1f620753a2dab325751bdb704933df7be8c598b9b47c67b191c7659dbd9470c888f2c
+  data.tar.gz: 689dba9548ddba6fe5e2e90fb339eb2dee6c23f9c8d51ce878d4d163da70453482a1fae0806c7fa56638e3dec9aa0cf38f3c5669c657b11768d7e1087a57dd47

data/.github/workflows/ruby.yml

@@ -0,0 +1,52 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Ruby
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.6', '2.7', '3.0']
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Ruby
+    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+    # change this to (see https://github.com/ruby/setup-ruby#versioning):
+    # uses: ruby/setup-ruby@v1
+      uses: ruby/setup-ruby@2b019609e2b0f1ea1a2bc8ca11cb82ab46ada124
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - name: Run tests
+      run: bundle exec rspec spec
+
+  lint:
+
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+      - name: Install Ruby and gems
+        uses: ruby/setup-ruby@8f312efe1262fb463d906e9bf040319394c18d3e # v1.92
+        with:
+          bundler-cache: true
+      # Add or replace any other lints here
+      - name: Lint Ruby files
+        run: bundle exec rubocop

data/.rubocop.yml

@@ -0,0 +1,8 @@
+AllCops:
+  TargetRubyVersion: 2.5
+Metrics/LineLength:
+  Max: 120
+Metrics/MethodLength:
+  Max: 35
+Metrics/ParameterLists:
+  Max: 6

data/Gemfile

@@ -1,5 +1,9 @@
 # frozen_string_literal: true
 
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
 gemspec
+
+group :test do
+  gem 'rspec', '~> 3.11'
+end

data/Gemfile.lock

@@ -1,12 +1,13 @@
 PATH
   remote: .
   specs:
-    knockapi (0.4.1)
+    knockapi (0.4.4)
 
 GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.2)
+    diff-lcs (1.5.0)
     parallel (1.20.1)
     parser (3.0.2.0)
       ast (~> 2.4.1)
@@ -14,6 +15,19 @@ GEM
     rake (13.0.6)
     regexp_parser (2.1.1)
     rexml (3.2.5)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
     rubocop (1.18.4)
       parallel (~> 1.10)
       parser (>= 3.0.0.0)
@@ -42,6 +56,7 @@ DEPENDENCIES
   bundler (>= 2.0.1)
   knockapi!
   rake
+  rspec (~> 3.11)
   standard
 
 BUNDLED WITH

data/bin/console

@@ -1,7 +1,8 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-require "bundler/setup"
-require "knock"
+require 'bundler/setup'
+require 'knock'
 
-require "irb"
-IRB.start(__FILE__)
+require 'irb'
+IRB.start(__FILE__)

data/knockapi.gemspec

@@ -1,30 +1,30 @@
 # frozen_string_literal: true
 
-lib = File.expand_path("lib", __dir__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "knock/version"
+require 'knock/version'
 
 Gem::Specification.new do |spec|
-  spec.name = "knockapi"
+  spec.name = 'knockapi'
   spec.version = Knock::VERSION
-  spec.authors = ["Knock Labs, Inc."]
-  spec.email = ["support@knock.app"]
-  spec.description = "API client for Knock"
-  spec.summary = "API client for Knock"
-  spec.homepage = "https://github.com/knocklabs/knock-ruby"
-  spec.license = "MIT"
+  spec.authors = ['Knock Labs, Inc.']
+  spec.email = ['support@knock.app']
+  spec.description = 'API client for Knock'
+  spec.summary = 'API client for Knock'
+  spec.homepage = 'https://github.com/knocklabs/knock-ruby'
+  spec.license = 'MIT'
   spec.metadata = {
-    "documentation_uri" => "https://docs.knock.app"
+    'documentation_uri' => 'https://docs.knock.app'
   }
 
   spec.files = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
   spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", ">= 2.0.1"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "standard"
+  spec.add_development_dependency 'bundler', '>= 2.0.1'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'standard'
 
-  spec.required_ruby_version = ">= 2.5"
+  spec.required_ruby_version = '>= 2.5'
 end

data/lib/knock/base.rb

@@ -1,11 +1,12 @@
+# 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_writer :key
-      attr_reader :key
+      attr_accessor :key
     end
   end
 end

data/lib/knock/bulk_operations.rb

@@ -1,5 +1,7 @@
-require "net/http"
-require "uri"
+# frozen_string_literal: true
+
+require 'net/http'
+require 'uri'
 
 module Knock
   # Provides convienience methods for working with bulk operations

data/lib/knock/client.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Knock
   # A Net::HTTP based API client for interacting with the Knock API
   module Client
@@ -18,7 +20,7 @@ module Knock
       http_status = response.code.to_i
       handle_error_response(response: response) if http_status >= 400
 
-      JSON.parse(response.body)
+      JSON.parse(response.body) if response.body && (response.body != '')
     end
 
     def get_request(path:, auth: false, params: {}, access_token: nil)
@@ -27,19 +29,19 @@ module Knock
 
       request = Net::HTTP::Get.new(
         uri.to_s,
-        "Content-Type" => "application/json"
+        'Content-Type' => 'application/json'
       )
 
-      request["Authorization"] = "Bearer #{access_token || Knock.key!}" if auth
-      request["User-Agent"] = user_agent
+      request['Authorization'] = "Bearer #{access_token || Knock.key!}" if auth
+      request['User-Agent'] = user_agent
       request
     end
 
-    def post_request(path:, auth: false, idempotency_key: nil, body: nil)
-      request = Net::HTTP::Post.new(path, "Content-Type" => "application/json")
+    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["User-Agent"] = user_agent
+      request['Authorization'] = "Bearer #{Knock.key!}" if auth
+      request['User-Agent'] = user_agent
       request
     end
 
@@ -49,19 +51,19 @@ module Knock
 
       request = Net::HTTP::Delete.new(
         uri.to_s,
-        "Content-Type" => "application/json"
+        'Content-Type' => 'application/json'
       )
 
-      request["Authorization"] = "Bearer #{Knock.key!}" if auth
-      request["User-Agent"] = user_agent
+      request['Authorization'] = "Bearer #{Knock.key!}" if auth
+      request['User-Agent'] = user_agent
       request
     end
 
-    def put_request(path:, auth: false, idempotency_key: nil, body: nil)
-      request = Net::HTTP::Put.new(path, "Content-Type" => "application/json")
+    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["User-Agent"] = user_agent
+      request['Authorization'] = "Bearer #{Knock.key!}" if auth
+      request['User-Agent'] = user_agent
       request
     end
 
@@ -69,6 +71,8 @@ module Knock
       "Knock Ruby - v#{Knock::VERSION}"
     end
 
+    # rubocop:disable Metrics/AbcSize
+
     def handle_error_response(response:)
       http_status = response.code.to_i
       json = JSON.parse(response.body)
@@ -76,41 +80,43 @@ module Knock
       case http_status
       when 400
         raise InvalidRequestError.new(
-          message: json["message"],
+          message: json['message'],
           http_status: http_status,
-          request_id: response["x-request-id"]
+          request_id: response['x-request-id']
         )
       when 401
         raise AuthenticationError.new(
-          message: json["message"],
+          message: json['message'],
           http_status: http_status,
-          request_id: response["x-request-id"]
+          request_id: response['x-request-id']
         )
       when 404
         raise APIError.new(
-          message: json["message"],
+          message: json['message'],
           http_status: http_status,
-          request_id: response["x-request-id"]
+          request_id: response['x-request-id']
         )
       when 422
-        message = json["message"]
-        errors = extract_error(json["errors"]) if json["errors"]
+        message = json['message']
+        errors = extract_error(json['errors']) if json['errors']
         message += " (#{errors})" if errors
 
         raise InvalidRequestError.new(
           message: message,
           http_status: http_status,
-          request_id: response["x-request-id"]
+          request_id: response['x-request-id']
         )
       end
     end
 
+    # rubocop:enable Metrics/AbcSize
+
     private
 
     def extract_error(errors)
       errors.map do |error|
-        "#{error["field"]}: #{error["message"]} (#{error["type"]})"
-      end.join("; ")
+        "#{error['field']}: #{error['message']} (#{error['type']})"
+      end.join('; ')
     end
   end
 end

data/lib/knock/errors.rb

@@ -1,9 +1,12 @@
+# frozen_string_literal: true
+
 module Knock
+  # Knock specific errors
   class KnockError < StandardError
-    attr_reader :http_status
-    attr_reader :request_id
+    attr_reader :http_status, :request_id
 
     def initialize(message: nil, error: nil, error_description: nil, http_status: nil, request_id: nil)
+      super
       @message = message
       @error = error
       @error_description = error_description
@@ -12,8 +15,8 @@ module Knock
     end
 
     def to_s
-      status_string = @http_status.nil? ? "" : "Status #{@http_status}, "
-      id_string = @request_id.nil? ? "" : " - request ID: #{@request_id}"
+      status_string = @http_status.nil? ? '' : "Status #{@http_status}, "
+      id_string = @request_id.nil? ? '' : " - request ID: #{@request_id}"
 
       if @error && @error_description
         error_string = "error: #{@error}, error_description: #{@error_description}"

data/lib/knock/messages.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+require 'net/http'
+require 'uri'
+
+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
+      #
+      # @param [Hash] options Options to pass to the messages endpoint query
+      #
+      # @return [Hash] Paginated list of Message records
+      def list(options: {})
+        request = get_request(
+          auth: true,
+          path: '/v1/messages',
+          params: options
+        )
+
+        execute_request(request: request)
+      end
+
+      # Retrieves a Message
+      #
+      # @param [String] id The message id
+      #
+      # @return [Hash] The Message
+      def get(id:)
+        request = get_request(
+          auth: true,
+          path: "/v1/messages/#{id}"
+        )
+
+        execute_request(request: request)
+      end
+
+      # Get a Message's content
+      #
+      # @param [String] id The message id
+      #
+      # @return [Hash] The Message content
+      def get_content(id:)
+        request = get_request(
+          auth: true,
+          path: "/v1/messages/#{id}/content"
+        )
+
+        execute_request(request: request)
+      end
+
+      # Get a Message's activities
+      #
+      # @param [String] id The message id
+      # @param [Hash] options Options to pass to the paginated activities endpoint query
+      #
+      # @return [Hash] Paginated Message's activities
+      def get_activities(id:, options: {})
+        request = get_request(
+          auth: true,
+          path: "/v1/messages/#{id}/activities",
+          params: options
+        )
+
+        execute_request(request: request)
+      end
+
+      # Get a Message's events
+      #
+      # @param [String] id The message id
+      # @param [Hash] options Options to pass to the paginated events endpoint query
+      #
+      # @return [Hash] Paginated Message's events
+      def get_events(id:, options: {})
+        request = get_request(
+          auth: true,
+          path: "/v1/messages/#{id}/events",
+          params: options
+        )
+
+        execute_request(request: request)
+      end
+    end
+  end
+end

data/lib/knock/objects.rb

@@ -1,13 +1,18 @@
-require "net/http"
-require "uri"
+# frozen_string_literal: true
+
+require 'net/http'
+require 'uri'
 
 module Knock
-  # Provides convienience methods for working with bulk operations
+  # Methods for interacting with objects in Knock
+  # rubocop:disable Metrics/ModuleLength
   module Objects
     class << self
       include Base
       include Client
 
+      DEFAULT_PREFERENCE_SET_ID = 'default'
+
       # Retrieves an Object in a collection
       #
       # @param [String] collection The collection the object is in
@@ -50,7 +55,7 @@ module Knock
         request = post_request(
           auth: true,
           path: "/v1/objects/#{collection}/bulk/set",
-          body: {objects: objects}
+          body: { objects: objects }
         )
 
         execute_request(request: request)
@@ -81,7 +86,7 @@ module Knock
         request = post_request(
           auth: true,
           path: "/v1/objects/#{collection}/bulk/delete",
-          body: {object_ids: object_ids}
+          body: { object_ids: object_ids }
         )
 
         execute_request(request: request)
@@ -111,15 +116,194 @@ module Knock
       # @param [Hash] channel_data channel data
       #
       # @return [Hash] channel data
-      def set_channel_data(id:, channel_id:, channel_data:)
+      def set_channel_data(collection:, id:, channel_id:, channel_data:)
         request = put_request(
           auth: true,
           path: "/v1/objects/#{collection}/#{id}/channel_data/#{channel_id}",
-          body: {data: channel_data}
+          body: { data: channel_data }
+        )
+
+        execute_request(request: request)
+      end
+
+      # Unsets object channel data for the given channel id
+      #
+      # @param [String] collection The collection the object is in
+      # @param [String] id The object id
+      # @param [String] channel_id target channel ID
+      #
+      # @return [Hash] channel data
+      def unset_channel_data(collection:, id:, channel_id:)
+        request = delete_request(
+          auth: true,
+          path: "/v1/objects/#{collection}/#{id}/channel_data/#{channel_id}"
+        )
+
+        execute_request(request: request)
+      end
+
+      # Get object's messages
+      #
+      # @param [String] collection The collection the object is in
+      # @param [String] id The object id
+      # @param [Hash] options Options to pass to the messages endpoint query
+      #
+      # @return [Hash] Paginated messages response
+      def get_messages(collection:, id:, options: {})
+        request = get_request(
+          auth: true,
+          path: "/v1/objects/#{collection}/#{id}/messages",
+          params: options
+        )
+
+        execute_request(request: request)
+      end
+
+      ##
+      # Preferences
+      ##
+
+      # Returns all preference sets for the object
+      #
+      # @param [String] collection The collection the object is in
+      # @param [String] id The object id
+      #
+      # @return [Array] The preference sets
+      def get_all_preferences(collection:, id:)
+        endpoint = "/v1/objects/#{collection}/#{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 object given.
+      #
+      # @param [String] collection The collection the object is in
+      # @param [String] id The object id
+      # @param [String] preference_set The preference set ID (defaults to `default`)
+      #
+      # @return [Hash] The preference set (if it exists)
+      def get_preferences(collection:, id:, preference_set: DEFAULT_PREFERENCE_SET_ID)
+        endpoint = "/v1/objects/#{collection}/#{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] collection The collection the object is in
+      # @param [String] id The object id
+      # @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(
+        collection:,
+        id:,
+        channel_types: nil,
+        workflows: nil,
+        categories: nil,
+        preference_set: DEFAULT_PREFERENCE_SET_ID
+      )
+        endpoint = "/v1/objects/#{collection}/#{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
+
+      # Sets preferences for the given channel type
+      #
+      # @param [String] collection The collection the object is in
+      # @param [String] id The object id
+      # @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(collection:,
+                                       id:,
+                                       channel_type:,
+                                       setting:,
+                                       preference_set: DEFAULT_PREFERENCE_SET_ID)
+        endpoint = "/v1/objects/#{collection}/#{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] collection The collection the object is in
+      # @param [String] id The object id
+      # @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(collection:, id:, workflow:, setting:, preference_set: DEFAULT_PREFERENCE_SET_ID)
+        params = setting.is_a?(Hash) ? setting : { subscribed: setting }
+        endpoint = "/v1/objects/#{collection}/#{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] collection The collection the object is in
+      # @param [String] id The object id
+      # @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(collection:, id:, category:, setting:, preference_set: DEFAULT_PREFERENCE_SET_ID)
+        params = setting.is_a?(Hash) ? setting : { subscribed: setting }
+        endpoint = "/v1/objects/#{collection}/#{id}/preferences/#{preference_set}/categories/#{category}"
+
+        request = put_request(
+          auth: true,
+          path: endpoint,
+          body: params
         )
 
         execute_request(request: request)
       end
     end
   end
+  # rubocop:enable Metrics/ModuleLength
 end

data/lib/knock/preferences.rb

@@ -1,5 +1,7 @@
-require "net/http"
-require "uri"
+# frozen_string_literal: true
+
+require 'net/http'
+require 'uri'
 
 module Knock
   # Provides convienience methods for working with preferences (deprecated)
@@ -36,7 +38,7 @@ module Knock
       # @param [String] preference_set The preference set ID (defaults to `default`)
       # @param [Hash] preferences The preferences hash to set
       #
-      #  @return [Hash] The preference set
+      # @return [Hash] The preference set
       # @deprecated Please use {#Knock::Users.set_preferences} instead
       def update(
         user_id:,

data/lib/knock/tenants.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+require 'net/http'
+require 'uri'
+
+module Knock
+  # Methods for interacting with tenants in Knock
+  module Tenants
+    class << self
+      include Base
+      include Client
+
+      # Retrieves all Tenants in environment
+      #
+      # @param [Hash] options Options to pass to the tenants endpoint query
+      #
+      # @return [Hash] Paginated list of Tenant records
+      def list(options: {})
+        request = get_request(
+          auth: true,
+          path: '/v1/tenants',
+          params: options
+        )
+
+        execute_request(request: request)
+      end
+
+      # Retrieves a Tenant
+      #
+      # @param [String] id The Tenant id
+      #
+      # @return [Hash] The Tenant
+      def get(id:)
+        request = get_request(
+          auth: true,
+          path: "/v1/tenants/#{id}"
+        )
+
+        execute_request(request: request)
+      end
+
+      # Upserts a Tenant
+      #
+      # @param [String] id The Tenant id
+      # @param [Hash] tenant_data The data to set on the Tenant
+      #
+      # @return [Hash] The Tenant
+      def set(id:, tenant_data: {})
+        request = put_request(
+          auth: true,
+          path: "/v1/tenants/#{id}",
+          body: tenant_data
+        )
+
+        execute_request(request: request)
+      end
+
+      # Deletes a Tenant
+      #
+      # @param [String] id The Tenant id
+      #
+      # @return [nil] Nothing
+      def delete(id:)
+        request = delete_request(
+          auth: true,
+          path: "/v1/tenants/#{id}"
+        )
+
+        execute_request(request: request)
+      end
+    end
+  end
+end

data/lib/knock/users.rb

@@ -1,14 +1,17 @@
-require "net/http"
-require "uri"
+# frozen_string_literal: true
+
+require 'net/http'
+require 'uri'
 
 module Knock
   # Provides convienience methods for working with users
+  # rubocop:disable Metrics/ModuleLength
   module Users
     class << self
       include Base
       include Client
 
-      DEFAULT_PREFERENCE_SET_ID = "default"
+      DEFAULT_PREFERENCE_SET_ID = 'default'
 
       # Identifies the user
       #
@@ -34,8 +37,8 @@ module Knock
       def bulk_identify(users: [])
         request = post_request(
           auth: true,
-          path: "/v1/users/bulk/identify",
-          body: {users: users}
+          path: '/v1/users/bulk/identify',
+          body: { users: users }
         )
 
         execute_request(request: request)
@@ -77,8 +80,8 @@ module Knock
       def bulk_delete(user_ids: [])
         request = post_request(
           auth: true,
-          path: "/v1/users/bulk/delete",
-          body: {user_ids: user_ids}
+          path: '/v1/users/bulk/delete',
+          body: { user_ids: user_ids }
         )
 
         execute_request(request: request)
@@ -198,12 +201,10 @@ module Knock
         preferences: {},
         preference_set: DEFAULT_PREFERENCE_SET_ID
       )
-        endpoint = "/v1/users/bulk/preferences"
+        endpoint = '/v1/users/bulk/preferences'
 
         # Put the preference set id if it doesn't already exist
-        unless preferences.has_key("id")
-          preferences["id"] = preference_set
-        end
+        preferences['id'] = preference_set unless preferences.has_key('id')
 
         request = put_request(
           auth: true,
@@ -231,7 +232,7 @@ module Knock
         request = put_request(
           auth: true,
           path: endpoint,
-          body: {subscribed: setting}
+          body: { subscribed: setting }
         )
 
         execute_request(request: request)
@@ -247,7 +248,7 @@ module Knock
       #
       # @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}
+        params = setting.is_a?(Hash) ? setting : { subscribed: setting }
         endpoint = "/v1/users/#{user_id}/preferences/#{preference_set}/workflows/#{workflow}"
 
         request = put_request(
@@ -269,7 +270,7 @@ module Knock
       #
       # @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}
+        params = setting.is_a?(Hash) ? setting : { subscribed: setting }
         endpoint = "/v1/users/#{user_id}/preferences/#{preference_set}/categories/#{category}"
 
         request = put_request(
@@ -311,11 +312,48 @@ module Knock
         request = put_request(
           auth: true,
           path: "/v1/users/#{id}/channel_data/#{channel_id}",
-          body: {data: channel_data}
+          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: {})
+        request = get_request(
+          auth: true,
+          path: "/v1/users/#{id}/messages",
+          params: options
         )
 
         execute_request(request: request)
       end
     end
   end
+  # rubocop:enable Metrics/ModuleLength
 end

data/lib/knock/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Knock
-  VERSION = "0.4.1"
+  VERSION = '0.4.4'
 end

data/lib/knock/workflows.rb

@@ -1,5 +1,7 @@
-require "net/http"
-require "uri"
+# frozen_string_literal: true
+
+require 'net/http'
+require 'uri'
 
 module Knock
   # Methods for interacting with workflows in Knock
@@ -11,7 +13,7 @@ module Knock
       # Triggers the workflow with the given key
       #
       # @param [String] key The workflow key
-      # @param [String, Hash] actor The actor identifier
+      # @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

data/lib/knock.rb

@@ -1,10 +1,11 @@
 # frozen_string_literal: true
 
-require "knock/version"
-require "json"
+require 'knock/version'
+require 'json'
 
+# Setup for Knock client
 module Knock
-  API_HOSTNAME = ENV["KNOCK_API_HOSTNAME"] || "api.knock.app"
+  API_HOSTNAME = ENV['KNOCK_API_HOSTNAME'] || 'api.knock.app'
 
   def self.key=(value)
     Base.key = value
@@ -15,25 +16,27 @@ module Knock
   end
 
   def self.key!
-    key || raise("Knock.key not set")
+    key || raise('Knock.key not set')
   end
 
-  autoload :Base, "knock/base"
-  autoload :Client, "knock/client"
+  autoload :Base, 'knock/base'
+  autoload :Client, 'knock/client'
 
   # Resources
-  autoload :Preferences, "knock/preferences"
-  autoload :Users, "knock/users"
-  autoload :Workflows, "knock/workflows"
-  autoload :BulkOperations, "knock/bulk_operations"
-  autoload :Objects, "knock/objects"
+  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 :APIError, 'knock/errors'
+  autoload :AuthenticationError, 'knock/errors'
+  autoload :InvalidRequestError, 'knock/errors'
 
-  key = ENV["KNOCK_API_KEY"]
+  key = ENV['KNOCK_API_KEY']
   Knock.key = key unless key.nil?
 
   # Triggers the workflow with the given key

data/spec/tenants_spec.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require_relative '../lib/knock'
+# rubocop:disable Metrics/BlockLength
+describe 'tenant tests' do
+  before do
+    allow_any_instance_of(Knock::Client)
+      .to receive(:execute_request)
+      .with({ request: 'request' })
+      .and_return('ok')
+  end
+  describe '#list' do
+    before do
+      allow_any_instance_of(Knock::Client)
+        .to receive(:get_request)
+        .with({ auth: true,
+                path: '/v1/tenants',
+                params: {} })
+        .and_return('request')
+    end
+    it 'sends the correct parameters to the tenants API' do
+      Knock::Tenants.list(options: {})
+    end
+  end
+
+  describe '#get' do
+    before do
+      allow_any_instance_of(Knock::Client)
+        .to receive(:get_request)
+        .with({ auth: true,
+                path: '/v1/tenants/tenant_id' })
+        .and_return('request')
+    end
+    it 'sends the correct parameters to the tenants API' do
+      Knock::Tenants.get(id: 'tenant_id')
+    end
+  end
+
+  describe '#delete' do
+    before do
+      allow_any_instance_of(Knock::Client)
+        .to receive(:delete_request)
+        .with({ auth: true,
+                path: '/v1/tenants/tenant_id' })
+        .and_return('request')
+    end
+    it 'sends the correct parameters to the tenants API' do
+      Knock::Tenants.delete(id: 'tenant_id')
+    end
+  end
+
+  describe '#set' do
+    before do
+      body = { name: 'My tenant', settings: { branding: { primary_color: '#FFFFFF' } } }
+      allow_any_instance_of(Knock::Client).to receive(:put_request)
+        .with({ auth: true,
+                body: body, path: '/v1/tenants/tenant_id' })
+        .and_return('request')
+    end
+    it 'sends the correct parameters to the tenants API' do
+      tenant_data = { name: 'My tenant', settings: { branding: { primary_color: '#FFFFFF' } } }
+      Knock::Tenants.set(id: 'tenant_id', tenant_data: tenant_data)
+    end
+  end
+end
+# rubocop:enable Metrics/BlockLength

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: knockapi
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.4
 platform: ruby
 authors:
 - Knock Labs, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-01-21 00:00:00.000000000 Z
+date: 2022-07-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -62,7 +62,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".github/workflows/publish.yml"
+- ".github/workflows/ruby.yml"
 - ".gitignore"
+- ".rubocop.yml"
 - ".ruby-version"
 - Gemfile
 - Gemfile.lock
@@ -76,11 +78,14 @@ files:
 - lib/knock/bulk_operations.rb
 - lib/knock/client.rb
 - lib/knock/errors.rb
+- lib/knock/messages.rb
 - lib/knock/objects.rb
 - lib/knock/preferences.rb
+- lib/knock/tenants.rb
 - lib/knock/users.rb
 - lib/knock/version.rb
 - lib/knock/workflows.rb
+- spec/tenants_spec.rb
 homepage: https://github.com/knocklabs/knock-ruby
 licenses:
 - MIT
@@ -101,8 +106,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
+rubygems_version: 3.3.7
 signing_key: 
 specification_version: 4
 summary: API client for Knock
-test_files: []
+test_files:
+- spec/tenants_spec.rb