service_mock 0.7 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: babc9682df466187ff0a09472b45f1f08b56e985
-  data.tar.gz: 556344bb1625cab5e3de9b20537a0a7359533763
+  metadata.gz: e9c6b2185d2d52eeda2b5b5a5487d766cdd9d7bc
+  data.tar.gz: f4c1fd46633aafffd94ad7345be13785cc6f731a
 SHA512:
-  metadata.gz: 0cc09426b3f7fd4c5760684279cc9725568845a2b163f90656b5221097eb9110bee32b6d71ea2ac9a11a8595eb4affa17efb785f03f50b5faf60e23d47b9dcca
-  data.tar.gz: 71c96c21493db96c7f5563f2350fe5717276b4f56037505001ce03a003de831653a651069284ceb906008ffd93dab452193d98c0f32fe4b196300ad5486f0921
+  metadata.gz: f92c202ccdae0f705052dc2b0dfa198d7616bb9e26da55439eea0bb87661a057da039db7f5a800ba532313fdefb32269829565fcc3584da65e457667f8a77c11
+  data.tar.gz: 5f8082f11c4bf0c7f1d798ff3d8a0e46ab0e63f6ce0e78bc9215a1f3b490664e8bcce32b593a22e1c5f108e7dc1cb03dbbd26a5500a949d403b615544a8706ef

data/ChangeLog

@@ -1,4 +1,10 @@
-=== Release 0.7
+=== Release 0.7.1 / 21-Aug-2017
+* Added ability to specify the stub creator file via Cucumber tags
+* Added count methods to retrieve the count for a specific request - thanks Jarl Friis
+* Fixed issue where rake was required even when rake was not part of bundle - thanks Jarl Friis
+* Added support for the extension option when starting the server - thanks Vinh Bachsy
+
+=== Release 0.7 / 23-Jan-2017
 * Added ability to set remote_host and port via WIREMOCK_URL environment variable
 
 === Release 0.6 / 9-Jan-2017
@@ -31,4 +37,4 @@
 * Reorganized the imports to make it easier to utilize the rake tasks
 
 === Release 0.1 / 15-Jun-2016
-* Initial release with basic functionality
+* Initial release with basic functionality

data/README.md

@@ -65,7 +65,7 @@ You will initialize the server like this:
 ```ruby
 # uses default working directory
 my_server = ServiceMock::Server.new('standalone-2.0.10-beta')
- 
+
 # or this sets the working directory
 my_server = ServiceMock::Server.new('standalone-2.0.10-beta', '/path/to/jar')
 ```
@@ -113,18 +113,35 @@ The values that can be set are:
 | enable_browser_proxy | Run as a browser proxy |
 | no_request_journal | Disable the request journal, which records incoming requests for later verification |
 | max_request_journal_entries | Sets maximum number of entries in request journal.  When this limit is reached oldest entries will be discarded |
+| classpath | Provides list of dependencies jar files to run with the standalone server, they could be extensions and their dependencies and should be kept in the same working directory with the standalone jar file. |
+| extensions | Provides list of wiremock extensions main class to run with the standalone server. |
 
 In addition, as mentioned before, you can set the `inherit_io` and `wait_for_process` options
 to `true` inside of the block.
 
+### Starting the Server with extensions
+
+To start WireMock with extensions, we save the extensions and dependencies jar files in the working directory (default is `config/mocks`) and provide the `classpath` and `extensions` as following:
+
+```ruby
+my_server.start do |server|
+  server.port = 8081
+  server.record_mappings = true
+  server.root_dir = /path/to/root
+  server.verbose = true
+  server.classpath = ['asm-1.0.2.jar', 'json-smart-2.2.1.jar', 'wiremock-body-transformer-1.1.1.jar']
+  server.extensions = 'com.opentable.extension.BodyTransformer'
+end
+```
+
 ### Stubbing service calls
 
-Please read the [WireMock stubbing](http://wiremock.org/stubbing.html) 
+Please read the [WireMock stubbing](http://wiremock.org/stubbing.html)
 documentation so you understand the message structures that are used.
 It is very important that you understand this first. Those details will
 not be covered here.
 
-There are three methods that can be used to stub services.  
+There are three methods that can be used to stub services.
 
 ```ruby
 my_server.stub(string_containing_json_stub)
@@ -136,7 +153,7 @@ my_server.stub_with_erb(erbfile_containing_json_stub, hash_with_values)
 
 The first method is pretty self-explanatory.  You simply pass a string
 that contains the json stub and the server contacts the running server
-process and sets it up.  The second method takes a full path to a file 
+process and sets it up.  The second method takes a full path to a file
 that contains the json stub.
 
 The third method is where things get interesting.  It allows you to provide
@@ -153,8 +170,8 @@ The third method takes the full path to an erb file that contains the
 json stub and a second parameter that is a `Hash` which provides the
 data that is used to fill in the data elements in the template.
 
-If you set the port value when you started the server you will need to 
-do the same via a block when stubbing.  
+If you set the port value when you started the server you will need to
+do the same via a block when stubbing.
 
 ```ruby
 my_server.stub(string_containing_json_stub) do |server|
@@ -178,18 +195,31 @@ variable `WIREMOCK_URL`.  It should take the form 'http://hostname:port'.
 
 ### Stubbing multiple services
 
-It is often necessary to stub multiple service calls in order to 
+It is often necessary to stub multiple service calls in order to
 complete a test.  ServiceMock has created a simple way to do this.
 It is implemented in a class named `ServiceMock::StubCreator`.
 This class has a single public method `create_stubs_with` which
-takes the name of the name of a file that has the data for all
+takes the name of the file that has the data for all
 of the stubs you wish to create and optional data to merge with
-that file. Also, when you create an instance of the class it 
+that file. Also, when you create an instance of the class it
 requires you to pass an instance of `ServiceMock::Server`.
 
+Another way to specify the file to use for creating the stubs is
+to set a tag on the Cucumber Scenario.  Create a tag in the form of
+`@servicemock_FILENAME` where `FILENAME` is the name of the
+file you wish to use.  For example, if you add the tag
+`@servicemock_foo` then the file `foo.yml` will be loaded.  The next
+thing you will need to do is add the following code in a hook:
+
+```ruby
+Before do |scenario|
+  ServiceMock.load_for_scenario(scenario)
+end
+```
+
 At this time you need to setup everything in a specific directory
 structure.  The directory it looks for is `config/mocks/stubs`.
-Inside that directory it looks for two additional directories - 
+Inside that directory it looks for two additional directories -
 `data` and `templates`. The data file needed by the call needs
 be located in the `data` directory and the `ERB` files (templates)
 that it references needs to be in the `templates` directory.
@@ -201,7 +231,7 @@ with an example.
 service1.erb:
   first_name: Mickey
   last_name: Mouse
-  
+
 service2.erb:
   username: mmouse
   password: secret
@@ -241,11 +271,11 @@ my_server.stop
 ```
 
 Stops the running WireMock server if it is running locally.
- 
+
 ```ruby
 my_server.save
 ```
- 
+
 Writes all of the stubs to disk so they are available the next time
 the server starts.
 
@@ -333,17 +363,17 @@ Or install it yourself as:
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. 
-Then, run `rake spec` to run the tests. You can also run `bin/console` 
+After checking out the repo, run `bin/setup` to install dependencies.
+Then, run `rake spec` to run the tests. You can also run `bin/console`
 for an interactive prompt that will allow you to experiment.
 
 
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at 
-https://github.com/cheezy/service_mock. This project is intended to 
-be a safe, welcoming space for collaboration, and contributors are 
-expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) 
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/cheezy/service_mock. This project is intended to
+be a safe, welcoming space for collaboration, and contributors are
+expected to adhere to the [Contributor Covenant](http://contributor-covenant.org)
 code of conduct.
 

data/lib/service_mock.rb

@@ -4,7 +4,7 @@ require 'service_mock/command_line_options'
 require 'service_mock/server'
 require 'service_mock/erb_methods'
 require 'service_mock/stub_creator'
-require 'service_mock/rake/rake_tasks'
+require 'service_mock/rake/rake_tasks' if Gem.loaded_specs.has_key? 'rake'
 
 #
 # ServiceMock is a Ruby gem that provides a wrapper over the [WireMock](http://wiremock.org)

data/lib/service_mock/command_line_options.rb

@@ -5,9 +5,9 @@ module ServiceMock
                :match_headers, :proxy_via, :https_keystore, :keystore_password,
                :enable_browser_proxying, :preserve_host_header, :https_truststore,
                :truststore_password, :https_require_client_cert, :no_request_journal,
-               :max_request_journal_entries]
+               :max_request_journal_entries, :extensions]
     NOT_IMPLEMENTED = [:container_threads, :jetty_acceptor_threads, :jetty_accept_queue_size,
-                       :jetty_header_buffer_size, :extensions, :help]
+                       :jetty_header_buffer_size, :help]
 
     attr_accessor *OPTIONS
 
@@ -85,5 +85,9 @@ module ServiceMock
     def max_request_journal_entries_command
       ["--max-request-journal-entries #{max_request_journal_entries}"]
     end
+
+    def extensions_command
+      ['--extensions', extensions]
+    end
   end
-end
+end

data/lib/service_mock/server.rb

@@ -1,5 +1,6 @@
 require 'childprocess'
 require 'net/http'
+require 'json'
 require 'erb'
 require 'ostruct'
 require 'service_mock/erb_methods'
@@ -42,7 +43,7 @@ module ServiceMock
   class Server
     include CommandLineOptions
 
-    attr_accessor :inherit_io, :wait_for_process, :remote_host
+    attr_accessor :inherit_io, :wait_for_process, :remote_host, :classpath
     attr_reader :wiremock_version, :working_directory, :process
 
     def initialize(wiremock_version, working_directory = ::ServiceMock.working_directory)
@@ -89,7 +90,8 @@ module ServiceMock
     #
     def start
       yield self if block_given?
-      start_process
+      classpath = self.classpath.is_a?(Array) ? self.classpath : []
+      start_process(classpath)
     end
 
     #
@@ -131,6 +133,38 @@ module ServiceMock
       stub(erb_content)
     end
 
+    #
+    # Get the count for the request criteria
+    #
+    def count(request_criteria)
+      return if ::ServiceMock.disable_stubs
+      yield self if block_given?
+      return JSON.parse(http.post('/__admin/requests/count', request_criteria).body)['count']
+    end
+
+    #
+    # Get the count for the request criteria in the provided filename.
+    #
+    def count_with_file(filename)
+      return if ::ServiceMock.disable_stubs
+      yield self if block_given?
+      content = File.open(filename, 'rb') { |file| file.read }
+      return count(content)
+    end
+
+    #
+    # Get the count for the request criteria using the erb template
+    # provided.  The +Hash+ second parameter contains the values to be
+    # inserted into the +ERB+.
+    #
+    def count_with_erb(filename, hsh={})
+      return if ::ServiceMock.disable_stubs
+      yield self if block_given?
+      template = File.open(filename, 'rb') { |file| file.read }
+      erb_content = ERB.new(template).result(data_binding(hsh))
+      count(erb_content)
+    end
+
     #
     # Writes all of the stubs to disk so they are available the next time
     # the server starts.
@@ -164,16 +198,18 @@ module ServiceMock
       OpenStruct.new(hsh).instance_eval { binding }
     end
 
-    def start_process
-      @process = ChildProcess.build(*(start_command + command_line_options))
+    def start_process(classpath)
+      @process = ChildProcess.build(*(start_command(classpath) + command_line_options))
       @process.cwd = working_directory
       @process.io.inherit! if inherit_io
       @process.start
       @process.wait if wait_for_process
     end
 
-    def start_command
-      ['java', '-jar', "wiremock-#{wiremock_version}.jar"]
+    def start_command(classpath)
+      dependency_jars = classpath + ["wiremock-#{wiremock_version}.jar"]
+      ['java', '-cp', dependency_jars.join(':'),
+        'com.github.tomakehurst.wiremock.standalone.WireMockServerRunner']
     end
 
     def http

data/lib/service_mock/stub_creator.rb

@@ -56,6 +56,11 @@ module ServiceMock
       create_stubs
     end
 
+    def load_for_scenario(scenario)
+      filename = scenario_filename(scenario)
+      create_stubs_with("#{filename.last}.yml")
+    end
+
     private
 
     def read_data(data_file)
@@ -90,5 +95,10 @@ module ServiceMock
         raise error_message
       end
     end
+
+    def scenario_filename(scenario)
+      tags = scenario.send(scenario.respond_to?(:tags) ? :tags : :source_tags)
+      tags.map(&:name).select { |t| t =~ /@servicemock_/ }.map { |t| t.gsub('@servicemock_', '').to_sym }
+    end
   end
 end

data/lib/service_mock/version.rb

@@ -1,3 +1,3 @@
 module ServiceMock
-  VERSION = "0.7"
+  VERSION = "0.7.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: service_mock
 version: !ruby/object:Gem::Version
-  version: '0.7'
+  version: 0.7.1
 platform: ruby
 authors:
 - Jeffrey S. Morgan
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-01-23 00:00:00.000000000 Z
+date: 2017-08-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: childprocess
@@ -116,9 +116,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.3
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: Simple wrapper over WireMock
 test_files: []
-has_rdoc: