onesignal-ruby 0.2.0

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,13 @@
+# 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.attr_reader(*self.class::ATTRIBUTES_WHITELIST)
+      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,22 @@
+# frozen_string_literal: true
+
+module OneSignal
+  class Segment
+    ALL_USERS = 'All'
+    ACTIVE_USERS = 'Active Users'
+    ENGAGED_USERS = 'Engaged Users'
+    INACTIVE_USERS = 'Inactive 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*/
+
+    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.2.0'
+  API_VERSION = 'v1'
+end

data/onesignal-ruby.gemspec

@@ -0,0 +1,47 @@
+# 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          = 'onesignal-ruby'
+  spec.version       = OneSignal::VERSION
+  spec.authors       = ['Matteo Joliveau']
+  spec.email         = ['matteo.joliveau@mikamai.com']
+
+  spec.summary       = 'Ruby wrapper to OneSignal API'
+  spec.description   = 'Ruby wrapper to OneSignal API, mapping to Plain Old Ruby Objects'
+  spec.homepage      = 'https://github.com/mikamai/onesignal-ruby'
+  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', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  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 'faraday', '~> 0.15', '>= 0.15.4'
+  spec.add_runtime_dependency 'simple_command', '~> 0', '>= 0.0.9'
+end

metadata

@@ -0,0 +1,251 @@
+--- !ruby/object:Gem::Specification
+name: onesignal-ruby
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Matteo Joliveau
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-01-07 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: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.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: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.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.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.2
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.15.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.15.4
+- !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: Ruby wrapper to OneSignal API, mapping to Plain Old Ruby Objects
+email:
+- matteo.joliveau@mikamai.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".editorconfig"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- fixtures/vcr_cassettes/os-fetch-noti.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/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/fetch_notification.rb
+- lib/onesignal/commands/fetch_player.rb
+- lib/onesignal/commands/fetch_players.rb
+- lib/onesignal/configuration.rb
+- lib/onesignal/filter.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/notification.rb
+- lib/onesignal/responses/player.rb
+- lib/onesignal/segment.rb
+- lib/onesignal/sounds.rb
+- lib/onesignal/version.rb
+- onesignal-ruby.gemspec
+homepage: https://github.com/mikamai/onesignal-ruby
+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: []
+rubyforge_project: 
+rubygems_version: 2.7.7
+signing_key: 
+specification_version: 4
+summary: Ruby wrapper to OneSignal API
+test_files: []