simple_spark 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 033a53e16f648e2adb8f809ba21ddc399240c41c
-  data.tar.gz: 0ff0164603265675973fc625caeeb55d64c9cc3f
+  metadata.gz: cd347b4dc4e50f6b0ee4b2d8679bbad9f70cc6c5
+  data.tar.gz: 4c1c0584b9bb8fd021823a57ceac610e26815797
 SHA512:
-  metadata.gz: a19340282526d9e2cbb280d71db1b827f079f7ba935858c9477fb91cd53191329d740f987584bdf570facbca725a5a76e00e88a1ab65aa742916582ea72b25fe
-  data.tar.gz: 9907ad59779cd9b7cf63dbaa388133fa6d2fe795f0261cf501a2fe001632e9ed13522cc3df4ef7b0199c9c4f1834fada0096eb216297381712464cc26072d2eb
+  metadata.gz: dd54320ae089dad8d23a9b8ead92bab3fe8475bef7d4d8e0d2822b0e5203a288ad223de4ab2b27b6dfc7bb88a239e9fec179d7e4cc252ff04a8d166c76ecc70a
+  data.tar.gz: 8ffdad3040e019cde03055e5dd2da7cc4d0160e94aaa0304744a86113d2884619c7561e4d40519bd3a51438dca437f79cbcf105a2bc51c36d14103028bcd8ccf

data/Gemfile

@@ -2,3 +2,5 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in sparkpost-snap.gemspec
 gemspec
+
+gem 'pry'

data/README.md

@@ -1,6 +1,6 @@
 # SimpleSpark
 
-[![Build Status](https://travis-ci.org/leadmachineapp/simple_spark.png?branch=master)](https://travis-ci.org/leadmachineapp/simple_spark)
+[![Build Status](https://travis-ci.org/leadmachineapp/simple_spark.png?branch=master)](https://travis-ci.org/leadmachineapp/simple_spark) [![Gem Version](https://badge.fury.io/rb/simple_spark.svg)](https://badge.fury.io/rb/simple_spark)
 
 This gem is an alternative to the [official Ruby gem](https://github.com/SparkPost/ruby-sparkpost) provided by [SparkPost](http://www.sparkpost.com)
 
@@ -86,6 +86,78 @@ Should you have any need to override the headers that are sent by default, then
 simple_spark = SimpleSpark::Client.new(api_key: 'your_api_key', headers: { 'NewSparkpostHeader' => 'hello'})
 ```
 
+
+### Metrics
+
+#### Discoverability Links
+
+```ruby
+simple_spark.metrics.discoverability_links
+```
+
+<a href="https://developers.sparkpost.com/api/#/reference/metrics/metrics-discoverability-links" target="_blank">see SparkPost API Documentation</a>
+
+#### Deliverability Metrics Summary
+
+Summary of metrics
+
+```ruby
+simple_spark.metrics.deliverability_metrics_summary(from: '2013-04-20T07:12', to: '2018-04-20T07:12', metrics: 'count_accepted', timezone: 'America/New_York')
+```
+
+<a href="https://developers.sparkpost.com/api/#/reference/metrics/discoverability-links/deliverability-metrics-summary" target="_blank">see SparkPost API Documentation</a>
+
+#### Deliverability Metrics by Domain
+
+Metrics grouped by Domain
+
+```ruby
+simple_spark.metrics.deliverability_metrics_by_domain(from: '2013-04-20T07:12', to: '2018-04-20T07:12', metrics: 'count_accepted', timezone: 'America/New_York')
+```
+
+<a href="https://developers.sparkpost.com/api/#/reference/metrics/deliverability-metrics/deliverability-metrics-by-domain" target="_blank">see SparkPost API Documentation</a>
+
+#### Deliverability Metrics by Sending Domain
+
+Metrics grouped by Sending Domain
+
+```ruby
+simple_spark.metrics.deliverability_metrics_by_sending_domain(from: '2013-04-20T07:12', to: '2018-04-20T07:12', metrics: 'count_accepted', timezone: 'America/New_York')
+```
+
+<a href="https://developers.sparkpost.com/api/#/reference/metrics/deliverability-metrics/deliverability-metrics-by-sending-domain" target="_blank">see SparkPost API Documentation</a>
+
+#### Deliverability Metrics by Subaccount
+
+Metrics grouped by Subaccount
+
+```ruby
+simple_spark.metrics.deliverability_metrics_by_subaccount(from: '2013-04-20T07:12', to: '2018-04-20T07:12', metrics: 'count_accepted', timezone: 'America/New_York')
+```
+
+<a href="https://developers.sparkpost.com/api/#/reference/metrics/deliverability-metrics/deliverability-metrics-by-subaccount" target="_blank">see SparkPost API Documentation</a>
+
+#### Deliverability Metrics by Campaign
+
+Metrics grouped by Campaign
+
+```ruby
+simple_spark.metrics.deliverability_metrics_by_campaign(from: '2013-04-20T07:12', to: '2018-04-20T07:12', metrics: 'count_accepted', timezone: 'America/New_York')
+```
+
+<a href="https://developers.sparkpost.com/api/#/reference/metrics/deliverability-metrics/deliverability-metrics-by-campaign" target="_blank">see SparkPost API Documentation</a>
+
+#### Deliverability Metrics by Template
+
+Metrics grouped by Template
+
+```ruby
+simple_spark.metrics.deliverability_metrics_by_template(from: '2013-04-20T07:12', to: '2018-04-20T07:12', metrics: 'count_accepted', timezone: 'America/New_York')
+```
+
+<a href="https://developers.sparkpost.com/api/#/reference/metrics/deliverability-metrics/deliverability-metrics-by-template" target="_blank">see SparkPost API Documentation</a>
+
+
 ### Transmissions
 
 #### List
@@ -153,6 +225,51 @@ simple_spark.transmissions.create(properties)
 
 <a href="https://developers.sparkpost.com/api/#/reference/transmissions/create" target="_blank">see SparkPost API Documentation</a>
 
+
+### Subaccounts
+
+#### List
+
+List all Subaccounts
+
+```ruby
+simple_spark.subaccounts.list
+```
+
+<a href="https://developers.sparkpost.com/api/#/reference/subaccounts/subaccounts-collection/list-subaccounts" target="_blank">see SparkPost API Documentation</a>
+
+#### Create
+
+Create a new Subaccount
+
+```ruby
+simple_spark.subaccounts.create({ "name": "Sparkle Ponies", "key_label": "API Key for Sparkle Ponies Subaccount", "key_grants": ["smtp/inject", "sending_domains/manage", "message_events/view", "suppression_lists/manage"] })
+```
+
+<a href="hhttps://developers.sparkpost.com/api/#/reference/subaccounts/subaccounts-collection/create-new-subaccount" target="_blank">see SparkPost API Documentation</a>
+
+#### Retrieve
+
+Retrieves a Subaccount by its id
+
+```ruby
+simple_spark.subaccounts.retrieve(123)
+```
+
+<a href="https://developers.sparkpost.com/api/#/reference/subaccounts/subaccounts-entity/list-specific-subaccount" target="_blank">see SparkPost API Documentation</a>
+
+#### Update
+
+Updates a Subaccount with new values
+
+```ruby
+properties = { name: "new name" }
+simple_spark.subaccounts.update('mail.mydomain.com', properties)
+```
+
+<a href="https://developers.sparkpost.com/api/#/reference/subaccounts/subaccounts-entity/edit-a-subaccount" target="_blank">see SparkPost API Documentation</a>
+
+
 ### Messsage Events
 
 #### Samples
@@ -509,6 +626,11 @@ simple_spark.templates.delete(yourtemplateid)
 
 ## Changelog
 
+### 0.0.5
+
+- Subaccounts endpoint added
+- Metrics main endpoints added
+
 ### 0.0.4
 
 - Merged pull request to fix Rails development check for debug

data/lib/simple_spark/client.rb

@@ -23,7 +23,13 @@ module SimpleSpark
       @session = Excon.new(@api_host, debug: @debug)
     end
 
-    def call(method, path, body_values = {}, query_params = {})
+    def call(opts)
+      method = opts[:method]
+      path = opts[:path]
+      body_values = opts[:body_values] || {}
+      query_params = opts[:query_values] || {}
+      extract_results = opts[:extract_results].nil? ? true : opts[:extract_results]
+
       fail Exceptions::InvalidConfiguration.new(method: method), 'Only GET, POST, PUT and DELETE are supported' unless [:get, :post, :put, :delete].include?(method)
 
       path = "#{@base_path}#{path}"
@@ -32,17 +38,21 @@ module SimpleSpark
       params[:query] = query_params unless query_params.empty?
       response = @session.send(method.to_s, params)
 
-      process_response(response)
+      process_response(response, extract_results)
     end
 
-    def process_response(response)
+    def process_response(response, extract_results)
       return true if response.status == 204
 
       response_body = JSON.parse(response.body)
       if response_body['errors']
         Exceptions::Error.fail_with_exception_for_status(response.status, response_body['errors'])
       else
-        response_body['results'] ? response_body['results'] : true
+        if extract_results
+          response_body['results'] ? response_body['results'] : true
+        else
+          response_body
+        end
       end
     end
 
@@ -63,6 +73,14 @@ module SimpleSpark
       defaults
     end
 
+    def metrics
+      Endpoints::Metrics.new(self)
+    end
+
+    def subaccounts
+      Endpoints::Subaccounts.new(self)
+    end
+
     def inbound_domains
       Endpoints::InboundDomains.new(self)
     end

data/lib/simple_spark/endpoints/inbound_domains.rb

@@ -13,14 +13,14 @@ module SimpleSpark
       # @return [Array] a list of Inbound Domain hash objects
       # @note See: https://developers.sparkpost.com/api/#/reference/inbound-domains/create-and-list
       def list
-        @client.call(:get, 'inbound-domains')
+        @client.call(method: :get, path: 'inbound-domains')
       end
 
       # Create an inbound domain
       # @param domain_name [String] the domain name to create
       # @note See: https://developers.sparkpost.com/api/#/reference/inbound-domains/create-and-list
       def create(domain_name)
-        @client.call(:post, 'inbound-domains', domain: domain_name)
+        @client.call(method: :post, path: 'inbound-domains', query_values: { domain: domain_name })
       end
 
       # Retrieve an inbound domain
@@ -29,7 +29,7 @@ module SimpleSpark
       # @note See: https://developers.sparkpost.com/api/#/reference/inbound-domains/retrieve-and-delete
       def retrieve(domain_name)
         domain_name = @client.url_encode(domain_name)
-        @client.call(:get, "inbound-domains/#{domain_name}")
+        @client.call(method: :get, path: "inbound-domains/#{domain_name}")
       end
 
       # Delete an inbound domain
@@ -37,7 +37,7 @@ module SimpleSpark
       # @note See: https://developers.sparkpost.com/api/#/reference/inbound-domains/retrieve-and-delete
       def delete(domain_name)
         domain_name = @client.url_encode(domain_name)
-        @client.call(:delete, "inbound-domains/#{domain_name}")
+        @client.call(method: :delete, path: "inbound-domains/#{domain_name}")
       end
     end
   end

data/lib/simple_spark/endpoints/message_events.rb

@@ -16,7 +16,7 @@ module SimpleSpark
       # @note See: https://developers.sparkpost.com/api/#/reference/message-events/events-samples
       def samples(events = nil)
         query_params = events.nil? ? {} : { events: events }
-        @client.call(:get, 'message-events/events/samples', {}, query_params)
+        @client.call(method: :get, path: 'message-events/events/samples', query_values: query_params)
       end
 
       # Perform a filtered search for message event data. The response is sorted by descending timestamp.
@@ -24,7 +24,7 @@ module SimpleSpark
       # @return [Array] a list of MessageEvent hash objects
       # @note See: https://developers.sparkpost.com/api/#/reference/message-events/search-for-message-events
       def search(params = {})
-        @client.call(:get, 'message-events', {}, params)
+        @client.call(method: :get, path: 'message-events', query_values: params)
       end
     end
   end

data/lib/simple_spark/endpoints/metrics.rb

@@ -0,0 +1,86 @@
+module SimpleSpark
+  module Endpoints
+    # Provides access to the /metrics endpoint
+    # @note See: https://developers.sparkpost.com/api/#/reference/metrics
+    class Metrics
+      attr_accessor :client
+
+      def initialize(client)
+        @client = client
+      end
+
+      # The Metrics API is designed for discoverability of child links. Calling the API root displays a list of URIs that exists within the Metrics API.
+      # @return [Hash] containg a Metrics hash, the 'links' key will contain the links
+      # @note See: https://developers.sparkpost.com/api/#/reference/metrics/metrics-discoverability-links
+      def discoverability_links
+        @client.call(method: :get, path: 'metrics', extract_results: false)
+      end
+
+      # 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')
+      # @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)
+        @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')
+      # @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)
+        @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')
+      # @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)
+        @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')
+      # @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)
+        @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')
+      # @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)
+        @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')
+      # @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)
+        @client.call(method: :get, path: 'metrics/deliverability/template', query_values: values)
+      end
+    end
+  end
+end

data/lib/simple_spark/endpoints/relay_webhooks.rb

@@ -13,7 +13,7 @@ module SimpleSpark
       # @return [Array] a list of Relay Webhook hash objects
       # @note See: https://developers.sparkpost.com/api/#/reference/relay-webhooks/create-and-list/list-all-relay-webhooks
       def list
-        @client.call(:get, 'relay-webhooks')
+        @client.call(method: :get, path: 'relay-webhooks')
       end
 
       # Create a relay webhook
@@ -30,7 +30,7 @@ module SimpleSpark
       #   }
       # }
       def create(values)
-        @client.call(:post, 'relay-webhooks', values)
+        @client.call(method: :post, path: 'relay-webhooks', body_values: values)
       end
 
       # Retrieve a relay webhook
@@ -38,7 +38,7 @@ module SimpleSpark
       # @return [Hash] an Relay Webhook hash object
       # @note See: https://developers.sparkpost.com/api/#/reference/relay-webhooks/retrieve-update-and-delete/retrieve-a-relay-webhook
       def retrieve(webhook_id)
-        @client.call(:get, "relay-webhooks/#{webhook_id}")
+        @client.call(method: :get, path: "relay-webhooks/#{webhook_id}")
       end
 
       # Update a relay webhook
@@ -52,14 +52,14 @@ module SimpleSpark
       # }
       # @note See: https://developers.sparkpost.com/api/#/reference/relay-webhooks/create-and-list/update-a-relay-webhook
       def update(webhook_id, values)
-        @client.call(:put, "relay-webhooks/#{webhook_id}", values)
+        @client.call(method: :put, path: "relay-webhooks/#{webhook_id}", body_values: values)
       end
 
       # Delete a relay webhook
       # @param webhook_id [String] the id to retrieve
       # @note See: https://developers.sparkpost.com/api/#/reference/relay-webhooks/retrieve-update-and-delete/delete-a-relay-webhook
       def delete(webhook_id)
-        @client.call(:delete, "relay-webhooks/#{webhook_id}")
+        @client.call(method: :delete, path: "relay-webhooks/#{webhook_id}")
       end
     end
   end

data/lib/simple_spark/endpoints/sending_domains.rb

@@ -17,7 +17,7 @@ module SimpleSpark
       # @return [Array] a list of Sending Domain hash objects
       # @note See: https://developers.sparkpost.com/api/#/reference/sending-domains/create-and-list/list-all-sending-domains
       def list
-        @client.call(:get, 'sending-domains')
+        @client.call(method: :get, path: 'sending-domains')
       end
 
       # Create a sending domain
@@ -25,7 +25,7 @@ module SimpleSpark
       # @param tracking_domain [String] the domain name to track this domain against
       # @note See: https://developers.sparkpost.com/api/#/reference/sending-domains/create-and-list
       def create(values)
-        @client.call(:post, 'sending-domains', values)
+        @client.call(method: :post, path: 'sending-domains', body_values: values)
       end
 
       # Retrieve a sending domain
@@ -34,7 +34,7 @@ module SimpleSpark
       # @note See: https://developers.sparkpost.com/api/#/reference/sending-domains/retrieve-update-and-delete
       def retrieve(domain_name)
         domain_name = @client.url_encode(domain_name)
-        @client.call(:get, "sending-domains/#{domain_name}")
+        @client.call(method: :get, path: "sending-domains/#{domain_name}")
       end
 
       # Update a Sending Domain by its domain name
@@ -44,7 +44,7 @@ module SimpleSpark
       # @note See: https://developers.sparkpost.com/api/#/reference/sending-domains/retrieve-update-and-delete
       def update(domain_name, values)
         domain_name = @client.url_encode(domain_name)
-        @client.call(:put, "sending-domains/#{domain_name}", values)
+        @client.call(method: :put, path: "sending-domains/#{domain_name}", body_values: values)
       end
 
       # Verify a Sending Domain by its domain name
@@ -59,7 +59,7 @@ module SimpleSpark
       # @note See: https://developers.sparkpost.com/api/#/reference/sending-domains/verify
       def verify(domain_name, values)
         domain_name = @client.url_encode(domain_name)
-        @client.call(:post, "sending-domains/#{domain_name}/verify", values)
+        @client.call(method: :post, path: "sending-domains/#{domain_name}/verify", body_values: values)
       end
 
       # Delete a sending domain
@@ -67,7 +67,7 @@ module SimpleSpark
       # @note See: https://developers.sparkpost.com/api/#/reference/sending-domains/retrieve-update-and-delete
       def delete(domain_name)
         domain_name = @client.url_encode(domain_name)
-        @client.call(:delete, "sending-domains/#{domain_name}")
+        @client.call(method: :delete, path: "sending-domains/#{domain_name}")
       end
     end
   end

data/lib/simple_spark/endpoints/subaccounts.rb

@@ -0,0 +1,50 @@
+module SimpleSpark
+  module Endpoints
+    # Provides access to the /subaccounts endpoint
+    # @note Example subaccount
+    # @note See: https://developers.sparkpost.com/api/#/reference/subaccounts
+    class Subaccounts
+      attr_accessor :client
+
+      def initialize(client)
+        @client = client
+      end
+
+      # List subaccounts
+      # @return [Array] a list of Subaccount hash objects
+      # @note See: https://developers.sparkpost.com/api/#/reference/subaccounts/subaccounts-collection/list-subaccounts
+      def list
+        @client.call(method: :get, path: 'subaccounts')
+      end
+
+      # Create a subaccount
+      # @param values [Hash] the values to create the subaccount with
+      # @note Example:
+      #   values = {
+      #     "name": "Sparkle Ponies",
+      #     "key_label": "API Key for Sparkle Ponies Subaccount",
+      #     "key_grants": ["smtp/inject", "sending_domains/manage", "message_events/view", "suppression_lists/manage"]
+      #   }
+      # @note See: https://developers.sparkpost.com/api/#/reference/subaccounts/subaccounts-collection/create-new-subaccount
+      def create(values)
+        @client.call(method: :post, path: 'subaccounts', body_values: values)
+      end
+
+      # Retrieve details about a subaccount by specifying its id
+      # @param id [Integer] the ID of the subaccount
+      # @return [Hash] an Subaccount hash object
+      # @note See: https://developers.sparkpost.com/api/#/reference/subaccounts/subaccounts-entity/list-specific-subaccount
+      def retrieve(id)
+        @client.call(method: :get, path: "subaccounts/#{id}")
+      end
+
+      # Update a Subaccount by its ID
+      # @param id [Integer] the ID of the subaccount
+      # @param values [Hash] the values to update the subaccount with
+      # @note See: https://developers.sparkpost.com/api/#/reference/subaccounts/subaccounts-entity/edit-a-subaccount
+      def update(id, values)
+        @client.call(method: :put, path: "subaccounts/#{id}", body_values: values)
+      end
+    end
+  end
+end

data/lib/simple_spark/endpoints/templates.rb

@@ -17,7 +17,7 @@ module SimpleSpark
       # @return [Array] a list of Template hash objects
       # @note See: https://developers.sparkpost.com/api/#/reference/templates/create-and-list
       def list
-        @client.call(:get, 'templates')
+        @client.call(method: :get, path: 'templates')
       end
 
       # Create a template by providing values for the template object.
@@ -27,7 +27,7 @@ module SimpleSpark
       # @return [boolean] true if success
       # @note See: https://developers.sparkpost.com/api/#/reference/templates/create-and-list
       def create(values)
-        @client.call(:post, 'templates', values)
+        @client.call(method: :post, path: 'templates', body_values: values)
       end
 
       # Retrieve a Template by its ID
@@ -40,7 +40,7 @@ module SimpleSpark
       def retrieve(id, draft = nil)
         path = "templates/#{id}"
         query_params = draft.nil? ? {} : { draft: draft }
-        @client.call(:get, path, {}, query_params)
+        @client.call(method: :get, path: path, query_values: query_params)
       end
 
       # Update a Template by its ID
@@ -51,7 +51,7 @@ module SimpleSpark
       #
       # @note See: https://developers.sparkpost.com/api/#/reference/templates/update
       def update(id, values, update_published = false)
-        @client.call(:put, "templates/#{id}", values,  update_published: update_published)
+        @client.call(method: :put, path: "templates/#{id}", body_values: values,  query_values: { update_published: update_published })
       end
 
       # Preview a Template by its ID
@@ -65,7 +65,7 @@ module SimpleSpark
       # @note See: https://developers.sparkpost.com/api/#/reference/templates/preview
       def preview(id, substitutions, draft = nil)
         query_params = draft.nil? ? {} : { draft: draft }
-        @client.call(:post, "templates/#{id}/preview", substitutions, query_params)
+        @client.call(method: :post, path: "templates/#{id}/preview", body_values: substitutions, query_values: query_params)
       end
 
       # Delete a Template by its ID
@@ -73,7 +73,7 @@ module SimpleSpark
       #
       # @note See: https://developers.sparkpost.com/api/#/reference/templates/delete
       def delete(id)
-        @client.call(:delete, "templates/#{id}")
+        @client.call(method: :delete, path: "templates/#{id}")
       end
     end
   end

data/lib/simple_spark/endpoints/transmissions.rb

@@ -37,7 +37,7 @@ module SimpleSpark
       #   }
       def create(values, num_rcpt_errors = nil)
         query_params = num_rcpt_errors.nil? ? {} : { num_rcpt_errors: num_rcpt_errors }
-        @client.call(:post, 'transmissions', values, query_params)
+        @client.call(method: :post, path: 'transmissions', body_values: values, query_values: query_params)
       end
 
       # Sends an email message
@@ -50,7 +50,7 @@ module SimpleSpark
         query_params = {}
         query_params[:campaign_id] = campaign_id if campaign_id
         query_params[:template_id] = template_id if template_id
-        @client.call(:get, 'transmissions', {}, query_params)
+        @client.call(method: :get, path: 'transmissions', query_values: query_params)
       end
 
       # send_message to be reserved as a 'quick' helper method to avoid using hash for Create

data/lib/simple_spark/endpoints/webhooks.rb

@@ -15,14 +15,14 @@ module SimpleSpark
       # @note See: https://developers.sparkpost.com/api/#/reference/webhooks/list
       def list(timezone = nil)
         query_params = timezone.nil? ? {} : { timezone: timezone }
-        @client.call(:get, 'webhooks', {}, query_params)
+        @client.call(method: :get, path: 'webhooks', query_values: query_params)
       end
 
       # Create a webhook
       # @param values [Hash] the values to create the webhook with
       # @note See: https://developers.sparkpost.com/api/#/reference/webhooks/create
       def create(values)
-        @client.call(:post, 'webhooks', values)
+        @client.call(method: :post, path: 'webhooks', body_values: values)
       end
 
       # Retrieve details about a webhook by specifying its id
@@ -30,7 +30,7 @@ module SimpleSpark
       # @return [Hash] an Webhook hash object
       # @note See: https://developers.sparkpost.com/api/#/reference/webhooks/retrieve
       def retrieve(id)
-        @client.call(:get, "webhooks/#{id}")
+        @client.call(method: :get, path: "webhooks/#{id}")
       end
 
       # Update a Webhook by its ID
@@ -38,14 +38,14 @@ module SimpleSpark
       # @param values [Hash] the values to update the webhook with
       # @note See: https://developers.sparkpost.com/api/#/reference/webhooks/update-and-delete
       def update(id, values)
-        @client.call(:put, "webhooks/#{id}", values)
+        @client.call(method: :put, path: "webhooks/#{id}", body_values: values)
       end
 
       # Validates a Webhook by sending an example message event batch from the Webhooks API to the target URL
       # @param id [String] the ID of the webhook
       # @note See: https://developers.sparkpost.com/api/#/reference/webhooks/validate
       def validate(id)
-        @client.call(:post, "webhooks/#{id}/validate")
+        @client.call(method: :post, path: "webhooks/#{id}/validate")
       end
 
       # Batch status information
@@ -54,7 +54,7 @@ module SimpleSpark
       # @note See: https://developers.sparkpost.com/api/#/reference/webhooks/batch-status
       def batch_status(id, limit = nil)
         query_params = limit.nil? ? {} : { limit: limit }
-        @client.call(:get, "webhooks/#{id}/batch-status", {}, query_params)
+        @client.call(method: :get, path: "webhooks/#{id}/batch-status", query_values: query_params)
       end
 
       # Returns sample event data
@@ -63,14 +63,14 @@ module SimpleSpark
       # @note See: https://developers.sparkpost.com/api/#/reference/webhooks/events-samples
       def samples(events = nil)
         query_params = events.nil? ? {} : { events: events }
-        @client.call(:get, 'webhooks/events/samples', {}, query_params)
+        @client.call(method: :get, path: 'webhooks/events/samples', query_values: query_params)
       end
 
       # Delete a webhook
       # @param id [String] the ID
       # @note See: https://developers.sparkpost.com/api/#/reference/webhooks/update-and-delete
       def delete(id)
-        @client.call(:delete, "webhooks/#{id}")
+        @client.call(method: :delete, path: "webhooks/#{id}")
       end
     end
   end

data/lib/simple_spark/version.rb

@@ -1,3 +1,3 @@
 module SimpleSpark
-  VERSION = '0.0.4'
+  VERSION = '0.0.5'
 end

data/lib/simple_spark.rb

@@ -1,6 +1,7 @@
 require 'simple_spark/version'
 require 'simple_spark/client'
 require 'simple_spark/exceptions'
+require 'simple_spark/endpoints/metrics'
 require 'simple_spark/endpoints/transmissions'
 require 'simple_spark/endpoints/templates'
 require 'simple_spark/endpoints/inbound_domains'
@@ -8,4 +9,5 @@ require 'simple_spark/endpoints/sending_domains'
 require 'simple_spark/endpoints/message_events'
 require 'simple_spark/endpoints/webhooks'
 require 'simple_spark/endpoints/relay_webhooks'
+require 'simple_spark/endpoints/subaccounts'
 

data/spec/simple_spark/client_spec.rb

@@ -52,5 +52,46 @@ describe SimpleSpark::Client do
     it 'will raise when headers is not a Hash' do
       expect { SimpleSpark::Client.new(api_key: 'mykey', headers: 'wrong') }.to raise_error(SimpleSpark::Exceptions::InvalidConfiguration, 'The headers options provided must be a valid Hash')
     end
+
+    context 'endpoints' do
+      let(:client) { SimpleSpark::Client.new(api_key: 'mykey') }
+
+      context 'metrics' do
+        specify { expect(client.metrics.class).to eq(SimpleSpark::Endpoints::Metrics) }
+      end
+
+      context 'subaccounts' do
+        specify { expect(client.subaccounts.class).to eq(SimpleSpark::Endpoints::Subaccounts) }
+      end
+
+      context 'inbound_domains' do
+        specify { expect(client.inbound_domains.class).to eq(SimpleSpark::Endpoints::InboundDomains) }
+      end
+
+      context 'message_events' do
+        specify { expect(client.message_events.class).to eq(SimpleSpark::Endpoints::MessageEvents) }
+      end
+
+      context 'relay_webhooks' do
+        specify { expect(client.relay_webhooks.class).to eq(SimpleSpark::Endpoints::RelayWebhooks) }
+      end
+
+      context 'sending_domains' do
+        specify { expect(client.sending_domains.class).to eq(SimpleSpark::Endpoints::SendingDomains) }
+      end
+
+      context 'templates' do
+        specify { expect(client.templates.class).to eq(SimpleSpark::Endpoints::Templates) }
+      end
+
+      context 'transmissions' do
+        specify { expect(client.transmissions.class).to eq(SimpleSpark::Endpoints::Transmissions) }
+      end
+
+      context 'webhooks' do
+        specify { expect(client.webhooks.class).to eq(SimpleSpark::Endpoints::Webhooks) }
+      end
+
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simple_spark
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Jak Charlton
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-20 00:00:00.000000000 Z
+date: 2016-04-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -209,8 +209,10 @@ files:
 - lib/simple_spark/client.rb
 - lib/simple_spark/endpoints/inbound_domains.rb
 - lib/simple_spark/endpoints/message_events.rb
+- lib/simple_spark/endpoints/metrics.rb
 - lib/simple_spark/endpoints/relay_webhooks.rb
 - lib/simple_spark/endpoints/sending_domains.rb
+- lib/simple_spark/endpoints/subaccounts.rb
 - lib/simple_spark/endpoints/templates.rb
 - lib/simple_spark/endpoints/transmissions.rb
 - lib/simple_spark/endpoints/webhooks.rb