http_signatures 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d470a2f4d0e20f91439770b757fec53dfe6e0cf7
-  data.tar.gz: 44e3fc97e52f403f4a71c7c0d9aead5440128409
+  metadata.gz: 2f089f43abace9a9b86c3d19ba394ca4029260c2
+  data.tar.gz: d3f055bf4eb80034756d585770be2bffd778b798
 SHA512:
-  metadata.gz: 6ae9785147e0d0d07deec0af632caafdc67ea901eea51ead27c990ef0bc98e9c39b0b465e7961898271f231aa035fd823ff2a9b026f0ed6c6a3a2344d5142fec
-  data.tar.gz: 69334e7da16049f64d3ccba567a4737c75071290c698699111bfae112449d20bdd570295f9a8053948b6dca023502d395df37f435475f682f407907b21b600f3
+  metadata.gz: 6d8a718a78fed672fb5c61b1a43f9d01fc983abf08f5fa97f7156f1d14ceaba5bcd95413f2b47dec8bc154880a7cfa4530b68ffa52cb63a48866a67309249065
+  data.tar.gz: 00be41245a855a9441a0414c1a2c10c5523df24b879f32c3b9c55d2327bb9dfe56b7382304a8e36818e870e0e4479e78830446bcef84daf2b79a410d69639671

data/README.md

@@ -15,10 +15,13 @@ require "http_signatures"
 $context = HttpSignatures::Context.new(
   keys: {"examplekey" => "secret-key-here"},
   algorithm: "hmac-sha256",
-  headers: %w{(request-target) Date Content-Length},
+  headers: ["(request-target)", "Date", "Content-Length"],
 )
 ```
 
+If there's only one key in the `keys` hash, that will be used for signing.
+Otherwise, specify one via `signing_key_id: "examplekey"`.
+
 ### Messages
 
 A message is an HTTP request or response. A subset of the interface of
@@ -29,6 +32,7 @@ of `message#method` and `message#path` for `(request-target)` support.
 ```rb
 require "net/http"
 require "time"
+
 message = Net::HTTP::Get.new(
   "/path?query=123",
   "Date" => Time.now.rfc822,
@@ -39,7 +43,7 @@ message = Net::HTTP::Get.new(
 ### Signing a message
 
 ```rb
-$context.signer("examplekey").sign(message)
+$context.signer.sign(message)
 ```
 
 Now `message` contains the signature headers:

data/lib/http_signatures/context.rb

@@ -1,19 +1,30 @@
 module HttpSignatures
   class Context
 
-    def initialize(keys: {}, algorithm: nil, headers: nil)
+    def initialize(keys: {}, signing_key_id: nil, algorithm: nil, headers: nil)
       @key_store = KeyStore.new(keys)
+      @signing_key_id = signing_key_id
       @algorithm_name = algorithm
       @headers = headers
     end
 
-    def signer(key_id)
+    def signer
       Signer.new(
-        key: @key_store.fetch(key_id),
+        key: signing_key,
         algorithm: Algorithm.create(@algorithm_name),
         header_list: HeaderList.new(@headers),
       )
     end
 
+    private
+
+    def signing_key
+      if @signing_key_id
+        @key_store.fetch(@signing_key_id)
+      else
+        @key_store.only_key
+      end
+    end
+
   end
 end

data/lib/http_signatures/key_store.rb

@@ -10,6 +10,14 @@ module HttpSignatures
       @keys.fetch(id)
     end
 
+    def only_key
+      if @keys.one?
+        @keys.values.first
+      else
+        raise KeyError, "Expected 1 key, found #{@keys.size}"
+      end
+    end
+
     private
 
     def []=(id, secret)

data/lib/http_signatures/version.rb

@@ -1,3 +1,3 @@
 module HttpSignatures
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/spec/context_spec.rb

@@ -2,28 +2,56 @@ require "net/http"
 
 RSpec.describe HttpSignatures::Context do
 
-  subject(:context) do
-    HttpSignatures::Context.new(
-      keys: {"hello" => "world"},
-      algorithm: "null",
-      headers: %w{(request-target) date content-length},
-    )
-  end
-
   let(:message) { Net::HTTP::Get.new("/", "date" => "x", "content-length" => "0") }
 
-  describe "#signer" do
-    it "instantiates Signer with key, algorithm, headers" do
-      expect(HttpSignatures::Signer).to receive(:new) do |args|
-        expect(args[:key]).to eq(HttpSignatures::Key.new(id: "hello", secret: "world"))
-        expect(args[:algorithm].name).to eq("null")
-        expect(args[:header_list].to_a).to eq(%w{(request-target) date content-length})
+  context "with one key in KeyStore, no signing_key_id specified" do
+    subject(:context) do
+      HttpSignatures::Context.new(
+        keys: {"hello" => "world"},
+        algorithm: "null",
+        headers: %w{(request-target) date content-length},
+      )
+    end
+
+    describe "#signer" do
+      it "instantiates Signer with key, algorithm, headers" do
+        expect(HttpSignatures::Signer).to receive(:new) do |args|
+          expect(args[:key]).to eq(HttpSignatures::Key.new(id: "hello", secret: "world"))
+          expect(args[:algorithm].name).to eq("null")
+          expect(args[:header_list].to_a).to eq(%w{(request-target) date content-length})
+        end
+        context.signer
+      end
+
+      it "signs without errors" do
+        context.signer.sign(message)
       end
-      context.signer("hello")
+    end
+  end
+
+  context "with two keys in KeyStore, signing_key_id specified" do
+    subject(:context) do
+      HttpSignatures::Context.new(
+        keys: {"hello" => "world", "another" => "key"},
+        signing_key_id: "another",
+        algorithm: "null",
+        headers: %w{(request-target) date content-length},
+      )
     end
 
-    it "signs without errors" do
-      context.signer("hello").sign(message)
+    describe "#signer" do
+      it "instantiates Signer with key, algorithm, headers" do
+        expect(HttpSignatures::Signer).to receive(:new) do |args|
+          expect(args[:key]).to eq(HttpSignatures::Key.new(id: "another", secret: "key"))
+          expect(args[:algorithm].name).to eq("null")
+          expect(args[:header_list].to_a).to eq(%w{(request-target) date content-length})
+        end
+        context.signer
+      end
+
+      it "signs without errors" do
+        context.signer.sign(message)
+      end
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: http_signatures
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Paul Annesley