datasift 3.1.3 → 3.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0eee7436a56aaedecada56c0fe536f159fcd2d10
-  data.tar.gz: f5df616662250c8ffbe52828e517650cdc3df25b
+  metadata.gz: bed62d86c7bd4459a24a217e685f36e4cd35e9a7
+  data.tar.gz: 1316874d66e385306c307d9f58a2907594e0fa54
 SHA512:
-  metadata.gz: efc65b0038b8e12dfa98e03bda3296a4ca3b4f28643a04e7aedeb6564a7c1e2ae0d18964961c590d415e28e14168f9fa6edda9dbf33c2f9ff6bf6b66c4eeb3aa
-  data.tar.gz: 018f6305640bd21c2f8594f515988975f07dc7cae7b71fbf2ca17bd07fdd75b036a5fa97b4350246134837cea5ea0ba169ee6752175de533b9d19dc8b8f147c2
+  metadata.gz: ce03cf0ff67454e8805cd04598b773c654bb69b03927e0e6b4e6364502120da9590f442660489060e8d40b96615b52550f6ffa391095a07294851d757d178f0a
+  data.tar.gz: 760580e9ca38f757fd4f6c8e3d2e27147c8f32b7061aa45c039ebb68d9b6351fa7c5df8c8fdef9febeaef6f2805ba55894c4226108187e3cf9aca49bea5bef41

data/.travis.yml

@@ -3,3 +3,4 @@ rvm:
   - 1.9.3
   - 2.0.0
   - 2.1
+  - 2.2

data/CHANGELOG.md

@@ -1,6 +1,13 @@
 CHANGELOG
 ================================
 
+v.3.1.4 (2015-02-10)
+--------------------
+####Improvements
+* Use TLSv1.2 by default, and allow users to specify SSL version in config with the :ssl_version parameter
+* Minor refactoring according to Rubocop style guides
+* Test against Ruby 2.2 on Travis
+
 v.3.1.3 (2014-12-02)
 --------------------
 ####Fixes

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2011-2014 MediaSift Ltd
+Copyright (c) 2011-2015 MediaSift Ltd
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -8,7 +8,7 @@ DataSift
 [travis]: https://travis-ci.org/datasift/datasift-ruby
 
 
-The official Ruby library for accessing the DataSift API. 
+The official Ruby library for accessing the DataSift API.
 
 Getting Started
 ---------------
@@ -93,7 +93,8 @@ This version of the client library has been tested, and is known to work against
 ### Language Versions
 * Ruby 1.9.3 (Seems to work, but NOT officially supported/thoroughly tested)
 * Ruby 2.0.0
-* Ruby 2.1.0
+* Ruby 2.1
+* Ruby 2.2
 
 ### Operating Systems
 * Linux
@@ -104,7 +105,7 @@ This version of the client library has been tested, and is known to work against
 License
 -------
 
-All code contained in this repository is Copyright 2011-2014 MediaSift Ltd.
+All code contained in this repository is Copyright 2011-2015 MediaSift Ltd.
 
 This code is released under the BSD license. Please see the [LICENSE](https://github.com/datasift/datasift-ruby/blob/master/LICENSE) file for
 more details.

data/VERSION

@@ -1 +1 @@
-3.1.3
+3.1.4

data/examples/live_stream_eg.rb

@@ -9,12 +9,12 @@ class StreamingApi < DataSiftExample
 
   def run
     begin
-      ruby_received   = 0
+      ruby_received = 0
       python_received = 0
-      ruby           = 'interaction.content contains "ruby"'
+      ruby = 'interaction.content contains "ruby"'
       ruby_stream     = @datasift.compile ruby
 
-      python       = 'interaction.content contains "python"'
+      python = 'interaction.content contains "python"'
       python_stream = @datasift.compile python
 
       on_delete = lambda { |stream, m| puts 'We must delete this to be compliant ==> ' + m }

data/lib/api/api_resource.rb

@@ -7,7 +7,18 @@ 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[:api_version] = 'v1' unless config.has_key?(:api_version)
-      config[:enable_ssl] = false unless config.has_key?(:enable_ssl)
+      config[:enable_ssl] = true unless config.has_key?(:enable_ssl)
+      # Only SSLv3, TLSv1 and TLSv1.2 currently supported, TLSv1.2 preferred
+      #   this is fixed in REST client and is scheduled for the 1.7.0 release
+      #   see https://github.com/rest-client/rest-client/pull/123
+
+      ssl_default = "TLSv1_2"
+      if RUBY_VERSION.to_i == 1
+        ssl_default = "TLSv1"
+      end
+      OpenSSL::SSL::SSLContext::DEFAULT_PARAMS[:ssl_version] = config[:ssl_version] ||
+        ssl_default
+
       # max 320 seconds retry - http://dev.datasift.com/docs/streaming-api/reconnecting
       config[:max_retry_time] = 320 unless config.has_key?(:max_retry_time)
       config[:retry_timeout] = 0 unless config.has_key?(:retry_timeout)

data/lib/datasift.rb

@@ -33,28 +33,20 @@ module DataSift
     while DETECT_DEAD_SOCKETS
       now = Time.now.to_i
       KNOWN_SOCKETS.clone.map { |connection, last_time|
-        if now - last_time > SOCKET_DETECTOR_TIMEOUT
-          connection.stream.reconnect
-        end
+        connection.stream.reconnect if now - last_time > SOCKET_DETECTOR_TIMEOUT
       }
       sleep SOCKET_DETECTOR_TIMEOUT * 10
     end
   end
 
   class Client < ApiResource
-
     #+config+:: A hash containing configuration options for the client for e.g.
     # {username => 'some_user', api_key => 'ds_api_key', 'enable_ssl' => true, open_timeout => 30, timeout => 30}
-    def initialize (config)
-      #only SSLv3 and TLSv1 currently supported, TLSv1 preferred
-      # this is fixed in REST client and is scheduled for the 1.7.0 release
-      # see https://github.com/rest-client/rest-client/pull/123
-      OpenSSL::SSL::SSLContext::DEFAULT_PARAMS[:ssl_version] = 'TLSv1'
-
-      if config == nil
-        raise InvalidConfigError.new ('Config cannot be nil')
+    def initialize(config)
+      if config.nil?
+        raise InvalidConfigError.new('Config cannot be nil')
       end
-      if config.key?(:api_key) == false || config.key?(:username) == false
+      if !config.key?(:username) || !config.key?(:api_key)
         raise InvalidConfigError.new('A valid username and API key are required. ' +
           'You can check your API credentials at https://datasift.com/settings')
       end
@@ -70,16 +62,17 @@ module DataSift
       @dynamic_list_replace     = DataSift::DynamicListReplace.new(config)
     end
 
-    attr_reader :historics, :push, :managed_source, :managed_source_resource, :managed_source_auth,
-      :historics_preview, :dynamic_list, :dynamic_list_replace
+    attr_reader :historics, :push, :managed_source, :managed_source_resource,
+      :managed_source_auth, :historics_preview, :dynamic_list,
+      :dynamic_list_replace
 
     ##
     # Checks if the syntax of the given CSDL is valid
-    #+boolResponse+ If true then a boolean is returned indicating whether the CSDL is valid, otherwise
-    # the response object itself is returned
+    #+boolResponse+ If true then a boolean is returned indicating whether the
+    #   CSDL is valid, otherwise the response object itself is returned
     def valid?(csdl, boolResponse = true)
-      requires({:csdl => csdl})
-      res = DataSift.request(:POST, 'validate', @config, {:csdl => csdl})
+      requires({ :csdl => csdl })
+      res = DataSift.request(:POST, 'validate', @config, :csdl => csdl )
       boolResponse ? res[:http][:status] == 200 : res
     end
 
@@ -87,22 +80,22 @@ module DataSift
     # Compile CSDL code.
     #+csdl+:: The CSDL you wish to compile
     def compile(csdl)
-      requires({:csdl => csdl})
-      DataSift.request(:POST, 'compile', @config, {:csdl => csdl})
+      requires({ :csdl => csdl })
+      DataSift.request(:POST, 'compile', @config, :csdl => csdl )
     end
 
     ##
-    # Check the number of objects processed and delivered for a given time period.
+    # Check the number of objects processed and delivered in a given period
     #+period+:: Can be "day", "hour", or "current", defaults to hour
     def usage(period = :hour)
-      DataSift.request(:POST, 'usage', @config, {:period => period})
+      DataSift.request(:POST, 'usage', @config, :period => period )
     end
 
     ##
     # Calculate the DPU cost of consuming a stream.
     def dpu(hash)
-      requires ({:hash => hash})
-      DataSift.request(:POST, 'dpu', @config, {:hash => hash})
+      requires ({ :hash => hash })
+      DataSift.request(:POST, 'dpu', @config, :hash => hash )
     end
 
     ##
@@ -113,40 +106,40 @@ module DataSift
 
     ##
     # Collect a batch of interactions from a push queue
-    def pull(id, size = 20971520, cursor='')
-      DataSift.request(:POST, 'pull', @config, {:id => id, :size => size, :cursor => cursor})
+    def pull(id, size = 20_971_520, cursor = '')
+      DataSift.request(:POST, 'pull', @config, { :id => id, :size => size, :cursor => cursor })
     end
-
   end
 
-
   # Generates and executes an HTTP request from the params provided
   # Params:
   # +method+:: the HTTP method to use e.g. GET,POST
   # +path+:: the DataSift path relevant to the base URL of the API
   # +username+:: API username
   # +api_key+:: DS api key
-  # +params+:: A hash representing the params to use in the request, if it's a get,head or delete request these params
-  # are used as query string params, if not they become form url encoded params
-  # +headers+:: any headers to pass to the API, Authorization header is automatically included
-  def self.request(method, path, config, params = {}, headers = {}, timeout=30, open_timeout=30, new_line_separated=false)
+  # +params+:: A hash representing the params to use in the request, if its a
+  #   GET, HEAD or DELETE request these params are used as query string params,
+  #   if not they become form url encoded params
+  # +headers+:: any headers to pass to the API, Authorization header is
+  #   automatically included
+  def self.request(method, path, config, params = {}, headers = {}, timeout = 30, open_timeout = 30, new_line_separated = false)
     validate config
     options = {}
-    url     = build_url(path, config)
+    url = build_url(path, config)
 
-    headers.update ({
+    headers.update(
       :user_agent    => "DataSift/#{config[:api_version]} Ruby/v#{VERSION}",
       :authorization => "#{config[:username]}:#{config[:api_key]}",
       :content_type  => 'application/x-www-form-urlencoded'
-    })
+    )
 
     case method.to_s.downcase.to_sym
-      when :get, :head, :delete
-        url     += "#{URI.parse(url).query ? '&' : '?'}#{encode params}"
-        payload = nil
-      else
-        payload = MultiJson.dump(params)
-        headers.update ({ :content_type => 'application/json' })
+    when :get, :head, :delete
+      url += "#{URI.parse(url).query ? '&' : '?'}#{encode params}"
+      payload = nil
+    else
+      payload = MultiJson.dump(params)
+      headers.update({ :content_type => 'application/json' })
     end
 
     options.update(
@@ -156,19 +149,20 @@ module DataSift
       :timeout      => timeout,
       :payload      => payload,
       :url          => url,
-      :ssl_version  => OpenSSL::SSL::SSLContext::DEFAULT_PARAMS[:ssl_version]
+      :ssl_version  => OpenSSL::SSL::SSLContext::DEFAULT_PARAMS[:ssl_version],
+      :verify_ssl   => OpenSSL::SSL::VERIFY_PEER
     )
 
     begin
       response = RestClient::Request.execute options
-      if response != nil && response.length > 0
+      if !response.nil? && response.length > 0
         if new_line_separated
           res_arr = response.split("\n")
           data    = []
           res_arr.each { |e|
             interaction = MultiJson.load(e, :symbolize_keys => true)
             data.push(interaction)
-            if params.has_key? :on_interaction
+            if params.key? :on_interaction
               params[:on_interaction].call(interaction)
             end
           }
@@ -179,7 +173,7 @@ module DataSift
         data = {}
       end
       {
-        :data     => data,
+        :data => data,
         :datasift => {
           :x_ratelimit_limit     => response.headers[:x_ratelimit_limit],
           :x_ratelimit_remaining => response.headers[:x_ratelimit_remaining],
@@ -190,7 +184,7 @@ module DataSift
           :headers => response.headers
         }
       }
-    rescue MultiJson::DecodeError => de
+    rescue MultiJson::DecodeError
       raise DataSiftError.new response
     rescue SocketError => e
       process_client_error(e)
@@ -208,71 +202,74 @@ module DataSift
         process_client_error(e)
       end
     rescue RestClient::Exception, Errno::ECONNREFUSED => e
-      process_client_error (e)
+      process_client_error(e)
     end
   end
 
   def self.build_url(path, config)
-    'http' + (config[:enable_ssl] ? 's' : '') + '://' + config[:api_host] + '/' + config[:api_version] + '/' + path
+    'http' + (config[:enable_ssl] ? 's' : '') + '://' + config[:api_host] +
+      '/' + config[:api_version] + '/' + path
   end
 
-  #returns true if username and api key are set
-  def self.is_invalid? config
+  # Returns true if username or api key are not set
+  def self.is_invalid?(config)
     !config.key?(:username) || !config.key?(:api_key)
   end
 
-  def self.validate conf
-    if is_invalid? conf
+  def self.validate(config)
+    if is_invalid? config
       raise InvalidConfigError.new 'A username and api_key are required'
     end
   end
 
-  def self.encode params
+  def self.encode(params)
     params.collect { |param, value| [param, CGI.escape(value.to_s)].join('=') }.join('&')
   end
 
   def self.handle_api_error(code, body)
     case code
-      when 400
-        raise BadRequestError.new(code, body)
-      when 401
-        raise AuthError.new(code, body)
-      when 404
-        raise ApiResourceNotFoundError.new(code, body)
-      else
-        raise DataSiftError.new(code, body)
+    when 400
+      raise BadRequestError.new(code, body)
+    when 401
+      raise AuthError.new(code, body)
+    when 404
+      raise ApiResourceNotFoundError.new(code, body)
+    else
+      raise DataSiftError.new(code, body)
     end
   end
 
   def self.process_client_error(e)
     case e
-      when RestClient::ServerBrokeConnection, RestClient::RequestTimeout
-        message = 'Unable to connect to DataSift. Please check your connection and try again'
-      when RestClient::SSLCertificateNotVerified
-        message = 'Failed to complete SSL verification'
-      when SocketError
-        message = 'Communication with DataSift failed. Are you able to resolve the API hostname?'
-      else
-        message = 'Unexpected error.'
+    when RestClient::ServerBrokeConnection, RestClient::RequestTimeout
+      message = 'Unable to connect to DataSift. Please check your connection and try again'
+    when RestClient::SSLCertificateNotVerified
+      message = 'Failed to complete SSL verification'
+    when SocketError
+      message = 'Communication with DataSift failed. Are you able to resolve the API hostname?'
+    else
+      message = 'Unexpected error.'
     end
     raise ConnectionError.new(message + " (Network error: #{e.message})")
   end
 
   ##
-  # a Proc/lambda callback to receive delete messages
-  # DataSift and its customers are required to process Twitter's delete request, a delete handler must be provided
-  # a Proc/lambda callback to receive errors
-  # Because EventMachine is used errors can be raised from another thread, this method will receive any such errors
+  # A Proc/lambda callback to receive delete messages.
+  # DataSift and its customers are required to process Twitter's Tweet delete
+  #   requests; a delete handler must be provided.
+  # A Proc/lambda callback to receive errors
+  # Because EventMachine is used errors can be raised from another thread, this
+  #   method will receive any such errors
   def self.new_stream(config, on_delete, on_error, on_open = nil, on_close = nil)
-    if on_delete == nil || on_error == nil
+    if on_delete.nil? || on_error.nil?
       raise NotConfiguredError.new 'on_delete and on_error are required before you can connect'
     end
     raise BadParametersError.new('on_delete - 2 parameter required') unless on_delete.arity == 2
     raise BadParametersError.new('on_error - 2 parameter required') unless on_error.arity == 2
-    if on_open != nil
+    unless on_open.nil?
       raise BadParametersError.new('on_open - 1 parameter required') unless on_open.arity == 1
     end
-    if on_close != nil
+    unless on_close.nil?
       raise BadParametersError.new('on_close - 2 parameter required') unless on_close.arity == 2
     end
     begin
@@ -285,25 +282,25 @@ module DataSift
       stream.on_open            = lambda {
         connection.connected     = true
         connection.retry_timeout = 0
-        on_open.call(connection) if on_open != nil
+        on_open.call(connection) unless on_open.nil?
       }
 
-      stream.on_close  =lambda { |message|
+      stream.on_close = lambda { |message|
         connection.connected = false
         retry_connect(config, connection, on_delete, on_error, on_open, on_close, message, true)
       }
-      stream.on_error  =lambda { |message|
+      stream.on_error = lambda { |message|
         connection.connected = false
         retry_connect(config, connection, on_delete, on_error, on_open, on_close, message)
       }
       stream.on_message=lambda { |msg|
-        data                      = MultiJson.load(msg.data, :symbolize_keys => true)
+        data = MultiJson.load(msg.data, :symbolize_keys => true)
         KNOWN_SOCKETS[connection] = Time.new.to_i
-        if data.has_key?(:deleted)
+        if data.key?(:deleted)
           on_delete.call(connection, data)
-        elsif data.has_key?(:status)
+        elsif data.key?(:status)
           connection.fire_ds_message(data)
-        elsif data.has_key?(:reconnect)
+        elsif data.key?(:reconnect)
           connection.stream.reconnect
         else
           connection.fire_on_message(data[:hash], data[:data])
@@ -311,21 +308,21 @@ module DataSift
       }
     rescue Exception => e
       case e
-        when DataSiftError, ArgumentError
-          raise e
-        else
-          retry_connect(config, connection, on_delete, on_error, on_open, on_close, e.message)
+      when DataSiftError, ArgumentError
+        raise e
+      else
+        retry_connect(config, connection, on_delete, on_error, on_open, on_close, e.message)
       end
     end
     connection
   end
 
   def self.retry_connect(config, connection, on_delete, on_error, on_open, on_close, message = '', use_closed = false)
-    config[:retry_timeout]   = config[:retry_timeout] == 0 || config[:retry_timeout] == nil ? 10 : config[:retry_timeout] * 2
+    config[:retry_timeout] = config[:retry_timeout] == 0 || config[:retry_timeout].nil? ? 10 : config[:retry_timeout] * 2
     connection.retry_timeout = config[:retry_timeout]
 
     if config[:retry_timeout] > config[:max_retry_time]
-      if use_closed && on_close != nil
+      if use_closed && !on_close.nil?
         on_close.call(connection, message)
       else
         on_error.call(connection, ReconnectTimeoutError.new("Connecting to DataSift has failed, re-connection was attempted but

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: datasift
 version: !ruby/object:Gem::Version
-  version: 3.1.3
+  version: 3.1.4
 platform: ruby
 authors:
 - DataSift
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-02 00:00:00.000000000 Z
+date: 2015-02-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -221,7 +221,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.3
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: DataSift is a simple wrapper for the DataSift API.