wiremock_mapper 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 86b9b09304308e135c6985a62ce777ad25cd2e34
-  data.tar.gz: c01087f79319cdc5db8e754f8ec7574e000ffdca
+  metadata.gz: 55d9acc4792e98d17662839d6b79f75012069f76
+  data.tar.gz: 86e81e72776ba7a27d9320529131bc19a5c74a77
 SHA512:
-  metadata.gz: b6ffe19295fa0caad4fb1e2f7f1b3800566fd743ba6d14d39d2c1573011a1d9f8f93655e852cb0bf43357dd93f7846085e3ab26cce472b2bff64c6082b0bbe5a
-  data.tar.gz: 015d5a5678db555717bca635d9a96003ebc00a0a4d4e74029b0c5ab567ae01f3c3f1da1ecad604b85f9618fbbc1148c7761044de40e884be7d2c686ccf9f8cc1
+  metadata.gz: 14cb6170c8b802ba1ea5d66886f139406fcc43ef10db2afaa8a754cb88bde9dfc9fac0db80c5620f2462642bc4fbc60e6684022505b6516f9aab078e5b46efc9
+  data.tar.gz: 39c74d269f1d2a76b3fdc8a68f1d950cdeeb61b797cc0c0df88695bf62ef4ae5fafa5e85f3596b4b58068d5c04f35b2c240675b4cf12c2ee56320810c3066a31

data/.gitignore

@@ -3,3 +3,4 @@ tags
 vendor
 .bundle
 Gemfile.lock
+*.gem

data/README.md

@@ -2,20 +2,24 @@
 [![Code Climate](https://codeclimate.com/github/ike18t/wiremock_mapper/badges/gpa.svg)](https://codeclimate.com/github/ike18t/wiremock_mapper)
 [![Test Coverage](https://codeclimate.com/github/ike18t/wiremock_mapper/badges/coverage.svg)](https://codeclimate.com/github/ike18t/wiremock_mapper/coverage)
 [![Dependency Status](https://gemnasium.com/badges/github.com/ike18t/wiremock_mapper.svg)](https://gemnasium.com/github.com/ike18t/wiremock_mapper)
+[![Gem Version](https://badge.fury.io/rb/wiremock_mapper.svg)](https://badge.fury.io/rb/wiremock_mapper)
 
 ##WireMockMapper
 
-**Ruby DSL for setting up WireMock mappings**
+**Ruby DSL for setting up [WireMock](http://wiremock.org/) mappings**
 
-####Usage Example####
+####Usage Example
 ```ruby
 WireMockMapper::Configuration.set_wiremock_url('http://my_wiremock.com')
-WireMockMapper::Configuration.add_header('Some-Header', 'some_value')
+WireMockMapper::Configuration.add_request_header('Some-Header').equal_to('some_value')
 
 WireMockMapper.create_mapping do |request, respond|
-	request.post_to_path('path/to/stub')
-			.with_header('Some-Other-Header', 'some_other_value')
-			.with_body(foo: bar)
+	request.receives_post
+           .with_url_path.equal_to('path/to/stub')
+           .with_header('Some-Other-Header').equal_to('some_other_value')
+           .with_body.equal_to(foo: bar)
 	respond.with_body('good job!')
 end
-```
+```
+
+###### Special thanks to [Manheim](https://www.manheim.com)'s [Seller Tools](https://sites.google.com/site/sellertoolsteam/home) team for allowing me to work on this during the team Hackathon.

data/lib/configuration.rb

@@ -6,8 +6,8 @@ module WireMockMapper
     class << self
       attr_reader :request_headers, :wiremock_url
 
-      def add_request_header(key, value)
-        @request_headers[key] = value
+      def add_request_header(key)
+        @request_headers[key] = MatchBuilder.new(self)
       end
 
       def set_wiremock_url(url)

data/lib/match_builder.rb

@@ -0,0 +1,76 @@
+module WireMockMapper
+  class MatchBuilder
+    def initialize(request_builder)
+      @request_builder = request_builder
+      @type = ''
+      @value = ''
+      @options = {}
+    end
+
+    def absent
+      @type = :absent
+      @value = true
+      @request_builder
+    end
+
+    def containing(value)
+      @type = :contains
+      @value = value
+      @request_builder
+    end
+
+    def equal_to(value)
+      @type = :equalTo
+      @value = value
+      @request_builder
+    end
+
+    def equal_to_json(json, ignore_array_order = false, ignore_extra_elements = false)
+      @type = :equalToJson
+      @value = json
+
+      @options[:ignoreArrayOrder] = true if ignore_array_order
+      @options[:ignoreExtraElements] = true if ignore_extra_elements
+
+      @request_builder
+    end
+
+    def equal_to_xml(xml)
+      @type = :equalToXml
+      @value = xml
+      @request_builder
+    end
+
+    def matching(regex_string)
+      @type = :matches
+      @value = regex_string
+      @request_builder
+    end
+
+    def matching_json_path(json_path)
+      @type = :matchesJsonPath
+      @value = json_path
+      @request_builder
+    end
+
+    def matching_xpath(xpath)
+      @type = :matchesXPath
+      @value = xpath
+      @request_builder
+    end
+
+    def not_matching(regex_string)
+      @type = :doesNotMatch
+      @value = regex_string
+      @request_builder
+    end
+
+    def to_hash(*)
+      { @type => @value }.merge(@options)
+    end
+
+    def to_json(*)
+      to_hash.to_json
+    end
+  end
+end

data/lib/request_builder.rb

@@ -1,35 +1,63 @@
+require_relative 'match_builder'
+require_relative 'url_match_builder'
+
 module WireMockMapper
   class RequestBuilder
     def initialize(configuration = nil)
       @options = {}
-      @options['headers'] ||= {}
-      @options['headers'] = configuration.request_headers if configuration
+      @options[:headers] = configuration.request_headers if configuration
     end
 
-    def posts_to_path(url)
-      @options['method'] = 'POST'
-      @options['urlPath'] = url
-      self
+    HttpVerbs = %w(ANY DELETE GET HEAD OPTIONS POST PUT TRACE).freeze
+    HttpVerbs.each do |verb|
+      define_method("receives_#{verb.downcase}") do
+        @options[:method] = verb
+        self
+      end
     end
 
-    def with_header(key, value)
-      @options['headers'][key] = { equalTo: value }
+    def with_basic_auth(username, password)
+      @options[:basicAuth] = { username: username, password: password }
       self
     end
 
-    def with_body(value)
-      @options['bodyPatterns'] ||= []
-      value = value.to_json unless value.is_a? String
-      @options['bodyPatterns'] << { matches: value }
-      self
+    def with_body
+      @options[:bodyPatterns] ||= []
+      match_builder = MatchBuilder.new(self)
+      @options[:bodyPatterns] << match_builder
+      match_builder
+    end
+
+    def with_cookie(key)
+      @options[:cookies] ||= {}
+      @options[:cookies][key] = MatchBuilder.new(self)
+    end
+
+    def with_header(key)
+      @options[:headers] ||= {}
+      @options[:headers][key] = MatchBuilder.new(self)
+    end
+
+    def with_query_params(key)
+      @options[:queryParameters] ||= {}
+      @options[:queryParameters][key] = MatchBuilder.new(self)
+    end
+
+    def with_url
+      @url_match = UrlMatchBuilder.new(self)
+    end
+
+    def with_url_path
+      @url_match = UrlMatchBuilder.new(self, true)
     end
 
     def to_hash(*)
-      @options
+      options_with_url_match = @options.merge(@url_match.to_hash) if @url_match
+      options_with_url_match || @options
     end
 
     def to_json(*)
-      @options.to_json
+      to_hash.to_json
     end
   end
 end

data/lib/response_builder.rb

@@ -6,7 +6,23 @@ module WireMockMapper
 
     def with_body(value)
       value = value.to_json unless value.is_a? String
-      @options['body'] = value
+      @options[:body] = value
+      self
+    end
+
+    def with_header(key, value)
+      @options[:headers] ||= {}
+      @options[:headers][key] = value
+      self
+    end
+
+    def with_status(status_code)
+      @options[:status] = status_code
+      self
+    end
+
+    def with_status_message(status_message)
+      @options[:statusMessage] = status_message
       self
     end
 

data/lib/url_match_builder.rb

@@ -0,0 +1,30 @@
+module WireMockMapper
+  class UrlMatchBuilder
+    def initialize(request_builder, path = false)
+      @request_builder = request_builder
+      @path = path
+      @type = ''
+      @url_or_pattern = ''
+    end
+
+    def equal_to(url)
+      @type = @path ? :urlPath : :url
+      @url_or_pattern = url
+      @request_builder
+    end
+
+    def matching(regex_string)
+      @type = @path ? :urlPathPattern : :urlPattern
+      @url_or_pattern = regex_string
+      @request_builder
+    end
+
+    def to_hash(*)
+      { @type => @url_or_pattern }
+    end
+
+    def to_json(*)
+      to_hash.to_json
+    end
+  end
+end

data/lib/wiremock_mapper.rb

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

data/spec/configuration_spec.rb

@@ -2,9 +2,9 @@ require 'spec_helper'
 
 describe WireMockMapper::Configuration do
   context 'request_header' do
-    it 'adds the request header' do
-      WireMockMapper::Configuration.add_request_header('some', 'header')
-      expect(WireMockMapper::Configuration.request_headers).to eq('some' => 'header')
+    it 'returns a MatchBuilder' do
+      WireMockMapper::Configuration.add_request_header('some_header')
+      expect(WireMockMapper::Configuration.request_headers['some_header']).to be_a(WireMockMapper::MatchBuilder)
     end
   end
 

data/spec/match_builder_spec.rb

@@ -0,0 +1,87 @@
+require 'spec_helper'
+
+describe WireMockMapper::MatchBuilder do
+  describe 'absent' do
+    it 'returns a hash of { absent => true }' do
+      builder = WireMockMapper::MatchBuilder.new(nil)
+      builder.absent
+      expect(builder.to_hash).to eq(absent: true)
+    end
+  end
+
+  describe 'containing' do
+    it 'returns a hash of { contains => value }' do
+      builder = WireMockMapper::MatchBuilder.new(nil)
+      builder.containing 'foo'
+      expect(builder.to_hash).to eq(contains: 'foo')
+    end
+  end
+
+  describe 'equal_to' do
+    it 'returns a hash of { equalTo => value }' do
+      builder = WireMockMapper::MatchBuilder.new(nil)
+      builder.equal_to 'foo'
+      expect(builder.to_hash).to eq(equalTo: 'foo')
+    end
+  end
+
+  describe 'equal_to_json' do
+    it 'returns a hash of { equalToJson => value }' do
+      builder = WireMockMapper::MatchBuilder.new(nil)
+      builder.equal_to_json 'foo'
+      expect(builder.to_hash).to eq(equalToJson: 'foo')
+    end
+
+    it 'returns a hash of { equalToJson => value, ignoreArrayOrder => true }' do
+      builder = WireMockMapper::MatchBuilder.new(nil)
+      builder.equal_to_json 'foo', true
+      expect(builder.to_hash).to eq(equalToJson: 'foo', ignoreArrayOrder: true)
+    end
+
+    it 'returns a hash of { equalToJson => value, ignoreExtraElements => true }' do
+      builder = WireMockMapper::MatchBuilder.new(nil)
+      builder.equal_to_json 'foo', false, true
+      expect(builder.to_hash).to eq(equalToJson: 'foo', ignoreExtraElements: true)
+    end
+  end
+
+  describe 'equal_to_xml' do
+    it 'returns a hash of { equalToXml => value }' do
+      builder = WireMockMapper::MatchBuilder.new(nil)
+      builder.equal_to_xml 'foo'
+      expect(builder.to_hash).to eq(equalToXml: 'foo')
+    end
+  end
+
+  describe 'matching' do
+    it 'returns a hash of { matches => value }' do
+      builder = WireMockMapper::MatchBuilder.new(nil)
+      builder.matching 'foo'
+      expect(builder.to_hash).to eq(matches: 'foo')
+    end
+  end
+
+  describe 'matching_json_path' do
+    it 'returns a hash of { matchesJsonPath => value }' do
+      builder = WireMockMapper::MatchBuilder.new(nil)
+      builder.matching_json_path 'foo'
+      expect(builder.to_hash).to eq(matchesJsonPath: 'foo')
+    end
+  end
+
+  describe 'matching_xpath' do
+    it 'returns a hash of { matchesXPath => value }' do
+      builder = WireMockMapper::MatchBuilder.new(nil)
+      builder.matching_xpath 'foo'
+      expect(builder.to_hash).to eq(matchesXPath: 'foo')
+    end
+  end
+
+  describe 'not_matching' do
+    it 'returns a hash of { doesNotMatch => value }' do
+      builder = WireMockMapper::MatchBuilder.new(nil)
+      builder.not_matching 'foo'
+      expect(builder.to_hash).to eq(doesNotMatch: 'foo')
+    end
+  end
+end

data/spec/request_builder_spec.rb

@@ -1,38 +1,117 @@
 require 'spec_helper'
 
 describe WireMockMapper::RequestBuilder do
-  context 'posts_to_path' do
+  describe 'receives_any' do
     it 'sets the http method and url path' do
       builder = WireMockMapper::RequestBuilder.new
-      builder.posts_to_path('/some/path')
+      builder.receives_any
       result = builder.to_hash
-      expect(result['method']).to eq('POST')
-      expect(result['urlPath']).to eq('/some/path')
+      expect(result[:method]).to eq('ANY')
     end
   end
 
-  context 'with_header' do
-    it 'adds the header' do
+  describe 'receives_delete' do
+    it 'sets the http method and url path' do
+      builder = WireMockMapper::RequestBuilder.new
+      builder.receives_delete
+      result = builder.to_hash
+      expect(result[:method]).to eq('DELETE')
+    end
+  end
+
+  describe 'receives_get' do
+    it 'sets the http method and url path' do
+      builder = WireMockMapper::RequestBuilder.new
+      builder.receives_get
+      result = builder.to_hash
+      expect(result[:method]).to eq('GET')
+    end
+  end
+
+  describe 'receives_head' do
+    it 'sets the http method and url path' do
       builder = WireMockMapper::RequestBuilder.new
-      builder.with_header('some', 'header')
+      builder.receives_head
       result = builder.to_hash
-      expect(result['headers']).to eq('some' => { equalTo: 'header' })
+      expect(result[:method]).to eq('HEAD')
     end
   end
 
-  context 'with_body' do
-    it 'adds the body' do
+  describe 'receives_options' do
+    it 'sets the http method and url path' do
       builder = WireMockMapper::RequestBuilder.new
-      builder.with_body('some body')
+      builder.receives_options
       result = builder.to_hash
-      expect(result['bodyPatterns']).to eq([{ matches: 'some body' }])
+      expect(result[:method]).to eq('OPTIONS')
     end
+  end
 
-    it 'converts value to_json if it is not a string' do
+  describe 'receives_put' do
+    it 'sets the http method and url path' do
       builder = WireMockMapper::RequestBuilder.new
-      builder.with_body(some: 'hash')
+      builder.receives_put
       result = builder.to_hash
-      expect(result['bodyPatterns']).to eq([{ matches: '{"some":"hash"}' }])
+      expect(result[:method]).to eq('PUT')
+    end
+  end
+
+  describe 'receives_post' do
+    it 'sets the http method and url path' do
+      builder = WireMockMapper::RequestBuilder.new
+      builder.receives_post
+      result = builder.to_hash
+      expect(result[:method]).to eq('POST')
+    end
+  end
+
+  describe 'receives_trace' do
+    it 'sets the http method and url path' do
+      builder = WireMockMapper::RequestBuilder.new
+      builder.receives_trace
+      result = builder.to_hash
+      expect(result[:method]).to eq('TRACE')
+    end
+  end
+
+  describe 'with_basic_auth' do
+    it 'adds basic auth' do
+      builder = WireMockMapper::RequestBuilder.new
+      builder.with_basic_auth('ike', '123456')
+      expect(builder.to_hash[:basicAuth]).to eq(username: 'ike', password: '123456')
+    end
+  end
+
+  describe 'with_body' do
+    it 'returns a MatchBuilder' do
+      builder = WireMockMapper::RequestBuilder.new
+      expect(builder.with_body).to be_a(WireMockMapper::MatchBuilder)
+    end
+
+    it 'adds the matcher to bodyPatterns' do
+      builder = WireMockMapper::RequestBuilder.new
+      matcher = builder.with_body
+      expect(builder.to_hash).to eq(bodyPatterns: [matcher])
+    end
+  end
+
+  describe 'with_cookie' do
+    it 'returns a MatchBuilder' do
+      builder = WireMockMapper::RequestBuilder.new
+      expect(builder.with_cookie(:whatever)).to be_a(WireMockMapper::MatchBuilder)
+    end
+  end
+
+  describe 'with_header' do
+    it 'returns a MatchBuilder' do
+      builder = WireMockMapper::RequestBuilder.new
+      expect(builder.with_header(:whatever)).to be_a(WireMockMapper::MatchBuilder)
+    end
+  end
+
+  describe 'with_query_params' do
+    it 'returns a MatchBuilder' do
+      builder = WireMockMapper::RequestBuilder.new
+      expect(builder.with_query_params(:whatever)).to be_a(WireMockMapper::MatchBuilder)
     end
   end
 end

data/spec/response_builder_spec.rb

@@ -1,19 +1,54 @@
 require 'spec_helper'
 
 describe WireMockMapper::ResponseBuilder do
-  context 'with_body' do
+  describe 'with_body' do
     it 'adds the body' do
       builder = WireMockMapper::ResponseBuilder.new
       builder.with_body('some body')
       result = builder.to_hash
-      expect(result['body']).to eq('some body')
+      expect(result[:body]).to eq('some body')
     end
 
     it 'converts value to_json if it is not a string' do
       builder = WireMockMapper::ResponseBuilder.new
       builder.with_body(some: 'hash')
       result = builder.to_hash
-      expect(result['body']).to eq('{"some":"hash"}')
+      expect(result[:body]).to eq('{"some":"hash"}')
+    end
+  end
+
+  describe 'with_header' do
+    it 'adds the header' do
+      builder = WireMockMapper::ResponseBuilder.new
+      builder.with_header('key', 'value')
+      result = builder.to_hash
+      expect(result[:headers]).to eq('key' => 'value')
+    end
+
+    it 'adds multiple headers' do
+      builder = WireMockMapper::ResponseBuilder.new
+      builder.with_header('key', 'value')
+      builder.with_header('another key', 'another value')
+      result = builder.to_hash
+      expect(result[:headers]).to eq('key' => 'value', 'another key' => 'another value')
+    end
+  end
+
+  describe 'with_status' do
+    it 'adds the status code' do
+      builder = WireMockMapper::ResponseBuilder.new
+      builder.with_status(400)
+      result = builder.to_hash
+      expect(result[:status]).to eq(400)
+    end
+  end
+
+  describe 'with_status_message' do
+    it 'adds the status message' do
+      builder = WireMockMapper::ResponseBuilder.new
+      builder.with_status_message('message')
+      result = builder.to_hash
+      expect(result[:statusMessage]).to eq('message')
     end
   end
 end

data/spec/spec_helper.rb

@@ -1,4 +1,5 @@
 require 'webmock/rspec'
 require 'codeclimate-test-reporter'
+require 'pry'
 
 CodeClimate::TestReporter.start

data/spec/url_match_builder_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+require_relative '../lib/url_match_builder'
+
+describe WireMockMapper::MatchBuilder do
+  context 'initialized with path = true' do
+    let(:builder) { WireMockMapper::UrlMatchBuilder.new(nil, true) }
+
+    describe 'equal_to' do
+      it 'sets the return of to_hash to {urlPath: value}' do
+        builder.equal_to '/some/path'
+        expect(builder.to_hash).to eq(urlPath: '/some/path')
+      end
+    end
+
+    describe 'matching' do
+      it 'sets the return of to_hash to {urlPathPattern: value}' do
+        builder.matching '/some/path'
+        expect(builder.to_hash).to eq(urlPathPattern: '/some/path')
+      end
+    end
+  end
+
+  context 'initialized with path = false' do
+    let(:builder) { WireMockMapper::UrlMatchBuilder.new(nil) }
+
+    describe 'equal_to' do
+      it 'sets the return of to_hash to {url: value}' do
+        builder.equal_to '/some/path'
+        expect(builder.to_hash).to eq(url: '/some/path')
+      end
+    end
+
+    describe 'matching' do
+      it 'sets the return of to_hash to {urlPattern: value}' do
+        builder.matching '/some/path'
+        expect(builder.to_hash).to eq(urlPattern: '/some/path')
+      end
+    end
+  end
+end

data/spec/wiremock_mapper_spec.rb

@@ -14,9 +14,10 @@ describe WireMockMapper do
       stub_request(:post, "#{url}/__admin/mappings/new").with(body: expected_request_body)
 
       WireMockMapper.create_mapping(url) do |request, respond|
-        request.posts_to_path('/some/path')
-               .with_header('some_header', 'some header value')
-               .with_body('some request body')
+        request.receives_post
+               .with_url_path.equal_to('/some/path')
+               .with_header('some_header').equal_to('some header value')
+               .with_body.matching('some request body')
 
         respond.with_body('some response body')
       end

data/wiremock_mapper.gemspec

@@ -21,7 +21,6 @@ Gem::Specification.new do |spec|
   spec.require_paths    = ['lib']
 
   spec.add_development_dependency 'codeclimate-test-reporter'
-  spec.add_development_dependency 'coveralls'
   spec.add_development_dependency 'pry'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wiremock_mapper
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Isaac Datlof
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-12 00:00:00.000000000 Z
+date: 2016-07-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: codeclimate-test-reporter
@@ -24,20 +24,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: coveralls
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -125,13 +111,17 @@ files:
 - README.md
 - Rakefile
 - lib/configuration.rb
+- lib/match_builder.rb
 - lib/request_builder.rb
 - lib/response_builder.rb
+- lib/url_match_builder.rb
 - lib/wiremock_mapper.rb
 - spec/configuration_spec.rb
+- spec/match_builder_spec.rb
 - spec/request_builder_spec.rb
 - spec/response_builder_spec.rb
 - spec/spec_helper.rb
+- spec/url_match_builder_spec.rb
 - spec/wiremock_mapper_spec.rb
 - wiremock_mapper.gemspec
 homepage: http://github.com/ike18t/wiremock_mapper
@@ -160,7 +150,9 @@ specification_version: 4
 summary: Ruby DSL for setting up WireMock mappings
 test_files:
 - spec/configuration_spec.rb
+- spec/match_builder_spec.rb
 - spec/request_builder_spec.rb
 - spec/response_builder_spec.rb
 - spec/spec_helper.rb
+- spec/url_match_builder_spec.rb
 - spec/wiremock_mapper_spec.rb