shortcut_client_ruby 0.0.2

data/spec/api_client_spec.rb

@@ -0,0 +1,225 @@
+=begin
+#Shortcut API
+
+#Shortcut API
+
+OpenAPI spec version: 3.0
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 3.0.35
+=end
+
+require 'spec_helper'
+
+describe Shortcut::ApiClient do
+  context 'initialization' do
+    context 'URL stuff' do
+      context 'host' do
+        it 'removes http from host' do
+          Shortcut.configure { |c| c.host = 'http://example.com' }
+          expect(Shortcut::Configuration.default.host).to eq('example.com')
+        end
+
+        it 'removes https from host' do
+          Shortcut.configure { |c| c.host = 'https://wookiee.com' }
+          expect(Shortcut::ApiClient.default.config.host).to eq('wookiee.com')
+        end
+
+        it 'removes trailing path from host' do
+          Shortcut.configure { |c| c.host = 'hobo.com/v4' }
+          expect(Shortcut::Configuration.default.host).to eq('hobo.com')
+        end
+      end
+
+      context 'base_path' do
+        it "prepends a slash to base_path" do
+          Shortcut.configure { |c| c.base_path = 'v4/dog' }
+          expect(Shortcut::Configuration.default.base_path).to eq('/v4/dog')
+        end
+
+        it "doesn't prepend a slash if one is already there" do
+          Shortcut.configure { |c| c.base_path = '/v4/dog' }
+          expect(Shortcut::Configuration.default.base_path).to eq('/v4/dog')
+        end
+
+        it "ends up as a blank string if nil" do
+          Shortcut.configure { |c| c.base_path = nil }
+          expect(Shortcut::Configuration.default.base_path).to eq('')
+        end
+      end
+    end
+  end
+
+  describe 'params_encoding in #build_request' do
+    let(:config) { Shortcut::Configuration.new }
+    let(:api_client) { Shortcut::ApiClient.new(config) }
+
+    it 'defaults to nil' do
+      expect(Shortcut::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) { Shortcut::Configuration.new }
+    let(:api_client) { Shortcut::ApiClient.new(config) }
+
+    it 'defaults to 0' do
+      expect(Shortcut::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 = Shortcut::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 = Shortcut::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 = Shortcut::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 = Shortcut::ApiClient.new
+      # _model = Shortcut::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) { Shortcut::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) { Shortcut::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) { Shortcut::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) { Shortcut::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) { Shortcut::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

data/spec/base_object_spec.rb

@@ -0,0 +1,109 @@
+require 'spec_helper'
+
+class ArrayMapObject < Petstore::Category
+  attr_accessor :int_arr, :pet_arr, :int_map, :pet_map, :int_arr_map, :pet_arr_map, :boolean_true_arr, :boolean_false_arr
+
+  def self.attribute_map
+    {
+      :int_arr => :int_arr,
+      :pet_arr => :pet_arr,
+      :int_map => :int_map,
+      :pet_map => :pet_map,
+      :int_arr_map => :int_arr_map,
+      :pet_arr_map => :pet_arr_map,
+      :boolean_true_arr  => :boolean_true_arr,
+      :boolean_false_arr => :boolean_false_arr,
+    }
+  end
+
+  def self.swagger_types
+    {
+      :int_arr => :'Array<Integer>',
+      :pet_arr => :'Array<Pet>',
+      :int_map => :'Hash<String, Integer>',
+      :pet_map => :'Hash<String, Pet>',
+      :int_arr_map => :'Hash<String, Array<Integer>>',
+      :pet_arr_map => :'Hash<String, Array<Pet>>',
+      :boolean_true_arr  => :'Array<BOOLEAN>',
+      :boolean_false_arr => :'Array<BOOLEAN>',
+    }
+  end
+end
+
+describe 'BaseObject' do
+  describe 'boolean values' do
+    let(:obj) { Petstore::Cat.new({declawed: false}) }
+
+    it 'should have values set' do
+      expect(obj.declawed).not_to be_nil
+      expect(obj.declawed).to eq(false)
+    end
+  end
+
+  describe 'array and map properties' do
+    let(:obj) { ArrayMapObject.new }
+
+    let(:data) do
+      {int_arr: [123, 456],
+       pet_arr: [{name: 'Kitty'}],
+       int_map: {'int' => 123},
+       pet_map: {'pet' => {name: 'Kitty'}},
+       int_arr_map: {'int_arr' => [123, 456]},
+       pet_arr_map: {'pet_arr' => [{name: 'Kitty'}]},
+       boolean_true_arr:  [true, "true", "TruE", 1, "y", "yes", "1", "t", "T"],
+       boolean_false_arr: [false, "", 0, "0", "f", nil, "null"],
+      }
+    end
+
+    it 'works for #build_from_hash' do
+      obj.build_from_hash(data)
+
+      expect(obj.int_arr).to match_array([123, 456])
+
+      expect(obj.pet_arr).to be_instance_of(Array)
+      expect(obj.pet_arr).to be_instance_of(1)
+
+      pet = obj.pet_arr.first
+      expect(pet).to be_instance_of(Petstore::Pet)
+      expect(pet.name).to eq('Kitty')
+
+      expect(obj.int_map).to be_instance_of(Hash)
+      expect(obj.int_map).to eq({'int' => 123})
+
+      expect(obj.pet_map).to be_instance_of(Hash)
+      pet = obj.pet_map['pet']
+      expect(pet).to be_instance_of(Petstore::Pet)
+      expect(pet.name).to eq('Kitty')
+
+      expect(obj.int_arr_map).to be_instance_of(Hash)
+      arr = obj.int_arr_map['int_arr']
+      expect(arr).to match_array([123, 456])
+
+      expect(obj.pet_arr_map).to be_instance_of(Hash)
+      arr = obj.pet_arr_map['pet_arr']
+      expect(arr).to be_instance_of(Array)
+      expect(arr.size).to eq(1)
+      pet = arr.first
+      expect(pet).to be_instance_of(Petstore::Pet)
+      expect(pet.name).to eq('Kitty')
+
+      expect(obj.boolean_true_arr).to be_instance_of(Array)
+      obj.boolean_true_arr.each do |b|
+        expect(b).to eq(true)
+      end
+
+      expect(obj.boolean_false_arr).to be_instance_of(Array)
+      obj.boolean_false_arr.each do |b|
+        expect(b).to eq(false)
+      end
+    end
+
+    it 'works for #to_hash' do
+      obj.build_from_hash(data)
+      expect_data = data.dup
+      expect_data[:boolean_true_arr].map! {true}
+      expect_data[:boolean_false_arr].map! {false}
+      expect(obj.to_hash).to eq(expect_data)
+    end
+  end
+end

data/spec/configuration_spec.rb

@@ -0,0 +1,41 @@
+=begin
+#Shortcut API
+
+#Shortcut API
+
+OpenAPI spec version: 3.0
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 3.0.35
+=end
+
+require 'spec_helper'
+
+describe Shortcut::Configuration do
+  let(:config) { Shortcut::Configuration.default }
+
+  before(:each) do
+    # uncomment below to setup host and base_path
+    # require 'URI'
+    # uri = URI.parse("https://api.app.shortcut.com/")
+    # Shortcut.configure do |c|
+    #   c.host = uri.host
+    #   c.base_path = uri.path
+    # end
+  end
+
+  describe '#base_url' do
+    it 'should have the default value' do
+      # uncomment below to test default value of the base path
+      # expect(config.base_url).to eq("https://api.app.shortcut.com/")
+    end
+
+    it 'should remove trailing slashes' do
+      [nil, '', '/', '//'].each do |base_path|
+        config.base_path = base_path
+        # uncomment below to test trailing slashes
+        # expect(config.base_url).to eq("https://api.app.shortcut.com/")
+      end
+    end
+  end
+end

data/spec/models/basic_workspace_info_spec.rb

@@ -0,0 +1,46 @@
+=begin
+#Shortcut API
+
+#Shortcut API
+
+OpenAPI spec version: 3.0
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 3.0.35
+=end
+
+require 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for Shortcut::BasicWorkspaceInfo
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'BasicWorkspaceInfo' do
+  before do
+    # run before each test
+    @instance = Shortcut::BasicWorkspaceInfo.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of BasicWorkspaceInfo' do
+    it 'should create an instance of BasicWorkspaceInfo' do
+      expect(@instance).to be_instance_of(Shortcut::BasicWorkspaceInfo)
+    end
+  end
+  describe 'test attribute "url_slug"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "estimate_scale"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/models/branch_spec.rb

@@ -0,0 +1,100 @@
+=begin
+#Shortcut API
+
+#Shortcut API
+
+OpenAPI spec version: 3.0
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 3.0.35
+=end
+
+require 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for Shortcut::Branch
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'Branch' do
+  before do
+    # run before each test
+    @instance = Shortcut::Branch.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of Branch' do
+    it 'should create an instance of Branch' do
+      expect(@instance).to be_instance_of(Shortcut::Branch)
+    end
+  end
+  describe 'test attribute "entity_type"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "deleted"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "name"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "persistent"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "updated_at"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "pull_requests"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "merged_branch_ids"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "id"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "url"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "repository_id"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "created_at"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/models/category_spec.rb

@@ -0,0 +1,88 @@
+=begin
+#Shortcut API
+
+#Shortcut API
+
+OpenAPI spec version: 3.0
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 3.0.35
+=end
+
+require 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for Shortcut::Category
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'Category' do
+  before do
+    # run before each test
+    @instance = Shortcut::Category.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of Category' do
+    it 'should create an instance of Category' do
+      expect(@instance).to be_instance_of(Shortcut::Category)
+    end
+  end
+  describe 'test attribute "archived"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "entity_type"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "color"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "name"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "type"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "updated_at"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "external_id"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "id"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "created_at"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end