datasift 3.4.0 → 3.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 231dfbf3fbb478090969896e459179651d9aab7d
-  data.tar.gz: dc955abee233f6cb82a5765065796563a89ef268
+  metadata.gz: 2fead364f5c1631d28e826b6ab3a1bc0feaf570b
+  data.tar.gz: 66b66356edcf1446051e3fc4fd8e35c72f5bf561
 SHA512:
-  metadata.gz: 5adc6aa0777edfef9835b08e1e133a63805cf10e926ab67fda130cca85ca79509e466d91b1c7eb21affa44f6829dd7fdc1c2807e0ae66666581c44aa532b3161
-  data.tar.gz: 7074591477540122765b3c91bd3dec1dbd1f2d65371277fb59b24a523455e791f44c21d2fa2572fa4abe04ce21f20a52203485bab10957bc349b8d1ee39ac8b3
+  metadata.gz: f8a5b9f74d8c5bb4d00271b921b1167e9ab2be70b254837042e368340d771546d995f83870ba9e743c2d17f40ac1f7824aef37d10291382ab369649c99ac26f3
+  data.tar.gz: 0a032a3711190b06f10ac7c3c1cc288ae4b4dd4af46eb0b8c7c2a006fa74b372c2406dc80b215654a725fc3026d67dbb198011311e3c3c6840530940ce1c508c

data/.rubocop_todo.yml

@@ -43,7 +43,7 @@ Metrics/CyclomaticComplexity:
 # Offense count: 118
 # Configuration parameters: AllowURI, URISchemes.
 LineLength:
-  Max: 90
+  Max: 100
 
 # Offense count: 33
 # Configuration parameters: CountComments.

data/.travis.yml

@@ -1,7 +1,16 @@
 language: ruby
 sudo: false
+cache: bundler
+bundler_args: --without development --retry=3 --jobs=3
+
 rvm:
   - 1.9.3
   - 2.0.0
   - 2.1
   - 2.2
+  - ruby-head
+
+matrix:
+  allow_failures:
+    - ruby-head
+  fast_finish: true

data/CHANGELOG.md

@@ -1,10 +1,21 @@
 CHANGELOG
 ================================
+## v.3.5.0 (2015-11-13)
+### Added
+* Support for the [/account/usage](http://dev.datasift.com/pylon/docs/api/acct-api-endpoints/get-accountusage) API endpoint
+* Added explicit support for 412, 415, 503 and 504 HTTP error responses
+* Support for the [/pylon/sample](http://dev.datasift.com/pylon/docs/api/pylon-api-endpoints/pylonsample) API endpoint. Full details about the feature can be found in our [platform release notes](http://community.datasift.com/t/pylon-1-6-release-notes/1859)
+
+### Changed
+* Only set ```Content-Type``` HTTP header for POST/PUT requests; it's not necessary unless we are passing a request entity
+* Teased out some minor performance enhancements by allocating fewer objects on each request
+* Loosen some Gem dependancies. Successfully tested against [rest-client](https://github.com/rest-client/rest-client) v2.0.0
+
 ## v.3.4.0 (2015-08-20)
 ### Added
-* Support for [Open Data Processing](https://datasift.com/products/open-data-processing-for-twitter/) batch uploads (Thanks @giovannelli)
-* Explicit supprot for 413 and 422 errors from API
-* Ability to get at API response headers using the ```object.response``` accessor. (Thanks again @giovannelli)
+* Support for [Open Data Processing](https://datasift.com/products/open-data-processing-for-twitter/) batch uploads (Thanks [@giovannelli](https://github.com/giovannelli))
+* Explicit support for 413 and 422 errors from API
+* Ability to get at API response headers using the ```object.response``` accessor. (Thanks again [@giovannelli](https://github.com/giovannelli))
 
 ### Changed
 * Bumped [rest-client](https://github.com/rest-client/rest-client) dependency to ~> 1.8

data/Gemfile

@@ -7,7 +7,7 @@ group :test do
   gem 'minitest', '~> 5.0'
   gem 'rubocop', '>= 0.27'
   gem 'simplecov', '>= 0.9'
-  gem 'shoulda', '~> 2.11'
+  gem 'shoulda', '>= 2.11'
   gem 'vcr', '~> 2.9'
   gem 'webmock'
 end

data/VERSION

@@ -1 +1 @@
-3.4.0
+3.5.0

data/datasift.gemspec

@@ -15,8 +15,8 @@ Gem::Specification.new do |s|
   s.test_files    = `git ls-files -- {test}/*`.split("\n")
   s.require_paths = ["lib"]
 
-  s.add_runtime_dependency('rest-client', '~> 1.8')
-  s.add_runtime_dependency('multi_json', '~> 1.7')
-  s.add_runtime_dependency('websocket-td', '~> 0.0.5')
-  s.add_development_dependency('bundler', '~> 1.0')
+  s.add_runtime_dependency 'rest-client', ['>= 1.8', '< 3.0']
+  s.add_runtime_dependency 'multi_json', '~> 1.7'
+  s.add_runtime_dependency 'websocket-td', '~> 0.0.5'
+  s.add_development_dependency 'bundler', '~> 1.0'
 end

data/examples/account_eg.rb

@@ -0,0 +1,33 @@
+require './auth'
+class AccountEg < DataSiftExample
+  def initialize
+    super
+    @datasift = DataSift::Client.new(@config)
+    run
+  end
+
+  def run
+    begin
+      puts "Get account usage for the default period"
+      puts @datasift.account.usage[:data].to_json
+
+      puts "\nGet account usage for the past month"
+      puts @datasift.account.usage('monthly')[:data].to_json
+
+    rescue DataSiftError => dse
+      puts dse.message
+      # Then match specific error to take action;
+      #   All errors thrown by the client extend DataSiftError
+      case dse
+        when ConnectionError
+          # some connection error
+        when AuthError
+        when BadRequestError
+        else
+          # do something else...
+      end
+    end
+  end
+end
+
+AccountEg.new

data/examples/account_identity_eg.rb

@@ -10,27 +10,27 @@ class AccountIdentityEg < DataSiftExample
     begin
       puts "Create a new identity"
       identity = @datasift.account_identity.create(
-        "Ruby Identity", "active", false
+        "Ruby Identity #{DateTime.now}", "active", false
       )
       identity_id = identity[:data][:id]
-      puts identity.to_json
+      puts identity[:data].to_json
 
       puts "\nList all existing identities"
-      puts @datasift.account_identity.list.to_json
+      puts @datasift.account_identity.list[:data].to_json
 
       puts "\nGet existing identity"
-      puts @datasift.account_identity.get(identity_id).to_json
+      puts @datasift.account_identity.get(identity_id)[:data].to_json
 
       puts "\nUpdate an identity"
       puts @datasift.account_identity.update(
-        identity_id, 'Updated Ruby Identity'
-      ).to_json
+        identity_id, "Updated Ruby Identity #{DateTime.now}"
+      )[:data].to_json
 
       puts "\nDelete an identity"
-      puts @datasift.account_identity.delete(identity_id).to_json
+      @datasift.account_identity.delete(identity_id)
 
     rescue DataSiftError => dse
-      puts dse.message
+      puts dse.inspect
       # Then match specific error to take action;
       #   All errors thrown by the client extend DataSiftError
       case dse
@@ -41,6 +41,8 @@ class AccountIdentityEg < DataSiftExample
         else
           # do something else...
       end
+      puts "\nClean up and delete the identity"
+      @datasift.account_identity.delete(identity_id)
     end
   end
 end

data/examples/account_identity_limit_eg.rb

@@ -13,44 +13,44 @@ class AccountIdentityLimitEg < DataSiftExample
         "Ruby Identity for Token Limits", "active", false
       )
       identity_id = identity[:data][:id]
-      puts identity.to_json
+      puts identity[:data].to_json
 
       puts "\nCreate a Limit for our Identity"
       puts @datasift.account_identity_limit.create(
         identity_id,
         'facebook',
         100_000
-      )
+      )[:data].to_json
 
       puts "\nList all existing Limits for this Service"
       puts @datasift.account_identity_limit.list(
         'facebook'
-      ).to_json
+      )[:data].to_json
 
       puts "\nGet existing Limit by Identity and Service"
       puts @datasift.account_identity_limit.get(
         identity_id,
         'facebook'
-      ).to_json
+      )[:data].to_json
 
       puts "\nUpdate a Limit for a given Identity"
       puts @datasift.account_identity_limit.update(
         identity_id,
         'facebook',
         250_000
-      ).to_json
+      )[:data].to_json
 
       puts "\nRemove the Limit from a given Identity and Service"
-      puts @datasift.account_identity_limit.delete(
+      @datasift.account_identity_limit.delete(
         identity_id,
         'facebook'
-      ).to_json
+      )
 
       puts "\nCleanup and remove the Identity"
       @datasift.account_identity.delete(identity_id)
 
     rescue DataSiftError => dse
-      puts dse.message
+      puts dse.inspect
       # Then match specific error to take action;
       #   All errors thrown by the client extend DataSiftError
       case dse
@@ -61,6 +61,8 @@ class AccountIdentityLimitEg < DataSiftExample
         else
           # do something else...
       end
+      puts "\nCleanup and remove the Identity"
+      @datasift.account_identity.delete(identity_id)
     end
   end
 end

data/examples/account_identity_token_eg.rb

@@ -10,7 +10,7 @@ class AccountIdentityTokenEg < DataSiftExample
     begin
       puts "Create a new identity to create tokens for"
       identity = @datasift.account_identity.create(
-        "Ruby Identity for Tokens",
+        "Ruby Identity for Tokena",
         "active",
         false
       )
@@ -52,7 +52,7 @@ class AccountIdentityTokenEg < DataSiftExample
       @datasift.account_identity.delete(identity_id)
 
     rescue DataSiftError => dse
-      puts dse.message
+      puts dse.inspect
       # Then match specific error to take action;
       #   All errors thrown by the client extend DataSiftError
       case dse
@@ -60,9 +60,12 @@ class AccountIdentityTokenEg < DataSiftExample
           # some connection error
         when AuthError
         when BadRequestError
+          puts '[WARNING] You will need to use a valid token to run through this example'
         else
           # do something else...
       end
+      puts "\nCleanup and remove the Identity"
+      @datasift.account_identity.delete(identity_id)
     end
   end
 end

data/examples/auth.rb

@@ -3,29 +3,29 @@ class DataSiftExample
 
   def initialize
     @config = {
-      :username => 'DATASIFT_USERNAME',
-      :api_key => 'DATASIFT_API_KEY',
-      :api_version => 'v1.2'
+      username: 'DATASIFT_USERNAME',
+      api_key: 'DATASIFT_API_KEY',
+      api_version: 'v1.2'
     }
     @params = {
-      :output_type => 's3',
-      :output_params => {
-        :bucket             => 'YOUR_BUCKET_NAME',
-        :directory          => 'ruby',
-        :acl                => 'private',
-        :delivery_frequency => 0,
-        :max_size           => 104857600,
-        :file_prefix        => 'DataSift',
-        :auth => {
-          :access_key => 'ADD_YOUR_ACCESS_KEY',
-          :secret_key => 'ADD_YOUR_SECRET_KEY',
+      output_type: 's3',
+      output_params: {
+        bucket: 'YOUR_BUCKET_NAME',
+        directory: 'ruby',
+        acl: 'private',
+        delivery_frequency: 0,
+        max_size: 104857600,
+        file_prefix: 'DataSift',
+        auth: {
+          access_key: 'ADD_YOUR_ACCESS_KEY',
+          secret_key: 'ADD_YOUR_SECRET_KEY',
         }
       }
     }
     @pull_params = {
-      :output_type => 'pull',
-      :output_params => {
-        :max_size => 52428800
+      output_type: 'pull',
+      output_params: {
+        max_size: 52428800
       }
     }
     @datasift = DataSift::Client.new(@config)
@@ -35,22 +35,21 @@ class DataSiftExample
 
   def create_push(hash, is_historics_id = false)
     create_params = @params.merge ({
-        #hash or historics_id can be used but not both
-        :name           => 'My awesome push subscription',
-        :initial_status => 'active', # or 'paused' or 'waiting_for_start'
+        # Hash or historics_id can be used, but not both
+        name: 'My awesome push subscription',
+        initial_status: 'active', # or 'paused' or 'waiting_for_start'
     })
     if is_historics_id
-      create_params.merge!({:historics_id => hash})
+      create_params.merge!(historics_id: hash)
     else
-      create_params.merge!({:hash  => hash,
-                            #start and end are not valid for historics
-                            :start => Time.now.to_i,
-                            :end   => Time.now.to_i + 320
-                           })
+      # Start and end are not valid for historics
+      create_params.merge!(
+        hash: hash,
+        start: Time.now.to_i,
+        end: Time.now.to_i + 320
+      )
     end
     puts 'Creating subscription'
-    subscription = @datasift.push.create create_params
-    puts 'Create push => ' + subscription.to_s
-    subscription
+    @datasift.push.create create_params
   end
 end

data/examples/core_api_eg.rb

@@ -35,7 +35,7 @@ class CoreApiEg < DataSiftExample
 
     rescue DataSiftError => dse
       puts dse.message
-      # Then match specific one to take action - All errors thrown by the client extend DataSiftError
+      # Then match specific one to take action; All errors thrown by the client extend DataSiftError
       case dse
         when ConnectionError
           # some connection error

data/examples/live_stream_eg.rb

@@ -68,15 +68,15 @@ class StreamingApi < DataSiftExample
         puts "DataSift Message #{hash} ==> #{message}"
       end
 
-      conn                     = DataSift::new_stream(@config, on_delete, on_error, on_connect, on_close)
+      conn = DataSift::new_stream(@config, on_delete, on_error, on_connect, on_close)
       conn.on_datasift_message = on_datasift_message
       #can do something else here now...
       puts 'Do some other business stuff...'
       conn.stream.read_thread.join
         #rescue DataSiftError
     rescue DataSiftError => dse
-      puts "Error #{dse.message}"
-      # Then match specific one to take action - All errors thrown by the client extend DataSiftError
+      puts dse.inspect
+      # Then match specific one to take action; All errors thrown by the client extend DataSiftError
       case dse
         when ConnectionError
           # some connection error

data/examples/pull.rb

@@ -6,34 +6,37 @@ class PushApi < DataSiftExample
 
   def run
     begin
-      @params = {:output_type => 'pull'}
+      @params = {output_type: 'pull'}
       puts 'Validating the Pull subscription'
-      if @datasift.push.valid? @params
-        stream = @datasift.compile 'interaction.content contains "music"'
-        subscription = create_push(stream[:data][:hash])
+      fail InvalidParamError unless @datasift.push.valid? @params
 
-        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
+      stream = @datasift.compile 'interaction.content contains "music"'
+      subscription = create_push(stream[:data][:hash])
 
-        puts "\nPulling data a first time, then waiting 10 seconds"
-        @datasift.push.pull(subscription_id).each { |e| puts e }
-
-        sleep 10
+      subscription_id = subscription[:data][:id]
+      # Pull a bunch of interactions from the push queue. This only works if we had set the
+      #   output_type above to "pull"
 
-        puts "\nPulling data a second time, then waiting 10 seconds"
+      2.times do
+        puts "\nPulling data, then waiting 10 seconds"
         @datasift.push.pull(subscription_id).each { |e| puts e }
-
         sleep 10
+      end
 
-        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}" })
+      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 processed twice
+      @datasift.push.pull(
+        subscription_id,
+        20_971_520,
+        '',
+        lambda{ |e| puts "on_message => #{e}" }
+      )
+
+      puts "\nDeleting the Pull subscription"
+      @datasift.push.delete subscription_id
 
-        puts "\nDeleting the Pull subscription"
-        @datasift.push.delete subscription_id
-      end
         #rescue DataSiftError
     rescue DataSiftError => dse
       puts dse.inspect

data/examples/push_eg.rb

@@ -8,14 +8,17 @@ class PushApi < DataSiftExample
   def run
     begin
       puts 'Creating Push subscription'
-      subscription = @datasift.push.create @params.merge(hash: '54dbfc8464258de162b7f1a057e630c5', name: 'Ruby Client Example')
+      subscription = @datasift.push.create @params.merge(
+        hash: '54dbfc8464258de162b7f1a057e630c5',
+        name: 'Ruby Client Example'
+      )
 
       subscription_id = subscription[:data][:id]
       puts "\nPush subscription created! Push Subscription ID #{subscription_id}"
 
       puts "\nGetting subscription info"
       # Get details for a subscription. Also available are
-      # push.[get, get_by_hash,get_by_historics_id]
+      #   push.[get, get_by_hash, get_by_historics_id]
       puts @datasift.push.get_by_subscription subscription_id
 
       puts "\nPausing Push subscription"
@@ -27,18 +30,16 @@ class PushApi < DataSiftExample
       @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
+      # 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
+      # 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.
+      # Push subscriptions can be deleted. On delete, any undelivered data is dropped. A delete
+      #   is permenent.
       @datasift.push.delete subscription_id
 
     rescue DataSiftError => dse