fuelsdk 0.0.1

data/.gitignore

@@ -0,0 +1,24 @@
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/
+sample.rb
+ExactTargetWSDL.xml
+config.yaml
+/objsamples/config.yaml
+/objsamples/AllTest.bat
+.DS_STORE

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,8 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+guard 'rspec' do
+  watch('spec/spec_helper.rb')  { "spec" }
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+end
+

data/README.md

@@ -0,0 +1,117 @@
+FuelSDK-Ruby
+============
+
+ExactTarget Fuel SDK for Ruby
+
+## Overview ##
+The Fuel SDK for Ruby provides easy access to ExactTarget's Fuel API Family services, including a collection of REST APIs and a SOAP API. These APIs provide access to ExactTarget functionality via common collection types such as array/hash. 
+
+## Requirements ##
+Ruby Version 1.9.3
+
+Gems:
+
+- [savon (2.x)](http://rubygems.org/gems/savon)
+- [json (1.7.x)](http://rubygems.org/gems/json)
+- [jwt (0.1.6)](https://rubygems.org/gems/jwt)
+
+
+## Getting Started ##
+After downloading the project, rename the config.yaml.template file to config.yaml. 
+
+Edit config.yaml so you can input the ClientID and Client Secret values provided when you registered your application. If you are building a HubExchange application for the Interactive Marketing Hub then, you must also provide the Application Signature (appsignature).  Only change the value for the defaultwsdl configuration item if instructed by ExactTarget.
+
+If you have not registered your application or you need to lookup your Application Key or Application Signature values, please go to App Center at [Code@: ExactTarget's Developer Community](http://code.exacttarget.com/appcenter "Code@ App Center").
+
+## Example Request ##
+All ExactTarget objects exposed through the Fuel SDK begin with be prefixed with "ET\_".  Start by working with the ET_List object:
+
+Add a require statement to reference the Fuel SDK's functionality:
+> require 'fuelsdk'
+
+Next, create an instance of the ET_Client class:
+> myClient = FuelSDK::ET_Client.new
+
+Create an instance of the object type we want to work with:
+> list = FuelSDK::ET_List.new
+
+Associate the ET_Client to the object using the authStub property:
+> list.authStub = myClient
+
+Utilize one of the ET_List methods:
+> response = list.get
+
+Print out the results for viewing
+> p response
+
+**Example Output:**
+
+<pre>
+#&lt;ET_Get:0x355bc48 
+	@results=[
+		{
+			:client=>{
+				:id=>"1000001", 
+				:partner_client_key=>nil
+				}, 
+			:partner_key=>nil, 
+			:created_date=>#&lt;DateTime: 2009-06-12T14:42:06+00:00 ((2454995j,52926s,100000000n),+0s,2299161j)&gt;, 
+			:modified_date=>#&lt;DateTime: 2011-08-17T14:50:30+00:00 ((2455791j,53430s,697000000n),+0s,2299161j)&gt;, 
+			:id=>"1718921", 
+			:object_id=>"f41c7d1b-8957-de11-92ee-001cc494ae9e", 
+			:customer_key=>"All Subscribers - 578623", 
+			:list_name=>"All Subscribers", 
+			:category=>"578623", 
+			:type=>"Private", 
+			:description=>"Contains all subscribers", 
+			:list_classification=>"ExactTargetList", 
+			:"@xsi:type"=>"List"}
+		], 
+	@code=200, 
+	@status=true, 
+	@moreResults=false, 
+	@request_id="41f0f293-954f-4ac7-8e7a-0a5756022218"
+>
+</pre>
+
+## ET\_Client Class ##
+
+The ET\_Client class takes care of many of the required steps when accessing ExactTarget's API, including retrieving appropriate access tokens, handling token state for managing refresh, and determining the appropriate endpoints for API requests.  In order to leverage the advantages this class provides, use a single instance of this class for an entire session.  Do not instantiate a new ET_Client object for each request made. 
+
+## Responses ##
+All methods on Fuel SDK objects return a generic object that follows the same structure, regardless of the type of call.  This object contains a common set of properties used to display details about the request.
+
+- status: Boolean value that indicates if the call was successful
+- code: HTTP Error Code (will always be 200 for SOAP requests)
+- message: Text values containing more details in the event of an error
+- results: Collection containing the details unique to the method called. 
+
+Get Methods also return an addition value to indicate if more information is available (that information can be retrieved using the getMoreResults method):
+
+ - moreResults - Boolean value that indicates on Get requests if more data is available. 
+
+
+## Samples ##
+Find more sample files that illustrate using all of the available functions for ExactTarget objects exposed through the API in the objsamples directory. 
+
+Sample List:
+
+ - [BounceEvent](https://github.com/ExactTarget/FuelSDK-Ruby/blob/master/objsamples/sample-bounceevent.rb)
+ - [Campaign](https://github.com/ExactTarget/FuelSDK-Ruby/blob/master/objsamples/sample-campaign.rb)
+ - [ClickEvent](https://github.com/ExactTarget/FuelSDK-Ruby/blob/master/objsamples/sample-clickevent.rb)
+ - [ContentArea](https://github.com/ExactTarget/FuelSDK-Ruby/blob/master/objsamples/sample-contentarea.rb)
+ - [DataExtension](https://github.com/ExactTarget/FuelSDK-Ruby/blob/master/objsamples/sample-dataextension.rb)
+ - [Email](https://github.com/ExactTarget/FuelSDK-Ruby/blob/master/objsamples/sample-email.rb)
+ - [List](https://github.com/ExactTarget/FuelSDK-Ruby/blob/master/objsamples/sample-list.rb)
+ - [List > Subscriber](https://github.com/ExactTarget/FuelSDK-Ruby/blob/master/objsamples/sample-list.subscriber.rb)
+ - [OpenEvent](https://github.com/ExactTarget/FuelSDK-Ruby/blob/master/objsamples/sample-openevent.rb)
+ - [SentEvent](https://github.com/ExactTarget/FuelSDK-Ruby/blob/master/objsamples/sample-sentevent.rb)
+ - [Subscriber](https://github.com/ExactTarget/FuelSDK-Ruby/blob/master/objsamples/sample-subscriber.rb)
+ - [TriggeredSend](https://github.com/ExactTarget/FuelSDK-Ruby/blob/master/objsamples/sample-triggeredsend.rb)
+ - [UnsubEvent](https://github.com/ExactTarget/FuelSDK-Ruby/blob/master/objsamples/sample-unsubevent.rb)
+
+
+ 
+
+
+

data/Rakefile

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

data/fuelsdk.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'fuelsdk/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "fuelsdk"
+  spec.version       = FuelSDK::VERSION
+  spec.authors       = ["MichaelAllenClark", "barberj"]
+  spec.email         = []
+  spec.description   = %q{Fuel SDK for Ruby}
+  spec.summary       = %q{Fuel SDK for Ruby}
+  spec.homepage      = "https://github.com/ExactTarget/FuelSDK-Ruby"
+  spec.license       = ""
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(samples|test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "guard"
+  spec.add_development_dependency "guard-rspec"
+
+  spec.add_dependency "savon", "~> 2.0"
+  spec.add_dependency "json", "~> 1.7.0"
+  spec.add_dependency "jwt", "~> 0.1.6"
+end

data/lib/fuelsdk.rb

@@ -0,0 +1,572 @@
+require "fuelsdk/version"
+
+require 'rubygems'
+require 'date'
+require 'jwt'
+
+module FuelSDK
+  autoload :HTTPRequest, 'fuelsdk/http_request'
+  autoload :Targeting, 'fuelsdk/targeting'
+  autoload :Soap, 'fuelsdk/soap'
+  autoload :Rest, 'fuelsdk/rest'
+  require 'fuelsdk/client'
+  require 'fuelsdk/objects'
+end
+
+=begin
+  class ET_Constructor
+    attr_accessor :status, :code, :message, :results, :request_id, :moreResults
+
+    def initialize(response = nil, rest = false)
+      @results = []
+      #if !response.nil? && !rest then
+      #  @@body = response.body
+
+      #  if ((!response.soap_fault?) or (!response.http_error?)) then
+      #    @code = response.http.code
+      #    @status = true
+      #  elsif (response.soap_fault?) then
+      #    @code = response.http.code
+      #    @message = @@body[:fault][:faultstring]
+      #    @status = false
+      #  elsif (response.http_error?) then
+      #    @code = response.http.code
+      #    @status = false
+      #  end
+      #elsif
+        @code = response.code
+        @status = true
+        if @code != "200" then
+          @status = false
+        end
+
+        begin
+          @results = JSON.parse(response.body)
+        rescue
+          @message = response.body
+        end
+
+      end
+    end
+  end
+
+  class ET_BaseObject
+    attr_accessor :authStub, :props
+    attr_reader :obj, :lastRequestID, :endpoint
+
+    def initialize
+      @authStub = nil
+      @props = nil
+      @filter = nil
+      @lastRequestID = nil
+      @endpoint = nil
+    end
+  end
+
+  class ET_GetSupportRest < ET_BaseObject
+    attr_reader :urlProps, :urlPropsRequired, :lastPageNumber
+
+    def get(props = nil)
+      if props and props.is_a? Hash then
+        @props = props
+      end
+
+      completeURL = @endpoint
+      additionalQS = {}
+
+      if @props and @props.is_a? Hash then
+        @props.each do |k,v|
+          if @urlProps.include?(k) then
+            completeURL.sub!("{#{k}}", v)
+          else
+            additionalQS[k] = v
+          end
+        end
+      end
+
+      @urlPropsRequired.each do |value|
+        if !@props || !@props.has_key?(value) then
+          raise "Unable to process request due to missing required prop: #{value}"
+        end
+      end
+
+      @urlProps.each do |value|
+        completeURL.sub!("/{#{value}}", "")
+      end
+
+      obj = ET_GetRest.new(@authStub, completeURL,additionalQS)
+
+      if obj.results.has_key?('page') then
+        @lastPageNumber = obj.results['page']
+        pageSize = obj.results['pageSize']
+        if obj.results.has_key?('count') then
+          count = obj.results['count']
+        elsif obj.results.has_key?('totalCount') then
+          count = obj.results['totalCount']
+        end
+
+        if !count.nil? && count > (@lastPageNumber * pageSize)  then
+          obj.moreResults = true
+        end
+      end
+      return obj
+    end
+
+    def getMoreResults()
+      if props and props.is_a? Hash then
+        @props = props
+      end
+
+      originalPageValue = "1"
+      removePageFromProps = false
+
+      if !@props.nil? && @props.has_key?('$page') then
+        originalPageValue = @props['page']
+      else
+        removePageFromProps = true
+      end
+
+      if @props.nil?
+        @props = {}
+      end
+
+      @props['$page'] = @lastPageNumber + 1
+
+      obj = self.get
+
+      if removePageFromProps then
+        @props.delete('$page')
+      else
+        @props['$page'] = originalPageValue
+      end
+
+      return obj
+    end
+  end
+
+  class ET_CUDSupportRest < ET_GetSupportRest
+
+    def post()
+      completeURL = @endpoint
+
+      if @props and @props.is_a? Hash then
+        @props.each do |k,v|
+          if @urlProps.include?(k) then
+            completeURL.sub!("{#{k}}", v)
+          end
+        end
+      end
+
+      @urlPropsRequired.each do |value|
+        if !@props || !@props.has_key?(value) then
+          raise "Unable to process request due to missing required prop: #{value}"
+        end
+      end
+
+      # Clean Optional Parameters from Endpoint URL first
+      @urlProps.each do |value|
+        completeURL.sub!("/{#{value}}", "")
+      end
+
+      ET_PostRest.new(@authStub, completeURL, @props)
+    end
+
+    def patch()
+      completeURL = @endpoint
+      # All URL Props are required when doing Patch
+      @urlProps.each do |value|
+        if !@props || !@props.has_key?(value) then
+          raise "Unable to process request due to missing required prop: #{value}"
+        end
+      end
+
+      if @props and @props.is_a? Hash then
+        @props.each do |k,v|
+          if @urlProps.include?(k) then
+            completeURL.sub!("{#{k}}", v)
+          end
+        end
+      end
+
+      obj = ET_PatchRest.new(@authStub, completeURL, @props)
+    end
+
+    def delete()
+      completeURL = @endpoint
+      # All URL Props are required when doing Patch
+      @urlProps.each do |value|
+        if !@props || !@props.has_key?(value) then
+          raise "Unable to process request due to missing required prop: #{value}"
+        end
+      end
+
+      if @props and @props.is_a? Hash then
+        @props.each do |k,v|
+          if @urlProps.include?(k) then
+            completeURL.sub!("{#{k}}", v)
+          end
+        end
+      end
+
+      ET_DeleteRest.new(@authStub, completeURL)
+    end
+
+  end
+
+
+  class ET_GetRest < ET_Constructor
+    def initialize(authStub, endpoint, qs = nil)
+      authStub.refreshToken
+
+      if qs then
+        qs['access_token'] = authStub.authToken
+      else
+        qs = {"access_token" => authStub.authToken}
+      end
+
+      uri = URI.parse(endpoint)
+      uri.query = URI.encode_www_form(qs)
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = true
+      request = Net::HTTP::Get.new(uri.request_uri)
+      requestResponse = http.request(request)
+
+      @moreResults = false
+
+      obj = super(requestResponse, true)
+      return obj
+    end
+  end
+
+
+  class ET_ContinueRest < ET_Constructor
+    def initialize(authStub, endpoint, qs = nil)
+      authStub.refreshToken
+
+      if qs then
+        qs['access_token'] = authStub.authToken
+      else
+        qs = {"access_token" => authStub.authToken}
+      end
+
+      uri = URI.parse(endpoint)
+      uri.query = URI.encode_www_form(qs)
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = true
+      request = Net::HTTP::Get.new(uri.request_uri)
+      requestResponse = http.request(request)
+
+      @moreResults = false
+
+      super(requestResponse, true)
+    end
+  end
+
+
+  class ET_PostRest < ET_Constructor
+    def initialize(authStub, endpoint, payload)
+      authStub.refreshToken
+
+      qs = {"access_token" => authStub.authToken}
+      uri = URI.parse(endpoint)
+      uri.query = URI.encode_www_form(qs)
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = true
+      request = Net::HTTP::Post.new(uri.request_uri)
+      request.body =  payload.to_json
+      request.add_field "Content-Type", "application/json"
+      requestResponse = http.request(request)
+
+      super(requestResponse, true)
+
+    end
+  end
+
+  class ET_PatchRest < ET_Constructor
+    def initialize(authStub, endpoint, payload)
+      authStub.refreshToken
+
+      qs = {"access_token" => authStub.authToken}
+      uri = URI.parse(endpoint)
+      uri.query = URI.encode_www_form(qs)
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = true
+      request = Net::HTTP::Patch.new(uri.request_uri)
+      request.body =  payload.to_json
+      request.add_field "Content-Type", "application/json"
+      requestResponse = http.request(request)
+      super(requestResponse, true)
+
+    end
+  end
+
+  class ET_DeleteRest < ET_Constructor
+    def initialize(authStub, endpoint)
+      authStub.refreshToken
+
+      qs = {"access_token" => authStub.authToken}
+
+      uri = URI.parse(endpoint)
+      uri.query = URI.encode_www_form(qs)
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = true
+      request = Net::HTTP::Delete.new(uri.request_uri)
+      requestResponse = http.request(request)
+      super(requestResponse, true)
+
+    end
+  end
+
+  class ET_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
+
+  class ET_DataExtension < ET_CUDSupport
+    attr_accessor :columns
+
+    def initialize
+      super
+      @obj = 'DataExtension'
+    end
+
+    def post
+      originalProps = @props
+
+      if @props.is_a? Array then
+        multiDE = []
+        @props.each { |currentDE|
+          currentDE['Fields'] = {}
+          currentDE['Fields']['Field'] = []
+          currentDE['columns'].each { |key|
+            currentDE['Fields']['Field'].push(key)
+          }
+          currentDE.delete('columns')
+          multiDE.push(currentDE.dup)
+        }
+
+        @props = multiDE
+      else
+        @props['Fields'] = {}
+        @props['Fields']['Field'] = []
+
+        @columns.each { |key|
+        @props['Fields']['Field'].push(key)
+        }
+      end
+
+      obj = super
+      @props = originalProps
+      return obj
+    end
+
+    def patch
+      @props['Fields'] = {}
+      @props['Fields']['Field'] = []
+      @columns.each { |key|
+        @props['Fields']['Field'].push(key)
+      }
+      obj = super
+      @props.delete("Fields")
+      return obj
+    end
+
+    class Column < ET_GetSupport
+      def initialize
+        super
+        @obj = 'DataExtensionField'
+      end
+
+      def get
+
+        if props and props.is_a? Array then
+          @props = props
+        end
+
+        if @props and @props.is_a? Hash then
+          @props = @props.keys
+        end
+
+        if filter and filter.is_a? Hash then
+          @filter = filter
+        end
+
+        fixCustomerKey = false
+        if filter and filter.is_a? Hash then
+          @filter = filter
+          if @filter.has_key?("Property") && @filter["Property"] == "CustomerKey" then
+            @filter["Property"]  = "DataExtension.CustomerKey"
+            fixCustomerKey = true
+          end
+        end
+
+        obj = ET_Get.new(@authStub, @obj, @props, @filter)
+        @lastRequestID = obj.request_id
+
+        if fixCustomerKey then
+          @filter["Property"] = "CustomerKey"
+        end
+
+        return obj
+      end
+    end
+
+    class Row < ET_CUDSupport
+      attr_accessor :Name, :CustomerKey
+
+      def initialize()
+        super
+        @obj = "DataExtensionObject"
+      end
+
+      def get
+        getName
+        if props and props.is_a? Array then
+          @props = props
+        end
+
+        if @props and @props.is_a? Hash then
+          @props = @props.keys
+        end
+
+        if filter and filter.is_a? Hash then
+          @filter = filter
+        end
+
+        obj = ET_Get.new(@authStub, "DataExtensionObject[#{@Name}]", @props, @filter)
+        @lastRequestID = obj.request_id
+
+        return obj
+      end
+
+      def post
+        getCustomerKey
+        originalProps = @props
+        ## FIX THIS
+        if @props.is_a? Array then
+ #         multiRow = []
+ #         @props.each { |currentDE|
+
+ #           currentDE['columns'].each { |key|
+ #             currentDE['Fields'] = {}
+ #             currentDE['Fields']['Field'] = []
+ #             currentDE['Fields']['Field'].push(key)
+ #           }
+ #           currentDE.delete('columns')
+ #           multiRow.push(currentDE.dup)
+ #         }
+
+ #         @props = multiRow
+        else
+          currentFields = []
+          currentProp = {}
+
+          @props.each { |key,value|
+            currentFields.push({"Name" => key, "Value" => value})
+          }
+          currentProp['CustomerKey'] = @CustomerKey
+          currentProp['Properties'] = {}
+          currentProp['Properties']['Property'] = currentFields
+        end
+
+        obj = ET_Post.new(@authStub, @obj, currentProp)
+        @props = originalProps
+        obj
+      end
+
+      def patch
+        getCustomerKey
+        currentFields = []
+        currentProp = {}
+
+        @props.each { |key,value|
+          currentFields.push({"Name" => key, "Value" => value})
+        }
+        currentProp['CustomerKey'] = @CustomerKey
+        currentProp['Properties'] = {}
+        currentProp['Properties']['Property'] = currentFields
+
+        ET_Patch.new(@authStub, @obj, currentProp)
+      end
+      def delete
+        getCustomerKey
+        currentFields = []
+        currentProp = {}
+
+        @props.each { |key,value|
+          currentFields.push({"Name" => key, "Value" => value})
+        }
+        currentProp['CustomerKey'] = @CustomerKey
+        currentProp['Keys'] = {}
+        currentProp['Keys']['Key'] = currentFields
+
+        ET_Delete.new(@authStub, @obj, currentProp)
+      end
+
+      private
+      def getCustomerKey
+        if @CustomerKey.nil? then
+          if @CustomerKey.nil? && @Name.nil? then
+            raise 'Unable to process DataExtension::Row request due to CustomerKey and Name not being defined on ET_DatExtension::row'
+          else
+            de = ET_DataExtension.new
+            de.authStub = @authStub
+            de.props = ["Name","CustomerKey"]
+            de.filter = {'Property' => 'CustomerKey','SimpleOperator' => 'equals','Value' => @Name}
+            getResponse = de.get
+            if getResponse.status && (getResponse.results.length == 1) then
+              @CustomerKey = getResponse.results[0][:customer_key]
+            else
+              raise 'Unable to process DataExtension::Row request due to unable to find DataExtension based on Name'
+            end
+          end
+        end
+      end
+
+      def getName
+        if @Name.nil? then
+          if @CustomerKey.nil? && @Name.nil? then
+            raise 'Unable to process DataExtension::Row request due to CustomerKey and Name not being defined on ET_DatExtension::row'
+          else
+            de = ET_DataExtension.new
+            de.authStub = @authStub
+            de.props = ["Name","CustomerKey"]
+            de.filter = {'Property' => 'CustomerKey','SimpleOperator' => 'equals','Value' => @CustomerKey}
+            getResponse = de.get
+            if getResponse.status && (getResponse.results.length == 1) then
+              @Name = getResponse.results[0][:name]
+            else
+              raise 'Unable to process DataExtension::Row request due to unable to find DataExtension based on CustomerKey'
+            end
+          end
+        end
+      end
+    end
+  end
+
+  class ET_TriggeredSend < ET_CUDSupport
+    attr_accessor :subscribers
+    def initialize
+      super
+      @obj = 'TriggeredSendDefinition'
+    end
+
+    def send
+      @tscall = {"TriggeredSendDefinition" => @props, "Subscribers" => @subscribers}
+      ET_Post.new(@authStub, "TriggeredSend", @tscall)
+    end
+  end
+=end