sendgrid4r 0.0.5 → 0.1.0

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

@@ -0,0 +1,68 @@
+# -*- encoding: utf-8 -*-
+$LOAD_PATH.unshift File.dirname(__FILE__)
+
+require 'sendgrid4r/rest/request'
+
+module SendGrid4r
+  module REST
+    module Asm
+      #
+      # SendGrid Web API v3 Advanced Suppression Manager - Suppressions
+      #
+      module Suppressions
+        include SendGrid4r::REST::Request
+
+        Suppression = Struct.new(:id, :name, :description, :suppressed)
+
+        def self.url(group_id, email_address = nil)
+          url =
+            "#{SendGrid4r::Client::BASE_URL}"\
+            "/asm/groups/#{group_id}/suppressions"
+          url = "#{url}/#{email_address}" unless email_address.nil?
+          url
+        end
+
+        def self.create_suppression(resp)
+          Suppression.new(
+            resp['id'], resp['name'], resp['description'], resp['suppressed'])
+        end
+
+        def post_suppressed_emails(group_id, recipient_emails)
+          resp = post(
+            @auth,
+            SendGrid4r::REST::Asm::Suppressions.url(group_id),
+            recipient_emails: recipient_emails
+          )
+          resp['recipient_emails']
+        end
+
+        def get_suppressions(email_address)
+          resp_a = get(
+            @auth,
+            "#{SendGrid4r::Client::BASE_URL}/asm/suppressions/#{email_address}")
+          suppressions = []
+          resp_a['suppressions'].each do |resp|
+            suppressions.push(
+              SendGrid4r::REST::Asm::Suppressions.create_suppression(resp)
+            )
+          end
+          suppressions
+        end
+
+        def get_suppressed_emails(group_id)
+          get(
+            @auth,
+            SendGrid4r::REST::Asm::Suppressions.url(group_id)
+          )
+        end
+
+        def delete_suppressed_email(group_id, email_address)
+          delete(
+            @auth,
+            SendGrid4r::REST::Asm::Suppressions.url(group_id, email_address)
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+# -*- encoding: utf-8 -*-
+$LOAD_PATH.unshift File.dirname(__FILE__)
+
+require 'sendgrid4r/rest/request'
+
+module SendGrid4r
+  module REST
+    module Categories
+      #
+      # SendGrid Web API v3 Categories - Categories
+      #
+      module Categories
+        include SendGrid4r::REST::Request
+
+        Category = Struct.new(:category)
+
+        def self.create_category(resp)
+          Category.new(resp['category'])
+        end
+
+        def get_categories(category = nil, limit = nil, offset = nil)
+          params = {}
+          params['category'] = category unless category.nil?
+          params['limit'] = limit unless limit.nil?
+          params['offset'] = offset unless limit.nil?
+          resp_a = get(
+            @auth, "#{SendGrid4r::Client::BASE_URL}/categories", params)
+          categories = []
+          resp_a.each do |resp|
+            categories.push(
+              SendGrid4r::REST::Categories::Categories.create_category(resp))
+          end
+          categories
+        end
+      end
+    end
+  end
+end

data/lib/sendgrid4r/rest/ips/addresses.rb

@@ -0,0 +1,74 @@
+# -*- encoding: utf-8 -*-
+$LOAD_PATH.unshift File.dirname(__FILE__)
+
+require 'sendgrid4r/rest/request'
+
+module SendGrid4r
+  module REST
+    #
+    # SendGrid Web API v3 Ip Management
+    #
+    module Ips
+      #
+      # SendGrid Web API v3 Ip Management - Pools
+      #
+      module Addresses
+        include SendGrid4r::REST::Request
+
+        Address = Struct.new(
+          :ip, :pools, :warmup, :start_date, :subusers, :rdns, :pool_name)
+
+        def self.create_address(resp)
+          Address.new(
+            resp['ip'],
+            resp['pools'],
+            resp['warmup'],
+            resp['start_date'],
+            resp['subusers'],
+            resp['rdns'],
+            resp['pool_name']
+          )
+        end
+
+        def post_ip_to_pool(pool_name, ip)
+          resp = post(
+            @auth,
+            "#{SendGrid4r::Client::BASE_URL}/ips/pools/#{pool_name}/ips",
+            ip: ip
+          )
+          SendGrid4r::REST::Ips::Addresses.create_address(resp)
+        end
+
+        def get_ips
+          resp_a = get(@auth, "#{SendGrid4r::Client::BASE_URL}/ips")
+          ips = []
+          resp_a.each do |resp|
+            ips.push(SendGrid4r::REST::Ips::Addresses.create_address(resp))
+          end
+          ips
+        end
+
+        def get_ips_assigned
+          resp_a = get(@auth, "#{SendGrid4r::Client::BASE_URL}/ips/assigned")
+          ips = []
+          resp_a.each do |resp|
+            ips.push(SendGrid4r::REST::Ips::Addresses.create_address(resp))
+          end
+          ips
+        end
+
+        def get_ip(ip)
+          resp = get(@auth, "#{SendGrid4r::Client::BASE_URL}/ips/#{ip}")
+          SendGrid4r::REST::Ips::Addresses.create_address(resp)
+        end
+
+        def delete_ip_from_pool(pool_name, ip)
+          delete(
+            @auth,
+            "#{SendGrid4r::Client::BASE_URL}/ips/pools/#{pool_name}/ips/#{ip}"
+          )
+        end
+      end
+    end
+  end
+end

data/lib/sendgrid4r/rest/ips/pools.rb

@@ -0,0 +1,63 @@
+# -*- encoding: utf-8 -*-
+$LOAD_PATH.unshift File.dirname(__FILE__)
+
+require 'sendgrid4r/rest/request'
+
+module SendGrid4r
+  module REST
+    #
+    # SendGrid Web API v3 Ip Management
+    #
+    module Ips
+      #
+      # SendGrid Web API v3 Ip Management - Pools
+      #
+      module Pools
+        include SendGrid4r::REST::Request
+
+        Pool = Struct.new(:pool_name, :name, :ips)
+
+        def self.create_pool(resp)
+          ips = []
+          Array(resp['ips']).each { |ip| ips.push(ip) }
+          Pool.new(resp['pool_name'], resp['name'], ips)
+        end
+
+        def post_pool(name)
+          resp = post(
+            @auth, "#{SendGrid4r::Client::BASE_URL}/ips/pools", name: name
+          )
+          SendGrid4r::REST::Ips::Pools.create_pool(resp)
+        end
+
+        def get_pools
+          resp_a = get(@auth, "#{SendGrid4r::Client::BASE_URL}/ips/pools")
+          pools = []
+          resp_a.each do |resp|
+            pools.push(SendGrid4r::REST::Ips::Pools.create_pool(resp))
+          end
+          pools
+        end
+
+        def get_pool(name)
+          resp = get(
+            @auth, "#{SendGrid4r::Client::BASE_URL}/ips/pools/#{name}"
+          )
+          SendGrid4r::REST::Ips::Pools.create_pool(resp)
+        end
+
+        def put_pool(name, new_name)
+          resp = put(
+            @auth,
+            "#{SendGrid4r::Client::BASE_URL}/ips/pools/#{name}",
+            name: new_name)
+          SendGrid4r::REST::Ips::Pools.create_pool(resp)
+        end
+
+        def delete_pool(name)
+          delete(@auth, "#{SendGrid4r::Client::BASE_URL}/ips/pools/#{name}")
+        end
+      end
+    end
+  end
+end

data/lib/sendgrid4r/rest/ips/warmup.rb

@@ -0,0 +1,55 @@
+# -*- encoding: utf-8 -*-
+$LOAD_PATH.unshift File.dirname(__FILE__)
+
+require 'sendgrid4r/rest/request'
+
+module SendGrid4r
+  module REST
+    module Ips
+      #
+      # SendGrid Web API v3 Ip Management - Warmup
+      #
+      module Warmup
+        include SendGrid4r::REST::Request
+        WarmupIp = Struct.new(:ip, :start_date)
+
+        def self.create_warmup_ip(resp)
+          WarmupIp.new(resp['ip'], resp['start_date'])
+        end
+
+        def get_warmup_ips
+          ips = []
+          resp_a = get(@auth, "#{SendGrid4r::Client::BASE_URL}/ips/warmup")
+          resp_a.each do |resp|
+            ips.push(SendGrid4r::REST::Ips::Warmup.create_warmup_ip(resp))
+          end
+          ips
+        end
+
+        def get_warmup_ip(ip_address)
+          resp = get(
+            @auth,
+            "#{SendGrid4r::Client::BASE_URL}/ips/warmup/#{ip_address}"
+          )
+          SendGrid4r::REST::Ips::Warmup.create_warmup_ip(resp)
+        end
+
+        def post_warmup_ip(ip_address)
+          resp = post(
+            @auth,
+            "#{SendGrid4r::Client::BASE_URL}/ips/warmup",
+            ip: ip_address
+          )
+          SendGrid4r::REST::Ips::Warmup.create_warmup_ip(resp)
+        end
+
+        def delete_warmup_ip(ip_address)
+          delete(
+            @auth,
+            "#{SendGrid4r::Client::BASE_URL}/ips/warmup/#{ip_address}"
+          )
+        end
+      end
+    end
+  end
+end

data/lib/sendgrid4r/rest/request.rb

@@ -1,48 +1,63 @@
 # -*- encoding: utf-8 -*-
-$:.unshift File.dirname(__FILE__)
+$LOAD_PATH.unshift File.dirname(__FILE__)
 
-require "rest-client"
-require "uri"
-require "json"
+require 'rest-client'
+require 'uri'
+require 'json'
 
 module SendGrid4r
   module REST
+    #
+    # SendGrid Web API v3 Request
+    #
     module Request
-
-      def get(auth, endpoint)
-        resource = RestClient::Resource.new(endpoint, auth.get_username, auth.get_password)
-        body = resource.get.body
+      def get(auth, endpoint, params = nil)
+        resource = RestClient::Resource.new(
+          endpoint, auth.username, auth.password)
+        p = { params: params } unless params.nil?
+        if p.nil?
+          body = resource.get
+        else
+          body = resource.get(p)
+          # TODO: handle ratelimit headers
+          # do |response, request, result, &block|
+          #   # puts response.headers
+          #   break response.body
+          # end
+        end
         JSON.parse(body)
       end
 
       def post(auth, endpoint, params = nil)
-        resource = RestClient::Resource.new(endpoint, auth.get_username, auth.get_password)
-        if params == nil
-          body = resource.post(:content_type => :json).body
+        resource = RestClient::Resource.new(
+          endpoint, auth.username, auth.password)
+        if params.nil?
+          body = resource.post(content_type: :json).body
         else
-          body = resource.post(params.to_json, :content_type => :json).body
+          body = resource.post(params.to_json, content_type: :json).body
         end
         JSON.parse(body)
       end
 
       def patch(auth, endpoint, params)
-        resource = RestClient::Resource.new(endpoint, auth.get_username, auth.get_password)
-        body = resource.patch(params.to_json, :content_type => :json).body
+        resource = RestClient::Resource.new(
+          endpoint, auth.username, auth.password)
+        body = resource.patch(params.to_json, content_type: :json).body
         JSON.parse(body)
       end
 
       def put(auth, endpoint, params)
-        resource = RestClient::Resource.new(endpoint, auth.get_username, auth.get_password)
-        body = resource.put(params.to_json, :content_type => :json).body
+        resource = RestClient::Resource.new(
+          endpoint, auth.username, auth.password)
+        body = resource.put(params.to_json, content_type: :json).body
         JSON.parse(body)
       end
 
       def delete(auth, endpoint)
-        resource = RestClient::Resource.new(endpoint, auth.get_username, auth.get_password)
+        resource = RestClient::Resource.new(
+          endpoint, auth.username, auth.password)
         resource.delete
       end
-
     end
-
   end
 end

data/lib/sendgrid4r/rest/settings/enforced_tls.rb

@@ -0,0 +1,39 @@
+# -*- encoding: utf-8 -*-
+$LOAD_PATH.unshift File.dirname(__FILE__)
+
+require 'sendgrid4r/rest/request'
+
+module SendGrid4r
+  module REST
+    module Settings
+      #
+      # SendGrid Web API v3 Settings - EnforcedTls
+      #
+      module EnforcedTls
+        include SendGrid4r::REST::Request
+        EnforcedTls = Struct.new(:require_tls, :require_valid_cert)
+
+        def self.create_enforced_tls(resp)
+          EnforcedTls.new(resp['require_tls'], resp['require_valid_cert'])
+        end
+
+        def get_enforced_tls
+          resp = get(
+            @auth,
+            "#{SendGrid4r::Client::BASE_URL}/user/settings/enforced_tls"
+          )
+          SendGrid4r::REST::Settings::EnforcedTls.create_enforced_tls(resp)
+        end
+
+        def patch_enforced_tls(params)
+          resp = patch(
+            @auth,
+            "#{SendGrid4r::Client::BASE_URL}/user/settings/enforced_tls",
+            params.to_h
+          )
+          SendGrid4r::REST::Settings::EnforcedTls.create_enforced_tls(resp)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,91 @@
+# -*- encoding: utf-8 -*-
+$LOAD_PATH.unshift File.dirname(__FILE__)
+
+require 'sendgrid4r/rest/request'
+
+module SendGrid4r
+  module REST
+    module Stats
+      #
+      # SendGrid Web API v3 Stats - Advanced
+      #
+      module Advanced
+        def get_geo_stats(
+            start_date:, end_date: nil, aggregated_by: nil, country: nil)
+          params = {
+            start_date: start_date,
+            end_date: end_date,
+            aggregated_by: aggregated_by,
+            country: country
+          }
+          resp_a = get(
+            @auth, "#{SendGrid4r::Client::BASE_URL}/geo/stats", params)
+          SendGrid4r::REST::Stats.create_top_stats(resp_a)
+        end
+
+        def get_devices_stats(start_date:, end_date: nil, aggregated_by: nil)
+          params = {
+            start_date: start_date,
+            end_date: end_date,
+            aggregated_by: aggregated_by
+          }
+          resp_a = get(
+            @auth, "#{SendGrid4r::Client::BASE_URL}/devices/stats", params)
+          SendGrid4r::REST::Stats.create_top_stats(resp_a)
+        end
+
+        def get_clients_stats(start_date:, end_date: nil, aggregated_by: nil)
+          params = {
+            start_date: start_date,
+            end_date: end_date,
+            aggregated_by: aggregated_by
+          }
+          resp_a = get(
+            @auth, "#{SendGrid4r::Client::BASE_URL}/clients/stats", params)
+          SendGrid4r::REST::Stats.create_top_stats(resp_a)
+        end
+
+        def get_clients_type_stats(
+            start_date:, end_date: nil, aggregated_by: nil, client_type:)
+          params = {
+            start_date: start_date,
+            end_date: end_date,
+            aggregated_by: aggregated_by,
+            client_type: client_type
+          }
+          resp_a = get(
+            @auth,
+            "#{SendGrid4r::Client::BASE_URL}/clients/#{client_type}/stats",
+            params)
+          SendGrid4r::REST::Stats.create_top_stats(resp_a)
+        end
+
+        def get_esp_stats(
+            start_date:, end_date: nil, aggregated_by: nil, esps: nil)
+          params = {
+            start_date: start_date,
+            end_date: end_date,
+            aggregated_by: aggregated_by,
+            esps: esps
+          }
+          resp_a = get(
+            @auth, "#{SendGrid4r::Client::BASE_URL}/esp/stats", params)
+          SendGrid4r::REST::Stats.create_top_stats(resp_a)
+        end
+
+        def get_browsers_stats(
+            start_date:, end_date: nil, aggregated_by: nil, browsers: nil)
+          params = {
+            start_date: start_date,
+            end_date: end_date,
+            aggregated_by: aggregated_by,
+            browsers: browsers
+          }
+          resp_a = get(
+            @auth, "#{SendGrid4r::Client::BASE_URL}/browsers/stats", params)
+          SendGrid4r::REST::Stats.create_top_stats(resp_a)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,47 @@
+# -*- encoding: utf-8 -*-
+$LOAD_PATH.unshift File.dirname(__FILE__)
+
+require 'sendgrid4r/rest/request'
+
+module SendGrid4r
+  module REST
+    module Stats
+      #
+      # SendGrid Web API v3 Stats - Category
+      #
+      module Category
+        def get_categories_stats(
+            start_date:, end_date: nil, aggregated_by: nil, categories:)
+          params = {
+            start_date: start_date,
+            end_date: end_date,
+            aggregated_by: aggregated_by,
+            categories: categories
+          }
+          # TODO: categories does not support array yet
+          resp_a = get(
+            @auth, "#{SendGrid4r::Client::BASE_URL}/categories/stats", params)
+          SendGrid4r::REST::Stats.create_top_stats(resp_a)
+        end
+
+        def get_categories_stats_sums(
+            start_date:, end_date: nil, sort_by_metric: nil,
+            sort_by_direction: nil, limit: nil, offset: nil)
+          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,
+            "#{SendGrid4r::Client::BASE_URL}/categories/stats/sums",
+            params)
+          SendGrid4r::REST::Stats.create_top_stat(resp)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$LOAD_PATH.unshift File.dirname(__FILE__)
+
+require 'sendgrid4r/rest/request'
+
+module SendGrid4r
+  module REST
+    module Stats
+      #
+      # SendGrid Web API v3 Stats - Global
+      #
+      module Global
+        def get_global_stats(start_date:, end_date: nil, aggregated_by: nil)
+          params = {
+            start_date: start_date,
+            end_date: end_date,
+            aggregated_by: aggregated_by
+          }
+          resp_a = get(
+            @auth, "#{SendGrid4r::Client::BASE_URL}/stats", params)
+          SendGrid4r::REST::Stats.create_top_stats(resp_a)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$LOAD_PATH.unshift File.dirname(__FILE__)
+
+require 'sendgrid4r/rest/request'
+
+module SendGrid4r
+  module REST
+    module Stats
+      #
+      # SendGrid Web API v3 Stats - Parse
+      #
+      module Parse
+        def get_parse_stats(start_date:, end_date: nil, aggregated_by: nil)
+          params = {
+            start_date: start_date,
+            end_date: end_date,
+            aggregated_by: aggregated_by
+          }
+          resp_a = get(
+            @auth, "#{SendGrid4r::Client::BASE_URL}/parse/stats", params)
+          SendGrid4r::REST::Stats.create_top_stats(resp_a)
+        end
+      end
+    end
+  end
+end