simple_spark 0.0.8 → 0.0.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 457e131ec0356d12efdfe669b4d9f13d506d5c5a
-  data.tar.gz: 8e2207f534f08403e3ac93e379287226f54c9a9b
+  metadata.gz: f1f14be82b033bbbd05c7bfb4c3879282de53136
+  data.tar.gz: bd7abf8bb57ece2b2f8f0a061ddb8ff74f9042e4
 SHA512:
-  metadata.gz: d19571e8b20e55511ce369c92661a20857a72a54781ec1edfd7f9c27201c8f0786f545c960c131008479f2f7763e39981cc545e11655ef09d5615003dc7e5c12
-  data.tar.gz: b975189f61b03f0757443bc200d65a8f8eba71ee3e11e76bff0539a8665a9266d20b06f33b19652c0e68fe13e3f389539b717db02e7cc2ee482a7133f3e3e987
+  metadata.gz: 511b77fb41792a9328990644edcdfe9c5ceb80b5fecd1d9b606bd42f428403d4a5d080ac8a255e242160ba8bd8b63e00848e3b3b65822b182d2eec483150d4b0
+  data.tar.gz: b39f9cbc6b11a8b4d1d503febaf35d3c5649550903479ed4326c351d49f6804bdc5ec53d8837a0593f4459679544d934d2aa912e6790f68a32895ea66d1f0925

data/README.md

@@ -72,6 +72,12 @@ Setting debug to true will cause [Excon](https://github.com/excon/excon) to outp
 
 This will default to true if you are running under Rails and are in a development environment, otherwise it will default to false (setting other values to nil will cause them to use their defaults)
 
+You can also pass a Logger into the client options to have SimpleSpark log there. By default Rails.logger will be used when runnign under Rails, and STDOUT will be used otherwise
+
+```ruby
+simple_spark = SimpleSpark::Client.new(api_key: 'your_api_key', debug: true, logger: Rails.logger)
+```
+
 #### Subaccounts
 
 By setting subaccount_id on your client you are telling Simple Spark to use that subaccount for all calls made on this instance of the client.
@@ -90,7 +96,7 @@ simple_spark = SimpleSpark::Client.new(api_key: 'your_api_key', headers: { 'NewS
 
 SimpleSpark wraps all the common errors from the SparkPost API
 
-If the API is unresponsive a GatewayTimeoutExceeded will be raised
+If the API takes too long to respond (times out in Excon) a GatewayTimeoutExceeded will be raised
 
 Status 400 raises Exceptions::BadRequest
 
@@ -102,6 +108,8 @@ Status 420 raises Exceptions::ThrottleLimitExceeded
 
 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
+
 ### Metrics
 
 #### Discoverability Links
@@ -703,13 +711,22 @@ simple_spark.templates.delete(yourtemplateid)
 
 ## Changelog
 
+### 0.0.9
+
+- Breaking change: 204 responses now return an empty hash t simplify consuming code
+- Added logging, if debug is set then SimpleSpark will log its options and calls in addition to Excon.
+
+### 0.0.8
+
+- Improved exception handling
+
 ### 0.0.7
 
-Added Time Series to Metrics
+- Added Time Series to Metrics
 
 ### 0.0.6
 
-Fixed accidental bug
+- Fixed accidental bug
 
 ### 0.0.5
 

data/lib/simple_spark/client.rb

@@ -1,9 +1,12 @@
 require 'rubygems'
 require 'excon'
 require 'json'
+require 'logger'
 
 module SimpleSpark
   class Client
+    attr_reader :logger
+
     def initialize(opts = {})
       @api_key = opts[:api_key] || ENV['SPARKPOST_API_KEY']
       @api_host = opts[:api_host] || 'https://api.sparkpost.com'
@@ -11,6 +14,8 @@ module SimpleSpark
       @subaccount_id = opts[:subaccount_id]
       @headers = opts[:headers]
 
+      @logger = opts[:logger] || SimpleSpark::Client.default_logger
+
       fail Exceptions::InvalidConfiguration.new, 'You must provide a SparkPost API key' unless @api_key
       fail Exceptions::InvalidConfiguration.new, 'You must provide a SparkPost API host' unless @api_host # this should never occur unless the default above is changed
       fail Exceptions::InvalidConfiguration.new, 'You must provide a SparkPost base path' unless @base_path # this should never occur unless the default above is changed
@@ -36,8 +41,21 @@ module SimpleSpark
       params = { path: path, headers: headers }
       params[:body] = body_values.to_json unless body_values.empty?
       params[:query] = query_params unless query_params.empty?
+
+      if @debug
+        logger.debug("Calling #{method}")
+        logger.debug(params)
+      end
+
       response = @session.send(method.to_s, params)
 
+      if @debug
+        logger.debug("Response #{response.status}")
+        logger.debug(response)
+      end
+
+      fail Exceptions::GatewayTimeoutExceeded('Received 504 from SparkPost API') if response.status == 504
+
       process_response(response, extract_results)
 
     rescue Excon::Errors::Timeout
@@ -45,14 +63,15 @@ module SimpleSpark
     end
 
     def process_response(response, extract_results)
-      return true if response.status == 204 || response.body.nil? || response.body == ''
+      logger.warn('Response had an empty body') if (response.body.nil? || response.body == '') && response.status != 204
+      return {} if response.status == 204 || response.body.nil? || response.body == ''
 
       response_body = JSON.parse(response.body)
       if response_body['errors']
         Exceptions::Error.fail_with_exception_for_status(response.status, response_body['errors'])
       else
         if extract_results
-          response_body['results'] ? response_body['results'] : true
+          response_body['results'] ? response_body['results'] : {}
         else
           response_body
         end
@@ -76,6 +95,12 @@ module SimpleSpark
       defaults
     end
 
+    def self.default_logger
+      logger = defined?(Rails) ? Rails.logger : Logger.new(STDOUT)
+      logger.progname = 'simple_spark'
+      logger
+    end
+
     def metrics
       Endpoints::Metrics.new(self)
     end

data/lib/simple_spark/version.rb

@@ -1,3 +1,3 @@
 module SimpleSpark
-  VERSION = '0.0.8'
+  VERSION = '0.0.10'
 end

metadata

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