sendgrid-web 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d55cccb3825dcfc129f5c068cd56dc1c4680c2eb
-  data.tar.gz: c18852eb71401b67a4c060de1af8ffe7826fc3f5
+  metadata.gz: 72f7a0fbf53971295a55c04915c382e9499e8573
+  data.tar.gz: c71046c3bf1adbd9536c3bacbb5bd4af8b80f332
 SHA512:
-  metadata.gz: 90fcb041fd4973bcd1033a6875ef900bd77950b47e6d059bda9be7db6addd0093a10ae6a10778fae631ecac998acd214f3983236939f44e15534c54fb8d00ae6
-  data.tar.gz: 647714ff3f4a66743eea7550a4d4e19794479e5d0e390f22302e09e234eab4150591500aeffed9e1ba27ccef5bc61cf470685be390d68a437b27befae2353b08
+  metadata.gz: 00b0c2db81803f65e168fbdd9e94f595a3258ff0a1e43c48a771b8bcd6ccd9c9a1b3c0f8fc10d270fa2eeab64f497faab2bf43b901f1c5295bfe9749a6315c4c
+  data.tar.gz: e28781fe17f6ba28e392524548aa7f905ceaca73f771ea5a131275dbe68a6764b2d0682e406854cda68322f08dc4143f316322c925de5351f29372dbc3d042d9

data/lib/sendgrid/web/statistics.rb

@@ -0,0 +1,101 @@
+class Sendgrid::Web::Statistics < Sendgrid::Web::Client
+
+  # Retrieve statistics and data about your use of SendGrid.
+  #
+  # @param days [Integer] Number of days in the past to include
+  #   statistics (Includes today).
+  # @param start_date [DateTime] The start date to look up statistics.
+  # @param end_date [DateTime] The end date to look up statistics.
+  # @param aggregate [Integer] This is used to indicate you are
+  #   interested in all-time totals.
+  # @param list [bool] Determins if SendGrid should return a list of
+  #   categories.
+  # @param category [String] The category you will specify to retrieve
+  #   detailed stats.
+  # @return [Sendgrid::Web::Response] The SendGrid response.
+  # @note All parameters are optional.
+  def get(
+    days: nil, start_date: nil, end_date: nil,
+    aggregate: nil, list: nil, category: nil)
+    res = connection.post(
+      '/api/stats.get.json',
+      default_params(
+        days: days,
+        start_date: start_date,
+        end_date: end_date,
+        aggregate: aggregate,
+        list: list,
+        category: category))
+    craft_response(res)
+  end
+
+  # Retrieve more advanced and in-depth statistics.
+  #
+  # @param data_type [String] Must be one of the following:
+  #   - +browsers+: Browser data obtained from click events.
+  #   - +clients+: Email client data obtained from open events.
+  #   - +devices+: Device data obtained from open events.
+  #   - +geo+: Geographical data obtained from multiple events.
+  #   - +global+: Global account data obtained from multiple events.
+  #   - +isps+: ISP data obtained from multiple events.
+  # @param start_date [String] Date format is based on aggregated_by
+  #   value (default is yyyy-mm-dd):
+  #   - yyyy-mm-dd (i.e 2012-12-13) if aggregated_by=day (default)
+  #   - yyyy-ww (i.e 2012-43) if aggregated_by=week
+  #   - yyyy-mm (i.e 2012-11) if aggregated_by=month
+  # @param end_date [String] Date format is based on aggregated_by
+  #   value (default is yyyy-mm-dd):
+  #   - yyyy-mm-dd (i.e 2012-12-13) if aggregated_by=day (default)
+  #   - yyyy-ww (i.e 2012-43) if aggregated_by=week
+  #   - yyyy-mm (i.e 2012-11) if aggregated_by=month
+  # @param metric [String] One of the following (default is all):
+  #   - +open+: Opens
+  #   - +click+: Clicks
+  #   - +unique_open+: Unique opens
+  #   - +unique_click+: Unique clicks
+  #   - +processed+: Processed emails
+  #   - +delivered+: Delivered emails
+  #   - +drop+: Dropped emails
+  #   - +bounce+: Bounced emails
+  #   - +deferred+: Deferred email tries
+  #   - +spamreport+: Emails marked as spam
+  #   - +blocked+: Emails that have been blocked
+  #   - +all+: All metrics are returned
+  # @param category [String] Return stats for the given category.
+  # @param aggregated_by [String] Aggregate the data by the given
+  #   period (default is day):
+  #   - +day+: Keys are returned in the format yyyy-mm-dd
+  #     (i.e 2012-12-13)
+  #   - +week+: Keys are return in the format yyyy-ww (i.e 2012-43)
+  #   - +month+: Keys are return in the format yyyy-mm (i.e 2012-11)
+  # @param country [String] Get stats for each region/state for the
+  #   given country. Only US (United States) and CA (Canada) is
+  #   supported at this time. Country code is two letter characters
+  #   based on {http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2 ISO 3166-1 alpha-2}.
+  #
+  #   This parameter is only used for when data_type=geo
+  # @return [Sendgrid::Web::Response] The SendGrid response.
+  # @note The +data_type+ and +start_date+ parameters are required.
+  def get_advanced(
+    data_type: nil, start_date: nil, end_date: nil,
+    metric: nil, category: nil, aggregated_by: nil,
+    country: nil)
+    if data_type.nil?
+      raise ArgumentError.new('Missing required `data_type` option')
+    elsif start_date.nil?
+      raise ArgumentError.new('Missing required `start_date` option')
+    end
+    res = connection.post(
+      '/api/stats.getAdvanced.json',
+      default_params(
+        data_type: data_type,
+        start_date: start_date,
+        end_date: end_date,
+        metric: metric,
+        category: category,
+        aggregated_by: aggregated_by,
+        country: country))
+    craft_response(res)
+  end
+
+end

data/lib/sendgrid/web/version.rb

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

data/lib/sendgrid/web.rb

@@ -16,6 +16,7 @@ module Sendgrid
     autoload :Profile,        'sendgrid/web/profile'
     autoload :SpamReports,    'sendgrid/web/spam_reports'
     autoload :Unsubscribes,   'sendgrid/web/unsubscribes'
+    autoload :Statistics,     'sendgrid/web/statistics'
     autoload :Response,       'sendgrid/web/response'
   end
 end

data/spec/sendgrid/web/statistics_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+
+describe Sendgrid::Web::Statistics do
+  describe '#get' do
+    it_behaves_like('a sendgrid response', '/api/stats.get.json') do
+      let(:action) { subject.get }
+      let(:response) do
+        '[
+          {
+            "date": "2009-06-20",
+            "requests": 12342,
+            "bounces": 12,
+            "clicks": 10223,
+            "opens": 9992,
+            "spamreports": 5,
+            "unique_clicks": 3,
+            "unique_opens": 6,
+            "blocked": 7
+          }
+        ]'
+      end
+    end
+  end
+
+  describe '#get_advanced' do
+    it_behaves_like('a sendgrid response', '/api/stats.getAdvanced.json') do
+      let(:action) { subject.get_advanced(
+        data_type: :global,
+        start_date: DateTime.new(2013, 01, 01)) }
+      let(:response) do
+        '[
+          {
+            "delivered": 41,
+            "request": 41,
+            "unique_open": 1,
+            "unique_click": 1,
+            "processed": 41,
+            "date": "2013-01-01",
+            "open": 2,
+            "click": 1
+          }
+        ]'
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sendgrid-web
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - Darren Coxall
@@ -109,6 +109,7 @@ files:
 - lib/sendgrid/web/profile.rb
 - lib/sendgrid/web/response.rb
 - lib/sendgrid/web/spam_reports.rb
+- lib/sendgrid/web/statistics.rb
 - lib/sendgrid/web/unsubscribes.rb
 - lib/sendgrid/web/version.rb
 - sendgrid-web.gemspec
@@ -124,6 +125,7 @@ files:
 - spec/sendgrid/web/profile_spec.rb
 - spec/sendgrid/web/response_spec.rb
 - spec/sendgrid/web/spam_reports_spec.rb
+- spec/sendgrid/web/statistics_spec.rb
 - spec/sendgrid/web/unsubscribes_spec.rb
 - spec/spec_helper.rb
 - spec/support/shared_sendgrid_response.rb
@@ -164,6 +166,7 @@ test_files:
 - spec/sendgrid/web/profile_spec.rb
 - spec/sendgrid/web/response_spec.rb
 - spec/sendgrid/web/spam_reports_spec.rb
+- spec/sendgrid/web/statistics_spec.rb
 - spec/sendgrid/web/unsubscribes_spec.rb
 - spec/spec_helper.rb
 - spec/support/shared_sendgrid_response.rb