sendgrid4r 0.2.0 → 0.3.0

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

@@ -11,79 +11,127 @@ module SendGrid4r
       #
       module Advanced
         def get_geo_stats(
-            start_date:, end_date: nil, aggregated_by: nil, country: nil)
+            start_date:,
+            end_date: nil,
+            aggregated_by: nil,
+            country: nil,
+            &block
+          )
           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)
+          resp = get(
+            @auth, "#{SendGrid4r::Client::BASE_URL}/geo/stats", params, &block)
+          SendGrid4r::REST::Stats.create_top_stats(resp)
         end
 
-        def get_devices_stats(start_date:, end_date: nil, aggregated_by: nil)
+        def get_devices_stats(
+            start_date:,
+            end_date: nil,
+            aggregated_by: nil,
+            &block
+          )
           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)
+          resp = get(
+            @auth,
+            "#{SendGrid4r::Client::BASE_URL}/devices/stats",
+            params,
+            &block
+          )
+          SendGrid4r::REST::Stats.create_top_stats(resp)
         end
 
-        def get_clients_stats(start_date:, end_date: nil, aggregated_by: nil)
+        def get_clients_stats(
+            start_date:,
+            end_date: nil,
+            aggregated_by: nil,
+            &block
+          )
           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)
+          resp = get(
+            @auth,
+            "#{SendGrid4r::Client::BASE_URL}/clients/stats",
+            params,
+            &block
+          )
+          SendGrid4r::REST::Stats.create_top_stats(resp)
         end
 
         def get_clients_type_stats(
-            start_date:, end_date: nil, aggregated_by: nil, client_type:)
+            start_date:,
+            end_date: nil,
+            aggregated_by: nil,
+            client_type:,
+            &block
+          )
           params = {
             start_date: start_date,
             end_date: end_date,
             aggregated_by: aggregated_by,
             client_type: client_type
           }
-          resp_a = get(
+          resp = get(
             @auth,
             "#{SendGrid4r::Client::BASE_URL}/clients/#{client_type}/stats",
-            params)
-          SendGrid4r::REST::Stats.create_top_stats(resp_a)
+            params,
+            &block
+          )
+          SendGrid4r::REST::Stats.create_top_stats(resp)
         end
 
-        def get_esp_stats(
-            start_date:, end_date: nil, aggregated_by: nil, esps: nil)
+        def get_mailbox_providers_stats(
+            start_date:,
+            end_date: nil,
+            aggregated_by: nil,
+            esps: nil,
+            &block
+          )
           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)
+          resp = get(
+            @auth,
+            "#{SendGrid4r::Client::BASE_URL}/mailbox_providers/stats",
+            params,
+            &block
+          )
+          SendGrid4r::REST::Stats.create_top_stats(resp)
         end
 
         def get_browsers_stats(
-            start_date:, end_date: nil, aggregated_by: nil, browsers: nil)
+            start_date:,
+            end_date: nil,
+            aggregated_by: nil,
+            browsers: nil,
+            &block
+          )
           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)
+          resp = get(
+            @auth,
+            "#{SendGrid4r::Client::BASE_URL}/browsers/stats",
+            params,
+            &block
+          )
+          SendGrid4r::REST::Stats.create_top_stats(resp)
         end
       end
     end

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

@@ -11,21 +11,25 @@ module SendGrid4r
       #
       module Category
         def get_categories_stats(
-            start_date:, end_date: nil, aggregated_by: nil, categories:)
+            start_date:, end_date: nil, aggregated_by: nil, categories:, &block)
           params = {
             start_date: start_date,
             end_date: end_date,
             aggregated_by: aggregated_by,
             categories: categories
           }
-          resp_a = get(
-            @auth, "#{SendGrid4r::Client::BASE_URL}/categories/stats", params)
-          SendGrid4r::REST::Stats.create_top_stats(resp_a)
+          resp = get(
+            @auth,
+            "#{SendGrid4r::Client::BASE_URL}/categories/stats",
+            params,
+            &block
+          )
+          SendGrid4r::REST::Stats.create_top_stats(resp)
         end
 
         def get_categories_stats_sums(
             start_date:, end_date: nil, sort_by_metric: nil,
-            sort_by_direction: nil, limit: nil, offset: nil)
+            sort_by_direction: nil, limit: nil, offset: nil, &block)
           params = {
             start_date: start_date,
             end_date: end_date,
@@ -37,7 +41,8 @@ module SendGrid4r
           resp = get(
             @auth,
             "#{SendGrid4r::Client::BASE_URL}/categories/stats/sums",
-            params)
+            params,
+            &block)
           SendGrid4r::REST::Stats.create_top_stat(resp)
         end
       end

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

@@ -10,15 +10,17 @@ module SendGrid4r
       # SendGrid Web API v3 Stats - Global
       #
       module Global
-        def get_global_stats(start_date:, end_date: nil, aggregated_by: nil)
+        def get_global_stats(
+          start_date:, end_date: nil, aggregated_by: nil, &block
+        )
           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)
+          resp = get(
+            @auth, "#{SendGrid4r::Client::BASE_URL}/stats", params, &block)
+          SendGrid4r::REST::Stats.create_top_stats(resp)
         end
       end
     end

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

@@ -10,15 +10,21 @@ module SendGrid4r
       # SendGrid Web API v3 Stats - Parse
       #
       module Parse
-        def get_parse_stats(start_date:, end_date: nil, aggregated_by: nil)
+        def get_parse_stats(
+          start_date:, end_date: nil, aggregated_by: nil, &block
+        )
           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)
+          resp = get(
+            @auth,
+            "#{SendGrid4r::Client::BASE_URL}/user/webhooks/parse/stats",
+            params,
+            &block
+          )
+          SendGrid4r::REST::Stats.create_top_stats(resp)
         end
       end
     end

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

@@ -42,6 +42,7 @@ module SendGrid4r
       )
 
       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))
@@ -50,34 +51,28 @@ module SendGrid4r
       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_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']
+          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))

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

@@ -11,21 +11,24 @@ module SendGrid4r
       #
       module Subuser
         def get_subusers_stats(
-            start_date:, end_date: nil, aggregated_by: nil, subusers:)
+            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_a = get(
-            @auth, "#{SendGrid4r::Client::BASE_URL}/subusers/stats", params)
-          SendGrid4r::REST::Stats.create_top_stats(resp_a)
+          resp = get(
+            @auth,
+            "#{SendGrid4r::Client::BASE_URL}/subusers/stats",
+            params,
+            &block)
+          SendGrid4r::REST::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)
+            sort_by_direction: nil, limit: nil, offset: nil, &block)
           params = {
             start_date: start_date,
             end_date: end_date,
@@ -37,7 +40,8 @@ module SendGrid4r
           resp = get(
             @auth,
             "#{SendGrid4r::Client::BASE_URL}/subusers/stats/sums",
-            params
+            params,
+            &block
           )
           SendGrid4r::REST::Stats.create_top_stat(resp)
         end

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

@@ -12,6 +12,7 @@ module SendGrid4r
     module Templates
       include SendGrid4r::REST::Request
 
+      Templates = Struct.new(:templates)
       Template = Struct.new(:id, :name, :versions)
 
       def self.url(temp_id = nil)
@@ -20,41 +21,47 @@ module SendGrid4r
         url
       end
 
+      def self.create_templates(resp)
+        return resp if resp.nil?
+        tmps = []
+        resp['templates'].each do |template|
+          tmps.push(SendGrid4r::REST::Templates.create_template(template))
+        end
+        Templates.new(tmps)
+      end
+
       def self.create_template(resp)
+        return resp if resp.nil?
         vers = []
         resp['versions'].each do |ver|
-          vers.push(SendGrid4r::REST::Templates.create_version(ver))
+          vers.push(SendGrid4r::REST::Templates::Versions.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)
+      def post_template(name, &block)
+        resp = post(@auth, SendGrid4r::REST::Templates.url, name: name, &block)
         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
+      def get_templates(&block)
+        resp = get(@auth, SendGrid4r::REST::Templates.url, &block)
+        SendGrid4r::REST::Templates.create_templates(resp)
       end
 
-      def get_template(temp_id)
-        resp = get(@auth, SendGrid4r::REST::Templates.url(temp_id))
+      def get_template(temp_id, &block)
+        resp = get(@auth, SendGrid4r::REST::Templates.url(temp_id), &block)
         SendGrid4r::REST::Templates.create_template(resp)
       end
 
-      def patch_template(temp_id, name)
+      def patch_template(temp_id, name, &block)
         resp = patch(
-          @auth, SendGrid4r::REST::Templates.url(temp_id), 'name' => name)
+          @auth, SendGrid4r::REST::Templates.url(temp_id), name: name, &block)
         SendGrid4r::REST::Templates.create_template(resp)
       end
 
-      def delete_template(temp_id)
-        delete(@auth, SendGrid4r::REST::Templates.url(temp_id))
+      def delete_template(temp_id, &block)
+        delete(@auth, SendGrid4r::REST::Templates.url(temp_id), &block)
       end
     end
   end

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

@@ -9,73 +9,76 @@ module SendGrid4r
     # 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
 
+        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 = "#{SendGrid4r::Client::BASE_URL}/templates/#{temp_id}/versions"
           url = "#{url}/#{ver_id}" unless ver_id.nil?
           url
         end
 
-        def post_version(temp_id, version)
+        def post_version(temp_id, version, &block)
           resp = post(
             @auth,
-            "#{SendGrid4r::REST::Templates::Versions.url(temp_id)}",
-            remove_uneditable_keys(version.to_h)
+            SendGrid4r::REST::Templates::Versions.url(temp_id),
+            remove_uneditable_keys(version.to_h),
+            &block
           )
-          SendGrid4r::REST::Templates.create_version(resp)
+          SendGrid4r::REST::Templates::Versions.create_version(resp)
         end
 
-        def activate_version(temp_id, ver_id)
+        def activate_version(temp_id, ver_id, &block)
           url = SendGrid4r::REST::Templates::Versions.url(temp_id, ver_id)
-          resp = post(
-            @auth,
-            "#{url}/activate"
-          )
-          SendGrid4r::REST::Templates.create_version(resp)
+          resp = post(@auth, "#{url}/activate", &block)
+          SendGrid4r::REST::Templates::Versions.create_version(resp)
         end
 
-        def get_version(temp_id, ver_id)
+        def get_version(temp_id, ver_id, &block)
           resp = get(
             @auth,
-            "#{SendGrid4r::REST::Templates::Versions.url(temp_id, ver_id)}")
-          SendGrid4r::REST::Templates.create_version(resp)
+            SendGrid4r::REST::Templates::Versions.url(temp_id, ver_id),
+            &block
+          )
+          SendGrid4r::REST::Templates::Versions.create_version(resp)
         end
 
-        def patch_version(temp_id, ver_id, version)
+        def patch_version(temp_id, ver_id, version, &block)
           resp = patch(
             @auth,
-            "#{SendGrid4r::REST::Templates::Versions.url(temp_id, ver_id)}",
-            remove_uneditable_keys(version.to_h)
+            SendGrid4r::REST::Templates::Versions.url(temp_id, ver_id),
+            remove_uneditable_keys(version.to_h),
+            &block
           )
-          SendGrid4r::REST::Templates.create_version(resp)
+          SendGrid4r::REST::Templates::Versions.create_version(resp)
         end
 
-        def delete_version(temp_id, ver_id)
+        def delete_version(temp_id, ver_id, &block)
           delete(
             @auth,
-            "#{SendGrid4r::REST::Templates::Versions.url(temp_id, ver_id)}"
+            SendGrid4r::REST::Templates::Versions.url(temp_id, ver_id),
+            &block
           )
         end
 

data/lib/sendgrid4r/version.rb

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

data/spec/api_keys/api_keys_spec.rb

@@ -0,0 +1,152 @@
+# encoding: utf-8
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe SendGrid4r::REST::ApiKeys do
+  describe 'integration test' do
+    before do
+      begin
+        Dotenv.load
+        @client = SendGrid4r::Client.new(api_key: ENV['API_KEY'])
+        @name1 = 'api_key_name1'
+        @name2 = 'api_key_name2'
+        @name1e = 'api_key_name1_edit'
+
+        # celan up test env(lists)
+        api_keys = @client.get_api_keys
+        api_keys.result.each do |api_key|
+          @client.delete_api_key(api_key.api_key_id) if api_key.name == @name1
+          @client.delete_api_key(api_key.api_key_id) if api_key.name == @name2
+          @client.delete_api_key(api_key.api_key_id) if api_key.name == @name1e
+        end
+
+        # post api_key
+        @api_key1 = @client.post_api_key(@name1)
+      rescue => e
+        puts e.inspect
+        raise e
+      end
+    end
+
+    context 'without block call' do
+      it '#get_api_keys' do
+        begin
+          api_keys = @client.get_api_keys
+          expect(api_keys).to be_a(SendGrid4r::REST::ApiKeys::ApiKeys)
+          expect(api_keys.result).to be_a(Array)
+        rescue => e
+          puts e.inspect
+          raise e
+        end
+      end
+
+      it '#post_api_key' do
+        begin
+          api_key2 = @client.post_api_key(@name2)
+          expect(api_key2).to be_a(SendGrid4r::REST::ApiKeys::ApiKey)
+          expect(api_key2.name).to eq(@name2)
+          expect(api_key2.api_key_id).to be_a(String)
+          expect(api_key2.api_key).to be_a(String)
+          expect(api_key2.scope_set_id).to be_a(String)
+        rescue => e
+          puts e.inspect
+          raise e
+        end
+      end
+
+      it '#delete_api_key' do
+        begin
+          @client.delete_api_key(@api_key1.api_key_id)
+        rescue => e
+          puts e.inspect
+          raise e
+        end
+      end
+
+      it '#patch_api_key' do
+        begin
+          edit_api_key = @client.patch_api_key(@api_key1.api_key_id, @name1e)
+          expect(edit_api_key.api_key_id).to eq(@api_key1.api_key_id)
+          expect(edit_api_key.name).to eq(@name1e)
+        rescue => e
+          puts e.inspect
+          raise e
+        end
+      end
+    end
+
+    context 'with block call' do
+      it '#get_api_keys' do
+        @client.get_api_keys do |resp, req, res|
+          resp =
+            SendGrid4r::REST::ApiKeys.create_api_keys(JSON.parse(resp))
+          expect(resp).to be_a(SendGrid4r::REST::ApiKeys::ApiKeys)
+          expect(req).to be_a(RestClient::Request)
+          expect(res).to be_a(Net::HTTPOK)
+        end
+      end
+
+      it '#post_api_key' do
+        @client.post_api_key(@name2) do |resp, req, res|
+          resp =
+            SendGrid4r::REST::ApiKeys.create_api_key(JSON.parse(resp))
+          expect(resp).to be_a(SendGrid4r::REST::ApiKeys::ApiKey)
+          expect(req).to be_a(RestClient::Request)
+          expect(res).to be_a(Net::HTTPCreated)
+        end
+      end
+
+      it '#delete_api_key' do
+        @client.delete_api_key(@api_key1.api_key_id) do |resp, req, res|
+          expect(resp).to eq('')
+          expect(req).to be_a(RestClient::Request)
+          expect(res).to be_a(Net::HTTPNoContent)
+        end
+      end
+
+      it '#patch_api_key' do
+        @client.patch_api_key(@api_key1.api_key_id, @name1e) do |resp, req, res|
+          resp =
+            SendGrid4r::REST::ApiKeys.create_api_key(JSON.parse(resp))
+          expect(resp).to be_a(SendGrid4r::REST::ApiKeys::ApiKey)
+          expect(req).to be_a(RestClient::Request)
+          expect(res).to be_a(Net::HTTPOK)
+        end
+      end
+    end
+  end
+
+  describe 'unit test' do
+    it 'creates api_key instance' do
+      json =
+        '{'\
+          '"api_key_id": "qfTQ6KG0QBiwWdJ0-pCLCA",'\
+          '"name": "A New Hope"'\
+        '}'
+      hash = JSON.parse(json)
+      actual = SendGrid4r::REST::ApiKeys.create_api_key(hash)
+      expect(actual).to be_a(SendGrid4r::REST::ApiKeys::ApiKey)
+      expect(actual.api_key_id).to eq('qfTQ6KG0QBiwWdJ0-pCLCA')
+      expect(actual.name).to eq('A New Hope')
+    end
+
+    it 'creates api_keys instance' do
+      json =
+        '{'\
+          '"result": ['\
+            '{'\
+              '"name": "A New Hope",'\
+              '"api_key_id": "xxxxxxxx"'\
+            '}'\
+          ']'\
+        '}'
+      hash = JSON.parse(json)
+      actual = SendGrid4r::REST::ApiKeys.create_api_keys(hash)
+      expect(actual).to be_a(SendGrid4r::REST::ApiKeys::ApiKeys)
+      expect(actual.result).to be_a(Array)
+      actual.result.each do |api_key|
+        expect(api_key.name).to eq('A New Hope')
+        expect(api_key.api_key_id).to eq('xxxxxxxx')
+      end
+    end
+  end
+end