blastengine 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a32c93429a747fae165318a2078c7e39750469c07f4fe8e974adc162d4ab0db8
+  data.tar.gz: 7eaa9bf6dc06fd82269c860307a870a18a369bc7a8189372ff6d672164b812be
+SHA512:
+  metadata.gz: 716f9265649718d4aa3a5d7895b3bc46c63bb920adceecb8ca650ee4a0a171788c8a7c574d934580d4db64a3c10d228732d026f95ddede1d7dc80725bb9c4fdb
+  data.tar.gz: fdf904fea321762b809b43ef43ca534279189f16bf814aa7d47772bc1a24c8d106c40d24f0037a9a35c967179e7e03833dbcb00b20162f02e0876d47cc09520d

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2022-09-23
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at nakatsugawa@AtsushinoMac-mini.local. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in blastengine.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+gem "rspec", "~> 3.9"
+gem "faraday"
+gem "faraday-multipart"
+gem "mini_mime"

data/Gemfile.lock

@@ -0,0 +1,46 @@
+PATH
+  remote: .
+  specs:
+    blastengine (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.5.0)
+    faraday (2.5.2)
+      faraday-net_http (>= 2.0, < 3.1)
+      ruby2_keywords (>= 0.0.4)
+    faraday-multipart (1.0.4)
+      multipart-post (~> 2)
+    faraday-net_http (3.0.0)
+    mini_mime (1.1.2)
+    multipart-post (2.2.3)
+    rake (13.0.6)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.1)
+    ruby2_keywords (0.0.5)
+
+PLATFORMS
+  arm64-darwin-21
+
+DEPENDENCIES
+  blastengine!
+  faraday
+  faraday-multipart
+  mini_mime
+  rake (~> 13.0)
+  rspec (~> 3.9)
+
+BUNDLED WITH
+   2.3.7

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright © 2022 Atsushi Nakatsugawa
+
+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.

data/README.md

@@ -0,0 +1,65 @@
+# Blastengine SDK
+
+Blastengine SDKは、Rubyを用いて[エンジニア向けメール配信システム「ブラストエンジン」](https://blastengine.jp/)にてメール送信を行うSDKです。
+
+## インストール
+
+Gemfileに以下を追加します。
+
+```ruby
+gem 'blastengine'
+```
+
+そして下記コマンドを実行します。
+
+    $ bundle install
+
+またはgemコマンドでインストールしてください。
+
+    $ gem install blastengine
+
+## 使い方
+
+### 初期化
+
+APIキーとユーザー名はblastengineのサイトで取得してください。
+
+```ruby
+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.subject = "Test subject"
+transaction.text_part = "This is a test email"
+transaction.html_part = "<H1>Hello, world!</h1>"
+delivery_id = transaction.send
+```
+
+#### 添付ファイル付きメール
+
+```ruby
+transaction = Blastengine::Transaction.new
+transaction.from "admin@example.com", "Administrator"
+transaction.to << "user@example.jp"
+transaction.subject = "Test subject"
+transaction.text_part = "This is a test email"
+transaction.html_part = "<H1>Hello, world!</h1>"
+transaction.attachments << "README.md"
+transaction.attachments << "./spec/test.jpg"
+delivery_id = transaction.send
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Blastengine project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/blastengineMania/blastengine/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+task default: %i[]

data/lib/blastengine/client.rb

@@ -0,0 +1,129 @@
+# frozen_string_literal: true
+require "base64"
+require "digest/sha2"
+require "faraday"
+require "faraday/multipart"
+require "json"
+require "mini_mime"
+
+#
+# Blastengine SDKのモジュール
+#
+module Blastengine
+	# APIエンドポイント
+	DOMAIN = "app.engn.jp"
+	# APIのベースパス
+	BASE_PATH = "/api/v1"
+	# APIリクエストエラーが入る変数
+	@@last_error = nil
+	# APIクライアントが入る変数
+	@@client = nil
+
+	#
+	# Blastengine SDKを初期化する
+	#
+	def Blastengine.initialize(api_key:, user_name:)
+		@@client = Client.new api_key, user_name
+	end
+
+	#
+	# Blastengine SDKクライアント
+	# 基本的に各メール機能から呼ばれる
+	#
+	class Client
+		include Blastengine
+		# APIキー
+		@api_key = nil
+		# ユーザー名
+		@user_name = nil
+		# トークン
+		@token = nil
+
+		#
+		# コンストラクター
+		# APIキー、ユーザー名の設定とトークンの生成を行う
+		#
+		def initialize(api_key, user_name)
+			self.api_key = api_key
+			self.user_name = user_name
+			self.generate_token
+		end
+		# アクセッサー
+		attr_accessor :token, :api_key, :user_name
+
+		#
+		# トークンを生成する
+		#
+		def generate_token
+			return @token unless @token.nil?
+			str = "#{@user_name}#{@api_key}";
+			@token = Base64.urlsafe_encode64 Digest::SHA256.hexdigest(str).downcase
+		end
+		
+		#
+		# APIリクエストを行うFaradayのインスタンスを返す
+		# 添付ファイルの有無によって返すオブジェクトが異なる
+		#
+		def conn(attachment_count)
+			# 共通の設定
+			url = "https://#{DOMAIN}"
+			headers = {
+				"Authorization": "Bearer #{@token}"
+			}
+			# 添付ファイルがある場合
+			if attachment_count > 0
+				# MultiPartの設定をして返す
+				Faraday.new(
+					url: url,
+					headers: headers
+				) do |faraday|
+					faraday.request :multipart, flat_encode: true
+				end
+			else
+				# 添付ファイルがない場合
+				# JSONの設定をして返す
+				headers["Content-Type"] = "application/json"
+				Faraday.new(
+					url: url,
+					headers: headers
+				)
+			end
+		end
+
+		#
+		# POSTリクエスト用のデータを生成する
+		#
+		def post_data(data, attachments)
+			# 添付ファイルがない場合は、データをJSONに変換して返す
+			return data.to_json if attachments.length == 0
+			# 添付ファイルがある場合はファイルを読み込んで返す
+			return {
+				data: Faraday::Multipart::ParamPart.new(data.to_json, "application/json"),
+				file: attachments.map{|a| Faraday::Multipart::FilePart.new(
+					File.open(a),
+					MiniMime.lookup_by_filename(a) ? MiniMime.lookup_by_filename(a).content_type : "application/octet-stream",
+					File.basename(a)
+				)}
+			}
+		end
+
+		#
+		# POSTリクエストを行う
+		#
+		def post(path, data, attachments = [])
+			# リクエストボディの生成
+			params = self.post_data data, attachments
+			# リクエスト実行
+			res = self.conn(attachments.size).post("#{BASE_PATH}#{path}", params)
+			# レスポンスをJSONパース
+			json = JSON.parse res.body
+			# 200または201なら、レスポンスを返す
+			return json if res.status == 200 or res.status == 201
+			# それ以外はエラーを生成して例外処理
+			message = json["error_messages"].map{|key, value| "Error in #{key} (#{value})"}.join("\n")
+			@@last_error = Blastengine::Error.new message
+			raise @@last_error
+		end
+
+	end
+end

data/lib/blastengine/transaction.rb

@@ -0,0 +1,37 @@
+module Blastengine
+	class Transaction
+		include Blastengine
+		attr_accessor :to, :subject, :text_part, :encode, :html_part, :attachments
+		def initialize
+			@to = []
+			@attachments = []
+			@encode = "UTF-8"
+		end
+
+		def from(email, name = "")
+			@_from = {email: email, name: name}
+		end
+
+		#
+		# トランザクションメールの送信
+		#
+		def send
+			# APIリクエスト用のパス
+			path = "/deliveries/transaction"
+			# APIリクエスト用のデータ
+			data = {
+				from: @_from,
+				to: @to.join(","),
+				subject: @subject,
+				encode: @encode,
+				text_part: @text_part,
+			}
+			# HTMLパートがある場合は追加
+			data[:html_part] = @html_part unless @html_part.nil?
+			# API実行
+			res = @@client.post path, data, @attachments
+			# エラーがあったら例外を投げるので、この場合は通常終了
+			return res["delivery_id"]
+		end
+	end
+end

data/lib/blastengine/version.rb

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

data/lib/blastengine.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require_relative "blastengine/version"
+require "blastengine/client"
+require "blastengine/transaction"
+
+module Blastengine
+  class Error < StandardError; end
+  # Your code goes here...
+end

data/sig/blastengine.rbs

@@ -0,0 +1,4 @@
+module Blastengine
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification
+name: blastengine
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Atsushi Nakatsugawa
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-09-23 00:00:00.000000000 Z
+dependencies: []
+description: This is a SDK for sending email by blastengine.
+email:
+- atsushi@moongift.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- lib/blastengine.rb
+- lib/blastengine/client.rb
+- lib/blastengine/transaction.rb
+- lib/blastengine/version.rb
+- sig/blastengine.rbs
+homepage: https://blastengine.jp/
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://blastengine.jp/
+  source_code_uri: https://github.com/blastengineMania/blastengine-ruby
+  changelog_uri: https://github.com/blastengineMania/blastengine-ruby/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: SDK for sending email by blastengine
+test_files: []