sendgrid4r 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fb22cf3a6851051dc9aff2ccd01bb58f44f05d6b
-  data.tar.gz: 78395e30015b6182fdf8bdc61bf773d1a0b2c0f3
+  metadata.gz: 9e77f18ddd75a6b86d7d8fe6fb50b3cb64ec8955
+  data.tar.gz: d594830d614fe4ba1c7b648d3a3929f904bdbca5
 SHA512:
-  metadata.gz: 4e38ab32b44f3bf59f2c5feb724af2ad0b3d1c128e99f8f490a41a4fecd2d2b44e42c2dd690c65654c2e68d706b465ed6e2fc57c028fbb893f8ecffb1ed1f45e
-  data.tar.gz: d34d0ed4873dc08367e41c88101095b967b10c292807f39132fc994ab415e3a5551c843ba8ba5b4ee6aaeaebfb404865fee394bd3d22c5999da3bf3a06182fe1
+  metadata.gz: 1f5845e151068e2cfe8d78dd19914b8ba76dad7d4f747f1a36bf292d7cb1b4f977afc406f334581f41c92a9edffc719d265551512bf622f267ff8a993eeccad8
+  data.tar.gz: a998a7a72c8c0400066bc3576b51f4182155db45cea319fc7bda6ebf93f4decfcbaf2c70ebd24ce5e724550f7c568c16fcad64959750de8a60372294ebc969ab

data/.rubocop.yml

@@ -19,3 +19,7 @@ AbcSize:
 # %r 内で利用できるスラッシュの数の制限変更
 RegexpLiteral:
   MaxSlashes: 0
+
+# 数値の区切りをなくす
+NumericLiterals:
+  MinDigits: 20

data/lib/client.rb

@@ -4,6 +4,8 @@ $LOAD_PATH.unshift File.dirname(__FILE__)
 require 'auth'
 require 'sendgrid4r/rest/api'
 require 'sendgrid4r/factory/version_factory'
+require 'sendgrid4r/factory/condition_factory'
+require 'sendgrid4r/factory/segment_factory'
 
 module SendGrid4r
   #

data/lib/sendgrid4r/factory/condition_factory.rb

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+$LOAD_PATH.unshift File.dirname(__FILE__)
+
+module SendGrid4r
+  module Factory
+    #
+    # SendGrid Web API v3 Condition Factory Class implementation
+    #
+    class ConditionFactory
+      def create(field:, value:, operator:, and_or:)
+        SendGrid4r::REST::Contacts::Segments::Condition.new(
+          field,
+          value,
+          operator,
+          and_or
+        ).to_h
+      end
+    end
+  end
+end

data/lib/sendgrid4r/factory/segment_factory.rb

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+$LOAD_PATH.unshift File.dirname(__FILE__)
+
+module SendGrid4r
+  module Factory
+    #
+    # SendGrid Web API v3 Segment Factory Class implementation
+    #
+    class SegmentFactory
+      def create(name:, conditions:)
+        SendGrid4r::REST::Contacts::Segments::Segment.new(
+          nil,
+          name,
+          nil,
+          conditions,
+          nil
+        ).to_h
+      end
+    end
+  end
+end

data/lib/sendgrid4r/factory/version_factory.rb

@@ -2,24 +2,26 @@
 $LOAD_PATH.unshift File.dirname(__FILE__)
 
 module SendGrid4r
-  #
-  # SendGrid Web API v3 Factory Class implementation
-  #
-  class VersionFactory
-    def create(
-      name:, subject: '<%subject%>',
-      html_content: '<%body%>', plain_content: '<%body%>', active: 1)
-      SendGrid4r::REST::Templates::Version.new(
-        nil,
-        nil,
-        nil,
-        active,
-        name,
-        html_content,
-        plain_content,
-        subject,
-        nil
-      )
+  module Factory
+    #
+    # SendGrid Web API v3 Factory Class implementation
+    #
+    class VersionFactory
+      def create(
+        name:, subject: '<%subject%>',
+        html_content: '<%body%>', plain_content: '<%body%>', active: 1)
+        SendGrid4r::REST::Templates::Version.new(
+          nil,
+          nil,
+          nil,
+          active,
+          name,
+          html_content,
+          plain_content,
+          subject,
+          nil
+        )
+      end
     end
   end
 end

data/lib/sendgrid4r/rest/api.rb

@@ -17,6 +17,11 @@ require 'sendgrid4r/rest/stats/category'
 require 'sendgrid4r/rest/stats/subuser'
 require 'sendgrid4r/rest/stats/advanced'
 require 'sendgrid4r/rest/stats/parse'
+require 'sendgrid4r/rest/contacts/custom_fields'
+require 'sendgrid4r/rest/contacts/lists'
+require 'sendgrid4r/rest/contacts/recipients'
+require 'sendgrid4r/rest/contacts/reserved_fields'
+require 'sendgrid4r/rest/contacts/segments'
 
 module SendGrid4r
   module REST
@@ -39,6 +44,11 @@ module SendGrid4r
       include SendGrid4r::REST::Stats::Subuser
       include SendGrid4r::REST::Stats::Advanced
       include SendGrid4r::REST::Stats::Parse
+      include SendGrid4r::REST::Contacts::CustomFields
+      include SendGrid4r::REST::Contacts::Lists
+      include SendGrid4r::REST::Contacts::Recipients
+      include SendGrid4r::REST::Contacts::ReservedFields
+      include SendGrid4r::REST::Contacts::Segments
     end
   end
 end

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

@@ -0,0 +1,79 @@
+# -*- encoding: utf-8 -*-
+$LOAD_PATH.unshift File.dirname(__FILE__)
+
+require 'sendgrid4r/rest/request'
+
+module SendGrid4r
+  module REST
+    module Contacts
+      #
+      # SendGrid Web API v3 Contacts - Custom Fields
+      #
+      module CustomFields
+        include SendGrid4r::REST::Request
+
+        Field = Struct.new(:id, :name, :type, :value) do
+          def eql?(other)
+            id.eql?(other.id)
+          end
+
+          def hash
+            id.hash
+          end
+        end
+
+        Fields = Struct.new(:custom_fields)
+
+        def self.url(custom_field_id = nil)
+          url = "#{SendGrid4r::Client::BASE_URL}/contactdb/custom_fields"
+          url = "#{url}/#{custom_field_id}" unless custom_field_id.nil?
+          url
+        end
+
+        def self.create_field(resp)
+          Field.new(resp['id'], resp['name'], resp['type'], resp['value'])
+        end
+
+        def self.create_fields(resp)
+          custom_fields = []
+          resp['custom_fields'].each do |field|
+            custom_fields.push(
+              SendGrid4r::REST::Contacts::CustomFields.create_field(field)
+            )
+          end
+          Fields.new(custom_fields)
+        end
+
+        def post_custom_field(name, type)
+          params = {}
+          params['name'] = name
+          params['type'] = type
+          resp = post(
+            @auth, SendGrid4r::REST::Contacts::CustomFields.url, params
+          )
+          SendGrid4r::REST::Contacts::CustomFields.create_field(resp)
+        end
+
+        def get_custom_fields
+          resp = get(@auth, SendGrid4r::REST::Contacts::CustomFields.url)
+          SendGrid4r::REST::Contacts::CustomFields.create_fields(resp)
+        end
+
+        def get_custom_field(custom_field_id)
+          resp = get(
+            @auth,
+            SendGrid4r::REST::Contacts::CustomFields.url(custom_field_id)
+          )
+          SendGrid4r::REST::Contacts::CustomFields.create_field(resp)
+        end
+
+        def delete_custom_field(custom_field_id)
+          delete(
+            @auth,
+            SendGrid4r::REST::Contacts::CustomFields.url(custom_field_id)
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,124 @@
+# -*- encoding: utf-8 -*-
+$LOAD_PATH.unshift File.dirname(__FILE__)
+
+require 'sendgrid4r/rest/request'
+
+module SendGrid4r
+  module REST
+    module Contacts
+      #
+      # SendGrid Web API v3 Contacts - Lists
+      #
+      module Lists
+        include SendGrid4r::REST::Request
+
+        List = Struct.new(:id, :name, :recipient_count)
+        Lists = Struct.new(:lists)
+
+        def self.url(list_id = nil)
+          url = "#{SendGrid4r::Client::BASE_URL}/contactdb/lists"
+          url = "#{url}/#{list_id}" unless list_id.nil?
+          url
+        end
+
+        def self.recipients_url(list_id, recipient_id = nil)
+          url = "#{SendGrid4r::REST::Contacts::Lists.url(list_id)}/recipients"
+          url = "#{url}/#{recipient_id}" unless recipient_id.nil?
+          url
+        end
+
+        def self.create_list(resp)
+          List.new(resp['id'], resp['name'], resp['recipient_count'])
+        end
+
+        def self.create_lists(resp)
+          lists = []
+          resp['lists'].each do |list|
+            lists.push(SendGrid4r::REST::Contacts::Lists.create_list(list))
+          end
+          Lists.new(lists)
+        end
+
+        def post_list(name)
+          params = {}
+          params['name'] = name
+          resp = post(@auth, SendGrid4r::REST::Contacts::Lists.url, params)
+          SendGrid4r::REST::Contacts::Lists.create_list(resp)
+        end
+
+        def get_lists
+          resp = get(@auth, SendGrid4r::REST::Contacts::Lists.url)
+          SendGrid4r::REST::Contacts::Lists.create_lists(resp)
+        end
+
+        def get_list(list_id)
+          resp = get(@auth, SendGrid4r::REST::Contacts::Lists.url(list_id))
+          SendGrid4r::REST::Contacts::Lists.create_list(resp)
+        end
+
+        def patch_list(list_id, name)
+          params = {}
+          params['name'] = name
+          resp = patch(
+            @auth,
+            SendGrid4r::REST::Contacts::Lists.url(list_id),
+            params
+          )
+          SendGrid4r::REST::Contacts::Lists.create_list(resp)
+        end
+
+        def delete_list(list_id)
+          delete(@auth, SendGrid4r::REST::Contacts::Lists.url(list_id))
+        end
+
+        # no bodies returned
+        def post_recipients_to_list(list_id, recipients)
+          url = SendGrid4r::REST::Contacts::Lists.url(list_id)
+          post(
+            @auth,
+            "#{url}/recipients_batch",
+            recipients
+          )
+        end
+
+        def get_recipients_from_list(list_id, limit = nil, offset = nil)
+          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
+          )
+          SendGrid4r::REST::Contacts::Recipients.create_recipients(resp)
+        end
+
+        def post_recipient_to_list(list_id, recipient_id)
+          post(
+            @auth,
+            SendGrid4r::REST::Contacts::Lists.recipients_url(
+              list_id, recipient_id
+            )
+          )
+        end
+
+        def delete_recipient_from_list(list_id, recipient_id)
+          delete(
+            @auth,
+            SendGrid4r::REST::Contacts::Lists.recipients_url(
+              list_id, recipient_id
+            )
+          )
+        end
+
+        def delete_lists(list_ids)
+          delete(
+            @auth,
+            "#{SendGrid4r::Client::BASE_URL}/contactdb/lists_batch",
+            list_ids
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,176 @@
+# -*- encoding: utf-8 -*-
+$LOAD_PATH.unshift File.dirname(__FILE__)
+
+require 'sendgrid4r/rest/request'
+
+module SendGrid4r
+  module REST
+    module Contacts
+      #
+      # SendGrid Web API v3 Contacts - Recipients
+      #
+      module Recipients
+        include SendGrid4r::REST::Request
+
+        Recipient = Struct.new(
+          :created_at,
+          :custom_fields,
+          :email,
+          :first_name,
+          :id,
+          :last_clicked,
+          :last_emailed,
+          :last_name,
+          :last_opened,
+          :updated_at
+        )
+
+        Recipients = Struct.new(:recipients)
+
+        def self.create_recipient(resp)
+          custom_fields = []
+          resp['custom_fields'].each do |field|
+            custom_fields.push(
+              SendGrid4r::REST::Contacts::CustomFields.create_field(field)
+            )
+          end
+          Recipient.new(
+            resp['created_at'],
+            custom_fields,
+            resp['email'],
+            resp['first_name'],
+            resp['id'],
+            resp['last_clicked'],
+            resp['last_emailed'],
+            resp['last_name'],
+            resp['last_opend'],
+            resp['updated_at']
+          )
+        end
+
+        def self.create_recipients(resp)
+          recipients = []
+          resp['recipients'].each do |recipient|
+            recipients.push(
+              SendGrid4r::REST::Contacts::Recipients.create_recipient(recipient)
+            )
+          end
+          Recipients.new(recipients)
+        end
+
+        def self.url(recipient_id = nil)
+          url = "#{SendGrid4r::Client::BASE_URL}/contactdb/recipients"
+          url = "#{url}/#{recipient_id}" unless recipient_id.nil?
+          url
+        end
+
+        def post_recipient(params)
+          resp = post(@auth, SendGrid4r::REST::Contacts::Recipients.url, params)
+          SendGrid4r::REST::Contacts::Recipients.create_recipient(resp)
+        end
+
+        def delete_recipients(emails)
+          delete(@auth, SendGrid4r::REST::Contacts::Recipients.url, emails)
+        end
+
+        def get_recipients(limit = nil, offset = nil)
+          params = {}
+          params['limit'] = limit unless limit.nil?
+          params['offset'] = offset unless offset.nil?
+          if params.length > 0
+            resp = get(
+              @auth, SendGrid4r::REST::Contacts::Recipients.url, params
+            )
+          else
+            resp = get(
+              @auth, SendGrid4r::REST::Contacts::Recipients.url
+            )
+          end
+          SendGrid4r::REST::Contacts::Recipients.create_recipients(resp)
+        end
+
+        def get_recipients_by_id(recipient_ids)
+          resp = get(
+            @auth,
+            "#{SendGrid4r::REST::Contacts::Recipients.url}/batch",
+            nil,
+            recipient_ids
+          )
+          SendGrid4r::REST::Contacts::Recipients.create_recipients(resp)
+        end
+
+        def get_recipients_count
+          resp = get(
+            @auth, "#{SendGrid4r::REST::Contacts::Recipients.url}/count")
+          resp['recipient_count']
+        end
+
+        def search_recipients(params)
+          resp = get(
+            @auth,
+            "#{SendGrid4r::REST::Contacts::Recipients.url}/search",
+            params
+          )
+          SendGrid4r::REST::Contacts::Recipients.create_recipients(resp)
+        end
+
+        def get_recipient(recipient_id)
+          resp = get(
+            @auth,
+            SendGrid4r::REST::Contacts::Recipients.url(recipient_id)
+          )
+          SendGrid4r::REST::Contacts::Recipients.create_recipient(resp)
+        end
+
+        def delete_recipient(recipient_id)
+          delete(
+            @auth, SendGrid4r::REST::Contacts::Recipients.url(recipient_id)
+          )
+        end
+
+        def get_lists_recipient_belong(recipient_id)
+          resp = get(
+            @auth,
+            "#{SendGrid4r::REST::Contacts::Recipients.url(recipient_id)}/lists"
+          )
+          SendGrid4r::REST::Contacts::Lists.create_lists(resp)
+        end
+
+        def post_recipients(recipients)
+          resp = post(
+            @auth,
+            "#{SendGrid4r::Client::BASE_URL}/contactdb/recipients_batch",
+            recipients
+          )
+          SendGrid4r::REST::Contacts::Recipients.create_result(resp)
+        end
+
+        ResultAddMultiple = Struct.new(
+          :error_count,
+          :error_indices,
+          :new_count,
+          :persisted_recipients,
+          :updated_count
+        )
+
+        def self.create_result(resp)
+          error_indices = []
+          resp['error_indices'].each do |index|
+            error_indices.push(index)
+          end
+          persisted_recipients = []
+          resp['persisted_recipients'].each do |value|
+            persisted_recipients.push(value)
+          end
+          ResultAddMultiple.new(
+            resp['error_count'],
+            error_indices,
+            resp['new_count'],
+            persisted_recipients,
+            resp['updated_count']
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,50 @@
+# -*- encoding: utf-8 -*-
+$LOAD_PATH.unshift File.dirname(__FILE__)
+
+require 'sendgrid4r/rest/request'
+
+module SendGrid4r
+  module REST
+    module Contacts
+      #
+      # SendGrid Web API v3 Contacts - Reserved Fields
+      #
+      module ReservedFields
+        include SendGrid4r::REST::Request
+
+        Field = Struct.new(:name, :type) do
+          def eql?(other)
+            name.eql?(other.name)
+          end
+
+          def hash
+            name.hash
+          end
+        end
+
+        Fields = Struct.new(:reserved_fields)
+
+        def self.create_fields(resp)
+          reserved_fields = []
+          resp['reserved_fields'].each do |field|
+            reserved_fields.push(
+              SendGrid4r::REST::Contacts::ReservedFields.create_field(field)
+            )
+          end
+          Fields.new(reserved_fields)
+        end
+
+        def self.create_field(resp)
+          Field.new(resp['name'], resp['type'])
+        end
+
+        def get_reserved_fields
+          resp = get(
+            @auth, "#{SendGrid4r::Client::BASE_URL}/contactdb/reserved_fields"
+          )
+          SendGrid4r::REST::Contacts::ReservedFields.create_fields(resp)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,102 @@
+# -*- encoding: utf-8 -*-
+$LOAD_PATH.unshift File.dirname(__FILE__)
+
+require 'sendgrid4r/rest/request'
+
+module SendGrid4r
+  module REST
+    module Contacts
+      #
+      # SendGrid Web API v3 Contacts - Segments
+      #
+      module Segments
+        include SendGrid4r::REST::Request
+
+        Condition = Struct.new(
+          :field, :value, :operator, :and_or
+        )
+        Segment = Struct.new(
+          :id, :name, :list_id, :conditions, :recipient_count
+        )
+        Segments = Struct.new(:segments)
+
+        def self.url(segment_id = nil)
+          url = "#{SendGrid4r::Client::BASE_URL}/contactdb/segments"
+          url = "#{url}/#{segment_id}" unless segment_id.nil?
+          url
+        end
+
+        def self.create_condition(resp)
+          Condition.new(
+            resp['field'], resp['value'], resp['operator'], resp['and_or']
+          )
+        end
+
+        def self.create_segment(resp)
+          conditions = []
+          resp['conditions'].each do |condition|
+            conditions.push(
+              SendGrid4r::REST::Contacts::Segments.create_condition(condition)
+            )
+          end
+          Segment.new(
+            resp['id'],
+            resp['name'],
+            resp['list_id'],
+            conditions,
+            resp['recipient_count']
+          )
+        end
+
+        def self.create_segments(resp)
+          segments = []
+          resp['segments'].each do |segment|
+            segments.push(
+              SendGrid4r::REST::Contacts::Segments.create_segment(segment)
+            )
+          end
+          Segments.new(segments)
+        end
+
+        def post_segment(params)
+          resp = post(
+            @auth, SendGrid4r::REST::Contacts::Segments.url, params.to_h
+          )
+          SendGrid4r::REST::Contacts::Segments.create_segment(resp)
+        end
+
+        def get_segments
+          resp = get(@auth, SendGrid4r::REST::Contacts::Segments.url)
+          SendGrid4r::REST::Contacts::Segments.create_segments(resp)
+        end
+
+        def get_segment(segment_id)
+          resp = get(
+            @auth, SendGrid4r::REST::Contacts::Segments.url(segment_id)
+          )
+          SendGrid4r::REST::Contacts::Segments.create_segment(resp)
+        end
+
+        def put_segment(segment_id, params)
+          resp = put(
+            @auth, SendGrid4r::REST::Contacts::Segments.url(segment_id), params
+          )
+          SendGrid4r::REST::Contacts::Segments.create_segment(resp)
+        end
+
+        def delete_segment(segment_id)
+          delete(@auth, SendGrid4r::REST::Contacts::Segments.url(segment_id))
+        end
+
+        def get_recipients_from_segment(segment_id, limit = nil, offset = nil)
+          params = {}
+          params['limit'] = limit unless limit.nil?
+          params['offset'] = offset unless offset.nil?
+          url = SendGrid4r::REST::Contacts::Segments.url(segment_id)
+          resp = get(@auth, "#{url}/recipients", params)
+          SendGrid4r::REST::Contacts::Recipients.create_recipients(resp)
+        end
+      end
+    end
+  end
+end