looker-sdk 0.1.11 → 0.1.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bd7f1ae1fc17049a2495fbe59b5daa30922eeee81324c198a14bd6e39714e4d6
-  data.tar.gz: 000eec5248e5cdee93e02a780822460a7c7adf10ebee87c645379a97eb8e2cf3
+  metadata.gz: 6b38ec236c26320f7fe18d8dcfb9e8020ee07aea5f65aeacc03f016d7aa12cf6
+  data.tar.gz: 717e65d319d58d044ab50656bde6b2fcdccdfff69400c5b20631bd737db7f412
 SHA512:
-  metadata.gz: 5d11ee93d5ea36eae97c8a2fff92c5505a3b1df8c750609cef85d431ca744ca188adfe8a1d17850ada2d9ac8bdf31129daef06713f5080303327f7360d366089
-  data.tar.gz: af88d3c1185927d26624900e6ed9794b3091415038aeba1f92a65c8d51daff308b3cc17f297709bd644cbb28e36d34011eccac83fa3f9aa0b3197e6af713dec6
+  metadata.gz: 87a1c61b1f6d4fba05c9bb31743757974ed91efb8f73cfd2e94ac2000b1b3d243c4e34b330e73319e965d477f0361e20b72d0fb196817f975bd666df79351341
+  data.tar.gz: 7f20baf26fb2d47782587e05f4867879eecc1b77552e1bc30e62fea52dd8eb053d10f272598dd0f2b5523cf293e3d875c122fb2b5550067dda20d265e984238b

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## [0.2.0](https://github.com/looker-open-source/looker-sdk-ruby/compare/v0.1.11...v0.2.0) (2026-03-08)
+
+
+### Features
+
+* Allow query parameters to be passed in the body for POST, PUT, and PATCH requests when no body parameter is explicitly defined. ([#156](https://github.com/looker-open-source/looker-sdk-ruby/issues/156)) ([6bb702b](https://github.com/looker-open-source/looker-sdk-ruby/commit/6bb702bd8c40bc2efdfad25df60a1a661e00e16b))
+
+
+### Bug Fixes
+
+* allow tests to run against remote server ([#155](https://github.com/looker-open-source/looker-sdk-ruby/issues/155)) ([1156d52](https://github.com/looker-open-source/looker-sdk-ruby/commit/1156d52c849197176ee62e8a122d2e5bab71f4be))
+* move query params -> body only on form ([#158](https://github.com/looker-open-source/looker-sdk-ruby/issues/158)) ([87e7280](https://github.com/looker-open-source/looker-sdk-ruby/commit/87e72805d479906ebd7d4753898d7609c9a33016))
+* send proper content-type header at /login ([#160](https://github.com/looker-open-source/looker-sdk-ruby/issues/160)) ([36866eb](https://github.com/looker-open-source/looker-sdk-ruby/commit/36866eb7d3414c2b00a65f3ee8b3b3784416bdf8))
+
 ## [0.1.11](https://github.com/looker-open-source/looker-sdk-ruby/compare/v0.1.10...v0.1.11) (2025-01-13)
 
 

data/lib/looker-sdk/authentication.rb

@@ -52,8 +52,7 @@ module LookerSDK
       set_access_token_from_params(nil)
       without_authentication do
         encoded_auth = Faraday::Utils.build_query(application_credentials)
-        post("#{URI.parse(api_endpoint).path}/login", encoded_auth, header: {:'Content-Type' => 'application/x-www-form-urlencoded'})
-        raise "login failure #{last_response.status}" unless last_response.status == 200
+        post(File.join(URI.parse(api_endpoint).path, 'login'), encoded_auth, headers: {:'Content-Type' => 'application/x-www-form-urlencoded'})
         set_access_token_from_params(last_response.data)
       end
     end

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

@@ -144,6 +144,22 @@ module LookerSDK
         b = args.length > 1 ? args[1] : {}
 
         method = entry[:method].to_sym
+
+        if [:post, :put, :patch].include?(method) && (entry[:info][:consumes] || []).include?("application/x-www-form-urlencoded")
+          if empty_body?(a) && !empty_body?(b)
+            a = {} if empty_body?(a)
+            if b.key?(:query)
+              a.merge!(b.delete(:query))
+            end
+
+            b.keys.each do |k|
+              next if k == :headers
+              next if Client::CONVENIENCE_HEADERS.include?(k)
+              a[k] = b.delete(k)
+            end
+          end
+        end
+
         case method
         when :get     then get(route, a, true, &block)
         when :post    then post(route, a, merge_content_type_if_body(a, b), true, &block)
@@ -154,6 +170,9 @@ module LookerSDK
         end
       end
 
+      def empty_body?(body)
+        body.nil? || (body.respond_to?(:empty?) && body.empty?)
+      end
     end
   end
 end

data/lib/looker-sdk/version.rb

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

data/test/helper.rb

@@ -22,9 +22,13 @@
 # THE SOFTWARE.
 ############################################################################################
 
-require 'simplecov'
-SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter.new SimpleCov::Formatter::HTMLFormatter
-SimpleCov.start
+begin
+  require 'simplecov'
+  SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter.new SimpleCov::Formatter::HTMLFormatter
+  SimpleCov.start
+rescue LoadError
+  # ignore simplecov if not installed
+end
 
 require 'rubygems'
 require 'bundler/setup'
@@ -94,6 +98,7 @@ def setup_sdk
     else
       c.netrc = true
       c.netrc_file =  File.join(fixture_path, '.netrc')
+      c.api_endpoint = "#{base_url}/api/#{api_version}"
     end
   end
 end

data/test/looker/test_body_params.rb

@@ -0,0 +1,150 @@
+require_relative '../helper'
+
+
+class LookerBodyParamsTest < Minitest::Spec
+
+  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.reset!
+    LookerSDK::Client.new do |config|
+      config.swagger = swagger
+      config.access_token = access_token
+      config.faraday = faraday
+    end
+  end
+
+  def default_swagger
+    json = <<-JSON
+      {
+        "swagger": "2.0",
+        "basePath": "/api/4.0",
+        "paths": {
+          "/test_post_urlencoded": {
+            "post": {
+              "operationId": "test_post_urlencoded",
+              "consumes": ["application/x-www-form-urlencoded"],
+              "parameters": [
+                {
+                  "name": "param1",
+                  "in": "query",
+                  "type": "string"
+                },
+                {
+                  "name": "param2",
+                  "in": "query",
+                  "type": "string"
+                }
+              ],
+              "responses": {
+                "200": { "description": "Success" }
+              }
+            }
+          },
+          "/test_post_json": {
+            "post": {
+              "operationId": "test_post_json",
+              "consumes": ["application/json"],
+              "parameters": [
+                {
+                  "name": "param1",
+                  "in": "query",
+                  "type": "string"
+                }
+              ],
+              "responses": {
+                "200": { "description": "Success" }
+              }
+            }
+          },
+          "/test_post_default": {
+            "post": {
+              "operationId": "test_post_default",
+              "parameters": [
+                {
+                  "name": "param1",
+                  "in": "query",
+                  "type": "string"
+                }
+              ],
+              "responses": {
+                "200": { "description": "Success" }
+              }
+            }
+          }
+        }
+      }
+    JSON
+    @swagger ||= JSON.parse(json, :symbolize_names => true)
+  end
+
+  def verify(response, method, path, expected_body='', expected_query={}, content_type = nil)
+    mock = Minitest::Mock.new.expect(:call, response) do |env|
+      req = Rack::Request.new(env)
+      req_body = req.body&.gets || ''
+      
+      # Parse body if it's JSON
+      begin
+        parsed_body = JSON.parse(req_body, :symbolize_names => true)
+      rescue JSON::ParserError
+        parsed_body = req_body
+      end
+
+      # Check method
+      method_match = req.request_method == method.to_s.upcase
+      
+      # Check path
+      path_match = req.path_info == path
+
+      # Check query params
+      parsed_query = JSON.parse(req.params.to_json, :symbolize_names => true)
+      query_match = parsed_query == expected_query
+      
+      # Check body
+      body_match = parsed_body == expected_body
+      
+      if !body_match
+        puts "Body mismatch! Expected: #{expected_body.inspect}, Got: #{parsed_body.inspect}"
+      end
+      method_match && path_match && query_match && body_match
+    end
+
+    
+    yield sdk_client(default_swagger, mock)
+    mock.verify
+  end
+
+  def response
+    [200, {'Content-Type' => 'application/json'}, [{}.to_json]]
+  end
+
+  describe "Body Params Refactor" do
+    it "moves query params to body for POST when consumes is x-www-form-urlencoded" do
+      # Expect body to have params, query to be empty
+      verify(response, :post, '/api/4.0/test_post_urlencoded', {param1: 'foo', param2: 'bar'}, {}) do |sdk|
+        sdk.test_post_urlencoded(nil, param1: 'foo', param2: 'bar')
+      end
+    end
+
+    it "keeps params in query for POST when consumes is application/json" do
+      # Expect body to be empty (or nil), query to have params
+      verify(response, :post, '/api/4.0/test_post_json', '', {param1: 'foo'}) do |sdk|
+        sdk.test_post_json(nil, param1: 'foo')
+      end
+    end
+
+    it "keeps params in query for POST when consumes is unspecified" do
+      # Expect body to be empty, query to have params
+      verify(response, :post, '/api/4.0/test_post_default', '', {param1: 'foo'}) do |sdk|
+        sdk.test_post_default(nil, param1: 'foo')
+      end
+    end
+  end
+end

data/test/looker/test_client.rb

@@ -57,6 +57,7 @@ describe LookerSDK::Client do
     opts.merge!({
       :netrc => true,
       :netrc_file => File.join(fixture_path, '.netrc'),
+      :api_endpoint => "#{base_url}/api/#{api_version}",
       :connection_options => {:ssl => {:verify => false}},
     })
 
@@ -156,12 +157,14 @@ describe LookerSDK::Client do
 
       describe "with .netrc"  do
         it "can read .netrc files" do
-          skip unless File.exist?(File.join(fixture_path, '.netrc'))
+          netrc_file = File.expand_path('../../../examples/.netrc', __FILE__)
+          skip unless File.exist?(netrc_file)
           LookerSDK.reset!
+          File.chmod(0600, netrc_file)
           client = LookerSDK::Client.new(
             :lazy_swagger => true,
             :netrc => true,
-            :netrc_file => File.join(fixture_path, '.netrc'),
+            :netrc_file => netrc_file,
           )
           client.client_id.wont_be_nil
           client.client_secret.wont_be_nil
@@ -373,6 +376,37 @@ describe LookerSDK::Client do
     end
   end
 
+  describe "authentication" do
+    it "sets the proper content type header on login" do
+      LookerSDK.reset!
+      client = LookerSDK::Client.new(
+        client_id: 'a',
+        client_secret: 'b',
+        api_endpoint: 'https://localhost:19999/api/4.0',
+        connection_options: {ssl: {verify: false}},
+        lazy_swagger: true
+      )
+
+      # login returns token info
+      token_response = OpenStruct.new(status: 200, data: {access_token: 'token', token_type: 'Bearer', expires_in: 3600})
+
+      # expect the post to have the right url, body, and headers
+      mock = Minitest::Mock.new.expect(:call, token_response) do |method, path, body, options|
+        method == :post &&
+        path == '/api/4.0/login' &&
+        body == 'client_id=a&client_secret=b' &&
+        options == {headers: {:'Content-Type' => 'application/x-www-form-urlencoded'}}
+      end
+
+      # test_client.rb uses mocha for mocking/stubbing usually:
+      Sawyer::Agent.stubs(:new).returns(mock)
+
+      client.authenticate
+
+      mock.verify
+    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.

data/test/looker/test_inline_query.rb

@@ -57,6 +57,7 @@ describe LookerSDK::Client do
     opts.merge!({
       :netrc => true,
       :netrc_file => File.join(fixture_path, '.netrc'),
+      :api_endpoint => "#{base_url}/api/#{api_version}",
       :connection_options => {:ssl => {:verify => false}},
     })
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: looker-sdk
 version: !ruby/object:Gem::Version
-  version: 0.1.11
+  version: 0.1.12
 platform: ruby
 authors:
 - Looker
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-01-13 00:00:00.000000000 Z
+date: 2026-03-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sawyer
@@ -131,6 +131,7 @@ files:
 - streaming.md
 - test/helper.rb
 - test/looker/swagger.json
+- test/looker/test_body_params.rb
 - test/looker/test_client.rb
 - test/looker/test_dynamic_client.rb
 - test/looker/test_dynamic_client_agent.rb
@@ -163,8 +164,9 @@ summary: Looker Ruby SDK
 test_files:
 - test/helper.rb
 - test/looker/test_dynamic_client.rb
-- test/looker/test_inline_query.rb
 - test/looker/test_dynamic_client_agent.rb
-- test/looker/test_client.rb
+- test/looker/test_body_params.rb
 - test/looker/user.json
+- test/looker/test_inline_query.rb
 - test/looker/swagger.json
+- test/looker/test_client.rb