wiremock_mapper 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 55d9acc4792e98d17662839d6b79f75012069f76
-  data.tar.gz: 86e81e72776ba7a27d9320529131bc19a5c74a77
+  metadata.gz: c55d34c227d457aecbfb8fc48fe1540c4fff8e6a
+  data.tar.gz: 7ea5eb65ccde458834d9773833a415d89f4f8985
 SHA512:
-  metadata.gz: 14cb6170c8b802ba1ea5d66886f139406fcc43ef10db2afaa8a754cb88bde9dfc9fac0db80c5620f2462642bc4fbc60e6684022505b6516f9aab078e5b46efc9
-  data.tar.gz: 39c74d269f1d2a76b3fdc8a68f1d950cdeeb61b797cc0c0df88695bf62ef4ae5fafa5e85f3596b4b58068d5c04f35b2c240675b4cf12c2ee56320810c3066a31
+  metadata.gz: b465342380e86cf5bcbbe1bfbe33de1d550cb05541c645fd894770b2f65800df035e8d95c914d618987fc8753596e96ece081af0709da76a6755ef3ce8b1641a
+  data.tar.gz: 37e5c4cf467e3017efbc48fefe3ed00b1a24b6c538b70463172202100093f65464ed51e2f8fb926446c2ce69bc8388d11b406cb1047d3fc47beaf6fa4975b94b

data/lib/configuration.rb

@@ -6,10 +6,16 @@ module WireMockMapper
     class << self
       attr_reader :request_headers, :wiremock_url
 
+
+      # Add a request header for all future requests
+      # @param key [String] header key
+      # @return [MatchBuilder] match builder to declare the match on the header
       def add_request_header(key)
         @request_headers[key] = MatchBuilder.new(self)
       end
 
+      # Set the WireMock url
+      # @param url [String] the url of the WireMock server
       def set_wiremock_url(url)
         @wiremock_url = url
       end

data/lib/match_builder.rb

@@ -7,24 +7,37 @@ module WireMockMapper
       @options = {}
     end
 
+    # Match if attribute is absent
+    # @return [RequestBuilder] calling request builder for chaining additional attributes
     def absent
       @type = :absent
       @value = true
       @request_builder
     end
 
+    # Match if attribute value contains the arg
+    # @param value [String] string to match
+    # @return [RequestBuilder] calling request builder for chaining additional attributes
     def containing(value)
       @type = :contains
       @value = value
       @request_builder
     end
 
+    # Match if attribute value is equal to the arg
+    # @param value [String] string to compare against
+    # @return [RequestBuilder] calling request builder for chaining additional attributes
     def equal_to(value)
       @type = :equalTo
       @value = value
       @request_builder
     end
 
+    # Match if attribute json is equal to the arg
+    # @param json [String] json to compare against
+    # @param ignore_array_order [true, false] flag to ignore the order of arrays
+    # @param ignore_extra_elements [true, false] flag to ignore any extra elements
+    # @return [RequestBuilder] calling request builder for chaining additional attributes
     def equal_to_json(json, ignore_array_order = false, ignore_extra_elements = false)
       @type = :equalToJson
       @value = json
@@ -35,30 +48,45 @@ module WireMockMapper
       @request_builder
     end
 
+    # Match if attribute xml is equal to the arg
+    # @param xml [String] xml to compare against
+    # @return [RequestBuilder] calling request builder for chaining additional attributes
     def equal_to_xml(xml)
       @type = :equalToXml
       @value = xml
       @request_builder
     end
 
+    # Match if attribute value matches the regex_string
+    # @param regex_string [String] xml to match against
+    # @return [RequestBuilder] calling request builder for chaining additional attributes
     def matching(regex_string)
       @type = :matches
       @value = regex_string
       @request_builder
     end
 
+    # Match if attribute json matches the json_path
+    # @param json_path [String] json_path to match against
+    # @return [RequestBuilder] calling request builder for chaining additional attributes
     def matching_json_path(json_path)
       @type = :matchesJsonPath
       @value = json_path
       @request_builder
     end
 
+    # Match if attribute xml matches the xpath
+    # @param xpath [String] xpath to match against
+    # @return [RequestBuilder] calling request builder for chaining additional attributes
     def matching_xpath(xpath)
       @type = :matchesXPath
       @value = xpath
       @request_builder
     end
 
+    # Match if attribute value does not match
+    # @param regex_string [String] regex_string to match against
+    # @return [RequestBuilder] calling request builder for chaining additional attributes
     def not_matching(regex_string)
       @type = :doesNotMatch
       @value = regex_string

data/lib/request_builder.rb

@@ -8,19 +8,27 @@ module WireMockMapper
       @options[:headers] = configuration.request_headers if configuration
     end
 
-    HttpVerbs = %w(ANY DELETE GET HEAD OPTIONS POST PUT TRACE).freeze
-    HttpVerbs.each do |verb|
+    HTTP_VERBS = %w(ANY DELETE GET HEAD OPTIONS POST PUT TRACE).freeze
+    private_constant :HTTP_VERBS
+
+    HTTP_VERBS.each do |verb|
       define_method("receives_#{verb.downcase}") do
         @options[:method] = verb
         self
       end
     end
 
+    # Expect basic auth
+    # @param username [String] username to expect
+    # @param password [String] password to expect
+    # @return [RequestBuilder] request builder for chaining
     def with_basic_auth(username, password)
       @options[:basicAuth] = { username: username, password: password }
       self
     end
 
+    # Expect body
+    # @return [MatchBuilder] match builder to declare the match on the body
     def with_body
       @options[:bodyPatterns] ||= []
       match_builder = MatchBuilder.new(self)
@@ -28,25 +36,38 @@ module WireMockMapper
       match_builder
     end
 
+    # Expect cookie
+    # @param key [String] the cookie key
+    # @return [MatchBuilder] match builder to declare the match on the cookie
     def with_cookie(key)
       @options[:cookies] ||= {}
       @options[:cookies][key] = MatchBuilder.new(self)
     end
 
+    # Expect header
+    # @param key [String] the header key
+    # @return [MatchBuilder] match builder to declare the match on the header
     def with_header(key)
       @options[:headers] ||= {}
       @options[:headers][key] = MatchBuilder.new(self)
     end
 
-    def with_query_params(key)
+    # Expect query param
+    # @param key [String] the query param key
+    # @return [MatchBuilder] match builder to declare the match on the query param
+    def with_query_param(key)
       @options[:queryParameters] ||= {}
       @options[:queryParameters][key] = MatchBuilder.new(self)
     end
 
+    # Expect url path with query params
+    # @return [UrlMatchBuilder] url match builder to declare the match on the url
     def with_url
       @url_match = UrlMatchBuilder.new(self)
     end
 
+    # Expect url path only
+    # @return [UrlMatchBuilder] url match builder to declare the match on the url
     def with_url_path
       @url_match = UrlMatchBuilder.new(self, true)
     end

data/lib/response_builder.rb

@@ -4,23 +4,36 @@ module WireMockMapper
       @options = {}
     end
 
+    # Response body
+    # @param value [String] the value to set the response body to
+    # @return [ResponseBuilder] response builder for chaining
     def with_body(value)
       value = value.to_json unless value.is_a? String
       @options[:body] = value
       self
     end
 
+    # Add a response header
+    # @param key [String] the key of the header
+    # @param value [String] the value of the header
+    # @return [ResponseBuilder] response builder for chaining
     def with_header(key, value)
       @options[:headers] ||= {}
       @options[:headers][key] = value
       self
     end
 
+    # Add a response http status
+    # @param status_code [String, Numeric] the status code to respond with
+    # @return [ResponseBuilder] response builder for chaining
     def with_status(status_code)
       @options[:status] = status_code
       self
     end
 
+    # Add a response http status
+    # @param status_code [String] the status message to respond with
+    # @return [ResponseBuilder] response builder for chaining
     def with_status_message(status_message)
       @options[:statusMessage] = status_message
       self

data/lib/url_match_builder.rb

@@ -7,12 +7,18 @@ module WireMockMapper
       @url_or_pattern = ''
     end
 
+    # Expect url to equal
+    # @param url [String] url to match against
+    # @return [RequestBuilder] calling request builder for chaining additional attributes
     def equal_to(url)
       @type = @path ? :urlPath : :url
       @url_or_pattern = url
       @request_builder
     end
 
+    # Expect url to match
+    # @param regex_string [String] regex for url to match against
+    # @return [RequestBuilder] calling request builder for chaining additional attributes
     def matching(regex_string)
       @type = @path ? :urlPathPattern : :urlPattern
       @url_or_pattern = regex_string

data/lib/wiremock_mapper.rb

@@ -4,7 +4,7 @@ require_relative 'request_builder'
 require_relative 'response_builder'
 
 module WireMockMapper
-  VERSION = '0.2.0'.freeze
+  VERSION = '0.3.0'.freeze
 
   def self.create_mapping(url = Configuration.wiremock_url)
     request_builder = RequestBuilder.new

data/spec/request_builder_spec.rb

@@ -108,10 +108,10 @@ describe WireMockMapper::RequestBuilder do
     end
   end
 
-  describe 'with_query_params' do
+  describe 'with_query_param' do
     it 'returns a MatchBuilder' do
       builder = WireMockMapper::RequestBuilder.new
-      expect(builder.with_query_params(:whatever)).to be_a(WireMockMapper::MatchBuilder)
+      expect(builder.with_query_param(:whatever)).to be_a(WireMockMapper::MatchBuilder)
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wiremock_mapper
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Isaac Datlof