sendgrid-web 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c25529f42cb3b382076bbf57b48be5ae98991bee
-  data.tar.gz: 91ceedecf727a38be051799fe81932900357d661
+  metadata.gz: d55cccb3825dcfc129f5c068cd56dc1c4680c2eb
+  data.tar.gz: c18852eb71401b67a4c060de1af8ffe7826fc3f5
 SHA512:
-  metadata.gz: 1a26f04093ebc8c51137300f121a3afa0eab6d5edb51dc99f5fc921d855e0c41136a1b6b692911be75e577243a6875cd56530b292d03ba02e9e16a5bf2e149f0
-  data.tar.gz: 8a56c673cd34b2d4e7cbc535a28097198080af2efb61047f46bec2e332704426df89ccf2661ea60620c5554755f7ce04b19945fb609c655c5238582863497e9b
+  metadata.gz: 90fcb041fd4973bcd1033a6875ef900bd77950b47e6d059bda9be7db6addd0093a10ae6a10778fae631ecac998acd214f3983236939f44e15534c54fb8d00ae6
+  data.tar.gz: 647714ff3f4a66743eea7550a4d4e19794479e5d0e390f22302e09e234eab4150591500aeffed9e1ba27ccef5bc61cf470685be390d68a437b27befae2353b08

data/lib/sendgrid/web/parse_webhook_settings.rb

@@ -0,0 +1,77 @@
+class Sendgrid::Web::ParseWebhookSettings < Sendgrid::Web::Client
+
+  # Retrieve settings already configured for parsing incoming email.
+  #
+  # @return [Sendgrid::Web::Response] The sendgrid response
+  def get
+    res = connection.post('/api/parse.get.json', default_params)
+    craft_response(res)
+  end
+
+  # Specify the hostname and url for parsing incoming emails.
+  #
+  # @param hostname [String] The hostname (domain or subdomain) for
+  #   which you would like to configure a Parse Webhook callback URL.
+  # @param url [String] The callback URL to which Parse Webhook
+  #   payloads will be POSTed.
+  # @param spam_check [Integer] If spam check is enabled, messages
+  #   that look like spam will not be POSTed.
+  # @return [Sendgrid::Web::Response] The sendgrid response
+  # @note +hostname+ and +url+ are required parameters.
+  def set(hostname: nil, url: nil, spam_check: nil)
+    if hostname.nil?
+      raise ArgumentError.new('Missing required `hostname` option')
+    elsif url.nil?
+      raise ArgumentError.new('Missing required `url` option')
+    end
+    res = connection.post(
+      '/api/parse.set.json',
+      default_params(
+        hostname: hostname,
+        url: url,
+        spam_check: spam_check))
+    craft_response(res)
+  end
+
+  # Edit your existing settings for parsing incoming emails.
+  #
+  # @param hostname [String] The hostname (domain or subdomain) for
+  #   which you would like to configure a Parse Webhook callback URL.
+  # @param url [String] The callback URL to which Parse Webhook
+  #   payloads will be POSTed.
+  # @param spam_check [Integer] If spam check is enabled, messages
+  #   that look like spam will not be POSTed.
+  # @return [Sendgrid::Web::Response] The sendgrid response
+  # @note +hostname+ and +url+ are required parameters.
+  def edit(hostname: nil, url: nil, spam_check: nil)
+    if hostname.nil?
+      raise ArgumentError.new('Missing required `hostname` option')
+    elsif url.nil?
+      raise ArgumentError.new('Missing required `url` option')
+    end
+    res = connection.post(
+      '/api/parse.edit.json',
+      default_params(
+        hostname: hostname,
+        url: url,
+        spam_check: spam_check))
+    craft_response(res)
+  end
+
+  # Delete the existing settings for parsing incoming emails.
+  #
+  # @param hostname [String] The hostname (domain or subdomain) for
+  #   which you would like to configure a Parse Webhook callback URL.
+  # @return [Sendgrid::Web::Response] The sendgrid response
+  # @note +hostname+ is a required parameter.
+  def delete(hostname: nil)
+    if hostname.nil?
+      raise ArgumentError.new('Missing required `hostname` option')
+    end
+    res = connection.post(
+      '/api/parse.delete.json',
+      default_params(hostname: hostname))
+    craft_response(res)
+  end
+
+end

data/lib/sendgrid/web/profile.rb

@@ -0,0 +1,110 @@
+class Sendgrid::Web::Profile < Sendgrid::Web::Client
+
+  # View your SendGrid profile.
+  #
+  # @return [Sendgrid::Web::Response] the Sendgrid response.
+  # @note All parameters are optional
+  def get
+    res = connection.post('/api/profile.get.json', default_params)
+    craft_response(res)
+  end
+
+  # Update your SendGrid profile.
+  #
+  # @param first_name [String] Your first name.
+  # @param last_name [String] Your last name.
+  # @param address [String] Your company address.
+  # @param city [String] City where your company is located.
+  # @param state [String] State where your company is located.
+  # @param country [String] Country where your company is located.
+  # @param zip [String] Zipcode/Postcode where your company is
+  #   located.
+  # @param phone [String] Valid phone number.
+  # @param website [String] Your companies website.
+  # @return [Sendgrid::Web::Response] the Sendgrid response.
+  # @note All parameters are optional
+  def set(
+    first_name: nil, last_name: nil, address: nil,
+    city: nil, state: nil, country: nil,
+    zip: nil, phone: nil, website: nil)
+    res = connection.post(
+      '/api/profile.set.json',
+      default_params(
+        first_name: first_name,
+        last_name: last_name,
+        address: address,
+        city: city,
+        state: state,
+        country: country,
+        zip: zip,
+        phone: phone,
+        website: website))
+    craft_response(res)
+  end
+
+  # Update your password.
+  #
+  # @param password [String] Your new password.
+  # @param confirm_password [String] Confirm your new password.
+  # @return [Sendgrid::Web::Response] the Sendgrid response.
+  # @note +password+ and +confirm_password+ are required.
+  # @see #set_username
+  # @see #set_email
+  def set_password(password: nil, confirm_password: nil)
+    if password.nil?
+      raise ArgumentError.new('Missing required `password` option')
+    elsif confirm_password.nil?
+      raise ArgumentError.new(
+        'Missing required `confirm_password` option')
+    end
+    res = connection.post(
+      '/api/password.set.json',
+      default_params(
+        password: password,
+        confirm_password: confirm_password))
+    craft_response(res)
+  end
+
+  # Update your username.
+  #
+  # @param username [String] This is the new username we will be
+  #   authenticating with our SMTP servers and our website. Changes
+  #   take effect immediately.
+  # @return [Sendgrid::Web::Response] the Sendgrid response.
+  # @note Only +username+ is required.
+  # @note Your account username is used to login to the SMTP server
+  #   and the website. Changes will take effect immediately.
+  # @see #set_password
+  # @see #set_email
+  def set_username(username: nil)
+    if username.nil?
+      raise ArgumentError.new('Missing required `username` option')
+    end
+    res = connection.post(
+      '/api/profile.setUsername.json',
+      default_params(username: username))
+    craft_response(res)
+  end
+
+  # Update your email address.
+  #
+  # @param email [String] This is the new email address SendGrid will
+  #   be contacting you with. Changes take effect immediately.
+  # @return [Sendgrid::Web::Response] the Sendgrid response.
+  # @note Only +email+ is required.
+  # @note SendGrid send out a confirmation email to the new email
+  #   account in order to be validated. Your email address changes
+  #   when you click on the confirmation link.
+  # @see #set_password
+  # @see #set_username
+  def set_email(email: nil)
+    if email.nil?
+      raise ArgumentError.new('Missing required `email` option')
+    end
+    res = connection.post(
+      '/api/profile.setEmail.json',
+      default_params(email: email))
+    craft_response(res)
+  end
+
+end

data/lib/sendgrid/web/spam_reports.rb

@@ -0,0 +1,49 @@
+class Sendgrid::Web::SpamReports < Sendgrid::Web::Client
+
+  # Retrieve entries in the Spam Reports list.
+  #
+  # @param date [Integer] Retrieve the timestamp of the spam reports
+  #   records.
+  # @param days [Integer] Number of days in the past for which to
+  #   retrieve spam reports (includes today).
+  # @param start_date [DateTime] The start of the date range for which
+  #   to retrieve spam reports.
+  # @param end_date [DateTime] The end of the date range for which to
+  #   retrieve spam reports.
+  # @param limit [Integer] Optional field to limit the number of
+  #   results returned.
+  # @param offset [Integer] Optional beginning point in the list to
+  #   retrieve from.
+  # @return [Sendgrid::Web::Response] The SendGrid response.
+  # @note All parameters are optional.
+  def get(
+    date: nil, days: nil, start_date: nil,
+    end_date: nil, limit: nil, offset: nil)
+    res = connection.post(
+      '/api/spamreports.get.json',
+      default_params(
+        date: date,
+        days: days,
+        start_date: start_date,
+        end_date: end_date,
+        limit: limit,
+        offset: offset))
+    craft_response(res)
+  end
+
+  # Deletes all spam reports associated with the provided email.
+  #
+  # @param email [String] Email spam reports address to remove.
+  # @return [Sendgrid::Web::Response] The SendGrid response.
+  # @note +email+ parameter is required.
+  def delete(email: nil)
+    if email.nil?
+      raise ArgumentError.new('Missing required `email` option')
+    end
+    res = connection.post(
+      '/api/spamreports.delete.json',
+      default_params(email: email))
+    craft_response(res)
+  end
+
+end

data/lib/sendgrid/web/unsubscribes.rb

@@ -0,0 +1,70 @@
+class Sendgrid::Web::Unsubscribes < Sendgrid::Web::Client
+
+  # Retrieve a list of Unsubscribes with addresses and optionally with
+  # dates.
+  #
+  # @param date [Integer] Retrieve the timestamp of the unsubscribe
+  #   records.
+  # @param days [Integer] Number of days in the past for which to
+  #   retrieve unsubscribe records (includes today).
+  # @param start_date [DateTime] The start of the date range for which
+  #   to retrieve unsubscribe records.
+  # @param end_date [DateTime] The end of the date range for which to
+  #   retrieve unsubscribe records.
+  # @param limit [Integer] Optional field to limit the number of
+  #   results returned.
+  # @param offset [Integer] Optional beginning point in the list to
+  #   retrieve from.
+  # @return [Sendgrid::Web::Response] The SendGrid response.
+  # @note All parameters are optional.
+  def get(
+    date: nil, days: nil, start_date: nil,
+    end_date: nil, limit: nil, offset: nil)
+    res = connection.post(
+      '/api/unsubscribes.get.json',
+      default_params(
+        date: date,
+        days: days,
+        start_date: start_date,
+        end_date: end_date,
+        limit: limit,
+        offset: offset))
+    craft_response(res)
+  end
+
+  # Delete an address from the Unsubscribe list.
+  #
+  # @param start_date [DateTime] Optional date to start retrieving
+  #   for.
+  # @param end_date [DateTime] Optional date to end retrieving for.
+  # @param email [String] Unsubscribed email address to remove.
+  # @return [Sendgrid::Web::Response] The SendGrid response.
+  # @note If no parameters are provided the ENTIRE list will be
+  #   removed.
+  def delete(
+    start_date: nil, end_date: nil, email: nil)
+    res = connection.post(
+      '/api/unsubscribes.delete.json',
+      default_params(
+        start_date: start_date,
+        end_date: end_date,
+        email: email))
+    craft_response(res)
+  end
+
+  # Add email addresses to the Unsubscribe list.
+  #
+  # @param email [String] Email address to add to unsubscribe list.
+  # @return [Sendgrid::Web::Response] The SendGrid response.
+  # @note +email+ is a required parameter.
+  def add(email: nil)
+    if email.nil?
+      raise ArgumentError.new('Missing required `email` option')
+    end
+    res = connection.post(
+      '/api/unsubscribes.add.json',
+      default_params(email: email))
+    craft_response(res)
+  end
+
+end

data/lib/sendgrid/web/version.rb

@@ -1,5 +1,5 @@
 module Sendgrid
   module Web
-    VERSION = "0.0.5"
+    VERSION = "0.0.6"
   end
 end

data/lib/sendgrid/web.rb

@@ -12,6 +12,10 @@ module Sendgrid
     autoload :InvalidEmails,  'sendgrid/web/invalid_emails'
     autoload :Mail,           'sendgrid/web/mail'
     autoload :Credentials,    'sendgrid/web/credentials'
+    autoload :ParseWebhookSettings, 'sendgrid/web/parse_webhook_settings'
+    autoload :Profile,        'sendgrid/web/profile'
+    autoload :SpamReports,    'sendgrid/web/spam_reports'
+    autoload :Unsubscribes,   'sendgrid/web/unsubscribes'
     autoload :Response,       'sendgrid/web/response'
   end
 end

data/spec/sendgrid/web/parse_webhook_settings_spec.rb

@@ -0,0 +1,64 @@
+require 'spec_helper'
+
+describe Sendgrid::Web::ParseWebhookSettings do
+  before(:all) do
+    Sendgrid::Web::Client.configure do |config|
+      config.username = 'foo'
+      config.password = 'bar'
+    end
+  end
+
+  describe '#get' do
+    it_behaves_like('a sendgrid response', '/api/parse.get.json') do
+      let(:action) { subject.get }
+      let(:response) do
+        '{
+          "parse": [
+            {
+              "hostname": "www.example.com",
+              "url": "www.mydomain.com/parse.php",
+              "spam_check": 1
+            }
+          ]
+        }'
+      end
+    end
+  end
+
+  describe '#set' do
+    it_behaves_like('a sendgrid response', '/api/parse.set.json') do
+      let(:action) { subject.set(
+        hostname: 'www.example.com',
+        url: 'www.mydomain.com/parse.php') }
+      let(:response) do
+        '{
+          "message": "success"
+        }'
+      end
+    end
+  end
+
+  describe '#edit' do
+    it_behaves_like('a sendgrid response', '/api/parse.edit.json') do
+      let(:action) { subject.edit(
+        hostname: 'www.example.com',
+        url: 'www.mydomain.com/parse.php') }
+      let(:response) do
+        '{
+          "message": "success"
+        }'
+      end
+    end
+  end
+
+  describe '#delete' do
+    it_behaves_like('a sendgrid response', '/api/parse.delete.json') do
+      let(:action) { subject.delete(hostname: 'www.example.com') }
+      let(:response) do
+        '{
+          "message": "success"
+        }'
+      end
+    end
+  end
+end

data/spec/sendgrid/web/profile_spec.rb

@@ -0,0 +1,79 @@
+require 'spec_helper'
+
+describe Sendgrid::Web::Profile do
+  before(:all) do
+    Sendgrid::Web::Client.configure do |config|
+      config.username = 'foo'
+      config.password = 'bar'
+    end
+  end
+
+  describe '#get' do
+    it_behaves_like('a sendgrid response', '/api/profile.get.json') do
+      let(:action) { subject.get }
+      let(:response) do
+        '[{
+          "username": "sampleuser@example.com",
+          "email": "sampleemail@example.com",
+          "active": "true",
+          "first_name": "john",
+          "last_name": "doe",
+          "address": "555 any street",
+          "city": "any city",
+          "state": "CA",
+          "zip": "91234",
+          "country": "US",
+          "phone": "555-555-5555",
+          "website": "example.com"
+        }]'
+      end
+    end
+  end
+
+  describe '#set' do
+    it_behaves_like('a sendgrid response', '/api/profile.set.json') do
+      let(:action) { subject.set }
+      let(:response) do
+        '{
+          "message": "success"
+        }'
+      end
+    end
+  end
+
+  describe '#set_password' do
+    it_behaves_like('a sendgrid response', '/api/password.set.json') do
+      let(:action) { subject.set_password(
+        password: 'foobar',
+        confirm_password: 'foobar') }
+      let(:response) do
+        '{
+          "message": "success"
+        }'
+      end
+    end
+  end
+
+  describe '#set_username' do
+    it_behaves_like('a sendgrid response', '/api/profile.setUsername.json') do
+      let(:action) { subject.set_username(username: 'foobar') }
+      let(:response) do
+        '{
+          "message": "success"
+        }'
+      end
+    end
+  end
+
+  describe '#set_email' do
+    it_behaves_like('a sendgrid response', '/api/profile.setEmail.json') do
+      let(:action) { subject.set_email(
+        email: 'foobar@example.com') }
+      let(:response) do
+        '{
+          "message": "success"
+        }'
+      end
+    end
+  end
+end

data/spec/sendgrid/web/spam_reports_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+describe Sendgrid::Web::SpamReports do
+  before(:all) do
+    Sendgrid::Web::Client.configure do |config|
+      config.username = 'foo'
+      config.password = 'bar'
+    end
+  end
+
+  describe '#get' do
+    it_behaves_like('a sendgrid response', '/api/spamreports.get.json') do
+      let(:action) { subject.get }
+      let(:response) do
+        '[
+          {
+            "ip": "174.36.80.219",
+            "email": "example@aol.com",
+            "created": "2009-12-06 15:45:08"
+          }
+        ]'
+      end
+    end
+  end
+
+  describe '#delete' do
+    it_behaves_like('a sendgrid response', '/api/spamreports.delete.json') do
+      let(:action) { subject.delete(email: 'foobar@example.com') }
+      let(:response) do
+        '{
+          "message": "success"
+        }'
+      end
+    end
+  end
+end

data/spec/sendgrid/web/unsubscribes_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+
+describe Sendgrid::Web::Unsubscribes do
+  before(:all) do
+    Sendgrid::Web::Client.configure do |config|
+      config.username = 'foo'
+      config.password = 'bar'
+    end
+  end
+
+  describe '#get' do
+    it_behaves_like('a sendgrid response', '/api/unsubscribes.get.json') do
+      let(:action) { subject.get }
+      let(:response) do
+        '[
+          {
+            "email": "brandon.west@sendgrid.com",
+            "created": "2012-09-06 14:03:18"
+          }
+        ]'
+      end
+    end
+  end
+
+  describe '#delete' do
+    it_behaves_like('a sendgrid response', '/api/unsubscribes.delete.json') do
+      let(:action) { subject.delete }
+      let(:response) do
+        '{
+          "message": "success"
+        }'
+      end
+    end
+  end
+
+  describe '#add' do
+    it_behaves_like('a sendgrid response', '/api/unsubscribes.add.json') do
+      let(:action) { subject.add(email: 'foobar@example.com') }
+      let(:response) do
+        '{
+          "message": "success"
+        }'
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sendgrid-web
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Darren Coxall
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-13 00:00:00.000000000 Z
+date: 2013-07-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -105,7 +105,11 @@ files:
 - lib/sendgrid/web/filter_commands.rb
 - lib/sendgrid/web/invalid_emails.rb
 - lib/sendgrid/web/mail.rb
+- lib/sendgrid/web/parse_webhook_settings.rb
+- lib/sendgrid/web/profile.rb
 - lib/sendgrid/web/response.rb
+- lib/sendgrid/web/spam_reports.rb
+- lib/sendgrid/web/unsubscribes.rb
 - lib/sendgrid/web/version.rb
 - sendgrid-web.gemspec
 - spec/sendgrid/web/blocks_spec.rb
@@ -116,7 +120,11 @@ files:
 - spec/sendgrid/web/filter_commands_spec.rb
 - spec/sendgrid/web/invalid_emails_spec.rb
 - spec/sendgrid/web/mail_spec.rb
+- spec/sendgrid/web/parse_webhook_settings_spec.rb
+- spec/sendgrid/web/profile_spec.rb
 - spec/sendgrid/web/response_spec.rb
+- spec/sendgrid/web/spam_reports_spec.rb
+- spec/sendgrid/web/unsubscribes_spec.rb
 - spec/spec_helper.rb
 - spec/support/shared_sendgrid_response.rb
 homepage: https://github.com/FreakyDazio/sendgrid-web
@@ -152,6 +160,10 @@ test_files:
 - spec/sendgrid/web/filter_commands_spec.rb
 - spec/sendgrid/web/invalid_emails_spec.rb
 - spec/sendgrid/web/mail_spec.rb
+- spec/sendgrid/web/parse_webhook_settings_spec.rb
+- spec/sendgrid/web/profile_spec.rb
 - spec/sendgrid/web/response_spec.rb
+- spec/sendgrid/web/spam_reports_spec.rb
+- spec/sendgrid/web/unsubscribes_spec.rb
 - spec/spec_helper.rb
 - spec/support/shared_sendgrid_response.rb