onesignal-ruby 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 754c561ba01eaaaa715c61f8f4016309679cdd0c34a5d830dd031f1e5f905a53
-  data.tar.gz: 51835e1af00b1ce9f0e1c4fcab7da9ddb5e9e94939236f11d054e8922cc6e71c
+  metadata.gz: d55ff42325f9b7c7c83a398d598df848053b95e98cb715e79b6d38355357b223
+  data.tar.gz: bdb457ba65dbd59d238bf2776167eb392f3b6deadda5d504155f17e5206cf839
 SHA512:
-  metadata.gz: 535958641b3d7bfe27eaa6509155c91d2607b0c56597d91b1eeea0956fd948404c5078385613abac1061e7722663240028fe6b6cb3c7331b843a4b05c01a49eb
-  data.tar.gz: 779675317569ebc0cde184c31be27a6b870162041ab3947870c7487974d8eb419ebb578b1df0748dc4ee054df64948017a924788de1836963a8e40107e841c6a
+  metadata.gz: 9c65cbfe1f08e453c4c23785d4fc394e51c377ba2f79b459caeed982c67720fe45fa34c435a16ca89d919e6ae82ee763b135b49227262c217cc8eac735fe0a9e
+  data.tar.gz: 4064fefacbfe49bde9f22ba865697e8b039e9b068bc474ace1d74310bceb3131a672300c22e7f9affc0552b68b6a55ab956d9872718bbba43ce47babebb15f16

data/.circleci/config.yml

@@ -0,0 +1,42 @@
+version: 2
+jobs:
+  build:
+    docker:
+      - image: circleci/ruby:2.5.1
+        environment:
+    working_directory: ~/repo
+
+    steps:
+      - checkout
+      - restore_cache:
+          name: Restore Bundle cache
+          keys:
+            - bundle-{{ checksum "Gemfile.lock" }}
+            - bundle-
+      - run:
+          name: Install dependencies
+          command: |
+            bundle install --jobs=4 --retry=3 --path vendor/bundle
+      - save_cache:
+          name: Save Bundle cache
+          paths:
+            - ./vendor/bundle
+          key: bundle-{{ checksum "Gemfile.lock" }}
+
+      - run:
+          name: Run tests
+          command: |
+            mkdir /tmp/test-results
+            TEST_FILES="$(circleci tests glob "spec/**/*_spec.rb" | circleci tests split --split-by=timings)"
+
+            bundle exec rspec --format progress \
+                            --format RspecJunitFormatter \
+                            --out /tmp/test-results/rspec.xml \
+                            --format progress \
+                            $TEST_FILES
+
+      - store_test_results:
+          path: /tmp/test-results
+      - store_artifacts:
+          path: /tmp/test-results
+          destination: test-results

data/Gemfile.lock

@@ -1,6 +1,6 @@
 GIT
   remote: https://github.com/stympy/faker.git
-  revision: 41b212d6512eae974d612af7dab593ca8ab01349
+  revision: 14599cc0f7a8bdf7b842714f776477061abda6e4
   branch: master
   specs:
     faker (1.9.1)
@@ -10,7 +10,7 @@ PATH
   remote: .
   specs:
     onesignal-ruby (0.2.0)
-      activesupport (~> 5.2, >= 5.2.2)
+      activesupport (~> 5.0, >= 5.0.0)
       faraday (~> 0.15, >= 0.15.4)
       simple_command (~> 0, >= 0.0.9)
 
@@ -53,6 +53,8 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.8.0)
     rspec-support (3.8.0)
+    rspec_junit_formatter (0.4.1)
+      rspec-core (>= 2, < 4, != 2.12.0)
     safe_yaml (1.0.4)
     simple_command (0.0.9)
     thread_safe (0.3.6)
@@ -75,6 +77,7 @@ DEPENDENCIES
   onesignal-ruby!
   rake (~> 10.0)
   rspec (~> 3.0)
+  rspec_junit_formatter (~> 0.4)
   vcr (~> 4.0, >= 4.0.0)
   webmock (~> 3.4)
 

data/README.md

@@ -1,4 +1,6 @@
 # OneSignal Ruby Client
+[![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.
 
@@ -6,7 +8,6 @@ A simple, pure Ruby client to the [OneSignal](https://onesignal.com/apps/22bc6de
 
 Add this line to your application's Gemfile:
 
-### COMING SOON (not yet published)
 ```ruby
 gem 'onesignal-ruby'
 ```
@@ -30,15 +31,20 @@ 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)
 
+It will also use an internal instance of the Ruby Logger at `INFO` level.
+
 To customize those values, call the following snippet during your
 initialization phase.
 
 ```ruby
+require 'onesignal'
+
 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
+  config.logger = Logger.new # Any Logger compliant implementation
 end
 ```
 ## Usage
@@ -66,6 +72,20 @@ Then send it.
  # => #<OneSignal::Responses::Notification> the created notification
 ```
 
+### Sending a notification to specific devices
+
+Instead of including/excluding a segment you can also target specific devices.
+```ruby
+# Setup headings and content
+
+# Select the devices
+include_player_ids = ["1dd608f2-c6a1-11e3-851d-000c2940e62c"]
+notification = OneSignal::Notification.new(headings: headings, contents: contents, include_player_ids: include_player_ids)
+```
+You can pass the followings when creating a notification: `include_player_ids: []`, `include_email_tokens: []`, `include_ios_tokens: []`, `include_wp_wns_uris: []`, `include_amazon_reg_ids: []`, `include_chrome_reg_ids: []`, `include_chrome_web_reg_ids: []`, `include_android_reg_ids: []`.
+Refer to [OneSignal's documentation](https://documentation.onesignal.com/reference#create-notification) for more information.
+
+
 ### Fetch a notification
 You can fetch an existing notification given its ID.
 ```ruby
@@ -122,7 +142,7 @@ player = OneSignal.fetch_player(player_id)
 
 ### Filters
 
-Filters can be created with a simple DSL. It closely matches the [JSON reference](), with a few touches of syntax
+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
 sugar.
 
 **Example**
@@ -146,6 +166,19 @@ Becomes
 ]
 ```
 
+The operator methods (`#lesser_than`, `#greater_than`, `#equals`, `#not_equals`) are also available through the following shorthands: `<`, `>`, `=`, `!=`.
+
+**Example**
+```ruby
+filters = [
+  OneSignal::Filter.tag('userId') == 5,
+  OneSignal::Filter.session_count < 2,
+  OneSignal::Filter.language != 'en'  
+]
+
+OneSignal::Notification.new(filters: filters)
+```
+
 ### Custom Sounds
 You can customize notification sounds by passing a `OneSignal::Sounds` object.
 ```ruby
@@ -153,6 +186,19 @@ sounds = OneSignal::Sounds.new(ios: 'ping.wav', android: 'ping')
 OneSignal::Notification.new(sounds: sounds)
 ```
 
+### Specific Targets
+If you want to send a notification only to specific targets (a particular user's email or device) you can
+pass a `OneSignal::IncludedTargets` to the notification object.
+See [the official documentation](https://documentation.onesignal.com/reference#section-send-to-specific-devices) for a list of available params.
+```ruby
+included_targets = OneSignal::IncludedTargets.new(include_player_ids: 'test-id-12345')
+OneSignal::Notification.new(included_targets: included_targets)
+```
+
+**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.
+
 ## 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.

data/fixtures/vcr_cassettes/os-fetch-noti.yml

@@ -2,7 +2,7 @@
 http_interactions:
 - request:
     method: get
-    uri: https://onesignal.com/api/v1/notifications/?app_id=22bc6dec-5150-4d6d-8628-377259d2dd14
+    uri: https://onesignal.com/api/v1/notifications/?app_id
     body:
       encoding: US-ASCII
       string: ''
@@ -12,7 +12,7 @@ http_interactions:
       Content-Type:
       - application/json
       Authorization:
-      - Basic NTc3Y2RhMTAtMjQzZC00NDIxLWE3MWUtNWU0OWM3YTVhZTlh
+      - Basic test
       Accept-Encoding:
       - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
       Accept:

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

@@ -2,7 +2,7 @@
 http_interactions:
 - request:
     method: get
-    uri: https://onesignal.com/api/v1/players/?app_id=22bc6dec-5150-4d6d-8628-377259d2dd14
+    uri: https://onesignal.com/api/v1/players/?app_id
     body:
       encoding: US-ASCII
       string: ''
@@ -12,7 +12,7 @@ http_interactions:
       Content-Type:
       - application/json
       Authorization:
-      - Basic NTc3Y2RhMTAtMjQzZC00NDIxLWE3MWUtNWU0OWM3YTVhZTlh
+      - Basic test
       Accept-Encoding:
       - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
       Accept:

data/fixtures/vcr_cassettes/os-fetch-players.yml

@@ -2,7 +2,7 @@
 http_interactions:
 - request:
     method: get
-    uri: https://onesignal.com/api/v1/players?app_id=22bc6dec-5150-4d6d-8628-377259d2dd14
+    uri: https://onesignal.com/api/v1/players?app_id
     body:
       encoding: US-ASCII
       string: ''
@@ -12,7 +12,7 @@ http_interactions:
       Content-Type:
       - application/json
       Authorization:
-      - Basic NTc3Y2RhMTAtMjQzZC00NDIxLWE3MWUtNWU0OWM3YTVhZTlh
+      - Basic test
       Accept-Encoding:
       - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
       Accept:

data/fixtures/vcr_cassettes/os-send-noti.yml

@@ -13,7 +13,7 @@ http_interactions:
       Content-Type:
       - application/json
       Authorization:
-      - Basic NTc3Y2RhMTAtMjQzZC00NDIxLWE3MWUtNWU0OWM3YTVhZTlh
+      - Basic test
       Accept-Encoding:
       - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
       Accept:
@@ -69,7 +69,7 @@ http_interactions:
   recorded_at: Thu, 28 Jun 2018 15:30:57 GMT
 - request:
     method: get
-    uri: https://onesignal.com/api/v1/notifications/29e9c2ad-41da-46f0-94c3-e71ee5c103dc?app_id=22bc6dec-5150-4d6d-8628-377259d2dd14
+    uri: https://onesignal.com/api/v1/notifications/29e9c2ad-41da-46f0-94c3-e71ee5c103dc?app_id
     body:
       encoding: US-ASCII
       string: ''

data/lib/onesignal.rb

@@ -15,24 +15,28 @@ module OneSignal
 
     def send_notification notification
       return unless OneSignal.config.active
+
       created = Commands::CreateNotification.call notification
       fetch_notification(JSON.parse(created.body)['id'])
     end
 
     def fetch_notification notification_id
       return unless OneSignal.config.active
+
       fetched = Commands::FetchNotification.call notification_id
       Responses::Notification.from_json fetched.body
     end
 
     def fetch_player player_id
       return unless OneSignal.config.active
+
       fetched = Commands::FetchPlayer.call player_id
       Responses::Player.from_json fetched.body
     end
 
     def fetch_players
       return unless OneSignal.config.active
+
       fetched = Commands::FetchPlayers.call
       JSON.parse(fetched.body)['players'].map { |player| Responses::Player.from_json player }
     end

data/lib/onesignal/client.rb

@@ -4,6 +4,8 @@ require 'faraday'
 
 module OneSignal
   class Client
+    class ApiError < RuntimeError; end
+
     def initialize app_id, api_key, api_url
       @app_id = app_id
       @api_key = api_key
@@ -42,20 +44,31 @@ module OneSignal
     end
 
     def post url, body
-      @conn.post do |req|
+      res = @conn.post do |req|
         req.url url
         req.body = create_body(body).to_json
         req.headers['Content-Type'] = 'application/json'
         req.headers['Authorization'] = "Basic #{@api_key}"
       end
+
+      handle_errors res
     end
 
     def get url
-      @conn.get do |req|
+      res = @conn.get do |req|
         req.url url, app_id: @app_id
         req.headers['Content-Type'] = 'application/json'
         req.headers['Authorization'] = "Basic #{@api_key}"
       end
+
+      handle_errors res
+    end
+
+    def handle_errors res
+      errors = JSON.parse(res.body).fetch 'errors', []
+      raise ApiError, (errors.first || "Error code #{res.status}") if res.status > 399 || errors.any?
+
+      res
     end
   end
 end

data/lib/onesignal/configuration.rb

@@ -1,14 +1,19 @@
 # frozen_string_literal: true
 
+require 'logger'
+
 module OneSignal
   class Configuration
-    attr_accessor :app_id, :api_key, :api_url, :active
+    attr_accessor :app_id, :api_key, :api_url, :active, :logger
 
     def initialize
       @app_id = ENV['ONESIGNAL_APP_ID']
       @api_key = ENV['ONESIGNAL_API_KEY']
       @api_url = "https://onesignal.com/api/#{OneSignal::API_VERSION}"
       @active = true
+      @logger = Logger.new(STDOUT).tap do |logger|
+        logger.level = Logger::INFO
+      end
     end
   end
 end

data/lib/onesignal/filter.rb

@@ -43,18 +43,18 @@ module OneSignal
         FilterBuilder.new 'app_version'
       end
 
+      def country
+        FilterBuilder.new 'country'
+      end
+
       def location radius:, lat:, long:
-        location = OpenStruct.new(radius: radius, latitude: lat, longitude: long)
-        new(FilterBuilder.new('location', location: location))
+        location = OpenStruct.new radius: radius, latitude: lat, longitude: long
+        new FilterBuilder.new('location', location: location)
       end
 
       def email email
         new(FilterBuilder.new('email', value: email))
       end
-
-      def country
-        FilterBuilder.new('country')
-      end
     end
 
     def hours_ago!
@@ -70,48 +70,56 @@ module OneSignal
     private
 
     def initialize builder
-      @field = builder.b_field
-      @key = builder.b_key
-      @relation = builder.b_relation
-      @value = builder.b_value
+      @field     = builder.b_field
+      @key       = builder.b_key
+      @relation  = builder.b_relation
+      @value     = builder.b_value
       @hours_ago = builder.b_hours_ago
-      @location = builder.b_location
+      @location  = builder.b_location
     end
 
     class FilterBuilder
       attr_reader :b_field, :b_key, :b_relation, :b_value, :b_hours_ago, :b_location
 
       def initialize field, params = {}
-        @b_field = field
-        @b_key = params[:key]
+        @b_field    = field
+        @b_key      = params[:key]
         @b_location = params[:location]
-        @b_value = params[:value]
+        @b_value    = params[:value]
       end
 
       def lesser_than value
         @b_relation = '<'
-        @b_value = value.to_s
+        @b_value    = value.to_s
         build
       end
 
+      alias < lesser_than
+
       def greater_than value
         @b_relation = '>'
-        @b_value = value.to_s
+        @b_value    = value.to_s
         build
       end
 
+      alias > greater_than
+
       def equals value
         @b_relation = '='
-        @b_value = value.to_s
+        @b_value    = value.to_s
         build
       end
 
+      alias == equals
+
       def not_equals value
         @b_relation = '!='
-        @b_value = value.to_s
+        @b_value    = value.to_s
         build
       end
 
+      alias != not_equals
+
       def exists
         @b_relation = 'exists'
         build

data/lib/onesignal/included_targets.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module OneSignal
+  class IncludedTargets
+    attr_reader :include_player_ids, :include_email_tokens, :include_external_user_ids, :include_ios_tokens,
+                :include_wp_wns_uris, :include_amazon_reg_ids, :include_chrome_reg_ids, :include_chrome_web_reg_ids,
+                :include_android_reg_ids
+
+    def initialize params
+      raise ArgumentError, 'include_player_ids cannot be used with other targets' if params.key?(:include_player_ids) && params.keys.count > 1
+
+      @include_player_ids        = params[:include_player_ids]
+      @include_email_tokens      = params[:include_email_tokens]
+      @include_external_user_ids = params[:include_external_user_ids]
+
+      @include_ios_tokens         = print_warning params, :include_ios_tokens
+      @include_wp_wns_uris        = print_warning params, :include_wp_wns_uris
+      @include_amazon_reg_ids     = print_warning params, :include_amazon_reg_ids
+      @include_chrome_reg_ids     = print_warning params, :include_chrome_reg_ids
+      @include_chrome_web_reg_ids = print_warning params, :include_chrome_web_reg_ids
+      @include_android_reg_ids    = print_warning params, :include_android_reg_ids
+    end
+
+    def print_warning params, name
+      if params.key? name
+        OneSignal.config.logger.warn "OneSignal WARNING - Use of #{name} is not recommended. " \
+        'Use either include_player_ids, include_email_tokens or include_external_user_ids. ' \
+        'See https://documentation.onesignal.com/reference#section-send-to-specific-devices'
+      end
+      params[name]
+    end
+
+    def as_json options = nil
+      {
+        'include_player_ids'         => @include_player_ids,
+        'include_email_tokens'       => @include_email_tokens,
+        'include_external_user_ids'  => @include_external_user_ids,
+        'include_ios_tokens'         => @include_ios_tokens,
+        'include_wp_wns_uris'        => @include_wp_wns_uris,
+        'include_amazon_reg_ids'     => @include_amazon_reg_ids,
+        'include_chrome_reg_ids'     => @include_chrome_reg_ids,
+        'include_chrome_web_reg_ids' => @include_chrome_web_reg_ids,
+        'include_android_reg_ids'    => @include_android_reg_ids
+      }
+    end
+  end
+end

data/lib/onesignal/notification.rb

@@ -6,29 +6,31 @@ require 'onesignal/notification/headings'
 module OneSignal
   class Notification
     attr_reader :contents, :headings, :template_id, :included_segments, :excluded_segments,
-                :send_after, :attachments, :sounds
+                :included_targets, :send_after, :attachments, :sounds
 
     def initialize **params
       unless params.include?(:contents) || params.include?(:template_id)
         raise ArgumentError, 'missing contents or template_id'
       end
 
-      @contents = params[:contents]
-      @headings = params[:headings]
-      @template_id = params[:template_id]
+      @contents          = params[:contents]
+      @headings          = params[:headings]
+      @template_id       = params[:template_id]
       @included_segments = params[:included_segments]
       @excluded_segments = params[:excluded_segments]
-      @send_after = params[:send_after].to_s
-      @attachments = params[:attachments]
-      @filters = params[:filters]
-      @sounds = params[:sounds]
+      @included_targets  = params[:included_targets]
+      @send_after        = params[:send_after].to_s
+      @attachments       = params[:attachments]
+      @filters           = params[:filters]
+      @sounds            = params[:sounds]
     end
 
     def as_json options = {}
       super(options)
-        .except('attachments', 'sounds')
+        .except('attachments', 'sounds', 'included_targets')
         .merge(@attachments&.as_json(options) || {})
         .merge(@sounds&.as_json(options) || {})
+        .merge(@included_targets&.as_json(options) || {})
         .select { |_k, v| v.present? }
     end
   end

data/lib/onesignal/sounds.rb

@@ -24,7 +24,7 @@ module OneSignal
 
     private
 
-    REGEX = /.*.\.\w*/
+    REGEX = /.*.\.\w*/.freeze
 
     def validate ios: nil, windows: nil
       ios_valid = !ios.nil? && (REGEX =~ ios).nil?

data/lib/onesignal/version.rb

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

data/onesignal-ruby.gemspec

@@ -38,10 +38,11 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'factory_bot', '~> 4.11'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rspec_junit_formatter', '~> 0.4'
   spec.add_development_dependency 'vcr', '~> 4.0', '>= 4.0.0'
   spec.add_development_dependency 'webmock', '~> 3.4'
 
-  spec.add_runtime_dependency 'activesupport', '~> 5.2', '>= 5.2.2'
+  spec.add_runtime_dependency 'activesupport', '~> 5.0', '>= 5.0.0'
   spec.add_runtime_dependency 'faraday', '~> 0.15', '>= 0.15.4'
   spec.add_runtime_dependency 'simple_command', '~> 0', '>= 0.0.9'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: onesignal-ruby
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Matteo Joliveau
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-01-07 00:00:00.000000000 Z
+date: 2019-01-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -80,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
 - !ruby/object:Gem::Dependency
   name: vcr
   requirement: !ruby/object:Gem::Requirement
@@ -120,20 +134,20 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '5.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.2.2
+        version: 5.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '5.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.2.2
+        version: 5.0.0
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
@@ -181,6 +195,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".circleci/config.yml"
 - ".editorconfig"
 - ".gitignore"
 - ".rspec"
@@ -211,6 +226,7 @@ files:
 - lib/onesignal/commands/fetch_players.rb
 - lib/onesignal/configuration.rb
 - lib/onesignal/filter.rb
+- lib/onesignal/included_targets.rb
 - lib/onesignal/notification.rb
 - lib/onesignal/notification/contents.rb
 - lib/onesignal/notification/headings.rb