knockapi 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: df2a97ad8702bbb6843e12eeca370179e4ce14e1c591312d8bc6462c9114fd07
-  data.tar.gz: bdaae5b1b47ef4e022ff4fa81f59250705880801ef6075af337b41ee657ef79a
+  metadata.gz: c8d8593021545fcd9b7c40062469882c43afe76a8777579719978ba9e54027ae
+  data.tar.gz: daad9dcf8d90f026cf056711b0616663edc9715d214e4a8e6b46a8c9ab021424
 SHA512:
-  metadata.gz: 799e436d7ca5514f82b76f789f7fcf031fb67ed1d5f2705b34c9313c3a9369b04b450bd72e4e18c1d29d4119cf65a353729a5102fabfb1be3ef3ade48a9bd047
-  data.tar.gz: aec1077db54be921685100263417cc360af0ede27c382282a0f117bf59bce26d41d1af7db4775dadfb7b19b27e3b53ceae1fab1c8b4c73b43f56dbd045ebc3a8
+  metadata.gz: 4525ed1305fded0310eb782031bd2e832dea431c94a6cddbeab5b72e06ee67b35458e78f1135f03911f41e0b669ee4819b514160a2bb198a648241972e3f3c6d
+  data.tar.gz: ab4906c79209c2159e6e2b420a1c7ad53752f174fd1bf10312afbe0775b47d38cbd11d793e7e400a3411fb6f48166018d9b5a4f8af7497b50b2ee40b0f72cb66

data/.github/workflows/publish.yml

@@ -0,0 +1,17 @@
+name: Publish Gem
+
+on:
+  push:
+    tags:
+      - v*
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v1
+      - name: Release Gem
+        uses: cadwallion/publish-rubygems-action@master
+        env:
+          GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
+          RUBYGEMS_API_KEY: ${{secrets.RUBYGEMS_API_KEY}}
+          RELEASE_COMMAND: ./bin/publish

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    knockapi (0.1.0)
+    knockapi (0.3.0)
 
 GEM
   remote: https://rubygems.org/
@@ -44,4 +44,4 @@ DEPENDENCIES
   standard
 
 BUNDLED WITH
-   2.2.22
+   2.2.26

data/README.md

@@ -112,6 +112,25 @@ Knock::Preferences.set(
 Knock::Preferences.get(user_id: "jhammond")
 ```
 
+### Getting and setting channel data
+
+```ruby
+require "knockapi"
+Knock.key = "sk_12345"
+
+# Set channel data for an APNS
+Knock::Users.set_channel_data(
+  id: "jhammond",
+  channel_id: KNOCK_APNS_CHANNEL_ID,
+  channel_data: {
+    'tokens': [apns_token]
+  }
+)
+
+# Get channel data for the APNS channel
+Knock::Users.get_channel_data(user_id: "jhammond", channel_id: KNOCK_APNS_CHANNEL_ID)
+```
+
 ### Cancelling workflows
 
 ```ruby

data/bin/publish

@@ -0,0 +1,5 @@
+#!/usr/bin/env bash
+
+bundle install
+bundle exec gem build knockapi --output=release.gem
+bundle exec gem push release.gem

data/lib/knock/users.rb

@@ -51,6 +51,38 @@ module Knock
 
         execute_request(request: request)
       end
+
+      # 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 [String] 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
     end
   end
 end

data/lib/knock/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Knock
-  VERSION = "0.1.0"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: knockapi
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Knock Labs, Inc.
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-08-18 00:00:00.000000000 Z
+date: 2021-08-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -57,9 +57,11 @@ email:
 - support@knock.app
 executables:
 - console
+- publish
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/publish.yml"
 - ".gitignore"
 - ".ruby-version"
 - Gemfile
@@ -67,6 +69,7 @@ files:
 - LICENSE
 - README.md
 - bin/console
+- bin/publish
 - knockapi.gemspec
 - lib/knock.rb
 - lib/knock/base.rb
@@ -96,7 +99,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.2.26
 signing_key:
 specification_version: 4
 summary: API client for Knock