discourse_api 0.42.0 → 0.45.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3ea694de473b398c706c2b61333e05663dcb69423178a6bcb25c2f6b1ac4abde
-  data.tar.gz: 85fb225fd5d9ab4aa407510a437b7b92a55f4c117b480cecbfb026c0f0b3750f
+  metadata.gz: 10c80ce6388205a855042bd1093627508e4929c6bf79902487549568af7304b0
+  data.tar.gz: 4aab3d70ba9343f6717a4e4ffce233b015565904129fd4b1244e7bdac64ef565
 SHA512:
-  metadata.gz: fbdd42c087c47c52ea91ba75d70fba75989ee6242a914f1147755d851d2645403c5f153cefbd60f04073cf34bc94e1e2fb01247204bce128538fe5b485b0b332
-  data.tar.gz: 43cf32bef0aba4d313c2d198e04be5531cc9e52bb5473ff6e6dbbfe6406090fa121c18b681e45847f4624031e0c7e004bb62443cb79a03e3fe972703b9d73410
+  metadata.gz: b37002fd695ca45872ba4b2ca09161173050f70692c8f051df737dd87370cb06c5103b51d5691807041ffbac9a0a9a1713fd74f406da192eeb8e29b41460c90a
+  data.tar.gz: 13163d2718c324780cb081aaca1e63f865e9b503bc008f4d1fbcb1145b6f3175e6621f6dbbaff14a30f8d730d9800ab6af8e3e1caee93b8baed8682d275f4b68

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

@@ -1,6 +1,36 @@
-# Change Log
+# Changelog
 All notable changes to this project will be documented in this file.
-This project adheres to [Semantic Versioning](http://semver.org/).
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [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 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.
+
+## [0.43.0] - 2020-11-04
+### Added
+- Add pagination to list groups endpoint
+### Deprecated
+- `change_topic_status` has been deprecated, use `update_topic_status` instead.
 
 ## [0.42.0] - 2020-07-09
 ### Added
@@ -9,17 +39,14 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 ## [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
 
@@ -41,7 +68,6 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 - 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
@@ -293,5 +319,4 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 - `client.category_latest_posts("category-slug")` endpoint
 
 ## [0.1.2] - 2014-05-11
-
 - Release

data/README.md

@@ -34,7 +34,6 @@ client.ssl(...)                                 #=> specify SSL connection setti
 
 # Topic endpoints
 client.latest_topics                            #=> Gets a list of the latest topics
-client.hot_topics                               #=> Gets a list of hot topics
 client.new_topics                               #=> Gets a list of new topics
 client.topics_by("sam")                         #=> Gets a list of topics created by user "sam"
 client.topic(57)                                #=> Gets the topic with id 57

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.2.3'
+  spec.required_ruby_version = '>= 2.5.0'
 end

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

@@ -16,9 +16,8 @@ response = client.create_topic(
     raw: "This is the raw markdown for my post"
 )
 
-# get topic_id and topic_slug from response
+# get topic_id from response
 topic_id = response['topic_id']
-topic_slug = response['topic_slug']
 
 ##
 # available options (guessing from reading discourse source)
@@ -28,8 +27,8 @@ topic_slug = response['topic_slug']
 
 # lock topic (note: api_username determines user that is performing action)
 params = { status: 'closed', enabled: true, api_username: "YOUR USERNAME/USERS USERNAME" }
-client.change_topic_status(topic_slug, topic_id, params)
+client.change_topic_status(topic_id, params)
 
 # unlock topic (note: api_username determines user that is performing action)
 params = { status: 'closed', enabled: false, api_username: "YOUR USERNAME/USERS USERNAME" }
-client.change_topic_status(topic_slug, topic_id, params)
+client.change_topic_status(topic_id, params)

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,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"
+
+# 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)

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

data/lib/discourse_api/api/groups.rb

@@ -60,8 +60,16 @@ module DiscourseApi
         put("/groups/#{group_id}", group: args)
       end
 
-      def groups
-        response = get("/groups.json")
+      def groups(args = {})
+        params = API.params(args)
+          .optional(:page)
+          .to_h
+
+        url = "/groups.json"
+        if params.include?(:page)
+          url += "?page=#{params[:page]}"
+        end
+        response = get(url)
         response.body
       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/tags.rb

@@ -3,7 +3,7 @@ module DiscourseApi
   module API
     module Tags
       def show_tag(tag)
-        response = get("/tags/#{tag}")
+        response = get("/tag/#{tag}")
         response[:body]
       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']
@@ -42,11 +47,17 @@ module DiscourseApi
         put("/t/#{topic_id}.json", topic_id: topic_id, category_id: category_id)
       end
 
+      # TODO: Deprecated. Remove after 20201231
       def change_topic_status(topic_slug, topic_id, params = {})
+        deprecated(__method__, 'update_topic_status')
+        update_topic_status(topic_id, params)
+      end
+
+      def update_topic_status(topic_id, params = {})
         params = API.params(params)
           .required(:status, :enabled)
           .optional(:api_username)
-        put("/t/#{topic_id}/status", params.to_h)
+        put("/t/#{topic_id}/status", params)
       end
 
       def topic(id, params = {})
@@ -72,6 +83,19 @@ module DiscourseApi
         response = get(url.join)
         response[:body]
       end
+
+      def change_owner(topic_id, params = {})
+        params = API.params(params)
+          .required(:username, :post_ids)
+
+        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
     end
   end
 end

data/lib/discourse_api/api/users.rb

@@ -52,7 +52,7 @@ module DiscourseApi
       def create_user(args)
         args = API.params(args)
           .required(:name, :email, :password, :username)
-          .optional(:active, :staged, :user_fields)
+          .optional(:active, :approved, :staged, :user_fields)
           .to_h
         post("/users", args)
       end

data/lib/discourse_api/client.rb

@@ -109,6 +109,10 @@ module DiscourseApi
       @user_agent ||= "DiscourseAPI Ruby Gem #{DiscourseApi::VERSION}"
     end
 
+    def deprecated(old, new)
+      warn "[DEPRECATED]: `#{old}` is deprecated. Please use `#{new}` instead."
+    end
+
     private
 
     def connection

data/lib/discourse_api/version.rb

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

data/spec/discourse_api/api/api_key_spec.rb

@@ -10,77 +10,101 @@ describe DiscourseApi::API::ApiKey do
     )
   }
 
-  describe "#api" do
+  describe "#list_api_keys" do
     before do
-      url = "#{host}/admin/api.json"
-      stub_get(url).to_return(body: fixture("api.json"),
+      url = "#{host}/admin/api/keys"
+      stub_get(url).to_return(body: fixture("list_api_keys.json"),
                               headers: { content_type: "application/json" })
     end
 
     it "requests the correct resource" do
-      subject.api
-      url = "#{host}/admin/api.json"
+      subject.list_api_keys
+      url = "#{host}/admin/api/keys"
       expect(a_get(url)).to have_been_made
     end
 
     it "returns the requested api keys" do
-      api = subject.api
-      expect(api).to be_an Array
-      expect(api.first).to be_a Hash
-      expect(api.first).to have_key('key')
+      keys = subject.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')
     end
   end
 
-  describe "#generate_master_key" do
+  describe "#create_api_key" do
     before do
-      url = "#{host}/admin/api/key"
-      stub_post(url).to_return(body: fixture("generate_master_key.json"),
+      url = "#{host}/admin/api/keys"
+      stub_post(url).to_return(body: fixture("api_key.json"),
                                headers: { content_type: "application/json" })
     end
 
-    it "returns the generated master key" do
-      master_key = subject.generate_master_key
-      expect(master_key).to be_a Hash
-      expect(master_key['api_key']).to have_key('key')
-      expect(master_key['api_key']['user']).to eq(nil)
+    it "requests the correct resource" do
+      subject.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' })
+      expect(api_key).to be_a Hash
+      expect(api_key['key']).to have_key('key')
     end
   end
 
   describe "#revoke_api_key" do
     before do
-      url = "#{host}/admin/api/key?id=10"
-      stub_delete(url).to_return(body: "",
-                                 headers: { content_type: "application/json" })
+      url = "#{host}/admin/api/keys/10/revoke"
+      stub_post(url).to_return(body: fixture("api_key.json"),
+                               headers: { content_type: "application/json" })
     end
 
     it "requests the correct resource" do
       subject.revoke_api_key(10)
-      url = "#{host}/admin/api/key?id=10"
-      expect(a_delete(url)).to have_been_made
+      url = "#{host}/admin/api/keys/10/revoke"
+      expect(a_post(url)).to have_been_made
     end
 
-    it "returns 200" do
-      response = subject.revoke_api_key(10)
-      expect(response['status']).to eq(200)
+    it "returns the api key" do
+      api_key = subject.revoke_api_key(10)
+      expect(api_key['key']).to have_key('key')
     end
   end
 
-  describe "#regenerate_api_key" do
+  describe "#undo_revoke_api_key" do
     before do
-      url = "#{host}/admin/api/key"
-      stub_put(url).to_return(body: fixture("regenerate_api_key.json"),
-                              headers: { content_type: "application/json" })
+      url = "#{host}/admin/api/keys/10/undo-revoke"
+      stub_post(url).to_return(body: fixture("api_key.json"),
+                               headers: { content_type: "application/json" })
     end
 
     it "requests the correct resource" do
-      subject.regenerate_api_key(10)
-      url = "#{host}/admin/api/key"
-      expect(a_put(url)).to have_been_made
+      subject.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 regenerated api key" do
-      key = subject.regenerate_api_key(10)
-      expect(key['api_key']).to have_key('key')
+    it "returns the api key" do
+      api_key = subject.undo_revoke_api_key(10)
+      expect(api_key['key']).to have_key('key')
+    end
+  end
+
+  describe "#delete_api_key" do
+    before do
+      url = "#{host}/admin/api/keys/10"
+      stub_delete(url).to_return(body: '{"success": "OK"}',
+                                 headers: { content_type: "application/json" })
+    end
+
+    it "requests the correct resource" do
+      subject.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)
+      expect(response['status']).to eq(200)
     end
   end
 end

data/spec/discourse_api/api/categories_spec.rb

@@ -28,6 +28,25 @@ describe DiscourseApi::API::Categories do
     end
   end
 
+  describe "#categories_full" do
+    before do
+      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("#{host}/categories.json")).to have_been_made
+    end
+
+    it "returns the entire categories response" do
+      categories = subject.categories_full
+      expect(categories).to be_a Hash
+      expect(categories).to have_key 'category_list'
+      expect(categories).to have_key 'featured_users'
+    end
+  end
+
   describe '#category_latest_topics' do
     before do
       stub_get("#{host}/c/category-slug/l/latest.json")
@@ -40,6 +59,20 @@ describe DiscourseApi::API::Categories do
     end
   end
 
+  describe '#category_latest_topics_full' do
+    before do
+      stub_get("#{host}/c/category-slug/l/latest.json")
+        .to_return(body: fixture("category_latest_topics.json"), headers: { content_type: "application/json" })
+    end
+
+    it "returns the entire latest topics in a category response" do
+      latest_topics = subject.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'
+    end
+  end
+
   describe '#category_top_topics' do
     before do
       stub_get("#{host}/c/category-slug/l/top.json")
@@ -55,6 +88,23 @@ describe DiscourseApi::API::Categories do
     end
   end
 
+  describe '#category_top_topics_full' do
+    before do
+      stub_get("#{host}/c/category-slug/l/top.json")
+        .to_return(
+        body: fixture("category_topics.json"),
+        headers: { content_type: "application/json" }
+      )
+    end
+
+    it "returns the entire top topics in a category response" do
+      topics = subject.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'
+    end
+  end
+
   describe '#category_new_topics' do
     before do
       stub_get("#{host}/c/category-slug/l/new.json")
@@ -70,6 +120,23 @@ describe DiscourseApi::API::Categories do
     end
   end
 
+  describe '#category_new_topics_full' do
+    before do
+      stub_get("#{host}/c/category-slug/l/new.json")
+        .to_return(
+        body: fixture("category_topics.json"),
+        headers: { content_type: "application/json" }
+      )
+    end
+
+    it "returns the new topics in a category" do
+      topics = subject.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'
+    end
+  end
+
   describe '#category_new_category' do
     before do
       stub_post("#{host}/categories")
@@ -85,4 +152,27 @@ describe DiscourseApi::API::Categories do
     end
   end
 
+  describe "#category_set_user_notification" do
+    before do
+      stub_post("#{host}/category/1/notifications").to_return(body: fixture("notification_success.json"), headers: { content_type: "application/json" })
+    end
+
+    it "makes the post request" do
+      response = subject.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
+  end
+
+  describe "#category_set_user_notification_level" do
+    before do
+      stub_post("#{host}/category/1/notifications").to_return(body: fixture("notification_success.json"), headers: { content_type: "application/json" })
+    end
+
+    it "makes the post request" do
+      response = subject.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
+      expect(response['success']).to eq('OK')
+    end
+  end
 end

data/spec/discourse_api/api/search_spec.rb

@@ -6,12 +6,12 @@ describe DiscourseApi::API::Search do
 
   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").with(query: { q: "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").with(query: { q: "test" })).to have_been_made
     end
 
     it "returns the requested search" do

data/spec/discourse_api/api/topics_spec.rb

@@ -10,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
@@ -55,6 +55,29 @@ describe DiscourseApi::API::Topics do
     end
   end
 
+  describe "#top_topics" do
+    before do
+      stub_get("#{host}/top.json").to_return(body: fixture("top.json"), headers: { content_type: "application/json" })
+    end
+
+    it "requests the correct resource" do
+      subject.top_topics
+      expect(a_get("#{host}/top.json")).to have_been_made
+    end
+
+    it "returns the requested topics" do
+      topics = subject.top_topics
+      expect(topics).to be_an Array
+      expect(topics.first).to be_a Hash
+    end
+
+    it "can take a hash param" do
+      topics = subject.top_topics({})
+      expect(topics).to be_an Array
+      expect(topics.first).to be_a Hash
+    end
+  end
+
   describe "#new_topics" do
     before do
       stub_get("#{host}/new.json").to_return(body: fixture("new.json"), headers: { content_type: "application/json" })
@@ -166,4 +189,15 @@ describe DiscourseApi::API::Topics do
     end
   end
 
+  describe "#topic_set_user_notification_level" do
+    before do
+      stub_post("#{host}/t/1/notifications").to_return(body: fixture("notification_success.json"), headers: { content_type: "application/json" })
+    end
+
+    it "makes the post request" do
+      response = subject.topic_set_user_notification_level(1, notification_level: 3)
+      expect(a_post("#{host}/t/1/notifications").with(body: "notification_level=3")).to have_been_made
+      expect(response['success']).to eq('OK')
+    end
+  end
 end

data/spec/fixtures/api_key.json

@@ -0,0 +1,12 @@
+{
+  "key": {
+    "id": 5,
+    "key": "e722e04df8cf6d097d565ca04eea1ff8e9e8f09beb405bae6f0c79852916f334",
+    "user": {
+      "id": 2,
+      "username": "robin",
+      "uploaded_avatar_id": 3,
+      "avatar_template": "/user_avatar/localhost/robin/{size}/3.png"
+    }
+  }
+}

data/spec/fixtures/list_api_keys.json

@@ -0,0 +1,14 @@
+{
+  "keys": [
+    {
+      "id": 1,
+      "key": "test_d7fd0429940",
+      "user": {
+        "id": 1,
+        "username": "test_user",
+        "uploaded_avatar_id": 7,
+        "avatar_template": "/user_avatar/localhost/test_user/{size}/7.png"
+      }
+    }
+  ]
+}

data/spec/fixtures/notification_success.json

@@ -0,0 +1,3 @@
+{
+  "success": "OK"
+}

data/spec/fixtures/top.json

@@ -0,0 +1,108 @@
+{
+  "topic_list": {
+    "can_create_topic": false,
+    "more_topics_url": "/latest.json?page=1",
+    "draft": null,
+    "draft_key": "new_topic",
+    "draft_sequence": null,
+    "topics": [
+      {
+        "id": 1,
+        "title": "Test topic #1",
+        "fancy_title": "Test topic #1",
+        "slug": "test-topic-1",
+        "posts_count": 1,
+        "reply_count": 0,
+        "highest_post_number": 1,
+        "image_url": null,
+        "created_at": "2013-02-04T15:26:25.977-05:00",
+        "last_posted_at": "2013-02-05T12:14:17.364-05:00",
+        "bumped": true,
+        "bumped_at": "2013-02-07T13:43:11.191-05:00",
+        "unseen": false,
+        "pinned": true,
+        "excerpt": "Welcome! \n\nTry is a sandbox, a safe place to play with Discourse and its features.\n\nThis site is reset every day (or even more often). Any accounts or posts you create here will not exist tomorrow! \n\nFeel free to experim…",
+        "visible": true,
+        "closed": false,
+        "archived": false,
+        "views": 268,
+        "like_count": 14,
+        "has_best_of": false,
+        "archetype": "regular",
+        "last_poster_username": "test_user",
+        "category_id": 1,
+        "posters": [
+          {
+            "extras": null,
+            "description": "Original Poster, Most Recent Poster",
+            "user_id": 1
+          }
+        ]
+      },
+      {
+        "id": 1,
+        "title": "Test topic #2",
+        "fancy_title": "Test topic #2",
+        "slug": "test-topic-1",
+        "posts_count": 1,
+        "reply_count": 0,
+        "highest_post_number": 2,
+        "image_url": null,
+        "created_at": "2013-11-06T13:57:47.984-05:00",
+        "last_posted_at": "2013-11-06T13:57:48.111-05:00",
+        "bumped": true,
+        "bumped_at": "2013-11-06T13:57:48.111-05:00",
+        "unseen": false,
+        "pinned": false,
+        "visible": true,
+        "closed": false,
+        "archived": false,
+        "views": 1,
+        "like_count": 0,
+        "has_best_of": false,
+        "archetype": "regular",
+        "last_poster_username": "test_user",
+        "category_id": 1,
+        "posters": [
+          {
+            "extras": null,
+            "description": "Original Poster, Most Recent Poster",
+            "user_id": 1
+          }
+        ]
+      },
+      {
+        "id": 1,
+        "title": "Test topic #3",
+        "fancy_title": "Test topic #3",
+        "slug": "test-topic-3",
+        "posts_count": 1,
+        "reply_count": 0,
+        "highest_post_number": 1,
+        "image_url": null,
+        "created_at": "2013-02-04T21:46:58.194-05:00",
+        "last_posted_at": "2013-11-06T13:56:27.753-05:00",
+        "bumped": true,
+        "bumped_at": "2013-11-06T13:56:27.753-05:00",
+        "unseen": false,
+        "pinned": false,
+        "visible": true,
+        "closed": false,
+        "archived": false,
+        "views": 82,
+        "like_count": 10,
+        "has_best_of": false,
+        "archetype": "regular",
+        "last_poster_username": "test_user",
+        "category_id": 1,
+        "posters": [
+          {
+            "extras": null,
+            "description": "Original Poster, Most Recent Poster",
+            "user_id": 1
+          }
+        ]
+      }
+    ]
+  }
+}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: discourse_api
 version: !ruby/object:Gem::Version
-  version: 0.42.0
+  version: 0.45.1
 platform: ruby
 authors:
 - Sam Saffron
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-09 00:00:00.000000000 Z
+date: 2021-03-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -159,28 +159,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: rubocop-discourse
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.4.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.4.1
 description: Discourse API
 email:
 - sam.saffron@gmail.com
@@ -216,6 +216,8 @@ files:
 - examples/group_set_user_notification_level.rb
 - examples/groups.rb
 - examples/invite_users.rb
+- examples/manage_api_keys.rb
+- examples/notifications.rb
 - examples/polls.rb
 - examples/post_action.rb
 - examples/search.rb
@@ -271,7 +273,7 @@ files:
 - spec/discourse_api/api/users_spec.rb
 - spec/discourse_api/client_spec.rb
 - spec/fixtures/admin_user.json
-- spec/fixtures/api.json
+- spec/fixtures/api_key.json
 - spec/fixtures/backups.json
 - spec/fixtures/badges.json
 - spec/fixtures/categories.json
@@ -280,15 +282,16 @@ files:
 - spec/fixtures/create_topic_with_tags.json
 - spec/fixtures/email_list_all.json
 - spec/fixtures/email_settings.json
-- spec/fixtures/generate_master_key.json
 - spec/fixtures/group.json
 - spec/fixtures/groups.json
 - spec/fixtures/hot.json
 - spec/fixtures/latest.json
+- spec/fixtures/list_api_keys.json
 - spec/fixtures/members_0.json
 - spec/fixtures/members_1.json
 - spec/fixtures/members_2.json
 - spec/fixtures/new.json
+- spec/fixtures/notification_success.json
 - spec/fixtures/notifications.json
 - spec/fixtures/polls_toggle_status.json
 - spec/fixtures/polls_vote.json
@@ -302,6 +305,7 @@ files:
 - spec/fixtures/replies.json
 - spec/fixtures/replies_and_topics.json
 - spec/fixtures/search.json
+- spec/fixtures/top.json
 - spec/fixtures/topic.json
 - spec/fixtures/topic_invite_user.json
 - spec/fixtures/topic_posts.json
@@ -333,14 +337,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.2.3
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Allows access to the Discourse API
@@ -365,7 +369,7 @@ test_files:
 - spec/discourse_api/api/users_spec.rb
 - spec/discourse_api/client_spec.rb
 - spec/fixtures/admin_user.json
-- spec/fixtures/api.json
+- spec/fixtures/api_key.json
 - spec/fixtures/backups.json
 - spec/fixtures/badges.json
 - spec/fixtures/categories.json
@@ -374,15 +378,16 @@ test_files:
 - spec/fixtures/create_topic_with_tags.json
 - spec/fixtures/email_list_all.json
 - spec/fixtures/email_settings.json
-- spec/fixtures/generate_master_key.json
 - spec/fixtures/group.json
 - spec/fixtures/groups.json
 - spec/fixtures/hot.json
 - spec/fixtures/latest.json
+- spec/fixtures/list_api_keys.json
 - spec/fixtures/members_0.json
 - spec/fixtures/members_1.json
 - spec/fixtures/members_2.json
 - spec/fixtures/new.json
+- spec/fixtures/notification_success.json
 - spec/fixtures/notifications.json
 - spec/fixtures/polls_toggle_status.json
 - spec/fixtures/polls_vote.json
@@ -396,6 +401,7 @@ test_files:
 - spec/fixtures/replies.json
 - spec/fixtures/replies_and_topics.json
 - spec/fixtures/search.json
+- spec/fixtures/top.json
 - spec/fixtures/topic.json
 - spec/fixtures/topic_invite_user.json
 - spec/fixtures/topic_posts.json

data/spec/fixtures/api.json

@@ -1,12 +0,0 @@
-[
-  {
-    "id": 1,
-    "key": "test_d7fd0429940",
-    "user": {
-      "id": 1,
-      "username": "test_user",
-      "uploaded_avatar_id": 7,
-      "avatar_template": "/user_avatar/localhost/test_user/{size}/7.png"
-    }
-  }
-]

data/spec/fixtures/generate_master_key.json

@@ -1,7 +0,0 @@
-{
-  "api_key": {
-    "id": 10,
-    "key": "c999afe41d3a6ed0798a13ef69f90c4cc7d38120818c4a098e402bc5e5ef2085",
-    "user": null
-  }
-}