discourse_api 0.14.1 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ba2465be5a6d174341ef11e71de4d2b498a0e3c8
-  data.tar.gz: 62de6896356366f2a37dd3e71776809437c952b4
+  metadata.gz: 90d97e9771aa2f4cb2c06fed9c40b5dc731c19cf
+  data.tar.gz: accbb8997a8343471fd23d156b0746f52551025d
 SHA512:
-  metadata.gz: 48a9e53c1558dc9ffab527577e7833da53a34f17b2a41037c0f492898fdade56824888d0aa0053fd4c85486524dbd61f6d5f9fd169131ffe8b7e1b85ed926677
-  data.tar.gz: 7550c6806d1534180b63e51ad8a166f9ccea49017bcdaebedaeee821cf99cf23ab973906cfd4f9ccb8c6d9619b2a87fddcd0b8b70565e5ca070f8488754d5ae9
+  metadata.gz: 6f177e29569f3d153f624590a066a3b13b64fda9356242928d114b6ff6bb3d713a1a6677e036c6098be9ac5b35e9e3199a5c10d71b5716f0a98d64569ef31780
+  data.tar.gz: 7573dd18b98da929223a1cb6bfd0d7eda423222dd9a8817f433b744bcc738f53c8b279468b35451c9bb5a263e6e5f50348d1cf51459252349739e1897330fb7b

data/CHANGELOG.md

@@ -2,6 +2,10 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+## [0.15.0] - 2017-04-12
+### Added
+- added the ability to create private messages
+
 ## [0.14.1] - 2016-12-20
 ### Fixed
 - allow for rack 2.0+ versions so that it doesn't clash with rails.

data/README.md

@@ -44,7 +44,7 @@ client.search("sandbox")                        #=> Gets a list of topics that m
 
 # Categories endpoint
 client.categories                               #=> Gets a list of categories
-client.category_latest_posts("category-slug")   #=> Gets a list of latest posts in a category
+client.category_latest_topics(category_slug: "lounge")  #=> Gets a list of latest topics in a category
 
 # SSO endpoint
 client.sync_sso(                                #=> Synchronizes the SSO record

data/examples/create_private_message.rb

@@ -0,0 +1,12 @@
+$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_private_message(
+  title: "Confidential: Hello World!",
+  raw: "This is the raw markdown for my private message",
+  target_usernames: ["user1", "user2"]
+)

data/examples/create_user.rb

@@ -6,9 +6,12 @@ client.api_key = "YOUR_API_KEY"
 client.api_username = "YOUR_USERNAME"
 
 # create user
-client.create_user(
+user = client.create_user(
   name: "Bruce Wayne",
   email: "bruce@wayne.com",
   username: "batman",
   password: "WhySoSerious"
 )
+
+# activate user
+client.activate(user["user_id"])

data/lib/discourse_api/api/private_messages.rb

@@ -1,6 +1,18 @@
 module DiscourseApi
   module API
     module PrivateMessages
+
+      # :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={})
+        args[:archetype] = 'private_message'
+        args = API.params(args)
+                  .required(:title, :raw, :target_usernames, :archetype)
+                  .optional(:category, :created_at, :api_username)
+        post("/posts", args.to_h)
+      end
+
       def private_messages(username, *args)
         response = get("topics/private-messages/#{username}.json", args)
         response[:body]['topic_list']['topics']

data/lib/discourse_api/version.rb

@@ -1,3 +1,3 @@
 module DiscourseApi
-  VERSION = "0.14.1"
+  VERSION = "0.15.0"
 end

data/spec/discourse_api/api/private_messages_spec.rb

@@ -19,4 +19,20 @@ describe DiscourseApi::API::PrivateMessages do
     end
   end
 
+  describe '#create_private_message' do
+    before do
+      stub_post("http://localhost:3000/posts?api_key=test_d7fd0429940&api_username=test_user")
+      subject.create_private_message(
+        title: "Confidential: Hello World!",
+        raw: "This is the raw markdown for my private message",
+        target_usernames: ["user1", "user2"]
+      )
+    end
+
+    it "makes a create private message request" do
+      expect(a_post("http://localhost:3000/posts?api_key=test_d7fd0429940&api_username=test_user").with(body:
+          'archetype=private_message&raw=This+is+the+raw+markdown+for+my+private+message&target_usernames%5B%5D=user1&target_usernames%5B%5D=user2&title=Confidential%3A+Hello+World%21')
+        ).to have_been_made
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: discourse_api
 version: !ruby/object:Gem::Version
-  version: 0.14.1
+  version: 0.15.0
 platform: ruby
 authors:
 - Sam Saffron
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-20 00:00:00.000000000 Z
+date: 2017-04-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -190,6 +190,7 @@ files:
 - examples/badges.rb
 - examples/category.rb
 - examples/change_topic_status.rb
+- examples/create_private_message.rb
 - examples/create_topic.rb
 - examples/create_update_category.rb
 - examples/create_user.rb