Installation

gem 'discourse_api'

$ bundle

$ gem install discourse_api

Usage

client=DiscourseApi::Client.new("http://try.discourse.org")client.api_key="YOUR_API_KEY"client.api_username="YOUR_USERNAME"client.ssl(...)#=> specify SSL connection settings if needed# Topic endpointsclient.latest_topics#=> Gets a list of the latest topicsclient.new_topics#=> Gets a list of new topicsclient.topics_by("sam")#=> Gets a list of topics created by user "sam"client.topic(57)#=> Gets the topic with id 57# Search endpointclient.search("sandbox")#=> Gets a list of topics that match "sandbox"# Categories endpointclient.categories#=> Gets a list of categoriesclient.category_latest_topics(category_slug:"lounge")#=> Gets a list of latest topics in a category# SSO endpointclient.sync_sso(#=> Synchronizes the SSO recordsso_secret:"discourse_sso_rocks",name:"Test Name",username:"test_name",email:"name@example.com",external_id:"2",custom_fields:{field_1:'potato'})# Private messagesclient.private_messages("test_user")#=> Gets a list of private messages received by "test_user"client.sent_private_messages("test_user")#=> Gets a list of private messages sent by "test_user"client.create_private_message(#=> Creates a private messages by api_username usertitle:"Confidential: Hello World!",raw:"This is the raw markdown for my private message",target_usernames:"user1,user2")

beginclient.create_group({name:'NO'})rescueDiscourseApi::UnprocessableEntity=>error# `body` is something like `{ errors: ["Name must be at least 3 characters"] }`# This outputs "Name must be at least 3 characters"putserror.response.body['errors'].firstend

client.basic_auth={user:"test",password:"secret"}

Contributing

Testing