looker-sdk 0.1.10 → 0.1.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 962fdcc584f53a5888bda532f4c35d10f7e1e9afb36132c8f5b3befa6e658e40
-  data.tar.gz: 2aa006572f93e9da8f9c0a12a0bcdd41799561b99ccda67f22d2b791a47141ef
+  metadata.gz: bd7f1ae1fc17049a2495fbe59b5daa30922eeee81324c198a14bd6e39714e4d6
+  data.tar.gz: 000eec5248e5cdee93e02a780822460a7c7adf10ebee87c645379a97eb8e2cf3
 SHA512:
-  metadata.gz: 2e65b9e2fe9c4a262a7240cbcd661ee43df2be13cdefd192a0c8a269bbfd9b07e8bf3fb435e05299e7443297e19a2ec9bd9a9e4a758a3243f9b2c72cbd06da5f
-  data.tar.gz: 10c0aed18b69b6f59c919016ad26725506a4cfbc02048b112a19cf6ca99f795f9482900760559abf1a3374b6682c591ebeb0551bcec6b5230fbbf78499425727
+  metadata.gz: 5d11ee93d5ea36eae97c8a2fff92c5505a3b1df8c750609cef85d431ca744ca188adfe8a1d17850ada2d9ac8bdf31129daef06713f5080303327f7360d366089
+  data.tar.gz: af88d3c1185927d26624900e6ed9794b3091415038aeba1f92a65c8d51daff308b3cc17f297709bd644cbb28e36d34011eccac83fa3f9aa0b3197e6af713dec6

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Changelog
 
+## [0.1.11](https://github.com/looker-open-source/looker-sdk-ruby/compare/v0.1.10...v0.1.11) (2025-01-13)
+
+
+### Bug Fixes
+
+* add error handling for streaming client ([69b8064](https://github.com/looker-open-source/looker-sdk-ruby/commit/69b8064818161d273872eb658be16bb17ed6df56))
+* handle all variety of http response codes. ([6d75ee2](https://github.com/looker-open-source/looker-sdk-ruby/commit/6d75ee2c30521d48b4e68b910c75ff5fe9ff22e7))
+* raise TypeError on marshal_dump ([#100](https://github.com/looker-open-source/looker-sdk-ruby/issues/100)) ([9e486ff](https://github.com/looker-open-source/looker-sdk-ruby/commit/9e486ff413f1951e557a9816729007067bf8588f))
+* update rexml to 3.3.9 to eliminate ReDos vulnerability ([#102](https://github.com/looker-open-source/looker-sdk-ruby/issues/102)) ([42c5cd3](https://github.com/looker-open-source/looker-sdk-ruby/commit/42c5cd349231457fd7e75e541a0a208bae625c39))
+
 ## [0.1.10](https://github.com/looker-open-source/looker-sdk-ruby/compare/v0.1.7...v0.1.10) (2024-10-07)
 
 

data/lib/looker-sdk/client/dynamic.rb

@@ -22,6 +22,8 @@
 # THE SOFTWARE.
 ############################################################################################
 
+require 'ruby2_keywords'
+
 module LookerSDK
   class Client
 
@@ -97,12 +99,12 @@ module LookerSDK
       # Callers can explicitly 'invoke' remote methods or let 'method_missing' do the trick.
       # If nothing else, this gives clients a way to deal with potential conflicts between remote method
       # names and names of methods on client itself.
-      def invoke(method_name, *args, &block)
+      ruby2_keywords def invoke(method_name, *args, &block)
         entry = find_entry(method_name) || raise(NameError, "undefined remote method '#{method_name}'")
         invoke_remote(entry, method_name, *args, &block)
       end
 
-      def method_missing(method_name, *args, &block)
+      ruby2_keywords def method_missing(method_name, *args, &block)
         entry = find_entry(method_name) || (return super)
         invoke_remote(entry, method_name, *args, &block)
       end
@@ -117,7 +119,7 @@ module LookerSDK
         operations && operations[method_name.to_sym] if dynamic
       end
 
-      def invoke_remote(entry, method_name, *args, &block)
+      ruby2_keywords def invoke_remote(entry, method_name, *args, &block)
         args = (args || []).dup
         route = entry[:route].to_s.dup
         params = (entry[:info][:parameters] || []).select {|param| param[:in] == 'path'}

data/lib/looker-sdk/client.rb

@@ -1,7 +1,7 @@
 ############################################################################################
 # The MIT License (MIT)
 #
-# Copyright (c) 2022 Looker Data Sciences, Inc.
+# Copyright (c) 2024 Google, LLC
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal
@@ -29,6 +29,8 @@ require 'looker-sdk/configurable'
 require 'looker-sdk/authentication'
 require 'looker-sdk/rate_limit'
 require 'looker-sdk/client/dynamic'
+require 'looker-sdk/error'
+require 'ruby2_keywords'
 
 module LookerSDK
 
@@ -292,7 +294,7 @@ module LookerSDK
     # LOOKER_SILENT is set to true.
     #
     # @return [nil]
-    def looker_warn(*message)
+    ruby2_keywords def looker_warn(*message)
       unless ENV['LOOKER_SILENT']
         warn message
       end
@@ -396,8 +398,15 @@ module LookerSDK
           http.read_timeout = connection.options.timeout rescue 60
 
           http.request(http_request) do |response|
-            progress = Progress.new(response)
-            if response.code == "200"
+            case response.code.to_i
+            when 400..599 then 
+              error = LookerSDK::Error.from_response(response)
+              raise error
+            when 300..399 then
+              error = LookerSDK::Error.new("3xx response from streaming request")
+              raise error
+            when 200..299 then
+              progress = Progress.new(response)
               response.read_body do |chunk|
                 next unless chunk.length > 0
                 progress.add_chunk(chunk)

data/lib/looker-sdk/default.rb

@@ -31,7 +31,7 @@ module LookerSDK
   module Default
 
     # Default API endpoint look TODO update this as needed
-    API_ENDPOINT = "https://localhost:19999/api/3.0/".freeze
+    API_ENDPOINT = "https://localhost:19999/api/4.0/".freeze
 
     # Default User Agent header string
     USER_AGENT   = "Looker Ruby Gem #{LookerSDK::VERSION}".freeze

data/lib/looker-sdk/error.rb

@@ -1,7 +1,7 @@
 ############################################################################################
 # The MIT License (MIT)
 #
-# Copyright (c) 2022 Looker Data Sciences, Inc.
+# Copyright (c) 2024 Google, LLC
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal
@@ -76,6 +76,12 @@ module LookerSDK
       response_message
     end
 
+    # Looker SDK error objects (e.g. LookerSDK::BadRequest) raise a
+    # WebMock::NetConnectNotAllowedError if they are marshal dumped.
+    def marshal_dump
+      raise TypeError.new("Refusing to marshal")
+    end
+
     # Error Doc URL
     #
     # @return [String]

data/lib/looker-sdk/version.rb

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

data/lib/looker-sdk.rb

@@ -50,6 +50,7 @@ end
 
 #require 'rack'
 #require 'rack/mock_response'
+require 'ruby2_keywords'
 
 require 'looker-sdk/client'
 require 'looker-sdk/default'
@@ -74,7 +75,7 @@ module LookerSDK
 
   private
 
-    def method_missing(method_name, *args, &block)
+    ruby2_keywords def method_missing(method_name, *args, &block)
       return super unless client.respond_to?(method_name)
       client.send(method_name, *args, &block)
     end

data/test/looker/test_inline_query.rb

@@ -0,0 +1,97 @@
+############################################################################################
+# The MIT License (MIT)
+#
+# Copyright (c) 2024 Google LLC
+#
+# 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
+
+  before(:each) do
+   setup_sdk
+  end
+
+  base_url = ENV['LOOKERSDK_BASE_URL'] || 'https://localhost:19999'
+  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 "run inline query" do
+    it "blocking" do
+      LookerSDK.reset!
+      client = LookerSDK::Client.new(opts)
+      response = client.run_inline_query("csv",
+        {
+          "model": "system__activity",
+          "view": "history",
+          "fields": ["history.query_run_count", "query.model"],
+          "limit": 5000
+        }
+      )
+      assert response
+    end
+
+    it "streaming" do
+      LookerSDK.reset!
+      client = LookerSDK::Client.new(opts)
+      response = ""
+      client.run_inline_query("csv",
+        {
+          "model": "system__activity",
+          "view": "history",
+          "fields": ["history.query_run_count", "query.model"],
+          "limit": 5000
+        }
+      ) do |data, progress|
+        response << data
+      end
+      assert response
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: looker-sdk
 version: !ruby/object:Gem::Version
-  version: 0.1.10
+  version: 0.1.11
 platform: ruby
 authors:
 - Looker
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-07 00:00:00.000000000 Z
+date: 2025-01-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sawyer
@@ -134,12 +134,13 @@ files:
 - test/looker/test_client.rb
 - test/looker/test_dynamic_client.rb
 - test/looker/test_dynamic_client_agent.rb
+- test/looker/test_inline_query.rb
 - test/looker/user.json
 homepage: https://github.com/looker-open-source/looker-sdk-ruby
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -156,13 +157,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements:
 - Looker version 4.0 or later
 rubygems_version: 3.1.6
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Looker Ruby SDK
 test_files:
 - test/helper.rb
-- test/looker/test_client.rb
 - test/looker/test_dynamic_client.rb
-- test/looker/swagger.json
-- test/looker/user.json
+- test/looker/test_inline_query.rb
 - test/looker/test_dynamic_client_agent.rb
+- test/looker/test_client.rb
+- test/looker/user.json
+- test/looker/swagger.json