simple_spark 1.0.4 → 1.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c2d4168cfad467ad86cb254fe01f6a17dcd3df92
-  data.tar.gz: bf14dc1293c65bdf3c7a7c4858dbf9ac4fe62acf
+  metadata.gz: d9d658ec10ada82c8d1923eef68a5a4063529801
+  data.tar.gz: 2be52f459b756448defdd33174fb16099a7a96e1
 SHA512:
-  metadata.gz: e3e3dba8c7f136987fbf9c697f608d7a8d1a748a14b663f164390179c2aab4cad6af0c8facf2ce74505d5a0d72e574eb793d3100a1bffca50de711337947cb9c
-  data.tar.gz: 06c246a18cdc54b6a3390b5e4fad8f54a78ff6ba7f51785c2443351bb5bb9a8feb98918045890373edabfe2567a05a1b57ab8ede7ceddd72d5367cdcddd72422
+  metadata.gz: 636cb92b6458d45736a125179fef0cbc66eaa82c3d4fa9d25d2a44af2dc6f6da8f974e26e464a69e220723c6f958a6ccc913bb2f2cec707a5df58b33c2b9df63
+  data.tar.gz: e6a60ed21f086e3d44935a20aa83962601ef4460a3af923907469b0298baacb78da2d085247192d23668760e0326944c1f62aba183410554774715af0c95905a

data/README.md

@@ -114,6 +114,39 @@ Other response status codes raise Exceptions::UnprocessableEntity
 
 In some cases it is possible to send too fast for the API (apparently) to handle , in this case the SparkPost API returns a 504 status with an empty body. This is raised by SimpleSpark as Exceptions::GatewayTimeoutExceeded
 
+### Account
+
+#### Retrieve account information
+
+```ruby
+simple_spark.account.retrieve
+```
+
+The argument can be specified in a comma separated list. The only valid value is currently usage.
+
+```ruby
+simple_spark.account.retrieve("usage")
+```
+
+<a href="https://developers.sparkpost.com/api/#/reference/account/retrieve-get" target="_blank">see SparkPost API Documentation</a>
+
+#### Update account information
+
+```ruby
+properties = {
+  company_name: "SparkPost",
+  options: {
+    smtp_tracking_default: true,
+    rest_tracking_default: true,
+    transactional_unsub: true,
+    transactional_default: true
+  }
+}
+simple_spark.account.update(properties)
+```
+
+<a href="https://developers.sparkpost.com/api/#/reference/account/update-put" target="_blank">see SparkPost API Documentation</a>
+
 ### Metrics
 
 #### Discoverability Links
@@ -308,6 +341,12 @@ properties[:content][:attachments] = [{ name: "attachment.txt", type: "text/plai
 simple_spark.transmissions.create(properties)
 ```
 
+#### Delete by campaign
+
+```ruby
+simple_spark.transmissions.delete_campaign("white-christmas")
+```
+
 <a href="https://developers.sparkpost.com/api/#/reference/transmissions/create" target="_blank">see SparkPost API Documentation</a>
 
 
@@ -599,17 +638,17 @@ simple_spark.suppression_list.create_or_update(params)
 Bulk update supression list entries
 
 ```ruby
-recipients = {
+recipients = [
   {
     recipient: "rcpt_1@example.com",
-    transactional: true,
+    type: "transactional",
     description: "User requested to not receive any transactional emails."
   },
   {
     recipient: "rcpt_2@example.com",
-    non_transactional: true
+    type: "non_transactional"
   }
-}
+]
 simple_spark.suppression_list.create_or_update(recipients)
 ```
 
@@ -768,6 +807,12 @@ simple_spark.templates.delete(yourtemplateid)
 
 ## Changelog
 
+### 1.0.5
+
+- Add Account API Endpoint
+- Add Delete Campaign
+- Bug fixes
+
 ### 1.0.4
 
 - Add Supression List Endpoint

data/lib/simple_spark/client.rb

@@ -104,6 +104,10 @@ module SimpleSpark
       logger
     end
 
+    def account
+      Endpoints::Account.new(self)
+    end
+
     def metrics
       Endpoints::Metrics.new(self)
     end

data/lib/simple_spark/endpoints/account.rb

@@ -0,0 +1,45 @@
+module SimpleSpark
+  module Endpoints
+    # Provides access to the /account endpoint
+    # @note See: https://developers.sparkpost.com/api/#/reference/account
+    class Account
+      attr_accessor :client
+
+      def initialize(client)
+        @client = client
+      end
+
+      # Get your SparkPost account information, including subscription status and quota usage.
+      # @param include_values [String] Additional parts of account details to include.
+      #   Multiple parts can be specified in a comma separated list.
+      #   The only valid value is currently usage and by default the usage details are not included.
+      # @return [Hash] an account information hash object
+      # @note See: https://developers.sparkpost.com/api/#/reference/account/retrieve-get
+      def retrieve(include_values = nil)
+        query_params = include_values.nil? ? {} : { include: include_values }
+        @client.call(method: :get, path: 'account', query_values: query_params)
+      end
+
+      # Update your SparkPost account information and account-level options.
+      # @param values [Hash] Request Body Attributes
+      #   company_name [String] company name
+      #   options [Hash] account-level options
+      #     smtp_tracking_default [Boolean] set to true to turn on SMTP engagement tracking by default
+      #     rest_tracking_default [Boolean] set to false to turn off REST API engagement tracking by default
+      #     transactional_unsub [Boolean] set to true to include List-Unsubscribe header for all transactional messages by default
+      #     transactional_default [Boolean] set to true to send messages as transactional by default
+      # @return { results: { message: "Account has been updated" } }
+      # @note See: https://developers.sparkpost.com/api/#/reference/account/update-put
+      # @note Example:
+      #   values = {
+      #     company_name: "SparkPost",
+      #     options: {
+      #       smtp_tracking_default: true
+      #     }
+      #   }
+      def update(values = {})
+        @client.call(method: :put, path: 'account', body_values: values)
+      end
+    end
+  end
+end

data/lib/simple_spark/endpoints/transmissions.rb

@@ -52,6 +52,14 @@ module SimpleSpark
         query_params[:template_id] = template_id if template_id
         @client.call(method: :get, path: 'transmissions', query_values: query_params)
       end
+      
+      # Deletes all transmissions for a given campaign
+      # @param campaign_id [String] specifies the campaign to delete transmissions for
+      # @returns empty string
+      # @note Endpoint returns empty response body with 204 status code
+      def delete_campaign(campaign_id)
+        @client.call(method: :delete, path: 'transmissions', query_values: { campaign_id: campaign_id })
+      end
 
       # send_message to be reserved as a 'quick' helper method to avoid using hash for Create
       # alias_method :send_message, :create

data/lib/simple_spark/version.rb

@@ -1,3 +1,3 @@
 module SimpleSpark
-  VERSION = '1.0.4'
+  VERSION = '1.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/account'
 require 'simple_spark/endpoints/metrics'
 require 'simple_spark/endpoints/transmissions'
 require 'simple_spark/endpoints/templates'

data/spec/simple_spark/client_spec.rb

@@ -56,6 +56,10 @@ describe SimpleSpark::Client do
     context 'endpoints' do
       let(:client) { SimpleSpark::Client.new(api_key: 'mykey') }
 
+      context 'account' do
+        specify { expect(client.account.class).to eq(SimpleSpark::Endpoints::Account) }
+      end
+
       context 'metrics' do
         specify { expect(client.metrics.class).to eq(SimpleSpark::Endpoints::Metrics) }
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simple_spark
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.0.5
 platform: ruby
 authors:
 - Jak Charlton
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-02 00:00:00.000000000 Z
+date: 2017-03-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -67,6 +67,7 @@ files:
 - Rakefile
 - lib/simple_spark.rb
 - lib/simple_spark/client.rb
+- lib/simple_spark/endpoints/account.rb
 - lib/simple_spark/endpoints/inbound_domains.rb
 - lib/simple_spark/endpoints/message_events.rb
 - lib/simple_spark/endpoints/metrics.rb
@@ -103,7 +104,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.6.7
 signing_key: 
 specification_version: 4
 summary: A library for accessing the SparkPost REST API http://www.sparkpost.com