sendgrid-api 0.0.2 → 0.0.3

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

@@ -17,7 +17,7 @@ module Sendgrid
               body = env[:body]
               status = env[:status].to_i
               if status != 200
-                message = body[:error] if body.is_a?(Hash)
+                message = body[:error] || body[:errors].join(', ') if body.is_a?(Hash)
                 error_class(status).new(message)
               else
                 nil
@@ -27,8 +27,12 @@ module Sendgrid
             def body_error(env)
               body = env[:body]
               if body.is_a?(Hash) && body.has_key?(:error)
-                status = body[:error][:code]
-                message = body[:error][:message]
+                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
@@ -47,11 +51,13 @@ module Sendgrid
         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

data/lib/sendgrid/api/rest/resource.rb

@@ -23,7 +23,7 @@ module Sendgrid
         private
 
         def request(method, url, params = {})
-          params.merge!(authentication_params)
+          params = params.merge(authentication_params)
           connection.send(method, url, params)
         rescue Faraday::Error::ClientError, JSON::ParserError
           raise Errors::Unknown
@@ -31,6 +31,8 @@ module Sendgrid
 
         def middleware
           @middleware ||= Faraday::Builder.new do |builder|
+            # checks for files in the payload, otherwise leaves everything untouched
+            builder.request :multipart
             # form-encode POST params
             builder.request :url_encoded
             # Parse response errors

data/lib/sendgrid/api/version.rb

@@ -1,5 +1,5 @@
 module Sendgrid
   module API
-    VERSION = "0.0.2"
+    VERSION = "0.0.3"
   end
 end

data/lib/sendgrid/api/web/mail.rb

@@ -0,0 +1,44 @@
+require 'sendgrid/api/service'
+require 'sendgrid/api/entities/response'
+
+module Sendgrid
+  module API
+    module Web
+      module Mail
+
+        def mail
+          Services.new(resource)
+        end
+
+        class Services < Sendgrid::API::Service
+
+          # Send email.
+          #
+          # @see http://sendgrid.com/docs/API_Reference/Web_API/mail.html#-send
+          # @param options [Hash] A customizable set of options.
+          # @option options [String]  :to         Must be a valid email address. This can also be passed in as an array, to send to multiple locations.
+          # @option options [String]  :toname     Give a name to the recipient. This can also be passed as an array if the to above is an array.
+          # @option options [String]  :x_smtpapi  Must be in valid JSON format. See http://sendgrid.com/docs/API_Reference/SMTP_API/index.html.
+          # @option options [String]  :subject    The subject of your email.
+          # @option options [String]  :text       The actual content of your email message. It can be sent as either plain text or HTML for the user to display.
+          # @option options [String]  :html       The actual content of your email message. It can be sent as either plain text or HTML for the user to display.
+          # @option options [String]  :from       This is where the email will appear to originate from for your recipient.
+          # @option options [String]  :bcc        This can also be passed in as an array of email addresses for multiple recipients.
+          # @option options [String]  :fromname   This is name appended to the from email field.
+          # @option options [String]  :replyto    Append a reply-to field to your email message.
+          # @option options [String]  :date       Specify the date header of your email.
+          # @option options [String]  :files      Files to be attached.
+          # @option options [String]  :content    Content IDs of the files to be used as inline images.
+          # @option options [String]  :headers    A collection of key/value pairs in JSON format.
+          # @return [Entities::Response] An Entities::Response object.
+          def send(options = {})
+            options['x-smtpapi'] = options.delete(:x_smtpapi) if options.member?(:x_smtpapi)
+            perform_request(Entities::Response, 'mail.send.json', options)
+          end
+
+        end
+
+      end
+    end
+  end
+end

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

@@ -16,7 +16,7 @@ module Sendgrid
           # View your SendGrid profile
           #
           # @see http://sendgrid.com/docs/API_Reference/Web_API/profile.html
-          # @return profile [Profile] An Entities::Profile object.
+          # @return [Entities::Profile] An Entities::Profile object.
           def get
             perform_request(Entities::Profile, 'profile.get.json').first
           end
@@ -24,8 +24,8 @@ module Sendgrid
           # Update your SendGrid profile
           #
           # @see http://sendgrid.com/docs/API_Reference/Web_API/profile.html#-set
-          # @param profile [Profile] An Entities::Profile object.
-          # @return response [Response] An Entities::Response object.
+          # @param profile [Entities::Profile] An Entities::Profile object.
+          # @return [Entities::Response] An Entities::Response object.
           def set(profile)
             perform_request(Entities::Response, 'profile.set.json', profile.as_json)
           end

data/lib/sendgrid/api/web/stats.rb

@@ -23,9 +23,9 @@ module Sendgrid
           # @option options [String] :category Return stats for the given category.
           # @option options [String] :aggregated_by Aggregate the data by the given period (default is day): day, week or month.
           # @option options [String] :country Get stats for each region/state for the given country. Only US (United States) and CA (Canada) is supported at this time.
-          # @return stats [Stats] An array of Entities::Stats object.
-          def advanced(params = {})
-            perform_request(Entities::Stats, 'stats.getAdvanced.json', params)
+          # @return [Array<Entities::Stats>] An array of Entities::Stats object.
+          def advanced(options = {})
+            perform_request(Entities::Stats, 'stats.getAdvanced.json', options)
           end
 
         end

data/spec/fixtures/categories.json

@@ -0,0 +1,11 @@
+[
+  {
+    "category": "sendgrid"
+  },
+  {
+    "category": "api"
+  },
+  {
+    "category": "my category"
+  }
+]

data/spec/fixtures/emails/email.json

@@ -0,0 +1,6 @@
+[
+  {
+    "email": "john@example.com",
+    "name": "John"
+  }
+]

data/spec/fixtures/emails/emails.json

@@ -0,0 +1,10 @@
+[
+  {
+    "email": "john@example.com",
+    "name": "John"
+  },
+  {
+    "email": "brian@example.com",
+    "name": "Brian"
+  }
+]

data/spec/fixtures/errors/already_exists.json

@@ -0,0 +1,3 @@
+{
+  "error": "object already exists"
+}

data/spec/fixtures/errors/bad_request.json

@@ -0,0 +1,6 @@
+{
+  "message": "error",
+  "errors": [
+    "Bad username / password"
+  ]
+}

data/spec/fixtures/errors/database_error.json

@@ -0,0 +1,3 @@
+{
+  "error": "A database error has occured. Please try again"
+}

data/spec/fixtures/errors/does_not_exist.json

@@ -0,0 +1,3 @@
+{
+  "error": "object does not exist"
+}

data/spec/fixtures/errors/invalid_fields.json

@@ -0,0 +1,3 @@
+{
+  "error": "error in email: email is required"
+}

data/spec/fixtures/errors/not_scheduled.json

@@ -0,0 +1,3 @@
+{
+  "error": "'The newsletter is not scheduled'"
+}

data/spec/fixtures/errors/unauthorized.json

@@ -0,0 +1,6 @@
+{
+  "error": {
+    "code": 401,
+    "message": "Permission denied, wrong credentials"
+  }
+}

data/spec/fixtures/lists/list.json

@@ -0,0 +1,5 @@
+[
+  {
+    "list": "list 1"
+  }
+]

data/spec/fixtures/lists/lists.json

@@ -0,0 +1,11 @@
+[
+  {
+    "list": "list 1"
+  },
+  {
+    "list": "list 2"
+  },
+  {
+    "list": "list 3"
+  }
+]

data/spec/fixtures/marketing_emails/marketing_email.json

@@ -0,0 +1,19 @@
+{
+  "content_preview": 1,
+  "subject": "SendGrid Email Marketing Service Tutorial",
+  "html": "<html><body>SendGrid Email Marketing Service Tutorial: Managing Your Marketing Email Unsubscribe List</body></html>",
+  "text": "SendGrid Email Marketing Service Tutorial: Managing Your Marketing Email Unsubscribe List",
+  "winner_sending_time": null,
+  "type": "html",
+  "date_schedule": null,
+  "is_winner": 0,
+  "nl_type": 0,
+  "identity": "comercial",
+  "can_edit": true,
+  "is_deleted": 0,
+  "name": "sendgrid tutorial",
+  "timezone_id": null,
+  "newsletter_id": 123456,
+  "total_recipients": 4459,
+  "is_split": 0
+}

data/spec/fixtures/marketing_emails/marketing_emails.json

@@ -0,0 +1,10 @@
+[
+  {
+    "name": "Sendgrid Tutorial",
+    "newsletter_id": 123456
+  },
+  {
+    "name": "Email Deliverability Spooks and Scares",
+    "newsletter_id": 123457
+  }
+]

data/spec/fixtures/recipients.json

@@ -0,0 +1,8 @@
+[
+  {
+    "list": "list 1"
+  },
+  {
+    "list": "list 2"
+  }
+]

data/spec/fixtures/schedule.json

@@ -0,0 +1,3 @@
+{
+  "date": "2013-10-30 18:01:40"
+}

data/spec/fixtures/sender_addresses/sender_address.json

@@ -0,0 +1,11 @@
+{
+  "city": "Anaheim",
+  "name": "SendGrid",
+  "zip": "92806",
+  "replyto": "contact@sendgrid.com",
+  "country": "US",
+  "state": "CA",
+  "address": "1065 N Pacificenter Drive, Suite 425",
+  "email": "contact@sendgrid.com",
+  "identity": "sendgrid"
+}

data/spec/fixtures/sender_addresses/sender_addresses.json

@@ -0,0 +1,11 @@
+[
+  {
+    "identity": "sendgrid"
+  },
+  {
+    "identity": "sendgrid helpdesk"
+  },
+  {
+    "identity": "sendgrid developers"
+  }
+]

data/spec/sendgrid/api/client_spec.rb

@@ -13,9 +13,25 @@ module Sendgrid
 
       it { should respond_to(:profile) }
       it { should respond_to(:stats) }
+      it { should respond_to(:mail) }
+      it { should respond_to(:lists) }
+      it { should respond_to(:emails) }
+      it { should respond_to(:sender_addresses) }
+      it { should respond_to(:categories) }
+      it { should respond_to(:marketing_emails) }
+      it { should respond_to(:recipients) }
+      it { should respond_to(:schedule) }
 
       its(:profile) { should_not be_nil }
       its(:stats) { should_not be_nil }
+      its(:mail) { should_not be_nil }
+      its(:lists) { should_not be_nil }
+      its(:emails) { should_not be_nil }
+      its(:sender_addresses) { should_not be_nil }
+      its(:categories) { should_not be_nil }
+      its(:marketing_emails) { should_not be_nil }
+      its(:recipients) { should_not be_nil }
+      its(:schedule) { should_not be_nil }
 
     end
   end