discourse_api 1.0.0 → 2.0.0

data/lib/discourse_api/api/groups.rb

@@ -3,83 +3,83 @@ module DiscourseApi
   module API
     module Groups
       def create_group(args)
-        args = API.params(args)
-          .required(:name)
-          .default(visibility_level: 0)
-          .optional(:mentionable_level,
-                            :messageable_level,
-                            :automatic_membership_email_domains,
-                            :automatic_membership_retroactive,
-                            :title,
-                            :primary_group,
-                            :grant_trust_level,
-                            :incoming_email,
-                            :flair_url,
-                            :flair_bg_color,
-                            :flair_color,
-                            :bio_raw,
-                            :members_visibility_level,
-                            :public_admission,
-                            :public_exit,
-                            :allow_membership_requests,
-                            :full_name,
-                            :default_notification_level,
-                            :usernames,
-                            :owner_usernames,
-                            :membership_request_template)
-          .to_h
+        args =
+          API
+            .params(args)
+            .required(:name)
+            .default(visibility_level: 0)
+            .optional(
+              :mentionable_level,
+              :messageable_level,
+              :automatic_membership_email_domains,
+              :automatic_membership_retroactive,
+              :title,
+              :primary_group,
+              :grant_trust_level,
+              :incoming_email,
+              :flair_url,
+              :flair_bg_color,
+              :flair_color,
+              :bio_raw,
+              :members_visibility_level,
+              :public_admission,
+              :public_exit,
+              :allow_membership_requests,
+              :full_name,
+              :default_notification_level,
+              :usernames,
+              :owner_usernames,
+              :membership_request_template,
+            )
+            .to_h
         post("/admin/groups", group: args)
       end
 
       def update_group(group_id, args)
-        args = API.params(args)
-          .default(visibility_level: 0)
-          .optional(:mentionable_level,
-                            :messageable_level,
-                            :name,
-                            :automatic_membership_email_domains,
-                            :title,
-                            :primary_group,
-                            :grant_trust_level,
-                            :incoming_email,
-                            :flair_url,
-                            :flair_bg_color,
-                            :flair_color,
-                            :bio_raw,
-                            :visibility_level,
-                            :public_admission,
-                            :public_exit,
-                            :allow_membership_requests,
-                            :full_name,
-                            :default_notification_level,
-                            :membership_request_template)
-          .to_h
+        args =
+          API
+            .params(args)
+            .default(visibility_level: 0)
+            .optional(
+              :mentionable_level,
+              :messageable_level,
+              :name,
+              :automatic_membership_email_domains,
+              :title,
+              :primary_group,
+              :grant_trust_level,
+              :incoming_email,
+              :flair_url,
+              :flair_bg_color,
+              :flair_color,
+              :bio_raw,
+              :visibility_level,
+              :public_admission,
+              :public_exit,
+              :allow_membership_requests,
+              :full_name,
+              :default_notification_level,
+              :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
+        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
+        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)
-          .to_h
+        params = API.params(args).optional(:page).to_h
 
         url = "/groups.json"
-        if params.include?(:page)
-          url += "?page=#{params[:page]}"
-        end
+        url += "?page=#{params[:page]}" if params.include?(:page)
         response = get(url)
         response.body
       end
@@ -92,12 +92,10 @@ module DiscourseApi
       def group_add(group_id, users)
         users.keys.each do |key|
           # Accept arrays and convert to comma-delimited string.
-          if users[key].respond_to? :join
-            users[key] = users[key].join(",")
-          end
+          users[key] = users[key].join(",") if users[key].respond_to? :join
 
           # Accept non-plural user_id or username, but send pluralized version in the request.
-          if key.to_s[-1] != 's'
+          if key.to_s[-1] != "s"
             users["#{key}s"] = users[key]
             users.delete(key)
           end
@@ -109,12 +107,10 @@ module DiscourseApi
       def group_remove(group_id, users)
         users.keys.each do |key|
           # Accept arrays and convert to comma-delimited string.
-          if users[key].respond_to? :join
-            users[key] = users[key].join(",")
-          end
+          users[key] = users[key].join(",") if users[key].respond_to? :join
 
           # Accept non-plural user_id or username, but send pluralized version in the request.
-          if key.to_s[-1] != 's'
+          if key.to_s[-1] != "s"
             users["#{key}s"] = users[key]
             users.delete(key)
           end
@@ -129,21 +125,20 @@ module DiscourseApi
 
       def group_members(group_name, params = {})
         options = params
-        params = API.params(params)
-          .optional(:offset, :limit)
-          .default(offset: 0, limit: 100)
-          .to_h
+        params = API.params(params).optional(:offset, :limit).default(offset: 0, limit: 100).to_h
         response = get("/groups/#{group_name}/members.json", params)
 
         if options[:all] == true
           response.body
         else
-          response.body['members']
+          response.body["members"]
         end
       end
 
       def group_set_user_notification_level(group, user_id, notification_level)
-        post("/groups/#{group}/notifications?user_id=#{user_id}&notification_level=#{notification_level}")
+        post(
+          "/groups/#{group}/notifications?user_id=#{user_id}&notification_level=#{notification_level}",
+        )
       end
     end
   end

data/lib/discourse_api/api/invite.rb

@@ -3,34 +3,31 @@ module DiscourseApi
   module API
     module Invite
       def invite_user(params = {})
-        args = API.params(params)
-          .optional(
-            :email,
-            :skip_email,
-            :custom_message,
-            :max_redemptions_allowed,
-            :topic_id,
-            :group_ids,
-            :expires_at
-          ).to_h
+        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 = {})
-        deprecated(__method__, 'invite_to_topic')
+        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
+        args = API.params(params).optional(:email, :user, :group_ids, :custom_message).to_h
 
         post("/t/#{topic_id}/invite", args)
       end
@@ -49,17 +46,20 @@ module DiscourseApi
       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
+        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
@@ -73,7 +73,7 @@ module DiscourseApi
       end
 
       def resend_invite(email)
-        post("invites/reinvite", { "email": email })
+        post("invites/reinvite", { email: email })
       end
 
       def destroy_invite(invite_id)

data/lib/discourse_api/api/notifications.rb

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

data/lib/discourse_api/api/params.rb

@@ -28,31 +28,21 @@ module DiscourseApi
       end
 
       def default(args)
-        args.each do |k, v|
-          @defaults[k] = v
-        end
+        args.each { |k, v| @defaults[k] = v }
         self
       end
 
       def to_h
         h = {}
 
-        @required.each do |k|
-          h[k] = @args[k]
-        end
+        @required.each { |k| h[k] = @args[k] }
 
-        @optional.each do |k|
-          h[k] = @args[k] if @args.include?(k)
-        end
+        @optional.each { |k| h[k] = @args[k] if @args.include?(k) }
 
-        @defaults.each do |k, v|
-          @args.key?(k) ? h[k] = @args[k] : h[k] = v
-        end
+        @defaults.each { |k, v| @args.key?(k) ? h[k] = @args[k] : h[k] = v }
 
         h
-
       end
     end
-
   end
 end

data/lib/discourse_api/api/polls.rb

@@ -4,28 +4,25 @@ module DiscourseApi
   module API
     module Polls
       def poll_vote(args)
-        args = API.params(args)
-          .required(:post_id, :poll_name, :options)
-          .optional(:created_at)
+        args = API.params(args).required(:post_id, :poll_name, :options).optional(:created_at)
         put("/polls/vote", args)
       end
 
       def toggle_poll_status(args)
-        args = API.params(args)
-          .required(:post_id, :poll_name, :status)
-          .optional(:api_username)
-          .optional(:raise_errors)
-            put("/polls/toggle_status", args)
+        args =
+          API
+            .params(args)
+            .required(:post_id, :poll_name, :status)
+            .optional(:api_username)
+            .optional(:raise_errors)
+        put("/polls/toggle_status", args)
       end
 
       def poll_voters(args)
-        args = API.params(args)
-          .required(:post_id, :poll_name)
-          .optional(:opts)
+        args = API.params(args).required(:post_id, :poll_name).optional(:opts)
         response = get("/polls/voters.json", args)
         response[:body]
       end
-
     end
   end
 end

data/lib/discourse_api/api/posts.rb

@@ -3,21 +3,17 @@ module DiscourseApi
   module API
     module Posts
       def create_post(args)
-        args = API.params(args)
-          .required(:topic_id, :raw)
-          .optional(:created_at, :api_username)
+        args = API.params(args).required(:topic_id, :raw).optional(:created_at, :api_username)
         post("/posts", args)
       end
 
       def create_post_action(args)
-        args = API.params(args)
-          .required(:id, :post_action_type_id)
+        args = API.params(args).required(:id, :post_action_type_id)
         post("/post_actions", args.to_h.merge(flag_topic: false))
       end
 
       def get_post(id, args = {})
-        args = API.params(args)
-          .optional(:version)
+        args = API.params(args).optional(:version)
         response = get("/posts/#{id}.json", args)
         response[:body]
       end
@@ -45,7 +41,8 @@ module DiscourseApi
       end
 
       def post_action_users(post_id, post_action_type_id)
-        response = get("/post_action_users.json", id: post_id, post_action_type_id: post_action_type_id)
+        response =
+          get("/post_action_users.json", id: post_id, post_action_type_id: post_action_type_id)
         response[:body]
       end
     end

data/lib/discourse_api/api/private_messages.rb

@@ -2,10 +2,9 @@
 module DiscourseApi
   module API
     module PrivateMessages
-
       # TODO: Deprecated. Remove after 20220628
       def create_private_message(args = {})
-        deprecated(__method__, 'create_pm')
+        deprecated(__method__, "create_pm")
         args[:target_recipients] = args.delete :target_usernames
         create_pm(args.to_h)
       end
@@ -14,21 +13,23 @@ module DiscourseApi
       # :category OPTIONAL name of category, not ID
       # :created_at OPTIONAL seconds since epoch.
       def create_pm(args = {})
-        args[:archetype] = 'private_message'
-        args = API.params(args)
-          .required(:title, :raw, :target_recipients, :archetype)
-          .optional(:category, :created_at, :api_username)
+        args[:archetype] = "private_message"
+        args =
+          API
+            .params(args)
+            .required(:title, :raw, :target_recipients, :archetype)
+            .optional(:category, :created_at, :api_username)
         post("/posts", args.to_h)
       end
 
       def private_messages(username, *args)
         response = get("topics/private-messages/#{username}.json", args)
-        response[:body]['topic_list']['topics']
+        response[:body]["topic_list"]["topics"]
       end
 
       def sent_private_messages(username, *args)
         response = get("topics/private-messages-sent/#{username}.json", args)
-        response[:body]['topic_list']['topics']
+        response[:body]["topic_list"]["topics"]
       end
     end
   end

data/lib/discourse_api/api/search.rb

@@ -10,9 +10,9 @@ module DiscourseApi
       # @return [Array] Return results as an array of Hashes.
       def search(term, options = {})
         raise ArgumentError.new("#{term} is required but not specified") unless term
-        raise ArgumentError.new("#{term} is required but not specified") unless !term.empty?
+        raise ArgumentError.new("#{term} is required but not specified") if term.empty?
 
-        response = get('/search', options.merge(q: term))
+        response = get("/search", options.merge(q: term))
         response[:body]
       end
     end

data/lib/discourse_api/api/topics.rb

@@ -7,15 +7,16 @@ module DiscourseApi
       # :auto_track OPTIONAL boolean
       # :created_at OPTIONAL seconds since epoch.
       def create_topic(args = {})
-        args = API.params(args)
-          .required(:title, :raw)
-          .optional(:skip_validations, :category, :auto_track, :created_at, :api_username, :tags)
+        args =
+          API
+            .params(args)
+            .required(:title, :raw)
+            .optional(:skip_validations, :category, :auto_track, :created_at, :api_username, :tags)
         post("/posts", args.to_h)
       end
 
       def create_topic_action(args)
-        args = API.params(args)
-          .required(:id, :post_action_type_id)
+        args = API.params(args).required(:id, :post_action_type_id)
         post("/post_actions", args.to_h.merge(flag_topic: true))
       end
 
@@ -25,18 +26,18 @@ module DiscourseApi
       end
 
       def latest_topics(params = {})
-        response = get('/latest.json', params)
-        response[:body]['topic_list']['topics']
+        response = get("/latest.json", params)
+        response[:body]["topic_list"]["topics"]
       end
 
       def top_topics(params = {})
         response = get("/top.json", params)
-        response[:body]['topic_list']['topics']
+        response[:body]["topic_list"]["topics"]
       end
 
       def new_topics(params = {})
         response = get("/new.json", params)
-        response[:body]['topic_list']['topics']
+        response[:body]["topic_list"]["topics"]
       end
 
       def rename_topic(topic_id, title)
@@ -49,14 +50,12 @@ module DiscourseApi
 
       # TODO: Deprecated. Remove after 20201231
       def change_topic_status(topic_slug, topic_id, params = {})
-        deprecated(__method__, 'update_topic_status')
+        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)
+        params = API.params(params).required(:status, :enabled).optional(:api_username)
         put("/t/#{topic_id}/status", params)
       end
 
@@ -67,7 +66,7 @@ module DiscourseApi
 
       def topics_by(username, params = {})
         response = get("/topics/created-by/#{username}.json", params)
-        response[:body]['topic_list']['topics']
+        response[:body]["topic_list"]["topics"]
       end
 
       def delete_topic(id)
@@ -75,8 +74,9 @@ module DiscourseApi
       end
 
       def topic_posts(topic_id, post_ids = [], params = {})
-        params = API.params(params)
-          .optional(:asc,
+        params =
+          API.params(params).optional(
+            :asc,
             :filter,
             :include_raw,
             :include_suggested,
@@ -86,23 +86,21 @@ module DiscourseApi
 
         url = ["/t/#{topic_id}/posts.json"]
         if post_ids.count > 0
-          url.push('?')
-          url.push(post_ids.map { |id| "post_ids[]=#{id}" }.join('&'))
+          url.push("?")
+          url.push(post_ids.map { |id| "post_ids[]=#{id}" }.join("&"))
         end
         response = get(url.join, params)
         response[:body]
       end
 
       def change_owner(topic_id, params = {})
-        params = API.params(params)
-          .required(:username, :post_ids)
+        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)
+        params = API.params(params).required(:notification_level)
         post("/t/#{topic_id}/notifications", params)
       end
 

data/lib/discourse_api/api/uploads.rb

@@ -3,11 +3,13 @@ module DiscourseApi
   module API
     module Uploads
       def upload_file(args)
-        args = API.params(args)
-          .optional(:file, :url, :user_id)
-          .default(type: 'composer', synchronous: true)
-          .to_h
-        post('/uploads', args)
+        args =
+          API
+            .params(args)
+            .optional(:file, :url, :user_id)
+            .default(type: "composer", synchronous: true)
+            .to_h
+        post("/uploads", args)
       end
     end
   end

data/lib/discourse_api/api/user_actions.rb

@@ -3,13 +3,13 @@ module DiscourseApi
   module API
     module UserActions
       def user_replies(username)
-        params = { "username": username, "filter": '5' }
+        params = { username: username, filter: "5" }
         response = get("/user_actions.json", params)
         response.body["user_actions"]
       end
 
       def user_topics_and_replies(username)
-        params = { "username": username, "filter": "4,5" }
+        params = { username: username, filter: "4,5" }
         response = get("/user_actions.json", params)
         response.body["user_actions"]
       end