looker-sdk 0.0.6 → 0.1.2

data/test/looker/swagger.json

@@ -5,7 +5,7 @@
     "title": "Looker API",
     "description": "This document is a representative sample (subset) of the Looker API that should only be used to unit test the Looker ruby sdk. To get the current, actual Looker API metadata visit /api/3.0/swagger.json on your Looker instance.",
     "contact": {
-      "name": "Looker Team <support@looker.com>"
+      "name": "Looker Team <https://help.looker.com>"
     },
     "license": {
       "name": "EULA",

data/test/looker/test_client.rb

@@ -1,3 +1,27 @@
+############################################################################################
+# The MIT License (MIT)
+#
+# Copyright (c) 2018 Looker Data Sciences, Inc.
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+############################################################################################
+
 require_relative '../helper'
 
 describe LookerSDK::Client do
@@ -6,8 +30,52 @@ describe LookerSDK::Client do
    setup_sdk
   end
 
-  after(:each) do
-   teardown_sdk
+  base_url = ENV['LOOKERSDK_BASE_URL'] || 'https://localhost:20000'
+  verify_ssl = case ENV['LOOKERSDK_VERIFY_SSL']
+               when /false/i
+                 false
+               when /f/i
+                 false
+               when '0'
+                 false
+               else
+                 true
+               end
+  api_version = ENV['LOOKERSDK_API_VERSION'] || '4.0'
+  client_id = ENV['LOOKERSDK_CLIENT_ID']
+  client_secret = ENV['LOOKERSDK_CLIENT_SECRET']
+
+  opts = {}
+  if (client_id && client_secret) then
+    opts.merge!({
+      :client_id => client_id,
+      :client_secret => client_secret,
+      :api_endpoint => "#{base_url}/api/#{api_version}",
+    })
+    opts[:connection_options] = {:ssl => {:verify => false}} unless verify_ssl
+  else
+    opts.merge!({
+      :netrc => true,
+      :netrc_file => File.join(fixture_path, '.netrc'),
+      :connection_options => {:ssl => {:verify => false}},
+    })
+
+  end
+
+  describe "lazy load swagger" do
+    it "lazy loads swagger" do
+      LookerSDK.reset!
+      client = LookerSDK::Client.new(opts.merge({:lazy_swagger => true}))
+      assert_nil client.swagger
+      client.me()
+      assert client.swagger
+    end
+
+    it "loads swagger initially" do
+      LookerSDK.reset!
+      client = LookerSDK::Client.new(opts.merge({:lazy_swagger => false}))
+      assert client.swagger
+    end
   end
 
   describe "module configuration" do
@@ -26,8 +94,9 @@ describe LookerSDK::Client do
     end
 
     it "inherits the module configuration" do
-      client = LookerSDK::Client.new
+      client = LookerSDK::Client.new(:lazy_swagger => true)
       LookerSDK::Configurable.keys.each do |key|
+        next if key == :lazy_swagger
         client.instance_variable_get(:"@#{key}").must_equal("Some #{key}")
       end
     end
@@ -39,7 +108,8 @@ describe LookerSDK::Client do
             :connection_options => {:ssl => {:verify => false}},
             :per_page => 40,
             :client_id    => "looker_client_id",
-            :client_secret => "client_secret2"
+            :client_secret => "client_secret2",
+            :lazy_swagger => true,
         }
       end
 
@@ -86,8 +156,13 @@ describe LookerSDK::Client do
 
       describe "with .netrc"  do
         it "can read .netrc files" do
+          skip unless File.exist?(File.join(fixture_path, '.netrc'))
           LookerSDK.reset!
-          client = LookerSDK::Client.new(:netrc => true, :netrc_file => File.join(fixture_path, '.netrc'))
+          client = LookerSDK::Client.new(
+            :lazy_swagger => true,
+            :netrc => true,
+            :netrc_file => File.join(fixture_path, '.netrc'),
+          )
           client.client_id.wont_be_nil
           client.client_secret.wont_be_nil
         end
@@ -98,6 +173,9 @@ describe LookerSDK::Client do
 
       before do
         LookerSDK.reset!
+        LookerSDK.configure do |c|
+          c.lazy_swagger = true
+        end
       end
 
       it "sets oauth token with .configure" do
@@ -208,6 +286,40 @@ describe LookerSDK::Client do
       end
     end
 
+    [
+        [:get, '/api/3.0/users/foo%2Fbar', false],
+        [:get, '/api/3.0/users/foo%252Fbar', true],
+        [:post, '/api/3.0/users/foo%2Fbar', false],
+        [:post, '/api/3.0/users/foo%252Fbar', true],
+        [:put, '/api/3.0/users/foo%2Fbar', false],
+        [:put, '/api/3.0/users/foo%252Fbar', true],
+        [:patch, '/api/3.0/users/foo%2Fbar', false],
+        [:patch, '/api/3.0/users/foo%252Fbar', true],
+        [:delete, '/api/3.0/users/foo%2Fbar', false],
+        [:delete, '/api/3.0/users/foo%252Fbar', true],
+        [:head, '/api/3.0/users/foo%2Fbar', false],
+        [:head, '/api/3.0/users/foo%252Fbar', true],
+    ].each do |method, path, encoded|
+      it "handles request path encoding" do
+        expected_path = '/api/3.0/users/foo%252Fbar'
+
+        resp = OpenStruct.new(:data => "hi", :status => 204)
+        mock = MiniTest::Mock.new.expect(:call, resp, [method, expected_path, nil, {}])
+        Sawyer::Agent.stubs(:new).returns(mock, mock)
+
+        sdk = LookerSDK::Client.new
+        if [:get, :delete, :head].include? method
+          args = [method, path, nil, encoded]
+        else
+          args = [method, path, nil, nil, encoded]
+        end
+        sdk.without_authentication do
+          value = sdk.public_send *args
+          assert_equal "hi", value
+        end
+        mock.verify
+      end
+    end
   end
 
   describe 'Sawyer date/time parsing patch' do

data/test/looker/test_dynamic_client.rb

@@ -1,3 +1,27 @@
+############################################################################################
+# The MIT License (MIT)
+#
+# Copyright (c) 2018 Looker Data Sciences, Inc.
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+############################################################################################
+
 require_relative '../helper'
 
 class LookerDynamicClientTest < MiniTest::Spec
@@ -12,6 +36,7 @@ class LookerDynamicClientTest < MiniTest::Spec
       conn.adapter :rack, engine
     end
 
+    LookerSDK.reset!
     LookerSDK::Client.new do |config|
       config.swagger = swagger
       config.access_token = access_token
@@ -68,9 +93,30 @@ class LookerDynamicClientTest < MiniTest::Spec
 
   describe "swagger" do
 
+    it "raises when swagger.json can't be loaded" do
+      mock = MiniTest::Mock.new.expect(:call, nil) {raise "no swagger for you"}
+      mock.expect(:call, nil) {raise "still no swagger for you"}
+      err = assert_raises(RuntimeError) { sdk_client(nil, mock) }
+      assert_equal "still no swagger for you", err.message
+    end
+
+    it "loads swagger without authentication" do
+      resp = [200, {'Content-Type' => 'application/json'}, [default_swagger.to_json]]
+      mock = MiniTest::Mock.new.expect(:call, resp, [Hash])
+      sdk = sdk_client(nil, mock)
+      assert_equal default_swagger, sdk.swagger
+    end
+
+    it "loads swagger with authentication" do
+      resp = [200, {'Content-Type' => 'application/json'}, [default_swagger.to_json]]
+      mock = MiniTest::Mock.new.expect(:call, nil) {raise "login first!"}
+      mock.expect(:call, resp, [Hash])
+      sdk = sdk_client(nil, mock)
+      assert_equal default_swagger, sdk.swagger
+    end
+
     it "invalid method name" do
-      mock = MiniTest::Mock.new.expect(:call, response){|env| confirm_env(env, method, path, body, query, content_type)}
-      sdk = sdk_client(default_swagger, mock)
+      sdk = sdk_client(default_swagger, nil)
       assert_raises NoMethodError do
         sdk.this_method_name_doesnt_exist()
       end
@@ -80,18 +126,44 @@ class LookerDynamicClientTest < MiniTest::Spec
       end
     end
 
+    describe "operation maps" do
+      it "invoke by string operationId" do
+        verify(response, :get, '/api/3.0/user') do |sdk|
+          sdk.invoke('me')
+        end
+      end
+
+      it "invoke by symbol operationId" do
+        verify(response, :get, '/api/3.0/user') do |sdk|
+          sdk.invoke(:me)
+        end
+      end
+    end
+
     it "get no params" do
       verify(response, :get, '/api/3.0/user') do |sdk|
         sdk.me
       end
     end
 
-    it "get with parms" do
+    it "get with params" do
       verify(response, :get, '/api/3.0/users/25') do |sdk|
         sdk.user(25)
       end
     end
 
+    it "get with params that need encoding" do
+      verify(response, :get, '/api/3.0/users/foo%2Fbar') do |sdk|
+        sdk.user("foo/bar")
+      end
+    end
+
+    it "get with params already encoded" do
+        verify(response, :get, '/api/3.0/users/foo%2Fbar') do |sdk|
+        sdk.user("foo%2Fbar")
+      end
+    end
+
     it "get with query" do
       verify(response, :get, '/api/3.0/user', '', {bar:"foo"}) do |sdk|
         sdk.me({bar:'foo'})

data/test/looker/test_dynamic_client_agent.rb

@@ -1,3 +1,27 @@
+############################################################################################
+# The MIT License (MIT)
+#
+# Copyright (c) 2018 Looker Data Sciences, Inc.
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+############################################################################################
+
 require_relative '../helper'
 
 describe LookerSDK::Client::Dynamic do

metadata

@@ -1,70 +1,76 @@
 --- !ruby/object:Gem::Specification
 name: looker-sdk
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.1.2
 platform: ruby
 authors:
 - Looker
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-31 00:00:00.000000000 Z
+date: 2021-11-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
+  name: sawyer
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.8'
-  name: sawyer
-  prerelease: false
   type: :runtime
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.8'
 - !ruby/object:Gem::Dependency
+  name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: '1.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '1.0'
-  name: faraday
-  prerelease: false
+        version: '2.0'
   type: :runtime
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: '1.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.0'
 description: Use this SDK to access the Looker API. The Looker API provides functions
   to perform administrative tasks such as provisioning users, configuring database
   connections, and so on. It also enables you to leverage the Looker data analytics
   engine to fetch data or render visualizations defined in your Looker data models.
   For more information, see https://looker.com.
-email: opensource+sdkruby@looker.com
+email: drstrangelove@google.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/scripts/wait_for_looker.sh"
+- ".github/workflows/release.yml"
+- ".github/workflows/ruby-ci.yml"
 - ".gitignore"
 - ".ruby-gemset"
-- ".travis.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
 - Gemfile
-- LICENSE
+- LICENSE.md
+- Makefile
 - Rakefile
 - authentication.md
 - examples/.netrc
 - examples/add_delete_users.rb
 - examples/change_credentials_email_address_for_users.rb
+- examples/convert_look_to_lookless_tile.rb
 - examples/create_credentials_email_for_users.rb
 - examples/delete_all_user_sessions.rb
 - examples/delete_credentials_google_for_users.rb
@@ -98,18 +104,18 @@ files:
 - shell/readme.md
 - shell/shell.rb
 - streaming.md
-- test/fixtures/.netrc
+- test/fixtures/.netrc.template
 - test/helper.rb
 - test/looker/swagger.json
 - test/looker/test_client.rb
 - test/looker/test_dynamic_client.rb
 - test/looker/test_dynamic_client_agent.rb
 - test/looker/user.json
-homepage: https://github.com/looker/looker-sdk-ruby
+homepage: https://github.com/looker-open-source/looker-sdk-ruby
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -117,7 +123,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.3
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -125,9 +131,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements:
 - Looker version 4.0 or later
-rubyforge_project:
-rubygems_version: 2.6.13
-signing_key:
+rubyforge_project: 
+rubygems_version: 2.7.6.2
+signing_key: 
 specification_version: 4
 summary: Looker Ruby SDK
 test_files: []

data/.travis.yml

@@ -1,16 +0,0 @@
-language: ruby
-rvm:
-  - 1.9.3
-  - 2.0
-  - 2.1
-  - 2.3.1
-  - jruby-1.7.27
-  - jruby-9.1.5.0
-cache:
-  bundler: true
-matrix:
-  fast_finish: true
-  allow_failures:
-    - rvm: ruby-head
-    - rvm: jruby-head
-    - rvm: ree

data/LICENSE

@@ -1,21 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) 2015 Looker Data Sciences, Inc.
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.