dkastner-hoverfly 0.0.6

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d99f28981261879e31d4d8bd018ed498aa09695d
+  data.tar.gz: 858b991506be34b6c6d2af0750b78f6b7df05b85
+SHA512:
+  metadata.gz: b845c5ac96febadf8dc043f7e38b2bae1973cf139d8b7b0a356f06962cc06e09da6c745bb8d07537217655ece2a0a9f2763e01119a64604f2f174cf3a7c5eeee
+  data.tar.gz: 200301bef97894e9b7a81bea70326eaf6c1a7baf4ed8de2e8517111c88c219ef322d5756d68389757b52ce8b91a10b5f2da7948e2e880fda687c27fe3ac2cb6b

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,97 @@
+# Hoverfly Gem
+[![Build Status](https://travis-ci.org/azohra/hoverfly.svg?branch=master)](https://travis-ci.org/azohra/hoverfly)
+
+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 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'
+
+# 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')
+
+# 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
+```
+### Replaying an existing API response
+```ruby
+require 'hoverfly'
+
+# 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')
+
+# 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`
+```
+
+### Available Methods
+| Method | Description | Example |
+|--------|-------------|---------|
+|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'])|
+|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|
+
+## 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,35 @@
+class Hoverfly
+  extend HoverflyAPI
+
+  class << self
+    attr_reader :admin_port, :proxy_port
+
+    def set_ports(admin:, proxy:, ip: 'localhost')
+      @admin_port = admin
+      @proxy_port = proxy
+      HoverflyAPI.default_options.update(verify: false)
+      HoverflyAPI.format :json
+      HoverflyAPI.base_uri "http://#{ip}:#{@admin_port}"
+    end
+
+    def middleware(middleware_location)
+      update_middleware({ binary: '', script: '', remote: '' }.merge(middleware_location))
+    end
+
+    def import(file_list, meta = {})
+      update_simulations(to_simulation(file_list, meta))
+    end
+
+    private
+
+    def to_simulation(file_list, meta)
+      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

@@ -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_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
+    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/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

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: dkastner-hoverfly
+version: !ruby/object:Gem::Version
+  version: 0.0.6
+platform: ruby
+authors:
+- Automation Wizards
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-10-17 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: 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/schema.json.erb
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Ruby wrapper for Hoverfly
+test_files: []