discourse_api 0.38.0 → 0.39.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 359440c0d7810ba745d422cb97b7465e55cb65d3abb145c7597f511d13e77609
-  data.tar.gz: 7be49a42e09f7d16c5e4ad564b57305c2f8eb17c78ed8781a1b19bf1645564b8
+  metadata.gz: 949fba1e4447d9615d8d3457b79328a866cfe61f325c3cd4f6a2cf3083ad9322
+  data.tar.gz: 2cc4f93ec719eb99e0bbd02caeecc02c3ed36bcd33b4b6435b9cb56835e622ae
 SHA512:
-  metadata.gz: 07ae95153a40f0b84fa64d439608a403e47ad46d75bb1f201364f621101158048345160725733d21540288c0588ed4fdbf3a43a7af3b2df969b1347fa2c9a91f
-  data.tar.gz: 0e58fa5071debb6d6d62035c48c9494ee0c811ed8097dd147745a6aeba85fe06a6c8b699ed943c56d8a88af9c33c51d2a59563355c81324b41cd4aec5533fca5
+  metadata.gz: 781247a4d7644d9f58609f221da038f8f59e58114ba2450c63c1ef8e7adfda029c775e8b58b0237220c76d3db1d95232249a6d04ff9138da2aa759eaa6938fa2
+  data.tar.gz: 995b7de67aef36acab3ef778201032aa9c2e9c9762a02d80e6cfeeacccd8dac64c433fc5cda75bfca6fbbcade605ea3917fd6c92283253c7a79618b24d2b644d

data/.gitignore

@@ -19,6 +19,6 @@ bin/
 .ruby-gemset
 .ruby-version
 .env
+/config.yml
 
-
-.rubocop-https---raw-githubusercontent-com-discourse-discourse-master--rubocop-yml
+.rubocop-https---raw-githubusercontent-com-discourse-discourse-master--rubocop-yml

data/CHANGELOG.md

@@ -2,6 +2,17 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+## [0.39.0] - 2020-03-27
+### Added
+- Get latest posts across topics via posts.json
+- Allow  more options parameters when creating a category
+- Don't require topic slug when updating topic status
+- Example files now read config.yml file when present for client settings
+
+### Fixed
+- Issue with `topic_posts` and frozen strings
+- Fixed some topic and category methods
+
 ## [0.38.0] - 2019-10-18
 ### Added
 - Allow setting locale in SingleSignOn

data/config_example.yml

@@ -0,0 +1,11 @@
+# Specify your environment by making a copy of this file to create a file in your root directory called config.yml with your environment settings.
+
+# host e.g. localhost:3000 or discourse.my_domain.com
+host: YOUR_HOST_NAME
+
+# api user (can effect results returned, e.g. .categories method returns only the categories your api_username can see)
+# create a new client with when changing api user
+api_username: YOUR_API_USERNAME
+
+# api key from Discourse admin panel /admin/api/keys
+api_key: YOUR_API_KEY

data/discourse_api.gemspec

@@ -28,9 +28,11 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake', '~> 11.1'
   spec.add_development_dependency 'rb-inotify', '~> 0.9'
   spec.add_development_dependency 'rspec', '~> 3.4'
-  spec.add_development_dependency 'rubocop', '~> 0.67.2'
+  spec.add_development_dependency 'rubocop', '~> 0.69'
   spec.add_development_dependency 'simplecov', '~> 0.11'
   spec.add_development_dependency 'webmock', '~> 2.0'
+  spec.add_development_dependency 'rubocop-discourse', '~> 1.0'
+  spec.add_development_dependency 'rubocop-rspec', '~> 1.0'
 
   spec.required_ruby_version = '>= 2.2.3'
 end

data/examples/backups.rb

@@ -2,9 +2,11 @@
 $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"
+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"
 
 # get list of backup files
 puts client.backups()

data/examples/badges.rb

@@ -2,9 +2,11 @@
 $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"
+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"
 
 # get badges
 puts client.badges

data/examples/category.rb

@@ -2,9 +2,11 @@
 $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"
+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"
 
 # get categories
 puts client.categories()

data/examples/change_topic_status.rb

@@ -2,9 +2,11 @@
 $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"
+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"
 
 response = client.create_topic(
     category: 1,

data/examples/create_private_message.rb

@@ -2,9 +2,11 @@
 $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"
+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.create_private_message(
   title: "Confidential: Hello World!",

data/examples/create_topic.rb

@@ -2,9 +2,11 @@
 $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"
+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.create_topic(
   category: 1,

data/examples/create_update_category.rb

@@ -2,14 +2,11 @@
 $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"
-#
+config = DiscourseApi::ExampleHelper.load_yml
 
-client = DiscourseApi::Client.new("http://localhost:8080")
-client.api_key = "a56a349e1870529d8d8da11453ea782ce8ab8de34d6564a65727171163be4338"
-client.api_username = "system"
+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"
 
 ###
 # Required category params:

data/examples/create_user.rb

@@ -2,9 +2,11 @@
 $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"
+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"
 
 # create user
 user = client.create_user(

data/examples/dashboard.rb

@@ -2,9 +2,11 @@
 $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"
+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"
 
 # get all dashboard status as json
 puts client.get_dashboard_stats

data/examples/disposable_invite_tokens.rb

@@ -6,9 +6,11 @@ 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"
+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"
 
 # fetch email-less invite tokens
 invite_tokens = client.disposable_tokens(username: "eviltrout", quantity: 5, group_names: "security,support")

data/examples/example.rb

@@ -2,9 +2,11 @@
 $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"
+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"
 
 # get latest topics
 puts client.latest_topics

data/examples/group_set_user_notification_level.rb

@@ -2,9 +2,11 @@
 $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"
+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"
 
 @target_username = "YOUR_TARGET_USERNAME"
 @target_group_id =   # YOUR NUMERIC TARGET GROUP ID

data/examples/groups.rb

@@ -2,9 +2,11 @@
 $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"
+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"
 
 response = client.create_group(name: "engineering_team")
 group_id = response["basic_group"]["id"]

data/examples/invite_users.rb

@@ -2,9 +2,11 @@
 $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"
+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"
 
 # invite user
 client.invite_user(email: "name@example.com", group_ids: "41,42")

data/examples/polls.rb

@@ -3,9 +3,11 @@
 $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"
+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"
 
 options = ['8b4736b1ae3dfb5a28088530f036f9e5']
 poll_option_votes = client.poll_vote post_id: 5, poll_name: 'poll', options: options

data/examples/post_action.rb

@@ -2,9 +2,11 @@
 $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"
+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"
 
 # Post Action Type IDs
 # 1 - Bookmark

data/examples/search.rb

@@ -2,9 +2,11 @@
 $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"
+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"
 
 # search for term
 puts client.search("discourse")

data/examples/sent_private_messages.rb

@@ -2,8 +2,10 @@
 $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"
+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.sent_private_messages('test_user')

data/examples/sso.rb

@@ -2,9 +2,11 @@
 $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"
+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.sync_sso(
   sso_secret: "discourse_sso_rocks",

data/examples/topic_lists.rb

@@ -2,9 +2,11 @@
 $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"
+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"
 
 # get latest topics
 puts client.latest_topics({})

data/examples/update_user.rb

@@ -2,9 +2,11 @@
 $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"
+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"
 
 # update username from "robin" to "batman"
 puts client.update_username("robin", "batman")

data/examples/upload_file.rb

@@ -2,9 +2,11 @@
 $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"
+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"
 
 # Upload a file
 file = Faraday::UploadIO.new('grumpy_cat.pdf', "application/pdf")

data/lib/discourse_api.rb

@@ -3,4 +3,5 @@ require "discourse_api/api/params"
 require "discourse_api/client"
 require "discourse_api/error"
 require "discourse_api/version"
+require "discourse_api/example_helper"
 require "discourse_api/single_sign_on"

data/lib/discourse_api/api/categories.rb

@@ -8,7 +8,8 @@ module DiscourseApi
       def create_category(args = {})
         args = API.params(args)
           .required(:name, :color, :text_color)
-          .optional(:description, :permissions, :custom_fields)
+          .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)
           .default(parent_category_id: nil)
         response = post("/categories", args)
         response['category']
@@ -19,7 +20,7 @@ module DiscourseApi
         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)
+                             :email_in_allow_strangers, :logo_url, :background_url, :allow_badges, :topic_template, :custom_fields, :description)
           .default(parent_category_id: nil)
         response = put("/categories/#{category_id}", args)
         response['body']['category'] if response['body']

data/lib/discourse_api/api/params.rb

@@ -16,6 +16,9 @@ module DiscourseApi
 
       def required(*keys)
         @required.concat(keys)
+        @required.each do |k|
+          raise ArgumentError.new("#{k} is required but not specified") unless @args.key?(k)
+        end
         self
       end
 
@@ -36,7 +39,6 @@ module DiscourseApi
 
         @required.each do |k|
           h[k] = @args[k]
-          raise ArgumentError.new("#{k} is required but not specified") unless h[k]
         end
 
         @optional.each do |k|

data/lib/discourse_api/api/posts.rb

@@ -22,6 +22,12 @@ module DiscourseApi
         response[:body]
       end
 
+      def posts(args = {})
+        args = API.params(args).default(before: 0)
+        response = get("/posts.json", args)
+        response[:body]
+      end
+
       def wikify_post(id)
         put("/posts/#{id}/wiki", wiki: true)
       end

data/lib/discourse_api/api/topics.rb

@@ -46,7 +46,7 @@ module DiscourseApi
         params = API.params(params)
           .required(:status, :enabled)
           .optional(:api_username)
-        put("/t/#{topic_slug}/#{topic_id}/status", params.to_h)
+        put("/t/#{topic_id}/status", params.to_h)
       end
 
       def topic(id, params = {})
@@ -64,14 +64,12 @@ module DiscourseApi
       end
 
       def topic_posts(topic_id, post_ids = [])
-        url = "/t/#{topic_id}/posts.json"
+        url = ["/t/#{topic_id}/posts.json"]
         if post_ids.count > 0
-          url << '?'
-          post_ids.each do |id|
-            url << "post_ids[]=#{id}&"
-          end
+          url.push('?')
+          url.push(post_ids.map { |id| "post_ids[]=#{id}" }.join('&'))
         end
-        response = get(url)
+        response = get(url.join)
         response[:body]
       end
     end

data/lib/discourse_api/example_helper.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+require 'yaml'
+
+module DiscourseApi
+  class ExampleHelper
+
+    def self.load_yml
+      config_yml = File.expand_path('../../../config.yml', __FILE__)
+      puts config_yml
+      begin
+        config = YAML.load_file config_yml
+      rescue Errno::ENOENT
+        config = {}
+      end
+      config
+    end
+
+  end
+end

data/lib/discourse_api/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module DiscourseApi
-  VERSION = "0.38.0"
+  VERSION = "0.39.0"
 end

data/spec/discourse_api/api/params_spec.rb

@@ -9,6 +9,10 @@ describe DiscourseApi::API::Params do
     expect { params_for({o1: "test"}).to_h }.to raise_error(ArgumentError)
   end
 
+  it "should not raise when a required param is false" do
+    expect { params_for({r1: false}).to_h }.not_to raise_error
+  end
+
   it "should not include optional params when not provided" do
     expect(params_for({r1: "test"}).to_h).not_to include(:o1)
   end

data/spec/discourse_api/api/posts_spec.rb

@@ -15,6 +15,25 @@ describe DiscourseApi::API::Posts do
     end
   end
 
+  describe "#posts" do
+    before do
+      stub_get("#{host}/posts.json?before=0").to_return(body: fixture("posts_latest.json"), headers: { content_type: "application/json" })
+      stub_get("#{host}/posts.json?before=14").to_return(body: fixture("posts_before.json"), headers: { content_type: "application/json" })
+    end
+
+    it "fetches latest posts" do
+      the_posts = client.posts()
+      expect(the_posts).to be_a Hash
+      expect(the_posts['latest_posts'][0]['id']).to eq(15)
+    end
+
+    it "fetches posts before 14" do
+      the_posts = client.posts(before: 14)
+      expect(the_posts).to be_a Hash
+      expect(the_posts['latest_posts'][0]['id']).to eq(14)
+    end
+  end
+
   describe "#wikify_post" do
     before do
       stub_put("#{host}/posts/9999/wiki")

data/spec/discourse_api/api/topics_spec.rb

@@ -3,6 +3,17 @@ require 'spec_helper'
 describe DiscourseApi::API::Topics do
   subject { DiscourseApi::Client.new("#{host}", "test_d7fd0429940", "test_user") }
 
+  describe "#change_topic_status" do
+    before do
+      stub_put("#{host}/t/57/status").to_return(body: fixture("topic.json"), headers: { content_type: "application/json" })
+    end
+
+    it "changes the topic status" do
+      subject.change_topic_status(nil, 57, { status: 'visible', enabled: false })
+      expect(a_put("#{host}/t/57/status")).to have_been_made
+    end
+  end
+
   describe "#invite_user_to_topic" do
     before do
       stub_post("#{host}/t/12/invite").to_return(body: fixture("topic_invite_user.json"), headers: { content_type: "application/json" })
@@ -110,4 +121,30 @@ describe DiscourseApi::API::Topics do
       expect(topics.first).to be_a Hash
     end
   end
+
+  describe "#topic_posts" do
+    before do
+      stub_get(/#{host}\/t\/57\/posts\.json/).to_return(
+        body: fixture("topic_posts.json"),
+        headers: { content_type: "application/json" }
+      )
+    end
+
+    it "requests the correct resource" do
+      subject.topic_posts(57)
+      expect(a_get("#{host}/t/57/posts.json")).to have_been_made
+    end
+
+    it 'allows scoping to specific post ids' do
+      subject.topic_posts(57, [123, 456])
+      expect(a_get("#{host}/t/57/posts.json?post_ids[]=123&post_ids[]=456")).to have_been_made
+    end
+
+    it "returns the requested topic posts" do
+      body = subject.topic_posts(57, [123])
+      expect(body).to be_a Hash
+      expect(body['post_stream']['posts']).to be_an Array
+      expect(body['post_stream']['posts'].first).to be_a Hash
+    end
+  end
 end

data/spec/fixtures/posts_before.json

@@ -0,0 +1,148 @@
+{
+  "latest_posts": [
+    {
+      "id": 14,
+      "name": null,
+      "username": "johndoe",
+      "avatar_template": "/letter_avatar_proxy/v3/letter/p/df705f/{size}.png",
+      "created_at": "2020-01-25T00:58:35.475Z",
+      "cooked": "<p>hi there.  hi there.  hi there.</p>",
+      "post_number": 1,
+      "post_type": 1,
+      "updated_at": "2020-01-25T00:58:35.475Z",
+      "reply_count": 0,
+      "reply_to_post_number": null,
+      "quote_count": 0,
+      "avg_time": null,
+      "incoming_link_count": 0,
+      "reads": 1,
+      "score": 0.2,
+      "yours": false,
+      "topic_id": 11,
+      "topic_slug": "this-is-an-uncategorized-title",
+      "topic_title": "This is an uncategorized title",
+      "topic_html_title": "This is an uncategorized title",
+      "category_id": 1,
+      "display_username": null,
+      "primary_group_name": null,
+      "primary_group_flair_url": null,
+      "primary_group_flair_bg_color": null,
+      "primary_group_flair_color": null,
+      "version": 1,
+      "can_edit": false,
+      "can_delete": false,
+      "can_recover": false,
+      "can_wiki": false,
+      "user_title": null,
+      "raw": "hi there.  hi there.  hi there.",
+      "actions_summary": [],
+      "moderator": false,
+      "admin": true,
+      "staff": true,
+      "user_id": 1,
+      "hidden": false,
+      "trust_level": 1,
+      "deleted_at": null,
+      "user_deleted": false,
+      "edit_reason": null,
+      "can_view_edit_history": true,
+      "wiki": false
+    },
+    {
+      "id": 10,
+      "name": "system",
+      "username": "system",
+      "avatar_template": "/user_avatar/localhost/system/{size}/1_2.png",
+      "created_at": "2020-01-24T23:26:09.014Z",
+      "cooked": "<p>The first paragraph of this pinned topic will be visible as a welcome message to all new visitors on your homepage. It’s important!</p>\n<p><strong>Edit this</strong> into a brief description of your community:</p>\n<ul>\n<li>Who is it for?</li>\n<li>What can they find here?</li>\n<li>Why should they come here?</li>\n<li>Where can they read more (links, resources, etc)?</li>\n</ul>\n<p><img src=\"//localhost/images/welcome/discourse-edit-post-animated.gif\" width=\"508\" height=\"106\"></p>\n<p>You may want to close this topic via the admin <img src=\"//localhost/images/emoji/twitter/wrench.png?v=6\" title=\":wrench:\" class=\"emoji\" alt=\":wrench:\"> (at the upper right and bottom), so that replies don’t pile up on an announcement.</p>",
+      "post_number": 1,
+      "post_type": 1,
+      "updated_at": "2020-01-24T23:26:09.014Z",
+      "reply_count": 0,
+      "reply_to_post_number": null,
+      "quote_count": 0,
+      "avg_time": null,
+      "incoming_link_count": 0,
+      "reads": 1,
+      "score": 0.2,
+      "yours": false,
+      "topic_id": 7,
+      "topic_slug": "welcome-to-discourse",
+      "topic_title": "Welcome to Discourse",
+      "topic_html_title": "Welcome to Discourse",
+      "category_id": 1,
+      "display_username": "system",
+      "primary_group_name": null,
+      "primary_group_flair_url": null,
+      "primary_group_flair_bg_color": null,
+      "primary_group_flair_color": null,
+      "version": 1,
+      "can_edit": false,
+      "can_delete": false,
+      "can_recover": false,
+      "can_wiki": false,
+      "user_title": null,
+      "raw": "\nThe first paragraph of this pinned topic will be visible as a welcome message to all new visitors on your homepage. It's important!\n\n**Edit this** into a brief description of your community:\n\n- Who is it for?\n- What can they find here?\n- Why should they come here?\n- Where can they read more (links, resources, etc)?\n\n<img src=\"/images/welcome/discourse-edit-post-animated.gif\" width=\"508\" height=\"106\">\n\nYou may want to close this topic via the admin :wrench: (at the upper right and bottom), so that replies don't pile up on an announcement.",
+      "actions_summary": [],
+      "moderator": true,
+      "admin": true,
+      "staff": true,
+      "user_id": -1,
+      "hidden": false,
+      "trust_level": 4,
+      "deleted_at": null,
+      "user_deleted": false,
+      "edit_reason": null,
+      "can_view_edit_history": true,
+      "wiki": false
+    },
+    {
+      "id": 2,
+      "name": "system",
+      "username": "system",
+      "avatar_template": "/user_avatar/localhost/system/{size}/1_2.png",
+      "created_at": "2020-01-24T23:26:05.551Z",
+      "cooked": "<p>Discussion about this site, its organization, how it works, and how we can improve it.</p>",
+      "post_number": 1,
+      "post_type": 1,
+      "updated_at": "2020-01-24T23:26:05.551Z",
+      "reply_count": 0,
+      "reply_to_post_number": null,
+      "quote_count": 0,
+      "avg_time": null,
+      "incoming_link_count": 0,
+      "reads": 1,
+      "score": 0.2,
+      "yours": false,
+      "topic_id": 2,
+      "topic_slug": "about-the-site-feedback-category",
+      "topic_title": "About the Site Feedback category",
+      "topic_html_title": "About the Site Feedback category",
+      "category_id": 3,
+      "display_username": "system",
+      "primary_group_name": null,
+      "primary_group_flair_url": null,
+      "primary_group_flair_bg_color": null,
+      "primary_group_flair_color": null,
+      "version": 1,
+      "can_edit": false,
+      "can_delete": false,
+      "can_recover": false,
+      "can_wiki": false,
+      "user_title": null,
+      "raw": "Discussion about this site, its organization, how it works, and how we can improve it.",
+      "actions_summary": [],
+      "moderator": true,
+      "admin": true,
+      "staff": true,
+      "user_id": -1,
+      "hidden": false,
+      "trust_level": 4,
+      "deleted_at": null,
+      "user_deleted": false,
+      "edit_reason": null,
+      "can_view_edit_history": true,
+      "wiki": false
+    }
+  ]
+}

data/spec/fixtures/posts_latest.json

@@ -0,0 +1,196 @@
+{
+  "latest_posts": [
+    {
+      "id": 15,
+      "name": null,
+      "username": "johndoe",
+      "avatar_template": "/letter_avatar_proxy/v3/letter/p/df705f/{size}.png",
+      "created_at": "2020-01-25T02:10:07.971Z",
+      "cooked": "<p>holla bullhonky.</p>",
+      "post_number": 2,
+      "post_type": 1,
+      "updated_at": "2020-01-25T02:10:07.971Z",
+      "reply_count": 0,
+      "reply_to_post_number": null,
+      "quote_count": 0,
+      "avg_time": null,
+      "incoming_link_count": 0,
+      "reads": 1,
+      "score": 0.2,
+      "yours": false,
+      "topic_id": 11,
+      "topic_slug": "this-is-an-uncategorized-title",
+      "topic_title": "This is an uncategorized title",
+      "topic_html_title": "This is an uncategorized title",
+      "category_id": 1,
+      "display_username": null,
+      "primary_group_name": null,
+      "primary_group_flair_url": null,
+      "primary_group_flair_bg_color": null,
+      "primary_group_flair_color": null,
+      "version": 1,
+      "can_edit": false,
+      "can_delete": false,
+      "can_recover": false,
+      "can_wiki": false,
+      "user_title": null,
+      "raw": "holla bullhonky.",
+      "actions_summary": [],
+      "moderator": false,
+      "admin": true,
+      "staff": true,
+      "user_id": 1,
+      "hidden": false,
+      "trust_level": 1,
+      "deleted_at": null,
+      "user_deleted": false,
+      "edit_reason": null,
+      "can_view_edit_history": true,
+      "wiki": false
+    },
+    {
+      "id": 14,
+      "name": null,
+      "username": "johndoe",
+      "avatar_template": "/letter_avatar_proxy/v3/letter/p/df705f/{size}.png",
+      "created_at": "2020-01-25T00:58:35.475Z",
+      "cooked": "<p>hi there.  hi there.  hi there.</p>",
+      "post_number": 1,
+      "post_type": 1,
+      "updated_at": "2020-01-25T00:58:35.475Z",
+      "reply_count": 0,
+      "reply_to_post_number": null,
+      "quote_count": 0,
+      "avg_time": null,
+      "incoming_link_count": 0,
+      "reads": 1,
+      "score": 0.2,
+      "yours": false,
+      "topic_id": 11,
+      "topic_slug": "this-is-an-uncategorized-title",
+      "topic_title": "This is an uncategorized title",
+      "topic_html_title": "This is an uncategorized title",
+      "category_id": 1,
+      "display_username": null,
+      "primary_group_name": null,
+      "primary_group_flair_url": null,
+      "primary_group_flair_bg_color": null,
+      "primary_group_flair_color": null,
+      "version": 1,
+      "can_edit": false,
+      "can_delete": false,
+      "can_recover": false,
+      "can_wiki": false,
+      "user_title": null,
+      "raw": "hi there.  hi there.  hi there.",
+      "actions_summary": [],
+      "moderator": false,
+      "admin": true,
+      "staff": true,
+      "user_id": 1,
+      "hidden": false,
+      "trust_level": 1,
+      "deleted_at": null,
+      "user_deleted": false,
+      "edit_reason": null,
+      "can_view_edit_history": true,
+      "wiki": false
+    },
+    {
+      "id": 10,
+      "name": "system",
+      "username": "system",
+      "avatar_template": "/user_avatar/localhost/system/{size}/1_2.png",
+      "created_at": "2020-01-24T23:26:09.014Z",
+      "cooked": "<p>The first paragraph of this pinned topic will be visible as a welcome message to all new visitors on your homepage. It’s important!</p>\n<p><strong>Edit this</strong> into a brief description of your community:</p>\n<ul>\n<li>Who is it for?</li>\n<li>What can they find here?</li>\n<li>Why should they come here?</li>\n<li>Where can they read more (links, resources, etc)?</li>\n</ul>\n<p><img src=\"//localhost/images/welcome/discourse-edit-post-animated.gif\" width=\"508\" height=\"106\"></p>\n<p>You may want to close this topic via the admin <img src=\"//localhost/images/emoji/twitter/wrench.png?v=6\" title=\":wrench:\" class=\"emoji\" alt=\":wrench:\"> (at the upper right and bottom), so that replies don’t pile up on an announcement.</p>",
+      "post_number": 1,
+      "post_type": 1,
+      "updated_at": "2020-01-24T23:26:09.014Z",
+      "reply_count": 0,
+      "reply_to_post_number": null,
+      "quote_count": 0,
+      "avg_time": null,
+      "incoming_link_count": 0,
+      "reads": 1,
+      "score": 0.2,
+      "yours": false,
+      "topic_id": 7,
+      "topic_slug": "welcome-to-discourse",
+      "topic_title": "Welcome to Discourse",
+      "topic_html_title": "Welcome to Discourse",
+      "category_id": 1,
+      "display_username": "system",
+      "primary_group_name": null,
+      "primary_group_flair_url": null,
+      "primary_group_flair_bg_color": null,
+      "primary_group_flair_color": null,
+      "version": 1,
+      "can_edit": false,
+      "can_delete": false,
+      "can_recover": false,
+      "can_wiki": false,
+      "user_title": null,
+      "raw": "\nThe first paragraph of this pinned topic will be visible as a welcome message to all new visitors on your homepage. It's important!\n\n**Edit this** into a brief description of your community:\n\n- Who is it for?\n- What can they find here?\n- Why should they come here?\n- Where can they read more (links, resources, etc)?\n\n<img src=\"/images/welcome/discourse-edit-post-animated.gif\" width=\"508\" height=\"106\">\n\nYou may want to close this topic via the admin :wrench: (at the upper right and bottom), so that replies don't pile up on an announcement.",
+      "actions_summary": [],
+      "moderator": true,
+      "admin": true,
+      "staff": true,
+      "user_id": -1,
+      "hidden": false,
+      "trust_level": 4,
+      "deleted_at": null,
+      "user_deleted": false,
+      "edit_reason": null,
+      "can_view_edit_history": true,
+      "wiki": false
+    },
+    {
+      "id": 2,
+      "name": "system",
+      "username": "system",
+      "avatar_template": "/user_avatar/localhost/system/{size}/1_2.png",
+      "created_at": "2020-01-24T23:26:05.551Z",
+      "cooked": "<p>Discussion about this site, its organization, how it works, and how we can improve it.</p>",
+      "post_number": 1,
+      "post_type": 1,
+      "updated_at": "2020-01-24T23:26:05.551Z",
+      "reply_count": 0,
+      "reply_to_post_number": null,
+      "quote_count": 0,
+      "avg_time": null,
+      "incoming_link_count": 0,
+      "reads": 1,
+      "score": 0.2,
+      "yours": false,
+      "topic_id": 2,
+      "topic_slug": "about-the-site-feedback-category",
+      "topic_title": "About the Site Feedback category",
+      "topic_html_title": "About the Site Feedback category",
+      "category_id": 3,
+      "display_username": "system",
+      "primary_group_name": null,
+      "primary_group_flair_url": null,
+      "primary_group_flair_bg_color": null,
+      "primary_group_flair_color": null,
+      "version": 1,
+      "can_edit": false,
+      "can_delete": false,
+      "can_recover": false,
+      "can_wiki": false,
+      "user_title": null,
+      "raw": "Discussion about this site, its organization, how it works, and how we can improve it.",
+      "actions_summary": [],
+      "moderator": true,
+      "admin": true,
+      "staff": true,
+      "user_id": -1,
+      "hidden": false,
+      "trust_level": 4,
+      "deleted_at": null,
+      "user_deleted": false,
+      "edit_reason": null,
+      "can_view_edit_history": true,
+      "wiki": false
+    }
+  ]
+}

data/spec/fixtures/topic_posts.json

@@ -0,0 +1,60 @@
+{
+  "post_stream":{
+    "posts":[
+      {
+        "id":123456,
+        "name":"Someones Name",
+        "username":"Some-username",
+        "avatar_template":"https://avatars.discourse.org/v4/letter/w/abcd123/{size}.png",
+        "created_at":"2020-01-27T11:32:03.646Z",
+        "cooked":"<p>Some text.</p>",
+        "post_number":2,
+        "post_type":1,
+        "updated_at":"2020-01-27T11:32:03.646Z",
+        "reply_count":0,
+        "reply_to_post_number":null,
+        "quote_count":0,
+        "incoming_link_count":0,
+        "reads":2,
+        "readers_count":1,
+        "score":45.2,
+        "yours":false,
+        "topic_id":57,
+        "topic_slug":"some-topic-slug",
+        "display_username":"Someones Name",
+        "primary_group_name":null,
+        "primary_group_flair_url":null,
+        "primary_group_flair_bg_color":null,
+        "primary_group_flair_color":null,
+        "version":1,
+        "can_edit":true,
+        "can_delete":true,
+        "can_recover":false,
+        "can_wiki":true,
+        "read":true,
+        "user_title":null,
+        "actions_summary":[{"id":2,"count":3,"can_act":true}],
+        "moderator":false,
+        "admin":false,
+        "staff":false,
+        "user_id":123,
+        "hidden":false,
+        "trust_level":3,
+        "deleted_at":null,
+        "user_deleted":false,
+        "edit_reason":null,
+        "can_view_edit_history":true,
+        "wiki":false,
+        "reviewable_id":0,
+        "reviewable_score_count":0,
+        "reviewable_score_pending_count":0,
+        "user_created_at":"2018-01-10T21:29:15.554Z",
+        "user_date_of_birth":null,
+        "can_accept_answer":false,
+        "can_unaccept_answer":false,
+        "accepted_answer":false
+      }
+    ]
+  },
+  "id":57
+}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: discourse_api
 version: !ruby/object:Gem::Version
-  version: 0.38.0
+  version: 0.39.0
 platform: ruby
 authors:
 - Sam Saffron
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-18 00:00:00.000000000 Z
+date: 2020-03-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -145,14 +145,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.67.2
+        version: '0.69'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.67.2
+        version: '0.69'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -181,6 +181,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-discourse
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 description: Discourse API
 email:
 - sam.saffron@gmail.com
@@ -200,6 +228,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- config_example.yml
 - discourse_api.gemspec
 - examples/backups.rb
 - examples/badges.rb
@@ -247,6 +276,7 @@ files:
 - lib/discourse_api/api/users.rb
 - lib/discourse_api/client.rb
 - lib/discourse_api/error.rb
+- lib/discourse_api/example_helper.rb
 - lib/discourse_api/single_sign_on.rb
 - lib/discourse_api/version.rb
 - spec/discourse_api/api/api_key_spec.rb
@@ -293,6 +323,8 @@ files:
 - spec/fixtures/polls_voters.json
 - spec/fixtures/post.json
 - spec/fixtures/post_action_users.json
+- spec/fixtures/posts_before.json
+- spec/fixtures/posts_latest.json
 - spec/fixtures/private_messages.json
 - spec/fixtures/regenerate_api_key.json
 - spec/fixtures/replies.json
@@ -300,6 +332,7 @@ files:
 - spec/fixtures/search.json
 - spec/fixtures/topic.json
 - spec/fixtures/topic_invite_user.json
+- spec/fixtures/topic_posts.json
 - spec/fixtures/topics_created_by.json
 - spec/fixtures/update_trust_level.json
 - spec/fixtures/upload_avatar.json
@@ -335,7 +368,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Allows access to the Discourse API
@@ -384,6 +417,8 @@ test_files:
 - spec/fixtures/polls_voters.json
 - spec/fixtures/post.json
 - spec/fixtures/post_action_users.json
+- spec/fixtures/posts_before.json
+- spec/fixtures/posts_latest.json
 - spec/fixtures/private_messages.json
 - spec/fixtures/regenerate_api_key.json
 - spec/fixtures/replies.json
@@ -391,6 +426,7 @@ test_files:
 - spec/fixtures/search.json
 - spec/fixtures/topic.json
 - spec/fixtures/topic_invite_user.json
+- spec/fixtures/topic_posts.json
 - spec/fixtures/topics_created_by.json
 - spec/fixtures/update_trust_level.json
 - spec/fixtures/upload_avatar.json