eloqua_api 0.0.9 → 0.0.11

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    YzJmNzgwOTEwNjU3OGQ2OGQzZGZlMWVkYWQ0OTUwNjM3ZGM0NjBmOA==
+    YTNmYzc1MDdlMzdjMWY2ZmY4Yjc5NjRjN2NkYzQ4MzYyNjYwYTk1ZQ==
   data.tar.gz: !binary |-
-    NmFhMDllZWQ5YjBmNGM4ZTMwZGZiNzUxMTk3MGZiYjE3ODhiNjc5OA==
+    MDg5ZjU1ZDhjNTg5NzY1YWI5MmNlM2I4NjNlMTQzYTYxNmQ2NDAwYg==
 SHA512:
   metadata.gz: !binary |-
-    YThmZGE2MTk2Mzc3MmI5Y2E2NDExMmE3MmZmMzE2NGVmYzdjYmUwZDI5YTE5
-    MzFkZmUzOTY2YzlhMGY3ODBmZmUxYzBhNWQ4OGQxYzdkYmFmOTFmZGRkYzdh
-    MTk1NzAyOTZmOWVmMmNmZmZmNzllYTBhNTZmMWNlMDlmODE5MDg=
+    MjgxMzZhYzIzOTRkZmRiZDRkNmQ4NjE4NGZjZDZmNGRiMzRkMzJhMWYyMjc3
+    MTIxYjU2NDQyMThmNjkwNmI0NjNjNmI5Y2E5ZjhmNzNhMzBjOGI3MWUwMDAz
+    ZTcxZjM0ZjJlNjA2M2I3Yjk3ZGJkNjQxMjhhNTZjZWRjNmJkZjk=
   data.tar.gz: !binary |-
-    OWU1ZTFiMWEwYmZiODU5NDgxNjdlODBmMWMxMTVjZGEwMTQyZWY3MWIwZTg1
-    NDA4Mzg3Y2RiMTQwYTlkMGVjYTY1Mzg0NGE0ZjQwMjlmZjUyNGU1NmY0NzVl
-    ZTE4NmRhOWY0MDczNWZmNDI3ZDA4YmJlZDg4Y2RhN2NjNWRlZDQ=
+    Y2VmNDZiMGYzMjkxZDg0OWE5YzA3MGZiMDkyYzA3NmY4NDRjNmY2OTdlYjQx
+    Y2RhYjFiMzE2NmMxNmM1MjYxZGUwMWI0ZjA4NTFiZTZlNzFlNGE3MmQ1YTVm
+    ODE1NDc5M2MxYzgwYWRjY2ExNTljZmM4Mzg3NTJjZjM0MmE1OTM=

data/lib/eloqua_api/bulk/export.rb

@@ -10,5 +10,28 @@ module Eloqua
 
       get("%s/data" % export_uri, options)
     end
+
+    #
+    # Version 2.0 of the Bulk API
+    #
+    def define_activity_export(export)
+      post("activities/exports", export)
+    end
+    alias :define_activities_export :define_activity_export
+
+    def retrieve_activity_export(export_uri, options={})
+      options[:limit] ||= 50000
+
+      get("%s/data" % export_uri, options)
+    end
+    alias :retrieve_activities_export :retrieve_activity_export
+
+    def delete_export_definition(export_uri, options={})
+      delete(export_uri)
+    end
+
+    def delete_export(export_uri, options={})
+      delete("%s/data" % export_uri)
+    end
   end
 end

data/lib/eloqua_api/bulk/query.rb

@@ -0,0 +1,224 @@
+module Eloqua
+  #
+  # Usage:
+  #
+  # client = Eloqua::BulkClient.new({ ...  })
+  # client.query("My Query/Export Name").
+  #        select("Activity.Asset.Id AS AssetId", "Activity.Id AS ActivityId").
+  #        from("activities").
+  #        where("Activity.CreatedAt > 2014-08-01", "Activity.Type = EmailOpen").
+  #        limit(3).
+  #        retain(3600).
+  #        execute().
+  #        wait(30).each do |row|
+  #           puts row
+  #        end
+  # 
+  # If anything goes wrong (at any stage of the chain) a Query::Error exception will be thrown 
+  # with a human readable error message, accompanied by the full HTTP request response and code 
+  # when appropriate.
+  #
+
+  class Query
+    class Error < StandardError
+      attr_reader :response
+
+      def initialize(message, response=nil)
+        @response = response
+        super(message)
+      end
+    end
+
+    def initialize(name, client)
+      @name = name
+      @client = client
+      @fields = {}
+      @filter = []
+      @retain = 0
+      @resource = nil
+      @limit = 50000
+      @uri = nil
+      @sync = false
+    end
+
+    def delete
+      raise Error, 'Execute must be called before calling delete.' if @uri.nil?
+      
+      @client.delete_export(@uri)
+      @client.delete_export_definition(@uri)
+
+      self
+    end
+
+    def execute
+      raise Error, 'Execute cannot be called more than once.' unless @uri.nil?
+      raise Error, 'A valid resource must be defined before calling execute.' unless @resource and @client.respond_to?(define_export_method) and @client.respond_to?(retrieve_export_method)
+
+      response = @client.send(define_export_method, to_h)
+      if response.code == 201 and response.parsed_response['uri']
+        @uri = response.parsed_response['uri']
+      else
+        raise Error.new("Could not execute query.", response)
+      end
+
+      self
+    end
+
+    def wait(secs)
+      raise Error, 'Execute must be called before wait.' if @uri.nil?
+
+      response = nil
+      @sync_uri ||= nil
+
+      if @sync_uri.nil?
+        response = @client.syncs(@uri)
+        if response.code == 201 and response.parsed_response['status'] == 'pending'
+          @sync_uri = response.parsed_response['uri']
+        else
+          raise Error.new("Could not sync.", response)
+        end
+      end
+
+      i = 0
+      while i < secs
+        i += 1
+
+        response = @client.syncs_status(@sync_uri)
+        if response.code == 200 and response.parsed_response['status'] == "success"
+          @sync = true
+          return self
+        end
+
+        sleep 1
+      end
+
+      raise Error.new("Could not sync in #{secs} seconds.", response)
+
+      self
+    end
+
+    def count
+      raise Error, 'Wait must be called before calling count.' unless @sync
+
+      response = @client.send(retrieve_export_method, @uri, :limit => @limit)
+      if response.code == 200 and response.parsed_response['totalResults']
+        response.parsed_response['totalResults'].to_i
+      else
+        raise Error.new("Failed to get count.", response)
+      end
+    end
+
+    def each
+      raise Error, 'No block provided.' unless block_given?
+      raise Error, 'Wait must be called before calling each.' unless @sync
+
+      offset = 0
+      while true
+        response = @client.send(retrieve_export_method, @uri, :offset => offset, :limit => @limit)
+        if response.code == 200 and response.parsed_response['totalResults']
+          response = response.parsed_response
+
+          response['items'].each do |item|
+            yield item
+          end if response['items'].is_a?(Array)
+
+          if response['hasMore']
+            offset += @limit
+          else
+            break
+          end
+        else
+          raise Error.new("Failed to get rows for each.", response)
+        end
+      end
+
+      self
+    end
+
+    def to_h
+      hash = {}
+      hash['name'] = @name
+      hash['fields'] = @fields
+      hash['filter'] = @filter.join(' ')
+      hash['secondsToRetainData'] = @retain if @retain > 0
+      hash
+    end
+
+    def limit(n)
+      @limit = n.to_i
+      self
+    end
+
+    def from(resource)
+      @resource = resource.downcase if resource.is_a?(String)
+      self
+    end
+
+    def retain(secs)
+      @retain = secs.to_i
+      self
+    end
+
+    def select(*selectors)
+      fields = {}
+
+      selectors.each do |field|
+        l, op, r = expression(field)
+        if not op.nil? and op.upcase == 'AS'
+          fields[r] = "{{#{l}}}"
+        elsif op.nil?
+          fields[field.gsub('.', '')] = "{{#{field}}}"
+        end
+      end
+
+      @fields.merge!(fields) if fields.any?
+
+      self
+    end
+
+    def where(*conditions)
+      filter = []
+      
+      conditions.each do |condition|
+        l, op, r = expression(condition)
+        filter << "'{{#{l}}}'#{op.upcase}'#{r}'" if l
+      end
+
+      if filter.any?
+        if block_given?
+          @filter << yield(filter.join(" AND "))
+        else
+          @filter << filter.join(" AND ")
+        end
+      end
+
+      self
+    end
+
+    def or(*conditions)
+      where(*conditions) do |filter|
+        "OR ( #{filter} )"
+      end
+
+      self
+    end
+
+    protected
+
+    def define_export_method
+      @define_export_method ||= :"define_#{@resource}_export"
+    end
+
+    def retrieve_export_method
+      @retrieve_export_method ||= :"retrieve_#{@resource}_export"
+    end
+
+    def expression(condition)
+      if condition =~ /^(.*?)\s+(.*?)\s+(.*?)$/
+        [$1, $2, $3]
+      else
+        [nil, nil, nil]
+      end
+    end
+  end
+end

data/lib/eloqua_api/bulk/sync.rb

@@ -8,5 +8,16 @@ module Eloqua
     def sync_status(sync_uri, options={})
       get(sync_uri, options)
     end
+
+    # 
+    # Version 2.0 of the Bulk API changed this endpoint
+    # from sync to syncs.
+    #
+    def syncs(export_uri, options={})
+      options[:syncedInstanceUri] ||= export_uri
+      post("syncs", options)
+    end
+
+    alias :syncs_status :sync_status
   end
 end

data/lib/eloqua_api/bulk_client.rb

@@ -1,11 +1,16 @@
 require 'eloqua_api/bulk/export'
 require 'eloqua_api/bulk/sync'
+require 'eloqua_api/bulk/query'
 
 module Eloqua
   class BulkClient < Client
     include Export
     include Sync
 
+    def query(name)
+      Query.new(name, self)
+    end
+
     def build_path(*segments)
       super('/Bulk/', *segments)
     end

data/lib/eloqua_api/client.rb

@@ -28,7 +28,7 @@ module Eloqua
       qs
     }
 
-    ssl_version :SSLv3
+    # ssl_version :SSLv3
     format :json
     # debug_output $stdout
   end

data/lib/eloqua_api/rest/landing_page.rb

@@ -9,7 +9,7 @@ module Eloqua
     end
 
     def validate_landing_page(id, options={})
-      get("assets/landingPage/%s/active/validatonErrors" % id)
+      get("assets/landingPage/%s/active/validationErrors" % id)
     end
 
     def activate_landing_page(id, options={})

data/lib/eloqua_api/rest/segment.rb

@@ -4,6 +4,10 @@ module Eloqua
       post("assets/contact/segment", segment)
     end
 
+    def create_segment_queue(segment)
+      post("assets/contact/segment/queue/%s" % segment)
+    end
+
     def get_segment(id)
       get("assets/contact/segment/%s" % id)
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: eloqua_api
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.0.11
 platform: ruby
 authors:
 - Nader Akhnoukh
@@ -59,6 +59,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/eloqua_api/bulk/export.rb
+- lib/eloqua_api/bulk/query.rb
 - lib/eloqua_api/bulk/sync.rb
 - lib/eloqua_api/bulk_client.rb
 - lib/eloqua_api/client.rb