datasift 3.0.0.beta2 → 3.0.0.beta4

data/lib/errors.rb

@@ -56,4 +56,6 @@ end
 class StreamingMessageError < DataSiftError
 end
 class WebSocketOnWindowsError < DataSiftError
+end
+class BadParametersError < DataSiftError
 end

data/lib/historics.rb

@@ -5,12 +5,12 @@ module DataSift
     # Create a new historics query and return its id.
     def prepare (hash, start, end_time, name, sources = 'twitter', sample = 100)
       params = {
-          :hash    => hash,
-          :start   => start,
-          :end     => end_time,
-          :name    => name,
+          :hash => hash,
+          :start => start,
+          :end => end_time,
+          :name => name,
           :sources => sources,
-          :sample  => sample
+          :sample => sample
       }
       requires params
       DataSift.request(:POST, 'historics/prepare', @config, params)
@@ -26,9 +26,10 @@ module DataSift
 
     ##
     # Stop historics query.
-    def stop(id)
+    def stop(id, reason = '')
       params = {:id => id}
       requires params
+      params[:reason] = reason
       DataSift.request(:POST, 'historics/stop', @config, params)
     end
 
@@ -73,4 +74,4 @@ module DataSift
     end
 
   end
-end
+end

data/lib/historics_preview.rb

@@ -7,7 +7,7 @@ module DataSift
           :parameters => parameters,
           :start      => start
       }
-      params.merge!(end_time) if end_time != nil
+      params.merge!(:end => end_time) if end_time != nil
 
       DataSift.request(:POST, 'preview/create', @config, params)
     end
@@ -17,4 +17,4 @@ module DataSift
     end
 
   end
-end
+end

data/lib/live_stream.rb

@@ -13,7 +13,12 @@ module DataSift
     end
 
     attr_reader :connected, :stream, :retry_timeout, :subscriptions
-    attr_writer :connected, :retry_timeout, :on_datasift_message
+    attr_writer :connected, :retry_timeout
+
+    def on_datasift_message=(p)
+      raise BadParametersError.new('on_ds_message - 3 parameters required') unless p.arity == 3
+      @on_datasift_message = p
+    end
 
     def connected?
       @connected
@@ -42,6 +47,7 @@ module DataSift
     end
 
     def subscribe(hash, on_message)
+      raise BadParametersError.new('on_message - 3 parameters required') unless on_message.arity == 3
       @subscriptions[hash] = on_message
       @stream.send "{ \"action\":\"subscribe\",\"hash\":\"#{hash}\"}"
     end

data/lib/managed_source.rb

@@ -5,18 +5,19 @@ module DataSift
     # Creates a new managed source
     #+source_type+:: can be facebook_page, googleplus, instagram or yammer
     def create(source_type, name, parameters = {}, resources = [], auth = [])
+      raise BadParametersError.new('source_type and name are required') if source_type.nil? || name.nil?
       params = {
           :source_type => source_type,
           :name        => name
       }
-      params.merge!({:auth => MultiJson.dump(auth)}) if !auth.empty?
-      params.merge!({:parameters => MultiJson.dump(parameters)}) if !parameters.empty?
-      params.merge!({:resources => MultiJson.dump(resources)}) if resources.length > 0
-
+      params.merge!({:auth => auth.is_a?(String) ? auth : MultiJson.dump(auth)}) unless auth.empty?
+      params.merge!({:parameters => parameters.is_a?(String) ? parameters : MultiJson.dump(parameters)}) unless parameters.empty?
+      params.merge!({:resources => resources.is_a?(String) ? resources : MultiJson.dump(resources)}) if resources.length > 0
       DataSift.request(:POST, 'source/create', @config, params)
     end
 
     def update(id, source_type, name, parameters = {}, resources = [], auth = [])
+      raise BadParametersError.new('id,source_type and name are required') if id.nil? || source_type.nil? || name.nil?
       params = {
           :id          => id,
           :source_type => source_type,
@@ -30,14 +31,17 @@ module DataSift
     end
 
     def delete(id)
+      raise BadParametersError.new('id is required') if id.nil?
       DataSift.request(:DELETE, 'source/delete', @config, {:id => id})
     end
 
     def stop(id)
+      raise BadParametersError.new('id is required') if id.nil?
       DataSift.request(:POST, 'source/stop', @config, {:id => id})
     end
 
     def start(id)
+      raise BadParametersError.new('id is required') if id.nil?
       DataSift.request(:POST, 'source/start', @config, {:id => id})
     end
 
@@ -50,8 +54,9 @@ module DataSift
     end
 
     def log(id, page = 1, per_page = 20)
-      DataSift.request(:POST, 'source/get', @config, {:id => id, :page => page, :per_page => per_page})
+      raise BadParametersError.new('id is required') if id.nil?
+      DataSift.request(:POST, 'source/log', @config, {:id => id, :page => page, :per_page => per_page})
     end
 
   end
-end
+end

data/lib/push.rb

@@ -7,10 +7,10 @@ module DataSift
 
     ##
     # Check that a subscription is defined correctly
-    def valid?(params)
+    def valid?(params, bool_response = true)
       requires params
       res = DataSift.request(:POST, 'push/validate', @config, params)
-      res[:http][:status] == 200
+      bool_response ? res[:http][:status] == 200 : res
     end
 
     ##
@@ -67,10 +67,10 @@ module DataSift
     # Retrieve log messages for a specific subscription
     def logs_for (id, page = 1, per_page = 20, order_by = :request_time, order_dir = :desc)
       params = {
-          :id        => id,
-          :page      => page,
-          :per_page  => per_page,
-          :order_by  => order_by,
+          :id => id,
+          :page => page,
+          :per_page => per_page,
+          :order_by => order_by,
           :order_dir => order_dir
       }
       DataSift.request(:GET, 'push/log', @config, params)
@@ -80,9 +80,9 @@ module DataSift
     # Retrieve log messages for all subscriptions
     def logs (page = 1, per_page = 20, order_by = :request_time, order_dir = :desc)
       params = {
-          :page      => page,
-          :per_page  => per_page,
-          :order_by  => order_by,
+          :page => page,
+          :per_page => per_page,
+          :order_by => order_by,
           :order_dir => order_dir
       }
       DataSift.request(:GET, 'push/log', @config, params)
@@ -92,10 +92,10 @@ module DataSift
     # Get details of the subscription with the given ID
     def get_by_subscription(id, page = 1, per_page = 20, order_by = :request_time, order_dir = :desc)
       params = {
-          :id        => id,
-          :page      => page,
-          :per_page  => per_page,
-          :order_by  => order_by,
+          :id => id,
+          :page => page,
+          :per_page => per_page,
+          :order_by => order_by,
           :order_dir => order_dir
       }
       DataSift.request(:GET, 'push/get', @config, params)
@@ -105,10 +105,10 @@ module DataSift
     # Get details of the subscription with the given stream ID/hash
     def get_by_hash(hash, page = 1, per_page = 20, order_by = :request_time, order_dir = :desc)
       params = {
-          :hash      => hash,
-          :page      => page,
-          :per_page  => per_page,
-          :order_by  => order_by,
+          :hash => hash,
+          :page => page,
+          :per_page => per_page,
+          :order_by => order_by,
           :order_dir => order_dir
       }
       DataSift.request(:GET, 'push/get', @config, params)
@@ -119,21 +119,21 @@ module DataSift
     def get_by_historics_id(id, page = 1, per_page = 20, order_by = :request_time, order_dir = :desc)
       params = {
           :historics_id => id,
-          :page         => page,
-          :per_page     => per_page,
-          :order_by     => order_by,
-          :order_dir    => order_dir
+          :page => page,
+          :per_page => per_page,
+          :order_by => order_by,
+          :order_dir => order_dir
       }
       DataSift.request(:GET, 'push/get', @config, params)
     end
 
     ##
     # Get details of all subscriptions within the given page constraints
-    def get(page = 1, per_page = 20, order_by = :request_time, order_dir = :desc)
+    def get(page = 1, per_page = 20, order_by = :created_at, order_dir = :desc)
       params = {
-          :page      => page,
-          :per_page  => per_page,
-          :order_by  => order_by,
+          :page => page,
+          :per_page => per_page,
+          :order_by => order_by,
           :order_dir => order_dir
       }
       DataSift.request(:GET, 'push/get', @config, params)
@@ -143,14 +143,14 @@ module DataSift
     # Pull data from a 'pull' type Push Subscription
     def pull(id, size = 20971520, cursor = '', callback = nil)
       params = {
-          :id     => id,
-          :size   => size,
+          :id => id,
+          :size => size,
           :cursor => cursor
       }
       if callback
-          params.merge!({:on_interaction => callback})
+        params.merge!({:on_interaction => callback})
       end
       DataSift.request(:GET, 'pull', @config, params, {}, 30, 30, true)
     end
   end
-end
+end

data/tests/core_api_test.rb

@@ -0,0 +1,95 @@
+require '../examples/auth'
+require 'test/unit'
+require 'webmock/test_unit'
+require 'multi_json'
+class CoreApiTest < Test::Unit::TestCase
+
+  def setup
+    auth       = DataSiftExample.new
+    @datasift  = auth.datasift
+    @data      = OpenStruct.new
+    @responses = OpenStruct.new
+    @statuses  = OpenStruct.new
+    @headers   = OpenStruct.new
+
+    @data.valid_csdl        = 'interaction.content contains "test"'
+    @data.invalid_csdl      = 'interaction.nonsense is not valid'
+    #{"created_at" => "2014-01-30 10:09:19", "dpu" => "0.1"}
+    @responses.valid_csdl   = '{"created_at": "2014-01-30 10:09:19","dpu": "0.1"}'
+    @responses.invalid_csdl = '{"error": "The target interaction.nonsense does not exist"}'
+    @responses.valid_stream = OpenStruct.new({:hash => '145ea24a4d83a14ecb9077b831f14809', :created_at => '2014-01-30 17:35:14', :dpu => '0.1'})
+
+    @statuses.valid_csdl   = 200
+    @statuses.invalid_csdl = 400
+
+    @headers.valid_csdl = {
+        "date"              => "Thu, 30 Jan 2014 10:09:19 GMT", "content-type" => "application/json",
+        "transfer-encoding" => "chunked", "connection" => "close", "x-api-version" => "1",
+        "x-ratelimit-limit" => "10000", "x-ratelimit-remaining" => "10000", "x-ratelimit-cost" => "5"}
+    #valid CSDL
+    stub_request(:post, /api.datasift.com\/.*\/validate/).
+        with(:body => {"csdl" => @data.valid_csdl}).
+        to_return(:status  => @statuses.valid_csdl,
+                  :body    => @responses.valid_csdl,
+                  :headers => @headers.valid_csdl)
+    #invalid CSDL
+    stub_request(:post, /api.datasift.com\/.*\/validate/).
+        with(:body => {"csdl" => @data.invalid_csdl}).
+        to_return(:status  => @statuses.invalid_csdl,
+                  :body    => @responses.invalid_csdl,
+                  :headers => @headers.valid_csdl)
+    #valid stream compilation
+    stub_request(:post, /api.datasift.com\/.*\/compile/).
+        with(:body => {"csdl" => @data.valid_csdl}).
+        to_return(:status  => @statuses.valid_csdl,
+                  :body    => MultiJson.dump(@responses.valid_stream),
+                  :headers => @headers.valid_csdl)
+
+  end
+
+
+  def teardown
+    # Do nothing
+  end
+
+  def test_csdl_cant_be_nil_when_validating
+    assert_raise InvalidParamError do
+      @datasift.valid?(nil)
+    end
+  end
+
+  def test_csdl_cant_be_empty_when_validating
+    assert_raise InvalidParamError do
+      @datasift.valid?('')
+    end
+  end
+
+  def test_if_user_can_get_successful_validation_as_bool
+    assert_boolean @datasift.valid?(@data.valid_csdl), 'Valid must return a bool by default'
+    assert_true @datasift.valid?(@data.valid_csdl), 'This request should have returned true'
+  end
+
+  def test_if_user_can_get_successful_validation_as_hash
+    validation = @datasift.valid?(@data.valid_csdl, false)
+    assert_kind_of Hash, validation, 'Valid should return a hash here'
+    assert_equal @statuses.valid_csdl, validation[:http][:status], "This request should have returned status as #{@statuses.validate_csdl}"
+  end
+
+  def test_failing_csdl_validation
+    assert_raise BadRequestError do
+      @datasift.valid?(@data.invalid_csdl)
+    end
+  end
+
+  def test_csdl_cant_be_nil_when_compiling
+    assert_raise InvalidParamError do
+      @datasift.compile(nil)
+    end
+  end
+
+  def test_csdl_cant_be_empty_when_compiling
+    assert_raise InvalidParamError do
+      @datasift.compile('')
+    end
+  end
+end

metadata

@@ -1,97 +1,111 @@
 --- !ruby/object:Gem::Specification
 name: datasift
 version: !ruby/object:Gem::Version
-  version: 3.0.0.beta2
+  version: 3.0.0.beta4
 platform: ruby
 authors:
 - DataSift
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-02 00:00:00.000000000 Z
+date: 2014-05-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.6.3
+        version: 1.6.7
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.6.3
+        version: 1.6.7
 - !ruby/object:Gem::Dependency
   name: multi_json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.8.0
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.8.0
 - !ruby/object:Gem::Dependency
   name: websocket-td
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.0.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.0.4
 - !ruby/object:Gem::Dependency
   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
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.17.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.17.1
 - !ruby/object:Gem::Dependency
   name: shoulda
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.11.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.11.3
 - !ruby/object:Gem::Dependency
   name: test-unit
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.5.5
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.5.5
 description: The official Ruby library for accessing the DataSift API. See http://datasift.com/
@@ -102,15 +116,16 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - CHANGELOG.md
 - Gemfile
 - LICENSE
+- MIGRATING_TO_V.3.0.0.md
 - README.md
-- Rakefile
 - VERSION
 - datasift.gemspec
 - examples/auth.rb
+- examples/cli.sh
 - examples/core_api_eg.rb
 - examples/historics_eg.rb
 - examples/historics_preview_eg.rb
@@ -119,6 +134,7 @@ files:
 - examples/pull.rb
 - examples/push_eg.rb
 - lib/api/api_resource.rb
+- lib/cli.rb
 - lib/datasift.rb
 - lib/errors.rb
 - lib/historics.rb
@@ -126,7 +142,7 @@ files:
 - lib/live_stream.rb
 - lib/managed_source.rb
 - lib/push.rb
-- test/core_api_test.rb
+- tests/core_api_test.rb
 homepage: https://github.com/datasift/datasift-ruby
 licenses:
 - BSD
@@ -137,19 +153,18 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: DataSift is a simple wrapper for the DataSift API.
-test_files:
-- test/core_api_test.rb
+test_files: []