onesignal-ruby-rails6 0.3.0.1

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

@@ -0,0 +1,72 @@
+---
+http_interactions:
+- request:
+    method: get
+    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/fixtures/vcr_cassettes/os-fetch-players.yml

@@ -0,0 +1,72 @@
+---
+http_interactions:
+- request:
+    method: get
+    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=db617b0b45cf8c5a16bdbc61edef5a1a81530199858; 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:
+      - 1dbdac59-c104-4c1d-9e92-428badf0dacf
+      Access-Control-Allow-Headers:
+      - SDK-Version
+      Etag:
+      - W/"cee038b261c95e403233f1ada96658e3"
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-Runtime:
+      - '0.051957'
+      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:
+      - 4321329b4893434c-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/fixtures/vcr_cassettes/os-send-noti.yml

@@ -0,0 +1,145 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://onesignal.com/api/v1/notifications
+    body:
+      encoding: UTF-8
+      string: '{"contents":{"en":"Live Test"},"headings":{"en":"This is a live test
+        for OneSignal"},"included_segments":["Active Users"],"app_id":"22bc6dec-5150-4d6d-8628-377259d2dd14"}'
+    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:57 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      Set-Cookie:
+      - __cfduid=daaa29327ffbbadef32c14c4f68e2ddcc1530199857; expires=Fri, 28-Jun-19
+        15:30:57 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:
+      - 12e56155-1b2a-4ae2-9c43-959cf76d1219
+      Access-Control-Allow-Headers:
+      - SDK-Version
+      Etag:
+      - W/"dcc6500f0081d2c4c38f7f6490657d92"
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-Runtime:
+      - '0.067198'
+      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:
+      - 432132947a73430a-MXP
+    body:
+      encoding: ASCII-8BIT
+      string: '{"id":"29e9c2ad-41da-46f0-94c3-e71ee5c103dc","recipients":1}'
+    http_version: 
+  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
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v0.15.2
+      Content-Type:
+      - application/json
+      Authorization:
+      - Basic NTc3Y2RhMTAtMjQzZC00NDIxLWE3MWUtNWU0OWM3YTVhZTlh
+      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:57 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      Set-Cookie:
+      - __cfduid=daaa29327ffbbadef32c14c4f68e2ddcc1530199857; expires=Fri, 28-Jun-19
+        15:30:57 GMT; path=/; domain=.onesignal.com; HttpOnly
+      Status:
+      - 200 OK
+      Cache-Control:
+      - public, max-age=7200
+      Access-Control-Allow-Origin:
+      - "*"
+      X-Xss-Protection:
+      - 1; mode=block
+      X-Request-Id:
+      - 713da936-b783-4ff4-aae6-4ec89a5e9ef7
+      Access-Control-Allow-Headers:
+      - SDK-Version
+      Etag:
+      - W/"8e772220e2df249cd3a196949cc81bfa"
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-Runtime:
+      - '0.016556'
+      X-Content-Type-Options:
+      - nosniff
+      X-Powered-By:
+      - Phusion Passenger 5.3.2
+      Cf-Cache-Status:
+      - MISS
+      Vary:
+      - Accept-Encoding
+      Expires:
+      - Thu, 28 Jun 2018 17:30:57 GMT
+      Expect-Ct:
+      - max-age=604800, report-uri="https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct"
+      Server:
+      - cloudflare
+      Cf-Ray:
+      - 432132961c5b430a-MXP
+    body:
+      encoding: ASCII-8BIT
+      string: '{"adm_big_picture":null,"adm_group":null,"adm_group_message":null,"adm_large_icon":null,"adm_small_icon":null,"adm_sound":null,"spoken_text":null,"alexa_ssml":null,"alexa_display_title":null,"amazon_background_data":null,"android_accent_color":null,"android_group":null,"android_group_message":null,"android_led_color":null,"android_sound":null,"android_visibility":null,"app_id":"22bc6dec-5150-4d6d-8628-377259d2dd14","big_picture":null,"buttons":null,"canceled":false,"chrome_big_picture":null,"chrome_icon":null,"chrome_web_icon":null,"chrome_web_image":null,"chrome_web_badge":null,"content_available":null,"contents":{"en":"Live
+        Test"},"converted":0,"data":null,"delayed_option":null,"delivery_time_of_day":null,"errored":0,"excluded_segments":[],"failed":0,"firefox_icon":null,"headings":{"en":"This
+        is a live test for OneSignal"},"id":"29e9c2ad-41da-46f0-94c3-e71ee5c103dc","include_player_ids":null,"included_segments":["Active
+        Users"],"ios_badgeCount":null,"ios_badgeType":null,"ios_category":null,"ios_sound":null,"apns_alert":null,"isAdm":false,"isAndroid":true,"isChrome":false,"isChromeWeb":false,"isAlexa":false,"isFirefox":false,"isIos":true,"isSafari":false,"isWP":false,"isWP_WNS":false,"isEdge":false,"large_icon":null,"priority":null,"queued_at":1530199857,"remaining":1,"send_after":1530199857,"completed_at":null,"small_icon":null,"successful":0,"tags":null,"filters":null,"template_id":null,"ttl":null,"url":null,"web_buttons":null,"web_push_topic":null,"wp_sound":null,"wp_wns_sound":null}'
+    http_version: 
+  recorded_at: Thu, 28 Jun 2018 15:30:57 GMT
+recorded_with: VCR 4.0.0

data/lib/onesignal.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require 'active_support/core_ext/string'
+require 'active_support/json'
+require 'onesignal/version'
+require 'onesignal/commands'
+
+ActiveSupport.escape_html_entities_in_json = false
+
+module OneSignal
+  class << self
+    def configure
+      yield config
+    end
+
+    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
+
+    def csv_export params = {}
+      return unless OneSignal.config.active
+
+      fetched = Commands::CsvExport.call params
+      Responses::CsvExport.from_json fetched.body
+    end
+
+    def config
+      @config ||= Configuration.new
+    end
+
+    alias define configure
+  end
+end
+
+require 'onesignal/autoloader'
+require 'onesignal/responses'

data/lib/onesignal/attachments.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module OneSignal
+  class Attachments
+    attr_reader :data, :url, :ios_attachments, :android_picture, :amazon_picture, :chrome_picture
+
+    def initialize data: nil, url: nil, ios_attachments: nil, android_picture: nil, amazon_picture: nil, chrome_picture: nil
+      @data = data
+      @url = url
+      @ios_attachments = ios_attachments
+      @android_picture = android_picture
+      @amazon_picture = amazon_picture
+      @chrome_picture = chrome_picture
+    end
+
+    def as_json options = nil
+      {
+        'data'               => @data.as_json(options),
+        'url'                => @url,
+        'ios_attachments'    => @ios_attachments.as_json(options),
+        'big_picture'        => @android_picture,
+        'adm_big_picture'    => @amazon_picture,
+        'chrome_big_picture' => @chrome_picture
+      }
+    end
+  end
+end

data/lib/onesignal/auto_map.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module OneSignal
+  module AutoMap
+    def create_readers **attributes
+      attributes.keys.each do |k|
+        self.class.define_method k do
+          attributes[k]
+        end
+      end
+    end
+  end
+end

data/lib/onesignal/autoloader.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+Dir["#{File.expand_path(__dir__)}/*.rb"].each do |file|
+  filename  = File.basename file
+  classname = filename.split('.rb').first.camelize
+  OneSignal.autoload classname, File.expand_path("../#{filename}", __FILE__)
+end

data/lib/onesignal/client.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+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
+      @api_url = api_url
+      @conn = ::Faraday.new(url: api_url) do |faraday|
+        # faraday.response :logger do |logger|
+        #   logger.filter(/(api_key=)(\w+)/, '\1[REMOVED]')
+        #   logger.filter(/(Basic )(\w+)/, '\1[REMOVED]')
+        # end
+        faraday.adapter Faraday.default_adapter
+      end
+    end
+
+    def create_notification notification
+      post 'notifications', notification
+    end
+
+    def fetch_notification notification_id
+      get "notifications/#{notification_id}"
+    end
+
+    def fetch_players
+      get 'players'
+    end
+
+    def fetch_player player_id
+      get "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, 
+        last_active_since: last_active_since&.to_i&.to_s, 
+        segment_name: segment_name
+    end
+
+    private
+
+    def create_body payload
+      body = payload.as_json.delete_if { |_, v| v.nil? }
+      body['app_id'] = @app_id
+      body
+    end
+
+    def post url, body
+      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
+      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