simple_spark 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8dc5b026632213e5e88bc3e7c4260ce79ba4184a
-  data.tar.gz: 0beacfa2100f3a4a9419104e271983383780a4ea
+  metadata.gz: 16ba8873c00d42cecd527635b7f551c03e357080
+  data.tar.gz: 5c2d0465090b9d068ed1761879b05a46871722f5
 SHA512:
-  metadata.gz: 2cb764d5b04dba18a6641994dd9235c7f71984b2b8d1ae664b0ab4b378d0dd41022c90ddf267932f6a40da6cce91c4253f4c0bef60de0a601002049d99a3421e
-  data.tar.gz: faeef41ea69b60c34a7e7c9febc6e4c820ff10348f757e7a77b37a1894a96b00677e9c72b981e41f2560f4052dd6aca7b931bac24008b360ed4a163829578870
+  metadata.gz: 639c9ad49a6277585ce70ccb4dd19b5369d2c5f98cc2872539348305c3c0e1160586c0df18c09b26bd6789a6e0f01fdbbbd34cfb8f6fd1cbf38b065ffff367c5
+  data.tar.gz: 9864262d473c0a460a85fe8580160060feeb2a8bb382d50b142268b7490c62b491219f2527761aca101edbed9c51588104a5c05ea444ba6dce1d6f0bce64b35e

data/README.md

@@ -35,8 +35,7 @@ The official gem currently only supports the send_message (create) method of /tr
 
 ### Status
 
-It's day one, and it's a day one project.
-
+Breaking change: initialising the client is now done with a hash instead of with ordered parameters, as there were getting to be too many after supporting Subaccounts and user specified headers
 
 ## Endpoints
 
@@ -51,7 +50,7 @@ require 'simple_spark'
 The simplest version of the client is to just provide your [API key from SparkPost](https://app.sparkpost.com/account/credentials)
 
 ```ruby
-simple_spark = SimpleSpark::Client.new('your_api_key')
+simple_spark = SimpleSpark::Client.new(api_key: 'your_api_key')
 ```
 
 You can also use ENV vars to configure the key, setting ENV['SPARKPOST_API_KEY'] will allow you to just use
@@ -63,15 +62,27 @@ simple_spark = SimpleSpark::Client.new
 You can also override the other options if you need to in advanced scenarios, the full signature is (api_key, api_host, base_path, debug), i.e.
 
 ```ruby
-simple_spark = SimpleSpark::Client.new('your_api_key', 'https://api.sparkpost.com',  '/api/v1/', false)
+simple_spark = SimpleSpark::Client.new(api_key: 'your_api_key', api_host: 'https://api.sparkpost.com',  base_path: '/api/v1/', debug: false, subaccount_id: 'my_subaccount')
 ```
 
-Setting debug to true will cause [Excon](https://github.com/excon/excon) to output full debug information to the log, to default the other values and just set debug, send nil values
+#### Debug
+
+Setting debug to true will cause [Excon](https://github.com/excon/excon) to output full debug information to the log.
 
 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)
 
+#### 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.
+
+Not all Sparkpost calls support the Subaccount feature, and their API will throw an unauthorized error if you use a subaccount_id on an unsupported call. Depending on your code this may mean you need to instantiate two instances of the Simple Spark client in your code, one for subaccount calls, and one for other calls. This is a less than ideal solution, but due to the rapid pace of Sparkpost development on their API this is the option that causes least dependency up Simple Spark to be updated as their API is.
+
+#### Headers
+
+Should you have any need to override the headers that are sent by default, then you can specify headers as an option. The headers specified here will override any of the generated headers that the library creates. In normal operation there should be no reason to use this option, but it is provided for convenience and to allow for Sparkpost updating their API in any unexpected way.
+
 ```ruby
-simple_spark = SimpleSpark::Client.new(nil, nil, nil, true)
+simple_spark = SimpleSpark::Client.new(api_key: 'your_api_key', headers: { 'NewSparkpostHeader' => 'hello'})
 ```
 
 ### Transmissions

data/lib/simple_spark/client.rb

@@ -4,26 +4,30 @@ require 'json'
 
 module SimpleSpark
   class Client
-    def initialize(api_key = nil, api_host = 'https://api.sparkpost.com', base_path = '/api/v1/', debug = nil)
-      @api_key = api_key || ENV['SPARKPOST_API_KEY']
-      @api_host = api_host || 'https://api.sparkpost.com'
-      @base_path = base_path || '/api/v1/'
+    def initialize(options = {})
+      @api_key = options[:api_key] || ENV['SPARKPOST_API_KEY']
+      @api_host = options[:api_host] || 'https://api.sparkpost.com'
+      @base_path = options[:base_path] || '/api/v1/'
+      @subaccount_id = options[:subaccount_id]
+      @headers = options[:headers]
 
       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
+      fail Exceptions::InvalidConfiguration.new, 'The headers options provided must be a valid Hash' if @headers && !@headers.is_a?(Hash)
 
       rails_development = !(defined?(Rails) && Rails.env.development?).nil?
 
-      @debug = debug.nil? ? rails_development : debug
+      @debug = options[:debug].nil? ? rails_development : options[:debug]
+
       @session = Excon.new(@api_host, debug: @debug)
     end
 
     def call(method, path, body_values = {}, query_params = {})
-      fail Exceptions::InvalidConfiguration.new({ method: method }), 'Only GET, POST, PUT and DELETE are supported' unless [:get, :post, :put, :delete].include?(method)
+      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}"
-      params = { path: path, headers: default_headers }
+      params = { path: path, headers: headers }
       params[:body] = body_values.to_json unless body_values.empty?
       params[:query] = query_params unless query_params.empty?
       response = @session.send(method.to_s, params)
@@ -44,15 +48,19 @@ module SimpleSpark
 
     # Copied from http://apidock.com/ruby/ERB/Util/url_encode
     def url_encode(s)
-      s.to_s.dup.force_encoding("ASCII-8BIT").gsub(/[^a-zA-Z0-9_\-.]/) { sprintf("%%%02X", $&.unpack("C")[0]) }
+      s.to_s.dup.force_encoding('ASCII-8BIT').gsub(/[^a-zA-Z0-9_\-.]/) { sprintf('%%%02X', $&.unpack('C')[0]) }
     end
 
-    def default_headers
-      {
+    def headers
+      defaults = {
         'User-Agent' => 'simple_spark/' + VERSION,
         'Content-Type' => 'application/json',
+        'Accept' => 'application/json',
         'Authorization' => @api_key
       }
+      defaults.merge!('X-MSYS-SUBACCOUNT' => @subaccount_id) if @subaccount_id
+      defaults.merge!(@headers) if @headers
+      defaults
     end
 
     def inbound_domains

data/lib/simple_spark/version.rb

@@ -1,3 +1,3 @@
 module SimpleSpark
-  VERSION = "0.0.2"
+  VERSION = '0.0.3'
 end

data/spec/simple_spark/client_spec.rb

@@ -7,12 +7,13 @@ describe SimpleSpark::Client do
     end
 
     context 'defaults' do
-      let(:client) { SimpleSpark::Client.new('mykey') }
+      let(:client) { SimpleSpark::Client.new(api_key: 'mykey') }
       specify { expect(client.instance_variable_get(:@api_key)).to eq('mykey') }
       specify { expect(client.instance_variable_get(:@api_host)).to eq('https://api.sparkpost.com') }
       specify { expect(client.instance_variable_get(:@base_path)).to eq('/api/v1/') }
       specify { expect(client.instance_variable_get(:@session).class).to eq(Excon::Connection) }
       specify { expect(client.instance_variable_get(:@debug)).to eq(false) }
+      specify { expect(client.instance_variable_get(:@subaccount_id)).to eq(nil) }
     end
 
     it 'will use the API key from the ENV var' do
@@ -22,11 +23,34 @@ describe SimpleSpark::Client do
     end
 
     it 'will use the base_path provided' do
-      expect(SimpleSpark::Client.new('mykey', nil, 'base').instance_variable_get(:@base_path)).to eq('base')
+      expect(SimpleSpark::Client.new(api_key: 'mykey', base_path: 'base').instance_variable_get(:@base_path)).to eq('base')
     end
 
     it 'will use the debug option provided' do
-      expect(SimpleSpark::Client.new('mykey', nil, nil, true).instance_variable_get(:@debug)).to eq(true)
+      expect(SimpleSpark::Client.new(api_key: 'mykey', debug: true).instance_variable_get(:@debug)).to eq(true)
+    end
+
+    context 'using the subaccount id provided' do
+      let(:subaccount_id) { 'my_subaccount_id' }
+      let(:client) { SimpleSpark::Client.new(api_key: 'mykey', subaccount_id: subaccount_id) }
+      specify { expect(client.instance_variable_get(:@subaccount_id)).to eq(subaccount_id) }
+      specify { expect(client.headers).to include('X-MSYS-SUBACCOUNT' => subaccount_id) }
+    end
+
+    context 'using the headers option provided' do
+      let(:headers) { { x: 'y' } }
+      let(:client) { SimpleSpark::Client.new(api_key: 'mykey', headers: headers) }
+      specify { expect(client.instance_variable_get(:@headers)).to eq(headers) }
+      specify { expect(client.headers).to include(headers) }
+
+      it 'specified headers will override default constructed ones' do
+        client = SimpleSpark::Client.new(api_key: 'mykey', subaccount_id: 'old', headers: { 'X-MSYS-SUBACCOUNT' => 'new' })
+        expect(client.headers['X-MSYS-SUBACCOUNT']).to eq('new')
+      end
+    end
+
+    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
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simple_spark
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Jak Charlton
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-14 00:00:00.000000000 Z
+date: 2016-04-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -246,3 +246,4 @@ summary: A library for accessing the SparkPost REST API http://www.sparkpost.com
 test_files:
 - spec/simple_spark/client_spec.rb
 - spec/spec_helper.rb
+has_rdoc: