wheniwork-ruby 1.0.0

data/lib/wheniwork-ruby/version.rb

@@ -0,0 +1,24 @@
+=begin
+Wheniwork
+
+OpenAPI spec version: v2
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+=end
+
+module WhenIWork
+  VERSION = "1.0.0"
+end

data/spec/api/api_spec.rb

@@ -0,0 +1,99 @@
+=begin
+Wheniwork
+
+OpenAPI spec version: v2
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for WhenIWork::Api
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'Api' do
+  before do
+    # run before each test
+    @instance = WhenIWork::Api.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of Api' do
+    it 'should create an instact of Api' do
+      expect(@instance).to be_instance_of(WhenIWork::Api)
+    end
+  end
+
+  # unit tests for get_positions
+  #
+  # This method allows you to get a list of all positions in your account.
+  # @param [Hash] opts the optional parameters
+  # @option opts [BOOLEAN] :show_deleted Whether to show positions that have been deleted.
+  # @return [InlineResponse200]
+  describe 'get_positions 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_shift
+  #
+  # Gets the details of an existing shift.
+  # @param shift_id max records to return
+  # @param [Hash] opts the optional parameters
+  # @return [InlineResponse2002]
+  describe 'get_shift 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_shifts
+  #
+  # Get a list of shifts.
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :user_id The ID of the user to get shifts for. For multiple users, enter a list of user IDs separated by commas (e.g. 1,5,3).
+  # @option opts [DateTime] :start Start time for the search window. The default is the current date and time
+  # @option opts [DateTime] :_end End time for the search window. The default is exactly three days from the start time.
+  # @option opts [String] :location_id The ID of the location to get shifts for. For multiple locations, enter a list of location IDs separated by commas.
+  # @option opts [String] :position_id The ID of the position to get shifts for. For multiple position, enter a list of position IDs separated by commas.
+  # @option opts [BOOLEAN] :include_open Whether to include OpenShifts in the results.
+  # @option opts [BOOLEAN] :include_onlyopen Whether to include OpenShifts in the results.
+  # @option opts [BOOLEAN] :unpublished Whether unpublished shifts should be included in the results.
+  # @return [InlineResponse2001]
+  describe 'get_shifts 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_user
+  #
+  # Get a specific user by their ID.
+  # @param user_id The user identifier number
+  # @param [Hash] opts the optional parameters
+  # @return [InlineResponse2003]
+  describe 'get_user 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,260 @@
+=begin
+Wheniwork
+
+OpenAPI spec version: v2
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+=end
+
+require 'spec_helper'
+
+describe WhenIWork::ApiClient do
+  context 'initialization' do
+    context 'URL stuff' do
+      context 'host' do
+        it 'removes http from host' do
+          WhenIWork.configure { |c| c.host = 'http://example.com' }
+          expect(WhenIWork::Configuration.default.host).to eq('example.com')
+        end
+
+        it 'removes https from host' do
+          WhenIWork.configure { |c| c.host = 'https://wookiee.com' }
+          expect(WhenIWork::ApiClient.default.config.host).to eq('wookiee.com')
+        end
+
+        it 'removes trailing path from host' do
+          WhenIWork.configure { |c| c.host = 'hobo.com/v4' }
+          expect(WhenIWork::Configuration.default.host).to eq('hobo.com')
+        end
+      end
+
+      context 'base_path' do
+        it "prepends a slash to base_path" do
+          WhenIWork.configure { |c| c.base_path = 'v4/dog' }
+          expect(WhenIWork::Configuration.default.base_path).to eq('/v4/dog')
+        end
+
+        it "doesn't prepend a slash if one is already there" do
+          WhenIWork.configure { |c| c.base_path = '/v4/dog' }
+          expect(WhenIWork::Configuration.default.base_path).to eq('/v4/dog')
+        end
+
+        it "ends up as a blank string if nil" do
+          WhenIWork.configure { |c| c.base_path = nil }
+          expect(WhenIWork::Configuration.default.base_path).to eq('')
+        end
+      end
+    end
+  end
+
+  describe "#update_params_for_auth!" do
+    it "sets header api-key parameter without prefix" do
+      WhenIWork.configure do |c|
+        c.api_key['W-Token'] = 'special-key'
+      end
+
+      api_client = WhenIWork::ApiClient.new
+
+      header_params = {}
+      query_params = {}
+      auth_names = ['api_key', 'unknown']
+      api_client.update_params_for_auth! header_params, query_params, auth_names
+      expect(api_client.config.api_key).to eq({'W-Token' => 'special-key'})
+    end
+  end
+
+  describe "timeout in #build_request" do
+    let(:config) { WhenIWork::Configuration.new }
+    let(:api_client) { WhenIWork::ApiClient.new(config) }
+
+    it "defaults to 0" do
+      expect(WhenIWork::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 = WhenIWork::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 = WhenIWork::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 = WhenIWork::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
+
+    it "handles Hash<String, Shift>" do
+      api_client = WhenIWork::ApiClient.new
+      headers = {'Content-Type' => 'application/json'}
+      response = double('response', headers: headers, body: '{"shift": {"id": 1}}')
+      data = api_client.deserialize(response, 'Hash<String, Shift>')
+      expect(data).to be_instance_of(Hash)
+      expect(data.keys).to eq([:shift])
+
+      shift = data[:shift]
+      expect(shift).to be_instance_of(WhenIWork::Shift)
+      expect(shift.id).to eq(1)
+    end
+
+    it "handles Hash<String, Hash<String, Shift>>" do
+      api_client = WhenIWork::ApiClient.new
+      headers = {'Content-Type' => 'application/json'}
+      response = double('response', headers: headers, body: '{"data": {"shift": {"id": 1}}}')
+      result = api_client.deserialize(response, 'Hash<String, Hash<String, Shift>>')
+      expect(result).to be_instance_of(Hash)
+      expect(result.keys).to match_array([:data])
+
+      data = result[:data]
+      expect(data).to be_instance_of(Hash)
+      expect(data.keys).to match_array([:shift])
+
+      pet = data[:shift]
+      expect(pet).to be_instance_of(WhenIWork::Shift)
+      expect(pet.id).to eq(1)
+    end
+  end
+
+  describe "#object_to_hash" do
+    it "ignores nils and includes empty arrays" do
+      api_client = WhenIWork::ApiClient.new
+      shift = WhenIWork::Shift.new
+      shift.id = 1
+      shift.notes = nil
+      expected = { id: 1 }
+      expect(api_client.object_to_hash(shift)).to eq(expected)
+    end
+  end
+
+  describe "#build_collection_param" do
+    let(:param) { ['aa', 'bb', 'cc'] }
+    let(:api_client) { WhenIWork::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) { WhenIWork::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) { WhenIWork::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) { WhenIWork::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) { WhenIWork::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/configuration_spec.rb

@@ -0,0 +1,46 @@
+=begin
+Wheniwork
+
+OpenAPI spec version: v2
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+=end
+
+require 'spec_helper'
+
+describe WhenIWork::Configuration do
+  let(:config) { WhenIWork::Configuration.default }
+
+  before(:each) do
+    WhenIWork.configure do |c|
+      c.host = 'petstore.swagger.io'
+      c.base_path = 'v2'
+    end
+  end
+
+  describe '#base_url' do
+    it 'should have the default value' do
+      expect(config.base_url).to eq('https://petstore.swagger.io/v2')
+    end
+
+    it 'should remove trailing slashes' do
+      [nil, '', '/', '//'].each do |base_path|
+        config.base_path = base_path
+        expect(config.base_url).to eq('https://petstore.swagger.io')
+      end
+    end
+  end
+end

data/spec/models/inline_response_200_1_spec.rb

@@ -0,0 +1,63 @@
+=begin
+Wheniwork
+
+OpenAPI spec version: v2
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+=end
+
+require 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for WhenIWork::InlineResponse2001
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'InlineResponse2001' do
+  before do
+    # run before each test
+    @instance = WhenIWork::InlineResponse2001.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of InlineResponse2001' do
+    it 'should create an instact of InlineResponse2001' do
+      expect(@instance).to be_instance_of(WhenIWork::InlineResponse2001)
+    end
+  end
+  describe 'test attribute "start"' do
+    it 'should work' do
+       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "_end"' do
+    it 'should work' do
+       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "shifts"' do
+    it 'should work' do
+       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end
+