discourse_api 1.1.0 → 2.0.0

data/spec/discourse_api/api/categories_spec.rb

@@ -1,13 +1,17 @@
 # frozen_string_literal: true
-require 'spec_helper'
+require "spec_helper"
 
 describe DiscourseApi::API::Categories do
   subject { DiscourseApi::Client.new("#{host}", "test_d7fd0429940", "test_user") }
 
   describe "#categories" do
     before do
-      stub_get("#{host}/categories.json")
-        .to_return(body: fixture("categories.json"), headers: { content_type: "application/json" })
+      stub_get("#{host}/categories.json").to_return(
+        body: fixture("categories.json"),
+        headers: {
+          content_type: "application/json",
+        },
+      )
     end
 
     it "requests the correct resource" do
@@ -30,8 +34,12 @@ describe DiscourseApi::API::Categories do
 
   describe "#categories_full" do
     before do
-      stub_get("#{host}/categories.json")
-        .to_return(body: fixture("categories.json"), headers: { content_type: "application/json" })
+      stub_get("#{host}/categories.json").to_return(
+        body: fixture("categories.json"),
+        headers: {
+          content_type: "application/json",
+        },
+      )
     end
 
     it "requests the correct resource" do
@@ -42,137 +50,171 @@ describe DiscourseApi::API::Categories do
     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'
+      expect(categories).to have_key "category_list"
+      expect(categories).to have_key "featured_users"
     end
   end
 
-  describe '#category_latest_topics' do
+  describe "#category_latest_topics" 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" })
+      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 latest topics in a category" do
-      latest_topics = subject.category_latest_topics(category_slug: 'category-slug')
+      latest_topics = subject.category_latest_topics(category_slug: "category-slug")
       expect(latest_topics).to be_an Array
     end
   end
 
-  describe '#category_latest_topics_full' do
+  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" })
+      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')
+      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'
+      expect(latest_topics).to have_key "topic_list"
+      expect(latest_topics).to have_key "users"
     end
   end
 
-  describe '#category_top_topics' do
+  describe "#category_top_topics" do
     before do
-      stub_get("#{host}/c/category-slug/l/top.json")
-        .to_return(
+      stub_get("#{host}/c/category-slug/l/top.json").to_return(
         body: fixture("category_topics.json"),
-        headers: { content_type: "application/json" }
+        headers: {
+          content_type: "application/json",
+        },
       )
     end
 
     it "returns the top topics in a category" do
-      topics = subject.category_top_topics('category-slug')
+      topics = subject.category_top_topics("category-slug")
       expect(topics).to be_an Array
     end
   end
 
-  describe '#category_top_topics_full' do
+  describe "#category_top_topics_full" do
     before do
-      stub_get("#{host}/c/category-slug/l/top.json")
-        .to_return(
+      stub_get("#{host}/c/category-slug/l/top.json").to_return(
         body: fixture("category_topics.json"),
-        headers: { content_type: "application/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')
+      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'
+      expect(topics).to have_key "topic_list"
+      expect(topics).to have_key "users"
     end
   end
 
-  describe '#category_new_topics' do
+  describe "#category_new_topics" do
     before do
-      stub_get("#{host}/c/category-slug/l/new.json")
-        .to_return(
+      stub_get("#{host}/c/category-slug/l/new.json").to_return(
         body: fixture("category_topics.json"),
-        headers: { content_type: "application/json" }
+        headers: {
+          content_type: "application/json",
+        },
       )
     end
 
     it "returns the new topics in a category" do
-      topics = subject.category_new_topics('category-slug')
+      topics = subject.category_new_topics("category-slug")
       expect(topics).to be_an Array
     end
   end
 
-  describe '#category_new_topics_full' do
+  describe "#category_new_topics_full" do
     before do
-      stub_get("#{host}/c/category-slug/l/new.json")
-        .to_return(
+      stub_get("#{host}/c/category-slug/l/new.json").to_return(
         body: fixture("category_topics.json"),
-        headers: { content_type: "application/json" }
+        headers: {
+          content_type: "application/json",
+        },
       )
     end
 
     it "returns the new topics in a category" do
-      topics = subject.category_new_topics_full('category-slug')
+      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'
+      expect(topics).to have_key "topic_list"
+      expect(topics).to have_key "users"
     end
   end
 
-  describe '#category_new_category' do
+  describe "#category_new_category" do
     before do
       stub_post("#{host}/categories")
-      subject.create_category(name: "test_category", color: "283890", text_color: "FFFFFF",
-                              description: "This is a description",
-                              permissions: { "group_1" => 1, "admins" => 1 })
+      subject.create_category(
+        name: "test_category",
+        color: "283890",
+        text_color: "FFFFFF",
+        description: "This is a description",
+        permissions: {
+          "group_1" => 1,
+          "admins" => 1,
+        },
+      )
     end
 
     it "makes a create category request" do
-      expect(a_post("#{host}/categories").with(body:
-          "color=283890&description=This+is+a+description&name=test_category&parent_category_id&permissions%5Badmins%5D=1&permissions%5Bgroup_1%5D=1&text_color=FFFFFF")
-        ).to have_been_made
+      expect(
+        a_post("#{host}/categories").with(
+          body:
+            "color=283890&description=This+is+a+description&name=test_category&parent_category_id&permissions%5Badmins%5D=1&permissions%5Bgroup_1%5D=1&text_color=FFFFFF",
+        ),
+      ).to have_been_made
     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" })
+      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')
+      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" })
+      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')
+      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/email_spec.rb

@@ -1,12 +1,17 @@
 # frozen_string_literal: true
-require 'spec_helper'
+require "spec_helper"
 
 describe DiscourseApi::API::Email do
   subject { DiscourseApi::Client.new("#{host}", "test_d7fd0429940", "test_user") }
 
   describe "#email_settings" do
     before do
-      stub_get("#{host}/admin/email.json").to_return(body: fixture("email_settings.json"), headers: { content_type: "application/json" })
+      stub_get("#{host}/admin/email.json").to_return(
+        body: fixture("email_settings.json"),
+        headers: {
+          content_type: "application/json",
+        },
+      )
     end
 
     it "requests the correct resource" do
@@ -17,23 +22,28 @@ describe DiscourseApi::API::Email do
     it "returns the requested settings" do
       settings = subject.email_settings
       expect(settings).to be_a Hash
-      expect(settings).to have_key('delivery_method')
-      expect(settings).to have_key('settings')
+      expect(settings).to have_key("delivery_method")
+      expect(settings).to have_key("settings")
     end
   end
 
   describe "#list_email_all" do
     before do
-      stub_get("#{host}/admin/email/all.json").to_return(body: fixture("email_list_all.json"), headers: { content_type: "application/json" })
+      stub_get("#{host}/admin/email/all.json").to_return(
+        body: fixture("email_list_all.json"),
+        headers: {
+          content_type: "application/json",
+        },
+      )
     end
 
     it "requests the correct resource" do
-      subject.list_email('all')
+      subject.list_email("all")
       expect(a_get("#{host}/admin/email/all.json")).to have_been_made
     end
 
     it "returns all email" do
-      all_email = subject.list_email('all')
+      all_email = subject.list_email("all")
       expect(all_email).to be_an Array
     end
   end

data/spec/discourse_api/api/groups_spec.rb

@@ -1,12 +1,17 @@
 # frozen_string_literal: true
-require 'spec_helper'
+require "spec_helper"
 
 describe DiscourseApi::API::Groups do
   subject { DiscourseApi::Client.new("#{host}", "test_d7fd0429940", "test_user") }
 
   describe "#groups" do
     before do
-      stub_get("#{host}/groups.json").to_return(body: fixture("groups.json"), headers: { content_type: "application/json" })
+      stub_get("#{host}/groups.json").to_return(
+        body: fixture("groups.json"),
+        headers: {
+          content_type: "application/json",
+        },
+      )
     end
 
     it "requests the correct resource" do
@@ -21,69 +26,74 @@ describe DiscourseApi::API::Groups do
     end
 
     it "returns a single group" do
-      stub_get("#{host}/groups/some-group.json").to_return(body: fixture("group.json"), headers: { content_type: "application/json" })
-      group = subject.group('some-group')
-      expect(group['basic_group']).to be_a Hash
+      stub_get("#{host}/groups/some-group.json").to_return(
+        body: fixture("group.json"),
+        headers: {
+          content_type: "application/json",
+        },
+      )
+      group = subject.group("some-group")
+      expect(group["basic_group"]).to be_a Hash
     end
 
     it "create new groups" do
       stub_post("#{host}/admin/groups")
       subject.create_group(name: "test_group")
       params = escape_params("group[name]" => "test_group", "group[visibility_level]" => 0)
-      expect(a_post("#{host}/admin/groups").
-              with(body: params)
-            ).to have_been_made
+      expect(a_post("#{host}/admin/groups").with(body: params)).to have_been_made
     end
 
     it "update an existing group" do
       stub_put("#{host}/groups/42")
       subject.update_group(42, name: "test_group")
       params = escape_params("group[name]" => "test_group", "group[visibility_level]" => 0)
-      expect(a_put("#{host}/groups/42").
-              with(body: params)
-            ).to have_been_made
+      expect(a_put("#{host}/groups/42").with(body: params)).to have_been_made
     end
 
     describe "add members" do
-      before do
-        stub_request(:put, "#{host}/admin/groups/123/members.json")
-      end
+      before { stub_request(:put, "#{host}/admin/groups/123/members.json") }
 
       it "adds a single member by username" do
         subject.group_add(123, username: "sam")
-        expect(a_request(:put, "#{host}/admin/groups/123/members.json").
-                with(body: { usernames: "sam" })
-              ).to have_been_made
+        expect(
+          a_request(:put, "#{host}/admin/groups/123/members.json").with(body: { usernames: "sam" }),
+        ).to have_been_made
       end
 
       it "adds an array of members by username" do
-        subject.group_add(123, usernames: ["sam", "jeff"])
-        expect(a_request(:put, "#{host}/admin/groups/123/members.json").
-                with(body: { usernames: "sam,jeff" })
-              ).to have_been_made
+        subject.group_add(123, usernames: %w[sam jeff])
+        expect(
+          a_request(:put, "#{host}/admin/groups/123/members.json").with(
+            body: {
+              usernames: "sam,jeff",
+            },
+          ),
+        ).to have_been_made
       end
 
       it "adds a single member by user_id" do
         subject.group_add(123, user_id: 456)
-        expect(a_request(:put, "#{host}/admin/groups/123/members.json").
-                with(body: { user_ids: "456" })
-              ).to have_been_made
+        expect(
+          a_request(:put, "#{host}/admin/groups/123/members.json").with(body: { user_ids: "456" }),
+        ).to have_been_made
       end
 
       it "adds an array of members by user_id" do
         subject.group_add(123, user_id: [123, 456])
-        expect(a_request(:put, "#{host}/admin/groups/123/members.json").
-                with(body: { user_ids: "123,456" })
-              ).to have_been_made
+        expect(
+          a_request(:put, "#{host}/admin/groups/123/members.json").with(
+            body: {
+              user_ids: "123,456",
+            },
+          ),
+        ).to have_been_made
       end
     end
 
     describe "remove members" do
       let(:url) { "#{host}/admin/groups/123/members.json?usernames=sam" }
 
-      before do
-        stub_delete(url)
-      end
+      before { stub_delete(url) }
 
       it "removes member" do
         subject.group_remove(123, username: "sam")
@@ -94,25 +104,21 @@ describe DiscourseApi::API::Groups do
     describe "add owners" do
       let(:url) { "#{host}/admin/groups/123/owners.json" }
 
-      before do
-        stub_put(url)
-      end
+      before { stub_put(url) }
 
       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
+        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
+      before { stub_delete(url) }
 
       it "removes the owner role from the group member" do
         subject.group_remove_owners(123, usernames: "sam")
@@ -122,39 +128,52 @@ describe DiscourseApi::API::Groups do
 
     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" })
-        stub_get("#{host}/groups/mygroup/members.json?limit=100&offset=100").to_return(body: fixture("members_1.json"), headers: { content_type: "application/json" })
-        members = subject.group_members('mygroup')
+        stub_get("#{host}/groups/mygroup/members.json?limit=100&offset=0").to_return(
+          body: fixture("members_0.json"),
+          headers: {
+            content_type: "application/json",
+          },
+        )
+        stub_get("#{host}/groups/mygroup/members.json?limit=100&offset=100").to_return(
+          body: fixture("members_1.json"),
+          headers: {
+            content_type: "application/json",
+          },
+        )
+        members = subject.group_members("mygroup")
         expect(a_get("#{host}/groups/mygroup/members.json?limit=100&offset=0")).to have_been_made
         expect(members.length).to eq(100)
-        members = subject.group_members('mygroup', offset: 100)
+        members = subject.group_members("mygroup", offset: 100)
         expect(a_get("#{host}/groups/mygroup/members.json?limit=100&offset=100")).to have_been_made
         expect(members.length).to eq(90)
       end
 
       context "with :all params" do
         it "lists members and owners" do
-          stub_get("#{host}/groups/mygroup/members.json?limit=100&offset=0").to_return(body: fixture("members_2.json"), headers: { content_type: "application/json" })
-          member_data = subject.group_members('mygroup', all: true)
+          stub_get("#{host}/groups/mygroup/members.json?limit=100&offset=0").to_return(
+            body: fixture("members_2.json"),
+            headers: {
+              content_type: "application/json",
+            },
+          )
+          member_data = subject.group_members("mygroup", all: true)
           expect(a_get("#{host}/groups/mygroup/members.json?limit=100&offset=0")).to have_been_made
           expect(member_data["members"].length).to eq(100)
           expect(member_data["owners"].length).to eq(7)
-          expect(member_data.keys.sort).to eq(["members", "meta", "owners"])
+          expect(member_data.keys.sort).to eq(%w[members meta owners])
         end
       end
     end
 
     describe "group user notification level" do
-      before do
-        stub_post("#{host}/groups/mygroup/notifications?user_id=77&notification_level=3")
-      end
+      before { stub_post("#{host}/groups/mygroup/notifications?user_id=77&notification_level=3") }
 
       it "updates user's notification level for group" do
         subject.group_set_user_notification_level("mygroup", 77, 3)
-        expect(a_post("#{host}/groups/mygroup/notifications?user_id=77&notification_level=3"))
-          .to have_been_made
+        expect(
+          a_post("#{host}/groups/mygroup/notifications?user_id=77&notification_level=3"),
+        ).to have_been_made
       end
     end
-
   end
 end

data/spec/discourse_api/api/invite_spec.rb

@@ -1,12 +1,17 @@
 # frozen_string_literal: true
-require 'spec_helper'
+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" })
+      stub_post("#{host}/invites").to_return(
+        body: fixture("topic_invite_user.json"),
+        headers: {
+          content_type: "application/json",
+        },
+      )
     end
 
     it "requests the correct resource" do
@@ -17,13 +22,18 @@ describe DiscourseApi::API::Invite do
     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
+      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" })
+      stub_put("#{host}/invites/27").to_return(
+        body: fixture("topic_invite_user.json"),
+        headers: {
+          content_type: "application/json",
+        },
+      )
     end
 
     it "updates invite" do
@@ -34,7 +44,12 @@ describe DiscourseApi::API::Invite do
 
   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" })
+      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
@@ -58,11 +73,12 @@ describe DiscourseApi::API::Invite do
     let(:url) { "#{host}/invites/destroy-all-expired" }
 
     before do
-      stub_post(url)
-        .to_return(
-          body: '{"success": "OK"}',
-          headers: { content_type: "application/json" }
-        )
+      stub_post(url).to_return(
+        body: '{"success": "OK"}',
+        headers: {
+          content_type: "application/json",
+        },
+      )
     end
 
     it "destroys all expired invites" do
@@ -75,11 +91,12 @@ describe DiscourseApi::API::Invite do
     let(:url) { "#{host}/invites/reinvite-all" }
 
     before do
-      stub_post(url)
-        .to_return(
-          body: '{"success": "OK"}',
-          headers: { content_type: "application/json" }
-        )
+      stub_post(url).to_return(
+        body: '{"success": "OK"}',
+        headers: {
+          content_type: "application/json",
+        },
+      )
     end
 
     it "resends all invites" do
@@ -92,11 +109,12 @@ describe DiscourseApi::API::Invite do
     let(:url) { "#{host}/invites/reinvite" }
 
     before do
-      stub_post(url)
-        .to_return(
-          body: '{"success": "OK"}',
-          headers: { content_type: "application/json" }
-        )
+      stub_post(url).to_return(
+        body: '{"success": "OK"}',
+        headers: {
+          content_type: "application/json",
+        },
+      )
     end
 
     it "resends invite" do
@@ -111,7 +129,9 @@ describe DiscourseApi::API::Invite do
     before do
       stub_delete(url).to_return(
         body: '{"success": "OK"}',
-        headers: { content_type: "application/json" }
+        headers: {
+          content_type: "application/json",
+        },
       )
     end