knockapi 0.4.5 → 0.4.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 81cfa3f6f13dddad567058c6c1bf837d41fbf4227247e6d5f7cd4bcedf94cb2b
-  data.tar.gz: 18ed9ffaed543083c5edcb5c2a0274919b10fca298938e324f96d2514c2dfa81
+  metadata.gz: 829d797080c6841ef0bda6f2e775e17d45f4c30c466f2b0e1b8ea2abb7e8602e
+  data.tar.gz: 34bfb3a3bcad22f326a3195d67f879d57e746c1eaef1bb8fd5be490a5eac1058
 SHA512:
-  metadata.gz: 8e2e848f8d590fff5367f1a805c671fc9ad0643fc6b14e1300d362d99007de94922fe56a74dc1a9bf73e4d4aa79002239b9f7171d25aef68cea6ef3c261304e8
-  data.tar.gz: c4c4ee1372ed47fea5d4fa4c7fddeb1daf4d101959214101b671c1ea8408c7144f98f0e263c0c785639cc8978b2639d438a38b1a97974eab1333fde9fa2d7fc4
+  metadata.gz: 8da11f98837db48e400a3387a081f2309fc7302029b592b6990293127302fd9c17c8c50747e6786943ede84a6cbda9b9496dce58cca25f8f603d016b844d4c8c
+  data.tar.gz: fc8224278dc1ef927eed734a5e55877d9d934a204a8cf22bd11b32ddeee3d04281bbff1195da500755fb1e248e30f30f28967d42e010f79da96ae4f53cbf3436

data/CONTRIBUTING.md

@@ -0,0 +1,31 @@
+# Contributing
+
+## Getting Started
+
+1. Install [asdf](https://asdf-vm.com)
+2. Install the asdf Ruby plugin
+
+```bash
+asdf plugin add ruby https://github.com/asdf-vm/asdf-ruby.git # Visit that repository to see installation prerequisites
+```
+
+3. Run `asdf install` to install the version of Ruby specified in the [.ruby-version](.ruby-version) file
+4. Run `bundle install` to install the Ruby dependencies
+
+## Running the tests
+
+```bash
+bundle exec rspec
+```
+
+## Running the linter
+
+```bash
+bundle exec rubocop
+```
+
+## Formatting
+
+```bash
+bundle exec rubocop -a
+```

data/Gemfile.lock

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

data/lib/knock/client.rb

@@ -37,15 +37,16 @@ module Knock
       request
     end
 
-    def post_request(path:, auth: false, _idempotency_key: nil, body: nil)
+    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['Idempotency-Key'] = idempotency_key if idempotency_key
       request
     end
 
-    def delete_request(path:, auth: false, params: {})
+    def delete_request(path:, auth: false, params: {}, body: nil)
       uri = URI(path)
       uri.query = URI.encode_www_form(params) if params
 
@@ -54,16 +55,18 @@ module Knock
         'Content-Type' => 'application/json'
       )
 
+      request.body = body.to_json if body
       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)
+    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['Idempotency-Key'] = idempotency_key if idempotency_key
       request
     end
 

data/lib/knock/objects.rb

@@ -306,6 +306,58 @@ module Knock
 
         execute_request(request: request)
       end
+
+      # Lists all subscriptiopns for the given object
+      #
+      # @param [String] collection The collection the object is in
+      # @param [String] id The object id
+      # @param [Hash] options Options to pass to the subscriptions endpoint
+      #
+      # @return [Hash] Paginated subscriptions response
+      def list_subscriptions(collection:, id:, options: {})
+        request = get_request(
+          auth: true,
+          path: "/v1/objects/#{collection}/#{id}/subscriptions",
+          params: options
+        )
+
+        execute_request(request: request)
+      end
+
+      # Creates a set of subscriptions for the recipients on the object
+      #
+      # @param [String] collection The collection the object is in
+      # @param [String] id The object id
+      # @param [Array<String, Hash>] recipients An array of recipients
+      # @param [Hash] properties A set of custom properties to set on the subscriptions
+      #
+      # @return [Array<Hash>] List of created subscriptions
+      def add_subscriptions(collection:, id:, recipients: [], properties: {})
+        request = post_request(
+          auth: true,
+          path: "/v1/objects/#{collection}/#{id}/subscriptions",
+          body: { recipients: recipients, properties: properties }
+        )
+
+        execute_request(request: request)
+      end
+
+      # Removes subscriptions for the recipients on the object
+      #
+      # @param [String] collection The collection the object is in
+      # @param [String] id The object id
+      # @param [Array<String, Hash>] recipients An array of recipients
+      #
+      # @return [Array<Hash>] List of deleted subscriptions
+      def delete_subscriptions(collection:, id:, recipients: [])
+        request = delete_request(
+          auth: true,
+          path: "/v1/objects/#{collection}/#{id}/subscriptions",
+          body: { recipients: recipients }
+        )
+
+        execute_request(request: request)
+      end
     end
   end
   # rubocop:enable Metrics/ModuleLength

data/lib/knock/version.rb

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

data/lib/knock/workflows.rb

@@ -19,9 +19,11 @@ module Knock
       # @param [String] cancellation_key An optional key to identify this workflow
       #  invocation for cancelling
       # @param [String] tenant An optional tenant identifier
+      # @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)
+      def trigger(key:, actor:, recipients:, data: {}, cancellation_key: nil, tenant: nil, idempotency_key: nil) # rubocop:disable Metrics/ParameterLists
         attrs = {
           actor: actor,
           recipients: recipients,
@@ -33,7 +35,8 @@ module Knock
         request = post_request(
           auth: true,
           path: "/v1/workflows/#{key}/trigger",
-          body: attrs
+          body: attrs,
+          idempotency_key: idempotency_key
         )
 
         execute_request(request: request)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: knockapi
 version: !ruby/object:Gem::Version
-  version: 0.4.5
+  version: 0.4.7
 platform: ruby
 authors:
 - Knock Labs, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-12-22 00:00:00.000000000 Z
+date: 2023-04-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,6 +66,7 @@ files:
 - ".gitignore"
 - ".rubocop.yml"
 - ".ruby-version"
+- CONTRIBUTING.md
 - Gemfile
 - Gemfile.lock
 - LICENSE
@@ -106,7 +107,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
+rubygems_version: 3.4.10
 signing_key: 
 specification_version: 4
 summary: API client for Knock