sendgrid_notification 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 5a6289282bff591ae77653ea3172ce498e80c001
-  data.tar.gz: ff5e384e4a9c50789108192cbb043db1833dd584
+SHA256:
+  metadata.gz: e396c43724c97f270821ea8d3e6207e4c646fabcc322622a8c3083d43e92e471
+  data.tar.gz: 95233c736ced4094c01141e07fbf30dcaa9644ac356658515934f4df57c7c4eb
 SHA512:
-  metadata.gz: abf8bdbfba44a15bf27270f45a2dfc888f08ba41d3ffdd25fe0417885b2ed474df233aacb5d1692258103d585eaef631300a6d4a2a17a713217283781a077d53
-  data.tar.gz: daa00bc9ebff0b4dd783d0d3e8e8e181ed0278978429268729f224af6eea998612fa7abf345de08e1cb85317e48b5d773ac2db292cc4237a458d189d4acb23c4
+  metadata.gz: 644f5639f1a2cef044c0b649f5c034e69035eeff83d4a5be0ff9be6eacdbb6116601d2c3169eab49fe7f3d30591dde9f1115fb16bdf6e6b5557a8af82f231b7e
+  data.tar.gz: df37e36a5bdd31f5df56c0478fbb018f3e9fdc9a768a3746d24e24a98573d29ece9ddd9c2180bcc0484b2f045ec0cd044ad0170b676171e85607232d74f0caaf

data/app/jobs/sendgrid_notification/sendmail_job.rb

@@ -1,11 +1,19 @@
 module SendgridNotification
   class SendmailJob < ApplicationJob
+    class HTTPException < StandardError; end
+
     queue_as :sendmail
 
     MailerClass = Rails.application.config.sendgrid_notification.mailer.constantize
 
-    def perform(to, notification_mail, params)
-      MailerClass.new(params).sendmail(to, notification_mail, params)
+    def perform(to, notification_mail, params, hash_attachments = [])
+
+      mailer = MailerClass.new(params)
+      obj_attachments = hash_attachments.map{|hash| SendgridNotification::Attachment.wrap(hash.symbolize_keys) }
+      mailer.sendmail(to, notification_mail, params, obj_attachments)
+      raise HTTPException, mailer.last_result.body unless mailer.last_result_success?
+
+      mailer.last_result.body
     end
   end
 end

data/app/models/sendgrid_notification/attachment.rb

@@ -0,0 +1,37 @@
+require 'sendgrid-ruby'
+
+module SendgridNotification
+  class Attachment
+    include ActiveModel::Model
+    include ActiveModel::Attributes # Rails 5.2
+
+    validates :content_id, :filename, :content, presence: true
+
+    attribute :content_id, :string
+    attribute :filename, :string
+    attribute :content, :string
+    attribute :mime_type, :string, default: "application/octet-stream"
+    attribute :disposition, :string, default: "attachment"
+
+    alias_method :to_h, :attributes
+
+    def as_sendgrid
+      a = ::SendGrid::Attachment.new
+      a.content_id = content_id
+      a.filename = filename
+      a.content = Base64.strict_encode64(content)
+      a.type = mime_type
+      a.disposition = disposition
+      a
+    end
+
+    def self.wrap(hash_or_attachment)
+      case hash_or_attachment
+      when Attachment
+        self
+      else
+        Attachment.new(**hash_or_attachment.to_h)
+      end
+    end
+  end
+end

data/app/models/sendgrid_notification/base_mailer.rb

@@ -8,7 +8,12 @@ module SendgridNotification
       @from_name = _params.fetch(:mail_from_name) { Rails.application.config.sendgrid_notification.mail_from_name }
     end
 
-    def sendmail(to, notification_mail, params = {})
+    # Send mail about:
+    # +to+ recipent to
+    # +notification_mail+ NotificationMail object for mail expression
+    # +params+ params for notification_mail
+    # +attachments+ attachment in hash or SendgridNotification::Attachment
+    def sendmail(to, notification_mail, params, attachments = [])
       raise NotImplementedError, "you should implement #{self.class}##{__method__}"
     end
 

data/app/models/sendgrid_notification/mail_recordable.rb

@@ -1,17 +1,32 @@
 # prepend me
 module SendgridNotification
   module MailRecordable
-    def sendmail(to, notification_mail, params = {})
+    def sendmail(to, notification_mail, parmas, attachments = [])
       result = super
 
-      m = MailHistory.create(
+      m = MailHistory.new(
         key: notification_mail.key,
         to: to,
         sent_at: Time.now,
       )
+      m.attachment_summary = attachment_summary(attachments) if m.respond_to?(:attachment_summary=)
+      m.save
       Rails.logger.error m.errors.full_messages if m.invalid? # and ignore
 
       result
     end
+
+    private
+
+    def attachment_summary(attachments)
+      attachments.map do |a|
+        {
+          content_id: a.content_id,
+          mime_type: a.mime_type,
+          filename: a.filename,
+          size: a.content.bytesize,
+        }
+      end.to_json
+    end
   end
 end

data/app/models/sendgrid_notification/notification_mail.rb

@@ -12,15 +12,16 @@ module SendgridNotification
     VARIABLE_REGEXP_DEFAULT = /\{\{\s*(\w+)\s*\}\}/
     self.variable_regexp = VARIABLE_REGEXP_DEFAULT
 
-
-    def sendmail_later(to, params = {})
-      SendmailJob.perform_later(to, self, params)
+    def sendmail_later(to, params, attachments = [])
+      hash_attachments = attachments.map(&:to_h)
+      SendmailJob.perform_later(to, self, params, hash_attachments)
     end
 
     alias_method :sendmail, :sendmail_later
 
-    def sendmail_now(to, params = {})
-      SendmailJob.perform_now(to, self, params)
+    def sendmail_now(to, params, attachments = [])
+      hash_attachments = attachments.map(&:to_h)
+      SendmailJob.perform_now(to, self, params, hash_attachments)
     end
 
     def apply(params)

data/app/models/sendgrid_notification/null_mailer.rb

@@ -1,14 +1,14 @@
 module SendgridNotification
   class NullMailer < BaseMailer
     prepend MailRecordable
-    Result = Struct.new(:from, :to, :subject, :body, :sent_at)
+    Result = Struct.new(:from, :to, :subject, :body, :sent_at, :attachments)
 
     @@results = []
     cattr_reader :results
 
-    def sendmail(to, notification_mail, params = {})
+    def sendmail(to, notification_mail, params, attachments = [])
       body = notification_mail.apply(params)
-      results << Result.new(from, to, notification_mail.subject, body, Time.now)
+      results << Result.new(from, to, notification_mail.subject, body, Time.now, attachments)
     end
 
     def last_result

data/app/models/sendgrid_notification/sendgrid_client.rb

@@ -50,8 +50,12 @@ module SendgridNotification
 
     # TODO: status_code が 500 系およびタイムアウトのときにリトライできるようにする
     # POST /mail/send
-    def mail_send(from:, from_name:, to:, subject:, body:)
+    def mail_send(from:, from_name:, to:, subject:, body:, attachments: [])
       mail = build_mail(from, from_name, to, subject, body)
+      attachments.each do |a|
+        a = SendgridNotification::Attachment.new(a) if a.is_a?(Hash)
+        mail.add_attachment(a.as_sendgrid)
+      end
       res = client.mail._('send').post(request_body: mail.to_json)
       @last_response = Response.new(res)
     end

data/app/models/sendgrid_notification/sendgrid_mailer.rb

@@ -3,9 +3,9 @@ module SendgridNotification
     prepend MailRecordable
     class Error < StandardError; end
 
-    def sendmail(to, notification_mail, params = {})
+    def sendmail(to, notification_mail, params, attachments = [])
       body = notification_mail.apply(params)
-      _sendmail(to, notification_mail, body)
+      _sendmail(to, notification_mail, body, attachments: attachments)
     end
 
     def last_result
@@ -24,13 +24,14 @@ module SendgridNotification
       @sendgrid_client ||= SendgridClient.new
     end
 
-    def _sendmail(to, notification_mail, body)
+    def _sendmail(to, notification_mail, body, attachments: )
       sendgrid_client.mail_send(
         from: from,
         from_name: from_name,
         to: to,
         subject: notification_mail.subject,
-        body: body
+        body: body,
+        attachments: attachments,
       )
     end
   end

data/app/models/sendgrid_notification/sendgrid_status.rb

@@ -17,19 +17,33 @@ module SendgridNotification
       end
     end
 
-    def self.auto_update
-      last = SendgridStatusUpdateHistory.last
-      start_time = last ? last.end_time : 1.hour.ago.to_i
+    def self.auto_update(ignore_errors: false)
+      last_end_time = SendgridNotification::SendgridStatusUpdateHistory.order(:id).reverse_order.limit(1).pluck(:end_time).first
+      start_time = last_end_time || 1.hour.ago.to_i
       end_time = Time.now.to_i
 
       suppressions = update(start_time, end_time)
 
-      SendgridStatusUpdateHistory.create!(
-        start_time: start_time,
-        end_time: end_time,
-        count: suppressions.size,
-        body: suppressions.map(&:to_s).join("\n")
-      )
+      begin
+        SendgridStatusUpdateHistory.create!(
+          start_time: start_time,
+          end_time: end_time,
+          count: suppressions.size,
+          body: suppressions.map(&:to_s).join("\n")
+        )
+      rescue => e
+        if ignore_errors
+          warn "#{e} (ignored)"
+          SendgridStatusUpdateHistory.create(
+            start_time: start_time,
+            end_time: end_time,
+            count: suppressions.size,
+            body: "" # ignored
+          )
+        else
+          raise
+        end
+      end
     end
 
     # TODO: 前回の保存日時からの内容を記録

data/db/migrate/20191120042452_alter_update_histories_body_to_longtext.rb

@@ -0,0 +1,14 @@
+class AlterUpdateHistoriesBodyToLongtext < ActiveRecord::Migration[5.1]
+  def change
+    longtextlimit = 4294967295
+    reversible do |dir|
+      dir.up do
+        change_column :sendgrid_status_update_histories, :body, :text, limit: longtextlimit
+      end
+
+      dir.down do
+        change_column :sendgrid_status_update_histories, :body, :text
+      end
+    end
+  end
+end

data/db/migrate/20191120042453_alter_notification_body_to_mediumtext.rb

@@ -0,0 +1,14 @@
+class AlterNotificationBodyToMediumtext < ActiveRecord::Migration[5.1]
+  def change
+    mediumtext = 16777215
+    reversible do |dir|
+      dir.up do
+        change_column :notification_mails, :content, :text, limit: mediumtext
+      end
+
+      dir.down do
+        change_column :notification_mails, :content, :text
+      end
+    end
+  end
+end

data/db/migrate/20191120070545_add_mail_histories_indexes.rb

@@ -0,0 +1,5 @@
+class AddMailHistoriesIndexes < ActiveRecord::Migration[5.1]
+  def change
+    add_index :mail_histories, :to
+  end
+end

data/db/migrate/20191125125857_add_attachment_summary_to_mail_histories.rb

@@ -0,0 +1,5 @@
+class AddAttachmentSummaryToMailHistories < ActiveRecord::Migration[5.1]
+  def change
+    add_column :mail_histories, :attachment_summary, :text
+  end
+end

data/lib/sendgrid_notification/version.rb

@@ -1,3 +1,3 @@
 module SendgridNotification
-  VERSION = "0.1.2".freeze
+  VERSION = "0.2.0".freeze
 end

data/lib/tasks/sendgrid_notification_tasks.rake

@@ -42,7 +42,8 @@ This is test mail.
 
     desc 'update status after previous autoupdate'
     task autoupdate: :environment do
-      SendgridNotification::SendgridStatus.auto_update
+      ignore_errors = !!ENV["IGNORE_ERRORS"]
+      SendgridNotification::SendgridStatus.auto_update(ignore_errors: ignore_errors)
     end
 
     desc 'only retrieve suppression statuses (start=datetime end=datetime)'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sendgrid_notification
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - HORII Keima
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-06 00:00:00.000000000 Z
+date: 2019-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: '5.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: '5.2'
 - !ruby/object:Gem::Dependency
   name: sendgrid-ruby
   requirement: !ruby/object:Gem::Requirement
@@ -141,6 +141,7 @@ files:
 - app/jobs/sendgrid_notification/sendmail_job.rb
 - app/mailers/sendgrid_notification/application_mailer.rb
 - app/models/sendgrid_notification/application_record.rb
+- app/models/sendgrid_notification/attachment.rb
 - app/models/sendgrid_notification/base_mailer.rb
 - app/models/sendgrid_notification/mail_history.rb
 - app/models/sendgrid_notification/mail_recordable.rb
@@ -156,6 +157,10 @@ files:
 - db/migrate/20170208085706_create_notification_mails.rb
 - db/migrate/20170208113843_create_mail_histories.rb
 - db/migrate/20170217072256_create_sendgrid_status_update_histories.rb
+- db/migrate/20191120042452_alter_update_histories_body_to_longtext.rb
+- db/migrate/20191120042453_alter_notification_body_to_mediumtext.rb
+- db/migrate/20191120070545_add_mail_histories_indexes.rb
+- db/migrate/20191125125857_add_attachment_summary_to_mail_histories.rb
 - lib/sendgrid_notification.rb
 - lib/sendgrid_notification/engine.rb
 - lib/sendgrid_notification/version.rb
@@ -179,8 +184,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: notification mail sender via sendgrid API