discourse_api 0.15.0 → 0.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 90d97e9771aa2f4cb2c06fed9c40b5dc731c19cf
-  data.tar.gz: accbb8997a8343471fd23d156b0746f52551025d
+  metadata.gz: dbc919ed6b4b910836e7c49ee0eeeba549089ab0
+  data.tar.gz: 66a670a076264fed42fc8763358c94a698d2fc0d
 SHA512:
-  metadata.gz: 6f177e29569f3d153f624590a066a3b13b64fda9356242928d114b6ff6bb3d713a1a6677e036c6098be9ac5b35e9e3199a5c10d71b5716f0a98d64569ef31780
-  data.tar.gz: 7573dd18b98da929223a1cb6bfd0d7eda423222dd9a8817f433b744bcc738f53c8b279468b35451c9bb5a263e6e5f50348d1cf51459252349739e1897330fb7b
+  metadata.gz: d29e787eb57d150ee9ceac985e41ac185a56316a2083a59f756e9f4a04ca3bb1ee0440cc772f33198c7222b1ff322dc67080c8ff1ac0610a550938a8b09c4c69
+  data.tar.gz: 696ff6e30a2c947d7a3c4906ebff3cc43b55b71ca7c3c95e77d530b083ceece1a7bf6ffd2899da18a5976f7fc7becc817fc472c572e201f531979e5426b05f6e

data/CHANGELOG.md

@@ -2,6 +2,12 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+## [0.16.0] - 2017-05-14
+### Added
+- added `upload_file`
+### Removed
+- removed `upload_post_image`
+
 ## [0.15.0] - 2017-04-12
 ### Added
 - added the ability to create private messages

data/README.md

@@ -54,6 +54,16 @@ client.sync_sso(                                #=> Synchronizes the SSO record
   email: "name@example.com",
   external_id: "2"
 )
+
+# Private messages
+client.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 user
+  title: "Confidential: Hello World!",
+  raw: "This is the raw markdown for my private message",
+  target_usernames: "user1,user2"
+)
+
 ```
 
 

data/examples/create_private_message.rb

@@ -8,5 +8,5 @@ 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"]
+  target_usernames: "user1,user2"
 )

data/examples/{upload.rb → sent_private_messages.rb}

@@ -5,8 +5,4 @@ client = DiscourseApi::Client.new("http://localhost:3000")
 client.api_key = "YOUR_API_KEY"
 client.api_username = "YOUR_USERNAME"
 
-# Upload an image via file
-client.upload_post_image(file: 'grumpy_cat.gif')
-
-# Upload an image via URL
-client.upload_post_image(url: 'https://giphy.com/grumpy_cat.gif')
+client.sent_private_messages('test_user')

data/examples/upload_file.rb

@@ -0,0 +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"
+
+# Upload a file
+file = Faraday::UploadIO.new('grumpy_cat.pdf', "application/pdf")
+client.upload_file(file: file)
+
+# Upload a file via URL
+client.upload_file(url: 'https://giphy.com/grumpy_cat.gif')

data/lib/discourse_api/api/private_messages.rb

@@ -17,6 +17,11 @@ module DiscourseApi
         response = get("topics/private-messages/#{username}.json", args)
         response[:body]['topic_list']['topics']
       end
+
+      def sent_private_messages(username, *args)
+        response = get("topics/private-messages-sent/#{username}.json", args)
+        response[:body]['topic_list']['topics']
+      end
     end
   end
 end

data/lib/discourse_api/api/uploads.rb

@@ -1,7 +1,7 @@
 module DiscourseApi
   module API
     module Uploads
-      def upload_post_image(args)
+      def upload_file(args)
         args = API.params(args)
                   .optional(:file, :url)
                   .default(type: 'composer', synchronous: true)

data/lib/discourse_api/client.rb

@@ -100,6 +100,8 @@ module DiscourseApi
       @connection ||= Faraday.new connection_options do |conn|
         # Follow redirects
         conn.use FaradayMiddleware::FollowRedirects, limit: 5
+        # Allow uploading of files
+        conn.request :multipart
         # Convert request params to "www-form-encoded"
         conn.request :url_encoded
         # Parse responses as JSON
@@ -135,6 +137,8 @@ module DiscourseApi
         raise DiscourseApi::UnprocessableEntity.new(response.env[:body])
       when 429
         raise DiscourseApi::TooManyRequests.new(response.env[:body])
+      when 500...600
+        raise DiscourseApi::Error.new(response.env[:body])
       end
     end
   end

data/lib/discourse_api/version.rb

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

data/spec/discourse_api/api/private_messages_spec.rb

@@ -19,19 +19,35 @@ describe DiscourseApi::API::PrivateMessages do
     end
   end
 
+  describe "#sent_private_messages" do
+    before do
+      stub_get("http://localhost:3000/topics/private-messages-sent/test_user.json?api_key=test_d7fd0429940&api_username=test_user").to_return(body: fixture("private_messages.json"), headers: { content_type: "application/json" })
+    end
+
+    it "requests the correct resource" do
+      subject.sent_private_messages('test_user')
+      expect(a_get("http://localhost:3000/topics/private-messages-sent/test_user.json?api_key=test_d7fd0429940&api_username=test_user")).to have_been_made
+    end
+
+    it "returns the requested sent private messages" do
+      private_messages = subject.sent_private_messages('test_user')
+      expect(private_messages).to be_an Array
+    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"]
+        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')
+          'archetype=private_message&raw=This+is+the+raw+markdown+for+my+private+message&target_usernames=user1%2Cuser2&title=Confidential%3A+Hello+World%21')
         ).to have_been_made
     end
   end

data/spec/discourse_api/api/uploads_spec.rb

@@ -3,16 +3,24 @@ require 'spec_helper'
 describe DiscourseApi::API::Uploads do
   subject { DiscourseApi::Client.new("http://localhost:3000", "test_d7fd0429940", "test_user") }
 
-  describe "#upload_post_image" do
+  describe "#upload_file" do
     before do
-      stub_post("http://localhost:3000/uploads?api_key=test_d7fd0429940&api_username=test_user").to_return(body: fixture("upload_post_image.json"), headers: { content_type: "application/json" })
+      stub_post("http://localhost:3000/uploads?api_key=test_d7fd0429940&api_username=test_user").to_return(body: fixture("upload_file.json"), headers: { content_type: "application/json" })
     end
 
     it "uploads an image via URL" do
       image = "https://meta-discourse.global.ssl.fastly.net/user_avatar/meta.discourse.org/sam/120/5243.png"
       args = { url: image }
-      response = subject.upload_post_image(args)
+      response = subject.upload_file(args)
       expect(response["url"]).to eq("/uploads/default/original/1X/417e624d2453925e6c68748b9aa67637c284b5aa.jpg")
     end
+
+    it "uploads a file" do
+      file = Faraday::UploadIO.new('spec/fixtures/upload_file.json', "application/json")
+      args = { file: file }
+      response = subject.upload_file(args)
+      expect(response["url"]).to eq("/uploads/default/original/1X/417e624d2453925e6c68748b9aa67637c284b5aa.jpg")
+    end
+
   end
 end

data/spec/discourse_api/client_spec.rb

@@ -102,6 +102,13 @@ describe DiscourseApi::Client do
   end
 
   describe "#request" do
+    it "catches 500 errors" do
+      connection = instance_double(Faraday::Connection)
+      allow(connection).to receive(:get).and_return(OpenStruct.new(env: { body: 'error page html' }, status: 500))
+      allow(subject).to receive(:connection).and_return(connection)
+      expect{subject.send(:request, :get, "/test")}.to raise_error DiscourseApi::Error
+    end
+
     it "catches Faraday errors" do
       allow(subject).to receive(:connection).and_raise(Faraday::Error::ClientError.new("BOOM!"))
       expect{subject.send(:request, :get, "/test")}.to raise_error DiscourseApi::Error

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: discourse_api
 version: !ruby/object:Gem::Version
-  version: 0.15.0
+  version: 0.16.0
 platform: ruby
 authors:
 - Sam Saffron
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-13 00:00:00.000000000 Z
+date: 2017-05-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -201,10 +201,11 @@ files:
 - examples/invite_users.rb
 - examples/post_action.rb
 - examples/search.rb
+- examples/sent_private_messages.rb
 - examples/sso.rb
 - examples/topic_lists.rb
 - examples/update_user.rb
-- examples/upload.rb
+- examples/upload_file.rb
 - lib/discourse_api.rb
 - lib/discourse_api/api/api_key.rb
 - lib/discourse_api/api/backups.rb
@@ -272,7 +273,7 @@ files:
 - spec/fixtures/topics_created_by.json
 - spec/fixtures/update_trust_level.json
 - spec/fixtures/upload_avatar.json
-- spec/fixtures/upload_post_image.json
+- spec/fixtures/upload_file.json
 - spec/fixtures/user.json
 - spec/fixtures/user_activate_success.json
 - spec/fixtures/user_badges.json
@@ -352,7 +353,7 @@ test_files:
 - spec/fixtures/topics_created_by.json
 - spec/fixtures/update_trust_level.json
 - spec/fixtures/upload_avatar.json
-- spec/fixtures/upload_post_image.json
+- spec/fixtures/upload_file.json
 - spec/fixtures/user.json
 - spec/fixtures/user_activate_success.json
 - spec/fixtures/user_badges.json