looker-sdk 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: a9c372139d8df28af2b71bce4382f3badfa6d1c8
-  data.tar.gz: 66910d788e066ef3767f76966e1973ca7312e3c4
+SHA256:
+  metadata.gz: ae194b96e860627f144eecc7921ce55b3a27930d574040d81f12bb663c6e96ba
+  data.tar.gz: c6bbf41bafaf912397caa40e61afc6d1e11382785b50f042704d4d046a3b3629
 SHA512:
-  metadata.gz: 043052d8df89d53724b1fe23e181ae5eafb598ff4aca2dd44d8d030510ffe98dffeb8c51a9a180c594b64597500d42b13db84f08d1969fcdb3d571c98e9eb49e
-  data.tar.gz: 8627156eb5061245b16330094381786800e1c32c1fbb8340297e962429a97ad14cc75e2fc2fe8073297e4c7b61751298c629da8ee65721c38c0b5975b643f644
+  metadata.gz: 3e75dc981959db75e1ff4a849ad9208d7299f380af2484e44850db2075d75fbd359f82cb0f1fcb68c6b0165a0d7612161cc112ec86b285ee06057548f8ccef03
+  data.tar.gz: b3798c47cb1b978541a723a1840c19ff60dbd8d8b7584cc0e5b9438b2d0216fea627bf66ba920acbc6c6ec236e117578b48c9e6ec4bafc3bcd880130579e052f

data/.travis.yml

@@ -4,7 +4,7 @@ rvm:
   - 2.0
   - 2.1
   - 2.3.1
-  - jruby-1.7.19
+  - jruby-1.7.27
   - jruby-9.1.5.0
 cache:
   bundler: true

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,46 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at opensource@looker.com. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/examples/users_with_credentials_embed.rb

@@ -0,0 +1,9 @@
+require './sdk_setup'
+
+users = sdk.all_users(fields:'id, is_disabled, display_name, credentials_embed').map do |u|
+  next if u.is_diabled || u.credentials_embed.empty?
+  creds = u.credentials_embed.first
+  [u.id, u.display_name, creds.external_user_id, creds.external_group_id, creds.logged_in_at]
+end.compact
+
+users.each{|u| p u}

data/lib/looker-sdk/client.rb

@@ -190,10 +190,34 @@ module LookerSDK
     #
     # @return http status code
     def alive
-      get '/alive'
+      without_authentication do
+        get '/alive'
+      end
       last_response.status
     end
 
+    # Are we connected to the server? - Does not attempt to authenticate.
+    def alive?
+      begin
+        without_authentication do
+          get('/alive')
+        end
+        true
+      rescue
+        false
+      end
+    end
+
+    # Are we connected and authenticated to the server?
+    def authenticated?
+      begin
+        ensure_logged_in
+        true
+      rescue
+        false
+      end
+    end
+
     # Response for last HTTP request
     #
     # @return [Sawyer::Response]
@@ -365,15 +389,20 @@ module LookerSDK
 
       # slight modification to the base class' decode_hash_value function to
       # less permissive when decoding time values.
+      # also prevent conversion from non-string types to Time e.g. integer/float timestamp
       #
       # See https://github.com/looker/looker-sdk-ruby/issues/53 for more details
       #
       # Base class function that we're overriding: https://github.com/lostisland/sawyer/blob/master/lib/sawyer/serializer.rb#L101-L121
       def decode_hash_value(key, value)
-        if time_field?(key, value) && value.is_a?(String)
-          begin
-            Time.iso8601(value)
-          rescue ArgumentError
+        if time_field?(key, value)
+          if value.is_a?(String)
+            begin
+              Time.iso8601(value)
+            rescue ArgumentError
+              value
+            end
+          else
             value
           end
         else

data/lib/looker-sdk/version.rb

@@ -2,6 +2,6 @@ module LookerSDK
 
   # Current version
   # @return [String]
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 
 end

data/looker-sdk.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |s|
   s.version     = LookerSDK::VERSION
   s.date        = "#{Time.now.strftime('%F')}"
   s.authors     = ['Looker']
-  s.email       = 'support@looker.com'
+  s.email       = 'opensource+sdkruby@looker.com'
   s.homepage    = 'https://github.com/looker/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 '+
@@ -23,5 +23,6 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = %w(lib)
   s.add_dependency 'jruby-openssl' if s.platform == :jruby
-  s.add_dependency 'sawyer', '0.6'
+  s.add_dependency 'sawyer', '~> 0.8'
+  s.add_dependency 'faraday', ['>= 0.9.0', '< 1.0']
 end

data/readme.md

@@ -4,7 +4,7 @@ This SDK supports secure/authenticated access to the Looker RESTful API. The SDK
 
 The Looker API uses OAuth2 authentication. 'API3' keys can be generated by Looker admins for any Looker user account from the Looker admin panel. These 'keys' each consist of a client_id/client_secret pair. These keys should be carefully protected as one would with any critical password. When using the SDK, one creates a client object that is initialized with a client_id/client_secret pair and the base URL of the Looker instance's API endpoint. The SDK transparently logs in to the API with that key pair to generate a short-term auth token that it sends to the API with each subsequent call to provide authentication for that call.
 
-All calls to the Looker API must be done over a TSL/SSL connection. Requests and responses are then encrypted at that transport layer. It is highly recommended that Looker instance https endpoints use certificates that are properly signed by a trusted certificate authority. The SDK will, by default, validate server certificates. It is possible to disable that validation when creating an SDK client object if necessary. But, that configuration is discouraged.
+All calls to the Looker API must be done over a TLS/SSL connection. Requests and responses are then encrypted at that transport layer. It is highly recommended that Looker instance https endpoints use certificates that are properly signed by a trusted certificate authority. The SDK will, by default, validate server certificates. It is possible to disable that validation when creating an SDK client object if necessary. But, that configuration is discouraged.
 
 Looker instances expose API documentation at: https://mygreatcompany.looker.com:19999/api-docs/index.html (the exact URL can be set in the Looker admin panel). By default, the documentation page requires a client_id/client_secret pair to load the detailed API information. That page also supports "Try it out!" links so that you can experiment with the API right from the documentation. The documentation is intended to show how to call the API endpoints via either raw RESTful https requests or using the SDK.
 
@@ -55,14 +55,14 @@ sdk = LookerSDK::Client.new(
   :netrc_file => "~/.net_rc",
   :api_endpoint => "https://mygreatcompany.looker.com:19999/api/3.0",
 
-  # Disable cert verification if the looker has a self-signed cert.
+  # 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}},
+
+  # Alternately, disable cert verification if the looker has a self-signed cert.
   # Avoid this if using real certificates; verification of the server cert is a very good thing for production.
   # :connection_options => {:ssl => {:verify => false}},
 
-  # Set longer timeout to allow for long running queries.
-  # :connection_options => {:request => {:timeout => 60 * 60, :open_timeout => 30}},
-
-  # Support self-signed cert *and* set longer timeout to allow for long running queries.
+  # Alternately, support self-signed cert *and* set longer timeout to allow for long running queries.
   # :connection_options => {:ssl => {:verify => false}, :request => {:timeout => 60 * 60, :open_timeout => 30}},
 )
 

data/shell/shell.rb

@@ -16,7 +16,7 @@ def sdk
     # Support self-signed cert *and* set longer timeout to allow for long running queries.
     :connection_options => {:ssl => {:verify => false}, :request => {:timeout => 60 * 60, :open_timeout => 30}},
 
-    :api_endpoint => "https://self-signed.looker.com:19999/api/3.0",
+    :api_endpoint => "https://localhost:19999/api/3.0",
 
     # Customize to use your specific looker instance
     # :connection_options => {:ssl => {:verify => true}},
@@ -26,7 +26,8 @@ end
 
 begin
   puts "Connecting to Looker at '#{sdk.api_endpoint}'"
-  puts (code = sdk.alive) == 200 ? "Looker is alive!" : "Sad Looker: #{code}"
+  puts sdk.alive? ? "Looker is alive!" : "Sad Looker, can't connect:\n  #{sdk.last_error}"
+  puts sdk.authenticated? ? "Authenticated!" : "Sad Looker, can't authenticate:\n  #{sdk.last_error}"
 
   binding.pry self
 rescue Exception => e

data/test/looker/swagger.json

@@ -3,13 +3,13 @@
   "info": {
     "version": "3.0.0",
     "title": "Looker API",
-    "description": "This document describes the 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>"
     },
     "license": {
       "name": "EULA",
-      "url": "https://localhost:9999/eula"
+      "url": "https://learn.looker.com/eula"
     }
   },
   "basePath": "/api/3.0",
@@ -1253,6 +1253,77 @@
         }
       }
     },
+    "/users/{user_id}/attribute_values": {
+      "get": {
+        "tags": [
+          "User"
+        ],
+        "operationId": "user_attribute_user_values",
+        "summary": "Get User Attribute Values",
+        "description": "### Get user attribute values for a given user.\n\nReturns the values of specified user attributes (or all user attributes) for a certain user.\n\nA value for each user attribute is searched for in the following locations, in this order:\n1. in the user's account information\n1. in groups that the user is a member of\n1. the default value of the user attribute\n\nIf more than one group has a value defined for a user attribute, the group with the lowest rank wins.\n\nThe response will only include user attributes for which values were found. Use `include_unset=true` to include\nempty records for user attributes with no value.\n\nThe value of all hidden user attributes will be blank.\n",
+        "parameters": [
+          {
+            "name": "user_id",
+            "in": "path",
+            "description": "Id of user",
+            "required": true,
+            "type": "integer",
+            "format": "int64"
+          },
+          {
+            "name": "fields",
+            "in": "query",
+            "description": "Requested fields.",
+            "required": false,
+            "type": "string"
+          },
+          {
+            "name": "user_attribute_ids",
+            "in": "query",
+            "description": "Specific user attributes to request. Omit or leave blank to request all user attributes.",
+            "required": false,
+            "type": "array",
+            "items": {
+              "type": "integer",
+              "format": "int64"
+            },
+            "collectionFormat": "csv"
+          },
+          {
+            "name": "all_values",
+            "in": "query",
+            "description": "If true, returns all values in the search path instead of just the first value found. Useful for debugging group precedence.",
+            "required": false,
+            "type": "boolean"
+          },
+          {
+            "name": "include_unset",
+            "in": "query",
+            "description": "If true, returns an empty record for each requested attribute that has no user, group, or default value.",
+            "required": false,
+            "type": "boolean"
+          }
+        ],
+        "responses": {
+          "404": {
+            "description": "Not Found",
+            "schema": {
+              "$ref": "#/definitions/Error"
+            }
+          },
+          "200": {
+            "description": "Value of user attribute.",
+            "schema": {
+              "type": "array",
+              "items": {
+                "$ref": "#/definitions/UserAttributeWithValue"
+              }
+            }
+          }
+        },
+        "x-looker-status": "beta"
+      }
+    },
     "/users/{user_id}/roles": {
       "get": {
         "tags": [

data/test/looker/test_client.rb

@@ -212,12 +212,18 @@ describe LookerSDK::Client do
 
   describe 'Sawyer date/time parsing patch' do
     describe 'key matches time_field pattern' do
-      it 'does not modify non-iso date/time string' do
+      it 'does not modify non-iso date/time string or integer fields' 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',
+            :test_int_at => 42,
+            :test_int_on => 42,
+            :test_int_date => 42.1,
+            :test_float_at => 42.1,
+            :test_float_on => 42.1,
+            :test_float_date => 42.1,
         }
 
         serializer = LookerSDK::Client.new.send(:serializer)

data/test/looker/test_dynamic_client.rb

@@ -1,6 +1,6 @@
 require_relative '../helper'
 
-describe LookerSDK::Client::Dynamic do
+class LookerDynamicClientTest < MiniTest::Spec
 
   def access_token
     '87614b09dd141c22800f96f11737ade5226d7ba8'
@@ -66,10 +66,21 @@ describe LookerSDK::Client::Dynamic do
     mock.verify
   end
 
-
   describe "swagger" do
 
-    it "get" do
+    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)
+      assert_raises NoMethodError do
+        sdk.this_method_name_doesnt_exist()
+      end
+
+      assert_raises NameError do
+        sdk.invoke(:this_method_name_doesnt_exist)
+      end
+    end
+
+    it "get no params" do
       verify(response, :get, '/api/3.0/user') do |sdk|
         sdk.me
       end
@@ -93,6 +104,20 @@ describe LookerSDK::Client::Dynamic do
       end
     end
 
+    it "get with array query param - string input (csv)" do
+      verify(response, :get, '/api/3.0/users/1/attribute_values','',{user_attribute_ids: '2,3,4'}) do |sdk|
+        sdk.user_attribute_user_values(1, {user_attribute_ids: '2,3,4'})
+        sdk.last_response.env.url.query.must_equal 'user_attribute_ids=2%2C3%2C4'
+      end
+    end
+
+    it "get with array query param - array input (multi[])" do
+      verify(response, :get, '/api/3.0/users/1/attribute_values','',{user_attribute_ids: ['2','3','4']}) do |sdk|
+        sdk.user_attribute_user_values(1, {user_attribute_ids: [2,3,4]})
+        sdk.last_response.env.url.query.must_equal 'user_attribute_ids%5B%5D=2&user_attribute_ids%5B%5D=3&user_attribute_ids%5B%5D=4'
+      end
+    end
+
     it "post" do
       verify(response, :post, '/api/3.0/users', {first_name:'Joe'}) do |sdk|
         sdk.create_user({first_name:'Joe'})

metadata

@@ -1,38 +1,63 @@
 --- !ruby/object:Gem::Specification
 name: looker-sdk
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Looker
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-03-10 00:00:00.000000000 Z
+date: 2018-08-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '0.8'
   name: sawyer
   prerelease: false
   type: :runtime
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
-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: support@looker.com
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  name: faraday
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.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
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .ruby-gemset
-- .travis.yml
+- ".gitignore"
+- ".ruby-gemset"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE
 - Rakefile
@@ -51,6 +76,7 @@ files:
 - examples/sdk_setup.rb
 - examples/streaming_downloads.rb
 - examples/users_with_credentials_email.rb
+- examples/users_with_credentials_embed.rb
 - examples/users_with_credentials_google.rb
 - examples/users_with_credentials_google_without_credentials_email.rb
 - lib/looker-sdk.rb
@@ -89,18 +115,18 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements:
 - Looker version 4.0 or later
 rubyforge_project:
-rubygems_version: 2.4.5
+rubygems_version: 2.6.13
 signing_key:
 specification_version: 4
 summary: Looker Ruby SDK