oauthenticator 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
---- 
-SHA1: 
-  metadata.gz: f69d23d4847799b28bcac89a56d812472727cf3d
-  data.tar.gz: ca253660ea69d85715f8ebe2427f45744e8aec57
-SHA512: 
-  metadata.gz: 7f2a35dc3501fa2542095db00906675fd0f77d40a3f0356e419a35399de4a3cd6ae7086b0420723529a271b6285b33efbdcf908e2b5c55109d81437fbf5fe7e2
-  data.tar.gz: b81c5679eb69fd602b0eb659e3be7c9f4b6df60792237a94aedcba0a47e231ecd9e6f5835fecc5a59b08ba50c42683160d2ca04a5957cccb800a6db5550622db
+---
+SHA1:
+  metadata.gz: 1c1af0773c8a1b3a3d9c3f1868856e19413eb8d6
+  data.tar.gz: 7d25f481acab4498447468b50dafcbd3d3afa87c
+SHA512:
+  metadata.gz: b087ed346c3d4919a29882e7d499cee5a316fa75e0193123617b8e18c0490c1a9791db2a2aac98bf73675736b8ff2741e4859c0c22b3c55dc78442d34bde31b9
+  data.tar.gz: c007f8fa60d9a7b0e1c54af75a56fe81f02faa4f449cba5030c184a59844ef9efc4f05f7a87e05101c41565f36f0ae67acff06a1f033dc2926e1985fef7a0130

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+# 1.3.0
+
+- Make error messages fully-human readable on their own (not requiring context of the error key)
+- Add error_message key to error response, with a sentence of error messages.
+- clarify argument errors
+
 # 1.2.0
 
 - OAuthenticator::RackTestSigner / OAuthenticator.signing_rack_test

data/lib/oauthenticator/parse_authorization.rb

@@ -50,7 +50,7 @@ module OAuthenticator
       duplicates = attributes.reject { |k,v| v.size <= 1 }
       if duplicates.any?
         errors = duplicates.map do |k,vs|
-          {k => "Received multiple instances of Authorization parameter #{k}. Received values were: #{vs.inspect}"}
+          {k => ["Received multiple instances of Authorization parameter #{k}. Received values were: #{vs.inspect}"]}
         end.inject({}, &:update)
         raise DuplicatedParameters.new("Received duplicate parameters: #{duplicates.keys.inspect}", errors)
       end

data/lib/oauthenticator/rack_authenticator.rb

@@ -45,7 +45,7 @@ module OAuthenticator
         oauth_request = oauth_signed_request_class.from_rack_request(request)
         if oauth_request.errors
           log_unauthenticated(env, oauth_request)
-          unauthenticated_response({'errors' => oauth_request.errors})
+          unauthenticated_response(oauth_request.errors)
         else
           log_success(env, oauth_request)
           env["oauth.consumer_key"] = oauth_request.consumer_key
@@ -61,11 +61,24 @@ module OAuthenticator
     # the response for an unauthenticated request. the argument will be a hash with the key 'errors', whose 
     # value is a hash with string keys indicating attributes with errors, and values being arrays of strings 
     # indicating error messages on the attribute key.. 
-    def unauthenticated_response(error_object)
+    def unauthenticated_response(errors)
       # default to a blank realm, I suppose
       realm = @options[:realm] || ''
       response_headers = {"WWW-Authenticate" => %Q(OAuth realm="#{realm}"), 'Content-Type' => 'application/json'}
-      [401, response_headers, [JSON.pretty_generate(error_object)]]
+
+      body = {'errors' => errors}
+      error_message = begin
+        error_values = errors.values.inject([], &:+)
+        if error_values.size <= 1
+          error_values.first
+        else
+          # sentencify with periods 
+          error_values.map { |v| v =~ /\.\s*\z/ ? v : v + '.' }.join(' ')
+        end
+      end
+      body['error_message'] = error_message if error_message
+
+      [401, response_headers, [JSON.pretty_generate(body)]]
     end
 
     # write a log entry regarding an unauthenticated request

data/lib/oauthenticator/signable_request.rb

@@ -69,10 +69,10 @@ module OAuthenticator
       required = %w(request_method uri media_type body)
       required += %w(signature_method consumer_key) unless @attributes['authorization']
       missing = required - @attributes.keys
-      raise ArgumentError, "missing: #{missing.inspect}" if missing.any?
+      raise ArgumentError, "missing required attributes: #{missing.inspect}" if missing.any?
       other_recognized = PROTOCOL_PARAM_KEYS + %w(authorization consumer_secret token_secret realm hash_body?)
       extra = @attributes.keys - (required + other_recognized)
-      raise ArgumentError, "received unrecognized @attributes: #{extra.inspect}" if extra.any?
+      raise ArgumentError, "received unrecognized attributes: #{extra.inspect}" if extra.any?
 
       if @attributes['authorization']
         # this means we are signing an existing request to validate the received signature. don't use defaults.
@@ -297,7 +297,7 @@ module OAuthenticator
     # @return [String]
     def rsa_sha1_signature
       private_key = OpenSSL::PKey::RSA.new(@attributes['consumer_secret'])
-      Base64.encode64(private_key.sign(OpenSSL::Digest::SHA1.new, signature_base)).chomp.gsub(/\n/, '')
+      Base64.encode64(private_key.sign(OpenSSL::Digest::SHA1.new, signature_base)).gsub(/\n/, '')
     end
 
     # signature, with method HMAC-SHA1. section 3.4.2
@@ -306,7 +306,7 @@ module OAuthenticator
     def hmac_sha1_signature
       # hmac secret is same as plaintext signature 
       secret = plaintext_signature
-      Base64.encode64(OpenSSL::HMAC.digest(OpenSSL::Digest::SHA1.new, secret, signature_base)).chomp.gsub(/\n/, '')
+      Base64.encode64(OpenSSL::HMAC.digest(OpenSSL::Digest::SHA1.new, secret, signature_base)).gsub(/\n/, '')
     end
 
     # signature, with method plaintext. section 3.4.4
@@ -320,7 +320,7 @@ module OAuthenticator
     #
     # @return [String]
     def sha1_body_hash
-      Base64.encode64(OpenSSL::Digest::SHA1.digest(read_body)).chomp.gsub(/\n/, '')
+      Base64.encode64(OpenSSL::Digest::SHA1.digest(read_body)).gsub(/\n/, '')
     end
 
     # map of oauth signature methods to their signature instance methods on this class 

data/lib/oauthenticator/signed_request.rb

@@ -112,22 +112,22 @@ module OAuthenticator
         # timestamp
         if !timestamp?
           unless signature_method == 'PLAINTEXT'
-            errors['Authorization oauth_timestamp'] << "is missing"
+            errors['Authorization oauth_timestamp'] << "Authorization oauth_timestamp is missing"
           end
         elsif timestamp !~ /\A\s*\d+\s*\z/
-          errors['Authorization oauth_timestamp'] << "is not an integer - got: #{timestamp}"
+          errors['Authorization oauth_timestamp'] << "Authorization oauth_timestamp is not an integer - got: #{timestamp}"
         else
           timestamp_i = timestamp.to_i
           if timestamp_i < Time.now.to_i - timestamp_valid_past
-            errors['Authorization oauth_timestamp'] << "is too old: #{timestamp}"
+            errors['Authorization oauth_timestamp'] << "Authorization oauth_timestamp is too old: #{timestamp}"
           elsif timestamp_i > Time.now.to_i + timestamp_valid_future
-            errors['Authorization oauth_timestamp'] << "is too far in the future: #{timestamp}"
+            errors['Authorization oauth_timestamp'] << "Authorization oauth_timestamp is too far in the future: #{timestamp}"
           end
         end
 
         # oauth version
         if version? && version != '1.0'
-          errors['Authorization oauth_version'] << "must be 1.0; got: #{version}"
+          errors['Authorization oauth_version'] << "Authorization oauth_version must be 1.0; got: #{version}"
         end
 
         # she's filled with secrets
@@ -135,11 +135,11 @@ module OAuthenticator
 
         # consumer / client application
         if !consumer_key?
-          errors['Authorization oauth_consumer_key'] << "is missing"
+          errors['Authorization oauth_consumer_key'] << "Authorization oauth_consumer_key is missing"
         else
           secrets[:consumer_secret] = consumer_secret
           if !secrets[:consumer_secret]
-            errors['Authorization oauth_consumer_key'] << 'is invalid'
+            errors['Authorization oauth_consumer_key'] << 'Authorization oauth_consumer_key is invalid'
           end
         end
 
@@ -147,32 +147,32 @@ module OAuthenticator
         if token?
           secrets[:token_secret] = token_secret
           if !secrets[:token_secret]
-            errors['Authorization oauth_token'] << 'is invalid'
+            errors['Authorization oauth_token'] << 'Authorization oauth_token is invalid'
           elsif !token_belongs_to_consumer?
-            errors['Authorization oauth_token'] << 'does not belong to the specified consumer'
+            errors['Authorization oauth_token'] << 'Authorization oauth_token does not belong to the specified consumer'
           end
         end
 
         # nonce
         if !nonce?
           unless signature_method == 'PLAINTEXT'
-            errors['Authorization oauth_nonce'] << "is missing"
+            errors['Authorization oauth_nonce'] << "Authorization oauth_nonce is missing"
           end
         elsif nonce_used?
-          errors['Authorization oauth_nonce'] << "has already been used"
+          errors['Authorization oauth_nonce'] << "Authorization oauth_nonce has already been used"
         end
 
         # signature method
         if !signature_method?
-          errors['Authorization oauth_signature_method'] << "is missing"
+          errors['Authorization oauth_signature_method'] << "Authorization oauth_signature_method is missing"
         elsif !allowed_signature_methods.any? { |sm| signature_method.downcase == sm.downcase }
-          errors['Authorization oauth_signature_method'] << "must be one of " +
+          errors['Authorization oauth_signature_method'] << "Authorization oauth_signature_method must be one of " +
             "#{allowed_signature_methods.join(', ')}; got: #{signature_method}"
         end
 
         # signature
         if !signature?
-          errors['Authorization oauth_signature'] << "is missing"
+          errors['Authorization oauth_signature'] << "Authorization oauth_signature is missing"
         end
 
         signable_request = SignableRequest.new(@attributes.merge(secrets).merge('authorization' => oauth_header_params))
@@ -189,21 +189,21 @@ module OAuthenticator
               if body_hash == signable_request.body_hash
                 # all good
               else
-                errors['Authorization oauth_body_hash'] << "is invalid"
+                errors['Authorization oauth_body_hash'] << "Authorization oauth_body_hash is invalid"
               end
             else
               # received a body hash with plaintext. weird situation - we will ignore it; signature will not 
               # be verified but it will be a part of the signature. 
             end
           else
-            errors['Authorization oauth_body_hash'] << "must not be included with form-encoded requests"
+            errors['Authorization oauth_body_hash'] << "Authorization oauth_body_hash must not be included with form-encoded requests"
           end
         else
           # allowed?
           if !signable_request.form_encoded?
             # required?
             if body_hash_required?
-              errors['Authorization oauth_body_hash'] << "is required (on non-form-encoded requests)"
+              errors['Authorization oauth_body_hash'] << "Authorization oauth_body_hash is required (on non-form-encoded requests)"
             else
               # okay - not supported by client, but allowed
             end
@@ -216,14 +216,14 @@ module OAuthenticator
 
         # proceed to check signature
         unless self.signature == signable_request.signature
-          throw(:errors, {'Authorization oauth_signature' => ['is invalid']})
+          throw(:errors, {'Authorization oauth_signature' => ['Authorization oauth_signature is invalid']})
         end
 
         if nonce?
           begin
             use_nonce!
           rescue NonceUsedError
-            throw(:errors, {'Authorization oauth_nonce' => ['has already been used']})
+            throw(:errors, {'Authorization oauth_nonce' => ['Authorization oauth_nonce has already been used']})
           end
         end
 

data/lib/oauthenticator/version.rb

@@ -1,5 +1,5 @@
 # OAuthenticator 
 module OAuthenticator
   # OAuthenticator::VERSION
-  VERSION = "1.2.0"
+  VERSION = "1.3.0"
 end

metadata

@@ -1,133 +1,196 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: oauthenticator
-version: !ruby/object:Gem::Version 
-  version: 1.2.0
+version: !ruby/object:Gem::Version
+  version: 1.3.0
 platform: ruby
-authors: 
+authors:
 - Ethan
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2014-06-25 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2014-11-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: rack
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        version: "1.4"
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: json
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        version: "1.8"
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
   type: :runtime
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: faraday
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        version: "0.9"
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
   type: :runtime
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: addressable
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        version: "2.3"
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
   type: :runtime
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
-  name: rake
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
-    requirements: 
-    - &id006 
-      - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id005
-- !ruby/object:Gem::Dependency 
-  name: minitest
   prerelease: false
-  requirement: &id007 !ruby/object:Gem::Requirement 
-    requirements: 
-    - *id006
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id007
-- !ruby/object:Gem::Dependency 
-  name: minitest-reporters
   prerelease: false
-  requirement: &id008 !ruby/object:Gem::Requirement 
-    requirements: 
-    - *id006
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id008
-- !ruby/object:Gem::Dependency 
-  name: rack-test
   prerelease: false
-  requirement: &id009 !ruby/object:Gem::Requirement 
-    requirements: 
-    - *id006
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id009
-- !ruby/object:Gem::Dependency 
-  name: timecop
   prerelease: false
-  requirement: &id010 !ruby/object:Gem::Requirement 
-    requirements: 
-    - *id006
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id010
-- !ruby/object:Gem::Dependency 
-  name: simplecov
   prerelease: false
-  requirement: &id011 !ruby/object:Gem::Requirement 
-    requirements: 
-    - *id006
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id011
-- !ruby/object:Gem::Dependency 
-  name: api_hammer
   prerelease: false
-  requirement: &id012 !ruby/object:Gem::Requirement 
-    requirements: 
-    - *id006
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: api_hammer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id012
-- !ruby/object:Gem::Dependency 
-  name: yard
   prerelease: false
-  requirement: &id013 !ruby/object:Gem::Requirement 
-    requirements: 
-    - *id006
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id013
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: OAuthenticator signs and authenticates OAuth 1.0 requests
-email: 
+email:
 - ethan@unth
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
+- ".simplecov"
+- ".yardopts"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile.rb
 - lib/oauthenticator.rb
 - lib/oauthenticator/config_methods.rb
 - lib/oauthenticator/faraday_signer.rb
@@ -137,11 +200,6 @@ files:
 - lib/oauthenticator/signable_request.rb
 - lib/oauthenticator/signed_request.rb
 - lib/oauthenticator/version.rb
-- .yardopts
-- LICENSE.txt
-- CHANGELOG.md
-- README.md
-- Rakefile.rb
 - test/config_methods_test.rb
 - test/faraday_signer_test.rb
 - test/helper.rb
@@ -151,31 +209,31 @@ files:
 - test/signable_request_test.rb
 - test/signed_request_test.rb
 - test/test_config_methods.rb
-- .simplecov
 homepage: https://github.com/notEthan/oauthenticator
-licenses: 
+licenses:
 - MIT
 metadata: {}
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - *id006
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - *id006
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 2.0.14
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: OAuth 1.0 request signing and authentication
-test_files: 
+test_files:
 - test/config_methods_test.rb
 - test/faraday_signer_test.rb
 - test/helper.rb
@@ -185,4 +243,5 @@ test_files:
 - test/signable_request_test.rb
 - test/signed_request_test.rb
 - test/test_config_methods.rb
-- .simplecov
+- ".simplecov"
+has_rdoc: