exact-target-client 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 614ec559735b61b1b116fdef1adf03bea2fb0bd0
+  data.tar.gz: 548a43df0c79f8fe7c1785f86447b8a897370315
+SHA512:
+  metadata.gz: 3fba540477dc8e5b5ec01017c6919b5a65d2300ce465fa8600b11811d8b32cc4c534b59187671d32c904195aa040ea9dd9b7f6874bbd35b650bbadfb74bddca8
+  data.tar.gz: 9562533fbd5e005c7788b1e90d9c9ca0602b496c8c68ae31eda6341229f1826dfc096abdff03582850dcf03e1c09a874b49f96be3902acda9fe281667a984d0c

data/.gitignore

@@ -0,0 +1 @@
+.idea/

data/Gemfile

@@ -0,0 +1,3 @@
+source 'http://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Yotpo Ltd
+
+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,10 @@
+# Exact Target Ruby API
+[![Build Status](https://travis-ci.org/YotpoLtd/exact-target-ruby-api.svg?branch=master)](https://travis-ci.org/YotpoLtd/exact-target-ruby-api)
+
+## Usage
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,3 @@
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exact-target-client.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'exact_target_client/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'exact-target-client'
+  spec.version       = ExactTargetClient::VERSION
+  spec.authors       = ['Ariel Cabib', 'Yaron Dinur']
+  spec.email         = ['acabib@yotpo.com', 'ydinur@yotpo.com']
+
+  spec.summary       = 'Ruby client for interacting with ExactTarget (Salesforce Marketing Cloud) APIs'
+  spec.description   = 'Ruby client for interacting with ExactTarget (Salesforce Marketing Cloud) APIs'
+  spec.homepage      = 'https://github.com/YotpoLtd/exact-target-ruby-api'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.12'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_runtime_dependency 'json'
+  spec.add_runtime_dependency 'savon', '2.3.3'
+  spec.add_runtime_dependency 'typhoeus'
+  spec.add_runtime_dependency 'oj'
+end

data/lib/exact_target_client/conf.rb

@@ -0,0 +1,23 @@
+
+module ExactTargetClient
+  class Conf
+
+    DEFAULT_TOKEN_ENDPOINT = 'https://auth.exacttargetapis.com/v1/requestToken'
+    DEFAULT_API_ENDPOINT = 'https://www.exacttargetapis.com'
+
+    class << self
+
+      attr_accessor :wsdl, :token_endpoint, :api_endpoint, :client_id, :client_secret
+
+      def configure
+        @token_endpoint = DEFAULT_TOKEN_ENDPOINT
+        @api_endpoint = DEFAULT_API_ENDPOINT
+        yield self
+        true
+      end
+
+    end
+
+  end
+end
+

data/lib/exact_target_client/exact_target_api.rb

@@ -0,0 +1,109 @@
+require 'exact_target_client/exact_target_rest_client'
+require 'exact_target_client/exact_target_soap_client'
+
+module ExactTargetClient
+  class ExactTargetAPI
+
+    attr_accessor :oauth_token, :refresh_token
+    class TimeOut < Exception;
+    end
+    class TokenExpired < Exception;
+    end
+    class ClientException < Exception;
+    end
+
+    def initialize
+      yield self if block_given?
+      raise ArgumentError, 'block not given' unless block_given?
+      init_clients
+    end
+
+    def refresh_oauth_token
+      results = @rest_client.get_oauth_token(Conf.client_id, Conf.client_secret, refresh_token)
+      if results
+        @oauth_token = results['accessToken']
+        @refresh_token = results['refreshToken']
+        refresh_clients(results['accessToken'])
+        results
+      end
+    end
+
+    def get_emails(ids = nil)
+      properties = %w(ID Name HTMLBody)
+      if ids.present?
+        filter = {property: 'ID', value: ids}
+      end
+      response = soap_client.retrieve('Email', properties, filter)
+      check_response(response)
+    end
+
+    def create_email(email_name, subject, html_template)
+      response = soap_client.create('Email',
+                                    {'Name' => email_name,
+                                     'Subject' => subject,
+                                     'HTMLBody' => html_template}
+      )
+      check_response(response)
+    end
+
+    def update_email(email_id, name, html_template, subject = nil)
+      properties = {'ID' => email_id, 'Name' => name, 'HTMLBody' => html_template}
+      if subject.present?
+        properties['Subject'] = subject
+      end
+      response = soap_client.update('Email', properties)
+      check_response(response)
+    end
+
+    def delete_email(email_id)
+      response = soap_client.delete('Email', {'ID' => email_id})
+      check_response(response)
+    end
+
+    private
+    attr_accessor :soap_client, :rest_client
+
+    def init_clients
+      @soap_client = ExactTargetClient::ExactTargetSoapClient.new do |c|
+        c.oauth_token = oauth_token
+        c.wsdl = Conf.wsdl % {:instance => oauth_token[0]} # WSDL instance is determined by first char of token
+      end
+      @rest_client = ExactTargetClient::ExactTargetRestClient.new do |c|
+        c.oauth_token = oauth_token
+      end
+    end
+
+    def refresh_clients(token)
+      @soap_client.set_oauth_token(token)
+      @rest_client.set_oauth_token(token)
+    end
+
+    def check_response(response)
+      if response.success?
+        response.results
+      else
+        raise ClientException.new(response.message)
+      end
+    end
+
+    def create_data_extension(properties)
+      response = soap_client.create('DataExtension', properties)
+      check_response(response)
+    end
+
+    def upsert_data_extension_row(data_extension_customer_key, primary_key_name, primary_key_value, object_hash)
+      rest_client.upsert_data_extension_row(data_extension_customer_key, primary_key_name, primary_key_value, object_hash)
+    end
+
+    def increment_data_extension_row(data_extension_customer_key, primary_key_name, primary_key_value, column, step = 1)
+      rest_client.increment_data_extension_row(data_extension_customer_key, primary_key_name, primary_key_value, column, step)
+    end
+
+    def get_subscribers_by_email(email, properties)
+      response = soap_client.retrieve('Subscriber', properties, {property: 'EmailAddress', value: email})
+      check_response(response)
+    end
+  end
+
+end
+

data/lib/exact_target_client/exact_target_rest_client.rb

@@ -0,0 +1,65 @@
+module ExactTargetClient
+  class ExactTargetRestClient
+    attr_accessor :oauth_token
+
+    def initialize
+      yield self if block_given?
+    end
+
+    def get_oauth_token(client_id, client_secret, refresh_token = nil)
+      request_url = EXACT_TARGET_CONF['ENDPOINTS']['REQUEST_TOKEN']
+      params = {
+          clientId: client_id,
+          clientSecret: client_secret,
+          accessType: 'offline'
+      }
+      if refresh_token.present?
+        params[:refreshToken] = refresh_token
+      end
+      request(:post, request_url, params, false)
+    end
+
+    def set_oauth_token(token)
+      @oauth_token = token
+    end
+
+    def upsert_data_extension_row(data_extension_customer_key, primary_key_name, primary_key_value, object_hash)
+      request_url = "#{EXACT_TARGET_CONF['ENDPOINTS']['API']}/hub/v1/dataevents/key:#{data_extension_customer_key}/rows/#{primary_key_name}:#{primary_key_value}"
+      request('PUT', request_url, {values: object_hash})
+    end
+
+    def increment_data_extension_row(data_extension_customer_key, primary_key_name, primary_key_value, column, step = 1)
+      request_url = "#{EXACT_TARGET_CONF['ENDPOINTS']['API']}/hub/v1/dataevents/key:#{data_extension_customer_key}/rows/#{primary_key_name}:#{primary_key_value}/column/#{column}/increment?step=#{step}"
+      request('PUT', request_url)
+    end
+
+
+    private
+    def request(type, url, params = nil, add_token = true)
+      body = params.to_json if params
+      headers = { 'Content-Type' => 'application/json' }
+      headers['Authorization'] = "Bearer #{@oauth_token}" if add_token
+      request = Typhoeus::Request.new(
+          url,
+          method: type,
+          body: body,
+          headers: headers
+      )
+      request.on_complete do |response|
+        if response.success?
+          return Oj.load(response.body)
+        elsif response.timed_out?
+          raise ExactTargetClient::ExactTargetAPI::TimeOut
+        else
+          response = JSON.parse(response.response_body)
+          if (response['message'] == 'Unauthorized' || response['message'] == 'Not Authorized') && url == EXACT_TARGET_CONF['ENDPOINTS']['REQUEST_TOKEN']
+            raise ExactTargetClient::ExactTargetAPI::TokenExpired
+          else
+            raise ExactTargetClient::ExactTargetAPI::ClientException.new("REST API Error #{response['errorcode'].to_s}: #{response['message']}")
+          end
+        end
+      end
+      request.run
+    end
+  end
+end

data/lib/exact_target_client/exact_target_soap_client.rb

@@ -0,0 +1,148 @@
+module ExactTargetClient
+  class SoapResponse
+    attr_reader :code, :message, :results, :request_id, :body, :result_key
+
+    def initialize(response, result_key, client)
+      @results = []
+      @result_key = result_key
+      @client = client
+      parse_response response
+    rescue => e
+      raise ExactTargetClient::ExactTargetAPI::ClientException.new("SOAP Client Error: #{e.message}")
+    end
+
+    def success?
+      @success ||= false
+    end
+
+    private
+
+    def get_more
+      parse_results @client.soap_client.call(:retrieve, :message => {'ContinueRequest' => request_id})
+    end
+
+    def parse_response(response)
+      @code = response.http.code
+      parse_body response
+    end
+
+    def parse_body(response)
+      @request_id = response.body[result_key][:request_id]
+      @success = response.body[result_key][:overall_status] == 'OK'
+      @results = result_key == :retrieve_response_msg ? parse_results(response) : response.body[result_key][:results]
+      @message = @results.present? ? response.body[result_key][:results][:status_message] : response.body[result_key][:overall_status]
+    rescue
+      @message = response.http.body
+      @body = response.http.body unless @body
+    end
+
+    def parse_results(response)
+      res = response.body[result_key][:results] || []
+      if response.body[result_key][:overall_status] == 'MoreDataAvailable'
+        res += get_more
+      end
+      Array.wrap(res)
+    rescue
+      []
+    end
+  end
+
+  class ExactTargetSoapClient
+    attr_accessor :wsdl, :oauth_token
+
+    RESPONSE_RESULT_KEYS = {
+        create: :create_response,
+        update: :update_response,
+        delete: :delete_response,
+        retrieve: :retrieve_response_msg
+    }
+
+    def initialize
+      yield self if block_given?
+    end
+
+    def header
+      raise ExactTargetClient::ExactTargetAPI::ClientException.new('OAuth token must be provided to SOAP client!') unless oauth_token
+      {
+          'fueloauth' => oauth_token,
+          '@xmlns' => 'http://exacttarget.com'
+      }
+    end
+
+    def wsdl
+      @wsdl ||= 'https://webservice.exacttarget.com/etframework.wsdl'
+    end
+
+    def soap_client
+      @soap_client = Savon.client(
+          soap_header: header,
+          wsdl: wsdl,
+          log: false,
+          open_timeout: 120,
+          read_timeout: 120
+      )
+    end
+
+    def set_oauth_token(token)
+      @oauth_token = token
+      soap_client.globals[:soap_header] = header
+    end
+
+    def retrieve(object_type, properties, filter = nil)
+      raise ExactTargetClient::ExactTargetAPI::ClientException.new('Object properties must be specified') unless properties.present?
+      payload = {'ObjectType' => object_type, 'Properties' => properties}
+      if filter.present?
+        values = Array.wrap(filter[:value])
+        payload['Filter'] = {
+            '@xsi:type' => 'tns:SimpleFilterPart',
+            'Property' => filter[:property],
+            'SimpleOperator' => values.one? ? 'equals' : 'IN',
+            'Value' => values
+        }
+      end
+      message = {'RetrieveRequest' => payload}
+      soap_request :retrieve, message
+    end
+
+    def create(object_type, properties)
+      soap_action :create, object_type, properties
+    end
+
+    def update(object_type, properties)
+      soap_action :update, object_type, properties
+    end
+
+    def delete(object_type, properties)
+      soap_action :delete, object_type, properties
+    end
+
+    private
+
+    def soap_action(action, object_type, properties)
+      properties['@xsi:type'] = "tns:#{object_type}"
+      message = {
+          'Objects' => properties
+      }
+      soap_request action, message
+    end
+
+    def soap_request(action, message)
+      responseObject = SoapResponse
+      begin
+        tries ||= 3
+        response = soap_client.call(action, :message => message)
+          # TODO - handle other error types
+      rescue Savon::SOAPFault => error
+        message = error.to_hash[:fault][:faultstring]
+        if message == 'Token Expired'
+          raise ExactTargetClient::ExactTargetAPI::TokenExpired
+        elsif message == 'Login Failed'
+          retry unless (tries -= 1).zero?
+        else
+          raise ExactTargetClient::ExactTargetAPI::ClientException.new("SOAP Client Error: #{message}")
+        end
+      end
+      responseObject.new response, RESPONSE_RESULT_KEYS[action], self
+    end
+  end
+end

data/lib/exact_target_client/version.rb

@@ -0,0 +1,3 @@
+module ExactTargetClient
+  VERSION = '0.0.2'
+end

metadata

@@ -0,0 +1,159 @@
+--- !ruby/object:Gem::Specification
+name: exact-target-client
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Ariel Cabib
+- Yaron Dinur
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-08-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: savon
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.3.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.3.3
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: oj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ruby client for interacting with ExactTarget (Salesforce Marketing Cloud)
+  APIs
+email:
+- acabib@yotpo.com
+- ydinur@yotpo.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exact-target-client.gemspec
+- lib/exact_target_client/conf.rb
+- lib/exact_target_client/exact_target_api.rb
+- lib/exact_target_client/exact_target_rest_client.rb
+- lib/exact_target_client/exact_target_soap_client.rb
+- lib/exact_target_client/version.rb
+homepage: https://github.com/YotpoLtd/exact-target-ruby-api
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Ruby client for interacting with ExactTarget (Salesforce Marketing Cloud)
+  APIs
+test_files: []