RubyGems - blastengine - Versions diffs - 0.4.1 → 0.5.1 - Mend

blastengine 0.4.1 → 0.5.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (17) hide show

checksums.yaml +4 -4
data/README.md +61 -3
data/lib/blastengine/base.rb +63 -0
data/lib/blastengine/bulk.rb +43 -1
data/lib/blastengine/client.rb +1 -0
data/lib/blastengine/download.rb +1 -0
data/lib/blastengine/email.rb +2 -0
data/lib/blastengine/job.rb +2 -0
data/lib/blastengine/log.rb +28 -0
data/lib/blastengine/mail.rb +105 -0
data/lib/blastengine/report.rb +2 -0
data/lib/blastengine/transaction.rb +13 -1
data/lib/blastengine/usage.rb +2 -0
data/lib/blastengine/version.rb +1 -1
data/lib/blastengine.rb +2 -0
metadata +5 -4
data/blastengine.gemspec +0 -39

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5446dc5334db835f92acb44be743dff7de15fbadfea05ee17b31ee24a00839d0
-  data.tar.gz: eaec75b620b64061ad33149270cdb6a806903b0b621dad49a3dd9f8470deda7b
+  metadata.gz: 02bc35ccd669b289c2a0f988b9b45eb234b340ebe56f95f24b8428774edefa65
+  data.tar.gz: 9311a00bbbd6b704f5dcb7317ad80122606326519c4a929ba484f026a17e3e4f
 SHA512:
-  metadata.gz: f912a678d09587f36aa4bec4ca6c62f672d6c8d12052ed3201c113312a2d4c91e0caffea70af8b52ec5eb10424e16efbcbe575bd80da3ba92482f926281218c0
-  data.tar.gz: 76deb185bb188795754903c55ee71fa61c168728fcf19114560f3a7dc7255e80dc5f8c3730ea60d8978640bff0756eedbe84b40392b0e2a82d4f93b9486de695
+  metadata.gz: 43416c93510d316fff59df714bc0e086539989d227691875fe34dc6579786d18ae85dc34c01db07065ab214d0ce9ad2b96a097b61ea626c2d7538c915fc1225c
+  data.tar.gz: 4e25b0934cf68ea34f62b6a671f2d79db388e50a1fbf47e0de4337a616363f57df8d15a9b277571c491bf964a00b71e87d248f5af71a68b53943cf62e9d6a1b1

data/README.md CHANGED Viewed

@@ -28,13 +28,71 @@ APIキーとユーザー名はblastengineのサイトで取得してください
 client = Blastengine.initialize api_key: "API_KEY", user_name: "YOUR_USER_NAME"
 ```
+### メール送信
+```ruby
+mail = Blastengine::Mail.new
+mail.from email: "admin@example.com", name: "Administrator"
+mail.addTo email: config["to"], insert_code: { name1: "name 1" }
+mail.subject = "Test email"
+mail.text_part = "This is a test email __name1__"
+mail.html_part = "<html><body>This is a test email __name1__</body></html>"
+mail.attachments << "README.md"
+bol = mail.send
+expect(bol).to be true
+delivery_id = mail.delivery_id
+expect(delivery_id).to be_an(Integer)
+```
+送信先は制限なく登録できます。
+```ruby
+mail = Blastengine::Mail.new
+mail.from email: "admin@example.com", name: "Administrator"
+10000.times do |i|
+    mail.addTo email: "bulk#{i}@example.jp", insert_code: { name1: "name #{i}" }
+end
+mail.subject = "Test email"
+mail.text_part = "This is a test email __name1__"
+mail.html_part = "<html><body>This is a test email __name1__</body></html>"
+mail.attachments << "README.md"
+bol = mail.send
+expect(bol).to be true
+delivery_id = mail.delivery_id
+expect(delivery_id).to be_an(Integer)
+```
+### メール検索
+```ruby
+params = {
+    "delivery_start": Time.now - 60 * 60 * 24 * 30,
+    "delivery_end": Time.now,
+    "delivery_type": ["BULK"],
+    "status": ["EDIT", "SENT"]
+}
+ary = Blastengine::Mail.find params
+ary[0].delivery_type # BULK
+ary[0].status # SENT
+```
+### 配信ログ検索
+```ruby
+params = {
+    "delivery_type": ["BULK"],
+    "status": ["EDIT", "SENT"]
+}
+ary = Blastengine::Log.find params
+```
 ### トランザクションメール
 #### テキストメール
 ```ruby
 transaction = Blastengine::Transaction.new
-transaction.from "admin@example.com", "Administrator"
+transaction.from email: "admin@example.com", name: "Administrator"
 transaction.to = "user@example.jp"
 transaction.subject = "Test subject"
 transaction.text_part = "This is a test email"
@@ -67,8 +125,8 @@ bulk.text_part = "This is a test email to __name__"
 bulk.register
 # Add address
-bulk.add "test1@example.jp", {name: "User 1"}
-bulk.add "test2@example.jp", {name: "User 2"}
+bulk.addTo "test1@example.jp", {name: "User 1"}
+bulk.addTo "test2@example.jp", {name: "User 2"}
 bulk.update
 # Send email immediately

data/lib/blastengine/base.rb CHANGED Viewed

@@ -1,9 +1,72 @@
+require "date"
 module Blastengine
 	class Base
 		include Blastengine
 		attr_accessor :delivery_id, :status, :delivery_time, :delivery_type, :open_count,
 			:created_time, :updated_time, :hard_error_count, :soft_error_count, :drop_count, :sent_count, :total_count
+		def self.client
+			base = Base.new
+			base.client
+		end
+		def client
+			@@client
+		end
+		def sets(params)
+			params.each do |key, value|
+				self.set(key, value)
+			end
+		end
+		def set(key, value)
+			case key
+			when "delivery_id"
+				@delivery_id = value
+			when "status"
+				@status = value
+			when "delivery_time"
+				@delivery_time = Date.parse(value) if value != nil
+			when "delivery_type"
+				@delivery_type = value
+			when "open_count"
+				@open_count = value
+			when "created_time"
+				@created_time = Date.parse(value) if value != nil
+			when "updated_time"
+				@updated_time = Date.parse(value) if value != nil
+			when "hard_error_count"
+				@hard_error_count = value
+			when "soft_error_count"
+				@soft_error_count = value
+			when "drop_count"
+				@drop_count = value
+			when "sent_count"
+				@sent_count = value
+			when "total_count"
+				@total_count = value
+			when "from"
+				@_from = value
+			when "reservation_time"
+				@reservation_time = Date.parse(value) if value != nil
+			when "maillog_id"
+				@maillog_id = value
+			when "email"
+				@to = value
+			when "last_response_code"
+				@last_response_code = value
+			when "last_response_message"
+				@last_response_message = value
+			when "subject"
+				@subject = value
+			when "open_time"
+				@open_time = Date.parse(value) if value != nil
+			end
+			self
+		end
 		def get
 			# APIリクエスト用のパス
 			path = "/deliveries/#{@delivery_id}"

data/lib/blastengine/bulk.rb CHANGED Viewed

@@ -1,4 +1,7 @@
 require "time"
+require "tempfile"
+require "csv"
+require "date"
 module Blastengine
 	class Bulk < Base
@@ -40,7 +43,7 @@ module Blastengine
 		#
 		# 受信者の追加
 		#
-		def add(email, params = {})
+		def addTo(email, params = {})
 			@to << {
 				email: email,
 				insert_code: params.map{|key, value| {
@@ -54,6 +57,14 @@ module Blastengine
 		# バルクメールの更新
 		#
 		def update
+			if @to.size > 50
+				return self.csv_update
+			else
+				return self.normal_update
+			end
+		end
+		def normal_update
 			# APIリクエスト用のパス
 			path = "/deliveries/bulk/update/#{@delivery_id}"
 			data = {
@@ -69,6 +80,36 @@ module Blastengine
 			return res["delivery_id"]
 		end
+		def csv_update
+			f = Tempfile.create(['blastengine', '.csv'])
+			f.close
+			csv = CSV.open(f.path, "w")
+			# ヘッダーの作成
+			headers = ["email"]
+			@to.each do |to|
+				to[:insert_code].each do |insert_code|
+					headers << insert_code[:key] if headers.index(insert_code[:key]) == nil
+				end
+			end
+			csv.puts headers
+			@to.each do |to|
+				lines = [to[:email]]
+				headers.each do |header|
+					next if header == "email"
+					insert_code = to[:insert_code].find{|insert_code| insert_code[:key] == header}
+					lines << insert_code[:value] if insert_code != nil
+				end
+				csv.puts lines
+			end
+			csv.close
+			job = self.import f.path
+			while !job.finish?
+				sleep 1
+			end
+			File.unlink f.path
+			@delivery_id
+		end
 		#
 		# バルクメールの送信
 		#
@@ -82,6 +123,7 @@ module Blastengine
 			# API実行
 			res = @@client.patch path, data
 			# エラーがあったら例外を投げるので、この場合は通常終了
+			@delivery_id = res["delivery_id"]
 			return res["delivery_id"]
 		end

data/lib/blastengine/client.rb CHANGED Viewed

@@ -5,6 +5,7 @@ require "faraday"
 require "faraday/multipart"
 require "json"
 require "mini_mime"
+require "date"
 #
 # Blastengine SDKのモジュール

data/lib/blastengine/download.rb CHANGED Viewed

@@ -1,3 +1,4 @@
+require 'date'
 require "zip"
 require "tempfile"

data/lib/blastengine/email.rb CHANGED Viewed

@@ -1,3 +1,5 @@
+require 'date'
 module Blastengine
 	class Email < Base
 		include Blastengine

data/lib/blastengine/job.rb CHANGED Viewed

@@ -1,3 +1,5 @@
+require 'date'
 module Blastengine
 	class Job < Download
 		include Blastengine

data/lib/blastengine/log.rb ADDED Viewed

@@ -0,0 +1,28 @@
+require 'date'
+module Blastengine
+	class Log < Base
+		include Blastengine
+		attr_accessor :cc, :bcc, :subject, :text_part, :encode, :html_part, :attachments, :delivery_id, :job
+		def self.from_hash(params)
+			log = Log.new
+			log.sets(params)
+			log
+		end
+		def self.find(params = {})
+			Hash[ params.map{|k,v| [k.to_sym, v] } ]
+			if params[:delivery_start] != nil
+				params[:delivery_start] = params[:delivery_start].iso8601
+			end
+			if params[:delivery_end] != nil
+				params[:delivery_end] = params[:delivery_end].iso8601
+			end
+			query_string = URI.encode_www_form(params)
+			url = "/logs/mails/results?#{query_string}";
+			res = Mail.client.get url
+			return res['data'].map {|params| Log.from_hash params }
+		end
+	end
+end

data/lib/blastengine/mail.rb ADDED Viewed

@@ -0,0 +1,105 @@
+require 'date'
+module Blastengine
+	class Mail < Base
+		include Blastengine
+		attr_accessor :to, :cc, :bcc, :subject, :text_part, :encode, :html_part, :attachments, :delivery_id
+		def initialize
+			@to = []
+			@cc = []
+			@bcc = []
+			@attachments = []
+			@encode = "UTF-8"
+		end
+		#
+		# 送信主の追加
+		#
+		def from(email:, name: "")
+			@_from = {email: email, name: name}
+		end
+		#
+		# 受信者の追加
+		#
+		def addTo(email:, insert_code: {})
+			@to << {
+				email: email,
+				insert_code: insert_code
+			}
+		end
+		def send(date = nil)
+			# CCまたはBCCがある場合はTransaction × Toの分
+			# Toが複数の場合はBulk、Toが1つの場合はTransaction
+			if @cc.size > 0 || @bcc.size > 0
+				# CCまたはBCCがある場合は、指定時刻送信はできない
+				raise "CC or BCC is not supported when sending at a specified time." if date != nil
+				raise "CC or BCC is not supported when sending to multiple recipients." if @to.size > 1
+			end
+			if date != nil || @to.size == 1
+				return self.sendTransaction();
+			end
+			return self.sendBulk(date)
+		end
+		def sendBulk(date = nil)
+			bulk = Bulk.new
+			bulk.from email: @_from[:email], name: @_from[:name]
+			bulk.subject = @subject
+			bulk.encode = @encode
+			bulk.text_part = @text_part
+			bulk.html_part = @html_part
+			if @attachments.size > 0
+				bulk.attachments = @attachments
+			end
+			bulk.register
+			@to.each do |to|
+				bulk.addTo(to[:email], to[:insert_code])
+			end
+			bulk.update
+			bulk.send date
+			@delivery_id = bulk.delivery_id
+			return true;
+		end
+		def sendTransaction
+			transaction = Transaction.new
+			transaction.from email: @_from[:email], name: @_from[:name]
+			transaction.subject = @subject
+			transaction.encode = @encode
+			transaction.text_part = @text_part
+			transaction.html_part = @html_part
+			transaction.to = @to[0][:email]
+			transaction.insert_code = @to[0][:insert_code] if @to[0][:insert_code].size > 0
+			transaction.cc = @cc if @cc.size > 0
+			transaction.bcc = @bcc if @bcc.size > 0
+			if @attachments.size > 0
+				transaction.attachments = @attachments
+			end
+			transaction.send
+			@delivery_id = transaction.delivery_id
+			return true;
+		end
+		def self.from_hash(params)
+			mail = params["delivery_type"] == "TRANSACTION" ? Transaction.new : Bulk.new
+			mail.sets(params);
+			mail
+		end
+		def self.find(params = {})
+			Hash[ params.map{|k,v| [k.to_sym, v] } ]
+			if params[:delivery_start] != nil
+				params[:delivery_start] = params[:delivery_start].iso8601
+			end
+			if params[:delivery_end] != nil
+				params[:delivery_end] = params[:delivery_end].iso8601
+			end
+			query_string = URI.encode_www_form(params)
+			url = "/deliveries?#{query_string}";
+			res = Mail.client.get url
+			return res['data'].map {|params| Mail.from_hash params }
+		end
+	end
+end

data/lib/blastengine/report.rb CHANGED Viewed

@@ -1,3 +1,5 @@
+require 'date'
 module Blastengine
 	class Report < Download
 		include Blastengine

data/lib/blastengine/transaction.rb CHANGED Viewed

@@ -1,13 +1,16 @@
+require 'date'
 module Blastengine
 	class Transaction < Base
 		include Blastengine
-		attr_accessor :to, :cc, :bcc, :subject, :text_part, :encode, :html_part, :attachments
+		attr_accessor :to, :cc, :bcc, :subject, :text_part, :encode, :html_part, :attachments, :insert_code
 		def initialize
 			@to = ""
 			@cc = []
 			@bcc = []
 			@attachments = []
 			@encode = "UTF-8"
+			@insert_code = {}
 		end
 		#
@@ -35,9 +38,18 @@ module Blastengine
 			}
 			# HTMLパートがある場合は追加
 			data[:html_part] = @html_part unless @html_part.nil?
+			if @insert_code != nil
+				data[:insert_code] = @insert_code.map do |key, value|
+					{
+						key: "__#{key}__",
+						value: value
+					}
+				end
+			end
 			# API実行
 			res = @@client.post path, data, @attachments
 			# エラーがあったら例外を投げるので、この場合は通常終了
+			@delivery_id = res["delivery_id"]
 			return res["delivery_id"]
 		end
 	end

data/lib/blastengine/usage.rb CHANGED Viewed

@@ -1,3 +1,5 @@
+require 'date'
 module Blastengine
 	class Usage < Base
 		include Blastengine

data/lib/blastengine/version.rb CHANGED Viewed

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 module Blastengine
-  VERSION = "0.4.1"
+  VERSION = "0.5.1"
 end

data/lib/blastengine.rb CHANGED Viewed

@@ -10,6 +10,8 @@ require "blastengine/job"
 require "blastengine/usage"
 require "blastengine/email"
 require "blastengine/report"
+require "blastengine/mail"
+require "blastengine/log"
 module Blastengine
   class Error < StandardError; end

metadata CHANGED Viewed

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: blastengine
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.1
 platform: ruby
 authors:
 - Atsushi Nakatsugawa
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-10-25 00:00:00.000000000 Z
+date: 2023-07-20 00:00:00.000000000 Z
 dependencies: []
 description: This is a SDK for sending email by blastengine.
 email:
@@ -25,7 +25,6 @@ files:
 - LICENSE
 - README.md
 - Rakefile
-- blastengine.gemspec
 - lib/blastengine.rb
 - lib/blastengine/base.rb
 - lib/blastengine/bulk.rb
@@ -33,6 +32,8 @@ files:
 - lib/blastengine/download.rb
 - lib/blastengine/email.rb
 - lib/blastengine/job.rb
+- lib/blastengine/log.rb
+- lib/blastengine/mail.rb
 - lib/blastengine/report.rb
 - lib/blastengine/transaction.rb
 - lib/blastengine/usage.rb
@@ -60,7 +61,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.4.9
 signing_key:
 specification_version: 4
 summary: SDK for sending email by blastengine

data/blastengine.gemspec DELETED Viewed

@@ -1,39 +0,0 @@
-# frozen_string_literal: true
-require_relative "lib/blastengine/version"
-Gem::Specification.new do |spec|
-  spec.name = "blastengine"
-  spec.version = Blastengine::VERSION
-  spec.authors = ["Atsushi Nakatsugawa"]
-  spec.email = ["atsushi@moongift.jp"]
-  spec.summary = "SDK for sending email by blastengine"
-  spec.description = "This is a SDK for sending email by blastengine."
-  spec.homepage = "https://blastengine.jp/"
-  spec.license = "MIT"
-  spec.required_ruby_version = ">= 2.6.0"
-  # spec.metadata["allowed_push_host"] = "TODO: Set to your gem server 'https://example.com'"
-  spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = "https://github.com/blastengineMania/blastengine-ruby"
-  spec.metadata["changelog_uri"] = "https://github.com/blastengineMania/blastengine-ruby/CHANGELOG.md"
-  # 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 do |f|
-      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
-    end
-  end
-  spec.bindir = "exe"
-  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-  # Uncomment to register a new dependency of your gem
-  # spec.add_dependency "example-gem", "~> 1.0"
-  # For more information and examples about making a new gem, check out our
-  # guide at: https://bundler.io/guides/creating_gem.html
-end