ionic_notification 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ee5e9c16fb782a621dd32fbf84f5c9e86ed03af7
+  data.tar.gz: 32401e6b956423a974c4e8d319e84809aa77e7c4
+SHA512:
+  metadata.gz: cb6f1768764d9f270806c68d8e4bfd6fb60859d84767ffcb7951ed534848ee36aa4a5c4f6a983bdb2634981b4b4395032c20154bf37428091378944f6196609f
+  data.tar.gz: 5bd12f0054420bae6aff470221eb1e2dc6e62056e4ef6fb368b846e241e62a772912bd83ff4dfdf3897b85da00177e843da110a091efd89aaff010eb90cea70a

data/MIT-LICENSE

@@ -0,0 +1,22 @@
+Copyright 2015 Francesco Renzi
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+This internal project started from the code base of nwwatson `ionic_push_repo`

data/Rakefile

@@ -0,0 +1,34 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'IonicNotification'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/lib/generators/ionic_notification/install/install_generator.rb

@@ -0,0 +1,16 @@
+require 'rails/generators'
+
+module IonicNotification
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+
+      source_root File.expand_path('../templates', __FILE__)
+
+      desc "Generates IonicNotification initializer"
+
+      def copy_config
+        copy_file "ionic_notification.rb", "config/initializers/ionic_notification.rb"
+      end
+    end
+  end
+end

data/lib/generators/ionic_notification/install/templates/ionic_notification.rb

@@ -0,0 +1,58 @@
+IonicNotification.setup do |config|
+  # ==> Configuration for the Ionic.io Application ID
+  # The Application ID can be found on the dashboard of
+  # https://apps.ionic.io/apps
+  config.ionic_application_id = ENV["IONIC_APPLICATION_ID"]
+
+  # ==> Configuration for the Ionic API Key
+  # The  API Key for your application can be found
+  # within the Settings of your application on
+  # https://apps.ionic.io/apps
+  config.ionic_api_key = ENV["IONIC_API_KEY"]
+
+  # Your Ionic app name will be used for the notification
+  # title if none is provided. If you leave this undefined
+  # IonicNotification will use your Rails app name
+  config.ionic_app_name = Rails.application.class.parent_name
+
+  # If you want, you can customize IonicNotification logging level
+  # It defaults to :debug
+  # config.log_level = :debug
+  #
+  # You can change the amount of stored sent notifications
+  # config.notification_store_limit = 3
+  #
+  # By default, notifications with no message provided will be skipped,
+  # you don't want your clients to receive a notification with no message,
+  # right? Well, sometimes it can be useful to speed up development
+  # and test. You could like to be able to do something like:
+  #   User.first.notify
+  # and see what happens, without bothering writing a fake message.
+  # You can enable this if you want:
+  # config.process_empty_messages = true
+  # Or in a more safe way:
+  # config.process_empty_messages = !Rails.env.production?
+  #
+  # Anyway, you can set up a default message to be used when you don't
+  # provide one:
+  # config.default_message = "This was intended to be a beautiful notification. Unfortunately, you're not qualified to read it."
+
+  # If production is set to true, notifications will be sent
+  # to all devices which have your app running with production
+  # certificates (generally coming from store). Otherwise,
+  # if set to false, to all devices which have your app running
+  # with developer certificates.
+  config.ionic_app_in_production = true
+  # If you want a more flexible solution, you can
+  # uncomment this, so that notifications will be sent
+  # to "production devices" only while Rails app is running
+  # in production environment
+  # config.ionic_app_in_production = Rails.env.production?
+
+  # ==> Configuration for the location of the API
+  # Refer to the Ionic documentation for the correct location
+  # Current documentation can be found here:
+  # http://docs.ionic.io/docs/push-sending-push and
+  # defaults to https://push.ionic.io
+  # config.ionic_api_url = ENV["IONIC_API_URL"]
+end

data/lib/generators/ionic_notification/model/model_generator.rb

@@ -0,0 +1,34 @@
+require 'rails/generators'
+require 'rails/generators/active_record'
+require 'generators/ionic_notification/orm_helpers'
+
+module IonicNotification
+  module Generators
+    class ModelGenerator < ActiveRecord::Generators::Base
+
+      include IonicNotification::Generators::OrmHelpers
+      source_root File.expand_path('../templates', __FILE__)
+
+      desc "Generates a migration for the given MODEL, adding :device_tokens column"
+
+      def copy_migration
+        migration_template "migration.rb", "db/migrate/add_device_tokens_to_#{table_name}.rb"
+      end
+
+      def inject_ionic_notification_content
+        content = model_contents
+
+        class_path = if namespaced?
+          class_name.to_s.split("::")
+        else
+          [class_name]
+        end
+
+        indent_depth = class_path.size - 1
+        content = content.split("\n").map { |line| "  " * indent_depth + line } .join("\n") << "\n"
+
+        inject_into_class(model_path, class_path.last, content)
+      end
+    end
+  end
+end

data/lib/generators/ionic_notification/model/templates/migration.rb

@@ -0,0 +1,9 @@
+class AddDeviceTokensTo<%= table_name.camelize %> < ActiveRecord::Migration
+  def self.up
+    add_column :<%= table_name %>, :device_tokens, :text
+  end
+
+  def down
+    remove_column :<%= table_name %>, :device_tokens
+  end
+end

data/lib/generators/ionic_notification/orm_helpers.rb

@@ -0,0 +1,33 @@
+module IonicNotification
+  module Generators
+    module OrmHelpers
+      def model_contents
+        buffer = <<-CONTENT
+  # Include IonicNotification behaviour
+  include IonicNotification::Concerns::IonicNotificable
+
+
+CONTENT
+        buffer
+      end
+
+      private
+
+      def model_exists?
+        File.exists?(File.join(destination_root, model_path))
+      end
+
+      def migration_exists?(table_name)
+        Dir.glob("#{File.join(destination_root, migration_path)}/[0-9]*_*.rb").grep(/\d+_add_devise_to_#{table_name}.rb$/).first
+      end
+
+      def migration_path
+        @migration_path ||= File.join("db", "migrate")
+      end
+
+      def model_path
+        @model_path ||= File.join("app", "models", "#{file_path}.rb")
+      end
+    end
+  end
+end

data/lib/ionic_notification.rb

@@ -0,0 +1,63 @@
+require 'rails'
+require 'httparty'
+
+module IonicNotification
+  # Registered application if for the ionic platform
+  mattr_accessor :ionic_application_id
+  @@ionic_application_id = ""
+
+  # Private key for sending information
+  mattr_accessor :ionic_api_key
+  @@ionic_api_key = ""
+
+  # Application name
+  mattr_accessor :ionic_app_name
+  @@ionic_app_name = Rails.application.class.parent_name
+
+  # Is application in production
+  mattr_accessor :ionic_app_in_production
+  @@ionic_app_in_production = true
+
+  # Send notification even if it has no message
+  mattr_accessor :process_empty_messages
+  @@process_empty_messages = false
+
+  # Default message for notifications
+  mattr_accessor :default_message
+  @@default_message = "This was intended to be a beautiful notification. Unfortunately, you're not qualified to read it."
+
+  # Logging level
+  mattr_accessor :log_level
+  @@log_level = :debug
+
+  # Array that stores latest X sent notifications
+  mattr_accessor :latest_notifications
+  @@latest_notifications = []
+
+  # Array that stores latest X sent notifications
+  mattr_accessor :notification_store_limit
+  @@notification_store_limit = 3
+
+  # API URL
+  mattr_accessor :ionic_api_url
+  @@ionic_api_url = "https://push.ionic.io"
+
+  def self.setup
+    yield self
+  end
+
+  def self.store(notification)
+    if latest_notifications.count >= notification_store_limit
+      latest_notifications.shift
+    end
+    latest_notifications << notification
+  end
+end
+
+require "ionic_notification/logger"
+require "ionic_notification/push_service"
+require "ionic_notification/status_service"
+require "ionic_notification/notification"
+require "ionic_notification/sent_notification"
+require "ionic_notification/exceptions"
+require "ionic_notification/concerns/ionic_notificable"

data/lib/ionic_notification/concerns/ionic_notificable.rb

@@ -0,0 +1,46 @@
+module IonicNotification
+  module Concerns
+    module IonicNotificable
+      extend ActiveSupport::Concern
+
+      included do
+        serialize :device_tokens, Array
+
+        def notify(options = {})
+          logger = self.class.new_logger
+          return logger.missing_device_tokens unless respond_to?(:device_tokens)
+          tokens = device_tokens.uniq
+          return logger.no_device_tokens(self) unless tokens.count > 0
+          notification = IonicNotification::Notification.new(options.merge!(tokens: tokens))
+          notification.send
+        end
+
+        def notify_at(schedule, options = {})
+          options.merge!(scheduled: schedule.to_time.to_i)
+          notify options
+        end
+
+        def notify_in(delay, options = {})
+          schedule = Time.now + delay
+          options.merge!(scheduled: schedule.to_i)
+          notify options
+        end
+
+        def self.notify_all(options = {})
+          logger = new_logger
+          return logger.missing_device_tokens unless method_defined?(:device_tokens)
+          tokens = all.map(&:device_tokens).flatten.uniq
+          return logger.no_device_tokens(self) unless tokens.count > 0
+          notification = IonicNotification::Notification.new(options.merge!(tokens: tokens))
+          notification.send
+        end
+
+        private
+
+        def self.new_logger
+          IonicNotification::Logger.new
+        end
+      end
+    end
+  end
+end

data/lib/ionic_notification/exceptions.rb

@@ -0,0 +1,35 @@
+module IonicNotification
+  class WrongTokenType < StandardError
+    def initialize(klazz = nil)
+      return complete_message(klazz) if klazz
+      default_message
+    end
+
+    private
+
+    def default_message
+      "Wrong type of tokens provided."
+    end
+
+    def complete_message(klazz)
+      "Wrong type of tokens provided. String and Array are accepted, #{klazz} was given."
+    end
+  end
+
+  class WrongPayloadType < StandardError
+    def initialize(klazz = nil)
+      return complete_message(klazz) if klazz
+      default_message
+    end
+
+    private
+
+    def default_message
+      "Wrong type of payload provided."
+    end
+
+    def complete_message(klazz)
+      "Wrong type of payload provided. Hash is accepted, #{klazz} was given."
+    end
+  end
+end

data/lib/ionic_notification/logger.rb

@@ -0,0 +1,42 @@
+module IonicNotification
+  class Logger
+    def no_device_tokens(instance)
+      return unless available?
+      ionic_logger "#{logger_label} No device tokens were found for #{instance}, skipping."
+    end
+
+    def missing_device_tokens
+      return unless available?
+      ionic_logger "#{logger_label} This model does not respond to :device_tokens, did you run your migrations?"
+    end
+
+    def empty_message
+      return unless available?
+      ionic_logger "#{logger_label} WARNING! You tried to send a notification with empty message, but you wisely chose not to allow this practice."
+    end
+
+    def logger_label
+      "IonicNotification:"
+    end
+
+    private
+
+    def ionic_logger(message)
+      Rails.logger.send(IonicNotification.log_level, message)
+      nil
+    end
+
+    def available_log_levels
+      [:debug, :info, :warn, :error, :fatal, :unknown]
+    end
+
+    def available?
+      if available_log_levels.include? IonicNotification.log_level
+        true
+      else
+        Rails.logger.fatal "#{logger_label} The specified log level is not available!"
+        false
+      end
+    end
+  end
+end

data/lib/ionic_notification/notification.rb

@@ -0,0 +1,82 @@
+module IonicNotification
+  class Notification
+    attr_accessor :tokens, :title, :message, :android_payload,
+      :ios_payload, :production, :scheduled
+
+    def initialize(options = {})
+      @message_provided = options[:message]
+
+      @tokens = init_tokens(options[:tokens])
+      @title ||= options[:title] || default_title
+      @message ||= options[:message] || default_message
+
+      if options[:android_payload]
+        @android_payload ||= assign_payload(options[:android_payload])
+      end
+
+      if options[:ios_payload]
+        @ios_payload ||= assign_payload(options[:ios_payload])
+      end
+
+      if options[:payload]
+        @android_payload ||= assign_payload(options[:payload])
+        @ios_payload ||= assign_payload(options[:payload])
+      end
+
+      @android_payload ||= default_payload
+      @ios_payload ||= default_payload
+
+      @scheduled = options[:scheduled]
+
+      @production = options[:production] || init_production
+    end
+
+    def send
+      if @message_provided || IonicNotification.process_empty_messages
+        service = PushService.new self
+        service.notify!
+      else
+        self.class.new_logger.empty_message
+      end
+    end
+
+    private
+
+    def self.new_logger
+      IonicNotification::Logger.new
+    end
+
+    def init_tokens(tokens)
+      case tokens
+      when Array
+        tokens
+      when String
+        [tokens]
+      else
+        raise IonicNotification::WrongTokenType.new(tokens.class)
+      end
+    end
+
+    def default_title
+      IonicNotification.ionic_app_name
+    end
+
+    def default_message
+      IonicNotification.default_message
+    end
+
+    def default_payload
+      { payload: {} }
+    end
+
+    def init_production
+      IonicNotification.ionic_app_in_production || false
+    end
+
+    def assign_payload(payload)
+      return default_payload unless payload
+      return { payload: payload } if payload.is_a? Hash
+      raise IonicNotification::WrongPayloadType.new(payload.class)
+    end
+  end
+end

data/lib/ionic_notification/push_service.rb

@@ -0,0 +1,62 @@
+module IonicNotification
+  class PushService
+    include HTTParty
+    base_uri IonicNotification.ionic_api_url
+
+    attr_accessor :body
+
+    def initialize(notification)
+      @notification = notification
+    end
+
+    def notify!
+      resp = self.class.post("/api/v1/push", payload)
+      IonicNotification.store(sent_notification(resp))
+    end
+
+    def payload
+      options = {}
+      options.merge!(body: body).
+        merge!(basic_auth: auth).
+        merge!(headers: headers)
+    end
+
+    private
+
+    def sent_notification(resp)
+      IonicNotification::SentNotification.new(
+        tokens: @notification.tokens,
+        production: @notification.production,
+        title: @notification.title,
+        message: @notification.message,
+        android_payload: @notification.android_payload,
+        ios_payload: @notification.ios_payload,
+        scheduled: @notification.scheduled,
+        result: resp["result"],
+        message_id: resp["message_id"]
+      )
+    end
+
+    def body
+      {
+        tokens: @notification.tokens,
+        scheduled: @notification.scheduled,
+        production: @notification.production,
+        notification: {
+          title: @notification.title,
+          alert: @notification.message,
+          android: @notification.android_payload,
+          ios: @notification.ios_payload
+        }
+      }.to_json
+    end
+
+    def auth
+      { username: IonicNotification.ionic_api_key }
+    end
+
+    def headers
+      { 'Content-Type' => 'application/json', 'X-Ionic-Application-Id' => IonicNotification.ionic_application_id }
+    end
+  end
+end

data/lib/ionic_notification/sent_notification.rb

@@ -0,0 +1,30 @@
+module IonicNotification
+  class SentNotification
+    attr_accessor :tokens, :title, :message, :android_payload,
+      :ios_payload, :production, :result, :message_id, :sent_at
+
+    def initialize(options = {})
+      @tokens = options[:tokens]
+      @title = options[:title]
+      @message = options[:message]
+      @android_payload = options[:android_payload]
+      @ios_payload = options[:ios_payload]
+      @production = options[:production]
+      @result = options[:result]
+      @message_id = options[:message_id]
+      @sent_at = Time.now
+      @scheduled = init_scheduled(options[:scheduled])
+    end
+
+    def status
+      service = StatusService.new @message_id
+      service.check_status!
+    end
+
+    private
+
+    def init_scheduled(timestamp)
+      return DateTime.strptime(timestamp.to_s,'%s') if timestamp
+    end
+  end
+end

data/lib/ionic_notification/status_service.rb

@@ -0,0 +1,33 @@
+module IonicNotification
+  class StatusService
+    include HTTParty
+    base_uri IonicNotification.ionic_api_url
+
+    attr_accessor :body
+
+    def initialize(message_id)
+      @message_id = message_id
+    end
+
+    def check_status!
+      self.class.get("/api/v1/status/#{@message_id}", payload)
+    end
+
+    def payload
+      options = {}
+      options.
+        merge!(basic_auth: auth).
+        merge!(headers: headers)
+    end
+
+    private
+
+    def auth
+      { username: IonicNotification.ionic_api_key }
+    end
+
+    def headers
+      { 'Content-Type' => 'application/json', 'X-Ionic-Application-Id' => IonicNotification.ionic_application_id }
+    end
+  end
+end

data/lib/ionic_notification/version.rb

@@ -0,0 +1,3 @@
+module IonicNotification
+  VERSION = "0.1.0"
+end

data/lib/tasks/ionic_notification_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :ionic_push do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: ionic_notification
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Francesco Renzi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-12-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.5
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Interface built for Rails to use Ionic.io Push Notification service
+email:
+- rentziass@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- Rakefile
+- lib/generators/ionic_notification/install/install_generator.rb
+- lib/generators/ionic_notification/install/templates/ionic_notification.rb
+- lib/generators/ionic_notification/model/model_generator.rb
+- lib/generators/ionic_notification/model/templates/migration.rb
+- lib/generators/ionic_notification/orm_helpers.rb
+- lib/ionic_notification.rb
+- lib/ionic_notification/concerns/ionic_notificable.rb
+- lib/ionic_notification/exceptions.rb
+- lib/ionic_notification/logger.rb
+- lib/ionic_notification/notification.rb
+- lib/ionic_notification/push_service.rb
+- lib/ionic_notification/sent_notification.rb
+- lib/ionic_notification/status_service.rb
+- lib/ionic_notification/version.rb
+- lib/tasks/ionic_notification_tasks.rake
+homepage: https://github.com/rentziass/ionic_notification
+licenses:
+- MIT
+metadata: {}
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: Simple interface to use Ionic.io Push Notification service
+test_files: []