exact-target-api 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6cfa8a6154a2844221f392f18b3bd279c04926dc
+  data.tar.gz: eaedaa8b1f741d0a6492028726b06848fd772fd9
+SHA512:
+  metadata.gz: 432df1a25e5e09a33fe0409d7864108f9dda8f465f0ae175b3bbdd1a6b42b7f22fcde7a9e3f8709979a9a1870ba714a5c6ca0459526a8428bbcaeb616653b9b2
+  data.tar.gz: 27a26d976407d8c93bab879bc6b383efc0ac1a5cb4dc8db1286ec246f2459523de569c136768e7242a729f7384c108d2884c5cbb48ed950d63470e885b7e9bdf

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in exact-target-api.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,41 @@
+PATH
+  remote: .
+  specs:
+    exact-target-api (0.0.1)
+      jwt (~> 0.1.8)
+      savon (~> 2.2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    akami (1.2.0)
+      gyoku (>= 0.4.0)
+      nokogiri (>= 1.4.0)
+    builder (3.2.0)
+    gyoku (1.0.0)
+      builder (>= 2.1.2)
+    httpi (2.0.2)
+      rack
+    jwt (0.1.8)
+      multi_json (>= 1.5)
+    multi_json (1.7.3)
+    nokogiri (1.5.9)
+    nori (2.1.0)
+    rack (1.5.2)
+    savon (2.2.0)
+      akami (~> 1.2.0)
+      builder (>= 2.1.2)
+      gyoku (~> 1.0.0)
+      httpi (~> 2.0.2)
+      nokogiri (>= 1.4.0)
+      nori (~> 2.1.0)
+      wasabi (~> 3.1.0)
+    wasabi (3.1.0)
+      httpi (~> 2.0)
+      nokogiri (>= 1.4.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  exact-target-api!

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 thousandsofthem
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,62 @@
+ExactTarget API wrapper
+=====================
+
+Usage example:
+
+```ruby
+require 'rubygems'
+require 'bundler/setup'
+require 'exact-target-api'
+
+config = {
+  clientid: 'xxxxxx',
+  clientsecret: 'yyyyyy',
+  appsignature: 'zzzzzz' # Optional
+}
+
+# All optional
+options = {
+  debug: false,
+  wsdl: true,
+  jwt: params[:jwt]
+}
+
+client = ET::Client.new(config, options)
+
+
+# Create new List
+list = client.list.create(
+  ListName: "Test-List",
+  Description:  "Test List",
+  Type: "Private"
+)
+
+puts "List ID is #{list.id}"
+
+# Find a List
+list2 = client.list.find(list.id)
+
+# Create invalid subscriber
+subscriber = client.subscriber.create(email: 'foo@bar.aaaa')
+subscriber = client.subscriber.create(email: 'foo@bar.aaaa', list: list)
+subscriber = client.subscriber.create(email: 'foo@bar.aaaa', list_id: 12345, name: "Foo Bar")
+
+puts subscriber.code # 200
+puts subscriber.status # false
+puts subscriber.results # {:status_code=>"Error", :status_message=>"TriggeredSpamFilter", :ordinal_id=>"0", :error_code=>"12002", :new_id=>"0", :object=>{:partner_key=>nil, :object_id=>nil, :email_address=>"foo@bar.aaaa", :lists=>{:partner_key=>nil, :id=>"3488", :object_id=>nil}, :"@xsi:type"=>"Subscriber"}}
+
+# Create valid subscriber
+subscriber = client.subscriber.create(email: "RubySDK@bh.exacttarget.com", name: "Foo Bar", Description: "Some text")
+puts subscriber.code # 200
+puts subscriber.status # true
+puts subscriber.results # {:status_code=>"OK", :status_message=>"Created Subscriber.", :ordinal_id=>"0", :new_id=>"24761785", :object=>{:partner_key=>nil, :id=>"24761785", :object_id=>nil, :email_address=>"RubySDK@bh.exacttarget.com", :attributes=>[{:name=>"name", :value=>"Foo Bar"}, {:name=>"Description", :value=>"Some text"}], :"@xsi:type"=>"Subscriber"}}
+
+# Find a  subscriber
+subscriber = client.subscriber.find("RubySDK@bh.exacttarget.com")
+
+puts subscriber.status # true
+puts subscriber.results	# {:partner_key=>nil, :object_id=>nil, :email_address=>"RubySDK@bh.exacttarget.com", :subscriber_key=>"RubySDK@bh.exacttarget.com", :status=>"Active", :"@xsi:type"=>"Subscriber"}
+
+
+
+```

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/exact-target-api.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'exact-target-api/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "exact-target-api"
+  gem.version       = ET::VERSION
+  gem.authors       = ["Alexander Shapiotko"]
+  gem.email         = ["thousandsofthem@gmail.com"]
+  gem.description   = "ExactTarget API wrapper"
+  gem.summary       = "ExactTarget API wrapper"
+  gem.homepage      = "https://github.com/BriteVerify/exact-target-api"
+
+  gem.add_dependency "savon", "~> 2.2.0"
+  gem.add_dependency "jwt", "~> 0.1.8"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+end

data/lib/exact-target-api.rb

@@ -0,0 +1,43 @@
+require 'rubygems'
+require 'open-uri'
+require 'savon'
+require 'date'
+require 'json'
+require 'yaml'
+require 'jwt'
+
+require "exact-target-api/version"
+require "exact-target-api/base_object"
+require "exact-target-api/get_support"
+require "exact-target-api/bounce_event"
+require "exact-target-api/get_support_rest"
+require "exact-target-api/cud_support_rest"
+require "exact-target-api/campaign"
+require "exact-target-api/click_event"
+require "exact-target-api/create_wsdl"
+require "exact-target-api/client"
+require "exact-target-api/constructor"
+require "exact-target-api/cud_support"
+require "exact-target-api/content_area"
+require "exact-target-api/continue"
+require "exact-target-api/continue_rest"
+require "exact-target-api/data_extension"
+require "exact-target-api/delete"
+require "exact-target-api/delete_rest"
+require "exact-target-api/describe"
+require "exact-target-api/email"
+require "exact-target-api/folder"
+require "exact-target-api/get"
+require "exact-target-api/get_rest"
+require "exact-target-api/list"
+require "exact-target-api/list_subscriber"
+require "exact-target-api/open_event"
+require "exact-target-api/patch"
+require "exact-target-api/patch_rest"
+require "exact-target-api/post"
+require "exact-target-api/post_rest"
+require "exact-target-api/sent_event"
+require "exact-target-api/subscriber"
+require "exact-target-api/triggered_send"
+require "exact-target-api/unsub_event"
+

data/lib/exact-target-api/base_object.rb

@@ -0,0 +1,28 @@
+module ET
+  class BaseObject
+    attr_accessor :props, :client
+    attr_reader :obj, :lastRequestID, :endpoint
+
+    def initialize
+      @props = nil
+      @filter = nil
+      @lastRequestID = nil
+      @endpoint = nil
+    end
+
+
+    def stringify_keys!(params)
+      params.keys.each do |key|
+        params[key.to_s] = params.delete(key)
+      end
+      params
+    end
+
+    def symbolize_keys!(params)
+      params.keys.each do |key|
+        params[key.to_sym] = params.delete(key)
+      end
+      params
+    end
+  end
+end

data/lib/exact-target-api/bounce_event.rb

@@ -0,0 +1,8 @@
+module ET
+  class BounceEvent < ET::GetSupport
+    def initialize
+      super
+      @obj = 'BounceEvent'
+    end
+  end
+end

data/lib/exact-target-api/campaign.rb

@@ -0,0 +1,19 @@
+module ET
+  class Campaign < ET::CUDSupportRest
+    def initialize
+      super
+      @endpoint = 'https://www.exacttargetapis.com/hub/v1/campaigns/{id}'
+      @urlProps = ["id"]
+      @urlPropsRequired = []
+    end
+
+    class Asset < ET::CUDSupportRest
+      def initialize
+        super
+        @endpoint = 'https://www.exacttargetapis.com/hub/v1/campaigns/{id}/assets/{assetId}'
+        @urlProps = ["id", "assetId"]
+        @urlPropsRequired = ["id"]
+      end
+    end
+  end
+end

data/lib/exact-target-api/click_event.rb

@@ -0,0 +1,8 @@
+module ET
+  class ClickEvent < ET::GetSupport
+    def initialize
+      super
+      @obj = 'ClickEvent'
+    end
+  end
+end

data/lib/exact-target-api/client.rb

@@ -0,0 +1,175 @@
+require 'tmpdir'
+
+module ET
+  class Client < ET::CreateWSDL
+    attr_accessor :auth, :ready, :status, :debug, :authToken
+    attr_reader :authTokenExpiration, :internalAuthToken, :wsdlLoc, :clientId, :clientSecret, :soapHeader, :authObj, :path, :appsignature, :stackID, :refreshKey
+
+    def initialize(config, options = {})
+      load_config(config)
+      symbolize_keys!(options)
+
+      get_wsdl = options.has_key?(:wsdl) ? options[:wsdl] : true
+
+      @debug = options[:debug]
+
+      @path = Dir.tmpdir
+
+      begin
+        if get_wsdl
+          super(@path)
+        end
+
+        if options[:jwt]
+          jwt = JWT.decode(options[:jwt], @appsignature, true)
+          @authToken = jwt['request']['user']['oauthToken']
+          @authTokenExpiration = [Time.at(jwt['exp']), Time.now + jwt['request']['user']['expiresIn']].min
+          @internalAuthToken = jwt['request']['user']['internalOauthToken']
+          @refreshKey = jwt['request']['user']['refreshToken']
+
+          self.determineStack
+
+          @authObj = {'oAuth' => {'oAuthToken' => @internalAuthToken}}
+          @authObj[:attributes!] = { 'oAuth' => { 'xmlns' => 'http://exacttarget.com' }}
+
+          @auth = Savon.client(soap_header: @authObj,
+                               wsdl: File.read(wsdl_file(@path)),
+                               endpoint: @endpoint,
+                               wsse_auth: ["*", "*"],
+                               raise_errors: false,
+                               log: @debug,
+                               open_timeout: 180,
+                               read_timeout: 180)
+        end
+        refreshToken
+      rescue
+        raise
+      end
+
+      @ready = @auth.operations.length > 0 && @status >= 200 && @status <= 400
+    end
+
+    def refreshToken(force = nil)
+      #If we don't already have a token or the token expires within 5 min(300 seconds), get one
+      if force || @authToken.nil? || Time.now + 300 > @authTokenExpiration
+        begin
+          uri = URI.parse("https://auth.exacttargetapis.com/v1/requestToken?legacy=1")
+          http = Net::HTTP.new(uri.host, uri.port)
+          http.use_ssl = true
+          request = Net::HTTP::Post.new(uri.request_uri)
+
+          jsonPayload = {clientId: @clientId, clientSecret: @clientSecret}#, accessType: 'offline'}
+          # Pass in the refreshKey if we have it
+          jsonPayload[:refreshToken] = @refreshKey if @refreshKey
+
+          request.body = jsonPayload.to_json
+          request.add_field "Content-Type", "application/json"
+          tokenResponse = JSON.parse(http.request(request).body)
+
+          if tokenResponse['accessToken'].nil?
+            raise 'Unable to validate App Keys(ClientID/ClientSecret) provided: ' + http.request(request).body
+          end
+
+          @authToken = tokenResponse['accessToken']
+          @authTokenExpiration = Time.new + tokenResponse['expiresIn']
+          @internalAuthToken = tokenResponse['legacyToken']
+          if tokenResponse["refreshToken"]
+            @refreshKey = tokenResponse['refreshToken']
+          end
+
+
+          self.determineStack if @endpoint.nil?
+
+          @authObj = {'oAuth' => {'oAuthToken' => @internalAuthToken}}
+          @authObj[:attributes!] = {'oAuth' => {'xmlns' => 'http://exacttarget.com' }}
+
+          @auth = Savon.client(soap_header: @authObj,
+                               wsdl: File.read(wsdl_file(@path)),
+                               endpoint: @endpoint,
+                               wsse_auth: ["*", "*"],
+                               raise_errors: false,
+                               log: @debug)
+
+
+        rescue Exception => e
+          raise 'Unable to validate App Keys(ClientID/ClientSecret) provided: ' + e.message
+        end
+      end
+    end
+
+
+    def list
+      ET::List.new(self)
+    end
+
+    def subscriber
+      ET::Subscriber.new(self)
+    end
+
+    #def AddSubscriberToList(emailAddress, listIDs, subscriberKey = nil)
+    #  newSub = ET::Subscriber.new
+    #  newSub.authStub = self
+    #  lists = []
+    #
+    #  listIDs.each{ |p|
+    #    lists.push({"ID"=> p})
+    #  }
+    #
+    #  newSub.props = {"EmailAddress" => emailAddress, "Lists" => lists}
+    #  if !subscriberKey.nil?
+    #    newSub.props['SubscriberKey']  = subscriberKey
+    #  end
+    #
+    #  # Try to add the subscriber
+    #  postResponse = newSub.post
+    #
+    #  if !postResponse.status
+    #    # If the subscriber already exists in the account then we need to do an update.
+    #    # Update Subscriber On List
+    #    if postResponse.results[0][:error_code] == "12014"
+    #      patchResponse = newSub.patch
+    #      return patchResponse
+    #    end
+    #  end
+    #  postResponse
+    #end
+
+    #def CreateDataExtensions(dataExtensionDefinitions)
+    #  newDEs = ET::DataExtension.new
+    #  newDEs.authStub = self
+    #
+    #  newDEs.props = dataExtensionDefinitions
+    #  newDEs.post
+    #end
+
+
+    protected
+
+
+    def load_config(config)
+      symbolize_keys!(config)
+
+      @clientId = config[:clientid] || raise("Please provide ClientID")
+      @clientSecret = config[:clientsecret] || raise("Please provide Client Secret")
+      @appsignature = config[:appsignature]
+      @wsdl = config[:defaultwsdl] || 'https://webservice.exacttarget.com/etframework.wsdl'
+    end
+
+    def determineStack
+      begin
+        uri = URI.parse("https://www.exacttargetapis.com/platform/v1/endpoints/soap?access_token=" + @authToken)
+        http = Net::HTTP.new(uri.host, uri.port)
+
+        http.use_ssl = true
+
+        request = Net::HTTP::Get.new(uri.request_uri)
+
+        contextResponse = JSON.parse(http.request(request).body)
+        @endpoint = contextResponse['url']
+
+      rescue Exception => e
+        raise 'Unable to determine stack using /platform/v1/tokenContext: ' + e.message
+      end
+    end
+  end
+end