datasift 3.7.2 → 3.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 59b54254c46ce1e8e158d0bbbfee1f4b6b8c11c8
-  data.tar.gz: 0d3e76374db8ce157e3e69850a78d3827044c26e
+  metadata.gz: 28fe865c20b2b0580a481a1c40388e9f288ee650
+  data.tar.gz: 81355aa4c5a023e7642bc209749e9dd4422a68a2
 SHA512:
-  metadata.gz: 06accc8e50f6334bba9baa2da4616433a1c9eb136fbee0c5bbb7556f29d3ea25de65bd6b071ba11d6fd2e75ed9a51cc2631e39aca3f8321897115bc70cbe472a
-  data.tar.gz: 032ef58aa25a045d126c64d1edb8d89709c8c8047dd6f4c0bc06461a70a7b771e29fd6bfdcaf0143d135db12a69ab843515d7e86d64a34a7b8922ec58a92162a
+  metadata.gz: cb529c831a844bcec7333bb4603943e3068a963707ee89c8764d76de0e9f8b57b650cc7b5be605117789ec175d29012eeef00493a4f87736f6055d46f53f1e60
+  data.tar.gz: 9a8b501082d89ad15ffa27735196ba2e0cf3cb9a1b195d0fa660176d6193f42d24cf1cac224b6026fb281a9784df509835da220451b2cace71e4f864fcfe8a02

data/CHANGELOG.md

@@ -7,6 +7,14 @@ CHANGELOG
 * Designed to make the most of DataSift's latest API version and features
 * Designed for Ruby 2.3+. Use features like keyword parameters across the board
 
+## v.3.8.0 (2017-05-23)
+### Added
+* Support for PYLON Task API
+* Ads explicit support for additional HTTP response codes
+
+### Changed
+* Uses API v1.5 by default
+
 ## v.3.7.2 (2016-11-08)
 ### Fixes
 * Uses correct timestamp params in PYLON Sample API calls. `start_time` -> `start` and `end_time` - `end`

data/datasift.gemspec

@@ -1,6 +1,9 @@
+$:.unshift(File.join(File.dirname(__FILE__), 'lib'))
+require 'version'
+
 Gem::Specification.new do |s|
   s.name        = 'datasift'
-  s.version     = File.open('VERSION').first
+  s.version     = DataSift::VERSION
   s.authors     = ['DataSift', 'Courtney Robinson', 'Jason Dugdale']
   s.email       = ['support@datasift.com']
   s.description = %q{The official Ruby library for accessing the DataSift API. See http://datasift.com/ for full details and to sign up for an account.}
@@ -11,8 +14,8 @@ Gem::Specification.new do |s|
   s.platform    = Gem::Platform::RUBY
   s.required_rubygems_version = '>= 1.3.5'
   s.required_ruby_version = '>= 2.0.0'
-  s.files         = `git ls-files`.split("\n")
-  s.test_files    = `git ls-files -- {test}/*`.split("\n")
+  s.files         = %w(.yardopts CHANGELOG.md README.md datasift.gemspec) + Dir['lib/**/*.rb']
+  s.test_files    = s.files.grep(%r{^(test)/})
   s.require_paths = ["lib"]
 
   s.add_runtime_dependency 'rest-client', ['>= 1.8', '< 3.0']

data/lib/api/api_resource.rb

@@ -14,7 +14,7 @@ module DataSift
       config[:api_host] = 'api.datasift.com' unless config.has_key?(:api_host)
       config[:stream_host] = 'websocket.datasift.com' unless config.has_key?(:stream_host)
       config[:ingestion_host] = 'in.datasift.com' unless config.has_key?(:ingestion_host)
-      config[:api_version] = 'v1.3' unless config.has_key?(:api_version)
+      config[:api_version] = 'v1.5' unless config.has_key?(:api_version)
       config[:enable_ssl] = true unless config.has_key?(:enable_ssl)
 
       ssl_default = TLSv1_2

data/lib/datasift.rb

@@ -17,18 +17,19 @@ require dir + '/managed_source_auth'
 require dir + '/managed_source_resource'
 require dir + '/live_stream'
 require dir + '/pylon'
+require dir + '/tasks'
 require dir + '/account'
 require dir + '/account_identity'
 require dir + '/account_identity_token'
 require dir + '/account_identity_limit'
 require dir + '/odp'
+require dir + '/version'
 #
 require 'rbconfig'
 
 module DataSift
   #
   IS_WINDOWS              = (RbConfig::CONFIG['host_os'] =~ /mswin|mingw|cygwin/)
-  VERSION                 = File.open(File.join(File.dirname(__FILE__), '../') + '/VERSION').first
   KNOWN_SOCKETS           = {}
   DETECT_DEAD_SOCKETS     = true
   SOCKET_DETECTOR_TIMEOUT = 6.5
@@ -37,9 +38,16 @@ module DataSift
   HEAD = 'HEAD'.freeze
   DELETE = 'DELETE'.freeze
   APPLICATION_JSON = 'application/json'.freeze
+  # Rate limits
   X_RATELIMIT_LIMIT = 'x_ratelimit_limit'.freeze
   X_RATELIMIT_REMAINING = 'x_ratelimit_remaining'.freeze
   X_RATELIMIT_COST = 'x_ratelimit_cost'.freeze
+  X_TASKS_QUEUED = 'x_tasks_queued'.freeze
+  X_TASKS_QUEUE_LIMIT = 'x_tasks_queue_limit'.freeze
+  X_ANALYSIS_TASKS_QUEUE_LIMIT = 'x_analysis_tasks_queue_limit'.freeze
+  X_ANALYSIS_TASKS_QUEUED = 'x_analysis_tasks_queued'.freeze
+  X_INSIGHT_TASKS_QUEUE_LIMIT = 'x_insight_tasks_queue_limit'.freeze
+  X_INSIGHT_TASKS_QUEUED = 'x_insight_tasks_queued'.freeze
 
   Thread.new do
     while DETECT_DEAD_SOCKETS
@@ -71,6 +79,7 @@ module DataSift
       @managed_source_auth      = DataSift::ManagedSourceAuth.new(config)
       @historics_preview        = DataSift::HistoricsPreview.new(config)
       @pylon                    = DataSift::Pylon.new(config)
+      @task                     = DataSift::Task.new(config)
       @account                  = DataSift::Account.new(config)
       @account_identity         = DataSift::AccountIdentity.new(config)
       @account_identity_token   = DataSift::AccountIdentityToken.new(config)
@@ -78,9 +87,9 @@ module DataSift
       @odp                      = DataSift::Odp.new(config)
     end
 
-    attr_reader :historics, :push, :managed_source, :managed_source_resource,
-      :managed_source_auth, :historics_preview, :pylon, :account,
-      :account_identity, :account_identity_token, :account_identity_limit, :odp
+    attr_reader :config, :historics, :push, :managed_source, :managed_source_resource,
+      :managed_source_auth, :historics_preview, :pylon, :account, :account_identity,
+      :account_identity_token, :account_identity_limit, :odp, :task
 
     # Checks if the syntax of the given CSDL is valid
     #
@@ -166,7 +175,7 @@ module DataSift
     url = build_url(path, config)
 
     headers.update(
-      :user_agent    => "DataSift/#{config[:api_version]} Ruby/v#{VERSION}",
+      :user_agent    => "DataSift/#{config[:api_version]} Ruby/v#{DataSift::VERSION}",
       :authorization => "#{config[:username]}:#{config[:api_key]}",
       :accept  => '*/*'
     )
@@ -212,11 +221,7 @@ module DataSift
       end
       {
         :data => data,
-        :datasift => {
-          X_RATELIMIT_LIMIT => response.headers[:x_ratelimit_limit],
-          X_RATELIMIT_REMAINING => response.headers[:x_ratelimit_remaining],
-          X_RATELIMIT_COST => response.headers[:x_ratelimit_cost]
-        },
+        :datasift => build_headers(response.headers),
         :http => {
           :status  => response.code,
           :headers => response.headers
@@ -240,11 +245,7 @@ module DataSift
           end
           response_on_error = {
             :data => nil,
-            :datasift => {
-              X_RATELIMIT_LIMIT => e.response.headers[:x_ratelimit_limit],
-              X_RATELIMIT_REMAINING => e.response.headers[:x_ratelimit_remaining],
-              X_RATELIMIT_COST => e.response.headers[:x_ratelimit_cost]
-            },
+            :datasift => build_headers(e.response.headers),
             :http => {
               :status  => e.response.code,
               :headers => e.response.headers
@@ -262,6 +263,20 @@ module DataSift
     end
   end
 
+  # Only to be used for building URI paths for /pylon API calls. API v1.4+ requires a 'service'
+  #   param to be passed as part of the URI. This checks the API version, and adds the service
+  #   if necessary
+  def build_path(service, path, config)
+    # We need to add the service param to PYLON API URLs for API v1.4+
+    if config[:api_version].split('v')[1].to_f >= 1.4
+      split_path = path.split('/')
+      path = split_path[0] + '/' + service + '/' + split_path[1]
+    end
+    puts path
+
+    return path
+  end
+
   private
 
   def self.build_url(path, config)
@@ -287,14 +302,36 @@ module DataSift
     params.collect { |param, value| [param, CGI.escape(value.to_s)].join('=') }.join('&')
   end
 
+  def self.build_headers(headers)
+    # rest_client downcases, and replaces hyphens in headers with underscores. Actual headers
+    #   returned by DS API can be found at:
+    #   http://dev.datasift.com/docs/platform/api/rest-api/api-rate-limiting
+    response = {}
+    response.merge!(X_TASKS_QUEUED => headers[:x_tasks_queued]) if headers.key?(:x_tasks_queued)
+    response.merge!(X_TASKS_QUEUE_LIMIT => headers[:x_tasks_queue_limit]) if headers.key?(:x_tasks_queue_limit)
+    response.merge!(X_ANALYSIS_TASKS_QUEUE_LIMIT => headers[:x_analysis_tasks_queue_limit]) if headers.key?(:x_analysis_tasks_queue_limit)
+    response.merge!(X_ANALYSIS_TASKS_QUEUED => headers[:x_analysis_tasks_queued]) if headers.key?(:x_analysis_tasks_queued)
+    response.merge!(X_INSIGHT_TASKS_QUEUE_LIMIT => headers[:x_insight_tasks_queue_limit]) if headers.key?(:x_insight_tasks_queue_limit)
+    response.merge!(X_INSIGHT_TASKS_QUEUED => headers[:x_insight_tasks_queued]) if headers.key?(:x_insight_tasks_queued)
+    response.merge!(
+      X_RATELIMIT_LIMIT => headers[:x_ratelimit_limit],
+      X_RATELIMIT_REMAINING => headers[:x_ratelimit_remaining],
+      X_RATELIMIT_COST => headers[:x_ratelimit_cost]
+    )
+  end
+
   def self.handle_api_error(code, body, response)
     case code
     when 400
       raise BadRequestError.new(code, body, response)
     when 401
       raise AuthError.new(code, body, response)
+    when 403
+      raise ForbiddenError.new(code, body, response)
     when 404
       raise ApiResourceNotFoundError.new(code, body, response)
+    when 405
+      raise MethodNotAllowedError.new(code, body, response)
     when 409
       raise ConflictError.new(code, body, response)
     when 410
@@ -413,7 +450,7 @@ module DataSift
           "encountered. As a result no further re-connection will be automatically " \
           "attempted. Manually invoke connect() after investigating the cause of the " \
           "failure, be sure to observe DataSift's re-connect policies available at " \
-          "http://dev.datasift.com/docs/streaming-api/reconnecting - Error {#{message}}"))
+          "https://dev.datasift.com/docs/platform/api/streaming-api/reconnecting - Error {#{message}}"))
       end
     else
       sleep config[:retry_timeout]

data/lib/errors.rb

@@ -36,10 +36,18 @@ end
 class ConnectionError < DataSiftError
 end
 
+# Standard error returned when receiving a 403 response from the API
+class ForbiddenError < DataSiftError
+end
+
 # Standard error returned when receiving a 404 response from the API
 class ApiResourceNotFoundError < DataSiftError
 end
 
+# Standard error returned when receiving a 405 response from the API
+class MethodNotAllowedError < DataSiftError
+end
+
 # Standard error returned when receiving a 409 response from the API
 class ConflictError < DataSiftError
 end

data/lib/live_stream.rb

@@ -1,10 +1,10 @@
 module DataSift
   class LiveStream < DataSift::ApiResource
 
-    @stream              = nil
+    @stream = nil
     @on_datasift_message = lambda {}
 
-    def initialize (config, stream)
+    def initialize(config, stream)
       super(config)
       @stream        = stream
       @retry_timeout = 0
@@ -30,11 +30,11 @@ module DataSift
         hash = message[:hash]
       end
       message.merge!({
-                         :is_failure => message[:status] == 'failure',
-                         :is_success => message[:status] == 'success',
-                         :is_warning => message[:status] == 'warning',
-                         :is_tick    => message[:status] == 'connected'
-                     })
+        :is_failure => message[:status] == 'failure',
+        :is_success => message[:status] == 'success',
+        :is_warning => message[:status] == 'warning',
+        :is_tick    => message[:status] == 'connected'
+      })
       @on_datasift_message.call(self, message, hash)
     end
 

data/lib/pylon.rb

@@ -6,39 +6,48 @@ module DataSift
     #
     # @param csdl [String] CSDL you wish to validate
     # @param boolResponse [Boolean] True if you want a boolean response.
+    # @param service [String] The PYLON service to make this API call against
     #   False if you want the full response object
     # @return [Boolean, Object] Dependent on value of boolResponse
-    def valid?(csdl = '', boolResponse = true)
+    def valid?(csdl = '', boolResponse = true, service = 'facebook')
       fail BadParametersError, 'csdl is required' if csdl.empty?
+      fail BadParametersError, 'service is required' if service.empty?
+
       params = { csdl: csdl }
 
-      res = DataSift.request(:POST, 'pylon/validate', @config, params)
+      res = DataSift.request(:POST, build_path(service, 'pylon/validate', @config), @config, params)
       boolResponse ? res[:http][:status] == 200 : res
     end
 
     # Compile PYLON CSDL by making an /pylon/compile API call
     #
     # @param csdl [String] CSDL you wish to compile
+    # @param service [String] The PYLON service to make this API call against
     # @return [Object] API reponse object
-    def compile(csdl)
+    def compile(csdl, service = 'facebook')
       fail BadParametersError, 'csdl is required' if csdl.empty?
+      fail BadParametersError, 'service is required' if service.empty?
+
       params = { csdl: csdl }
 
-      DataSift.request(:POST, 'pylon/compile', @config, params)
+      DataSift.request(:POST, build_path(service, 'pylon/compile', @config), @config, params)
     end
 
     # Perform /pylon/get API call to query status of your PYLON recordings
     #
     # @param hash [String] Hash you with the get the status for
     # @param id [String] The ID of the PYLON recording to get
+    # @param service [String] The PYLON service to make this API call against
     # @return [Object] API reponse object
-    def get(hash = '', id = '')
+    def get(hash = '', id = '', service = 'facebook')
       fail BadParametersError, 'hash or id is required' if hash.empty? && id.empty?
+      fail BadParametersError, 'service is required' if service.empty?
+
       params = {}
       params.merge!(hash: hash) unless hash.empty?
       params.merge!(id: id) unless id.empty?
 
-      DataSift.request(:GET, 'pylon/get', @config, params)
+      DataSift.request(:GET, build_path(service, 'pylon/get', @config), @config, params)
     end
 
     # Perform /pylon/get API call to list all PYLON Recordings
@@ -48,15 +57,18 @@ module DataSift
     # @param order_by [String, Symbol] Which field to sort results by
     # @param order_dir [String, Symbol] Order results in ascending or descending
     #   order
+    # @param service [String] The PYLON service to make this API call against
     # @return [Object] API reponse object
-    def list(page = nil, per_page = nil, order_by = '', order_dir = '')
+    def list(page = nil, per_page = nil, order_by = '', order_dir = '', service = 'facebook')
+      fail BadParametersError, 'service is required' if service.empty?
+
       params = {}
       params.merge!(page: page) unless page.nil?
       params.merge!(per_page: per_page) unless per_page.nil?
       params.merge!(order_by: order_by) unless order_by.empty?
       params.merge!(order_dir: order_dir) unless order_dir.empty?
 
-      DataSift.request(:GET, 'pylon/get', @config, params)
+      DataSift.request(:GET, build_path(service, 'pylon/get', @config), @config, params)
     end
 
     # Perform /pylon/update API call to update a given PYLON Recording
@@ -64,13 +76,16 @@ module DataSift
     # @param id [String] The ID of the PYLON recording to update
     # @param hash [String] The CSDL filter hash this recording should be subscribed to
     # @param name [String] Update the name of your recording
+    # @param service [String] The PYLON service to make this API call against
     # @return [Object] API reponse object
-    def update(id, hash = '', name = '')
-      params = {id: id}
+    def update(id, hash = '', name = '', service = 'facebook')
+      fail BadParametersError, 'service is required' if service.empty?
+
+      params = { id: id }
       params.merge!(hash: hash) unless hash.empty?
       params.merge!(name: name) unless name.empty?
 
-      DataSift.request(:PUT, 'pylon/update', @config, params)
+      DataSift.request(:PUT, build_path(service, 'pylon/update', @config), @config, params)
     end
 
     # Start recording a PYLON filter by making an /pylon/start API call
@@ -79,15 +94,18 @@ module DataSift
     # @param name [String] Give your recording a name. Required when starting a
     # @param id [String] ID of the recording you wish to start
     #   new recording
+    # @param service [String] The PYLON service to make this API call against
     # @return [Object] API reponse object
-    def start(hash = '', name = '', id = '')
+    def start(hash = '', name = '', id = '', service = 'facebook')
       fail BadParametersError, 'hash or id is required' if hash.empty? && id.empty?
+      fail BadParametersError, 'service is required' if service.empty?
+
       params = {}
       params.merge!(hash: hash) unless hash.empty?
       params.merge!(name: name) unless name.empty?
       params.merge!(id: id) unless id.empty?
 
-      DataSift.request(:PUT, 'pylon/start', @config, params)
+      DataSift.request(:PUT, build_path(service, 'pylon/start', @config), @config, params)
     end
 
     # Restart an existing PYLON recording by making an /pylon/start API call with a recording ID
@@ -95,27 +113,33 @@ module DataSift
     # @param id [String] CSDL you wish to begin (or resume) recording
     # @param name [String] Give your recording a name. Required when starting a
     #   new recording
+    # @param service [String] The PYLON service to make this API call against
     # @return [Object] API reponse object
-    def restart(id, name = '')
+    def restart(id, name = '', service = 'facebook')
       fail BadParametersError, 'id is required' if id.empty?
+      fail BadParametersError, 'service is required' if service.empty?
+
       params = { id: id }
       params.merge!(name: name) unless name.empty?
 
-      DataSift.request(:PUT, 'pylon/start', @config, params)
+      DataSift.request(:PUT, build_path(service, 'pylon/start', @config), @config, params)
     end
 
     # Stop an active PYLON recording by making an /pylon/stop API call
     #
     # @param hash [String] CSDL you wish to stop recording
     # @param id [String] ID of the recording you wish to stop
+    # @param service [String] The PYLON service to make this API call against
     # @return [Object] API reponse object
-    def stop(hash = '', id = '')
+    def stop(hash = '', id = '', service = 'facebook')
       fail BadParametersError, 'hash or id is required' if hash.empty? && id.empty?
+      fail BadParametersError, 'service is required' if service.empty?
+
       params = {}
       params.merge!(hash: hash) unless hash.empty?
       params.merge!(id: id) unless id.empty?
 
-      DataSift.request(:PUT, 'pylon/stop', @config, params)
+      DataSift.request(:PUT, build_path(service, 'pylon/stop', @config), @config, params)
     end
 
     # Perform a PYLON analysis query by making an /pylon/analyze API call
@@ -130,10 +154,13 @@ module DataSift
     # @param start_time [Integer] Optional start timestamp for filtering by date
     # @param end_time [Integer] Optional end timestamp for filtering by date
     # @param id [String] ID of the recording you wish to analyze
+    # @param service [String] The PYLON service to make this API call against
     # @return [Object] API reponse object
-    def analyze(hash = '', parameters = '', filter = '', start_time = nil, end_time = nil, id = '')
+    def analyze(hash = '', parameters = '', filter = '', start_time = nil, end_time = nil, id = '', service = 'facebook')
       fail BadParametersError, 'hash or id is required' if hash.empty? && id.empty?
       fail BadParametersError, 'parameters is required' if parameters.empty?
+      fail BadParametersError, 'service is required' if service.empty?
+
       params = { parameters: parameters }
       params.merge!(hash: hash) unless hash.empty?
       params.merge!(id: id) unless id.empty?
@@ -141,7 +168,7 @@ module DataSift
       params.merge!(start: start_time) unless start_time.nil?
       params.merge!(end: end_time) unless end_time.nil?
 
-      DataSift.request(:POST, 'pylon/analyze', @config, params)
+      DataSift.request(:POST, build_path(service, 'pylon/analyze', @config), @config, params)
     end
 
     # Query the tag hierarchy on interactions populated by a particular
@@ -149,14 +176,17 @@ module DataSift
     #
     # @param hash [String] Hash of the recording you wish to query
     # @param id [String] ID of the recording you wish to query
+    # @param service [String] The PYLON service to make this API call against
     # @return [Object] API reponse object
-    def tags(hash = '', id = '')
+    def tags(hash = '', id = '', service = 'facebook')
       fail BadParametersError, 'hash or id is required' if hash.empty? && id.empty?
+      fail BadParametersError, 'service is required' if service.empty?
+
       params = {}
       params.merge!(hash: hash) unless hash.empty?
       params.merge!(id: id) unless id.empty?
 
-      DataSift.request(:GET, 'pylon/tags', @config, params)
+      DataSift.request(:GET, build_path(service, 'pylon/tags', @config), @config, params)
     end
 
     # Hit the PYLON Sample endpoint to pull public sample data from a PYLON recording
@@ -167,21 +197,24 @@ module DataSift
     # @param end_time [Integer] Optional end timestamp for filtering by date
     # @param filter [String] Optional PYLON CSDL for a query filter
     # @param id [String] ID of the recording you wish to sample
+    # @param service [String] The PYLON service to make this API call against
     # @return [Object] API reponse object
-    def sample(hash = '', count = nil, start_time = nil, end_time = nil, filter = '', id = '')
+    def sample(hash = '', count = nil, start_time = nil, end_time = nil, filter = '', id = '', service = 'facebook')
       fail BadParametersError, 'hash or id is required' if hash.empty? && id.empty?
+      fail BadParametersError, 'service is required' if service.empty?
+
       params = {}
       params.merge!(hash: hash) unless hash.empty?
       params.merge!(id: id) unless id.empty?
       params.merge!(count: count) unless count.nil?
-      params.merge!(start: start_time) unless start_time.nil?
-      params.merge!(end: end_time) unless end_time.nil?
+      params.merge!(start_time: start_time) unless start_time.nil?
+      params.merge!(end_time: end_time) unless end_time.nil?
 
       if filter.empty?
-        DataSift.request(:GET, 'pylon/sample', @config, params)
+        DataSift.request(:GET, build_path(service, 'pylon/sample', @config), @config, params)
       else
         params.merge!(filter: filter)
-        DataSift.request(:POST, 'pylon/sample', @config, params)
+        DataSift.request(:POST, build_path(service, 'pylon/sample', @config), @config, params)
       end
     end
   end