discourse_api 0.45.0 → 0.48.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 82cd748487d5d986f8327b702088ea4ea22c43cae311c2634dfa5d9cf4c4059f
-  data.tar.gz: a4fd68101134895f5071443f221a2327e9fe9e4a0a79df0d53a620c7e08d685d
+  metadata.gz: '047378d84854b5dae025d57550c071bf9944257a4048bd1be5b51b389e995dc3'
+  data.tar.gz: af75df86361c631aba91dc685c26e2f0d392597fbd561ef93b628f319f907457
 SHA512:
-  metadata.gz: 42546f17e134cd1e4ac6be81c8fdb53cf82461d60a73859dd757c2ec69e1128127f33a131e45dfec3d910012702256a173a7a1afd2a9873dc3d8a3e220c4af1a
-  data.tar.gz: 990fc89fd2a4935704e1512b858872b41ed7a6b7ba3ef28f583ad272e0675daff74f61b9a441632a8dc92c76892b8c507e53afce356317403c7c67f31a4fab18
+  metadata.gz: 7a435c702c930231c817d8192a20ddd859c3102cb3a9928ad4402dc1c019330d4dca79bd407f00ffa9e9038cebe7a0c138c081a019f4373711bfea67104c1a00
+  data.tar.gz: 8664b7d0efa3982e223a61af2a7d28ea2744100fdf1f3dcef99c9c1c3f7c59481c264ac04092c9b0c4c6a5f7559bd1fa99c4010d69fb1451f1a7875678a06d19

data/.github/workflows/ci.yml

@@ -5,8 +5,7 @@ on:
   push:
     branches:
       - master
-    tags:
-      - v*
+      - main
 
 jobs:
   build:
@@ -18,30 +17,25 @@ jobs:
           - 2.5
           - 2.6
           - 2.7
+          - 3.0
 
     steps:
-      - uses: actions/checkout@v1
+      - uses: actions/checkout@v2
 
       - name: Setup ruby
-        uses: actions/setup-ruby@v1
+        uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}
-          architecture: 'x64'
-
-      - name: Setup bundler
-        run: gem install bundler
-
-      - name: Setup gems
-        run: bundle install
+          bundler-cache: true
 
-      - name: Rubocop
+      - name: Lint
         run: bundle exec rubocop
 
-      - name: RSpec
-        run: bundle exec rspec
+      - name: Tests
+        run: bundle exec rake test
 
   publish:
-    if: contains(github.ref, 'refs/tags/v')
+    if: github.event_name == 'push' && (github.ref == 'refs/heads/main' || github.ref == 'refs/heads/master')
     needs: build
     runs-on: ubuntu-latest
 
@@ -49,6 +43,8 @@ jobs:
       - uses: actions/checkout@v2
 
       - name: Release Gem
-        uses: CvX/publish-rubygems-action@master
+        uses: discourse/publish-rubygems-action@v2-beta
         env:
-          RUBYGEMS_API_KEY: ${{secrets.RUBYGEMS_API_KEY}}
+          RUBYGEMS_API_KEY: ${{ secrets.RUBYGEMS_API_KEY }}
+          GIT_EMAIL: team@discourse.org
+          GIT_NAME: discoursebot

data/.gitignore

@@ -1,22 +1,3 @@
-*.gem
-*.rbc
-.bundle
-.config
-.yardoc
 Gemfile.lock
-InstalledFiles
-_yardoc
 coverage
-doc/
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp
-bin/
-.ruby-gemset
-.ruby-version
-.env
 /config.yml

data/CHANGELOG.md

@@ -6,6 +6,45 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.48.0] - 2022-01-28
+### Added
+- `group_add_owners` method (#239)
+- `group_remove_owners` method (#239)
+- `anonymize` method (#241)
+
+### Changed
+- `DiscourseApi::Timeout` error now inherits from `DiscourseApi::Error` (#240)
+- `DiscourseApi::SingleSignOn#groups` now returns an array of strings where each string is a group name, rather than an array with a single string that contains all the groups comma-concatenated (#243)
+
+## [0.47.0] - 2021-07-19
+### Added
+- Update invite method
+- Retrieve invite method
+- Destroy all expired invites method
+- Destroy invite method
+- Resend all invites method
+- Resend invite method
+- Pass params to get notifications API
+
+### Deprecated
+- `invite_user_to_topic` has been deprecated, use `invite_to_topic` instead.
+- `create_private_message` has been deprecated, use `create_pm` instead.
+
+## [0.46.0] - 2021-04-12
+### Added
+- Allow bookmarking topics
+- Add timeout to requests
+- Add params to get_topic_posts
+
+## [0.45.1] - 2021-03-11
+### Added
+- Fetch global top topics
+- Allow setting topic notifications
+- Return full category response
+
+### Changed
+- Use new search endpoint
+
 ## [0.45.0] - 2021-01-15
 ### Added
 - Tag configuration in create_category/update_category

data/discourse_api.gemspec

@@ -18,9 +18,9 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'faraday', '~> 1.0'
-  spec.add_dependency 'faraday_middleware', '~> 1.0'
-  spec.add_dependency 'rack', '>= 1.6'
+  spec.add_runtime_dependency 'faraday', '~> 1.0'
+  spec.add_runtime_dependency 'faraday_middleware', '~> 1.0'
+  spec.add_runtime_dependency 'rack', '>= 1.6'
 
   spec.add_development_dependency 'bundler', '~> 2.0'
   spec.add_development_dependency 'guard', '~> 2.14'
@@ -30,7 +30,7 @@ Gem::Specification.new do |spec|
   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'
+  spec.add_development_dependency 'rubocop-discourse', '~> 2.4.1'
 
   spec.required_ruby_version = '>= 2.5.0'
 end

data/examples/bookmark_topic.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require File.expand_path('../../lib/discourse_api', __FILE__)
+
+config = DiscourseApi::ExampleHelper.load_yml
+
+client = DiscourseApi::Client.new(config['host'] || 'http://localhost:3000')
+client.api_key = config['api_key'] || "YOUR_API_KEY"
+client.api_username = config['api_username'] || "YOUR_USERNAME"
+
+# Bookmark topic
+puts client.bookmark_topic(1418)
+
+# Remove bookmark from topic
+puts client.remove_topic_bookmark(1418)

data/examples/category.rb

@@ -14,6 +14,9 @@ puts client.categories()
 # get sub categories for parent category with id 2
 puts client.categories(parent_category_id: 2)
 
+# get the full categories response
+puts client.categories_full()
+
 # List topics in a category
 category_topics = client.category_latest_topics(category_slug: "test-category")
 puts category_topics

data/examples/invite_users.rb

@@ -9,10 +9,28 @@ client.api_key = config['api_key'] || "YOUR_API_KEY"
 client.api_username = config['api_username'] || "YOUR_USERNAME"
 
 # invite user
-client.invite_user(email: "name@example.com", group_ids: "41,42")
+invite = client.invite_user(email: "name@example.com", group_ids: "41,42")
+
+#update invite
+client.update_invite(invite["id"], email: "namee@example.com")
+
+# resend invite
+client.resend_invite("namee@example.com")
 
 # invite to a topic
-client.invite_user_to_topic(email: "foo@bar.com", topic_id: 1)
+client.invite_to_topic(1, email: "foo@bar.com")
 
 # if the user is an admin you may invite to a group as well
-client.invite_user_to_topic(email: "foo@bar.com", topic_id: 1, group_ids: "1,2,3")
+client.invite_to_topic(1, email: "foo@bar.com", group_ids: "1,2,3")
+
+# retrieve invite
+puts client.retrieve_invite(email: "foo@bar.com")
+
+# resend all invites
+client.resend_all_invites
+
+# destroy invite
+client.destroy_invite(invite["id"])
+
+# destroy all expired invites
+client.destroy_all_expired_invites

data/examples/notifications.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require File.expand_path('../../lib/discourse_api', __FILE__)
+
+config = DiscourseApi::ExampleHelper.load_yml
+
+client = DiscourseApi::Client.new(config['host'] || 'http://localhost:3000')
+client.api_key = config['api_key'] || "YOUR_API_KEY"
+client.api_username = config['api_username'] || "YOUR_USERNAME"
+
+# watch an entire category
+client.category_set_user_notification_level(1, notification_level: 3)
+
+# mute a topic
+client.topic_set_user_notification_level(1, notification_level: 0)
+
+# get user notifications
+client.notifications(username: 'discourse')

data/examples/topic_lists.rb

@@ -11,6 +11,9 @@ client.api_username = config['api_username'] || "YOUR_USERNAME"
 # get latest topics
 puts client.latest_topics({})
 
+# get top topics
+puts client.top_topics
+
 # recategorize topic
 puts client.recategorize_topic(topic_id: 108, category_id: 5)
 

data/lib/discourse_api/api/categories.rb

@@ -36,11 +36,24 @@ module DiscourseApi
       end
 
       def categories(params = {})
+        categories_full(params)['category_list']['categories']
+      end
+
+      def categories_full(params = {})
         response = get('/categories.json', params)
-        response[:body]['category_list']['categories']
+        response[:body]
       end
 
       def category_latest_topics(args = {})
+        response = category_latest_topics_full(args)
+        if response['errors']
+          response['errors']
+        else
+          response['topic_list']['topics']
+        end
+      end
+
+      def category_latest_topics_full(args = {})
         params = API.params(args)
           .required(:category_slug)
           .optional(:page).to_h
@@ -49,25 +62,31 @@ module DiscourseApi
           url = "#{url}?page=#{params[:page]}"
         end
         response = get(url)
-        if response[:body]['errors']
-          response[:body]['errors']
-        else
-          response[:body]['topic_list']['topics']
-        end
+        response[:body]
       end
 
       def category_top_topics(category_slug)
-        response = get("/c/#{category_slug}/l/top.json")
-        if response[:body]['errors']
-          response[:body]['errors']
+        response = category_top_topics_full(category_slug)
+        if response['errors']
+          response['errors']
         else
-          response[:body]['topic_list']['topics']
+          response['topic_list']['topics']
         end
       end
 
+      def category_top_topics_full(category_slug)
+        response = get("/c/#{category_slug}/l/top.json")
+        response[:body]
+      end
+
       def category_new_topics(category_slug)
+        response = category_new_topics_full(category_slug)
+        response['topic_list']['topics']
+      end
+
+      def category_new_topics_full(category_slug)
         response = get("/c/#{category_slug}/l/new.json")
-        response[:body]['topic_list']['topics']
+        response[:body]
       end
 
       def category(id)
@@ -75,12 +94,19 @@ module DiscourseApi
         response[:body]['category']
       end
 
+      # TODO: Deprecated. Remove after 20210727
       def category_set_user_notification(args = {})
         category_id = args[:id]
         args = API.params(args)
           .required(:notification_level)
         post("/category/#{category_id}/notifications", args)
       end
+
+      def category_set_user_notification_level(category_id, params)
+        params = API.params(params)
+          .required(:notification_level)
+        post("/category/#{category_id}/notifications", params)
+      end
     end
   end
 end

data/lib/discourse_api/api/dashboard.rb

@@ -14,10 +14,10 @@ module DiscourseApi
         topics = global_reports[3]
         posts = global_reports[4]
 
-        totals = {
+        {
           'users' => users['total'],
           'topics' => topics['total'],
-          'posts' => posts['total']
+          'posts' => posts['total'],
         }
       end
     end

data/lib/discourse_api/api/groups.rb

@@ -38,7 +38,6 @@ module DiscourseApi
                             :messageable_level,
                             :name,
                             :automatic_membership_email_domains,
-                            :automatic_membership_retroactive,
                             :title,
                             :primary_group,
                             :grant_trust_level,
@@ -47,19 +46,31 @@ module DiscourseApi
                             :flair_bg_color,
                             :flair_color,
                             :bio_raw,
-                            :members_visibility_level,
+                            :visibility_level,
                             :public_admission,
                             :public_exit,
                             :allow_membership_requests,
                             :full_name,
                             :default_notification_level,
-                            :usernames,
-                            :owner_usernames,
                             :membership_request_template)
           .to_h
         put("/groups/#{group_id}", group: args)
       end
 
+      def group_add_owners(group_id, args)
+        args = API.params(args)
+          .required(:usernames)
+          .to_h
+        put("/admin/groups/#{group_id}/owners.json", group: args)
+      end
+
+      def group_remove_owners(group_id, args)
+        args = API.params(args)
+          .required(:usernames)
+          .to_h
+        delete("/admin/groups/#{group_id}/owners.json", group: args)
+      end
+
       def groups(args = {})
         params = API.params(args)
           .optional(:page)

data/lib/discourse_api/api/invite.rb

@@ -3,17 +3,82 @@ module DiscourseApi
   module API
     module Invite
       def invite_user(params = {})
-        post("/invites", params)
+        args = API.params(params)
+          .optional(
+            :email,
+            :skip_email,
+            :custom_message,
+            :max_redemptions_allowed,
+            :topic_id,
+            :group_ids,
+            :expires_at
+          ).to_h
+
+        post("/invites", args)
       end
 
+      # TODO: Deprecated. Remove after 20220506
       def invite_user_to_topic(params = {})
-        post("/t/#{params[:topic_id]}/invite", params)
+        deprecated(__method__, 'invite_to_topic')
+        invite_to_topic(params[:topic_id], params)
+      end
+
+      def invite_to_topic(topic_id, params = {})
+        args = API.params(params)
+          .optional(
+            :email,
+            :user,
+            :group_ids,
+            :custom_message
+          ).to_h
+
+        post("/t/#{topic_id}/invite", args)
+      end
+
+      def retrieve_invite(params = {})
+        args = API.params(params).required(:email).to_h
+
+        response = get("invites/retrieve.json", args)
+
+        response.body
       end
 
       # requires this plugin => https://github.com/discourse/discourse-invite-tokens
       def disposable_tokens(params = {})
         post("/invite-token/generate", params)
       end
+
+      def update_invite(invite_id, params = {})
+        args = API.params(params)
+          .optional(
+            :topic_id,
+            :group_ids,
+            :group_names,
+            :email,
+            :send_email,
+            :custom_message,
+            :max_redemptions_allowed,
+            :expires_at
+          ).to_h
+
+        put("invites/#{invite_id}", args)
+      end
+
+      def destroy_all_expired_invites
+        post("invites/destroy-all-expired")
+      end
+
+      def resend_all_invites
+        post("invites/reinvite-all")
+      end
+
+      def resend_invite(email)
+        post("invites/reinvite", { "email": email })
+      end
+
+      def destroy_invite(invite_id)
+        delete("/invites", { id: invite_id })
+      end
     end
   end
 end

data/lib/discourse_api/api/notifications.rb

@@ -2,8 +2,11 @@
 module DiscourseApi
   module API
     module Notifications
-      def notifications
-        response = get('/notifications.json')
+      def notifications(params = {})
+        params = API.params(params)
+          .optional(:username, :recent, :limit, :offset, :filter)
+
+        response = get('/notifications.json', params)
         response[:body]
       end
     end

data/lib/discourse_api/api/private_messages.rb

@@ -3,13 +3,20 @@ module DiscourseApi
   module API
     module PrivateMessages
 
-      # :target_usernames REQUIRED comma separated list of usernames
+      # TODO: Deprecated. Remove after 20220628
+      def create_private_message(args = {})
+        deprecated(__method__, 'create_pm')
+        args[:target_recipients] = args.delete :target_usernames
+        create_pm(args.to_h)
+      end
+
+      # :target_recipients REQUIRED comma separated list of usernames
       # :category OPTIONAL name of category, not ID
       # :created_at OPTIONAL seconds since epoch.
-      def create_private_message(args = {})
+      def create_pm(args = {})
         args[:archetype] = 'private_message'
         args = API.params(args)
-          .required(:title, :raw, :target_usernames, :archetype)
+          .required(:title, :raw, :target_recipients, :archetype)
           .optional(:category, :created_at, :api_username)
         post("/posts", args.to_h)
       end

data/lib/discourse_api/api/search.rb

@@ -12,7 +12,7 @@ module DiscourseApi
         raise ArgumentError.new("#{term} is required but not specified") unless term
         raise ArgumentError.new("#{term} is required but not specified") unless !term.empty?
 
-        response = get('/search/query', options.merge(term: term))
+        response = get('/search', options.merge(q: term))
         response[:body]
       end
     end

data/lib/discourse_api/api/site_settings.rb

@@ -3,10 +3,10 @@ module DiscourseApi
   module API
     module SiteSettings
       def site_setting_update(args = {})
-        params = API.params(args)
-          .required(:name, :value).to_h
+        params = API.params(args).required(:name, :value).to_h
         new_site_setting = { params[:name] => params[:value] }
-        response = put("/admin/site_settings/#{params[:name]}", new_site_setting)
+
+        put("/admin/site_settings/#{params[:name]}", new_site_setting)
       end
     end
   end

data/lib/discourse_api/api/topics.rb

@@ -29,6 +29,11 @@ module DiscourseApi
         response[:body]['topic_list']['topics']
       end
 
+      def top_topics(params = {})
+        response = get("/top.json", params)
+        response[:body]['topic_list']['topics']
+      end
+
       def new_topics(params = {})
         response = get("/new.json", params)
         response[:body]['topic_list']['topics']
@@ -69,13 +74,22 @@ module DiscourseApi
         delete("/t/#{id}.json")
       end
 
-      def topic_posts(topic_id, post_ids = [])
+      def topic_posts(topic_id, post_ids = [], params = {})
+        params = API.params(params)
+          .optional(:asc,
+            :filter,
+            :include_raw,
+            :include_suggested,
+            :post_number,
+            :username_filters,
+          )
+
         url = ["/t/#{topic_id}/posts.json"]
         if post_ids.count > 0
           url.push('?')
           url.push(post_ids.map { |id| "post_ids[]=#{id}" }.join('&'))
         end
-        response = get(url.join)
+        response = get(url.join, params)
         response[:body]
       end
 
@@ -85,6 +99,20 @@ module DiscourseApi
 
         post("/t/#{topic_id}/change-owner.json", params)
       end
+
+      def topic_set_user_notification_level(topic_id, params)
+        params = API.params(params)
+          .required(:notification_level)
+        post("/t/#{topic_id}/notifications", params)
+      end
+
+      def bookmark_topic(topic_id)
+        put("/t/#{topic_id}/bookmark.json")
+      end
+
+      def remove_topic_bookmark(topic_id)
+        put("/t/#{topic_id}/remove_bookmarks.json")
+      end
     end
   end
 end

data/lib/discourse_api/api/users.rb

@@ -102,6 +102,10 @@ module DiscourseApi
         put("/admin/users/#{user_id}/unsuspend")
       end
 
+      def anonymize(user_id)
+        put("/admin/users/#{user_id}/anonymize")
+      end
+
       def delete_user(user_id, delete_posts = false)
         delete("/admin/users/#{user_id}.json?delete_posts=#{delete_posts}")
       end

data/lib/discourse_api/client.rb

@@ -29,7 +29,9 @@ module DiscourseApi
   class Client
     attr_accessor :api_key
     attr_accessor :basic_auth
-    attr_reader :host, :api_username
+    attr_reader :host, :api_username, :timeout
+
+    DEFAULT_TIMEOUT = 30
 
     include DiscourseApi::API::Categories
     include DiscourseApi::API::Search
@@ -60,6 +62,11 @@ module DiscourseApi
       @use_relative = check_subdirectory(host)
     end
 
+    def timeout=(timeout)
+      @timeout = timeout
+      @connection.options.timeout = timeout if @connection
+    end
+
     def api_username=(api_username)
       @api_username = api_username
       @connection.headers['Api-Username'] = api_username unless @connection.nil?
@@ -68,6 +75,9 @@ module DiscourseApi
     def connection_options
       @connection_options ||= {
         url: @host,
+        request: {
+          timeout: @timeout || DEFAULT_TIMEOUT
+        },
         headers: {
           accept: 'application/json',
           user_agent: user_agent,
@@ -158,6 +168,8 @@ module DiscourseApi
       response.env
     rescue Faraday::ClientError, JSON::ParserError
       raise DiscourseApi::Error
+    rescue Faraday::ConnectionFailed
+      raise DiscourseApi::Timeout
     end
 
     def handle_error(response)

data/lib/discourse_api/error.rb

@@ -33,4 +33,7 @@ module DiscourseApi
 
   class TooManyRequests < DiscourseError
   end
+
+  class Timeout < Error
+  end
 end