Allow setting topic notifications (#220)

Deprecate #category_set_user_notification and add #category_set_user_notification_level in favor of passing require args as params

Author: mikepack

examples/notifications.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require File.expand_path('../../lib/discourse_api', __FILE__)
+
+config = DiscourseApi::ExampleHelper.load_yml
+
+client = DiscourseApi::Client.new(config['host'] || 'http://localhost:3000')
+client.api_key = config['api_key'] || "YOUR_API_KEY"
+client.api_username = config['api_username'] || "YOUR_USERNAME"
+
+# watch an entire category
+client.category_set_user_notification_level(1, notification_level: 3)
+
+# mute a topic
+client.topic_set_user_notification_level(1, notification_level: 0)

lib/discourse_api/api/categories.rb

@@ -75,12 +75,19 @@ def category(id)
         response[:body]['category']
       end
 
+      # TODO: Deprecated. Remove after 20210727
       def category_set_user_notification(args = {})
         category_id = args[:id]
         args = API.params(args)
           .required(:notification_level)
         post("/category/#{category_id}/notifications", args)
       end
+
+      def category_set_user_notification_level(category_id, params)
+        params = API.params(params)
+          .required(:notification_level)
+        post("/category/#{category_id}/notifications", params)
+      end
     end
   end
 end

lib/discourse_api/api/topics.rb

@@ -90,6 +90,12 @@ def change_owner(topic_id, params = {})
 
         post("/t/#{topic_id}/change-owner.json", params)
       end
+
+      def topic_set_user_notification_level(topic_id, params)
+        params = API.params(params)
+          .required(:notification_level)
+        post("/t/#{topic_id}/notifications", params)
+      end
     end
   end
 end

spec/discourse_api/api/categories_spec.rb

@@ -85,4 +85,27 @@
     end
   end
 
+  describe "#category_set_user_notification" do
+    before do
+      stub_post("#{host}/category/1/notifications").to_return(body: fixture("notification_success.json"), headers: { content_type: "application/json" })
+    end
+
+    it "makes the post request" do
+      response = subject.category_set_user_notification(id: 1, notification_level: 3)
+      expect(a_post("#{host}/category/1/notifications")).to have_been_made
+      expect(response['success']).to eq('OK')
+    end
+  end
+
+  describe "#category_set_user_notification_level" do
+    before do
+      stub_post("#{host}/category/1/notifications").to_return(body: fixture("notification_success.json"), headers: { content_type: "application/json" })
+    end
+
+    it "makes the post request" do
+      response = subject.category_set_user_notification_level(1, notification_level: 3)
+      expect(a_post("#{host}/category/1/notifications").with(body: "notification_level=3")).to have_been_made
+      expect(response['success']).to eq('OK')
+    end
+  end
 end

spec/discourse_api/api/topics_spec.rb

@@ -189,4 +189,15 @@
     end
   end
 
+  describe "#topic_set_user_notification_level" do
+    before do
+      stub_post("#{host}/t/1/notifications").to_return(body: fixture("notification_success.json"), headers: { content_type: "application/json" })
+    end
+
+    it "makes the post request" do
+      response = subject.topic_set_user_notification_level(1, notification_level: 3)
+      expect(a_post("#{host}/t/1/notifications").with(body: "notification_level=3")).to have_been_made
+      expect(response['success']).to eq('OK')
+    end
+  end
 end

spec/fixtures/notification_success.json

@@ -0,0 +1,3 @@
+{
+  "success": "OK"
+}