discourse_api 0.37.0 → 0.38.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 11fa2d5cdcb3800c4bae5679d2644790c12d46c8d0797018f5a220a1f39d6ebe
-  data.tar.gz: fb596a1e54cac03f298492561d86afb226cb51c3a69400fb4461eeec3ab39836
+  metadata.gz: 359440c0d7810ba745d422cb97b7465e55cb65d3abb145c7597f511d13e77609
+  data.tar.gz: 7be49a42e09f7d16c5e4ad564b57305c2f8eb17c78ed8781a1b19bf1645564b8
 SHA512:
-  metadata.gz: 0ed9ad86bc438113850a8313d9672b7dfb67fdcb70c1d2c0ca668544f8f9babf2e4e0aa3b4392f6887592fdaa821aaae12e3e2c53277dede8fef06e8ca626d17
-  data.tar.gz: 23ce5939282ca3686dd62f09eedb191d78592c64c1ce47f7e58df92368cda1471bf9da6c1697718307e96a1b12fb800ad85a63080798a91c95ee1669a9022f4a
+  metadata.gz: 07ae95153a40f0b84fa64d439608a403e47ad46d75bb1f201364f621101158048345160725733d21540288c0588ed4fdbf3a43a7af3b2df969b1347fa2c9a91f
+  data.tar.gz: 0e58fa5071debb6d6d62035c48c9494ee0c811ed8097dd147745a6aeba85fe06a6c8b699ed943c56d8a88af9c33c51d2a59563355c81324b41cd4aec5533fca5

data/CHANGELOG.md

@@ -2,6 +2,11 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+## [0.38.0] - 2019-10-18
+### Added
+- Allow setting locale in SingleSignOn
+- Optional param to group memebrs to include owners as well as members
+
 ## [0.37.0] - 2019-09-23
 ### Added
 - user-badges endpoint for full badges list

data/lib/discourse_api/api/groups.rb

@@ -107,12 +107,18 @@ module DiscourseApi
       end
 
       def group_members(group_name, params = {})
+        options = params
         params = API.params(params)
           .optional(:offset, :limit)
           .default(offset: 0, limit: 100)
           .to_h
         response = get("/groups/#{group_name}/members.json", params)
-        response.body['members']
+
+        if options[:all] == true
+          response.body
+        else
+          response.body['members']
+        end
       end
 
       def group_set_user_notification_level(group, user_id, notification_level)

data/lib/discourse_api/client.rb

@@ -140,7 +140,7 @@ module DiscourseApi
       response = connection.send(method.to_sym, path, params)
       handle_error(response)
       response.env
-    rescue Faraday::Error::ClientError, JSON::ParserError
+    rescue Faraday::ClientError, JSON::ParserError
       raise DiscourseApi::Error
     end
 

data/lib/discourse_api/single_sign_on.rb

@@ -7,9 +7,10 @@ module DiscourseApi
   class SingleSignOn
     ACCESSORS = [:nonce, :name, :username, :email, :avatar_url, :avatar_force_update, :require_activation,
                  :bio, :external_id, :return_sso_url, :admin, :moderator, :suppress_welcome_message, :title,
-                 :add_groups, :remove_groups, :groups]
+                 :add_groups, :remove_groups, :groups, :locale, :locale_force_update]
     FIXNUMS = []
-    BOOLS = [:avatar_force_update, :admin, :moderator, :require_activation, :suppress_welcome_message]
+    BOOLS = [:avatar_force_update, :admin, :moderator, :require_activation, :suppress_welcome_message,
+      :locale_force_update]
     ARRAYS = [:groups]
     #NONCE_EXPIRY_TIME = 10.minutes # minutes is a rails method and is causing an error. Is this needed in the api?
 

data/lib/discourse_api/version.rb

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

data/spec/discourse_api/api/api_key_spec.rb

@@ -3,7 +3,7 @@ require 'spec_helper'
 describe DiscourseApi::API::ApiKey do
   subject {
     DiscourseApi::Client.new(
-      "http://localhost:3000",
+      "#{host}",
       "test_d7fd0429940",
       "test_user"
     )
@@ -11,14 +11,14 @@ describe DiscourseApi::API::ApiKey do
 
   describe "#api" do
     before do
-      url = "http://localhost:3000/admin/api.json"
+      url = "#{host}/admin/api.json"
       stub_get(url).to_return(body: fixture("api.json"),
                               headers: { content_type: "application/json" })
     end
 
     it "requests the correct resource" do
       subject.api
-      url = "http://localhost:3000/admin/api.json"
+      url = "#{host}/admin/api.json"
       expect(a_get(url)).to have_been_made
     end
 
@@ -32,7 +32,7 @@ describe DiscourseApi::API::ApiKey do
 
   describe "#generate_user_api_key" do
     before do
-      url = "http://localhost:3000/admin/users/2/generate_api_key.json"
+      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
@@ -46,7 +46,7 @@ describe DiscourseApi::API::ApiKey do
 
   describe "#revoke_user_api_key" do
     before do
-      url = "http://localhost:3000/admin/users/2/revoke_api_key.json"
+      url = "#{host}/admin/users/2/revoke_api_key.json"
       stub_delete(url).to_return(body: "",
       headers: { content_type: "application/json" })
     end
@@ -59,7 +59,7 @@ describe DiscourseApi::API::ApiKey do
 
   describe "#generate_master_key" do
     before do
-      url = "http://localhost:3000/admin/api/key"
+      url = "#{host}/admin/api/key"
       stub_post(url).to_return(body: fixture("generate_master_key.json"),
                                headers: { content_type: "application/json" })
     end
@@ -74,14 +74,14 @@ describe DiscourseApi::API::ApiKey do
 
   describe "#revoke_api_key" do
     before do
-      url = "http://localhost:3000/admin/api/key?id=10"
+      url = "#{host}/admin/api/key?id=10"
       stub_delete(url).to_return(body: "",
                                  headers: { content_type: "application/json" })
     end
 
     it "requests the correct resource" do
       subject.revoke_api_key(10)
-      url = "http://localhost:3000/admin/api/key?id=10"
+      url = "#{host}/admin/api/key?id=10"
       expect(a_delete(url)).to have_been_made
     end
 
@@ -93,14 +93,14 @@ describe DiscourseApi::API::ApiKey do
 
   describe "#regenerate_api_key" do
     before do
-      url = "http://localhost:3000/admin/api/key"
+      url = "#{host}/admin/api/key"
       stub_put(url).to_return(body: fixture("regenerate_api_key.json"),
                                  headers: { content_type: "application/json" })
     end
 
     it "requests the correct resource" do
       subject.regenerate_api_key(10)
-      url = "http://localhost:3000/admin/api/key"
+      url = "#{host}/admin/api/key"
       expect(a_put(url)).to have_been_made
     end
 

data/spec/discourse_api/api/backups_spec.rb

@@ -1,16 +1,16 @@
 require 'spec_helper'
 
 describe DiscourseApi::API::Backups do
-  subject { DiscourseApi::Client.new("http://localhost:3000", "test_d7fd0429940", "test_user" )}
+  subject { DiscourseApi::Client.new("#{host}", "test_d7fd0429940", "test_user" )}
 
   describe "#backups" do
     before do
-      stub_get("http://localhost:3000/admin/backups.json").to_return(body: fixture("backups.json"), headers: { content_type: "application/json" })
+      stub_get("#{host}/admin/backups.json").to_return(body: fixture("backups.json"), headers: { content_type: "application/json" })
     end
 
     it "requests the correct resource" do
       subject.backups
-      expect(a_get("http://localhost:3000/admin/backups.json")).to have_been_made
+      expect(a_get("#{host}/admin/backups.json")).to have_been_made
     end
 
     it "returns the requested backups" do

data/spec/discourse_api/api/badges_spec.rb

@@ -1,16 +1,16 @@
 require 'spec_helper'
 
 describe DiscourseApi::API::Badges do
-  subject { DiscourseApi::Client.new("http://localhost:3000", "test_d7fd0429940", "test_user" )}
+  subject { DiscourseApi::Client.new("#{host}", "test_d7fd0429940", "test_user" )}
 
   describe "#badges" do
     before do
-      stub_get("http://localhost:3000/admin/badges.json").to_return(body: fixture("badges.json"), headers: { content_type: "application/json" })
+      stub_get("#{host}/admin/badges.json").to_return(body: fixture("badges.json"), headers: { content_type: "application/json" })
     end
 
     it "requests the correct resource" do
       subject.badges
-      expect(a_get("http://localhost:3000/admin/badges.json")).to have_been_made
+      expect(a_get("#{host}/admin/badges.json")).to have_been_made
     end
 
     it "returns the requested badges" do
@@ -22,12 +22,12 @@ describe DiscourseApi::API::Badges do
 
   describe "#user-badges" do
     before do
-      stub_get("http://localhost:3000/user-badges/test_user.json").to_return(body: fixture("user_badges.json"), headers: { content_type: "application/json" })
+      stub_get("#{host}/user-badges/test_user.json").to_return(body: fixture("user_badges.json"), headers: { content_type: "application/json" })
     end
 
     it "requests the correct resource" do
       subject.user_badges('test_user')
-      expect(a_get("http://localhost:3000/user-badges/test_user.json")).to have_been_made
+      expect(a_get("#{host}/user-badges/test_user.json")).to have_been_made
     end
 
     it "returns the requested user badges" do

data/spec/discourse_api/api/categories_spec.rb

@@ -1,17 +1,17 @@
 require 'spec_helper'
 
 describe DiscourseApi::API::Categories do
-  subject { DiscourseApi::Client.new("http://localhost:3000", "test_d7fd0429940", "test_user" )}
+  subject { DiscourseApi::Client.new("#{host}", "test_d7fd0429940", "test_user" )}
 
   describe "#categories" do
     before do
-      stub_get("http://localhost:3000/categories.json")
+      stub_get("#{host}/categories.json")
         .to_return(body: fixture("categories.json"), headers: { content_type: "application/json" })
     end
 
     it "requests the correct resource" do
       subject.categories
-      expect(a_get("http://localhost:3000/categories.json")).to have_been_made
+      expect(a_get("#{host}/categories.json")).to have_been_made
     end
 
     it "returns the requested categories" do
@@ -29,7 +29,7 @@ describe DiscourseApi::API::Categories do
 
   describe '#category_latest_topics' do
     before do
-      stub_get("http://localhost:3000/c/category-slug/l/latest.json")
+      stub_get("#{host}/c/category-slug/l/latest.json")
         .to_return(body: fixture("category_latest_topics.json"), headers: { content_type: "application/json" })
     end
 
@@ -41,7 +41,7 @@ describe DiscourseApi::API::Categories do
 
   describe '#category_top_topics' do
     before do
-      stub_get("http://localhost:3000/c/category-slug/l/top.json")
+      stub_get("#{host}/c/category-slug/l/top.json")
       .to_return(
         body: fixture("category_topics.json"), 
         headers: { content_type: "application/json" }
@@ -56,7 +56,7 @@ describe DiscourseApi::API::Categories do
 
   describe '#category_new_topics' do
     before do
-      stub_get("http://localhost:3000/c/category-slug/l/new.json")
+      stub_get("#{host}/c/category-slug/l/new.json")
       .to_return(
         body: fixture("category_topics.json"), 
         headers: { content_type: "application/json" }
@@ -71,14 +71,14 @@ describe DiscourseApi::API::Categories do
 
   describe '#category_new_category' do
     before do
-      stub_post("http://localhost:3000/categories")
+      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})
     end
     
     it "makes a create category request" do
-      expect(a_post("http://localhost:3000/categories").with(body: 
+      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

data/spec/discourse_api/api/email_spec.rb

@@ -1,16 +1,16 @@
 require 'spec_helper'
 
 describe DiscourseApi::API::Email do
-  subject { DiscourseApi::Client.new("http://localhost:3000", "test_d7fd0429940", "test_user" )}
+  subject { DiscourseApi::Client.new("#{host}", "test_d7fd0429940", "test_user" )}
 
   describe "#email_settings" do
     before do
-      stub_get("http://localhost:3000/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
       subject.email_settings
-      expect(a_get("http://localhost:3000/admin/email.json")).to have_been_made
+      expect(a_get("#{host}/admin/email.json")).to have_been_made
     end
 
     it "returns the requested settings" do
@@ -23,12 +23,12 @@ describe DiscourseApi::API::Email do
 
   describe "#list_email_all" do
     before do
-      stub_get("http://localhost:3000/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')
-      expect(a_get("http://localhost:3000/admin/email/all.json")).to have_been_made
+      expect(a_get("#{host}/admin/email/all.json")).to have_been_made
     end
 
     it "returns all email" do

data/spec/discourse_api/api/groups_spec.rb

@@ -1,16 +1,16 @@
 require 'spec_helper'
 
 describe DiscourseApi::API::Groups do
-  subject { DiscourseApi::Client.new("http://localhost:3000", "test_d7fd0429940", "test_user" )}
+  subject { DiscourseApi::Client.new("#{host}", "test_d7fd0429940", "test_user" )}
 
   describe "#groups" do
     before do
-      stub_get("http://localhost:3000/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
       subject.groups
-      expect(a_get("http://localhost:3000/groups.json")).to have_been_made
+      expect(a_get("#{host}/groups.json")).to have_been_made
     end
 
     it "returns the requested groups" do
@@ -20,65 +20,65 @@ describe DiscourseApi::API::Groups do
     end
 
     it "returns a single group" do
-      stub_get("http://localhost:3000/groups/some-group.json").to_return(body: fixture("group.json"), headers: { content_type: "application/json" })
+      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("http://localhost:3000/admin/groups")
+      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("http://localhost:3000/admin/groups").
+      expect(a_post("#{host}/admin/groups").
               with(body: params)
             ).to have_been_made
     end
 
     it "update an existing group" do
-      stub_put("http://localhost:3000/groups/42")
+      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("http://localhost:3000/groups/42").
+      expect(a_put("#{host}/groups/42").
               with(body: params)
             ).to have_been_made
     end
 
     describe "add members" do
       before do
-        stub_request(:put, "http://localhost:3000/admin/groups/123/members.json")
+        stub_request(:put, "#{host}/admin/groups/123/members.json")
       end
 
       it "adds a single member by username" do
         subject.group_add(123, username: "sam")
-        expect(a_request(:put, "http://localhost:3000/admin/groups/123/members.json").
+        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, "http://localhost:3000/admin/groups/123/members.json").
+        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, "http://localhost:3000/admin/groups/123/members.json").
+        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, "http://localhost:3000/admin/groups/123/members.json").
+        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) { "http://localhost:3000/admin/groups/123/members.json?usernames=sam" }
+      let(:url) { "#{host}/admin/groups/123/members.json?usernames=sam" }
 
       before do
         stub_delete(url)
@@ -91,29 +91,37 @@ describe DiscourseApi::API::Groups do
     end
 
     describe "group members" do
-      before do
-        stub_get("http://localhost:3000/groups/mygroup/members.json?limit=100&offset=0").to_return(body: fixture("members_0.json"), headers: { content_type: "application/json" })
-        stub_get("http://localhost:3000/groups/mygroup/members.json?limit=100&offset=100").to_return(body: fixture("members_1.json"), headers: { content_type: "application/json" })
-      end
-
       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')
-        expect(a_get("http://localhost:3000/groups/mygroup/members.json?limit=100&offset=0")).to have_been_made
+        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)
-        expect(a_get("http://localhost:3000/groups/mygroup/members.json?limit=100&offset=100")).to have_been_made
+        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)
+          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"])
+        end
+      end
     end
 
     describe "group user notification level" do
       before do
-        stub_post("http://localhost:3000/groups/mygroup/notifications?user_id=77&notification_level=3")
+        stub_post("#{host}/groups/mygroup/notifications?user_id=77&notification_level=3")
       end
 
       it "updates user's notification level for group" do
         subject.group_set_user_notification_level("mygroup", 77, 3)
-        expect(a_post("http://localhost:3000/groups/mygroup/notifications?user_id=77&notification_level=3"))
+        expect(a_post("#{host}/groups/mygroup/notifications?user_id=77&notification_level=3"))
             .to have_been_made
       end
     end