Merge pull request #127 from thoughtworks/http_method

Rename method to http_method (Fixes #69)

features/configuration/strict_matchers.feature

@@ -17,7 +17,7 @@ Feature: Strict Matching
       """json
       {
         "request": {
-          "method": "GET",
+          "http_method": "GET",
           "path": "/hello/:id",
           "headers": {
             "Accept": "application/json"
@@ -94,4 +94,4 @@ Feature: Strict Matching
       Exact: {"message":"Hello, world!"}
       Wrong headers: {"message":"Hello, world!"}
       ID placeholder: {"message":"Hello, world!"}
-      """    
+      """

features/generate/generation.feature

@@ -12,7 +12,7 @@ Feature: Contract Generation
     """
         {
         "request": {
-          "method": "GET",
+          "http_method": "GET",
           "path": "/hello",
           "headers": {
             "Accept": "application/json"
@@ -50,7 +50,7 @@ Feature: Contract Generation
         "headers": {
           "Accept": "application/json"
         },
-        "method": "get",
+        "http_method": "get",
         "path": "/hello"
       },
       "response": {
@@ -74,4 +74,4 @@ Feature: Contract Generation
       }
     }
 
-    """
+    """

features/stub/templates.feature

@@ -14,7 +14,7 @@ Feature: Templating
       """json
       {
         "request": {
-          "method": "GET",
+          "http_method": "GET",
           "path": "/hello",
           "headers": {
             "Accept": "application/json"

features/validate/body_only.feature

@@ -28,7 +28,7 @@ Feature: Validation
       """json
       {
         "request": {
-          "method": "GET",
+          "http_method": "GET",
           "path": "/hello",
           "headers": {
             "Accept": "application/json"

features/validate/meta_validation.feature

@@ -9,7 +9,7 @@ Feature: Meta-validation
       """
           {
           "request": {
-            "method": "GET",    
+            "http_method": "GET",
             "path": "/hello_world",
             "headers": {
               "Accept": "application/json"
@@ -75,7 +75,7 @@ Feature: Meta-validation
     """
         {
         "request": {
-          "method": "GET",
+          "http_method": "GET",
           "path": "/hello_world"
         },
 

features/validate/validation.feature

@@ -7,7 +7,7 @@ Feature: Validation
       """
           {
           "request": {
-            "method": "GET",
+            "http_method": "GET",
             "path": "/hello",
             "headers": { "Accept": "application/json" },
             "params": {}

lib/pacto/actors/from_examples.rb

@@ -32,6 +32,7 @@ def build_request(contract, values = {})
           data = contract.request.to_hash
           data['uri'] = contract.request.uri
           data['body'] = example.request.body
+          data['method'] = contract.request.http_method
           Pacto::PactoRequest.new(data)
         else
           @fallback_actor.build_request contract, values

lib/pacto/actors/json_generator.rb

@@ -5,6 +5,7 @@ def self.build_request(contract, _values = {})
         data = contract.request.to_hash
         data['uri'] = contract.request.uri
         data['body'] = JSON::Generator.generate(data['schema'])
+        data['method'] = contract.request.http_method
         Pacto::PactoRequest.new(data)
       end
 

lib/pacto/generator.rb

@@ -61,7 +61,7 @@ def generate_contract(source, request, response)
     def generate_request(request, response, source)
       {
         :headers => @filters.filter_request_headers(request, response),
-        :method => request.method,
+        :http_method => request.method,
         :params => request.uri.query_values,
         :path => request.uri.path,
         :schema => generate_schema(source, request.body)

lib/pacto/native_contract_factory.rb

@@ -14,6 +14,7 @@ def build_from_file(contract_path, host)
       definition['request'].merge!('host' => host)
       body_to_schema(definition, 'request', contract_path)
       body_to_schema(definition, 'response', contract_path)
+      method_to_http_method(definition, contract_path)
       request = RequestClause.new(definition['request'])
       response = ResponseClause.new(definition['response'])
       Contract.new(request: request, response: response, file: contract_path, name: definition['name'], examples: definition['examples'])
@@ -28,5 +29,13 @@ def body_to_schema(definition, section, file)
       Pacto::UI.deprecation "Contract format deprecation: #{section}:body will be moved to #{section}:schema (#{file})"
       definition[section]['schema'] = schema
     end
+
+    def method_to_http_method(definition, file)
+      method = definition['request'].delete 'method'
+      return nil unless method
+
+      Pacto::UI.deprecation "Contract format deprecation: request:method will be moved to request:http_method (#{file})"
+      definition['request']['http_method'] = method
+    end
   end
 end

lib/pacto/request_clause.rb

@@ -3,19 +3,19 @@ class RequestClause < Hashie::Dash
     include Hashie::Extensions::Coercion
     # include Hashie::Extensions::IndifferentAccess # remove this if we cleanup string vs symbol
     property :host # required?
-    property :method, required: true
+    property :http_method, required: true
     property :schema, default: {}
     property :path
     property :headers
     property :params, default: {}
 
     def initialize(definition)
       mash = Hashie::Mash.new definition
-      mash['method'] = normalize(mash['method'])
+      mash['http_method'] = normalize(mash['http_method'])
       super mash
     end
 
-    def method=(method)
+    def http_method=(method)
       normalize(method)
     end
 

lib/pacto/request_pattern.rb

@@ -2,7 +2,7 @@ module Pacto
   class RequestPattern
     def self.for(base_request)
       uri_pattern = UriPattern.for(base_request)
-      WebMock::RequestPattern.new(base_request.method, uri_pattern)
+      WebMock::RequestPattern.new(base_request.http_method, uri_pattern)
     end
   end
 end

lib/pacto/stubs/webmock_adapter.rb

@@ -3,7 +3,7 @@ module Adapters
     module WebMock
       class PactoRequest < Pacto::PactoRequest
         extend Forwardable
-        def_delegators :@webmock_request_signature, :headers, :body, :method, :uri, :to_s
+        def_delegators :@webmock_request_signature, :headers, :method, :body, :uri, :to_s
 
         def initialize(webmock_request_signature)
           @webmock_request_signature = webmock_request_signature
@@ -17,6 +17,7 @@ def path
           @webmock_request_signature.uri.path
         end
       end
+
       class PactoResponse < Pacto::PactoResponse
         extend Forwardable
         def_delegators :@webmock_response, :body, :body=, :headers=, :status=, :to_s
@@ -51,7 +52,7 @@ def initialize(middleware)
       def stub_request!(contract)
         request_clause = contract.request
         uri_pattern = UriPattern.for(request_clause)
-        stub = WebMock.stub_request(request_clause.method, uri_pattern)
+        stub = WebMock.stub_request(request_clause.http_method, uri_pattern)
 
         stub.request_pattern.with(strict_details(request_clause)) if Pacto.configuration.strict_matchers
 
@@ -99,7 +100,7 @@ def strict_details(request)
       end
 
       def webmock_params_key(request)
-        request.method == :get ? :query : :body
+        request.http_method == :get ? :query : :body
       end
     end
   end

resources/contract_schema.json

@@ -16,9 +16,13 @@
     },
     "request": {
       "type": "object",
-      "required": ["method", "path"],
+      "required": ["path"],
       "properties": {
         "method": {
+          "_deprecated": true,
+          "type": "string"
+        },
+        "http_method": {
           "type": "string"
         },
         "path": {
@@ -27,7 +31,7 @@
         "headers": {
           "type": "object"
         },
-        "params": {   
+        "params": {
           "type": "object"
         },
         "body": {
@@ -69,4 +73,4 @@
       }
     }
   }
-}
+}

samples/contracts/localhost/api/echo.json

@@ -2,7 +2,7 @@
   "request": {
     "headers": {
     },
-    "method": "get",
+    "http_method": "get",
     "path": "/api/echo"
   },
   "response": {
@@ -23,4 +23,4 @@
       }
     }
   }
-}
+}

samples/contracts/localhost/api/ping.json

@@ -2,7 +2,7 @@
   "request": {
     "headers": {
     },
-    "method": "get",
+    "http_method": "get",
     "path": "/api/ping"
   },
   "response": {
@@ -34,4 +34,4 @@
       }
     }
   }
-}
+}

spec/fabricators/contract_fabricator.rb

@@ -34,7 +34,7 @@
 Fabricator(:request_clause, from: Pacto::RequestClause) do
   initialize_with { @_klass.new to_hash } # Hash based initialization
   host { 'example.com' }
-  method { 'GET' }
+  http_method { 'GET' }
   path { '/abcd' }
   headers do
     {

spec/fixtures/contracts/contract.json

@@ -1,6 +1,6 @@
 {
   "request": {
-    "method": "GET",
+    "http_method": "GET",
     "path": "/hello_world",
     "headers": {
       "Accept": "application/json"

spec/fixtures/contracts/contract_with_examples.json

@@ -2,7 +2,7 @@
   "request": {
     "headers": {
     },
-    "method": "get",
+    "http_method": "get",
     "path": "/api/echo",
     "schema": {
       "type": "object",
@@ -55,4 +55,4 @@
       }
     }
   }
-}
+}

spec/fixtures/contracts/simple_contract.json

@@ -1,6 +1,6 @@
 {
   "request": {
-    "method": "GET",
+    "http_method": "GET",
     "path": "/hello",
     "headers": {
       "Accept": "application/json"

spec/fixtures/contracts/strict_contract.json

@@ -1,6 +1,6 @@
 {
   "request": {
-    "method": "GET",
+    "http_method": "GET",
     "path": "/strict",
     "headers": {
       "Accept": "application/json"
@@ -31,4 +31,4 @@
       }
     }
   }
-}
+}

spec/fixtures/contracts/templating_contract.json

@@ -1,6 +1,6 @@
 {
   "request": {
-    "method": "GET",
+    "http_method": "GET",
     "path": "/echo",
     "headers": {
       "Accept": "application/json",

spec/unit/pacto/consumer/faraday_driver_spec.rb

@@ -28,8 +28,6 @@ class Consumer
         end
 
         context 'for a POST request' do
-          let(:method)  { 'POST' }
-
           it 'makes the request thru the http client' do
             strategy.execute post_request
             expect(WebMock).to have_requested(:post, 'http://localhost/hello_world?foo=bar')

spec/unit/pacto/contract_spec.rb

@@ -2,7 +2,7 @@ module Pacto
   describe Contract do
     let(:request_clause) do
       Pacto::RequestClause.new(
-        method: 'GET',
+        http_method: 'GET',
         host: 'http://example.com',
         schema:  {
           :type => 'object',

spec/unit/pacto/generator/filters_spec.rb

@@ -7,7 +7,7 @@ class Generator
       let(:request) do
         RequestClause.new(
           host: record_host,
-          method: 'GET',
+          http_method: 'GET',
           path: '/abcd',
           headers: {
             'Server' => ['example.com'],

spec/unit/pacto/generator_spec.rb

@@ -103,7 +103,7 @@ def pretty(obj)
 
         it 'normalizes the request method' do
           generated_request = subject['request']
-          expect(generated_request['method']).to eq(request.method.downcase.to_s)
+          expect(generated_request['http_method']).to eq(request.method.downcase.to_s)
         end
 
         it 'sets the response attributes' do

spec/unit/pacto/request_clause_spec.rb

@@ -11,7 +11,7 @@ module Pacto
     subject(:request) do
       req_hash = {
         host: host,
-        'method'  => method,
+        'http_method'  => method,
         'path'    => path,
         'headers' => headers,
         'params'  => params
@@ -25,17 +25,17 @@ module Pacto
       expect(request.host).to eq host
     end
 
-    describe '#method' do
+    describe '#http_method' do
       it 'delegates to definition' do
-        expect(request.method).to eq :get
+        expect(request.http_method).to eq :get
       end
 
       it 'downcases the method' do
-        expect(request.method).to eq request.method.downcase
+        expect(request.http_method).to eq request.http_method.downcase
       end
 
       it 'returns a symbol' do
-        expect(request.method).to be_kind_of Symbol
+        expect(request.http_method).to be_kind_of Symbol
       end
     end