discourse_api 0.46.0 → 0.47.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 83d6fc91bd7fd472cc3eab0fa06b79d0fbaa5e4cf7a2003bef82eee43f33acf4
-  data.tar.gz: c0aef1ea4eee35c3cf3143d100707c2850829e5551c79af3a6d6f76efb3b262c
+  metadata.gz: 3fffa65d4ed129c229766cecd20c2b5684570d22dcd08deaa44474f37cbe0b7c
+  data.tar.gz: 35db4a119a91642c632b43b78cbde678c2a753f28adb88b376bf1b5ab9bb6a2b
 SHA512:
-  metadata.gz: 4227051151b05bd67b403a9922d0199b4cdaf84ccf5973e4be57fb63af8345053b0d80ca763aa2a9c49c27a1a73a623540bde643a714710298c57e73c4a3a0d3
-  data.tar.gz: 5a6dfdc85bf1db5edb7e474ecfa1df038a617ebb4d3bf890611d6e195e3093d441e2dbdb3826ad468cc397e6de420f4d4d295b275ad0febb78fb32ae86dfec8e
+  metadata.gz: 7353e073896a9e70d38336cba97d0c0f53f951c925e21e4333cc67fd8bfbd40ce5745f50ee6c6a87ce3e5c69c77d67e3287458a96418f033c9ee88901da7e3fa
+  data.tar.gz: 8a3cbddb1585c72dcf3eeaa3723e4742007b076c239e47a23cbf98c87024a95e4712e54eed85be4b48f9100acef41b282b91007c05237cc10048d5753ed82db4

data/CHANGELOG.md

@@ -6,6 +6,20 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.47.0] - 2021-07-19
+### Added
+- Update invite method
+- Retrieve invite method
+- Destroy all expired invites method
+- Destroy invite method
+- Resend all invites method
+- Resend invite method
+- Pass params to get notifications API
+
+### Deprecated
+- `invite_user_to_topic` has been deprecated, use `invite_user` instead.
+- `create_private_message` has been deprecated, use `create_pm` instead.
+
 ## [0.46.0] - 2021-04-12
 ### Added
 - Allow bookmarking topics

data/examples/invite_users.rb

@@ -9,10 +9,28 @@ client.api_key = config['api_key'] || "YOUR_API_KEY"
 client.api_username = config['api_username'] || "YOUR_USERNAME"
 
 # invite user
-client.invite_user(email: "name@example.com", group_ids: "41,42")
+invite = client.invite_user(email: "name@example.com", group_ids: "41,42")
+
+#update invite
+client.update_invite(invite["id"], email: "namee@example.com")
+
+# resend invite
+client.resend_invite("namee@example.com")
 
 # invite to a topic
 client.invite_user_to_topic(email: "foo@bar.com", topic_id: 1)
 
 # if the user is an admin you may invite to a group as well
-client.invite_user_to_topic(email: "foo@bar.com", topic_id: 1, group_ids: "1,2,3")
+client.invite_user_to_topic(email: "foo@bar.com", group_ids: "1,2,3", topic_id: 1)
+
+# retrieve invite
+puts client.retrieve_invite(email: "foo@bar.com")
+
+# resend all invites
+client.resend_all_invites
+
+# destroy invite
+client.destroy_invite(invite["id"])
+
+# destroy all expired invites
+client.destroy_all_expired_invites

data/examples/notifications.rb

@@ -13,3 +13,6 @@ client.category_set_user_notification_level(1, notification_level: 3)
 
 # mute a topic
 client.topic_set_user_notification_level(1, notification_level: 0)
+
+# get user notifications
+client.notifications(username: 'discourse')

data/lib/discourse_api/api/invite.rb

@@ -3,17 +3,82 @@ module DiscourseApi
   module API
     module Invite
       def invite_user(params = {})
-        post("/invites", params)
+        args = API.params(params)
+          .optional(
+            :email,
+            :skip_email,
+            :custom_message,
+            :max_redemptions_allowed,
+            :topic_id,
+            :group_ids,
+            :expires_at
+          ).to_h
+
+        post("/invites", args)
       end
 
+      # TODO: Deprecated. Remove after 20220506
       def invite_user_to_topic(params = {})
-        post("/t/#{params[:topic_id]}/invite", params)
+        deprecated(__method__, 'invite_to_topic')
+        invite_to_topic(params[:topic_id], params)
+      end
+
+      def invite_to_topic(topic_id, params = {})
+        args = API.params(params)
+          .optional(
+            :email,
+            :user,
+            :group_ids,
+            :custom_message
+          ).to_h
+
+        post("/t/#{topic_id}/invite", args)
+      end
+
+      def retrieve_invite(params = {})
+        args = API.params(params).required(:email).to_h
+
+        response = get("invites/retrieve.json", args)
+
+        response.body
       end
 
       # requires this plugin => https://github.com/discourse/discourse-invite-tokens
       def disposable_tokens(params = {})
         post("/invite-token/generate", params)
       end
+
+      def update_invite(invite_id, params = {})
+        args = API.params(params)
+          .optional(
+            :topic_id,
+            :group_ids,
+            :group_names,
+            :email,
+            :send_email,
+            :custom_message,
+            :max_redemptions_allowed,
+            :expires_at
+          ).to_h
+
+        put("invites/#{invite_id}", args)
+      end
+
+      def destroy_all_expired_invites
+        post("invites/destroy-all-expired")
+      end
+
+      def resend_all_invites
+        post("invites/reinvite-all")
+      end
+
+      def resend_invite(email)
+        post("invites/reinvite", { "email": email })
+      end
+
+      def destroy_invite(invite_id)
+        delete("/invites", { id: invite_id })
+      end
     end
   end
 end

data/lib/discourse_api/api/notifications.rb

@@ -2,8 +2,11 @@
 module DiscourseApi
   module API
     module Notifications
-      def notifications
-        response = get('/notifications.json')
+      def notifications(params = {})
+        params = API.params(params)
+          .optional(:username, :recent, :limit, :offset, :filter)
+
+        response = get('/notifications.json', params)
         response[:body]
       end
     end

data/lib/discourse_api/api/private_messages.rb

@@ -3,13 +3,20 @@ module DiscourseApi
   module API
     module PrivateMessages
 
-      # :target_usernames REQUIRED comma separated list of usernames
+      # TODO: Deprecated. Remove after 20220628
+      def create_private_message(args = {})
+        deprecated(__method__, 'create_pm')
+        args[:target_recipients] = args.delete :target_usernames
+        create_pm(args.to_h)
+      end
+
+      # :target_recipients REQUIRED comma separated list of usernames
       # :category OPTIONAL name of category, not ID
       # :created_at OPTIONAL seconds since epoch.
-      def create_private_message(args = {})
+      def create_pm(args = {})
         args[:archetype] = 'private_message'
         args = API.params(args)
-          .required(:title, :raw, :target_usernames, :archetype)
+          .required(:title, :raw, :target_recipients, :archetype)
           .optional(:category, :created_at, :api_username)
         post("/posts", args.to_h)
       end

data/lib/discourse_api/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module DiscourseApi
-  VERSION = "0.46.0"
+  VERSION = "0.47.0"
 end

data/spec/discourse_api/api/invite_spec.rb

@@ -0,0 +1,123 @@
+# frozen_string_literal: true
+require 'spec_helper'
+
+describe DiscourseApi::API::Invite do
+  subject { DiscourseApi::Client.new("#{host}", "test_d7fd0429940", "test_user") }
+
+  describe "#invite_user" do
+    before do
+      stub_post("#{host}/invites").to_return(body: fixture("topic_invite_user.json"), headers: { content_type: "application/json" })
+    end
+
+    it "requests the correct resource" do
+      subject.invite_user(email: "fake_user@example.com", group_ids: "41,42")
+      expect(a_post("#{host}/invites")).to have_been_made
+    end
+
+    it "returns success" do
+      response = subject.invite_user(email: "fake_user@example.com", group_ids: "41,42")
+      expect(response).to be_a Hash
+      expect(response['success']).to be_truthy
+    end
+  end
+
+  describe "#update_invite" do
+    before do
+      stub_put("#{host}/invites/27").to_return(body: fixture("topic_invite_user.json"), headers: { content_type: "application/json" })
+    end
+
+    it "updates invite" do
+      subject.update_invite(27, email: "namee@example.com")
+      expect(a_put("#{host}/invites/27")).to have_been_made
+    end
+  end
+
+  describe "#retrieve_invite" do
+    before do
+      stub_get("#{host}/invites/retrieve.json?email=foo@bar.com").to_return(body: fixture("retrieve_invite.json"), headers: { content_type: "application/json" })
+    end
+
+    it "requests the correct resource" do
+      subject.retrieve_invite(email: "foo@bar.com")
+      expect(a_get("#{host}/invites/retrieve.json?email=foo@bar.com")).to have_been_made
+    end
+
+    it "returns the requested topics" do
+      invites = subject.retrieve_invite(email: "foo@bar.com")
+      expect(invites).to be_an Hash
+    end
+
+    it "returns the requested invite" do
+      invites = subject.retrieve_invite(email: "foo@bar.com")
+      expect(invites["email"]).to eq("foo@bar.com")
+      expect(invites).to have_key("invite_key")
+    end
+  end
+
+  describe "#destroy_all_expired_invites" do
+    let(:url) { "#{host}/invites/destroy-all-expired" }
+
+    before do
+      stub_post(url)
+        .to_return(
+          body: '{"success": "OK"}',
+          headers: { content_type: "application/json" }
+        )
+    end
+
+    it "destroys all expired invites" do
+      subject.destroy_all_expired_invites
+      expect(a_post(url)).to have_been_made
+    end
+  end
+
+  describe "#resend_all_invites" do
+    let(:url) { "#{host}/invites/reinvite-all" }
+
+    before do
+      stub_post(url)
+        .to_return(
+          body: '{"success": "OK"}',
+          headers: { content_type: "application/json" }
+        )
+    end
+
+    it "resends all invites" do
+      subject.resend_all_invites
+      expect(a_post(url)).to have_been_made
+    end
+  end
+
+  describe "#resend_invite" do
+    let(:url) { "#{host}/invites/reinvite" }
+
+    before do
+      stub_post(url)
+        .to_return(
+          body: '{"success": "OK"}',
+          headers: { content_type: "application/json" }
+        )
+    end
+
+    it "resends invite" do
+      subject.resend_invite("foo@bar.com")
+      expect(a_post(url)).to have_been_made
+    end
+  end
+
+  describe "#destroy_invite" do
+    let(:url) { "#{host}/invites?id=27" }
+
+    before do
+      stub_delete(url).to_return(
+        body: '{"success": "OK"}',
+        headers: { content_type: "application/json" }
+      )
+    end
+
+    it "destroys the invite" do
+      subject.destroy_invite(27)
+      expect(a_delete(url)).to have_been_made
+    end
+  end
+end

data/spec/discourse_api/api/private_messages_spec.rb

@@ -36,19 +36,19 @@ describe DiscourseApi::API::PrivateMessages do
     end
   end
 
-  describe '#create_private_message' do
+  describe '#create_pm' do
     before do
       stub_post("#{host}/posts")
-      subject.create_private_message(
+      subject.create_pm(
         title: "Confidential: Hello World!",
         raw: "This is the raw markdown for my private message",
-        target_usernames: "user1,user2"
+        target_recipients: "user1,user2"
       )
     end
 
     it "makes a create private message request" do
       expect(a_post("#{host}/posts").with(body:
-          'archetype=private_message&raw=This+is+the+raw+markdown+for+my+private+message&target_usernames=user1%2Cuser2&title=Confidential%3A+Hello+World%21')
+          'archetype=private_message&raw=This+is+the+raw+markdown+for+my+private+message&target_recipients=user1%2Cuser2&title=Confidential%3A+Hello+World%21')
         ).to have_been_made
     end
   end

data/spec/discourse_api/api/topics_spec.rb

@@ -25,6 +25,11 @@ describe DiscourseApi::API::Topics do
       expect(a_post("#{host}/t/12/invite")).to have_been_made
     end
 
+    it "requests the correct resource with new method 'invite_to_topic'" do
+      subject.invite_to_topic(12, email: "fake_user@example.com")
+      expect(a_post("#{host}/t/12/invite")).to have_been_made
+    end
+
     it "returns success" do
       response = subject.invite_user_to_topic(email: "fake_user@example.com", topic_id: 12)
       expect(response).to be_a Hash

data/spec/fixtures/retrieve_invite.json

@@ -0,0 +1,116 @@
+{
+  "id": 26,
+  "invite_key": "CGUHjNC4Na",
+  "link": "http://localhost:3000/invites/CGUHjNC4Na",
+  "email": "foo@bar.com",
+  "emailed": true,
+  "custom_message": null,
+  "created_at": "2021-05-07T20:48:14.278Z",
+  "updated_at": "2021-05-07T20:48:14.278Z",
+  "expires_at": "2021-06-06T20:48:14.278Z",
+  "expired": false,
+  "topics": [
+    {
+      "id": 1,
+      "title": "About the Site Feedback category",
+      "fancy_title": "About the Site Feedback category",
+      "slug": "about-the-site-feedback-category",
+      "posts_count": 1
+    }
+  ],
+  "groups": [
+    {
+      "id": 1,
+      "automatic": true,
+      "name": "admins",
+      "display_name": "admins",
+      "user_count": 1,
+      "mentionable_level": 0,
+      "messageable_level": 0,
+      "visibility_level": 1,
+      "primary_group": false,
+      "title": null,
+      "grant_trust_level": null,
+      "incoming_email": null,
+      "has_messages": true,
+      "flair_url": null,
+      "flair_bg_color": null,
+      "flair_color": null,
+      "bio_raw": "",
+      "bio_cooked": null,
+      "bio_excerpt": null,
+      "public_admission": false,
+      "public_exit": false,
+      "allow_membership_requests": false,
+      "full_name": null,
+      "default_notification_level": 3,
+      "membership_request_template": null,
+      "members_visibility_level": 0,
+      "can_see_members": true,
+      "can_admin_group": true,
+      "publish_read_state": false
+    },
+    {
+      "id": 2,
+      "automatic": true,
+      "name": "moderators",
+      "display_name": "moderators",
+      "user_count": 1,
+      "mentionable_level": 0,
+      "messageable_level": 99,
+      "visibility_level": 1,
+      "primary_group": false,
+      "title": null,
+      "grant_trust_level": null,
+      "incoming_email": null,
+      "has_messages": true,
+      "flair_url": null,
+      "flair_bg_color": null,
+      "flair_color": null,
+      "bio_raw": null,
+      "bio_cooked": null,
+      "bio_excerpt": null,
+      "public_admission": false,
+      "public_exit": false,
+      "allow_membership_requests": false,
+      "full_name": null,
+      "default_notification_level": 2,
+      "membership_request_template": null,
+      "members_visibility_level": 0,
+      "can_see_members": true,
+      "can_admin_group": true,
+      "publish_read_state": false
+    },
+    {
+      "id": 3,
+      "automatic": true,
+      "name": "staff",
+      "display_name": "staff",
+      "user_count": 2,
+      "mentionable_level": 0,
+      "messageable_level": 0,
+      "visibility_level": 1,
+      "primary_group": false,
+      "title": null,
+      "grant_trust_level": null,
+      "incoming_email": null,
+      "has_messages": false,
+      "flair_url": null,
+      "flair_bg_color": null,
+      "flair_color": null,
+      "bio_raw": null,
+      "bio_cooked": null,
+      "bio_excerpt": null,
+      "public_admission": false,
+      "public_exit": false,
+      "allow_membership_requests": false,
+      "full_name": null,
+      "default_notification_level": 3,
+      "membership_request_template": null,
+      "members_visibility_level": 0,
+      "can_see_members": true,
+      "can_admin_group": true,
+      "publish_read_state": false
+    }
+  ]
+}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: discourse_api
 version: !ruby/object:Gem::Version
-  version: 0.46.0
+  version: 0.47.0
 platform: ruby
 authors:
 - Sam Saffron
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-04-12 00:00:00.000000000 Z
+date: 2021-07-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -260,6 +260,7 @@ files:
 - spec/discourse_api/api/categories_spec.rb
 - spec/discourse_api/api/email_spec.rb
 - spec/discourse_api/api/groups_spec.rb
+- spec/discourse_api/api/invite_spec.rb
 - spec/discourse_api/api/notifications_spec.rb
 - spec/discourse_api/api/params_spec.rb
 - spec/discourse_api/api/polls_spec.rb
@@ -305,6 +306,7 @@ files:
 - spec/fixtures/regenerate_api_key.json
 - spec/fixtures/replies.json
 - spec/fixtures/replies_and_topics.json
+- spec/fixtures/retrieve_invite.json
 - spec/fixtures/search.json
 - spec/fixtures/top.json
 - spec/fixtures/topic.json
@@ -356,6 +358,7 @@ test_files:
 - spec/discourse_api/api/categories_spec.rb
 - spec/discourse_api/api/email_spec.rb
 - spec/discourse_api/api/groups_spec.rb
+- spec/discourse_api/api/invite_spec.rb
 - spec/discourse_api/api/notifications_spec.rb
 - spec/discourse_api/api/params_spec.rb
 - spec/discourse_api/api/polls_spec.rb
@@ -401,6 +404,7 @@ test_files:
 - spec/fixtures/regenerate_api_key.json
 - spec/fixtures/replies.json
 - spec/fixtures/replies_and_topics.json
+- spec/fixtures/retrieve_invite.json
 - spec/fixtures/search.json
 - spec/fixtures/top.json
 - spec/fixtures/topic.json