discourse_api 0.45.0 → 0.48.0

data/lib/discourse_api/single_sign_on.rb

@@ -15,8 +15,7 @@ module DiscourseApi
     #NONCE_EXPIRY_TIME = 10.minutes # minutes is a rails method and is causing an error. Is this needed in the api?
 
     attr_accessor(*ACCESSORS)
-    attr_accessor :custom_fields
-    attr_writer :sso_secret, :sso_url
+    attr_writer :custom_fields, :sso_secret, :sso_url
 
     def self.sso_secret
       raise RuntimeError, "sso_secret not implemented on class, be sure to set it on instance"
@@ -27,7 +26,6 @@ module DiscourseApi
     end
 
     def self.parse_hash(payload)
-      payload
       sso = new
 
       sso.sso_secret = payload.delete(:sso_secret)
@@ -40,11 +38,13 @@ module DiscourseApi
         if BOOLS.include? k
           val = ["true", "false"].include?(val) ? val == "true" : nil
         end
-        val = Array(val) if ARRAYS.include?(k) && !val.nil?
+        val = val.split(",") if ARRAYS.include?(k) && !val.nil?
         sso.send("#{k}=", val)
       end
+
       # Set custom_fields
       sso.custom_fields = payload[:custom_fields]
+
       # Add custom_fields (old format)
       payload.each do |k, v|
         if field = k[/^custom\.(.+)$/, 1]
@@ -79,7 +79,7 @@ module DiscourseApi
         if BOOLS.include? k
           val = ["true", "false"].include?(val) ? val == "true" : nil
         end
-        val = Array(val) if ARRAYS.include?(k) && !val.nil?
+        val = val.split(",") if ARRAYS.include?(k) && !val.nil?
         sso.send("#{k}=", val)
       end
 
@@ -127,7 +127,7 @@ module DiscourseApi
 
       ACCESSORS.each do |k|
         next if (val = send k) == nil
-       payload[k] = val
+        payload[k] = val
       end
 
       if @custom_fields

data/lib/discourse_api/version.rb

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

data/spec/discourse_api/api/categories_spec.rb

@@ -28,6 +28,25 @@ describe DiscourseApi::API::Categories do
     end
   end
 
+  describe "#categories_full" do
+    before do
+      stub_get("#{host}/categories.json")
+        .to_return(body: fixture("categories.json"), headers: { content_type: "application/json" })
+    end
+
+    it "requests the correct resource" do
+      subject.categories
+      expect(a_get("#{host}/categories.json")).to have_been_made
+    end
+
+    it "returns the entire categories response" do
+      categories = subject.categories_full
+      expect(categories).to be_a Hash
+      expect(categories).to have_key 'category_list'
+      expect(categories).to have_key 'featured_users'
+    end
+  end
+
   describe '#category_latest_topics' do
     before do
       stub_get("#{host}/c/category-slug/l/latest.json")
@@ -40,6 +59,20 @@ describe DiscourseApi::API::Categories do
     end
   end
 
+  describe '#category_latest_topics_full' do
+    before do
+      stub_get("#{host}/c/category-slug/l/latest.json")
+        .to_return(body: fixture("category_latest_topics.json"), headers: { content_type: "application/json" })
+    end
+
+    it "returns the entire latest topics in a category response" do
+      latest_topics = subject.category_latest_topics_full(category_slug: 'category-slug')
+      expect(latest_topics).to be_a Hash
+      expect(latest_topics).to have_key 'topic_list'
+      expect(latest_topics).to have_key 'users'
+    end
+  end
+
   describe '#category_top_topics' do
     before do
       stub_get("#{host}/c/category-slug/l/top.json")
@@ -55,6 +88,23 @@ describe DiscourseApi::API::Categories do
     end
   end
 
+  describe '#category_top_topics_full' do
+    before do
+      stub_get("#{host}/c/category-slug/l/top.json")
+        .to_return(
+        body: fixture("category_topics.json"),
+        headers: { content_type: "application/json" }
+      )
+    end
+
+    it "returns the entire top topics in a category response" do
+      topics = subject.category_top_topics_full('category-slug')
+      expect(topics).to be_a Hash
+      expect(topics).to have_key 'topic_list'
+      expect(topics).to have_key 'users'
+    end
+  end
+
   describe '#category_new_topics' do
     before do
       stub_get("#{host}/c/category-slug/l/new.json")
@@ -70,6 +120,23 @@ describe DiscourseApi::API::Categories do
     end
   end
 
+  describe '#category_new_topics_full' do
+    before do
+      stub_get("#{host}/c/category-slug/l/new.json")
+        .to_return(
+        body: fixture("category_topics.json"),
+        headers: { content_type: "application/json" }
+      )
+    end
+
+    it "returns the new topics in a category" do
+      topics = subject.category_new_topics_full('category-slug')
+      expect(topics).to be_a Hash
+      expect(topics).to have_key 'topic_list'
+      expect(topics).to have_key 'users'
+    end
+  end
+
   describe '#category_new_category' do
     before do
       stub_post("#{host}/categories")
@@ -85,4 +152,27 @@ describe DiscourseApi::API::Categories do
     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

data/spec/discourse_api/api/groups_spec.rb

@@ -91,6 +91,35 @@ describe DiscourseApi::API::Groups do
       end
     end
 
+    describe "add owners" do
+      let(:url) { "#{host}/admin/groups/123/owners.json" }
+
+      before do
+        stub_put(url)
+      end
+
+      it "makes the member an owner" do
+        subject.group_add_owners(123, usernames: "sam")
+        params = escape_params("group[usernames]" => "sam")
+        expect(a_request(:put, "#{host}/admin/groups/123/owners.json").
+                with(body: params)
+              ).to have_been_made
+      end
+    end
+
+    describe "remove owners" do
+      let(:url) { "#{host}/admin/groups/123/owners.json?group%5Busernames%5D=sam" }
+
+      before do
+        stub_delete(url)
+      end
+
+      it "removes the owner role from the group member" do
+        subject.group_remove_owners(123, usernames: "sam")
+        expect(a_delete(url)).to have_been_made
+      end
+    end
+
     describe "group members" do
       it "list members" do
         stub_get("#{host}/groups/mygroup/members.json?limit=100&offset=0").to_return(body: fixture("members_0.json"), headers: { content_type: "application/json" })

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

@@ -15,18 +15,18 @@ describe DiscourseApi::API::Topics do
     end
   end
 
-  describe "#invite_user_to_topic" do
+  describe "#invite_to_topic" do
     before do
       stub_post("#{host}/t/12/invite").to_return(body: fixture("topic_invite_user.json"), headers: { content_type: "application/json" })
     end
 
     it "requests the correct resource" do
-      subject.invite_user_to_topic(email: "fake_user@example.com", topic_id: 12)
+      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)
+      response = subject.invite_to_topic(12, email: "fake_user@example.com")
       expect(response).to be_a Hash
       expect(response['success']).to be_truthy
     end
@@ -55,6 +55,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 +170,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 +197,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/api/users_spec.rb

@@ -306,6 +306,20 @@ describe DiscourseApi::API::Users do
     end
   end
 
+  describe "#anonymize" do
+    before do
+      url = "#{host}/admin/users/11/anonymize"
+      stub_put(url).to_return(body: '', status: 200)
+    end
+
+    it "makes the correct put request" do
+      result = subject.anonymize(11)
+      url = "#{host}/admin/users/11/anonymize"
+      expect(a_put(url)).to have_been_made
+      expect(result.status).to eq(200)
+    end
+  end
+
   describe "#delete_user" do
     before do
       url = "#{host}/admin/users/11.json?delete_posts=true"

data/spec/discourse_api/client_spec.rb

@@ -28,6 +28,27 @@ 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
+
+    it "raises DiscourseApi::Timeout" do
+      stub_get("#{host}/t/1.json").to_timeout
+
+      expect { subject.topic(1) }.to raise_error(DiscourseApi::Timeout)
+    end
+  end
+
   describe "#api_key" do
     it "is publically accessible" do
       subject.api_key = "test_d7fd0429940"

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