looker-sdk 0.0.7 → 0.1.2

data/lib/looker-sdk/client.rb

@@ -58,7 +58,9 @@ module LookerSDK
       @original_options = options.dup
 
       load_credentials_from_netrc unless application_credentials?
-      load_swagger
+      if !@lazy_swagger
+        load_swagger
+      end
       self.dynamic = true
     end
 
@@ -89,11 +91,12 @@ module LookerSDK
     #
     # @param url [String] The path, relative to {#api_endpoint}
     # @param options [Hash] Query and header params for request
+    # @param encoded [Boolean] true: url already encoded, false: url needs encoding
     # @param &block [Block] Block to be called with |response, chunk| for each chunk of the body from
     #   the server. The block must return true to continue, or false to abort streaming.
     # @return [Sawyer::Resource]
-    def get(url, options = {}, &block)
-      request :get, url, nil, parse_query_and_convenience_headers(options), &block
+    def get(url, options = {}, encoded=false, &block)
+      request :get, url, nil, parse_query_and_convenience_headers(options), encoded, &block
     end
 
     # Make a HTTP POST request
@@ -101,11 +104,12 @@ module LookerSDK
     # @param url [String] The path, relative to {#api_endpoint}
     # @param data [String|Array|Hash] Body and optionally header params for request
     # @param options [Hash] Optional header params for request
+    # @param encoded [Boolean] true: url already encoded, false: url needs encoding
     # @param &block [Block] Block to be called with |response, chunk| for each chunk of the body from
     #   the server. The block must return true to continue, or false to abort streaming.
     # @return [Sawyer::Resource]
-    def post(url, data = {}, options = {}, &block)
-      request :post, url, data, parse_query_and_convenience_headers(options), &block
+    def post(url, data = {}, options = {}, encoded=false, &block)
+      request :post, url, data, parse_query_and_convenience_headers(options), encoded, &block
     end
 
     # Make a HTTP PUT request
@@ -113,11 +117,12 @@ module LookerSDK
     # @param url [String] The path, relative to {#api_endpoint}
     # @param data [String|Array|Hash] Body and optionally header params for request
     # @param options [Hash] Optional header params for request
+    # @param encoded [Boolean] true: url already encoded, false: url needs encoding
     # @param &block [Block] Block to be called with |response, chunk| for each chunk of the body from
     #   the server. The block must return true to continue, or false to abort streaming.
     # @return [Sawyer::Resource]
-    def put(url, data = {}, options = {}, &block)
-      request :put, url, data, parse_query_and_convenience_headers(options), &block
+    def put(url, data = {}, options = {}, encoded=false, &block)
+      request :put, url, data, parse_query_and_convenience_headers(options), encoded, &block
     end
 
     # Make a HTTP PATCH request
@@ -125,29 +130,32 @@ module LookerSDK
     # @param url [String] The path, relative to {#api_endpoint}
     # @param data [String|Array|Hash] Body and optionally header params for request
     # @param options [Hash] Optional header params for request
+    # @param encoded [Boolean] true: url already encoded, false: url needs encoding
     # @param &block [Block] Block to be called with |response, chunk| for each chunk of the body from
     #   the server. The block must return true to continue, or false to abort streaming.
     # @return [Sawyer::Resource]
-    def patch(url, data = {}, options = {}, &block)
-      request :patch, url, data, parse_query_and_convenience_headers(options), &block
+    def patch(url, data = {}, options = {}, encoded=false, &block)
+      request :patch, url, data, parse_query_and_convenience_headers(options), encoded, &block
     end
 
     # Make a HTTP DELETE request
     #
     # @param url [String] The path, relative to {#api_endpoint}
     # @param options [Hash] Query and header params for request
+    # @param encoded [Boolean] true: url already encoded, false: url needs encoding
     # @return [Sawyer::Resource]
-    def delete(url, options = {}, &block)
-      request :delete, url, nil, parse_query_and_convenience_headers(options)
+    def delete(url, options = {}, encoded=false, &block)
+      request :delete, url, nil, parse_query_and_convenience_headers(options), encoded, &block
     end
 
     # Make a HTTP HEAD request
     #
     # @param url [String] The path, relative to {#api_endpoint}
     # @param options [Hash] Query and header params for request
+    # @param encoded [Boolean] true: url already encoded, false: url needs encoding
     # @return [Sawyer::Resource]
-    def head(url, options = {}, &block)
-      request :head, url, nil, parse_query_and_convenience_headers(options)
+    def head(url, options = {}, encoded=false, &block)
+      request :head, url, nil, parse_query_and_convenience_headers(options), encoded
     end
 
     # Make one or more HTTP GET requests, optionally fetching
@@ -192,7 +200,7 @@ module LookerSDK
       Sawyer::Agent.new(api_endpoint, options) do |http|
         http.headers[:accept] = default_media_type
         http.headers[:user_agent] = user_agent
-        http.authorization('token', @access_token) if token_authenticated?
+        http.headers[:authorization] = "token #{@access_token}" if token_authenticated?
       end
     end
 
@@ -296,12 +304,16 @@ module LookerSDK
       @agent = nil
     end
 
-    def request(method, path, data, options, &block)
+    def request(method, path, data, options, encoded, &block)
       ensure_logged_in
       begin
+        path = path.to_s
+        if !encoded
+          path = URI::Parser.new.escape(path)
+        end
         @last_response = @last_error = nil
         return stream_request(method, path, data, options, &block) if block_given?
-        @last_response = response = agent.call(method, URI::Parser.new.escape(path.to_s), data, options)
+        @last_response = response = agent.call(method, path, data, options)
         @raw_responses ? response : response.data
       rescue StandardError => e
         @last_error = e

data/lib/looker-sdk/configurable.rb

@@ -66,7 +66,8 @@ module LookerSDK
     attr_accessor :access_token, :auto_paginate, :client_id,
                   :client_secret, :default_media_type, :connection_options,
                   :middleware, :netrc, :netrc_file,
-                  :per_page, :proxy, :user_agent, :faraday, :swagger, :shared_swagger, :raw_responses
+                  :per_page, :proxy, :user_agent, :faraday, :swagger, :shared_swagger, :raw_responses,
+                  :lazy_swagger
     attr_writer :web_endpoint, :api_endpoint
 
     class << self
@@ -92,7 +93,8 @@ module LookerSDK
           :shared_swagger,
           :swagger,
           :raw_responses,
-          :web_endpoint
+          :web_endpoint,
+          :lazy_swagger,
         ]
       end
     end

data/lib/looker-sdk/default.rb

@@ -125,6 +125,12 @@ module LookerSDK
         false
       end
 
+      # Default behavior for loading swagger during initialization or at first call
+      # @return [Boolean]
+      def lazy_swagger
+        false
+      end
+
       def raw_responses
         false
       end

data/lib/looker-sdk/response/raise_error.rb

@@ -30,9 +30,7 @@ module LookerSDK
   module Response
 
     # HTTP status codes returned by the API
-    class RaiseError < Faraday::Response::Middleware
-
-      private
+    class RaiseError < Faraday::Middleware
 
       def on_complete(response)
         if error = LookerSDK::Error.from_response(response)

data/lib/looker-sdk/version.rb

@@ -26,6 +26,6 @@ module LookerSDK
 
   # Current version
   # @return [String]
-  VERSION = "0.0.7"
+  VERSION = "0.1.2"
 
 end

data/lib/looker-sdk.rb

@@ -43,7 +43,6 @@ require 'faraday/rack_builder'
 require 'faraday/request'
 require 'faraday/request/authorization'
 require 'faraday/response'
-require 'faraday/upload_io'
 require 'faraday/utils'
 
 #require 'rack'

data/looker-sdk.gemspec

@@ -7,15 +7,15 @@ Gem::Specification.new do |s|
   s.version     = LookerSDK::VERSION
   s.date        = "#{Time.now.strftime('%F')}"
   s.authors     = ['Looker']
-  s.email       = 'opensource+sdkruby@looker.com'
-  s.homepage    = 'https://github.com/looker/looker-sdk-ruby'
+  s.email       = 'drstrangelove@google.com'
+  s.homepage    = 'https://github.com/looker-open-source/looker-sdk-ruby'
   s.summary     = %q{Looker Ruby SDK}
   s.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.'
   s.license     = 'MIT'
-  s.required_ruby_version = '>= 2.0'
+  s.required_ruby_version = '>= 2.5'
   s.requirements = 'Looker version 4.0 or later'  # informational
 
   s.files         = `git ls-files`.split("\n")
@@ -24,5 +24,5 @@ Gem::Specification.new do |s|
   s.require_paths = %w(lib)
   s.add_dependency 'jruby-openssl' if s.platform == :jruby
   s.add_dependency 'sawyer', '~> 0.8'
-  s.add_dependency 'faraday', ['>= 0.9.0', '< 1.0']
+  s.add_dependency 'faraday', ['>= 1.2', '< 2.0']
 end

data/readme.md

@@ -1,4 +1,5 @@
-# [Looker](http://looker.com/) SDK for Ruby [![Build Status](https://travis-ci.org/looker/looker-sdk-ruby.svg)](https://travis-ci.org/looker/looker-sdk-ruby)
+[![Ruby-CI](https://github.com/looker-open-source/looker-sdk-ruby/actions/workflows/ruby-ci.yml/badge.svg?branch=main)](https://github.com/looker-open-source/looker-sdk-ruby/actions/workflows/ruby-ci.yml)
+# [Looker](http://looker.com/) SDK for Ruby
 ### Overview
 This SDK supports secure/authenticated access to the Looker RESTful API. The SDK binds dynamically to the Looker API and builds mappings for the sets of API methods that the Looker instance exposes. This allows for writing straightforward Ruby scripts to interact with the Looker API. And, it allows the SDK to provide access to new Looker API features in each Looker release without requiring an update to the SDK each time.
 
@@ -14,7 +15,7 @@ When trying to access a resource with the API that the current user is not allow
 
 ### Installation
 ```bash
-$ git clone git@github.com:looker/looker-sdk-ruby.git looker-sdk
+$ git clone git@github.com:looker-open-source/looker-sdk-ruby.git looker-sdk
 $ cd looker-sdk
 $ gem install bundle
 $ bundle install
@@ -23,10 +24,13 @@ $ rake install
 
 ### Development
 
+Rename test/fixtures/.netrc.template to test/fixtures/.netrc and add API3
+credentials for tests to pass.
+Comment out coverage configuration in test/helper.rb for debugging.
 ```bash
 $ bundle install
 $ rake test # run the test suite
-$ rake test:all # run the test suite on all supported Rubies
+$ make install test # run the test suite on all supported Rubies
 ```
 
 ### Basic Usage
@@ -39,7 +43,7 @@ require 'looker-sdk'
 sdk = LookerSDK::Client.new(
   :client_id => "4CN7jzm7yrkcy2MC4CCG",
   :client_secret => "Js3rZZ7vHfbc2hBynSj7zqKh",
-  :api_endpoint => "https://mygreatcompany.looker.com:19999/api/3.0"
+  :api_endpoint => "https://mygreatcompany.looker.com:19999/api/4.0"
 )
 
 # If you don't want to provide explicit credentials: (trust me you don't)
@@ -53,7 +57,7 @@ sdk = LookerSDK::Client.new(
 sdk = LookerSDK::Client.new(
   :netrc      => true,
   :netrc_file => "~/.net_rc",
-  :api_endpoint => "https://mygreatcompany.looker.com:19999/api/3.0",
+  :api_endpoint => "https://mygreatcompany.looker.com:19999/api/4.0",
 
   # Set longer timeout to allow for long running queries. The default is 60 seconds and can be problematic.
   :connection_options => {:request => {:timeout => 60 * 60, :open_timeout => 30}},

data/shell/Gemfile

@@ -2,5 +2,5 @@ source 'https://rubygems.org'
 
 gem 'pry', '~> 0.10.1'
 gem 'netrc', '~> 0.7.7'
-# gem 'looker-sdk',  :git => 'git@github.com:looker/looker-sdk-ruby.git'
+# gem 'looker-sdk',  :git => 'git@github.com:looker-open-source/looker-sdk-ruby.git'
 gem 'looker-sdk',  :path => '../'

data/test/helper.rb

@@ -52,19 +52,45 @@ def fix_netrc_permissions(path)
   File.chmod(0600, path) unless s.mode.to_s(8)[3..5] == "0600"
 end
 
-fix_netrc_permissions(File.join(fixture_path, '.netrc'))
+begin
+  fix_netrc_permissions(File.join(fixture_path, '.netrc'))
+rescue => e
+  puts e
+end
 
 def setup_sdk
   LookerSDK.reset!
+
+  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']
+
   LookerSDK.configure do |c|
-    c.connection_options = {:ssl => {:verify => false}}
-    c.netrc = true
-    c.netrc_file =  File.join(fixture_path, '.netrc')
+    c.lazy_swagger = true
+    c.connection_options = {:ssl => {:verify => false}} unless verify_ssl
+    if (client_id && client_secret) then
+      c.client_id = client_id
+      c.client_secret = client_secret
+      c.api_endpoint = "#{base_url}/api/#{api_version}"
+    else
+      c.netrc = true
+      c.netrc_file =  File.join(fixture_path, '.netrc')
+    end
   end
 end
 
 def teardown_sdk
+  setup_sdk  # put back initial config
   LookerSDK.logout
 end
-
-

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

@@ -30,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
@@ -50,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
@@ -63,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
 
@@ -110,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
@@ -122,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
@@ -232,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

@@ -36,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
@@ -92,41 +93,30 @@ class LookerDynamicClientTest < MiniTest::Spec
 
   describe "swagger" do
 
-    it "warns when swagger.json can't be loaded" do
-      sdk = sdk_client(nil, nil)
-
-      obj = OpenStruct.new({status: 200, data: {key: "my data"}})
-      sdk.stubs(:last_response).returns(obj)
-      sdk.stubs(:looker_warn).once
-
-      sdk.load_swagger
+    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 "no warning when swagger.json can be loaded with authentication" do
-      sdk = sdk_client(nil, nil)
-
-      # first call to try_load_swagger fails, returning nil
-      # second call succeeds
-      sdk.stubs(:try_load_swagger).returns(nil, {key: "my data"})
-      sdk.stubs(:looker_warn).never
-
-      sdk.load_swagger
+    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 "no warning when swagger.json can be loaded without authentication" do
-      sdk = sdk_client(nil, nil)
-
-      # first call to try_load_swagger fails, returning nil
-      # second call succeeds
-      sdk.stubs(:try_load_swagger).returns({key: "my data"}, nil)
-      sdk.stubs(:looker_warn).never
-
-      sdk.load_swagger
+    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
@@ -136,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'})