discourse_api 0.10.1 → 0.11.0

data/examples/post_action.rb

@@ -1,25 +1,25 @@
-$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
-require File.expand_path('../../lib/discourse_api', __FILE__)
-
-client = DiscourseApi::Client.new("http://localhost:3000")
-client.api_key = "YOUR_API_KEY"
-client.api_username = "YOUR_USERNAME"
-
-# Post Action Type IDs
-# 1 - Bookmark
-# 2 - Like
-# 3 - Flag: Off-topic
-# 4 - Flag: Inappropriate
-# 5 - Vote
-# 6 - Notify User
-# 7 - Flag - Notify Moderators
-# 8 - Flag - Spam
-
-# Like a post
-client.create_post_action(id: 2, post_action_type_id: 2)
-
-# Flag a topic as spam
-client.create_topic_action(id: 1, post_action_type_id: 8)
-
-# Unlike a post
-client.destroy_post_action(id: 3, post_action_type_id: 2)
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require File.expand_path('../../lib/discourse_api', __FILE__)
+
+client = DiscourseApi::Client.new("http://localhost:3000")
+client.api_key = "YOUR_API_KEY"
+client.api_username = "YOUR_USERNAME"
+
+# Post Action Type IDs
+# 1 - Bookmark
+# 2 - Like
+# 3 - Flag: Off-topic
+# 4 - Flag: Inappropriate
+# 5 - Vote
+# 6 - Notify User
+# 7 - Flag - Notify Moderators
+# 8 - Flag - Spam
+
+# Like a post
+client.create_post_action(id: 2, post_action_type_id: 2)
+
+# Flag a topic as spam
+client.create_topic_action(id: 1, post_action_type_id: 8)
+
+# Unlike a post
+client.destroy_post_action(id: 3, post_action_type_id: 2)

data/examples/search.rb

@@ -1,9 +1,9 @@
-$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
-require File.expand_path('../../lib/discourse_api', __FILE__)
-
-client = DiscourseApi::Client.new("http://localhost:3000")
-client.api_key = "YOUR_API_KEY"
-client.api_username = "YOUR_USERNAME"
-
-# search for term
-puts client.search("discourse")
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require File.expand_path('../../lib/discourse_api', __FILE__)
+
+client = DiscourseApi::Client.new("http://localhost:3000")
+client.api_key = "YOUR_API_KEY"
+client.api_username = "YOUR_USERNAME"
+
+# search for term
+puts client.search("discourse")

data/examples/sso.rb

@@ -1,14 +1,14 @@
-$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
-require File.expand_path('../../lib/discourse_api', __FILE__)
-
-client = DiscourseApi::Client.new("http://localhost:3000")
-client.api_key = "YOUR_API_KEY"
-client.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"
-)
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require File.expand_path('../../lib/discourse_api', __FILE__)
+
+client = DiscourseApi::Client.new("http://localhost:3000")
+client.api_key = "YOUR_API_KEY"
+client.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"
+)

data/examples/topic_lists.rb

@@ -1,15 +1,15 @@
-$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
-require File.expand_path('../../lib/discourse_api', __FILE__)
-
-client = DiscourseApi::Client.new("http://localhost:3000")
-client.api_key = "YOUR_API_KEY"
-client.api_username = "YOUR_USERNAME"
-
-# get latest topics
-puts client.latest_topics({})
-
-# recategorize topic
-puts client.recategorize_topic(topic_id: 108, category_id: 5)
-
-# get all categories
-puts client.categories({})
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require File.expand_path('../../lib/discourse_api', __FILE__)
+
+client = DiscourseApi::Client.new("http://localhost:3000")
+client.api_key = "YOUR_API_KEY"
+client.api_username = "YOUR_USERNAME"
+
+# get latest topics
+puts client.latest_topics({})
+
+# recategorize topic
+puts client.recategorize_topic(topic_id: 108, category_id: 5)
+
+# get all categories
+puts client.categories({})

data/examples/update_user.rb

@@ -1,22 +1,22 @@
-$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
-require File.expand_path('../../lib/discourse_api', __FILE__)
-
-client = DiscourseApi::Client.new("http://localhost:3000")
-client.api_key = "YOUR_API_KEY"
-client.api_username = "YOUR_USERNAME"
-
-# update username from "robin" to "batman"
-puts client.update_username("robin", "batman")
-# update name of user whose username is "batman"
-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")
-# 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")
-
-# log out everywhere and refresh browser of user whose id is "2"
-puts client.log_out(2)
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require File.expand_path('../../lib/discourse_api', __FILE__)
+
+client = DiscourseApi::Client.new("http://localhost:3000")
+client.api_key = "YOUR_API_KEY"
+client.api_username = "YOUR_USERNAME"
+
+# update username from "robin" to "batman"
+puts client.update_username("robin", "batman")
+# update name of user whose username is "batman"
+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")
+# 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")
+
+# log out everywhere and refresh browser of user whose id is "2"
+puts client.log_out(2)

data/lib/discourse_api.rb

@@ -1,5 +1,5 @@
-require "discourse_api/api/params"
-require "discourse_api/client"
-require "discourse_api/error"
-require "discourse_api/version"
-require "discourse_api/single_sign_on"
+require "discourse_api/api/params"
+require "discourse_api/client"
+require "discourse_api/error"
+require "discourse_api/version"
+require "discourse_api/single_sign_on"

data/lib/discourse_api/api/api_key.rb

@@ -1,31 +1,31 @@
-module DiscourseApi
-  module API
-    module ApiKey
-      def api
-        response = get("/admin/api.json")
-        response.body
-      end
-
-      def generate_user_api_key(user_id)
-        response = post("/admin/users/#{user_id}/generate_api_key.json")
-      end
-
-      def revoke_user_api_key(user_id)
-        response = delete("/admin/users/#{user_id}/revoke_api_key.json")
-      end
-
-      def generate_master_key
-        response = post("/admin/api/key")
-      end
-
-      def revoke_api_key(id)
-        response = delete("/admin/api/key", {id: id})
-      end
-
-      def regenerate_api_key(id)
-        response = put("/admin/api/key", {id: id})
-        response.body
-      end
-    end
-  end
-end
+module DiscourseApi
+  module API
+    module ApiKey
+      def api
+        response = get("/admin/api.json")
+        response.body
+      end
+
+      def generate_user_api_key(user_id)
+        response = post("/admin/users/#{user_id}/generate_api_key.json")
+      end
+
+      def revoke_user_api_key(user_id)
+        response = delete("/admin/users/#{user_id}/revoke_api_key.json")
+      end
+
+      def generate_master_key
+        response = post("/admin/api/key")
+      end
+
+      def revoke_api_key(id)
+        response = delete("/admin/api/key", {id: id})
+      end
+
+      def regenerate_api_key(id)
+        response = put("/admin/api/key", {id: id})
+        response.body
+      end
+    end
+  end
+end

data/lib/discourse_api/api/backups.rb

@@ -1,24 +1,24 @@
-module DiscourseApi
-  module API
-    module Backups
-      def backups
-        response = get("/admin/backups.json")
-        response.body
-      end
-
-      def create_backup
-        post("/admin/backups", with_uploads: true)
-      end
-
-      def restore_backup(file_name)
-        post("/admin/backups/#{file_name}/restore")
-      end
-
-      def download_backup(file_name)
-        response = get("/admin/backups/#{file_name}")
-        # write file
-        File.open('examples/backup.tar.gz', 'wb') { |fp| fp.write(response.body) }
-      end
-    end
-  end
-end
+module DiscourseApi
+  module API
+    module Backups
+      def backups
+        response = get("/admin/backups.json")
+        response.body
+      end
+
+      def create_backup
+        post("/admin/backups", with_uploads: true)
+      end
+
+      def restore_backup(file_name)
+        post("/admin/backups/#{file_name}/restore")
+      end
+
+      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) }
+      end
+    end
+  end
+end

data/lib/discourse_api/api/badges.rb

@@ -1,28 +1,28 @@
-module DiscourseApi
-  module API
-    module Badges
-      def badges
-        response = get("/admin/badges.json")
-        response.body
-      end
-
-      def user_badges(username)
-        response = get("/users/#{username}/activity/badges.json")
-        response.body['badges']
-      end
-
-      def grant_user_badge(params={})
-        post("/user_badges", params)
-      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)
-        post("/admin/badges.json", args)
-      end
-    end
-  end
-end
+module DiscourseApi
+  module API
+    module Badges
+      def badges
+        response = get("/admin/badges.json")
+        response.body
+      end
+
+      def user_badges(username)
+        response = get("/users/#{username}/activity/badges.json")
+        response.body['badges']
+      end
+
+      def grant_user_badge(params={})
+        post("/user_badges", params)
+      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)
+        post("/admin/badges.json", args)
+      end
+    end
+  end
+end

data/lib/discourse_api/api/categories.rb

@@ -1,57 +1,57 @@
-module DiscourseApi
-  module API
-    module Categories
-      # :color and :text_color are RGB hexadecimal strings
-      # :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(:description, :permissions)
-                  .default(parent_category_id: nil)
-        response = post("/categories", args)
-        response['category']
-      end
-
-      def categories(params={})
-        response = get('/categories.json', params)
-        response[:body]['category_list']['categories']
-      end
-
-      def category_latest_topics(args={})
-        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 
-        response = get(url)
-        if response[:body]['errors']
-          response[:body]['errors']
-        else
-          response[:body]['topic_list']['topics']
-        end
-      end
-
-      def category_top_topics(category_slug)
-        response = get("/c/#{category_slug}/l/top.json")
-        if response[:body]['errors']
-          response[:body]['errors']
-        else
-          response[:body]['topic_list']['topics']
-        end
-      end
-
-      def category_new_topics(category_slug)
-        response = get("/c/#{category_slug}/l/new.json")
-        response[:body]['topic_list']['topics']
-      end
-
-      def category(id)
-        response = get("/c/#{id}/show")
-        response.body['category']
-      end
-    end
-  end
-end
+module DiscourseApi
+  module API
+    module Categories
+      # :color and :text_color are RGB hexadecimal strings
+      # :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(:description, :permissions)
+                  .default(parent_category_id: nil)
+        response = post("/categories", args)
+        response['category']
+      end
+
+      def categories(params={})
+        response = get('/categories.json', params)
+        response[:body]['category_list']['categories']
+      end
+
+      def category_latest_topics(args={})
+        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 
+        response = get(url)
+        if response[:body]['errors']
+          response[:body]['errors']
+        else
+          response[:body]['topic_list']['topics']
+        end
+      end
+
+      def category_top_topics(category_slug)
+        response = get("/c/#{category_slug}/l/top.json")
+        if response[:body]['errors']
+          response[:body]['errors']
+        else
+          response[:body]['topic_list']['topics']
+        end
+      end
+
+      def category_new_topics(category_slug)
+        response = get("/c/#{category_slug}/l/new.json")
+        response[:body]['topic_list']['topics']
+      end
+
+      def category(id)
+        response = get("/c/#{id}/show")
+        response.body['category']
+      end
+    end
+  end
+end