parity-sendgrid-api 0.0.4

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

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

@@ -0,0 +1,80 @@
+require 'sendgrid/api/service'
+require 'sendgrid/api/entities/sender_address'
+require 'sendgrid/api/entities/response'
+
+module Sendgrid
+  module API
+    module Newsletter
+      module SenderAddresses
+
+        def sender_addresses
+          Services.new(resource)
+        end
+
+        class Services < Sendgrid::API::Service
+          # Create a new Sender Address.
+          #
+          # @see http://sendgrid.com/docs/API_Reference/Marketing_Emails_API/sender_address.html#-add
+          # @param sender_address [Entities::SenderAddress] An Entities::SenderAddress object.
+          # @return [Entities::Response] An Entities::Response object.
+          def add(sender_address)
+            perform_request(Entities::Response, 'newsletter/identity/add.json', sender_address.as_json)
+          end
+
+          # Edit an existing Sender Address.
+          #
+          # @see http://sendgrid.com/docs/API_Reference/Marketing_Emails_API/sender_address.html#-edit
+          # @param sender_address [Entities::SenderAddress] An existing Entities::SenderAddress object.
+          # @param new_identity [String] A new identity for the existing sender address. Optional.
+          # @return [Entities::Response] An Entities::Response object.
+          def edit(sender_address, new_identity = nil)
+            params = sender_address.as_json
+            params[:newidentity] = new_identity if new_identity
+            perform_request(Entities::Response, 'newsletter/identity/edit.json', params)
+          end
+
+          # Retrieve information associated with a particular Sender Address.
+          #
+          # @see http://sendgrid.com/docs/API_Reference/Marketing_Emails_API/sender_address.html#-get
+          # @param sender_address [String, Entities::SenderAddress] An existing sender address identity or Entities::SenderAddress object.
+          # @return [Entities::SenderAddress] An Entities::SenderAddress object.
+          def get(sender_address)
+            params = { :identity => extract_identity(sender_address) }
+            perform_request(Entities::SenderAddress, 'newsletter/identity/get.json', params)
+          end
+
+          # List all Sender Addresses on your account.
+          #
+          # @see http://sendgrid.com/docs/API_Reference/Marketing_Emails_API/sender_address.html#-list
+          # @return [Array<Entities::SenderAddress>] An array of Entities::SenderAddress objects.
+          def list
+            perform_request(Entities::SenderAddress, 'newsletter/identity/list.json')
+          end
+
+          # Remove a Sender Address from your account.
+          #
+          # @see http://sendgrid.com/docs/API_Reference/Marketing_Emails_API/sender_address.html#-delete
+          # @param sender_address [String, Entities::SenderAddress] An existing sender address identity or Entities::SenderAddress object.
+          # @return [Entities::Response] An Entities::Response object.
+          def delete(sender_address)
+            params = { :identity => extract_identity(sender_address) }
+            perform_request(Entities::Response, 'newsletter/identity/delete.json', params)
+          end
+
+          private
+
+          def extract_identity(sender_address)
+            case sender_address
+            when ::String
+              sender_address
+            when Entities::SenderAddress
+              sender_address.identity
+            end
+          end
+
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,34 @@
+require 'sendgrid/api/entities/list'
+require 'sendgrid/api/entities/marketing_email'
+
+module Sendgrid
+  module API
+    module Newsletter
+      module Utils
+
+        private
+
+        # Convert the object to an Entities::List.
+        def extract_list(object)
+          Entities::List.from_object(object)
+        end
+
+        # Retrieve the list name.
+        def extract_listname(object)
+          extract_list(object).list
+        end
+
+        # Retrieve the marketing email name
+        def extract_marketing_email(marketing_email)
+          case marketing_email
+          when ::String
+            marketing_email
+          when Entities::MarketingEmail
+            marketing_email.name
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/sendgrid/api/rest/errors/error.rb

@@ -0,0 +1,66 @@
+module Sendgrid
+  module API
+    module REST
+      module Errors
+
+        class Error < StandardError
+
+          class << self
+
+            def from_response(env)
+              status_error(env) || body_error(env)
+            end
+
+            private
+
+            def status_error(env)
+              body = env[:body]
+              status = env[:status].to_i
+              if status != 200
+                message = body[:error] || body[:errors].join(', ') if body.is_a?(Hash)
+                error_class(status).new(message)
+              else
+                nil
+              end
+            end
+
+            def body_error(env)
+              body = env[:body]
+              if body.is_a?(Hash) && body.has_key?(:error)
+                status, message = case body[:error]
+                                  when ::Hash
+                                    [ body[:error][:code], body[:error][:message] ]
+                                  when ::String
+                                    [ 422, body[:error] ]
+                                  end
+                error_class(status).new(message)
+              else
+                nil
+              end
+            end
+
+            def error_class(status)
+              Errors::CODES[status] || Errors::Unknown
+            end
+
+          end
+
+        end
+
+        class BadRequest < Error; end
+        class Unauthorized < Error; end
+        class Forbidden < Error; end
+        class Unknown < Error; end
+        class UnprocessableEntity < Error; end
+
+        CODES = {
+          400 => BadRequest,
+          401 => Unauthorized,
+          403 => Forbidden,
+          422 => UnprocessableEntity
+        }.freeze
+
+      end
+    end
+  end
+end