mockserver-client 1.0.8.pre → 5.3.0

data/lib/mockserver-client/version.rb

@@ -0,0 +1,15 @@
+=begin
+#Mock Server API
+
+#MockServer enables easy mocking of any system you integrate with via HTTP or HTTPS with clients written in Java, JavaScript and Ruby and a simple REST API (as shown below).  MockServer Proxy is a proxy that introspects all proxied traffic including encrypted SSL traffic and supports Port Forwarding, Web Proxying (i.e. HTTP proxy), HTTPS Tunneling Proxying (using HTTP CONNECT) and SOCKS Proxying (i.e. dynamic port forwarding).  Both MockServer and the MockServer Proxy record all received requests so that it is possible to verify exactly what requests have been sent by the system under test.
+
+OpenAPI spec version: 5.3.0
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 3.3.1
+
+=end
+
+module MockServer
+  VERSION = '5.3.0'
+end

data/mockserver-client.gemspec

@@ -1,37 +1,45 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'mockserver/version'
-
-Gem::Specification.new do |spec|
-  spec.name        = 'mockserver-client'
-  spec.version     = MockServer::VERSION
-  spec.authors     = ['Nayyara Samuel', 'James D Bloom']
-  spec.email       = ['nayyara.samuel@opower.com', 'jamesdbloom@gmail.com']
-  spec.homepage    = 'http://www.mock-server.com'
-  spec.summary     = 'A Ruby client for MockServer'
-  spec.description = 'A Ruby Client for MockServer that enables easy mocking of any system you integrate with via HTTP or HTTPS (i.e. services, web sites, etc)'
-
-  spec.required_ruby_version     = '>= 1.9'
-  spec.required_rubygems_version = '~> 2.0'
-
-  spec.files         = `git ls-files -z`.split("\x0")
-  spec.executables   = spec.files.grep(/^bin\//) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(/^(test|spec|features)\//)
-  spec.require_paths = ['lib']
-
-  spec.add_development_dependency 'bundler', '~> 1'
-  spec.add_development_dependency 'rake', '~> 10.3'
-  spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'simplecov', '~> 0.8'
-  spec.add_development_dependency 'webmock', '~> 1.18'
-  spec.add_development_dependency 'rubocop', '~> 0.23'
-
-  spec.add_dependency 'hashie', '~> 3.0'
-  spec.add_dependency 'json', '~> 1.8'
-  spec.add_dependency 'activesupport', '~> 4.1'
-  spec.add_dependency 'rest-client', '~> 1.7'
-  spec.add_dependency 'logging_factory', '~> 0.0.2'
-  spec.add_dependency 'thor', '~> 0.19'
-  spec.add_dependency 'colorize', '~> 0.7'
+# -*- encoding: utf-8 -*-
+
+=begin
+#Mock Server API
+
+#MockServer enables easy mocking of any system you integrate with via HTTP or HTTPS with clients written in Java, JavaScript and Ruby and a simple REST API (as shown below).  MockServer Proxy is a proxy that introspects all proxied traffic including encrypted SSL traffic and supports Port Forwarding, Web Proxying (i.e. HTTP proxy), HTTPS Tunneling Proxying (using HTTP CONNECT) and SOCKS Proxying (i.e. dynamic port forwarding).  Both MockServer and the MockServer Proxy record all received requests so that it is possible to verify exactly what requests have been sent by the system under test.
+
+OpenAPI spec version: 5.3.0
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 3.3.1
+
+=end
+
+$:.push File.expand_path("../lib", __FILE__)
+require "mockserver-client/version"
+
+Gem::Specification.new do |s|
+  s.name        = "mockserver-client"
+  s.version     = MockServer::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["James D Bloom"]
+  s.email       = ["jamesdbloom@gmail.com"]
+  s.homepage    = "http://www.mock-server.com"
+  s.summary     = "Mock Server API Ruby Gem"
+  s.description = "MockServer enables easy mocking of any system you integrate with via HTTP or HTTPS with clients written in Java, JavaScript and Ruby and a simple REST API (as shown below).  MockServer Proxy is a proxy that introspects all proxied traffic including encrypted SSL traffic and supports Port Forwarding, Web Proxying (i.e. HTTP proxy), HTTPS Tunneling Proxying (using HTTP CONNECT) and SOCKS Proxying (i.e. dynamic port forwarding).  Both MockServer and the MockServer Proxy record all received requests so that it is possible to verify exactly what requests have been sent by the system under test."
+  s.license     = 'Apache-2.0'
+  s.required_ruby_version = ">= 2.0"
+
+  s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
+  s.add_runtime_dependency 'json', '~> 2.1', '>= 2.1.0'
+
+  s.add_development_dependency 'rspec', '~> 3.6', '>= 3.6.0'
+  s.add_development_dependency 'vcr', '~> 3.0', '>= 3.0.1'
+  s.add_development_dependency 'webmock', '~> 1.24', '>= 1.24.3'
+  s.add_development_dependency 'autotest', '~> 4.4', '>= 4.4.6'
+  s.add_development_dependency 'autotest-rails-pure', '~> 4.1', '>= 4.1.2'
+  s.add_development_dependency 'autotest-growl', '~> 0.2', '>= 0.2.16'
+  s.add_development_dependency 'autotest-fsevent', '~> 0.2', '>= 0.2.12'
+
+  s.files         = `find *`.split("\n").uniq.sort.select { |f| !f.empty? }
+  s.test_files    = `find spec/*`.split("\n")
+  s.executables   = []
+  s.require_paths = ["lib"]
 end

data/spec/api/control_api_spec.rb

@@ -0,0 +1,102 @@
+=begin
+#Mock Server API
+
+#MockServer enables easy mocking of any system you integrate with via HTTP or HTTPS with clients written in Java, JavaScript and Ruby and a simple REST API (as shown below).  MockServer Proxy is a proxy that introspects all proxied traffic including encrypted SSL traffic and supports Port Forwarding, Web Proxying (i.e. HTTP proxy), HTTPS Tunneling Proxying (using HTTP CONNECT) and SOCKS Proxying (i.e. dynamic port forwarding).  Both MockServer and the MockServer Proxy record all received requests so that it is possible to verify exactly what requests have been sent by the system under test.
+
+OpenAPI spec version: 5.3.0
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 3.3.1
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for MockServer::ControlApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'ControlApi' do
+  before do
+    # run before each test
+    @instance = MockServer::ControlApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of ControlApi' do
+    it 'should create an instance of ControlApi' do
+      expect(@instance).to be_instance_of(MockServer::ControlApi)
+    end
+  end
+
+  # unit tests for bind_put
+  # bind additional listening ports
+  # only supported on Netty version
+  # @param ports list of ports to bind to, where 0 indicates dynamically bind to any available port
+  # @param [Hash] opts the optional parameters
+  # @return [Ports]
+  describe 'bind_put test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for clear_put
+  # clears expectations and recorded requests that match the request matcher
+  # @param [Hash] opts the optional parameters
+  # @option opts [HttpRequest] :http_request request used to match expectations and recored requests to clear
+  # @return [nil]
+  describe 'clear_put test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for reset_put
+  # clears all expectations and recorded requests
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'reset_put test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for retrieve_put
+  # retrieve recorded requests, active expectations, recorded expectations or log messages
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :format changes response format, default if not specificed is \"json\", supported values are \"java\", \"json\"
+  # @option opts [String] :type specifies the type of object that is retrieve, default if not specified is \"requests\", supported values are \"logs\", \"requests\", \"recorded_expectations\", \"active_expectations\"
+  # @option opts [HttpRequest] :http_request request used to match which recorded requests, expectations or log messages to return, an empty body matches all requests, expectations or log messages
+  # @return [Object]
+  describe 'retrieve_put test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for status_put
+  # return listening ports
+  # @param [Hash] opts the optional parameters
+  # @return [Ports]
+  describe 'status_put test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for stop_put
+  # stop running process
+  # only supported on Netty version
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'stop_put test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/api/expectation_api_spec.rb

@@ -0,0 +1,46 @@
+=begin
+#Mock Server API
+
+#MockServer enables easy mocking of any system you integrate with via HTTP or HTTPS with clients written in Java, JavaScript and Ruby and a simple REST API (as shown below).  MockServer Proxy is a proxy that introspects all proxied traffic including encrypted SSL traffic and supports Port Forwarding, Web Proxying (i.e. HTTP proxy), HTTPS Tunneling Proxying (using HTTP CONNECT) and SOCKS Proxying (i.e. dynamic port forwarding).  Both MockServer and the MockServer Proxy record all received requests so that it is possible to verify exactly what requests have been sent by the system under test.
+
+OpenAPI spec version: 5.3.0
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 3.3.1
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for MockServer::ExpectationApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'ExpectationApi' do
+  before do
+    # run before each test
+    @instance = MockServer::ExpectationApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of ExpectationApi' do
+    it 'should create an instance of ExpectationApi' do
+      expect(@instance).to be_instance_of(MockServer::ExpectationApi)
+    end
+  end
+
+  # unit tests for expectation_put
+  # create expectation
+  # @param expectations expectation to create
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'expectation_put test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/api/verify_api_spec.rb

@@ -0,0 +1,57 @@
+=begin
+#Mock Server API
+
+#MockServer enables easy mocking of any system you integrate with via HTTP or HTTPS with clients written in Java, JavaScript and Ruby and a simple REST API (as shown below).  MockServer Proxy is a proxy that introspects all proxied traffic including encrypted SSL traffic and supports Port Forwarding, Web Proxying (i.e. HTTP proxy), HTTPS Tunneling Proxying (using HTTP CONNECT) and SOCKS Proxying (i.e. dynamic port forwarding).  Both MockServer and the MockServer Proxy record all received requests so that it is possible to verify exactly what requests have been sent by the system under test.
+
+OpenAPI spec version: 5.3.0
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 3.3.1
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for MockServer::VerifyApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'VerifyApi' do
+  before do
+    # run before each test
+    @instance = MockServer::VerifyApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of VerifyApi' do
+    it 'should create an instance of VerifyApi' do
+      expect(@instance).to be_instance_of(MockServer::VerifyApi)
+    end
+  end
+
+  # unit tests for verify_put
+  # verify a request has been received a specific number of times
+  # @param verification request matcher and the number of times to match
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'verify_put test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for verify_sequence_put
+  # verify a sequence of request has been received in the specific order
+  # @param verification_sequence the sequence of requests matchers
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'verify_sequence_put test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/api_client_spec.rb

@@ -0,0 +1,226 @@
+=begin
+#Mock Server API
+
+#MockServer enables easy mocking of any system you integrate with via HTTP or HTTPS with clients written in Java, JavaScript and Ruby and a simple REST API (as shown below).  MockServer Proxy is a proxy that introspects all proxied traffic including encrypted SSL traffic and supports Port Forwarding, Web Proxying (i.e. HTTP proxy), HTTPS Tunneling Proxying (using HTTP CONNECT) and SOCKS Proxying (i.e. dynamic port forwarding).  Both MockServer and the MockServer Proxy record all received requests so that it is possible to verify exactly what requests have been sent by the system under test.
+
+OpenAPI spec version: 5.3.0
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 3.3.1
+
+=end
+
+require 'spec_helper'
+
+describe MockServer::ApiClient do
+  context 'initialization' do
+    context 'URL stuff' do
+      context 'host' do
+        it 'removes http from host' do
+          MockServer.configure { |c| c.host = 'http://example.com' }
+          expect(MockServer::Configuration.default.host).to eq('example.com')
+        end
+
+        it 'removes https from host' do
+          MockServer.configure { |c| c.host = 'https://wookiee.com' }
+          expect(MockServer::ApiClient.default.config.host).to eq('wookiee.com')
+        end
+
+        it 'removes trailing path from host' do
+          MockServer.configure { |c| c.host = 'hobo.com/v4' }
+          expect(MockServer::Configuration.default.host).to eq('hobo.com')
+        end
+      end
+
+      context 'base_path' do
+        it "prepends a slash to base_path" do
+          MockServer.configure { |c| c.base_path = 'v4/dog' }
+          expect(MockServer::Configuration.default.base_path).to eq('/v4/dog')
+        end
+
+        it "doesn't prepend a slash if one is already there" do
+          MockServer.configure { |c| c.base_path = '/v4/dog' }
+          expect(MockServer::Configuration.default.base_path).to eq('/v4/dog')
+        end
+
+        it "ends up as a blank string if nil" do
+          MockServer.configure { |c| c.base_path = nil }
+          expect(MockServer::Configuration.default.base_path).to eq('')
+        end
+      end
+    end
+  end
+
+  describe 'params_encoding in #build_request' do
+    let(:config) { MockServer::Configuration.new }
+    let(:api_client) { MockServer::ApiClient.new(config) }
+
+    it 'defaults to nil' do
+      expect(MockServer::Configuration.default.params_encoding).to eq(nil)
+      expect(config.params_encoding).to eq(nil)
+
+      request = api_client.build_request(:get, '/test')
+      expect(request.options[:params_encoding]).to eq(nil)
+    end
+
+    it 'can be customized' do
+      config.params_encoding = :multi
+      request = api_client.build_request(:get, '/test')
+      expect(request.options[:params_encoding]).to eq(:multi)
+    end
+  end
+
+  describe 'timeout in #build_request' do
+    let(:config) { MockServer::Configuration.new }
+    let(:api_client) { MockServer::ApiClient.new(config) }
+
+    it 'defaults to 0' do
+      expect(MockServer::Configuration.default.timeout).to eq(0)
+      expect(config.timeout).to eq(0)
+
+      request = api_client.build_request(:get, '/test')
+      expect(request.options[:timeout]).to eq(0)
+    end
+
+    it 'can be customized' do
+      config.timeout = 100
+      request = api_client.build_request(:get, '/test')
+      expect(request.options[:timeout]).to eq(100)
+    end
+  end
+
+  describe '#deserialize' do
+    it "handles Array<Integer>" do
+      api_client = MockServer::ApiClient.new
+      headers = { 'Content-Type' => 'application/json' }
+      response = double('response', headers: headers, body: '[12, 34]')
+      data = api_client.deserialize(response, 'Array<Integer>')
+      expect(data).to be_instance_of(Array)
+      expect(data).to eq([12, 34])
+    end
+
+    it 'handles Array<Array<Integer>>' do
+      api_client = MockServer::ApiClient.new
+      headers = { 'Content-Type' => 'application/json' }
+      response = double('response', headers: headers, body: '[[12, 34], [56]]')
+      data = api_client.deserialize(response, 'Array<Array<Integer>>')
+      expect(data).to be_instance_of(Array)
+      expect(data).to eq([[12, 34], [56]])
+    end
+
+    it 'handles Hash<String, String>' do
+      api_client = MockServer::ApiClient.new
+      headers = { 'Content-Type' => 'application/json' }
+      response = double('response', headers: headers, body: '{"message": "Hello"}')
+      data = api_client.deserialize(response, 'Hash<String, String>')
+      expect(data).to be_instance_of(Hash)
+      expect(data).to eq(:message => 'Hello')
+    end
+  end
+
+  describe "#object_to_hash" do
+    it 'ignores nils and includes empty arrays' do
+      # uncomment below to test object_to_hash for model
+      # api_client = MockServer::ApiClient.new
+      # _model = MockServer::ModelName.new
+      # update the model attribute below
+      # _model.id = 1
+      # update the expected value (hash) below
+      # expected = {id: 1, name: '', tags: []}
+      # expect(api_client.object_to_hash(_model)).to eq(expected)
+    end
+  end
+
+  describe '#build_collection_param' do
+    let(:param) { ['aa', 'bb', 'cc'] }
+    let(:api_client) { MockServer::ApiClient.new }
+
+    it 'works for csv' do
+      expect(api_client.build_collection_param(param, :csv)).to eq('aa,bb,cc')
+    end
+
+    it 'works for ssv' do
+      expect(api_client.build_collection_param(param, :ssv)).to eq('aa bb cc')
+    end
+
+    it 'works for tsv' do
+      expect(api_client.build_collection_param(param, :tsv)).to eq("aa\tbb\tcc")
+    end
+
+    it 'works for pipes' do
+      expect(api_client.build_collection_param(param, :pipes)).to eq('aa|bb|cc')
+    end
+
+    it 'works for multi' do
+      expect(api_client.build_collection_param(param, :multi)).to eq(['aa', 'bb', 'cc'])
+    end
+
+    it 'fails for invalid collection format' do
+      expect(proc { api_client.build_collection_param(param, :INVALID) }).to raise_error(RuntimeError, 'unknown collection format: :INVALID')
+    end
+  end
+
+  describe '#json_mime?' do
+    let(:api_client) { MockServer::ApiClient.new }
+
+    it 'works' do
+      expect(api_client.json_mime?(nil)).to eq false
+      expect(api_client.json_mime?('')).to eq false
+
+      expect(api_client.json_mime?('application/json')).to eq true
+      expect(api_client.json_mime?('application/json; charset=UTF8')).to eq true
+      expect(api_client.json_mime?('APPLICATION/JSON')).to eq true
+
+      expect(api_client.json_mime?('application/xml')).to eq false
+      expect(api_client.json_mime?('text/plain')).to eq false
+      expect(api_client.json_mime?('application/jsonp')).to eq false
+    end
+  end
+
+  describe '#select_header_accept' do
+    let(:api_client) { MockServer::ApiClient.new }
+
+    it 'works' do
+      expect(api_client.select_header_accept(nil)).to be_nil
+      expect(api_client.select_header_accept([])).to be_nil
+
+      expect(api_client.select_header_accept(['application/json'])).to eq('application/json')
+      expect(api_client.select_header_accept(['application/xml', 'application/json; charset=UTF8'])).to eq('application/json; charset=UTF8')
+      expect(api_client.select_header_accept(['APPLICATION/JSON', 'text/html'])).to eq('APPLICATION/JSON')
+
+      expect(api_client.select_header_accept(['application/xml'])).to eq('application/xml')
+      expect(api_client.select_header_accept(['text/html', 'application/xml'])).to eq('text/html,application/xml')
+    end
+  end
+
+  describe '#select_header_content_type' do
+    let(:api_client) { MockServer::ApiClient.new }
+
+    it 'works' do
+      expect(api_client.select_header_content_type(nil)).to eq('application/json')
+      expect(api_client.select_header_content_type([])).to eq('application/json')
+
+      expect(api_client.select_header_content_type(['application/json'])).to eq('application/json')
+      expect(api_client.select_header_content_type(['application/xml', 'application/json; charset=UTF8'])).to eq('application/json; charset=UTF8')
+      expect(api_client.select_header_content_type(['APPLICATION/JSON', 'text/html'])).to eq('APPLICATION/JSON')
+      expect(api_client.select_header_content_type(['application/xml'])).to eq('application/xml')
+      expect(api_client.select_header_content_type(['text/plain', 'application/xml'])).to eq('text/plain')
+    end
+  end
+
+  describe '#sanitize_filename' do
+    let(:api_client) { MockServer::ApiClient.new }
+
+    it 'works' do
+      expect(api_client.sanitize_filename('sun')).to eq('sun')
+      expect(api_client.sanitize_filename('sun.gif')).to eq('sun.gif')
+      expect(api_client.sanitize_filename('../sun.gif')).to eq('sun.gif')
+      expect(api_client.sanitize_filename('/var/tmp/sun.gif')).to eq('sun.gif')
+      expect(api_client.sanitize_filename('./sun.gif')).to eq('sun.gif')
+      expect(api_client.sanitize_filename('..\sun.gif')).to eq('sun.gif')
+      expect(api_client.sanitize_filename('\var\tmp\sun.gif')).to eq('sun.gif')
+      expect(api_client.sanitize_filename('c:\var\tmp\sun.gif')).to eq('sun.gif')
+      expect(api_client.sanitize_filename('.\sun.gif')).to eq('sun.gif')
+    end
+  end
+end