one_signal 1.2.1 → 1.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6312a5c7e29a88416dec30655471bcec898cc6e99cdcbfa85951898bb596b595
-  data.tar.gz: 398a5d3096deab33d3aba362f31d700f0dbc260fd2afa18cf389cacacc1b933e
+  metadata.gz: a0ecf8297187f5f593675815585d362c3a8c4c99c6af50bbf709023a3f14f042
+  data.tar.gz: 1f934153151a37c760d740c681566af64dc0b30b2ad06f2074395c79289aba7f
 SHA512:
-  metadata.gz: a391445498ec397d1eec346775468bd5b3c45591e282bd934cdb77067c6cde5f365346725138659b53c94ba253e9e5fe0f44b788741898308535904483d55a76
-  data.tar.gz: 8b59c80ece8b59017c54b6b512cbf350815f0db51ff272eb143272eb690560f9a51112c9a87782e4d682a717459520d617cc49cfb43a6ae3b95ce4843611213c
+  metadata.gz: 6b5248740e5a2ee2f456faff1f9641d3d37d9535d6bb826050beff88900f608eb7c7bf794bbffa9f65454acdc4966412645ef029995051c53b7e58a8ce341cca
+  data.tar.gz: b962c34e169b1751e88126d66ce7f964e0199859ec5ce2856b25ef3a7f758e5cea3209067286006418a94769ca1259d95d234c41450244b851a876c63a77ac88

data/.github/workflows/gem-push.yml

@@ -0,0 +1,30 @@
+name: Ruby Gem
+
+on:
+  workflow_dispatch:
+
+jobs:
+  build:
+    name: Build + Publish
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby 2.6
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.6.x
+
+    - name: Publish to RubyGems
+      run: |
+        mkdir -p $HOME/.gem
+        touch $HOME/.gem/credentials
+        chmod 0600 $HOME/.gem/credentials
+        printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+        gem build *.gemspec
+        gem push *.gem
+      env:
+        GEM_HOST_API_KEY: "${{secrets.RUBYGEMS_AUTH_TOKEN}}"

data/CHANGELOG.txt

@@ -1,3 +1,7 @@
+=== 1.2.2 2021-09-02
+
+* Fix delete a player method to include `params` argument: https://github.com/tbalthazar/onesignal-ruby/pull/20
+
 === 1.2.1 2021-09-01
 
 * Add a method to delete a player: https://github.com/tbalthazar/onesignal-ruby/pull/18
@@ -16,7 +20,7 @@
 
 === 0.0.14 2016-02-22
 
-* Change ruby required version from 2.2.0 to 2.1.0 
+* Change ruby required version from 2.2.0 to 2.1.0
 
 === 0.0.13 2016-02-18
 

data/README.md

@@ -12,19 +12,22 @@ gem install one_signal
 
 ## Development
 
+Run `bin/setup` to install dependencies and set your API keys.
+
 Run the tests
 
 ```
 bundle exec rake
 ```
 
+You can also run `bin/console` for an interactive prompt that will allow you to experiment with authenticated library methods.
+
 ## Basic usage
 
-See basic examples in [example.rb](/example.rb).
+See some basic examples in [example.rb](/example.rb).
 To run it:
-- rename [.env.example](/.env.example) into `.env`
-- set your `USER_AUTH_KEY` and `API_KEY` in the `.env` file
-- run `ruby example.rb`
+- run `bin/setup` to set your API keys
+- then run `ruby example.rb`
 
 ## Documentation
 
@@ -81,6 +84,7 @@ The return value of each method is a `Net::HTTPResponse`.
 - OneSignal::Player.create_purchase(id:, params:)
 - OneSignal::Player.create_focus(id:, params:)
 - OneSignal::Player.update(id:, params:)
+- OneSignal::Player.delete(id:, params:)
 ```
 
 ### Notifications
@@ -103,4 +107,4 @@ They are [listed here](https://github.com/tbalthazar/onesignal-ruby/graphs/contr
 
 ## License
 
-Please see [LICENSE](/LICENSE) for licensing details. 
+Please see [LICENSE](/LICENSE) for licensing details.

data/bin/console

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "dotenv/load"
+require "one_signal"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+OneSignal::OneSignal.user_auth_key = ENV['USER_AUTH_KEY']
+OneSignal::OneSignal.api_key = ENV['API_KEY']
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,18 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+echo "Enter your OneSignal credentials."
+echo "For dealing with Apps, you'll need a user auth key."
+read -p 'User Auth Key: ' user_auth_key
+echo "For dealing with Players and Notifications, you'll need an API key."
+read -p 'API Key: ' api_key
+
+cp .env.example .env
+
+sed -i '' -e "s/YOUR_USER_AUTH_KEY_HERE/$user_auth_key/g" .env
+sed -i '' -e "s/YOUR_API_KEY_HERE/$api_key/g" .env
+
+echo "Done."

data/lib/one_signal/player.rb

@@ -154,7 +154,7 @@ module OneSignal
       return response
     end
 
-    def self.delete(id: "", opts: {})
+    def self.delete(id: "", params: {}, opts: {})
       opts[:auth_key] ||= @@api_key
 
       uri_string = @@base_uri
@@ -162,7 +162,7 @@ module OneSignal
       uri_string += "/#{id}"
       uri = URI.parse(uri_string)
 
-      response = send_delete_request(uri: uri, params: nil, opts: opts)
+      response = send_delete_request(uri: uri, params: params, opts: opts)
 
       ensure_http_status(response: response,
                          status: '200',

data/lib/one_signal/version.rb

@@ -1,3 +1,3 @@
 module OneSignal
-  VERSION = '1.2.1'
+  VERSION = '1.2.2'
 end

data/test/player_test.rb

@@ -198,17 +198,20 @@ class PlayerTest < MiniTest::Test
   def test_delete
     response = mock_response_ok
     OneSignal::OneSignal.expects(:send_delete_request)
-                        .with(uri: @delete_uri, params: nil, opts: @default_opts)
+                        .with(uri: @delete_uri, params: @params, opts: @default_opts)
                         .returns(response)
-    assert_equal response, OneSignal::Player.delete(id: @player_id)
+    assert_equal response, OneSignal::Player.delete(id: @player_id,
+                                                    params: @params)
   end
 
   def test_delete_with_auth_key
     response = mock_response_ok
     OneSignal::OneSignal.expects(:send_delete_request)
-                        .with(uri: @delete_uri, params: nil, opts: @opts)
+                        .with(uri: @delete_uri, params: @params, opts: @opts)
                         .returns(response)
-    assert_equal response, OneSignal::Player.delete(id: @player_id, opts: @opts)
+    assert_equal response, OneSignal::Player.delete(id: @player_id,
+                                                    params: @params,
+                                                    opts: @opts)
   end
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: one_signal
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.2.2
 platform: ruby
 authors:
 - Thomas Balthazar
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-09-01 00:00:00.000000000 Z
+date: 2021-09-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -74,12 +74,15 @@ extra_rdoc_files: []
 files:
 - ".env.example"
 - ".github/workflows/ci.yml"
+- ".github/workflows/gem-push.yml"
 - ".gitignore"
 - CHANGELOG.txt
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
+- bin/console
+- bin/setup
 - example.rb
 - lib/one_signal.rb
 - lib/one_signal/app.rb
@@ -99,7 +102,7 @@ homepage: https://github.com/tbalthazar/onesignal-ruby
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -114,8 +117,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.15
-signing_key:
+rubygems_version: 3.0.3.1
+signing_key: 
 specification_version: 4
 summary: A library which implements the OneSignal API
 test_files: []