datasift 3.0.0.beta4 → 3.0.0

data/examples/live_stream_eg.rb

@@ -86,4 +86,5 @@ class StreamingApi < DataSiftExample
     end
   end
 end
-StreamingApi.new
+
+StreamingApi.new

data/examples/managed_source_eg.rb

@@ -10,13 +10,14 @@ class ManagedSourceApi < DataSiftExample
       puts 'Creating a managed source'
       parameters = {:likes           => true,
                     :posts_by_others => true,
-                    :comments        => true
+                    :comments        => true,
+                    :page_likes      => true
       }
       resources  = [{
                         :parameters => {
-                            :url   => 'http://www.facebook.com/thegaurdian',
+                            :url   => 'http://www.facebook.com/theguardian',
                             :title => 'Some news page',
-                            :id    => :thegaurdian
+                            :id    => :theguardian
                         }
                     }]
       auth       = [{
@@ -30,22 +31,22 @@ class ManagedSourceApi < DataSiftExample
 
       id = source[:data][:id]
 
-      puts 'Starting delivery for my private source'
+      puts "\nStarting delivery for my Managed Source"
       puts @datasift.managed_source.start id
 
-      puts 'Updating'
+      puts "\nUpdating"
       puts @datasift.managed_source.update(id, 'facebook_page', 'Updated source', parameters, resources, auth)
 
-      puts 'Getting info from DataSift about my page'
+      puts "\nGetting info from DataSift about my page"
       puts @datasift.managed_source.get id
 
-      puts 'Fetching logs'
+      puts "\nFetching logs"
       puts @datasift.managed_source.log id
 
-      puts 'Stopping'
+      puts "\nStopping"
       puts @datasift.managed_source.stop id
 
-      puts 'Deleting'
+      puts "\nDeleting"
       puts @datasift.managed_source.delete id
     rescue DataSiftError => dse
       puts dse.message
@@ -53,4 +54,4 @@ class ManagedSourceApi < DataSiftExample
   end
 end
 
-ManagedSourceApi.new
+ManagedSourceApi.new

data/examples/pull.rb

@@ -7,7 +7,7 @@ class PushApi < DataSiftExample
   def run
     begin
       @params = {:output_type => 'pull'}
-      puts 'Validating'
+      puts 'Validating the Pull subscription'
       if @datasift.push.valid? @params
         stream = @datasift.compile 'interaction.content contains "music"'
         subscription = create_push(stream[:data][:hash])
@@ -16,22 +16,22 @@ class PushApi < DataSiftExample
         #pull a bunch of interactions from the push queue - only work if we had set the output_type above to pull
         #pull @datasift.pull subscription_id
 
-        puts 'pullinga'
+        puts "\nPulling data a first time, then waiting 10 seconds"
         @datasift.push.pull(subscription_id).each { |e| puts e }
 
         sleep 10
 
-        puts 'pullingb'
+        puts "\nPulling data a second time, then waiting 10 seconds"
         @datasift.push.pull(subscription_id).each { |e| puts e }
 
         sleep 10
 
-        puts 'pullingc'
+        puts "\nPulling data the third and final time time"
         #passing a lambda is more efficient because it is executed once for each interaction received
         #this saves having to iterate over the array returned so the same iteration isn't done twice
-        @datasift.push.pull(subscription_id,20971520,'', lambda{ |e| puts "on_message => #{e}" })
+        @datasift.push.pull(subscription_id, 20971520, '', lambda{ |e| puts "on_message => #{e}" })
 
-        puts 'pullingdelete'
+        puts "\nDeleting the Pull subscription"
         @datasift.push.delete subscription_id
       end
         #rescue DataSiftError
@@ -39,6 +39,6 @@ class PushApi < DataSiftExample
       puts dse.inspect
     end
   end
-
 end
-PushApi.new().run
+
+PushApi.new().run

data/examples/push_eg.rb

@@ -2,32 +2,49 @@ require './auth'
 class PushApi < DataSiftExample
   def initialize
     super
+    run
   end
 
-  def run(count)
+  def run
     begin
-      subscription = create_push('5cdb0c8b4f3f6ca26f6ba1b086f22edd', count)
+      puts 'Creating Push subscription'
+      subscription = @datasift.push.create @params.merge(hash: '54dbfc8464258de162b7f1a057e630c5', name: 'Ruby Client Example')
 
       subscription_id = subscription[:data][:id]
-      #pull a bunch of interactions from the push queue - only work if we had set the output_type above to pull
-      #pull @datasift.pull subscription_id
+      puts "\nPush subscription created! Push Subscription ID #{subscription_id}"
 
-      puts 'getting subscription info'
-      # get details for a subscription also available are
+      puts "\nGetting subscription info"
+      # Get details for a subscription. Also available are
       # push.[get, get_by_hash,get_by_historics_id]
       puts @datasift.push.get_by_subscription subscription_id
+
+      puts "\nPausing Push subscription"
+      # Push subscriptions can be paused for up to an hour
+      @datasift.push.pause subscription_id
+
+      puts "\nResuming Push subscription"
+      # Push subscriptions must be resumed to continue delivering data
+      @datasift.push.resume subscription_id
+
+      puts "\nGetting subscription logs"
+      # Get logs for a subscription. Also available is
+      # push.log to get logs for all subscriptions
+      puts @datasift.push.log_for subscription_id
+
+      puts "\nStopping Push subscription"
+      # Push subscriptions can be stopped. Once stopped, a
+      # subscription can not be resumed
+      @datasift.push.stop subscription_id
+
+      puts "\nDeleting Push subscription"
+      # Push subscriptions can be deleted. On delete, any undelivered
+      # data is dropped. A delete is permenent.
+      @datasift.push.delete subscription_id
+
     rescue DataSiftError => dse
       puts dse.message
     end
   end
-
-  def get_all
-    puts MultiJson.dump(@datasift.push.get(1, 500))
-  end
 end
 
-p = PushApi.new()
-#for i in 1..1000
-#  p.run(i)
-#end
-p.get_all()
+PushApi.new()

data/lib/cli.rb

@@ -178,8 +178,8 @@ def run_push_command (c, command, p)
         c.push.get_by_subscription(p['id'], opt(p['page'], 0), opt(p['per_page'], 20), opt(p['order_by'], :request_time))
       elsif p['hash']
         c.push.get_by_hash(p['hash'], opt(p['page'], 0), opt(p['per_page'], 20), opt(p['order_by'], :request_time), opt(p['order_dir'], :desc))
-      elsif p['playback_id']
-        c.push.get_by_historics_id(p['playback_id'], opt(p['page'], 0), opt(p['per_page'], 20), opt(p['order_by'], :request_time), opt(p['order_dir'], :desc))
+      elsif p['historics_id']
+        c.push.get_by_historics_id(p['historics_id'], opt(p['page'], 0), opt(p['per_page'], 20), opt(p['order_by'], :request_time), opt(p['order_dir'], :desc))
       else
         c.push.get(opt(p['page'], 0), opt(p['per_page'], 20), opt(p['order_by'], :request_time), opt(p['order_dir'], :desc))
       end

data/lib/datasift.rb

@@ -13,6 +13,8 @@ require dir + '/historics'
 require dir + '/historics_preview'
 require dir + '/managed_source'
 require dir + '/live_stream'
+require dir + '/dynamic_list'
+require dir + '/dynamic_list_replace'
 #
 require 'rbconfig'
 
@@ -53,9 +55,11 @@ module DataSift
       @push              = DataSift::Push.new(config)
       @managed_source    = DataSift::ManagedSource.new(config)
       @historics_preview = DataSift::HistoricsPreview.new(config)
+      @dynamic_list      = DataSift::DynamicList.new(config)
+      @dynamic_list_replace = DataSift::DynamicListReplace.new(config)
     end
 
-    attr_reader :historics, :push, :managed_source, :historics_preview
+    attr_reader :historics, :push, :managed_source, :historics_preview, :dynamic_list, :dynamic_list_replace
 
     ##
     # Checks if the syntax of the given CSDL is valid
@@ -63,7 +67,7 @@ module DataSift
     # the response object itself is returned
     def valid?(csdl, boolResponse = true)
       requires({:csdl => csdl})
-      res= DataSift.request(:POST, 'validate', @config, {:csdl => csdl})
+      res = DataSift.request(:POST, 'validate', @config, {:csdl => csdl})
       boolResponse ? res[:http][:status] == 200 : res
     end
 
@@ -92,7 +96,7 @@ module DataSift
     ##
     # Determine your credit balance or DPU balance.
     def balance
-      DataSift.request(:POST, 'balance', @config, {})
+      DataSift.request(:POST, 'balance', @config)
     end
 
     ##

data/lib/dynamic_list.rb

@@ -0,0 +1,66 @@
+module DataSift
+  class DynamicList < DataSift::ApiResource
+
+    ##
+    # Get all lists and their ids.
+    def get
+      params = {}
+      requires params
+      DataSift.request(:GET, 'list/get', @config, params)
+    end
+
+    ##
+    # Create a new dynamic list
+    def create (type, name)
+      params = {
+          :type => type
+      }
+      requires params
+      params[:name] = name
+      DataSift.request(:POST, 'list/create', @config, params)
+    end
+
+    ##
+    # Delete a dynamic list
+    def delete (id)
+      params = {
+          :id => id
+      }
+      requires params
+      DataSift.request(:DELETE, 'list/delete', @config, params)
+    end
+
+    ##
+    # Check if items exist in given list
+    def exists (id, items)
+      params = {
+          :id => id,
+          :items => items
+      }
+      requires params
+      DataSift.request(:POST, 'list/exists', @config, params)
+    end
+
+    ##
+    # Add items to a given list
+    def add (id, items)
+      params = {
+          :id => id,
+          :items => items
+      }
+      requires params
+      DataSift.request(:POST, 'list/add', @config, params)
+    end
+
+    ##
+    # Remove items from a given list
+    def remove (id, items)
+      params = {
+          :id => id,
+          :items => items
+      }
+      requires params
+      DataSift.request(:POST, 'list/remove', @config, params)
+    end
+  end
+end

data/lib/dynamic_list_replace.rb

@@ -0,0 +1,45 @@
+module DataSift
+  class DynamicListReplace < DataSift::ApiResource
+
+    ##
+    # Start a new replace list
+    def start (list_id)
+      params = {
+          :list_id => list_id
+      }
+      requires params
+      DataSift.request(:POST, 'list/replace/start', @config, params)
+    end
+
+    ##
+    # Commit the replace list
+    def commit (id)
+      params = {
+          :id => id
+      }
+      requires params
+      DataSift.request(:POST, 'list/replace/commit', @config, params)
+    end
+
+    ##
+    # Abort the replace list
+    def abort (id)
+      params = {
+          :id => id
+      }
+      requires params
+      DataSift.request(:POST, 'list/replace/abort', @config, params)
+    end
+
+    ##
+    # Add items to the replace list
+    def add (id, items)
+      params = {
+          :id => id,
+          :items => items
+      }
+      requires params
+      DataSift.request(:POST, 'list/replace/add', @config, params)
+    end
+  end
+end

data/lib/historics.rb

@@ -16,6 +16,22 @@ module DataSift
       DataSift.request(:POST, 'historics/prepare', @config, params)
     end
 
+    # Pause historics query.
+    def pause(id, reason = '')
+      params = {:id => id}
+      requires params
+      params[:reason] = reason
+      DataSift.request(:PUT, 'historics/pause', @config, params)
+    end
+
+    ##
+    # Resume historics query.
+    def resume(id)
+      params = {:id => id}
+      requires params
+      DataSift.request(:PUT, 'historics/resume', @config, params)
+    end
+
     ##
     # Starts historics query.
     def start(id)
@@ -32,6 +48,7 @@ module DataSift
       params[:reason] = reason
       DataSift.request(:POST, 'historics/stop', @config, params)
     end
+    ##
 
     ##
     # Check the data coverage in the archive for a specified interval.

data/lib/historics_preview.rb

@@ -1,9 +1,10 @@
 module DataSift
   class HistoricsPreview < DataSift::ApiResource
 
-    def create(hash, parameters, start, end_time = nil)
+    def create(hash, sources, parameters, start, end_time = nil)
       params = {
           :hash       => hash,
+          :sources    => sources,
           :parameters => parameters,
           :start      => start
       }

data/lib/push.rb

@@ -24,7 +24,6 @@ module DataSift
       DataSift.request(:POST, 'push/create', @config, params)
     end
 
-
     ##
     # Update the name or output parameters for an existing subscription
     def update (params)
@@ -36,7 +35,7 @@ module DataSift
     def pause(id)
       params = {:id => id}
       requires params
-      DataSift.request(:POST, 'push/pause', @config, params)
+      DataSift.request(:PUT, 'push/pause', @config, params)
     end
 
     ##
@@ -44,7 +43,7 @@ module DataSift
     def resume(id)
       params = {:id => id}
       requires params
-      DataSift.request(:POST, 'push/resume', @config, params)
+      DataSift.request(:PUT, 'push/resume', @config, params)
     end
 
     ##
@@ -52,7 +51,7 @@ module DataSift
     def stop(id)
       params = {:id => id}
       requires params
-      DataSift.request(:POST, 'push/stop', @config, params)
+      DataSift.request(:PUT, 'push/stop', @config, params)
     end
 
     ##
@@ -65,7 +64,7 @@ module DataSift
 
     ##
     # Retrieve log messages for a specific subscription
-    def logs_for (id, page = 1, per_page = 20, order_by = :request_time, order_dir = :desc)
+    def log_for(id, page = 1, per_page = 20, order_by = :request_time, order_dir = :desc)
       params = {
           :id => id,
           :page => page,
@@ -78,7 +77,7 @@ module DataSift
 
     ##
     # Retrieve log messages for all subscriptions
-    def logs (page = 1, per_page = 20, order_by = :request_time, order_dir = :desc)
+    def log(page = 1, per_page = 20, order_by = :request_time, order_dir = :desc)
       params = {
           :page => page,
           :per_page => per_page,
@@ -90,20 +89,14 @@ module DataSift
 
     ##
     # Get details of the subscription with the given ID
-    def get_by_subscription(id, page = 1, per_page = 20, order_by = :request_time, order_dir = :desc)
-      params = {
-          :id => id,
-          :page => page,
-          :per_page => per_page,
-          :order_by => order_by,
-          :order_dir => order_dir
-      }
+    def get_by_subscription(id)
+      params = { :id => id }
       DataSift.request(:GET, 'push/get', @config, params)
     end
 
     ##
     # Get details of the subscription with the given stream ID/hash
-    def get_by_hash(hash, page = 1, per_page = 20, order_by = :request_time, order_dir = :desc)
+    def get_by_hash(hash, page = 1, per_page = 20, order_by = :created_at, order_dir = :desc)
       params = {
           :hash => hash,
           :page => page,
@@ -116,7 +109,7 @@ module DataSift
 
     ##
     # Get details of the subscription with the given Historics ID
-    def get_by_historics_id(id, page = 1, per_page = 20, order_by = :request_time, order_dir = :desc)
+    def get_by_historics_id(id, page = 1, per_page = 20, order_by = :created_at, order_dir = :desc)
       params = {
           :historics_id => id,
           :page => page,
@@ -141,7 +134,7 @@ module DataSift
 
     ##
     # Pull data from a 'pull' type Push Subscription
-    def pull(id, size = 20971520, cursor = '', callback = nil)
+    def pull(id, size = 52428800, cursor = '', callback = nil)
       params = {
           :id => id,
           :size => size,