discourse_api 0.39.2 → 0.43.0

data/lib/discourse_api/version.rb

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

data/spec/discourse_api/api/api_key_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'spec_helper'
 
 describe DiscourseApi::API::ApiKey do
@@ -30,33 +31,6 @@ describe DiscourseApi::API::ApiKey do
     end
   end
 
-  describe "#generate_user_api_key" do
-    before do
-      url = "#{host}/admin/users/2/generate_api_key.json"
-      stub_post(url).to_return(body: fixture("generate_api_key.json"),
-                               headers: { content_type: "application/json" })
-    end
-
-    it "returns the generated api key" do
-      api_key = subject.generate_user_api_key(2)
-      expect(api_key).to be_a Hash
-      expect(api_key['api_key']).to have_key('key')
-    end
-  end
-
-  describe "#revoke_user_api_key" do
-    before do
-      url = "#{host}/admin/users/2/revoke_api_key.json"
-      stub_delete(url).to_return(body: "",
-      headers: { content_type: "application/json" })
-    end
-
-    it "returns 200" do
-      response = subject.revoke_user_api_key(2)
-      expect(response['status']).to eq(200)
-    end
-  end
-
   describe "#generate_master_key" do
     before do
       url = "#{host}/admin/api/key"
@@ -95,7 +69,7 @@ describe DiscourseApi::API::ApiKey do
     before do
       url = "#{host}/admin/api/key"
       stub_put(url).to_return(body: fixture("regenerate_api_key.json"),
-                                 headers: { content_type: "application/json" })
+                              headers: { content_type: "application/json" })
     end
 
     it "requests the correct resource" do

data/spec/discourse_api/api/backups_spec.rb

@@ -1,7 +1,8 @@
+# frozen_string_literal: true
 require 'spec_helper'
 
 describe DiscourseApi::API::Backups do
-  subject { DiscourseApi::Client.new("#{host}", "test_d7fd0429940", "test_user" )}
+  subject { DiscourseApi::Client.new("#{host}", "test_d7fd0429940", "test_user") }
 
   describe "#backups" do
     before do

data/spec/discourse_api/api/badges_spec.rb

@@ -1,7 +1,8 @@
+# frozen_string_literal: true
 require 'spec_helper'
 
 describe DiscourseApi::API::Badges do
-  subject { DiscourseApi::Client.new("#{host}", "test_d7fd0429940", "test_user" )}
+  subject { DiscourseApi::Client.new("#{host}", "test_d7fd0429940", "test_user") }
 
   describe "#badges" do
     before do

data/spec/discourse_api/api/categories_spec.rb

@@ -1,7 +1,8 @@
+# frozen_string_literal: true
 require 'spec_helper'
 
 describe DiscourseApi::API::Categories do
-  subject { DiscourseApi::Client.new("#{host}", "test_d7fd0429940", "test_user" )}
+  subject { DiscourseApi::Client.new("#{host}", "test_d7fd0429940", "test_user") }
 
   describe "#categories" do
     before do
@@ -42,8 +43,8 @@ describe DiscourseApi::API::Categories do
   describe '#category_top_topics' do
     before do
       stub_get("#{host}/c/category-slug/l/top.json")
-      .to_return(
-        body: fixture("category_topics.json"), 
+        .to_return(
+        body: fixture("category_topics.json"),
         headers: { content_type: "application/json" }
       )
     end
@@ -57,8 +58,8 @@ describe DiscourseApi::API::Categories do
   describe '#category_new_topics' do
     before do
       stub_get("#{host}/c/category-slug/l/new.json")
-      .to_return(
-        body: fixture("category_topics.json"), 
+        .to_return(
+        body: fixture("category_topics.json"),
         headers: { content_type: "application/json" }
       )
     end
@@ -74,14 +75,14 @@ describe DiscourseApi::API::Categories 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})
+                              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
     end
-  end  
+  end
 
 end

data/spec/discourse_api/api/email_spec.rb

@@ -1,7 +1,8 @@
+# frozen_string_literal: true
 require 'spec_helper'
 
 describe DiscourseApi::API::Email do
-  subject { DiscourseApi::Client.new("#{host}", "test_d7fd0429940", "test_user" )}
+  subject { DiscourseApi::Client.new("#{host}", "test_d7fd0429940", "test_user") }
 
   describe "#email_settings" do
     before do

data/spec/discourse_api/api/groups_spec.rb

@@ -1,7 +1,8 @@
+# frozen_string_literal: true
 require 'spec_helper'
 
 describe DiscourseApi::API::Groups do
-  subject { DiscourseApi::Client.new("#{host}", "test_d7fd0429940", "test_user" )}
+  subject { DiscourseApi::Client.new("#{host}", "test_d7fd0429940", "test_user") }
 
   describe "#groups" do
     before do
@@ -51,28 +52,28 @@ describe DiscourseApi::API::Groups do
       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"})
+                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"})
+                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"})
+                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"})
+                with(body: { user_ids: "123,456" })
               ).to have_been_made
       end
     end
@@ -122,7 +123,7 @@ describe DiscourseApi::API::Groups do
       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
+          .to have_been_made
       end
     end
 

data/spec/discourse_api/api/notifications_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'spec_helper'
 
 describe DiscourseApi::API::Notifications do

data/spec/discourse_api/api/params_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'spec_helper'
 
 describe DiscourseApi::API::Params do
@@ -6,31 +7,31 @@ describe DiscourseApi::API::Params do
   end
 
   it "should raise on missing required params" do
-    expect { params_for({o1: "test"}).to_h }.to raise_error(ArgumentError)
+    expect { params_for({ o1: "test" }).to_h }.to raise_error(ArgumentError)
   end
 
   it "should not raise when a required param is false" do
-    expect { params_for({r1: false}).to_h }.not_to raise_error
+    expect { params_for({ r1: false }).to_h }.not_to raise_error
   end
 
   it "should not include optional params when not provided" do
-    expect(params_for({r1: "test"}).to_h).not_to include(:o1)
+    expect(params_for({ r1: "test" }).to_h).not_to include(:o1)
   end
 
   it "should include optional params if provided but blank" do
-    expect(params_for({r1: "test", o2: nil}).to_h).to include(:o2)
+    expect(params_for({ r1: "test", o2: nil }).to_h).to include(:o2)
   end
 
   it "should include default params when defined but not provided" do
-    expect(params_for({r1: "test"}).to_h).to include(d1: "default")
+    expect(params_for({ r1: "test" }).to_h).to include(d1: "default")
   end
 
   it "should include default params when defined and provided" do
-    expect(params_for({r1: "test", d1: "override"}).to_h).to include(d1: "override")
+    expect(params_for({ r1: "test", d1: "override" }).to_h).to include(d1: "override")
   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,14 +1,15 @@
+# frozen_string_literal: true
 require 'spec_helper'
 
 describe DiscourseApi::API::Polls do
-  subject { DiscourseApi::Client.new("#{host}", "test_d7fd0429940", "test_user" )}
+  subject { DiscourseApi::Client.new("#{host}", "test_d7fd0429940", "test_user") }
 
   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" })
-    
+        .to_return(body: fixture("polls_vote.json"), headers: { content_type: "application/json" })
+
     end
 
     it "requests the correct resource" do
@@ -29,7 +30,7 @@ describe DiscourseApi::API::Polls do
     before do
       path = "#{host}/polls/toggle_status"
       stub_put(path)
-          .to_return(body: fixture("polls_toggle_status.json"), headers: { content_type: "application/json" })
+        .to_return(body: fixture("polls_toggle_status.json"), headers: { content_type: "application/json" })
 
     end
 
@@ -49,7 +50,7 @@ describe DiscourseApi::API::Polls do
   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" })
+        .to_return(body: fixture("polls_voters.json"), headers: { content_type: "application/json" })
     end
 
     it "requests the correct resource" do
@@ -64,7 +65,7 @@ describe DiscourseApi::API::Polls do
       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,3 +1,4 @@
+# frozen_string_literal: true
 require 'spec_helper'
 
 describe DiscourseApi::API::Posts do

data/spec/discourse_api/api/private_messages_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'spec_helper'
 
 describe DiscourseApi::API::PrivateMessages do

data/spec/discourse_api/api/search_spec.rb

@@ -1,16 +1,17 @@
+# frozen_string_literal: true
 require 'spec_helper'
 
 describe DiscourseApi::API::Search do
-  subject { DiscourseApi::Client.new("#{host}", "test_d7fd0429940", "test_user" )}
+  subject { DiscourseApi::Client.new("#{host}", "test_d7fd0429940", "test_user") }
 
   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/query").with(query: { term: "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/query").with(query: { term: "test" })).to have_been_made
     end
 
     it "returns the requested search" do

data/spec/discourse_api/api/site_settings_spec.rb

@@ -1,7 +1,8 @@
+# frozen_string_literal: true
 require 'spec_helper'
 
 describe DiscourseApi::API::SiteSettings do
-  subject { DiscourseApi::Client.new("#{host}", "test_d7fd0429940", "test_user" )}
+  subject { DiscourseApi::Client.new("#{host}", "test_d7fd0429940", "test_user") }
 
   describe "#site_setting_update" do
     before do

data/spec/discourse_api/api/sso_spec.rb

@@ -1,15 +1,58 @@
+# frozen_string_literal: true
 require 'spec_helper'
 
 describe DiscourseApi::API::SSO do
-  subject { DiscourseApi::Client.new("#{host}", "test_d7fd0429940", "test_user" )}
+  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'],
+      # old format (which results in custom.custom.field_1 in unsigned_payload)
+      'custom.field_1' => 'tomato',
+      # new format
+      custom_fields: {
+        field_2: 'potato'
+      }
+    }
+  end
+  let(:expected_unsigned_payload) do
+    'name=Some+User&username=some_user&email=some%40email.com&'\
+    'avatar_url=https%3A%2F%2Fwww.website.com&external_id=abc&title=ruby'\
+    '&add_groups=a&add_groups=b&remove_groups=c&remove_groups=d&custom.field_2=potato&'\
+    'custom.custom.field_1=tomato'
+  end
+  let(:sso_double) { DiscourseApi::SingleSignOn.parse_hash(params) }
 
   describe "#sync_sso" do
     before do
-      stub_post(/.*sync_sso.*/).to_return(body: fixture("user.json"), headers: { content_type: "application/json" })
+      stub_post(/.*sync_sso.*/).to_return(
+        body: fixture("user.json"),
+        headers: { content_type: "application/json" }
+      )
+    end
+
+    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.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

data/spec/discourse_api/api/topics_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'spec_helper'
 
 describe DiscourseApi::API::Topics do
@@ -9,7 +10,7 @@ describe DiscourseApi::API::Topics do
     end
 
     it "changes the topic status" do
-      subject.change_topic_status(nil, 57, { status: 'visible', enabled: false })
+      subject.update_topic_status(57, { status: 'visible', enabled: false })
       expect(a_put("#{host}/t/57/status")).to have_been_made
     end
   end
@@ -147,4 +148,22 @@ describe DiscourseApi::API::Topics do
       expect(body['post_stream']['posts'].first).to be_a Hash
     end
   end
+
+  describe "#create_topic_with_tags" do
+    before do
+      stub_post("#{host}/posts").to_return(body: fixture("create_topic_with_tags.json"), headers: { content_type: "application/json" })
+    end
+
+    it "makes the post request" do
+      subject.create_topic title: "Sample Topic Title", raw: "Sample topic content body", tags: ["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: ["asdf", "fdsa"]
+      expect(response).to be_a Hash
+      expect(response['topic_id']).to eq 21
+    end
+  end
+
 end

data/spec/discourse_api/api/uploads_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'spec_helper'
 
 describe DiscourseApi::API::Uploads do

data/spec/discourse_api/api/user_actions_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'spec_helper'
 
 describe DiscourseApi::API::UserActions do

data/spec/discourse_api/api/users_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'spec_helper'
 
 describe DiscourseApi::API::Users do
@@ -113,12 +114,12 @@ 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"
+      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
     end
@@ -163,7 +164,7 @@ describe DiscourseApi::API::Users do
     end
 
     it "Raises API Error" do
-      expect{subject.log_out(90)}.to raise_error DiscourseApi::NotFoundError
+      expect { subject.log_out(90) }.to raise_error DiscourseApi::NotFoundError
     end
   end