datasift 3.0.0.beta4 → 3.0.0

data/test/datasift/core_api_test.rb

@@ -0,0 +1,153 @@
+require File.expand_path('../../test_helper', __FILE__)
+
+describe 'DataSift' do
+
+  before do
+    auth      = DataSiftExample.new
+    @datasift = auth.datasift
+    @data     = OpenStruct.new
+    @statuses = OpenStruct.new
+    @headers  = OpenStruct.new
+
+    @data.valid_csdl    = 'interaction.content contains "test"'
+    @data.invalid_csdl  = 'interaction.nonsense is not valid'
+
+    @statuses.valid        = 200
+    @statuses.bad_request  = 400
+
+  end
+
+  describe '#compile/validate' do
+    before do
+      @headers.csdl_compile = {
+          "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,
+                    :body    => fixture('validate_csdl_valid.json'),
+                    :headers => @headers.csdl_compile)
+      #invalid CSDL
+      stub_request(:post, /api.datasift.com\/.*\/validate/).
+          with(:body => {"csdl" => @data.invalid_csdl}).
+          to_return(:status  => @statuses.bad_request,
+                    :body    => fixture('validate_csdl_invalid.json'),
+                    :headers => @headers.csdl_compile)
+      #valid stream compilation
+      stub_request(:post, /api.datasift.com\/.*\/compile/).
+          with(:body => {"csdl" => @data.valid_csdl}).
+          to_return(:status  => @statuses.valid,
+                    :body    => fixture('compile_csdl_valid.json'),
+                    :headers => @headers.csdl_compile)
+    end
+
+    it 'test_csdl_cant_be_nil_when_validating' do
+      assert_raises InvalidParamError do
+        @datasift.valid?(nil)
+      end
+    end
+
+    it 'test_csdl_cant_be_empty_when_validating' do
+      assert_raises InvalidParamError do
+        @datasift.valid?('')
+      end
+    end
+
+    it 'test_if_user_can_get_successful_validation_as_bool' do
+      assert @datasift.valid?(@data.valid_csdl), 'Valid CSDL must return true'
+    end
+
+    it 'test_if_user_can_get_successful_validation_as_hash' do
+      validation = @datasift.valid?(@data.valid_csdl, false)
+      assert_kind_of Hash, validation, 'Valid should return a hash here'
+      assert_equal @statuses.valid, validation[:http][:status], "This request should have returned status as #{@statuses.validate_csdl}"
+    end
+
+    it 'test_failing_csdl_validation' do
+      assert_raises BadRequestError do
+        @datasift.valid?(@data.invalid_csdl)
+      end
+    end
+
+    it 'test_csdl_cant_be_nil_when_compiling' do
+      assert_raises InvalidParamError do
+        @datasift.compile(nil)
+      end
+    end
+
+    it 'test_csdl_cant_be_empty_when_compiling' do
+      assert_raises InvalidParamError do
+        @datasift.compile('')
+      end
+    end
+  end
+
+  describe '#usage' do
+    describe 'with valid request' do
+      before do
+        @headers.valid_usage = {
+            "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" => "25"}
+
+        #valid /usage request
+        stub_request(:post, /api.datasift.com\/.*\/usage/).
+            with(:body => {:period => 'hour'}).
+            to_return(status:  @statuses.valid,
+                      body:    fixture('usage_current.json'),
+                      headers: @headers.valid_usage)
+      end
+
+      it 'can get users usage' do
+        @datasift.usage
+        assert_requested(:post, "https://api.datasift.com/v1/usage", :body => {"period"=>"hour"})
+      end
+    end
+  end
+
+  describe '#dpu' do
+    before do
+      @data.dpu_hash_valid = '145ea24a4d83a14ecb9077b831f14809'
+      @headers.dpu = {
+          "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 /dpu request
+      stub_request(:post, /api.datasift.com\/.*\/dpu/).
+          with(:body => {:hash => @data.dpu_hash_valid}).
+          to_return(status:  @statuses.valid,
+                    body:    fixture('dpu_valid.json'),
+                    headers: @headers.dpu)
+    end
+
+    it 'can get dpu cost for valid stream' do
+      @datasift.dpu(@data.dpu_hash_valid)
+      assert_requested(:post, "https://api.datasift.com/v1/dpu", body: {hash: @data.dpu_hash_valid})
+    end
+  end
+
+  describe '#balance' do
+    before do
+      @headers.balance = {
+          "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" => "25"}
+
+      #valid /dpu request
+      stub_request(:post, /api.datasift.com\/.*\/balance/).
+          to_return(status:  @statuses.valid,
+                    body:    fixture('balance.json'),
+                    headers: @headers.balance)
+    end
+
+    it 'can get account balance' do
+      @datasift.balance
+      assert_requested(:post, "https://api.datasift.com/v1/balance")
+    end
+  end
+
+end

data/test/datasift/historics_preview_api_test.rb

@@ -0,0 +1,83 @@
+require File.expand_path('../../test_helper', __FILE__)
+
+describe 'DataSift::HistoricsPreview' do
+
+  before do
+    auth      = DataSiftExample.new
+    @datasift = auth.datasift
+    @data     = OpenStruct.new
+    @statuses = OpenStruct.new
+    @headers  = OpenStruct.new
+
+    @statuses.valid     = 200
+    @statuses.accepted  = 202
+  end
+
+  describe '#create' do
+    before do
+      @data.stream_hash = '145ea24a4d83a14ecb9077b831f14809'
+      @data.sources     = 'facebook,twitter'
+      @data.parameters  = 'language.tag,freqDist,5;interaction.id,targetVol,hour'
+      @data.start       = '1398898800'
+      @data.end         = '1398985200'
+
+      @headers.preview_create = {
+            "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" => "25"}
+
+      #valid /preview/create request
+      stub_request(:post, /api.datasift.com\/.*\/preview\/create/).
+          with(:body => { :hash       => @data.stream_hash,
+                          :sources    => @data.sources,
+                          :parameters => @data.parameters,
+                          :start      => @data.start,
+                          :end        => @data.end}).
+          to_return(status:  @statuses.valid,
+                    body:    fixture('preview_create_valid.json'),
+                    headers: @headers.preview_create)
+    end
+
+    it 'can create an Historics Preview' do
+      @datasift.historics_preview.create(@data.stream_hash, @data.sources, @data.parameters, @data.start, @data.end)
+      assert_requested( :post,
+                        'https://api.datasift.com/v1/preview/create',
+                        :body => {:start      => @data.start,
+                                  :end        => @data.end,
+                                  :hash       => @data.stream_hash,
+                                  :sources    => @data.sources,
+                                  :parameters => @data.parameters})
+    end
+
+  end
+
+  describe '#get' do
+    before do
+      @data.id = 'fbd5441ab17a46f2ac200f8cab6bdb79fe8efb31'
+
+      @headers.preview_get = {
+            "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 /preview/get running request
+      stub_request(:post, /api.datasift.com\/.*\/preview\/get/).
+          with(:body => { :id => @data.id}).
+          to_return(status:  @statuses.accepted,
+                    body:    fixture('preview_get_running.json'),
+                    headers: @headers.preview_get)
+
+      #valid /preview/get succeeded request
+      stub_request(:post, /api.datasift.com\/.*\/preview\/get/).
+          with(:body => { :id => @data.id}).
+          to_return(status:  @statuses.valid,
+                    body:    fixture('preview_get_succeeded.json'),
+                    headers: @headers.preview_get)
+    end
+
+    it 'can get an Historics Preview' do
+      @datasift.historics_preview.get(@data.id)
+      assert_requested( :post, 'https://api.datasift.com/v1/preview/get', :body => {:id => @data.id})
+    end
+  end
+end

data/test/datasift/push_api_test.rb

@@ -0,0 +1,223 @@
+require File.expand_path('../../test_helper', __FILE__)
+
+describe 'DataSift::Push' do
+
+  before do
+    auth      = DataSiftExample.new
+    @datasift = auth.datasift
+    @data     = OpenStruct.new
+    @statuses = OpenStruct.new
+
+    @statuses.valid        = 200
+    @statuses.no_content   = 204
+#    @statuses.invalid_csdl = 400
+#    @statuses.bad_request  = 400
+
+    @data.params = {
+        'name'                              => 'connectorhttp',
+        'output_type'                       => 'http',
+        'output_params.url'                 => 'http://example.com/datasift',
+        'output_params.compression'         => 'none',
+        'output_params.delivery_frequency'  => '0',
+        'output_params.max_size'            => '10485760',
+        'output_params.verify_ssl'          => 'false',
+        'output_params.auth.type'           => 'basic',
+        'output_params.auth.username'       => 'username',
+        'output_params.auth.password'       => 'password'
+      }
+
+    @data.subscription_params  = {:id           => '7802b84cfe79e50e0a6e3cdac5ce54ab',
+                                  :stream_hash  => '145ea24a4d83a14ecb9077b831f14809',
+                                  :historics_id => '5f569d6f99002bfaa483' }
+  end
+
+  describe '#push/validate' do
+    before do
+      #valid /push/validate request
+      stub_request(:post, "https://api.datasift.com/v1/push/validate").
+      with(:body => @data.params).
+      to_return(status: @statuses.valid,
+                body:   fixture('push_validate_valid.json'))
+    end
+
+    it 'can validate a push destination' do
+      @datasift.push.valid? @data.params
+      assert_requested(:post, 'https://api.datasift.com/v1/push/validate', :body => @data.params)
+    end
+  end
+
+  describe '#push/create' do
+    before do
+      @data.params.merge({'hash' => '145ea24a4d83a14ecb9077b831f14809'})
+
+      #valid /push/create request
+      stub_request(:post, "https://api.datasift.com/v1/push/create").
+      with(:body => @data.params).
+      to_return(status: @statuses.valid,
+                body:   fixture('push_create_valid.json'))
+    end
+
+    it 'can create a push subscription' do
+      @datasift.push.create @data.params
+      assert_requested(:post, 'https://api.datasift.com/v1/push/create', :body => @data.params)
+    end
+  end
+
+  describe '#push/get' do
+    before do
+      @data.list_params = { :order_by   => 'created_at',
+                            :order_dir  => 'desc',
+                            :page       => 1,
+                            :per_page   => 20 }
+
+      #valid /push/get request
+      stub_request(:get, "https://api.datasift.com/v1/push/get").
+        with(:query => {:id => @data.subscription_params['id']}).
+        to_return(status: @statuses.valid,
+                  body:   fixture('push_get_valid.json'))
+
+      #valid /push/get list request
+      stub_request(:get, "https://api.datasift.com/v1/push/get").
+        with(:query => @data.list_params).
+        to_return(status:  @statuses.valid,
+                  body:    fixture('push_get_list_valid.json'))
+
+      #valid /push/get list by hash request
+      stub_request(:get, "https://api.datasift.com/v1/push/get").
+        with(:query => @data.list_params.merge('hash' => @data.subscription_params['stream_hash'])).
+        to_return(status:  @statuses.valid,
+                  body:    fixture('push_get_list_by_hash_valid.json'))
+
+      #valid /push/get list by historics id request
+      stub_request(:get, "https://api.datasift.com/v1/push/get").
+        with(:query => @data.list_params.merge('historics_id' => @data.subscription_params['historics_id'])).
+        to_return(status:  @statuses.valid,
+                  body:    fixture('push_get_list_by_historics_id_valid.json'))
+    end
+
+    it 'can get a specific push subscription' do
+      @datasift.push.get_by_subscription @data.subscription_params['id']
+      assert_requested(:get, 'https://api.datasift.com/v1/push/get', :query => {:id => @data.subscription_params['id']})
+    end
+
+    it 'can get a list of push subscriptions' do
+      @datasift.push.get
+      assert_requested(:get, 'https://api.datasift.com/v1/push/get', :query => @data.list_params)
+    end
+
+    it 'can get a list of push subscriptions by stream hash' do
+      @datasift.push.get_by_hash @data.subscription_params['stream_hash']
+      assert_requested(:get, 'https://api.datasift.com/v1/push/get', :query => @data.list_params.merge('hash' => @data.subscription_params['stream_hash']))
+    end
+
+    it 'can get a list of push subscriptions by historic id' do
+      @datasift.push.get_by_historics_id @data.subscription_params['historics_id']
+      assert_requested(:get, 'https://api.datasift.com/v1/push/get', :query => @data.list_params.merge('historics_id' => @data.subscription_params['historics_id']))
+    end
+  end
+
+  describe '#push/stop' do
+    before do
+      #valid /push/stop request
+      stub_request(:put, "https://api.datasift.com/v1/push/stop").
+        with(:body => {:id => @data.subscription_params[:id]}).
+        to_return(status: @statuses.valid,
+                  body:   fixture('push_stop_valid.json'))
+    end
+
+    it 'can stop a push subscription' do
+      @datasift.push.stop @data.subscription_params[:id]
+      assert_requested(:put, 'https://api.datasift.com/v1/push/stop', :body => {:id => @data.subscription_params[:id]})
+    end
+  end
+
+  describe '#push/log' do
+    before do
+      @data.list_params = { :order_by   => 'request_time',
+                            :order_dir  => 'desc',
+                            :page       => 1,
+                            :per_page   => 20 }
+
+      #valid /push/log request
+      stub_request(:get, "https://api.datasift.com/v1/push/log").
+        with(:query => @data.list_params.merge('id' => @data.subscription_params[:id])).
+        to_return(status: @statuses.valid,
+                  body:   fixture('push_log_valid.json'))
+      #valid /push/log list request
+      stub_request(:get, "https://api.datasift.com/v1/push/log").
+        with(:query => @data.list_params).
+        to_return(status: @statuses.valid,
+                  body:   fixture('push_log_valid.json'))
+    end
+
+    it 'can get the /push/log for a given subscription' do
+      @datasift.push.log_for @data.subscription_params[:id]
+      assert_requested(:get, 'https://api.datasift.com/v1/push/log', :query => @data.list_params.merge('id' => @data.subscription_params[:id]))
+    end
+
+    it 'can get the /push/log for all subscriptions' do
+      @datasift.push.log
+      assert_requested(:get, 'https://api.datasift.com/v1/push/log', :query => @data.list_params)
+    end
+  end
+
+  describe '#push/pause' do
+    before do
+      #valid /push/pause request
+      stub_request(:put, "https://api.datasift.com/v1/push/pause").
+        with(:body => {:id => @data.subscription_params[:id]}).
+        to_return(status: @statuses.valid,
+                  body:   fixture('push_pause_valid.json'))
+    end
+
+    it 'can pause a push subscription' do
+      @datasift.push.pause @data.subscription_params[:id]
+      assert_requested(:put, 'https://api.datasift.com/v1/push/pause', :body => {:id => @data.subscription_params[:id]})
+    end
+  end
+
+  describe '#push/resume' do
+    before do
+      #valid /push/resume request
+      stub_request(:put, "https://api.datasift.com/v1/push/resume").
+        with(:body => {:id => @data.subscription_params[:id]}).
+        to_return(status: @statuses.valid,
+                  body:   fixture('push_get_valid.json'))
+    end
+
+    it 'can resume a push subscription' do
+      @datasift.push.resume @data.subscription_params[:id]
+      assert_requested(:put, 'https://api.datasift.com/v1/push/resume', :body => {:id => @data.subscription_params[:id]})
+    end
+  end
+
+  describe '#push/update' do
+    before do
+      @data.update_params = {id: @data.subscription_params[:id]}
+      #valid /push/update request
+      stub_request(:post, "https://api.datasift.com/v1/push/update").
+        with(:body => {:id => @data.subscription_params[:id]}).
+        to_return(status: @statuses.valid,
+                  body:   fixture('push_get_valid.json'))
+    end
+
+    it 'can update a push subscription' do
+      @datasift.push.update @data.update_params
+      assert_requested(:post, 'https://api.datasift.com/v1/push/update', :body => @data.update_params)
+    end
+  end
+
+  describe '#push/delete' do
+    before do
+      #valid /push/delete request
+      stub_request(:delete, "https://api.datasift.com/v1/push/delete").
+        with(:query => {:id => @data.subscription_params[:id]}).
+        to_return(status: @statuses.no_content)
+    end
+
+    it 'can delete a push subscription' do
+      @datasift.push.delete @data.subscription_params[:id]
+      assert_requested(:delete, 'https://api.datasift.com/v1/push/delete', :query => {:id => @data.subscription_params[:id]})
+    end
+  end
+end