parity-sendgrid-api 0.0.4

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

@@ -0,0 +1,58 @@
+require 'faraday'
+require 'sendgrid/api/rest/response/parse_json'
+require 'sendgrid/api/rest/response/parse_error'
+
+module Sendgrid
+  module API
+    module REST
+      class Resource
+
+        attr_reader :user, :key
+
+        ENDPOINT = 'https://sendgrid.com/api'.freeze
+
+        def initialize(user, key)
+          @user = user
+          @key = key
+        end
+
+        def post(url, params = {})
+          request(:post, url, params)
+        end
+
+        private
+
+        def request(method, url, params = {})
+          params = params.merge(authentication_params)
+          connection.send(method, url, params)
+        rescue Faraday::Error::ClientError, JSON::ParserError
+          raise Errors::Unknown
+        end
+
+        def middleware
+          @middleware ||= Faraday::RackBuilder.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
+            builder.use Response::ParseError
+            # Parse JSON response bodies
+            builder.use Response::ParseJson
+            # Set Faraday's HTTP adapter
+            builder.adapter Faraday.default_adapter
+          end
+        end
+
+        def connection
+          @connection ||= Faraday.new(ENDPOINT, :builder => middleware)
+        end
+
+        def authentication_params
+          { :api_user => @user, :api_key => @key }
+        end
+
+      end
+    end
+  end
+end

data/lib/sendgrid/api/rest/response/parse_error.rb

@@ -0,0 +1,19 @@
+require 'faraday'
+require 'sendgrid/api/rest/errors/error'
+
+module Sendgrid
+  module API
+    module REST
+      module Response
+        class ParseError < Faraday::Response::Middleware
+
+          def on_complete(env)
+            error = REST::Errors::Error.from_response(env)
+            raise error unless error.nil?
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/sendgrid/api/rest/response/parse_json.rb

@@ -0,0 +1,24 @@
+require 'faraday'
+require 'json'
+
+module Sendgrid
+  module API
+    module REST
+      module Response
+        class ParseJson < Faraday::Response::Middleware
+
+          def parse(body)
+            JSON.parse(body, :symbolize_names => true) unless blank?(body)
+          end
+
+          private
+
+          def blank?(string)
+            string.respond_to?(:empty?) ? !!string.empty? : !string
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/sendgrid/api/service.rb

@@ -0,0 +1,23 @@
+module Sendgrid
+  module API
+    class Service
+
+      attr_reader :resource
+
+      def initialize(resource)
+        @resource = resource
+      end
+
+      def perform_request(entity, url, params = {})
+        entity.from_response(request(url, params))
+      end
+
+      private
+
+      def request(url, params = {})
+        resource.post(url, params)
+      end
+
+    end
+  end
+end

data/lib/sendgrid/api/version.rb

@@ -0,0 +1,5 @@
+module Sendgrid
+  module API
+    VERSION = "0.0.4"
+  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

@@ -0,0 +1,38 @@
+require 'sendgrid/api/service'
+require 'sendgrid/api/entities/profile'
+require 'sendgrid/api/entities/response'
+
+module Sendgrid
+  module API
+    module Web
+      module Profile
+
+        def profile
+          Services.new(resource)
+        end
+
+        class Services < Sendgrid::API::Service
+
+          # View your SendGrid profile
+          #
+          # @see http://sendgrid.com/docs/API_Reference/Web_API/profile.html
+          # @return [Entities::Profile] An Entities::Profile object.
+          def get
+            perform_request(Entities::Profile, 'profile.get.json').first
+          end
+
+          # Update your SendGrid profile
+          #
+          # @see http://sendgrid.com/docs/API_Reference/Web_API/profile.html#-set
+          # @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
+
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,36 @@
+require 'sendgrid/api/service'
+require 'sendgrid/api/entities/stats'
+
+module Sendgrid
+  module API
+    module Web
+      module Stats
+
+        def stats
+          Services.new(resource)
+        end
+
+        class Services < Sendgrid::API::Service
+
+          # Get Advanced Statistics
+          #
+          # @see http://sendgrid.com/docs/API_Reference/Web_API/Statistics/statistics_advanced.html
+          # @param options [Hash] A customizable set of options.
+          # @option options [String] :data_type One of the following: browsers, clients, devices, geo, global, isps. Required.
+          # @option options [Date] :start_date Date format is based on aggregated_by value (default is yyyy-mm-dd). Required.
+          # @option options [Date] :end_date Date format is based on aggregated_by value (default is yyyy-mm-dd).
+          # @option options [String] :metric One of the following (default is all): open, click, unique_open, unique_click, processed, delivered, drop, bounce, deferred, spamreport, blocked, all.
+          # @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 [Array<Entities::Stats>] An array of Entities::Stats object.
+          def advanced(options = {})
+            perform_request(Entities::Stats, 'stats.getAdvanced.json', options)
+          end
+
+        end
+
+      end
+    end
+  end
+end

data/sendgrid-api.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sendgrid/api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "parity-sendgrid-api"
+  spec.version       = Sendgrid::API::VERSION
+  spec.authors       = ["Jimish Jobanputra, Hardik Gondaliya"]
+  spec.email         = ["jimish@desidime.com"]
+  spec.description   = %q{A Ruby interface to the SendGrid API}
+  spec.summary       = %q{A Ruby interface to the SendGrid API}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'faraday', '~> 0.9.0'
+  spec.add_dependency 'json', '~> 1.8.1'
+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/forbidden.json

@@ -0,0 +1,3 @@
+{
+  "error":"Bad username / password"
+}

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/profile.json

@@ -0,0 +1,18 @@
+[
+  {
+    "username":"sendgrid",
+    "email":"contact@sendgrid.com",
+    "active":"true",
+    "first_name":"Jim",
+    "last_name":"Franklin",
+    "address":"1065 N Pacificenter Drive, Suite 425",
+    "address2":"",
+    "city":"Anaheim",
+    "state":"CA",
+    "zip":"92806",
+    "country":"US",
+    "phone":"123456789",
+    "website":"http:\/\/www.sendgrid.com",
+    "website_access":"true"
+  }
+]

data/spec/fixtures/recipients.json

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