looker-sdk 0.0.5

data/test/looker/test_client.rb

@@ -0,0 +1,258 @@
+require_relative '../helper'
+
+describe LookerSDK::Client do
+
+  before(:each) do
+   setup_sdk
+  end
+
+  after(:each) do
+   teardown_sdk
+  end
+
+  describe "module configuration" do
+
+    before do
+      LookerSDK.reset!
+      LookerSDK.configure do |config|
+        LookerSDK::Configurable.keys.each do |key|
+          config.send("#{key}=", "Some #{key}")
+        end
+      end
+    end
+
+    after do
+      LookerSDK.reset!
+    end
+
+    it "inherits the module configuration" do
+      client = LookerSDK::Client.new
+      LookerSDK::Configurable.keys.each do |key|
+        client.instance_variable_get(:"@#{key}").must_equal("Some #{key}")
+      end
+    end
+
+    describe "with class level configuration" do
+
+      before do
+        @opts = {
+            :connection_options => {:ssl => {:verify => false}},
+            :per_page => 40,
+            :client_id    => "looker_client_id",
+            :client_secret => "client_secret2"
+        }
+      end
+
+      it "overrides module configuration" do
+        client = LookerSDK::Client.new(@opts)
+        client.per_page.must_equal(40)
+        client.client_id.must_equal("looker_client_id")
+        client.instance_variable_get(:"@client_secret").must_equal("client_secret2")
+        client.auto_paginate.must_equal(LookerSDK.auto_paginate)
+        client.client_id.wont_equal(LookerSDK.client_id)
+      end
+
+      it "can set configuration after initialization" do
+        client = LookerSDK::Client.new
+        client.configure do |config|
+          @opts.each do |key, value|
+            config.send("#{key}=", value)
+          end
+        end
+        client.per_page.must_equal(40)
+        client.client_id.must_equal("looker_client_id")
+        client.instance_variable_get(:"@client_secret").must_equal("client_secret2")
+        client.auto_paginate.must_equal(LookerSDK.auto_paginate)
+        client.client_id.wont_equal(LookerSDK.client_id)
+      end
+
+      it "masks client_secrets on inspect" do
+        client = LookerSDK::Client.new(@opts)
+        inspected = client.inspect
+        inspected.wont_include("client_secret2")
+      end
+
+      it "masks tokens on inspect" do
+        client = LookerSDK::Client.new(:access_token => '87614b09dd141c22800f96f11737ade5226d7ba8')
+        inspected = client.inspect
+        inspected.wont_equal("87614b09dd141c22800f96f11737ade5226d7ba8")
+      end
+
+      it "masks client secrets on inspect" do
+        client = LookerSDK::Client.new(:client_secret => '87614b09dd141c22800f96f11737ade5226d7ba8')
+        inspected = client.inspect
+        inspected.wont_equal("87614b09dd141c22800f96f11737ade5226d7ba8")
+      end
+
+      describe "with .netrc"  do
+        it "can read .netrc files" do
+          LookerSDK.reset!
+          client = LookerSDK::Client.new(:netrc => true, :netrc_file => File.join(fixture_path, '.netrc'))
+          client.client_id.wont_be_nil
+          client.client_secret.wont_be_nil
+        end
+      end
+    end
+
+    describe "config tests" do
+
+      before do
+        LookerSDK.reset!
+      end
+
+      it "sets oauth token with .configure" do
+        client = LookerSDK::Client.new
+        client.configure do |config|
+          config.access_token = 'd255197b4937b385eb63d1f4677e3ffee61fbaea'
+        end
+        client.application_credentials?.must_equal false
+        client.token_authenticated?.must_equal true
+      end
+
+      it "sets oauth token with initializer block" do
+        client = LookerSDK::Client.new do |config|
+          config.access_token = 'd255197b4937b385eb63d1f4677e3ffee61fbaea'
+        end
+        client.application_credentials?.must_equal false
+        client.token_authenticated?.must_equal true
+      end
+
+      it "sets oauth token with instance methods" do
+        client = LookerSDK::Client.new
+        client.access_token = 'd255197b4937b385eb63d1f4677e3ffee61fbaea'
+        client.application_credentials?.must_equal false
+        client.token_authenticated?.must_equal true
+      end
+
+      it "sets oauth application creds with .configure" do
+        client = LookerSDK::Client.new
+        client.configure do |config|
+          config.client_id     = '97b4937b385eb63d1f46'
+          config.client_secret = 'd255197b4937b385eb63d1f4677e3ffee61fbaea'
+        end
+        client.application_credentials?.must_equal true
+        client.token_authenticated?.must_equal false
+      end
+
+      it "sets oauth application creds with initializer block" do
+        client = LookerSDK::Client.new do |config|
+          config.client_id     = '97b4937b385eb63d1f46'
+          config.client_secret = 'd255197b4937b385eb63d1f4677e3ffee61fbaea'
+        end
+        client.application_credentials?.must_equal true
+        client.token_authenticated?.must_equal false
+      end
+
+      it "sets oauth token with module methods" do
+        client = LookerSDK::Client.new
+        client.client_id     = '97b4937b385eb63d1f46'
+        client.client_secret = 'd255197b4937b385eb63d1f4677e3ffee61fbaea'
+        client.application_credentials?.must_equal true
+        client.token_authenticated?.must_equal false
+      end
+    end
+
+  end
+
+  describe "request options" do
+
+    it "parse_query_and_convenience_headers must handle good input" do
+
+      [
+        # no need for empty query or headers
+        [{}, {}],
+        [{query: {}}, {}],
+        [{headers: {}}, {}],
+        [{query: {}, headers: {}}, {}],
+
+        # promote raw stuff into query
+        [{query:{foo:'bar'}}, {query:{foo:'bar'}}],
+        [{foo:'bar'}, {query:{foo:'bar'}}],
+        [{foo:'bar', one:1}, {query:{foo:'bar', one:1}}],
+
+        # promote CONVENIENCE_HEADERS into headers
+        [{accept: 'foo'}, {headers:{accept: 'foo'}}],
+        [{content_type: 'foo'}, {headers:{content_type: 'foo'}}],
+        [{accept: 'foo', content_type: 'bar'}, {headers:{accept: 'foo', content_type: 'bar'}}],
+
+        # merge CONVENIENCE_HEADERS into headers if headers not empty
+        [{accept: 'foo', headers:{content_type: 'bar'}}, {headers:{accept: 'foo', content_type: 'bar'}}],
+
+        # promote CONVENIENCE_HEADERS into headers while also handling query parts
+        [{accept: 'foo', content_type: 'bar', query:{foo:'bar'}}, {query:{foo:'bar'}, headers:{accept: 'foo', content_type: 'bar'}}],
+        [{accept: 'foo', content_type: 'bar', foo:'bar'}, {query:{foo:'bar'}, headers:{accept: 'foo', content_type: 'bar'}}],
+
+      ].each do |pair|
+        input_original, expected = pair
+        input = input_original.dup
+
+        output = LookerSDK::Client.new.send(:parse_query_and_convenience_headers, input)
+
+        input.must_equal input_original
+        output.must_equal expected
+      end
+
+      # don't make the code above handle the special case of nil input.
+      LookerSDK::Client.new.send(:parse_query_and_convenience_headers, nil).must_equal({})
+    end
+
+    it "parse_query_and_convenience_headers must detect bad input" do
+      [
+        1,
+        '',
+        [],
+        {query:1},
+        {query:[]},
+      ].each do |input|
+        proc { LookerSDK::Client.new.send(:parse_query_and_convenience_headers, input) }.must_raise RuntimeError
+      end
+    end
+
+  end
+
+  describe 'Sawyer date/time parsing patch' do
+    describe 'key matches time_field pattern' do
+      it 'does not modify non-iso date/time string' do
+        values = {
+            :test_at => '30 days',
+            :test_on => 'July 20, 1969',
+            :test_date => '1968-04-03 12:23:34',  # this is not iso8601 format!
+            :date => '2 months ago',
+        }
+
+        serializer = LookerSDK::Client.new.send(:serializer)
+        values.each {|k,v| serializer.decode_hash_value(k,v).must_equal v, k}
+      end
+
+      it 'converts iso date/time strings to Ruby date/time' do
+        iso_values = {
+            :test_at => '2017-02-07T13:21:50-08:00',
+            :test_on => '2017-02-07T00:00:00z',
+            :test_date => '1969-07-20T00:00:00-08:00',
+            :date => '1968-04-03T12:23:34z',
+        }
+        serializer = LookerSDK::Client.new.send(:serializer)
+        iso_values.each {|k,v| serializer.decode_hash_value(k,v).must_be_kind_of Time, k}
+      end
+    end
+
+    describe 'key does NOT match time_field pattern' do
+      it 'ignores time-like values' do
+        values = {
+            :testat => '30 days',
+            :teston => '2017-02-07T13:21:50-08:00',
+            :testdate => '1968-04-03T12:23:34z',
+            :range => '2 months ago for 1 month'
+        }
+
+        serializer = LookerSDK::Client.new.send(:serializer)
+        values.each {|k,v| serializer.decode_hash_value(k,v).must_equal v, k}
+      end
+    end
+  end
+
+  # TODO: Convert the old tests that were here to deal with swagger/dynamic way of doing things. Perhaps
+  # with a dedicated server that serves swagger customized to the test suite. Also, bring the auth tests
+  # to life here on the SDK client end.
+
+end

data/test/looker/test_dynamic_client.rb

@@ -0,0 +1,158 @@
+require_relative '../helper'
+
+describe LookerSDK::Client::Dynamic do
+
+  def access_token
+    '87614b09dd141c22800f96f11737ade5226d7ba8'
+  end
+
+  def sdk_client(swagger, engine)
+    faraday = Faraday.new do |conn|
+      conn.use LookerSDK::Response::RaiseError
+      conn.adapter :rack, engine
+    end
+
+    LookerSDK::Client.new do |config|
+      config.swagger = swagger
+      config.access_token = access_token
+      config.faraday = faraday
+    end
+  end
+
+  def default_swagger
+    @swagger ||= JSON.parse(File.read(File.join(File.dirname(__FILE__), 'swagger.json')), :symbolize_names => true)
+  end
+
+  def response
+    [200, {'Content-Type' => 'application/json'}, [{}.to_json]]
+  end
+
+  def delete_response
+    [204, {}, []]
+  end
+
+  def confirm_env(env, method, path, body, query, content_type)
+    req = Rack::Request.new(env)
+    req_body = req.body.gets || ''
+
+    req.base_url.must_equal 'https://localhost:19999'
+    req.request_method.must_equal method.to_s.upcase
+    req.path_info.must_equal path
+
+    env["HTTP_AUTHORIZATION"].must_equal  "token #{access_token}"
+
+    JSON.parse(req.params.to_json, :symbolize_names => true).must_equal query
+
+    begin
+      JSON.parse(req_body, :symbolize_names => true).must_equal body
+    rescue JSON::ParserError => e
+      req_body.must_equal body
+    end
+
+    req.content_type.must_equal(content_type) if content_type
+
+    # puts env
+    # puts req.inspect
+    # puts req.params.inspect
+    # puts req_body
+    # puts req.content_type
+
+    true
+  end
+
+  def verify(response, method, path, body='', query={}, content_type = nil)
+    mock = MiniTest::Mock.new.expect(:call, response){|env| confirm_env(env, method, path, body, query, content_type)}
+    yield sdk_client(default_swagger, mock)
+    mock.verify
+  end
+
+
+  describe "swagger" do
+
+    it "get" do
+      verify(response, :get, '/api/3.0/user') do |sdk|
+        sdk.me
+      end
+    end
+
+    it "get with parms" do
+      verify(response, :get, '/api/3.0/users/25') do |sdk|
+        sdk.user(25)
+      end
+    end
+
+    it "get with query" do
+      verify(response, :get, '/api/3.0/user', '', {bar:"foo"}) do |sdk|
+        sdk.me({bar:'foo'})
+      end
+    end
+
+    it "get with params and query" do
+      verify(response, :get, '/api/3.0/users/25', '', {bar:"foo"}) do |sdk|
+        sdk.user(25, {bar:'foo'})
+      end
+    end
+
+    it "post" do
+      verify(response, :post, '/api/3.0/users', {first_name:'Joe'}) do |sdk|
+        sdk.create_user({first_name:'Joe'})
+      end
+    end
+
+    it "post with default body" do
+      verify(response, :post, '/api/3.0/users', {}) do |sdk|
+        sdk.create_user()
+      end
+    end
+
+    it "post with default body and default content_type" do
+      verify(response, :post, '/api/3.0/users', {}, {}, "application/json") do |sdk|
+        sdk.create_user()
+      end
+    end
+
+    it "post with default body and specific content_type at option-level" do
+      verify(response, :post, '/api/3.0/users', {}, {}, "application/vnd.BOGUS1+json") do |sdk|
+        sdk.create_user({}, {:content_type => "application/vnd.BOGUS1+json"})
+      end
+    end
+
+    it "post with default body and specific content_type in headers" do
+      verify(response, :post, '/api/3.0/users', {}, {}, "application/vnd.BOGUS2+json") do |sdk|
+        sdk.create_user({}, {:headers => {:content_type => "application/vnd.BOGUS2+json"}})
+      end
+    end
+
+    it "post with file upload" do
+      verify(response, :post, '/api/3.0/users', {first_name:'Joe', last_name:'User'}, {}, "application/vnd.BOGUS3+json") do |sdk|
+        name = File.join(File.dirname(__FILE__), 'user.json')
+        sdk.create_user(Faraday::UploadIO.new(name, "application/vnd.BOGUS3+json"))
+      end
+    end
+
+    it "patch" do
+      verify(response, :patch, '/api/3.0/users/25', {first_name:'Jim'}) do |sdk|
+        sdk.update_user(25, {first_name:'Jim'})
+      end
+    end
+
+    it "patch with query" do
+      verify(response, :post, '/api/3.0/users', {first_name:'Jim'}, {foo:'bar', baz:'bla'}) do |sdk|
+        sdk.create_user({first_name:'Jim'}, {foo:'bar', baz:'bla'})
+      end
+    end
+
+    it "put" do
+      verify(response, :put, '/api/3.0/users/25/roles', [10, 20]) do |sdk|
+        sdk.set_user_roles(25, [10,20])
+      end
+    end
+
+    it "delete" do
+      verify(delete_response, :delete, '/api/3.0/users/25') do |sdk|
+        sdk.delete_user(25)
+      end
+    end
+
+  end
+end

data/test/looker/test_dynamic_client_agent.rb

@@ -0,0 +1,131 @@
+require_relative '../helper'
+
+describe LookerSDK::Client::Dynamic do
+
+  def access_token
+    '87614b09dd141c22800f96f11737ade5226d7ba8'
+  end
+
+  def sdk_client(swagger)
+    LookerSDK::Client.new do |config|
+      config.swagger = swagger
+      config.access_token = access_token
+    end
+  end
+
+  def default_swagger
+    @swagger ||= JSON.parse(File.read(File.join(File.dirname(__FILE__), 'swagger.json')), :symbolize_names => true)
+  end
+
+  def sdk
+    @sdk ||= sdk_client(default_swagger)
+  end
+
+  def with_stub(klass, method, result)
+    klass.stubs(method).returns(result)
+    begin
+      yield
+    ensure
+      klass.unstub(method)
+    end
+  end
+
+  def response
+    OpenStruct.new(:data => "foo", :status => 200)
+  end
+
+  def delete_response
+    OpenStruct.new(:data => "", :status => 204)
+  end
+
+  describe "swagger" do
+    it "get" do
+      mock = MiniTest::Mock.new.expect(:call, response, [:get, '/api/3.0/user', nil, {}])
+      with_stub(Sawyer::Agent, :new, mock) do
+        sdk.me
+        mock.verify
+      end
+    end
+
+    it "get with parms" do
+      mock = MiniTest::Mock.new.expect(:call, response, [:get, '/api/3.0/users/25', nil, {}])
+      with_stub(Sawyer::Agent, :new, mock) do
+        sdk.user(25)
+        mock.verify
+      end
+    end
+
+    it "get with query" do
+      mock = MiniTest::Mock.new.expect(:call, response, [:get, '/api/3.0/user', nil, {query:{bar:"foo"}}])
+      with_stub(Sawyer::Agent, :new, mock) do
+        sdk.me({bar:'foo'})
+        mock.verify
+      end
+    end
+
+    it "get with params and query" do
+      mock = MiniTest::Mock.new.expect(:call, response, [:get, '/api/3.0/users/25', nil, {query:{bar:"foo"}}])
+      with_stub(Sawyer::Agent, :new, mock) do
+        sdk.user(25, {bar:'foo'})
+        mock.verify
+      end
+    end
+
+    it "post" do
+      mock = MiniTest::Mock.new.expect(:call, response, [:post, '/api/3.0/users', {first_name:'Joe'}, {:headers=>{:content_type=>"application/json"}}])
+      with_stub(Sawyer::Agent, :new, mock) do
+        sdk.create_user({first_name:'Joe'})
+        mock.verify
+      end
+    end
+
+    it "post with default body" do
+      mock = MiniTest::Mock.new.expect(:call, response, [:post, '/api/3.0/users', {}, {:headers=>{:content_type=>"application/json"}}])
+      with_stub(Sawyer::Agent, :new, mock) do
+        sdk.create_user()
+        mock.verify
+      end
+    end
+
+    it "patch" do
+      mock = MiniTest::Mock.new.expect(:call, response, [:patch, '/api/3.0/users/25', {first_name:'Jim'}, {:headers=>{:content_type=>"application/json"}}])
+      with_stub(Sawyer::Agent, :new, mock) do
+        sdk.update_user(25, {first_name:'Jim'})
+        mock.verify
+      end
+    end
+
+    it "put" do
+      mock = MiniTest::Mock.new.expect(:call, response, [:put, '/api/3.0/users/25/roles', [10, 20], {:headers=>{:content_type=>"application/json"}}])
+      with_stub(Sawyer::Agent, :new, mock) do
+        sdk.set_user_roles(25, [10,20])
+        mock.verify
+      end
+    end
+
+    it "put with nil body" do
+      mock = MiniTest::Mock.new.expect(:call, response, [:put, '/api/3.0/users/25/roles', nil, {}])
+      with_stub(Sawyer::Agent, :new, mock) do
+        sdk.set_user_roles(25, nil)
+        mock.verify
+      end
+    end
+
+    it "put with empty body" do
+      mock = MiniTest::Mock.new.expect(:call, response, [:put, '/api/3.0/users/25/roles', {}, {:headers=>{:content_type=>"application/json"}}])
+      with_stub(Sawyer::Agent, :new, mock) do
+        sdk.set_user_roles(25, {})
+        mock.verify
+      end
+    end
+
+    it "delete" do
+      mock = MiniTest::Mock.new.expect(:call, delete_response, [:delete, '/api/3.0/users/25', nil, {}])
+      with_stub(Sawyer::Agent, :new, mock) do
+        sdk.delete_user(25)
+        mock.verify
+      end
+    end
+
+  end
+end