sendgrid4r 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 18804ec5896082dcfa570e2b27a7d58ab6092903
-  data.tar.gz: 09f1702cbe8b86550e66a8f8522b593562ce177d
+  metadata.gz: b7417acd0a5a7f7568d4b05a42983b09da86d716
+  data.tar.gz: eba6a546a827b39af30df5128b267d5432820c80
 SHA512:
-  metadata.gz: cee31b5daa5bdc9b0fb90a7d16b0f7c7ce6efe375870c17200294b57f7c80b87110c3b3a580e985a91f3a1cbcb4ae4c4bf11aad91ecf9559096e917d7125e7ed
-  data.tar.gz: cdac0d4cbbd0308f9c0eb2945f0e566893543f2fb6e5d4f4dd427dfdb9a07e5aa83a64de52e8b44f94ea4f1e4169b13e756180b3a399a49b20f927e28710b763
+  metadata.gz: 8bf55ba5f91ea40f8e9062208b87597a0242526a3101bddd52f6da55c537a99478bccb357676eb99b67bdac5aff8d9b69f17fb9fe4f42e2bad74c6170db39f4d
+  data.tar.gz: 8573913c991b79f02d8c39168e41f574b63ceba5abc4151b1e89d2a0083a8c442c488b5e4b9dbfbaa2958622f6000e6144730f2809e2c5d21fc9c633651b309e

data/.env.example

@@ -1,7 +1,10 @@
 SENDGRID_USERNAME=sendgrid username
 SENDGRID_PASSWORD=sendgrid_password
 API_KEY=apikey
-USE_SILVER=true
 SILVER_SENDGRID_USERNAME=silver_sendgrid_username
 SILVER_SENDGRID_PASSWORD=silver_sendgird_password
 SILVER_SUBUSER=subusername
+SILVER_SUBUSER2=subusername
+SUBUSER1=subusername
+SUBPASS1=password
+SUBMAIL1=email@email.com

data/.travis.yml

@@ -5,4 +5,4 @@ before_script:
   - bundle install
 script:
   - rubocop --fail-level=W
-  - rspec
+  - rspec --tag ut

data/lib/client.rb

@@ -14,8 +14,6 @@ module SendGrid4r
   class Client
     include SendGrid4r::REST::API
 
-    BASE_URL = 'https://api.sendgrid.com/v3'
-
     def initialize(
       username: username, password: password, api_key: api_key = nil
     )

data/lib/sendgrid4r/rest/api.rb

@@ -24,6 +24,8 @@ require 'sendgrid4r/rest/contacts/recipients'
 require 'sendgrid4r/rest/contacts/reserved_fields'
 require 'sendgrid4r/rest/contacts/segments'
 require 'sendgrid4r/rest/api_keys/api_keys'
+require 'sendgrid4r/rest/subusers/subusers'
+require 'sendgrid4r/rest/email_activity/email_activity'
 
 module SendGrid4r
   module REST
@@ -53,6 +55,8 @@ module SendGrid4r
       include SendGrid4r::REST::Contacts::ReservedFields
       include SendGrid4r::REST::Contacts::Segments
       include SendGrid4r::REST::ApiKeys
+      include SendGrid4r::REST::Subusers
+      include SendGrid4r::REST::EmailActivity
     end
   end
 end

data/lib/sendgrid4r/rest/api_keys/api_keys.rb

@@ -15,7 +15,7 @@ module SendGrid4r
       ApiKey = Struct.new(:name, :api_key_id, :api_key, :scope_set_id)
 
       def self.url(api_key = nil)
-        url = "#{SendGrid4r::Client::BASE_URL}/api_keys"
+        url = "#{BASE_URL}/api_keys"
         url = "#{url}/#{api_key}" unless api_key.nil?
         url
       end
@@ -47,9 +47,7 @@ module SendGrid4r
       def post_api_key(name, &block)
         params = {}
         params['name'] = name
-        resp = post(
-          @auth, SendGrid4r::REST::ApiKeys.url, params, &block
-        )
+        resp = post(@auth, SendGrid4r::REST::ApiKeys.url, params, &block)
         SendGrid4r::REST::ApiKeys.create_api_key(resp)
       end
 
@@ -60,12 +58,8 @@ module SendGrid4r
       def patch_api_key(api_key, name, &block)
         params = {}
         params['name'] = name
-        resp = patch(
-          @auth,
-          SendGrid4r::REST::ApiKeys.url(api_key),
-          params,
-          &block
-        )
+        endpoint = SendGrid4r::REST::ApiKeys.url(api_key)
+        resp = patch(@auth, endpoint, params, &block)
         SendGrid4r::REST::ApiKeys.create_api_key(resp)
       end
     end

data/lib/sendgrid4r/rest/asm/global_suppressions.rb

@@ -13,36 +13,29 @@ module SendGrid4r
         include SendGrid4r::REST::Request
 
         def self.url(email_address = nil)
-          url = "#{SendGrid4r::Client::BASE_URL}/asm/suppressions/global"
+          url = "#{BASE_URL}/asm/suppressions/global"
           url = "#{url}/#{email_address}" unless email_address.nil?
           url
         end
 
         def post_global_suppressed_emails(recipient_emails, &block)
           params = { recipient_emails: recipient_emails }
-          resp = post(
-            @auth,
-            SendGrid4r::REST::Asm::GlobalSuppressions.url,
-            params,
-            &block
-          )
+          endpoint = SendGrid4r::REST::Asm::GlobalSuppressions.url
+          resp = post(@auth, endpoint, params, &block)
           SendGrid4r::REST::Asm.create_recipient_emails(resp)
         end
 
         def get_global_suppressed_email(email_address, &block)
-          resp = get(
-            @auth,
-            SendGrid4r::REST::Asm::GlobalSuppressions.url(email_address),
-            &block
-          )
+          endpoint =
+            SendGrid4r::REST::Asm::GlobalSuppressions.url(email_address)
+          resp = get(@auth, endpoint, &block)
           SendGrid4r::REST::Asm.create_recipient_email(resp)
         end
 
         def delete_global_suppressed_email(email_address, &block)
-          delete(
-            @auth,
-            SendGrid4r::REST::Asm::GlobalSuppressions.url(email_address),
-            &block)
+          endpoint =
+            SendGrid4r::REST::Asm::GlobalSuppressions.url(email_address)
+          delete(@auth, endpoint, &block)
         end
       end
     end

data/lib/sendgrid4r/rest/asm/groups.rb

@@ -16,7 +16,7 @@ module SendGrid4r
           :id, :name, :description, :last_email_sent_at, :unsubscribes)
 
         def self.url(group_id = nil)
-          url = "#{SendGrid4r::Client::BASE_URL}/asm/groups"
+          url = "#{BASE_URL}/asm/groups"
           url = "#{url}/#{group_id}" unless group_id.nil?
           url
         end
@@ -58,12 +58,8 @@ module SendGrid4r
         end
 
         def patch_group(group_id, group, &block)
-          resp = patch(
-            @auth,
-            SendGrid4r::REST::Asm::Groups.url(group_id),
-            group.to_h,
-            &block
-          )
+          endpoint = SendGrid4r::REST::Asm::Groups.url(group_id)
+          resp = patch(@auth, endpoint, group.to_h, &block)
           SendGrid4r::REST::Asm::Groups.create_group(resp)
         end
 

data/lib/sendgrid4r/rest/asm/suppressions.rb

@@ -16,15 +16,13 @@ module SendGrid4r
         Suppressions = Struct.new(:suppressions)
 
         def self.url(group_id, email_address = nil)
-          url =
-            "#{SendGrid4r::Client::BASE_URL}"\
-            "/asm/groups/#{group_id}/suppressions"
+          url = "#{BASE_URL}/asm/groups/#{group_id}/suppressions"
           url = "#{url}/#{email_address}" unless email_address.nil?
           url
         end
 
         def self.create_suppressions(resp)
-          resp if resp.nil?
+          return resp if resp.nil?
           suppressions = []
           resp['suppressions'].each do |suppression|
             suppressions.push(
@@ -37,39 +35,48 @@ module SendGrid4r
         end
 
         def self.create_suppression(resp)
-          resp if resp.nil?
+          return resp if resp.nil?
           Suppression.new(
             resp['id'], resp['name'], resp['description'], resp['suppressed']
           )
         end
 
-        def post_suppressed_emails(group_id, recipient_emails)
+        def self.create_emails(resp)
+          return resp if resp.nil?
+          emails = []
+          resp.each do |email|
+            emails.push(email)
+          end
+          emails
+        end
+
+        def post_suppressed_emails(group_id, recipient_emails, &block)
           resp = post(
             @auth,
             SendGrid4r::REST::Asm::Suppressions.url(group_id),
-            recipient_emails: recipient_emails
+            recipient_emails: recipient_emails,
+            &block
           )
           SendGrid4r::REST::Asm.create_recipient_emails(resp)
         end
 
-        def get_suppressed_emails(group_id)
-          get(
-            @auth,
-            SendGrid4r::REST::Asm::Suppressions.url(group_id)
-          )
+        def get_suppressed_emails(group_id, &block)
+          endpoint = SendGrid4r::REST::Asm::Suppressions.url(group_id)
+          resp = get(@auth, endpoint, &block)
+          SendGrid4r::REST::Asm::Suppressions.create_emails(resp)
         end
 
-        def get_suppressions(email_address)
-          resp = get(
-            @auth,
-            "#{SendGrid4r::Client::BASE_URL}/asm/suppressions/#{email_address}")
+        def get_suppressions(email_address, &block)
+          endpoint = "#{BASE_URL}/asm/suppressions/#{email_address}"
+          resp = get(@auth, endpoint, &block)
           SendGrid4r::REST::Asm::Suppressions.create_suppressions(resp)
         end
 
-        def delete_suppressed_email(group_id, email_address)
+        def delete_suppressed_email(group_id, email_address, &block)
           delete(
             @auth,
-            SendGrid4r::REST::Asm::Suppressions.url(group_id, email_address)
+            SendGrid4r::REST::Asm::Suppressions.url(group_id, email_address),
+            &block
           )
         end
       end

data/lib/sendgrid4r/rest/categories/categories.rb

@@ -37,9 +37,7 @@ module SendGrid4r
           params['category'] = category unless category.nil?
           params['limit'] = limit unless limit.nil?
           params['offset'] = offset unless limit.nil?
-          resp = get(
-            @auth, "#{SendGrid4r::Client::BASE_URL}/categories", params, &block
-          )
+          resp = get(@auth, "#{BASE_URL}/categories", params, &block)
           SendGrid4r::REST::Categories::Categories.create_categories(resp)
         end
       end

data/lib/sendgrid4r/rest/contacts/custom_fields.rb

@@ -25,7 +25,7 @@ module SendGrid4r
         Fields = Struct.new(:custom_fields)
 
         def self.url(custom_field_id = nil)
-          url = "#{SendGrid4r::Client::BASE_URL}/contactdb/custom_fields"
+          url = "#{BASE_URL}/contactdb/custom_fields"
           url = "#{url}/#{custom_field_id}" unless custom_field_id.nil?
           url
         end

data/lib/sendgrid4r/rest/contacts/lists.rb

@@ -16,7 +16,7 @@ module SendGrid4r
         Lists = Struct.new(:lists)
 
         def self.url(list_id = nil)
-          url = "#{SendGrid4r::Client::BASE_URL}/contactdb/lists"
+          url = "#{BASE_URL}/contactdb/lists"
           url = "#{url}/#{list_id}" unless list_id.nil?
           url
         end
@@ -65,12 +65,8 @@ module SendGrid4r
         def patch_list(list_id, name, &block)
           params = {}
           params['name'] = name
-          resp = patch(
-            @auth,
-            SendGrid4r::REST::Contacts::Lists.url(list_id),
-            params,
-            &block
-          )
+          endpoint = SendGrid4r::REST::Contacts::Lists.url(list_id)
+          resp = patch(@auth, endpoint, params, &block)
           SendGrid4r::REST::Contacts::Lists.create_list(resp)
         end
 
@@ -81,54 +77,36 @@ module SendGrid4r
         # no bodies returned
         def post_recipients_to_list(list_id, recipients, &block)
           url = SendGrid4r::REST::Contacts::Lists.url(list_id)
-          post(
-            @auth,
-            "#{url}/recipients_batch",
-            recipients,
-            &block
-          )
+          endpoint = "#{url}/recipients_batch"
+          post(@auth, endpoint, recipients, &block)
         end
 
         def get_recipients_from_list(list_id, limit = nil, offset = nil, &block)
           params = {}
           params['limit'] = limit unless limit.nil?
           params['offset'] = offset unless offset.nil?
-          resp = get(
-            @auth,
-            SendGrid4r::REST::Contacts::Lists.recipients_url(list_id),
-            params,
-            &block
-          )
+          endpoint = SendGrid4r::REST::Contacts::Lists.recipients_url(list_id)
+          resp = get(@auth, endpoint, params, &block)
           SendGrid4r::REST::Contacts::Recipients.create_recipients(resp)
         end
 
         def post_recipient_to_list(list_id, recipient_id, &block)
-          post(
-            @auth,
-            SendGrid4r::REST::Contacts::Lists.recipients_url(
-              list_id, recipient_id
-            ),
-            &block
+          endpoint = SendGrid4r::REST::Contacts::Lists.recipients_url(
+            list_id, recipient_id
           )
+          post(@auth, endpoint, &block)
         end
 
         def delete_recipient_from_list(list_id, recipient_id, &block)
-          delete(
-            @auth,
-            SendGrid4r::REST::Contacts::Lists.recipients_url(
-              list_id, recipient_id
-            ),
-            &block
+          endpoint = SendGrid4r::REST::Contacts::Lists.recipients_url(
+            list_id, recipient_id
           )
+          delete(@auth, endpoint, &block)
         end
 
         def delete_lists(list_ids, &block)
-          delete(
-            @auth,
-            "#{SendGrid4r::Client::BASE_URL}/contactdb/lists_batch",
-            list_ids,
-            &block
-          )
+          endpoint = "#{BASE_URL}/contactdb/lists_batch"
+          delete(@auth, endpoint, list_ids, &block)
         end
       end
     end

data/lib/sendgrid4r/rest/contacts/recipients.rb

@@ -61,79 +61,58 @@ module SendGrid4r
         end
 
         def self.url(recipient_id = nil)
-          url = "#{SendGrid4r::Client::BASE_URL}/contactdb/recipients"
+          url = "#{BASE_URL}/contactdb/recipients"
           url = "#{url}/#{recipient_id}" unless recipient_id.nil?
           url
         end
 
         def post_recipient(params, &block)
-          resp = post(
-            @auth, SendGrid4r::REST::Contacts::Recipients.url, params, &block
-          )
+          endpoint = SendGrid4r::REST::Contacts::Recipients.url
+          resp = post(@auth, endpoint, params, &block)
           SendGrid4r::REST::Contacts::Recipients.create_recipient(resp)
         end
 
         def delete_recipients(emails, &block)
-          delete(
-            @auth, SendGrid4r::REST::Contacts::Recipients.url, emails, &block
-          )
+          endpoint = SendGrid4r::REST::Contacts::Recipients.url
+          delete(@auth, endpoint, emails, &block)
         end
 
         def get_recipients(limit = nil, offset = nil, &block)
           params = {}
           params['limit'] = limit unless limit.nil?
           params['offset'] = offset unless offset.nil?
-          resp = get(
-            @auth, SendGrid4r::REST::Contacts::Recipients.url, params, &block
-          )
+          endpoint = SendGrid4r::REST::Contacts::Recipients.url
+          resp = get(@auth, endpoint, params, &block)
           SendGrid4r::REST::Contacts::Recipients.create_recipients(resp)
         end
 
         def get_recipients_by_id(recipient_ids, &block)
-          resp = get(
-            @auth,
-            "#{SendGrid4r::REST::Contacts::Recipients.url}/batch",
-            nil,
-            recipient_ids,
-            &block
-          )
+          endpoint = "#{SendGrid4r::REST::Contacts::Recipients.url}/batch"
+          resp = get(@auth, endpoint, nil, recipient_ids, &block)
           SendGrid4r::REST::Contacts::Recipients.create_recipients(resp)
         end
 
         def get_recipients_count(&block)
-          resp = get(
-            @auth,
-            "#{SendGrid4r::REST::Contacts::Recipients.url}/count",
-            &block
-          )
+          endpoint = "#{SendGrid4r::REST::Contacts::Recipients.url}/count"
+          resp = get(@auth, endpoint, &block)
           resp['recipient_count'] unless resp.nil?
         end
 
         def search_recipients(params, &block)
-          resp = get(
-            @auth,
-            "#{SendGrid4r::REST::Contacts::Recipients.url}/search",
-            params,
-            &block
-          )
+          endpoint = "#{SendGrid4r::REST::Contacts::Recipients.url}/search"
+          resp = get(@auth, endpoint, params, &block)
           SendGrid4r::REST::Contacts::Recipients.create_recipients(resp)
         end
 
         def get_recipient(recipient_id, &block)
-          resp = get(
-            @auth,
-            SendGrid4r::REST::Contacts::Recipients.url(recipient_id),
-            &block
-          )
+          endpoint = SendGrid4r::REST::Contacts::Recipients.url(recipient_id)
+          resp = get(@auth, endpoint, &block)
           SendGrid4r::REST::Contacts::Recipients.create_recipient(resp)
         end
 
         def delete_recipient(recipient_id, &block)
-          delete(
-            @auth,
-            SendGrid4r::REST::Contacts::Recipients.url(recipient_id),
-            &block
-          )
+          endpoint = SendGrid4r::REST::Contacts::Recipients.url(recipient_id)
+          delete(@auth, endpoint, &block)
         end
 
         def get_lists_recipient_belong(recipient_id, &block)
@@ -146,12 +125,8 @@ module SendGrid4r
         end
 
         def post_recipients(recipients, &block)
-          resp = post(
-            @auth,
-            "#{SendGrid4r::Client::BASE_URL}/contactdb/recipients_batch",
-            recipients,
-            &block
-          )
+          endpoint = "#{BASE_URL}/contactdb/recipients_batch"
+          resp = post(@auth, endpoint, recipients, &block)
           SendGrid4r::REST::Contacts::Recipients.create_result(resp)
         end
 

data/lib/sendgrid4r/rest/contacts/reserved_fields.rb

@@ -41,11 +41,7 @@ module SendGrid4r
         end
 
         def get_reserved_fields(&block)
-          resp = get(
-            @auth,
-            "#{SendGrid4r::Client::BASE_URL}/contactdb/reserved_fields",
-            &block
-          )
+          resp = get(@auth, "#{BASE_URL}/contactdb/reserved_fields", &block)
           SendGrid4r::REST::Contacts::ReservedFields.create_fields(resp)
         end
       end

data/lib/sendgrid4r/rest/contacts/segments.rb

@@ -21,7 +21,7 @@ module SendGrid4r
         Segments = Struct.new(:segments)
 
         def self.url(segment_id = nil)
-          url = "#{SendGrid4r::Client::BASE_URL}/contactdb/segments"
+          url = "#{BASE_URL}/contactdb/segments"
           url = "#{url}/#{segment_id}" unless segment_id.nil?
           url
         end
@@ -62,9 +62,8 @@ module SendGrid4r
         end
 
         def post_segment(params, &block)
-          resp = post(
-            @auth, SendGrid4r::REST::Contacts::Segments.url, params.to_h, &block
-          )
+          endpoint = SendGrid4r::REST::Contacts::Segments.url
+          resp = post(@auth, endpoint, params.to_h, &block)
           SendGrid4r::REST::Contacts::Segments.create_segment(resp)
         end
 
@@ -74,26 +73,20 @@ module SendGrid4r
         end
 
         def get_segment(segment_id, &block)
-          resp = get(
-            @auth, SendGrid4r::REST::Contacts::Segments.url(segment_id), &block
-          )
+          endpoint = SendGrid4r::REST::Contacts::Segments.url(segment_id)
+          resp = get(@auth, endpoint, &block)
           SendGrid4r::REST::Contacts::Segments.create_segment(resp)
         end
 
         def put_segment(segment_id, params, &block)
-          resp = put(
-            @auth,
-            SendGrid4r::REST::Contacts::Segments.url(segment_id),
-            params,
-            &block
-          )
+          endpoint = SendGrid4r::REST::Contacts::Segments.url(segment_id)
+          resp = put(@auth, endpoint, params, &block)
           SendGrid4r::REST::Contacts::Segments.create_segment(resp)
         end
 
         def delete_segment(segment_id, &block)
-          delete(
-            @auth, SendGrid4r::REST::Contacts::Segments.url(segment_id), &block
-          )
+          endpoint = SendGrid4r::REST::Contacts::Segments.url(segment_id)
+          delete(@auth, endpoint, &block)
         end
 
         def get_recipients_from_segment(

data/lib/sendgrid4r/rest/email_activity/email_activity.rb

@@ -0,0 +1,84 @@
+# -*- encoding: utf-8 -*-
+$LOAD_PATH.unshift File.dirname(__FILE__)
+
+require 'sendgrid4r/rest/request'
+
+module SendGrid4r
+  module REST
+    #
+    # SendGrid Web API v3 EmailActivity
+    #
+    module EmailActivity
+      include SendGrid4r::REST::Request
+
+      #
+      # SendGrid Web API v3 Stats - AggregatedBy
+      #
+      module Event
+        BOUNCES = 'bounces'
+        CLICKS = 'clicks'
+        DEFERRED = 'deferred'
+        DELIVERED = 'delivered'
+        DROPS = 'drops'
+        GROUP_UNSUBSCRIBE = 'group_unsubscribe'
+        GROUP_RESUBSCRIBE = 'group_resubscribe'
+        OPENS = 'opens'
+        PROCESSED = 'processed'
+        PARSEAPI = 'parseapi'
+        SPAM_REPORTS = 'spam_reports'
+        UNSUBSCRIBE = 'unsubscribes'
+      end
+
+      Activity = Struct.new(
+        :email, :event, :created, :category, :smtp_id, :asm_group_id,
+        :msg_id, :ip, :url, :reason
+      )
+
+      def self.url
+        url = "#{BASE_URL}/email_activity"
+        url
+      end
+
+      def self.create_activities(resp)
+        return resp if resp.nil?
+        activities = []
+        resp.each do |activity|
+          activities.push(
+            SendGrid4r::REST::EmailActivity.create_activity(activity)
+          )
+        end
+        activities
+      end
+
+      def self.create_activity(resp)
+        return resp if resp.nil?
+        Activity.new(
+          resp['email'],
+          resp['event'],
+          resp['created'].nil? ? nil : Time.at(resp['created']),
+          resp['category'],
+          resp['smtp_id'],
+          resp['asm_group_id'],
+          resp['msg_id'],
+          resp['ip'],
+          resp['url'],
+          resp['reason']
+        )
+      end
+
+      def get_email_activities(
+        email: nil, events: nil, exclude_events: nil, start_time: nil,
+        end_time: nil, &block
+      )
+        params = {}
+        params['email'] = email unless email.nil?
+        params['events'] = events unless events.nil?
+        params['exclude_events'] = exclude_events unless exclude_events.nil?
+        params['start_time'] = start_time.to_i unless start_time.nil?
+        params['end_time'] = end_time.to_i unless end_time.nil?
+        resp = get(@auth, SendGrid4r::REST::EmailActivity.url, params, &block)
+        SendGrid4r::REST::EmailActivity.create_activities(resp)
+      end
+    end
+  end
+end