ones-ruby-msm 0.3.1

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,39 @@
+# 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, :buttons
+
+    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]
+      @buttons           = params[:buttons]
+    end
+
+    def as_json options = {}
+      super(options)
+        .except('attachments', 'sounds', 'included_targets')
+        .merge(@attachments&.as_json(options) || {})
+        .merge(@sounds&.as_json(options) || {})
+        .merge(@buttons&.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

data/lib/onesignal/responses/notification.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module OneSignal
+  module Responses
+    # Example JSON
+    # {
+    #   "id":           '481a2734-6b7d-11e4-a6ea-4b53294fa671',
+    #   "successful":   15,
+    #   "failed":       1,
+    #   "converted":    3,
+    #   "remaining":    0,
+    #   "queued_at":    1_415_914_655,
+    #   "send_after":   1_415_914_655,
+    #   "completed_at": 1_415_914_656,
+    #   "url":          'https://yourWebsiteToOpen.com',
+    #   "data":         {
+    #     "foo":  'bar',
+    #     "your": 'custom metadata'
+    #   },
+    #   "canceled":     false,
+    #   "headings":     {
+    #     "en": 'English and default language heading',
+    #     "es": 'Spanish language heading'
+    #   },
+    #   "contents":     {
+    #     "en": 'English language content',
+    #     "es": 'Hola'
+    #   }
+    # }
+    class Notification < BaseResponse
+      ATTRIBUTES_WHITELIST = %i[id successful failed converted remaining
+                                queued_at send_after completed_at url data
+                                canceled headings contents].freeze
+
+      def canceled?
+        canceled
+      end
+
+      def self.from_json json
+        body = json.is_a?(String) ? JSON.parse(json) : json
+        new(body)
+      end
+    end
+  end
+end

data/lib/onesignal/responses/player.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module OneSignal
+  module Responses
+    class Player < BaseResponse
+      ATTRIBUTES_WHITELIST = %i[id identifier session_count language timezone
+                                game_version device_os device_type device_model tags
+                                ad_id last_active playtime amount_spent created_at
+                                invalid_identifier badge_count sdk test_type ip].freeze
+
+      def invalid_identifier?
+        invalid_identifier
+      end
+
+      def self.from_json json
+        body = json.is_a?(String) ? JSON.parse(json) : json
+        new(body)
+      end
+    end
+  end
+end

data/lib/onesignal/segment.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module OneSignal
+  class Segment
+    ALL_USERS = 'All'
+    ACTIVE_USERS = 'Active Users'
+    ENGAGED_USERS = 'Engaged Users'
+    INACTIVE_USERS = 'Inactive Users'
+    SUBSCRIBED_USERS = 'Subscribed Users'
+
+    def initialize name:
+      @name = name
+    end
+
+    def as_json _options = nil
+      @name.to_s
+    end
+
+    def to_s
+      @name.to_s
+    end
+  end
+end

data/lib/onesignal/sounds.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module OneSignal
+  class Sounds
+    attr_reader :ios, :android, :amazon, :windows
+
+    def initialize ios: nil, android: nil, amazon: nil, windows: nil
+      validate ios: ios, windows: windows
+
+      @ios = ios
+      @android = android
+      @amazon = amazon
+      @windows = windows
+    end
+
+    def as_json options = nil
+      {
+        'ios_sound'     => @ios.as_json(options),
+        'android_sound' => @android.as_json(options),
+        'adm_sound'     => @amazon.as_json(options),
+        'wp_wns_sound'  => @windows.as_json(options)
+      }
+    end
+
+    private
+
+    REGEX = /.*.\.\w*/.freeze
+
+    def validate ios: nil, windows: nil
+      ios_valid = !ios.nil? && (REGEX =~ ios).nil?
+      windows_valid = !windows.nil? && (REGEX =~ windows).nil?
+      raise InvalidError, "provide file extension for iOS: #{ios}" if ios_valid
+      raise InvalidError, "provide file extension for windows: #{ios}" if windows_valid
+    end
+  end
+
+  class InvalidError < StandardError
+  end
+end

data/lib/onesignal/version.rb

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

data/onesignal-ruby.gemspec

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'onesignal/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'ones-ruby-msm'
+  spec.version       = OneSignal::VERSION
+  spec.authors       = ['Daniel Wetteroth']
+  spec.email         = ['danielcw@gmail.com']
+
+  spec.summary       = 'OneSignal Wrapper'
+  spec.description   = 'Test Fix version Ruby wrapper to OneSignal API, mapping to Plain Old Ruby Objects'
+  # spec.homepage      = 'https://github.com/mi'
+  spec.license       = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+      'public gem pushes.'
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'dotenv', '~> 2.5'
+  spec.add_development_dependency 'factory_bot', '~> 4.11'
+  spec.add_development_dependency 'rake', '~> 13.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.0.0', '< 7'
+  spec.add_runtime_dependency 'faraday', '~>1.1.0'  #'~> 0.15', '>= 0.15.4'
+  spec.add_runtime_dependency 'simple_command', '~> 0', '>= 0.0.9'
+end

metadata

@@ -0,0 +1,268 @@
+--- !ruby/object:Gem::Specification
+name: ones-ruby-msm
+version: !ruby/object:Gem::Version
+  version: 0.3.1
+platform: ruby
+authors:
+- Daniel Wetteroth
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2020-11-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+- !ruby/object:Gem::Dependency
+  name: factory_bot
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !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
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+- !ruby/object:Gem::Dependency
+  name: simple_command
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.9
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.9
+description: Test Fix version Ruby wrapper to OneSignal API, mapping to Plain Old
+  Ruby Objects
+email:
+- danielcw@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".circleci/config.yml"
+- ".editorconfig"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- CODEOWNERS
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- fixtures/vcr_cassettes/os-csv-export.yml
+- fixtures/vcr_cassettes/os-fetch-noti.yml
+- fixtures/vcr_cassettes/os-fetch-notifications.yml
+- fixtures/vcr_cassettes/os-fetch-player.yml
+- fixtures/vcr_cassettes/os-fetch-players.yml
+- fixtures/vcr_cassettes/os-send-noti.yml
+- lib/onesignal.rb
+- lib/onesignal/attachments.rb
+- lib/onesignal/auto_map.rb
+- lib/onesignal/autoloader.rb
+- lib/onesignal/buttons.rb
+- lib/onesignal/client.rb
+- lib/onesignal/commands.rb
+- lib/onesignal/commands/autoloader.rb
+- lib/onesignal/commands/base_command.rb
+- lib/onesignal/commands/create_notification.rb
+- lib/onesignal/commands/csv_export.rb
+- lib/onesignal/commands/fetch_notification.rb
+- lib/onesignal/commands/fetch_notifications.rb
+- lib/onesignal/commands/fetch_player.rb
+- 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
+- lib/onesignal/responses.rb
+- lib/onesignal/responses/autoloader.rb
+- lib/onesignal/responses/base_response.rb
+- lib/onesignal/responses/csv_export.rb
+- lib/onesignal/responses/notification.rb
+- lib/onesignal/responses/player.rb
+- lib/onesignal/segment.rb
+- lib/onesignal/sounds.rb
+- lib/onesignal/version.rb
+- onesignal-ruby.gemspec
+homepage:
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.6
+signing_key:
+specification_version: 4
+summary: OneSignal Wrapper
+test_files: []