simple_spark 1.0.7 → 1.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 2d7b1b06465275e9cfa691c57938c9dfbce22e21
-  data.tar.gz: e37df0bba4c9881c0bcacf669ef7eb4cf108dc76
+SHA256:
+  metadata.gz: cbdf85242494fe095cb7ce40c9e6c2ef485c079c2ff6dd306e0446c3f5b4f7a5
+  data.tar.gz: 43e97d881ece27eded5f6166ed8b9cdf5c716c0d23dfff99291e39149eed41d2
 SHA512:
-  metadata.gz: 9bd90b7dae7cd70dd373b06bffb34c6649b6d1846e3df3d7a84d6ae21190b0968ce980759073e313d51e670bcd631f7626cd0ee37d0893cefdf6b3d57c07f1c6
-  data.tar.gz: 65bcd8e3f5afbbad757905a42487b2c0cb248f0d4fa84c06315ec925788a3c66d7fe2a7af2124d42b31ebc913472c094c3b04ae05bd4c8793d3e156b9df4d113
+  metadata.gz: bce5c2d519fe46bb10aca0eabb8043a4888ab946d74c4334a987efadca0de08b1a12fa9744c435213dbed40057c4c2993d352fc8c7b9f3837afbfb458a2bc8d5
+  data.tar.gz: 801c0d5bfb2958a555ae45bd4de93f0941a548ae025ebe6d7b01a2214632694b6c4c1cf395c24361746b17e34a53431dd323700367e1decde23973302d43501f

data/README.md

@@ -426,6 +426,34 @@ simple_spark.message_events.search(campaign_ids: 'christmas-campaign, summer-cam
 
 <a href="https://developers.sparkpost.com/api/#/reference/message-events/events-samples" target="_blank">see SparkPost API Documentation</a>
 
+### Events
+
+#### Samples
+
+List an example of the event data that will be included in a response from the Events search endpoint
+
+```ruby
+simple_spark.events.samples
+```
+
+To limit to just some events
+
+```ruby
+simple_spark.events.samples('bounce')
+```
+
+<a href="https://developers.sparkpost.com/api/events/#events-get-events-samples" target="_blank">see SparkPost API Documentation</a>
+
+#### Search
+
+Perform a filtered search for event data. The response is sorted by descending timestamp. For full options you should consult the SparkPost API documentation
+
+```ruby
+simple_spark.events.search(campaign_ids: 'christmas-campaign, summer-campaign')
+```
+
+<a href="https://developers.sparkpost.com/api/events/#events-get-events-samples" target="_blank">see SparkPost API Documentation</a>
+
 ### Webhooks
 
 #### List
@@ -807,6 +835,11 @@ simple_spark.templates.delete(yourtemplateid)
 
 ## Changelog
 
+
+### 1.0.8
+
+- Add Events Endpoint
+
 ### 1.0.6
 
 - Exceptions now return SparkPost results object too

data/lib/simple_spark/client.rb

@@ -132,6 +132,10 @@ module SimpleSpark
       Endpoints::Transmissions.new(self)
     end
 
+    def events
+      Endpoints::Events.new(self)
+    end
+
     def message_events
       Endpoints::MessageEvents.new(self)
     end

data/lib/simple_spark/endpoints/events.rb

@@ -0,0 +1,31 @@
+module SimpleSpark
+  module Endpoints
+    # Provides access to the /message-events endpoint
+    # @note See: https://developers.sparkpost.com/api/events/
+    class Events
+      attr_accessor :client
+
+      def initialize(client)
+        @client = client
+      end
+
+      # Returns sample events
+      # @param events [String] Event types for which to get a sample payload, use the Webhooks Events endpoint to list the
+      #   available event types, defaults to all event types
+      # @return [Array] a list of sample Event hash objects
+      # @note See: https://developers.sparkpost.com/api/events/#events-get-events-samples
+      def samples(events = nil)
+        query_params = events.nil? ? {} : { events: events }
+        @client.call(method: :get, path: 'events/message/samples', query_values: query_params)
+      end
+
+      # Perform a filtered search for message event data. The response is sorted by descending timestamp.
+      # @param params [String] Params to use in the search
+      # @return [Array] a list of Event hash objects
+      # @note https://developers.sparkpost.com/api/events/#events-get-search-for-message-events
+      def search(params = {})
+        @client.call(method: :get, path: 'events/message', query_values: params)
+      end
+    end
+  end
+end

data/lib/simple_spark/version.rb

@@ -1,3 +1,3 @@
 module SimpleSpark
-  VERSION = '1.0.7'
+  VERSION = '1.0.8'
 end

data/lib/simple_spark.rb

@@ -8,6 +8,7 @@ require 'simple_spark/endpoints/templates'
 require 'simple_spark/endpoints/inbound_domains'
 require 'simple_spark/endpoints/sending_domains'
 require 'simple_spark/endpoints/message_events'
+require 'simple_spark/endpoints/events'
 require 'simple_spark/endpoints/webhooks'
 require 'simple_spark/endpoints/relay_webhooks'
 require 'simple_spark/endpoints/subaccounts'

data/spec/simple_spark/client_spec.rb

@@ -76,6 +76,10 @@ describe SimpleSpark::Client do
         specify { expect(client.message_events.class).to eq(SimpleSpark::Endpoints::MessageEvents) }
       end
 
+      context 'events' do
+        specify { expect(client.events.class).to eq(SimpleSpark::Endpoints::Events) }
+      end
+
       context 'relay_webhooks' do
         specify { expect(client.relay_webhooks.class).to eq(SimpleSpark::Endpoints::RelayWebhooks) }
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simple_spark
 version: !ruby/object:Gem::Version
-  version: 1.0.7
+  version: 1.0.8
 platform: ruby
 authors:
 - Jak Charlton
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-06 00:00:00.000000000 Z
+date: 2019-05-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -68,6 +68,7 @@ files:
 - lib/simple_spark.rb
 - lib/simple_spark/client.rb
 - lib/simple_spark/endpoints/account.rb
+- lib/simple_spark/endpoints/events.rb
 - lib/simple_spark/endpoints/inbound_domains.rb
 - lib/simple_spark/endpoints/message_events.rb
 - lib/simple_spark/endpoints/metrics.rb
@@ -104,7 +105,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.7
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: A library for accessing the SparkPost REST API http://www.sparkpost.com