x-signature 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6f1d3f9f8bffd4aee0038f5151d573e1c7ba7e81
-  data.tar.gz: a4d0d93ddf55eb587a9f3bbc6ed93ddd8ed32a6a
+  metadata.gz: 02081a2dfd7d57f2d232b004f29170bcffe731b9
+  data.tar.gz: cbc18ecdf8d074aa9ee839d4aa7b868423dd8495
 SHA512:
-  metadata.gz: cffca84f57a29654d303046bbd17bc380a236a1b6e7373d7e40be49a95d42abd43c17c214bddf0dbb32ded47a4c4a5ba76b7d0b557e47f18b6d64f7f4a52fb57
-  data.tar.gz: 113f54fee2427a91cb33ed554d2512d2ce1314a7b95717bab18a41ca9405c8e9adb3435ec1dd4c1a9cd3b403d3e4b9898e246d32fe857e8569bb77ba8945b01a
+  metadata.gz: 1fa1ec83f927a3c9af48e06cbce24da98c37520949c199ec41be97e2bd998a078b87e89c1d1f98d328d31cbc79c8d7c0a373ee8c951a2201461fee0ef0ef7ba9
+  data.tar.gz: 865f2b7b8f6fc12179ab3e2410cf4cfc828a1bed05bfd8d30c1755bfdf193cd5ef037e2ef032b4a6a7761051cb55876ca51431a7020e1fbc57c9d7f965c45cc6

data/README.md

@@ -22,7 +22,22 @@ Or install it yourself as:
 
 ## Usage
 
-### Rails
+For details check out [API reference](http://www.rubydoc.info/gems/x-signature).
+
+### Signing request
+
+```ruby
+nonce = (Time.now.to_f * 1e3).to_i
+headers['X-Nonce'] = nonce
+headers['X-Signature'] = XSignature::HexSignatureValidator.signature(
+  secret: '42', nonce: nonce, body: 'test', method: 'GET', request_uri: '/path'
+)
+headers['X-Client'] = user.id
+```
+
+### Verifying signature
+
+#### Rails
 
 In the controller:
 

data/lib/x-signature.rb

@@ -19,4 +19,23 @@ module XSignature
   autoload :Base64SignatureValidator, File.expand_path('../x-signature/base64_signature_validator', __FILE__)
   autoload :HexSignatureValidator, File.expand_path('../x-signature/hex_signature_validator', __FILE__)
 
+  class << self
+    attr_writer :signature_header, :client_header, :nonce_header
+
+    def signature_header
+      @signature_header ||= 'HTTP_X_SIGNATURE'
+    end
+
+    def client_header
+      @client_header ||= 'HTTP_X_CLIENT'
+    end
+
+    def nonce_header
+      @nonce_header ||= 'HTTP_X_NONCE'
+    end
+
+    def configure
+      yield self
+    end
+  end
 end

data/lib/x-signature/rails_request_validator.rb

@@ -12,9 +12,9 @@ module XSignature
       request_uri = (URI(env['REQUEST_URI']).request_uri rescue env['REQUEST_URI'])
       params      = {
         secret:      secret,
-        signature:   env['HTTP_X_SIGNATURE'],
-        client:      env['HTTP_X_CLIENT'],
-        nonce:       env['HTTP_X_NONCE'],
+        signature:   env[XSignature.signature_header],
+        client:      env[XSignature.client_header],
+        nonce:       env[XSignature.nonce_header],
         method:      request.method,
         request_uri: request_uri,
         body:        body,

data/lib/x-signature/version.rb

@@ -1,3 +1,3 @@
 module XSignature
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: x-signature
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - AlexanderPavlenko
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-10-26 00:00:00.000000000 Z
+date: 2015-10-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler