discourse_api 0.44.0 → 0.47.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 13cfa5b25dbe59e809cdcdb924406f9e680f1e029a5666fff9a0febbd75d5bf0
-  data.tar.gz: d68c096a8ae91dea4a70b60f9d412954712297544e49b891fc228f11d63ca4d6
+  metadata.gz: 3fffa65d4ed129c229766cecd20c2b5684570d22dcd08deaa44474f37cbe0b7c
+  data.tar.gz: 35db4a119a91642c632b43b78cbde678c2a753f28adb88b376bf1b5ab9bb6a2b
 SHA512:
-  metadata.gz: c942a353d95a144daa1939d448c949ad56a00e0999a0166c112e403e0ce5529941e8883d7456b029a173cdc79ebf7ffc08e84cc7e2e63956434ab00a6a60abf0
-  data.tar.gz: 909bb8f30f2ae412c93d1e0a9777786b8cae01c4bd15474f5ea980c0485bb91ca82f5eb62a81773f76a05b8eeb97bde076411a0dbe61e4407c0ca2204ac5484e
+  metadata.gz: 7353e073896a9e70d38336cba97d0c0f53f951c925e21e4333cc67fd8bfbd40ce5745f50ee6c6a87ce3e5c69c77d67e3287458a96418f033c9ee88901da7e3fa
+  data.tar.gz: 8a3cbddb1585c72dcf3eeaa3723e4742007b076c239e47a23cbf98c87024a95e4712e54eed85be4b48f9100acef41b282b91007c05237cc10048d5753ed82db4

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,16 +6,52 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [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_user` 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
+- Topic#change_owner
+- Support passing approved to #create_user
+### Changed
+- API key methods use the latest endpoints
+
 ## [0.44.0] - 2020-11-13
 ### Fixed
 - Updated `show_tag` method to use new route
-
 ### Removed
 - Support for Ruby 2.3 and 2.4
 
 ## [0.43.1] - 2020-11-04
 ### Fixed
-- tagged verion 0.43.0 got pushed without commmit due to new master branch
+- Tagged version 0.43.0 got pushed without commmit due to new master branch
   protections in github. No, code changes here just making sure tags align with
   commits.
 
@@ -32,17 +68,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## [0.41.0] - 2020-06-17
 ### Added
 - Add basic auth support
-
 ### Fixed
 - Fix SSO custom field prefixes
-
 ### Removed
 - Obsolete api key endpoints
 
 ## [0.40.0] - 2020-05-07
 ### Fixed
 - Add missing attributes to `sync_sso`
-
 ### Added
 - Add delete category method
 
@@ -64,7 +97,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Allow  more options parameters when creating a category
 - Don't require topic slug when updating topic status
 - Example files now read config.yml file when present for client settings
-
 ### Fixed
 - Issue with `topic_posts` and frozen strings
 - Fixed some topic and category methods
@@ -316,5 +348,4 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - `client.category_latest_posts("category-slug")` endpoint
 
 ## [0.1.2] - 2014-05-11
-
 - Release

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'
@@ -29,8 +29,8 @@ Gem::Specification.new do |spec|
   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', '~> 2.0'
-  spec.add_development_dependency 'rubocop-discourse'
+  spec.add_development_dependency 'webmock', '~> 3.0'
+  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)
 
 # 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_user_to_topic(email: "foo@bar.com", group_ids: "1,2,3", topic_id: 1)
+
+# 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/manage_api_keys.rb

@@ -0,0 +1,42 @@
+# 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"
+
+# generate user api key
+response = client.create_api_key(
+  key: {
+    description: "Key to The Batmobile",
+    username: "batman"
+  }
+)
+
+api_key_id = response["key"]["id"]
+
+puts response
+# sample output: {"key"=>{"id"=>13, "key"=>"abc", "description"=>"Key to the Batmobile"}}
+
+response = client.revoke_api_key(api_key_id)
+
+puts response
+# sample output: {"key"=>{"id"=>13, "key"=>"abc", "description"=>"Key to the Batmobile", "revoked_at"=>"2021-01-01T00:00:00.000Z"}}
+
+response = client.undo_revoke_api_key(api_key_id)
+
+puts response
+# sample output: {"key"=>{"id"=>13, "key"=>"abc", "description"=>"Key to the Batmobile", "revoked_at"=>nil}}
+
+response = client.list_api_keys
+
+puts response
+# sample output: {"keys"=>[{"id"=>13, "key"=>"abc", "description"=>"Key to the Batmobile"}]}
+
+response = client.delete_api_key(api_key_id)
+
+puts response
+# sample output: {"success"=>"OK"}

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/api_key.rb

@@ -2,22 +2,28 @@
 module DiscourseApi
   module API
     module ApiKey
-      def api
-        response = get("/admin/api.json")
-        response.body
+      def list_api_keys
+        response = get("/admin/api/keys")
+        response[:body]
       end
 
-      def generate_master_key
-        response = post("/admin/api/key")
+      def create_api_key(args)
+        args = API.params(args)
+          .required(:key)
+          .to_h
+        post("/admin/api/keys", args)
       end
 
       def revoke_api_key(id)
-        response = delete("/admin/api/key", id: id)
+        post("/admin/api/keys/#{id}/revoke")
       end
 
-      def regenerate_api_key(id)
-        response = put("/admin/api/key", id: id)
-        response.body
+      def undo_revoke_api_key(id)
+        post("/admin/api/keys/#{id}/undo-revoke")
+      end
+
+      def delete_api_key(id)
+        delete("/admin/api/keys/#{id}")
       end
     end
   end

data/lib/discourse_api/api/categories.rb

@@ -10,7 +10,8 @@ module DiscourseApi
           .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)
+                             :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)
         response['category']
@@ -22,7 +23,8 @@ module DiscourseApi
           .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)
+                             :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)
         response['body']['category'] if response['body']
@@ -34,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
@@ -47,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)
@@ -73,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