swaggy_jenkins 0.0.1

data/spec/api/remote_access_api_spec.rb

@@ -0,0 +1,304 @@
+=begin
+#Swaggy Jenkins
+
+#Jenkins API clients generated from Swagger / Open API specification
+
+OpenAPI spec version: 0.1.0
+Contact: blah@cliffano.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.3.0-SNAPSHOT
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for SwaggyJenkinsClient::RemoteAccessApi
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'RemoteAccessApi' do
+  before do
+    # run before each test
+    @instance = SwaggyJenkinsClient::RemoteAccessApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of RemoteAccessApi' do
+    it 'should create an instance of RemoteAccessApi' do
+      expect(@instance).to be_instance_of(SwaggyJenkinsClient::RemoteAccessApi)
+    end
+  end
+
+  # unit tests for get_computer
+  # 
+  # Retrieve computer details
+  # @param depth Recursion depth in response model
+  # @param [Hash] opts the optional parameters
+  # @return [ComputerSet]
+  describe 'get_computer 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 get_crumb
+  # 
+  # Retrieve CSRF protection token
+  # @param [Hash] opts the optional parameters
+  # @return [DefaultCrumbIssuer]
+  describe 'get_crumb 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 get_jenkins
+  # 
+  # Retrieve Jenkins details
+  # @param [Hash] opts the optional parameters
+  # @return [Hudson]
+  describe 'get_jenkins 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 get_job
+  # 
+  # Retrieve job details
+  # @param name Name of the job
+  # @param [Hash] opts the optional parameters
+  # @return [FreeStyleProject]
+  describe 'get_job 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 get_job_config
+  # 
+  # Retrieve job configuration
+  # @param name Name of the job
+  # @param [Hash] opts the optional parameters
+  # @return [String]
+  describe 'get_job_config 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 get_job_last_build
+  # 
+  # Retrieve job's last build details
+  # @param name Name of the job
+  # @param [Hash] opts the optional parameters
+  # @return [FreeStyleBuild]
+  describe 'get_job_last_build 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 get_job_progressive_text
+  # 
+  # Retrieve job's build progressive text output
+  # @param name Name of the job
+  # @param number Build number
+  # @param start Starting point of progressive text output
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'get_job_progressive_text 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 get_queue
+  # 
+  # Retrieve queue details
+  # @param [Hash] opts the optional parameters
+  # @return [Queue]
+  describe 'get_queue 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 get_queue_item
+  # 
+  # Retrieve queued item details
+  # @param number Queue number
+  # @param [Hash] opts the optional parameters
+  # @return [Queue]
+  describe 'get_queue_item 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 get_view
+  # 
+  # Retrieve view details
+  # @param name Name of the view
+  # @param [Hash] opts the optional parameters
+  # @return [ListView]
+  describe 'get_view 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 get_view_config
+  # 
+  # Retrieve view configuration
+  # @param name Name of the view
+  # @param [Hash] opts the optional parameters
+  # @return [String]
+  describe 'get_view_config 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 head_jenkins
+  # 
+  # Retrieve Jenkins headers
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'head_jenkins 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 post_create_item
+  # 
+  # Create a new job using job configuration, or copied from an existing job
+  # @param name Name of the new job
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :from Existing job to copy from
+  # @option opts [String] :mode Set to 'copy' for copying an existing job
+  # @option opts [String] :body Job configuration in config.xml format
+  # @option opts [String] :jenkins_crumb CSRF protection token
+  # @option opts [String] :content_type Content type header application/xml
+  # @return [nil]
+  describe 'post_create_item 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 post_create_view
+  # 
+  # Create a new view using view configuration
+  # @param name Name of the new view
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :body View configuration in config.xml format
+  # @option opts [String] :jenkins_crumb CSRF protection token
+  # @option opts [String] :content_type Content type header application/xml
+  # @return [nil]
+  describe 'post_create_view 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 post_job_build
+  # 
+  # Build a job
+  # @param name Name of the job
+  # @param json 
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :token 
+  # @option opts [String] :jenkins_crumb CSRF protection token
+  # @return [nil]
+  describe 'post_job_build 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 post_job_config
+  # 
+  # Update job configuration
+  # @param name Name of the job
+  # @param body Job configuration in config.xml format
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :jenkins_crumb CSRF protection token
+  # @return [nil]
+  describe 'post_job_config 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 post_job_delete
+  # 
+  # Delete a job
+  # @param name Name of the job
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :jenkins_crumb CSRF protection token
+  # @return [nil]
+  describe 'post_job_delete 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 post_job_disable
+  # 
+  # Disable a job
+  # @param name Name of the job
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :jenkins_crumb CSRF protection token
+  # @return [nil]
+  describe 'post_job_disable 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 post_job_enable
+  # 
+  # Enable a job
+  # @param name Name of the job
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :jenkins_crumb CSRF protection token
+  # @return [nil]
+  describe 'post_job_enable 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 post_job_last_build_stop
+  # 
+  # Stop a job
+  # @param name Name of the job
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :jenkins_crumb CSRF protection token
+  # @return [nil]
+  describe 'post_job_last_build_stop 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 post_view_config
+  # 
+  # Update view configuration
+  # @param name Name of the view
+  # @param body View configuration in config.xml format
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :jenkins_crumb CSRF protection token
+  # @return [nil]
+  describe 'post_view_config 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
+#Swaggy Jenkins
+
+#Jenkins API clients generated from Swagger / Open API specification
+
+OpenAPI spec version: 0.1.0
+Contact: blah@cliffano.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.3.0-SNAPSHOT
+
+=end
+
+require 'spec_helper'
+
+describe SwaggyJenkinsClient::ApiClient do
+  context 'initialization' do
+    context 'URL stuff' do
+      context 'host' do
+        it 'removes http from host' do
+          SwaggyJenkinsClient.configure { |c| c.host = 'http://example.com' }
+          expect(SwaggyJenkinsClient::Configuration.default.host).to eq('example.com')
+        end
+
+        it 'removes https from host' do
+          SwaggyJenkinsClient.configure { |c| c.host = 'https://wookiee.com' }
+          expect(SwaggyJenkinsClient::ApiClient.default.config.host).to eq('wookiee.com')
+        end
+
+        it 'removes trailing path from host' do
+          SwaggyJenkinsClient.configure { |c| c.host = 'hobo.com/v4' }
+          expect(SwaggyJenkinsClient::Configuration.default.host).to eq('hobo.com')
+        end
+      end
+
+      context 'base_path' do
+        it "prepends a slash to base_path" do
+          SwaggyJenkinsClient.configure { |c| c.base_path = 'v4/dog' }
+          expect(SwaggyJenkinsClient::Configuration.default.base_path).to eq('/v4/dog')
+        end
+
+        it "doesn't prepend a slash if one is already there" do
+          SwaggyJenkinsClient.configure { |c| c.base_path = '/v4/dog' }
+          expect(SwaggyJenkinsClient::Configuration.default.base_path).to eq('/v4/dog')
+        end
+
+        it "ends up as a blank string if nil" do
+          SwaggyJenkinsClient.configure { |c| c.base_path = nil }
+          expect(SwaggyJenkinsClient::Configuration.default.base_path).to eq('')
+        end
+      end
+    end
+  end
+
+  describe "params_encoding in #build_request" do
+    let(:config) { SwaggyJenkinsClient::Configuration.new }
+    let(:api_client) { SwaggyJenkinsClient::ApiClient.new(config) }
+
+    it "defaults to nil" do
+      expect(SwaggyJenkinsClient::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) { SwaggyJenkinsClient::Configuration.new }
+    let(:api_client) { SwaggyJenkinsClient::ApiClient.new(config) }
+
+    it "defaults to 0" do
+      expect(SwaggyJenkinsClient::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 = SwaggyJenkinsClient::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 = SwaggyJenkinsClient::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 = SwaggyJenkinsClient::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 = SwaggyJenkinsClient::ApiClient.new
+      #_model = SwaggyJenkinsClient::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) { SwaggyJenkinsClient::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) { SwaggyJenkinsClient::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) { SwaggyJenkinsClient::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) { SwaggyJenkinsClient::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) { SwaggyJenkinsClient::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