feat: respond correctly to OPTIONS requests

pact-foundation · Jun 21, 2018 · c5d3937 · c5d3937
1 parent d6260c1
commit c5d3937
Show file tree

Hide file tree

Showing 37 changed files with 60 additions and 35 deletions.
diff --git a/lib/pact_broker/api/resources/all_webhooks.rb b/lib/pact_broker/api/resources/all_webhooks.rb
@@ -18,7 +18,7 @@ def content_types_accepted
         end
 
         def allowed_methods
-          ["GET", "POST"]
+          ["GET", "POST", "OPTIONS", "OPTIONS"]
         end
 
         def create_path

diff --git a/lib/pact_broker/api/resources/badge.rb b/lib/pact_broker/api/resources/badge.rb
@@ -9,7 +9,7 @@ module Resources
       class Badge < BaseResource
 
         def allowed_methods
-          ['GET']
+          ["GET", "OPTIONS", "OPTIONS"]
         end
 
         def content_types_provided

diff --git a/lib/pact_broker/api/resources/base_resource.rb b/lib/pact_broker/api/resources/base_resource.rb
@@ -30,6 +30,10 @@ def initialize
           PactBroker.configuration.before_resource.call(self)
         end
 
+        def options
+          { 'Access-Control-Allow-Methods' => allowed_methods.join(", ")}
+        end
+
         def update_matrix_after_request?
           false
         end

diff --git a/lib/pact_broker/api/resources/dashboard.rb b/lib/pact_broker/api/resources/dashboard.rb
@@ -16,7 +16,7 @@ def content_types_provided
         end
 
         def allowed_methods
-          ["GET"]
+          ["GET", "OPTIONS"]
         end
 
         def to_json

diff --git a/lib/pact_broker/api/resources/error_test.rb b/lib/pact_broker/api/resources/error_test.rb
@@ -20,7 +20,7 @@ def content_types_accepted
         end
 
         def allowed_methods
-          ["GET", "POST"]
+          ["GET", "POST", "OPTIONS"]
         end
 
         def to_json

diff --git a/lib/pact_broker/api/resources/group.rb b/lib/pact_broker/api/resources/group.rb
@@ -13,7 +13,7 @@ def content_types_provided
         end
 
         def allowed_methods
-          ["GET"]
+          ["GET", "OPTIONS"]
         end
 
         def resource_exists?

diff --git a/lib/pact_broker/api/resources/index.rb b/lib/pact_broker/api/resources/index.rb
@@ -12,7 +12,7 @@ def content_types_provided
         end
 
         def allowed_methods
-          ["GET"]
+          ["GET", "OPTIONS"]
         end
 
         def to_json

diff --git a/lib/pact_broker/api/resources/label.rb b/lib/pact_broker/api/resources/label.rb
@@ -15,7 +15,7 @@ def content_types_accepted
         end
 
         def allowed_methods
-          ["GET","PUT","DELETE"]
+          ["GET", "PUT", "DELETE", "OPTIONS"]
         end
 
         def from_json

diff --git a/lib/pact_broker/api/resources/latest_pact.rb b/lib/pact_broker/api/resources/latest_pact.rb
@@ -14,7 +14,7 @@ def content_types_provided
         end
 
         def allowed_methods
-          ["GET"]
+          ["GET", "OPTIONS"]
         end
 
         def resource_exists?

diff --git a/lib/pact_broker/api/resources/latest_pacts.rb b/lib/pact_broker/api/resources/latest_pacts.rb
@@ -11,7 +11,7 @@ def content_types_provided
         end
 
         def allowed_methods
-          ["GET"]
+          ["GET", "OPTIONS"]
         end
 
         def to_json

diff --git a/lib/pact_broker/api/resources/latest_verifications_for_consumer_version.rb b/lib/pact_broker/api/resources/latest_verifications_for_consumer_version.rb
@@ -11,7 +11,7 @@ module Resources
       class LatestVerificationsForConsumerVersion < BaseResource
 
         def allowed_methods
-          ["GET"]
+          ["GET", "OPTIONS"]
         end
 
         def content_types_provided

diff --git a/lib/pact_broker/api/resources/matrix.rb b/lib/pact_broker/api/resources/matrix.rb
@@ -20,7 +20,7 @@ def content_types_provided
         end
 
         def allowed_methods
-          ["GET"]
+          ["GET", "OPTIONS"]
         end
 
         def malformed_request?

diff --git a/lib/pact_broker/api/resources/matrix_for_consumer_and_provider.rb b/lib/pact_broker/api/resources/matrix_for_consumer_and_provider.rb
@@ -11,7 +11,7 @@ def content_types_provided
         end
 
         def allowed_methods
-          ["GET"]
+          ["GET", "OPTIONS"]
         end
 
         def resource_exists?

diff --git a/lib/pact_broker/api/resources/pact.rb b/lib/pact_broker/api/resources/pact.rb
@@ -34,7 +34,7 @@ def content_types_accepted
         end
 
         def allowed_methods
-          ["GET", "PUT", "DELETE", "PATCH"]
+          ["GET", "PUT", "DELETE", "PATCH", "OPTIONS"]
         end
 
         def known_methods

diff --git a/lib/pact_broker/api/resources/pact_content_diff.rb b/lib/pact_broker/api/resources/pact_content_diff.rb
@@ -11,7 +11,7 @@ def content_types_provided
         end
 
         def allowed_methods
-          ["GET"]
+          ["GET", "OPTIONS"]
         end
 
         def resource_exists?

diff --git a/lib/pact_broker/api/resources/pact_triggered_webhooks.rb b/lib/pact_broker/api/resources/pact_triggered_webhooks.rb
@@ -5,7 +5,7 @@ module Api
     module Resources
       class PactTriggeredWebhooks < BaseResource
         def allowed_methods
-          ["GET"]
+          ["GET", "OPTIONS"]
         end
 
         def content_types_provided

diff --git a/lib/pact_broker/api/resources/pact_version.rb b/lib/pact_broker/api/resources/pact_version.rb
@@ -5,7 +5,7 @@ module Api
     module Resources
       class PactVersion < Pact
         def allowed_methods
-          ["GET"]
+          ["GET", "OPTIONS"]
         end
       end
     end

diff --git a/lib/pact_broker/api/resources/pact_versions.rb b/lib/pact_broker/api/resources/pact_versions.rb
@@ -13,7 +13,7 @@ def content_types_provided
         end
 
         def allowed_methods
-          ["GET"]
+          ["GET", "OPTIONS"]
         end
 
         def resource_exists?

diff --git a/lib/pact_broker/api/resources/pact_webhooks.rb b/lib/pact_broker/api/resources/pact_webhooks.rb
@@ -11,7 +11,7 @@ module Resources
       class PactWebhooks < BaseResource
 
         def allowed_methods
-          ["POST", "GET"]
+          ["POST", "GET", "OPTIONS"]
         end
 
         def content_types_provided

diff --git a/lib/pact_broker/api/resources/pact_webhooks_status.rb b/lib/pact_broker/api/resources/pact_webhooks_status.rb
@@ -9,7 +9,7 @@ module Resources
       class PactWebhooksStatus < BaseResource
 
         def allowed_methods
-          ["GET"]
+          ["GET", "OPTIONS"]
         end
 
         def content_types_provided

diff --git a/lib/pact_broker/api/resources/pacticipant.rb b/lib/pact_broker/api/resources/pacticipant.rb
@@ -23,7 +23,7 @@ def content_types_accepted
         end
 
         def allowed_methods
-          ["GET", "PATCH", "DELETE"]
+          ["GET", "PATCH", "DELETE", "OPTIONS"]
         end
 
         def known_methods

diff --git a/lib/pact_broker/api/resources/pacticipants.rb b/lib/pact_broker/api/resources/pacticipants.rb
@@ -17,7 +17,7 @@ def content_types_accepted
         end
 
         def allowed_methods
-          ["GET", "POST"]
+          ["GET", "POST", "OPTIONS"]
         end
 
         def malformed_request?

diff --git a/lib/pact_broker/api/resources/pacticipants_for_label.rb b/lib/pact_broker/api/resources/pacticipants_for_label.rb
@@ -11,7 +11,7 @@ def content_types_provided
         end
 
         def allowed_methods
-          ["GET"]
+          ["GET", "OPTIONS"]
         end
 
         def to_json

diff --git a/lib/pact_broker/api/resources/previous_distinct_pact_version.rb b/lib/pact_broker/api/resources/previous_distinct_pact_version.rb
@@ -14,7 +14,7 @@ def content_types_provided
         end
 
         def allowed_methods
-          ["GET"]
+          ["GET", "OPTIONS"]
         end
 
         def resource_exists?

diff --git a/lib/pact_broker/api/resources/provider_pacts.rb b/lib/pact_broker/api/resources/provider_pacts.rb
@@ -12,7 +12,7 @@ def content_types_provided
         end
 
         def allowed_methods
-          ["GET"]
+          ["GET", "OPTIONS"]
         end
 
         def resource_exists?

diff --git a/lib/pact_broker/api/resources/relationships.rb b/lib/pact_broker/api/resources/relationships.rb
@@ -12,7 +12,7 @@ def content_types_provided
         end
 
         def allowed_methods
-          ["GET"]
+          ["GET", "OPTIONS"]
         end
 
         def to_csv

diff --git a/lib/pact_broker/api/resources/tag.rb b/lib/pact_broker/api/resources/tag.rb
@@ -14,7 +14,7 @@ def content_types_accepted
         end
 
         def allowed_methods
-          ["GET","PUT","DELETE"]
+          ["GET","PUT","DELETE", "OPTIONS"]
         end
 
         def from_json

diff --git a/lib/pact_broker/api/resources/triggered_webhook_logs.rb b/lib/pact_broker/api/resources/triggered_webhook_logs.rb
@@ -12,7 +12,7 @@ def content_types_provided
         end
 
         def allowed_methods
-          ["GET"]
+          ["GET", "OPTIONS"]
         end
 
         def resource_exists?

diff --git a/lib/pact_broker/api/resources/verification.rb b/lib/pact_broker/api/resources/verification.rb
@@ -15,7 +15,7 @@ def content_types_provided
         end
 
         def allowed_methods
-          ["GET"]
+          ["GET", "OPTIONS"]
         end
 
         def resource_exists?

diff --git a/lib/pact_broker/api/resources/verification_triggered_webhooks.rb b/lib/pact_broker/api/resources/verification_triggered_webhooks.rb
@@ -5,7 +5,7 @@ module Api
     module Resources
       class VerificationTriggeredWebhooks < BaseResource
         def allowed_methods
-          ["GET"]
+          ["GET", "OPTIONS"]
         end
 
         def content_types_provided

diff --git a/lib/pact_broker/api/resources/verifications.rb b/lib/pact_broker/api/resources/verifications.rb
@@ -19,7 +19,7 @@ def content_types_provided
         end
 
         def allowed_methods
-          ["POST"]
+          ["POST", "OPTIONS"]
         end
 
         def post_is_create?

diff --git a/lib/pact_broker/api/resources/version.rb b/lib/pact_broker/api/resources/version.rb
@@ -13,7 +13,7 @@ def content_types_provided
         end
 
         def allowed_methods
-          ["GET", "DELETE"]
+          ["GET", "DELETE", "OPTIONS"]
         end
 
         def resource_exists?

diff --git a/lib/pact_broker/api/resources/versions.rb b/lib/pact_broker/api/resources/versions.rb
@@ -13,7 +13,7 @@ def content_types_provided
         end
 
         def allowed_methods
-          ["GET"]
+          ["GET", "OPTIONS"]
         end
 
         def resource_exists?

diff --git a/lib/pact_broker/api/resources/webhook.rb b/lib/pact_broker/api/resources/webhook.rb
@@ -17,7 +17,7 @@ def content_types_provided
         end
 
         def allowed_methods
-          ["GET", "PUT", "DELETE"]
+          ["GET", "PUT", "DELETE", "OPTIONS"]
         end
 
         def resource_exists?

diff --git a/lib/pact_broker/api/resources/webhook_execution.rb b/lib/pact_broker/api/resources/webhook_execution.rb
@@ -10,7 +10,7 @@ module Resources
       class WebhookExecution < BaseResource
 
         def allowed_methods
-          ["POST"]
+          ["POST", "OPTIONS"]
         end
 
         def process_post

diff --git a/lib/pact_broker/api/resources/webhooks.rb b/lib/pact_broker/api/resources/webhooks.rb
@@ -9,7 +9,7 @@ module Resources
       class Webhooks < BaseResource
 
         def allowed_methods
-          ["POST", "GET"]
+          ["POST", "GET", "OPTIONS"]
         end
 
         def content_types_provided

diff --git a/spec/lib/pact_broker/api/resources/base_resource_spec.rb b/spec/lib/pact_broker/api/resources/base_resource_spec.rb
@@ -11,6 +11,27 @@ module Resources
         subject { BaseResource.new(request, response) }
 
         its(:resource_url) { is_expected.to eq 'http://example.org/path' }
+
+        describe "options" do
+          subject { options "/"; last_response }
+
+          it "returns a list of allowed methods" do
+            expect(subject.headers['Access-Control-Allow-Methods']).to eq "GET, OPTIONS"
+          end
+        end
+      end
+
+      ALL_RESOURCES = ObjectSpace.each_object(::Class).select {|klass| klass < BaseResource }
+
+      ALL_RESOURCES.each do | resource |
+        describe resource do
+          let(:request) { double('request', uri: URI("http://example.org")) }
+          let(:response) { double('response') }
+
+          it "includes OPTIONS in the list of allowed_methods" do
+            expect(resource.new(request, response).allowed_methods).to include "OPTIONS"
+          end
+        end
       end
     end
   end
-Original file line number
+Diff line change
@@ Expand Up / @@ -16,7 +16,7 @@ def content_types_provided @@
             end
             def allowed_methods
-              ["GET"]
+              ["GET", "OPTIONS"]
             end
             def to_json
@@ Expand Down @@