discourse_api 1.0.0 → 2.0.0

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
 

data/spec/discourse_api/api/notifications_spec.rb

@@ -1,13 +1,17 @@
 # frozen_string_literal: true
-require 'spec_helper'
+require "spec_helper"
 
 describe DiscourseApi::API::Notifications do
   subject { DiscourseApi::Client.new("#{host}", "test_d7fd0429940", "test_user") }
 
   describe "#notifications" do
-
     before do
-      stub_get("#{host}/notifications.json").to_return(body: fixture("notifications.json"), headers: { content_type: "application/json" })
+      stub_get("#{host}/notifications.json").to_return(
+        body: fixture("notifications.json"),
+        headers: {
+          content_type: "application/json",
+        },
+      )
     end
 
     it "requests the correct resource" do
@@ -19,7 +23,7 @@ describe DiscourseApi::API::Notifications do
       notifications = subject.notifications
       expect(notifications).to be_an Array
       expect(notifications.first).to be_an Hash
-      expect(notifications[0]['notification_type']).to eq(9)
+      expect(notifications[0]["notification_type"]).to eq(9)
     end
   end
 end

data/spec/discourse_api/api/params_spec.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-require 'spec_helper'
+require "spec_helper"
 
 describe DiscourseApi::API::Params do
   def params_for(h)
@@ -31,7 +31,9 @@ describe DiscourseApi::API::Params do
   end
 
   it "should include optional and default params when defined and provided" do
-    expect(params_for({ r1: "test", o1: "optional", d1: "override" }).to_h).to include(o1: "optional", d1: "override")
+    expect(params_for({ r1: "test", o1: "optional", d1: "override" }).to_h).to include(
+      o1: "optional",
+      d1: "override",
+    )
   end
-
 end

data/spec/discourse_api/api/polls_spec.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-require 'spec_helper'
+require "spec_helper"
 
 describe DiscourseApi::API::Polls do
   subject { DiscourseApi::Client.new("#{host}", "test_d7fd0429940", "test_user") }
@@ -7,65 +7,74 @@ describe DiscourseApi::API::Polls do
   describe "#poll vote" do
     before do
       path = "#{host}/polls/vote"
-      stub_put(path)
-        .to_return(body: fixture("polls_vote.json"), headers: { content_type: "application/json" })
-
+      stub_put(path).to_return(
+        body: fixture("polls_vote.json"),
+        headers: {
+          content_type: "application/json",
+        },
+      )
     end
 
     it "requests the correct resource" do
-      options = ['8b4736b1ae3dfb5a28088530f036f9e5']
-      subject.poll_vote post_id: 5, poll_name: 'poll', options: options
+      options = ["8b4736b1ae3dfb5a28088530f036f9e5"]
+      subject.poll_vote post_id: 5, poll_name: "poll", options: options
       expect(a_put("#{host}/polls/vote")).to have_been_made
     end
 
     it "returns the expected votes" do
-      options = ['8b4736b1ae3dfb5a28088530f036f9e5']
-      vote = subject.poll_vote post_id: 5, poll_name: 'poll', options: options
+      options = ["8b4736b1ae3dfb5a28088530f036f9e5"]
+      vote = subject.poll_vote post_id: 5, poll_name: "poll", options: options
       expect(vote.body).to be_a Hash
-      expect(vote.body['poll']['options']).to be_an Array
-      expect(vote.body['vote']).to eq(['8b4736b1ae3dfb5a28088530f036f9e5'])
+      expect(vote.body["poll"]["options"]).to be_an Array
+      expect(vote.body["vote"]).to eq(["8b4736b1ae3dfb5a28088530f036f9e5"])
     end
 
-  describe "#poll toggle_status" do
-    before do
-      path = "#{host}/polls/toggle_status"
-      stub_put(path)
-        .to_return(body: fixture("polls_toggle_status.json"), headers: { content_type: "application/json" })
+    describe "#poll toggle_status" do
+      before do
+        path = "#{host}/polls/toggle_status"
+        stub_put(path).to_return(
+          body: fixture("polls_toggle_status.json"),
+          headers: {
+            content_type: "application/json",
+          },
+        )
+      end
 
-    end
+      it "toggles the poll status to closed" do
+        subject.toggle_poll_status post_id: 5, poll_name: "poll", status: "closed"
+        expect(a_put("#{host}/polls/toggle_status")).to have_been_made
+      end
 
-    it "toggles the poll status to closed" do
-      subject.toggle_poll_status post_id: 5, poll_name: 'poll', status: 'closed'
-      expect(a_put("#{host}/polls/toggle_status")).to have_been_made
+      it "returns the expected results of closed poll" do
+        returned_poll_status =
+          subject.toggle_poll_status post_id: 5, poll_name: "poll", status: "closed"
+        expect(returned_poll_status.body).to be_a Hash
+        returned_poll_status.body["poll"]["options"].each { |g| expect(g).to be_a Hash }
+      end
     end
 
-    it "returns the expected results of closed poll" do
-      returned_poll_status = subject.toggle_poll_status post_id: 5, poll_name: 'poll', status: 'closed'
-      expect(returned_poll_status.body).to be_a Hash
-      returned_poll_status.body['poll']['options'].each { |g| expect(g).to be_a Hash }
-    end
-
-  end
-
-  describe "#poll voters" do
-    before do
-      stub_get("#{host}/polls/voters.json?post_id=5&poll_name=poll")
-        .to_return(body: fixture("polls_voters.json"), headers: { content_type: "application/json" })
-    end
+    describe "#poll voters" do
+      before do
+        stub_get("#{host}/polls/voters.json?post_id=5&poll_name=poll").to_return(
+          body: fixture("polls_voters.json"),
+          headers: {
+            content_type: "application/json",
+          },
+        )
+      end
 
-    it "requests the correct resource" do
-      subject.poll_voters post_id: 5, poll_name: 'poll'
-      expect(a_get("#{host}/polls/voters.json?post_id=5&poll_name=poll")).to have_been_made
-    end
+      it "requests the correct resource" do
+        subject.poll_voters post_id: 5, poll_name: "poll"
+        expect(a_get("#{host}/polls/voters.json?post_id=5&poll_name=poll")).to have_been_made
+      end
 
-    it "returns the expected votes" do
-      voters = subject.poll_voters post_id: 5, poll_name: 'poll'
-      expect(voters).to be_a Hash
-      voters.each { |g| expect(g).to be_an Array }
-      expect(voters['voters']['e539a9df8700d0d05c69356a07b768cf']).to be_an Array
-      expect(voters['voters']['e539a9df8700d0d05c69356a07b768cf'][0]['id']).to eq(356)
+      it "returns the expected votes" do
+        voters = subject.poll_voters post_id: 5, poll_name: "poll"
+        expect(voters).to be_a Hash
+        voters.each { |g| expect(g).to be_an Array }
+        expect(voters["voters"]["e539a9df8700d0d05c69356a07b768cf"]).to be_an Array
+        expect(voters["voters"]["e539a9df8700d0d05c69356a07b768cf"][0]["id"]).to eq(356)
+      end
     end
   end
-
-  end
 end

data/spec/discourse_api/api/posts_spec.rb

@@ -1,44 +1,59 @@
 # frozen_string_literal: true
-require 'spec_helper'
+require "spec_helper"
 
 describe DiscourseApi::API::Posts do
-  let (:client) { DiscourseApi::Client.new("#{host}", "test_d7fd0429940", "test_user") }
+  let (:client) {
+    DiscourseApi::Client.new("#{host}", "test_d7fd0429940", "test_user")
+  }
 
   describe "#get_post" do
     before do
-      stub_get("#{host}/posts/11.json").to_return(body: fixture("post.json"), headers: { content_type: "application/json" })
+      stub_get("#{host}/posts/11.json").to_return(
+        body: fixture("post.json"),
+        headers: {
+          content_type: "application/json",
+        },
+      )
     end
 
     it "fetches a post" do
       the_post = client.get_post(11)
       expect(the_post).to be_a Hash
-      expect(the_post['id']).to eq(11)
+      expect(the_post["id"]).to eq(11)
     end
   end
 
   describe "#posts" do
     before do
-      stub_get("#{host}/posts.json?before=0").to_return(body: fixture("posts_latest.json"), headers: { content_type: "application/json" })
-      stub_get("#{host}/posts.json?before=14").to_return(body: fixture("posts_before.json"), headers: { content_type: "application/json" })
+      stub_get("#{host}/posts.json?before=0").to_return(
+        body: fixture("posts_latest.json"),
+        headers: {
+          content_type: "application/json",
+        },
+      )
+      stub_get("#{host}/posts.json?before=14").to_return(
+        body: fixture("posts_before.json"),
+        headers: {
+          content_type: "application/json",
+        },
+      )
     end
 
     it "fetches latest posts" do
       the_posts = client.posts()
       expect(the_posts).to be_a Hash
-      expect(the_posts['latest_posts'][0]['id']).to eq(15)
+      expect(the_posts["latest_posts"][0]["id"]).to eq(15)
     end
 
     it "fetches posts before 14" do
       the_posts = client.posts(before: 14)
       expect(the_posts).to be_a Hash
-      expect(the_posts['latest_posts'][0]['id']).to eq(14)
+      expect(the_posts["latest_posts"][0]["id"]).to eq(14)
     end
   end
 
   describe "#wikify_post" do
-    before do
-      stub_put("#{host}/posts/9999/wiki")
-    end
+    before { stub_put("#{host}/posts/9999/wiki") }
 
     it "fails on unknown post" do
       client.wikify_post(9999)
@@ -47,9 +62,7 @@ describe DiscourseApi::API::Posts do
   end
 
   describe "#delete_post" do
-    before do
-      stub_delete("#{host}/posts/9999.json")
-    end
+    before { stub_delete("#{host}/posts/9999.json") }
 
     it "deletes a post" do
       client.delete_post(9999)
@@ -59,7 +72,12 @@ describe DiscourseApi::API::Posts do
 
   describe "#post_action_users" do
     before do
-      stub_get("#{host}/post_action_users.json?id=11&post_action_type_id=2").to_return(body: fixture("post_action_users.json"), headers: { content_type: "application/json" })
+      stub_get("#{host}/post_action_users.json?id=11&post_action_type_id=2").to_return(
+        body: fixture("post_action_users.json"),
+        headers: {
+          content_type: "application/json",
+        },
+      )
     end
 
     it "fetches post_action_users" do
@@ -68,5 +86,4 @@ describe DiscourseApi::API::Posts do
       expect(post_action_users["post_action_users"][0]["id"]).to eq(1286)
     end
   end
-
 end

data/spec/discourse_api/api/private_messages_spec.rb

@@ -1,55 +1,68 @@
 # frozen_string_literal: true
-require 'spec_helper'
+require "spec_helper"
 
 describe DiscourseApi::API::PrivateMessages do
   subject { DiscourseApi::Client.new("#{host}", "test_d7fd0429940", "test_user") }
 
   describe "#private_messages" do
     before do
-      stub_get("#{host}/topics/private-messages/test_user.json").to_return(body: fixture("private_messages.json"), headers: { content_type: "application/json" })
+      stub_get("#{host}/topics/private-messages/test_user.json").to_return(
+        body: fixture("private_messages.json"),
+        headers: {
+          content_type: "application/json",
+        },
+      )
     end
 
     it "requests the correct resource" do
-      subject.private_messages('test_user')
+      subject.private_messages("test_user")
       expect(a_get("#{host}/topics/private-messages/test_user.json")).to have_been_made
     end
 
     it "returns the requested private messages" do
-      private_messages = subject.private_messages('test_user')
+      private_messages = subject.private_messages("test_user")
       expect(private_messages).to be_an Array
     end
   end
 
   describe "#sent_private_messages" do
     before do
-      stub_get("#{host}/topics/private-messages-sent/test_user.json").to_return(body: fixture("private_messages.json"), headers: { content_type: "application/json" })
+      stub_get("#{host}/topics/private-messages-sent/test_user.json").to_return(
+        body: fixture("private_messages.json"),
+        headers: {
+          content_type: "application/json",
+        },
+      )
     end
 
     it "requests the correct resource" do
-      subject.sent_private_messages('test_user')
+      subject.sent_private_messages("test_user")
       expect(a_get("#{host}/topics/private-messages-sent/test_user.json")).to have_been_made
     end
 
     it "returns the requested sent private messages" do
-      private_messages = subject.sent_private_messages('test_user')
+      private_messages = subject.sent_private_messages("test_user")
       expect(private_messages).to be_an Array
     end
   end
 
-  describe '#create_pm' do
+  describe "#create_pm" do
     before do
       stub_post("#{host}/posts")
       subject.create_pm(
         title: "Confidential: Hello World!",
         raw: "This is the raw markdown for my private message",
-        target_recipients: "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_recipients=user1%2Cuser2&title=Confidential%3A+Hello+World%21')
-        ).to have_been_made
+      expect(
+        a_post("#{host}/posts").with(
+          body:
+            "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
 end

data/spec/discourse_api/api/search_spec.rb

@@ -1,12 +1,17 @@
 # frozen_string_literal: true
-require 'spec_helper'
+require "spec_helper"
 
 describe DiscourseApi::API::Search do
   subject { DiscourseApi::Client.new("#{host}", "test_d7fd0429940", "test_user") }
 
   describe "#search" do
     before do
-      stub_get("#{host}/search").with(query: { q: "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
@@ -25,7 +30,7 @@ describe DiscourseApi::API::Search do
     end
 
     it "raises an ArgumentError for empty string" do
-      expect { subject.search('') }.to raise_error(ArgumentError)
+      expect { subject.search("") }.to raise_error(ArgumentError)
     end
   end
 end

data/spec/discourse_api/api/site_settings_spec.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-require 'spec_helper'
+require "spec_helper"
 
 describe DiscourseApi::API::SiteSettings do
   subject { DiscourseApi::Client.new("#{host}", "test_d7fd0429940", "test_user") }
@@ -11,8 +11,7 @@ describe DiscourseApi::API::SiteSettings do
     end
 
     it "makes a site_settings_update request" do
-      expect(a_put("#{host}/admin/site_settings/foo")
-             .with(body: "foo=bar")).to have_been_made
+      expect(a_put("#{host}/admin/site_settings/foo").with(body: "foo=bar")).to have_been_made
     end
   end
 end

data/spec/discourse_api/api/sso_spec.rb

@@ -1,36 +1,36 @@
 # frozen_string_literal: true
-require 'spec_helper'
+require "spec_helper"
 
 describe DiscourseApi::API::SSO do
   subject { DiscourseApi::Client.new("#{host}", "test_d7fd0429940", "test_user") }
 
   let(:params) do
     {
-      sso_secret: 'abc',
-      sso_url: 'www.google.com',
-      name: 'Some User',
-      username: 'some_user',
-      email: 'some@email.com',
-      external_id: 'abc',
-      suppress_welcome_message: false,
-      avatar_url: 'https://www.website.com',
-      title: 'ruby',
-      avatar_force_update: false,
-      add_groups: ['a', 'b'],
-      remove_groups: ['c', 'd'],
+      :sso_secret => "abc",
+      :sso_url => "www.google.com",
+      :name => "Some User",
+      :username => "some_user",
+      :email => "some@email.com",
+      :external_id => "abc",
+      :suppress_welcome_message => false,
+      :avatar_url => "https://www.website.com",
+      :title => "ruby",
+      :avatar_force_update => false,
+      :add_groups => %w[a b],
+      :remove_groups => %w[c d],
       # old format (which results in custom.custom.field_1 in unsigned_payload)
-      'custom.field_1' => 'tomato',
+      "custom.field_1" => "tomato",
       # new format
-      custom_fields: {
-        field_2: 'potato'
-      }
+      :custom_fields => {
+        field_2: "potato",
+      },
     }
   end
   let(:expected_unsigned_payload) do
-    'add_groups=a&add_groups=b&avatar_url=https%3A%2F%2Fwww.website.com'\
-    '&email=some%40email.com&external_id=abc&name=Some+User&remove_groups=c'\
-    '&remove_groups=d&title=ruby&username=some_user&custom.field_2=potato'\
-    '&custom.custom.field_1=tomato'
+    "add_groups=a&add_groups=b&avatar_url=https%3A%2F%2Fwww.website.com" \
+      "&email=some%40email.com&external_id=abc&name=Some+User&remove_groups=c" \
+      "&remove_groups=d&title=ruby&username=some_user&custom.field_2=potato" \
+      "&custom.custom.field_1=tomato"
   end
   let(:sso_double) { DiscourseApi::SingleSignOn.parse_hash(params) }
 
@@ -38,21 +38,25 @@ describe DiscourseApi::API::SSO do
     before do
       stub_post(/.*sync_sso.*/).to_return(
         body: fixture("user.json"),
-        headers: { content_type: "application/json" }
+        headers: {
+          content_type: "application/json",
+        },
       )
     end
 
-    it 'assigns params to sso instance' do
+    it "assigns params to sso instance" do
       allow(DiscourseApi::SingleSignOn).to(receive(:parse_hash).with(params).and_return(sso_double))
 
       subject.sync_sso(params)
 
-      expect(sso_double.custom_fields).to eql({ 'custom.field_1' => 'tomato', :field_2 => 'potato' })
+      expect(sso_double.custom_fields).to eql(
+        { "custom.field_1" => "tomato", :field_2 => "potato" },
+      )
       expect(sso_double.unsigned_payload).to eql(expected_unsigned_payload)
     end
 
     it "requests the correct resource" do
-      subject.sync_sso({ sso_secret: "test_d7fd0429940", "custom.riffle_url" => "test" })
+      subject.sync_sso({ :sso_secret => "test_d7fd0429940", "custom.riffle_url" => "test" })
       expect(a_post(/.*sync_sso.*/)).to have_been_made
     end
   end