simple_spark 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 48f67a4d104d2173d2e603bf2408f0e487c5a7fa
-  data.tar.gz: 558790542ce8eaa9de855a100551687cc6cd5d69
+  metadata.gz: 9fbe341a22eda0d04e959f2c63bdb11aaed0c063
+  data.tar.gz: 9c051cede4440b5e40de0e249e213f48d12d0651
 SHA512:
-  metadata.gz: e9cdf1aeddc939693f6cd34be0712a890ef0810301cdb69b7ed910d9ce2d5c8c1f5e8e4461620e057ec0dd1c805ad8426491cb787d6c7a3e4ebc99aaabd4524c
-  data.tar.gz: 9dc6f8b0cb0e29cf1a1b7fbf1aede1cbb30d9a7f812e454cced9eef79ecb63255649e981af413a65da5e96e303164eaba9c3ac1632005b0de737c348189aa879
+  metadata.gz: 2f0264a5ee16bae3a0ea08b3af30627672dd6eaeb448b1820b3799c0589828a29a4a26bbe4fdd47661eab9b7106060c5b510fa80f7e18334348404d69125fb57
+  data.tar.gz: 6cdd94b5f13ce42d1467e614712e9d9fc7daa0325b12c9405ec208bcfe275c3fc35ba067b48cbddf3c50bf4989314893cd035986ee1f36553248843d46b99084

data/README.md

@@ -193,6 +193,28 @@ simple_spark.metrics.deliverability_metrics_by_template(properties)
 
 <a href="https://developers.sparkpost.com/api/#/reference/metrics/deliverability-metrics/deliverability-metrics-by-template" target="_blank">see SparkPost API Documentation</a>
 
+#### Deliverability Metrics as Time Series
+
+Metrics across a Time Series
+
+```ruby
+properties = {
+  from: '2013-04-20T07:12',
+  to: '2018-04-20T07:12',
+  metrics: 'count_accepted',
+  timezone: 'America/New_York',
+  precision: 'day'
+}
+simple_spark.metrics.deliverability_time_series(properties)
+```
+
+Returns an array of metrics with time stamps:
+
+```ruby
+[{ "count_targeted"=>2, "ts"=>"2011-06-01T00:00:00+00:00" }, { "count_targeted"=>3, "ts"=>"2011-06-02T00:00:00+00:00" }]
+```
+
+<a href="https://developers.sparkpost.com/api/#/reference/metrics/time-series/time-series-metrics" target="_blank">see SparkPost API Documentation</a>
 
 ### Transmissions
 
@@ -666,6 +688,10 @@ simple_spark.templates.delete(yourtemplateid)
 
 ## Changelog
 
+### 0.0.7
+
+Added Time Series to Metrics
+
 ### 0.0.6
 
 Fixed accidental bug

data/lib/simple_spark/endpoints/metrics.rb

@@ -18,69 +18,93 @@ module SimpleSpark
 
       # Deliverability Metrics Summary
       # @param values [Hash] the values to query with
-      # @note dates from and to should be converted using strftime('%Y-%m-%dT%H:%M')
+      # @note dates from and need to be sent using strftime('%Y-%m-%dT%H:%M'), for convenience if provided as Time, Date or DateTime objects they will be automatically converted
       # @return [Hash] containg a Metrics hash, the 'results' key will contain the metrics, the 'links' key will contain discoverability links
       # @note Example:
       #   client.metrics.deliverability_metrics_summary(from: '2013-04-20T07:12', to: '2018-04-20T07:12', metrics: 'count_accepted', timezone: 'America/New_York')
       # @note See: https://developers.sparkpost.com/api/#/reference/metrics/discoverability-links/deliverability-metrics-summary
       def deliverability_metrics_summary(values)
+        format_date_time_values(values)
         @client.call(method: :get, path: 'metrics/deliverability', query_values: values, extract_results: false)
       end
 
       # Deliverability Metrics By Domain
       # @param values [Hash] the values to query with
-      # @note dates from and to should be converted using strftime('%Y-%m-%dT%H:%M')
+      # @note dates from and need to be sent using strftime('%Y-%m-%dT%H:%M'), for convenience if provided as Time, Date or DateTime objects they will be automatically converted
       # @return [Array] containg Metrics results i.e. { "count_accepted": 66, "domain": "gmail.com" }
       # @note Example:
       #   client.metrics.deliverability_metrics_by_domain(from: '2013-04-20T07:12', to: '2018-04-20T07:12', metrics: 'count_accepted', timezone: 'America/New_York', domains: 'gmail.com')
       # @note See: https://developers.sparkpost.com/api/#/reference/metrics/deliverability-metrics/deliverability-metrics-by-domain
       def deliverability_metrics_by_domain(values)
+        format_date_time_values(values)
         @client.call(method: :get, path: 'metrics/deliverability/domain', query_values: values)
       end
 
       # Deliverability Metrics By Sending Domain
       # @param values [Hash] the values to query with
-      # @note dates from and to should be converted using strftime('%Y-%m-%dT%H:%M')
+      # @note dates from and need to be sent using strftime('%Y-%m-%dT%H:%M'), for convenience if provided as Time, Date or DateTime objects they will be automatically converted
       # @return [Array] containg Metrics results i.e. { "count_accepted": 66, "sending_domain": "gmail.com" }
       # @note Example:
       #   client.metrics.deliverability_metrics_by_sending_domain(from: '2013-04-20T07:12', to: '2018-04-20T07:12', metrics: 'count_accepted', timezone: 'America/New_York', sending_domains: 'mydomain.com')
       # @note See: https://developers.sparkpost.com/api/#/reference/metrics/deliverability-metrics/deliverability-metrics-by-sending-domain
       def deliverability_metrics_by_sending_domain(values)
+        format_date_time_values(values)
         @client.call(method: :get, path: 'metrics/deliverability/sending-domain', query_values: values)
       end
 
       # Deliverability Metrics By Campaign
       # @param values [Hash] the values to query with
-      # @note dates from and to should be converted using strftime('%Y-%m-%dT%H:%M')
+      # @note dates from and need to be sent using strftime('%Y-%m-%dT%H:%M'), for convenience if provided as Time, Date or DateTime objects they will be automatically converted
       # @return [Array] containg Metrics results i.e. { "count_accepted": 66, "campaign_id": "Summer Sale" }
       # @note Example:
       #   client.metrics.deliverability_metrics_by_campaign(from: '2013-04-20T07:12', to: '2018-04-20T07:12', metrics: 'count_accepted', timezone: 'America/New_York', campaigns: 'Summer Sale')
       # @note See: https://developers.sparkpost.com/api/#/reference/metrics/deliverability-metrics/deliverability-metrics-by-campaign
       def deliverability_metrics_by_campaign(values)
+        format_date_time_values(values)
         @client.call(method: :get, path: 'metrics/deliverability/campaign', query_values: values)
       end
 
       # Deliverability Metrics By Subaccount
       # @param values [Hash] the values to query with
-      # @note dates from and to should be converted using strftime('%Y-%m-%dT%H:%M')
+      # @note dates from and need to be sent using strftime('%Y-%m-%dT%H:%M'), for convenience if provided as Time, Date or DateTime objects they will be automatically converted
       # @return [Array] containg Metrics results i.e. { "count_accepted": 66, "subaccount_id": "acc123" }
       # @note Example:
       #   client.metrics.deliverability_metrics_by_subaccount(from: '2013-04-20T07:12', to: '2018-04-20T07:12', metrics: 'count_accepted', timezone: 'America/New_York', subaccounts: 'acc123')
       # @note See: https://developers.sparkpost.com/api/#/reference/metrics/deliverability-metrics/deliverability-metrics-by-subaccount
       def deliverability_metrics_by_subaccount(values)
+        format_date_time_values(values)
         @client.call(method: :get, path: 'metrics/deliverability/subaccount', query_values: values)
       end
 
       # Deliverability Metrics By Template
       # @param values [Hash] the values to query with
-      # @note dates from and to should be converted using strftime('%Y-%m-%dT%H:%M')
+      # @note dates from and need to be sent using strftime('%Y-%m-%dT%H:%M'), for convenience if provided as Time, Date or DateTime objects they will be automatically converted
       # @return [Array] containg Metrics results i.e. { "count_accepted": 66, "template": "My Template" }
       # @note Example:
       #   client.metrics.deliverability_metrics_by_template(from: '2013-04-20T07:12', to: '2018-04-20T07:12', metrics: 'count_accepted', timezone: 'America/New_York', subaccounts: 'acc123')
       # @note See: https://developers.sparkpost.com/api/#/reference/metrics/deliverability-metrics/deliverability-metrics-by-template
       def deliverability_metrics_by_template(values)
+        format_date_time_values(values)
         @client.call(method: :get, path: 'metrics/deliverability/template', query_values: values)
       end
+
+      # Time Series
+      # @param values [Hash] the values to query with
+      # @note dates from and need to be sent using strftime('%Y-%m-%dT%H:%M'), for convenience if provided as Time, Date or DateTime objects they will be automatically converted
+      # @return [Array] containg Metrics results with time stamps i.e. [{"count_targeted"=>0, "ts"=>"2011-06-01T00:00:00+00:00"}]
+      # @note Example:
+      #   client.metrics.deliverability_time_series(from: '2013-04-20T07:12', to: '2018-04-20T07:12', metrics: 'count_accepted', timezone: 'America/New_York', precision: 'day')
+      # @note See: https://developers.sparkpost.com/api/#/reference/metrics/time-series/time-series-metrics
+      def deliverability_time_series(values)
+        format_date_time_values(values)
+        @client.call(method: :get, path: 'metrics/deliverability/time-series', query_values: values)
+      end
+
+      private
+
+      def format_date_time_values(values)
+        values.keys.each { |k| values[k] = values[k].strftime('%Y-%m-%dT%H:%M') if values[k].respond_to?(:strftime) }
+      end
     end
   end
 end

data/lib/simple_spark/version.rb

@@ -1,3 +1,3 @@
 module SimpleSpark
-  VERSION = '0.0.6'
+  VERSION = '0.0.7'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: simple_spark
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - Jak Charlton