discourse_api 0.44.0 → 0.47.0

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/search_spec.rb

@@ -6,12 +6,12 @@ describe DiscourseApi::API::Search do
 
   describe "#search" do
     before do
-      stub_get("#{host}/search/query").with(query: { term: "test" }).to_return(body: fixture("search.json"), headers: { content_type: "application/json" })
+      stub_get("#{host}/search").with(query: { q: "test" }).to_return(body: fixture("search.json"), headers: { content_type: "application/json" })
     end
 
     it "requests the correct resource" do
       subject.search("test")
-      expect(a_get("#{host}/search/query").with(query: { term: "test" })).to have_been_made
+      expect(a_get("#{host}/search").with(query: { q: "test" })).to have_been_made
     end
 
     it "returns the requested search" do

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
@@ -55,6 +60,29 @@ describe DiscourseApi::API::Topics do
     end
   end
 
+  describe "#top_topics" do
+    before do
+      stub_get("#{host}/top.json").to_return(body: fixture("top.json"), headers: { content_type: "application/json" })
+    end
+
+    it "requests the correct resource" do
+      subject.top_topics
+      expect(a_get("#{host}/top.json")).to have_been_made
+    end
+
+    it "returns the requested topics" do
+      topics = subject.top_topics
+      expect(topics).to be_an Array
+      expect(topics.first).to be_a Hash
+    end
+
+    it "can take a hash param" do
+      topics = subject.top_topics({})
+      expect(topics).to be_an Array
+      expect(topics.first).to be_a Hash
+    end
+  end
+
   describe "#new_topics" do
     before do
       stub_get("#{host}/new.json").to_return(body: fixture("new.json"), headers: { content_type: "application/json" })
@@ -147,6 +175,14 @@ describe DiscourseApi::API::Topics do
       expect(body['post_stream']['posts']).to be_an Array
       expect(body['post_stream']['posts'].first).to be_a Hash
     end
+
+    it "can retrieve a topic posts' raw attribute" do
+      body = subject.topic_posts(57, [123], { include_raw: true })
+      expect(body).to be_a Hash
+      expect(body['post_stream']['posts']).to be_an Array
+      expect(body['post_stream']['posts'].first).to be_a Hash
+      expect(body['post_stream']['posts'].first['raw']).to be_an Array
+    end
   end
 
   describe "#create_topic_with_tags" do
@@ -166,4 +202,39 @@ describe DiscourseApi::API::Topics do
     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
+
+  describe "#bookmark_topic" do
+    before do
+      stub_put("#{host}/t/1/bookmark.json").to_return(body: "", headers: { content_type: "application/json" })
+    end
+
+    it "makes the put request" do
+      response = subject.bookmark_topic(1)
+      expect(a_put("#{host}/t/1/bookmark.json")).to have_been_made
+      expect(response.body).to eq(nil)
+    end
+  end
+
+  describe "#remove_topic_bookmark" do
+    before do
+      stub_put("#{host}/t/1/remove_bookmarks.json").to_return(body: "", headers: { content_type: "application/json" })
+    end
+
+    it "makes the put request" do
+      response = subject.remove_topic_bookmark(1)
+      expect(a_put("#{host}/t/1/remove_bookmarks.json")).to have_been_made
+      expect(response.body).to eq(nil)
+    end
+  end
 end

data/spec/discourse_api/client_spec.rb

@@ -28,6 +28,21 @@ describe DiscourseApi::Client do
     end
   end
 
+  describe "#timeout" do
+    context 'custom timeout' do
+      it "is set to Faraday connection" do
+        expect(subject.send(:connection).options.timeout).to eq(30)
+      end
+    end
+
+    context 'default timeout' do
+      it "is set to Faraday connection" do
+        subject.timeout = 25
+        expect(subject.send(:connection).options.timeout).to eq(25)
+      end
+    end
+  end
+
   describe "#api_key" do
     it "is publically accessible" do
       subject.api_key = "test_d7fd0429940"

data/spec/fixtures/api_key.json

@@ -0,0 +1,12 @@
+{
+  "key": {
+    "id": 5,
+    "key": "e722e04df8cf6d097d565ca04eea1ff8e9e8f09beb405bae6f0c79852916f334",
+    "user": {
+      "id": 2,
+      "username": "robin",
+      "uploaded_avatar_id": 3,
+      "avatar_template": "/user_avatar/localhost/robin/{size}/3.png"
+    }
+  }
+}

data/spec/fixtures/list_api_keys.json

@@ -0,0 +1,14 @@
+{
+  "keys": [
+    {
+      "id": 1,
+      "key": "test_d7fd0429940",
+      "user": {
+        "id": 1,
+        "username": "test_user",
+        "uploaded_avatar_id": 7,
+        "avatar_template": "/user_avatar/localhost/test_user/{size}/7.png"
+      }
+    }
+  ]
+}

data/spec/fixtures/notification_success.json

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

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
+    }
+  ]
+}

data/spec/fixtures/top.json

@@ -0,0 +1,108 @@
+{
+  "topic_list": {
+    "can_create_topic": false,
+    "more_topics_url": "/latest.json?page=1",
+    "draft": null,
+    "draft_key": "new_topic",
+    "draft_sequence": null,
+    "topics": [
+      {
+        "id": 1,
+        "title": "Test topic #1",
+        "fancy_title": "Test topic #1",
+        "slug": "test-topic-1",
+        "posts_count": 1,
+        "reply_count": 0,
+        "highest_post_number": 1,
+        "image_url": null,
+        "created_at": "2013-02-04T15:26:25.977-05:00",
+        "last_posted_at": "2013-02-05T12:14:17.364-05:00",
+        "bumped": true,
+        "bumped_at": "2013-02-07T13:43:11.191-05:00",
+        "unseen": false,
+        "pinned": true,
+        "excerpt": "Welcome! \n\nTry is a sandbox, a safe place to play with Discourse and its features.\n\nThis site is reset every day (or even more often). Any accounts or posts you create here will not exist tomorrow! \n\nFeel free to experim…",
+        "visible": true,
+        "closed": false,
+        "archived": false,
+        "views": 268,
+        "like_count": 14,
+        "has_best_of": false,
+        "archetype": "regular",
+        "last_poster_username": "test_user",
+        "category_id": 1,
+        "posters": [
+          {
+            "extras": null,
+            "description": "Original Poster, Most Recent Poster",
+            "user_id": 1
+          }
+        ]
+      },
+      {
+        "id": 1,
+        "title": "Test topic #2",
+        "fancy_title": "Test topic #2",
+        "slug": "test-topic-1",
+        "posts_count": 1,
+        "reply_count": 0,
+        "highest_post_number": 2,
+        "image_url": null,
+        "created_at": "2013-11-06T13:57:47.984-05:00",
+        "last_posted_at": "2013-11-06T13:57:48.111-05:00",
+        "bumped": true,
+        "bumped_at": "2013-11-06T13:57:48.111-05:00",
+        "unseen": false,
+        "pinned": false,
+        "visible": true,
+        "closed": false,
+        "archived": false,
+        "views": 1,
+        "like_count": 0,
+        "has_best_of": false,
+        "archetype": "regular",
+        "last_poster_username": "test_user",
+        "category_id": 1,
+        "posters": [
+          {
+            "extras": null,
+            "description": "Original Poster, Most Recent Poster",
+            "user_id": 1
+          }
+        ]
+      },
+      {
+        "id": 1,
+        "title": "Test topic #3",
+        "fancy_title": "Test topic #3",
+        "slug": "test-topic-3",
+        "posts_count": 1,
+        "reply_count": 0,
+        "highest_post_number": 1,
+        "image_url": null,
+        "created_at": "2013-02-04T21:46:58.194-05:00",
+        "last_posted_at": "2013-11-06T13:56:27.753-05:00",
+        "bumped": true,
+        "bumped_at": "2013-11-06T13:56:27.753-05:00",
+        "unseen": false,
+        "pinned": false,
+        "visible": true,
+        "closed": false,
+        "archived": false,
+        "views": 82,
+        "like_count": 10,
+        "has_best_of": false,
+        "archetype": "regular",
+        "last_poster_username": "test_user",
+        "category_id": 1,
+        "posters": [
+          {
+            "extras": null,
+            "description": "Original Poster, Most Recent Poster",
+            "user_id": 1
+          }
+        ]
+      }
+    ]
+  }
+}