propertyware 1.0.5

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/Gemfile.lock

@@ -0,0 +1,76 @@
+PATH
+  remote: .
+  specs:
+    propertyware (1.0.5)
+      faraday (>= 1.0.1, < 3.0)
+      faraday-multipart
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    byebug (11.1.3)
+    coderay (1.1.3)
+    diff-lcs (1.5.0)
+    faraday (2.7.10)
+      faraday-net_http (>= 2.0, < 3.1)
+      ruby2_keywords (>= 0.0.4)
+    faraday-multipart (1.0.4)
+      multipart-post (~> 2)
+    faraday-net_http (3.0.2)
+    jaro_winkler (1.5.4)
+    method_source (1.0.0)
+    multipart-post (2.3.0)
+    parallel (1.23.0)
+    parser (3.2.2.3)
+      ast (~> 2.4.1)
+      racc
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-byebug (3.9.0)
+      byebug (~> 11.0)
+      pry (~> 0.13.0)
+    psych (4.0.3)
+      stringio
+    racc (1.4.16)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.3)
+    rubocop (0.66.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.5, != 2.5.1.1)
+      psych (>= 3.1.0)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.6)
+    ruby-progressbar (1.13.0)
+    ruby2_keywords (0.0.5)
+    stringio (3.0.1)
+    unicode-display_width (1.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  propertyware!
+  pry-byebug
+  rake (~> 13.0.1)
+  rspec (~> 3.6, >= 3.6.0)
+  rubocop (~> 0.66.0)
+
+BUNDLED WITH
+   2.1.4

data/README.md

@@ -0,0 +1,93 @@
+# Propertyware
+
+A Ruby client library for interacting with the [Propertyware API](https://app.propertyware.com/pw/apidocs), created and maintained by LeadSimple. This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project.
+
+**DO NOT EDIT THIS README**. Edit the one in `bin/README.md` instead and rerun the `rebuild.sh` file, see below.
+
+## Getting Started
+
+1. Add this gem to your dependencies
+
+   ```ruby
+   # In your .gemspec, if any
+   s.add_runtime_dependency "propertyware", "~> 1.0.0"
+
+   # In your Gemfile
+   gem "propertyware"
+   ```
+
+2. Get a Propertyware API client ID and secret in your Propertyware portal.
+
+### Usage Examples
+
+You can configure the gem in two ways.
+
+#### Global Configuration
+
+All requests will use a single API key. Use this when you only expect to make requests on behalf of one Propertyware account.
+
+```ruby
+# Load the gem
+require 'propertyware'
+
+# Setup authorization
+Propertyware.configure do |config|
+  # Configure API key username: clientId
+  config.username = 'YOUR API CLIENT ID'
+
+  # Configure API key authorization: clientSecret
+  config.password = 'YOUR API CLIENT SECRET'
+end
+
+# Configure your Partner ID header
+api_client = Propertyware::ApiClient.new
+api_client.default_headers['X-Propertyware-System-ID'] = 'YOUR PARTNER ID'
+
+api_instance = Propertyware::UnitsApi.new
+
+begin
+  # Get all units
+  result = api_instance.units_get(query_params: {filters: {"LastUpdatedAtFrom" => '2020-12-15T16:30:46Z'}})
+  p result
+rescue Propertyware::ApiError => e
+  puts "Exception when calling UnitsApi->units_get: #{e}"
+end
+```
+
+#### Per-Request Configuration
+
+If you need to make requests on behalf of several Propertyware accounts, then you will want to configure each request individually. Here's an example of how to do that:
+
+```ruby
+require "propertyware"
+
+# Create a configuration object, configuring credentials
+config = Propertyware::Configuration.new do
+  config.api_key["clientId"] = "<CLIENT_ID>"
+  config.api_key["clientSecret"] = "<CLIENT_SECRET>"
+  config.api_key["organizationId"] = "<ORGANIZATION_ID>"
+endl
+
+# Build an API client
+api_client = Propertyware::ApiClient.new(config)
+
+# Hit their API
+buildings_api = Propertyware::BuildingsApi.new(api_client)
+buildings_api.get_buildings(query_params: {filters: {"lastModifiedDateTimeStart" => '2020-12-15T16:30:46Z'}})
+# => [<Propertyware::Property ...>]
+```
+
+## Documentation
+
+Read the [generated docs here](/DOCS.md). They're actually pretty good!
+
+## Customizations
+
+Besides using OpenAPI Generator, we have some overrides to their templates, to make things easier in our side. You can find about them [here](./CUSTOMIZATIONS.md).
+
+## How to Regenerate This Library
+
+1. Download a new `swagger.json` file from the [Propertyware docs](https://app.propertyware.com/pw/apidocs/) by clicking the "Download" button
+2. Replace the `bin/propertyware.json` file with it
+3. Increment the `gemVersion` key in `bin/config.yml`
+4. Run `bin/rebuild.sh` to rebuild everything

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/bin/CUSTOMIZATIONS.md

@@ -0,0 +1,11 @@
+# Customizations
+
+To satisfy our needs, we sometimes update some of OpenAPI Generator templates. This is a list of all of them, and the version where they were introduced.
+
+These customizations reside in the `.openapi-generator/templates/ruby-client` folder.
+
+## Changelog
+
+### v1.0.0
+
+- In case we receive an enum with an invalid value, we are adding the received value in the error message to make debugging (and further contacting Propertyware) easier. Update done, at the time of this commit, at `./.openapi-generator/templates/ruby-client/partial_model_generic.mustache:L281`.

data/bin/README.md

@@ -0,0 +1,93 @@
+# Propertyware
+
+A Ruby client library for interacting with the [Propertyware API](https://app.propertyware.com/pw/apidocs), created and maintained by LeadSimple. This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project.
+
+**DO NOT EDIT THIS README**. Edit the one in `bin/README.md` instead and rerun the `rebuild.sh` file, see below.
+
+## Getting Started
+
+1. Add this gem to your dependencies
+
+   ```ruby
+   # In your .gemspec, if any
+   s.add_runtime_dependency "propertyware", "~> 1.0.0"
+
+   # In your Gemfile
+   gem "propertyware"
+   ```
+
+2. Get a Propertyware API client ID and secret in your Propertyware portal.
+
+### Usage Examples
+
+You can configure the gem in two ways.
+
+#### Global Configuration
+
+All requests will use a single API key. Use this when you only expect to make requests on behalf of one Propertyware account.
+
+```ruby
+# Load the gem
+require 'propertyware'
+
+# Setup authorization
+Propertyware.configure do |config|
+  # Configure API key username: clientId
+  config.username = 'YOUR API CLIENT ID'
+
+  # Configure API key authorization: clientSecret
+  config.password = 'YOUR API CLIENT SECRET'
+end
+
+# Configure your Partner ID header
+api_client = Propertyware::ApiClient.new
+api_client.default_headers['X-Propertyware-System-ID'] = 'YOUR PARTNER ID'
+
+api_instance = Propertyware::UnitsApi.new
+
+begin
+  # Get all units
+  result = api_instance.units_get(query_params: {filters: {"LastUpdatedAtFrom" => '2020-12-15T16:30:46Z'}})
+  p result
+rescue Propertyware::ApiError => e
+  puts "Exception when calling UnitsApi->units_get: #{e}"
+end
+```
+
+#### Per-Request Configuration
+
+If you need to make requests on behalf of several Propertyware accounts, then you will want to configure each request individually. Here's an example of how to do that:
+
+```ruby
+require "propertyware"
+
+# Create a configuration object, configuring credentials
+config = Propertyware::Configuration.new do
+  config.api_key["clientId"] = "<CLIENT_ID>"
+  config.api_key["clientSecret"] = "<CLIENT_SECRET>"
+  config.api_key["organizationId"] = "<ORGANIZATION_ID>"
+endl
+
+# Build an API client
+api_client = Propertyware::ApiClient.new(config)
+
+# Hit their API
+buildings_api = Propertyware::BuildingsApi.new(api_client)
+buildings_api.get_buildings(query_params: {filters: {"lastModifiedDateTimeStart" => '2020-12-15T16:30:46Z'}})
+# => [<Propertyware::Property ...>]
+```
+
+## Documentation
+
+Read the [generated docs here](/DOCS.md). They're actually pretty good!
+
+## Customizations
+
+Besides using OpenAPI Generator, we have some overrides to their templates, to make things easier in our side. You can find about them [here](./CUSTOMIZATIONS.md).
+
+## How to Regenerate This Library
+
+1. Download a new `swagger.json` file from the [Propertyware docs](https://app.propertyware.com/pw/apidocs/) by clicking the "Download" button
+2. Replace the `bin/propertyware.json` file with it
+3. Increment the `gemVersion` key in `bin/config.yml`
+4. Run `bin/rebuild.sh` to rebuild everything

data/bin/config.yml

@@ -0,0 +1,7 @@
+additionalProperties:
+  moduleName: Propertyware
+  gemAuthor: LeadSimple
+  gemHomepage: https://github.com/LeadSimple/propertyware
+  gemDescription: API client library for Propertyware
+  gemRequiredRubyVersion: "> 2.6.0"
+  gemVersion: 1.0.5

data/bin/fix_json.rb

@@ -0,0 +1,59 @@
+require 'pry'
+require 'json'
+
+file = File.read('bin/propertyware.json')
+data = JSON.parse(file)
+
+# For some reason, the validator fails to properly parse the contact URL,
+# so we are simply removing it becase it has no effect in the final SDK anyway
+data['info']['contact'].delete('url')
+
+# The operation IDs - which are used to generate the SDK method names - are
+# in a weird format where they have a `Using<METHOD>` suffix. We are removing
+# that suffix here to simplify the SDK method names.
+data['paths'].each do |_path_name, methods|
+  methods.each do |_method_name, method|
+    method['operationId'] = method['operationId'].gsub(/Using[A-Z]+$/, '') 
+  end
+end
+
+# This enum is failing to be parsed, because the values are actually capitalized
+# They are properly capitalized in SaveBuilding#propertyType, but not in Building#propertyType
+#
+# The reason why we simply copy the data instead of capitalizing it, is because there are some
+# inconsistencies and simply capitalizing doesn't work. For example, the `propertyType` enum
+# in `SaveBuilding` has a `DU_FOUR_PLEX` value, but the `Building` enum has a `Du/Fourplex` value.
+data['components']['schemas']['Building']['properties']['propertyType']['enum'] = 
+  data['components']['schemas']['SaveBuilding']['properties']['propertyType']['enum']
+
+# The API does not include the Authorization part on their JSON, so we add it ourselves
+data['security'] = [{ "clientId": [] }, { "clientSecret": [] }, { "organizationId": [] }]
+data['components']['securitySchemes'] = {
+  "clientId": {
+    "type": "apiKey",
+    "in": "header",
+    "name": "x-propertyware-client-id"
+  },
+  "clientSecret": {
+    "type": "apiKey",
+    "in": "header",
+    "name": "x-propertyware-client-secret"
+  },
+  "organizationId": {
+    "type": "apiKey",
+    "in": "header",
+    "name": "x-propertyware-system-id"
+  }
+}
+
+# Guarantee we automatically set HTTPS as the schema
+data['servers'][0] = { "url": "https://api.propertyware.com/pw/api/rest/v1" } unless data['servers'].first['url'].start_with?("https://")
+
+# All models have an extra `DTO` suffix, which we are removing here for simplicity sake.
+# To simplify, we are acting directly in the output string, which is not ideal, but it's simpler
+# than handling all cases using `#each` calls
+data_json = data.to_json
+data_json = data_json.gsub(/DTOs? */i, '')
+
+# Save it back to the file
+File.write('bin/propertyware.json', data_json)