datasift 3.1.0 → 3.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dac333f752e67d6791b6bc3936553e01ab09f2c6
-  data.tar.gz: 7f02d47c1cb8103e1f7315a10365c21c512e8521
+  metadata.gz: fa899a750cdf5d358c93ab071c4dc35c796f3114
+  data.tar.gz: 2d2a1b150ec62f0e689be3ebf48749183e5d5fba
 SHA512:
-  metadata.gz: 2cbf887afc303ce2f470d1beaa3adf92f010b46b9abc58025769ca5828acf542efdf85e343a0b51af39a62fca73e6637a6403f2a43322c3a3a756b2e27ba3933
-  data.tar.gz: 0033b783f9dc01b1f846be11fbb751c335274bd896198584c9b900fa338d9b5e07fd85686eee90404fc61749f49f54431cbe070d402213ae7b547a0356c6b4d6
+  metadata.gz: 7931605c899901c11f9563d31b695a1b41f8dc9fe3d5c7de8204e06eb272620502064ea212cb620586f2da80507b12ab85d1c6e892e1b6a3102d86e3e1bba28b
+  data.tar.gz: 5ad02f8dd35ca6f4bd6230087a70d5145482f2778d9b9fe86e335cca5703afad257ca28395bc7fe0642c91bccc4e22ec98a5e650ab47db17a5238249c4d8090c

data/CHANGELOG.md

@@ -1,6 +1,12 @@
 CHANGELOG
 ================================
 
+v.3.1.1 (2014-08-14)
+--------------------
+
+####Fixes
+Resolves [#59](https://github.com/datasift/datasift-ruby/issues/59); we now use CGI.escape rather than URI.escape to ensure special characters such as '+' or '\' are escaped correctly when submitted. 
+
 v.3.1.0 (2014-07-30)
 --------------------
 

data/README.md

@@ -1,20 +1,31 @@
 DataSift
 ========
 
+[![Gem Version](http://img.shields.io/gem/v/datasift.svg)][gem]
+[![Build Status](http://img.shields.io/travis/datasift/datasift-ruby.svg)][travis]
+
+[gem]: https://rubygems.org/gems/datasift
+[travis]: https://travis-ci.org/datasift/datasift-ruby
+
+
 The official Ruby library for accessing the DataSift API. See
-http://datasift.com/ for full details and to sign up for an account.
+[datasift.com](http://datasift.com/) for full details and to sign up for an account.
 
 Install Instructions
 --------------------
 
+```
 sudo gem install datasift
+```
 
 Dependencies
 ------------
 
 If you're using the source you'll need to install the dependencies.
 
+```
 sudo gem install rest-client multi_json websocket-td
+```
 
 The library will use SSL connections by default. While we recommend using SSL
 you may disable it if required by passing ':enable_ssl => false' as the third
@@ -24,7 +35,7 @@ Getting Started
 ---------------
 Before you can begin using this library, you will need to have an active [DataSift](http://datasift.com) account - you can sign up for a new account at [datasift.com/get-started](http://datasift.com/get-started/).
 
-Many of the examples and API endpoints used in this library require you have enabled certain data sources before you can receive any data (you should do this at [datasift.com/source](https://datasift.com/source)). Certain API features, such as [Historics](http://datasift.com/platform/historics/) and [Managed Sources](http://datasift.com/platform/datasources/) will require you have signed up to a monthly subscription before you can access them. 
+Many of the examples and API endpoints used in this library require you have enabled certain data sources before you can receive any data (you should do this at [datasift.com/source](https://datasift.com/source)). Certain API features, such as [Historics](http://datasift.com/platform/historics/) and [Managed Sources](http://datasift.com/platform/datasources/) will require you have signed up to a monthly subscription before you can access them.
 
 If you are interested in using these features, or would like more information about DataSift, please [get in touch](http://datasift.com/contact-us/)!
 

data/VERSION

@@ -1 +1 @@
-3.1.0
+3.1.1

data/datasift.gemspec

@@ -15,12 +15,12 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency('multi_json', '~> 1.8.0')
   s.add_runtime_dependency('websocket-td', '~> 0.0.4')
 
-  s.add_development_dependency('rdoc', '~> 0')
+  s.add_development_dependency('rdoc', '>= 0')
   s.add_development_dependency('webmock', '~> 1.17.1')
   s.add_development_dependency('shoulda', '~> 2.11.3')
   s.add_development_dependency('minitest', '~> 5.0')
-  s.add_development_dependency('rake', '~> 0')
-  s.add_development_dependency('simplecov', '~> 0')
+  s.add_development_dependency('rake', '>= 0')
+  s.add_development_dependency('simplecov', '>= 0')
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test}/*`.split("\n")

data/examples/auth.rb

@@ -6,19 +6,25 @@ class DataSiftExample
     @api_key  = 'DATASIFT_API_KEY'
     @config   = {:username => @username, :api_key => @api_key, :enable_ssl => true}
     @params   = {
-        :output_type                       => 's3',
-        'output_params.bucket'             => 'YOUR_BUCKET_NAME',
-        'output_params.directory'          => 'ruby',
-        'output_params.acl'                => 'private',
-        'output_params.auth.access_key'    => 'ADD_YOUR_ACCESS_KEY',
-        'output_params.auth.secret_key'    => 'ADD_YOUR_SECRET_KEY',
-        'output_params.delivery_frequency' => 0,
-        'output_params.max_size'           => 104857600,
-        'output_params.file_prefix'        => 'DataSift',
+      :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_params => {
+        :max_size => 52428800
+      }
     }
     @datasift = DataSift::Client.new(@config)
   end

data/lib/datasift.rb

@@ -1,6 +1,7 @@
 dir = File.dirname(__FILE__)
 #
 require 'uri'
+require 'cgi'
 require 'rest_client'
 require 'multi_json'
 require 'websocket_td'
@@ -134,9 +135,9 @@ module DataSift
     url     = build_url(path, config)
 
     headers.update ({
-        :user_agent    => "DataSift/#{config[:api_version]} Ruby/v#{VERSION}",
-        :authorization => "#{config[:username]}:#{config[:api_key]}",
-        :content_type  => 'application/x-www-form-urlencoded'
+      :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
@@ -144,19 +145,18 @@ module DataSift
         url     += "#{URI.parse(url).query ? '&' : '?'}#{encode params}"
         payload = nil
       else
-        #payload = encode params
         payload = MultiJson.dump(params)
         headers.update ({ :content_type => 'application/json' })
     end
 
     options.update(
-        :headers      => headers,
-        :method       => method,
-        :open_timeout => open_timeout,
-        :timeout      => timeout,
-        :payload      => payload,
-        :url          => url,
-        :ssl_version => 'TLSv1'
+      :headers      => headers,
+      :method       => method,
+      :open_timeout => open_timeout,
+      :timeout      => timeout,
+      :payload      => payload,
+      :url          => url,
+      :ssl_version => 'TLSv1'
     )
 
     begin
@@ -179,16 +179,16 @@ module DataSift
         data = {}
       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]
-          },
-          :http     => {
-              :status  => response.code,
-              :headers => response.headers
-          }
+        :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]
+        },
+        :http => {
+          :status  => response.code,
+          :headers => response.headers
+        }
       }
     rescue MultiJson::DecodeError => de
       raise DataSiftError.new response
@@ -228,7 +228,7 @@ module DataSift
   end
 
   def self.encode params
-    URI.escape(params.collect { |k, v| "#{k}=#{v}" }.join('&'))
+    params.collect { |param, value| [param, CGI.escape(value.to_s)].join('=') }.join('&')
   end
 
   def self.handle_api_error(code, body)
@@ -282,7 +282,7 @@ module DataSift
       stream.on_ping            = lambda { |data|
         KNOWN_SOCKETS[connection] = Time.new.to_i
       }
-      stream.on_open            =lambda {
+      stream.on_open            = lambda {
         connection.connected     = true
         connection.retry_timeout = 0
         on_open.call(connection) if on_open != nil

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: datasift
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.1.1
 platform: ruby
 authors:
 - DataSift
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-13 00:00:00.000000000 Z
+date: 2014-08-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -56,14 +56,14 @@ dependencies:
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
@@ -112,28 +112,28 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: The official Ruby library for accessing the DataSift API. See http://datasift.com/
@@ -165,7 +165,6 @@ files:
 - examples/managed_source_eg.rb
 - examples/pull.rb
 - examples/push_eg.rb
-- lib/DataSift/managed_source.rb
 - lib/api/api_resource.rb
 - lib/cli.rb
 - lib/datasift.rb

data/lib/DataSift/managed_source.rb

@@ -1,263 +0,0 @@
-require 'yajl/json_gem'
-### Usage ###
-# user = DataSift::User.new(config['username'], config['api_key'])
-# user.createManagedSource(:token => "CAAIUKbXn8xsBAILlxGCZADEZAM87tRqJXo9OqWskCs6jej3wfQ1LRRZAgHJQEZCHU0ABBXDwiq9o7D4uytC5LpsAcx7oiDusagsJiKtmPaZBeMkuGh4jYt1zsXo4EQuZCWPcZAIdQQLZBtjTpQlbbAZCTuJ4SSrlmOPQZD", :source_type => "facebook_page", :name => "test", :parameters=> {:likes => true, :posts_by_others =>  true, :comments => true}, :resources => [{ :url =>  "http://www.facebook.com/theguardian", :title =>  "The Guardian", :id => 10513336322 } ] )
-
-module DataSift
-  #The ManagedSource class represents a ManagedSource query.
-  class ManagedSource
-    #The ID of this Managed Source
-    attr_reader :managed_source_id
-    #The Managed Source type
-    attr_reader :source_type
-    #The current status of this Managed Source.
-    attr_reader :status
-    #The title for this Managed Source.
-    attr_reader :name
-    #The date/time when this Managed Source was created.
-    attr_reader :created_at
-    #The Managed Source source_type
-    attr_reader :source_type
-    #The Managed Source parameters
-    attr_reader :parameters
-    #The Managed Source resources
-    attr_reader :resources
-    #The Managed Source token
-    attr_reader :token
-    #The Managed Source auth
-    attr_reader :auth
-    #Api raw response
-    attr_reader :raw_attributes
-
-    #Constructor. Pass all parameters to create a new Managed Source, or provide a User object and a managed_source_id to load an existing Managed Source from the API.
-    #=== Parameters
-    #* +user+ - The DataSift::User object.
-    def initialize(user, hash)
-      raise InvalidDataError, 'Please supply a valid User object when creating a Managed Source object.' unless user.is_a? DataSift::User
-      @user = user
-
-      if hash.kind_of?(Hash)
-        if hash.has_key?('id')
-          # Initialising from an array
-          @managed_source_id = hash['id']
-          initFromArray(hash)
-        else
-          @source_type = hash[:source_type]
-          @name = hash[:name]
-          @parameters = hash[:parameters]
-          @resources = hash[:resources]
-          @auth = hash[:auth]
-        end
-      else
-        # Fetching from the API
-        @managed_source_id = hash
-        reloadData()
-      end
-    end
-
-    #Get a single Managed Source by ID.
-    #=== Parameters
-    #* +id+ - The Managed Source ID.
-    #=== Returns
-    #A ManagedSource object
-    def self.get(user, managed_source_id)
-      return new(user, user.callAPI('source/get', { 'id' => managed_source_id }))
-    end
-
-    def self.list(user, page = 1, per_page = 20, source_type = '')
-      begin
-        res = user.callAPI(
-        'source/get', {
-          'page' => page,
-          'per_page' => per_page,
-          'source_type' => source_type
-          })
-          retval = { 'count' => res['count'], 'managed_sources' => [] }
-          for source in res['sources']
-           retval['managed_sources'].push(new(user, source))
-          end
-          retval
-        rescue APIError => err
-          case err.http_code
-          when 400
-            #Missing or invalid parameters
-            raise InvalidDataError, err
-          else
-            raise APIError.new(err.http_code), 'Unexpected APIError code: ' + err.http_code.to_s + ' [' + err.message + ']'
-          end
-        end
-    end
-
-    #Call the DataSift API to create the Managed Source
-    def create()
-      raise InvalidDataError, 'This Managed Source has already been created' unless not @managed_source_id
-
-      begin
-        res = @user.callAPI(
-        'source/create', {
-          'source_type' => @source_type,
-          'name' => @name,
-          'parameters' => @parameters.to_json,
-          'resources' => @resources.to_json,
-          'auth' => @auth.to_json
-        })
-        raise InvalidDataError, 'Prepared successfully but no managed_source_id ID in the response' unless res.has_key?('id')
-        @managed_source_id = res['id']
-
-      rescue APIError => err
-        case err.http_code
-        when 400
-          raise InvalidDataError, err
-        else
-          raise APIError.new(err.http_code), 'Unexpected APIError code: ' + err.http_code.to_s + ' [' + err.message + ']'
-        end
-      end
-
-      # Reload the data so we get the created_at date, initial status and the rest.
-      reloadData()
-    end
-
-    #Reload the data for this object from the API.
-    def reloadData()
-      #Can't do this without a playback ID
-      raise InvalidDataError, 'Cannot reload the data with a Managed Source with no Managed Source ID' unless @managed_source_id
-
-      begin
-        initFromArray(@user.callAPI('source/get', { 'id' => @managed_source_id }))
-      rescue APIError => err
-        case err.http_code
-        when 400
-          raise InvalidDataError, err
-        else
-          raise APIError.new(err.http_code), 'Unexpected APIError code: ' + err.http_code.to_s + ' [' + err.message + ']'
-        end
-      end
-    end
-
-    #Initialise this object from the data in a Hash.
- 		#=== Parameters
-    #* +data+ - The Hash containing the data.
-    def initFromArray(data)
-      raise APIError, 'No managed source ID in the response' unless data.has_key?('id')
-      raise APIError, 'Incorrect managed source ID in the response' unless not @managed_source_id or data['id'] == @managed_source_id
-      @managed_source_id = data['id']
-
-      raise APIError, 'No name in the response' unless data.has_key?('name')
-      @name = data['name']
-
-      raise APIError, 'No auth in the response' unless data.has_key?('auth')
-      @auth = data['auth']
-
-      raise APIError, 'No created at timstamp in the response' unless data.has_key?('created_at')
-      @created_at = DateTime.strptime(String(data['created_at']), '%s')
-
-      raise APIError, 'No status in the response' unless data.has_key?('status')
-      @status = data['status']
-
-      raise APIError, 'No source_type in the response' unless data.has_key?('source_type')
-      @source_type = data['source_type']
-
-      raise APIError, 'No parameters in the response' unless data.has_key?('parameters')
-      @parameters = data['parameters']
-
-      raise APIError, 'No resources in the response' unless data.has_key?('resources')
-      @resources = data['resources']
-
-      @raw_attributes = data
-
-      return true
-    end
-
-    #Start this Managed Source query.
-    def start()
-      raise InvalidDataError, 'Cannot start a Managed souce query that hasn\'t been created' unless @managed_source_id
-
-      begin
-        res = @user.callAPI('source/start', { 'id' => @managed_source_id })
-      rescue APIError => err
-        case err.http_code
-        when 400
-          # Missing or invalid parameters
-          raise InvalidDataError, err
-        when 404
-          # Managed Source not found
-          raise InvalidDataError, err
-        else
-          raise APIError.new(err.http_code), 'Unexpected APIError code: ' + err.http_code.to_s + ' [' + err.message + ']'
-        end
-      end
-    end
-
-    #Stop this Managed Source
-    def stop()
-      raise InvalidDataError, 'Cannot stop a Managed Source query that hasn\'t been prepared' unless @managed_source_id
-
-      begin
-        res = @user.callAPI('source/stop', { 'id' => @managed_source_id })
-      rescue APIError => err
-        case err.http_code
-        when 400
-          # Missing or invalid parameters
-          raise InvalidDataError, err
-        when 404
-          # Managed Source not found
-          raise InvalidDataError, err
-        else
-          raise APIError.new(err.http_code), 'Unexpected APIError code: ' + err.http_code.to_s + ' [' + err.message + ']'
-        end
-      end
-    end
-
-    #Delete this Managed Source
-    def delete()
-      raise InvalidDataError, 'Cannot delete a Managed source query that hasn\'t been prepared' unless @managed_source_id
-
-      begin
-        @user.callAPI('source/delete', { 'id' => @managed_source_id })
-      rescue APIError => err
-        case err.http_code
-        when 400
-          # Missing or invalid parameters
-          raise InvalidDataError, err
-        when 404
-          # Managed Source not found
-          raise InvalidDataError, err
-        else
-          raise APIError.new(err.http_code), 'Unexpected APIError code: ' + err.http_code.to_s + ' [' + err.message + ']'
-        end
-      end
-    end
-
-    #Page through recent Managed Sources log entries
-    #=== Parameters
-    #* +page+ - The page number to get.
-    #* +per_page+ - The number of items per page.
-    #=== Returns
-    #A Hash containing...
-    #* +count+ - The total number of matching log entries.
-    #* +log_entries+ - An array of Hashes where each Hash is a log entry.
-    def getLogs(page = 1, per_page = 20)
-      begin
-        raise InvalidDataError, 'The specified page number is invalid' unless page >= 1
-        raise InvalidDataError, 'The specified per_page value is invalid' unless per_page >= 1
-
-        params = {
-          'id'        => @managed_source_id,
-          'page'      => page,
-          'per_page'  => per_page
-        }
-
-        return @user.callAPI('source/log', params)
-      rescue APIError => err
-        case err.http_code
-        when 400
-          # Missing or invalid parameters
-          raise InvalidDataError, err
-        else
-          raise APIError.new(err.http_code), 'Unexpected APIError code: ' + err.http_code.to_s + ' [' + err.message + ']'
-        end
-      end
-    end
-
-  end
-end