discourse_api 0.34.0 → 0.35.0

data/lib/discourse_api/api/email.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module DiscourseApi
   module API
     module Email

data/lib/discourse_api/api/groups.rb

@@ -1,11 +1,12 @@
+# frozen_string_literal: true
 module DiscourseApi
   module API
     module Groups
       def create_group(args)
         args = API.params(args)
-                  .required(:name)
-                  .default(visibility_level: 0)
-                  .optional(:mentionable_level,
+          .required(:name)
+          .default(visibility_level: 0)
+          .optional(:mentionable_level,
                             :messageable_level,
                             :automatic_membership_email_domains,
                             :automatic_membership_retroactive,
@@ -25,14 +26,14 @@ module DiscourseApi
                             :usernames,
                             :owner_usernames,
                             :membership_request_template)
-                  .to_h
+          .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,
+          .default(visibility_level: 0)
+          .optional(:mentionable_level,
                             :messageable_level,
                             :name,
                             :automatic_membership_email_domains,
@@ -53,7 +54,7 @@ module DiscourseApi
                             :usernames,
                             :owner_usernames,
                             :membership_request_template)
-                  .to_h
+          .to_h
         put("/groups/#{group_id}", group: args)
       end
 
@@ -107,9 +108,9 @@ module DiscourseApi
 
       def group_members(group_name, params = {})
         params = API.params(params)
-                 .optional(:offset, :limit)
-                 .default(offset: 0, limit: 100)
-                 .to_h
+          .optional(:offset, :limit)
+          .default(offset: 0, limit: 100)
+          .to_h
         response = get("/groups/#{group_name}/members.json", params)
         response.body['members']
       end

data/lib/discourse_api/api/invite.rb

@@ -1,16 +1,17 @@
+# frozen_string_literal: true
 module DiscourseApi
   module API
     module Invite
-      def invite_user(params={})
+      def invite_user(params = {})
         post("/invites", params)
       end
 
-      def invite_user_to_topic(params={})
+      def invite_user_to_topic(params = {})
         post("/t/#{params[:topic_id]}/invite", params)
       end
 
       # requires this plugin => https://github.com/discourse/discourse-invite-tokens
-      def disposable_tokens(params={})
+      def disposable_tokens(params = {})
         post("/invite-token/generate", params)
       end
     end

data/lib/discourse_api/api/notifications.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module DiscourseApi
   module API
     module Notifications
@@ -7,4 +8,4 @@ module DiscourseApi
       end
     end
   end
-end
+end

data/lib/discourse_api/api/params.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module DiscourseApi
   module API
     def self.params(args)
@@ -24,7 +25,7 @@ module DiscourseApi
       end
 
       def default(args)
-        args.each do |k,v|
+        args.each do |k, v|
           @defaults[k] = v
         end
         self
@@ -42,7 +43,7 @@ module DiscourseApi
           h[k] = @args[k] if @args.include?(k)
         end
 
-        @defaults.each do |k,v|
+        @defaults.each do |k, v|
           @args.key?(k) ? h[k] = @args[k] : h[k] = v
         end
 

data/lib/discourse_api/api/posts.rb

@@ -1,22 +1,23 @@
+# frozen_string_literal: true
 module DiscourseApi
   module API
     module Posts
       def create_post(args)
         args = API.params(args)
-                  .required(:topic_id, :raw)
-                  .optional(:created_at, :api_username)
+          .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)
+          .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)
+          .optional(:version)
         response = get("/posts/#{id}.json", args)
         response[:body]
       end
@@ -26,7 +27,7 @@ module DiscourseApi
       end
 
       def edit_post(id, raw)
-        put("/posts/#{id}", post: {raw: raw})
+        put("/posts/#{id}", post: { raw: raw })
       end
 
       def delete_post(id)
@@ -38,7 +39,7 @@ 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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module DiscourseApi
   module API
     module PrivateMessages
@@ -5,11 +6,11 @@ module DiscourseApi
       # :target_usernames REQUIRED comma separated list of usernames
       # :category OPTIONAL name of category, not ID
       # :created_at OPTIONAL seconds since epoch.
-      def create_private_message(args={})
+      def create_private_message(args = {})
         args[:archetype] = 'private_message'
         args = API.params(args)
-                  .required(:title, :raw, :target_usernames, :archetype)
-                  .optional(:category, :created_at, :api_username)
+          .required(:title, :raw, :target_usernames, :archetype)
+          .optional(:category, :created_at, :api_username)
         post("/posts", args.to_h)
       end
 

data/lib/discourse_api/api/search.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module DiscourseApi
   module API
     module Search
@@ -7,7 +8,7 @@ module DiscourseApi
       # @param options [Hash] A customizable set of options
       # @option options [String] :type_filter Returns results of the specified type.
       # @return [Array] Return results as an array of Hashes.
-      def search(term, options={})
+      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?
 

data/lib/discourse_api/api/site_settings.rb

@@ -1,9 +1,10 @@
+# frozen_string_literal: true
 module DiscourseApi
   module API
     module SiteSettings
-      def site_setting_update(args={})
+      def site_setting_update(args = {})
         params = API.params(args)
-                  .required(:name, :value).to_h
+          .required(:name, :value).to_h
         new_site_setting = { params[:name] => params[:value] }
         response = put("/admin/site_settings/#{params[:name]}", new_site_setting)
       end

data/lib/discourse_api/api/sso.rb

@@ -1,7 +1,8 @@
+# frozen_string_literal: true
 module DiscourseApi
   module API
     module SSO
-      def sync_sso(params={})
+      def sync_sso(params = {})
         sso = DiscourseApi::SingleSignOn.new
         sso.sso_secret = params[:sso_secret]
         sso.name = params[:name]
@@ -14,7 +15,7 @@ module DiscourseApi
         sso.avatar_force_update = params[:avatar_force_update] === true
         sso.add_groups = params[:add_groups]
         sso.remove_groups = params[:remove_groups]
-        params.keys.select{|key| key.to_s.start_with?("custom") }.each do |custom_key|
+        params.keys.select { |key| key.to_s.start_with?("custom") }.each do |custom_key|
           sso.custom_fields[custom_key] = params[custom_key]
         end
 

data/lib/discourse_api/api/tags.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module DiscourseApi
   module API
     module Tags

data/lib/discourse_api/api/topics.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module DiscourseApi
   module API
     module Topics
@@ -5,55 +6,55 @@ module DiscourseApi
       # :skip_validations OPTIONAL boolean
       # :auto_track OPTIONAL boolean
       # :created_at OPTIONAL seconds since epoch.
-      def create_topic(args={})
+      def create_topic(args = {})
         args = API.params(args)
-                  .required(:title, :raw)
-                  .optional(:skip_validations, :category, :auto_track, :created_at, :api_username)
+          .required(:title, :raw)
+          .optional(:skip_validations, :category, :auto_track, :created_at, :api_username)
         post("/posts", args.to_h)
       end
 
       def create_topic_action(args)
         args = API.params(args)
-                   .required(:id, :post_action_type_id)
+          .required(:id, :post_action_type_id)
         post("/post_actions", args.to_h.merge(flag_topic: true))
       end
 
       # timestamp is seconds past the epoch.
-      def edit_topic_timestamp(topic_id,timestamp)
-        put("/t/#{topic_id}/change-timestamp", { timestamp: timestamp })
+      def edit_topic_timestamp(topic_id, timestamp)
+        put("/t/#{topic_id}/change-timestamp", timestamp: timestamp)
       end
 
-      def latest_topics(params={})
+      def latest_topics(params = {})
         response = get('/latest.json', params)
         response[:body]['topic_list']['topics']
       end
 
-      def new_topics(params={})
+      def new_topics(params = {})
         response = get("/new.json", params)
         response[:body]['topic_list']['topics']
       end
 
       def rename_topic(topic_id, title)
-        put("/t/#{topic_id}.json", { topic_id: topic_id, title: title })
+        put("/t/#{topic_id}.json", topic_id: topic_id, title: title)
       end
 
       def recategorize_topic(topic_id, category_id)
-        put("/t/#{topic_id}.json", { topic_id: topic_id, category_id: category_id })
+        put("/t/#{topic_id}.json", topic_id: topic_id, category_id: category_id)
       end
 
-      def change_topic_status(topic_slug, topic_id, params={})
+      def change_topic_status(topic_slug, topic_id, params = {})
         params = API.params(params)
-                     .required(:status, :enabled)
-                     .optional(:api_username)
+          .required(:status, :enabled)
+          .optional(:api_username)
         put("/t/#{topic_slug}/#{topic_id}/status", params.to_h)
       end
 
-      def topic(id, params={})
+      def topic(id, params = {})
         response = get("/t/#{id}.json", params)
         response[:body]
       end
 
-      def topics_by(username, params={})
+      def topics_by(username, params = {})
         response = get("/topics/created-by/#{username}.json", params)
         response[:body]['topic_list']['topics']
       end
@@ -62,7 +63,7 @@ module DiscourseApi
         delete("/t/#{id}.json")
       end
 
-      def topic_posts(topic_id, post_ids=[])
+      def topic_posts(topic_id, post_ids = [])
         url = "/t/#{topic_id}/posts.json"
         if post_ids.count > 0
           url << '?'

data/lib/discourse_api/api/uploads.rb

@@ -1,11 +1,12 @@
+# frozen_string_literal: true
 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
+          .optional(:file, :url, :user_id)
+          .default(type: 'composer', synchronous: true)
+          .to_h
         post('/uploads', args)
       end
     end

data/lib/discourse_api/api/user_actions.rb

@@ -1,14 +1,15 @@
+# frozen_string_literal: true
 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

data/lib/discourse_api/api/users.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module DiscourseApi
   module API
     module Users
@@ -5,7 +6,7 @@ module DiscourseApi
         put("/admin/users/#{id}/activate")
       end
 
-      def user(username, params={})
+      def user(username, params = {})
         response = get("/users/#{username}.json", params)
         response[:body]['user']
       end
@@ -15,41 +16,43 @@ module DiscourseApi
         response[:body]['single_sign_on_record']
       end
 
-      def update_avatar(args)
+      def update_avatar(username, args)
         args = API.params(args)
-                  .required(:username)
-                  .optional(:file, :url)
-                  .default(type: 'avatar', synchronous: true)
-                  .to_h
+          .optional(:file, :url)
+          .default(type: 'avatar', synchronous: true)
+          .to_h
         upload_response = post("/uploads", args)
-        put("/users/#{args[:username]}/preferences/avatar/pick", { upload_id: upload_response['id'] })
+        put("/u/#{username}/preferences/avatar/pick", upload_id: upload_response['id'])
       end
 
       def update_email(username, email)
-        put("/users/#{username}/preferences/email", { email: email, api_key: api_key })
+        put("/u/#{username}/preferences/email", email: email)
       end
 
-      def update_user(username, params={})
-        put("/users/#{username}", params)
+      def update_user(username, args)
+        args = API.params(args)
+          .optional(:name, :title, :bio_raw, :location, :website, :profile_background, :card_background)
+          .to_h
+        put("/u/#{username}", args)
       end
 
       def update_username(username, new_username)
-        put("/users/#{username}/preferences/username", { new_username: new_username, api_key: api_key })
+        put("/u/#{username}/preferences/username", new_username: new_username)
       end
 
-      def update_trust_level(args)
+      def update_trust_level(user_id, args)
         args = API.params(args)
-                  .required(:user_id, :level)
-                  .to_h
-        response = put("/admin/users/#{args[:user_id]}/trust_level", args)
+          .required(:level)
+          .to_h
+        response = put("/admin/users/#{user_id}/trust_level", args)
         response[:body]
       end
 
       def create_user(args)
         args = API.params(args)
-                  .required(:name, :email, :password, :username)
-                  .optional(:active, :staged, :user_fields)
-                  .to_h
+          .required(:name, :email, :password, :username)
+          .optional(:active, :staged, :user_fields)
+          .to_h
         post("/users", args)
       end
 
@@ -57,7 +60,7 @@ module DiscourseApi
         post("/admin/users/#{id}/log_out")
       end
 
-      def invite_admin(args={})
+      def invite_admin(args = {})
         post("/admin/users/invite_admin", args)
       end
 
@@ -82,7 +85,7 @@ module DiscourseApi
       end
 
       def suspend(user_id, suspend_until, reason)
-        put("/admin/users/#{user_id}/suspend", {suspend_until: suspend_until, reason: reason})
+        put("/admin/users/#{user_id}/suspend", suspend_until: suspend_until, reason: reason)
       end
 
       def unsuspend(user_id)

data/lib/discourse_api/client.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'faraday'
 require 'faraday_middleware'
 require 'json'
@@ -58,7 +59,7 @@ module DiscourseApi
 
     def api_username=(api_username)
       @api_username = api_username
-      @connection.params['api_username'] = api_username unless @connection.nil?
+      @connection.headers['Api-username'] = api_username unless @connection.nil?
     end
 
     def connection_options
@@ -75,15 +76,15 @@ module DiscourseApi
       connection_options[:ssl] = options
     end
 
-    def delete(path, params={})
+    def delete(path, params = {})
       request(:delete, path, params)
     end
 
-    def get(path, params={})
+    def get(path, params = {})
       request(:get, path, params)
     end
 
-    def post(path, params={})
+    def post(path, params = {})
       response = request(:post, path, params)
       case response.status
       when 200, 201, 204
@@ -93,11 +94,11 @@ module DiscourseApi
       end
     end
 
-    def put(path, params={})
+    def put(path, params = {})
       request(:put, path, params)
     end
 
-    def patch(path, params={})
+    def patch(path, params = {})
       request(:patch, path, params)
     end
 
@@ -127,7 +128,7 @@ module DiscourseApi
       end
     end
 
-    def request(method, path, params={})
+    def request(method, path, params = {})
       unless Hash === params
         params = params.to_h if params.respond_to? :to_h
       end