discourse_api 2.0.0 → 2.1.0

data/spec/discourse_api/api/topics_spec.rb

@@ -2,7 +2,7 @@
 require "spec_helper"
 
 describe DiscourseApi::API::Topics do
-  subject { DiscourseApi::Client.new("#{host}", "test_d7fd0429940", "test_user") }
+  subject(:client) { DiscourseApi::Client.new("#{host}", "test_d7fd0429940", "test_user") }
 
   describe "#change_topic_status" do
     before do
@@ -15,7 +15,7 @@ describe DiscourseApi::API::Topics do
     end
 
     it "changes the topic status" do
-      subject.update_topic_status(57, { status: "visible", enabled: false })
+      client.update_topic_status(57, { status: "visible", enabled: false })
       expect(a_put("#{host}/t/57/status")).to have_been_made
     end
   end
@@ -31,12 +31,12 @@ describe DiscourseApi::API::Topics do
     end
 
     it "requests the correct resource" do
-      subject.invite_to_topic(12, email: "fake_user@example.com")
+      client.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_to_topic(12, email: "fake_user@example.com")
+      response = client.invite_to_topic(12, email: "fake_user@example.com")
       expect(response).to be_a Hash
       expect(response["success"]).to be_truthy
     end
@@ -53,18 +53,18 @@ describe DiscourseApi::API::Topics do
     end
 
     it "requests the correct resource" do
-      subject.latest_topics
+      client.latest_topics
       expect(a_get("#{host}/latest.json")).to have_been_made
     end
 
     it "returns the requested topics" do
-      topics = subject.latest_topics
+      topics = client.latest_topics
       expect(topics).to be_an Array
       expect(topics.first).to be_a Hash
     end
 
     it "can take a hash param" do
-      topics = subject.latest_topics({})
+      topics = client.latest_topics({})
       expect(topics).to be_an Array
       expect(topics.first).to be_a Hash
     end
@@ -81,18 +81,18 @@ describe DiscourseApi::API::Topics do
     end
 
     it "requests the correct resource" do
-      subject.top_topics
+      client.top_topics
       expect(a_get("#{host}/top.json")).to have_been_made
     end
 
     it "returns the requested topics" do
-      topics = subject.top_topics
+      topics = client.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({})
+      topics = client.top_topics({})
       expect(topics).to be_an Array
       expect(topics.first).to be_a Hash
     end
@@ -109,13 +109,13 @@ describe DiscourseApi::API::Topics do
     end
 
     it "requests the correct resource" do
-      subject.new_topics
+      client.new_topics
       expect(a_get("#{host}/new.json")).to have_been_made
     end
 
     it "returns the requested topics" do
-      subject.api_username = "test_user"
-      topics = subject.new_topics
+      client.api_username = "test_user"
+      topics = client.new_topics
       expect(topics).to be_an Array
       expect(topics.first).to be_a Hash
     end
@@ -132,12 +132,12 @@ describe DiscourseApi::API::Topics do
     end
 
     it "requests the correct resource" do
-      subject.topic(57)
+      client.topic(57)
       expect(a_get("#{host}/t/57.json")).to have_been_made
     end
 
     it "returns the requested topic" do
-      topic = subject.topic(57)
+      topic = client.topic(57)
       expect(topic).to be_a Hash
       expect(topic["id"]).to eq(57)
     end
@@ -154,12 +154,12 @@ describe DiscourseApi::API::Topics do
     end
 
     it "renames the topic" do
-      subject.rename_topic(57, "A new title!")
+      client.rename_topic(57, "A new title!")
       expect(a_put("#{host}/t/57.json")).to have_been_made
     end
 
     it "assigns the topic a new category" do
-      subject.recategorize_topic(57, 3)
+      client.recategorize_topic(57, 3)
       expect(a_put("#{host}/t/57.json")).to have_been_made
     end
   end
@@ -175,12 +175,12 @@ describe DiscourseApi::API::Topics do
     end
 
     it "requests the correct resource" do
-      subject.topics_by("test")
+      client.topics_by("test")
       expect(a_get("#{host}/topics/created-by/test.json")).to have_been_made
     end
 
     it "returns the requested topics" do
-      topics = subject.topics_by("test")
+      topics = client.topics_by("test")
       expect(topics).to be_an Array
       expect(topics.first).to be_a Hash
     end
@@ -197,24 +197,24 @@ describe DiscourseApi::API::Topics do
     end
 
     it "requests the correct resource" do
-      subject.topic_posts(57)
+      client.topic_posts(57)
       expect(a_get("#{host}/t/57/posts.json")).to have_been_made
     end
 
     it "allows scoping to specific post ids" do
-      subject.topic_posts(57, [123, 456])
+      client.topic_posts(57, [123, 456])
       expect(a_get("#{host}/t/57/posts.json?post_ids[]=123&post_ids[]=456")).to have_been_made
     end
 
     it "returns the requested topic posts" do
-      body = subject.topic_posts(57, [123])
+      body = client.topic_posts(57, [123])
       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
     end
 
     it "can retrieve a topic posts' raw attribute" do
-      body = subject.topic_posts(57, [123], { include_raw: true })
+      body = client.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
@@ -233,17 +233,17 @@ describe DiscourseApi::API::Topics do
     end
 
     it "makes the post request" do
-      subject.create_topic title: "Sample Topic Title",
-                           raw: "Sample topic content body",
-                           tags: %w[asdf fdsa]
+      client.create_topic title: "Sample Topic Title",
+                          raw: "Sample topic content body",
+                          tags: %w[asdf fdsa]
       expect(a_post("#{host}/posts")).to have_been_made
     end
 
     it "returns success" do
       response =
-        subject.create_topic title: "Sample Topic Title",
-                             raw: "Sample topic content body",
-                             tags: %w[asdf fdsa]
+        client.create_topic title: "Sample Topic Title",
+                            raw: "Sample topic content body",
+                            tags: %w[asdf fdsa]
       expect(response).to be_a Hash
       expect(response["topic_id"]).to eq 21
     end
@@ -260,7 +260,7 @@ describe DiscourseApi::API::Topics do
     end
 
     it "makes the post request" do
-      response = subject.topic_set_user_notification_level(1, notification_level: 3)
+      response = client.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
@@ -279,7 +279,7 @@ describe DiscourseApi::API::Topics do
     end
 
     it "makes the put request" do
-      response = subject.bookmark_topic(1)
+      response = client.bookmark_topic(1)
       expect(a_put("#{host}/t/1/bookmark.json")).to have_been_made
       expect(response.body).to eq(nil)
     end
@@ -296,7 +296,7 @@ describe DiscourseApi::API::Topics do
     end
 
     it "makes the put request" do
-      response = subject.remove_topic_bookmark(1)
+      response = client.remove_topic_bookmark(1)
       expect(a_put("#{host}/t/1/remove_bookmarks.json")).to have_been_made
       expect(response.body).to eq(nil)
     end

data/spec/discourse_api/api/uploads_spec.rb

@@ -2,7 +2,7 @@
 require "spec_helper"
 
 describe DiscourseApi::API::Uploads do
-  subject { DiscourseApi::Client.new("#{host}", "test_d7fd0429940", "test_user") }
+  subject(:client) { DiscourseApi::Client.new("#{host}", "test_d7fd0429940", "test_user") }
 
   describe "#upload_file" do
     before do
@@ -18,7 +18,7 @@ describe DiscourseApi::API::Uploads do
       image =
         "https://meta-discourse.global.ssl.fastly.net/user_avatar/meta.discourse.org/sam/120/5243.png"
       args = { url: image }
-      response = subject.upload_file(args)
+      response = client.upload_file(args)
       expect(response["url"]).to eq(
         "/uploads/default/original/1X/417e624d2453925e6c68748b9aa67637c284b5aa.jpg",
       )
@@ -27,7 +27,7 @@ describe DiscourseApi::API::Uploads do
     it "uploads a file" do
       file = Faraday::UploadIO.new("spec/fixtures/upload_file.json", "application/json")
       args = { file: file }
-      response = subject.upload_file(args)
+      response = client.upload_file(args)
       expect(response["url"]).to eq(
         "/uploads/default/original/1X/417e624d2453925e6c68748b9aa67637c284b5aa.jpg",
       )

data/spec/discourse_api/api/user_actions_spec.rb

@@ -2,7 +2,7 @@
 require "spec_helper"
 
 describe DiscourseApi::API::UserActions do
-  subject { DiscourseApi::Client.new("#{host}", "test_d7fd0429940", "test_user") }
+  subject(:client) { DiscourseApi::Client.new("#{host}", "test_d7fd0429940", "test_user") }
 
   describe "#user_replies" do
     before do
@@ -15,12 +15,12 @@ describe DiscourseApi::API::UserActions do
     end
 
     it "requests the correct resource" do
-      subject.user_replies("testuser")
+      client.user_replies("testuser")
       expect(a_get("#{host}/user_actions.json?username=testuser&filter=5")).to have_been_made
     end
 
     it "returns the requested user" do
-      replies = subject.user_replies("testuser")
+      replies = client.user_replies("testuser")
       expect(replies).to be_an Array
     end
   end
@@ -36,12 +36,12 @@ describe DiscourseApi::API::UserActions do
     end
 
     it "requests the correct resource" do
-      subject.user_topics_and_replies("testuser")
+      client.user_topics_and_replies("testuser")
       expect(a_get("#{host}/user_actions.json?username=testuser&filter=4,5")).to have_been_made
     end
 
     it "returns the requested user" do
-      replies = subject.user_topics_and_replies("testuser")
+      replies = client.user_topics_and_replies("testuser")
       expect(replies).to be_an Array
     end
   end

data/spec/discourse_api/api/users_spec.rb

@@ -2,7 +2,7 @@
 require "spec_helper"
 
 describe DiscourseApi::API::Users do
-  subject { DiscourseApi::Client.new("#{host}", "test_d7fd0429940", "test_user") }
+  subject(:client) { DiscourseApi::Client.new("#{host}", "test_d7fd0429940", "test_user") }
 
   describe "#user" do
     before do
@@ -15,17 +15,17 @@ describe DiscourseApi::API::Users do
     end
 
     it "requests the correct resource" do
-      subject.user("test")
+      client.user("test")
       expect(a_get("#{host}/users/test.json")).to have_been_made
     end
 
     it "returns the requested user" do
-      user = subject.user("test")
+      user = client.user("test")
       expect(user).to be_a Hash
     end
 
     it "works with optional params" do
-      user = subject.user("test", {})
+      user = client.user("test", {})
       expect(user).to be_a Hash
     end
   end
@@ -41,12 +41,12 @@ describe DiscourseApi::API::Users do
     end
 
     it "requests the correct resource" do
-      subject.user_sso(15)
+      client.user_sso(15)
       expect(a_get("#{host}/admin/users/15.json")).to have_been_made
     end
 
     it "has single_sign_on_record" do
-      user_sso = subject.user_sso(15)
+      user_sso = client.user_sso(15)
       expect(user_sso).to be_a Hash
       expect(user_sso).to have_key("external_id")
     end
@@ -72,7 +72,7 @@ describe DiscourseApi::API::Users do
       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)
+      response = client.update_avatar("test_user", args)
       expect(response[:body]["success"]).to eq("OK")
     end
   end
@@ -88,12 +88,12 @@ describe DiscourseApi::API::Users do
     end
 
     it "makes the put request" do
-      subject.update_email("fake_user", "fake_user_2@example.com")
+      client.update_email("fake_user", "fake_user_2@example.com")
       expect(a_put("#{host}/u/fake_user/preferences/email")).to have_been_made
     end
 
     it "returns success" do
-      response = subject.update_email("fake_user", "fake_user_2@example.com")
+      response = client.update_email("fake_user", "fake_user_2@example.com")
       expect(response[:body]["success"]).to be_truthy
     end
   end
@@ -109,16 +109,16 @@ describe DiscourseApi::API::Users do
     end
 
     it "makes the put request" do
-      subject.api_key = "test_d7fd0429940"
-      subject.api_username = "test_user"
-      subject.update_user("fake_user", name: "Fake User 2")
+      client.api_key = "test_d7fd0429940"
+      client.api_username = "test_user"
+      client.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"
-      response = subject.update_user("fake_user", name: "Fake User 2")
+      client.api_key = "test_d7fd0429940"
+      client.api_username = "test_user"
+      response = client.update_user("fake_user", name: "Fake User 2")
       expect(response[:body]["success"]).to be_truthy
     end
   end
@@ -134,12 +134,12 @@ describe DiscourseApi::API::Users do
     end
 
     it "makes the put request" do
-      subject.update_username("fake_user", "fake_user_2")
+      client.update_username("fake_user", "fake_user_2")
       expect(a_put("#{host}/u/fake_user/preferences/username")).to have_been_made
     end
 
     it "returns the updated username" do
-      response = subject.update_username("fake_user", "fake_user_2")
+      response = client.update_username("fake_user", "fake_user_2")
       expect(response[:body]["username"]).to eq("fake_user_2")
     end
   end
@@ -155,19 +155,19 @@ describe DiscourseApi::API::Users do
     end
 
     it "makes the post request" do
-      subject.create_user name: "Test User",
-                          email: "test2@example.com",
-                          password: "P@ssword",
-                          username: "test2"
+      client.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"
+        client.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
     end
@@ -184,12 +184,12 @@ describe DiscourseApi::API::Users do
     end
 
     it "makes the put request" do
-      subject.activate(15)
+      client.activate(15)
       expect(a_put("#{host}/admin/users/15/activate")).to have_been_made
     end
 
     it "returns success" do
-      response = subject.activate(15)
+      response = client.activate(15)
       expect(response[:body]["success"]).to eq("OK")
     end
   end
@@ -205,12 +205,12 @@ describe DiscourseApi::API::Users do
     end
 
     it "makes a post request" do
-      subject.log_out(4)
+      client.log_out(4)
       expect(a_post("#{host}/admin/users/4/log_out")).to have_been_made
     end
 
     it "returns success" do
-      response = subject.log_out(4)
+      response = client.log_out(4)
       expect(response).to be_a Hash
       expect(response["success"]).to eq("OK")
     end
@@ -227,7 +227,7 @@ describe DiscourseApi::API::Users do
     end
 
     it "Raises API Error" do
-      expect { subject.log_out(90) }.to raise_error DiscourseApi::NotFoundError
+      expect { client.log_out(90) }.to raise_error DiscourseApi::NotFoundError
     end
   end
 
@@ -242,12 +242,12 @@ describe DiscourseApi::API::Users do
     end
 
     it "requests the correct resource" do
-      subject.list_users("active")
+      client.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 = client.list_users("active")
       expect(users).to be_an Array
       expect(users.first).to be_a Hash
     end
@@ -266,14 +266,14 @@ describe DiscourseApi::API::Users do
 
     it "makes the correct put request" do
       params = { level: 2 }
-      subject.update_trust_level(2, params)
+      client.update_trust_level(2, params)
       url = "#{host}/admin/users/2/trust_level"
       expect(a_put(url)).to have_been_made
     end
 
     it "updates the trust_level" do
       params = { level: 2 }
-      admin_user = subject.update_trust_level(2, params)
+      admin_user = client.update_trust_level(2, params)
       expect(admin_user).to be_a Hash
       expect(admin_user["admin_user"]).to have_key("trust_level")
     end
@@ -291,13 +291,13 @@ describe DiscourseApi::API::Users do
     end
 
     it "makes the correct put request" do
-      subject.grant_admin(11)
+      client.grant_admin(11)
       url = "#{host}/admin/users/11/grant_admin"
       expect(a_put(url)).to have_been_made
     end
 
     it "makes the user an admin" do
-      result = subject.grant_admin(11)
+      result = client.grant_admin(11)
       expect(result).to be_a Hash
       expect(result["admin_user"]["admin"]).to eq(true)
     end
@@ -315,13 +315,13 @@ describe DiscourseApi::API::Users do
     end
 
     it "makes the correct put request" do
-      subject.grant_moderation(11)
+      client.grant_moderation(11)
       url = "#{host}/admin/users/11/grant_moderation"
       expect(a_put(url)).to have_been_made
     end
 
     it "makes the user a moderator" do
-      result = subject.grant_moderation(11)
+      result = client.grant_moderation(11)
       expect(result).to be_a Hash
       expect(result["admin_user"]["moderator"]).to eq(true)
     end
@@ -334,7 +334,7 @@ describe DiscourseApi::API::Users do
     end
 
     it "makes the correct put request" do
-      result = subject.revoke_moderation(11)
+      result = client.revoke_moderation(11)
       url = "#{host}/admin/users/11/revoke_moderation"
       expect(a_put(url)).to have_been_made
       expect(result.status).to eq(200)
@@ -352,12 +352,12 @@ describe DiscourseApi::API::Users do
     end
 
     it "requests the correct resource" do
-      subject.by_external_id(1)
+      client.by_external_id(1)
       expect(a_get("#{host}/users/by-external/1")).to have_been_made
     end
 
     it "returns the requested user" do
-      user = subject.by_external_id(1)
+      user = client.by_external_id(1)
       expect(user["id"]).to eq 1
     end
   end
@@ -369,7 +369,7 @@ describe DiscourseApi::API::Users do
     end
 
     it "makes the correct put request" do
-      result = subject.suspend(11, "2030-01-01", "no reason")
+      result = client.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)
@@ -383,7 +383,7 @@ describe DiscourseApi::API::Users do
     end
 
     it "makes the correct put request" do
-      result = subject.unsuspend(11)
+      result = client.unsuspend(11)
       url = "#{host}/admin/users/11/unsuspend"
       expect(a_put(url)).to have_been_made
       expect(result.status).to eq(200)
@@ -397,7 +397,7 @@ describe DiscourseApi::API::Users do
     end
 
     it "makes the correct put request" do
-      result = subject.anonymize(11)
+      result = client.anonymize(11)
       url = "#{host}/admin/users/11/anonymize"
       expect(a_put(url)).to have_been_made
       expect(result.status).to eq(200)
@@ -411,7 +411,7 @@ describe DiscourseApi::API::Users do
     end
 
     it "makes the correct delete request" do
-      result = subject.delete_user(11, true)
+      result = client.delete_user(11, true)
       url = "#{host}/admin/users/11.json?delete_posts=true"
       expect(a_delete(url)).to have_been_made
       expect(result.body).to eq('{"deleted": true}')
@@ -426,12 +426,12 @@ describe DiscourseApi::API::Users do
     before { stub_get(url).to_return(body: body, headers: { content_type: "application/json" }) }
 
     it "requests the correct resource" do
-      subject.check_username("sparrow")
+      client.check_username("sparrow")
       expect(a_get(url)).to have_been_made
     end
 
     it "returns the result" do
-      result = subject.check_username("sparrow")
+      result = client.check_username("sparrow")
       expect(result["available"]).to eq false
     end
 
@@ -440,12 +440,12 @@ describe DiscourseApi::API::Users do
       let(:body) { '{"errors":["must only include numbers, letters, dashes, and underscores"]}' }
 
       it "escapes them" do
-        subject.check_username("1_[4]! @the$#?")
+        client.check_username("1_[4]! @the$#?")
         expect(a_get(url)).to have_been_made
       end
 
       it "returns the result" do
-        result = subject.check_username("1_[4]! @the$#?")
+        result = client.check_username("1_[4]! @the$#?")
         expect(
           result["errors"].first,
         ).to eq "must only include numbers, letters, dashes, and underscores"
@@ -457,12 +457,12 @@ describe DiscourseApi::API::Users do
     before { stub_put("#{host}/admin/users/15/deactivate").to_return(body: nil) }
 
     it "makes the put request" do
-      subject.deactivate(15)
+      client.deactivate(15)
       expect(a_put("#{host}/admin/users/15/deactivate")).to have_been_made
     end
 
     it "returns success" do
-      response = subject.deactivate(15)
+      response = client.deactivate(15)
       expect(response.status).to eq(200)
     end
   end