quake_timesheets_client 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 119ee596e8cc8a04f1d9bd725708df328f45e6a132e0ff12f763ddf61cd0ffc5
+  data.tar.gz: d7626dc544854a7c36266d2b63366a2417beb69cd685fe742c8f5ba26c6c5335
+SHA512:
+  metadata.gz: 22b2e259dc75dac178cdf18f7c914798d5c5b4a7437733f2f73db40923ec3534fa0070cdb6005643c669cfab0a6ae2364dc28d7dc733fe8935e58345c8e865d2
+  data.tar.gz: a66d08915cb9e5e6908caea7db6ff4565af70031211d650f48df14497c41f712bbac6de9f17c22e7d406fdcc258dd814ae102076d3c1df4cca10007cdc93d675

data/GENERATING_README.md

@@ -0,0 +1,17 @@
+Timesheets client generator
+---
+
+Generation of the Timesheets client depends on the openapi-generator tools. see https://openapi-generator.tech/
+
+To generate a client, install the openapi-generator tools.
+
+```
+brew install openapi-generator
+```
+
+Once this has been done, you can generate the ruby gem source using the below command:
+
+```
+openapi-generator generate -i '<SOURCE>/apidocs/1.0.json?type=swagger' -g ruby -c ruby.config.yaml --minimal-update --template-dir ruby-templates/
+```
+

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'rake', '~> 13.0.1'
+  gem 'pry-byebug'
+  gem 'rubocop', '~> 0.66.0'
+end

data/README.md

@@ -0,0 +1,161 @@
+# quake_timesheets_client
+
+Quake::Timesheets - the Ruby gem for the TimesheetsApi (params in:formData)
+
+
+<p>Another API description</p>
+
+
+This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
+
+- API version: 1.0
+- Package version: 0.1.0
+- Build package: org.openapitools.codegen.languages.RubyClientCodegen
+
+## Generating
+
+To re-generate the source for this gem, use the command:
+```shell
+./build.sh
+```
+
+To generate from a local timesheets installation (e.g. during development) use:
+```shell
+./build.sh local
+```
+
+## Installation
+
+### Build a gem
+
+To build the Ruby code into a gem:
+
+```shell
+gem build quake_timesheets_client.gemspec
+```
+
+Then either install the gem locally:
+
+```shell
+gem install ./quake_timesheets_client-0.1.0.gem
+```
+
+(for development, run `gem install --dev ./quake_timesheets_client-0.1.0.gem` to install the development dependencies)
+
+or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
+
+Finally add this to the Gemfile:
+
+    gem 'quake_timesheets_client', '~> 0.1.0'
+
+### Install from Git
+
+If the Ruby gem is hosted at a git repository: https://github.com/quake-saas/timesheets-client-ruby, then add the following in the Gemfile:
+
+    gem 'quake_timesheets_client', :git => 'https://github.com/quake-saas/timesheets-client-ruby.git'
+
+### Include the Ruby code directly
+
+Include the Ruby code directly using `-I` as follows:
+
+```shell
+ruby -Ilib script.rb
+```
+
+## Getting Started
+
+Please follow the [installation](#installation) procedure and then run the following code:
+
+```ruby
+# Load the gem
+require 'quake_timesheets_client'
+
+# Setup authorization
+Quake::Timesheets.configure do |config|
+  # Configure API key authorization: authToken
+  config.api_key['authToken'] = 'YOUR API KEY'
+end
+
+# Optionally, for local development, you can override the endpoint being used with the below:
+Quake::Timesheets.configure do |config|
+  config.endpoint = 'http://localhost:3000'
+end
+
+api_instance = Quake::Timesheets::ApprovalTypesApi.new
+opts = {
+  dataset_id: 'dataset_id_example' # String | Filter to the approval types belonging to one of the identified datasets
+}
+
+begin
+  #Search for approval types matching filters
+  result = api_instance.get_api_v1_approval_types(opts)
+  p result
+rescue Quake::Timesheets::ApiError => e
+  puts "Exception when calling ApprovalTypesApi->get_api_v1_approval_types: #{e}"
+end
+
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *https://timesheetsapi.svc.lumbry.co.uk:443*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*Quake::Timesheets::ApprovalTypesApi* | [**get_api_v1_approval_types**](docs/ApprovalTypesApi.md#get_api_v1_approval_types) | **GET** /api/v1/approval_types | Search for approval types matching filters
+*Quake::Timesheets::ApprovalTypesApi* | [**post_api_v1_approval_types**](docs/ApprovalTypesApi.md#post_api_v1_approval_types) | **POST** /api/v1/approval_types | Create a new Approval Type
+*Quake::Timesheets::ApprovalsApi* | [**get_api_v1_approvals**](docs/ApprovalsApi.md#get_api_v1_approvals) | **GET** /api/v1/approvals | Search for approval types matching filters
+*Quake::Timesheets::ApprovalsApi* | [**post_api_v1_approvals**](docs/ApprovalsApi.md#post_api_v1_approvals) | **POST** /api/v1/approvals | Create a new Approval
+*Quake::Timesheets::DatasetsApi* | [**get_api_v1_datasets**](docs/DatasetsApi.md#get_api_v1_datasets) | **GET** /api/v1/datasets | List all available datasets
+*Quake::Timesheets::DatasetsApi* | [**get_api_v1_datasets_id**](docs/DatasetsApi.md#get_api_v1_datasets_id) | **GET** /api/v1/datasets/{id} | Show details about a specific dataset
+*Quake::Timesheets::DatasetsApi* | [**post_api_v1_datasets**](docs/DatasetsApi.md#post_api_v1_datasets) | **POST** /api/v1/datasets | Create a new Dataset record
+*Quake::Timesheets::EntriesApi* | [**get_api_v1_entries**](docs/EntriesApi.md#get_api_v1_entries) | **GET** /api/v1/entries | Search for entries matching filters
+*Quake::Timesheets::EntriesApi* | [**post_api_v1_entries**](docs/EntriesApi.md#post_api_v1_entries) | **POST** /api/v1/entries | Create a new Entry
+*Quake::Timesheets::EntriesApi* | [**post_api_v1_entries_id**](docs/EntriesApi.md#post_api_v1_entries_id) | **POST** /api/v1/entries/{id} | Update an existing Entry
+*Quake::Timesheets::PeopleApi* | [**get_api_v1_people**](docs/PeopleApi.md#get_api_v1_people) | **GET** /api/v1/people | Search for people matching filters
+*Quake::Timesheets::PeopleApi* | [**post_api_v1_people**](docs/PeopleApi.md#post_api_v1_people) | **POST** /api/v1/people | Create a new Person record
+
+
+## Documentation for Models
+
+ - [Quake::Timesheets::Approval](docs/Approval.md)
+ - [Quake::Timesheets::ApprovalType](docs/ApprovalType.md)
+ - [Quake::Timesheets::Dataset](docs/Dataset.md)
+ - [Quake::Timesheets::Entry](docs/Entry.md)
+ - [Quake::Timesheets::Person](docs/Person.md)
+
+
+## Documentation for Authorization
+
+
+### authToken
+
+
+- **Type**: API key
+- **API key parameter name**: authorization
+- **Location**: HTTP header
+
+
+## Debugging
+
+When enabled, the additional information can be provided to the logger. To enable debug logging:
+
+```ruby
+Quake::Timesheets.configure do |config|
+  config.debugging = true
+end
+```
+
+## Middleware
+
+This gem uses Faraday to manage the underlying http requests. Faraday supports middleware that can
+interact with the request and response directly before and after they are sent or received. This
+can be used to provide additional logic such as adding custom logging. See
+[https://lostisland.github.io/faraday/middleware/] for details
+
+To add a middleware to be used do something like below:
+```ruby
+Quake::Timesheets.configure do |config|
+  config.faraday_middlewares.push(MyMiddleware)
+end
+```

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end

data/build.sh

@@ -0,0 +1,10 @@
+# /bin/sh
+
+# passing the parameter "local" builds against the local instance
+if [ "local" = "$1" ]; then
+  SOURCE='http://localhost:3000/apidocs/1.0.json?type=swagger'
+else
+  SOURCE='https://timesheetsapi.svc.lumbry.co.uk/apidocs/1.0.json?type=swagger'
+fi
+
+openapi-generator generate --generator-name ruby --input-spec $SOURCE --config ruby.config.yaml --template-dir ruby-templates --git-user-id quake-saas --git-repo-id timesheets-client-ruby

data/commands

@@ -0,0 +1,13 @@
+require 'quake_timesheets_client'
+
+config = Quake::Timesheets::Configuration.new
+config.api_key['authToken'] = 'supersecretkey'
+
+config.server_settings = [{url: 'http://localhost:3000'}]
+
+client = Quake::Timesheets::ApiClient.new(config)
+api_instance = Quake::Timesheets::ApprovalTypesApi.new(client)
+result = api_instance.get_api_v1_approval_types(dataset_id: '05033a75-de02-4689-9c55-04b575d33b2c')
+
+result.first.name == 'my approval'
+result.first.weight == 2.0

data/docs/Approval.md

@@ -0,0 +1,34 @@
+# Quake::Timesheets::Approval
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The ID of the approval type |  |
+| **dataset_id** | **String** | ID of the dataset this approval type is linked to |  |
+| **entry_ids** | **Array<String>** | The ID of the Entry this Approval is linked to |  |
+| **approver_id** | **String** | The ID of the Person who created this Approval |  |
+| **approval_type_id** | **String** | The ID of the Approval Type of this Approval |  |
+| **state** | **String** |  |  |
+| **notes** | **String** |  |  |
+| **created_at** | **String** | Time at which the record was created |  |
+| **updated_at** | **String** | Time at which the record was updated |  |
+
+## Example
+
+```ruby
+require 'quake_timesheets_client'
+
+instance = Quake::Timesheets::Approval.new(
+  id: null,
+  dataset_id: null,
+  entry_ids: null,
+  approver_id: null,
+  approval_type_id: null,
+  state: null,
+  notes: null,
+  created_at: null,
+  updated_at: null
+)
+```
+

data/docs/ApprovalType.md

@@ -0,0 +1,24 @@
+# Quake::Timesheets::ApprovalType
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The ID of the approval type |  |
+| **dataset_id** | **String** | ID of the dataset this approval type is linked to |  |
+| **name** | **String** | The name of the approval type |  |
+| **weight** | **Float** | The weight provided by approvals of this type |  |
+
+## Example
+
+```ruby
+require 'quake_timesheets_client'
+
+instance = Quake::Timesheets::ApprovalType.new(
+  id: null,
+  dataset_id: null,
+  name: null,
+  weight: null
+)
+```
+

data/docs/ApprovalTypesApi.md

@@ -0,0 +1,153 @@
+# Quake::Timesheets::ApprovalTypesApi
+
+All URIs are relative to *https://timesheetsapi.svc.lumbry.co.uk:443*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_api_v1_approval_types**](ApprovalTypesApi.md#get_api_v1_approval_types) | **GET** /api/v1/approval_types | Search for approval types matching filters |
+| [**post_api_v1_approval_types**](ApprovalTypesApi.md#post_api_v1_approval_types) | **POST** /api/v1/approval_types | Create a new Approval Type |
+
+
+## get_api_v1_approval_types
+
+> <Array<ApprovalType>> get_api_v1_approval_types(opts)
+
+Search for approval types matching filters
+
+### Examples
+
+```ruby
+require 'time'
+require 'quake_timesheets_client'
+# setup authorization
+Quake::Timesheets.configure do |config|
+  # Configure API key authorization: authToken
+  config.api_key['authToken'] = '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['authToken'] = 'Bearer'
+end
+
+api_instance = Quake::Timesheets::ApprovalTypesApi.new
+opts = {
+  dataset_id: 'dataset_id_example' # String | Filter to the approval types belonging to one of the identified datasets
+}
+
+begin
+  # Search for approval types matching filters
+  result = api_instance.get_api_v1_approval_types(opts)
+  p result
+rescue Quake::Timesheets::ApiError => e
+  puts "Error when calling ApprovalTypesApi->get_api_v1_approval_types: #{e}"
+end
+```
+
+#### Using the get_api_v1_approval_types_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<ApprovalType>>, Integer, Hash)> get_api_v1_approval_types_with_http_info(opts)
+
+```ruby
+begin
+  # Search for approval types matching filters
+  data, status_code, headers = api_instance.get_api_v1_approval_types_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<ApprovalType>>
+rescue Quake::Timesheets::ApiError => e
+  puts "Error when calling ApprovalTypesApi->get_api_v1_approval_types_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **dataset_id** | **String** | Filter to the approval types belonging to one of the identified datasets | [optional] |
+
+### Return type
+
+[**Array&lt;ApprovalType&gt;**](ApprovalType.md)
+
+### Authorization
+
+[authToken](../README.md#authToken)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: */*
+
+
+## post_api_v1_approval_types
+
+> <ApprovalType> post_api_v1_approval_types(weight, name, dataset_id)
+
+Create a new Approval Type
+
+### Examples
+
+```ruby
+require 'time'
+require 'quake_timesheets_client'
+# setup authorization
+Quake::Timesheets.configure do |config|
+  # Configure API key authorization: authToken
+  config.api_key['authToken'] = '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['authToken'] = 'Bearer'
+end
+
+api_instance = Quake::Timesheets::ApprovalTypesApi.new
+weight = 8.14 # Float | The weight provided by approvals of this type
+name = 'name_example' # String | The name of the approval type
+dataset_id = 'dataset_id_example' # String | ID of the dataset this approval type is linked to
+
+begin
+  # Create a new Approval Type
+  result = api_instance.post_api_v1_approval_types(weight, name, dataset_id)
+  p result
+rescue Quake::Timesheets::ApiError => e
+  puts "Error when calling ApprovalTypesApi->post_api_v1_approval_types: #{e}"
+end
+```
+
+#### Using the post_api_v1_approval_types_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ApprovalType>, Integer, Hash)> post_api_v1_approval_types_with_http_info(weight, name, dataset_id)
+
+```ruby
+begin
+  # Create a new Approval Type
+  data, status_code, headers = api_instance.post_api_v1_approval_types_with_http_info(weight, name, dataset_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ApprovalType>
+rescue Quake::Timesheets::ApiError => e
+  puts "Error when calling ApprovalTypesApi->post_api_v1_approval_types_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **weight** | **Float** | The weight provided by approvals of this type |  |
+| **name** | **String** | The name of the approval type |  |
+| **dataset_id** | **String** | ID of the dataset this approval type is linked to |  |
+
+### Return type
+
+[**ApprovalType**](ApprovalType.md)
+
+### Authorization
+
+[authToken](../README.md#authToken)
+
+### HTTP request headers
+
+- **Content-Type**: application/x-www-form-urlencoded, multipart/form-data
+- **Accept**: */*
+