datasift 3.1.5 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7e26c08e631f867f85ab95045922077db5b67e1c
-  data.tar.gz: 93187c60a79ee54862d6cb535903c722dcfd1aff
+  metadata.gz: c6c428274cf28d80ef439f0ca06a5a247cf70140
+  data.tar.gz: dc0df1b7d90456facf9cdc193ee69a2ebd5ab210
 SHA512:
-  metadata.gz: 6924f398475a57823c4dcaa1a5ccf08ac0504b19b2b0b15c88243ad1ee8e6888c0ba0c49dec3dc6dc579429d03cbd7bf1bdf475ac3ad2230a077b15260f2deac
-  data.tar.gz: dd038e17916e0416fbd6b0484fb32f5386925e45ddde4e73c414b69279c6d45612825b29cbf4e34764064aab560e09fe8dffddbb1875e25a55a61db44e0bc870
+  metadata.gz: c150becbafbc9ddf74a49b482bd2b83f93b67595701779c7383c6232b78739099982f1e4cdd6170b0fe8b13b05ef28c01ab96e28b709d8f31fd399dd12e04956
+  data.tar.gz: 9188cf1a6dead964bfee1a77ea8d3ecad37e4261af29eab15e505c7f51d9a0b4d7998aee69eae75f141670eed02bfd55459f8e28460e047d1314628a13f189e4

data/.gitignore

@@ -2,10 +2,11 @@
 sftp-config.json
 *.iml
 .idea/
-rdoc/
 .bundle/
 Gemfile.lock
-coverage/*
+coverage/
 TODO
 pkg/*
 *.gem
+.yardoc
+doc/

data/.yardopts

@@ -0,0 +1,4 @@
+--no-private
+--protected
+lib/**/*.rb
+-

data/CHANGELOG.md

@@ -1,5 +1,28 @@
 CHANGELOG
 ================================
+## v.3.2.0 (2015-05-13)
+### Added
+* Support for [PYLON API](http://dev.datasift.com/pylon/docs/api-endpoints)
+* Support for [Account Identities API](http://dev.datasift.com/pylon/docs/api/account-api)
+* Adds opts for Managed Sources create/update endpoints to allow passing of 'validate' param
+* Support for HTTP 409 Conflict error
+* Support for HTTP 410 Gone error
+* Comprehensive Yard Docs for all classes and methods
+* Due to API v1.1 change, we've added support for ```include_finished``` and ```all``` parameters when making calls to the ```/push/get``` API endpoint
+* Due to the API v1.1 change, a ```delivery_count``` field has been added to the main object, and individual chunks in the response from ```/historics/get``` calls
+* Due to the API v1.1 change, an ```interaction_count``` field has been added to the respomse from ```/push/get``` API calls
+* The ```dpu()``` method now also accepts the ```historics_id``` parameter, which allows you to get the DPU cost of an Historics query
+
+### Changed
+* Some refactoring for the Rubocop across the library
+* We now use [VCR](https://github.com/vcr/vcr) in our test suite for all outbound API calls
+* Updated some methods due to deprecations in the Ruby language
+* Use DataSift API v1.1 by default
+* Due to the API v1.1 change, /usage and /balance API calls will now return an empty Object rather than an empy Array when there is no data available
+
+### Deprecated
+* Support for Ruby 1.x is being dropped in the next major release; 4.0.0
+* Due to the API v1.1 change, the ```volume_info``` field has been removed from ```/historics/get``` API calls
 
 v.3.1.5 (2015-04-16)
 --------------------

data/Gemfile

@@ -1,2 +1,15 @@
 source "https://rubygems.org"
+
+gem 'rake'
+gem 'yard'
+
+group :test do
+  gem 'minitest', '~> 5.0'
+  gem 'rubocop', '>= 0.27'
+  gem 'simplecov', '>= 0.9'
+  gem 'shoulda', '~> 2.11'
+  gem 'vcr', '~> 2.9'
+  gem 'webmock'
+end
+
 gemspec

data/README.md

@@ -1,6 +1,5 @@
 DataSift
 ========
-
 [![Gem Version](http://img.shields.io/gem/v/datasift.svg)][gem]
 [![Build Status](http://img.shields.io/travis/datasift/datasift-ruby.svg)][travis]
 
@@ -12,7 +11,6 @@ The official Ruby library for accessing the DataSift API.
 
 Getting Started
 ---------------
-
 **Read our [Ruby Getting Started Guide](http://dev.datasift.com/quickstart/ruby) to get started with the DataSift platform.** The guide will take you through creating a [DataSift](http://datasift.com) account, and activating data sources which you will need to do before using the DataSift API.
 
 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.
@@ -22,14 +20,12 @@ If you are interested in using these features, or would like more information ab
 
 Install Instructions
 --------------------
-
 ```
 sudo gem install datasift
 ```
 
 Dependencies
 ------------
-
 If you're using the source you'll need to install the dependencies.
 
 ```
@@ -37,19 +33,18 @@ 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
-parameter when creating your @config object.
+you may disable it if required by passing ```enable_ssl: false``` as the third
+parameter when creating your ```@config``` object.
 
 
 Simple example
 --------------
-
 This example looks for anything that contains the word "football" in real-time,
 and simply prints the content to the screen as they come in.
 
 ```ruby
 require 'datasift'
-@config = {:username => 'DATASIFT_USERNAME', :api_key => 'DATASIFT_API_KEY', :enable_ssl => true}
+@config = { username: 'DATASIFT_USERNAME', api_key: 'DATASIFT_API_KEY' }
 @datasift = DataSift::Client.new(@config)
 csdl = 'interaction.content contains "football"'
 filter = @datasift.compile csdl
@@ -83,16 +78,13 @@ conn.on_datasift_message = on_datasift_message
 conn.stream.read_thread.join
 ```
 
-See the [Understanding the Output Data](http://dev.datasift.com/docs/getting-started/data) page on the DataSift Developer site for
-full details of the data contained within each interaction.
-
 Supported Operating Environment
 -------------------------------
 This version of the client library has been tested, and is known to work against the following language versions and Operating Systems:
 
 ### Language Versions
-* Ruby 1.9.3 (Seems to work, but NOT officially supported/thoroughly tested)
-* Ruby 2.0.0
+* Ruby 1.9.3 (Support for Ruby 1.x will be dropped from v4.0 of the library)
+* Ruby 2.0
 * Ruby 2.1
 * Ruby 2.2
 
@@ -102,10 +94,19 @@ This version of the client library has been tested, and is known to work against
 * OS X
 * Windows 7/8
 
+Contributing
+------------
+Contributions are always welcome and appreciated
+
+1. Fork on GitHub
+2. Create a feature branch (we use [Gitflow](http://datasift.github.io/gitflow/IntroducingGitFlow.html) for branching)
+3. Commit your changes with tests
+	* New feature? Send a pull request against the develop branch.
+	* Bug fix? Send a pull request against the master branch.
+	* Please don't break backwards-compatibility :)
+
 License
 -------
-
 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.
+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.5
+3.2.0

data/datasift.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
   s.name        = 'datasift'
   s.version     = File.open('VERSION').first
-  s.authors     = ['DataSift']
+  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.}
   s.summary     = %q{DataSift is a simple wrapper for the DataSift API.}
@@ -9,20 +9,14 @@ Gem::Specification.new do |s|
   s.license     = 'BSD'
 
   s.platform    = Gem::Platform::RUBY
-  s.required_rubygems_version = Gem::Requirement.new(">= 1.3.6") if s.respond_to? :required_rubygems_version=
-
-  s.add_runtime_dependency('rest-client', '~> 1.6')
-  s.add_runtime_dependency('multi_json', '>= 1.7')
-  s.add_runtime_dependency('websocket-td', '~> 0.0.4')
-
-  s.add_development_dependency('rdoc', '>= 0')
-  s.add_development_dependency('webmock', '~> 1.17')
-  s.add_development_dependency('shoulda', '~> 2.11')
-  s.add_development_dependency('minitest', '~> 5.0')
-  s.add_development_dependency('rake', '>= 0')
-  s.add_development_dependency('simplecov', '>= 0')
-
+  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.require_paths = ["lib"]
+
+  s.add_runtime_dependency('rest-client', '~> 1.6')
+  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_identity_eg.rb

@@ -0,0 +1,48 @@
+require './auth'
+class AccountIdentityEg < DataSiftExample
+  def initialize
+    super
+    @datasift = DataSift::Client.new(@config)
+    run
+  end
+
+  def run
+    begin
+      puts "Create a new identity"
+      identity = @datasift.account_identity.create(
+        "Ruby Identity", "active", false
+      )
+      identity_id = identity[:data][:id]
+      puts identity.to_json
+
+      puts "\nList all existing identities"
+      puts @datasift.account_identity.list.to_json
+
+      puts "\nGet existing identity"
+      puts @datasift.account_identity.get(identity_id).to_json
+
+      puts "\nUpdate an identity"
+      puts @datasift.account_identity.update(
+        identity_id, 'Updated Ruby Identity'
+      ).to_json
+
+      puts "\nDelete an identity"
+      puts @datasift.account_identity.delete(identity_id).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
+
+AccountIdentityEg.new

data/examples/account_identity_limit_eg.rb

@@ -0,0 +1,68 @@
+require './auth'
+class AccountIdentityLimitEg < DataSiftExample
+  def initialize
+    super
+    @datasift = DataSift::Client.new(@config)
+    run
+  end
+
+  def run
+    begin
+      puts "Create a new identity to apply Limits to"
+      identity = @datasift.account_identity.create(
+        "Ruby Identity for Token Limits", "active", false
+      )
+      identity_id = identity[:data][:id]
+      puts identity.to_json
+
+      puts "\nCreate a Limit for our Identity"
+      puts @datasift.account_identity_limit.create(
+        identity_id,
+        'facebook',
+        100_000
+      )
+
+      puts "\nList all existing Limits for this Service"
+      puts @datasift.account_identity_limit.list(
+        'facebook'
+      ).to_json
+
+      puts "\nGet existing Limit by Identity and Service"
+      puts @datasift.account_identity_limit.get(
+        identity_id,
+        'facebook'
+      ).to_json
+
+      puts "\nUpdate a Limit for a given Identity"
+      puts @datasift.account_identity_limit.update(
+        identity_id,
+        'facebook',
+        250_000
+      ).to_json
+
+      puts "\nRemove the Limit from a given Identity and Service"
+      puts @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
+      # 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
+
+AccountIdentityLimitEg.new

data/examples/account_identity_token_eg.rb

@@ -0,0 +1,70 @@
+require './auth'
+class AccountIdentityTokenEg < DataSiftExample
+  def initialize
+    super
+    @datasift = DataSift::Client.new(@config)
+    run
+  end
+
+  def run
+    begin
+      puts "Create a new identity to create tokens for"
+      identity = @datasift.account_identity.create(
+        "Ruby Identity for Tokens",
+        "active",
+        false
+      )
+      identity_id = identity[:data][:id]
+      puts identity.to_json
+
+      puts "\nCreate a Token for our Identity"
+      puts @datasift.account_identity_token.create(
+        identity_id,
+        'facebook',
+        'YOUR_TOKEN'
+      )
+
+      puts "\nList all existing Tokens for this Identity"
+      puts @datasift.account_identity_token.list(
+        identity_id
+      ).to_json
+
+      puts "\nGet existing Token by Identity and Service"
+      puts @datasift.account_identity_token.get(
+        identity_id,
+        'facebook'
+      ).to_json
+
+      puts "\nUpdate a Token for a given Identity"
+      puts @datasift.account_identity_token.update(
+        identity_id,
+        'facebook',
+        'YOUR_NEW_TOKEN'
+      ).to_json
+
+      puts "\nDelete an Token for a given Identity and Service"
+      puts @datasift.account_identity_token.delete(
+        identity_id,
+        'facebook'
+      ).to_json
+
+      puts "\nCleanup and remove the Identity"
+      @datasift.account_identity.delete(identity_id)
+
+    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
+
+AccountIdentityTokenEg.new

data/examples/auth.rb

@@ -3,9 +3,9 @@ class DataSiftExample
 
   def initialize
     @username = 'DATASIFT_USERNAME'
-    @api_key  = 'DATASIFT_API_KEY'
-    @config   = {:username => @username, :api_key => @api_key, :enable_ssl => true}
-    @params   = {
+    @api_key = 'DATASIFT_API_KEY'
+    @config = { :username => @username, :api_key => @api_key }
+    @params = {
       :output_type => 's3',
       :output_params => {
         :bucket             => 'YOUR_BUCKET_NAME',
@@ -29,7 +29,7 @@ class DataSiftExample
     @datasift = DataSift::Client.new(@config)
   end
 
-  attr_reader :datasift
+  attr_reader :datasift, :params
 
   def create_push(hash, is_historics_id = false)
     create_params = @params.merge ({

data/examples/core_api_eg.rb

@@ -16,7 +16,7 @@ class CoreApiEg < DataSiftExample
       # http://dev.datasift.com/docs/rest-api/compile
       puts "\nCompile the CSDL and get a stream hash"
       stream = @datasift.compile csdl
-      puts stream[:data][:hash]
+      puts stream[:data]
 
       # http://dev.datasift.com/docs/rest-api/dpu
       puts "\nGet the DPU cost of the compiled CSDL"
@@ -33,7 +33,6 @@ class CoreApiEg < DataSiftExample
       usage = @datasift.usage
       puts usage[:data]
 
-        #rescue DataSiftError
     rescue DataSiftError => dse
       puts dse.message
       # Then match specific one to take action - All errors thrown by the client extend DataSiftError

data/examples/historics_eg.rb

@@ -22,8 +22,11 @@ class HistoricsApi < DataSiftExample
 
       id = historics[:data][:id]
 
+      puts "\nCheck the DPU cost of this Historics query"
+      puts "#{@datasift.dpu('', id)[:data][:dpu]} DPUs"
+
       puts "\nCreating push subscription for historics"
-      puts create_push(id, true)
+      subscription = create_push(id, true)
 
       puts "\nStarting historics #{id}"
       puts @datasift.historics.start id
@@ -48,6 +51,9 @@ class HistoricsApi < DataSiftExample
 
       puts "\nDeleting historics"
       puts @datasift.historics.delete id
+
+      puts "\nCleanup and delete Push subscription"
+      puts @datasift.push.delete subscription[:data][:id]
     rescue DataSiftError => dse
       puts dse.message
     end