discourse_api 0.11.0 → 0.12.0

data/Rakefile

@@ -1,7 +1,7 @@
-require "bundler/gem_tasks"
-
-require 'rspec/core/rake_task'
-RSpec::Core::RakeTask.new(:spec)
-
-task test: :spec
-task default: :spec
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task test: :spec
+task default: :spec

data/discourse_api.gemspec

@@ -1,35 +1,35 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'discourse_api/version'
-
-Gem::Specification.new do |spec|
-  spec.name          = "discourse_api"
-  spec.version       = DiscourseApi::VERSION
-  spec.authors       = ["Sam Saffron", "John Paul Ashenfelter", "Michael Herold", "Blake Erickson"]
-  spec.email         = ["sam.saffron@gmail.com", "john@ashenfelter.com", "michael.j.herold@gmail.com", "o.blakeerickson@gmail.com"]
-  spec.description   = %q{Discourse API}
-  spec.summary       = %q{Allows access to the Discourse API}
-  spec.homepage      = "http://github.com/discourse/discourse_api"
-  spec.license       = "MIT"
-
-  spec.files         = `git ls-files`.split($/)
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
-
-  spec.add_dependency "faraday", "~> 0.9"
-  spec.add_dependency "faraday_middleware", "~> 0.10"
-  spec.add_dependency "rack", "~> 1.6"
-
-  spec.add_development_dependency "bundler", "~> 1.12"
-  spec.add_development_dependency "rake", "~> 11.1"
-  spec.add_development_dependency "rspec", "~> 3.4"
-  spec.add_development_dependency "webmock", "~> 2.0"
-  spec.add_development_dependency "guard-rspec", "~> 4.7"
-  spec.add_development_dependency "guard", "~> 2.14"
-  spec.add_development_dependency "rb-inotify", "~> 0.9"
-  spec.add_development_dependency "simplecov", "~> 0.11"
-
-  spec.required_ruby_version = '>= 2.2.3'
-end
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'discourse_api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "discourse_api"
+  spec.version       = DiscourseApi::VERSION
+  spec.authors       = ["Sam Saffron", "John Paul Ashenfelter", "Michael Herold", "Blake Erickson"]
+  spec.email         = ["sam.saffron@gmail.com", "john@ashenfelter.com", "michael.j.herold@gmail.com", "o.blakeerickson@gmail.com"]
+  spec.description   = %q{Discourse API}
+  spec.summary       = %q{Allows access to the Discourse API}
+  spec.homepage      = "http://github.com/discourse/discourse_api"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "faraday", "~> 0.9"
+  spec.add_dependency "faraday_middleware", "~> 0.10"
+  spec.add_dependency "rack", "~> 1.6"
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 11.1"
+  spec.add_development_dependency "rspec", "~> 3.4"
+  spec.add_development_dependency "webmock", "~> 2.0"
+  spec.add_development_dependency "guard-rspec", "~> 4.7"
+  spec.add_development_dependency "guard", "~> 2.14"
+  spec.add_development_dependency "rb-inotify", "~> 0.9"
+  spec.add_development_dependency "simplecov", "~> 0.11"
+
+  spec.required_ruby_version = '>= 2.2.3'
+end

data/examples/backups.rb

@@ -1,18 +1,18 @@
-$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 list of backup files
-puts client.backups()
-
-# create backup
-puts client.create_backup()
-
-# restore backup
-puts client.restore_backup("backup_file_name.tar.gz")
-
-# download backup
-puts client.download_backup("backup_file_name.tar.gz", "/tmp/")
+$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 list of backup files
+puts client.backups()
+
+# create backup
+puts client.create_backup()
+
+# restore backup
+puts client.restore_backup("backup_file_name.tar.gz")
+
+# download backup
+puts client.download_backup("backup_file_name.tar.gz", "/tmp/")

data/examples/category.rb

@@ -1,21 +1,21 @@
-$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 categories
-puts client.categories()
-
-# get sub categories for parent category with id 2
-puts client.categories(parent_category_id: 2)
-
-# List topics in a category
-category_topics = client.category_latest_topics(category_slug: "test-category")
-puts category_topics
-
-# List topics in a category paged
-category_topics_paged = client.category_latest_topics(category_slug: "test-category", page: "5")
-puts category_topics_paged
-
+$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 categories
+puts client.categories()
+
+# get sub categories for parent category with id 2
+puts client.categories(parent_category_id: 2)
+
+# List topics in a category
+category_topics = client.category_latest_topics(category_slug: "test-category")
+puts category_topics
+
+# List topics in a category paged
+category_topics_paged = client.category_latest_topics(category_slug: "test-category", page: "5")
+puts category_topics_paged
+

data/examples/change_topic_status.rb

@@ -1,33 +1,33 @@
-$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"
-
-response = client.create_topic(
-    category: "Boing Boing",
-    skip_validations: true,
-    auto_track: false,
-    title: "Concert Master: A new way to choose",
-    raw: "This is the raw markdown for my post"
-)
-
-# get topic_id and topic_slug from response
-topic_id = response['topic_id']
-topic_slug = response['topic_slug']
-
-
-##
-# available options (guessing from reading discourse source)
-# status can be: ['autoclose', 'closed', 'archived', 'disabled', 'visible']
-# enabled can be: [true, false]
-##
-
-# lock topic (note: api_username determines user that is performing action)
-params = {status: 'closed', enabled: true, api_username: "YOUR USERNAME/USERS USERNAME"}
-client.change_topic_status(topic_slug, topic_id, params)
-
-# unlock topic (note: api_username determines user that is performing action)
-params = {status: 'closed', enabled: false, api_username: "YOUR USERNAME/USERS USERNAME"}
-client.change_topic_status(topic_slug, topic_id, params)
+$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"
+
+response = client.create_topic(
+    category: "Boing Boing",
+    skip_validations: true,
+    auto_track: false,
+    title: "Concert Master: A new way to choose",
+    raw: "This is the raw markdown for my post"
+)
+
+# get topic_id and topic_slug from response
+topic_id = response['topic_id']
+topic_slug = response['topic_slug']
+
+
+##
+# available options (guessing from reading discourse source)
+# status can be: ['autoclose', 'closed', 'archived', 'disabled', 'visible']
+# enabled can be: [true, false]
+##
+
+# lock topic (note: api_username determines user that is performing action)
+params = {status: 'closed', enabled: true, api_username: "YOUR USERNAME/USERS USERNAME"}
+client.change_topic_status(topic_slug, topic_id, params)
+
+# unlock topic (note: api_username determines user that is performing action)
+params = {status: 'closed', enabled: false, api_username: "YOUR USERNAME/USERS USERNAME"}
+client.change_topic_status(topic_slug, topic_id, params)

data/examples/create_topic.rb

@@ -1,23 +1,23 @@
-$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.create_topic(
-  category: "Boing Boing",
-  skip_validations: true,
-  auto_track: false,
-  title: "Concert Master: A new way to choose",
-  raw: "This is the raw markdown for my post"
-)
-
-# create Poll topic
-client.create_topic(
-  category: "general",
-  skip_validations: false,
-  auto_track: false,
-  title: "Your Favorite Color?",
-  raw: "[poll name=color]\n- Green\n- Blue\n- Red\n[/poll]"
-)
+$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.create_topic(
+  category: "Boing Boing",
+  skip_validations: true,
+  auto_track: false,
+  title: "Concert Master: A new way to choose",
+  raw: "This is the raw markdown for my post"
+)
+
+# create Poll topic
+client.create_topic(
+  category: "general",
+  skip_validations: false,
+  auto_track: false,
+  title: "Your Favorite Color?",
+  raw: "[poll name=color]\n- Green\n- Blue\n- Red\n[/poll]"
+)

data/examples/create_user.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"
-
-# create user
-client.create_user(
-  name: "Bruce Wayne",
-  email: "bruce@wayne.com",
-  username: "batman",
-  password: "WhySoSerious"
-)
+$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"
+
+# create user
+client.create_user(
+  name: "Bruce Wayne",
+  email: "bruce@wayne.com",
+  username: "batman",
+  password: "WhySoSerious"
+)

data/examples/dashboard.rb

@@ -1,13 +1,13 @@
-$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 all dashboard status as json 
-puts client.get_dashboard_stats
-
-# get hash of some dashboard total value 
-puts client.get_dashboard_stats_totals
-# sample output: {"users"=>9, "topics"=>230, "posts"=>441}
+$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 all dashboard status as json 
+puts client.get_dashboard_stats
+
+# get hash of some dashboard total value 
+puts client.get_dashboard_stats_totals
+# sample output: {"users"=>9, "topics"=>230, "posts"=>441}

data/examples/disposable_invite_tokens.rb

@@ -1,18 +1,18 @@
-require 'csv'
-
-$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"
-
-# fetch email-less invite tokens
-invite_tokens = client.disposable_tokens(username: "eviltrout", quantity: 5, group_names: "security,support")
-
-# write to CSV file
-CSV.open(File.expand_path("../invite_tokens.csv", __FILE__), "w") do |csv|
-  invite_tokens.each do |value|
-    csv << [value]
-  end
-end
+require 'csv'
+
+$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"
+
+# fetch email-less invite tokens
+invite_tokens = client.disposable_tokens(username: "eviltrout", quantity: 5, group_names: "security,support")
+
+# write to CSV file
+CSV.open(File.expand_path("../invite_tokens.csv", __FILE__), "w") do |csv|
+  invite_tokens.each do |value|
+    csv << [value]
+  end
+end

data/examples/example.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"
-
-# get latest topics
-puts client.latest_topics
+$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

data/examples/groups.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"
-
-response = client.create_group(name: "engineering_team")
-group_id = response["basic_group"]["id"]
-
-client.group_add(group_id, username: "sam")
-client.group_add(group_id, username: "jeff")
-client.group_add(group_id, usernames: ["neil", "dan"])
-client.group_add(group_id, user_id: 123)
-client.group_add(group_id, user_ids: [123, 456])
-
-client.group_remove(group_id, username: "neil")
-client.group_remove(group_id, user_id: 123)
-
-client.delete_group(group_id)
-
-## List users of a group
-
-members = client.group_members('trust_level_0')
-puts members
+$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"
+
+response = client.create_group(name: "engineering_team")
+group_id = response["basic_group"]["id"]
+
+client.group_add(group_id, username: "sam")
+client.group_add(group_id, username: "jeff")
+client.group_add(group_id, usernames: ["neil", "dan"])
+client.group_add(group_id, user_id: 123)
+client.group_add(group_id, user_ids: [123, 456])
+
+client.group_remove(group_id, username: "neil")
+client.group_remove(group_id, user_id: 123)
+
+client.delete_group(group_id)
+
+## List users of a group
+
+members = client.group_members('trust_level_0')
+puts members