quake_timesheets_client 0.1.0

data/ruby-templates/gem.mustache

@@ -0,0 +1,59 @@
+=begin
+{{> api_info}}
+=end
+
+# Pre-define base modules
+'{{moduleName}}'.split('::').reduce(Object) do |previous, mod|
+  if previous.const_defined?(mod.to_sym)
+    previous.const_get(mod.to_sym)
+  else
+    previous.const_set(mod.to_sym, Module.new)
+  end
+end
+
+# Common files
+require '{{gemName}}/api_client'
+require '{{gemName}}/api_error'
+require '{{gemName}}/version'
+require '{{gemName}}/configuration'
+
+# Models
+{{#models}}
+{{#model}}
+{{^parent}}
+require '{{gemName}}/{{modelPackage}}/{{classFilename}}'
+{{/parent}}
+{{/model}}
+{{/models}}
+{{#models}}
+{{#model}}
+{{#parent}}
+require '{{gemName}}/{{modelPackage}}/{{classFilename}}'
+{{/parent}}
+{{/model}}
+{{/models}}
+
+# APIs
+{{#apiInfo}}
+{{#apis}}
+require '{{importPath}}'
+{{/apis}}
+{{/apiInfo}}
+
+module {{moduleName}}
+  class << self
+    # Customize default settings for the SDK using block.
+    #   {{moduleName}}.configure do |config|
+    #     config.username = "xxx"
+    #     config.password = "xxx"
+    #   end
+    # If no block given, return the default Configuration object.
+    def configure
+      if block_given?
+        yield(Configuration.default)
+      else
+        Configuration.default
+      end
+    end
+  end
+end

data/ruby-templates/version.mustache

@@ -0,0 +1,16 @@
+=begin
+{{> api_info}}
+=end
+
+# Pre-define base modules
+'{{moduleName}}'.split('::').reduce(Object) do |previous, mod|
+  if previous.const_defined?(mod.to_sym)
+    previous.const_get(mod.to_sym)
+  else
+    previous.const_set(mod.to_sym, Module.new)
+  end
+end
+
+module {{moduleName}}
+  VERSION = '{{gemVersion}}'
+end

data/ruby.config.yaml

@@ -0,0 +1,10 @@
+---
+gemName: "quake_timesheets_client"
+gemHomepage: https://www.quake.co.uk
+gemSummary: A client for the Quake Timesheets API
+gemDescription: Requires the Quake Timesheets system
+gemLicense: MIT
+gemVersion: 0.1.0
+gemRequiredRubyVersion: ">= 2.7"
+library: faraday
+moduleName: Quake::Timesheets

data/spec/api/approval_types_api_spec.rb

@@ -0,0 +1,59 @@
+=begin
+#TimesheetsApi (params in:formData)
+
+# <p>Another API description</p> 
+
+The version of the OpenAPI document: 1.0
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.1.0
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for Quake::Timesheets::ApprovalTypesApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'ApprovalTypesApi' do
+  before do
+    # run before each test
+    @api_instance = Quake::Timesheets::ApprovalTypesApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of ApprovalTypesApi' do
+    it 'should create an instance of ApprovalTypesApi' do
+      expect(@api_instance).to be_instance_of(Quake::Timesheets::ApprovalTypesApi)
+    end
+  end
+
+  # unit tests for get_api_v1_approval_types
+  # Search for approval types matching filters
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :dataset_id Filter to the approval types belonging to one of the identified datasets
+  # @return [Array<ApprovalType>]
+  describe 'get_api_v1_approval_types 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_api_v1_approval_types
+  # Create a new Approval Type
+  # @param weight The weight provided by approvals of this type
+  # @param name The name of the approval type
+  # @param dataset_id ID of the dataset this approval type is linked to
+  # @param [Hash] opts the optional parameters
+  # @return [ApprovalType]
+  describe 'post_api_v1_approval_types 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/approvals_api_spec.rb

@@ -0,0 +1,60 @@
+=begin
+#TimesheetsApi (params in:formData)
+
+# <p>Another API description</p> 
+
+The version of the OpenAPI document: 1.0
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.1.0
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for Quake::Timesheets::ApprovalsApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'ApprovalsApi' do
+  before do
+    # run before each test
+    @api_instance = Quake::Timesheets::ApprovalsApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of ApprovalsApi' do
+    it 'should create an instance of ApprovalsApi' do
+      expect(@api_instance).to be_instance_of(Quake::Timesheets::ApprovalsApi)
+    end
+  end
+
+  # unit tests for get_api_v1_approvals
+  # Search for approval types matching filters
+  # @param dataset_id Filter to the approvals belonging to one of the identified datasets
+  # @param [Hash] opts the optional parameters
+  # @return [Array<Approval>]
+  describe 'get_api_v1_approvals 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_api_v1_approvals
+  # Create a new Approval
+  # @param state 
+  # @param approval_type_id The ID of the Approval Type of this Approval
+  # @param entry_id The ID of the Entry this Approval is linked to
+  # @param dataset_id ID of the dataset this approval type is linked to
+  # @param [Hash] opts the optional parameters
+  # @return [Approval]
+  describe 'post_api_v1_approvals 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/datasets_api_spec.rb

@@ -0,0 +1,67 @@
+=begin
+#TimesheetsApi (params in:formData)
+
+# <p>Another API description</p> 
+
+The version of the OpenAPI document: 1.0
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.1.0
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for Quake::Timesheets::DatasetsApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'DatasetsApi' do
+  before do
+    # run before each test
+    @api_instance = Quake::Timesheets::DatasetsApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of DatasetsApi' do
+    it 'should create an instance of DatasetsApi' do
+      expect(@api_instance).to be_instance_of(Quake::Timesheets::DatasetsApi)
+    end
+  end
+
+  # unit tests for get_api_v1_datasets
+  # List all available datasets
+  # @param [Hash] opts the optional parameters
+  # @return [Array<Dataset>]
+  describe 'get_api_v1_datasets 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_api_v1_datasets_id
+  # Show details about a specific dataset
+  # @param id ID of the dataset
+  # @param [Hash] opts the optional parameters
+  # @return [Dataset]
+  describe 'get_api_v1_datasets_id 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_api_v1_datasets
+  # Create a new Dataset record
+  # @param name Name for the Dataset object
+  # @param [Hash] opts the optional parameters
+  # @return [Dataset]
+  describe 'post_api_v1_datasets 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/entries_api_spec.rb

@@ -0,0 +1,82 @@
+=begin
+#TimesheetsApi (params in:formData)
+
+# <p>Another API description</p> 
+
+The version of the OpenAPI document: 1.0
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.1.0
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for Quake::Timesheets::EntriesApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'EntriesApi' do
+  before do
+    # run before each test
+    @api_instance = Quake::Timesheets::EntriesApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of EntriesApi' do
+    it 'should create an instance of EntriesApi' do
+      expect(@api_instance).to be_instance_of(Quake::Timesheets::EntriesApi)
+    end
+  end
+
+  # unit tests for get_api_v1_entries
+  # Search for entries matching filters
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :dataset_id Filter to the entries belonging to one of the identified datasets
+  # @option opts [String] :person_id Filter to the entries belonging to one of the identified people
+  # @option opts [String] :from_date Return only entries after this DateTime (inclusive)
+  # @option opts [String] :to_date Return only entries before this DateTime (inclusive)
+  # @return [Array<Entry>]
+  describe 'get_api_v1_entries 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_api_v1_entries
+  # Create a new Entry
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :person_id ID of the person to which this entry pertains
+  # @option opts [String] :start_at Time period at which this entry starts
+  # @option opts [String] :end_at Time period at which this entry ends
+  # @option opts [Float] :quantity 
+  # @option opts [String] :unit 
+  # @option opts [String] :external_reference Unique identifier of the activity this Entry relates to
+  # @return [Entry]
+  describe 'post_api_v1_entries 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_api_v1_entries_id
+  # Update an existing Entry
+  # @param id The ID for the Entry
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :person_id ID of the person to which this entry pertains
+  # @option opts [String] :start_at Time period at which this entry starts
+  # @option opts [String] :end_at Time period at which this entry ends
+  # @option opts [Float] :quantity 
+  # @option opts [String] :unit 
+  # @option opts [String] :external_reference Unique identifier of the activity this Entry relates to
+  # @return [Entry]
+  describe 'post_api_v1_entries_id 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/people_api_spec.rb

@@ -0,0 +1,58 @@
+=begin
+#TimesheetsApi (params in:formData)
+
+# <p>Another API description</p> 
+
+The version of the OpenAPI document: 1.0
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.1.0
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for Quake::Timesheets::PeopleApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'PeopleApi' do
+  before do
+    # run before each test
+    @api_instance = Quake::Timesheets::PeopleApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of PeopleApi' do
+    it 'should create an instance of PeopleApi' do
+      expect(@api_instance).to be_instance_of(Quake::Timesheets::PeopleApi)
+    end
+  end
+
+  # unit tests for get_api_v1_people
+  # Search for people matching filters
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :dataset_id Filter to the people belonging to one of the identified datasets
+  # @return [Array<Person>]
+  describe 'get_api_v1_people 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_api_v1_people
+  # Create a new Person record
+  # @param name Human readable name for the Person object (usually the subject&#39;s real name)
+  # @param dataset_id Dataset to which the Person object should belong
+  # @param [Hash] opts the optional parameters
+  # @return [Person]
+  describe 'post_api_v1_people 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,188 @@
+=begin
+#TimesheetsApi (params in:formData)
+
+# <p>Another API description</p> 
+
+The version of the OpenAPI document: 1.0
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.1.0
+
+=end
+
+require 'spec_helper'
+
+describe Quake::Timesheets::ApiClient do
+  context 'initialization' do
+    context 'URL stuff' do
+      context 'host' do
+        it 'removes http from host' do
+          Quake::Timesheets.configure { |c| c.host = 'http://example.com' }
+          expect(Quake::Timesheets::Configuration.default.host).to eq('example.com')
+        end
+
+        it 'removes https from host' do
+          Quake::Timesheets.configure { |c| c.host = 'https://wookiee.com' }
+          expect(Quake::Timesheets::ApiClient.default.config.host).to eq('wookiee.com')
+        end
+
+        it 'removes trailing path from host' do
+          Quake::Timesheets.configure { |c| c.host = 'hobo.com/v4' }
+          expect(Quake::Timesheets::Configuration.default.host).to eq('hobo.com')
+        end
+      end
+
+      context 'base_path' do
+        it "prepends a slash to base_path" do
+          Quake::Timesheets.configure { |c| c.base_path = 'v4/dog' }
+          expect(Quake::Timesheets::Configuration.default.base_path).to eq('/v4/dog')
+        end
+
+        it "doesn't prepend a slash if one is already there" do
+          Quake::Timesheets.configure { |c| c.base_path = '/v4/dog' }
+          expect(Quake::Timesheets::Configuration.default.base_path).to eq('/v4/dog')
+        end
+
+        it "ends up as a blank string if nil" do
+          Quake::Timesheets.configure { |c| c.base_path = nil }
+          expect(Quake::Timesheets::Configuration.default.base_path).to eq('')
+        end
+      end
+    end
+  end
+
+  describe '#deserialize' do
+    it "handles Array<Integer>" do
+      api_client = Quake::Timesheets::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 = Quake::Timesheets::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 = Quake::Timesheets::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 = Quake::Timesheets::ApiClient.new
+      # _model = Quake::Timesheets::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) { Quake::Timesheets::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 { api_client.build_collection_param(param, :INVALID) }.to raise_error(RuntimeError, 'unknown collection format: :INVALID')
+    end
+  end
+
+  describe '#json_mime?' do
+    let(:api_client) { Quake::Timesheets::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) { Quake::Timesheets::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) { Quake::Timesheets::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) { Quake::Timesheets::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