discourse_api 2.0.1 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9f47031bfa7dd5d842e604d3c6abbe2e827e2b0426b2a8de7a7a7bcd7c98acae
-  data.tar.gz: acd348ad9e5af8713d4250f69590b38e6e25278ce634eca6967562c601f72a25
+  metadata.gz: 6b5410419d12b39c4cfce5fcf10660b377de6b33ed493b9d65cb2adbb7c077e4
+  data.tar.gz: 8a763251cd8d55335d8d4233923e93f9e17449b326f709d5d7561e9c7207926e
 SHA512:
-  metadata.gz: a6b94a3a14a8f7bcbf4d540e0f92bc0afad8acf8a91d46b3ec939565ebe9a13c5f69baf2eafe41eb56be8008904eb08533fc0ce05803f8c9ee0886758ae05b5d
-  data.tar.gz: adcd6538209fc97b605aba126364a0ba4c73e404bae21116bd208181618f4ede69315408282e77317087e4c472fd0980dc3c24f33add64299af992611d9a4dba
+  metadata.gz: 48ee6f9f4814add51b8d574902410ec7b2e7a3c60c913816633f12412e21378fceeae8edce513df44d36222fcbbcf8d0eaf82adae94addf2626718306362ad05
+  data.tar.gz: 49ae595660f7662be7a9bbd881034b43f316265b7ed26de294152887b1e9ef002061b635f021b030a7f2f4c48a5eee129ce75389a1e23c0269575729335b3937

data/.github/workflows/ci.yml

@@ -10,12 +10,12 @@ jobs:
   lint:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       - name: Setup ruby
         uses: ruby/setup-ruby@v1
         with:
-          ruby-version: '3.2'
+          ruby-version: "3.3"
           bundler-cache: true
 
       - name: Rubocop
@@ -32,10 +32,10 @@ jobs:
 
     strategy:
       matrix:
-        ruby: ['2.7', '3.0', '3.1', '3.2']
+        ruby: ["2.7", "3.0", "3.1", "3.2", "3.3"]
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       - name: Setup ruby
         uses: ruby/setup-ruby@v1
@@ -52,10 +52,10 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       - name: Release Gem
-        uses: discourse/publish-rubygems-action@v2
+        uses: discourse/publish-rubygems-action@v3
         env:
           RUBYGEMS_API_KEY: ${{ secrets.RUBYGEMS_API_KEY }}
           GIT_EMAIL: team@discourse.org

data/.rubocop.yml

@@ -1,2 +1,5 @@
 inherit_gem:
   rubocop-discourse: stree-compat.yml
+
+Discourse/Plugins:
+  Enabled: false

data/.streerc

@@ -1,2 +1,2 @@
 --print-width=100
---plugins=plugin/trailing_comma,disable_ternary
+--plugins=plugin/trailing_comma,plugin/disable_auto_ternary

data/CHANGELOG.md

@@ -6,6 +6,16 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [2.1.0] - 2025-12-02
+### Changed
+- Add support for `external_id` in topic creation
+### Added
+- Add get topic url by `external_id`
+
+## [2.0.1] - 2023-06-09
+### Removed
+- Invite admin method removed
+
 ## [2.0.0] - 2023-05-26
 ### Changed
 - The package now requires ruby 2.7+

data/config_example.yml

@@ -1,6 +1,6 @@
 # Specify your environment by making a copy of this file to create a file in your root directory called config.yml with your environment settings.
 
-# host e.g. localhost:3000 or discourse.my_domain.com
+# host e.g. http://localhost:3000 or https://discourse.my_domain.com
 host: YOUR_HOST_NAME
 
 # api user (can effect results returned, e.g. .categories method returns only the categories your api_username can see)

data/discourse_api.gemspec

@@ -1,39 +1,44 @@
 # frozen_string_literal: true
-lib = File.expand_path('lib', __dir__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'discourse_api/version'
+
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) if !$LOAD_PATH.include?(lib)
+require "discourse_api/version"
 
 Gem::Specification.new do |spec|
-  spec.name          = 'discourse_api'
-  spec.version       = DiscourseApi::VERSION
-  spec.authors       = ['Sam Saffron', 'John Paul Ashenfelter', 'Michael Herold', 'Blake Erickson']
-  spec.email         = ['sam.saffron@gmail.com', 'john@ashenfelter.com', 'michael.j.herold@gmail.com', 'o.blakeerickson@gmail.com']
-  spec.description   = 'Discourse API'
-  spec.summary       = 'Allows access to the Discourse API'
-  spec.homepage      = 'http://github.com/discourse/discourse_api'
-  spec.license       = 'MIT'
+  spec.name = "discourse_api"
+  spec.version = DiscourseApi::VERSION
+  spec.authors = ["Sam Saffron", "John Paul Ashenfelter", "Michael Herold", "Blake Erickson"]
+  spec.email = %w[
+    sam.saffron@gmail.com
+    john@ashenfelter.com
+    michael.j.herold@gmail.com
+    o.blakeerickson@gmail.com
+  ]
+  spec.description = "Discourse API"
+  spec.summary = "Allows access to the Discourse API"
+  spec.homepage = "http://github.com/discourse/discourse_api"
+  spec.license = "MIT"
 
-  spec.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ['lib']
+  spec.files = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency 'faraday', '~> 2.7'
-  spec.add_runtime_dependency 'faraday-follow_redirects'
-  spec.add_runtime_dependency 'faraday-multipart'
-  spec.add_runtime_dependency 'rack', '>= 1.6'
+  spec.add_runtime_dependency "faraday", "~> 2.7"
+  spec.add_runtime_dependency "faraday-follow_redirects"
+  spec.add_runtime_dependency "faraday-multipart"
+  spec.add_runtime_dependency "rack", ">= 1.6"
 
-  spec.add_development_dependency 'bundler', '~> 2.0'
-  spec.add_development_dependency 'guard', '~> 2.14'
-  spec.add_development_dependency 'guard-rspec', '~> 4.7'
-  spec.add_development_dependency 'rake', '>= 12.3.3'
-  spec.add_development_dependency 'rb-inotify', '~> 0.9'
-  spec.add_development_dependency 'rspec', '~> 3.4'
-  spec.add_development_dependency 'simplecov', '~> 0.11'
-  spec.add_development_dependency 'webmock', '~> 3.0'
-  spec.add_development_dependency 'rubocop-discourse', '~> 3.2.0'
-  spec.add_development_dependency 'syntax_tree', '~> 6.1.1'
-  spec.add_development_dependency 'syntax_tree-disable_ternary', '~> 1.0.0'
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "guard", "~> 2.14"
+  spec.add_development_dependency "guard-rspec", "~> 4.7"
+  spec.add_development_dependency "rake", ">= 12.3.3"
+  spec.add_development_dependency "rb-inotify", "~> 0.9"
+  spec.add_development_dependency "rspec", "~> 3.4"
+  spec.add_development_dependency "simplecov", "~> 0.11"
+  spec.add_development_dependency "webmock", "~> 3.0"
+  spec.add_development_dependency "rubocop-discourse", "= 3.8.1"
+  spec.add_development_dependency "syntax_tree", "~> 6.2.0"
 
-  spec.required_ruby_version = '>= 2.7.0'
+  spec.required_ruby_version = ">= 2.7.0"
 end

data/lib/discourse_api/api/categories.rb

@@ -6,68 +6,23 @@ module DiscourseApi
       # :permissions is a hash with the group name and permission_type which is
       # an integer 1 = Full 2 = Create Post 3 = Read Only
       def create_category(args = {})
-        args =
-          API
-            .params(args)
-            .required(:name, :color, :text_color)
-            .optional(
-              :slug,
-              :permissions,
-              :auto_close_hours,
-              :auto_close_based_on_last_post,
-              :position,
-              :email_in,
-              :email_in_allow_strangers,
-              :logo_url,
-              :background_url,
-              :allow_badges,
-              :topic_template,
-              :custom_fields,
-              :description,
-              :reviewable_by_group_name,
-              :show_subcategory_list,
-              :subcategory_list_style,
-              :allowed_tags,
-              :allowed_tag_groups,
-              :required_tag_group_name,
-            )
-            .default(parent_category_id: nil)
-        response = post("/categories", args)
+        params = common_category_params(args)
+        response = post("/categories", params.to_h)
         response["category"]
       end
 
       def update_category(args = {})
         category_id = args[:id]
-        args =
-          API
-            .params(args)
-            .required(:id, :name, :color, :text_color)
-            .optional(
-              :slug,
-              :permissions,
-              :auto_close_hours,
-              :auto_close_based_on_last_post,
-              :position,
-              :email_in,
-              :email_in_allow_strangers,
-              :logo_url,
-              :background_url,
-              :allow_badges,
-              :topic_template,
-              :custom_fields,
-              :description,
-              :reviewable_by_group_name,
-              :show_subcategory_list,
-              :subcategory_list_style,
-              :allowed_tags,
-              :allowed_tag_groups,
-              :required_tag_group_name,
-            )
-            .default(parent_category_id: nil)
-        response = put("/categories/#{category_id}", args)
+        params = common_category_params(args, include_id: true)
+        response = put("/categories/#{category_id}", params.to_h)
         response["body"]["category"] if response["body"]
       end
 
+      def reorder_categories(args = {})
+        params = API.params(args).required(:mapping)
+        post("/categories/reorder", params)
+      end
+
       def delete_category(id)
         response = delete("/categories/#{id}")
         response[:body]["success"]
@@ -139,6 +94,42 @@ module DiscourseApi
         params = API.params(params).required(:notification_level)
         post("/category/#{category_id}/notifications", params)
       end
+
+      private
+
+      def common_category_params(args, include_id: false)
+        params = API.params(args)
+        params = params.required(:id) if include_id
+        params
+          .required(:name)
+          .optional(
+            :color,
+            :text_color,
+            :slug,
+            :permissions,
+            :auto_close_hours,
+            :auto_close_based_on_last_post,
+            :position,
+            :email_in,
+            :email_in_allow_strangers,
+            :logo_url,
+            :background_url,
+            :allow_badges,
+            :topic_template,
+            :custom_fields,
+            :description,
+            :reviewable_by_group_name,
+            :show_subcategory_list,
+            :subcategory_list_style,
+            :allowed_tags,
+            :allowed_tag_groups,
+            :required_tag_group_name,
+            :topic_featured_links_allowed,
+            :search_priority,
+            :form_template_ids,
+          )
+          .default(parent_category_id: nil)
+      end
     end
   end
 end

data/lib/discourse_api/api/topics.rb

@@ -11,7 +11,15 @@ module DiscourseApi
           API
             .params(args)
             .required(:title, :raw)
-            .optional(:skip_validations, :category, :auto_track, :created_at, :api_username, :tags)
+            .optional(
+              :skip_validations,
+              :category,
+              :auto_track,
+              :created_at,
+              :api_username,
+              :tags,
+              :external_id,
+            )
         post("/posts", args.to_h)
       end
 
@@ -111,6 +119,10 @@ module DiscourseApi
       def remove_topic_bookmark(topic_id)
         put("/t/#{topic_id}/remove_bookmarks.json")
       end
+
+      def get_topic_url_by_external_id(external_id)
+        get("/t/external_id/#{external_id}")
+      end
     end
   end
 end

data/lib/discourse_api/single_sign_on.rb

@@ -98,10 +98,10 @@ module DiscourseApi
       sso.sso_secret = sso_secret if sso_secret
 
       parsed = Rack::Utils.parse_query(payload)
-      if sso.sign(parsed["sso"]) != parsed["sig"]
+      if parsed["sso"].nil? || sso.sign(parsed["sso"]) != parsed["sig"]
         diags =
-          "\n\nsso: #{parsed["sso"]}\n\nsig: #{parsed["sig"]}\n\nexpected sig: #{sso.sign(parsed["sso"])}"
-        if parsed["sso"] =~ %r{[^a-zA-Z0-9=\r\n/+]}m
+          "\n\nsso: #{parsed["sso"].inspect}\n\nsig: #{parsed["sig"].inspect}\n\nexpected sig: #{sso.sign(parsed.fetch("sso", ""))}"
+        if parsed["sso"].nil? || parsed["sso"] =~ %r{[^a-zA-Z0-9=\r\n/+]}m
           raise ParseError,
                 "The SSO field should be Base64 encoded, using only A-Z, a-z, 0-9, +, /, and = characters. Your input contains characters we don't understand as Base64, see http://en.wikipedia.org/wiki/Base64 #{diags}"
         else

data/lib/discourse_api/version.rb

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

data/spec/discourse_api/api/api_key_spec.rb

@@ -2,7 +2,7 @@
 require "spec_helper"
 
 describe DiscourseApi::API::ApiKey do
-  subject { DiscourseApi::Client.new("#{host}", "test_d7fd0429940", "test_user") }
+  subject(:client) { DiscourseApi::Client.new("#{host}", "test_d7fd0429940", "test_user") }
 
   describe "#list_api_keys" do
     before do
@@ -16,13 +16,13 @@ describe DiscourseApi::API::ApiKey do
     end
 
     it "requests the correct resource" do
-      subject.list_api_keys
+      client.list_api_keys
       url = "#{host}/admin/api/keys"
       expect(a_get(url)).to have_been_made
     end
 
     it "returns the requested api keys" do
-      keys = subject.list_api_keys
+      keys = client.list_api_keys
       expect(keys["keys"]).to be_an Array
       expect(keys["keys"].first).to be_a Hash
       expect(keys["keys"].first).to have_key("key")
@@ -41,13 +41,13 @@ describe DiscourseApi::API::ApiKey do
     end
 
     it "requests the correct resource" do
-      subject.create_api_key(key: { username: "robin" })
+      client.create_api_key(key: { username: "robin" })
       url = "#{host}/admin/api/keys"
       expect(a_post(url)).to have_been_made
     end
 
     it "returns the generated api key" do
-      api_key = subject.create_api_key(key: { username: "robin" })
+      api_key = client.create_api_key(key: { username: "robin" })
       expect(api_key).to be_a Hash
       expect(api_key["key"]).to have_key("key")
     end
@@ -65,13 +65,13 @@ describe DiscourseApi::API::ApiKey do
     end
 
     it "requests the correct resource" do
-      subject.revoke_api_key(10)
+      client.revoke_api_key(10)
       url = "#{host}/admin/api/keys/10/revoke"
       expect(a_post(url)).to have_been_made
     end
 
     it "returns the api key" do
-      api_key = subject.revoke_api_key(10)
+      api_key = client.revoke_api_key(10)
       expect(api_key["key"]).to have_key("key")
     end
   end
@@ -88,13 +88,13 @@ describe DiscourseApi::API::ApiKey do
     end
 
     it "requests the correct resource" do
-      subject.undo_revoke_api_key(10)
+      client.undo_revoke_api_key(10)
       url = "#{host}/admin/api/keys/10/undo-revoke"
       expect(a_post(url)).to have_been_made
     end
 
     it "returns the api key" do
-      api_key = subject.undo_revoke_api_key(10)
+      api_key = client.undo_revoke_api_key(10)
       expect(api_key["key"]).to have_key("key")
     end
   end
@@ -111,13 +111,13 @@ describe DiscourseApi::API::ApiKey do
     end
 
     it "requests the correct resource" do
-      subject.delete_api_key(10)
+      client.delete_api_key(10)
       url = "#{host}/admin/api/keys/10"
       expect(a_delete(url)).to have_been_made
     end
 
     it "returns 200" do
-      response = subject.delete_api_key(10)
+      response = client.delete_api_key(10)
       expect(response["status"]).to eq(200)
     end
   end

data/spec/discourse_api/api/backups_spec.rb

@@ -2,7 +2,7 @@
 require "spec_helper"
 
 describe DiscourseApi::API::Backups do
-  subject { DiscourseApi::Client.new("#{host}", "test_d7fd0429940", "test_user") }
+  subject(:client) { DiscourseApi::Client.new("#{host}", "test_d7fd0429940", "test_user") }
 
   describe "#backups" do
     before do
@@ -15,12 +15,12 @@ describe DiscourseApi::API::Backups do
     end
 
     it "requests the correct resource" do
-      subject.backups
+      client.backups
       expect(a_get("#{host}/admin/backups.json")).to have_been_made
     end
 
     it "returns the requested backups" do
-      backups = subject.backups
+      backups = client.backups
       expect(backups).to be_an Array
       expect(backups.first).to be_a Hash
       expect(backups.first).to have_key("filename")

data/spec/discourse_api/api/badges_spec.rb

@@ -2,7 +2,7 @@
 require "spec_helper"
 
 describe DiscourseApi::API::Badges do
-  subject { DiscourseApi::Client.new("#{host}", "test_d7fd0429940", "test_user") }
+  subject(:client) { DiscourseApi::Client.new("#{host}", "test_d7fd0429940", "test_user") }
 
   describe "#badges" do
     before do
@@ -15,12 +15,12 @@ describe DiscourseApi::API::Badges do
     end
 
     it "requests the correct resource" do
-      subject.badges
+      client.badges
       expect(a_get("#{host}/admin/badges.json")).to have_been_made
     end
 
     it "returns the requested badges" do
-      badges = subject.badges
+      badges = client.badges
       expect(badges).to be_a Hash
       expect(badges["badges"]).to be_an Array
     end
@@ -37,12 +37,12 @@ describe DiscourseApi::API::Badges do
     end
 
     it "requests the correct resource" do
-      subject.user_badges("test_user")
+      client.user_badges("test_user")
       expect(a_get("#{host}/user-badges/test_user.json")).to have_been_made
     end
 
     it "returns the requested user badges" do
-      badges = subject.user_badges("test_user")
+      badges = client.user_badges("test_user")
       expect(badges).to be_an Array
       expect(badges.first).to be_a Hash
       expect(badges.first).to have_key("badge_type_id")

data/spec/discourse_api/api/categories_spec.rb

@@ -2,7 +2,7 @@
 require "spec_helper"
 
 describe DiscourseApi::API::Categories do
-  subject { DiscourseApi::Client.new("#{host}", "test_d7fd0429940", "test_user") }
+  subject(:client) { DiscourseApi::Client.new("#{host}", "test_d7fd0429940", "test_user") }
 
   describe "#categories" do
     before do
@@ -15,18 +15,18 @@ describe DiscourseApi::API::Categories do
     end
 
     it "requests the correct resource" do
-      subject.categories
+      client.categories
       expect(a_get("#{host}/categories.json")).to have_been_made
     end
 
     it "returns the requested categories" do
-      categories = subject.categories
+      categories = client.categories
       expect(categories).to be_an Array
       expect(categories.first).to be_a Hash
     end
 
     it "returns the requested categories with hash arg" do
-      categories = subject.categories({})
+      categories = client.categories({})
       expect(categories).to be_an Array
       expect(categories.first).to be_a Hash
     end
@@ -43,12 +43,12 @@ describe DiscourseApi::API::Categories do
     end
 
     it "requests the correct resource" do
-      subject.categories
+      client.categories
       expect(a_get("#{host}/categories.json")).to have_been_made
     end
 
     it "returns the entire categories response" do
-      categories = subject.categories_full
+      categories = client.categories_full
       expect(categories).to be_a Hash
       expect(categories).to have_key "category_list"
       expect(categories).to have_key "featured_users"
@@ -66,7 +66,7 @@ describe DiscourseApi::API::Categories do
     end
 
     it "returns the latest topics in a category" do
-      latest_topics = subject.category_latest_topics(category_slug: "category-slug")
+      latest_topics = client.category_latest_topics(category_slug: "category-slug")
       expect(latest_topics).to be_an Array
     end
   end
@@ -82,7 +82,7 @@ describe DiscourseApi::API::Categories do
     end
 
     it "returns the entire latest topics in a category response" do
-      latest_topics = subject.category_latest_topics_full(category_slug: "category-slug")
+      latest_topics = client.category_latest_topics_full(category_slug: "category-slug")
       expect(latest_topics).to be_a Hash
       expect(latest_topics).to have_key "topic_list"
       expect(latest_topics).to have_key "users"
@@ -100,7 +100,7 @@ describe DiscourseApi::API::Categories do
     end
 
     it "returns the top topics in a category" do
-      topics = subject.category_top_topics("category-slug")
+      topics = client.category_top_topics("category-slug")
       expect(topics).to be_an Array
     end
   end
@@ -116,7 +116,7 @@ describe DiscourseApi::API::Categories do
     end
 
     it "returns the entire top topics in a category response" do
-      topics = subject.category_top_topics_full("category-slug")
+      topics = client.category_top_topics_full("category-slug")
       expect(topics).to be_a Hash
       expect(topics).to have_key "topic_list"
       expect(topics).to have_key "users"
@@ -134,7 +134,7 @@ describe DiscourseApi::API::Categories do
     end
 
     it "returns the new topics in a category" do
-      topics = subject.category_new_topics("category-slug")
+      topics = client.category_new_topics("category-slug")
       expect(topics).to be_an Array
     end
   end
@@ -150,7 +150,7 @@ describe DiscourseApi::API::Categories do
     end
 
     it "returns the new topics in a category" do
-      topics = subject.category_new_topics_full("category-slug")
+      topics = client.category_new_topics_full("category-slug")
       expect(topics).to be_a Hash
       expect(topics).to have_key "topic_list"
       expect(topics).to have_key "users"
@@ -160,7 +160,7 @@ describe DiscourseApi::API::Categories do
   describe "#category_new_category" do
     before do
       stub_post("#{host}/categories")
-      subject.create_category(
+      client.create_category(
         name: "test_category",
         color: "283890",
         text_color: "FFFFFF",
@@ -182,6 +182,28 @@ describe DiscourseApi::API::Categories do
     end
   end
 
+  describe "#reorder_categories" do
+    before do
+      stub_post("#{host}/categories/reorder").to_return(
+        body: fixture("notification_success.json"),
+        headers: {
+          content_type: "application/json",
+        },
+      )
+    end
+
+    it "makes a categories reordering request" do
+      payload = { "1": 2, "2": 3, "3": 4, "4": 1 }
+      response = client.reorder_categories(mapping: payload.to_json)
+      expect(
+        a_post("#{host}/categories/reorder").with(
+          body: "mapping=#{CGI.escape(payload.to_json.to_s)}",
+        ),
+      ).to have_been_made
+      expect(response["success"]).to eq("OK")
+    end
+  end
+
   describe "#category_set_user_notification" do
     before do
       stub_post("#{host}/category/1/notifications").to_return(
@@ -193,7 +215,7 @@ describe DiscourseApi::API::Categories do
     end
 
     it "makes the post request" do
-      response = subject.category_set_user_notification(id: 1, notification_level: 3)
+      response = client.category_set_user_notification(id: 1, notification_level: 3)
       expect(a_post("#{host}/category/1/notifications")).to have_been_made
       expect(response["success"]).to eq("OK")
     end
@@ -210,7 +232,7 @@ describe DiscourseApi::API::Categories do
     end
 
     it "makes the post request" do
-      response = subject.category_set_user_notification_level(1, notification_level: 3)
+      response = client.category_set_user_notification_level(1, notification_level: 3)
       expect(
         a_post("#{host}/category/1/notifications").with(body: "notification_level=3"),
       ).to have_been_made