datasift 3.2.0 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c6c428274cf28d80ef439f0ca06a5a247cf70140
-  data.tar.gz: dc0df1b7d90456facf9cdc193ee69a2ebd5ab210
+  metadata.gz: b1fe731a05bf2f78cee04bd0d37a053991ee0b08
+  data.tar.gz: 119a97e10c022290c0a239c0fd192b63a13eca3d
 SHA512:
-  metadata.gz: c150becbafbc9ddf74a49b482bd2b83f93b67595701779c7383c6232b78739099982f1e4cdd6170b0fe8b13b05ef28c01ab96e28b709d8f31fd399dd12e04956
-  data.tar.gz: 9188cf1a6dead964bfee1a77ea8d3ecad37e4261af29eab15e505c7f51d9a0b4d7998aee69eae75f141670eed02bfd55459f8e28460e047d1314628a13f189e4
+  metadata.gz: 660b017e290d8218413938369e93f5bdf3c784971d954497d6b8d14de9049dca430b4a78f13867acf458fe10085815357d7d7b0a0016ec4a962e2eaf87c0890c
+  data.tar.gz: d99b43dc735b245c684fffde08cdb65ee4fa47c892c91330e6ee67def6a634df015ddeb46c16b6ba7c4ebfcac07c917610c6cc52cb391c3f375f74a74e76dd7c

data/.travis.yml

@@ -1,4 +1,5 @@
 language: ruby
+sudo: false
 rvm:
   - 1.9.3
   - 2.0.0

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 CHANGELOG
 ================================
+## v.3.3.0 (2015-08-05)
+### Added
+* Explicit support for 429 errors from the API
+* PYLON Nested query example
+
+### Changed
+* Default API version to 1.2
+* Improved Managed Sources examples (added dedicated Facebook Pages example)
+
+### Removed
+* References to the Twitter data source (being deprecated on August 13th, 2015)
+
 ## v.3.2.0 (2015-05-13)
 ### Added
 * Support for [PYLON API](http://dev.datasift.com/pylon/docs/api-endpoints)

data/VERSION

@@ -1 +1 @@
-3.2.0
+3.3.0

data/examples/account_identity_token_eg.rb

@@ -15,38 +15,38 @@ class AccountIdentityTokenEg < DataSiftExample
         false
       )
       identity_id = identity[:data][:id]
-      puts identity.to_json
+      puts identity[:data].to_json
 
       puts "\nCreate a Token for our Identity"
       puts @datasift.account_identity_token.create(
         identity_id,
         'facebook',
         'YOUR_TOKEN'
-      )
+      )[:data].to_json
 
       puts "\nList all existing Tokens for this Identity"
       puts @datasift.account_identity_token.list(
         identity_id
-      ).to_json
+      )[:data].to_json
 
       puts "\nGet existing Token by Identity and Service"
       puts @datasift.account_identity_token.get(
         identity_id,
         'facebook'
-      ).to_json
+      )[:data].to_json
 
       puts "\nUpdate a Token for a given Identity"
       puts @datasift.account_identity_token.update(
         identity_id,
         'facebook',
         'YOUR_NEW_TOKEN'
-      ).to_json
+      )[:data].to_json
 
       puts "\nDelete an Token for a given Identity and Service"
       puts @datasift.account_identity_token.delete(
         identity_id,
         'facebook'
-      ).to_json
+      )[:data].to_json
 
       puts "\nCleanup and remove the Identity"
       @datasift.account_identity.delete(identity_id)

data/examples/auth.rb

@@ -2,9 +2,11 @@ class DataSiftExample
   require 'datasift'
 
   def initialize
-    @username = 'DATASIFT_USERNAME'
-    @api_key = 'DATASIFT_API_KEY'
-    @config = { :username => @username, :api_key => @api_key }
+    @config = {
+      :username => 'DATASIFT_USERNAME',
+      :api_key => 'DATASIFT_API_KEY',
+      :api_version => 'v1.2'
+    }
     @params = {
       :output_type => 's3',
       :output_params => {

data/examples/cli.sh

@@ -108,7 +108,7 @@ ds -e push -c delete -p id ${push_id} | jq .
 #todo update push, pull
 
 echo "Attempting to create a Historics preview"
-preview=$(ds -e preview -c create -p start ${start} -p end ${end} -p hash ${hash} -p sources twitter \
+preview=$(ds -e preview -c create -p start ${start} -p end ${end} -p hash ${hash} -p sources tumblr \
 -p parameters 'interaction.author.link,targetVol,hour;interaction.type,freqDist,10')
 
 echo ${preview} | jq .

data/examples/historics_eg.rb

@@ -16,8 +16,11 @@ class HistoricsApi < DataSiftExample
       puts @datasift.historics.status(start, end_time)
 
       puts "\nPreparing"
-      #prepare a historics to start from three hours ago and run for 1 hour using twitter as a data source and using only a 10% sample
-      historics = @datasift.historics.prepare(hash, start, end_time, 'My ruby historics', 'twitter', 10)
+      # Prepare an Historics query to start from three hours ago and run for 1
+      #   hour using Tumblr as a data source and using only a 10% sample
+      historics = @datasift.historics.prepare(
+        hash, start, end_time, 'My ruby historics', 'tumblr', 10
+      )
       puts historics
 
       id = historics[:data][:id]

data/examples/historics_preview_eg.rb

@@ -13,7 +13,7 @@ class HistoricsPreviewApi < DataSiftExample
 
       puts "\nCreating a preview"
       # see http://dev.datasift.com/docs/rest-api/previewcreate for docs
-      sources    = 'facebook,twitter'
+      sources    = 'tumblr'
       parameters = 'interaction.author.link,targetVol,hour;interaction.type,freqDist,10'
       start      = Time.now.to_i - (3600 * 48) # 48hrs ago
       source     = @datasift.historics_preview.create(hash, sources, parameters, start)

data/examples/managed_source_fb_eg.rb

@@ -0,0 +1,129 @@
+require './auth'
+class ManagedSourceApi < DataSiftExample
+  def initialize
+    super
+    run
+  end
+
+  def run
+    puts "Creating a managed source\n--"
+    parameters = {
+      likes: true,
+      posts_by_others: true,
+      comments: true,
+      page_likes: true
+    }
+    resources = [{
+      parameters: {
+        id: 130871750291428,
+        title: 'DataSift'
+      }
+    }]
+    auth = [{
+      parameters: {
+        value: 'vnHQocnOEChoOsYYOHVIn80......EOMmZ63go6s0DzxsAmJaDeE2ljdQjDqJVT'
+      }
+    }]
+
+    source = @datasift.managed_source.create(
+      'facebook_page', 'Ruby test', parameters, resources, auth
+    )
+    puts source[:data].to_json
+
+    id = source[:data][:id]
+
+    puts "\nStarting delivery for my Managed Source\n--"
+    puts @datasift.managed_source.start(id)[:data].to_json
+
+    # Define new resources to be added
+    update_resources = [{
+      parameters: {
+        id: 10513336322,
+        title: 'The Guardian'
+      }
+    }]
+
+    # Push each of the existing resources back into the new resources array
+    source[:data][:resources].each do |resource|
+      update_resources.push(resource)
+    end
+
+    puts "\nUpdating; adding a new resource, and changing the name\n--"
+    puts @datasift.managed_source.update(
+      id, 'facebook_page', 'Updated Ruby test', source[:data][:parameters],
+      update_resources, source[:data][:auth]
+    )[:data].to_json
+
+    puts "\nGetting info from DataSift about my source\n--"
+    puts @datasift.managed_source.get(id)[:data].to_json
+
+    # Define new resources to add to Managed Source
+    new_resources = [
+      {
+        parameters: {
+          id: 5281959998,
+          title: 'The New York Times'
+        }
+      },
+      {
+        parameters: {
+          id: 18468761129,
+          title: 'The Huffington Post'
+        }
+      },
+      {
+        parameters: {
+          id: 97212224368,
+          title: 'CNBC'
+        }
+      }
+    ]
+
+    new_auth = [{
+      parameters: {
+        value: 'CAAIUKbXn8xsBAL7eP......9hcU0b4ZVwlMe9dH5G93Nmvfi2EHJ7nXkRfc7'
+      }
+    }]
+
+    puts "\nAdding new resources to my source (as an array of Ruby objects)\n--"
+    puts @datasift.managed_source_resource.add(
+      id, new_resources
+    )[:data].to_json
+
+    puts "\nAdding a new token to my source (as an array of Ruby objects)\n--"
+    puts @datasift.managed_source_auth.add(id, new_auth)[:data].to_json
+
+    puts "\nGetting info from DataSift about my source (notice the new " \
+      "resources and tokens have been added)\n--"
+    source = @datasift.managed_source.get id
+    puts source[:data].to_json
+
+    puts "\nRemoving a resource from my source by resource_id\n--"
+    puts @datasift.managed_source_resource.remove(
+      id, [source[:data][:resources][0][:resource_id]]
+    )[:data].to_json
+
+    puts "\nRemoving an auth token from my source by identity_id\n--"
+    puts @datasift.managed_source_auth.remove(
+      id, [source[:data][:auth][0][:identity_id]]
+    )[:data].to_json
+
+    puts "\nGetting info from DataSift about my source (notice an auth " \
+      "token and resource have been removed)\n--"
+    puts @datasift.managed_source.get(id)[:data].to_json
+
+    puts "\nFetching logs (Any error logs for your source will appear here)\n--"
+    puts @datasift.managed_source.log(id)[:data].to_json
+
+    puts "\nStopping the Managed Source\n--"
+    puts @datasift.managed_source.stop(id)[:data].to_json
+
+    puts "\nDeleting the Managed Source\n--"
+    puts @datasift.managed_source.delete(id)[:data].to_json
+
+  rescue DataSiftError => dse
+    puts dse.message
+  end
+end
+
+ManagedSourceApi.new

data/examples/managed_source_ig_eg.rb

@@ -0,0 +1,126 @@
+require './auth'
+class ManagedSourceApi < DataSiftExample
+  def initialize
+    super
+    run
+  end
+
+  def run
+    puts "Creating a managed source--\n"
+    parameters = {
+      likes: true,
+      comments: true
+    }
+    resources = [{
+      parameters: {
+        type: 'user',
+        value: 25025320
+      }
+    }]
+    auth = [{
+      parameters: {
+        value: '10942122.00a3229.fff654d524854054bdb0288a05cdbdd1'
+      }
+    }]
+
+    source = @datasift.managed_source.create(
+      'instagram', 'Ruby test', parameters, resources, auth
+    )
+    puts source[:data].to_json
+
+    id = source[:data][:id]
+
+    puts "\nStarting delivery for my Managed Source--\n"
+    puts @datasift.managed_source.start(id)[:data].to_json
+
+    # Define new resources to be added
+    update_resources = [{
+      parameters: {
+        type: 'user',
+        value: 8139971
+      }
+    }]
+
+    # Push each of the existing resources back into the new resources array
+    source[:data][:resources].each do |resource|
+      update_resources.push(resource)
+    end
+
+    puts "\nUpdating; adding a new resource, and changing the name--\n"
+    puts @datasift.managed_source.update(
+      id, 'instagram', 'Updated Ruby test', source[:data][:parameters],
+      update_resources, source[:data][:auth]
+    )[:data].to_json
+
+    puts "\nGetting info from DataSift about my source--\n"
+    puts @datasift.managed_source.get(id)[:data].to_json
+
+    # Define new resources to add to Managed Source
+    new_resources = [
+      {
+        parameters: {
+          type: 'tag',
+          value: 'sun'
+        }
+      },
+      {
+        parameters: {
+          type: 'tag',
+          value: 'sea'
+        }
+      },
+      {
+        parameters: {
+          type: 'tag',
+          value: 'surf'
+        }
+      }
+    ]
+
+    new_auth = [{
+      parameters: {
+        value: '10942111.1f2134f.8837abb205b44ece801022f6fa989cc4'
+      }
+    }]
+
+    puts "\nAdding a new resource to my source (as array of Ruby objects)--\n"
+    puts @datasift.managed_source_resource.add(
+      id, new_resources
+    )[:data].to_json
+
+    puts "\nAdding a new token to my source (as array of Ruby objects)--\n"
+    puts @datasift.managed_source_auth.add(id, new_auth)[:data].to_json
+
+    puts "\nGetting info from DataSift about my source (notice the new " \
+      "resources and tokens have been added)--\n"
+    source = @datasift.managed_source.get id
+    puts source[:data].to_json
+
+    puts "\nRemoving a resource from my source by resource_id--\n"
+    puts @datasift.managed_source_resource.remove(
+      id, [source[:data][:resources][0][:resource_id]]
+    )[:data].to_json
+
+    puts "\nRemoving an auth token from my source by identity_id--\n"
+    puts @datasift.managed_source_auth.remove(
+      id, [source[:data][:auth][0][:identity_id]]
+    )[:data].to_json
+
+    puts "\nGetting info from DataSift about my source (notice an auth " \
+      "token and resource have been removed)--\n"
+    puts @datasift.managed_source.get(id)[:data].to_json
+
+    puts "\nFetching logs--\n"
+    puts @datasift.managed_source.log(id)[:data].to_json
+
+    puts "\nStopping--\n"
+    puts @datasift.managed_source.stop(id)[:data].to_json
+
+    puts "\nDeleting--\n"
+    puts @datasift.managed_source.delete(id)[:data].to_json
+    rescue DataSiftError => dse
+      puts dse.message
+  end
+end
+
+ManagedSourceApi.new

data/examples/pylon_eg.rb

@@ -9,7 +9,7 @@ class AnalysisApi < DataSiftExample
     begin
       puts "Create a new identity to make PYLON API calls"
       identity = @datasift.account_identity.create(
-        "JASON_#{Time.now.to_i}",
+        "RUBY_LIB_#{Time.now.to_i}",
         "active",
         false
       )
@@ -91,7 +91,41 @@ class AnalysisApi < DataSiftExample
         }
       }
       filter = ''
-      start_time = Time.now.to_i - (60 * 60 * 12) # 7 days ago
+      start_time = Time.now.to_i - (60 * 60 * 24 * 7) # 7 days ago
+      end_time = Time.now.to_i
+      puts @datasift.pylon.analyze(
+        hash,
+        params,
+        filter,
+        start_time,
+        end_time
+      )[:data].to_json
+
+      puts "\nFrequency Distribution with nested queries. Find the top three " \
+        "age groups for each gender by country"
+      filter = ''
+      params = {
+        analysis_type: 'freqDist',
+        parameters: {
+          threshold: 4,
+          target: 'fb.author.country'
+        },
+        child: {
+          analysis_type: 'freqDist',
+          parameters: {
+            threshold: 2,
+            target: 'fb.author.gender'
+          },
+          child: {
+            analysis_type: 'freqDist',
+            parameters: {
+              threshold: 3,
+              target: 'fb.author.age'
+            }
+          }
+        }
+      }
+      start_time = Time.now.to_i - (60 * 60 * 24 * 7)
       end_time = Time.now.to_i
       puts @datasift.pylon.analyze(
         hash,