sendgrid4r 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9e77f18ddd75a6b86d7d8fe6fb50b3cb64ec8955
-  data.tar.gz: d594830d614fe4ba1c7b648d3a3929f904bdbca5
+  metadata.gz: 18804ec5896082dcfa570e2b27a7d58ab6092903
+  data.tar.gz: 09f1702cbe8b86550e66a8f8522b593562ce177d
 SHA512:
-  metadata.gz: 1f5845e151068e2cfe8d78dd19914b8ba76dad7d4f747f1a36bf292d7cb1b4f977afc406f334581f41c92a9edffc719d265551512bf622f267ff8a993eeccad8
-  data.tar.gz: a998a7a72c8c0400066bc3576b51f4182155db45cea319fc7bda6ebf93f4decfcbaf2c70ebd24ce5e724550f7c568c16fcad64959750de8a60372294ebc969ab
+  metadata.gz: cee31b5daa5bdc9b0fb90a7d16b0f7c7ce6efe375870c17200294b57f7c80b87110c3b3a580e985a91f3a1cbcb4ae4c4bf11aad91ecf9559096e917d7125e7ed
+  data.tar.gz: cdac0d4cbbd0308f9c0eb2945f0e566893543f2fb6e5d4f4dd427dfdb9a07e5aa83a64de52e8b44f94ea4f1e4169b13e756180b3a399a49b20f927e28710b763

data/.env.example

@@ -1,2 +1,7 @@
 SENDGRID_USERNAME=sendgrid username
 SENDGRID_PASSWORD=sendgrid_password
+API_KEY=apikey
+USE_SILVER=true
+SILVER_SENDGRID_USERNAME=silver_sendgrid_username
+SILVER_SENDGRID_PASSWORD=silver_sendgird_password
+SILVER_SUBUSER=subusername

data/.rubocop.yml

@@ -1,25 +1,25 @@
-# メソッド名のprefixに「set_」「get_」を許可
+# Let prefix of method name set_ and get_
 AccessorMethodName:
   Enabled: false
 
-# メソッドの行数上限を変更
+# Change limitation of method length
 MethodLength:
   CountComments: true  # count full line comments?
   Max: 20
 
-# 引数上限を変更
+# Change limitation of the number of params
 ParameterLists:
-  Max: 6
+  Max: 7
   CountKeywordArgs: true
 
-# AbcSizeの上限を変更
+# Change limitation of AbcSize
 AbcSize:
-  Max: 20
+  Max: 21
 
-# %r 内で利用できるスラッシュの数の制限変更
+# Change limitation of the number of '/' within %r
 RegexpLiteral:
   MaxSlashes: 0
 
-# 数値の区切りをなくす
+# Change numeric literals
 NumericLiterals:
   MinDigits: 20

data/README.md

@@ -1,5 +1,7 @@
 # Sendgrid4r
 
+**This gem is BETA yet. The interfaces will be changed often.**
+
 This gem allows you to quickly and easily access to SendGrid Web API v3 for Ruby.
 See [api reference](https://sendgrid.com/docs/API_Reference/Web_API_v3/index.html) for more detail
 

data/lib/auth.rb

@@ -6,11 +6,14 @@ module SendGrid4r
   # SendGrid Web API v3 data container for authentication
   #
   class Auth
-    attr_reader :username, :password
+    attr_reader :username, :password, :api_key
 
-    def initialize(username, password)
+    def initialize(
+      username: username, password: password, api_key: api_key = nil
+    )
       @username = username
       @password = password
+      @api_key = api_key
     end
   end
 end

data/lib/client.rb

@@ -16,8 +16,10 @@ module SendGrid4r
 
     BASE_URL = 'https://api.sendgrid.com/v3'
 
-    def initialize(username, password)
-      @auth = Auth.new(username, password)
+    def initialize(
+      username: username, password: password, api_key: api_key = nil
+    )
+      @auth = Auth.new(username: username, password: password, api_key: api_key)
     end
   end
 end

data/lib/sendgrid4r/factory/version_factory.rb

@@ -10,7 +10,7 @@ module SendGrid4r
       def create(
         name:, subject: '<%subject%>',
         html_content: '<%body%>', plain_content: '<%body%>', active: 1)
-        SendGrid4r::REST::Templates::Version.new(
+        SendGrid4r::REST::Templates::Versions::Version.new(
           nil,
           nil,
           nil,

data/lib/sendgrid4r/rest/api.rb

@@ -3,6 +3,7 @@ $LOAD_PATH.unshift File.dirname(__FILE__)
 
 require 'sendgrid4r/rest/templates/templates'
 require 'sendgrid4r/rest/templates/versions'
+require 'sendgrid4r/rest/asm/asm'
 require 'sendgrid4r/rest/asm/groups'
 require 'sendgrid4r/rest/asm/suppressions'
 require 'sendgrid4r/rest/asm/global_suppressions'
@@ -22,6 +23,7 @@ require 'sendgrid4r/rest/contacts/lists'
 require 'sendgrid4r/rest/contacts/recipients'
 require 'sendgrid4r/rest/contacts/reserved_fields'
 require 'sendgrid4r/rest/contacts/segments'
+require 'sendgrid4r/rest/api_keys/api_keys'
 
 module SendGrid4r
   module REST
@@ -31,6 +33,7 @@ module SendGrid4r
     module API
       include SendGrid4r::REST::Templates
       include SendGrid4r::REST::Templates::Versions
+      include SendGrid4r::REST::Asm
       include SendGrid4r::REST::Asm::Groups
       include SendGrid4r::REST::Asm::Suppressions
       include SendGrid4r::REST::Asm::GlobalSuppressions
@@ -49,6 +52,7 @@ module SendGrid4r
       include SendGrid4r::REST::Contacts::Recipients
       include SendGrid4r::REST::Contacts::ReservedFields
       include SendGrid4r::REST::Contacts::Segments
+      include SendGrid4r::REST::ApiKeys
     end
   end
 end

data/lib/sendgrid4r/rest/api_keys/api_keys.rb

@@ -0,0 +1,73 @@
+# -*- encoding: utf-8 -*-
+$LOAD_PATH.unshift File.dirname(__FILE__)
+
+require 'sendgrid4r/rest/request'
+
+module SendGrid4r
+  module REST
+    #
+    # SendGrid Web API v3 ApiKeys
+    #
+    module ApiKeys
+      include SendGrid4r::REST::Request
+
+      ApiKeys = Struct.new(:result)
+      ApiKey = Struct.new(:name, :api_key_id, :api_key, :scope_set_id)
+
+      def self.url(api_key = nil)
+        url = "#{SendGrid4r::Client::BASE_URL}/api_keys"
+        url = "#{url}/#{api_key}" unless api_key.nil?
+        url
+      end
+
+      def self.create_api_keys(resp)
+        return resp if resp.nil?
+        api_keys = []
+        resp['result'].each do |api_key|
+          api_keys.push(SendGrid4r::REST::ApiKeys.create_api_key(api_key))
+        end
+        ApiKeys.new(api_keys)
+      end
+
+      def self.create_api_key(resp)
+        return resp if resp.nil?
+        ApiKey.new(
+          resp['name'],
+          resp['api_key_id'],
+          resp['api_key'],
+          resp['scope_set_id']
+        )
+      end
+
+      def get_api_keys(&block)
+        resp = get(@auth, SendGrid4r::REST::ApiKeys.url, &block)
+        SendGrid4r::REST::ApiKeys.create_api_keys(resp)
+      end
+
+      def post_api_key(name, &block)
+        params = {}
+        params['name'] = name
+        resp = post(
+          @auth, SendGrid4r::REST::ApiKeys.url, params, &block
+        )
+        SendGrid4r::REST::ApiKeys.create_api_key(resp)
+      end
+
+      def delete_api_key(api_key, &block)
+        delete(@auth, SendGrid4r::REST::ApiKeys.url(api_key), &block)
+      end
+
+      def patch_api_key(api_key, name, &block)
+        params = {}
+        params['name'] = name
+        resp = patch(
+          @auth,
+          SendGrid4r::REST::ApiKeys.url(api_key),
+          params,
+          &block
+        )
+        SendGrid4r::REST::ApiKeys.create_api_key(resp)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+$LOAD_PATH.unshift File.dirname(__FILE__)
+
+require 'sendgrid4r/rest/request'
+
+module SendGrid4r
+  module REST
+    #
+    # SendGrid Web API v3 Advanced Suppression Manager
+    #
+    module Asm
+      include SendGrid4r::REST::Request
+
+      RecipientEmails = Struct.new(:recipient_emails)
+      RecipientEmail = Struct.new(:recipient_email)
+
+      def self.create_recipient_emails(resp)
+        return resp if resp.nil?
+        RecipientEmails.new(resp['recipient_emails'])
+      end
+
+      def self.create_recipient_email(resp)
+        return resp if resp.nil?
+        RecipientEmail.new(resp['recipient_email'])
+      end
+    end
+  end
+end

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

@@ -18,27 +18,31 @@ module SendGrid4r
           url
         end
 
-        def post_global_suppressed_emails(recipient_emails)
+        def post_global_suppressed_emails(recipient_emails, &block)
           params = { recipient_emails: recipient_emails }
           resp = post(
             @auth,
             SendGrid4r::REST::Asm::GlobalSuppressions.url,
-            params
+            params,
+            &block
           )
-          resp['recipient_emails']
+          SendGrid4r::REST::Asm.create_recipient_emails(resp)
         end
 
-        def get_global_suppressed_email(email_address)
+        def get_global_suppressed_email(email_address, &block)
           resp = get(
             @auth,
-            SendGrid4r::REST::Asm::GlobalSuppressions.url(email_address)
+            SendGrid4r::REST::Asm::GlobalSuppressions.url(email_address),
+            &block
           )
-          resp['recipient_email']
+          SendGrid4r::REST::Asm.create_recipient_email(resp)
         end
 
-        def delete_global_suppressed_email(email_address)
+        def delete_global_suppressed_email(email_address, &block)
           delete(
-            @auth, SendGrid4r::REST::Asm::GlobalSuppressions.url(email_address))
+            @auth,
+            SendGrid4r::REST::Asm::GlobalSuppressions.url(email_address),
+            &block)
         end
       end
     end

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

@@ -15,7 +15,23 @@ module SendGrid4r
         Group = Struct.new(
           :id, :name, :description, :last_email_sent_at, :unsubscribes)
 
+        def self.url(group_id = nil)
+          url = "#{SendGrid4r::Client::BASE_URL}/asm/groups"
+          url = "#{url}/#{group_id}" unless group_id.nil?
+          url
+        end
+
+        def self.create_groups(resp)
+          return resp if resp.nil?
+          groups = []
+          resp.each do |group|
+            groups.push(SendGrid4r::REST::Asm::Groups.create_group(group))
+          end
+          groups
+        end
+
         def self.create_group(resp)
+          return resp if resp.nil?
           Group.new(
             resp['id'],
             resp['name'],
@@ -25,43 +41,34 @@ module SendGrid4r
           )
         end
 
-        def post_group(name, description)
+        def post_group(name, description, &block)
           params = { name: name, description: description }
-          resp = post(
-            @auth, "#{SendGrid4r::Client::BASE_URL}/asm/groups", params
-          )
+          resp = post(@auth, SendGrid4r::REST::Asm::Groups.url, params, &block)
           SendGrid4r::REST::Asm::Groups.create_group(resp)
         end
 
-        def get_groups
-          resp_a = get(@auth, "#{SendGrid4r::Client::BASE_URL}/asm/groups")
-          groups = []
-          resp_a.each do |resp|
-            groups.push(SendGrid4r::REST::Asm::Groups.create_group(resp))
-          end
-          groups
+        def get_groups(&block)
+          resp = get(@auth, SendGrid4r::REST::Asm::Groups.url, &block)
+          SendGrid4r::REST::Asm::Groups.create_groups(resp)
         end
 
-        def get_group(group_id)
-          resp = get(
-            @auth, "#{SendGrid4r::Client::BASE_URL}/asm/groups/#{group_id}"
-          )
+        def get_group(group_id, &block)
+          resp = get(@auth, SendGrid4r::REST::Asm::Groups.url(group_id), &block)
           SendGrid4r::REST::Asm::Groups.create_group(resp)
         end
 
-        def patch_group(group_id, group)
+        def patch_group(group_id, group, &block)
           resp = patch(
             @auth,
-            "#{SendGrid4r::Client::BASE_URL}/asm/groups/#{group_id}",
-            group.to_h
+            SendGrid4r::REST::Asm::Groups.url(group_id),
+            group.to_h,
+            &block
           )
           SendGrid4r::REST::Asm::Groups.create_group(resp)
         end
 
-        def delete_group(group_id)
-          delete(
-            @auth, "#{SendGrid4r::Client::BASE_URL}/asm/groups/#{group_id}"
-          )
+        def delete_group(group_id, &block)
+          delete(@auth, SendGrid4r::REST::Asm::Groups.url(group_id), &block)
         end
       end
     end

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

@@ -13,6 +13,7 @@ module SendGrid4r
         include SendGrid4r::REST::Request
 
         Suppression = Struct.new(:id, :name, :description, :suppressed)
+        Suppressions = Struct.new(:suppressions)
 
         def self.url(group_id, email_address = nil)
           url =
@@ -22,9 +23,24 @@ module SendGrid4r
           url
         end
 
+        def self.create_suppressions(resp)
+          resp if resp.nil?
+          suppressions = []
+          resp['suppressions'].each do |suppression|
+            suppressions.push(
+              SendGrid4r::REST::Asm::Suppressions.create_suppression(
+                suppression
+              )
+            )
+          end
+          Suppressions.new(suppressions)
+        end
+
         def self.create_suppression(resp)
+          resp if resp.nil?
           Suppression.new(
-            resp['id'], resp['name'], resp['description'], resp['suppressed'])
+            resp['id'], resp['name'], resp['description'], resp['suppressed']
+          )
         end
 
         def post_suppressed_emails(group_id, recipient_emails)
@@ -33,20 +49,7 @@ module SendGrid4r
             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
+          SendGrid4r::REST::Asm.create_recipient_emails(resp)
         end
 
         def get_suppressed_emails(group_id)
@@ -56,6 +59,13 @@ module SendGrid4r
           )
         end
 
+        def get_suppressions(email_address)
+          resp = get(
+            @auth,
+            "#{SendGrid4r::Client::BASE_URL}/asm/suppressions/#{email_address}")
+          SendGrid4r::REST::Asm::Suppressions.create_suppressions(resp)
+        end
+
         def delete_suppressed_email(group_id, email_address)
           delete(
             @auth,

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

@@ -15,23 +15,33 @@ module SendGrid4r
         Category = Struct.new(:category)
 
         def self.create_category(resp)
+          return resp if resp.nil?
           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)
+        def self.create_categories(resp)
+          return resp if resp.nil?
           categories = []
-          resp_a.each do |resp|
+          resp.each do |category|
             categories.push(
-              SendGrid4r::REST::Categories::Categories.create_category(resp))
+              SendGrid4r::REST::Categories::Categories.create_category(
+                category
+              )
+            )
           end
           categories
         end
+
+        def get_categories(category = nil, limit = nil, offset = nil, &block)
+          params = {}
+          params['category'] = category unless category.nil?
+          params['limit'] = limit unless limit.nil?
+          params['offset'] = offset unless limit.nil?
+          resp = get(
+            @auth, "#{SendGrid4r::Client::BASE_URL}/categories", params, &block
+          )
+          SendGrid4r::REST::Categories::Categories.create_categories(resp)
+        end
       end
     end
   end

data/lib/sendgrid4r/rest/contacts/custom_fields.rb

@@ -31,10 +31,12 @@ module SendGrid4r
         end
 
         def self.create_field(resp)
+          return resp if resp.nil?
           Field.new(resp['id'], resp['name'], resp['type'], resp['value'])
         end
 
         def self.create_fields(resp)
+          return resp if resp.nil?
           custom_fields = []
           resp['custom_fields'].each do |field|
             custom_fields.push(
@@ -44,33 +46,37 @@ module SendGrid4r
           Fields.new(custom_fields)
         end
 
-        def post_custom_field(name, type)
+        def post_custom_field(name, type, &block)
           params = {}
           params['name'] = name
           params['type'] = type
           resp = post(
-            @auth, SendGrid4r::REST::Contacts::CustomFields.url, params
+            @auth, SendGrid4r::REST::Contacts::CustomFields.url, params, &block
           )
           SendGrid4r::REST::Contacts::CustomFields.create_field(resp)
         end
 
-        def get_custom_fields
-          resp = get(@auth, SendGrid4r::REST::Contacts::CustomFields.url)
+        def get_custom_fields(&block)
+          resp = get(
+            @auth, SendGrid4r::REST::Contacts::CustomFields.url, &block
+          )
           SendGrid4r::REST::Contacts::CustomFields.create_fields(resp)
         end
 
-        def get_custom_field(custom_field_id)
+        def get_custom_field(custom_field_id, &block)
           resp = get(
             @auth,
-            SendGrid4r::REST::Contacts::CustomFields.url(custom_field_id)
+            SendGrid4r::REST::Contacts::CustomFields.url(custom_field_id),
+            &block
           )
           SendGrid4r::REST::Contacts::CustomFields.create_field(resp)
         end
 
-        def delete_custom_field(custom_field_id)
+        def delete_custom_field(custom_field_id, &block)
           delete(
             @auth,
-            SendGrid4r::REST::Contacts::CustomFields.url(custom_field_id)
+            SendGrid4r::REST::Contacts::CustomFields.url(custom_field_id),
+            &block
           )
         end
       end

data/lib/sendgrid4r/rest/contacts/lists.rb

@@ -28,10 +28,12 @@ module SendGrid4r
         end
 
         def self.create_list(resp)
+          return resp if resp.nil?
           List.new(resp['id'], resp['name'], resp['recipient_count'])
         end
 
         def self.create_lists(resp)
+          return resp if resp.nil?
           lists = []
           resp['lists'].each do |list|
             lists.push(SendGrid4r::REST::Contacts::Lists.create_list(list))
@@ -39,83 +41,93 @@ module SendGrid4r
           Lists.new(lists)
         end
 
-        def post_list(name)
+        def post_list(name, &block)
           params = {}
           params['name'] = name
-          resp = post(@auth, SendGrid4r::REST::Contacts::Lists.url, params)
+          resp = post(
+            @auth, SendGrid4r::REST::Contacts::Lists.url, params, &block
+          )
           SendGrid4r::REST::Contacts::Lists.create_list(resp)
         end
 
-        def get_lists
-          resp = get(@auth, SendGrid4r::REST::Contacts::Lists.url)
+        def get_lists(&block)
+          resp = get(@auth, SendGrid4r::REST::Contacts::Lists.url, &block)
           SendGrid4r::REST::Contacts::Lists.create_lists(resp)
         end
 
-        def get_list(list_id)
-          resp = get(@auth, SendGrid4r::REST::Contacts::Lists.url(list_id))
+        def get_list(list_id, &block)
+          resp = get(
+            @auth, SendGrid4r::REST::Contacts::Lists.url(list_id), &block
+          )
           SendGrid4r::REST::Contacts::Lists.create_list(resp)
         end
 
-        def patch_list(list_id, name)
+        def patch_list(list_id, name, &block)
           params = {}
           params['name'] = name
           resp = patch(
             @auth,
             SendGrid4r::REST::Contacts::Lists.url(list_id),
-            params
+            params,
+            &block
           )
           SendGrid4r::REST::Contacts::Lists.create_list(resp)
         end
 
-        def delete_list(list_id)
-          delete(@auth, SendGrid4r::REST::Contacts::Lists.url(list_id))
+        def delete_list(list_id, &block)
+          delete(@auth, SendGrid4r::REST::Contacts::Lists.url(list_id), &block)
         end
 
         # no bodies returned
-        def post_recipients_to_list(list_id, recipients)
+        def post_recipients_to_list(list_id, recipients, &block)
           url = SendGrid4r::REST::Contacts::Lists.url(list_id)
           post(
             @auth,
             "#{url}/recipients_batch",
-            recipients
+            recipients,
+            &block
           )
         end
 
-        def get_recipients_from_list(list_id, limit = nil, offset = nil)
+        def get_recipients_from_list(list_id, limit = nil, offset = nil, &block)
           params = {}
           params['limit'] = limit unless limit.nil?
           params['offset'] = offset unless offset.nil?
           resp = get(
             @auth,
             SendGrid4r::REST::Contacts::Lists.recipients_url(list_id),
-            params
+            params,
+            &block
           )
           SendGrid4r::REST::Contacts::Recipients.create_recipients(resp)
         end
 
-        def post_recipient_to_list(list_id, recipient_id)
+        def post_recipient_to_list(list_id, recipient_id, &block)
           post(
             @auth,
             SendGrid4r::REST::Contacts::Lists.recipients_url(
               list_id, recipient_id
-            )
+            ),
+            &block
           )
         end
 
-        def delete_recipient_from_list(list_id, recipient_id)
+        def delete_recipient_from_list(list_id, recipient_id, &block)
           delete(
             @auth,
             SendGrid4r::REST::Contacts::Lists.recipients_url(
               list_id, recipient_id
-            )
+            ),
+            &block
           )
         end
 
-        def delete_lists(list_ids)
+        def delete_lists(list_ids, &block)
           delete(
             @auth,
             "#{SendGrid4r::Client::BASE_URL}/contactdb/lists_batch",
-            list_ids
+            list_ids,
+            &block
           )
         end
       end