swiftype 0.0.5 → 1.0.0

data/spec/fixtures/vcr/update_document_unknown_field_failure.yml

@@ -0,0 +1,45 @@
+---
+http_interactions:
+- request:
+    method: put
+    uri: http://hello:@localhost:3000/api/v1/engines/swiftype-api-example/document_types/videos/documents/FtX8nswnUKU/update_fields.json
+    body:
+      encoding: UTF-8
+      string: ! '{"fields":{"not_a_field":"not a field"}}'
+    headers:
+      Accept:
+      - ! '*/*'
+      User-Agent:
+      - Swiftype-Ruby/1.0.0
+      Content-Type:
+      - application/json
+  response:
+    status:
+      code: 400
+      message: Bad Request
+    headers:
+      Content-Type:
+      - application/json; charset=utf-8
+      X-Ua-Compatible:
+      - IE=Edge
+      Cache-Control:
+      - no-cache
+      Set-Cookie:
+      - _session_id=BAh7B0kiD3Nlc3Npb25faWQGOgZFRkkiJTAyNzA5MzQyMWU1YjAxMzQ4NDVkNGMxNDIxZWUyZmFhBjsAVEkiGXdhcmRlbi51c2VyLnVzZXIua2V5BjsAVFsISSIJVXNlcgY7AEZbBlU6Gk1vcGVkOjpCU09OOjpPYmplY3RJZCIRUDg5%2By7ZYCnHAAABSSIiJDJhJDEwJE1rNmZOdHA1cC9ZNVIuQU5sZFB2UWUGOwBU--2f8beaf078c885a87f8fe33dc37fff06995d1993;
+        path=/; HttpOnly
+      X-Request-Id:
+      - 0ee335dac175f232bf27d29dc65cc45a
+      X-Runtime:
+      - '0.034146'
+      Connection:
+      - close
+      Server:
+      - thin 1.5.0 codename Knife
+    body:
+      encoding: US-ASCII
+      string: ! '{"error":"Error updating field(s). Attempt to set() nonexistent key.  Known
+        keys are: url, thumbnail_url, channel_id, title, caption, category_name, category_id,
+        published_at, duration, view_count, like_count"}'
+    http_version: 
+  recorded_at: Thu, 12 Sep 2013 22:40:58 GMT
+recorded_with: VCR 2.5.0

data/spec/fixtures/vcr/update_documents_failure_non_existent_document.yml

@@ -0,0 +1,45 @@
+---
+http_interactions:
+- request:
+    method: put
+    uri: http://hello:@localhost:3000/api/v1/engines/swiftype-api-example/document_types/videos/documents/bulk_update.json
+    body:
+      encoding: UTF-8
+      string: ! '{"documents":[{"external_id":"not_there","fields":[{"name":"title","value":"hi","type":"string"}]}]}'
+    headers:
+      Accept:
+      - ! '*/*'
+      User-Agent:
+      - Swiftype-Ruby/1.0.0
+      Content-Type:
+      - application/json
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Content-Type:
+      - application/json; charset=utf-8
+      X-Ua-Compatible:
+      - IE=Edge
+      Etag:
+      - ! '"f9e544f77b7eac7add281ef28ca5559f"'
+      Cache-Control:
+      - max-age=0, private, must-revalidate
+      Set-Cookie:
+      - _session_id=BAh7B0kiD3Nlc3Npb25faWQGOgZFRkkiJTkzYTQ3NTIwNGRmMWY3MTkyMDVmNGZiZTM3ZWU1ZDQyBjsAVEkiGXdhcmRlbi51c2VyLnVzZXIua2V5BjsAVFsISSIJVXNlcgY7AEZbBlU6Gk1vcGVkOjpCU09OOjpPYmplY3RJZCIRUDg5%2By7ZYCnHAAABSSIiJDJhJDEwJE1rNmZOdHA1cC9ZNVIuQU5sZFB2UWUGOwBU--8efc561386be1984b12246d0ab067933720a0179;
+        path=/; HttpOnly
+      X-Request-Id:
+      - a9fd5dc44eb51d4a7d37fd53b165ba3a
+      X-Runtime:
+      - '0.150458'
+      Connection:
+      - close
+      Server:
+      - thin 1.5.0 codename Knife
+    body:
+      encoding: US-ASCII
+      string: ! '[false]'
+    http_version: 
+  recorded_at: Thu, 12 Sep 2013 22:46:53 GMT
+recorded_with: VCR 2.5.0

data/spec/fixtures/vcr/update_documents_success.yml

@@ -0,0 +1,45 @@
+---
+http_interactions:
+- request:
+    method: put
+    uri: http://hello:@localhost:3000/api/v1/engines/swiftype-api-example/document_types/videos/documents/bulk_update.json
+    body:
+      encoding: UTF-8
+      string: ! '{"documents":[{"external_id":"INscMGmhmX4","fields":{"title":"hi"}},{"external_id":"XfY9Dsg_DZk","fields":{"title":"bye"}}]}'
+    headers:
+      Accept:
+      - ! '*/*'
+      User-Agent:
+      - Swiftype-Ruby/1.0.0
+      Content-Type:
+      - application/json
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Content-Type:
+      - application/json; charset=utf-8
+      X-Ua-Compatible:
+      - IE=Edge
+      Etag:
+      - ! '"bb009c6dcb5c622766ad5aa1ea1562d9"'
+      Cache-Control:
+      - max-age=0, private, must-revalidate
+      Set-Cookie:
+      - _session_id=BAh7B0kiD3Nlc3Npb25faWQGOgZFRkkiJWM1YzRmN2EwYjg5NzU5YjU3MDE4ZTg0OWUyMzc0ZWU3BjsAVEkiGXdhcmRlbi51c2VyLnVzZXIua2V5BjsAVFsISSIJVXNlcgY7AEZbBlU6Gk1vcGVkOjpCU09OOjpPYmplY3RJZCIRUDg5%2By7ZYCnHAAABSSIiJDJhJDEwJE1rNmZOdHA1cC9ZNVIuQU5sZFB2UWUGOwBU--f928b9637411dd24c049b64c4bb0ca7455bb0508;
+        path=/; HttpOnly
+      X-Request-Id:
+      - 904d7bc728da1bbcb64649cbfb310078
+      X-Runtime:
+      - '0.062213'
+      Connection:
+      - close
+      Server:
+      - thin 1.5.0 codename Knife
+    body:
+      encoding: US-ASCII
+      string: ! '[true,true]'
+    http_version: 
+  recorded_at: Thu, 12 Sep 2013 22:57:05 GMT
+recorded_with: VCR 2.5.0

data/spec/fixtures/vcr/users_client_secret_incorrect.yml

@@ -0,0 +1,42 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://localhost:3000/api/v1/users.json?client_id=0d94f7cf2bd1e65a7e1f9f929d1bcb2b248af69b8112d24484e87014125538f8&client_secret=wrong
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - ! '*/*'
+      User-Agent:
+      - Swiftype-Ruby/1.0.0
+      Content-Type:
+      - application/json
+  response:
+    status:
+      code: 401
+      message: Unauthorized
+    headers:
+      Www-Authenticate:
+      - Basic realm="Swiftype"
+      Content-Type:
+      - application/json; charset=utf-8
+      X-Ua-Compatible:
+      - IE=Edge
+      Cache-Control:
+      - no-cache
+      X-Request-Id:
+      - 3605ea2e9f85f5b74652d7bade07e97a
+      X-Runtime:
+      - '0.013547'
+      Connection:
+      - close
+      Server:
+      - thin 1.5.0 codename Knife
+    body:
+      encoding: US-ASCII
+      string: ! '{"error":"You need to sign in or sign up before continuing."}'
+    http_version: 
+  recorded_at: Fri, 13 Sep 2013 00:53:23 GMT
+recorded_with: VCR 2.5.0

data/spec/fixtures/vcr/users_no_api_key.yml

@@ -0,0 +1,42 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://localhost:3000/api/v1/users.json?client_id=0d94f7cf2bd1e65a7e1f9f929d1bcb2b248af69b8112d24484e87014125538f8&client_secret=f600fb0b16b516cbb9b9f0eeb60f3b35f685b5ec4a94694ae57b5bbb8860f240
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - ! '*/*'
+      User-Agent:
+      - Swiftype-Ruby/1.0.0
+      Content-Type:
+      - application/json
+  response:
+    status:
+      code: 401
+      message: Unauthorized
+    headers:
+      Www-Authenticate:
+      - Basic realm="Swiftype"
+      Content-Type:
+      - application/json; charset=utf-8
+      X-Ua-Compatible:
+      - IE=Edge
+      Cache-Control:
+      - no-cache
+      X-Request-Id:
+      - 29b283e021cb39b78c9b6ef0c06ec041
+      X-Runtime:
+      - '0.015617'
+      Connection:
+      - close
+      Server:
+      - thin 1.5.0 codename Knife
+    body:
+      encoding: US-ASCII
+      string: ! '{"error":"You need to sign in or sign up before continuing."}'
+    http_version: 
+  recorded_at: Fri, 13 Sep 2013 00:53:23 GMT
+recorded_with: VCR 2.5.0

data/spec/fixtures/vcr/users_no_client_id_or_secret.yml

@@ -0,0 +1,43 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://hello:@localhost:3000/api/v1/users.json?client_id&client_secret
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - ! '*/*'
+      User-Agent:
+      - Swiftype-Ruby/1.0.0
+      Content-Type:
+      - application/json
+  response:
+    status:
+      code: 400
+      message: Bad Request
+    headers:
+      Content-Type:
+      - application/json; charset=utf-8
+      X-Ua-Compatible:
+      - IE=Edge
+      Cache-Control:
+      - no-cache
+      Set-Cookie:
+      - _session_id=BAh7B0kiD3Nlc3Npb25faWQGOgZFRkkiJTllNTAzNzFlZDcwYWFhOWQ4MGRiOGYzMTkxMDUzODgzBjsAVEkiGXdhcmRlbi51c2VyLnVzZXIua2V5BjsAVFsISSIJVXNlcgY7AEZbBlU6Gk1vcGVkOjpCU09OOjpPYmplY3RJZCIRUDg5%2By7ZYCnHAAABSSIiJDJhJDEwJE1rNmZOdHA1cC9ZNVIuQU5sZFB2UWUGOwBU--3a3ffdd780afdce5468176fe6593400bdc28ab0e;
+        path=/; HttpOnly
+      X-Request-Id:
+      - afbbf899940811879d2af25a041fa397
+      X-Runtime:
+      - '0.026651'
+      Connection:
+      - close
+      Server:
+      - thin 1.5.0 codename Knife
+    body:
+      encoding: US-ASCII
+      string: ! '{"error":"Missing required parameter: client_id"}'
+    http_version: 
+  recorded_at: Fri, 13 Sep 2013 00:53:23 GMT
+recorded_with: VCR 2.5.0

data/spec/platform_spec.rb

@@ -0,0 +1,95 @@
+require 'spec_helper'
+
+describe 'platform user API' do
+  let(:client) { Swiftype::Client.new }
+
+  context 'authentication' do
+    it 'succeeds with api_key and correct client_id and client_secret' do
+      Swiftype.api_key = 'hello'
+      Swiftype.platform_client_id = '0d94f7cf2bd1e65a7e1f9f929d1bcb2b248af69b8112d24484e87014125538f8'
+      Swiftype.platform_client_secret = 'f600fb0b16b516cbb9b9f0eeb60f3b35f685b5ec4a94694ae57b5bbb8860f240'
+
+      VCR.use_cassette('list_users') do
+        expect do
+          client.users
+        end.to_not raise_error
+      end
+    end
+
+    it 'fails without api_key' do
+      Swiftype.platform_client_id = '0d94f7cf2bd1e65a7e1f9f929d1bcb2b248af69b8112d24484e87014125538f8'
+      Swiftype.platform_client_secret = 'f600fb0b16b516cbb9b9f0eeb60f3b35f685b5ec4a94694ae57b5bbb8860f240'
+
+      VCR.use_cassette('users_no_api_key') do
+        expect do
+          client.users
+        end.to raise_error
+      end
+    end
+
+    it 'fails with missing client_id and client_secret' do
+      Swiftype.api_key = 'hello'
+
+      VCR.use_cassette('users_no_client_id_or_secret') do
+        expect do
+          client.users
+        end.to raise_error
+      end
+    end
+
+    it 'fails with incorrect client_secret' do
+      Swiftype.platform_client_id = '0d94f7cf2bd1e65a7e1f9f929d1bcb2b248af69b8112d24484e87014125538f8'
+      Swiftype.platform_client_secret = 'wrong'
+
+      VCR.use_cassette('users_client_secret_incorrect') do
+        expect do
+          client.users
+        end.to raise_error
+      end
+    end
+  end
+
+  context 'with proper authentication' do
+    before :each do
+      Swiftype.api_key = 'hello'
+      Swiftype.platform_client_id = '0d94f7cf2bd1e65a7e1f9f929d1bcb2b248af69b8112d24484e87014125538f8'
+      Swiftype.platform_client_secret = 'f600fb0b16b516cbb9b9f0eeb60f3b35f685b5ec4a94694ae57b5bbb8860f240'
+    end
+
+    context 'creating a user' do
+      it 'returns a Hash with user info' do
+        VCR.use_cassette('create_user') do
+          user = client.create_user
+          user.should have_key('id')
+          user.should have_key('access_token')
+        end
+      end
+    end
+
+    context 'listing users' do
+      it 'returns the first page of users' do
+        VCR.use_cassette('list_users') do
+          users = client.users
+          users.length.should == 3
+        end
+      end
+
+      it 'returns an empty list of users once you page past the end' do
+        VCR.use_cassette('list_users_with_pagination') do
+          users = client.users(:page => 2)
+          users.length.should == 0
+        end
+      end
+    end
+
+    context 'showing a user' do
+      it 'returns a Hash with user info' do
+        VCR.use_cassette('show_user') do
+          user = client.user('5230b8c82ed960ba2000001d')
+          user['id'].should == '5230b8c82ed960ba2000001d'
+          user['access_token'].should == '0381294b7ef41db44fba20aad86a52d294b9fae67a26e85139d323eb78106706'
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,26 @@
+require 'bundler/setup'
+require 'rspec'
+require 'vcr'
+require 'awesome_print'
+require 'swiftype'
+
+RSpec.configure do |config|
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = "random"
+
+  VCR.configure do |c|
+    c.cassette_library_dir = 'spec/fixtures/vcr'
+    c.hook_into :webmock
+  end
+
+  config.before :each do
+    Swiftype.endpoint = "http://localhost:3000/api/v1/"
+  end
+
+  config.after :each do
+    Swiftype.reset
+  end
+end

data/spec/ssl_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+# These tests use real network connections to test the SSL
+# support. Since a real API key is not used, the success condition is
+# that the connection was made and the approriate error message is
+# returned from the API
+describe 'SSL support' do
+  let(:client) { Swiftype::Client.new }
+
+  context 'when the endpoint is configured to use SSL' do
+    it 'connects successfully' do
+      Swiftype.endpoint = 'https://api.swiftype.com/api/v1/'
+
+      VCR.turned_off do
+        WebMock.allow_net_connect!
+        expect do
+          client.search('swiftype-api-example', 'test')
+        end.to raise_error(Swiftype::InvalidCredentials)
+      end
+    end
+  end
+
+  context 'when the endpoint is configured not to use SSL' do
+    it 'connects successfully' do
+      Swiftype.endpoint = 'http://api.swiftype.com/api/v1/'
+      VCR.turned_off do
+        WebMock.allow_net_connect!
+        expect do
+          client.search('swiftype-api-example', 'test')
+        end.to raise_error(Swiftype::InvalidCredentials)
+      end
+    end
+  end
+end

data/spec/sso_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe Swiftype::SSO do
+  let(:user_id) { '5064a7de2ed960e715000276' }
+  let(:timestamp) { 1379382520 }
+  before :each do
+    Swiftype.platform_client_id = '3e4fd842fc99aecb4dc50e5b88a186c1e206ddd516cdd336da3622c4afd7e2e9'
+    Swiftype.platform_client_secret = '4441879b5e2a9c3271f5b1a4bc223b715f091e5ed20fe75d1352e1290c7a6dfb'
+
+    Time.any_instance.stub(:to_i).and_return(timestamp)
+  end
+
+  context '.token' do
+    it 'generates an SSO token' do
+      Swiftype::SSO.token(user_id, timestamp).should == '81033d182ad51f231cc9cda9fb24f2298a411437'
+    end
+  end
+
+  context '.url' do
+    it 'generates an SSO URL' do
+      Swiftype::SSO.url(user_id).should == 'https://swiftype.com/sso?user_id=5064a7de2ed960e715000276&client_id=3e4fd842fc99aecb4dc50e5b88a186c1e206ddd516cdd336da3622c4afd7e2e9&timestamp=1379382520&token=81033d182ad51f231cc9cda9fb24f2298a411437'
+    end
+  end
+end