onesignal-ruby 0.3.0 → 0.4.0

data/lib/onesignal.rb

@@ -27,6 +27,31 @@ module OneSignal
       Responses::Notification.from_json fetched.body
     end
 
+    def fetch_notifications(page_limit: 50, page_offset: 0, kind: nil)
+      return unless OneSignal.config.active
+
+      Enumerator.new() do |yielder|
+        limit = page_limit
+        offset = page_offset
+
+        fetched = Commands::FetchNotifications.call limit, offset, kind
+        parsed = JSON.parse(fetched.body)
+
+        total_count = parsed["total_count"]
+        max_pages = (total_count / limit.to_f).ceil
+
+        loop do
+          parsed['notifications'].each do |notification|
+            yielder << Responses::Notification.from_json(notification)
+          end
+          offset += 1
+          break if offset >= max_pages
+          fetched = Commands::FetchNotifications.call limit, offset*limit, kind
+          parsed = JSON.parse(fetched.body)
+        end
+      end
+    end
+
     def fetch_player player_id
       return unless OneSignal.config.active
 
@@ -41,6 +66,13 @@ module OneSignal
       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

data/lib/onesignal/buttons.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module OneSignal
+  class Buttons
+    attr_reader :buttons
+
+    def initialize buttons: nil
+      @buttons = buttons
+    end
+
+    def as_json options = nil
+      {
+        'buttons' => @buttons.as_json(options),
+      }
+    end
+  end
+end

data/lib/onesignal/client.rb

@@ -27,6 +27,12 @@ module OneSignal
       get "notifications/#{notification_id}"
     end
 
+    def fetch_notifications page_limit: 50, page_offset: 0, kind: nil
+      url = "notifications?limit=#{page_limit}&offset=#{page_offset}"
+      url = kind ? "#{url}&kind=#{kind}" : url
+      get url
+    end
+
     def fetch_players
       get 'players'
     end
@@ -35,10 +41,17 @@ module OneSignal
       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
+      body = payload.as_json.delete_if { |_, v| v.nil? }
       body['app_id'] = @app_id
       body
     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_notifications.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module OneSignal
+  module Commands
+    class FetchNotifications < BaseCommand
+      def initialize page_limit, page_offset, kind
+        @page_limit = page_limit
+        @page_offset = page_offset
+        @kind = kind
+      end
+
+      def call
+        client.fetch_notifications page_limit: @page_limit, page_offset: @page_offset, kind: @kind
+      end
+    end
+  end
+end

data/lib/onesignal/notification.rb

@@ -6,7 +6,7 @@ require 'onesignal/notification/headings'
 module OneSignal
   class Notification
     attr_reader :contents, :headings, :template_id, :included_segments, :excluded_segments,
-                :included_targets, :send_after, :attachments, :sounds
+                :included_targets, :send_after, :attachments, :sounds, :buttons
 
     def initialize **params
       unless params.include?(:contents) || params.include?(:template_id)
@@ -23,6 +23,7 @@ module OneSignal
       @attachments       = params[:attachments]
       @filters           = params[:filters]
       @sounds            = params[:sounds]
+      @buttons           = params[:buttons]
     end
 
     def as_json options = {}
@@ -30,6 +31,7 @@ module OneSignal
         .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

data/lib/onesignal/notification/contents.rb

@@ -10,7 +10,7 @@ module OneSignal
 
       def initialize en:, **content
         @content = content.merge(en: en)
-        create_readers @content
+        create_readers **@content
       end
     end
   end

data/lib/onesignal/notification/headings.rb

@@ -10,7 +10,7 @@ module OneSignal
 
       def initialize en:, **headings
         @headings = headings.merge(en: en)
-        create_readers @headings
+        create_readers **@headings
       end
     end
   end

data/lib/onesignal/responses/base_response.rb

@@ -6,7 +6,12 @@ module OneSignal
       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)
+
+        self.class::ATTRIBUTES_WHITELIST.each do |attribute|
+          self.class.send(:define_method, attribute) do
+            @attributes[attribute]
+          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/segment.rb

@@ -6,6 +6,7 @@ module OneSignal
     ACTIVE_USERS = 'Active Users'
     ENGAGED_USERS = 'Engaged Users'
     INACTIVE_USERS = 'Inactive Users'
+    SUBSCRIBED_USERS = 'Subscribed Users'
 
     def initialize name:
       @name = name

data/lib/onesignal/version.rb

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

data/onesignal-ruby.gemspec

@@ -33,16 +33,16 @@ Gem::Specification.new do |spec|
   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 'bundler', '~> 2.0'
   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 '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', '>= 5.0.0'
+  spec.add_runtime_dependency 'activesupport', '>= 5.0.0', '< 7'
   spec.add_runtime_dependency 'faraday', '~> 0.15', '>= 0.15.4'
   spec.add_runtime_dependency 'simple_command', '~> 0', '>= 0.0.9'
 end

data/shell.nix

@@ -0,0 +1,7 @@
+with import <nixpkgs> {};
+
+ pkgs.mkShell {
+   buildInputs = [
+     ruby_2_7
+  ];
+ }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: onesignal-ruby
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Matteo Joliveau
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-01-08 00:00:00.000000000 Z
+date: 2021-01-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: dotenv
   requirement: !ruby/object:Gem::Requirement
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -132,22 +132,22 @@ dependencies:
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.0'
     - - ">="
       - !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'
     - - ">="
       - !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
@@ -197,18 +197,22 @@ extra_rdoc_files: []
 files:
 - ".circleci/config.yml"
 - ".editorconfig"
+- ".envrc"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
+- ".ruby-version"
+- 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
@@ -216,12 +220,15 @@ files:
 - 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
@@ -233,12 +240,14 @@ files:
 - 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
+- shell.nix
 homepage: https://github.com/mikamai/onesignal-ruby
 licenses:
 - MIT
@@ -259,8 +268,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Ruby wrapper to OneSignal API

data/Gemfile.lock

@@ -1,85 +0,0 @@
-GIT
-  remote: https://github.com/stympy/faker.git
-  revision: 14599cc0f7a8bdf7b842714f776477061abda6e4
-  branch: master
-  specs:
-    faker (1.9.1)
-      i18n (>= 0.7)
-
-PATH
-  remote: .
-  specs:
-    onesignal-ruby (0.2.0)
-      activesupport (~> 5.0, >= 5.0.0)
-      faraday (~> 0.15, >= 0.15.4)
-      simple_command (~> 0, >= 0.0.9)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    activesupport (5.2.2)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-    addressable (2.5.2)
-      public_suffix (>= 2.0.2, < 4.0)
-    concurrent-ruby (1.1.4)
-    crack (0.4.3)
-      safe_yaml (~> 1.0.0)
-    diff-lcs (1.3)
-    dotenv (2.6.0)
-    factory_bot (4.11.1)
-      activesupport (>= 3.0.0)
-    faraday (0.15.4)
-      multipart-post (>= 1.2, < 3)
-    hashdiff (0.3.8)
-    i18n (1.5.1)
-      concurrent-ruby (~> 1.0)
-    minitest (5.11.3)
-    multipart-post (2.0.0)
-    public_suffix (3.0.3)
-    rake (10.5.0)
-    rspec (3.8.0)
-      rspec-core (~> 3.8.0)
-      rspec-expectations (~> 3.8.0)
-      rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.0)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.2)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.0)
-      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)
-    tzinfo (1.2.5)
-      thread_safe (~> 0.1)
-    vcr (4.0.0)
-    webmock (3.5.1)
-      addressable (>= 2.3.6)
-      crack (>= 0.3.2)
-      hashdiff
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler (~> 1.16)
-  dotenv (~> 2.5)
-  factory_bot (~> 4.11)
-  faker!
-  onesignal-ruby!
-  rake (~> 10.0)
-  rspec (~> 3.0)
-  rspec_junit_formatter (~> 0.4)
-  vcr (~> 4.0, >= 4.0.0)
-  webmock (~> 3.4)
-
-BUNDLED WITH
-   1.16.2