service_mock 0.6 → 0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b891d952ac8245a9333fba17e4600dbf404a46dc
-  data.tar.gz: 9912ed6df33f2f6a743fd2f56120d1fc23bf5b5f
+  metadata.gz: babc9682df466187ff0a09472b45f1f08b56e985
+  data.tar.gz: 556344bb1625cab5e3de9b20537a0a7359533763
 SHA512:
-  metadata.gz: dd9407b2f66e52be507e5f07538da001dc35869c5ef6e9049afc3e98c22a35a8881cfe6a01cb27888f2f63c16f56c07d4a0a9c4b084a9244c60a147f7bcafc90
-  data.tar.gz: 228ff0302d8406083c42bcf0b6da97750bffe469ccd6cd5983d0019e67532492f5bf30a11572f80e863427d665176f93ff82ade81fbc2d2f3ee060d1eabe3104
+  metadata.gz: 0cc09426b3f7fd4c5760684279cc9725568845a2b163f90656b5221097eb9110bee32b6d71ea2ac9a11a8595eb4affa17efb785f03f50b5faf60e23d47b9dcca
+  data.tar.gz: 71c96c21493db96c7f5563f2350fe5717276b4f56037505001ce03a003de831653a651069284ceb906008ffd93dab452193d98c0f32fe4b196300ad5486f0921

data/ChangeLog

@@ -1,31 +1,34 @@
-=== Release 0.6
+=== Release 0.7
+* Added ability to set remote_host and port via WIREMOCK_URL environment variable
+
+=== Release 0.6 / 9-Jan-2017
 * Added value_with_default method to be used in templates
 
-=== Release 0.5.2
+=== Release 0.5.2 / 17-Aug-2016
 * Fixed defect with merging data where key doesn't exist
 
-=== Release 0.5.1
+=== Release 0.5.1 / 10-Aug-2016
 * Added ability to turn off all stubbing by setting disable_stubs
 
-=== Release 0.5
+=== Release 0.5 / 31-Jul-2016
 * Added new helper method to remove all whitespace
 * Added ability to merge data when creating a set of stubs with StubCreator
 * Added ability to change default working directory
 
-=== Release 0.4 / 2016-07-20
+=== Release 0.4 / 21-Jul-2016
 * Added new class (StubCreator) to create a set of stubs from a yaml file
 
-=== Release 0.3.1 / 2016-06-27
+=== Release 0.3.1 / 28-Jun-2016
 * Added remove_newlines method to String as a helper for rendering subtemplates
 * Added escape_double_quotes method to String as a helper for rendering subtemplates
 * Added empty Hash as default parameter for stub_with_erb
 
-=== Release 0.3 / 2016-06-27
+=== Release 0.3 / 27-Jun-2016
 * Removed the config directory from the gem thereby reducing the size
 * Added documentation
 
-=== Release 0.2 / 2016-06-16
+=== Release 0.2 / 16-Jun-2016
 * Reorganized the imports to make it easier to utilize the rake tasks
 
-=== Release 0.1 / 2016-06-15
+=== Release 0.1 / 15-Jun-2016
 * Initial release with basic functionality

data/README.md

@@ -15,24 +15,48 @@ ServiceMock also provides two built-in rake task that can be used to start and s
 instance of WireMock.  The rake task need to be executed on the machine that the server
 will run - there is no ability for remote start and stop.
 
+## Getting Started
+
+This section is a high-level overview of how I typically use this gem in my projects.
+I will skip over some details here but you can find them below.
+
+Let's say that I have an application that is using many restful services.  I would
+begin by starting up WireMock in proxy mode and make my application request the services
+from the WireMock url (usually with a Rake task I would create). WireMock will create
+two files for each service call - one that has the request / response structure and
+one that has the response body.
+
+Next I would take the files created by WireMock and turn them into my templates.  I do
+this by updating values in the files to data elements.  For example, if I have some place
+that had a persons last name I would put `<%= last_name %>` there. If I wanted to provide
+a default that could be used I would use one of this gems ERB helper methods that allows
+me to provide a default - `<%= value_with_default(last_name, 'Smith') %>`.  If there
+is part of the message that repeats itself I might create a loop.  I can use any Ruby
+code I want.
+
+Once I have the templates created I then turn to my tests.  For each test I specify
+the data that I need to merge with the templates or override the defaults.  I put this
+data in my yml files.  Once I have the data file created I simply make the call in my
+code to stub out the services.
+
 ## Usage
 
 ### Using the API
 
 All interaction with the WireMock services is via calls to an instance of
 `ServiceMock::Server`.  On your local machine you can `start` and `stop` an
-instance of the server process.  On local and remove machines you can also
+instance of the server process.  On local and remote machines you can also
 use one of several methods to create stubs (specify request/response data)
 as well as tell the server to `save` in-memory stubs, `reset_mappings` to
 remove all of the stubs you have provided and `reset_all` which completely
 clears all mappings and files that you have setup for WireMock to return
 as your system under test interacts with it.
 
-When you create your instance of `ServiceMock::Server` you need to provide
-some information.  The required piece of data is the version of WireMock
+When you create an instance of `ServiceMock::Server` you often need to provide
+some additional information.  The _required_ piece of data is the version of WireMock
 you will be using.  If the name of the WireMock jar file you will be using
-is `wiremock-standalone-2.0.10-beta.jar` then the version you should provide
-is `standalone-2.0.10-beta`.  In other words, take off the initial `wiremock-`
+is `wiremock-standalone-2.5.0.jar` then the version you should provide
+is `standalone-2.5.0`.  In other words, take off the initial `wiremock-`
 and the trailing `.jar` and this is your version.  The other optional value
 you can provide is the working directory - the location where the WireMock
 jar is located.  By default the working directory is set to `config/mocks`.
@@ -47,8 +71,8 @@ my_server = ServiceMock::Server.new('standalone-2.0.10-beta', '/path/to/jar')
 ```
 
 There are two additional values (inherit_io and wait_for_process) that 
-are defaulted to `false`.  If set to `true`, `inherit_io` will cause our
-instance to 'inherit' the standard out and in for the running WireMock
+have default values of `false`.  If set to `true`, `inherit_io` will cause the
+server instance to 'inherit' the standard out and in for the running WireMock
 process.  When `wait_for_process` is set to `true` it will cause the
 call to `start` to block until the underlying WireMock process exits.
 These values can be overwritten in the call to `start` as described below.
@@ -63,7 +87,7 @@ WireMock runs.  These are set via a block that is passed to the `start` method.
 my_server.start do |server|
   server.port = 8081
   server.record_mappings = true
-  server.root_dir = /path/to/root
+  server.root_dir = '/path/to/root'
   server.verbose = true
 end
 ```
@@ -119,15 +143,15 @@ The third method is where things get interesting.  It allows you to provide
 an [ERB](https://docs.puppet.com/puppet/latest/reference/lang_template_erb.html)
 file that will become your json stub.  ERB stands for Embedded Ruby and
 allows you to insert Ruby code inside any type of file - including json.
-Using this ability to allows us to build templates of the service messages.
-It is quite common to mock a service many times and while the structure
-is the same with each mock the data supplied and returned is different.
-Using templates allows us to simply write the template once and then 
-supply the data for each mock.
+Using this ability allows us to build templates of the service messages.
+It is quite common to mock a service many times in your test suite and 
+while the structure is the same with each mock the data supplied and 
+returned is different. Using templates allows us to simply write the 
+template once and then supply the data for each mock.
 
 The third method takes the full path to an erb file that contains the
-json stub and a `Hash` that contains `key=>value` combinations that will
-fill in the data elements in the template.
+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.  
@@ -138,6 +162,20 @@ my_server.stub(string_containing_json_stub) do |server|
 end
 ```
 
+If the WireMock instance is running on another server you will need to
+provide the url so it can be found.  This is often necessary when you
+are running your tests in a build pipeline or a continuous integration
+server.  You can do this by setting the `remote_host` value like this:
+
+```ruby
+my_server.stub_with_erb(erbfile, values) do |server|
+  server.remote_host = 'other_host_name'
+end
+```
+
+Another way to set both the port and remote host is to set an instance
+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 
@@ -169,10 +207,28 @@ service2.erb:
   password: secret
 ```
 
-With the above file the method call will mock to services.  It will first
+With the above file the method call will mock two services.  It will first
 of all read the file `service1.erb` from the `templates` directory and
 stub it passing the data that is associated.  Next it will read the next
-template file, etc.
+template file (`service2.erb`), etc.
+
+The `create_stubs_with` method has an optional second parameter.  It is
+a `Hash` that can be used to override a value that is contained within
+our data file.  For example, if I wanted to override just the password
+used in service2 from the example above I do this:
+
+```ruby
+stub_creater.create_stubs_with(filename, {'service2' => {'password' => 'updated'}})
+```
+
+### Disabling Stubbing
+
+There might be some tests that you want to run sometimes against mocked
+services and sometimes against the real services.  This is very simple
+to do.  If you simply set the value of `ServieMock.disable_stubs` to
+true all of the `stub_*` methods return immediately without stubbing 
+anything. In practice you would simply point your application to the 
+real services and disable the stubs via this flag.
 
 ### Other capabilities
 
@@ -206,6 +262,22 @@ my_server.reset_all
 Removes all stubs, file based stubs, and request logs from the WireMock
 server.
 
+
+There are two methods that can be used in your ERB templates.  They are:
+
+```ruby
+render(path)
+```
+This will read the file at `path` and place its' contents in place of the call.
+I use this to insert the body inside the response.
+
+```ruby
+value_with_default(value, default)
+```
+This call allows you to provide a default for the data that will be inserted into
+the ERB template.  It can be used like this - 
+`<%= value_with_default(city, 'Toronto') %>`
+
 ### Using the Rake Tasks
 
 There are two rake tasks that are provided to make it easy to start and
@@ -228,7 +300,7 @@ to the rake task.
 ServiceMock::Rake::StartServerTask.new(:start_server, WIREMOCK_VERSION) do |server|
   server.port = 8081
   server.record_mappings = true
-  server.root_dir = /path/to/root
+  server.root_dir = '/path/to/root'
   server.verbose = true
 end
 ```

data/lib/service_mock/server.rb

@@ -115,7 +115,7 @@ module ServiceMock
     def stub_with_file(filename)
       return if ::ServiceMock.disable_stubs
       yield self if block_given?
-      content = File.open(filename, 'rb') {|file| file.read}
+      content = File.open(filename, 'rb') { |file| file.read }
       stub(content)
     end
 
@@ -126,7 +126,7 @@ module ServiceMock
     def stub_with_erb(filename, hsh={})
       return if ::ServiceMock.disable_stubs
       yield self if block_given?
-      template = File.open(filename, 'rb') {|file| file.read}
+      template = File.open(filename, 'rb') { |file| file.read }
       erb_content = ERB.new(template).result(data_binding(hsh))
       stub(erb_content)
     end
@@ -181,10 +181,12 @@ module ServiceMock
     end
 
     def admin_host
+      return ENV['WIREMOCK_URL'].match(/http\:\/\/(.+)\:\d+/)[1] if ENV['WIREMOCK_URL']
       "#{remote_host ? remote_host : 'localhost'}"
     end
 
     def admin_port
+      self.port = ENV['WIREMOCK_URL'].match(/http\:\/\/.+\:(\d*)/)[1] if ENV['WIREMOCK_URL']
       "#{port ? port.to_s : '8080'}"
     end
 

data/lib/service_mock/version.rb

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

metadata

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