parity-sendgrid-api 0.0.4

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

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

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

@@ -0,0 +1,13 @@
+require 'sendgrid/api/entities/entity'
+
+module Sendgrid
+  module API
+    module Entities
+      class Email < Entity
+
+        attribute :email, :name, :unsubscribe_code, :username
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,83 @@
+require 'json'
+
+module Sendgrid
+  module API
+    module Entities
+      class Entity
+
+        attr_reader :attributes
+
+        def initialize(attributes = {})
+          @attributes = sanitize_attributes(attributes)
+        end
+
+        def to_json(*a)
+          as_json.to_json(*a)
+        end
+
+        def as_json
+          attributes
+        end
+
+        def method_missing(method, *args, &block)
+          setter = method.to_s.gsub(/=$/, '').to_sym
+          if has_attribute?(method)
+            attributes[method]
+          elsif has_attribute?(setter)
+            attributes[setter] = args.first
+          else
+            super
+          end
+        end
+
+        def respond_to?(method, include_private = false)
+          super || has_attribute?(method)
+        end
+
+        private
+
+        def has_attribute?(attribute)
+          self.class.attributes.include?(attribute)
+        end
+
+        def sanitize_attributes(attributes)
+          attributes.reject { |key, value| !has_attribute?(key) }
+        end
+
+        class << self
+
+          # Instantiate the entity from API response body.
+          # Can generate multiple entities if response is an Array.
+          def from_response(response)
+            body = response.body
+            if body.is_a?(Array)
+              body.map { |item| new(item) }
+            elsif body.is_a?(Hash)
+              new(body)
+            else
+              nil
+            end
+          end
+
+          # Add attributes to the entity
+          def attribute(*args)
+            @attributes = attributes
+            @attributes += args
+            @attributes.uniq!
+          end
+
+          # Get the entity attributes
+          def attributes
+            @attributes ||= []
+          end
+
+          def clear_attributes
+            @attributes = []
+          end
+
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,30 @@
+require 'sendgrid/api/entities/entity'
+
+module Sendgrid
+  module API
+    module Entities
+      class List < Entity
+
+        attribute :list
+
+        class << self
+
+          # Convert the object to an Entities::List.
+          #
+          # @param object [String, Entities::List] A list name or Entities::List object
+          # @return [Entities::List] An Entities::List object
+          def from_object(object)
+            case object
+            when ::String
+              new(:list => object)
+            when self
+              object
+            end
+          end
+
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+require 'sendgrid/api/entities/entity'
+
+module Sendgrid
+  module API
+    module Entities
+      class MarketingEmail < Entity
+
+        # required attributes to create
+        attribute :identity, :name, :subject, :text, :html
+
+        # other attributes
+        attribute :can_edit, :content_preview, :date_schedule, 
+                  :is_deleted, :is_split, :is_winner, :newsletter_id, 
+                  :nl_type, :timezone_id, :total_recipients,
+                  :type, :winner_sending_time
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+require 'sendgrid/api/entities/entity'
+
+module Sendgrid
+  module API
+    module Entities
+      class Profile < Entity
+
+        attribute :username, :email, :active, :first_name, :last_name, :address,
+                  :address2, :city, :state, :zip, :country, :phone, :website, :website_access
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+require 'sendgrid/api/entities/entity'
+
+module Sendgrid
+  module API
+    module Entities
+      class Response < Entity
+
+        attribute :message, :errors
+
+        def success?
+          message == 'success'
+        end
+
+        def error?
+          message == 'error'
+        end
+
+      end
+    end
+  end
+end

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/entities/stats.rb

@@ -0,0 +1,14 @@
+require 'sendgrid/api/entities/entity'
+
+module Sendgrid
+  module API
+    module Entities
+      class Stats < Entity
+
+        attribute :delivered, :request, :unique_open, :unique_click, :processed, :date, :open, :click,
+                  :blocked, :spamreport, :drop, :bounce, :deferred
+
+      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