looker-sdk 0.0.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a9c372139d8df28af2b71bce4382f3badfa6d1c8
+  data.tar.gz: 66910d788e066ef3767f76966e1973ca7312e3c4
+SHA512:
+  metadata.gz: 043052d8df89d53724b1fe23e181ae5eafb598ff4aca2dd44d8d030510ffe98dffeb8c51a9a180c594b64597500d42b13db84f08d1969fcdb3d571c98e9eb49e
+  data.tar.gz: 8627156eb5061245b16330094381786800e1c32c1fbb8340297e962429a97ad14cc75e2fc2fe8073297e4c7b61751298c629da8ee65721c38c0b5975b643f644

data/.gitignore

@@ -0,0 +1,52 @@
+# Numerous always-ignore extensions
+*.diff
+*.err
+*.orig
+*.log
+*.rej
+*.swo
+*.swp
+*.vi
+*~
+*.sass-cache
+*.iml
+
+# OS or Editor folders
+.DS_Store
+.cache
+.project
+.settings
+.tmproj
+nbproject
+Thumbs.db
+
+# Folders to ignore
+intermediate
+publish
+target
+.idea
+out
+
+# markdown previews
+*.md.html
+
+# bundler suggested ignores
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+Gemfile.optional.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.netrc

data/.ruby-gemset

@@ -0,0 +1 @@
+looker-sdk-ruby

data/.travis.yml

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

data/Gemfile

@@ -0,0 +1,22 @@
+source 'https://rubygems.org'
+
+group :development do
+  gem 'awesome_print', '~>1.6.1', :require => 'ap'
+  gem 'redcarpet', '~>3.1.2', :platforms => :ruby
+end
+
+group :development, :test do
+  gem 'rake', '< 11.0'
+end
+
+group :test do
+  # gem 'json', '~> 1.7', :platforms => [:jruby] look TODO needed?
+  gem 'minitest',         '5.3.5'
+  gem 'mocha',            '1.1.0'
+  gem 'rack',             '1.6.4'
+  gem 'rack-test',        '0.6.2'
+  gem 'netrc', '~> 0.7.7'
+  gem 'simplecov', '~> 0.7.1', :require => false
+end
+
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+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.

data/Rakefile

@@ -0,0 +1,37 @@
+require 'bundler'
+require "bundler/gem_tasks"
+
+require "rake/testtask"
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList["test/**/test_*.rb"]
+  t.verbose = true
+end
+
+namespace :test do
+  desc "Run tests against all supported Rubies"
+  task :all do
+    supported_rubies = ['ruby-1.9.3', 'ruby-2.0', 'ruby-2.1', 'ruby-2.3.1', 'jruby-1.7.19', 'jruby-9.1.5.0']
+    failing_rubies = []
+
+    supported_rubies.each do |ruby|
+      cmd = "rvm install #{ruby} && rvm #{ruby} exec gem install bundler && rvm #{ruby} exec bundle install && rvm #{ruby} exec bundle exec rake"
+      system cmd
+      if $? != 0
+        failing_rubies << ruby
+      end
+    end
+
+    failing_rubies.each do |ruby|
+      puts "FAIL: #{ruby}.  Problem with the tests on #{ruby}."
+    end
+
+    if failing_rubies
+      exit 1
+    else
+      exit 0
+    end
+  end
+end
+
+task :default => :test

data/authentication.md

@@ -0,0 +1,104 @@
+## How to authenticate to Looker's API 3
+
+The preferred way to authenticate is to use the looker SDK to manage the login and the passing of
+access_tokens as needed. This doc, however, explains how to do this authentication in a generic way without the SDK and using curl instead for illustration.
+
+Looker API 3 implements OAuth 2's "Resource Owner Password Credentials Grant" pattern,
+See: http://tools.ietf.org/html/rfc6749#section-4.3
+
+### Setup an API key
+An 'API 3' key is required in order to login and use the API. The key consists of a client_id and a client_secret.
+'Login' consists of using these credentials to generate a short-term access_token which is then used to make API calls.
+
+The client_id could be considered semi-public. While, the client_secret is a secret password and MUST be
+carefully protected. These credentials should not be hard-coded into client code. They should be read from
+a closely guarded data file when used by client processes.
+
+Admins can create an API 3 key for a user on looker's user edit page. All requests made using these
+credentials are made 'as' that user and limited to the role permissions specified for that user. A user
+account with an appropriate role may be created as needed for the API client's use.
+
+Note that API 3 tokens should be created for 'regular' Looker users and *not* via the legacy 'Add API User' button.
+
+
+### Ensure that the API is accessible
+Looker versions 3.4 (and beyond) expose the 3.0 API via a port different from the port used by the web app.
+The default port is 19999. It may be necessary to have the Ops team managing the looker instance ensure that this
+port is made accessible network-wise to client software running on non-local hosts.
+
+The '/alive' url can be used to detect if the server is reachable
+
+
+### Login
+To access the API it is necessary to 'login' using the client_id and client_secret in order to acquire an
+access_token that will be used in actual API requests. This is done by POSTing to the /login url. The access_token is returned in a short json body and has a limited time before it expires (the default at this point is 1 hour).
+An 'expires_in' field is provided to tell client software how long they should expect the token to last.
+
+A new token is created for each /login call and remains valid until it expires or is revoked via /logout.
+
+It is VERY important that these tokens never be sent in the clear or exposed in any other way.
+
+
+### Call the API
+API calls then pass the access_token to looker using an 'Authorization' header. API calls are
+done using GET, PUT, POST, PATCH, or DELETE as appropriate for the specific call. Normal REST stuff.
+
+
+### Logout
+A '/logout' url is available if the client wants to revoke an access_token. It requires a DELETE request.
+Looker reserves the right to limit the number of 'live' access_tokens per user.
+
+-------------------------------------------------------------------------------------------------
+
+The following is an example session using Curl. The '-i' param is used to show returned headers.
+
+The simple flow in this example is to login, get info about the current user, then logout.
+
+Note that in this example the client_id and client_secret params are passed using '-d' which causes the
+request to be done as a POST. And, the -H param is used to specify http headers to add for API requests.
+
+```
+# Check that the port is reachable
+> curl -i https://localhost:19999/alive
+HTTP/1.1 200 OK
+Content-Type: application/json;charset=utf-8
+Vary: Accept-Encoding
+X-Content-Type-Options: nosniff
+Content-Length: 0
+
+
+# Do the login to get an access_token
+> curl -i  -d "client_id=4j3SD8W5RchHw5gvZ5Yd&client_secret=sVySctSMpQQG3TzdNQ5d2dND"  https://localhost:19999/login
+HTTP/1.1 200 OK
+Content-Type: application/json;charset=utf-8
+Vary: Accept-Encoding
+X-Content-Type-Options: nosniff
+Content-Length: 99
+
+{"access_token":"4QDkCyCtZzYgj4C2p2cj3csJH7zqS5RzKs2kTnG4","token_type":"Bearer","expires_in":3600}
+
+# Use an access_token (the token can be used over and over for API calls until it expires)
+> curl -i -H "Authorization: token 4QDkCyCtZzYgj4C2p2cj3csJH7zqS5RzKs2kTnG4"  https://localhost:19999/api/3.0/user
+HTTP/1.1 200 OK
+Content-Type: application/json;charset=utf-8
+Vary: Accept-Encoding
+X-Content-Type-Options: nosniff
+Content-Length: 502
+
+{"id":14,"first_name":"Plain","last_name":"User","email":"dude+1@looker.com","models_dir":null,"is_disabled":false,"look_access":[14],"avatar_url":"https://www.gravatar.com/avatar/b7f792a6180a36a4058f36875584bc45?s=156&d=mm","credentials_email":{"email":"dude+1@looker.com","url":"https://localhost:19999/api/3.0/users/14/credentials_email","user_url":"https://localhost:19999/api/3.0/users/14","password_reset_url":"https://localhost:19999/api/3.0"},"url":"https://localhost:19999/api/3.0/users/14"}
+
+# Logout to revoke an access_token
+> curl -i -X DELETE -H "Authorization: token 4QDkCyCtZzYgj4C2p2cj3csJH7zqS5RzKs2kTnG4"  https://localhost:19999/logout
+HTTP/1.1 204 No Content
+X-Content-Type-Options: nosniff
+
+# Show that the access_token is no longer valid
+> curl -i -X DELETE -H "Authorization: token 4QDkCyCtZzYgj4C2p2cj3csJH7zqS5RzKs2kTnG4"  https://localhost:19999/logout
+HTTP/1.1 404 Not Found
+Content-Type: application/json;charset=utf-8
+Vary: Accept-Encoding
+X-Content-Type-Options: nosniff
+Content-Length: 69
+
+{"message":"Not found","documentation_url":"http://docs.looker.com/"}
+```

data/examples/add_delete_users.rb

@@ -0,0 +1,94 @@
+require './sdk_setup'
+
+############################################################################################
+# simulate a list read from file
+
+user_list = <<-ENDMARK
+
+Joe Williams, joe@mycoolcompany.com, Admin
+Jane Schumacher, jane@mycoolcompany.com, User SuperDeveloper
+Jim Watson, jim@mycoolcompany.com, User
+Jim Wu, jimw@mycoolcompany.com, User
+
+ENDMARK
+
+############################################################################################
+
+def create_users(lines)
+  # create a hash to use below. role.name => role.id
+  roles_by_name = Hash[ sdk.all_roles.map{|role| [role.name, role.id] } ]
+
+  # for each line, try to create that user with name, email credentials, and roles
+  lines.each_line do |line|
+    line.strip!
+    next if line.empty?
+
+    # quicky parsing: note lack of error handling!
+
+    name, email, roles = line.split(',')
+    fname, lname = name.split(' ')
+    [fname, lname, email, roles].each(&:strip!)
+
+    role_ids = []
+    roles.split(' ').each do |role_name|
+      if id = roles_by_name[role_name]
+        role_ids << id
+      else
+        raise "#{role_name} does not exist. ABORTING!"
+      end
+    end
+
+    # for display
+    user_info = "#{fname} #{lname} <#{email}> as #{roles}"
+
+    begin
+      # call the SDK to create user with names, add email/password login credentials, set user roles
+      user = sdk.create_user({:first_name => fname, :last_name => lname})
+      sdk.create_user_credentials_email(user.id, {:email => email})
+      sdk.set_user_roles(user.id, role_ids)
+      puts "Created user: #{user_info}"
+    rescue LookerSDK::Error => e
+      # if any errors occur above then 'undo' by deleting the given user (if we got that far)
+      sdk.delete_user(user.id) if user
+      puts "FAILED to create user: #{user_info} (#{e.message}) "
+    end
+  end
+end
+
+##################################################################
+
+def delete_users(lines)
+  # create a hash to use below. user.credentials_email.email => user.id
+  users_by_email = Hash[ sdk.all_users.map{|user| [user.credentials_email.email, user.id] if user.credentials_email}.compact ]
+
+  lines.each_line do |line|
+    line.strip!
+    next if line.empty?
+
+    # quicky parsing: note lack of error handling!
+    name, email, roles = line.split(',')
+    fname, lname = name.split(' ')
+    [fname, lname, email, roles].each(&:strip!)
+
+    # for display
+    user_info = "#{fname} #{lname} <#{email}>"
+
+    begin
+      if id = users_by_email[email]
+        sdk.delete_user(id)
+        puts "Deleted user: #{user_info}>"
+      else
+        puts "Did not find user: #{user_info}>"
+      end
+    rescue LookerSDK::Error => e
+      puts "FAILED to delete user: #{user_info} (#{e.message}) "
+    end
+  end
+end
+
+##################################################################
+
+# call the methods
+create_users(user_list)
+puts
+delete_users(user_list)

data/examples/change_credentials_email_address_for_users.rb

@@ -0,0 +1,23 @@
+require './sdk_setup'
+
+users = Hash[
+    sdk.all_users(:fields => 'id, credentials_email').
+      map{|u| [u.credentials_email.email, u.id] if u.credentials_email }.compact
+    ]
+
+$stdin.each_line do |line|
+  line.chomp!
+
+  _, old_email, new_email = line.split(',', 3).map(&:strip)
+
+  if id = users[old_email]
+    begin
+      sdk.update_user_credentials_email(id, {:email => new_email})
+      puts "Successfully changed '#{old_email}' => '#{new_email}'"
+    rescue => e
+      puts "FAILED to changed '#{old_email}' => '#{new_email}' because of: #{e.class}:#{e.message}"
+    end
+  else
+    puts "FAILED: Could not find user with email '#{old_email}'"
+  end
+end

data/examples/create_credentials_email_for_users.rb

@@ -0,0 +1,19 @@
+require './sdk_setup'
+
+$stdin.each_line do |line|
+  line.chomp!
+
+  id, email = line.split(',', 2).map(&:strip)
+
+  begin
+    user = sdk.user(id)
+    if user.credentials_email
+      puts "Error: User with id '#{id}' Already has credentials_email"
+    else
+      sdk.create_user_credentials_email(id, {:email => email})
+      puts "Success: Created credentials_email for User with id '#{id}' and email '#{email}'"
+    end
+  rescue LookerSDK::NotFound
+    puts "Error: User with id '#{id}' Not found"
+  end
+end

data/examples/delete_all_user_sessions.rb

@@ -0,0 +1,15 @@
+require './sdk_setup'
+
+total_count = 0
+sdk.all_users(:fields => 'id, display_name').each do |user|
+  count = 0
+  sdk.all_user_sessions(user.id, :fields => 'id').each do |session|
+    sdk.delete_user_session(user.id, session.id)
+    count += 1
+  end
+    puts "Deleted #{count} sessions for #{user.id} #{user.display_name}"
+    total_count += count
+end
+puts "Deleted #{total_count} sessions"
+
+

data/examples/delete_credentials_google_for_users.rb

@@ -0,0 +1,19 @@
+require './sdk_setup'
+
+$stdin.each_line do |line|
+  line.chomp!
+
+  id, _ = line.split(',', 2).map(&:strip)
+
+  begin
+    user = sdk.user(id)
+    if user.credentials_google
+      sdk.delete_user_credentials_google(id)
+      puts "Success: Deleted credentials_google for User with id '#{id}'"
+    else
+      puts "Error: User with id '#{id}' Does not have credentials_google"
+    end
+  rescue LookerSDK::NotFound
+    puts "Error: User with id '#{id}' Not found"
+  end
+end