exact_target_rest 0.1.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fa84ba5f3df0a1fd9a95147ed0bfcc378160bed0
-  data.tar.gz: b22021bcd6e34c42d3b678932a49c165edc4e349
+  metadata.gz: c619daa30b70dc6807b0e57e95de854633bc4328
+  data.tar.gz: 70f5940d63176afbc6550e3fef3983f081af6913
 SHA512:
-  metadata.gz: a197fe64b7a0665b28e4d361f21282825fe9a77fb29a9d3c2507320b39abdd4e18cd46e9fc11b4d291bc1bdb0a432ac46f6789b580ff087ce840f45c7819d15c
-  data.tar.gz: 3a486c16b1e098904fa4c02537070eafaeb2d6c509a57434401e5bbcf69153c087282a7a21a6db12a339fe4cb94739f1966db29fced5f125f2ffad77d0c43dc2
+  metadata.gz: c9b75e3fa94e08c19ce0f7d673e35fb9ada526ab47069e7286345a68ecaeada3d7ccdc27956855f047e7bbdaf6b78897efa189de35f614cb301cba9f0c3c2864
+  data.tar.gz: a6a468e7313dc448b20888e8f15250fff7a9936947b45a10f2db1b9921d61af277112b827b4219f0551e4d0fbba99d51ece0854b99f606e166d89fbec2928881

data/README.md

@@ -34,22 +34,57 @@ auth = ExactTargetRest::Authorization.new(client_id, client_secret)
 
 ### TriggeredSend Activation
 
+There are two ways to use.
+
+The first calls `send_one` and receives DataExtensions as parameters:
+
 ```ruby
 external_key = 'My TriggeredSend External Key'
 ts = ExactTargetRest::TriggeredSend.new(auth, external_key)
 ts.send_one(email_address: 'uga@kabuga.com', an_attribute: 'XXX', another_attribute: 'YYY')
 ```
 
-**email_address** is mandatory, any other field will be put in the DataExtension (or List) associated with the TriggeredSend. You can also pass "subscriber_key" as parameter, if absent, it will use the value in "email_address" as default value.
-
-All other attributes will be converted to CamelCase (ExactTarget convention) before send. So, "an_attribute" and "another_attribute" would become "AnAttribute" and "AnotherAttribute".
+**email_address** is mandatory, any other field will be put in the DataExtension (or List) associated with the TriggeredSend. You can also pass **subscriber_key** as parameter, if absent, it will use the value in **email_address** as default value.
 
-If you don't want this behavior, pass the flag "snake\_to\_camel: false" in the constructor:
+In first example, with method `send_one`, all other attributes will be converted to CamelCase (ExactTarget convention) before send. So, **an_attribute** and **another_attribute** would become "AnAttribute" and "AnotherAttribute". If you don't want this behavior, pass the flag "snake\_to\_camel: false" in the constructor:
 
 ```ruby
 ts = ExactTargetRest::TriggeredSend.new(auth, external_key, snake_to_camel: false)
 ```
 
+The second way helps in two situations:
+
+- If you have DataExtension's keys with spaces or any unusual pattern
+
+```ruby
+external_key = 'My TriggeredSend External Key'
+ts = ExactTargetRest::TriggeredSend.new(auth, external_key)
+ts.with_options(email_address: 'uga@kabuga.com', subscriber_attributes: { 'An Attribute' => 'XXX', 'Another_Attribute' => 'YYY' }).deliver
+```
+
+- if you have to call the api asynchronously
+
+```ruby
+def deliver
+  external_key = 'My TriggeredSend External Key'
+  triggered_send = ExactTargetRest::TriggeredSend.new(auth, external_key)
+  triggered_send.with_options(email_address: 'uga@kabuga.com')
+
+  Worker.perform_async(triggered_send.to_yaml)
+end
+
+class Worker
+  include Sidekiq::Worker
+
+  sidekiq_options queue: :exact_target_mailer
+
+  def perform(triggered_send)
+    YAML::load(triggered_send).deliver
+  end
+end
+
+```
+
 ### DataExtension Upsert
 
 ```ruby

data/exact_target_rest.gemspec

@@ -25,4 +25,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'guard-rspec', '~> 4.5'
   spec.add_development_dependency 'pry', '~> 0.10'
+  spec.add_development_dependency 'pry-byebug', '~> 3.4.0'
+  spec.add_development_dependency 'webmock', '~> 2.1.0'
 end

data/lib/exact_target_rest/authorization.rb

@@ -21,20 +21,13 @@ module ExactTargetRest
     #
     # @yield [access_token] Block to be executed
     # @yieldparam access_token [String] Access token used to authorize a request
+    # @yieldparam expires_in [String] Time to token's expire
     def with_authorization
       authorize! unless authorized?
-      tries = 1
-      begin
-        yield @access_token
-      rescue NotAuthorizedError
-        authorize!
-        tries -= 1
-        retry if tries >= 0
-      end
-
+      yield @access_token
     end
 
-    # Execute authorization and keeps an access token
+    # Execute authorization, keeps an access token and returns the result
     def authorize!
       resp = endpoint.post do |p|
         p.body = {clientId: @client_id,
@@ -43,14 +36,15 @@ module ExactTargetRest
       if resp.success?
         @access_token = resp.body['accessToken']
         @expires_in = Time.now + resp.body['expiresIn']
+        { access_token: @access_token, expires_in: @expires_in }
       else
-        fail resp.body.inspect
+        fail NotAuthorizedError
       end
     end
 
     # Already authorized and NOT expired?
     def authorized?
-      @access_token && @expires_in < Time.now
+      @access_token && @expires_in > Time.now
     end
 
     protected
@@ -63,4 +57,4 @@ module ExactTargetRest
       end
     end
   end
-end
+end

data/lib/exact_target_rest/data_extension.rb

@@ -42,4 +42,4 @@ module ExactTargetRest
       end
     end
   end
-end
+end

data/lib/exact_target_rest/triggered_send.rb

@@ -12,28 +12,81 @@ module ExactTargetRest
     end
 
     # TriggeredSend for just one subscriber.
-    #
-    # @param email_address [String] Email to send.
+    # @param to_address [String] Email to send.
     # @param subscriber_key [String] SubscriberKey (it uses Email if not set).
     # @param data_extension_attributes [{Symbol => Object}] List of attributes (in snake_case)
     #   that will be used in TriggeredSend and will be saved in related DataExtension
     #   (in CamelCase).
-    def send_one(email_address:, subscriber_key: email_address, ** data_extension_attributes)
+    def send_one(
+      email_address:,
+      subscriber_key: email_address,
+      ** data_extension_attributes
+      )
+      with_options(
+        email_address: email_address,
+        subscriber_key: subscriber_key,
+        subscriber_attributes: prepare_attributes(data_extension_attributes)
+      ).deliver
+    end
+
+    # Load attributes and return "self". To send using async methods.
+    # @param request_type [String] ASYNC or SYNC.
+    # @param to_address [String] Email to send.
+    # @param subscriber_key [String] SubscriberKey.
+    # => it uses Email if not set
+    # @param from_address [String] Sender email address.
+    # @param from_name [String] Sender name.
+    # @param subscriber_attributes [{String => String, ...}] List of attributes
+    # => Keys as Strings (when your ExactTarget's fields doesn't have a pattern)
+    def with_options(
+      request_type: "ASYNC",
+      email_address:,
+      subscriber_key: email_address,
+      from_address: "",
+      from_name: "",
+      subscriber_attributes: {}
+      )
+      @request_type = request_type
+      @email_address = email_address
+      @subscriber_key = subscriber_key
+      @from_address = from_address
+      @from_name = from_name
+      @subscriber_attributes = subscriber_attributes
+
+      self
+    end
+
+    # TriggeredSend with loaded attributes.
+    def deliver
+      tries ||= 1
       @authorization.with_authorization do |access_token|
         resp = endpoint.post do |p|
           p.url(format(TRIGGERED_SEND_PATH, URI.encode(@external_key)))
           p.headers['Authorization'] = "Bearer #{access_token}"
-          p.body = {To: {
-              Address: email_address,
-              SubscriberKey: subscriber_key,
+          p.body = {
+            From: {
+              Address: @from_address,
+              Name: @from_name
+            },
+            To: {
+              Address: @email_address,
+              SubscriberKey: @subscriber_key,
               ContactAttributes: {
-                  SubscriberAttributes: prepare_attributes(data_extension_attributes)
+                  SubscriberAttributes: @subscriber_attributes
               }
-          }}
+            },
+            OPTIONS: {
+              RequestType: @request_type
+            }
+          }
         end
         raise NotAuthorizedError if resp.status == 401
         resp
       end
+    rescue NotAuthorizedError
+      tries -= 1
+      retry if tries >= 0
+      raise NotAuthorizedError
     end
 
     protected
@@ -50,4 +103,4 @@ module ExactTargetRest
       @snake_to_camel ? attributes.snake_to_camel : attributes
     end
   end
-end
+end

data/lib/exact_target_rest/version.rb

@@ -1,3 +1,3 @@
 module ExactTargetRest
-  VERSION = '0.1.1'
+  VERSION = '0.2.2'
 end

data/spec/lib/exact_target_rest/authorization_spec.rb

@@ -0,0 +1,73 @@
+require 'spec_helper'
+
+describe Authorization do
+
+  let(:client_id) { "12345" }
+  let(:client_secret) { "Y9axRxR9bcvSW2cc0IwoWeq7" }
+  let(:expires_in) { 3600 }
+
+  let(:access_token) { "75sf4WWbwfr6HYd5URpC6KBk" }
+
+  subject do
+    described_class
+  end
+
+  before do
+    stub_requests
+  end
+
+  describe '#with_authorization' do
+    it "returns a valid authorization" do
+      subject.new(client_id, client_secret).with_authorization do |access_token|
+        expect(access_token).to eq access_token
+      end
+    end
+
+    it "returns Unauthorized" do
+      expect {
+        subject.new("invalid", client_secret).with_authorization
+      }.to raise_error NotAuthorizedError
+    end
+  end
+
+  describe '#authorize!' do
+    it "returns a valid authorization" do
+      auth = subject.new(client_id, client_secret).authorize!
+
+      expect(auth[:access_token]).to eq access_token
+      expect(auth[:expires_in]).not_to be_nil
+    end
+
+    it "returns Unauthorized" do
+      expect {
+        subject.new("invalid", client_secret).authorize!
+      }.to raise_error NotAuthorizedError
+    end
+  end
+
+  private
+
+  def stub_requests
+    stub_request(:post, "https://auth.exacttargetapis.com/v1/requestToken").
+      with(
+        :body => "{\"clientId\":\"12345\",\"clientSecret\":\"Y9axRxR9bcvSW2cc0IwoWeq7\"}",
+        :headers => {'Accept'=>'*/*', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'Content-Type'=>'application/json', 'User-Agent'=>'Faraday v0.9.2'}
+        ).
+      to_return(
+        headers: {"Content-Type"=> "application/json"},
+        body: %({"accessToken": "#{access_token}", "expiresIn": 3600}),
+        status: 200
+      )
+
+    stub_request(:any, ExactTargetRest::AUTH_URL).
+      with(
+        :body => "{\"clientId\":\"invalid\",\"clientSecret\":\"Y9axRxR9bcvSW2cc0IwoWeq7\"}",
+        :headers => {'Accept'=>'*/*', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'Content-Type'=>'application/json', 'User-Agent'=>'Faraday v0.9.2'}
+        ).
+      to_return(
+        headers: {"Content-Type"=> "application/json"},
+        body: %({"message": "Unauthorized","errorcode": 1,"documentation": ""}),
+        status: 401
+      )
+  end
+end

data/spec/lib/exact_target_rest/triggered_send_spec.rb

@@ -0,0 +1,119 @@
+require 'spec_helper'
+
+describe TriggeredSend do
+
+  let(:external_key) { "12345" }
+  let(:access_token) { "Y9axRxR9bcvSW2cc0IwoWeq7" }
+  let(:expires_in) { 3600 }
+
+  subject do
+    authorization = instance_double("ExactTargetRest::Authorization")
+    allow(authorization).to receive(:with_authorization).and_yield(access_token)
+    described_class.new(authorization,external_key)
+  end
+
+  before do
+    stub_requests
+  end
+
+  describe '#send_one' do
+    it "sends a simple TriggeredSend" do
+      response = subject.send_one(email_address: "jake@oo.com")
+      expect(response.body["requestId"]).to eq "simple-response-id"
+    end
+
+    it "sends a TriggeredSend with DataExtension" do
+      response = subject.send_one(
+        email_address: "jake@oo.com",
+        city: "São Paulo",
+        zip: "04063-040"
+        )
+      expect(response.body["requestId"]).to eq "data-extension-response-id"
+    end
+  end
+
+  describe '#deliver' do
+    it "sends a simple TriggeredSend" do
+      response = subject.with_options(email_address: "jake@oo.com").deliver
+      expect(response.body["requestId"]).to eq "simple-response-id"
+    end
+
+    it "sends a TriggeredSend with DataExtension" do
+      response = subject.with_options(
+        email_address: "jake@oo.com",
+        subscriber_attributes: { City: "São Paulo", Zip: "04063-040" }
+        ).deliver
+      expect(response.body["requestId"]).to eq "data-extension-response-id"
+    end
+
+    it "sends a TriggeredSend with a DataExtension's key with spaces" do
+      response = subject.with_options(
+        email_address: "jake@oo.com",
+        subscriber_attributes: { "City" => "São Paulo", "Profile ID" => "42" }
+        ).deliver
+      expect(response.body["requestId"]).to eq "uncommon-key-response-id"
+    end
+
+  end
+
+  private
+
+  def stub_requests
+    stub_request(:any, ExactTargetRest::AUTH_URL).
+      to_return(
+        headers: {"Content-Type"=> "application/json"},
+        body: %({"accessToken": "75sf4WWbwfr6HYd5URpC6KBk", "expiresIn": 3600}),
+        status: 200
+      )
+
+    stub_request(:post, triggered_send_url).
+      with(
+        :body => "{\"From\":{\"Address\":\"\",\"Name\":\"\"},\"To\":{\"Address\":\"jake@oo.com\",\"SubscriberKey\":\"jake@oo.com\",\"ContactAttributes\":{\"SubscriberAttributes\":{\"City\":\"São Paulo\",\"Zip\":\"04063-040\"}}},\"OPTIONS\":{\"RequestType\":\"ASYNC\"}}",
+        :headers => {'Accept'=>'*/*', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'Authorization'=>"Bearer #{access_token}", 'Content-Type'=>'application/json', 'User-Agent'=>'Faraday v0.9.2'}
+      ).
+      to_return(
+        headers: {"Content-Type"=> "application/json"},
+        body: stub_response("data-extension-response-id"),
+        status: 202
+      )
+
+    stub_request(:post, triggered_send_url).
+      with(
+        :body => "{\"From\":{\"Address\":\"\",\"Name\":\"\"},\"To\":{\"Address\":\"jake@oo.com\",\"SubscriberKey\":\"jake@oo.com\",\"ContactAttributes\":{\"SubscriberAttributes\":{\"City\":\"São Paulo\",\"Profile ID\":\"42\"}}},\"OPTIONS\":{\"RequestType\":\"ASYNC\"}}",
+        :headers => {'Accept'=>'*/*', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'Authorization'=>"Bearer #{access_token}", 'Content-Type'=>'application/json', 'User-Agent'=>'Faraday v0.9.2'}
+      ).
+      to_return(
+        headers: {"Content-Type"=> "application/json"},
+        body: stub_response("uncommon-key-response-id"),
+        status: 202
+      )
+
+    stub_request(:post, triggered_send_url).
+      with(
+        :body => "{\"From\":{\"Address\":\"\",\"Name\":\"\"},\"To\":{\"Address\":\"jake@oo.com\",\"SubscriberKey\":\"jake@oo.com\",\"ContactAttributes\":{\"SubscriberAttributes\":{}}},\"OPTIONS\":{\"RequestType\":\"ASYNC\"}}",
+        :headers => {'Accept'=>'*/*', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'Authorization'=>"Bearer #{access_token}", 'Content-Type'=>'application/json', 'User-Agent'=>'Faraday v0.9.2'}
+        ).
+      to_return(
+        headers: {"Content-Type"=> "application/json"},
+        body: stub_response("simple-response-id"),
+        status: 202
+      )
+  end
+
+  def triggered_send_url
+    "#{TRIGGERED_SEND_URL}#{TRIGGERED_SEND_PATH}" % external_key
+  end
+
+  def stub_response(mockId)
+    %({
+      "requestId": "#{mockId}",
+      "responses": [   {
+        "recipientSendId": "#{mockId}",
+        "hasErrors": false,
+        "messages": ["Queued"]
+      }]
+    })
+  end
+
+
+end

data/spec/spec_helper.rb

@@ -1,2 +1,4 @@
 require 'exact_target_rest'
+require 'webmock/rspec'
+require 'pry'
 include ExactTargetRest

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: exact_target_rest
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Ronie Uliana
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-08 00:00:00.000000000 Z
+date: 2016-06-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -94,6 +94,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
 description: Simple wrapper around ExactTarget REST API. It deals with authorization
   and with coding conventions (CamelCase vs snake_case)
 email:
@@ -104,7 +132,6 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".ruby-gemset"
-- ".ruby-version"
 - Gemfile
 - Guardfile
 - LICENSE.txt
@@ -119,9 +146,11 @@ files:
 - lib/exact_target_rest/support/string_extension.rb
 - lib/exact_target_rest/triggered_send.rb
 - lib/exact_target_rest/version.rb
+- spec/lib/exact_target_rest/authorization_spec.rb
 - spec/lib/exact_target_rest/support/data_ext_params_spec.rb
 - spec/lib/exact_target_rest/support/hash_extension_spec.rb
 - spec/lib/exact_target_rest/support/string_extension_spec.rb
+- spec/lib/exact_target_rest/triggered_send_spec.rb
 - spec/spec_helper.rb
 homepage: ''
 licenses:
@@ -143,12 +172,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Simple wrapper around ExactTarget REST API
 test_files:
+- spec/lib/exact_target_rest/authorization_spec.rb
 - spec/lib/exact_target_rest/support/data_ext_params_spec.rb
 - spec/lib/exact_target_rest/support/hash_extension_spec.rb
 - spec/lib/exact_target_rest/support/string_extension_spec.rb
+- spec/lib/exact_target_rest/triggered_send_spec.rb
 - spec/spec_helper.rb

data/.ruby-version

@@ -1 +0,0 @@
-ruby-2.2