sendgrid4r 0.0.5 → 0.1.0

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

@@ -0,0 +1,89 @@
+# -*- encoding: utf-8 -*-
+$LOAD_PATH.unshift File.dirname(__FILE__)
+
+require 'sendgrid4r/rest/request'
+
+module SendGrid4r
+  module REST
+    #
+    # SendGrid Web API v3 Stats
+    #
+    module Stats
+      #
+      # SendGrid Web API v3 Stats - AggregatedBy
+      #
+      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
+      )
+
+      def self.create_top_stat(resp)
+        stats = []
+        resp['stats'].each do |stat|
+          stats.push(SendGrid4r::REST::Stats.create_stat(stat))
+        end
+        TopStat.new(resp['date'], stats)
+      end
+
+      def self.create_stat(resp)
+        stat = SendGrid4r::REST::Stats.create_metric(resp['metrics'])
+        Stat.new(stat, resp['name'], resp['type'])
+      end
+
+      def self.create_metric(resp)
+        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)
+        top_stats = []
+        resp_a.each do |resp|
+          top_stats.push(SendGrid4r::REST::Stats.create_top_stat(resp))
+        end
+        top_stats
+      end
+    end
+  end
+end

data/lib/sendgrid4r/rest/stats/subuser.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 - Subuser
+      #
+      module Subuser
+        def get_subusers_stats(
+            start_date:, end_date: nil, aggregated_by: nil, subusers:)
+          params = {
+            start_date: start_date,
+            end_date: end_date,
+            aggregated_by: aggregated_by,
+            subusers: subusers
+          }
+          resp_a = get(
+            @auth, "#{SendGrid4r::Client::BASE_URL}/subusers/stats", params)
+          SendGrid4r::REST::Stats.create_top_stats(resp_a)
+        end
+
+        def get_subusers_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}/subusers/stats/sums",
+            params
+          )
+          SendGrid4r::REST::Stats.create_top_stat(resp)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,61 @@
+# -*- encoding: utf-8 -*-
+$LOAD_PATH.unshift File.dirname(__FILE__)
+
+require 'sendgrid4r/rest/request'
+require 'versions'
+
+module SendGrid4r
+  module REST
+    #
+    # SendGrid Web API v3 Template Engine - Templates
+    #
+    module Templates
+      include SendGrid4r::REST::Request
+
+      Template = Struct.new(:id, :name, :versions)
+
+      def self.url(temp_id = nil)
+        url = "#{SendGrid4r::Client::BASE_URL}/templates"
+        url = "#{url}/#{temp_id}" unless temp_id.nil?
+        url
+      end
+
+      def self.create_template(resp)
+        vers = []
+        resp['versions'].each do |ver|
+          vers.push(SendGrid4r::REST::Templates.create_version(ver))
+        end
+        Template.new(resp['id'], resp['name'], vers)
+      end
+
+      def post_template(name)
+        resp = post(@auth, SendGrid4r::REST::Templates.url, 'name' => name)
+        SendGrid4r::REST::Templates.create_template(resp)
+      end
+
+      def get_templates
+        resp_a = get(@auth, SendGrid4r::REST::Templates.url)
+        tmps = []
+        resp_a['templates'].each do |resp|
+          tmps.push(SendGrid4r::REST::Templates.create_template(resp))
+        end
+        tmps
+      end
+
+      def get_template(temp_id)
+        resp = get(@auth, SendGrid4r::REST::Templates.url(temp_id))
+        SendGrid4r::REST::Templates.create_template(resp)
+      end
+
+      def patch_template(temp_id, name)
+        resp = patch(
+          @auth, SendGrid4r::REST::Templates.url(temp_id), 'name' => name)
+        SendGrid4r::REST::Templates.create_template(resp)
+      end
+
+      def delete_template(temp_id)
+        delete(@auth, SendGrid4r::REST::Templates.url(temp_id))
+      end
+    end
+  end
+end

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

@@ -0,0 +1,92 @@
+# -*- encoding: utf-8 -*-
+$LOAD_PATH.unshift File.dirname(__FILE__)
+
+require 'sendgrid4r/rest/request'
+
+module SendGrid4r
+  module REST
+    #
+    # SendGrid Web API v3 Template Engine - Templates
+    #
+    module Templates
+      Version = Struct.new(
+        :id, :user_id, :template_id, :active, :name, :html_content,
+        :plain_content, :subject, :updated_at)
+
+      def self.create_version(resp)
+        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
+
+      #
+      # SendGrid Web API v3 Template Engine - Versions
+      #
+      module Versions
+        include SendGrid4r::REST::Request
+
+        def self.url(temp_id, ver_id = nil)
+          url = "#{SendGrid4r::Client::BASE_URL}/templates/#{temp_id}/versions"
+          url = "#{url}/#{ver_id}" unless ver_id.nil?
+          url
+        end
+
+        def post_version(temp_id, version)
+          resp = post(
+            @auth,
+            "#{SendGrid4r::REST::Templates::Versions.url(temp_id)}",
+            remove_uneditable_keys(version.to_h)
+          )
+          SendGrid4r::REST::Templates.create_version(resp)
+        end
+
+        def activate_version(temp_id, ver_id)
+          url = SendGrid4r::REST::Templates::Versions.url(temp_id, ver_id)
+          resp = post(
+            @auth,
+            "#{url}/activate"
+          )
+          SendGrid4r::REST::Templates.create_version(resp)
+        end
+
+        def get_version(temp_id, ver_id)
+          resp = get(
+            @auth,
+            "#{SendGrid4r::REST::Templates::Versions.url(temp_id, ver_id)}")
+          SendGrid4r::REST::Templates.create_version(resp)
+        end
+
+        def patch_version(temp_id, ver_id, version)
+          resp = patch(
+            @auth,
+            "#{SendGrid4r::REST::Templates::Versions.url(temp_id, ver_id)}",
+            remove_uneditable_keys(version.to_h)
+          )
+          SendGrid4r::REST::Templates.create_version(resp)
+        end
+
+        def delete_version(temp_id, ver_id)
+          delete(
+            @auth,
+            "#{SendGrid4r::REST::Templates::Versions.url(temp_id, ver_id)}"
+          )
+        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
+end

data/lib/sendgrid4r/version.rb

@@ -1,3 +1,6 @@
+#
+# SendGrid API v3 wrapper implementation.
+#
 module SendGrid4r
-  VERSION = "0.0.5"
+  VERSION = '0.1.0'
 end

data/lib/sendgrid4r.rb

@@ -1,2 +1,5 @@
-require "client"
-require "sendgrid4r/version"
+# -*- encoding: utf-8 -*-
+$LOAD_PATH.unshift File.dirname(__FILE__)
+
+require 'client'
+require 'sendgrid4r/version'

data/sendgrid4r.gemspec

@@ -4,22 +4,23 @@ $LOAD_PATH.unshift(src) unless $LOAD_PATH.include?(src)
 require 'sendgrid4r/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "sendgrid4r"
+  spec.name          = 'sendgrid4r'
   spec.version       = SendGrid4r::VERSION
-  spec.authors       = ["awwa500@gmail.com"]
-  spec.email         = ["awwa500@gmail.com"]
-  spec.summary       = "SendGrid Web API v3 module"
-  spec.description   = "SendGrid Web API v3 module"
-  spec.homepage      = ""
-  spec.license       = "MIT"
+  spec.authors       = ['awwa500@gmail.com']
+  spec.email         = ['awwa500@gmail.com']
+  spec.summary       = 'SendGrid Web API v3 module'
+  spec.description   = 'SendGrid Web API v3 module'
+  spec.homepage      = ''
+  spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0")
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_dependency "rest-client"
-  spec.add_development_dependency "bundler", "~> 1.6"
-  spec.add_development_dependency "rspec"
-  spec.add_development_dependency "dotenv"
+  spec.add_dependency('rest-client', '1.7.2')
+  spec.add_development_dependency('rubocop', '>=0.29.0', '<0.30.0')
+  spec.add_development_dependency('bundler', '>=1.6.0', '<1.8.0')
+  spec.add_development_dependency('rspec', '3.1.0')
+  spec.add_development_dependency('dotenv', '>=0.11.0', '<0.12.0')
 end

data/spec/{global_suppressions_spec.rb → asm/global_suppressions_spec.rb}

@@ -1,27 +1,35 @@
 # encoding: utf-8
-require File.dirname(__FILE__) + '/spec_helper'
-
-describe "SendGrid4r::REST::Asm::GlobalSuppressions" do
+require File.dirname(__FILE__) + '/../spec_helper'
 
+describe 'SendGrid4r::REST::Asm::GlobalSuppressions' do
   before :all do
     Dotenv.load
-    @client = SendGrid4r::Client.new(ENV["SENDGRID_USERNAME"], ENV["SENDGRID_PASSWORD"])
-    @email1 = "test1@test.com"
-    @email2 = "test2@test.com"
-    @email3 = "test3@test.com"
+    @client = SendGrid4r::Client.new(
+      ENV['SENDGRID_USERNAME'], ENV['SENDGRID_PASSWORD'])
+    @email1 = 'test1@test.com'
+    @email2 = 'test2@test.com'
+    @email3 = 'test3@test.com'
   end
 
-  context "always" do
-    it "is normal" do
+  context 'always' do
+    it 'is normal' do
       # celan up test env
       actual_email1 = @client.get_global_suppressed_email(@email1)
       actual_email2 = @client.get_global_suppressed_email(@email2)
       actual_email3 = @client.get_global_suppressed_email(@email3)
-      @client.delete_global_suppressed_email(@email1) if actual_email1 == @email1
-      @client.delete_global_suppressed_email(@email2) if actual_email2 == @email2
-      @client.delete_global_suppressed_email(@email3) if actual_email3 == @email3
+      @client.delete_global_suppressed_email(
+        @email1
+      ) if actual_email1 == @email1
+      @client.delete_global_suppressed_email(
+        @email2
+      ) if actual_email2 == @email2
+      @client.delete_global_suppressed_email(
+        @email3
+      ) if actual_email3 == @email3
       # post_global_suppressed_emails
-      suppressed_emails = @client.post_global_suppressed_emails([@email1, @email2, @email3])
+      suppressed_emails = @client.post_global_suppressed_emails(
+        [@email1, @email2, @email3]
+      )
       expect(suppressed_emails.length).to eq(3)
       expect(suppressed_emails.include? @email1).to eq(true)
       expect(suppressed_emails.include? @email2).to eq(true)
@@ -30,15 +38,15 @@ describe "SendGrid4r::REST::Asm::GlobalSuppressions" do
       actual_email1 = @client.get_global_suppressed_email(@email1)
       actual_email2 = @client.get_global_suppressed_email(@email2)
       actual_email3 = @client.get_global_suppressed_email(@email3)
-      actual_notexist = @client.get_global_suppressed_email("notexist")
+      actual_notexist = @client.get_global_suppressed_email('notexist')
       expect(actual_email1).to eq(@email1)
       expect(actual_email2).to eq(@email2)
       expect(actual_email3).to eq(@email3)
       expect(actual_notexist).to eq(nil)
       # delete_global_suppressed_email
-      expect(@client.delete_global_suppressed_email(@email1)).to eq("")
-      expect(@client.delete_global_suppressed_email(@email2)).to eq("")
-      expect(@client.delete_global_suppressed_email(@email3)).to eq("")
+      expect(@client.delete_global_suppressed_email(@email1)).to eq('')
+      expect(@client.delete_global_suppressed_email(@email2)).to eq('')
+      expect(@client.delete_global_suppressed_email(@email3)).to eq('')
     end
   end
 end

data/spec/asm/groups_spec.rb

@@ -0,0 +1,58 @@
+# encoding: utf-8
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe 'SendGrid4r::REST::Asm::Groups' do
+  before :all do
+    Dotenv.load
+    @client = SendGrid4r::Client.new(
+      ENV['SENDGRID_USERNAME'], ENV['SENDGRID_PASSWORD'])
+    @group_name = 'group_test'
+    @group_edit = 'group_edit'
+    @group_desc = 'group_desc'
+    @group_desc_edit = 'group_desc_edit'
+  end
+
+  context 'always' do
+    it 'is normal' do
+      # celan up test env
+      grps = @client.get_groups
+      expect(grps.length >= 0).to eq(true)
+      grps.each do |grp|
+        if grp.name == @group_name || grp.name == @group_edit
+          @client.delete_group(grp.id)
+        end
+      end
+      # post a group
+      new_group = @client.post_group(@group_name, @group_desc)
+      expect(@group_name).to eq(new_group.name)
+      expect(@group_desc).to eq(new_group.description)
+      # patch the group
+      new_group.name = @group_edit
+      new_group.description = @group_desc_edit
+      @client.patch_group(new_group.id, new_group)
+      # get the group
+      edit_group = @client.get_group(new_group.id)
+      expect(edit_group.respond_to?('id')).to eq(true)
+      expect(edit_group.respond_to?('name')).to eq(true)
+      expect(edit_group.respond_to?('description')).to eq(true)
+      expect(edit_group.respond_to?('last_email_sent_at')).to eq(true)
+      expect(edit_group.respond_to?('unsubscribes')).to eq(true)
+      expect(new_group.id).to eq(edit_group.id)
+      expect(@group_edit).to eq(edit_group.name)
+      expect(@group_desc_edit).to eq(edit_group.description)
+      # delete the group
+      @client.delete_group(edit_group.id)
+      expect do
+        @client.get_group(edit_group.id)
+      end.to raise_error(RestClient::ResourceNotFound)
+    end
+  end
+
+  context 'abnormal' do
+    it 'raise resource not found for none existance id' do
+      expect do
+        @client.get_group('notexistid')
+      end.to raise_error(RestClient::ResourceNotFound)
+    end
+  end
+end

data/spec/{suppressions_spec.rb → asm/suppressions_spec.rb}

@@ -1,43 +1,43 @@
 # encoding: utf-8
-require File.dirname(__FILE__) + '/spec_helper'
-
-describe "SendGrid4r::REST::Asm::Groups::Suppressions" do
+require File.dirname(__FILE__) + '/../spec_helper'
 
+describe 'SendGrid4r::REST::Asm::Groups::Suppressions' do
   before :all do
     Dotenv.load
-    @client = SendGrid4r::Client.new(ENV["SENDGRID_USERNAME"], ENV["SENDGRID_PASSWORD"])
-    @email1 = "test1@test.com"
-    @email2 = "test2@test.com"
-    @email3 = "test3@test.com"
-    @group_name = "suppressions_test"
-    @group_desc = "group_desc"
+    @client = SendGrid4r::Client.new(
+      ENV['SENDGRID_USERNAME'], ENV['SENDGRID_PASSWORD'])
+    @email1 = 'test1@test.com'
+    @email2 = 'test2@test.com'
+    @email3 = 'test3@test.com'
+    @group_name = 'suppressions_test'
+    @group_desc = 'group_desc'
   end
 
-  context "always" do
-    it "is normal" do
+  context 'always' do
+    it 'is normal' do
       # celan up test env
       grps = @client.get_groups
       expect(grps.length >= 0).to eq(true)
-      grps.each{|grp|
-        if grp.name == @group_name then
-          emails = @client.get_suppressed_emails(grp.id)
-          emails.each{|email|
-            @client.delete_suppressed_email(grp.id, email)
-          }
-          @client.delete_group(grp.id)
+      grps.each do |grp|
+        next if grp.name != @group_name
+        emails = @client.get_suppressed_emails(grp.id)
+        emails.each do |email|
+          @client.delete_suppressed_email(grp.id, email)
         end
-      }
+        @client.delete_group(grp.id)
+      end
       # post a group
       new_group = @client.post_group(@group_name, @group_desc)
       # post recipient emails to the suppression group
-      suppressed_emails = @client.post_suppressed_emails(new_group.id, [@email1, @email2, @email3])
+      suppressed_emails = @client.post_suppressed_emails(
+        new_group.id, [@email1, @email2, @email3])
       expect(suppressed_emails.length).to eq(3)
       expect(suppressed_emails[0]).to eq(@email1)
       expect(suppressed_emails[1]).to eq(@email2)
       expect(suppressed_emails[2]).to eq(@email3)
       # get the suppressions
       suppressions = @client.get_suppressions(@email1)
-      expect(suppressions.length>=1).to eq(true)
+      expect(suppressions.length >= 1).to eq(true)
       expect(suppressions[0].name).to eq(@group_name)
       expect(suppressions[0].description).to eq(@group_desc)
       expect(suppressions[0].suppressed).to eq(true)
@@ -53,7 +53,9 @@ describe "SendGrid4r::REST::Asm::Groups::Suppressions" do
       @client.delete_suppressed_email(new_group.id, @email3)
       # delete the group
       @client.delete_group(new_group.id)
-      expect{@client.get_group(new_group.id)}.to raise_error(RestClient::ResourceNotFound)
+      expect do
+        @client.get_group(new_group.id)
+      end.to raise_error(RestClient::ResourceNotFound)
     end
   end
 end

data/spec/categories/categories_spec.rb

@@ -0,0 +1,39 @@
+# encoding: utf-8
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe 'SendGrid4r::REST::Categories' do
+  before :all do
+    Dotenv.load
+    @client = SendGrid4r::Client.new(
+      ENV['SENDGRID_USERNAME'], ENV['SENDGRID_PASSWORD'])
+  end
+
+  context 'always' do
+    it 'is normal when nothing specified' do
+      categories = @client.get_categories
+      expect(true).to eq(categories.is_a?(Array))
+      expect(categories.length >= 0).to eq(true)
+      categories.each do |category|
+        expect(category.category.length > 0).to eq(true)
+      end
+    end
+
+    it 'is normal when specify category' do
+      categories = @client.get_categories('Newsletter', nil, nil)
+      expect(true).to eq(categories.is_a?(Array))
+      expect(categories.length).to eq(1)
+      categories.each do |category|
+        expect(category.category).to eq('Newsletter')
+      end
+    end
+
+    it 'returns is normal' do
+      categories = @client.get_categories(nil, 5, 2)
+      expect(true).to eq(categories.is_a?(Array))
+      expect(categories.length).to eq(5)
+      categories.each do |category|
+        expect(category.category.length > 0).to eq(true)
+      end
+    end
+  end
+end