diff --git a/.github/ISSUE_TEMPLATE/ask-question.yml b/.github/ISSUE_TEMPLATE/ask-question.yml new file mode 100644 index 0000000..3da173f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/ask-question.yml @@ -0,0 +1,25 @@ +name: 🙋♂️ Ask a question +description: Tell us what's on your mind +title: "[question]: " +labels: ["triage"] +body: + - type: markdown + attributes: + value: | + Having issues integrating this API library? + - type: textarea + id: question + attributes: + label: How can we help? + description: Specific question regarding integrating this API library. + placeholder: How do I...? + validations: + required: true + - type: checkboxes + id: terms + attributes: + label: Code of Conduct + description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/OneSignal/api/blob/main/CONTRIBUTING.md) + options: + - label: I agree to follow this project's Code of Conduct + required: true \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml new file mode 100644 index 0000000..f274813 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -0,0 +1,51 @@ +name: 🪳 Bug report +description: File a bug report +title: "[Bug]: " +labels: ["bug", "triage"] +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out this bug report! + - type: textarea + id: what-happened + attributes: + label: What happened? + description: Provide a thorough description of whats going on. + placeholder: The latest version of the API library throws an exception when creating a notification targetting all Active Users. + validations: + required: true + - type: textarea + id: reproduction-steps + attributes: + label: Steps to reproduce? + description: Provide as much detail as posible to reproduce the issue. + placeholder: | + 1. Install vX.Y.Z of dependency + 2. Run provided code snippet + 3. Note that the app crashes + render: Markdown + validations: + required: true + - type: textarea + id: what-are-expectations + attributes: + label: What did you expect to happen? + description: Also tell us, what did you expect to happen? + placeholder: I expected the API library to properly deserialize any response returned by OneSignal. + validations: + required: true + - type: textarea + id: logs + attributes: + label: Relevant log output + description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks. + render: Shell + - type: checkboxes + id: terms + attributes: + label: Code of Conduct + description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/OneSignal/api/blob/main/CONTRIBUTING.md) + options: + - label: I agree to follow this project's Code of Conduct + required: true \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/general-feedback.yml b/.github/ISSUE_TEMPLATE/general-feedback.yml new file mode 100644 index 0000000..e632759 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/general-feedback.yml @@ -0,0 +1,25 @@ +name: 📣 General feedback +description: Tell us what's on your mind +title: "[Bug]: " +labels: ["triage"] +body: + - type: markdown + attributes: + value: | + Thanks for sharing your valuable feedback! + - type: textarea + id: feedback + attributes: + label: What's on your mind? + description: Feedback regarding this API library. + placeholder: Share your feedback... + validations: + required: true + - type: checkboxes + id: terms + attributes: + label: Code of Conduct + description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/OneSignal/api/blob/main/CONTRIBUTING.md) + options: + - label: I agree to follow this project's Code of Conduct + required: true \ No newline at end of file diff --git a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md new file mode 100644 index 0000000..c16540f --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md @@ -0,0 +1,44 @@ + +# READ AND DELETE THIS SECTION BEFORE SUBMITTING PR +* **Fill out each _REQUIRED_ section** +* **Fill out _OPTIONAL_ sections, remove section if it doesn't apply to your PR** +* **Read and fill out each of the checklists below** +* **Remove this section after reading** + + +# Description +## One Line Summary +**REQUIRED** - Very short description that summaries the changes in this PR. + +## Details + +### Motivation +**REQUIRED -** Why is this code change being made? Or what is the goal of this PR? Examples: Fixes a specific bug, provides additional logging to debug future issues, feature to allow X. + +### Scope +**RECOMMEND - OPTIONAL -** What is intended to be effected. What is known not to change. Example: Notifications are grouped when parameter X is set, not enabled by default. + +### OPTIONAL - Other +**OPTIONAL -** Feel free to add any other sections or sub-sections that can explain your PR better. + +# Testing + +## Manual testing +**REQUIRED -** Explain what scenarios were tested and the environment. + + +# Checklist +## Overview + - [ ] I have filled out all **REQUIRED** sections above + - [ ] PR does one thing + - If it is hard to explain how any codes changes are related to each other then it most likely needs to be more than one PR + - [ ] Any Public API changes are explained in the PR details and conform to existing APIs + +## Testing + - [ ] I have personally tested this on my device, or explained why that is not possible + +## Final pass + - [ ] Code is as readable as possible. + - Simplify with less code, followed by splitting up code into well named functions and variables, followed by adding comments to the code. + - [ ] I have reviewed this PR myself, ensuring it meets each checklist item + - WIP (Work In Progress) is ok, but explain what is still in progress and what you would like feedback on. Start the PR title with "WIP" to indicate this. \ No newline at end of file diff --git a/.gitignore b/.gitignore deleted file mode 100644 index 05a17cb..0000000 --- a/.gitignore +++ /dev/null @@ -1,39 +0,0 @@ -# Generated by: https://openapi-generator.tech -# - -*.gem -*.rbc -/.config -/coverage/ -/InstalledFiles -/pkg/ -/spec/reports/ -/spec/examples.txt -/test/tmp/ -/test/version_tmp/ -/tmp/ - -## Specific to RubyMotion: -.dat* -.repl_history -build/ - -## Documentation cache and generated files: -/.yardoc/ -/_yardoc/ -/doc/ -/rdoc/ - -## Environment normalization: -/.bundle/ -/vendor/bundle -/lib/bundler/man/ - -# for a library or gem, you might want to ignore these files since the code is -# intended to run in multiple environments; otherwise, check them in: -# Gemfile.lock -# .ruby-version -# .ruby-gemset - -# unless supporting rvm < 1.11.0 or doing something fancy, ignore this: -.rvmrc diff --git a/.openapi-generator-ignore b/.openapi-generator-ignore deleted file mode 100644 index 7484ee5..0000000 --- a/.openapi-generator-ignore +++ /dev/null @@ -1,23 +0,0 @@ -# OpenAPI Generator Ignore -# Generated by openapi-generator https://github.com/openapitools/openapi-generator - -# Use this file to prevent files from being overwritten by the generator. -# The patterns follow closely to .gitignore or .dockerignore. - -# As an example, the C# client generator defines ApiClient.cs. -# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line: -#ApiClient.cs - -# You can match any string of characters against a directory, file or extension with a single asterisk (*): -#foo/*/qux -# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux - -# You can recursively match patterns against a directory, file or extension with a double asterisk (**): -#foo/**/qux -# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux - -# You can also negate patterns with an exclamation (!). -# For example, you can ignore all files in a docs folder with the file extension .md: -#docs/*.md -# Then explicitly reverse the ignore rule for a single file: -#!docs/README.md diff --git a/.openapi-generator/FILES b/.openapi-generator/FILES deleted file mode 100644 index a6b9bdb..0000000 --- a/.openapi-generator/FILES +++ /dev/null @@ -1,126 +0,0 @@ -.gitignore -.openapi-generator-ignore -.rspec -.rubocop.yml -.travis.yml -Gemfile -README.md -Rakefile -docs/App.md -docs/Button.md -docs/DefaultApi.md -docs/DeliveryData.md -docs/ExportPlayersRequestBody.md -docs/Filter.md -docs/FilterExpressions.md -docs/FilterNotificationTarget.md -docs/GetNotificationRequestBody.md -docs/InlineResponse200.md -docs/InlineResponse2001.md -docs/InlineResponse2002.md -docs/InlineResponse2003.md -docs/InlineResponse2004.md -docs/InlineResponse2005.md -docs/InlineResponse201.md -docs/InlineResponse400.md -docs/InlineResponse4001.md -docs/InlineResponse4002.md -docs/InlineResponse409.md -docs/Notification.md -docs/NotificationAllOf.md -docs/NotificationAllOfAndroidBackgroundLayout.md -docs/NotificationSlice.md -docs/NotificationTarget.md -docs/Operator.md -docs/OutcomeData.md -docs/PlatformDeliveryData.md -docs/Player.md -docs/PlayerNotificationTarget.md -docs/PlayerSlice.md -docs/Purchase.md -docs/Segment.md -docs/SegmentNotificationTarget.md -docs/StringMap.md -docs/UpdatePlayerTagsRequestBody.md -git_push.sh -lib/onesignal.rb -lib/onesignal/api/default_api.rb -lib/onesignal/api_client.rb -lib/onesignal/api_error.rb -lib/onesignal/configuration.rb -lib/onesignal/models/app.rb -lib/onesignal/models/button.rb -lib/onesignal/models/delivery_data.rb -lib/onesignal/models/export_players_request_body.rb -lib/onesignal/models/filter.rb -lib/onesignal/models/filter_expressions.rb -lib/onesignal/models/filter_notification_target.rb -lib/onesignal/models/get_notification_request_body.rb -lib/onesignal/models/inline_response200.rb -lib/onesignal/models/inline_response2001.rb -lib/onesignal/models/inline_response2002.rb -lib/onesignal/models/inline_response2003.rb -lib/onesignal/models/inline_response2004.rb -lib/onesignal/models/inline_response2005.rb -lib/onesignal/models/inline_response201.rb -lib/onesignal/models/inline_response400.rb -lib/onesignal/models/inline_response4001.rb -lib/onesignal/models/inline_response4002.rb -lib/onesignal/models/inline_response409.rb -lib/onesignal/models/notification.rb -lib/onesignal/models/notification_all_of.rb -lib/onesignal/models/notification_all_of_android_background_layout.rb -lib/onesignal/models/notification_slice.rb -lib/onesignal/models/notification_target.rb -lib/onesignal/models/operator.rb -lib/onesignal/models/outcome_data.rb -lib/onesignal/models/platform_delivery_data.rb -lib/onesignal/models/player.rb -lib/onesignal/models/player_notification_target.rb -lib/onesignal/models/player_slice.rb -lib/onesignal/models/purchase.rb -lib/onesignal/models/segment.rb -lib/onesignal/models/segment_notification_target.rb -lib/onesignal/models/string_map.rb -lib/onesignal/models/update_player_tags_request_body.rb -lib/onesignal/version.rb -onesignal.gemspec -spec/api/default_api_spec.rb -spec/api_client_spec.rb -spec/configuration_spec.rb -spec/models/app_spec.rb -spec/models/button_spec.rb -spec/models/delivery_data_spec.rb -spec/models/export_players_request_body_spec.rb -spec/models/filter_expressions_spec.rb -spec/models/filter_notification_target_spec.rb -spec/models/filter_spec.rb -spec/models/get_notification_request_body_spec.rb -spec/models/inline_response2001_spec.rb -spec/models/inline_response2002_spec.rb -spec/models/inline_response2003_spec.rb -spec/models/inline_response2004_spec.rb -spec/models/inline_response2005_spec.rb -spec/models/inline_response200_spec.rb -spec/models/inline_response201_spec.rb -spec/models/inline_response4001_spec.rb -spec/models/inline_response4002_spec.rb -spec/models/inline_response400_spec.rb -spec/models/inline_response409_spec.rb -spec/models/notification_all_of_android_background_layout_spec.rb -spec/models/notification_all_of_spec.rb -spec/models/notification_slice_spec.rb -spec/models/notification_spec.rb -spec/models/notification_target_spec.rb -spec/models/operator_spec.rb -spec/models/outcome_data_spec.rb -spec/models/platform_delivery_data_spec.rb -spec/models/player_notification_target_spec.rb -spec/models/player_slice_spec.rb -spec/models/player_spec.rb -spec/models/purchase_spec.rb -spec/models/segment_notification_target_spec.rb -spec/models/segment_spec.rb -spec/models/string_map_spec.rb -spec/models/update_player_tags_request_body_spec.rb -spec/spec_helper.rb diff --git a/.openapi-generator/VERSION b/.openapi-generator/VERSION deleted file mode 100644 index 6555596..0000000 --- a/.openapi-generator/VERSION +++ /dev/null @@ -1 +0,0 @@ -5.2.0-SNAPSHOT \ No newline at end of file diff --git a/.travis.yml b/.travis.yml deleted file mode 100644 index 636db68..0000000 --- a/.travis.yml +++ /dev/null @@ -1,9 +0,0 @@ -language: ruby -cache: bundler -rvm: - - 2.7.4 -script: - - bundle install --path vendor/bundle - - bundle exec rspec - - gem build onesignal.gemspec - - gem install ./onesignal-1.0.0.gem diff --git a/LICENSE b/LICENSE index c05c7d3..48fd45d 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ Modified MIT License -Copyright 2021 OneSignal +Copyright 2022 OneSignal Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/README.md b/README.md index ba68ee8..2c47b85 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,4 @@ -