sendgrid4r 0.3.0 → 0.4.0

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

@@ -41,18 +41,14 @@ module SendGrid4r
         end
 
         def self.url(ip = nil)
-          url = "#{SendGrid4r::Client::BASE_URL}/ips"
+          url = "#{BASE_URL}/ips"
           url = "#{url}/#{ip}" unless ip.nil?
           url
         end
 
         def post_ip_to_pool(pool_name, ip, &block)
-          resp = post(
-            @auth,
-            SendGrid4r::REST::Ips::Pools.url(pool_name, 'ips'),
-            ip: ip,
-            &block
-          )
+          endpoint = SendGrid4r::REST::Ips::Pools.url(pool_name, 'ips')
+          resp = post(@auth, endpoint, ip: ip, &block)
           SendGrid4r::REST::Ips::Addresses.create_address(resp)
         end
 
@@ -62,25 +58,20 @@ module SendGrid4r
         end
 
         def get_ips_assigned(&block)
-          resp = get(
-            @auth, SendGrid4r::REST::Ips::Addresses.url('assigned'), &block
-          )
+          endpoint = SendGrid4r::REST::Ips::Addresses.url('assigned')
+          resp = get(@auth, endpoint, &block)
           SendGrid4r::REST::Ips::Addresses.create_addresses(resp)
         end
 
         def get_ip(ip, &block)
-          resp = get(
-            @auth, SendGrid4r::REST::Ips::Addresses.url(ip), &block
-          )
+          endpoint = SendGrid4r::REST::Ips::Addresses.url(ip)
+          resp = get(@auth, endpoint, &block)
           SendGrid4r::REST::Ips::Addresses.create_address(resp)
         end
 
         def delete_ip_from_pool(pool_name, ip, &block)
-          delete(
-            @auth,
-            SendGrid4r::REST::Ips::Pools.url(pool_name, 'ips', ip),
-            &block
-          )
+          endpoint = SendGrid4r::REST::Ips::Pools.url(pool_name, 'ips', ip)
+          delete(@auth, endpoint, &block)
         end
       end
     end

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

@@ -34,7 +34,7 @@ module SendGrid4r
         end
 
         def self.url(name = nil, ips = nil, ip = nil)
-          url = "#{SendGrid4r::Client::BASE_URL}/ips/pools"
+          url = "#{BASE_URL}/ips/pools"
           url = "#{url}/#{name}" unless name.nil?
           url = "#{url}/#{ips}" unless ips.nil?
           url = "#{url}/#{ip}" unless ip.nil?
@@ -42,9 +42,8 @@ module SendGrid4r
         end
 
         def post_pool(name, &block)
-          resp = post(
-            @auth, SendGrid4r::REST::Ips::Pools.url, name: name, &block
-          )
+          endpoint = SendGrid4r::REST::Ips::Pools.url
+          resp = post(@auth, endpoint, name: name, &block)
           SendGrid4r::REST::Ips::Pools.create_pool(resp)
         end
 
@@ -54,18 +53,14 @@ module SendGrid4r
         end
 
         def get_pool(name, &block)
-          resp = get(
-            @auth, SendGrid4r::REST::Ips::Pools.url(name), &block
-          )
+          endpoint = SendGrid4r::REST::Ips::Pools.url(name)
+          resp = get(@auth, endpoint, &block)
           SendGrid4r::REST::Ips::Pools.create_pool(resp)
         end
 
         def put_pool(name, new_name, &block)
-          resp = put(
-            @auth,
-            SendGrid4r::REST::Ips::Pools.url(name),
-            name: new_name,
-            &block)
+          endpoint = SendGrid4r::REST::Ips::Pools.url(name)
+          resp = put(@auth, endpoint, name: new_name, &block)
           SendGrid4r::REST::Ips::Pools.create_pool(resp)
         end
 

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

@@ -32,7 +32,7 @@ module SendGrid4r
         end
 
         def self.url(ip_address = nil)
-          url = "#{SendGrid4r::Client::BASE_URL}/ips/warmup"
+          url = "#{BASE_URL}/ips/warmup"
           url = "#{url}/#{ip_address}" unless ip_address.nil?
           url
         end
@@ -43,30 +43,20 @@ module SendGrid4r
         end
 
         def get_warmup_ip(ip_address, &block)
-          resp = get(
-            @auth,
-            SendGrid4r::REST::Ips::Warmup.url(ip_address),
-            &block
-          )
+          endpoint = SendGrid4r::REST::Ips::Warmup.url(ip_address)
+          resp = get(@auth, endpoint, &block)
           SendGrid4r::REST::Ips::Warmup.create_warmup_ip(resp)
         end
 
         def post_warmup_ip(ip_address, &block)
-          resp = post(
-            @auth,
-            SendGrid4r::REST::Ips::Warmup.url,
-            ip: ip_address,
-            &block
-          )
+          endpoint = SendGrid4r::REST::Ips::Warmup.url
+          resp = post(@auth, endpoint, ip: ip_address, &block)
           SendGrid4r::REST::Ips::Warmup.create_warmup_ip(resp)
         end
 
         def delete_warmup_ip(ip_address, &block)
-          delete(
-            @auth,
-            SendGrid4r::REST::Ips::Warmup.url(ip_address),
-            &block
-          )
+          endpoint = SendGrid4r::REST::Ips::Warmup.url(ip_address)
+          delete(@auth, endpoint, &block)
         end
       end
     end

data/lib/sendgrid4r/rest/request.rb

@@ -11,6 +11,8 @@ module SendGrid4r
     # SendGrid Web API v3 Request
     #
     module Request
+      BASE_URL = 'https://api.sendgrid.com/v3'
+
       def get(auth, endpoint, params = nil, payload = nil, &block)
         execute(:get, auth, endpoint, params, payload, &block)
       end
@@ -67,11 +69,15 @@ module SendGrid4r
           endpoint
         else
           query_string = params.collect do |k, v|
-            "#{k}=#{CGI.escape(v.to_s)}"
+            "#{k}=#{CGI.escape(process_array_params(v))}"
           end.join('&')
           endpoint + "?#{query_string}"
         end
       end
+
+      def process_array_params(v)
+        v.is_a?(Array) ? v.join(',') : v.to_s
+      end
     end
   end
 end

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

@@ -19,25 +19,18 @@ module SendGrid4r
         end
 
         def self.url
-          "#{SendGrid4r::Client::BASE_URL}/user/settings/enforced_tls"
+          "#{BASE_URL}/user/settings/enforced_tls"
         end
 
         def get_enforced_tls(&block)
-          resp = get(
-            @auth,
-            SendGrid4r::REST::Settings::EnforcedTls.url,
-            &block
-          )
+          endpoint = SendGrid4r::REST::Settings::EnforcedTls.url
+          resp = get(@auth, endpoint, &block)
           SendGrid4r::REST::Settings::EnforcedTls.create_enforced_tls(resp)
         end
 
         def patch_enforced_tls(params, &block)
-          resp = patch(
-            @auth,
-            SendGrid4r::REST::Settings::EnforcedTls.url,
-            params.to_h,
-            &block
-          )
+          endpoint = SendGrid4r::REST::Settings::EnforcedTls.url
+          resp = patch(@auth, endpoint, params.to_h, &block)
           SendGrid4r::REST::Settings::EnforcedTls.create_enforced_tls(resp)
         end
       end

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

@@ -10,6 +10,8 @@ module SendGrid4r
       # SendGrid Web API v3 Stats - Advanced
       #
       module Advanced
+        include SendGrid4r::REST::Request
+
         def get_geo_stats(
             start_date:,
             end_date: nil,
@@ -23,8 +25,7 @@ module SendGrid4r
             aggregated_by: aggregated_by,
             country: country
           }
-          resp = get(
-            @auth, "#{SendGrid4r::Client::BASE_URL}/geo/stats", params, &block)
+          resp = get(@auth, "#{BASE_URL}/geo/stats", params, &block)
           SendGrid4r::REST::Stats.create_top_stats(resp)
         end
 
@@ -39,12 +40,7 @@ module SendGrid4r
             end_date: end_date,
             aggregated_by: aggregated_by
           }
-          resp = get(
-            @auth,
-            "#{SendGrid4r::Client::BASE_URL}/devices/stats",
-            params,
-            &block
-          )
+          resp = get(@auth, "#{BASE_URL}/devices/stats", params, &block)
           SendGrid4r::REST::Stats.create_top_stats(resp)
         end
 
@@ -59,12 +55,7 @@ module SendGrid4r
             end_date: end_date,
             aggregated_by: aggregated_by
           }
-          resp = get(
-            @auth,
-            "#{SendGrid4r::Client::BASE_URL}/clients/stats",
-            params,
-            &block
-          )
+          resp = get(@auth, "#{BASE_URL}/clients/stats", params, &block)
           SendGrid4r::REST::Stats.create_top_stats(resp)
         end
 
@@ -81,12 +72,8 @@ module SendGrid4r
             aggregated_by: aggregated_by,
             client_type: client_type
           }
-          resp = get(
-            @auth,
-            "#{SendGrid4r::Client::BASE_URL}/clients/#{client_type}/stats",
-            params,
-            &block
-          )
+          endpoint = "#{BASE_URL}/clients/#{client_type}/stats"
+          resp = get(@auth, endpoint, params, &block)
           SendGrid4r::REST::Stats.create_top_stats(resp)
         end
 
@@ -103,12 +90,8 @@ module SendGrid4r
             aggregated_by: aggregated_by,
             esps: esps
           }
-          resp = get(
-            @auth,
-            "#{SendGrid4r::Client::BASE_URL}/mailbox_providers/stats",
-            params,
-            &block
-          )
+          endpoint = "#{BASE_URL}/mailbox_providers/stats"
+          resp = get(@auth, endpoint, params, &block)
           SendGrid4r::REST::Stats.create_top_stats(resp)
         end
 
@@ -125,12 +108,7 @@ module SendGrid4r
             aggregated_by: aggregated_by,
             browsers: browsers
           }
-          resp = get(
-            @auth,
-            "#{SendGrid4r::Client::BASE_URL}/browsers/stats",
-            params,
-            &block
-          )
+          resp = get(@auth, "#{BASE_URL}/browsers/stats", params, &block)
           SendGrid4r::REST::Stats.create_top_stats(resp)
         end
       end

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

@@ -10,6 +10,8 @@ module SendGrid4r
       # SendGrid Web API v3 Stats - Category
       #
       module Category
+        include SendGrid4r::REST::Request
+
         def get_categories_stats(
             start_date:, end_date: nil, aggregated_by: nil, categories:, &block)
           params = {
@@ -18,12 +20,7 @@ module SendGrid4r
             aggregated_by: aggregated_by,
             categories: categories
           }
-          resp = get(
-            @auth,
-            "#{SendGrid4r::Client::BASE_URL}/categories/stats",
-            params,
-            &block
-          )
+          resp = get(@auth, "#{BASE_URL}/categories/stats", params, &block)
           SendGrid4r::REST::Stats.create_top_stats(resp)
         end
 
@@ -38,11 +35,7 @@ module SendGrid4r
             limit: limit,
             offset: offset
           }
-          resp = get(
-            @auth,
-            "#{SendGrid4r::Client::BASE_URL}/categories/stats/sums",
-            params,
-            &block)
+          resp = get(@auth, "#{BASE_URL}/categories/stats/sums", params, &block)
           SendGrid4r::REST::Stats.create_top_stat(resp)
         end
       end

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

@@ -10,6 +10,8 @@ module SendGrid4r
       # SendGrid Web API v3 Stats - Global
       #
       module Global
+        include SendGrid4r::REST::Request
+
         def get_global_stats(
           start_date:, end_date: nil, aggregated_by: nil, &block
         )
@@ -18,8 +20,7 @@ module SendGrid4r
             end_date: end_date,
             aggregated_by: aggregated_by
           }
-          resp = get(
-            @auth, "#{SendGrid4r::Client::BASE_URL}/stats", params, &block)
+          resp = get(@auth, "#{BASE_URL}/stats", params, &block)
           SendGrid4r::REST::Stats.create_top_stats(resp)
         end
       end

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

@@ -10,6 +10,8 @@ module SendGrid4r
       # SendGrid Web API v3 Stats - Parse
       #
       module Parse
+        include SendGrid4r::REST::Request
+
         def get_parse_stats(
           start_date:, end_date: nil, aggregated_by: nil, &block
         )
@@ -18,12 +20,8 @@ module SendGrid4r
             end_date: end_date,
             aggregated_by: aggregated_by
           }
-          resp = get(
-            @auth,
-            "#{SendGrid4r::Client::BASE_URL}/user/webhooks/parse/stats",
-            params,
-            &block
-          )
+          endpoint = "#{BASE_URL}/user/webhooks/parse/stats"
+          resp = get(@auth, endpoint, params, &block)
           SendGrid4r::REST::Stats.create_top_stats(resp)
         end
       end

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

@@ -10,6 +10,8 @@ module SendGrid4r
       # SendGrid Web API v3 Stats - Subuser
       #
       module Subuser
+        include SendGrid4r::REST::Request
+
         def get_subusers_stats(
             start_date:, end_date: nil, aggregated_by: nil, subusers:, &block)
           params = {
@@ -18,11 +20,7 @@ module SendGrid4r
             aggregated_by: aggregated_by,
             subusers: subusers
           }
-          resp = get(
-            @auth,
-            "#{SendGrid4r::Client::BASE_URL}/subusers/stats",
-            params,
-            &block)
+          resp = get(@auth, "#{BASE_URL}/subusers/stats", params, &block)
           SendGrid4r::REST::Stats.create_top_stats(resp)
         end
 
@@ -37,12 +35,7 @@ module SendGrid4r
             limit: limit,
             offset: offset
           }
-          resp = get(
-            @auth,
-            "#{SendGrid4r::Client::BASE_URL}/subusers/stats/sums",
-            params,
-            &block
-          )
+          resp = get(@auth, "#{BASE_URL}/subusers/stats/sums", params, &block)
           SendGrid4r::REST::Stats.create_top_stat(resp)
         end
       end

data/lib/sendgrid4r/rest/subusers/subusers.rb

@@ -0,0 +1,83 @@
+# -*- encoding: utf-8 -*-
+$LOAD_PATH.unshift File.dirname(__FILE__)
+
+require 'sendgrid4r/rest/request'
+
+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
+      )
+      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
+
+      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 get_subuser_reputation(usernames:, &block)
+        params = ''
+        usernames.each do |username|
+          params += "usernames=#{username}&"
+        end
+        endpoint = "#{SendGrid4r::REST::Subusers.url}/reputations?#{params}"
+        resp = get(@auth, endpoint, usernames, &block)
+        SendGrid4r::REST::Subusers.create_subusers(resp)
+      end
+
+      def put_subuser_assigned_ips(username:, &block)
+        endpoint = "#{SendGrid4r::REST::Subusers.url(username)}/ips"
+        resp = put(@auth, endpoint, nil, &block)
+        SendGrid4r::REST::Subusers.create_subuser(resp)
+      end
+    end
+  end
+end

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

@@ -16,7 +16,7 @@ module SendGrid4r
       Template = Struct.new(:id, :name, :versions)
 
       def self.url(temp_id = nil)
-        url = "#{SendGrid4r::Client::BASE_URL}/templates"
+        url = "#{BASE_URL}/templates"
         url = "#{url}/#{temp_id}" unless temp_id.nil?
         url
       end

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

@@ -34,15 +34,16 @@ module SendGrid4r
         end
 
         def self.url(temp_id, ver_id = nil)
-          url = "#{SendGrid4r::Client::BASE_URL}/templates/#{temp_id}/versions"
+          url = "#{BASE_URL}/templates/#{temp_id}/versions"
           url = "#{url}/#{ver_id}" unless ver_id.nil?
           url
         end
 
         def post_version(temp_id, version, &block)
+          endpoint = SendGrid4r::REST::Templates::Versions.url(temp_id)
           resp = post(
             @auth,
-            SendGrid4r::REST::Templates::Versions.url(temp_id),
+            endpoint,
             remove_uneditable_keys(version.to_h),
             &block
           )

data/lib/sendgrid4r/version.rb

@@ -2,5 +2,5 @@
 # SendGrid API v3 wrapper implementation.
 #
 module SendGrid4r
-  VERSION = '0.3.0'
+  VERSION = '0.4.0'
 end

data/spec/client_spec.rb

@@ -6,21 +6,34 @@ describe SendGrid4r::Client do
     Dotenv.load
   end
 
-  context 'always' do
-    before :all do
+  describe 'unit test', :ut do
+    before do
       @client = SendGrid4r::Client.new(
         username: 'username',
         password: 'password')
     end
 
     describe '#initialize' do
-      it 'create instance' do
+      it 'create instance with username and password' do
+        @client = SendGrid4r::Client.new(
+          username: 'username',
+          password: 'password')
+        expect(@client.class).to eq(SendGrid4r::Client)
+      end
+
+      it 'create instance with apikey' do
+        @client = SendGrid4r::Client.new(api_key: 'api_key')
         expect(@client.class).to eq(SendGrid4r::Client)
       end
     end
 
     describe 'methods' do
       it 'available' do
+        # Subusers
+        expect(@client.respond_to?('get_subusers')).to eq(true)
+        expect(@client.respond_to?('post_subuser')).to eq(true)
+        expect(@client.respond_to?('get_subuser_reputation')).to eq(true)
+        expect(@client.respond_to?('put_subuser_assigned_ips')).to eq(true)
         # Api Keys
         expect(@client.respond_to?('get_api_keys')).to eq(true)
         expect(@client.respond_to?('post_api_key')).to eq(true)
@@ -136,7 +149,7 @@ describe SendGrid4r::Client do
 
     describe 'VERSION' do
       it 'returns VERSION value' do
-        expect(SendGrid4r::VERSION).to eq('0.3.0')
+        expect(SendGrid4r::VERSION).to eq('0.4.0')
       end
     end
   end

data/spec/factory/condition_factory_spec.rb

@@ -2,7 +2,7 @@
 require File.dirname(__FILE__) + '/../spec_helper'
 
 describe SendGrid4r::Factory::ConditionFactory do
-  describe 'unit test' do
+  describe 'unit test', :ut do
     before do
       Dotenv.load
       @factory = SendGrid4r::Factory::ConditionFactory.new

data/spec/factory/segment_factory_spec.rb

@@ -2,7 +2,7 @@
 require File.dirname(__FILE__) + '/../spec_helper'
 
 describe SendGrid4r::Factory::SegmentFactory do
-  describe 'unit test' do
+  describe 'unit test', :ut do
     before do
       Dotenv.load
       @segment_factory = SendGrid4r::Factory::SegmentFactory.new

data/spec/factory/version_factory_spec.rb

@@ -2,7 +2,7 @@
 require File.dirname(__FILE__) + '/../spec_helper'
 
 describe SendGrid4r::Factory::VersionFactory do
-  describe 'unit test' do
+  describe 'unit test', :ut do
     before do
       Dotenv.load
       @factory = SendGrid4r::Factory::VersionFactory.new