sendpulse 0.0.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.gitignore +3 -0
- data/.rspec +1 -0
- data/.travis.yml +4 -0
- data/Gemfile +4 -0
- data/Gemfile.lock +49 -0
- data/README.md +52 -0
- data/Rakefile +6 -0
- data/SendPulse.gemspec +27 -0
- data/lib/sendpulse/api.rb +98 -0
- data/lib/sendpulse/host.rb +7 -0
- data/lib/sendpulse/smtp.rb +17 -0
- data/lib/sendpulse/version.rb +3 -0
- data/spec/lib/sendpulse/api_spec.rb +16 -0
- data/spec/lib/sendpulse/smtp_spec.rb +47 -0
- data/spec/spec_helper.rb +10 -0
- metadata +146 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: cf8288c003a2fdf99278dbcbacd388178c55bd3f
|
4
|
+
data.tar.gz: dd1ece8c1e5162e13791484e1c53eddc2721dcc4
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: f9a8b1827b7d949e03babd0c3ca79ff32c87ea5ab925e5a62a664769b3d8e9e7fdef1600d674cb65f2bc0211becf888749172475c8f78e0cae4d4da970a9ea83
|
7
|
+
data.tar.gz: e9ef3f04b6f063331e97d1bc378f92257ebc0d31226ddbbdf7e567b048f554d61703de162be8b017a797482f65c703e5984b3c6fad63cf25a242b653d2cd2f3d
|
data/.gitignore
ADDED
data/.rspec
ADDED
@@ -0,0 +1 @@
|
|
1
|
+
--color
|
data/.travis.yml
ADDED
data/Gemfile
ADDED
data/Gemfile.lock
ADDED
@@ -0,0 +1,49 @@
|
|
1
|
+
PATH
|
2
|
+
remote: .
|
3
|
+
specs:
|
4
|
+
sendpulse (0.0.1)
|
5
|
+
|
6
|
+
GEM
|
7
|
+
remote: https://rubygems.org/
|
8
|
+
specs:
|
9
|
+
diff-lcs (1.3)
|
10
|
+
docile (1.1.5)
|
11
|
+
dotenv (2.1.1)
|
12
|
+
faker (1.7.3)
|
13
|
+
i18n (~> 0.5)
|
14
|
+
i18n (0.8.1)
|
15
|
+
json (2.0.3)
|
16
|
+
rake (10.5.0)
|
17
|
+
rspec (3.5.0)
|
18
|
+
rspec-core (~> 3.5.0)
|
19
|
+
rspec-expectations (~> 3.5.0)
|
20
|
+
rspec-mocks (~> 3.5.0)
|
21
|
+
rspec-core (3.5.4)
|
22
|
+
rspec-support (~> 3.5.0)
|
23
|
+
rspec-expectations (3.5.0)
|
24
|
+
diff-lcs (>= 1.2.0, < 2.0)
|
25
|
+
rspec-support (~> 3.5.0)
|
26
|
+
rspec-mocks (3.5.0)
|
27
|
+
diff-lcs (>= 1.2.0, < 2.0)
|
28
|
+
rspec-support (~> 3.5.0)
|
29
|
+
rspec-support (3.5.0)
|
30
|
+
simplecov (0.14.1)
|
31
|
+
docile (~> 1.1.0)
|
32
|
+
json (>= 1.8, < 3)
|
33
|
+
simplecov-html (~> 0.10.0)
|
34
|
+
simplecov-html (0.10.0)
|
35
|
+
|
36
|
+
PLATFORMS
|
37
|
+
ruby
|
38
|
+
|
39
|
+
DEPENDENCIES
|
40
|
+
bundler (~> 1.7)
|
41
|
+
dotenv (~> 2.1.1)
|
42
|
+
faker (~> 1.7.3)
|
43
|
+
rake (~> 10.0)
|
44
|
+
rspec (~> 3.2)
|
45
|
+
sendpulse!
|
46
|
+
simplecov (~> 0.14.1)
|
47
|
+
|
48
|
+
BUNDLED WITH
|
49
|
+
1.14.6
|
data/README.md
ADDED
@@ -0,0 +1,52 @@
|
|
1
|
+
[![Build Status](https://travis-ci.org/yogahp/SendPulse.svg?branch=master)](https://travis-ci.org/yogahp/SendPulse)
|
2
|
+
|
3
|
+
# SendPulse
|
4
|
+
|
5
|
+
Ruby client for [SendPulse](https://sendpulse.com/)
|
6
|
+
|
7
|
+
## Usage
|
8
|
+
|
9
|
+
### SMTP
|
10
|
+
#### Send Email
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'sendpulse/smtp'
|
14
|
+
|
15
|
+
email = {
|
16
|
+
html: '<html><body><h1>HTML</h1></body></html>',
|
17
|
+
text: 'Text',
|
18
|
+
subject: 'Subject',
|
19
|
+
from: {
|
20
|
+
name: 'Sender Name',
|
21
|
+
email: 'sender@example.com'
|
22
|
+
},
|
23
|
+
to: [
|
24
|
+
{
|
25
|
+
name: 'Receiver Name',
|
26
|
+
email: 'receiver@example.com'
|
27
|
+
}
|
28
|
+
]
|
29
|
+
}
|
30
|
+
|
31
|
+
sendpulse_smtp = SendPulse::Smtp.new(your_client_id, your_client_secret, 'https', nil)
|
32
|
+
sendpulse_smtp.send_email(email)
|
33
|
+
```
|
34
|
+
|
35
|
+
#### Retrieve Emails
|
36
|
+
|
37
|
+
```ruby
|
38
|
+
require 'sendpulse/smtp'
|
39
|
+
|
40
|
+
sendpulse_smtp = SendPulse::Smtp.new(your_client_id, your_client_secret, 'https', nil)
|
41
|
+
sendpulse_smtp.retrieve_emails
|
42
|
+
```
|
43
|
+
|
44
|
+
[Here](https://sendpulse.com/integrations/api) is SendPulse API specification.
|
45
|
+
|
46
|
+
## Contributing
|
47
|
+
|
48
|
+
1. Fork it ( https://github.com/yogahp/SendPulse/fork )
|
49
|
+
2. Create your feature branch (`git checkout -b my-new-feature`)
|
50
|
+
3. Commit your changes (`git commit -am 'Add some feature'`)
|
51
|
+
4. Push to the branch (`git push origin my-new-feature`)
|
52
|
+
5. Create a new Pull Request
|
data/Rakefile
ADDED
data/SendPulse.gemspec
ADDED
@@ -0,0 +1,27 @@
|
|
1
|
+
# coding: utf-8
|
2
|
+
lib = File.expand_path('../lib', __FILE__)
|
3
|
+
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
4
|
+
require 'sendpulse/version'
|
5
|
+
|
6
|
+
Gem::Specification.new do |spec|
|
7
|
+
spec.name = 'sendpulse'
|
8
|
+
spec.version = SendPulse::VERSION
|
9
|
+
spec.authors = ['Yoga Hapriana']
|
10
|
+
spec.email = ['thenelse@rocketmail.com']
|
11
|
+
spec.summary = %q{Client to http://sendpulse.com/ API.}
|
12
|
+
spec.description = %q{Ruby client to http://sendpulse.com/ API}
|
13
|
+
spec.homepage = 'https://github.com/yogahp/SendPulse'
|
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_development_dependency 'bundler', '~> 1.7'
|
22
|
+
spec.add_development_dependency 'rake', '~> 10.0'
|
23
|
+
spec.add_development_dependency 'rspec', '~> 3.2'
|
24
|
+
spec.add_development_dependency 'dotenv', '~> 2.1.1'
|
25
|
+
spec.add_development_dependency 'simplecov', '~> 0.14.1'
|
26
|
+
spec.add_development_dependency 'faker', '~> 1.7.3'
|
27
|
+
end
|
@@ -0,0 +1,98 @@
|
|
1
|
+
require 'sendpulse/host'
|
2
|
+
require 'net/http'
|
3
|
+
require 'json'
|
4
|
+
|
5
|
+
module SendPulse
|
6
|
+
class Api
|
7
|
+
attr_reader :client_id, :client_secret, :protocol, :token
|
8
|
+
|
9
|
+
def initialize(client_id, client_secret, protocol = 'https', token = '')
|
10
|
+
main_url = SendPulse::Host.main_url
|
11
|
+
@url = "#{protocol}://#{main_url}"
|
12
|
+
@client_id = client_id
|
13
|
+
@client_secret = client_secret
|
14
|
+
@protocol = protocol
|
15
|
+
@refresh_token = 0
|
16
|
+
@token = token
|
17
|
+
|
18
|
+
if @token.nil? || @token.empty?
|
19
|
+
raise 'Could not connect to API, check your CLIENT_ID and CLIENT_SECRET' unless refresh_token
|
20
|
+
end
|
21
|
+
end
|
22
|
+
|
23
|
+
def refresh_token
|
24
|
+
@refresh_token += 1
|
25
|
+
|
26
|
+
data = {
|
27
|
+
grant_type: 'client_credentials',
|
28
|
+
client_id: @client_id,
|
29
|
+
client_secret: @client_secret
|
30
|
+
}
|
31
|
+
|
32
|
+
request_data = send_request('oauth/access_token', 'POST', data, false)
|
33
|
+
|
34
|
+
if !request_data.nil? && request_data[:data]['access_token']
|
35
|
+
@token = request_data[:data]['access_token']
|
36
|
+
@refresh_token = 0
|
37
|
+
else
|
38
|
+
return false
|
39
|
+
end
|
40
|
+
|
41
|
+
true
|
42
|
+
end
|
43
|
+
protected :refresh_token
|
44
|
+
|
45
|
+
def send_request(path, method = 'GET', data = {}, use_token = true)
|
46
|
+
begin
|
47
|
+
request_data = {}
|
48
|
+
|
49
|
+
uri = URI.parse("#{@url}/#{path}")
|
50
|
+
|
51
|
+
http = Net::HTTP.new(uri.host, uri.port)
|
52
|
+
http.use_ssl = true if @protocol == 'https'
|
53
|
+
|
54
|
+
token = {}
|
55
|
+
token.merge!('Authorization': "Bearer #{@token}") if use_token
|
56
|
+
|
57
|
+
case method
|
58
|
+
when 'POST'
|
59
|
+
request = Net::HTTP::Post.new(uri.request_uri, token)
|
60
|
+
request.set_form_data(data)
|
61
|
+
when 'PUT'
|
62
|
+
request = Net::HTTP::Put.new(uri.request_uri, token)
|
63
|
+
request.set_form_data(data)
|
64
|
+
else
|
65
|
+
request = Net::HTTP::Get.new(uri.request_uri, token)
|
66
|
+
end
|
67
|
+
|
68
|
+
response = http.request(request)
|
69
|
+
|
70
|
+
if response.code.to_i == 401 && @refresh_token == 0
|
71
|
+
refresh_token
|
72
|
+
return send_request(path, method, data, use_token)
|
73
|
+
else
|
74
|
+
request_data[:data] = JSON.parse(response.body)
|
75
|
+
request_data[:http_code] = response.code
|
76
|
+
end
|
77
|
+
rescue Exception => e
|
78
|
+
raise "Exception \n message: #{e.message} \n backtrace: #{e.backtrace}"
|
79
|
+
end
|
80
|
+
|
81
|
+
handle_result(request_data)
|
82
|
+
end
|
83
|
+
protected :send_request
|
84
|
+
|
85
|
+
def handle_result(data)
|
86
|
+
unless data[:http_code].to_i == 200
|
87
|
+
data[:is_error] = true
|
88
|
+
end
|
89
|
+
data
|
90
|
+
end
|
91
|
+
protected :handle_result
|
92
|
+
|
93
|
+
def serialize(data)
|
94
|
+
JSON.generate(data)
|
95
|
+
end
|
96
|
+
protected :serialize
|
97
|
+
end
|
98
|
+
end
|
@@ -0,0 +1,17 @@
|
|
1
|
+
require 'sendpulse/api'
|
2
|
+
require 'base64'
|
3
|
+
|
4
|
+
module SendPulse
|
5
|
+
class Smtp < SendPulse::Api
|
6
|
+
def send_email(email)
|
7
|
+
return handle_error('Empty email') if email.empty?
|
8
|
+
email[:html] = Base64.encode64(email[:html])
|
9
|
+
data = { email: serialize(email) }
|
10
|
+
send_request('smtp/emails', 'POST', data)
|
11
|
+
end
|
12
|
+
|
13
|
+
def retrieve_emails
|
14
|
+
send_request('smtp/emails', 'GET')
|
15
|
+
end
|
16
|
+
end
|
17
|
+
end
|
@@ -0,0 +1,16 @@
|
|
1
|
+
require 'spec_helper'
|
2
|
+
|
3
|
+
describe SendPulse::Api do
|
4
|
+
before(:each) do
|
5
|
+
@client_id = ENV['CLIENT_ID']
|
6
|
+
@client_secret = ENV['CLIENT_SECRET']
|
7
|
+
end
|
8
|
+
|
9
|
+
context "Initialize" do
|
10
|
+
describe "Correctly initialize class" do
|
11
|
+
let(:sendpulse_api) { described_class.new(@client_id, @client_secret, "https", nil) }
|
12
|
+
|
13
|
+
it { expect(sendpulse_api).to be_a SendPulse::Api }
|
14
|
+
end
|
15
|
+
end
|
16
|
+
end
|
@@ -0,0 +1,47 @@
|
|
1
|
+
require 'spec_helper'
|
2
|
+
require 'faker'
|
3
|
+
|
4
|
+
describe SendPulse::Smtp do
|
5
|
+
before(:each) do
|
6
|
+
@client_id = ENV['CLIENT_ID']
|
7
|
+
@client_secret = ENV['CLIENT_SECRET']
|
8
|
+
@email = {
|
9
|
+
html: '<html><body><h1>HTML</h1></body></html>',
|
10
|
+
text: 'Text',
|
11
|
+
subject: 'Subject',
|
12
|
+
from: {
|
13
|
+
name: Faker::Name.name,
|
14
|
+
email: ENV['FROM_EMAIL']
|
15
|
+
},
|
16
|
+
to: [
|
17
|
+
{
|
18
|
+
name: Faker::Name.name,
|
19
|
+
email: ENV['TO_EMAIL']
|
20
|
+
}
|
21
|
+
]
|
22
|
+
}
|
23
|
+
end
|
24
|
+
|
25
|
+
context "Initialize" do
|
26
|
+
describe "Sending & Retrieve Emails" do
|
27
|
+
let(:sendpulse_smtp) { described_class.new(@client_id, @client_secret, "https", nil) }
|
28
|
+
let(:send_email) { sendpulse_smtp.send_email(@email) }
|
29
|
+
let(:retrieve_emails) { sendpulse_smtp.retrieve_emails }
|
30
|
+
|
31
|
+
it { expect(sendpulse_smtp).to be_a SendPulse::Smtp }
|
32
|
+
it { expect(send_email[:data]).to eql({ "result" => true }) }
|
33
|
+
it { expect(retrieve_emails[:data][0]).to include("id") }
|
34
|
+
it { expect(retrieve_emails[:data][0]).to include("sender") }
|
35
|
+
it { expect(retrieve_emails[:data][0]).to include("total_size") }
|
36
|
+
it { expect(retrieve_emails[:data][0]).to include("sender_ip") }
|
37
|
+
it { expect(retrieve_emails[:data][0]).to include("smtp_answer_code") }
|
38
|
+
it { expect(retrieve_emails[:data][0]).to include("smtp_answer_code_explain") }
|
39
|
+
it { expect(retrieve_emails[:data][0]).to include("smtp_answer_subcode") }
|
40
|
+
it { expect(retrieve_emails[:data][0]).to include("smtp_answer_data") }
|
41
|
+
it { expect(retrieve_emails[:data][0]).to include("used_ip") }
|
42
|
+
it { expect(retrieve_emails[:data][0]).to include("recipient") }
|
43
|
+
it { expect(retrieve_emails[:data][0]).to include("subject") }
|
44
|
+
it { expect(retrieve_emails[:data][0]).to include("send_date") }
|
45
|
+
end
|
46
|
+
end
|
47
|
+
end
|
data/spec/spec_helper.rb
ADDED
metadata
ADDED
@@ -0,0 +1,146 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: sendpulse
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.0.1
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- Yoga Hapriana
|
8
|
+
autorequire:
|
9
|
+
bindir: bin
|
10
|
+
cert_chain: []
|
11
|
+
date: 2017-04-09 00:00:00.000000000 Z
|
12
|
+
dependencies:
|
13
|
+
- !ruby/object:Gem::Dependency
|
14
|
+
name: bundler
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
16
|
+
requirements:
|
17
|
+
- - "~>"
|
18
|
+
- !ruby/object:Gem::Version
|
19
|
+
version: '1.7'
|
20
|
+
type: :development
|
21
|
+
prerelease: false
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
23
|
+
requirements:
|
24
|
+
- - "~>"
|
25
|
+
- !ruby/object:Gem::Version
|
26
|
+
version: '1.7'
|
27
|
+
- !ruby/object:Gem::Dependency
|
28
|
+
name: rake
|
29
|
+
requirement: !ruby/object:Gem::Requirement
|
30
|
+
requirements:
|
31
|
+
- - "~>"
|
32
|
+
- !ruby/object:Gem::Version
|
33
|
+
version: '10.0'
|
34
|
+
type: :development
|
35
|
+
prerelease: false
|
36
|
+
version_requirements: !ruby/object:Gem::Requirement
|
37
|
+
requirements:
|
38
|
+
- - "~>"
|
39
|
+
- !ruby/object:Gem::Version
|
40
|
+
version: '10.0'
|
41
|
+
- !ruby/object:Gem::Dependency
|
42
|
+
name: rspec
|
43
|
+
requirement: !ruby/object:Gem::Requirement
|
44
|
+
requirements:
|
45
|
+
- - "~>"
|
46
|
+
- !ruby/object:Gem::Version
|
47
|
+
version: '3.2'
|
48
|
+
type: :development
|
49
|
+
prerelease: false
|
50
|
+
version_requirements: !ruby/object:Gem::Requirement
|
51
|
+
requirements:
|
52
|
+
- - "~>"
|
53
|
+
- !ruby/object:Gem::Version
|
54
|
+
version: '3.2'
|
55
|
+
- !ruby/object:Gem::Dependency
|
56
|
+
name: dotenv
|
57
|
+
requirement: !ruby/object:Gem::Requirement
|
58
|
+
requirements:
|
59
|
+
- - "~>"
|
60
|
+
- !ruby/object:Gem::Version
|
61
|
+
version: 2.1.1
|
62
|
+
type: :development
|
63
|
+
prerelease: false
|
64
|
+
version_requirements: !ruby/object:Gem::Requirement
|
65
|
+
requirements:
|
66
|
+
- - "~>"
|
67
|
+
- !ruby/object:Gem::Version
|
68
|
+
version: 2.1.1
|
69
|
+
- !ruby/object:Gem::Dependency
|
70
|
+
name: simplecov
|
71
|
+
requirement: !ruby/object:Gem::Requirement
|
72
|
+
requirements:
|
73
|
+
- - "~>"
|
74
|
+
- !ruby/object:Gem::Version
|
75
|
+
version: 0.14.1
|
76
|
+
type: :development
|
77
|
+
prerelease: false
|
78
|
+
version_requirements: !ruby/object:Gem::Requirement
|
79
|
+
requirements:
|
80
|
+
- - "~>"
|
81
|
+
- !ruby/object:Gem::Version
|
82
|
+
version: 0.14.1
|
83
|
+
- !ruby/object:Gem::Dependency
|
84
|
+
name: faker
|
85
|
+
requirement: !ruby/object:Gem::Requirement
|
86
|
+
requirements:
|
87
|
+
- - "~>"
|
88
|
+
- !ruby/object:Gem::Version
|
89
|
+
version: 1.7.3
|
90
|
+
type: :development
|
91
|
+
prerelease: false
|
92
|
+
version_requirements: !ruby/object:Gem::Requirement
|
93
|
+
requirements:
|
94
|
+
- - "~>"
|
95
|
+
- !ruby/object:Gem::Version
|
96
|
+
version: 1.7.3
|
97
|
+
description: Ruby client to http://sendpulse.com/ API
|
98
|
+
email:
|
99
|
+
- thenelse@rocketmail.com
|
100
|
+
executables: []
|
101
|
+
extensions: []
|
102
|
+
extra_rdoc_files: []
|
103
|
+
files:
|
104
|
+
- ".gitignore"
|
105
|
+
- ".rspec"
|
106
|
+
- ".travis.yml"
|
107
|
+
- Gemfile
|
108
|
+
- Gemfile.lock
|
109
|
+
- README.md
|
110
|
+
- Rakefile
|
111
|
+
- SendPulse.gemspec
|
112
|
+
- lib/sendpulse/api.rb
|
113
|
+
- lib/sendpulse/host.rb
|
114
|
+
- lib/sendpulse/smtp.rb
|
115
|
+
- lib/sendpulse/version.rb
|
116
|
+
- spec/lib/sendpulse/api_spec.rb
|
117
|
+
- spec/lib/sendpulse/smtp_spec.rb
|
118
|
+
- spec/spec_helper.rb
|
119
|
+
homepage: https://github.com/yogahp/SendPulse
|
120
|
+
licenses:
|
121
|
+
- MIT
|
122
|
+
metadata: {}
|
123
|
+
post_install_message:
|
124
|
+
rdoc_options: []
|
125
|
+
require_paths:
|
126
|
+
- lib
|
127
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
128
|
+
requirements:
|
129
|
+
- - ">="
|
130
|
+
- !ruby/object:Gem::Version
|
131
|
+
version: '0'
|
132
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
133
|
+
requirements:
|
134
|
+
- - ">="
|
135
|
+
- !ruby/object:Gem::Version
|
136
|
+
version: '0'
|
137
|
+
requirements: []
|
138
|
+
rubyforge_project:
|
139
|
+
rubygems_version: 2.6.11
|
140
|
+
signing_key:
|
141
|
+
specification_version: 4
|
142
|
+
summary: Client to http://sendpulse.com/ API.
|
143
|
+
test_files:
|
144
|
+
- spec/lib/sendpulse/api_spec.rb
|
145
|
+
- spec/lib/sendpulse/smtp_spec.rb
|
146
|
+
- spec/spec_helper.rb
|