wheniwork-ruby 1.0.0 → 1.1.0

data/lib/wheniwork-ruby/models/user.rb

@@ -22,26 +22,18 @@ limitations under the License.
 require 'date'
 
 module WhenIWork
-
   class User
-    attr_accessor :id
+    include WhenIWork::Response
 
+    attr_accessor :id
     attr_accessor :account_id
-
     attr_accessor :role
-
     attr_accessor :email
-
     attr_accessor :first_name
-
     attr_accessor :last_name
-
     attr_accessor :phone_number
-
     attr_accessor :employee_code
-
     attr_accessor :positions
-
     attr_accessor :locations
 
     # Attribute mapping from ruby-style variable name to JSON key.
@@ -159,122 +151,10 @@ module WhenIWork
           locations == o.locations
     end
 
-    # @see the `==` method
-    # @param [Object] Object to be compared
-    def eql?(o)
-      self == o
-    end
-
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
       [id, account_id, role, email, first_name, last_name, phone_number, employee_code, positions, locations].hash
     end
-
-    # Builds the object from hash
-    # @param [Hash] attributes Model attributes in the form of hash
-    # @return [Object] Returns the model itself
-    def build_from_hash(attributes)
-      return nil unless attributes.is_a?(Hash)
-      self.class.swagger_types.each_pair do |key, type|
-        if type =~ /^Array<(.*)>/i
-          # check to ensure the input is an array given that the the attribute
-          # is documented as an array but the input is not
-          if attributes[self.class.attribute_map[key]].is_a?(Array)
-            self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
-          end
-        elsif !attributes[self.class.attribute_map[key]].nil?
-          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
-        end # or else data not found in attributes(hash), not an issue as the data can be optional
-      end
-
-      self
-    end
-
-    # Deserializes the data based on type
-    # @param string type Data type
-    # @param string value Value to be deserialized
-    # @return [Object] Deserialized data
-    def _deserialize(type, value)
-      case type.to_sym
-      when :DateTime
-        DateTime.parse(value)
-      when :Date
-        Date.parse(value)
-      when :String
-        value.to_s
-      when :Integer
-        value.to_i
-      when :Float
-        value.to_f
-      when :BOOLEAN
-        if value.to_s =~ /^(true|t|yes|y|1)$/i
-          true
-        else
-          false
-        end
-      when :Object
-        # generic object (usually a Hash), return directly
-        value
-      when /\AArray<(?<inner_type>.+)>\z/
-        inner_type = Regexp.last_match[:inner_type]
-        value.map { |v| _deserialize(inner_type, v) }
-      when /\AHash<(?<k_type>.+), (?<v_type>.+)>\z/
-        k_type = Regexp.last_match[:k_type]
-        v_type = Regexp.last_match[:v_type]
-        {}.tap do |hash|
-          value.each do |k, v|
-            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
-          end
-        end
-      else # model
-        temp_model = WhenIWork.const_get(type).new
-        temp_model.build_from_hash(value)
-      end
-    end
-
-    # Returns the string representation of the object
-    # @return [String] String presentation of the object
-    def to_s
-      to_hash.to_s
-    end
-
-    # to_body is an alias to to_hash (backward compatibility)
-    # @return [Hash] Returns the object in the form of hash
-    def to_body
-      to_hash
-    end
-
-    # Returns the object in the form of hash
-    # @return [Hash] Returns the object in the form of hash
-    def to_hash
-      hash = {}
-      self.class.attribute_map.each_pair do |attr, param|
-        value = self.send(attr)
-        next if value.nil?
-        hash[param] = _to_hash(value)
-      end
-      hash
-    end
-
-    # Outputs non-array value in the form of hash
-    # For object, use to_hash. Otherwise, just return the value
-    # @param [Object] value Any valid value
-    # @return [Hash] Returns the value in the form of hash
-    def _to_hash(value)
-      if value.is_a?(Array)
-        value.compact.map{ |v| _to_hash(v) }
-      elsif value.is_a?(Hash)
-        {}.tap do |hash|
-          value.each { |k, v| hash[k] = _to_hash(v) }
-        end
-      elsif value.respond_to? :to_hash
-        value.to_hash
-      else
-        value
-      end
-    end
-
   end
-
 end

data/lib/wheniwork-ruby/modules/response.rb

@@ -0,0 +1,117 @@
+module WhenIWork
+  module Response
+    attr_accessor :raw_data
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.raw_data = attributes
+
+      self.class.swagger_types.each_pair do |key, type|
+        if type =~ /^Array<(.*)>/i
+          # check to ensure the input is an array given that the the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(other)
+      self == other
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = send(attr)
+        next if value.nil?
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :BOOLEAN
+        if value.to_s =~ /^(true|t|yes|y|1)$/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        temp_model = WhenIWork.const_get(type).new
+        temp_model.build_from_hash(value)
+      end
+    end
+  end
+end

data/lib/wheniwork-ruby/version.rb

@@ -20,5 +20,5 @@ limitations under the License.
 =end
 
 module WhenIWork
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

data/spec/models/inline_response_200_4_spec.rb

@@ -0,0 +1,51 @@
+=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::InlineResponse2004
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'InlineResponse2004' do
+  before do
+    # run before each test
+    @instance = WhenIWork::InlineResponse2004.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of InlineResponse2004' do
+    it 'should create an instact of InlineResponse2004' do
+      expect(@instance).to be_instance_of(WhenIWork::InlineResponse2004)
+    end
+  end
+  describe 'test attribute "user"' do
+    it 'should work' do
+       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wheniwork-ruby
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Swagger-Codegen
@@ -201,11 +201,11 @@ files:
 - Gemfile.lock
 - LICENSE
 - README.md
-- docs/DefaultApi.md
 - docs/InlineResponse200.md
 - docs/InlineResponse2001.md
 - docs/InlineResponse2002.md
 - docs/InlineResponse2003.md
+- docs/InlineResponse2004.md
 - docs/Position.md
 - docs/Shift.md
 - docs/User.md
@@ -219,9 +219,11 @@ files:
 - lib/wheniwork-ruby/models/inline_response_200_1.rb
 - lib/wheniwork-ruby/models/inline_response_200_2.rb
 - lib/wheniwork-ruby/models/inline_response_200_3.rb
+- lib/wheniwork-ruby/models/inline_response_200_4.rb
 - lib/wheniwork-ruby/models/position.rb
 - lib/wheniwork-ruby/models/shift.rb
 - lib/wheniwork-ruby/models/user.rb
+- lib/wheniwork-ruby/modules/response.rb
 - lib/wheniwork-ruby/version.rb
 - spec/api/api_spec.rb
 - spec/api_client_spec.rb
@@ -229,6 +231,7 @@ files:
 - spec/models/inline_response_200_1_spec.rb
 - spec/models/inline_response_200_2_spec.rb
 - spec/models/inline_response_200_3_spec.rb
+- spec/models/inline_response_200_4_spec.rb
 - spec/models/inline_response_200_spec.rb
 - spec/models/position_spec.rb
 - spec/models/shift_spec.rb
@@ -266,6 +269,7 @@ test_files:
 - spec/models/inline_response_200_1_spec.rb
 - spec/models/inline_response_200_2_spec.rb
 - spec/models/inline_response_200_3_spec.rb
+- spec/models/inline_response_200_4_spec.rb
 - spec/models/inline_response_200_spec.rb
 - spec/models/position_spec.rb
 - spec/models/shift_spec.rb

data/docs/DefaultApi.md

@@ -1,240 +0,0 @@
-# WhenIWork::Api
-
-All URIs are relative to *https://api.wheniwork.com/2*
-
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**get_positions**](Api.md#get_positions) | **GET** /positions |
-[**get_shift**](Api.md#get_shift) | **GET** /shifts/{shift-id} |
-[**get_shifts**](Api.md#get_shifts) | **GET** /shifts |
-[**get_user**](Api.md#get_user) | **GET** /users/{user-id} |
-
-
-# **get_positions**
-> InlineResponse200 get_positions(opts)
-
-
-
-This method allows you to get a list of all positions in your account.
-
-### Example
-```ruby
-# load the gem
-require 'wheniwork-ruby'
-# setup authorization
-WhenIWork.configure do |config|
-  # Configure API key authorization: apiKey
-  config.api_key['W-Token'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  #config.api_key_prefix['W-Token'] = 'Bearer'
-end
-
-api_instance = WhenIWork::Api.new
-
-opts = {
-  show_deleted: true # BOOLEAN | Whether to show positions that have been deleted.
-}
-
-begin
-  result = api_instance.get_positions(opts)
-  p result
-rescue WhenIWork::ApiError => e
-  puts "Exception when calling Api->get_positions: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **show_deleted** | **BOOLEAN**| Whether to show positions that have been deleted. | [optional]
-
-### Return type
-
-[**InlineResponse200**](InlineResponse200.md)
-
-### Authorization
-
-[apiKey](../README.md#apiKey)
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-
-# **get_shift**
-> InlineResponse2002 get_shift(shift_id)
-
-
-
-Gets the details of an existing shift.
-
-### Example
-```ruby
-# load the gem
-require 'wheniwork-ruby'
-# setup authorization
-WhenIWork.configure do |config|
-  # Configure API key authorization: apiKey
-  config.api_key['W-Token'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  #config.api_key_prefix['W-Token'] = 'Bearer'
-end
-
-api_instance = WhenIWork::Api.new
-
-shift_id = 56 # Integer | max records to return
-
-
-begin
-  result = api_instance.get_shift(shift_id)
-  p result
-rescue WhenIWork::ApiError => e
-  puts "Exception when calling Api->get_shift: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **shift_id** | **Integer**| max records to return |
-
-### Return type
-
-[**InlineResponse2002**](InlineResponse2002.md)
-
-### Authorization
-
-[apiKey](../README.md#apiKey)
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-
-# **get_shifts**
-> InlineResponse2001 get_shifts(opts)
-
-
-
-Get a list of shifts.
-
-### Example
-```ruby
-# load the gem
-require 'wheniwork-ruby'
-# setup authorization
-WhenIWork.configure do |config|
-  # Configure API key authorization: apiKey
-  config.api_key['W-Token'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  #config.api_key_prefix['W-Token'] = 'Bearer'
-end
-
-api_instance = WhenIWork::Api.new
-
-opts = {
-  user_id: "user_id_example", # String | 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).
-  start: DateTime.parse("2013-10-20T19:20:30+01:00"), # DateTime | Start time for the search window. The default is the current date and time
-  _end: DateTime.parse("2013-10-20T19:20:30+01:00"), # DateTime | End time for the search window. The default is exactly three days from the start time.
-  location_id: "location_id_example", # String | The ID of the location to get shifts for. For multiple locations, enter a list of location IDs separated by commas.
-  position_id: "position_id_example", # String | The ID of the position to get shifts for. For multiple position, enter a list of position IDs separated by commas.
-  include_open: true, # BOOLEAN | Whether to include OpenShifts in the results.
-  include_onlyopen: true, # BOOLEAN | Whether to include OpenShifts in the results.
-  unpublished: true # BOOLEAN | Whether unpublished shifts should be included in the results.
-}
-
-begin
-  result = api_instance.get_shifts(opts)
-  p result
-rescue WhenIWork::ApiError => e
-  puts "Exception when calling Api->get_shifts: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **user_id** | **String**| 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). | [optional]
- **start** | **DateTime**| Start time for the search window. The default is the current date and time | [optional]
- **_end** | **DateTime**| End time for the search window. The default is exactly three days from the start time. | [optional]
- **location_id** | **String**| The ID of the location to get shifts for. For multiple locations, enter a list of location IDs separated by commas. | [optional]
- **position_id** | **String**| The ID of the position to get shifts for. For multiple position, enter a list of position IDs separated by commas. | [optional]
- **include_open** | **BOOLEAN**| Whether to include OpenShifts in the results. | [optional]
- **include_onlyopen** | **BOOLEAN**| Whether to include OpenShifts in the results. | [optional]
- **unpublished** | **BOOLEAN**| Whether unpublished shifts should be included in the results. | [optional]
-
-### Return type
-
-[**InlineResponse2001**](InlineResponse2001.md)
-
-### Authorization
-
-[apiKey](../README.md#apiKey)
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-
-# **get_user**
-> InlineResponse2003 get_user(user_id)
-
-
-
-Get a specific user by their ID.
-
-### Example
-```ruby
-# load the gem
-require 'wheniwork-ruby'
-# setup authorization
-WhenIWork.configure do |config|
-  # Configure API key authorization: apiKey
-  config.api_key['W-Token'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  #config.api_key_prefix['W-Token'] = 'Bearer'
-end
-
-api_instance = WhenIWork::Api.new
-
-user_id = 56 # Integer | The user identifier number
-
-
-begin
-  result = api_instance.get_user(user_id)
-  p result
-rescue WhenIWork::ApiError => e
-  puts "Exception when calling Api->get_user: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **user_id** | **Integer**| The user identifier number |
-
-### Return type
-
-[**InlineResponse2003**](InlineResponse2003.md)
-
-### Authorization
-
-[apiKey](../README.md#apiKey)
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-