peat 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a6458716c3b767d619513a812ae31734feb46cb2
-  data.tar.gz: 3c44d3b47f367d2150d2764df01c2b6c5b5ec343
+  metadata.gz: f18ccc9a6d39e4fc1bbdabd00d66ec9f3f3dc952
+  data.tar.gz: 865c919192a754f7e8722e1ce46a43032d28742e
 SHA512:
-  metadata.gz: e88ead8d052a1622ba6da04fb9de2360785c7bfdc84701e8c43a76a844a5f8a693ec0f3a24f21dbbaf8987d533a696a8f96f1ef7562b4eccc73f1e1d8650f1b7
-  data.tar.gz: 140a8380a08b6be8ee390642cba400e86d44709647e0221495733587839b71ed7fc418a45faf6bfe4f7a65e113d368457479fe527ead4fce2fd15d8c18d4e9bf
+  metadata.gz: 94752332abb63450259015db70bd8a35dc13071a94328540ff4c929e3f0663c8e7ec8536ca52952570f33bb13ce06e5227004932419fd8c80ac8ad0f59876240
+  data.tar.gz: 6ef7118062f556d5570cce0af88a9dc3c7ab0be1c85d526f4ef308b04f2016fcb1d9bb1612328e544d8d92c7a1b453f38b94a220a54b39dece696dd898cf6298

data/README.md

@@ -56,9 +56,38 @@ mail_params = {
     }
   }
 }
-peat_client = Peat::Client.deliver('name_of_my_triggered_send', mail_params)
+
+# simple one-off send
+Peat::Client.deliver('name_of_my_triggered_send', mail_params)
+```
+
+You can also initiate a client to use throughout:
+
+```
+peat_client = Peat::Client.new
+peat_client.deliver('name_of_triggered_send', maii_params)
 ```
 
+## Advanced Usage
+
+Peat is built on top of Faraday and gives you the ability to 
+customize the adapter, as well as insert faraday middleware 
+to be used when making the request to Exact Target.
+
+```
+class MyAwesomeMiddleware < Faraday::Middleware
+  def call(env)
+    ...
+  end
+end
+
+peat_client = Peat::Client.new(middleware: [MyAwesomeMiddleware], adapter: :net_http_persistent)
+peat_client.deliver('name_of_triggered_send', maii_params)
+```
+
+Middleware are inserted in the order they are specified. By default,
+the json middlware and the Net::HTTP adapter are used.
+
 ## Contributing
 
 1. Fork it 

data/lib/peat/client.rb

@@ -1,6 +1,10 @@
 module Peat
   class Client
 
+    def self.deliver(triggered_send, params)
+      new.deliver(triggered_send, params)
+    end
+
     def initialize(middleware: [], adapter: Faraday.default_adapter)
       @middleware = middleware
       @adapter = adapter

data/lib/peat/version.rb

@@ -1,3 +1,3 @@
 module Peat
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/spec/client_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+
+module Peat
+  describe Client do
+    before do
+      FooMiddleware = Class.new(Faraday::Middleware) do
+        def call(req_env)
+          @app.call(req_env).on_complete do |resp_env|
+            resp_env.status = 200
+          end
+        end
+      end
+    end
+
+    describe '.deliver' do
+      it 'proxies calls to peat client' do
+        VCR.use_cassette 'peat' do
+          expect(Peat::Client.deliver(:foo, {})).to be_falsey
+        end
+      end
+    end
+
+    describe '#deliver' do
+      it 'allows configuration of middleware' do
+        client = Peat::Client.new(middleware: [FooMiddleware])
+        VCR.use_cassette 'peat' do
+          expect(client.deliver!(:foo, {})).to be_truthy
+        end
+      end
+
+      it 'defaults to no middleware' do
+        client = Peat::Client.new
+        VCR.use_cassette 'peat' do
+          expect { client.deliver!(:foo, {}) }.to raise_exception Peat::DeliveryFailed
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+require 'vcr'
+VCR.configure do |c|
+  c.cassette_library_dir = 'spec/vcr_cassettes'
+  c.hook_into :webmock # or :fakeweb
+  #c.allow_http_connections_when_no_cassette = true
+  c.default_cassette_options = {
+    match_requests_on: [:method, :path],
+    allow_playback_repeats: true,
+  }
+end
+
+require 'faraday_middleware'
+
+require 'peat'

data/spec/vcr_cassettes/peat.yml

@@ -0,0 +1,51 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://www.exacttargetapis.com/messaging/v1/messageDefinitionSends/key:foo/send
+    body:
+      encoding: UTF-8
+      string: "{}"
+    headers:
+      User-Agent:
+      - Faraday v0.9.1
+      Content-Type:
+      - application/json
+      Authorization:
+      - Bearer valid
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 401
+      message: Unauthorized
+    headers:
+      Content-Type:
+      - application/json
+      Date:
+      - Tue, 28 Jul 2015 21:59:00 GMT
+      Server:
+      - Mashery Proxy
+      Www-Authenticate:
+      - Bearer realm="www.exacttargetapis.com", error="invalid_token"
+      X-Error-Detail-Header:
+      - Not Authorized
+      X-Mashery-Error-Code:
+      - ERR_403_NOT_AUTHORIZED
+      X-Mashery-Message-Id:
+      - 74bd23c8-a58c-4b39-94d6-2ce55be02b06
+      X-Mashery-Responder:
+      - prod-j-worker-us-west-1c-47.mashery.com
+      Content-Length:
+      - '110'
+      Connection:
+      - keep-alive
+    body:
+      encoding: UTF-8
+      string: '{"documentation":"https://code.docs.exacttarget.com/rest/errors/403","errorcode":0,"message":"Not
+        Authorized"}'
+    http_version: 
+  recorded_at: Tue, 28 Jul 2015 21:59:01 GMT
+recorded_with: VCR 2.9.3

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: peat
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Hubert Huang
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-28 00:00:00.000000000 Z
+date: 2015-08-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -111,7 +111,10 @@ files:
 - lib/peat/token_manager.rb
 - lib/peat/version.rb
 - peat.gemspec
+- spec/client_spec.rb
+- spec/spec_helper.rb
 - spec/token_manager_spec.rb
+- spec/vcr_cassettes/peat.yml
 homepage: ''
 licenses:
 - MIT
@@ -137,4 +140,7 @@ signing_key:
 specification_version: 4
 summary: Wrapper for the Exact Target fuel api
 test_files:
+- spec/client_spec.rb
+- spec/spec_helper.rb
 - spec/token_manager_spec.rb
+- spec/vcr_cassettes/peat.yml