hoverfly 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c609fc3bdd9124c5b52e4388ba54b43c8f3abf1b
-  data.tar.gz: 9ced6d3f6317248a839969384859155c4b6eb090
+  metadata.gz: 195c03f65558691d1b564ef22563d42d2f69ced6
+  data.tar.gz: 90af28506d7c2870b438bfa7a755ea1dc9a994ac
 SHA512:
-  metadata.gz: e90f2e0151bd3df700b405a116ead38d4659115d22f9bfad328838dfa9574d895832ffaafb2d7a13169bfee7131d6b02ec3fbe1cc232a1f5479f444aa85a490f
-  data.tar.gz: 86a40c481cb302a76a4bab6e58767db0d83eadd6df5b8df4fda2859603e962392f21619bed86904f1462a27101a6487b50c2a8e5d5871d73e801bf76d1cea173
+  metadata.gz: 7e1841e75801f9c3e10a67cdef3c1b1ef9103f3d15eb3224fafbc21168b50673639e1efa22981967b50a211beed8ebb76e907e86f792580e491f9735b5c073ab
+  data.tar.gz: 900cdb2b1ee91f43efb782b6d400ac22f0119971fd81b7555da5dad03685fb5ee2133cf1a0150f11823a4b0f5b3519e7d31aa58af8e517a2e93c81cfbb5d89cc

data/README.md

@@ -20,14 +20,24 @@ Or install it yourself as:
 
 ## Usage
 
-This gem gives you full access to the Hoverfly API as well as the ability to spin up and tear down different Hoverfly instances. See below for examples, as well as a reference of the actions that can be done
+This gem gives you full access to the Hoverfly API as well as the ability to dynamically build simulations to import into Hoverfly. See below for examples, as well as a reference of the actions that can be done.
+
+This gem assumes that you have already started a running instance of Hoverfly. This can be done in multiple ways. For example, you can install Hoverfly on your host system and start it by executing:
+
+    $ hoverctl start
+    
+Alternatively, you can start Hoverfly in a docker container and expose the Hoverfly admin and proxy ports to the host system as. If you have a docker image named `hoverfly` with Hoverfly already installed, then you can do this as follows:
+
+    $ docker run -d -p 8888:8888 -p 8500:8500 --name hoverfly hoverfly
+
+The following examples assume that you have already started a Hoverfly instance (docker or otherwise) with the default admin and proxy ports (8888 and 8500 respectively)
 
 ### Recording an API response
 ```ruby
 require 'hoverfly'
 
-# Start Hoverfly as a proxy
-Hoverfly.start('test', 'proxy')
+# Specify the ports to be used to communicate with Hoverfly
+Hoverfly.set_ports(admin: 8888, proxy: 8500)
 
 # Set Hoverfly to capture mode
 Hoverfly.update_mode('capture')
@@ -39,15 +49,13 @@ Hoverfly.update_mode('capture')
 file = File.open( "simulation.json", "w" )
 file << Hoverfly.get_current_simulations
 file.close
-
-Hoverfly.stop
 ```
 ### Replaying an existing API response
 ```ruby
 require 'hoverfly'
 
-# Start Hoverfly as a webserver
-Hoverfly.start('test')
+# Specify the ports to be used to communicate with Hoverfly
+Hoverfly.set_ports(admin: 8888, proxy: 8500)
 
 # Set Hoverfly to simulate mode
 Hoverfly.update_mode('simulate')
@@ -56,15 +64,12 @@ Hoverfly.update_mode('simulate')
 Hoverfly.import(['simulation.json'])
 
 # Now when we make the API call, we will get the response that we imported into Hoverfly
-`curl http://localhost:8500`
-
-Hoverfly.stop
+`curl --proxy http://localhost:8500 http://time.jsontest.com`
 ```
 
 ### Available Methods
 | Method | Description | Example |
 |--------|-------------|---------|
-|start(tag, mode, ports)|This method starts up a new instance of Hoverfly. It takes in a tag, which is required, an optional mode, as well as keyword arguments that allow you to specify the admin and proxy ports. If no mode is specified, Hoverfly will start in webserver mode by default. If no hash is specified, then the default admin port (8888) and proxy port (8500) are used.| Hoverfly.start('test', 'proxy', admin: 9000, proxy: 9001)|
 |get_current_simulations|Returns the current simulation being used by Hoverfly|Hoverfly.get_current_simulations|
 |get_current_simulation_schema|Returns the schema of the simulations currently being used by Hoverfly|Hoverfly.get_current_simulation_schema|
 |import(file_list)|Compiles the given files into a simulation JSON file, and then sets that file as the simulation to be used by Hoverfly|Hoverfly.import(['./login.json', './logout.json'])|
@@ -81,7 +86,6 @@ Hoverfly.stop
 |get_cached_data|Returns data that Hoverfly has cached|Hoverfly.get_cached_data|
 |clear_cached_data|Clears the Hoverfly cache|Hoverfly.clear_cached_data|
 |get_logs|Returns the Hoverfly logs|Hoverfly.get_logs|
-|stop|Kills the current instance of Hoverfly. This shuts down Hoverfly and deletes the tag used to start that instance. Once Hoverfly is stopped, the tag can be reused|Hoverfly.stop|
 
 ## Contributing
 

data/lib/client.rb

@@ -2,29 +2,14 @@ class Hoverfly
   extend HoverflyAPI
 
   class << self
-    attr_reader :target
+    attr_reader :admin_port, :proxy_port
 
-    def start(target, mode = 'webserver', **ports)
-      @target = target
-      admin_port = ports.fetch(:admin, 8888)
-      proxy_port = ports.fetch(:proxy, 8500)
-      puts "Starting target #{target} with admin #{admin_port} and proxy #{proxy_port}"
-      system "hoverctl targets create #{@target}"
-      if mode == 'proxy'
-        system "hoverctl start --admin-port #{admin_port} --proxy-port #{proxy_port} -t #{@target}"
-      else
-        system "hoverctl start webserver --admin-port #{admin_port} --proxy-port #{proxy_port} -t #{@target}"
-        puts "Unknown Hoverfly mode \"#{mode}\". Starting in webserver mode" if mode != 'webserver'
-      end
+    def set_ports(admin:, proxy:)
+      @admin_port = admin
+      @proxy_port = proxy
       HoverflyAPI.default_options.update(verify: false)
       HoverflyAPI.format :json
-      HoverflyAPI.base_uri "http://localhost:#{admin_port}"
-    end
-
-    def stop
-      puts "Stopping target #{Hoverfly.target} with base URL #{HoverflyAPI.base_uri}"
-      system "hoverctl stop -t #{@target}"
-      system "hoverctl targets delete #{@target} -f"
+      HoverflyAPI.base_uri "http://localhost:#{@admin_port}"
     end
 
     def middleware(middleware_location)
@@ -38,22 +23,13 @@ class Hoverfly
     private
 
     def to_simulation(file_list, meta)
-      header_path = meta[:header] || File.expand_path('schema_metadata/header.json', __dir__)
-      footer_path = meta[:footer] || File.expand_path('schema_metadata/footer.json', __dir__)
-      header = File.open(header_path)
-      footer = File.open(footer_path)
-      mock = header.read
-      all_simulations = file_list.map do |filename|
-        file = File.open(filename)
-        simulation = file.read
-        file.close
-        simulation
-      end
-      mock << all_simulations.join(',')
-      mock << footer.read
-      header.close
-      footer.close
-      mock
+      schema_path = meta[:schema] || File.expand_path('schema_metadata/schema.json.erb', __dir__)
+      all_simulations = file_list.map { |filename| File.read(filename) }
+      erb(File.read(schema_path)) { all_simulations.join(',') }
+    end
+
+    def erb(template)
+      ERB.new(template).result(binding)
     end
   end
 end

data/lib/endpoints.rb

@@ -18,11 +18,11 @@ module HoverflyAPI
   end
 
   def get_current_destination
-    HoverflyAPI.get(' /api/v2/hoverfly/destination').response.body
+    HoverflyAPI.get('/api/v2/hoverfly/destination').response.body
   end
 
-  def update_destinitation(destination)
-    HoverflyAPI.put(' /api/v2/hoverfly/destination', headers: { 'Content-Type' => 'application/json' }, body: { destination: destination }.to_json).response.body
+  def update_destination(destination)
+    HoverflyAPI.put('/api/v2/hoverfly/destination', headers: { 'Content-Type' => 'application/json' }, body: { destination: destination }.to_json).response.body
   end
 
   def get_current_middleware

data/lib/schema_metadata/schema.json.erb

@@ -0,0 +1,15 @@
+{
+  "data": {
+    "pairs": [
+      <%= yield %>
+    ],
+    "globalActions": {
+      "delays": []
+    }
+  },
+  "meta": {
+    "schemaVersion": "v2",
+    "hoverflyVersion": "v0.10.2",
+    "timeExported": "2017-05-05T15:10:36-04:00"
+  }
+}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hoverfly
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Automation Wizards
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-06-20 00:00:00.000000000 Z
+date: 2017-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -78,8 +78,7 @@ files:
 - lib/client.rb
 - lib/endpoints.rb
 - lib/hoverfly.rb
-- lib/schema_metadata/footer.json
-- lib/schema_metadata/header.json
+- lib/schema_metadata/schema.json.erb
 homepage: https://github.com/automation-wizards/hoverfly
 licenses:
 - MIT

data/lib/schema_metadata/footer.json

@@ -1,11 +0,0 @@
-		],
-		"globalActions": {
-			"delays": []
-		}
-	},
-	"meta": {
-		"schemaVersion": "v2",
-		"hoverflyVersion": "v0.10.2",
-		"timeExported": "2017-05-05T15:10:36-04:00"
-	}
-}

data/lib/schema_metadata/header.json

@@ -1,3 +0,0 @@
-{
-	"data": {
-		"pairs": [