sendgrid_template_engine 0.0.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.
- checksums.yaml +7 -0
- data/.env.example +2 -0
- data/.gitignore +23 -0
- data/.travis.yml +10 -0
- data/Gemfile +4 -0
- data/LICENSE.txt +22 -0
- data/README.md +137 -0
- data/Rakefile +9 -0
- data/lib/resources.rb +20 -0
- data/lib/sendgrid_template_engine.rb +7 -0
- data/lib/sendgrid_template_engine/version.rb +3 -0
- data/lib/templates.rb +77 -0
- data/lib/versions.rb +109 -0
- data/sendgrid_template_engine.gemspec +25 -0
- data/test/sendgrid_template_engine_test.rb +14 -0
- data/test/templates_test.rb +138 -0
- data/test/versions_test.rb +177 -0
- metadata +119 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: 3e7d6e78791493a76386165219f8877d6989f162
|
4
|
+
data.tar.gz: d2a98bee7dc2d73969aaf4e6d22fa5a8babdfce8
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: c4633934f1eb5a274ab33f7f1a93c039fedf975743f78842cf9b9cfa052a936b1308549d385d11329d397cbef67a7d6ced281ab06daf85be9ce46f16a4d7ffaf
|
7
|
+
data.tar.gz: 26006969a24dcc7fe5c06fd8dff93277adc666ca8bffacfe1a1e7d80df941aa57ddeb07cf069335baeec3fe75bef0ede6b7f7dea06e3a1da8b6f24772de49e52
|
data/.env.example
ADDED
data/.gitignore
ADDED
@@ -0,0 +1,23 @@
|
|
1
|
+
*.gem
|
2
|
+
*.rbc
|
3
|
+
.bundle
|
4
|
+
.config
|
5
|
+
.yardoc
|
6
|
+
Gemfile.lock
|
7
|
+
InstalledFiles
|
8
|
+
_yardoc
|
9
|
+
coverage
|
10
|
+
doc/
|
11
|
+
lib/bundler/man
|
12
|
+
pkg
|
13
|
+
rdoc
|
14
|
+
spec/reports
|
15
|
+
test/tmp
|
16
|
+
test/version_tmp
|
17
|
+
tmp
|
18
|
+
*.bundle
|
19
|
+
*.so
|
20
|
+
*.o
|
21
|
+
*.a
|
22
|
+
mkmf.log
|
23
|
+
.env
|
data/.travis.yml
ADDED
data/Gemfile
ADDED
data/LICENSE.txt
ADDED
@@ -0,0 +1,22 @@
|
|
1
|
+
Copyright (c) 2014 awwa500@gmail.com
|
2
|
+
|
3
|
+
MIT License
|
4
|
+
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining
|
6
|
+
a copy of this software and associated documentation files (the
|
7
|
+
"Software"), to deal in the Software without restriction, including
|
8
|
+
without limitation the rights to use, copy, modify, merge, publish,
|
9
|
+
distribute, sublicense, and/or sell copies of the Software, and to
|
10
|
+
permit persons to whom the Software is furnished to do so, subject to
|
11
|
+
the following conditions:
|
12
|
+
|
13
|
+
The above copyright notice and this permission notice shall be
|
14
|
+
included in all copies or substantial portions of the Software.
|
15
|
+
|
16
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
17
|
+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
18
|
+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
19
|
+
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
|
20
|
+
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
21
|
+
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
22
|
+
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
data/README.md
ADDED
@@ -0,0 +1,137 @@
|
|
1
|
+
# SendgridTemplateEngine
|
2
|
+
|
3
|
+
This gem allows you to quickly and easily access to SendGrid Template Engine using Ruby.
|
4
|
+
See [api reference](https://sendgrid.com/docs/API_Reference/Template_Engine_API/index.html) for more detail
|
5
|
+
|
6
|
+
[](https://travis-ci.org/awwa/sendgrid_template_engine_ruby.svg?branch=master)
|
7
|
+
|
8
|
+
## Installation
|
9
|
+
|
10
|
+
Add this line to your application's Gemfile:
|
11
|
+
|
12
|
+
gem 'sendgrid_template_engine'
|
13
|
+
|
14
|
+
And then execute:
|
15
|
+
|
16
|
+
$ bundle
|
17
|
+
|
18
|
+
Or install it yourself as:
|
19
|
+
|
20
|
+
$ gem install sendgrid_template_engine
|
21
|
+
|
22
|
+
## Usage
|
23
|
+
|
24
|
+
### Templates
|
25
|
+
```Ruby
|
26
|
+
#
|
27
|
+
# Retrieve all templates
|
28
|
+
#
|
29
|
+
templates = SendgridTemplateEngine::Templates.new("user", "pass")
|
30
|
+
tmps = templates.get_all()
|
31
|
+
tmps.each {|tmp|
|
32
|
+
puts tmp.id
|
33
|
+
puts tmp.name
|
34
|
+
tmp.versions.each {|ver|
|
35
|
+
puts ver.id
|
36
|
+
puts ver.template_id
|
37
|
+
puts ver.active
|
38
|
+
puts ver.name
|
39
|
+
puts ver.updated_at
|
40
|
+
}
|
41
|
+
}
|
42
|
+
|
43
|
+
#
|
44
|
+
# Retrieve a single template
|
45
|
+
#
|
46
|
+
templates = SendgridTemplateEngine::Templates.new("user", "pass")
|
47
|
+
tmp = templates.get(template_id)
|
48
|
+
puts tmp.id
|
49
|
+
puts tmp.name
|
50
|
+
tmp.versions.each {|ver|
|
51
|
+
puts ver.id
|
52
|
+
puts ver.template_id
|
53
|
+
puts ver.active
|
54
|
+
puts ver.name
|
55
|
+
puts ver.updated_at
|
56
|
+
}
|
57
|
+
|
58
|
+
#
|
59
|
+
# Create a template
|
60
|
+
#
|
61
|
+
templates = SendgridTemplateEngine::Templates.new(@username, @password)
|
62
|
+
tmp = templates.post("new_template_name")
|
63
|
+
|
64
|
+
#
|
65
|
+
# Edit a template
|
66
|
+
#
|
67
|
+
templates = SendgridTemplateEngine::Templates.new(@username, @password)
|
68
|
+
tmp = templates.patch("edit_template_name")
|
69
|
+
|
70
|
+
#
|
71
|
+
# Delete a template
|
72
|
+
#
|
73
|
+
templates = SendgridTemplateEngine::Templates.new(@username, @password)
|
74
|
+
tmp = templates.delete(template_id)
|
75
|
+
```
|
76
|
+
|
77
|
+
### Versions
|
78
|
+
```Ruby
|
79
|
+
#
|
80
|
+
# Retrieve a specific version of template
|
81
|
+
#
|
82
|
+
versions = SendgridTemplateEngine::Versions.new(@username, @password)
|
83
|
+
ver = versions.get(template_id, version_id)
|
84
|
+
puts ver.id
|
85
|
+
puts ver.template_id
|
86
|
+
puts ver.active
|
87
|
+
puts ver.name
|
88
|
+
puts ver.html_content
|
89
|
+
puts ver.plain_content
|
90
|
+
puts ver.subject
|
91
|
+
puts ver.update_at
|
92
|
+
|
93
|
+
#
|
94
|
+
# Create a new version
|
95
|
+
#
|
96
|
+
new_version = SendgridTemplateEngine::Version.new()
|
97
|
+
new_version.set_name("new_version")
|
98
|
+
new_version.set_subject("<%subject%>")
|
99
|
+
new_version.set_html_content("<%body%>")
|
100
|
+
new_version.set_plain_content("<%body%>")
|
101
|
+
new_version.set_active(1)
|
102
|
+
versions = SendgridTemplateEngine::Versions.new(@username, @password)
|
103
|
+
ver = versions.post(template_id, new_version)
|
104
|
+
|
105
|
+
#
|
106
|
+
# Activate a version
|
107
|
+
#
|
108
|
+
versions = SendgridTemplateEngine::Versions.new(@username, @password)
|
109
|
+
ver = versions.post_activate(template_id, version_id)
|
110
|
+
|
111
|
+
#
|
112
|
+
# Edit a version
|
113
|
+
#
|
114
|
+
edit_version = SendgridTemplateEngine::Version.new()
|
115
|
+
edit_version.set_name("edit_version")
|
116
|
+
edit_version.set_subject("edit<%subject%>edit")
|
117
|
+
edit_version.set_html_content("edit<%body%>edit")
|
118
|
+
edit_version.set_plain_content("edit<%body%>edit")
|
119
|
+
edit_version.set_active(0)
|
120
|
+
versions = SendgridTemplateEngine::Versions.new(@username, @password)
|
121
|
+
ver = versions.patch(template_id, version_id, edit_version)
|
122
|
+
|
123
|
+
#
|
124
|
+
# Delete a version
|
125
|
+
#
|
126
|
+
versions = SendgridTemplateEngine::Versions.new(@username, @password)
|
127
|
+
versions.delete(template_id, version_id)
|
128
|
+
|
129
|
+
```
|
130
|
+
|
131
|
+
## Contributing
|
132
|
+
|
133
|
+
1. Fork it ( https://github.com/[my-github-username]/sendgrid_template_engine/fork )
|
134
|
+
2. Create your feature branch (`git checkout -b my-new-feature`)
|
135
|
+
3. Commit your changes (`git commit -am 'Add some feature'`)
|
136
|
+
4. Push to the branch (`git push origin my-new-feature`)
|
137
|
+
5. Create a new Pull Request
|
data/Rakefile
ADDED
data/lib/resources.rb
ADDED
@@ -0,0 +1,20 @@
|
|
1
|
+
# -*- encoding: utf-8 -*-
|
2
|
+
$:.unshift File.dirname(__FILE__)
|
3
|
+
|
4
|
+
require "sendgrid_template_engine/version"
|
5
|
+
require "rest-client"
|
6
|
+
require "uri"
|
7
|
+
|
8
|
+
module SendgridTemplateEngine
|
9
|
+
|
10
|
+
class Resources
|
11
|
+
|
12
|
+
def initialize(username, password)
|
13
|
+
raise ArgumentError.new("username should not be nil") if username == nil
|
14
|
+
raise ArgumentError.new("password should not be nil") if password == nil
|
15
|
+
@url_base = "https://#{username}:#{password}@api.sendgrid.com/v3"
|
16
|
+
end
|
17
|
+
|
18
|
+
end
|
19
|
+
|
20
|
+
end
|
data/lib/templates.rb
ADDED
@@ -0,0 +1,77 @@
|
|
1
|
+
# -*- encoding: utf-8 -*-
|
2
|
+
$:.unshift File.dirname(__FILE__)
|
3
|
+
|
4
|
+
require "sendgrid_template_engine/version"
|
5
|
+
require "rest-client"
|
6
|
+
require "uri"
|
7
|
+
require "resources"
|
8
|
+
require "versions"
|
9
|
+
|
10
|
+
module SendgridTemplateEngine
|
11
|
+
|
12
|
+
class Templates < Resources
|
13
|
+
|
14
|
+
def get_all
|
15
|
+
endpoint = "#{@url_base}/templates"
|
16
|
+
body = RestClient.get(endpoint).body
|
17
|
+
response = JSON.parse(body)
|
18
|
+
temps = []
|
19
|
+
response["templates"].each{|template|
|
20
|
+
temp = Template.create(template)
|
21
|
+
temps.push(temp)
|
22
|
+
} if response["templates"] != nil
|
23
|
+
temps
|
24
|
+
end
|
25
|
+
|
26
|
+
def get(template_id)
|
27
|
+
raise ArgumentError.new("template_id should not be nil") if template_id == nil
|
28
|
+
endpoint = "#{@url_base}/templates/#{template_id}"
|
29
|
+
body = RestClient.get(endpoint).body
|
30
|
+
Template.create(JSON.parse(body))
|
31
|
+
end
|
32
|
+
|
33
|
+
def post(name)
|
34
|
+
raise ArgumentError.new("name should not be nil") if name == nil
|
35
|
+
endpoint = "#{@url_base}/templates"
|
36
|
+
params = Hash.new
|
37
|
+
params["name"] = name
|
38
|
+
body = RestClient.post(endpoint, params.to_json, :content_type => :json).body
|
39
|
+
Template.create(JSON.parse(body))
|
40
|
+
end
|
41
|
+
|
42
|
+
def patch(template_id, name)
|
43
|
+
raise ArgumentError.new("template_id should not be nil") if template_id == nil
|
44
|
+
raise ArgumentError.new("name should not be nil") if name == nil
|
45
|
+
endpoint = "#{@url_base}/templates/#{template_id}"
|
46
|
+
params = Hash.new
|
47
|
+
params["name"] = name
|
48
|
+
body = RestClient.patch(endpoint, params.to_json, :content_type => :json).body
|
49
|
+
Template.create(JSON.parse(body))
|
50
|
+
end
|
51
|
+
|
52
|
+
def delete(template_id)
|
53
|
+
raise ArgumentError.new("template_id should not be nil") if template_id == nil
|
54
|
+
endpoint = "#{@url_base}/templates/#{template_id}"
|
55
|
+
RestClient.delete(endpoint)
|
56
|
+
end
|
57
|
+
|
58
|
+
end
|
59
|
+
|
60
|
+
class Template
|
61
|
+
|
62
|
+
attr_accessor :id, :name, :versions
|
63
|
+
|
64
|
+
def self.create(value)
|
65
|
+
obj = Template.new
|
66
|
+
obj.id = value["id"]
|
67
|
+
obj.name = value["name"]
|
68
|
+
obj.versions = []
|
69
|
+
value["versions"].each{|version|
|
70
|
+
ver = Version.create(version)
|
71
|
+
obj.versions.push(ver)
|
72
|
+
}
|
73
|
+
obj
|
74
|
+
end
|
75
|
+
|
76
|
+
end
|
77
|
+
end
|
data/lib/versions.rb
ADDED
@@ -0,0 +1,109 @@
|
|
1
|
+
# -*- encoding: utf-8 -*-
|
2
|
+
$:.unshift File.dirname(__FILE__)
|
3
|
+
|
4
|
+
require "sendgrid_template_engine/version"
|
5
|
+
require "rest-client"
|
6
|
+
require "uri"
|
7
|
+
require "resources"
|
8
|
+
|
9
|
+
module SendgridTemplateEngine
|
10
|
+
|
11
|
+
class Versions < Resources
|
12
|
+
|
13
|
+
def get(template_id, version_id)
|
14
|
+
raise ArgumentError.new("template_id should not be nil") if template_id == nil
|
15
|
+
raise ArgumentError.new("version_id should not be nil") if version_id == nil
|
16
|
+
endpoint = "#{@url_base}/templates/#{template_id}/versions/#{version_id}"
|
17
|
+
body = RestClient.get(endpoint).body
|
18
|
+
Version.create(JSON.parse(body))
|
19
|
+
end
|
20
|
+
|
21
|
+
def post(template_id, version)
|
22
|
+
raise ArgumentError.new("template_id should not be nil") if template_id == nil
|
23
|
+
raise ArgumentError.new("version should not be nil") if version == nil
|
24
|
+
endpoint = "#{@url_base}/templates/#{template_id}/versions"
|
25
|
+
body = RestClient.post(endpoint, version.to_hash.to_json, :content_type => :json).body
|
26
|
+
Version.create(JSON.parse(body))
|
27
|
+
end
|
28
|
+
|
29
|
+
def post_activate(template_id, version_id)
|
30
|
+
raise ArgumentError.new("template_id should not be nil") if template_id == nil
|
31
|
+
raise ArgumentError.new("version_id should not be nil") if version_id == nil
|
32
|
+
endpoint = "#{@url_base}/templates/#{template_id}/versions/#{version_id}/activate"
|
33
|
+
body = RestClient.post(endpoint, :content_type => :json).body
|
34
|
+
Version.create(JSON.parse(body))
|
35
|
+
end
|
36
|
+
|
37
|
+
def patch(template_id, version_id, version)
|
38
|
+
raise ArgumentError.new("template_id should not be nil") if template_id == nil
|
39
|
+
raise ArgumentError.new("version_id should not be nil") if version_id == nil
|
40
|
+
raise ArgumentError.new("version should not be nil") if version == nil
|
41
|
+
endpoint = "#{@url_base}/templates/#{template_id}/versions/#{version_id}"
|
42
|
+
body = RestClient.patch(endpoint, version.to_hash.to_json, :content_type => :json).body
|
43
|
+
Version.create(JSON.parse(body))
|
44
|
+
end
|
45
|
+
|
46
|
+
def delete(template_id, version_id)
|
47
|
+
raise ArgumentError.new("template_id should not be nil") if template_id == nil
|
48
|
+
raise ArgumentError.new("version_id should not be nil") if version_id == nil
|
49
|
+
endpoint = "#{@url_base}/templates/#{template_id}/versions/#{version_id}"
|
50
|
+
RestClient.delete(endpoint)
|
51
|
+
end
|
52
|
+
|
53
|
+
end
|
54
|
+
|
55
|
+
class Version
|
56
|
+
|
57
|
+
attr_accessor :id, :template_id, :active, :name, :html_content, :plain_content, :subject, :updated_at
|
58
|
+
|
59
|
+
def self.create(value)
|
60
|
+
obj = Version.new
|
61
|
+
obj.id = value["id"]
|
62
|
+
obj.template_id = value["template_id"]
|
63
|
+
obj.active = value["active"]
|
64
|
+
obj.name = value["name"]
|
65
|
+
obj.html_content = value["html_content"]
|
66
|
+
obj.plain_content = value["plain_content"]
|
67
|
+
obj.subject = value["subject"]
|
68
|
+
obj.updated_at = value["updated_at"]
|
69
|
+
obj
|
70
|
+
end
|
71
|
+
|
72
|
+
def to_hash
|
73
|
+
hash = {
|
74
|
+
"active" => @active,
|
75
|
+
"name" => @name,
|
76
|
+
"html_content" => @html_content,
|
77
|
+
"plain_content" => @plain_content,
|
78
|
+
"subject" => @subject,
|
79
|
+
}
|
80
|
+
hash
|
81
|
+
end
|
82
|
+
|
83
|
+
def set_name(name)
|
84
|
+
@name = name
|
85
|
+
self
|
86
|
+
end
|
87
|
+
|
88
|
+
def set_subject(subject)
|
89
|
+
@subject = subject
|
90
|
+
self
|
91
|
+
end
|
92
|
+
|
93
|
+
def set_html_content(html_content)
|
94
|
+
@html_content = html_content
|
95
|
+
self
|
96
|
+
end
|
97
|
+
|
98
|
+
def set_plain_content(plain_content)
|
99
|
+
@plain_content = plain_content
|
100
|
+
self
|
101
|
+
end
|
102
|
+
|
103
|
+
def set_active(active)
|
104
|
+
@active = active
|
105
|
+
self
|
106
|
+
end
|
107
|
+
|
108
|
+
end
|
109
|
+
end
|
@@ -0,0 +1,25 @@
|
|
1
|
+
# coding: utf-8
|
2
|
+
lib = File.expand_path('../lib', __FILE__)
|
3
|
+
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
4
|
+
require 'sendgrid_template_engine/version'
|
5
|
+
|
6
|
+
Gem::Specification.new do |spec|
|
7
|
+
spec.name = "sendgrid_template_engine"
|
8
|
+
spec.version = SendgridTemplateEngine::VERSION
|
9
|
+
spec.authors = ["awwa500@gmail.com"]
|
10
|
+
spec.email = ["awwa500@gmail.com"]
|
11
|
+
spec.summary = "SendGrid Template Engine API module"
|
12
|
+
spec.description = "SendGrid Template Engine API module"
|
13
|
+
spec.homepage = ""
|
14
|
+
spec.license = "MIT"
|
15
|
+
|
16
|
+
spec.files = `git ls-files -z`.split("\x0")
|
17
|
+
spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
|
18
|
+
spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
|
19
|
+
spec.require_paths = ["lib"]
|
20
|
+
|
21
|
+
spec.add_dependency "rest-client"
|
22
|
+
spec.add_development_dependency "bundler", "~> 1.6"
|
23
|
+
spec.add_development_dependency "rake"
|
24
|
+
spec.add_development_dependency "dotenv"
|
25
|
+
end
|
@@ -0,0 +1,14 @@
|
|
1
|
+
# -*- encoding: utf-8 -*-
|
2
|
+
require "json"
|
3
|
+
require "dotenv"
|
4
|
+
require "test/unit"
|
5
|
+
require "./lib/templates"
|
6
|
+
require "./lib/sendgrid_template_engine/version"
|
7
|
+
|
8
|
+
class SendgridTemplateEngineTest < Test::Unit::TestCase
|
9
|
+
|
10
|
+
def test_version
|
11
|
+
assert_equal("0.0.1", SendgridTemplateEngine::VERSION)
|
12
|
+
end
|
13
|
+
|
14
|
+
end
|
@@ -0,0 +1,138 @@
|
|
1
|
+
# -*- encoding: utf-8 -*-
|
2
|
+
require "json"
|
3
|
+
require "dotenv"
|
4
|
+
require "test/unit"
|
5
|
+
require "./lib/sendgrid_template_engine/version"
|
6
|
+
|
7
|
+
class TemplatesTest < Test::Unit::TestCase
|
8
|
+
|
9
|
+
def setup
|
10
|
+
config = Dotenv.load
|
11
|
+
@username = ENV["SENDGRID_USERNAME"]
|
12
|
+
@password = ENV["SENDGRID_PASSWORD"]
|
13
|
+
end
|
14
|
+
|
15
|
+
def test_initialize
|
16
|
+
templates = SendgridTemplateEngine::Templates.new("user", "pass")
|
17
|
+
assert_equal(SendgridTemplateEngine::Templates, templates.class)
|
18
|
+
end
|
19
|
+
|
20
|
+
def test_bad_username
|
21
|
+
assert_raise(ArgumentError) {
|
22
|
+
templates = SendgridTemplateEngine::Templates.new(nil, nil)
|
23
|
+
}
|
24
|
+
end
|
25
|
+
|
26
|
+
def test_invalid_auth
|
27
|
+
templates = SendgridTemplateEngine::Templates.new("user", "pass")
|
28
|
+
assert_raise(RestClient::Unauthorized) {
|
29
|
+
response = templates.get_all()
|
30
|
+
}
|
31
|
+
end
|
32
|
+
|
33
|
+
# def test_get_all
|
34
|
+
# templates = SendgridTemplateEngine::Templates.new(@username, @password)
|
35
|
+
# resp_temps = templates.get_all()
|
36
|
+
# assert_equal(true, resp_temps.length >= 0)
|
37
|
+
# end
|
38
|
+
#
|
39
|
+
# def test_get_template_id_nil
|
40
|
+
# templates = SendgridTemplateEngine::Templates.new(@username, @password)
|
41
|
+
# assert_raise(ArgumentError) {
|
42
|
+
# response = templates.get(nil)
|
43
|
+
# }
|
44
|
+
# end
|
45
|
+
#
|
46
|
+
# def test_get_template_id_not_exist
|
47
|
+
# templates = SendgridTemplateEngine::Templates.new(@username, @password)
|
48
|
+
# assert_raise(RestClient::ResourceNotFound) {
|
49
|
+
# response = templates.get("not_exist")
|
50
|
+
# }
|
51
|
+
# end
|
52
|
+
#
|
53
|
+
# def test_get_template_id_exist
|
54
|
+
# templates = SendgridTemplateEngine::Templates.new(@username, @password)
|
55
|
+
# # Add template
|
56
|
+
# new_template = templates.post("new_template")
|
57
|
+
# # Get template
|
58
|
+
# actual = templates.get(new_template.id)
|
59
|
+
# assert_equal(new_template.id, actual.id)
|
60
|
+
# assert_equal(new_template.name, actual.name)
|
61
|
+
# assert_equal(new_template.versions, actual.versions)
|
62
|
+
# # Delete template
|
63
|
+
# templates.delete(actual.id)
|
64
|
+
# end
|
65
|
+
#
|
66
|
+
# def test_post_name_nil
|
67
|
+
# templates = SendgridTemplateEngine::Templates.new(@username, @password)
|
68
|
+
# assert_raise(ArgumentError) {
|
69
|
+
# resp = templates.post(nil)
|
70
|
+
# }
|
71
|
+
# end
|
72
|
+
#
|
73
|
+
# def test_post_bad_request
|
74
|
+
# templates = SendgridTemplateEngine::Templates.new(@username, @password)
|
75
|
+
# expect = ""
|
76
|
+
# assert_raise(RestClient::BadRequest) {
|
77
|
+
# resp = templates.post(expect)
|
78
|
+
# }
|
79
|
+
# end
|
80
|
+
#
|
81
|
+
# def test_patch_id_nil
|
82
|
+
# templates = SendgridTemplateEngine::Templates.new(@username, @password)
|
83
|
+
# new_name = "new_name"
|
84
|
+
# assert_raise(ArgumentError) {
|
85
|
+
# actual = templates.patch(nil, new_name)
|
86
|
+
# }
|
87
|
+
# end
|
88
|
+
#
|
89
|
+
# def test_patch_name_nil
|
90
|
+
# templates = SendgridTemplateEngine::Templates.new(@username, @password)
|
91
|
+
# id = "some_id"
|
92
|
+
# assert_raise(ArgumentError) {
|
93
|
+
# actual = templates.patch(id, nil)
|
94
|
+
# }
|
95
|
+
# end
|
96
|
+
#
|
97
|
+
# def test_patch
|
98
|
+
# templates = SendgridTemplateEngine::Templates.new(@username, @password)
|
99
|
+
# # Add template
|
100
|
+
# new_template = templates.post("new_template")
|
101
|
+
# # Edit template
|
102
|
+
# templates.patch(new_template.id, "edit_template")
|
103
|
+
# # Get template
|
104
|
+
# actual = templates.get(new_template.id)
|
105
|
+
# assert_equal(new_template.id, actual.id)
|
106
|
+
# assert_equal("edit_template", actual.name)
|
107
|
+
# assert_equal(new_template.versions, actual.versions)
|
108
|
+
# # Delete template
|
109
|
+
# templates.delete(actual.id)
|
110
|
+
# end
|
111
|
+
#
|
112
|
+
# def test_delete_id_nil
|
113
|
+
# templates = SendgridTemplateEngine::Templates.new(@username, @password)
|
114
|
+
# assert_raise(ArgumentError) {
|
115
|
+
# templates.delete(nil)
|
116
|
+
# }
|
117
|
+
# end
|
118
|
+
#
|
119
|
+
# def test_delete_not_exist
|
120
|
+
# templates = SendgridTemplateEngine::Templates.new(@username, @password)
|
121
|
+
# assert_raise(RestClient::ResourceNotFound) {
|
122
|
+
# templates.delete("not_exist")
|
123
|
+
# }
|
124
|
+
# end
|
125
|
+
#
|
126
|
+
# def test_delete
|
127
|
+
# #-- prepare test
|
128
|
+
# templates = SendgridTemplateEngine::Templates.new(@username, @password)
|
129
|
+
# # Add template
|
130
|
+
# new_template = templates.post("new_template")
|
131
|
+
# # Delete template
|
132
|
+
# templates.delete(new_template.id)
|
133
|
+
# assert_raise(RestClient::ResourceNotFound) {
|
134
|
+
# templates.get(new_template.id)
|
135
|
+
# }
|
136
|
+
# end
|
137
|
+
|
138
|
+
end
|
@@ -0,0 +1,177 @@
|
|
1
|
+
# -*- encoding: utf-8 -*-
|
2
|
+
require "json"
|
3
|
+
require "dotenv"
|
4
|
+
require "test/unit"
|
5
|
+
require "./lib/sendgrid_template_engine/version"
|
6
|
+
|
7
|
+
class VersionsTest < Test::Unit::TestCase
|
8
|
+
|
9
|
+
def setup
|
10
|
+
config = Dotenv.load
|
11
|
+
@username = ENV["SENDGRID_USERNAME"]
|
12
|
+
@password = ENV["SENDGRID_PASSWORD"]
|
13
|
+
end
|
14
|
+
|
15
|
+
def test_initialize
|
16
|
+
versions = SendgridTemplateEngine::Versions.new("user", "pass")
|
17
|
+
assert_equal(SendgridTemplateEngine::Versions, versions.class)
|
18
|
+
end
|
19
|
+
|
20
|
+
def test_bad_username
|
21
|
+
assert_raise(ArgumentError) {
|
22
|
+
versions = SendgridTemplateEngine::Versions.new(nil, nil)
|
23
|
+
}
|
24
|
+
end
|
25
|
+
|
26
|
+
def test_invalid_auth
|
27
|
+
versions = SendgridTemplateEngine::Versions.new("user", "pass")
|
28
|
+
assert_raise(RestClient::Unauthorized) {
|
29
|
+
response = versions.get("template_id", "version_id")
|
30
|
+
}
|
31
|
+
end
|
32
|
+
|
33
|
+
# def test_get_template_id_nil
|
34
|
+
# versions = SendgridTemplateEngine::Versions.new(@username, @password)
|
35
|
+
# assert_raise(ArgumentError) {
|
36
|
+
# response = versions.get(nil, "version_id")
|
37
|
+
# }
|
38
|
+
# end
|
39
|
+
#
|
40
|
+
# def test_get_version_id_nil
|
41
|
+
# versions = SendgridTemplateEngine::Versions.new(@username, @password)
|
42
|
+
# assert_raise(ArgumentError) {
|
43
|
+
# response = versions.get("template_id", nil)
|
44
|
+
# }
|
45
|
+
# end
|
46
|
+
#
|
47
|
+
# def test_get_not_exist
|
48
|
+
# versions = SendgridTemplateEngine::Versions.new(@username, @password)
|
49
|
+
# assert_raise(RestClient::ResourceNotFound) {
|
50
|
+
# response = versions.get("not_exist", "not_exist")
|
51
|
+
# }
|
52
|
+
# end
|
53
|
+
#
|
54
|
+
# def test_get
|
55
|
+
# begin
|
56
|
+
# templates = SendgridTemplateEngine::Templates.new(@username, @password)
|
57
|
+
# # Add template
|
58
|
+
# new_template = templates.post("new_template")
|
59
|
+
# # Add version
|
60
|
+
# new_version = SendgridTemplateEngine::Version.new()
|
61
|
+
# new_version.set_name("new_version")
|
62
|
+
# new_version.set_subject("<%subject%>")
|
63
|
+
# new_version.set_html_content("<%body%>")
|
64
|
+
# new_version.set_plain_content("<%body%>")
|
65
|
+
# new_version.set_active(1)
|
66
|
+
# versions = SendgridTemplateEngine::Versions.new(@username, @password)
|
67
|
+
# new_version = versions.post(new_template.id, new_version)
|
68
|
+
# # Get version
|
69
|
+
# actual = versions.get(new_template.id, new_version.id)
|
70
|
+
# assert_equal(new_version.template_id, actual.template_id)
|
71
|
+
# assert_equal(new_version.active, actual.active)
|
72
|
+
# assert_equal(new_version.name, actual.name)
|
73
|
+
# assert_equal(new_version.html_content, actual.html_content)
|
74
|
+
# assert_equal(new_version.plain_content, actual.plain_content)
|
75
|
+
# assert_equal(new_version.subject, actual.subject)
|
76
|
+
# # Edit version
|
77
|
+
# edit_version = SendgridTemplateEngine::Version.new()
|
78
|
+
# edit_version.set_name("edit_version")
|
79
|
+
# edit_version.set_subject("edit<%subject%>edit")
|
80
|
+
# edit_version.set_html_content("edit<%body%>edit")
|
81
|
+
# edit_version.set_plain_content("edit<%body%>edit")
|
82
|
+
# edit_version.set_active(0)
|
83
|
+
# versions.patch(new_template.id, new_version.id, edit_version)
|
84
|
+
# # Get version
|
85
|
+
# actual = versions.get(new_template.id, new_version.id)
|
86
|
+
# assert_equal(new_template.id, actual.template_id)
|
87
|
+
# assert_equal(edit_version.active, actual.active)
|
88
|
+
# assert_equal(edit_version.name, actual.name)
|
89
|
+
# assert_equal(edit_version.html_content, actual.html_content)
|
90
|
+
# assert_equal(edit_version.plain_content, actual.plain_content)
|
91
|
+
# assert_equal(edit_version.subject, actual.subject)
|
92
|
+
# # Delete version
|
93
|
+
# versions.delete(actual.template_id, actual.id)
|
94
|
+
# assert_raise(RestClient::ResourceNotFound) {
|
95
|
+
# versions.get(new_template.id, new_version.id)
|
96
|
+
# }
|
97
|
+
# # Delete template
|
98
|
+
# templates.delete(actual.template_id)
|
99
|
+
# rescue => ex
|
100
|
+
# puts ex.inspect
|
101
|
+
# end
|
102
|
+
# end
|
103
|
+
|
104
|
+
def test_post_activate
|
105
|
+
begin
|
106
|
+
templates = SendgridTemplateEngine::Templates.new(@username, @password)
|
107
|
+
# Add template
|
108
|
+
new_template = templates.post("new_template")
|
109
|
+
# Add version
|
110
|
+
new_version = SendgridTemplateEngine::Version.new()
|
111
|
+
new_version.set_name("new_version")
|
112
|
+
new_version.set_subject("<%subject%>")
|
113
|
+
new_version.set_html_content("<%body%>")
|
114
|
+
new_version.set_plain_content("<%body%>")
|
115
|
+
new_version.set_active(0)
|
116
|
+
versions = SendgridTemplateEngine::Versions.new(@username, @password)
|
117
|
+
new_version = versions.post(new_template.id, new_version)
|
118
|
+
# Get version
|
119
|
+
actual = versions.get(new_template.id, new_version.id)
|
120
|
+
assert_equal(new_version.active, actual.active)
|
121
|
+
# Activate version
|
122
|
+
versions.post_activate(new_template.id, new_version.id)
|
123
|
+
# Get version
|
124
|
+
actual = versions.get(new_template.id, new_version.id)
|
125
|
+
assert_equal(1, actual.active)
|
126
|
+
# Delete version
|
127
|
+
versions.delete(actual.template_id, actual.id)
|
128
|
+
# Delete template
|
129
|
+
templates.delete(actual.template_id)
|
130
|
+
rescue => ex
|
131
|
+
puts ex.inspect
|
132
|
+
end
|
133
|
+
end
|
134
|
+
|
135
|
+
|
136
|
+
|
137
|
+
|
138
|
+
|
139
|
+
#
|
140
|
+
# def test_post_name_nil
|
141
|
+
# templates = SendgridTemplateEngine::Templates.new(@username, @password)
|
142
|
+
# assert_raise(ArgumentError) {
|
143
|
+
# resp = templates.post(nil)
|
144
|
+
# }
|
145
|
+
# end
|
146
|
+
#
|
147
|
+
# def test_post_bad_request
|
148
|
+
# templates = SendgridTemplateEngine::Templates.new(@username, @password)
|
149
|
+
# expect = ""
|
150
|
+
# assert_raise(RestClient::BadRequest) {
|
151
|
+
# resp = templates.post(expect)
|
152
|
+
# }
|
153
|
+
# end
|
154
|
+
#
|
155
|
+
# def test_patch_name_nil
|
156
|
+
# templates = SendgridTemplateEngine::Templates.new(@username, @password)
|
157
|
+
# id = "some_id"
|
158
|
+
# assert_raise(ArgumentError) {
|
159
|
+
# actual = templates.patch(id, nil)
|
160
|
+
# }
|
161
|
+
# end
|
162
|
+
#
|
163
|
+
# def test_delete_id_nil
|
164
|
+
# templates = SendgridTemplateEngine::Templates.new(@username, @password)
|
165
|
+
# assert_raise(ArgumentError) {
|
166
|
+
# templates.delete(nil)
|
167
|
+
# }
|
168
|
+
# end
|
169
|
+
#
|
170
|
+
# def test_delete_not_exist
|
171
|
+
# templates = SendgridTemplateEngine::Templates.new(@username, @password)
|
172
|
+
# assert_raise(RestClient::ResourceNotFound) {
|
173
|
+
# templates.delete("not_exist")
|
174
|
+
# }
|
175
|
+
# end
|
176
|
+
|
177
|
+
end
|
metadata
ADDED
@@ -0,0 +1,119 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: sendgrid_template_engine
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.0.1
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- awwa500@gmail.com
|
8
|
+
autorequire:
|
9
|
+
bindir: bin
|
10
|
+
cert_chain: []
|
11
|
+
date: 2014-07-14 00:00:00.000000000 Z
|
12
|
+
dependencies:
|
13
|
+
- !ruby/object:Gem::Dependency
|
14
|
+
name: rest-client
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
16
|
+
requirements:
|
17
|
+
- - ">="
|
18
|
+
- !ruby/object:Gem::Version
|
19
|
+
version: '0'
|
20
|
+
type: :runtime
|
21
|
+
prerelease: false
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
23
|
+
requirements:
|
24
|
+
- - ">="
|
25
|
+
- !ruby/object:Gem::Version
|
26
|
+
version: '0'
|
27
|
+
- !ruby/object:Gem::Dependency
|
28
|
+
name: bundler
|
29
|
+
requirement: !ruby/object:Gem::Requirement
|
30
|
+
requirements:
|
31
|
+
- - "~>"
|
32
|
+
- !ruby/object:Gem::Version
|
33
|
+
version: '1.6'
|
34
|
+
type: :development
|
35
|
+
prerelease: false
|
36
|
+
version_requirements: !ruby/object:Gem::Requirement
|
37
|
+
requirements:
|
38
|
+
- - "~>"
|
39
|
+
- !ruby/object:Gem::Version
|
40
|
+
version: '1.6'
|
41
|
+
- !ruby/object:Gem::Dependency
|
42
|
+
name: rake
|
43
|
+
requirement: !ruby/object:Gem::Requirement
|
44
|
+
requirements:
|
45
|
+
- - ">="
|
46
|
+
- !ruby/object:Gem::Version
|
47
|
+
version: '0'
|
48
|
+
type: :development
|
49
|
+
prerelease: false
|
50
|
+
version_requirements: !ruby/object:Gem::Requirement
|
51
|
+
requirements:
|
52
|
+
- - ">="
|
53
|
+
- !ruby/object:Gem::Version
|
54
|
+
version: '0'
|
55
|
+
- !ruby/object:Gem::Dependency
|
56
|
+
name: dotenv
|
57
|
+
requirement: !ruby/object:Gem::Requirement
|
58
|
+
requirements:
|
59
|
+
- - ">="
|
60
|
+
- !ruby/object:Gem::Version
|
61
|
+
version: '0'
|
62
|
+
type: :development
|
63
|
+
prerelease: false
|
64
|
+
version_requirements: !ruby/object:Gem::Requirement
|
65
|
+
requirements:
|
66
|
+
- - ">="
|
67
|
+
- !ruby/object:Gem::Version
|
68
|
+
version: '0'
|
69
|
+
description: SendGrid Template Engine API module
|
70
|
+
email:
|
71
|
+
- awwa500@gmail.com
|
72
|
+
executables: []
|
73
|
+
extensions: []
|
74
|
+
extra_rdoc_files: []
|
75
|
+
files:
|
76
|
+
- ".env.example"
|
77
|
+
- ".gitignore"
|
78
|
+
- ".travis.yml"
|
79
|
+
- Gemfile
|
80
|
+
- LICENSE.txt
|
81
|
+
- README.md
|
82
|
+
- Rakefile
|
83
|
+
- lib/resources.rb
|
84
|
+
- lib/sendgrid_template_engine.rb
|
85
|
+
- lib/sendgrid_template_engine/version.rb
|
86
|
+
- lib/templates.rb
|
87
|
+
- lib/versions.rb
|
88
|
+
- sendgrid_template_engine.gemspec
|
89
|
+
- test/sendgrid_template_engine_test.rb
|
90
|
+
- test/templates_test.rb
|
91
|
+
- test/versions_test.rb
|
92
|
+
homepage: ''
|
93
|
+
licenses:
|
94
|
+
- MIT
|
95
|
+
metadata: {}
|
96
|
+
post_install_message:
|
97
|
+
rdoc_options: []
|
98
|
+
require_paths:
|
99
|
+
- lib
|
100
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
101
|
+
requirements:
|
102
|
+
- - ">="
|
103
|
+
- !ruby/object:Gem::Version
|
104
|
+
version: '0'
|
105
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
106
|
+
requirements:
|
107
|
+
- - ">="
|
108
|
+
- !ruby/object:Gem::Version
|
109
|
+
version: '0'
|
110
|
+
requirements: []
|
111
|
+
rubyforge_project:
|
112
|
+
rubygems_version: 2.2.2
|
113
|
+
signing_key:
|
114
|
+
specification_version: 4
|
115
|
+
summary: SendGrid Template Engine API module
|
116
|
+
test_files:
|
117
|
+
- test/sendgrid_template_engine_test.rb
|
118
|
+
- test/templates_test.rb
|
119
|
+
- test/versions_test.rb
|