discourse_api 1.1.0 → 2.0.0

data/spec/discourse_api/api/users_spec.rb

@@ -1,12 +1,17 @@
 # frozen_string_literal: true
-require 'spec_helper'
+require "spec_helper"
 
 describe DiscourseApi::API::Users do
   subject { DiscourseApi::Client.new("#{host}", "test_d7fd0429940", "test_user") }
 
   describe "#user" do
     before do
-      stub_get("#{host}/users/test.json").to_return(body: fixture("user.json"), headers: { content_type: "application/json" })
+      stub_get("#{host}/users/test.json").to_return(
+        body: fixture("user.json"),
+        headers: {
+          content_type: "application/json",
+        },
+      )
     end
 
     it "requests the correct resource" do
@@ -27,7 +32,12 @@ describe DiscourseApi::API::Users do
 
   describe "#user_sso" do
     before do
-      stub_get("#{host}/admin/users/15.json").to_return(body: fixture("admin_user.json"), headers: { content_type: "application/json" })
+      stub_get("#{host}/admin/users/15.json").to_return(
+        body: fixture("admin_user.json"),
+        headers: {
+          content_type: "application/json",
+        },
+      )
     end
 
     it "requests the correct resource" do
@@ -44,21 +54,37 @@ describe DiscourseApi::API::Users do
 
   describe "#update_avatar" do
     before do
-      stub_post("#{host}/uploads").to_return(body: fixture("upload_avatar.json"), headers: { content_type: "application/json" })
-      stub_put("#{host}/u/test_user/preferences/avatar/pick").to_return(body: fixture("user_update_avatar_success.json"), headers: { content_type: "application/json" })
+      stub_post("#{host}/uploads").to_return(
+        body: fixture("upload_avatar.json"),
+        headers: {
+          content_type: "application/json",
+        },
+      )
+      stub_put("#{host}/u/test_user/preferences/avatar/pick").to_return(
+        body: fixture("user_update_avatar_success.json"),
+        headers: {
+          content_type: "application/json",
+        },
+      )
     end
 
     it "uploads an image" do
-      sam = "https://meta-discourse.global.ssl.fastly.net/user_avatar/meta.discourse.org/sam/120/5243.png"
+      sam =
+        "https://meta-discourse.global.ssl.fastly.net/user_avatar/meta.discourse.org/sam/120/5243.png"
       args = { url: sam }
-      response = subject.update_avatar('test_user', args)
-      expect(response[:body]['success']).to eq('OK')
+      response = subject.update_avatar("test_user", args)
+      expect(response[:body]["success"]).to eq("OK")
     end
   end
 
   describe "#update_email" do
     before do
-      stub_put("#{host}/u/fake_user/preferences/email").to_return(body: fixture("user_update_user.json"), headers: { content_type: "application/json" })
+      stub_put("#{host}/u/fake_user/preferences/email").to_return(
+        body: fixture("user_update_user.json"),
+        headers: {
+          content_type: "application/json",
+        },
+      )
     end
 
     it "makes the put request" do
@@ -68,33 +94,43 @@ describe DiscourseApi::API::Users do
 
     it "returns success" do
       response = subject.update_email("fake_user", "fake_user_2@example.com")
-      expect(response[:body]['success']).to be_truthy
+      expect(response[:body]["success"]).to be_truthy
     end
   end
 
   describe "#update_user" do
     before do
-      stub_put("#{host}/u/fake_user").to_return(body: fixture("user_update_user.json"), headers: { content_type: "application/json" })
+      stub_put("#{host}/u/fake_user").to_return(
+        body: fixture("user_update_user.json"),
+        headers: {
+          content_type: "application/json",
+        },
+      )
     end
 
     it "makes the put request" do
-      subject.api_key = 'test_d7fd0429940'
-      subject.api_username = 'test_user'
+      subject.api_key = "test_d7fd0429940"
+      subject.api_username = "test_user"
       subject.update_user("fake_user", name: "Fake User 2")
       expect(a_put("#{host}/u/fake_user")).to have_been_made
     end
 
     it "returns success" do
-      subject.api_key = 'test_d7fd0429940'
-      subject.api_username = 'test_user'
+      subject.api_key = "test_d7fd0429940"
+      subject.api_username = "test_user"
       response = subject.update_user("fake_user", name: "Fake User 2")
-      expect(response[:body]['success']).to be_truthy
+      expect(response[:body]["success"]).to be_truthy
     end
   end
 
   describe "#update_username" do
     before do
-      stub_put("#{host}/u/fake_user/preferences/username").to_return(body: fixture("user_update_username.json"), headers: { content_type: "application/json" })
+      stub_put("#{host}/u/fake_user/preferences/username").to_return(
+        body: fixture("user_update_username.json"),
+        headers: {
+          content_type: "application/json",
+        },
+      )
     end
 
     it "makes the put request" do
@@ -104,30 +140,47 @@ describe DiscourseApi::API::Users do
 
     it "returns the updated username" do
       response = subject.update_username("fake_user", "fake_user_2")
-      expect(response[:body]['username']).to eq('fake_user_2')
+      expect(response[:body]["username"]).to eq("fake_user_2")
     end
   end
 
   describe "#create_user" do
     before do
-      stub_post("#{host}/users").to_return(body: fixture("user_create_success.json"), headers: { content_type: "application/json" })
+      stub_post("#{host}/users").to_return(
+        body: fixture("user_create_success.json"),
+        headers: {
+          content_type: "application/json",
+        },
+      )
     end
 
     it "makes the post request" do
-      subject.create_user name: "Test User", email: "test2@example.com", password: "P@ssword", username: "test2"
+      subject.create_user name: "Test User",
+                          email: "test2@example.com",
+                          password: "P@ssword",
+                          username: "test2"
       expect(a_post("#{host}/users")).to have_been_made
     end
 
     it "returns success" do
-      response = subject.create_user name: "Test User", email: "test2@example.com", password: "P@ssword", username: "test2"
+      response =
+        subject.create_user name: "Test User",
+                            email: "test2@example.com",
+                            password: "P@ssword",
+                            username: "test2"
       expect(response).to be_a Hash
-      expect(response['success']).to be_truthy
+      expect(response["success"]).to be_truthy
     end
   end
 
   describe "#activate_user" do
     before do
-      stub_put("#{host}/admin/users/15/activate").to_return(body: fixture("user_activate_success.json"), headers: { content_type: "application/json" })
+      stub_put("#{host}/admin/users/15/activate").to_return(
+        body: fixture("user_activate_success.json"),
+        headers: {
+          content_type: "application/json",
+        },
+      )
     end
 
     it "makes the put request" do
@@ -137,13 +190,18 @@ describe DiscourseApi::API::Users do
 
     it "returns success" do
       response = subject.activate(15)
-      expect(response[:body]['success']).to eq('OK')
+      expect(response[:body]["success"]).to eq("OK")
     end
   end
 
   describe "#log_out_success" do
     before do
-      stub_post("#{host}/admin/users/4/log_out").to_return(body: fixture("user_log_out_success.json"), headers: { content_type: "application/json" })
+      stub_post("#{host}/admin/users/4/log_out").to_return(
+        body: fixture("user_log_out_success.json"),
+        headers: {
+          content_type: "application/json",
+        },
+      )
     end
 
     it "makes a post request" do
@@ -154,13 +212,18 @@ describe DiscourseApi::API::Users do
     it "returns success" do
       response = subject.log_out(4)
       expect(response).to be_a Hash
-      expect(response['success']).to eq('OK')
+      expect(response["success"]).to eq("OK")
     end
   end
 
   describe "#log_out_unsuccessful" do
     before do
-      stub_post("#{host}/admin/users/90/log_out").to_return(status: 404, headers: { content_type: "application/json" })
+      stub_post("#{host}/admin/users/90/log_out").to_return(
+        status: 404,
+        headers: {
+          content_type: "application/json",
+        },
+      )
     end
 
     it "Raises API Error" do
@@ -170,16 +233,21 @@ describe DiscourseApi::API::Users do
 
   describe "#list_users" do
     before do
-      stub_get("#{host}/admin/users/list/active.json").to_return(body: fixture("user_list.json"), headers: { content_type: "application/json" })
+      stub_get("#{host}/admin/users/list/active.json").to_return(
+        body: fixture("user_list.json"),
+        headers: {
+          content_type: "application/json",
+        },
+      )
     end
 
     it "requests the correct resource" do
-      subject.list_users('active')
+      subject.list_users("active")
       expect(a_get("#{host}/admin/users/list/active.json")).to have_been_made
     end
 
     it "returns the requested users" do
-      users = subject.list_users('active')
+      users = subject.list_users("active")
       expect(users).to be_an Array
       expect(users.first).to be_a Hash
     end
@@ -188,8 +256,12 @@ describe DiscourseApi::API::Users do
   describe "#update_trust_level" do
     before do
       url = "#{host}/admin/users/2/trust_level"
-      stub_put(url).to_return(body: fixture("update_trust_level.json"),
-                              headers: { content_type: "application/json" })
+      stub_put(url).to_return(
+        body: fixture("update_trust_level.json"),
+        headers: {
+          content_type: "application/json",
+        },
+      )
     end
 
     it "makes the correct put request" do
@@ -203,15 +275,19 @@ describe DiscourseApi::API::Users do
       params = { level: 2 }
       admin_user = subject.update_trust_level(2, params)
       expect(admin_user).to be_a Hash
-      expect(admin_user['admin_user']).to have_key('trust_level')
+      expect(admin_user["admin_user"]).to have_key("trust_level")
     end
   end
 
   describe "#grant admin" do
     before do
       url = "#{host}/admin/users/11/grant_admin"
-      stub_put(url).to_return(body: fixture("user_grant_admin.json"),
-                              headers: { content_type: "application/json" })
+      stub_put(url).to_return(
+        body: fixture("user_grant_admin.json"),
+        headers: {
+          content_type: "application/json",
+        },
+      )
     end
 
     it "makes the correct put request" do
@@ -223,15 +299,19 @@ describe DiscourseApi::API::Users do
     it "makes the user an admin" do
       result = subject.grant_admin(11)
       expect(result).to be_a Hash
-      expect(result['admin_user']['admin']).to eq(true)
+      expect(result["admin_user"]["admin"]).to eq(true)
     end
   end
 
   describe "#grant moderation" do
     before do
       url = "#{host}/admin/users/11/grant_moderation"
-      stub_put(url).to_return(body: fixture("user_grant_moderator.json"),
-                              headers: { content_type: "application/json" })
+      stub_put(url).to_return(
+        body: fixture("user_grant_moderator.json"),
+        headers: {
+          content_type: "application/json",
+        },
+      )
     end
 
     it "makes the correct put request" do
@@ -243,14 +323,14 @@ describe DiscourseApi::API::Users do
     it "makes the user a moderator" do
       result = subject.grant_moderation(11)
       expect(result).to be_a Hash
-      expect(result['admin_user']['moderator']).to eq(true)
+      expect(result["admin_user"]["moderator"]).to eq(true)
     end
   end
 
   describe "#revoke moderation" do
     before do
       url = "#{host}/admin/users/11/revoke_moderation"
-      stub_put(url).to_return(body: '', status: 200)
+      stub_put(url).to_return(body: "", status: 200)
     end
 
     it "makes the correct put request" do
@@ -259,12 +339,16 @@ describe DiscourseApi::API::Users do
       expect(a_put(url)).to have_been_made
       expect(result.status).to eq(200)
     end
-
   end
 
   describe "#by_external_id" do
     before do
-      stub_get("#{host}/users/by-external/1").to_return(body: fixture("user.json"), headers: { content_type: "application/json" })
+      stub_get("#{host}/users/by-external/1").to_return(
+        body: fixture("user.json"),
+        headers: {
+          content_type: "application/json",
+        },
+      )
     end
 
     it "requests the correct resource" do
@@ -274,18 +358,18 @@ describe DiscourseApi::API::Users do
 
     it "returns the requested user" do
       user = subject.by_external_id(1)
-      expect(user['id']).to eq 1
+      expect(user["id"]).to eq 1
     end
   end
 
   describe "#suspend" do
     before do
       url = "#{host}/admin/users/11/suspend"
-      stub_put(url).to_return(body: '', status: 200)
+      stub_put(url).to_return(body: "", status: 200)
     end
 
     it "makes the correct put request" do
-      result = subject.suspend(11, '2030-01-01', "no reason")
+      result = subject.suspend(11, "2030-01-01", "no reason")
       url = "#{host}/admin/users/11/suspend"
       expect(a_put(url)).to have_been_made
       expect(result.status).to eq(200)
@@ -295,7 +379,7 @@ describe DiscourseApi::API::Users do
   describe "#unsuspend" do
     before do
       url = "#{host}/admin/users/11/unsuspend"
-      stub_put(url).to_return(body: '', status: 200)
+      stub_put(url).to_return(body: "", status: 200)
     end
 
     it "makes the correct put request" do
@@ -309,7 +393,7 @@ describe DiscourseApi::API::Users do
   describe "#anonymize" do
     before do
       url = "#{host}/admin/users/11/anonymize"
-      stub_put(url).to_return(body: '', status: 200)
+      stub_put(url).to_return(body: "", status: 200)
     end
 
     it "makes the correct put request" do
@@ -339,9 +423,7 @@ describe DiscourseApi::API::Users do
     let(:url) { "#{host}/users/check_username.json?username=sparrow" }
     let(:body) { '{"available":false,"suggestion":"sparrow1"}' }
 
-    before do
-      stub_get(url).to_return(body: body, headers: { content_type: "application/json" })
-    end
+    before { stub_get(url).to_return(body: body, headers: { content_type: "application/json" }) }
 
     it "requests the correct resource" do
       subject.check_username("sparrow")
@@ -350,7 +432,7 @@ describe DiscourseApi::API::Users do
 
     it "returns the result" do
       result = subject.check_username("sparrow")
-      expect(result['available']).to eq false
+      expect(result["available"]).to eq false
     end
 
     context "when non-URI characters are used" do
@@ -364,15 +446,15 @@ describe DiscourseApi::API::Users do
 
       it "returns the result" do
         result = subject.check_username("1_[4]! @the$#?")
-        expect(result['errors'].first).to eq "must only include numbers, letters, dashes, and underscores"
+        expect(
+          result["errors"].first,
+        ).to eq "must only include numbers, letters, dashes, and underscores"
       end
     end
   end
 
   describe "#deactivate" do
-    before do
-      stub_put("#{host}/admin/users/15/deactivate").to_return(body: nil)
-    end
+    before { stub_put("#{host}/admin/users/15/deactivate").to_return(body: nil) }
 
     it "makes the put request" do
       subject.deactivate(15)

data/spec/discourse_api/client_spec.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-require 'spec_helper'
+require "spec_helper"
 
 describe DiscourseApi::Client do
   subject { DiscourseApi::Client.new(host) }
@@ -18,24 +18,24 @@ describe DiscourseApi::Client do
     end
 
     it "accepts an api key argument" do
-      client = DiscourseApi::Client.new(host, 'test')
-      expect(client.api_key).to eq('test')
+      client = DiscourseApi::Client.new(host, "test")
+      expect(client.api_key).to eq("test")
     end
 
     it "accepts an api username argument" do
-      client = DiscourseApi::Client.new(host, 'test', 'test_user')
-      expect(client.api_username).to eq('test_user')
+      client = DiscourseApi::Client.new(host, "test", "test_user")
+      expect(client.api_username).to eq("test_user")
     end
   end
 
   describe "#timeout" do
-    context 'custom timeout' do
+    context "with a 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
+    context "with the default timeout" do
       it "is set to Faraday connection" do
         subject.timeout = 25
         expect(subject.send(:connection).options.timeout).to eq(25)
@@ -50,25 +50,25 @@ describe DiscourseApi::Client do
   end
 
   describe "#api_key" do
-    it "is publically accessible" do
+    it "is publicly accessible" do
       subject.api_key = "test_d7fd0429940"
       expect(subject.api_key).to eq("test_d7fd0429940")
     end
   end
 
   describe "#api_username" do
-    it "is publically accessible" do
+    it "is publicly accessible" do
       subject.api_username = "test_user"
       expect(subject.api_username).to eq("test_user")
     end
   end
 
   describe "#host" do
-    it "is publically readable" do
+    it "is publicly readable" do
       expect(subject.host).to eq("#{host}")
     end
 
-    it "is not publically writeable" do
+    it "is not publicly writeable" do
       expect(subject).not_to respond_to(:host=)
     end
   end
@@ -87,8 +87,8 @@ describe DiscourseApi::Client do
   describe "#delete" do
     before do
       stub_delete("#{host}/test/delete").with(query: { deleted: "object" })
-      subject.api_key = 'test_d7fd0429940'
-      subject.api_username = 'test_user'
+      subject.api_key = "test_d7fd0429940"
+      subject.api_username = "test_user"
     end
 
     it "allows custom delete requests" do
@@ -96,16 +96,16 @@ describe DiscourseApi::Client do
       expect(a_delete("#{host}/test/delete").with(query: { deleted: "object" })).to have_been_made
     end
 
-    context 'when using a host with a subdirectory' do
+    context "when using a host with a subdirectory" do
       subject { DiscourseApi::Client.new("#{host}/forum") }
 
-      before do
-        stub_delete("#{host}/forum/test/delete").with(query: { deleted: "object" })
-      end
+      before { stub_delete("#{host}/forum/test/delete").with(query: { deleted: "object" }) }
 
       it "allows custom delete requests" do
         subject.delete("/test/delete", { deleted: "object" })
-        expect(a_delete("#{host}/forum/test/delete").with(query: { deleted: "object" })).to have_been_made
+        expect(
+          a_delete("#{host}/forum/test/delete").with(query: { deleted: "object" }),
+        ).to have_been_made
       end
     end
   end
@@ -113,8 +113,8 @@ describe DiscourseApi::Client do
   describe "#post" do
     before do
       stub_post("#{host}/test/post").with(body: { created: "object" })
-      subject.api_key = 'test_d7fd0429940'
-      subject.api_username = 'test_user'
+      subject.api_key = "test_d7fd0429940"
+      subject.api_username = "test_user"
     end
 
     it "allows custom post requests" do
@@ -122,16 +122,16 @@ describe DiscourseApi::Client do
       expect(a_post("#{host}/test/post").with(body: { created: "object" })).to have_been_made
     end
 
-    context 'when using a host with a subdirectory' do
+    context "when using a host with a subdirectory" do
       subject { DiscourseApi::Client.new("#{host}/forum") }
 
-      before do
-        stub_post("#{host}/forum/test/post").with(body: { created: "object" })
-      end
+      before { stub_post("#{host}/forum/test/post").with(body: { created: "object" }) }
 
       it "allows custom post requests" do
         subject.post("/test/post", { created: "object" })
-        expect(a_post("#{host}/forum/test/post").with(body: { created: "object" })).to have_been_made
+        expect(
+          a_post("#{host}/forum/test/post").with(body: { created: "object" }),
+        ).to have_been_made
       end
     end
   end
@@ -139,8 +139,8 @@ describe DiscourseApi::Client do
   describe "#put" do
     before do
       stub_put("#{host}/test/put").with(body: { updated: "object" })
-      subject.api_key = 'test_d7fd0429940'
-      subject.api_username = 'test_user'
+      subject.api_key = "test_d7fd0429940"
+      subject.api_username = "test_user"
     end
 
     it "allows custom put requests" do
@@ -148,12 +148,10 @@ describe DiscourseApi::Client do
       expect(a_put("#{host}/test/put").with(body: { updated: "object" })).to have_been_made
     end
 
-    context 'when using a host with a subdirectory' do
+    context "when using a host with a subdirectory" do
       subject { DiscourseApi::Client.new("#{host}/forum") }
 
-      before do
-        stub_put("#{host}/forum/test/put").with(body: { updated: "object" })
-      end
+      before { stub_put("#{host}/forum/test/put").with(body: { updated: "object" }) }
 
       it "allows custom post requests" do
         subject.put("/test/put", { updated: "object" })
@@ -165,7 +163,9 @@ describe DiscourseApi::Client do
   describe "#request" do
     it "catches 500 errors" do
       connection = instance_double(Faraday::Connection)
-      allow(connection).to receive(:get).and_return(OpenStruct.new(env: { body: 'error page html' }, status: 500))
+      allow(connection).to receive(:get).and_return(
+        OpenStruct.new(env: { body: "error page html" }, status: 500),
+      )
       allow(Faraday).to receive(:new).and_return(connection)
       expect { subject.send(:request, :get, "/test") }.to raise_error DiscourseApi::Error
     end

data/spec/discourse_api/single_sign_on_spec.rb

@@ -1,43 +1,43 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
+require "spec_helper"
 
 describe DiscourseApi::SingleSignOn do
-  context "::MissingConfigError" do
+  describe DiscourseApi::SingleSignOn::MissingConfigError do
     it "inherits from RuntimeError for backward compatibility" do
       expect(DiscourseApi::SingleSignOn::MissingConfigError).to be < RuntimeError
     end
   end
 
-  context "::ParseError" do
+  describe DiscourseApi::SingleSignOn::ParseError do
     it "inherits from RuntimeError for backward compatibility" do
       expect(DiscourseApi::SingleSignOn::ParseError).to be < RuntimeError
     end
   end
 
-  context ".sso_secret" do
+  describe ".sso_secret" do
     it "raises MissingConfigError when sso_secret is not present" do
-      expect {
-        described_class.sso_secret
-      }.to raise_error(DiscourseApi::SingleSignOn::MissingConfigError)
+      expect { described_class.sso_secret }.to raise_error(
+        DiscourseApi::SingleSignOn::MissingConfigError,
+      )
     end
   end
 
-  context ".sso_url" do
+  describe ".sso_url" do
     it "raises MissingConfigError when sso_url is not present" do
-      expect {
-        described_class.sso_url
-      }.to raise_error(DiscourseApi::SingleSignOn::MissingConfigError)
+      expect { described_class.sso_url }.to raise_error(
+        DiscourseApi::SingleSignOn::MissingConfigError,
+      )
     end
   end
 
-  context ".parse" do
+  describe ".parse" do
     it "raises ParseError when there's a signature mismatch" do
       sso = described_class.new
       sso.sso_secret = "abcd"
-      expect {
-        described_class.parse(sso.payload, "dcba")
-      }.to raise_error(DiscourseApi::SingleSignOn::ParseError)
+      expect { described_class.parse(sso.payload, "dcba") }.to raise_error(
+        DiscourseApi::SingleSignOn::ParseError,
+      )
     end
   end
 end

data/spec/fixtures/categories.json

@@ -9,7 +9,7 @@
     "categories": [
       {
         "id": 1,
-        "n    ame": "test1",
+        "name": "test1",
         "color": "0000FF",
         "text_color": "FFFFFF",
         "slug": "test1",