discourse_api 0.13.0 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b5e090466c70d88bfb066f1c386941a3ef8dfef2
-  data.tar.gz: 5f0d7f3b8ce464254a7d60dcab7f0cf5278da843
+  metadata.gz: a2f179ec13fc9566ae7d24d6221d37daa6c25151
+  data.tar.gz: ea37ff2e519badc32e263b0b2e5a735f85f089c1
 SHA512:
-  metadata.gz: de5bfc7a37df4f79cce7c1ccc357f47e9e7f6335f723b1577ef3743d19e55b503d8c6ccbdfd8beec9989ae31f86dd1d7396df6b2ad21b455a4f3403c65517d10
-  data.tar.gz: 3a2020987363559ec2bd44080716d4bfe526c81d169cfeeb8ce467f80c83576bed655f6cbe9866c57f8aac93c4373465f5a9d8932636a8c6c5d677599a04aa86
+  metadata.gz: fc09d50774412963b6aa4801d4008565b3a925be812a97a226950b8562ebf1c6214651b5b95aab4c2110943994710728aa3f3ee194c34a1646343bd492aac7c0
+  data.tar.gz: 05921ec9da249ba553a0a83b6f9ae64bd83d6f17413fb109114d7cec892bb6303be7964b7398029b3a170f7a7adb852beddfda9cefe1614019569d2bbb5ad17b

data/CHANGELOG.md

@@ -2,6 +2,11 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+## [0.14.0] - 2016-10-30
+### Added
+- improved error responses by adding `NotFoundError`, `UnprocessableEntity`, and `TooManyRequests`
+- added `delete_post` method
+
 ## [0.13.0] - 2016-10-09
 ### Added
 - added `update_category`

data/examples/badges.rb

@@ -0,0 +1,28 @@
+$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 badges
+puts client.badges
+
+# get badges for a user
+puts client.user_badges("test-user")
+
+# Grants a badge to a user.
+puts client.grant_user_badge(badge_id: 9, username: "test-user", reason: "Really nice person")
+
+# Creates a new badge
+
+###
+# Required params:
+#   :name, :badge_type_id (gold: 1, bronze: 3, silver: 2)
+# Optional params:
+#   :description, :allow_title, :multiple_grant, :icon, :listable,
+#   :target_posts, :query, :enabled, :auto_revoke, :badge_grouping_id,
+#   :trigger, :show_posts, :image, :long_description
+###
+
+puts client.create_badge(name: "Shiny new badge", badge_type_id: 1)

data/lib/discourse_api/api/posts.rb

@@ -28,6 +28,10 @@ module DiscourseApi
         put("/posts/#{id}", post: {raw: raw})
       end
 
+      def delete_post(id)
+        delete("/posts/#{id}.json")
+      end
+
       def destroy_post_action(post_id, post_action_type_id)
         delete("/post_actions/#{post_id}.json", post_action_type_id: post_action_type_id)
       end

data/lib/discourse_api/client.rb

@@ -129,6 +129,12 @@ module DiscourseApi
       case response.status
       when 403
         raise DiscourseApi::UnauthenticatedError.new(response.env[:body])
+      when 404, 410
+        raise DiscourseApi::NotFoundError.new(response.env[:body])
+      when 422
+        raise DiscourseApi::UnprocessableEntity.new(response.env[:body])
+      when 429
+        raise DiscourseApi::TooManyRequests.new(response.env[:body])
       end
     end
   end

data/lib/discourse_api/error.rb

@@ -14,4 +14,13 @@ module DiscourseApi
 
   class UnauthenticatedError < StandardError
   end
+
+  class NotFoundError < StandardError
+  end
+
+  class UnprocessableEntity < StandardError
+  end
+
+  class TooManyRequests < StandardError
+  end
 end

data/lib/discourse_api/version.rb

@@ -1,3 +1,3 @@
 module DiscourseApi
-  VERSION = "0.13.0"
+  VERSION = "0.14.0"
 end

data/spec/discourse_api/api/posts_spec.rb

@@ -26,6 +26,17 @@ describe DiscourseApi::API::Posts do
     end
   end
 
+  describe "#delete_post" do
+    before do
+      stub_delete("http://localhost:3000/posts/9999.json?api_key=test_d7fd0429940&api_username=test_user")
+    end
+
+    it "deletes a post" do
+      client.delete_post(9999)
+      expect(a_delete("http://localhost:3000/posts/9999.json?api_key=test_d7fd0429940&api_username=test_user")).to have_been_made
+    end
+  end
+
   describe "#post_action_users" do
     before do
       stub_get("http://localhost:3000/post_action_users.json?api_key=test_d7fd0429940&api_username=test_user&id=11&post_action_type_id=2").to_return(body: fixture("post_action_users.json"), headers: { content_type: "application/json" })

data/spec/discourse_api/api/users_spec.rb

@@ -146,7 +146,7 @@ describe DiscourseApi::API::Users do
     end
 
     it "Raises API Error" do
-      expect{subject.log_out(90)}.to raise_error DiscourseApi::Error
+      expect{subject.log_out(90)}.to raise_error DiscourseApi::NotFoundError
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: discourse_api
 version: !ruby/object:Gem::Version
-  version: 0.13.0
+  version: 0.14.0
 platform: ruby
 authors:
 - Sam Saffron
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-09 00:00:00.000000000 Z
+date: 2016-10-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -187,6 +187,7 @@ files:
 - Rakefile
 - discourse_api.gemspec
 - examples/backups.rb
+- examples/badges.rb
 - examples/category.rb
 - examples/change_topic_status.rb
 - examples/create_topic.rb