onesignal-ruby-rails6 0.3.0.1

data/lib/onesignal/commands.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module OneSignal
+  module Commands
+    require 'onesignal/commands/autoloader'
+  end
+end

data/lib/onesignal/commands/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::Commands.autoload classname, File.expand_path("../#{filename}", __FILE__)
+end

data/lib/onesignal/commands/base_command.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'simple_command'
+
+module OneSignal
+  module Commands
+    class BaseCommand
+      prepend ::SimpleCommand
+
+      def call
+        raise NotImplementedError, 'this is an abstract class'
+      end
+
+      def client
+        @client ||= OneSignal::Client.new(config.app_id, config.api_key, config.api_url)
+      end
+
+      def config
+        OneSignal.config
+      end
+    end
+  end
+end

data/lib/onesignal/commands/create_notification.rb

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

data/lib/onesignal/commands/csv_export.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module OneSignal
+  module Commands
+    class CsvExport < BaseCommand
+      def initialize params
+        @params = params || {}
+      end
+
+      def call
+        client.csv_export @params
+      end
+    end
+  end
+end

data/lib/onesignal/commands/fetch_notification.rb

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

data/lib/onesignal/commands/fetch_player.rb

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

data/lib/onesignal/commands/fetch_players.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module OneSignal
+  module Commands
+    class FetchPlayers < BaseCommand
+      def call
+        client.fetch_players
+      end
+    end
+  end
+end

data/lib/onesignal/configuration.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'logger'
+
+module OneSignal
+  class Configuration
+    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

@@ -0,0 +1,140 @@
+# frozen_string_literal: true
+
+module OneSignal
+  class Filter
+    OR = { operator: 'OR' }.freeze
+
+    attr_reader :field, :key, :relation, :value, :hours_ago, :location
+
+    class << self
+      def last_session
+        FilterBuilder.new 'last_session'
+      end
+
+      def first_session
+        FilterBuilder.new 'first_session'
+      end
+
+      def session_count
+        FilterBuilder.new 'session_count'
+      end
+
+      def session_time
+        FilterBuilder.new 'session_time'
+      end
+
+      def amount_spent
+        FilterBuilder.new 'amount_spent'
+      end
+
+      def bought_sku sku
+        FilterBuilder.new 'bought_sku', key: sku
+      end
+
+      def tag tag
+        FilterBuilder.new 'tag', key: tag
+      end
+
+      def language
+        FilterBuilder.new 'language'
+      end
+
+      def app_version
+        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)
+      end
+
+      def email email
+        new(FilterBuilder.new('email', value: email))
+      end
+    end
+
+    def hours_ago!
+      @hours_ago ||= @value
+      @value = nil
+      self
+    end
+
+    def as_json options = nil
+      super(options).select { |_k, v| v.present? }
+    end
+
+    private
+
+    def initialize builder
+      @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
+    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_location = params[:location]
+        @b_value    = params[:value]
+      end
+
+      def lesser_than value
+        @b_relation = '<'
+        @b_value    = value.to_s
+        build
+      end
+
+      alias < lesser_than
+
+      def greater_than value
+        @b_relation = '>'
+        @b_value    = value.to_s
+        build
+      end
+
+      alias > greater_than
+
+      def equals value
+        @b_relation = '='
+        @b_value    = value.to_s
+        build
+      end
+
+      alias == equals
+
+      def not_equals value
+        @b_relation = '!='
+        @b_value    = value.to_s
+        build
+      end
+
+      alias != not_equals
+
+      def exists
+        @b_relation = 'exists'
+        build
+      end
+
+      def not_exists
+        @b_relation = 'not_exists'
+        build
+      end
+
+      private
+
+      def build
+        Filter.new self
+      end
+    end
+  end
+end

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

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require 'onesignal/notification/contents'
+require 'onesignal/notification/headings'
+
+module OneSignal
+  class Notification
+    attr_reader :contents, :headings, :template_id, :included_segments, :excluded_segments,
+                :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]
+      @included_segments = params[:included_segments]
+      @excluded_segments = params[:excluded_segments]
+      @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', '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
+end

data/lib/onesignal/notification/contents.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module OneSignal
+  class Notification
+    class Contents
+      include OneSignal::AutoMap
+      extend Forwardable
+
+      def_delegators :@content, :as_json, :to_json
+
+      def initialize en:, **content
+        @content = content.merge(en: en)
+        create_readers @content
+      end
+    end
+  end
+end

data/lib/onesignal/notification/headings.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module OneSignal
+  class Notification
+    class Headings
+      include OneSignal::AutoMap
+      extend Forwardable
+
+      def_delegators :@headings, :as_json, :to_json
+
+      def initialize en:, **headings
+        @headings = headings.merge(en: en)
+        create_readers @headings
+      end
+    end
+  end
+end

data/lib/onesignal/responses.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module OneSignal
+  module Responses
+    require 'onesignal/responses/autoloader'
+  end
+end

data/lib/onesignal/responses/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::Responses.autoload classname, File.expand_path("../#{filename}", __FILE__)
+end

data/lib/onesignal/responses/base_response.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module OneSignal
+  module Responses
+    class BaseResponse
+      def initialize attributes = {}
+        @attributes = attributes.deep_symbolize_keys
+                                .keep_if { |k, _v| self.class::ATTRIBUTES_WHITELIST.include?(k.to_sym) }
+
+        self.class::ATTRIBUTES_WHITELIST.each do |attribute|
+          self.class.send(:define_method, attribute) do
+            @attributes[attribute]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/onesignal/responses/csv_export.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module OneSignal
+  module Responses
+    # Example JSON
+    # {
+    #   "csv_file_url": "https://onesignal.s3.amazonaws.com/csv_exports/test/users_abc123.csv.gz"
+    # }
+    class CsvExport < BaseResponse
+      ATTRIBUTES_WHITELIST = %i[csv_file_url].freeze
+
+      def self.from_json json
+        body = json.is_a?(String) ? JSON.parse(json) : json
+        new(body)
+      end
+    end
+  end
+end