sendpulse 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cf8288c003a2fdf99278dbcbacd388178c55bd3f
-  data.tar.gz: dd1ece8c1e5162e13791484e1c53eddc2721dcc4
+  metadata.gz: 410d39c2cdf278d41fefb97a275d021384be3e62
+  data.tar.gz: 9461b6f3da754d3e9939ce69c580aa3fa8554f6e
 SHA512:
-  metadata.gz: f9a8b1827b7d949e03babd0c3ca79ff32c87ea5ab925e5a62a664769b3d8e9e7fdef1600d674cb65f2bc0211becf888749172475c8f78e0cae4d4da970a9ea83
-  data.tar.gz: e9ef3f04b6f063331e97d1bc378f92257ebc0d31226ddbbdf7e567b048f554d61703de162be8b017a797482f65c703e5984b3c6fad63cf25a242b653d2cd2f3d
+  metadata.gz: d76f1f3453d8668ea393d63ff599952263966662293c5371693202d5471c672ea8e079390f7817da2efd3c0ddc67683dccad7ac70ea9ceefbd4f442e85725ebf
+  data.tar.gz: 5672def6d76dc0832cde50594ffdfe34e6ea3f40789bdf61118a918516436c7b14f9543fdcca63aaafb685de46230c6d6211f55c2a379d447175c6845813f3ed

data/Gemfile.lock

@@ -1,18 +1,16 @@
 PATH
   remote: .
   specs:
-    sendpulse (0.0.1)
+    sendpulse (0.0.2)
 
 GEM
   remote: https://rubygems.org/
   specs:
     diff-lcs (1.3)
-    docile (1.1.5)
     dotenv (2.1.1)
     faker (1.7.3)
       i18n (~> 0.5)
     i18n (0.8.1)
-    json (2.0.3)
     rake (10.5.0)
     rspec (3.5.0)
       rspec-core (~> 3.5.0)
@@ -27,11 +25,6 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.5.0)
     rspec-support (3.5.0)
-    simplecov (0.14.1)
-      docile (~> 1.1.0)
-      json (>= 1.8, < 3)
-      simplecov-html (~> 0.10.0)
-    simplecov-html (0.10.0)
 
 PLATFORMS
   ruby
@@ -43,7 +36,6 @@ DEPENDENCIES
   rake (~> 10.0)
   rspec (~> 3.2)
   sendpulse!
-  simplecov (~> 0.14.1)
 
 BUNDLED WITH
    1.14.6

data/README.md

@@ -41,6 +41,117 @@ sendpulse_smtp = SendPulse::Smtp.new(your_client_id, your_client_secret, 'https'
 sendpulse_smtp.retrieve_emails
 ```
 
+### Mailing List
+#### Creating a mailing list
+
+```ruby
+require 'sendpulse/mailing_list'
+
+sendpulse_mailinglist = SendPulse::MailingList.new(your_client_id, your_client_secret, 'https', nil)
+sendpulse_mailinglist.create("Mailing List Title")
+```
+
+#### Editing a mailing list
+
+```ruby
+require 'sendpulse/mailing_list'
+
+sendpulse_mailinglist = SendPulse::MailingList.new(your_client_id, your_client_secret, 'https', nil)
+sendpulse_mailinglist.update({ id: id, name: "New mailing list name" })
+```
+
+#### Retrieving a list of mailing list
+
+```ruby
+require 'sendpulse/mailing_list'
+
+sendpulse_mailinglist = SendPulse::MailingList.new(your_client_id, your_client_secret, 'https', nil)
+sendpulse_mailinglist.list({ limit: 10, offset: 10 })
+```
+
+#### Retrieving mailing list information
+
+```ruby
+require 'sendpulse/mailing_list'
+
+sendpulse_mailinglist = SendPulse::MailingList.new(your_client_id, your_client_secret, 'https', nil)
+sendpulse_mailinglist.get(mailinglist_id)
+```
+
+#### Retrieving a list of emails from a mailing list
+
+```ruby
+require 'sendpulse/mailing_list'
+
+sendpulse_mailinglist = SendPulse::MailingList.new(your_client_id, your_client_secret, 'https', nil)
+sendpulse_mailinglist.get_emails(mailinglist_id)
+```
+
+#### Adding emails to a mailing list
+
+```ruby
+require 'sendpulse/mailing_list'
+
+sendpulse_mailinglist = SendPulse::MailingList.new(your_client_id, your_client_secret, 'https', nil)
+sendpulse_mailinglist.add_emails(
+  {
+    id: id,
+    emails: [
+      {
+        "email": "test1@gmail.com",
+        "variables": {
+          "variable1": "value1",
+          "variable2": "value2"
+        }
+      },
+      {
+        "email": "test1@gmail.com",
+        "variables": {
+          "variable1": "value1",
+          "variable2": "value2"
+        }
+      }
+    ]
+  }
+)
+```
+
+#### Deleting emails from a mailing list
+
+```ruby
+require 'sendpulse/mailing_list'
+
+sendpulse_mailinglist = SendPulse::MailingList.new(your_client_id, your_client_secret, 'https', nil)
+sendpulse_mailinglist.delete_emails({ id: id, emails: ["test1@gmail.com"] })
+```
+
+#### Retrieving information for specific email address from a mailing list
+
+```ruby
+require 'sendpulse/mailing_list'
+
+sendpulse_mailinglist = SendPulse::MailingList.new(your_client_id, your_client_secret, 'https', nil)
+sendpulse_mailinglist.get_email({ id: id, email: "test1@gmail.com" })
+```
+
+#### Erasing a mailing list
+
+```ruby
+require 'sendpulse/mailing_list'
+
+sendpulse_mailinglist = SendPulse::MailingList.new(your_client_id, your_client_secret, 'https', nil)
+sendpulse_mailinglist.delete(id)
+```
+
+#### Calculating the cost of a campaign carried out by a mailing list
+
+```ruby
+require 'sendpulse/mailing_list'
+
+sendpulse_mailinglist = SendPulse::MailingList.new(your_client_id, your_client_secret, 'https', nil)
+sendpulse_mailinglist.cost(id)
+```
+
 [Here](https://sendpulse.com/integrations/api) is SendPulse API specification.
 
 ## Contributing

data/SendPulse.gemspec

@@ -22,6 +22,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.2'
   spec.add_development_dependency 'dotenv', '~> 2.1.1'
-  spec.add_development_dependency 'simplecov', '~> 0.14.1'
   spec.add_development_dependency 'faker', '~> 1.7.3'
 end

data/lib/sendpulse/api.rb

@@ -61,6 +61,9 @@ module SendPulse
           when 'PUT'
             request = Net::HTTP::Put.new(uri.request_uri, token)
             request.set_form_data(data)
+          when 'DELETE'
+            request = Net::HTTP::Delete.new(uri.request_uri, token)
+            request.set_form_data(data)
           else
             request = Net::HTTP::Get.new(uri.request_uri, token)
         end

data/lib/sendpulse/mailing_list.rb

@@ -0,0 +1,45 @@
+require 'sendpulse/api'
+
+module SendPulse
+  class MailingList < SendPulse::Api
+    def create(list_name)
+      send_request('addressbooks', 'POST', { bookName: list_name })
+    end
+
+    def update(params)
+      send_request("addressbooks/#{params[:id]}", 'PUT', params)
+    end
+
+    def list(params = {})
+      send_request('addressbooks', 'GET', params)
+    end
+
+    def get(id)
+      send_request("addressbooks/#{id}", 'GET')
+    end
+
+    def add_emails(params)
+      send_request("addressbooks/#{params[:id]}/emails", 'POST', { id: params[:id], emails: serialize(params[:emails]) })
+    end
+
+    def get_emails(params)
+      send_request("addressbooks/#{params[:id]}/emails", 'GET', params)
+    end
+
+    def delete_emails(params)
+      send_request("addressbooks/#{params[:id]}/emails", 'DELETE', { emails: serialize(params[:emails]) })
+    end
+
+    def get_email(params)
+      send_request("addressbooks/#{params[:id]}/emails/#{params[:email]}", 'GET', params)
+    end
+
+    def delete(id)
+      send_request("addressbooks/#{id}", 'DELETE')
+    end
+
+    def cost(id)
+      send_request("addressbooks/#{id}/cost", 'GET')
+    end
+  end
+end

data/lib/sendpulse/version.rb

@@ -1,3 +1,3 @@
 module SendPulse
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

data/spec/lib/sendpulse/mailing_list_spec.rb

@@ -0,0 +1,99 @@
+require 'spec_helper'
+require 'faker'
+
+describe SendPulse::MailingList do
+  before(:each) do
+    @client_id = ENV['CLIENT_ID']
+    @client_secret = ENV['CLIENT_SECRET']
+  end
+
+  context "Initialize" do
+    describe "Mailing List" do
+      let(:sendpulse_mailinglist) { described_class.new(@client_id, @client_secret, "https", nil) } 
+      let(:mailinglist) { sendpulse_mailinglist.create("#{Faker::Book.title} #{Time.now.to_i}") }
+
+      it do 
+        expect(mailinglist[:data]).to include("id")
+
+        id = mailinglist[:data]["id"]
+        new_name = "#{Faker::Book.title} #{Time.now.to_i}"
+        update_mailing_list = sendpulse_mailinglist.update({ id: id, name: new_name })
+        expect(update_mailing_list[:data]).to eql({ "result" => true })
+        list = sendpulse_mailinglist.list[:data]
+        first_list = list[0]
+        expect(first_list).to include("id")
+        expect(first_list).to include("name")
+        expect(first_list).to include("all_email_qty")
+        expect(first_list).to include("active_email_qty")
+        expect(first_list).to include("inactive_email_qty")
+        expect(first_list).to include("creationdate")
+        expect(first_list).to include("status")
+        expect(first_list).to include("status_explain")
+        single_list = sendpulse_mailinglist.get(id)[:data][0]
+        expect(single_list).to include("id")
+        expect(single_list).to include("name")
+        expect(single_list).to include("all_email_qty")
+        expect(single_list).to include("active_email_qty")
+        expect(single_list).to include("inactive_email_qty")
+        expect(single_list).to include("creationdate")
+        expect(single_list).to include("status")
+        expect(single_list).to include("status_explain")
+        add_emails = sendpulse_mailinglist.add_emails(
+          { 
+            id: id, 
+            emails: [ 
+              { 
+                "email": "test1@gmail.com", 
+                "variables": { 
+                  "variable1": "value1", 
+                  "variable2": "value2" 
+                } 
+              }, 
+              { 
+                "email": "test2@gmail.com", 
+                "variables": { 
+                  "variable3": "value3", 
+                  "variable4": "value4" 
+                } 
+              }, 
+              { 
+                "email": "test3@gmail.com", 
+                "variables": { 
+                  "variable5": "value5", 
+                  "variable6": "value6" 
+                } 
+              } 
+            ] 
+          }
+        )
+        expect(add_emails[:data]).to eql({ "result" => true })
+        get_emails = sendpulse_mailinglist.get_emails({ id: id })[:data]
+        get_email = get_emails[0]
+        expect(get_email).to include("email")
+        expect(get_email).to include("status")
+        expect(get_email).to include("phone")
+        expect(get_email).to include("status_explain")
+        expect(get_email).to include("variables")
+        get_email = sendpulse_mailinglist.get_email({ id: id, email: "test1@gmail.com" })[:data]
+        expect(get_email).to include("email")
+        expect(get_email).to include("abook_id")
+        expect(get_email).to include("phone")
+        expect(get_email).to include("status")
+        expect(get_email).to include("status_explain")
+        expect(get_email).to include("variables")
+        delete_emails = sendpulse_mailinglist.delete_emails({ id: id, emails: ["test1@gmail.com", "test2@gmail.com"] })
+        expect(delete_emails[:data]).to eql({ "result" => true })
+        cost = sendpulse_mailinglist.cost(id)[:data]
+        expect(cost).to include("cur")
+        expect(cost).to include("sent_emails_qty")
+        expect(cost).to include("overdraftAllEmailsPrice")
+        expect(cost).to include("addressesDeltaFromBalance")
+        expect(cost).to include("addressesDeltaFromTariff")
+        expect(cost).to include("max_emails_per_task")
+        expect(cost).to include("result")
+        delete = sendpulse_mailinglist.delete(id)
+        expect(delete[:data]).to eql({ "result" => true })
+      end
+    end
+  end
+end

data/spec/lib/sendpulse/smtp_spec.rb

@@ -28,20 +28,22 @@ describe SendPulse::Smtp do
       let(:send_email) { sendpulse_smtp.send_email(@email) }
       let(:retrieve_emails) { sendpulse_smtp.retrieve_emails }
 
-      it { expect(sendpulse_smtp).to be_a SendPulse::Smtp }
-      it { expect(send_email[:data]).to eql({ "result" => true }) }
-      it { expect(retrieve_emails[:data][0]).to include("id") }
-      it { expect(retrieve_emails[:data][0]).to include("sender") }
-      it { expect(retrieve_emails[:data][0]).to include("total_size") }
-      it { expect(retrieve_emails[:data][0]).to include("sender_ip") }
-      it { expect(retrieve_emails[:data][0]).to include("smtp_answer_code") }
-      it { expect(retrieve_emails[:data][0]).to include("smtp_answer_code_explain") }
-      it { expect(retrieve_emails[:data][0]).to include("smtp_answer_subcode") }
-      it { expect(retrieve_emails[:data][0]).to include("smtp_answer_data") }
-      it { expect(retrieve_emails[:data][0]).to include("used_ip") }
-      it { expect(retrieve_emails[:data][0]).to include("recipient") }
-      it { expect(retrieve_emails[:data][0]).to include("subject") }
-      it { expect(retrieve_emails[:data][0]).to include("send_date") }
+      it do 
+        expect(sendpulse_smtp).to be_a SendPulse::Smtp
+        expect(send_email[:data]).to eql({ "result" => true })
+        expect(retrieve_emails[:data][0]).to include("id")
+        expect(retrieve_emails[:data][0]).to include("sender")
+        expect(retrieve_emails[:data][0]).to include("total_size")
+        expect(retrieve_emails[:data][0]).to include("sender_ip")
+        expect(retrieve_emails[:data][0]).to include("smtp_answer_code")
+        expect(retrieve_emails[:data][0]).to include("smtp_answer_code_explain")
+        expect(retrieve_emails[:data][0]).to include("smtp_answer_subcode")
+        expect(retrieve_emails[:data][0]).to include("smtp_answer_data")
+        expect(retrieve_emails[:data][0]).to include("used_ip")
+        expect(retrieve_emails[:data][0]).to include("recipient")
+        expect(retrieve_emails[:data][0]).to include("subject")
+        expect(retrieve_emails[:data][0]).to include("send_date")
+      end
     end
   end
 end

data/spec/spec_helper.rb

@@ -3,8 +3,6 @@ require 'dotenv'
 require 'json'
 Dotenv.load
 
-require 'simplecov'
-SimpleCov.start
-
 require 'sendpulse/api'
 require 'sendpulse/smtp'
+require 'sendpulse/mailing_list'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sendpulse
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Yoga Hapriana
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-09 00:00:00.000000000 Z
+date: 2017-04-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,20 +66,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 2.1.1
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.14.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.14.1
 - !ruby/object:Gem::Dependency
   name: faker
   requirement: !ruby/object:Gem::Requirement
@@ -111,9 +97,11 @@ files:
 - SendPulse.gemspec
 - lib/sendpulse/api.rb
 - lib/sendpulse/host.rb
+- lib/sendpulse/mailing_list.rb
 - lib/sendpulse/smtp.rb
 - lib/sendpulse/version.rb
 - spec/lib/sendpulse/api_spec.rb
+- spec/lib/sendpulse/mailing_list_spec.rb
 - spec/lib/sendpulse/smtp_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/yogahp/SendPulse
@@ -142,5 +130,6 @@ specification_version: 4
 summary: Client to http://sendpulse.com/ API.
 test_files:
 - spec/lib/sendpulse/api_spec.rb
+- spec/lib/sendpulse/mailing_list_spec.rb
 - spec/lib/sendpulse/smtp_spec.rb
 - spec/spec_helper.rb