discourse_api 0.44.0 → 0.45.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 13cfa5b25dbe59e809cdcdb924406f9e680f1e029a5666fff9a0febbd75d5bf0
-  data.tar.gz: d68c096a8ae91dea4a70b60f9d412954712297544e49b891fc228f11d63ca4d6
+  metadata.gz: 82cd748487d5d986f8327b702088ea4ea22c43cae311c2634dfa5d9cf4c4059f
+  data.tar.gz: a4fd68101134895f5071443f221a2327e9fe9e4a0a79df0d53a620c7e08d685d
 SHA512:
-  metadata.gz: c942a353d95a144daa1939d448c949ad56a00e0999a0166c112e403e0ce5529941e8883d7456b029a173cdc79ebf7ffc08e84cc7e2e63956434ab00a6a60abf0
-  data.tar.gz: 909bb8f30f2ae412c93d1e0a9777786b8cae01c4bd15474f5ea980c0485bb91ca82f5eb62a81773f76a05b8eeb97bde076411a0dbe61e4407c0ca2204ac5484e
+  metadata.gz: 42546f17e134cd1e4ac6be81c8fdb53cf82461d60a73859dd757c2ec69e1128127f33a131e45dfec3d910012702256a173a7a1afd2a9873dc3d8a3e220c4af1a
+  data.tar.gz: 990fc89fd2a4935704e1512b858872b41ed7a6b7ba3ef28f583ad272e0675daff74f61b9a441632a8dc92c76892b8c507e53afce356317403c7c67f31a4fab18

data/CHANGELOG.md

@@ -6,16 +6,23 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [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 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 +39,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 +68,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 +319,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

@@ -29,7 +29,7 @@ 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 'webmock', '~> 3.0'
   spec.add_development_dependency 'rubocop-discourse'
 
   spec.required_ruby_version = '>= 2.5.0'

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/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']

data/lib/discourse_api/api/topics.rb

@@ -78,6 +78,13 @@ 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
     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/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module DiscourseApi
-  VERSION = "0.44.0"
+  VERSION = "0.45.0"
 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/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"
+      }
+    }
+  ]
+}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: discourse_api
 version: !ruby/object:Gem::Version
-  version: 0.44.0
+  version: 0.45.0
 platform: ruby
 authors:
 - Sam Saffron
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-11-13 00:00:00.000000000 Z
+date: 2021-01-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -159,14 +159,14 @@ 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
@@ -216,6 +216,7 @@ files:
 - examples/group_set_user_notification_level.rb
 - examples/groups.rb
 - examples/invite_users.rb
+- examples/manage_api_keys.rb
 - examples/polls.rb
 - examples/post_action.rb
 - examples/search.rb
@@ -271,7 +272,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,11 +281,11 @@ 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
@@ -365,7 +366,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,11 +375,11 @@ 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

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
-  }
-}