sendgrid-api 0.0.2 → 0.0.3

data/lib/sendgrid/api/entities/response_insert.rb

@@ -0,0 +1,23 @@
+require 'sendgrid/api/entities/entity'
+
+module Sendgrid
+  module API
+    module Entities
+      class ResponseInsert < Entity
+
+        attribute :inserted
+
+        # Return true if one or more inserts were made
+        def any?
+          inserted > 0
+        end
+
+        # Return true if no inserts were made
+        def none?
+          !any?
+        end
+
+      end
+    end
+  end
+end

data/lib/sendgrid/api/entities/response_remove.rb

@@ -0,0 +1,23 @@
+require 'sendgrid/api/entities/entity'
+
+module Sendgrid
+  module API
+    module Entities
+      class ResponseRemove < Entity
+
+        attribute :removed
+
+        # Return true if one or more removals were made
+        def any?
+          removed > 0
+        end
+
+        # Return true if no removals were made
+        def none?
+          !any?
+        end
+
+      end
+    end
+  end
+end

data/lib/sendgrid/api/entities/schedule.rb

@@ -0,0 +1,13 @@
+require 'sendgrid/api/entities/entity'
+
+module Sendgrid
+  module API
+    module Entities
+      class Schedule < Entity
+
+        attribute :date
+
+      end
+    end
+  end
+end

data/lib/sendgrid/api/entities/sender_address.rb

@@ -0,0 +1,13 @@
+require 'sendgrid/api/entities/entity'
+
+module Sendgrid
+  module API
+    module Entities
+      class SenderAddress < Entity
+
+        attribute :identity, :name, :email, :replyto, :address, :city, :state, :zip, :country
+
+      end
+    end
+  end
+end

data/lib/sendgrid/api/newsletter/categories.rb

@@ -0,0 +1,74 @@
+require 'sendgrid/api/service'
+require 'sendgrid/api/entities/category'
+require 'sendgrid/api/entities/response'
+require 'sendgrid/api/newsletter/utils'
+
+module Sendgrid
+  module API
+    module Newsletter
+      module Categories
+
+        def categories
+          Services.new(resource)
+        end
+
+        class Services < Sendgrid::API::Service
+          include Newsletter::Utils
+
+          # Create a new Category.
+          #
+          # @see http://sendgrid.com/docs/API_Reference/Marketing_Emails_API/categories.html#-create
+          # @param category [String, Entities::Category] A category name or Entities::Category object.
+          # @return [Entities::Response] An Entities::Response object.
+          def create(category)
+            params = { :category => extract_category(category) }
+            perform_request(Entities::Response, 'newsletter/category/create.json', params)
+          end
+
+          # Assign a Category to an existing Marketing Email.
+          #
+          # @see http://sendgrid.com/docs/API_Reference/Marketing_Emails_API/categories.html#-add
+          # @param marketing_email [String, Entities::MarketingEmail] An existing marketing email name or Entities::MarketingEmail object.
+          # @param category [String, Entities::Category] A category name or Entities::Category object.
+          # @return [Entities::Response] An Entities::Response object.
+          def add(marketing_email, category)
+            params = { :name => extract_marketing_email(marketing_email), :category => extract_category(category) }
+            perform_request(Entities::Response, 'newsletter/category/add.json', params)
+          end
+
+          # Remove specific categories, or all categories from a Marketing Email.
+          #
+          # @see http://sendgrid.com/docs/API_Reference/Marketing_Emails_API/categories.html#-remove
+          # @param marketing_email [String, Entities::MarketingEmail] An existing marketing email name or Entities::MarketingEmail object.
+          # @param category [String, Entities::Category] A category name or Entities::Category object.
+          # @return [Entities::Response] An Entities::Response object.
+          def remove(marketing_email, category)
+            params = { :name => extract_marketing_email(marketing_email), :category => extract_category(category) }
+            perform_request(Entities::Response, 'newsletter/category/remove.json', params)
+          end
+
+          # List all categories.
+          #
+          # @see http://sendgrid.com/docs/API_Reference/Marketing_Emails_API/categories.html#-list
+          # @return [Array<Entities::Category>] An array of Entities::Category objects.
+          def list
+            perform_request(Entities::Category, 'newsletter/category/list.json')
+          end
+
+          private
+
+          def extract_category(category)
+            case category
+            when ::String
+              category
+            when Entities::Category
+              category.category
+            end
+          end
+
+        end
+
+      end
+    end
+  end
+end

data/lib/sendgrid/api/newsletter/emails.rb

@@ -0,0 +1,69 @@
+require 'sendgrid/api/service'
+require 'sendgrid/api/entities/email'
+require 'sendgrid/api/entities/response_insert'
+require 'sendgrid/api/entities/response_remove'
+require 'sendgrid/api/newsletter/utils'
+
+module Sendgrid
+  module API
+    module Newsletter
+      module Emails
+
+        def emails
+          Services.new(resource)
+        end
+
+        class Services < Sendgrid::API::Service
+          include Newsletter::Utils
+
+          # Add one or more emails to a Recipient List.
+          #
+          # @see http://sendgrid.com/docs/API_Reference/Marketing_Emails_API/emails.html#-add
+          # @param list [String, Entities::List] A list name or Entities::List object.
+          # @param emails [Array<Entities::Email>] A list of emails to be added. Limited to a 1000 entries maximum.
+          # @return [Entities::ResponseInsert] An Entities::ResponseInsert object.
+          def add(list, emails)
+            params = { :list => extract_listname(list), :data => map_emails(emails, :to_json) }
+            perform_request(Entities::ResponseInsert, 'newsletter/lists/email/add.json', params)
+          end
+
+          # Get the email addresses and associated fields for a Recipient List.
+          #
+          # @see http://sendgrid.com/docs/API_Reference/Marketing_Emails_API/emails.html#-get
+          # @param list [String, Entities::List] A list name or Entities::List object.
+          # @param emails [Entities::Email, Array<Entities::Email>] An email or list of emails to be searched and retrieved. Optional.
+          # @return [Array<Entities::Email>] An array of Entities::Email object.
+          def get(list, emails = nil)
+            params = { :list => extract_listname(list) }
+            params[:email] = map_emails(emails, :email) if emails
+            perform_request(Entities::Email, 'newsletter/lists/email/get.json', params)
+          end
+
+          # Remove one or more emails from a Recipient List.
+          #
+          # @see http://sendgrid.com/docs/API_Reference/Marketing_Emails_API/emails.html#-delete
+          # @param list [String, Entities::List] A list name or Entities::List object.
+          # @param emails [Entities::Email, Array<Entities::Email>] An email or list of emails to be removed.
+          # @return [Entities::ResponseRemove] An Entities::ResponseRemove object.
+          def delete(list, emails)
+            params = { :list => extract_listname(list), :email => map_emails(emails, :email) }
+            perform_request(Entities::ResponseRemove, 'newsletter/lists/email/delete.json', params)
+          end
+
+          private
+
+          # Return a mapping from an email method name.
+          #
+          # @param emails [Entities::Email, Array<Entities::Email>] An email or list of emails.
+          # @param to [Symbol] The email method name to be mapped.
+          # @return [Array] An array of the mapping.
+          def map_emails(emails, to)
+            emails = [emails] unless emails.is_a?(Array)
+            emails.map(&to)
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/sendgrid/api/newsletter/lists.rb

@@ -0,0 +1,64 @@
+require 'sendgrid/api/service'
+require 'sendgrid/api/entities/list'
+require 'sendgrid/api/entities/response'
+require 'sendgrid/api/newsletter/utils'
+
+module Sendgrid
+  module API
+    module Newsletter
+      module Lists
+
+        def lists
+          Services.new(resource)
+        end
+
+        class Services < Sendgrid::API::Service
+          include Newsletter::Utils
+
+          # Create a new Recipient List.
+          #
+          # @see http://sendgrid.com/docs/API_Reference/Marketing_Emails_API/lists.html#-add
+          # @param list [String, Entities::List] A new list name or Entities::List object.
+          # @return [Entities::Response] An Entities::Response object.
+          def add(list)
+            params = { :list => extract_listname(list) }
+            perform_request(Entities::Response, 'newsletter/lists/add.json', params)
+          end
+
+          # Rename a Recipient List.
+          #
+          # @see http://sendgrid.com/docs/API_Reference/Marketing_Emails_API/lists.html#-edit
+          # @param list [String, Entities::List] An existing list name or Entities::List object.
+          # @param newlist [String, Entities::List] A new list name or Entities::List object.
+          # @return [Entities::Response] An Entities::Response object.
+          def edit(list, newlist)
+            params = { :list => extract_listname(list), :newlist => extract_listname(newlist) }
+            perform_request(Entities::Response, 'newsletter/lists/edit.json', params)
+          end
+
+          # List all Recipient Lists on your account, or check if a particular List exists.
+          #
+          # @see http://sendgrid.com/docs/API_Reference/Marketing_Emails_API/lists.html#-get
+          # @param list [String, Entities::List] An existing list name or Entities::List object. Optional.
+          # @return [Array<Entities::List>] An array of Entities::List objects.
+          def get(list = nil)
+            params = { :list => extract_listname(list) } if list
+            perform_request(Entities::List, 'newsletter/lists/get.json', params || {})
+          end
+
+          # Remove a Recipient List from your account.
+          #
+          # @see http://sendgrid.com/docs/API_Reference/Marketing_Emails_API/lists.html#-delete
+          # @param list [String, Entities::List] An existing list name or Entities::List object.
+          # @return [Entities::Response] An Entities::Response object.
+          def delete(list)
+            params = { :list => extract_listname(list) }
+            perform_request(Entities::Response, 'newsletter/lists/delete.json', params)
+          end
+
+        end
+
+      end
+    end
+  end
+end

data/lib/sendgrid/api/newsletter/marketing_emails.rb

@@ -0,0 +1,72 @@
+require 'sendgrid/api/service'
+require 'sendgrid/api/entities/marketing_email'
+require 'sendgrid/api/entities/response'
+require 'sendgrid/api/newsletter/utils'
+
+module Sendgrid
+  module API
+    module Newsletter
+      module MarketingEmails
+
+        def marketing_emails
+          Services.new(resource)
+        end
+
+        class Services < Sendgrid::API::Service
+          include Newsletter::Utils
+
+          # Create a new Marketing Email.
+          #
+          # @see http://sendgrid.com/docs/API_Reference/Marketing_Emails_API/newsletters.html#-add
+          # @param marketing_email [Entities::MarketingEmail] An Entities::MarketingEmail object.
+          # @return [Entities::Response] An Entities::Response object.
+          def add(marketing_email)
+            perform_request(Entities::Response, 'newsletter/add.json', marketing_email.as_json)
+          end
+
+          # Edit an existing Marketing Email.
+          #
+          # @see http://sendgrid.com/docs/API_Reference/Marketing_Emails_API/newsletters.html#-edit
+          # @param marketing_email [Entities::MarketingEmail] An Entities::MarketingEmail object.
+          # @param newname [String] The new name for the Marketing Email being edited. Optional.
+          # @return [Entities::Response] An Entities::Response object.
+          def edit(marketing_email, newname = nil)
+            params = marketing_email.as_json
+            params.merge!(:newname => newname) if newname
+            perform_request(Entities::Response, 'newsletter/edit.json', params)
+          end
+
+          # Retrieve the contents of an existing Marketing Email.
+          #
+          # @see http://sendgrid.com/docs/API_Reference/Marketing_Emails_API/newsletters.html#-get
+          # @param marketing_email [String, Entities::MarketingEmail] An existing marketing email name or Entities::MarketingEmail object.
+          # @return [Entities::MarketingEmail] An Entities::MarketingEmail object.
+          def get(marketing_email)
+            params = { :name => extract_marketing_email(marketing_email) }
+            perform_request(Entities::MarketingEmail, 'newsletter/get.json', params)
+          end
+
+          # Retrieve a list of all existing Marketing Email.
+          #
+          # @see http://sendgrid.com/docs/API_Reference/Marketing_Emails_API/newsletters.html#-list
+          # @return [Array<Entities::MarketingEmail>] An array of Entities::MarketingEmail objects.
+          def list
+            perform_request(Entities::MarketingEmail, 'newsletter/list.json')
+          end
+
+          # Remove an existing Marketing Email.
+          #
+          # @see http://sendgrid.com/docs/API_Reference/Marketing_Emails_API/newsletters.html#-delete
+          # @param marketing_email [String, Entities::MarketingEmail] An existing marketing email name or Entities::MarketingEmail object.
+          # @return [Entities::Response] An Entities::Response object.
+          def delete(marketing_email)
+            params = { :name => extract_marketing_email(marketing_email) }
+            perform_request(Entities::Response, 'newsletter/delete.json', params)
+          end
+
+        end
+
+      end
+    end
+  end
+end

data/lib/sendgrid/api/newsletter/recipients.rb

@@ -0,0 +1,55 @@
+require 'sendgrid/api/service'
+require 'sendgrid/api/entities/list'
+require 'sendgrid/api/entities/response'
+require 'sendgrid/api/newsletter/utils'
+
+module Sendgrid
+  module API
+    module Newsletter
+      module Recipients
+
+        def recipients
+          Services.new(resource)
+        end
+
+        class Services < Sendgrid::API::Service
+          include Newsletter::Utils
+
+          # Assign a List to a Marketing Email.
+          #
+          # @see http://sendgrid.com/docs/API_Reference/Marketing_Emails_API/recipients.html#-add
+          # @param list [String, Entities::List] A list name or Entities::List object.
+          # @param marketing_email [String, Entities::MarketingEmail] A marketing email name or Entities::MarketingEmail object.
+          # @return [Entities::Response] An Entities::Response object.
+          def add(list, marketing_email)
+            params = { :list => extract_listname(list), :name => extract_marketing_email(marketing_email) }
+            perform_request(Entities::Response, 'newsletter/recipients/add.json', params)
+          end
+
+          # Get all lists assigned to a particular Marketing Email.
+          #
+          # @see http://sendgrid.com/docs/API_Reference/Marketing_Emails_API/recipients.html#-get
+          # @param marketing_email [String, Entities::MarketingEmail] A marketing email name or Entities::MarketingEmail object.
+          # @return [Array<Entities::List>] An array of Entities::List objects.
+          def get(marketing_email)
+            params = { :name => extract_marketing_email(marketing_email) }
+            perform_request(Entities::List, 'newsletter/recipients/get.json', params)
+          end
+
+          # Remove assigned lists from Marketing Email.
+          #
+          # @see http://sendgrid.com/docs/API_Reference/Marketing_Emails_API/recipients.html#-delete
+          # @param list [String, Entities::List] A list name or Entities::List object.
+          # @param marketing_email [String, Entities::MarketingEmail] A marketing email name or Entities::MarketingEmail object.
+          # @return [Entities::Response] An Entities::Response object.
+          def delete(list, marketing_email)
+            params = { :list => extract_listname(list), :name => extract_marketing_email(marketing_email) }
+            perform_request(Entities::Response, 'newsletter/recipients/delete.json', params)
+          end
+
+        end
+
+      end
+    end
+  end
+end

data/lib/sendgrid/api/newsletter/schedule.rb

@@ -0,0 +1,70 @@
+require 'sendgrid/api/service'
+require 'sendgrid/api/entities/schedule'
+require 'sendgrid/api/entities/response'
+require 'sendgrid/api/newsletter/utils'
+
+module Sendgrid
+  module API
+    module Newsletter
+      module Schedule
+
+        def schedule
+          Services.new(resource)
+        end
+
+        class Services < Sendgrid::API::Service
+          include Newsletter::Utils
+
+          # Schedule a delivery time for an existing Marketing Email.
+          #
+          # @see http://sendgrid.com/docs/API_Reference/Marketing_Emails_API/schedule.html#-add
+          # @param marketing_email [String, Entities::MarketingEmail] A marketing email name or Entities::MarketingEmail object.
+          # @param options [Hash] A customizable set of options.
+          # @option options [String] :at Date/Time to schedule marketing email Delivery. Date/Time must be provided in ISO 8601 format (YYYY-MM-DD HH:MM:SS+-HH:MM)
+          # @option options [Fixnum] :after Number of minutes until delivery should occur. Must be a positive integer.
+          # @return [Entities::Response] An Entities::Response object.
+          def add(marketing_email, options = {})
+            options.keep_if {|key, value| [:at, :after].include?(key) }
+            options[:at] = format_time(options[:at]) if options.member?(:at)
+            params = { :name => extract_marketing_email(marketing_email) }
+            params.merge!(options) if options.any?
+            perform_request(Entities::Response, 'newsletter/schedule/add.json', params)
+          end
+
+          # Retrieve the scheduled delivery time for an existing Marketing Email.
+          #
+          # @see http://sendgrid.com/docs/API_Reference/Marketing_Emails_API/schedule.html#-get
+          # @param marketing_email [String, Entities::MarketingEmail] A marketing email name or Entities::MarketingEmail object.
+          # @return [Entities::Schedule] An Entities::Schedule objects.
+          def get(marketing_email)
+            params = { :name => extract_marketing_email(marketing_email) }
+            perform_request(Entities::Schedule, 'newsletter/schedule/get.json', params)
+          end
+
+          # Cancel a scheduled send for a Marketing Email.
+          #
+          # @see http://sendgrid.com/docs/API_Reference/Marketing_Emails_API/schedule.html#-delete
+          # @param marketing_email [String, Entities::MarketingEmail] A marketing email name or Entities::MarketingEmail object.
+          # @return [Entities::Response] An Entities::Response object.
+          def delete(marketing_email)
+            params = { :name => extract_marketing_email(marketing_email) }
+            perform_request(Entities::Response, 'newsletter/schedule/delete.json', params)
+          end
+
+          private
+
+          def format_time(at)
+            case at
+            when ::String
+              at
+            when ::Time
+              at.strftime('%Y-%m-%d %H:%M:%S%:z')
+            end
+          end
+
+        end
+
+      end
+    end
+  end
+end