eloqua_api 0.0.5 → 0.0.7

data/lib/eloqua_api/bulk/export.rb

@@ -0,0 +1,14 @@
+module Eloqua
+  module Export
+    def define_export(export)
+      post("contact/export", export)
+    end
+    
+    def retrieve_export(export_uri, options={})
+      options[:page] ||= 1
+      options[:pageSize] ||= 50000
+
+      get("%s/data" % export_uri, options)
+    end
+  end
+end

data/lib/eloqua_api/bulk/sync.rb

@@ -0,0 +1,12 @@
+module Eloqua
+  module Sync
+    def sync(export_uri, options={})
+      options[:syncedInstanceUri] ||= export_uri
+      post("sync", options)
+    end
+
+    def sync_status(sync_uri, options={})
+      get(sync_uri, options)
+    end
+  end
+end

data/lib/eloqua_api/bulk_client.rb

@@ -1,29 +1,13 @@
-module Eloqua
-  class BulkClient < Eloqua::Client
-    BULK_API_PATH = "/API/Bulk/1.0"
-
-    def bulk_path(path)
-      BULK_API_PATH + '/' + path
-    end
-
-    # convenience methods
-    def define_export(export_definition)
-      post(bulk_path("contact/export"), export_definition)
-    end
+require 'eloqua_api/bulk/export'
+require 'eloqua_api/bulk/sync'
 
-    def sync(export_uri)
-      post(bulk_path("sync"), {"syncedInstanceUri" => export_uri}.to_json)
-    end
-
-    def sync_status(sync_uri)
-      get(bulk_path(sync_uri))
-    end
-
-    def retrieve_export(export_uri, options={})
-      options[:page] ||= 1
-      options[:page_size] ||= 50000
+module Eloqua
+  class BulkClient < Client
+    include Export
+    include Sync
 
-      get(bulk_path("#{export_uri}/data?page=#{options[:page]}&pageSize=#{options[:page_size]}"))
+    def build_path(*segments)
+      super('/Bulk/', *segments)
     end
   end
-end
+end

data/lib/eloqua_api/client.rb

@@ -1,54 +1,239 @@
-require 'net/https'
 require 'json'
+require 'httmultiparty'
+require 'uri'
+require 'cgi'
 
 module Eloqua
+  class HTTPClient
+    include HTTMultiParty
+
+    class Parser::CustomJSON < HTTParty::Parser
+      def parse
+        JSON.parse(body) if body
+      rescue JSON::ParserError
+        body
+      end
+    end
+    parser Parser::CustomJSON
+
+    headers 'User-Agent' => 'Kapost Eloqua API Client'
+    headers 'Accept' => 'application/json'
+    headers 'Content-Type' => 'application/json'
+
+    query_string_normalizer proc { |query|
+      qs = HashConversions.to_params(query)
+      qs.gsub!(/orderBy=(.*?)%2B(.*?)(&|\?|$)/) do |m|
+        "orderBy=#{$1}+#{$2}#{$3}"
+      end
+      qs
+    }
+
+    format :json
+    # debug_output $stdout
+  end
+
   class Client
-    attr_reader :site, :user
+    SITE = 'eloqua.com'
+    BASE_URI = "https://secure.#{SITE}"
+    BASE_LOGIN_URI = "https://login.#{SITE}"
+    BASE_VERSION = '1.0'
+    BASE_PATH = '/API/'
+
+    AUTHORIZE_PATH = '/auth/oauth2/authorize'
+    TOKEN_PATH = '/auth/oauth2/token'
+    TOKEN_PATH_HEADERS = 
+    {
+      'Accept'          => 'application/json, text/javascript, */*; q=0.01',
+      'Accept-Language' => 'en-US,en;q=0.5',
+      'Content-Type'    => 'application/x-www-form-urlencoded; charset=UTF-8'
+    }.freeze
+
+    attr_reader :opts
+
+    attr_accessor :on_authorize
+    attr_accessor :on_refresh_token
+    attr_accessor :on_url_changed
 
-    def initialize(site=nil, user=nil, password=nil)
-      @site = site
-      @user = user
-      @password = password
+    def initialize(opts={})
+      @opts = opts.is_a?(Hash) ? opts.dup : {}
+      @opts[:url] ||= BASE_URI
+      @opts[:version] ||= BASE_VERSION
+      @url_changed = false
+      @token_refreshed = false
+    end
 
-      @https = Net::HTTP.new('secure.eloqua.com', 443)
-      @https.use_ssl = true
-      @https.verify_mode = OpenSSL::SSL::VERIFY_PEER
+    def version
+      @opts[:version]
     end
 
-    METHODS = {
-            :get    => ::Net::HTTP::Get,
-            :post   => ::Net::HTTP::Post,
-            :put    => ::Net::HTTP::Put,
-            :delete => ::Net::HTTP::Delete
-          }
+    def authorize_url(options={})
+      query = {}
+      query[:response_type] = 'code'
+      query[:client_id]     = @opts[:client_id]
+      query[:scope]         = options[:scope] || @opts[:scope] || 'full'
 
-    def delete(path)
-      request(:delete, path)
+      if (state=(options[:state] || @opts[:state]))
+        query[:state] = state
+      end
+
+      query[:redirect_uri]  = escape_uri(options[:redirect_uri] || @opts[:redirect_uri])
+
+      "#{BASE_LOGIN_URI}#{AUTHORIZE_PATH}?#{query.map { |k,v| [k, v].join('=') }.join('&')}"
+    end
+
+    def exchange_token(options={})
+      auth = [@opts[:client_id], @opts[:client_secret]]
+
+      body = {}
+      if options[:code] and @opts[:redirect_uri]
+        body[:grant_type]   = 'authorization_code'
+        body[:code]         = options[:code]
+        body[:redirect_uri] = escape_uri(@opts[:redirect_uri])
+      elsif refresh_token?
+        body[:grant_type]   = 'refresh_token'
+        body[:refresh_token] = @opts[:refresh_token]
+        body[:redirect_uri] = escape_uri(@opts[:redirect_uri])
+      else
+        raise ArgumentError, 'code and redirect_uri or refresh_token and redirect_uri is required'
+      end
+
+      result = http(BASE_LOGIN_URI, auth).post(TOKEN_PATH, :body => body, :headers => TOKEN_PATH_HEADERS)
+      return result unless result.code == 200 and result.parsed_response.is_a? Hash
+
+      response = result.parsed_response
+      return result unless response['access_token'] and response['refresh_token']
+
+      @opts[:access_token] = response['access_token']
+      @opts[:refresh_token] = response['refresh_token']
+        
+      @http = nil
+      @token_refreshed = true
+
+      if refresh_token? and on_refresh_token?
+        on_refresh_token.call(response)
+      elsif options[:code] and @opts[:redirect_uri] and on_authorize?
+        on_authorize.call(response)
+      end
+
+      result
+    end
+
+    def on_authorize?
+      on_authorize.is_a? Proc
+    end
+
+    def on_refresh_token?
+      on_refresh_token.is_a? Proc
+    end
+
+    def on_url_changed?
+      on_url_changed.is_a? Proc
+    end
+
+    def url
+      @opts[:url]
+    end
+
+    def url_changed?
+      @url_changed
+    end
+
+    def token_refreshed?
+      @token_refreshed
+    end
+
+    def build_path(*segments)
+      File.join(BASE_PATH, *segments.shift, version, *segments)
+    end
+
+    def login
+      @http = nil
+
+      uri = BASE_URI
+      result = http(BASE_LOGIN_URI).get('/id')
+      if result.code == 200 and result.parsed_response.is_a? Hash
+        uri = result.parsed_response["urls"]["base"]
+      end
+
+      @url_changed = (uri != @opts[:url])
+      if @url_changed
+        @opts[:url] = uri
+        on_url_changed.call(uri) if on_url_changed?
+      end
+
+      result
     end
 
-    def get(path)
-      request(:get, path)
+    def get(path, query={})
+      request(:get, build_path(path), :query => query)
     end
 
     def post(path, body={})
-      request(:post, path, body)
+      request(:post, build_path(path), :body => body.to_json)
+    end
+
+    def multipart_post(path, body={})
+      request(:post, build_path(path), :body => body)
     end
 
     def put(path, body={})
-      request(:put, path, body)
+      request(:put, build_path(path), :body => body.to_json)
+    end
+
+    def delete(path)
+      request(:delete, build_path(path))
+    end
+
+    protected
+
+    def refresh_token?
+      @opts[:refresh_token] and 
+      @opts[:redirect_uri]
     end
 
-    def request(method, path, body={})
-      request = METHODS[method].new(path, {'Content-Type' =>'application/json'})
-      request.basic_auth @site + '\\' + @user, @password
+    def escape_uri(url)
+      URI.escape(URI.unescape(url))
+    end
+
+    def request(method, path, params={}, login_fallback=true)
+      @http ||= http
+
+      result = @http.send(method, path, params)
+      if result.code == 401 and login_fallback
+        exchange_token if refresh_token?
+        
+        if login
+          request(method, path, params, false)
+        else
+          result
+        end
+      else
+        result
+      end
+    end
 
-      case method
-        when :post, :put
-          request.body = body
+    def http(url=nil, auth=nil)
+      url ||= @opts[:url]
+      auth ||= begin
+        if @opts[:access_token]
+          @opts[:access_token]
+        elsif (site=@opts[:site]) and (username=@opts[:username]) and (password=@opts[:password])
+          ["%s\\%s" % [site, username], password]
+        else
+          nil
+        end
       end
 
-      response = @https.request(request)
-      return response
+      Class.new(HTTPClient) do |klass|
+        klass.base_uri(url.to_s) if url
+
+        if auth.is_a?(String) and auth.size > 0
+          klass.headers("Authorization" => "Bearer %s" % auth)
+        elsif auth.is_a?(Array) and auth.size == 2
+          klass.basic_auth(*auth)
+        end
+      end
     end
   end
-end
+end
+

data/lib/eloqua_api/rest/campaign.rb

@@ -0,0 +1,22 @@
+module Eloqua
+  module Campaign
+    def get_campaign(campaign_id, options={})
+      get("assets/campaign/%s" % campaign_id, options)
+    end
+
+    def get_recent_campaigns(options={})
+      options[:count] ||= 10
+      options[:depth] ||= "minimal"
+      
+      get("assets/campaigns/recent", options)
+    end
+
+    def get_campaigns(options={})
+      options[:count] ||= 10
+      options[:depth] ||= "minimal"
+      options[:orderBy] ||= "createdAt+DESC"
+
+      get("assets/campaigns", options)
+    end
+  end
+end

data/lib/eloqua_api/rest/contact.rb

@@ -0,0 +1,39 @@
+module Eloqua
+  module Contact
+    def get_contact(contact_id, options={})
+      options[:depth] ||= "minimal"
+  
+      get("data/contact/#{contact_id}", options)
+    end
+    
+    def get_contact_fields(options={})
+      options[:depth] ||= "minimal"
+
+      get("assets/contact/fields", options)
+    end
+    
+    def create_contact(data)
+      post("data/contact", data)
+    end
+    
+    def update_contact(contact_id, data)
+      put("data/contact/#{contact_id}", data)
+    end
+    
+    def get_contacts(options={})
+      options[:count] ||= 10
+      options[:depth] ||= "minimal"
+
+      get("data/contacts", options)
+    end
+
+    def contact_activity(contact_id, options={})
+      options[:startDate] ||= 1.year.ago.to_i
+      options[:endDate] ||= Time.now.to_i
+      options[:type] ||= "webVisit"
+      options[:count] ||= 1000
+
+      get("data/activities/contact/%s" % contact_id, options)
+    end
+  end
+end

data/lib/eloqua_api/rest/email.rb

@@ -0,0 +1,50 @@
+module Eloqua
+  module Email
+    def create_email(email)
+      post("assets/email", email)
+    end
+
+    def delete_email(id)
+      delete("assets/email/%s" % id)
+    end
+
+    def get_email(id, options={})
+      get("assets/email/%s" % id, options)
+    end
+
+    def get_email_preview(id, options={})
+      get("assets/email/%s/preview" % id, options)
+    end
+
+    def get_recent_emails(options={})
+      options[:count] ||= 10
+      options[:depth] ||= "minimal"
+      
+      get("assets/emails/recent", options)
+    end
+
+    def get_emails(options={})
+      options[:count] ||= 10
+      options[:depth] ||= "minimal"
+      options[:orderBy] ||= "createdAt+DESC"
+
+      get("assets/emails", options)
+    end 
+
+    def get_email_template(id, options={})
+      get("assets/email/template/%s" % id, options)
+    end
+
+    def get_email_templates(options={})
+      get("assets/templates/email", options)
+    end
+    
+    def get_email_deployments(options={})
+      options[:count] ||= 50
+      options[:depth] ||= "complete"
+      options[:orderBy] ||= "createdAt+DESC"
+
+      get("assets/email/deployments", options)
+    end
+  end
+end

data/lib/eloqua_api/rest/imported_file.rb

@@ -0,0 +1,43 @@
+module Eloqua
+  module ImportedFile
+    def create_imported_file(file)
+      multipart_post("assets/importedFile/content", file)
+    end
+
+    def replace_imported_file(id, file)
+      multipart_post("assets/importedFile/%s/content/replace" % id, file)
+    end
+
+    def get_imported_file(id, options={})
+      get("assets/importedFile/%s" % id, options)
+    end
+
+    def update_imported_file(id, file)
+      put("assets/importedFile/%s" % id, file)
+    end
+
+    def delete_imported_file(id)
+      delete("assets/importedFile/%s" % id)
+    end
+
+    def imported_file_folder(id, options={})
+      options[:depth] ||= 'minimal'
+
+      get("assets/importedFile/folder/%s" % id, options)
+    end
+
+    def imported_file_folder_folders(id, options={})
+      options[:count] ||= 10
+      options[:depth] ||= 'minimal'
+
+      get("assets/importedFile/folder/%s/folders" % id, options)
+    end
+
+    def imported_file_folders(options={})
+      options[:count] ||= 10
+      options[:depth] ||= 'minimal'
+
+      get("assets/importedFile/folders", options)
+    end
+  end
+end

data/lib/eloqua_api/rest/landing_page.rb

@@ -0,0 +1,50 @@
+module Eloqua
+  module LandingPage
+    def create_landing_page(page)
+      post("assets/landingPage", page)
+    end
+
+    def delete_landing_page(id)
+      delete("assets/landingPage/%s" % id)
+    end
+
+    def validate_landing_page(id, options={})
+      get("assets/landingPage/%s/active/validatonErrors" % id)
+    end
+
+    def activate_landing_page(id, options={})
+      post("assets/landingPage/%s/active" % id, options)
+    end
+
+    def get_landing_page(id)
+      get("assets/landingPage/%s" % id)
+    end
+
+    def get_landing_page_preview(id, options={})
+      get("assets/landingPage/%s/preview" % id, options)
+    end
+
+    def get_recent_landing_pages(options={})
+      options[:count] ||= 10
+      options[:depth] ||= "minimal"
+      
+      get("assets/landingPages/recent", options)
+    end
+
+    def get_landing_pages(options={})
+      options[:count] ||= 10
+      options[:depth] ||= "minimal"
+      options[:orderBy] ||= "createdAt+DESC"
+
+      get("assets/landingPages", options)
+    end 
+
+    def get_landing_page_template(id, options={})
+      get("assets/landingPage/template/%s" % id, options)
+    end
+
+    def get_landing_page_templates(options={})
+      get("assets/templates/landingpage", options)
+    end
+  end
+end

data/lib/eloqua_api/rest/microsite.rb

@@ -0,0 +1,7 @@
+module Eloqua
+  module Microsite
+    def get_micro_site(id)
+      get("assets/microsite/%s" % id)
+    end
+  end
+end

data/lib/eloqua_api/rest/segment.rb

@@ -0,0 +1,11 @@
+module Eloqua
+  module Segment
+    def create_segment(segment)
+      post("assets/contact/segment", segment)
+    end
+
+    def get_segment(id)
+      get("assets/contact/segment/%s" % id)
+    end
+  end
+end

data/lib/eloqua_api/rest/user.rb

@@ -0,0 +1,14 @@
+module Eloqua
+  module User
+    def get_user(id, options={})
+      get("system/user/%s" % id, options)
+    end
+
+    def get_users(options={})
+      options[:count] ||= 10
+      options[:depth] ||= "minimal"
+
+      get("system/users", options)
+    end
+  end
+end

data/lib/eloqua_api/rest_client.rb

@@ -1,82 +1,25 @@
-module Eloqua
-  class RESTClient < Eloqua::Client
-    REST_API_PATH = "/API/REST/1.0"
-
-    def rest_path(path)
-      REST_API_PATH + '/' + path
-    end
-
-    # convenience methods
-    
-    # SEGMENTS
-    def create_segment(segment_definition)
-      # debugger
-      post(rest_path("assets/contact/segment"), segment_definition)
-    end
-
-    def get_segment(segment_id)
-      get(rest_path("assets/contact/segment/#{segment_id}"))
-    end
-    
-    # LANDING PAGES
-    def get_landing_page(landing_page_id)
-      get(rest_path("assets/landingPage/#{landing_page_id}"))
-    end
-    
-    def get_landing_pages(options={})
-     options["count"] ||= 10
-     options["depth"] ||= "minimal"
-     options["order_by"] ||= "createdAt+DESC"
-
-     query = "count=#{options["count"]}&depth=#{options["depth"]}&orderBy=#{options["order_by"]}"
-
-     get(rest_path("assets/landingPages?#{query}"))
-   end 
-  
-    # EMAILS
-    def get_email(email_id)
-      get(rest_path("assets/email/#{email_id}"))
-    end
-
-    def get_emails(options={})
-     options["count"] ||= 10
-     options["depth"] ||= "minimal"
-     options["order_by"] ||= "createdAt+DESC"
-
-     query = "count=#{options["count"]}&depth=#{options["depth"]}&orderBy=#{options["order_by"]}"
-
-     get(rest_path("assets/emails?#{query}"))
-   end 
-
-    # CAMPAIGNS
-    def get_campaign(campaign_id)
-      get(rest_path("assets/campaign/#{campaign_id}"))
-    end
-    
-    def get_recent_campaigns(options={})
-      options["count"] ||= 10
-      options["depth"] ||= "minimal"
-      get(rest_path("assets/campaigns/recent?count=#{options["count"]}&depth=#{options["depth"]}"))
-    end
-    
-    def get_campaigns(options={})
-      options["count"] ||= 10
-      options["depth"] ||= "minimal"
-      options["order_by"] ||= "createdAt+DESC"
-      
-      query = "count=#{options["count"]}&depth=#{options["depth"]}&orderBy=#{options["order_by"]}"
-      
-      get(rest_path("assets/campaigns?#{query}"))
-    end
+require 'eloqua_api/rest/segment'
+require 'eloqua_api/rest/landing_page'
+require 'eloqua_api/rest/email'
+require 'eloqua_api/rest/campaign'
+require 'eloqua_api/rest/contact'
+require 'eloqua_api/rest/user'
+require 'eloqua_api/rest/microsite'
+require 'eloqua_api/rest/imported_file'
 
-    # CONTACTS
-    def contact_activity(contact_id, options={})
-      options["start_date"] ||= 1.year.ago.to_i
-      options["end_date"] ||= Time.now.to_i
-      options["type"] ||= "webVisit"
-      options["count"] ||= 1000
-
-      get(rest_path("data/activities/contact/#{contact_id}?startDate=#{options["start_date"]}&endDate=#{options["end_date"]}&type=#{options["type"]}&count=#{options["count"]}"))
+module Eloqua
+  class RESTClient < Client
+    include Segment
+    include LandingPage
+    include Email
+    include Campaign
+    include Contact
+    include User
+    include Microsite
+    include ImportedFile
+
+    def build_path(*segments)
+      super('/REST/', *segments)
     end
   end
 end

data/lib/eloqua_api.rb

@@ -1,4 +1,3 @@
 require 'eloqua_api/client'
 require 'eloqua_api/rest_client'
 require 'eloqua_api/bulk_client'
-

metadata

@@ -1,11 +1,12 @@
 --- !ruby/object:Gem::Specification
 name: eloqua_api
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.7
   prerelease: 
 platform: ruby
 authors:
 - Nader Akhnoukh
+- Mihail Szabolcs
 autorequire: 
 bindir: bin
 cert_chain: []
@@ -27,14 +28,56 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: httmultiparty
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Convenience wrapper for Eloqua REST and Bulk APIs
 email: nader@kapost.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/eloqua_api/bulk/export.rb
+- lib/eloqua_api/bulk/sync.rb
 - lib/eloqua_api/bulk_client.rb
 - lib/eloqua_api/client.rb
+- lib/eloqua_api/rest/campaign.rb
+- lib/eloqua_api/rest/contact.rb
+- lib/eloqua_api/rest/email.rb
+- lib/eloqua_api/rest/imported_file.rb
+- lib/eloqua_api/rest/landing_page.rb
+- lib/eloqua_api/rest/microsite.rb
+- lib/eloqua_api/rest/segment.rb
+- lib/eloqua_api/rest/user.rb
 - lib/eloqua_api/rest_client.rb
 - lib/eloqua_api.rb
 homepage: http://github.com/kapost/eloqua_api