onesignal 1.0.0.beta1 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d21c45ad6dc835a3d618d705c0abad6b42cb5d81733232519ff6305f444736cd
-  data.tar.gz: cb84fa7dcfbf2dbbce153806f056f059587aa45fda020451f2df01ffe496b235
+  metadata.gz: 5ed573134bbb56b24a52664d42154e91205f9ea004d945816cece64b091f70a0
+  data.tar.gz: 9216667b6c7d0b68e7fd13556a27f88006bab0ed59747b3bf2e17a095c95afa3
 SHA512:
-  metadata.gz: 798df78ec20c50fddf2cc396900b83209d684e15f4a978b1c15a2a6fe33eb8b6bd33c149806a3984bc837ce79e4610da405d1774252cd4f8c7261b96846c3d39
-  data.tar.gz: 2091ac298b863f0658ecb69eb20009231216f4ad4a044a55ee67f356ea0d19038953ebfdbffc28731cb110e58ac8a4ede9b8f5f411904ef5e86bda9f2abb9549
+  metadata.gz: b57b8d0ed69672c664b0ec114576d702b0c601eef83e8c2db0a32d483a9bd79ecb5cfe27e442ede4785bd7fd18d039f4d3389487c20966ad22319f3198922dd5
+  data.tar.gz: d8f30f8aa642aab8150a908fc594d8c1c3e7e1f9da56999ed5b7f0c122682b741ab66c29f6beabe6c531b64c97c253ed062f9cf0c67794ee94e86cd6c7279972

data/CHANGELOG.md

@@ -0,0 +1,31 @@
+# Change Log
+All notable changes to this project will be documented in this file.
+This project adheres to [Semantic Versioning](http://semver.org/).
+
+## [1.0.0.beta1] - 2021-10-13
+### Major Release
+**INCLUDES BREAKING CHANGES**
+This release is the code-generated Ruby client made with OpenAPI Generator.
+The release is a complete overhaul and includes a new API.
+See README for full documentation.
+
+**Full Changelog**: https://github.com/OneSignal/onesignal-ruby-client/compare/v0.3.0...1.0.0.beta1
+
+## [0.3.0] - 2016-05-10
+### Added
+* Models dynamically create attributes on initialization
+
+## [0.2.0] - 2016-04-29
+### Added
+* Ruby 2.0 compatibility
+* CHANGELOG
+
+### Fixed
+* Typos in README
+
+## 0.1.0 - 2016-03-29
+### Added
+* Methods for all OneSignal resources
+
+[0.3.0]: https://github.com/coding-chimp/onesignal/compare/v0.2.0...v0.3.0
+[0.2.0]: https://github.com/coding-chimp/onesignal/compare/v0.1.0...v0.2.0

data/LICENSE

@@ -0,0 +1,24 @@
+Modified MIT License
+
+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
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+1. The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+2. All copies of substantial portions of the Software may only be used in connection
+with services provided by OneSignal.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -1,4 +1,19 @@
-# onesignal
+<h1 align="center">Welcome to the official OneSignal Ruby Client 👋</h1>
+
+[![Gem Version][rgb]][rgl]
+
+<p>
+  <a href="https://github.com/OneSignal/onesignal-ruby-client/blob/master/README.md" target="_blank">
+    <img alt="Documentation" src="https://img.shields.io/badge/documentation-yes-brightgreen.svg" />
+  </a>
+  <a href="https://github.com/OneSignal/onesignal-ruby-client/graphs/commit-activity" target="_blank">
+    <img alt="Maintenance" src="https://img.shields.io/badge/Maintained%3F-yes-green.svg" />
+  </a>
+  <a href="https://twitter.com/onesignal" target="_blank">
+    <img alt="Twitter: onesignal" src="https://img.shields.io/twitter/follow/onesignal.svg?style=social" />
+  </a>
+</p>
+
 
 OneSignal - the Ruby gem for the OneSignal
 
@@ -6,75 +21,54 @@ A powerful way to send personalized messages at scale and build effective custom
 
 This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
-- API version: 1.0.0
-- Package version: 1.0.0
-- Build package: org.openapitools.codegen.languages.RubyClientCodegen
-For more information, please visit [https://onesignal.com](https://onesignal.com)
-
-## Installation
-
-### Build a gem
+OneSignal is a simple ruby wrapper for the [OneSignal API][osa].
 
-To build the Ruby code into a gem:
+### 🖤 [RubyGems](https://rubygems.org/gems/onesignal)
 
-```shell
-gem build onesignal.gemspec
-```
+## Installation
 
-Then either install the gem locally:
+Add this line to your application's Gemfile:
 
-```shell
-gem install ./onesignal-1.0.0.gem
+```ruby
+gem 'onesignal', '~> 1.0.1'
 ```
 
-(for development, run `gem install --dev ./onesignal-1.0.0.gem` to install the development dependencies)
-
-or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
+And then execute:
 
-Finally add this to the Gemfile:
+    $ bundle
 
-    gem 'onesignal', '~> 1.0.0'
+Or install it yourself as:
 
-### Install from Git
+    $ gem install onesignal
 
-If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:
+Or install from Github:
 
-    gem 'onesignal', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
-
-### Include the Ruby code directly
-
-Include the Ruby code directly using `-I` as follows:
-
-```shell
-ruby -Ilib script.rb
-```
+    $ gem "onesignal", '~> 1.0.1', git: 'git://github.com/OneSignal/onesignal-ruby-api.git'
 
 ## Getting Started
 
 Please follow the [installation](#installation) procedure and then run the following code:
 
 ```ruby
-# Load the gem
+require 'time'
 require 'onesignal'
-
-# Setup authorization
+# setup authorization
 OneSignal.configure do |config|
   # Configure Bearer authorization: app_key
-  config.access_token = 'YOUR_BEARER_TOKEN'
+  config.user_key = 'YOUR_USER_KEY' # Change this
+  config.app_key = 'YOUR_APP_KEY'
 end
 
 api_instance = OneSignal::DefaultApi.new
-app_id = 'app_id_example' # String | 
-notification_id = 'notification_id_example' # String | 
+notification = OneSignal::Notification.new({app_id: 'YOUR APP ID'}) # Notification
 
 begin
-  #Stop a scheduled or currently outgoing notification
-  result = api_instance.cancel_notification(app_id, notification_id)
+  # Create notification
+  result = api_instance.create_notification(notification)
   p result
 rescue OneSignal::ApiError => e
-  puts "Exception when calling DefaultApi->cancel_notification: #{e}"
+  puts "Error when calling DefaultApi->create_notification: #{e}"
 end
-
 ```
 
 ## Documentation for API Endpoints
@@ -103,7 +97,6 @@ Class | Method | HTTP request | Description
 *OneSignal::DefaultApi* | [**update_player**](docs/DefaultApi.md#update_player) | **PUT** /players/{player_id} | Edit device
 *OneSignal::DefaultApi* | [**update_player_tags**](docs/DefaultApi.md#update_player_tags) | **PUT** /apps/{app_id}/users/{external_user_id} | Edit tags with external user id
 
-
 ## Documentation for Models
 
  - [OneSignal::App](docs/App.md)
@@ -142,15 +135,52 @@ Class | Method | HTTP request | Description
  - [OneSignal::StringMap](docs/StringMap.md)
  - [OneSignal::UpdatePlayerTagsRequestBody](docs/UpdatePlayerTagsRequestBody.md)
 
-
 ## Documentation for Authorization
 
-
 ### app_key
 
 - **Type**: Bearer authentication
 
+```rb
+OneSignal.configure do |config|
+  config.app_key = 'APP_KEY' # replace with your app key
+end
+```
+
 ### user_key
 
 - **Type**: Bearer authentication
 
+```rb
+OneSignal.configure do |config|
+  config.user_key = 'USER_KEY' # replace with your user key
+end
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License][mit].
+
+[rgb]: https://img.shields.io/gem/v/onesignal.svg
+[rgl]: https://rubygems.org/gems/onesignal
+[osa]: https://documentation.onesignal.com/reference/
+[mit]: http://opensource.org/licenses/MIT
+
+## Author
+
+* Website: https://onesignal.com
+* Twitter: [@onesignal](https://twitter.com/onesignal)
+* Github: [@OneSignal](https://github.com/OneSignal)
+
+## 🤝 Contributing
+
+Contributions, issues and feature requests are welcome!<br />Feel free to check [issues page](https://github.com/OneSignal/onesignal-ruby-client/issues).
+
+## Show your support
+
+Give a ⭐️ if this project helped you!
+
+## 📝 License
+
+Copyright © 2022 [OneSignal](https://github.com/OneSignal).<br />
+This project is [MIT](https://opensource.org/licenses/MIT) licensed.

data/RELEASE_INSTRUCTIONS.md

@@ -0,0 +1,11 @@
+# Release Instructions
+1. Generate new client version using OpenApi Generator
+2. Make sure `ruby.yml` has the correct gem version
+2. Create a new PR and merge
+   * Carefully review the PR to ensure nothing is overwritten and you are including all desired changes
+   * Ensure the correct version number is being sent in the header params `OS-Usage-Data` (`api_client.rb`)
+3. Generate the gem: `gem build onesignal`
+4. Publish to RubyGems
+   * To publish version 0.1.0 of a new gem called 'squid-utils', run: `gem push squid-utils-0.1.0.gem`
+   * To publish a beta version, simply add `.beta1`, `.beta2` etc... after the semantic version (e.g: `1.0.0.beta1`)
+