hoverfly 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9ea3d9618109d0f8e5181c050845e168ff36fd5e
+  data.tar.gz: 8feb22c719fba488f4c0155493cb3f5a23ae08b7
+SHA512:
+  metadata.gz: c40742df721ad9465f8b1005ca9f682d07b31c1f6e0327c12c0534bb650bf2168b03e8ee0be0269384727fc35ebcd9106be8e24189d8da9799c8d1d1dda41412
+  data.tar.gz: 5723d1522fd4b21c588e68ae6238e91461ed9fd90739320787d4c85da6ac62ddc137aa5fa24b9fa88cc04d28d189f710fcfcaaf2f975241febe81fb8c7142995

data/LICENSE

@@ -0,0 +1,21 @@
+MIT LICENSE
+
+Copyright (c)  Justin Commu <Justin.Commu@loblaw.ca>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,89 @@
+# Hoverfly Gem
+
+Welcome to the Hoverfly Gem, a ruby written wrapper for Hoverfly!
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'hoverfly'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install hoverfly
+
+## 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
+
+### Recording an API response
+```
+require 'hoverfly'
+
+Hoverfly.start('test')
+
+# Set Hoverfly to capture mode
+Hoverfly.update_mode('capture')
+
+# Send the API request to be recorded
+`curl --proxy http://localhost:8500 http://time.jsontest.com `
+
+# Export the simulation that Hoverfly has recorded
+file = File.open( "simulation.json", "w" )
+file << Hoverfly.get_current_simulations
+file.close
+
+Hoverfly.stop
+```
+### Replaying an existing API response
+```
+require 'hoverfly'
+
+Hoverfly.start('test')
+
+# Set Hoverfly to simulate mode
+Hoverfly.update_mode('simulate')
+
+# Import an existing simulation into Hoverfly
+Hoverfly.import(['simulation.json'])
+
+# Now when we make the API call, we will get the response that we imported into Hoverfly
+`curl --proxy http://localhost:8500 http://time.jsontest.com `
+
+Hoverfly.stop
+```
+
+### Available Methods
+| Method | Description | Example |
+|--------|-------------|---------|
+|start(tag, ports)|This method starts up a new instance of Hoverfly. It takes in a tag, which is required, as well as an optional hash which allows you to specify the admin and proxy ports. If no hash is specified, then the default admin port (8888) and proxy port (8500) are used.| Hoverfly.start('test', {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|
+|get_config_info|Returns Hoverfly configuration info|Hoverfly.get_config_info|
+|get_current_destination|Returns the current destination that has been set for Hoverfly. Once a destination has been set, Hoverfly only intercepts traffic for that URL|Hoverfly.get_current_destination|
+|update_destinitation|Sets / updates the destination URL that Hoverfly looks at|Hoverfly.update_destination('http://time.jsontest.com')|
+|get_current_middleware|Returns info about the middleware that Hoverfly is currently set to use|Hoverfly.get_current_middleware|
+|middleware|This allows you to set the middleware to be used by Hoverfly. This method accepts a hash where the key specifies the type of middleware, and the value specifies the location. For example if wanted to use a remote server for your middleware, you would pass {remote: <server_url>} to this method|Hoverfly.middleware({remote: 'http://mymiddleware.com'})|
+|get_current_mode|Returns the mode that Hoverfly is currently set to|Hoverfly.get_current_mode|
+|update_mode|Changes the mode that Hoverfly in running in. By default, Hoverfly starts in simulate mdoe|Hoverfly.update_mode('capture')|
+|get_usage|Returns usage info for Hoverfly|Hoverfly.get_usage|
+|get_version|Returns the current Hoverfly version|Hoverfly.get_version|
+|get_upstream_proxy|Returns the proxy port that Hoverfly is currently using|Hoverfly.get_upstream_proxy|
+|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
+
+Bug reports and pull requests are welcome. Note that if you are reporting a bug then make sure to include a failing spec that highlights an example of the bug. 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.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/lib/client.rb

@@ -0,0 +1,54 @@
+class Hoverfly
+  extend HoverflyAPI
+
+  class << self
+    attr_reader :target
+
+    def start(target, 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}"
+      system "hoverctl start --admin-port #{admin_port} --proxy-port #{proxy_port} -t #{@target}"
+      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"
+    end
+
+    def middleware(middleware_location)
+      update_middleware({binary: '', script: '', remote: ''}.merge(middleware_location))
+    end
+
+    def import(file_list)
+      update_simulations(to_simulation(file_list))
+    end
+
+    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
+    end
+  end
+end

data/lib/endpoints.rb

@@ -0,0 +1,67 @@
+module HoverflyAPI
+  include HTTParty
+
+  def get_current_simulations
+    HoverflyAPI.get('/api/v2/simulation').response.body
+  end
+
+  def update_simulations(simulation)
+    HoverflyAPI.put('/api/v2/simulation', headers: { 'Content-Type' => 'application/json' }, body: simulation).response.body
+  end
+
+  def get_current_simulation_schema
+    HoverflyAPI.get('/api/v2/simulation/schema').response.body
+  end
+
+  def get_config_info
+    HoverflyAPI.get('/api/v2/hoverfly').response.body
+  end
+
+  def get_current_destination
+    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
+  end
+
+  def get_current_middleware
+    HoverflyAPI.get('/api/v2/hoverfly/middleware').response.body
+  end
+
+  def update_middleware(middleware_request)
+    HoverflyAPI.put('/api/v2/hoverfly/middleware', headers: { 'Content-Type' => 'application/json' }, body: middleware_request.to_json).response.body
+  end
+
+  def get_current_mode
+    HoverflyAPI.get('/api/v2/hoverfly/mode').response.body
+  end
+
+  def update_mode(mode)
+    HoverflyAPI.put('/api/v2/hoverfly/mode', headers: { 'Content-Type' => 'application/json' }, body: { mode: mode }.to_json).response.body
+  end
+
+  def get_usage
+    HoverflyAPI.get('/api/v2/hoverfly/usage').response.body
+  end
+
+  def get_version
+    HoverflyAPI.get('/api/v2/hoverfly/version').response.body
+  end
+
+  def get_upstream_proxy
+    HoverflyAPI.get('/api/v2/hoverfly/upstream-proxy').response.body
+  end
+
+  def get_cached_data
+    HoverflyAPI.get('/api/v2/cache').response.body
+  end
+
+  def clear_cached_data
+    HoverflyAPI.delete('/api/v2/cache').response.body
+  end
+
+  def get_logs
+    HoverflyAPI.get('/api/v2/logs').response.body
+  end
+end

data/lib/hoverfly.rb

@@ -0,0 +1,5 @@
+require 'httparty'
+require 'json'
+
+require_relative 'endpoints'
+require_relative 'client'

data/lib/schema_metadata/footer.json

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

data/lib/schema_metadata/header.json

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

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: hoverfly
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Automation Wizards
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-06-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.13.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.13.7
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.11.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.11.2
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.10.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.10.4
+description: Use this library to interact with Hoverfly in ruby
+email:
+- bjorn.ramroop@loblaw.ca
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/client.rb
+- lib/endpoints.rb
+- lib/hoverfly.rb
+- lib/schema_metadata/footer.json
+- lib/schema_metadata/header.json
+homepage: https://github.com/automation-wizards/hoverfly
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: Ruby wrapper for Hoverfly
+test_files: []