knockapi 0.4.6 → 0.4.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bb2117c38dcd672ea551af82b0803b141576d46ba155bbb345e3dd3136c8ad13
-  data.tar.gz: eebda102aea7791d7b664f244dadb26b98d529d4eb197227684dcb1f64bbdfe4
+  metadata.gz: f76a1fe37f883f760b872f6b52bafb40e22a870f650fb0c4cc5b40e85912888c
+  data.tar.gz: 7dc8c721a049b9b3a25ff67db18dc9cdca1e551f1bbcdddbf025305f6b23e582
 SHA512:
-  metadata.gz: 7f56c9b141388fbf5793b1699a958b71b321593acc86f19afaadb96c15425c3ce0895e47d2e7f229d36a0a512a55a77cad90ae8da5e5c9e812833d035db93eb1
-  data.tar.gz: a1837d1bc86cecf3250ac99286e0a46c8ea6f3bc5b7c07cca6f806fe6b443a02ee7996daa7009f39169065ba377b5acce24c337ad7fc9a05d37cad7f383be1d7
+  metadata.gz: 38e0c87a2c2e4fe46c1cc80c9a7707e1b26416f682a5de387f8725afa0e9a9599a9ee35b0b57e693b1a37897d2cf5e132c75595304497281f4b014e350946ef5
+  data.tar.gz: 4a3be25fd78f03bc7605fea581486950639ea333c819828e1859e30d94ea8f0e42d00807a5076ba9d97db508c48e08163dbe81f694adc49517401028b8f582f2

data/.rubocop.yml

@@ -5,4 +5,4 @@ Metrics/LineLength:
 Metrics/MethodLength:
   Max: 35
 Metrics/ParameterLists:
-  Max: 6
+  Max: 7

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.6)
+    knockapi (0.4.8)
 
 GEM
   remote: https://rubygems.org/

data/lib/knock/client.rb

@@ -37,11 +37,12 @@ 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
 
@@ -60,11 +61,12 @@ module Knock
       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

@@ -358,6 +358,23 @@ module Knock
 
         execute_request(request: request)
       end
+
+      # Get object's schedules
+      #
+      # @param [String] collection The collection the object is in
+      # @param [String] id The object id
+      # @param [Hash] options Options to pass to the schedules endpoint query
+      #
+      # @return [Hash] Paginated schedules response
+      def get_schedules(collection:, id:, options: {})
+        request = get_request(
+          auth: true,
+          path: "/v1/objects/#{collection}/#{id}/schedules",
+          params: options
+        )
+
+        execute_request(request: request)
+      end
     end
   end
   # rubocop:enable Metrics/ModuleLength

data/lib/knock/users.rb

@@ -358,6 +358,26 @@ module Knock
 
         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
     end
   end
   # rubocop:enable Metrics/ModuleLength

data/lib/knock/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Knock
-  VERSION = '0.4.6'
+  VERSION = '0.4.8'
 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)
         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)
@@ -60,6 +63,91 @@ module Knock
 
         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] tenant An optional tenant identifier
+
+      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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: knockapi
 version: !ruby/object:Gem::Version
-  version: 0.4.6
+  version: 0.4.8
 platform: ruby
 authors:
 - Knock Labs, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-03-28 00:00:00.000000000 Z
+date: 2023-04-14 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.4.6
+rubygems_version: 3.4.10
 signing_key: 
 specification_version: 4
 summary: API client for Knock