discourse_api 0.24.0 → 0.25.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 7035ac6290f7d29c21b40e4b757be7accf00f8c3
-  data.tar.gz: e9904cd1909edf0897e408bf39be92e95718cfcd
+SHA256:
+  metadata.gz: e90f0e873e3f4704e132a4be3b7bc5982c804bf71536c426f90a6008bcf68765
+  data.tar.gz: ab6e8ff566a35424fd5baf81641fef179a73978c7b860fda97dd34c62e597599
 SHA512:
-  metadata.gz: 20e661ccc7fb697d732bebc1aad5819086dbc693885c8de0461bc37bfaa2428cc3f2e89258997fe48d0d5548d89fa612bba6c2b78a7daa5f94801fb2f1d23cf5
-  data.tar.gz: ddda92734e27df622b4633bbe88d99b72744dd52c5c52c904a38fda95c5ae157710bcf4754fd00527476b3e5d26bc535b6cff688d8358ea8e0eaeee23ef821b2
+  metadata.gz: ae8f232c209917ece93c461619873da8e9883f333345a7d5000637aa5a548cc32044fea30e3b5d815910748fafd49cde11969f829d09ecb6e9647a3c2290bd91
+  data.tar.gz: 9980a0850e4597bbc93cd359d38de90f9b3396eed81d73c14b842e7347d2b65bca4db76c5028e441bff67fedb6ce00cfaf2044da37723624a02d327ebe6a0fc3

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.25.0] - 2018-08-15
+### Added
+- Added ability to rescue certain error classes and inspect the response object
+
 ## [0.24.0] - 2018-05-30
 ### Added
 - Added support for custom `user_fields` when creating a user

data/README.md

@@ -66,6 +66,19 @@ client.create_private_message(                  #=> Creates a private messages b
 
 ```
 
+You can handle some basic errors by rescuing from certain error classes and inspecting the response object passed to those errors:
+
+```ruby
+begin
+  client.create_group({ name: 'NO' })
+rescue DiscourseApi::UnprocessableEntity => error
+  # `body` is something like `{ errors: ["Name must be at least 3 characters"] }`
+  # This outputs "Name must be at least 3 characters"
+  puts error.response.body['errors'].first
+end
+```
+
+Check out [lib/discourse_api/error.rb](lib/discourse_api/error.rb) and [lib/discourse_api/client.rb](lib/discourse_api/client.rb)'s `handle_error` method for the types of errors raised by the API.
 
 ## Contributing
 

data/lib/discourse_api/client.rb

@@ -138,13 +138,13 @@ module DiscourseApi
     def handle_error(response)
       case response.status
       when 403
-        raise DiscourseApi::UnauthenticatedError.new(response.env[:body])
+        raise DiscourseApi::UnauthenticatedError.new(response.env[:body], response.env)
       when 404, 410
-        raise DiscourseApi::NotFoundError.new(response.env[:body])
+        raise DiscourseApi::NotFoundError.new(response.env[:body], response.env)
       when 422
-        raise DiscourseApi::UnprocessableEntity.new(response.env[:body])
+        raise DiscourseApi::UnprocessableEntity.new(response.env[:body], response.env)
       when 429
-        raise DiscourseApi::TooManyRequests.new(response.env[:body])
+        raise DiscourseApi::TooManyRequests.new(response.env[:body], response.env)
       when 500...600
         raise DiscourseApi::Error.new(response.env[:body])
       end

data/lib/discourse_api/error.rb

@@ -1,5 +1,11 @@
 module DiscourseApi
   class DiscourseError < StandardError
+    attr_reader :response
+
+    def initialize(message, response = nil)
+      super(message)
+      @response = response
+    end
   end
 
   class Error < DiscourseError

data/lib/discourse_api/version.rb

@@ -1,3 +1,3 @@
 module DiscourseApi
-  VERSION = "0.24.0"
+  VERSION = "0.25.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: discourse_api
 version: !ruby/object:Gem::Version
-  version: 0.24.0
+  version: 0.25.0
 platform: ruby
 authors:
 - Sam Saffron
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-30 00:00:00.000000000 Z
+date: 2018-08-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -307,7 +307,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: Allows access to the Discourse API