sendgrid4r 1.8.1 → 1.10.0

data/lib/sendgrid4r/rest/stats/stats.rb

@@ -1,81 +1,71 @@
 # -*- encoding: utf-8 -*-
 
-module SendGrid4r
-  module REST
+module SendGrid4r::REST
+  #
+  # SendGrid Web API v3 Stats
+  #
+  module Stats
     #
-    # SendGrid Web API v3 Stats
+    # [DEPRECATED] SendGrid Web API v3 Stats - AggregatedBy
     #
-    module Stats
-      #
-      # SendGrid Web API v3 Stats - AggregatedBy
-      #
-      module AggregatedBy
-        DAY = 'day'
-        WEEK = 'week'
-        MONTH = 'month'
-      end
+    module AggregatedBy
+      DAY = 'day'
+      WEEK = 'week'
+      MONTH = 'month'
+    end
 
-      TopStat = Struct.new(:date, :stats)
-      Stat        = Struct.new(:metrics, :name, :type)
-      Metric      = Struct.new(
-        :blocks,
-        :bounce_drops,
-        :bounces,
-        :clicks,
-        :deferred,
-        :delivered,
-        :drops,
-        :invalid_emails,
-        :opens,
-        :processed,
-        :requests,
-        :spam_report_drops,
-        :spam_reports,
-        :unique_clicks,
-        :unique_opens,
-        :unsubscribe_drops,
-        :unsubscribes,
-        :received
-      )
+    TopStat = Struct.new(:date, :stats)
+    Stat        = Struct.new(:metrics, :name, :type)
+    Metric      = Struct.new(
+      :blocks,
+      :bounce_drops,
+      :bounces,
+      :clicks,
+      :deferred,
+      :delivered,
+      :drops,
+      :invalid_emails,
+      :opens,
+      :processed,
+      :requests,
+      :spam_report_drops,
+      :spam_reports,
+      :unique_clicks,
+      :unique_opens,
+      :unsubscribe_drops,
+      :unsubscribes,
+      :received
+    )
 
-      def self.create_top_stat(resp)
-        return resp if resp.nil?
-        stats = []
-        resp['stats'].each do |stat|
-          stats.push(SendGrid4r::REST::Stats.create_stat(stat))
-        end
-        TopStat.new(resp['date'], stats)
-      end
+    def self.create_top_stat(resp)
+      return resp if resp.nil?
+      stats = resp['stats'].map { |stat| Stats.create_stat(stat) }
+      TopStat.new(resp['date'], stats)
+    end
 
-      def self.create_stat(resp)
-        return resp if resp.nil?
-        stat = SendGrid4r::REST::Stats.create_metric(resp['metrics'])
-        Stat.new(stat, resp['name'], resp['type'])
-      end
+    def self.create_stat(resp)
+      return resp if resp.nil?
+      Stat.new(Stats.create_metric(resp['metrics']), resp['name'], resp['type'])
+    end
 
-      def self.create_metric(resp)
-        return resp if resp.nil?
-        Metric.new(
-          resp['blocks'],       resp['bounce_drops'],
-          resp['bounces'],      resp['clicks'],
-          resp['deferred'],     resp['delivered'],
-          resp['drops'],        resp['invalid_emails'],
-          resp['opens'],        resp['processed'],
-          resp['requests'],     resp['spam_report_drops'],
-          resp['spam_reports'], resp['unique_clicks'],
-          resp['unique_opens'], resp['unsubscribe_drops'],
-          resp['unsubscribes'], resp['received']
-        )
-      end
+    def self.create_metric(resp)
+      return resp if resp.nil?
+      Metric.new(
+        resp['blocks'],       resp['bounce_drops'],
+        resp['bounces'],      resp['clicks'],
+        resp['deferred'],     resp['delivered'],
+        resp['drops'],        resp['invalid_emails'],
+        resp['opens'],        resp['processed'],
+        resp['requests'],     resp['spam_report_drops'],
+        resp['spam_reports'], resp['unique_clicks'],
+        resp['unique_opens'], resp['unsubscribe_drops'],
+        resp['unsubscribes'], resp['received']
+      )
+    end
 
-      def self.create_top_stats(resp_a)
-        return resp_a if resp_a.nil?
-        top_stats = []
-        resp_a.each do |resp|
-          top_stats.push(SendGrid4r::REST::Stats.create_top_stat(resp))
-        end
-        top_stats
-      end
+    def self.create_top_stats(resp_a)
+      return resp_a if resp_a.nil?
+      resp_a.map { |resp| Stats.create_top_stat(resp) }
     end
   end
 end

data/lib/sendgrid4r/rest/stats/subuser.rb

@@ -1,40 +1,78 @@
 # -*- encoding: utf-8 -*-
 
-module SendGrid4r
-  module REST
-    module Stats
-      #
-      # SendGrid Web API v3 Stats - Subuser
-      #
-      module Subuser
-        include SendGrid4r::REST::Request
+module SendGrid4r::REST
+  module Stats
+    #
+    # SendGrid Web API v3 Stats - Subuser
+    #
+    module Subuser
+      include Request
 
-        def get_subusers_stats(
-            start_date:, end_date: nil, aggregated_by: nil, subusers:, &block)
-          params = {
-            start_date: start_date,
-            end_date: end_date,
-            aggregated_by: aggregated_by,
-            subusers: subusers
-          }
-          resp = get(@auth, "#{BASE_URL}/subusers/stats", params, &block)
-          SendGrid4r::REST::Stats.create_top_stats(resp)
+      def self.url(subuser_name = nil, aggregate = nil)
+        url = "#{BASE_URL}/subusers"
+        if subuser_name.nil?
+          url = "#{url}/stats"
+        else
+          url = "#{url}/#{subuser_name}/stats"
         end
+        url = "#{url}/#{aggregate}" unless aggregate.nil?
+        url
+      end
 
-        def get_subusers_stats_sums(
-            start_date:, end_date: nil, sort_by_metric: nil,
-            sort_by_direction: nil, limit: nil, offset: nil, &block)
-          params = {
-            start_date: start_date,
-            end_date: end_date,
-            sort_by_metric: sort_by_metric,
-            sort_by_direction: sort_by_direction,
-            limit: limit,
-            offset: offset
-          }
-          resp = get(@auth, "#{BASE_URL}/subusers/stats/sums", params, &block)
-          SendGrid4r::REST::Stats.create_top_stat(resp)
-        end
+      def get_subusers_stats(
+          start_date:, end_date: nil, aggregated_by: nil, subusers:, &block)
+        params = {
+          start_date: start_date,
+          end_date: end_date,
+          aggregated_by: aggregated_by,
+          subusers: subusers
+        }
+        resp = get(@auth, Subuser.url, params, &block)
+        Stats.create_top_stats(resp)
+      end
+
+      def get_subusers_stats_sums(
+          start_date:, end_date: nil, sort_by_metric: nil,
+          sort_by_direction: nil, limit: nil, offset: nil, &block)
+        params = {
+          start_date: start_date,
+          end_date: end_date,
+          sort_by_metric: sort_by_metric,
+          sort_by_direction: sort_by_direction,
+          limit: limit,
+          offset: offset
+        }
+        resp = get(@auth, Subuser.url(nil, :sums), params, &block)
+        Stats.create_top_stat(resp)
+      end
+
+      def get_subusers_stats_monthly(
+          date:, subuser: nil, sort_by_metric: nil, sort_by_direction: nil,
+          limit: nil, offset: nil, &block)
+        params = {
+          date: date,
+          subuser: subuser,
+          sort_by_metric: sort_by_metric,
+          sort_by_direction: sort_by_direction,
+          limit: limit,
+          offset: offset
+        }
+        resp = get(@auth, Subuser.url(nil, :monthly), params, &block)
+        Stats.create_top_stat(resp)
+      end
+
+      def get_subuser_stats_monthly(
+          subuser_name:, date:, sort_by_metric: nil, sort_by_direction: nil,
+          limit: nil, offset: nil, &block)
+        params = {
+          date: date,
+          sort_by_metric: sort_by_metric,
+          sort_by_direction: sort_by_direction,
+          limit: limit,
+          offset: offset
+        }
+        resp = get(@auth, Subuser.url(subuser_name, :monthly), params, &block)
+        Stats.create_top_stat(resp)
       end
     end
   end

data/lib/sendgrid4r/rest/subusers.rb

@@ -1,140 +1,112 @@
 # -*- encoding: utf-8 -*-
 
-module SendGrid4r
-  module REST
-    #
-    # SendGrid Web API v3 Subusers
-    #
-    module Subusers
-      include SendGrid4r::REST::Request
-
-      Subuser = Struct.new(
-        :id, :username, :email, :password, :ips, :reputation, :disabled
+module SendGrid4r::REST
+  #
+  # SendGrid Web API v3 Subusers
+  #
+  module Subusers
+    include Request
+
+    Subuser = Struct.new(
+      :id, :username, :email, :password, :ips, :reputation, :disabled
+    )
+    Ips = Struct.new(:ips)
+
+    def self.url(subuser_name = nil)
+      url = "#{BASE_URL}/subusers"
+      url = "#{url}/#{subuser_name}" unless subuser_name.nil?
+      url
+    end
+
+    def self.url_monitor(username)
+      "#{Subusers.url(username)}/monitor"
+    end
+
+    def self.create_subusers(resp)
+      return resp if resp.nil?
+      resp.map { |subuser| Subusers.create_subuser(subuser) }
+    end
+
+    def self.create_subuser(resp)
+      return resp if resp.nil?
+      Subuser.new(
+        resp['id'],
+        resp['username'],
+        resp['email'],
+        resp['password'],
+        resp['ips'],
+        resp['reputation'],
+        resp['disabled']
       )
-      Ips = Struct.new(:ips)
-
-      def self.url(subuser_name = nil)
-        url = "#{BASE_URL}/subusers"
-        url = "#{url}/#{subuser_name}" unless subuser_name.nil?
-        url
-      end
-
-      def self.create_subusers(resp)
-        return resp if resp.nil?
-        subusers = []
-        resp.each do |subuser|
-          subusers.push(SendGrid4r::REST::Subusers.create_subuser(subuser))
-        end
-        subusers
-      end
-
-      def self.create_subuser(resp)
-        return resp if resp.nil?
-        Subuser.new(
-          resp['id'],
-          resp['username'],
-          resp['email'],
-          resp['password'],
-          resp['ips'],
-          resp['reputation'],
-          resp['disabled']
-        )
-      end
-
-      Monitor = Struct.new(:email, :frequency)
-
-      def self.create_monitor(resp)
-        return resp if resp.nil?
-        Monitor.new(
-          resp['email'],
-          resp['frequency']
-        )
-      end
-
-      def get_subusers(limit: nil, offset: nil, username: nil, &block)
-        params = {}
-        params['limit'] = limit unless limit.nil?
-        params['offset'] = offset unless offset.nil?
-        params['username'] = username unless username.nil?
-        resp = get(@auth, SendGrid4r::REST::Subusers.url, params, &block)
-        SendGrid4r::REST::Subusers.create_subusers(resp)
-      end
-
-      def post_subuser(username:, email:, password:, ips:, &block)
-        params = {}
-        params['username'] = username
-        params['email'] = email
-        params['password'] = password
-        params['ips'] = ips
-        resp = post(@auth, SendGrid4r::REST::Subusers.url, params, &block)
-        SendGrid4r::REST::Subusers.create_subuser(resp)
-      end
-
-      def patch_subuser(username:, disabled:, &block)
-        endpoint = SendGrid4r::REST::Subusers.url(username)
-        payload = {}
-        payload['disabled'] = disabled
-        resp = patch(@auth, endpoint, payload, &block)
-        SendGrid4r::REST::Subusers.create_subuser(resp)
-      end
-
-      def delete_subuser(username:, &block)
-        endpoint = SendGrid4r::REST::Subusers.url(username)
-        delete(@auth, endpoint, &block)
-      end
-
-      def get_subuser_monitor(username:, email:, frequency:, &block)
-        endpoint = SendGrid4r::REST::Subusers.url(username)
-        endpoint = "#{endpoint}/monitor"
-        payload = {}
-        payload['email'] = email
-        payload['frequency'] = frequency
-        resp = post(@auth, endpoint, payload, &block)
-        SendGrid4r::REST::Subusers.create_monitor(resp)
-      end
-
-      def post_subuser_monitor(username:, email:, frequency:, &block)
-        endpoint = SendGrid4r::REST::Subusers.url(username)
-        endpoint = "#{endpoint}/monitor"
-        payload = {}
-        payload['email'] = email
-        payload['frequency'] = frequency
-        resp = post(@auth, endpoint, payload, &block)
-        SendGrid4r::REST::Subusers.create_monitor(resp)
-      end
-
-      def put_subuser_monitor(username:, email:, frequency:, &block)
-        endpoint = SendGrid4r::REST::Subusers.url(username)
-        endpoint = "#{endpoint}/monitor"
-        payload = {}
-        payload['email'] = email
-        payload['frequency'] = frequency
-        resp = put(@auth, endpoint, payload, &block)
-        SendGrid4r::REST::Subusers.create_monitor(resp)
-      end
-
-      def delete_subuser_monitor(username:, &block)
-        endpoint = SendGrid4r::REST::Subusers.url(username)
-        endpoint = "#{endpoint}/monitor"
-        delete(@auth, endpoint, &block)
-      end
-
-      def get_subuser_reputation(usernames:, &block)
-        params = ''
-        usernames.each do |username|
-          params += "usernames=#{username}&"
-        end
-        endpoint = SendGrid4r::REST::Subusers.url
-        endpoint = "#{endpoint}/reputations?#{params}"
-        resp = get(@auth, endpoint, usernames, &block)
-        SendGrid4r::REST::Subusers.create_subusers(resp)
-      end
-
-      def put_subuser_assigned_ips(username:, ips:, &block)
-        endpoint = "#{SendGrid4r::REST::Subusers.url(username)}/ips"
-        resp = put(@auth, endpoint, ips, &block)
-        SendGrid4r::REST::Subusers.create_subuser(resp)
-      end
+    end
+
+    Monitor = Struct.new(:email, :frequency)
+
+    def self.create_monitor(resp)
+      return resp if resp.nil?
+      Monitor.new(resp['email'], resp['frequency'])
+    end
+
+    def get_subusers(limit: nil, offset: nil, username: nil, &block)
+      params = {}
+      params[:limit] = limit unless limit.nil?
+      params[:offset] = offset unless offset.nil?
+      params[:username] = username unless username.nil?
+      Subusers.create_subusers(get(@auth, Subusers.url, params, &block))
+    end
+
+    def post_subuser(username:, email:, password:, ips:, &block)
+      params = {
+        username: username,
+        email: email,
+        password: password,
+        ips: ips
+      }
+      Subusers.create_subuser(post(@auth, Subusers.url, params, &block))
+    end
+
+    def patch_subuser(username:, disabled:, &block)
+      payload = { disabled: disabled }
+      resp = patch(@auth, Subusers.url(username), payload, &block)
+      Subusers.create_subuser(resp)
+    end
+
+    def delete_subuser(username:, &block)
+      delete(@auth, Subusers.url(username), &block)
+    end
+
+    def get_subuser_monitor(username:, email:, frequency:, &block)
+      endpoint = Subusers.url_monitor(username)
+      payload = { email: email, frequency: frequency }
+      Subusers.create_monitor(post(@auth, endpoint, payload, &block))
+    end
+
+    def post_subuser_monitor(username:, email:, frequency:, &block)
+      endpoint = Subusers.url_monitor(username)
+      payload = { email: email, frequency: frequency }
+      Subusers.create_monitor(post(@auth, endpoint, payload, &block))
+    end
+
+    def put_subuser_monitor(username:, email:, frequency:, &block)
+      endpoint = Subusers.url_monitor(username)
+      payload = { email: email, frequency: frequency }
+      Subusers.create_monitor(put(@auth, endpoint, payload, &block))
+    end
+
+    def delete_subuser_monitor(username:, &block)
+      delete(@auth, Subusers.url_monitor(username), &block)
+    end
+
+    def get_subuser_reputation(usernames:, &block)
+      params = ''
+      usernames.each { |username| params += "usernames=#{username}&" }
+      endpoint = "#{Subusers.url}/reputations?#{params}"
+      Subusers.create_subusers(get(@auth, endpoint, usernames, &block))
+    end
+
+    def put_subuser_assigned_ips(username:, ips:, &block)
+      resp = put(@auth, "#{Subusers.url(username)}/ips", ips, &block)
+      Subusers.create_subuser(resp)
     end
   end
 end

data/lib/sendgrid4r/rest/transactional_templates/templates.rb

@@ -0,0 +1,63 @@
+# -*- encoding: utf-8 -*-
+
+module SendGrid4r::REST
+  #
+  # SendGrid Web API v3 Template Engine - Templates
+  #
+  module TransactionalTemplates
+    include Request
+
+    Templates = Struct.new(:templates)
+    Template = Struct.new(:id, :name, :versions)
+
+    def self.url(temp_id = nil)
+      url = "#{BASE_URL}/templates"
+      url = "#{url}/#{temp_id}" unless temp_id.nil?
+      url
+    end
+
+    def self.create_templates(resp)
+      return resp if resp.nil?
+      tmps = resp['templates'].map do |template|
+        TransactionalTemplates.create_template(template)
+      end
+      Templates.new(tmps)
+    end
+
+    def self.create_template(resp)
+      return resp if resp.nil?
+      vers = resp['versions'].map do |ver|
+        TransactionalTemplates::Versions.create_version(ver)
+      end
+      Template.new(resp['id'], resp['name'], vers)
+    end
+
+    def post_template(name:, &block)
+      endpoint = TransactionalTemplates.url
+      resp = post(@auth, endpoint, name: name, &block)
+      TransactionalTemplates.create_template(resp)
+    end
+
+    def get_templates(&block)
+      resp = get(@auth, TransactionalTemplates.url, &block)
+      TransactionalTemplates.create_templates(resp)
+    end
+
+    def get_template(template_id:, &block)
+      endpoint = TransactionalTemplates.url(template_id)
+      resp = get(@auth, endpoint, &block)
+      TransactionalTemplates.create_template(resp)
+    end
+
+    def patch_template(template_id:, name:, &block)
+      endpoint = TransactionalTemplates.url(template_id)
+      resp = patch(@auth, endpoint, name: name, &block)
+      TransactionalTemplates.create_template(resp)
+    end
+
+    def delete_template(template_id:, &block)
+      endpoint = TransactionalTemplates.url(template_id)
+      delete(@auth, endpoint, &block)
+    end
+  end
+end

data/lib/sendgrid4r/rest/transactional_templates/versions.rb

@@ -0,0 +1,90 @@
+# -*- encoding: utf-8 -*-
+
+module SendGrid4r::REST
+  #
+  # SendGrid Web API v3 Template Engine - Templates
+  #
+  module TransactionalTemplates
+    #
+    # SendGrid Web API v3 Template Engine - Versions
+    #
+    module Versions
+      include Request
+
+      Version = Struct.new(
+        :id, :user_id, :template_id, :active, :name, :html_content,
+        :plain_content, :subject, :updated_at)
+
+      def self.create_version(resp)
+        return resp if resp.nil?
+        Version.new(
+          resp['id'],
+          resp['user_id'],
+          resp['template_id'],
+          resp['active'],
+          resp['name'],
+          resp['html_content'],
+          resp['plain_content'],
+          resp['subject'],
+          resp['updated_at'])
+      end
+
+      def self.url(temp_id, ver_id = nil)
+        url = "#{BASE_URL}/templates/#{temp_id}/versions"
+        url = "#{url}/#{ver_id}" unless ver_id.nil?
+        url
+      end
+
+      def post_version(template_id:, version:, &block)
+        resp = post(
+          @auth,
+          Versions.url(template_id),
+          remove_uneditable_keys(version.to_h),
+          &block
+        )
+        Versions.create_version(resp)
+      end
+
+      def activate_version(template_id:, version_id:, &block)
+        url = Versions.url(template_id, version_id)
+        resp = post(@auth, "#{url}/activate", &block)
+        Versions.create_version(resp)
+      end
+
+      def get_version(template_id:, version_id:, &block)
+        resp = get(
+          @auth,
+          Versions.url(template_id, version_id),
+          &block
+        )
+        Versions.create_version(resp)
+      end
+
+      def patch_version(template_id:, version_id:, version:, &block)
+        resp = patch(
+          @auth,
+          Versions.url(template_id, version_id),
+          remove_uneditable_keys(version.to_h),
+          &block
+        )
+        Versions.create_version(resp)
+      end
+
+      def delete_version(template_id:, version_id:, &block)
+        delete(
+          @auth,
+          Versions.url(template_id, version_id),
+          &block
+        )
+      end
+
+      private
+
+      def remove_uneditable_keys(hash_value)
+        hash_value.delete(:id) if hash_value.key?(:id)
+        hash_value.delete(:template_id) if hash_value.key?(:template_id)
+        hash_value
+      end
+    end
+  end
+end