fuelsdk 0.0.1

data/lib/fuelsdk/client.rb

@@ -0,0 +1,142 @@
+module FuelSDK
+  class ET_Response
+    # not doing accessor so user, can't update these values from response.
+    # You will see in the code some of these
+    # items are being updated via back doors and such.
+    attr_reader :code, :message, :results, :request_id, :body, :raw
+
+    # some defaults
+    def success
+      @success ||= false
+    end
+    alias :success? :success
+    alias :status :success # backward compatibility
+
+    def more
+      @more ||= false
+    end
+    alias :more? :more
+
+    def initialize raw, client
+      @client = client # keep connection with client in case we request more
+      @results = []
+      @raw = raw
+      @body = raw.body
+      unpack raw
+    rescue => ex # all else fails return raw
+      puts ex.message
+      raw
+    end
+
+    def continue
+      raise NotImplementedError
+    end
+
+    private
+      def unpack raw
+        raise NotImplementedError
+      end
+  end
+
+  class ET_Client
+    attr_accessor :debug, :access_token, :auth_token, :internal_token, :refresh_token,
+      :id, :secret, :signature
+
+    include FuelSDK::Soap
+    include FuelSDK::Rest
+
+    def jwt= encoded_jwt
+      raise 'Require app signature to decode JWT' unless self.signature
+      decoded_jwt = JWT.decode(encoded_jwt, self.signature, true)
+
+      self.auth_token = decoded_jwt['request']['user']['oauthToken']
+      self.internal_token = decoded_jwt['request']['user']['internalOauthToken']
+      self.refresh_token = decoded_jwt['request']['user']['refreshToken']
+      #@authTokenExpiration = Time.new + decoded_jwt['request']['user']['expiresIn']
+    end
+
+    def initialize(params={}, debug=false)
+      self.debug = debug
+      client_config = params['client']
+      if client_config
+        self.id = client_config["id"]
+        self.secret = client_config["secret"]
+        self.signature = client_config["signature"]
+      end
+
+      self.jwt = params['jwt'] if params['jwt']
+      self.refresh_token = params['refresh_token'] if params['refresh_token']
+
+      self.wsdl = params["defaultwsdl"] if params["defaultwsdl"]
+    end
+
+    def refresh force=false
+      raise 'Require Client Id and Client Secret to refresh tokens' unless (id && secret)
+
+      if (self.access_token.nil? || force)
+        payload = Hash.new.tap do |h|
+          h['clientId']= id
+          h['clientSecret'] = secret
+          h['refreshToken'] = refresh_token if refresh_token
+          h['accessType'] = 'offline'
+        end
+
+        options = Hash.new.tap do |h|
+          h['data'] = payload
+          h['content_type'] = 'application/json'
+          h['params'] = {'legacy' => 1}
+        end
+
+        response = post("https://auth.exacttargetapis.com/v1/requestToken", options)
+        raise "Unable to refresh token: #{response['message']}" unless response.has_key?('accessToken')
+
+        self.access_token = response['accessToken']
+        self.internal_token = response['legacyToken']
+        #@authTokenExpiration = Time.new + tokenResponse['expiresIn']
+        self.refresh_token = response['refreshToken'] if response.has_key?("refreshToken")
+      end
+    end
+
+    def refresh!
+      refresh true
+    end
+
+    #def AddSubscriberToList(emailAddress, listIDs, subscriberKey = nil)
+    #  newSub = FuelSDK::ET_Subscriber.new
+    #  newSub.authStub = self
+    #  lists = []
+
+    #  listIDs.each{ |p|
+    #    lists.push({"ID"=> p})
+    #  }
+
+    #  newSub.props = {"EmailAddress" => emailAddress, "Lists" => lists}
+    #  if !subscriberKey.nil? then
+    #    newSub.props['SubscriberKey']  = subscriberKey;
+    #  end
+
+    #  # Try to add the subscriber
+    #  postResponse = newSub.post
+
+    #  if postResponse.status == false then
+    #    # 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" then
+    #      patchResponse = newSub.patch
+    #      return patchResponse
+    #    end
+    #  end
+    #  return postResponse
+    #end
+
+    #def CreateDataExtensions(dataExtensionDefinitions)
+    #  newDEs = FuelSDK::ET_DataExtension.new
+    #  newDEs.authStub = self
+
+    #  newDEs.props = dataExtensionDefinitions
+    #  postResponse = newDEs.post
+
+    #  return postResponse
+    #end
+  end
+end

data/lib/fuelsdk/http_request.rb

@@ -0,0 +1,79 @@
+require 'open-uri'
+require 'net/https'
+require 'json'
+
+module FuelSDK
+
+  class HTTPResponse < FuelSDK::ET_Response
+
+    def initialize raw, client, request
+      super raw, client
+      @request = request
+    end
+
+    def continue
+      rsp = nil
+      if more?
+       rsp = unpack @client.rest_get(@request['url'], @request['options'])
+      else
+        puts 'No more data'
+      end
+
+      rsp
+    end
+
+    def [] key
+      @results[key]
+    end
+
+    private
+      def unpack raw
+        @code = raw.code.to_i
+        @message = raw.message
+        @body = JSON.parse(raw.body) rescue {}
+        @results = @body
+        @more = ((@results['count'] || @results['totalCount']) > @results['page'] * @results['pageSize']) rescue false
+        @success = @message == 'OK'
+      end
+
+      # by default try everything against results
+      def method_missing method, *args, &block
+        @results.send(method, *args, &block)
+      end
+  end
+
+  module HTTPRequest
+
+    request_methods = ['get', 'post', 'patch', 'delete']
+    request_methods.each do |method|
+      class_eval <<-EOT, __FILE__, __LINE__ + 1
+        def #{method}(url, options={})                                      # def post(url, options)
+          request Net::HTTP::#{method.capitalize}, url, options             #   request Net::HTTP::Post, url, options
+        end                                                                 # end
+      EOT
+    end
+
+    private
+
+      def generate_uri(url, params=nil)
+        uri = URI.parse(url)
+        uri.query = URI.encode_www_form(params) if params
+        uri
+      end
+
+      def request(method, url, options={})
+        uri = generate_uri url, options['params']
+
+        http = Net::HTTP.new(uri.host, uri.port)
+        http.use_ssl = true
+
+        data = options['data']
+        _request = method.new uri.request_uri
+        _request.body = data.to_json if data
+        _request.content_type = options['content_type'] if options['content_type']
+        response = http.request(_request)
+
+        HTTPResponse.new(response, self, :url => url, :options => options)
+      end
+  end
+end

data/lib/fuelsdk/objects.rb

@@ -0,0 +1,143 @@
+module FuelSDK
+  module ET_SoapGet
+    def get
+      client.soap_get id, properties, filter
+    end
+
+    def info
+      client.soap_describe id
+    end
+  end
+
+  module ET_SoapCUD #create, update, delete
+    def post
+      client.soap_post id, properties
+    end
+
+    def patch
+      client.soap_patch id, properties
+    end
+
+    def delete
+      client.soap_delete id, properties
+    end
+  end
+
+  module ET_RestGet
+    def get
+      client.rest_get id, properties
+    end
+  end
+
+  module ET_RestCUD
+    def post
+      client.rest_post id, properties
+    end
+
+    def patch
+      client.rest_patch id, properties
+    end
+
+    def delete
+      client.rest_delete id, properties
+    end
+  end
+
+  class ET_Base
+    attr_accessor :filter, :properties, :client
+    attr_reader :id
+
+    alias props= properties= # backward compatibility
+    alias authStub= client= # backward compatibility
+
+    def id
+      self.class.name.split('::').pop.split('_').pop
+    end
+  end
+
+  class ET_BounceEvent < ET_Base
+    include ET_SoapGet
+  end
+
+  class ET_ClickEvent < ET_Base
+    include ET_SoapGet
+  end
+
+  class ET_ContentArea < ET_Base
+    include ET_SoapGet
+    include ET_SoapCUD
+  end
+
+  class ET_Folder < ET_Base
+    include ET_SoapGet
+    include ET_SoapCUD
+    def id
+      'DataFolder'
+    end
+  end
+
+  class ET_Email < ET_Base
+    include ET_SoapGet
+    include ET_SoapCUD
+  end
+
+  class ET_List < ET_Base
+    include ET_SoapGet
+    include ET_SoapCUD
+
+    class Subscriber < ET_Base
+      include ET_SoapGet
+      def id
+        'ListSubscriber'
+      end
+    end
+  end
+
+  class ET_OpenEvent < ET_Base
+    include ET_SoapGet
+  end
+
+  class ET_SentEvent < ET_Base
+    include ET_SoapGet
+  end
+
+  class ET_Subscriber < ET_Base
+    include ET_SoapGet
+    include ET_SoapCUD
+  end
+
+  class ET_UnsubEvent < ET_Base
+    include ET_SoapGet
+  end
+
+  class ET_Campaign < ET_Base
+    include ET_RestGet
+    include ET_RestCUD
+
+
+    def properties
+      @properties ||= {}
+      @properties.merge! 'id' => '' unless @properties.include? 'id'
+      @properties
+    end
+
+    def id
+      "https://www.exacttargetapis.com/hub/v1/campaigns/%{id}"
+    end
+
+    class Asset < ET_Base
+      include ET_RestGet
+      include ET_RestCUD
+
+      def properties
+        @properties ||= {}
+        @properties.merge! 'assetId' => '' unless @properties.include? 'assetId'
+        @properties
+      end
+
+      def id
+        'https://www.exacttargetapis.com/hub/v1/campaigns/%{id}/assets/%{assetId}'
+      end
+    end
+  end
+end

data/lib/fuelsdk/rest.rb

@@ -0,0 +1,84 @@
+module FuelSDK
+  module Rest
+
+    include FuelSDK::Targeting
+
+    def rest_client
+      self
+    end
+
+    def normalize_keys obj
+      if obj and obj.is_a? Hash
+        obj.keys.each do |k|
+          obj[(k.to_sym rescue k) || k] = obj.delete(k)
+        end
+      end
+      obj
+    end
+
+    def get_url_properties url, properties
+      url_property_names = url.scan(/(%{(.+?)})/).collect{|frmt, name| name}
+      url_properties = {}
+      properties.keys.each do |k|
+        if url_property_names.include? k
+          url_properties[k] = properties.delete(k)
+        end
+      end
+      url_properties
+    end
+
+    def complete_url url, url_properties
+      normalize_keys(url_properties)
+      url = url % url_properties if url_properties
+      url.end_with?('/') ? url.chop : url
+    rescue KeyError => ex
+      raise "#{ex.message} to complete #{url}"
+    end
+
+    def parse_properties url, properties
+      url_properties = get_url_properties url, properties
+      url = complete_url url, url_properties
+      [url, properties]
+    end
+
+    def rest_get url, properties={}
+      url, properties = parse_properties url, properties
+      rest_request :get, url, {'params' => properties}
+    end
+
+    def rest_delete url, properties={}
+      url, properties = parse_properties url, properties
+      rest_request :delete, url
+    end
+
+    def rest_patch url, properties={}
+      url, payload = parse_properties url, properties
+      rest_request :patch, url, {'data' => payload,
+        'content_type' => 'application/json'}
+    end
+
+    def rest_post url, properties={}
+      url, payload = parse_properties url, properties
+      rest_request :post, url, {'data' => payload,
+        'content_type' => 'application/json'}
+    end
+
+    private
+      def rest_request action, url, options={}
+        retried = false
+        begin
+          (options['params'] ||= {}).merge! 'access_token' => access_token
+          rsp = rest_client.send(action, url, options)
+          raise 'Unauthorized' if rsp.message == 'Unauthorized'
+        rescue
+          raise if retried
+          self.refresh! # ask for forgiveness not, permission
+          retried = true
+          retry
+        end
+          rsp
+      rescue
+        rsp
+      end
+  end
+end