onesignal-ruby 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 754c561ba01eaaaa715c61f8f4016309679cdd0c34a5d830dd031f1e5f905a53
+  data.tar.gz: 51835e1af00b1ce9f0e1c4fcab7da9ddb5e9e94939236f11d054e8922cc6e71c
+SHA512:
+  metadata.gz: 535958641b3d7bfe27eaa6509155c91d2607b0c56597d91b1eeea0956fd948404c5078385613abac1061e7722663240028fe6b6cb3c7331b843a4b05c01a49eb
+  data.tar.gz: 779675317569ebc0cde184c31be27a6b870162041ab3947870c7487974d8eb419ebb578b1df0748dc4ee054df64948017a924788de1836963a8e40107e841c6a

data/.editorconfig

@@ -0,0 +1,14 @@
+# editorconfig.org
+
+root = true
+
+[*]
+charset = utf-8
+insert_final_newline = true
+trim_trailing_whitespace = true
+end_of_line = lf
+indent_style = space
+indent_size = 2
+
+[*.md]
+trim_trailing_whitespace = false

data/.gitignore

@@ -0,0 +1,17 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+.idea/
+*.iml
+.env
+.env.*
+*.gem

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,182 @@
+AllCops:
+  # Cop names are not displayed in offense messages by default. Change behavior
+  # by overriding DisplayCopNames, or by giving the `-D/--display-cop-names`
+  # option.
+  DisplayCopNames: true
+
+  # Style guide URLs are not displayed in offense messages by default. Change
+  # behavior by overriding `DisplayStyleGuide`, or by giving the
+  # `-S/--display-style-guide` option.
+  DisplayStyleGuide: true
+
+  # Extra details are not displayed in offense messages by default. Change
+  # behavior by overriding ExtraDetails, or by giving the
+  # `-E/--extra-details` option.
+  ExtraDetails: true
+
+  # What MRI version of the Ruby interpreter is the inspected code intended to
+  # run on? (If there is more than one, set this to the lowest version.)
+  # If a value is specified for TargetRubyVersion then it is used.
+  # Else if .ruby-version exists and it contains an MRI version it is used.
+  # Otherwise we fallback to the oldest officially supported Ruby version (2.1).
+  TargetRubyVersion: 2.4
+
+# Align the elements of a hash literal if they span more than one line.
+Layout/AlignHash:
+  # Alignment of entries using hash rocket as separator. Valid values are:
+  #
+  # key - left alignment of keys
+  #   'a' => 2
+  #   'bb' => 3
+  # separator - alignment of hash rockets, keys are right aligned
+  #    'a' => 2
+  #   'bb' => 3
+  # table - left alignment of keys, hash rockets, and values
+  #   'a'  => 2
+  #   'bb' => 3
+  EnforcedHashRocketStyle: table
+  SupportedHashRocketStyles:
+    - key
+    - separator
+    - table
+  # Alignment of entries using colon as separator. Valid values are:
+  #
+  # key - left alignment of keys
+  #   a: 0
+  #   bb: 1
+  # separator - alignment of colons, keys are right aligned
+  #    a: 0
+  #   bb: 1
+  # table - left alignment of keys and values
+  #   a:  0
+  #   bb: 1
+  EnforcedColonStyle: table
+  SupportedColonStyles:
+    - key
+    - separator
+    - table
+  # Select whether hashes that are the last argument in a method call should be
+  # inspected? Valid values are:
+  #
+  # always_inspect - Inspect both implicit and explicit hashes.
+  #   Registers an offense for:
+  #     function(a: 1,
+  #       b: 2)
+  #   Registers an offense for:
+  #     function({a: 1,
+  #       b: 2})
+  # always_ignore - Ignore both implicit and explicit hashes.
+  #   Accepts:
+  #     function(a: 1,
+  #       b: 2)
+  #   Accepts:
+  #     function({a: 1,
+  #       b: 2})
+  # ignore_implicit - Ignore only implicit hashes.
+  #   Accepts:
+  #     function(a: 1,
+  #       b: 2)
+  #   Registers an offense for:
+  #     function({a: 1,
+  #       b: 2})
+  # ignore_explicit - Ignore only explicit hashes.
+  #   Accepts:
+  #     function({a: 1,
+  #       b: 2})
+  #   Registers an offense for:
+  #     function(a: 1,
+  #       b: 2)
+  EnforcedLastArgumentHashStyle: ignore_implicit
+  SupportedLastArgumentHashStyles:
+    - always_inspect
+    - always_ignore
+    - ignore_implicit
+    - ignore_explicit
+
+Layout/EndOfLine:
+  # The `native` style means that CR+LF (Carriage Return + Line Feed) is
+  # enforced on Windows, and LF is enforced on other platforms. The other styles
+  # mean LF and CR+LF, respectively.
+  EnforcedStyle: lf
+  SupportedStyles:
+    - native
+    - lf
+    - crlf
+
+Style/BlockDelimiters:
+  EnforcedStyle: braces_for_chaining
+  SupportedStyles:
+    # The `line_count_based` style enforces braces around single line blocks and
+    # do..end around multi-line blocks.
+    - line_count_based
+    # The `semantic` style enforces braces around functional blocks, where the
+    # primary purpose of the block is to return a value and do..end for
+    # procedural blocks, where the primary purpose of the block is its
+    # side-effects.
+    #
+    # This looks at the usage of a block's method to determine its type (e.g. is
+    # the result of a `map` assigned to a variable or passed to another
+    # method) but exceptions are permitted in the `ProceduralMethods`,
+    # `FunctionalMethods` and `IgnoredMethods` sections below.
+    - semantic
+    # The `braces_for_chaining` style enforces braces around single line blocks
+    # and do..end around multi-line blocks, except for multi-line blocks whose
+    # return value is being chained with another method (in which case braces
+    # are enforced).
+    - braces_for_chaining
+
+Style/Documentation:
+  Enabled: false
+
+Style/MethodDefParentheses:
+  EnforcedStyle: require_no_parentheses
+  SupportedStyles:
+    - require_parentheses
+    - require_no_parentheses
+    - require_no_parentheses_except_multiline
+
+Style/RedundantReturn:
+  # When `true` allows code like `return x, y`.
+  AllowMultipleReturnValues: true
+
+Style/Semicolon:
+  # Allow `;` to separate several expressions on the same line.
+  AllowAsExpressionSeparator: true
+
+Metrics/BlockLength:
+  Exclude:
+    - "**/*_spec.rb"
+
+Metrics/LineLength:
+  Max: 100
+  # To make it possible to copy or click on URIs in the code, we allow lines
+  # containing a URI to be longer than Max.
+  AllowHeredoc: true
+  AllowURI: true
+  URISchemes:
+    - http
+    - https
+    - ftp
+  # The IgnoreCopDirectives option causes the LineLength rule to ignore cop
+  # directives like '# rubocop: enable ...' when calculating a line's length.
+  IgnoreCopDirectives: false
+  # The IgnoredPatterns option is a list of !ruby/regexp and/or string
+  # elements. Strings will be converted to Regexp objects. A line that matches
+  # any regular expression listed in this option will be ignored by LineLength.
+  IgnoredPatterns: []
+
+# Align ends correctly.
+Lint/EndAlignment:
+  # The value `keyword` means that `end` should be aligned with the matching
+  # keyword (`if`, `while`, etc.).
+  # The value `variable` means that in assignments, `end` should be aligned
+  # with the start of the variable on the left hand side of `=`. In all other
+  # situations, `end` should still be aligned with the keyword.
+  # The value `start_of_line` means that `end` should be aligned with the start
+  # of the line which the matching keyword appears on.
+  EnforcedStyleAlignWith: variable
+  SupportedStylesAlignWith:
+    - keyword
+    - variable
+    - start_of_line
+  AutoCorrect: false

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at matteo.joliveau@mikamai.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in onesignal-ruby.gemspec
+gemspec
+
+group :test do
+  gem 'faker', git: 'https://github.com/stympy/faker.git', branch: 'master'
+end

data/Gemfile.lock

@@ -0,0 +1,82 @@
+GIT
+  remote: https://github.com/stympy/faker.git
+  revision: 41b212d6512eae974d612af7dab593ca8ab01349
+  branch: master
+  specs:
+    faker (1.9.1)
+      i18n (>= 0.7)
+
+PATH
+  remote: .
+  specs:
+    onesignal-ruby (0.2.0)
+      activesupport (~> 5.2, >= 5.2.2)
+      faraday (~> 0.15, >= 0.15.4)
+      simple_command (~> 0, >= 0.0.9)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (5.2.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    concurrent-ruby (1.1.4)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.3)
+    dotenv (2.6.0)
+    factory_bot (4.11.1)
+      activesupport (>= 3.0.0)
+    faraday (0.15.4)
+      multipart-post (>= 1.2, < 3)
+    hashdiff (0.3.8)
+    i18n (1.5.1)
+      concurrent-ruby (~> 1.0)
+    minitest (5.11.3)
+    multipart-post (2.0.0)
+    public_suffix (3.0.3)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    safe_yaml (1.0.4)
+    simple_command (0.0.9)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    vcr (4.0.0)
+    webmock (3.5.1)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  dotenv (~> 2.5)
+  factory_bot (~> 4.11)
+  faker!
+  onesignal-ruby!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  vcr (~> 4.0, >= 4.0.0)
+  webmock (~> 3.4)
+
+BUNDLED WITH
+   1.16.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Mikamai
+
+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:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+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

@@ -0,0 +1,179 @@
+# OneSignal Ruby Client
+
+A simple, pure Ruby client to the [OneSignal](https://onesignal.com/apps/22bc6dec-5150-4d6d-8628-377259d2dd14/segments) API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+### COMING SOON (not yet published)
+```ruby
+gem 'onesignal-ruby'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install onesignal-ruby
+
+## Configuration
+OneSignal requires an App ID and an API Key, which can be found
+on the OneSignal dashboard.
+By default, OneSignal Ruby looks for them in the environment, loading
+`ONESIGNAL_APP_ID` and `ONESIGNAL_API_KEY` variables.
+
+It also defaults to `https://onesignal.com/api/v1` as the API URL.
+
+You can also turn off OneSignal entirely with a boolean flag (for example to avoid sending
+notification while in test or development environments)
+
+To customize those values, call the following snippet during your
+initialization phase.
+
+```ruby
+OneSignal.configure do |config|
+  config.app_id = 'my_app_id'
+  config.api_key = 'my_api_key'
+  config.api_url = 'http://my_api_url'
+  config.active = false
+end
+```
+## Usage
+
+### Create a notification
+
+Create a `Notification` object.
+```ruby
+# Create headings for different languages. English is required.
+headings = OneSignal::Notification::Headings.new(en: 'Hello!', it: 'Ciao!')
+
+# Create contents for different languages. English is required.
+contents = OneSignal::Notification::Contents.new(en: "I'm a notification!", it: 'Sono una notifica!')
+
+# Select the included (and/or excluded) segments to target
+included_segments = [OneSignal::Segment::ACTIVE_USERS, 'My custom segment']
+
+# Create the Notification object
+notification = OneSignal::Notification.new(headings: headings, contents: contents, included_segments: included_segments)
+```
+
+Then send it.
+```ruby
+ response = OneSignal.send_notification(notification)
+ # => #<OneSignal::Responses::Notification> the created notification
+```
+
+### Fetch a notification
+You can fetch an existing notification given its ID.
+```ruby
+response = OneSignal.fetch_notification(notification_id)
+# => #<OneSignal::Responses::Notification> the created notification
+```
+`OneSignal::Responses::Notification` has the following fields.
+```ruby
+id            # Notification UUID
+successful    # Number of successful deliveries
+failed        # Number of failed deliveries
+converted     # Number of users who have clicked / tapped on your notification.
+remaining     # Number of notifications that have not been sent out yet
+queued_at     # Unix timestamp of enqueuing time
+send_after    # Unix timestamp indicating when notification delivery should begin
+completed_at  # Unix timestamp indicating when notification delivery completed.
+url           # URL associated with the notification
+data          # Custom metadata
+canceled      # Boolean, has the notification been canceled
+headings      # Map of locales to title strings
+contents      # Map of locales to content strings
+
+response.id # => fe82c1ae-54c2-458b-8aad-7edc3e8a96c4
+```
+
+### Attachments
+You can add files, data or images to a notification, or an external URL to open.
+```ruby
+attachments = OneSignal::Attachments.new(
+      data:            { 'test' => 'test' },
+      url:             'http://example.com',
+      ios_attachments: { 'something' => 'drawable resource name or URL.' },
+      android_picture: 'drawable resource name or URL.',
+      amazon_picture:  'drawable resource name or URL.',
+      chrome_picture:  'drawable resource name or URL.'
+)
+
+OneSignal::Notification.new(attachments: attachments)
+```
+
+### Fetch players
+You can fetch all players and devices with a simple method.
+
+```ruby
+players = OneSignal.fetch_players
+# => Array of OneSignal::Responses::Player
+```
+
+Or you can fetch a single player by its ID.
+```ruby
+player = OneSignal.fetch_player(player_id)
+# => #<OneSignal::Responses::Player>
+```
+
+### Filters
+
+Filters can be created with a simple DSL. It closely matches the [JSON reference](), with a few touches of syntax
+sugar.
+
+**Example**
+```ruby
+filters = [
+  OneSignal::Filter.last_session.lesser_than(2).hours_ago!,
+  OneSignal::Filter.session_count.equals(5),
+  OneSignal::Filter::OR,
+  OneSignal::Filter.country.equals('IT')
+]
+
+OneSignal::Notification.new(filters: filters)
+```
+Becomes
+```json
+[
+  {"field":"last_session","relation":"<","hours_ago":"2"},
+  {"field":"session_count","relation":"=","value":"5"},
+  {"operator":"OR"},
+  {"field":"country","relation":"=","value":"IT"}
+]
+```
+
+### Custom Sounds
+You can customize notification sounds by passing a `OneSignal::Sounds` object.
+```ruby
+sounds = OneSignal::Sounds.new(ios: 'ping.wav', android: 'ping')
+OneSignal::Notification.new(sounds: sounds)
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/mikamai/onesignal-ruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+This repo is managed following the [Git Flow](https://danielkummer.github.io/git-flow-cheatsheet/) principles.
+- `master` is the stable, production-ready branch. Never work directly on it. The gem is published from this branch.
+- `develop` is the active development branch. It is supposed to be somewhat stable. Every new feature is merged here once completed, before being released to master.
+- `feature/my-awesome-branch` are personal, dedicated branches for working on actual features. They are merged in develop once completed and then deleted.
+- `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.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the OneSignal Ruby project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](CODE_OF_CONDUCT.md).