restful_api_authentication 0.2.0 → 0.2.1

data/CHANGELOG.md

@@ -2,7 +2,7 @@
 
 ## Version 0.2.0
 
-* Added verbose error messaging; if this is enabled in the YML config file, then the response to an authentication failure will be more descriptive as to why the authentication failed.
+* Added verbose error messaging; if this is enabled in the YML config file, then the response to an authentication failure will be more descriptive as to why the authentication failed. To enable, add `verbose_errors: true` to the `config/restful_api_authentication.yml`.
 
 ## Version 0.1.2
 

data/README.md

@@ -100,6 +100,14 @@ puts result.inspect
 
 In the `config/restful_api_authentication.yml` file you will find several things that you can change. The defaults are usually fine for most cases.
 
+#### Verbose Error Messages (>= 0.2.0)
+
+By default, the standard response to any authentication error is "not authorized". However, more meaningful explanations of why authentication is failing can be sent by adding the following to the `config/restful_api_authentication.yml` file:
+
+```
+verbose_errors: true
+```
+
 ### Requiring Authentication
 
 To require authentication for a specific resource (controller) of your RESTful web service, add this at the top of your controller just under where you open the controller class:

data/lib/restful_api_authentication/railtie.rb

@@ -30,12 +30,17 @@ module RestfulApiAuthentication
       RestfulApiAuthentication::Checker.header_api_key   = 'x-api-key'
       RestfulApiAuthentication::Checker.verbose_errors   = false
       if File.exists? Rails.root.join('config', 'restful_api_authentication.yml')
-        config_data = YAML::load_file(Rails.root.join('config', 'restful_api_authentication.yml'))[Rails.env]
-        RestfulApiAuthentication::Checker.time_window      ||= config_data['request_window']
-        RestfulApiAuthentication::Checker.header_timestamp ||= config_data['header_names']['timestamp']
-        RestfulApiAuthentication::Checker.header_signature ||= config_data['header_names']['signature']
-        RestfulApiAuthentication::Checker.header_api_key   ||= config_data['header_names']['api_key']
-        RestfulApiAuthentication::Checker.verbose_errors   ||= config_data['verbose_errors']
+        begin
+          config_data = YAML::load_file(Rails.root.join('config', 'restful_api_authentication.yml'))[Rails.env]
+          RestfulApiAuthentication::Checker.time_window      = config_data['request_window'].to_i unless config_data['request_window'].nil?
+          RestfulApiAuthentication::Checker.header_timestamp = config_data['header_names']['timestamp'] unless config_data['header_names'].nil? or config_data['header_names']['timestamp'].nil?
+          RestfulApiAuthentication::Checker.header_signature = config_data['header_names']['signature'] unless config_data['header_names'].nil? or config_data['header_names']['signature'].nil?
+          RestfulApiAuthentication::Checker.header_api_key   = config_data['header_names']['api_key'] unless config_data['header_names'].nil? or config_data['header_names']['api_key'].nil?
+          RestfulApiAuthentication::Checker.verbose_errors   = config_data['verbose_errors'] unless config_data['verbose_errors'].nil?
+        rescue Exception => e
+          # do nothing here -- we already have set the defaults
+          Rails.logger.debug e.message
+        end
       end
     end
   end

data/lib/restful_api_authentication/version.rb

@@ -22,5 +22,5 @@
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
 module RestfulApiAuthentication
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: restful_api_authentication
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-25 00:00:00.000000000 Z
+date: 2012-06-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &70141551581760 !ruby/object:Gem::Requirement
+  requirement: &70131007101400 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: 3.2.0
   type: :runtime
   prerelease: false
-  version_requirements: *70141551581760
+  version_requirements: *70131007101400
 - !ruby/object:Gem::Dependency
   name: uuid
-  requirement: &70141551581260 !ruby/object:Gem::Requirement
+  requirement: &70131007100900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: 2.3.5
   type: :runtime
   prerelease: false
-  version_requirements: *70141551581260
+  version_requirements: *70131007100900
 - !ruby/object:Gem::Dependency
   name: chronic
-  requirement: &70141551580780 !ruby/object:Gem::Requirement
+  requirement: &70131007100420 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,7 +43,7 @@ dependencies:
         version: 0.6.7
   type: :runtime
   prerelease: false
-  version_requirements: *70141551580780
+  version_requirements: *70131007100420
 description: A gem which implements a standard api_key / secret authentication system
   for your Ruby on Rails RESTful web services.
 email: