shotgrid_api_ruby 0.1.3.3 → 0.2.0.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.github/workflows/test_and_publish.yml +2 -0
- data/.github/workflows/test_only.yml +2 -0
- data/.gitignore +3 -0
- data/.overcommit.yml +9 -0
- data/.rubocop.yml +2 -0
- data/CHANGELOG.md +11 -1
- data/Gemfile +18 -0
- data/Guardfile +2 -2
- data/bin/generate_and_add_documentation +1 -0
- data/bin/generate_sorbet_coverage +3 -0
- data/bin/prettirun +1 -1
- data/bin/sorbet_check +1 -0
- data/bin/tapioca +29 -0
- data/docs/ShotgridApiRuby/Auth/Validator.html +319 -0
- data/docs/ShotgridApiRuby/Auth.html +1079 -0
- data/docs/ShotgridApiRuby/Client.html +933 -0
- data/docs/ShotgridApiRuby/Entities/Params/TooComplexFiltersError.html +124 -0
- data/docs/ShotgridApiRuby/Entities/Params.html +1377 -0
- data/docs/ShotgridApiRuby/Entities/Schema.html +646 -0
- data/docs/ShotgridApiRuby/Entities/Summarize/Summary.html +401 -0
- data/docs/ShotgridApiRuby/Entities/Summarize.html +775 -0
- data/docs/ShotgridApiRuby/Entities.html +2461 -0
- data/docs/ShotgridApiRuby/Entity.html +935 -0
- data/docs/ShotgridApiRuby/Preferences.html +417 -0
- data/docs/ShotgridApiRuby/ServerInfo.html +415 -0
- data/docs/ShotgridApiRuby/ShotgridCallError.html +328 -0
- data/docs/ShotgridApiRuby/Types.html +136 -0
- data/docs/ShotgridApiRuby.html +307 -0
- data/docs/_index.html +253 -0
- data/docs/class_list.html +51 -0
- data/docs/css/common.css +1 -0
- data/docs/css/full_list.css +58 -0
- data/docs/css/style.css +497 -0
- data/docs/file.README.html +578 -0
- data/docs/file_list.html +56 -0
- data/docs/frames.html +17 -0
- data/docs/index.html +578 -0
- data/docs/js/app.js +314 -0
- data/docs/js/full_list.js +216 -0
- data/docs/js/jquery.js +4 -0
- data/docs/method_list.html +643 -0
- data/docs/top-level-namespace.html +110 -0
- data/lib/shotgrid_api_ruby/auth.rb +89 -33
- data/lib/shotgrid_api_ruby/client.rb +50 -7
- data/lib/shotgrid_api_ruby/entities/params.rb +304 -65
- data/lib/shotgrid_api_ruby/entities/schema.rb +18 -3
- data/lib/shotgrid_api_ruby/entities/summarize.rb +39 -7
- data/lib/shotgrid_api_ruby/entities.rb +118 -29
- data/lib/shotgrid_api_ruby/entity.rb +29 -12
- data/lib/shotgrid_api_ruby/preferences.rb +7 -1
- data/lib/shotgrid_api_ruby/server_info.rb +7 -1
- data/lib/shotgrid_api_ruby/shotgrid_call_error.rb +5 -1
- data/lib/shotgrid_api_ruby/types/auth_type.rb +23 -0
- data/lib/shotgrid_api_ruby/version.rb +2 -1
- data/lib/shotgrid_api_ruby.rb +20 -2
- data/shotgrid_api_ruby.gemspec +2 -10
- data/sorbet/config +6 -0
- data/sorbet/rbi/faraday.rbi +20 -0
- data/sorbet/rbi/gems/activesupport@6.1.4.1.rbi +3770 -0
- data/sorbet/rbi/gems/ast@2.4.2.rbi +54 -0
- data/sorbet/rbi/gems/backport@1.2.0.rbi +8 -0
- data/sorbet/rbi/gems/benchmark@0.1.1.rbi +65 -0
- data/sorbet/rbi/gems/bundler-audit@0.8.0.rbi +8 -0
- data/sorbet/rbi/gems/byebug@11.1.3.rbi +1569 -0
- data/sorbet/rbi/gems/childprocess@4.1.0.rbi +8 -0
- data/sorbet/rbi/gems/coderay@1.1.3.rbi +1005 -0
- data/sorbet/rbi/gems/colorize@0.8.1.rbi +39 -0
- data/sorbet/rbi/gems/commander@4.6.0.rbi +8 -0
- data/sorbet/rbi/gems/concurrent-ruby@1.1.9.rbi +2403 -0
- data/sorbet/rbi/gems/diff-lcs@1.4.4.rbi +8 -0
- data/sorbet/rbi/gems/docile@1.4.0.rbi +54 -0
- data/sorbet/rbi/gems/dotenv@2.7.6.rbi +88 -0
- data/sorbet/rbi/gems/e2mmap@0.1.0.rbi +8 -0
- data/sorbet/rbi/gems/faker@2.19.0.rbi +2513 -0
- data/sorbet/rbi/gems/faraday-em_http@1.0.0.rbi +101 -0
- data/sorbet/rbi/gems/faraday-em_synchrony@1.0.0.rbi +78 -0
- data/sorbet/rbi/gems/faraday-excon@1.1.0.rbi +77 -0
- data/sorbet/rbi/gems/faraday-httpclient@1.0.1.rbi +73 -0
- data/sorbet/rbi/gems/faraday-net_http@1.0.1.rbi +82 -0
- data/sorbet/rbi/gems/faraday-net_http_persistent@1.2.0.rbi +72 -0
- data/sorbet/rbi/gems/faraday-patron@1.0.0.rbi +74 -0
- data/sorbet/rbi/gems/faraday-rack@1.0.0.rbi +73 -0
- data/sorbet/rbi/gems/faraday@1.7.0.rbi +783 -0
- data/sorbet/rbi/gems/ffi@1.15.3.rbi +8 -0
- data/sorbet/rbi/gems/formatador@0.3.0.rbi +8 -0
- data/sorbet/rbi/gems/guard-compat@1.2.1.rbi +8 -0
- data/sorbet/rbi/gems/guard-rspec@4.7.3.rbi +8 -0
- data/sorbet/rbi/gems/guard@2.18.0.rbi +8 -0
- data/sorbet/rbi/gems/haml@5.2.2.rbi +8 -0
- data/sorbet/rbi/gems/highline@2.0.3.rbi +8 -0
- data/sorbet/rbi/gems/i18n@1.8.10.rbi +584 -0
- data/sorbet/rbi/gems/iniparse@1.5.0.rbi +8 -0
- data/sorbet/rbi/gems/jaro_winkler@1.5.4.rbi +8 -0
- data/sorbet/rbi/gems/kramdown-parser-gfm@1.1.0.rbi +8 -0
- data/sorbet/rbi/gems/kramdown@2.3.1.rbi +8 -0
- data/sorbet/rbi/gems/listen@3.7.0.rbi +476 -0
- data/sorbet/rbi/gems/lumberjack@1.2.8.rbi +8 -0
- data/sorbet/rbi/gems/method_source@1.0.0.rbi +72 -0
- data/sorbet/rbi/gems/minitest@5.14.4.rbi +344 -0
- data/sorbet/rbi/gems/multipart-post@2.1.1.rbi +69 -0
- data/sorbet/rbi/gems/nenv@0.3.0.rbi +8 -0
- data/sorbet/rbi/gems/nokogiri@1.12.3.rbi +8 -0
- data/sorbet/rbi/gems/notiffany@0.1.3.rbi +8 -0
- data/sorbet/rbi/gems/overcommit@0.58.0.rbi +8 -0
- data/sorbet/rbi/gems/parallel@1.20.1.rbi +8 -0
- data/sorbet/rbi/gems/parlour@6.0.1.rbi +1610 -0
- data/sorbet/rbi/gems/parser@3.0.2.0.rbi +1731 -0
- data/sorbet/rbi/gems/prettier@1.6.1.rbi +8 -0
- data/sorbet/rbi/gems/pry-byebug@3.9.0.rbi +461 -0
- data/sorbet/rbi/gems/pry@0.13.1.rbi +2553 -0
- data/sorbet/rbi/gems/racc@1.5.2.rbi +47 -0
- data/sorbet/rbi/gems/rainbow@3.0.0.rbi +153 -0
- data/sorbet/rbi/gems/rake@13.0.6.rbi +807 -0
- data/sorbet/rbi/gems/rb-fsevent@0.11.0.rbi +8 -0
- data/sorbet/rbi/gems/rb-inotify@0.10.1.rbi +8 -0
- data/sorbet/rbi/gems/regexp_parser@2.1.1.rbi +8 -0
- data/sorbet/rbi/gems/reverse_markdown@2.0.0.rbi +8 -0
- data/sorbet/rbi/gems/rexml@3.2.5.rbi +672 -0
- data/sorbet/rbi/gems/rspec-core@3.10.1.rbi +2500 -0
- data/sorbet/rbi/gems/rspec-expectations@3.10.1.rbi +1574 -0
- data/sorbet/rbi/gems/rspec-mocks@3.10.2.rbi +1462 -0
- data/sorbet/rbi/gems/rspec-support@3.10.2.rbi +510 -0
- data/sorbet/rbi/gems/rspec@3.10.0.rbi +39 -0
- data/sorbet/rbi/gems/rspec_in_context@1.1.0.3.rbi +196 -0
- data/sorbet/rbi/gems/rubocop-ast@1.11.0.rbi +8 -0
- data/sorbet/rbi/gems/rubocop-faker@1.1.0.rbi +8 -0
- data/sorbet/rbi/gems/rubocop-performance@1.11.5.rbi +8 -0
- data/sorbet/rbi/gems/rubocop-sorbet@0.6.2.rbi +8 -0
- data/sorbet/rbi/gems/rubocop@1.20.0.rbi +8 -0
- data/sorbet/rbi/gems/ruby-progressbar@1.11.0.rbi +8 -0
- data/sorbet/rbi/gems/ruby2_keywords@0.0.5.rbi +8 -0
- data/sorbet/rbi/gems/shellany@0.0.1.rbi +8 -0
- data/sorbet/rbi/gems/simplecov-html@0.12.3.rbi +89 -0
- data/sorbet/rbi/gems/simplecov@0.21.2.rbi +577 -0
- data/sorbet/rbi/gems/simplecov_json_formatter@0.1.3.rbi +8 -0
- data/sorbet/rbi/gems/solargraph@0.43.0.rbi +8 -0
- data/sorbet/rbi/gems/spoom@1.1.2.rbi +1204 -0
- data/sorbet/rbi/gems/tapioca@0.4.25.rbi +1239 -0
- data/sorbet/rbi/gems/temple@0.8.2.rbi +8 -0
- data/sorbet/rbi/gems/thor@1.1.0.rbi +838 -0
- data/sorbet/rbi/gems/tilt@2.0.10.rbi +8 -0
- data/sorbet/rbi/gems/timecop@0.9.4.rbi +82 -0
- data/sorbet/rbi/gems/tzinfo@2.0.4.rbi +857 -0
- data/sorbet/rbi/gems/unicode-display_width@2.0.0.rbi +8 -0
- data/sorbet/rbi/gems/unparser@0.6.0.rbi +8 -0
- data/sorbet/rbi/gems/vcr@6.0.0.rbi +782 -0
- data/sorbet/rbi/gems/yard-sorbet@0.5.3.rbi +8 -0
- data/sorbet/rbi/gems/yard@0.9.26.rbi +8 -0
- data/sorbet/rbi/gems/zeitwerk@2.4.2.rbi +173 -0
- data/sorbet/tapioca/config +0 -0
- data/sorbet/tapioca/require.rb +5 -0
- metadata +144 -127
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 9c75a790bf6a5bcafd7ecae41e3027099ef522fe1a4dcc8d907857f21a40e5ef
|
4
|
+
data.tar.gz: 3b0741ffcad53db13e7d9327219ae6ead229a01c58db869cd7dc37a1546a5c16
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 63122cb395863f20ae9e3bdb2812cc6c710778e84bd059ddc79d38c87d3e68df31adc3e07ef07db8d451093848e6f4602c69006c2d3ea888b4cac0f6b2f926c0
|
7
|
+
data.tar.gz: a1c1d4227bad34da46580b62f8a6f891d261ab71bd84fa12117e0d188460780144182dd0f8d9eff7e3ce3f7c9f56d4273b9f2e7079834ae8b0a0ca6dc452b42b
|
data/.gitignore
CHANGED
data/.overcommit.yml
CHANGED
@@ -9,6 +9,12 @@ PreCommit:
|
|
9
9
|
Prettier:
|
10
10
|
enabled: true
|
11
11
|
required_executable: './bin/prettirun'
|
12
|
+
Sorbet:
|
13
|
+
enabled: true
|
14
|
+
required_executable: './bin/sorbet_check'
|
15
|
+
Documentation:
|
16
|
+
enabled: true
|
17
|
+
required_executable: './bin/generate_and_add_documentation'
|
12
18
|
PrePush:
|
13
19
|
RSpec:
|
14
20
|
enabled: true
|
@@ -19,3 +25,6 @@ PrePush:
|
|
19
25
|
Rubocop:
|
20
26
|
enabled: true
|
21
27
|
required_executable: './bin/ruborun'
|
28
|
+
Sorbet:
|
29
|
+
enabled: true
|
30
|
+
required_executable: './bin/sorbet_check'
|
data/.rubocop.yml
CHANGED
data/CHANGELOG.md
CHANGED
@@ -6,10 +6,19 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
|
6
6
|
|
7
7
|
## [Unreleased]
|
8
8
|
|
9
|
+
## [0.2.0.1] - 2021-10-12
|
10
|
+
### Changed
|
11
|
+
- Fixing Rubocop
|
12
|
+
|
13
|
+
## [0.2.0] - 2021-08-27
|
14
|
+
### Added
|
15
|
+
- Adding Sorbet
|
16
|
+
|
9
17
|
## [0.1.3.3] - 2021-08-28
|
10
18
|
### Added
|
11
19
|
- Issue default format
|
12
20
|
|
21
|
+
|
13
22
|
## [0.1.3.2] - 2021-08-24
|
14
23
|
### Added
|
15
24
|
- Code Of Conduct
|
@@ -67,7 +76,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
|
67
76
|
- Entities: delete
|
68
77
|
- Entities: revive
|
69
78
|
|
70
|
-
[Unreleased]: https://github.com/shotgunsoftware/shotgrid_api_ruby/compare/v0.
|
79
|
+
[Unreleased]: https://github.com/shotgunsoftware/shotgrid_api_ruby/compare/v0.2.0...HEAD
|
80
|
+
[0.2.0]: https://github.com/shotgunsoftware/shotgrid_api_ruby/releases/tag/v0.2.0
|
71
81
|
[0.1.3.3]: https://github.com/shotgunsoftware/shotgrid_api_ruby/releases/tag/v0.1.3.3
|
72
82
|
[0.1.3.2]: https://github.com/shotgunsoftware/shotgrid_api_ruby/releases/tag/v0.1.3.2
|
73
83
|
[0.1.3.1]: https://github.com/shotgunsoftware/shotgrid_api_ruby/releases/tag/v0.1.3.1
|
data/Gemfile
CHANGED
@@ -2,5 +2,23 @@
|
|
2
2
|
|
3
3
|
source 'https://rubygems.org'
|
4
4
|
|
5
|
+
group :development do
|
6
|
+
gem 'bundler-audit', '> 0.6.0', require: false
|
7
|
+
gem 'guard-rspec', require: false
|
8
|
+
gem 'haml', require: false
|
9
|
+
gem 'overcommit', require: false
|
10
|
+
gem 'prettier', require: false
|
11
|
+
gem 'rubocop', '> 0.58', require: false
|
12
|
+
gem 'rubocop-faker', require: false
|
13
|
+
gem 'rubocop-performance', require: false
|
14
|
+
gem 'rubocop-sorbet', require: false
|
15
|
+
gem 'solargraph', require: false
|
16
|
+
gem 'sorbet', require: false
|
17
|
+
gem 'tapioca', require: false
|
18
|
+
gem 'unparser', require: false
|
19
|
+
gem 'yard', require: false
|
20
|
+
gem 'yard-sorbet', require: false
|
21
|
+
end
|
22
|
+
|
5
23
|
# Specify your gem's dependencies in shotgrid_api_ruby.gemspec
|
6
24
|
gemspec
|
data/Guardfile
CHANGED
@@ -26,8 +26,8 @@
|
|
26
26
|
# * zeus: 'zeus rspec' (requires the server to be started separately)
|
27
27
|
# * 'just' rspec: 'rspec'
|
28
28
|
|
29
|
-
guard :rspec, cmd:
|
30
|
-
require
|
29
|
+
guard :rspec, cmd: 'bundle exec rspec' do
|
30
|
+
require 'guard/rspec/dsl'
|
31
31
|
dsl = Guard::RSpec::Dsl.new(self)
|
32
32
|
|
33
33
|
# Feel free to open issues for suggestions and improvements
|
@@ -0,0 +1 @@
|
|
1
|
+
yard doc --plugin sorbet -o docs && git add -f docs
|
data/bin/prettirun
CHANGED
@@ -1 +1 @@
|
|
1
|
-
yarn prettier -c './**/*.rb'
|
1
|
+
yarn prettier -c './**/*.rb' Guardfile Rakefile *.gemspec Gemfile
|
data/bin/sorbet_check
ADDED
@@ -0,0 +1 @@
|
|
1
|
+
bundle exec srb tc
|
data/bin/tapioca
ADDED
@@ -0,0 +1,29 @@
|
|
1
|
+
#!/usr/bin/env ruby
|
2
|
+
# frozen_string_literal: true
|
3
|
+
|
4
|
+
#
|
5
|
+
# This file was generated by Bundler.
|
6
|
+
#
|
7
|
+
# The application 'tapioca' is installed as part of a gem, and
|
8
|
+
# this file is here to facilitate running it.
|
9
|
+
#
|
10
|
+
|
11
|
+
require "pathname"
|
12
|
+
ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
|
13
|
+
Pathname.new(__FILE__).realpath)
|
14
|
+
|
15
|
+
bundle_binstub = File.expand_path("../bundle", __FILE__)
|
16
|
+
|
17
|
+
if File.file?(bundle_binstub)
|
18
|
+
if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
|
19
|
+
load(bundle_binstub)
|
20
|
+
else
|
21
|
+
abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
|
22
|
+
Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
|
23
|
+
end
|
24
|
+
end
|
25
|
+
|
26
|
+
require "rubygems"
|
27
|
+
require "bundler/setup"
|
28
|
+
|
29
|
+
load Gem.bin_path("tapioca", "tapioca")
|
@@ -0,0 +1,319 @@
|
|
1
|
+
<!DOCTYPE html>
|
2
|
+
<html>
|
3
|
+
<head>
|
4
|
+
<meta charset="utf-8">
|
5
|
+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
6
|
+
<title>
|
7
|
+
Module: ShotgridApiRuby::Auth::Validator
|
8
|
+
|
9
|
+
— Documentation by YARD 0.9.26
|
10
|
+
|
11
|
+
</title>
|
12
|
+
|
13
|
+
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
|
14
|
+
|
15
|
+
<link rel="stylesheet" href="../../css/common.css" type="text/css" />
|
16
|
+
|
17
|
+
<script type="text/javascript">
|
18
|
+
pathId = "ShotgridApiRuby::Auth::Validator";
|
19
|
+
relpath = '../../';
|
20
|
+
</script>
|
21
|
+
|
22
|
+
|
23
|
+
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
|
24
|
+
|
25
|
+
<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
|
26
|
+
|
27
|
+
|
28
|
+
</head>
|
29
|
+
<body>
|
30
|
+
<div class="nav_wrap">
|
31
|
+
<iframe id="nav" src="../../class_list.html?1"></iframe>
|
32
|
+
<div id="resizer"></div>
|
33
|
+
</div>
|
34
|
+
|
35
|
+
<div id="main" tabindex="-1">
|
36
|
+
<div id="header">
|
37
|
+
<div id="menu">
|
38
|
+
|
39
|
+
<a href="../../_index.html">Index (V)</a> »
|
40
|
+
<span class='title'><span class='object_link'><a href="../../ShotgridApiRuby.html" title="ShotgridApiRuby (module)">ShotgridApiRuby</a></span></span> » <span class='title'><span class='object_link'><a href="../Auth.html" title="ShotgridApiRuby::Auth (class)">Auth</a></span></span>
|
41
|
+
»
|
42
|
+
<span class="title">Validator</span>
|
43
|
+
|
44
|
+
</div>
|
45
|
+
|
46
|
+
<div id="search">
|
47
|
+
|
48
|
+
<a class="full_list_link" id="class_list_link"
|
49
|
+
href="../../class_list.html">
|
50
|
+
|
51
|
+
<svg width="24" height="24">
|
52
|
+
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
|
53
|
+
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
|
54
|
+
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
|
55
|
+
</svg>
|
56
|
+
</a>
|
57
|
+
|
58
|
+
</div>
|
59
|
+
<div class="clear"></div>
|
60
|
+
</div>
|
61
|
+
|
62
|
+
<div id="content"><h1>Module: ShotgridApiRuby::Auth::Validator
|
63
|
+
|
64
|
+
|
65
|
+
|
66
|
+
</h1>
|
67
|
+
<div class="box_info">
|
68
|
+
|
69
|
+
|
70
|
+
|
71
|
+
|
72
|
+
<dl>
|
73
|
+
<dt>Extended by:</dt>
|
74
|
+
<dd>T::Sig</dd>
|
75
|
+
</dl>
|
76
|
+
|
77
|
+
|
78
|
+
|
79
|
+
|
80
|
+
|
81
|
+
|
82
|
+
|
83
|
+
|
84
|
+
<dl>
|
85
|
+
<dt>Defined in:</dt>
|
86
|
+
<dd>lib/shotgrid_api_ruby/auth.rb</dd>
|
87
|
+
</dl>
|
88
|
+
|
89
|
+
</div>
|
90
|
+
|
91
|
+
<h2>Overview</h2><div class="docstring">
|
92
|
+
<div class="discussion">
|
93
|
+
|
94
|
+
<p>Validate auth parameters format</p>
|
95
|
+
|
96
|
+
|
97
|
+
</div>
|
98
|
+
</div>
|
99
|
+
<div class="tags">
|
100
|
+
|
101
|
+
|
102
|
+
</div>
|
103
|
+
|
104
|
+
|
105
|
+
|
106
|
+
|
107
|
+
|
108
|
+
|
109
|
+
|
110
|
+
<h2>
|
111
|
+
Class Method Summary
|
112
|
+
<small><a href="#" class="summary_toggle">collapse</a></small>
|
113
|
+
</h2>
|
114
|
+
|
115
|
+
<ul class="summary">
|
116
|
+
|
117
|
+
<li class="public ">
|
118
|
+
<span class="summary_signature">
|
119
|
+
|
120
|
+
<a href="#valid%3F-class_method" title="valid? (class method)">.<strong>valid?</strong>(client_id: nil, client_secret: nil, username: nil, password: nil, session_token: nil, refresh_token: nil) ⇒ Boolean </a>
|
121
|
+
|
122
|
+
|
123
|
+
|
124
|
+
</span>
|
125
|
+
|
126
|
+
|
127
|
+
|
128
|
+
|
129
|
+
|
130
|
+
|
131
|
+
|
132
|
+
|
133
|
+
|
134
|
+
<span class="summary_desc"><div class='inline'>
|
135
|
+
<p>Validate auth parameters format.</p>
|
136
|
+
</div></span>
|
137
|
+
|
138
|
+
</li>
|
139
|
+
|
140
|
+
|
141
|
+
</ul>
|
142
|
+
|
143
|
+
|
144
|
+
|
145
|
+
|
146
|
+
|
147
|
+
<div id="class_method_details" class="method_details_list">
|
148
|
+
<h2>Class Method Details</h2>
|
149
|
+
|
150
|
+
|
151
|
+
<div class="method_details first">
|
152
|
+
<h3 class="signature first" id="valid?-class_method">
|
153
|
+
|
154
|
+
.<strong>valid?</strong>(client_id: nil, client_secret: nil, username: nil, password: nil, session_token: nil, refresh_token: nil) ⇒ <tt>Boolean</tt>
|
155
|
+
|
156
|
+
|
157
|
+
|
158
|
+
|
159
|
+
|
160
|
+
</h3><div class="docstring">
|
161
|
+
<div class="discussion">
|
162
|
+
|
163
|
+
<p>Validate auth parameters format</p>
|
164
|
+
|
165
|
+
|
166
|
+
</div>
|
167
|
+
</div>
|
168
|
+
<div class="tags">
|
169
|
+
<p class="tag_title">Parameters:</p>
|
170
|
+
<ul class="param">
|
171
|
+
|
172
|
+
<li>
|
173
|
+
|
174
|
+
<span class='name'>client_id</span>
|
175
|
+
|
176
|
+
|
177
|
+
<span class='type'>(<tt>String</tt>, <tt>nil</tt>)</span>
|
178
|
+
|
179
|
+
|
180
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
181
|
+
|
182
|
+
|
183
|
+
</li>
|
184
|
+
|
185
|
+
<li>
|
186
|
+
|
187
|
+
<span class='name'>client_secret</span>
|
188
|
+
|
189
|
+
|
190
|
+
<span class='type'>(<tt>String</tt>, <tt>nil</tt>)</span>
|
191
|
+
|
192
|
+
|
193
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
194
|
+
|
195
|
+
|
196
|
+
</li>
|
197
|
+
|
198
|
+
<li>
|
199
|
+
|
200
|
+
<span class='name'>username</span>
|
201
|
+
|
202
|
+
|
203
|
+
<span class='type'>(<tt>String</tt>, <tt>nil</tt>)</span>
|
204
|
+
|
205
|
+
|
206
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
207
|
+
|
208
|
+
|
209
|
+
</li>
|
210
|
+
|
211
|
+
<li>
|
212
|
+
|
213
|
+
<span class='name'>password</span>
|
214
|
+
|
215
|
+
|
216
|
+
<span class='type'>(<tt>String</tt>, <tt>nil</tt>)</span>
|
217
|
+
|
218
|
+
|
219
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
220
|
+
|
221
|
+
|
222
|
+
</li>
|
223
|
+
|
224
|
+
<li>
|
225
|
+
|
226
|
+
<span class='name'>session_token</span>
|
227
|
+
|
228
|
+
|
229
|
+
<span class='type'>(<tt>String</tt>, <tt>nil</tt>)</span>
|
230
|
+
|
231
|
+
|
232
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
233
|
+
|
234
|
+
|
235
|
+
</li>
|
236
|
+
|
237
|
+
<li>
|
238
|
+
|
239
|
+
<span class='name'>refresh_token</span>
|
240
|
+
|
241
|
+
|
242
|
+
<span class='type'>(<tt>String</tt>, <tt>nil</tt>)</span>
|
243
|
+
|
244
|
+
|
245
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
246
|
+
|
247
|
+
|
248
|
+
</li>
|
249
|
+
|
250
|
+
</ul>
|
251
|
+
|
252
|
+
<p class="tag_title">Returns:</p>
|
253
|
+
<ul class="return">
|
254
|
+
|
255
|
+
<li>
|
256
|
+
|
257
|
+
|
258
|
+
<span class='type'>(<tt>Boolean</tt>)</span>
|
259
|
+
|
260
|
+
|
261
|
+
|
262
|
+
</li>
|
263
|
+
|
264
|
+
</ul>
|
265
|
+
|
266
|
+
</div><table class="source_code">
|
267
|
+
<tr>
|
268
|
+
<td>
|
269
|
+
<pre class="lines">
|
270
|
+
|
271
|
+
|
272
|
+
26
|
273
|
+
27
|
274
|
+
28
|
275
|
+
29
|
276
|
+
30
|
277
|
+
31
|
278
|
+
32
|
279
|
+
33
|
280
|
+
34
|
281
|
+
35
|
282
|
+
36
|
283
|
+
37
|
284
|
+
38</pre>
|
285
|
+
</td>
|
286
|
+
<td>
|
287
|
+
<pre class="code"><span class="info file"># File 'lib/shotgrid_api_ruby/auth.rb', line 26</span>
|
288
|
+
|
289
|
+
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_valid?'>valid?</span><span class='lparen'>(</span>
|
290
|
+
<span class='label'>client_id:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
291
|
+
<span class='label'>client_secret:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
292
|
+
<span class='label'>username:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
293
|
+
<span class='label'>password:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
294
|
+
<span class='label'>session_token:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
295
|
+
<span class='label'>refresh_token:</span> <span class='kw'>nil</span>
|
296
|
+
<span class='rparen'>)</span>
|
297
|
+
<span class='op'>!</span><span class='op'>!</span><span class='lparen'>(</span>
|
298
|
+
<span class='lparen'>(</span><span class='id identifier rubyid_client_id'>client_id</span> <span class='op'>&&</span> <span class='id identifier rubyid_client_secret'>client_secret</span><span class='rparen'>)</span> <span class='op'>||</span> <span class='lparen'>(</span><span class='id identifier rubyid_password'>password</span> <span class='op'>&&</span> <span class='id identifier rubyid_username'>username</span><span class='rparen'>)</span> <span class='op'>||</span>
|
299
|
+
<span class='id identifier rubyid_session_token'>session_token</span> <span class='op'>||</span> <span class='id identifier rubyid_refresh_token'>refresh_token</span>
|
300
|
+
<span class='rparen'>)</span>
|
301
|
+
<span class='kw'>end</span></pre>
|
302
|
+
</td>
|
303
|
+
</tr>
|
304
|
+
</table>
|
305
|
+
</div>
|
306
|
+
|
307
|
+
</div>
|
308
|
+
|
309
|
+
</div>
|
310
|
+
|
311
|
+
<div id="footer">
|
312
|
+
Generated on Tue Oct 12 21:57:54 2021 by
|
313
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
314
|
+
0.9.26 (ruby-3.0.2).
|
315
|
+
</div>
|
316
|
+
|
317
|
+
</div>
|
318
|
+
</body>
|
319
|
+
</html>
|