Add new client side error type for detecting wrong parameter values.

piotrmurach · piotrmurach · commit 01d9e1fdd310 · 2012-06-12T12:56:58.000+01:00
diff --git a/lib/github_api/error.rb b/lib/github_api/error.rb
@@ -29,6 +29,7 @@ def initialize(message)
   client_error
   invalid_options
   required_params
+  unknown_value
 ].each do |error|
   require "github_api/error/#{error}"
 end
diff --git a/lib/github_api/error/unknown_value.rb b/lib/github_api/error/unknown_value.rb
@@ -0,0 +1,18 @@
+# encoding: utf-8
+
+module Github #:nodoc
+  # Raised when invalid options are passed to a request body
+  module Error
+    class UnknownValue < ClientError
+      def initialize(key, value, permitted)
+        super(
+          generate_message(
+            :problem => "Wrong value of '#{value}' for the parameter: #{key} provided for this request.",
+            :summary => "Github gem checks the request parameters passed to ensure that github api is not hit unnecessairly and fails fast.",
+            :resolution => "Permitted values are: #{permitted}, make sure these are the ones you are using"
+          )
+        )
+      end
+    end
+  end # Error
+end # Github
diff --git a/spec/github/error/unknown_value_spec.rb b/spec/github/error/unknown_value_spec.rb
@@ -0,0 +1,21 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Github::Error::UnknownValue do
+  describe '#message' do
+    let(:error) { described_class.new(:state, 'open', "closed, deleted") }
+
+    it 'contains the problem in the message' do
+      error.message.should include "Wrong value of 'open' for the parameter: state provided for this request"
+    end
+
+    it 'contains the summary in the message' do
+      error.message.should include "Github gem checks the request parameters passed to ensure that github api is not hit unnecessairly and fails fast."
+    end
+
+    it 'contains the resolution in the message' do
+      error.message.should include "Permitted values are: closed, deleted, make sure these are the ones you are using"
+    end
+  end
+end # Github::Error::UnkownValue
