blastengine 0.2.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6a0d56347bd3459eed133d5cdde17c19098a3b9d269a034c23466730bee8e614
-  data.tar.gz: b73c691f2ffb5677dbb8df8bb3cf4b9c0ae1f259c1dcb307d150608bb050f20c
+  metadata.gz: cb192455e96f1e16a8c2d70ac2035758bef80f0d5e56c0c651b33dd118558f15
+  data.tar.gz: 6fc1ef4846f1090cb4b57b38fe1ff1c063a8eeb4f47cadff2a930fb62b1af0f4
 SHA512:
-  metadata.gz: 568a2da98c6f37d8bd3acc62c27641f57b6949f9d0b45413d4aff249c38218994afae6594886c37d402b5c8868d49e9153b99c4eaaba4cbd506c751d8eb14ba6
-  data.tar.gz: a8cee8211a2c09e53aceb494538d07b78bbbe671bf468f30aebafec0ace6202966f629cbd98937bdf6f685f70683341214a2aeb07d8614dcefe1af19a39b39cf
+  metadata.gz: 6c44da8ddac18082ebcf1fe7a3007bf242e7b3d3236c4b6479df8ae643b1f0f8762122716b87f8795cc245ad6ebe97aafa0de0e5325a6db2f59d6ad96da1cb76
+  data.tar.gz: 7001480e3afe9debb0d7ec8c95996450c79bb0e92eafbdbdc37758ea2aa7c277e938b8772b2a362d537f8ca32ca904d506028a2ac4645d265cb5208c53d6a842

data/README.md

@@ -35,7 +35,7 @@ client = Blastengine.initialize api_key: "API_KEY", user_name: "YOUR_USER_NAME"
 ```ruby
 transaction = Blastengine::Transaction.new
 transaction.from "admin@example.com", "Administrator"
-transaction.to << "user@example.jp"
+transaction.to = "user@example.jp"
 transaction.subject = "Test subject"
 transaction.text_part = "This is a test email"
 transaction.html_part = "<H1>Hello, world!</h1>"
@@ -47,7 +47,7 @@ delivery_id = transaction.send
 ```ruby
 transaction = Blastengine::Transaction.new
 transaction.from "admin@example.com", "Administrator"
-transaction.to << "user@example.jp"
+transaction.to = "user@example.jp"
 transaction.subject = "Test subject"
 transaction.text_part = "This is a test email"
 transaction.html_part = "<H1>Hello, world!</h1>"
@@ -56,6 +56,53 @@ transaction.attachments << "./spec/test.jpg"
 delivery_id = transaction.send
 ```
 
+### バルクメール
+
+```ruby
+bulk = Blastengine::Bulk.new
+bulk.from "admin@example.com", "Administrator"
+bulk.subject = "Test bulk email"
+bulk.text_part = "This is a test email to __name__"
+# Register email as template
+bulk.register
+
+# Add address
+bulk.add "test1@example.jp", {name: "User 1"}
+bulk.add "test2@example.jp", {name: "User 2"}
+bulk.update
+
+# Send email immediately
+bulk.send
+
+# Send email 2 minutes later
+bulk.send Time.now + 120
+```
+
+### アドレスのCSVアップロード
+
+```ruby
+bulk = Blastengine::Bulk.new
+bulk.from email: config["from"]["email"], name: config["from"]["name"]
+bulk.subject = "Test bulk email, 2 minute later"
+bulk.text_part = "This is a test email to __name__"
+bulk.register
+
+job = bulk.import "./spec/example.csv"
+
+while !job.finish?
+    puts job.percentage
+end
+
+# Result of importing email addresses
+job.total_count
+job.success_count
+job.failed_count
+job.error_file_url
+
+# Get error if there is it
+job.error_message
+```
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/blastengine/base.rb

@@ -0,0 +1,47 @@
+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 get
+			# APIリクエスト用のパス
+			path = "/deliveries/#{@delivery_id}"
+			res = @@client.get path
+			# エラーがあったら例外を投げるので、この場合は通常終了
+			@delivery_type = res["delivery_type"]
+			@delivery_id = res["delivery_id"]
+			@status = res["status"]
+			@total_count = res["total_count"]
+			@sent_count = res["sent_count"]
+			@drop_count = res["drop_count"]
+			@hard_error_count = res["hard_error_count"]
+			@soft_error_count = res["soft_error_count"]
+			@open_count = res["open_count"]
+			@delivery_time = res["delivery_time"]
+			@reservation_time = res["reservation_time"]
+			@created_time = res["created_time"]
+			@updated_time = res["updated_time"]
+			@_from = res["from"]
+			@subject = res["subject"]
+			@text_part = res["text_part"]
+			@html_part = res["html_part"]
+		end
+
+		#
+		# バルクメールの削除
+		#
+		def delete
+			path = "/deliveries/#{@delivery_id}"
+			# API実行
+			res = @@client.delete path
+			return res["delivery_id"]
+		end
+
+		def report
+			report = Blastengine::Report.new @delivery_id
+			report.create
+			report
+		end
+	end
+end

data/lib/blastengine/bulk.rb

@@ -1,9 +1,9 @@
 require "time"
 
 module Blastengine
-	class Bulk
+	class Bulk < Base
 		include Blastengine
-		attr_accessor :subject, :text_part, :encode, :html_part, :attachments, :delivery_id
+		attr_accessor :subject, :text_part, :encode, :html_part, :attachments, :delivery_id, :job
 		def initialize
 			@to = []
 			@attachments = []
@@ -69,16 +69,6 @@ module Blastengine
 			return res["delivery_id"]
 		end
 
-		#
-		# バルクメールの削除
-		#
-		def delete
-			path = "/deliveries/#{@delivery_id}"
-			# API実行
-			res = @@client.delete path
-			return res["delivery_id"]
-		end
-
 		#
 		# バルクメールの送信
 		#
@@ -94,5 +84,26 @@ module Blastengine
 			# エラーがあったら例外を投げるので、この場合は通常終了
 			return res["delivery_id"]
 		end
+
+		def cancel
+			# APIリクエスト用のパス
+			path = "/deliveries/#{@delivery_id}/cancel"
+			# API実行
+			res = @@client.patch path, {}
+			return res["delivery_id"]
+		end
+
+		def import(file, ignore_errors = false)
+			# APIリクエスト用のパス
+			path = "/deliveries/#{@delivery_id}/emails/import"
+			# API実行
+			res = @@client.post path, {ignore_errors: ignore_errors}, [file]
+			@job = Blastengine::Job.new res["job_id"]
+			return @job
+		end
+	end
+
+	def email
+		Blastengine::Email.new(@delivery_id)
 	end
 end

data/lib/blastengine/client.rb

@@ -107,10 +107,20 @@ module Blastengine
 			}
 		end
 
+		#
+		# GETリクエストを行う
+		#
+		def get(path, binary = false)
+			# リクエスト実行
+			res = self.conn.get("#{BASE_PATH}#{path}")
+			# レスポンスを処理
+			return self.handle_response res, binary
+		end
+
 		#
 		# POSTリクエストを行う
 		#
-		def post(path, data, attachments = [])
+		def post(path, data = {}, attachments = [])
 			# リクエストボディの生成
 			params = self.post_data data, attachments
 			# リクエスト実行
@@ -149,13 +159,13 @@ module Blastengine
 		#
 		# レスポンスのハンドリング用
 		# 
-		def handle_response(res)
+		def handle_response(res, binary = false)
 			# レスポンスをJSONパース
-			json = JSON.parse res.body
+			body = binary ? res.body : JSON.parse(res.body)
 			# 200または201なら、レスポンスを返す
-			return json if res.status == 200 or res.status == 201
+			return body if res.status == 200 or res.status == 201
 			# それ以外はエラーを生成して例外処理
-			message = json["error_messages"].map{|key, value| "Error in #{key} (#{value})"}.join("\n")
+			message = body["error_messages"].map{|key, value| "Error in #{key} (#{value})"}.join("\n")
 			@@last_error = Blastengine::Error.new message
 			raise @@last_error
 		end

data/lib/blastengine/download.rb

@@ -0,0 +1,20 @@
+require "zip"
+require "tempfile"
+
+module Blastengine
+	class Download < Base
+		include Blastengine
+
+		def download res
+			f = Tempfile.create("blastengine")
+			f.binmode
+			f.write res
+			f.flush
+			path = f.path
+			input = Zip::File.open path
+			data = input.read input.entries[0].to_s
+			f.close
+			return data
+		end
+	end
+end

data/lib/blastengine/email.rb

@@ -0,0 +1,71 @@
+module Blastengine
+	class Email < Base
+		include Blastengine
+		attr_accessor :delivery_id, :address, :insert_code, :email_id, :created_time, :updated_time
+		def initialize delivery_id
+			@delivery_id = delivery_id
+			@insert_code = {}
+		end
+
+		def get
+			# APIリクエスト用のパス
+			path = "/deliveries/-/emails/#{@email_id}"
+			# API実行
+			res = @@client.get path
+			@email_id = res["email_id"]
+			res["insert_code"].each do |params|
+				@insert_code[params["key"].gsub("__", "")] = params["value"]
+			end
+			@address = res["email"]
+			@created_time = Time.parse(res["created_time"])
+			@updated_time = Time.parse(res["updated_time"])
+			return res["email_id"]
+		end
+
+		def save
+			# APIリクエスト用のパス
+			if @email_id.nil?
+				return create
+			else
+				return update
+			end
+		end
+
+		def create
+			path = "/deliveries/#{@delivery_id}/emails"
+			params = {
+				email: @address,
+				insert_code: @insert_code.map{|key, value| {
+					key: "__#{key}__",
+					value: value
+				}}
+			}
+			# API実行
+			res = @@client.post path, params
+			@email_id = res["email_id"]
+			return res["email_id"]
+		end
+
+		def update
+			path = "/deliveries/-/emails/#{@email_id}"
+			params = {
+				email: @address,
+				insert_code: @insert_code.map{|key, value| {
+					key: "__#{key}__",
+					value: value
+				}}
+			}
+			# API実行
+			res = @@client.put path, params
+			@email_id = res["email_id"]
+			return res["email_id"]
+		end
+
+		def delete
+			path = "/deliveries/-/emails/#{@email_id}"
+			# API実行
+			res = @@client.delete path
+			return res["email_id"]
+		end
+	end
+end

data/lib/blastengine/job.rb

@@ -0,0 +1,31 @@
+module Blastengine
+	class Job < Download
+		include Blastengine
+		attr_accessor :job_id, :percentage, :status, :error_file_url, :success_count, :failed_count, :total_count
+		def initialize id
+			@job_id = id
+		end
+
+		def finish?
+			# APIリクエスト用のパス
+			path = "/deliveries/-/emails/import/#{@job_id}"
+			res = @@client.get path
+			@percentage = res["percentage"]
+			@status = res["status"]
+			@error_file_url = res["error_file_url"] unless res["error_file_url"].nil?
+			@success_count = res["success_count"] unless res["success_count"].nil?
+			@failed_count = res["failed_count"] unless res["failed_count"].nil?
+			@total_count = res["total_count"] unless res["total_count"].nil?
+			return @percentage == 100
+		end
+
+		def error_message
+			return @error_message unless @error_message.nil?
+			return nil if @error_file_url.nil?
+			path = "/deliveries/-/emails/import/#{@job_id}/errorinfo/download"
+			res = @@client.get path, true
+			@error_message = download res
+			@error_message
+		end
+	end
+end

data/lib/blastengine/report.rb

@@ -0,0 +1,37 @@
+module Blastengine
+	class Report < Download
+		include Blastengine
+		attr_accessor :job_id, :delivery_id, :percentage, :status, :mail_open_file_url, :total_count, :report
+		def initialize delivery_id
+			@delivery_id = delivery_id
+		end
+
+		def create
+			# APIリクエスト用のパス
+			path = "/deliveries/#{@delivery_id}/analysis/report"
+			res = @@client.post path
+			@job_id = res["job_id"]
+			return @job_id
+		end
+
+		def finish?
+			# APIリクエスト用のパス
+			path = "/deliveries/-/analysis/report/#{@job_id}"
+			res = @@client.get path
+			@percentage = res["percentage"]
+			@status = res["status"]
+			@total_count = res["total_count"] unless res["total_count"].nil?
+			@mail_open_file_url = res["mail_open_file_url"] unless res["mail_open_file_url"].nil?
+			return @percentage == 100
+		end
+
+		def get
+			return @report unless @report.nil?
+			return nil unless @percentage == 100
+			path = "/deliveries/-/analysis/report/#{@job_id}/download"
+			res = @@client.get path, true
+			@report = download res
+			@report
+		end
+	end
+end

data/lib/blastengine/transaction.rb

@@ -1,9 +1,11 @@
 module Blastengine
-	class Transaction
+	class Transaction < Base
 		include Blastengine
-		attr_accessor :to, :subject, :text_part, :encode, :html_part, :attachments
+		attr_accessor :to, :cc, :bcc, :subject, :text_part, :encode, :html_part, :attachments
 		def initialize
-			@to = []
+			@to = ""
+			@cc = []
+			@bcc = []
 			@attachments = []
 			@encode = "UTF-8"
 		end
@@ -24,7 +26,9 @@ module Blastengine
 			# APIリクエスト用のデータ
 			data = {
 				from: @_from,
-				to: @to.join(","),
+				to: @to,
+				cc: @cc,
+				bcc: @bcc,
 				subject: @subject,
 				encode: @encode,
 				text_part: @text_part,

data/lib/blastengine/usage.rb

@@ -0,0 +1,36 @@
+module Blastengine
+	class Usage < Base
+		include Blastengine
+		attr_accessor :month, :current, :remaining, :updated_time, :plan_id
+		def initialize params
+			@month = params["month"]
+			@current = params["current"]
+			@remaining = params["remaining"]
+			@updated_time = params["updated_time"]
+			@plan_id = params["plan_id"]
+		end
+
+		def self.all month_ago = 1
+			# APIリクエスト用のパス
+			path = "/usages?month_ago=#{month_ago}"
+			res = @@client.get path
+			res["data"].map do |params|
+				self.new params
+			end
+		end
+
+		def self.get month = Date.today.strftime("%Y%m")
+			# APIリクエスト用のパス
+			path = "/usages/#{month}"
+			res = @@client.get path
+			self.new res
+		end
+
+		def self.latest
+			# APIリクエスト用のパス
+			path = "/usages/latest"
+			res = @@client.get path
+			self.new res
+		end
+	end
+end

data/lib/blastengine/version.rb

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

data/lib/blastengine.rb

@@ -2,8 +2,14 @@
 
 require_relative "blastengine/version"
 require "blastengine/client"
+require "blastengine/base"
+require "blastengine/download"
 require "blastengine/transaction"
 require "blastengine/bulk"
+require "blastengine/job"
+require "blastengine/usage"
+require "blastengine/email"
+require "blastengine/report"
 
 module Blastengine
   class Error < StandardError; end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: blastengine
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Atsushi Nakatsugawa
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-09-24 00:00:00.000000000 Z
+date: 2022-10-25 00:00:00.000000000 Z
 dependencies: []
 description: This is a SDK for sending email by blastengine.
 email:
@@ -27,9 +27,15 @@ files:
 - Rakefile
 - blastengine.gemspec
 - lib/blastengine.rb
+- lib/blastengine/base.rb
 - lib/blastengine/bulk.rb
 - lib/blastengine/client.rb
+- lib/blastengine/download.rb
+- lib/blastengine/email.rb
+- lib/blastengine/job.rb
+- lib/blastengine/report.rb
 - lib/blastengine/transaction.rb
+- lib/blastengine/usage.rb
 - lib/blastengine/version.rb
 - sig/blastengine.rbs
 homepage: https://blastengine.jp/