discourse_api 1.1.0 → 2.0.0

data/examples/notifications.rb

@@ -1,12 +1,12 @@
 # frozen_string_literal: true
-$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
-require File.expand_path('../../lib/discourse_api', __FILE__)
+$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"
+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)
@@ -15,4 +15,4 @@ client.category_set_user_notification_level(1, notification_level: 3)
 client.topic_set_user_notification_level(1, notification_level: 0)
 
 # get user notifications
-client.notifications(username: 'discourse')
+client.notifications(username: "discourse")

data/examples/polls.rb

@@ -1,20 +1,20 @@
 # frozen_string_literal: true
 
-$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
-require File.expand_path('../../lib/discourse_api', __FILE__)
+$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"
+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"
 
-options = ['8b4736b1ae3dfb5a28088530f036f9e5']
-poll_option_votes = client.poll_vote post_id: 5, poll_name: 'poll', options: options
-puts poll_option_votes.body['vote']
+options = ["8b4736b1ae3dfb5a28088530f036f9e5"]
+poll_option_votes = client.poll_vote post_id: 5, poll_name: "poll", options: options
+puts poll_option_votes.body["vote"]
 
-poll_option_votes = client.toggle_poll_status(post_id: 5, poll_name: 'poll', status: 'closed')
-puts poll_option_votes[:body]['poll']['status']
+poll_option_votes = client.toggle_poll_status(post_id: 5, poll_name: "poll", status: "closed")
+puts poll_option_votes[:body]["poll"]["status"]
 
-poll_option_votes = client.poll_voters(post_id: 5, poll_name: 'poll')
-puts poll_option_votes['voters']
+poll_option_votes = client.poll_voters(post_id: 5, poll_name: "poll")
+puts poll_option_votes["voters"]

data/examples/post_action.rb

@@ -1,12 +1,12 @@
 # frozen_string_literal: true
-$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
-require File.expand_path('../../lib/discourse_api', __FILE__)
+$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"
+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"
 
 # Post Action Type IDs
 # 1 - Bookmark

data/examples/search.rb

@@ -1,12 +1,12 @@
 # frozen_string_literal: true
-$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
-require File.expand_path('../../lib/discourse_api', __FILE__)
+$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"
+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"
 
 # search for term
 puts client.search("discourse")

data/examples/sent_private_messages.rb

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
-$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
-require File.expand_path('../../lib/discourse_api', __FILE__)
+$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"
+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"
 
-client.sent_private_messages('test_user')
+client.sent_private_messages("test_user")

data/examples/sso.rb

@@ -1,17 +1,17 @@
 # frozen_string_literal: true
-$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
-require File.expand_path('../../lib/discourse_api', __FILE__)
+$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"
+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"
 
 client.sync_sso(
   sso_secret: "discourse_sso_rocks",
   name: "Test Name",
   username: "test_name",
   email: "name@example.com",
-  external_id: "2"
+  external_id: "2",
 )

data/examples/topic_lists.rb

@@ -1,12 +1,12 @@
 # frozen_string_literal: true
-$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
-require File.expand_path('../../lib/discourse_api', __FILE__)
+$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"
+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"
 
 # get latest topics
 puts client.latest_topics({})

data/examples/update_user.rb

@@ -1,12 +1,12 @@
 # frozen_string_literal: true
-$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
-require File.expand_path('../../lib/discourse_api', __FILE__)
+$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"
+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"
 
 # update username from "robin" to "batman"
 puts client.update_username("robin", "batman")
@@ -15,11 +15,19 @@ puts client.update_user("batman", name: "Bruce Wayne")
 # update email of user whose username is "batman"
 puts client.update_email("batman", "batman@gotham.com")
 # update avatar of user whose username is "batman"
-puts client.update_avatar(username: "batman", url: "http://meta-discourse.r.worldssl.net/uploads/default/2497/724a6ef2e79d2bc7.png")
+puts client.update_avatar(
+       username: "batman",
+       url: "http://meta-discourse.r.worldssl.net/uploads/default/2497/724a6ef2e79d2bc7.png",
+     )
 # update trust level of user whose id is "102"
 puts client.update_trust_level(user_id: 102, level: 2)
 # update user bio, location or website
-puts client.update_user("batman", bio_raw: "I am Batman.", location: "Gotham", website: "https://en.wikipedia.org/wiki/Batman")
+puts client.update_user(
+       "batman",
+       bio_raw: "I am Batman.",
+       location: "Gotham",
+       website: "https://en.wikipedia.org/wiki/Batman",
+     )
 
 # log out everywhere and refresh browser of user whose id is "2"
 puts client.log_out(2)

data/examples/upload_file.rb

@@ -1,16 +1,16 @@
 # frozen_string_literal: true
-$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
-require File.expand_path('../../lib/discourse_api', __FILE__)
+$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"
+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"
 
 # Upload a file
-file = Faraday::UploadIO.new('grumpy_cat.pdf', "application/pdf")
+file = Faraday::UploadIO.new("grumpy_cat.pdf", "application/pdf")
 client.upload_file(file: file)
 
 # Upload a file via URL
-client.upload_file(url: 'https://giphy.com/grumpy_cat.gif')
+client.upload_file(url: "https://giphy.com/grumpy_cat.gif")

data/lib/discourse_api/api/api_key.rb

@@ -8,9 +8,7 @@ module DiscourseApi
       end
 
       def create_api_key(args)
-        args = API.params(args)
-          .required(:key)
-          .to_h
+        args = API.params(args).required(:key).to_h
         post("/admin/api/keys", args)
       end
 

data/lib/discourse_api/api/backups.rb

@@ -18,7 +18,7 @@ module DiscourseApi
       def download_backup(file_name, destination)
         response = get("/admin/backups/#{file_name}")
         # write file
-        File.open("#{destination}/#{file_name}", 'wb') { |fp| fp.write(response.body) }
+        File.open("#{destination}/#{file_name}", "wb") { |fp| fp.write(response.body) }
       end
     end
   end

data/lib/discourse_api/api/badges.rb

@@ -9,7 +9,7 @@ module DiscourseApi
 
       def user_badges(username)
         response = get("/user-badges/#{username}.json")
-        response.body['badges']
+        response.body["badges"]
       end
 
       def grant_user_badge(params = {})
@@ -17,11 +17,26 @@ module DiscourseApi
       end
 
       def create_badge(params = {})
-        args = API.params(params)
-          .required(:name, :badge_type_id)
-          .optional(:description, :allow_title, :multiple_grant, :icon, :listable,
-                            :target_posts, :query, :enabled, :auto_revoke, :badge_grouping_id,
-                            :trigger, :show_posts, :image, :long_description)
+        args =
+          API
+            .params(params)
+            .required(:name, :badge_type_id)
+            .optional(
+              :description,
+              :allow_title,
+              :multiple_grant,
+              :icon,
+              :listable,
+              :target_posts,
+              :query,
+              :enabled,
+              :auto_revoke,
+              :badge_grouping_id,
+              :trigger,
+              :show_posts,
+              :image,
+              :long_description,
+            )
         post("/admin/badges.json", args)
       end
     end

data/lib/discourse_api/api/categories.rb

@@ -6,71 +6,105 @@ module DiscourseApi
       # :permissions is a hash with the group name and permission_type which is
       # an integer 1 = Full 2 = Create Post 3 = Read Only
       def create_category(args = {})
-        args = API.params(args)
-          .required(:name, :color, :text_color)
-          .optional(:slug, :permissions, :auto_close_hours, :auto_close_based_on_last_post, :position, :email_in,
-                             :email_in_allow_strangers, :logo_url, :background_url, :allow_badges, :topic_template, :custom_fields, :description,
-                             :reviewable_by_group_name, :show_subcategory_list, :subcategory_list_style,
-                             :allowed_tags, :allowed_tag_groups, :required_tag_group_name)
-          .default(parent_category_id: nil)
+        args =
+          API
+            .params(args)
+            .required(:name, :color, :text_color)
+            .optional(
+              :slug,
+              :permissions,
+              :auto_close_hours,
+              :auto_close_based_on_last_post,
+              :position,
+              :email_in,
+              :email_in_allow_strangers,
+              :logo_url,
+              :background_url,
+              :allow_badges,
+              :topic_template,
+              :custom_fields,
+              :description,
+              :reviewable_by_group_name,
+              :show_subcategory_list,
+              :subcategory_list_style,
+              :allowed_tags,
+              :allowed_tag_groups,
+              :required_tag_group_name,
+            )
+            .default(parent_category_id: nil)
         response = post("/categories", args)
-        response['category']
+        response["category"]
       end
 
       def update_category(args = {})
         category_id = args[:id]
-        args = API.params(args)
-          .required(:id, :name, :color, :text_color)
-          .optional(:slug, :permissions, :auto_close_hours, :auto_close_based_on_last_post, :position, :email_in,
-                             :email_in_allow_strangers, :logo_url, :background_url, :allow_badges, :topic_template, :custom_fields, :description,
-                             :reviewable_by_group_name, :show_subcategory_list, :subcategory_list_style,
-                             :allowed_tags, :allowed_tag_groups, :required_tag_group_name)
-          .default(parent_category_id: nil)
+        args =
+          API
+            .params(args)
+            .required(:id, :name, :color, :text_color)
+            .optional(
+              :slug,
+              :permissions,
+              :auto_close_hours,
+              :auto_close_based_on_last_post,
+              :position,
+              :email_in,
+              :email_in_allow_strangers,
+              :logo_url,
+              :background_url,
+              :allow_badges,
+              :topic_template,
+              :custom_fields,
+              :description,
+              :reviewable_by_group_name,
+              :show_subcategory_list,
+              :subcategory_list_style,
+              :allowed_tags,
+              :allowed_tag_groups,
+              :required_tag_group_name,
+            )
+            .default(parent_category_id: nil)
         response = put("/categories/#{category_id}", args)
-        response['body']['category'] if response['body']
+        response["body"]["category"] if response["body"]
       end
 
       def delete_category(id)
         response = delete("/categories/#{id}")
-        response[:body]['success']
+        response[:body]["success"]
       end
 
       def categories(params = {})
-        categories_full(params)['category_list']['categories']
+        categories_full(params)["category_list"]["categories"]
       end
 
       def categories_full(params = {})
-        response = get('/categories.json', params)
+        response = get("/categories.json", params)
         response[:body]
       end
 
       def category_latest_topics(args = {})
         response = category_latest_topics_full(args)
-        if response['errors']
-          response['errors']
+        if response["errors"]
+          response["errors"]
         else
-          response['topic_list']['topics']
+          response["topic_list"]["topics"]
         end
       end
 
       def category_latest_topics_full(args = {})
-        params = API.params(args)
-          .required(:category_slug)
-          .optional(:page).to_h
+        params = API.params(args).required(:category_slug).optional(:page).to_h
         url = "/c/#{params[:category_slug]}/l/latest.json"
-        if params.include?(:page)
-          url = "#{url}?page=#{params[:page]}"
-        end
+        url = "#{url}?page=#{params[:page]}" if params.include?(:page)
         response = get(url)
         response[:body]
       end
 
       def category_top_topics(category_slug)
         response = category_top_topics_full(category_slug)
-        if response['errors']
-          response['errors']
+        if response["errors"]
+          response["errors"]
         else
-          response['topic_list']['topics']
+          response["topic_list"]["topics"]
         end
       end
 
@@ -81,7 +115,7 @@ module DiscourseApi
 
       def category_new_topics(category_slug)
         response = category_new_topics_full(category_slug)
-        response['topic_list']['topics']
+        response["topic_list"]["topics"]
       end
 
       def category_new_topics_full(category_slug)
@@ -91,20 +125,18 @@ module DiscourseApi
 
       def category(id)
         response = get("/c/#{id}/show")
-        response[:body]['category']
+        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)
+        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)
+        params = API.params(params).required(:notification_level)
         post("/category/#{category_id}/notifications", params)
       end
     end

data/lib/discourse_api/api/dashboard.rb

@@ -9,16 +9,12 @@ module DiscourseApi
 
       def get_dashboard_stats_totals
         stats = get_dashboard_stats
-        global_reports = stats['global_reports']
+        global_reports = stats["global_reports"]
         users = global_reports[1]
         topics = global_reports[3]
         posts = global_reports[4]
 
-        {
-          'users' => users['total'],
-          'topics' => topics['total'],
-          'posts' => posts['total'],
-        }
+        { "users" => users["total"], "topics" => topics["total"], "posts" => posts["total"] }
       end
     end
   end