onesignal-ruby 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7cc04a0b28c94e926c36f1edde7ed3d651474f2aebf47f2361b612beb329bb01
-  data.tar.gz: 1d2eb9bddde95ce61315bdc5913e035305ad1b8e507c0d6fcc6a68be16a92702
+  metadata.gz: b152a9f9718b89b2e82e057aa1574e0376f10f3a20149e93113c97cb23d40680
+  data.tar.gz: c64d9e07ec9c528ba2104d72c538390e97f5fc6befe6d488cf7eb44146aafc38
 SHA512:
-  metadata.gz: 528ff50448ce553e2bdc2c2f920dcd160208db6648caf1c2c0ad635279bce099c965c33b7930503a274d2cd7c05c42a498f873dfa4fd365ae69beae970c06b5c
-  data.tar.gz: '0083d2a4996ef9cba0bcbbac3de6cb1dbe32ded69777e8512e0665be5647a4d5f349c272a781115bf814d987f108f7ed49f80942a29d7f7127b8870cd1ee0f61'
+  metadata.gz: a6e7d702153b4d487b94299887254287d8dc1f2d09db79002cddc4ec30b19eed1152f713c81a2ebc59a42263766e6f81da21b3a77161f22e1ab6ff6dc955282a
+  data.tar.gz: 8b99a40ce488772517310b767f26913b27a5b4a22205652e5435e55192551cab81f200adca0bf02942f1f2f688edf68900f98f31232026743943c5ce8b6c8420

data/.github/pull_request_template.md

@@ -0,0 +1,23 @@
+Hello there! Welcome. Thank you for your contribution!
+
+Here you can describe the code you are submitting. You can also reference related issues or other
+pull requests that might add context.
+
+Remember to assign the pull request to a [CODEOWNER](../CODEOWNERS) for review.
+
+**ALWAYS** open PRs targeting [develop](https://github.com/mikamai/onesignal-ruby/tree/develop), as it is our mainline branch. Master is only used to cut stable releases.
+
+## Type of change
+
+Please delete options that are not relevant.
+
+- [ ] Bug fix (non-breaking change which fixes an issue)
+- [ ] New feature (non-breaking change which adds functionality)
+- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
+- [ ] This change requires a documentation update
+
+## Checklist
+
+- [ ] I have added tests for each new piece of code I added, or updated existing tests if I changed some existing code
+- [ ] I have added the relevant entry in the `Unreleased` section of the CHANGELOG file 
+- [ ] I have made corresponding changes to the documentation (namely the README file)

data/CHANGELOG.md

@@ -0,0 +1,57 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.6.0] - 2021-10-21
+### Added
+- Support for external_player_id and for deleting a Player thanks to [@reachire-smendola] ([#35](https://github.com/mikamai/onesignal-ruby/pull/35))
+- Support for icons thanks to [@mtayllan] ([#33](https://github.com/mikamai/onesignal-ruby/pull/33))
+
+
+## [0.5.0] - 2021-05-17
+### Added
+- Support for the email_subject field thanks to [@regedarek] ([#26](https://github.com/mikamai/onesignal-ruby/pull/26))
+  with tests contributed by [@martinjaimem] ([#28](https://github.com/mikamai/onesignal-ruby/pull/28))
+- Support for the email_body field thanks to [@martinjaimem] ([#29](https://github.com/mikamai/onesignal-ruby/pull/29))
+
+### Changed
+- Bump Faraday to ~> 1.0 thanks to [@jongirard] (#25)
+
+## [0.4.0] - 2021-01-19
+### Added
+- Support for OneSignal action buttons thanks to [@jongirard] ([#15](https://github.com/mikamai/onesignal-ruby/pull/15))
+- Support for Ruby 2.7 thanks to [@hotatekaoru] ([#13](https://github.com/mikamai/onesignal-ruby/pull/13))
+- Support for Rails 6 thanks to [@chrismaximin] ([#11](https://github.com/mikamai/onesignal-ruby/pull/11))
+- API call for fetching all notifications thanks to [@rgould] ([#7](https://github.com/mikamai/onesignal-ruby/pull/7))
+- CSV export thanks to [@joecorcoran] ([#6](https://github.com/mikamai/onesignal-ruby/pull/6))
+
+### Changed
+- Bump bundler to ~> 2.0
+
+## [0.3.0] - 2019-01-08
+## Added
+- Support for specific device targets for notifications, thanks to [@gabriel-dehan].
+
+## [0.2.0] - 2019-01-07
+First public release. This version is the first publicly available on [RubyGems](https://rubygems.org/gems/onesignal-ruby).
+
+[Unreleased]: https://github.com/mikamai/onesignal-ruby/compare/0.6.0...HEAD
+[0.6.0]: https://github.com/mikamai/onesignal-ruby/compare/0.5.0...0.6.0
+[0.5.0]: https://github.com/mikamai/onesignal-ruby/compare/0.4.0...0.5.0
+[0.4.0]: https://github.com/mikamai/onesignal-ruby/compare/0.3.0...0.4.0
+[0.3.0]: https://github.com/mikamai/onesignal-ruby/compare/0.2.0...0.3.0
+[0.2.0]: https://github.com/mikamai/onesignal-ruby/releases/tag/0.2.0
+
+[@chrismaximin]: https://github.com/chrismaximin
+[@gabriel-dehan]: https://github.com/gabriel-dehan
+[@hotatekaoru]: https://github.com/hotatekaoru
+[@joecorcoran]: https://github.com/joecorcoran
+[@jongirard]: https://github.com/jongirard
+[@martinjaimem]: https://github.com/martinjaimem
+[@regedarek]: https://github.com/regedarek
+[@rgould]: https://github.com/rgould
+[@reachire-smendola]: https://github.com/reachire-smendola

data/README.md

@@ -2,7 +2,7 @@
 [![Gem Version](https://badge.fury.io/rb/onesignal-ruby.svg)](https://badge.fury.io/rb/onesignal-ruby)
 [![CircleCI](https://circleci.com/gh/mikamai/onesignal-ruby.svg?style=svg)](https://circleci.com/gh/mikamai/onesignal-ruby)
 
-A simple, pure Ruby client to the [OneSignal](https://onesignal.com/apps/22bc6dec-5150-4d6d-8628-377259d2dd14/segments) API.
+A simple, pure Ruby client to the [OneSignal Push Notification API](https://onesignal.com/). OneSignal provides a self-serve customer engagement solution for Push Notifications, Email, SMS & In-App.
 
 ## Installation
 
@@ -137,6 +137,13 @@ player = OneSignal.fetch_player(player_id)
 # => #<OneSignal::Responses::Player>
 ```
 
+### Delete players
+You can delete a single player by its ID.
+```ruby
+OneSignal.delete_player(player_id)
+#<OneSignal::Responses::Player:0x000056062f397d18 @attributes={}>
+```
+
 ### Filters
 
 Filters can be created with a simple DSL. It closely matches the [JSON reference](https://documentation.onesignal.com/reference#section-send-to-users-based-on-filters), with a few touches of syntax
@@ -192,6 +199,23 @@ included_targets = OneSignal::IncludedTargets.new(include_player_ids: 'test-id-1
 OneSignal::Notification.new(included_targets: included_targets)
 ```
 
+### Icons
+You can customize notification icons by passing a `OneSignal::Icons` object.
+```ruby
+icons = OneSignal::Icons.new(
+  small_icon: 'image URL',
+  huawei_small_icon: 'image URL',
+  large_icon: 'image URL',
+  huawei_large_icon: 'image URL',
+  adm_small_icon: 'image URL',
+  adm_large_icon: 'image URL',
+  chrome_web_icon: 'image URL',
+  firefox_icon: 'image URL',
+  chrome_icon: 'image URL'
+)
+OneSignal::Notification.new(icons: icons)
+```
+
 **WARNING**
 Passing `include_player_ids` alongside other params is prohibited and will raise an `ArgumentError`.
 Either use `include_player_ids` or use the other params.
@@ -213,6 +237,8 @@ This repo is managed following the [Git Flow](https://danielkummer.github.io/git
 - `hotfix/my-awesome-fix` are special branches dedicated to bugfixes that compromise the library functionality. They are merged
 in both master and develop and then deleted.
 
+[CHANGELOG](CHANGELOG.md) entries MUST be added for every change made to the source code.
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/fixtures/vcr_cassettes/os-delete-player.yml

@@ -0,0 +1,72 @@
+---
+http_interactions:
+- request:
+    method: delete
+    uri: https://onesignal.com/api/v1/players/?app_id
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v0.15.2
+      Content-Type:
+      - application/json
+      Authorization:
+      - Basic test
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Thu, 28 Jun 2018 15:30:58 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      Set-Cookie:
+      - __cfduid=d162ae07cbc70fafa075f6d10a6694cc61530199858; expires=Fri, 28-Jun-19
+        15:30:58 GMT; path=/; domain=.onesignal.com; HttpOnly
+      Status:
+      - 200 OK
+      Cache-Control:
+      - max-age=0, private, must-revalidate
+      Access-Control-Allow-Origin:
+      - "*"
+      X-Xss-Protection:
+      - 1; mode=block
+      X-Request-Id:
+      - 768dd4da-9f24-4a93-8a1b-3efbc3bf22b2
+      Access-Control-Allow-Headers:
+      - SDK-Version
+      Etag:
+      - W/"cee038b261c95e403233f1ada96658e3"
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-Runtime:
+      - '0.029141'
+      X-Content-Type-Options:
+      - nosniff
+      X-Powered-By:
+      - Phusion Passenger 5.3.2
+      Expect-Ct:
+      - max-age=604800, report-uri="https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct"
+      Server:
+      - cloudflare
+      Cf-Ray:
+      - 4321329ccab1430a-MXP
+    body:
+      encoding: ASCII-8BIT
+      string: '{"total_count":8,"offset":0,"limit":300,"players":[{"id":"14c8141f-d57d-4652-8911-960a00ff14fa","identifier":"52812f0ca9b3cc1c1f6a13fd1467c3a2a9f7ef3db5ee56cb951b00fb6bb78665","session_count":10,"language":"it","timezone":7200,"game_version":"1","device_os":"11.4","device_type":0,"device_model":"iPhone10,5","ad_id":"7A30EDB9-A4EA-404E-BA5E-2AEA86C74AA7","tags":{},"last_active":1530184068,"playtime":1219,"amount_spent":0.0,"created_at":1530177751,"invalid_identifier":false,"badge_count":0,"sdk":"020805","test_type":1,"ip":null},{"id":"16c0eee0-edc0-4630-8792-1c432a2e7da1","identifier":null,"session_count":2,"language":"en","timezone":7200,"game_version":"1","device_os":"7.1.2","device_type":1,"device_model":"MotoG3","ad_id":null,"tags":{},"last_active":1530192672,"playtime":0,"amount_spent":0.0,"created_at":1530192553,"invalid_identifier":true,"badge_count":0,"sdk":"030901","test_type":null,"ip":null},{"id":"066e3db6-1ed1-49f0-9340-624327e3faf8","identifier":null,"session_count":1,"language":"en","timezone":7200,"game_version":"1","device_os":"7.1.2","device_type":1,"device_model":"MotoG3","ad_id":null,"tags":{},"last_active":1530193737,"playtime":0,"amount_spent":0.0,"created_at":1530193737,"invalid_identifier":true,"badge_count":0,"sdk":"030901","test_type":null,"ip":null},{"id":"cf435718-f137-4fd8-ba43-b9ada7e88846","identifier":null,"session_count":1,"language":"en","timezone":7200,"game_version":"1","device_os":"7.1.2","device_type":1,"device_model":"MotoG3","ad_id":null,"tags":{},"last_active":1530194294,"playtime":0,"amount_spent":0.0,"created_at":1530194294,"invalid_identifier":true,"badge_count":0,"sdk":"030901","test_type":null,"ip":null},{"id":"ba4b2ab3-cc89-4bd6-8c1a-9f69e7a2aa55","identifier":null,"session_count":1,"language":"en","timezone":7200,"game_version":"1","device_os":"7.1.2","device_type":1,"device_model":"MotoG3","ad_id":null,"tags":{},"last_active":1530197017,"playtime":0,"amount_spent":0.0,"created_at":1530197017,"invalid_identifier":true,"badge_count":0,"sdk":"030901","test_type":null,"ip":null},{"id":"152c5092-beb7-4b54-a0c0-168460ff41c0","identifier":null,"session_count":1,"language":"en","timezone":0,"game_version":"1","device_os":"8.1.0","device_type":1,"device_model":"Android
+        SDK built for x86","ad_id":null,"tags":{},"last_active":1530198026,"playtime":0,"amount_spent":0.0,"created_at":1530198026,"invalid_identifier":true,"badge_count":0,"sdk":"030901","test_type":null,"ip":null},{"id":"16421e68-fa8f-4072-82db-2d2d1765c317","identifier":null,"session_count":1,"language":"en","timezone":0,"game_version":"1","device_os":"8.1.0","device_type":1,"device_model":"Android
+        SDK built for x86","ad_id":null,"tags":{},"last_active":1530198244,"playtime":0,"amount_spent":0.0,"created_at":1530198244,"invalid_identifier":true,"badge_count":0,"sdk":"030901","test_type":null,"ip":null},{"id":"e818b09c-3eca-41be-b0ee-8379cab19d93","identifier":null,"session_count":1,"language":"en","timezone":0,"game_version":"1","device_os":"8.1.0","device_type":1,"device_model":"Android
+        SDK built for x86","ad_id":null,"tags":{},"last_active":1530199447,"playtime":0,"amount_spent":0.0,"created_at":1530199447,"invalid_identifier":true,"badge_count":0,"sdk":"030901","test_type":null,"ip":null}]}'
+    http_version: 
+  recorded_at: Thu, 28 Jun 2018 15:30:58 GMT
+recorded_with: VCR 4.0.0

data/lib/onesignal/client.rb

@@ -41,6 +41,10 @@ module OneSignal
       get "players/#{player_id}"
     end
 
+    def delete_player player_id
+      delete "players/#{player_id}"
+    end
+
     def csv_export extra_fields: nil, last_active_since: nil, segment_name: nil
       post "players/csv_export?app_id=#{@app_id}", 
         extra_fields: extra_fields, 
@@ -56,6 +60,15 @@ module OneSignal
       body
     end
 
+    def delete url
+      res = @conn.delete do |req|
+        req.url url, app_id: @app_id
+        req.headers['Authorization'] = "Basic #{@api_key}"
+      end
+
+      handle_errors res
+    end
+
     def post url, body
       res = @conn.post do |req|
         req.url url

data/lib/onesignal/commands/delete_player.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module OneSignal
+  module Commands
+    class DeletePlayer < BaseCommand
+      def initialize player_id
+        @player_id = player_id
+      end
+
+      def call
+        client.delete_player @player_id
+      end
+    end
+  end
+end

data/lib/onesignal/icons.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module OneSignal
+  class Icons
+    attr_reader :small_icon, :huawei_small_icon, :large_icon, :huawei_large_icon, :adm_small_icon,
+                :adm_large_icon, :chrome_web_icon, :firefox_icon, :chrome_icon
+
+    def initialize **params
+      @small_icon = params[:small_icon]
+      @huawei_small_icon = params[:huawei_small_icon]
+      @large_icon = params[:large_icon]
+      @huawei_large_icon = params[:huawei_large_icon]
+      @adm_small_icon = params[:adm_small_icon]
+      @adm_large_icon = params[:adm_large_icon]
+      @chrome_web_icon = params[:chrome_web_icon]
+      @firefox_icon = params[:firefox_icon]
+      @chrome_icon = params[:chrome_icon]
+    end
+
+    def as_json options = nil
+      {
+        'small_icon' => @small_icon,
+        'huawei_small_icon' => @huawei_small_icon,
+        'large_icon' => @large_icon,
+        'huawei_large_icon' => @huawei_large_icon,
+        'adm_small_icon' => @adm_small_icon,
+        'adm_large_icon' => @adm_large_icon,
+        'chrome_web_icon' => @chrome_web_icon,
+        'firefox_icon' => @firefox_icon,
+        'chrome_icon' => @chrome_icon
+      }
+    end
+  end
+end

data/lib/onesignal/notification.rb

@@ -7,7 +7,7 @@ module OneSignal
   class Notification
     attr_reader :contents, :headings, :template_id, :included_segments, :excluded_segments,
                 :included_targets, :email_subject, :send_after, :attachments, :sounds, :buttons,
-                :email_body
+                :email_body, :icons, :external_id
 
     def initialize **params
       unless params.include?(:contents) || params.include?(:template_id)
@@ -27,15 +27,18 @@ module OneSignal
       @filters           = params[:filters]
       @sounds            = params[:sounds]
       @buttons           = params[:buttons]
+      @icons             = params[:icons]
+      @external_id       = params[:external_id]
     end
 
     def as_json options = {}
       super(options)
-        .except('attachments', 'sounds', 'included_targets')
+        .except('attachments', 'sounds', 'included_targets', 'icons')
         .merge(@attachments&.as_json(options) || {})
         .merge(@sounds&.as_json(options) || {})
         .merge(@buttons&.as_json(options) || {})
         .merge(@included_targets&.as_json(options) || {})
+        .merge(@icons&.as_json(options) || {})
         .select { |_k, v| v.present? }
     end
   end

data/lib/onesignal/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
 module OneSignal
-  VERSION = '0.5.0'
+  VERSION = '0.6.0'
   API_VERSION = 'v1'
 end

data/lib/onesignal.rb

@@ -59,6 +59,13 @@ module OneSignal
       Responses::Player.from_json fetched.body
     end
 
+    def delete_player player_id
+      return unless OneSignal.config.active
+
+      fetched = Commands::DeletePlayer.call player_id
+      Responses::Player.from_json fetched.body
+    end
+
     def fetch_players
       return unless OneSignal.config.active
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: onesignal-ruby
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Matteo Joliveau
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-05-17 00:00:00.000000000 Z
+date: 2021-10-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -198,10 +198,12 @@ files:
 - ".circleci/config.yml"
 - ".editorconfig"
 - ".envrc"
+- ".github/pull_request_template.md"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
 - ".ruby-version"
+- CHANGELOG.md
 - CODEOWNERS
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -211,6 +213,7 @@ files:
 - bin/console
 - bin/setup
 - fixtures/vcr_cassettes/os-csv-export.yml
+- fixtures/vcr_cassettes/os-delete-player.yml
 - fixtures/vcr_cassettes/os-fetch-noti.yml
 - fixtures/vcr_cassettes/os-fetch-notifications.yml
 - fixtures/vcr_cassettes/os-fetch-player.yml
@@ -227,12 +230,14 @@ files:
 - lib/onesignal/commands/base_command.rb
 - lib/onesignal/commands/create_notification.rb
 - lib/onesignal/commands/csv_export.rb
+- lib/onesignal/commands/delete_player.rb
 - lib/onesignal/commands/fetch_notification.rb
 - lib/onesignal/commands/fetch_notifications.rb
 - lib/onesignal/commands/fetch_player.rb
 - lib/onesignal/commands/fetch_players.rb
 - lib/onesignal/configuration.rb
 - lib/onesignal/filter.rb
+- lib/onesignal/icons.rb
 - lib/onesignal/included_targets.rb
 - lib/onesignal/notification.rb
 - lib/onesignal/notification/contents.rb