shotgrid_api_ruby 0.1.3.3 → 0.2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b3d22a3f63c6e1fcccbce5467741ccea7df6d21c596beceadb41d97a728b23ee
-  data.tar.gz: cb1b8029e0da53a7c134101f8a2ec50ec64d898f63a106a8c7d1f063d58ab00e
+  metadata.gz: 9c75a790bf6a5bcafd7ecae41e3027099ef522fe1a4dcc8d907857f21a40e5ef
+  data.tar.gz: 3b0741ffcad53db13e7d9327219ae6ead229a01c58db869cd7dc37a1546a5c16
 SHA512:
-  metadata.gz: 1a21da51ac645ddfd6e047554ee2539252f3b57c933a347a837b610b444c206cfec494d835159fa569243caffb9d08395bd1abd29821705183e060c12e0e54a1
-  data.tar.gz: a16b118eab23a178c324a3bae810965de85c4beb6c0dcb3e1486cd93bb410daa358a2990ccfc73eb835eca5834e2d427d436892df3426014b9cb22d208d29f25
+  metadata.gz: 63122cb395863f20ae9e3bdb2812cc6c710778e84bd059ddc79d38c87d3e68df31adc3e07ef07db8d451093848e6f4602c69006c2d3ea888b4cac0f6b2f926c0
+  data.tar.gz: a1c1d4227bad34da46580b62f8a6f891d261ab71bd84fa12117e0d188460780144182dd0f8d9eff7e3ce3f7c9f56d4273b9f2e7079834ae8b0a0ca6dc452b42b

data/.github/workflows/test_and_publish.yml

@@ -23,6 +23,8 @@ jobs:
         run: bundle exec rubocop
       - name: Run tests
         run: bundle exec rspec
+      - name: Run type checking (Sorbet)
+        run: bundle exec srb tc
   prettier:
     runs-on: ubuntu-latest
     steps:

data/.github/workflows/test_only.yml

@@ -23,6 +23,8 @@ jobs:
         run: bundle exec rubocop
       - name: Run tests
         run: bundle exec rspec
+      - name: Run type checking (Sorbet)
+        run: bundle exec srb tc
   prettier:
     runs-on: ubuntu-latest
     steps:

data/.gitignore

@@ -12,3 +12,6 @@
 .env
 Gemfile.lock
 Gemfile.lock
+docs
+spoom_report.html
+spoom_data

data/.overcommit.yml

@@ -9,6 +9,12 @@ PreCommit:
   Prettier:
     enabled: true
     required_executable: './bin/prettirun'
+  Sorbet:
+    enabled: true
+    required_executable: './bin/sorbet_check'
+  Documentation:
+    enabled: true
+    required_executable: './bin/generate_and_add_documentation'
 PrePush:
   RSpec:
     enabled: true
@@ -19,3 +25,6 @@ PrePush:
   Rubocop:
     enabled: true
     required_executable: './bin/ruborun'
+  Sorbet:
+    enabled: true
+    required_executable: './bin/sorbet_check'

data/.rubocop.yml

@@ -5,7 +5,9 @@ inherit_gem:
   prettier: rubocop.yml
 
 require:
+  - rubocop-faker
   - rubocop-performance
+  - rubocop-sorbet
 
 AllCops:
   NewCops: enable

data/CHANGELOG.md

@@ -6,10 +6,19 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.2.0.1] - 2021-10-12
+### Changed
+- Fixing Rubocop
+
+## [0.2.0] - 2021-08-27
+### Added
+- Adding Sorbet
+
 ## [0.1.3.3] - 2021-08-28
 ### Added
 - Issue default format
 
+
 ## [0.1.3.2] - 2021-08-24
 ### Added
 - Code Of Conduct
@@ -67,7 +76,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Entities: delete
 - Entities: revive
 
-[Unreleased]: https://github.com/shotgunsoftware/shotgrid_api_ruby/compare/v0.1.3.3...HEAD
+[Unreleased]: https://github.com/shotgunsoftware/shotgrid_api_ruby/compare/v0.2.0...HEAD
+[0.2.0]: https://github.com/shotgunsoftware/shotgrid_api_ruby/releases/tag/v0.2.0
 [0.1.3.3]: https://github.com/shotgunsoftware/shotgrid_api_ruby/releases/tag/v0.1.3.3
 [0.1.3.2]: https://github.com/shotgunsoftware/shotgrid_api_ruby/releases/tag/v0.1.3.2
 [0.1.3.1]: https://github.com/shotgunsoftware/shotgrid_api_ruby/releases/tag/v0.1.3.1

data/Gemfile

@@ -2,5 +2,23 @@
 
 source 'https://rubygems.org'
 
+group :development do
+  gem 'bundler-audit', '> 0.6.0', require: false
+  gem 'guard-rspec', require: false
+  gem 'haml', require: false
+  gem 'overcommit', require: false
+  gem 'prettier', require: false
+  gem 'rubocop', '> 0.58', require: false
+  gem 'rubocop-faker', require: false
+  gem 'rubocop-performance', require: false
+  gem 'rubocop-sorbet', require: false
+  gem 'solargraph', require: false
+  gem 'sorbet', require: false
+  gem 'tapioca', require: false
+  gem 'unparser', require: false
+  gem 'yard', require: false
+  gem 'yard-sorbet', require: false
+end
+
 # Specify your gem's dependencies in shotgrid_api_ruby.gemspec
 gemspec

data/Guardfile

@@ -26,8 +26,8 @@
 #  * zeus: 'zeus rspec' (requires the server to be started separately)
 #  * 'just' rspec: 'rspec'
 
-guard :rspec, cmd: "bundle exec rspec" do
-  require "guard/rspec/dsl"
+guard :rspec, cmd: 'bundle exec rspec' do
+  require 'guard/rspec/dsl'
   dsl = Guard::RSpec::Dsl.new(self)
 
   # Feel free to open issues for suggestions and improvements

data/bin/generate_and_add_documentation

@@ -0,0 +1 @@
+yard doc --plugin sorbet -o docs && git add -f docs

data/bin/generate_sorbet_coverage

@@ -0,0 +1,3 @@
+bundle exec spoom coverage timeline --from=2021-08-26 --save && \
+  bundle exec spoom coverage report && \
+  bundle exec spoom coverage open

data/bin/prettirun

@@ -1 +1 @@
-yarn prettier -c './**/*.rb'
+yarn prettier -c './**/*.rb' Guardfile Rakefile *.gemspec Gemfile

data/bin/sorbet_check

@@ -0,0 +1 @@
+bundle exec srb tc

data/bin/tapioca

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'tapioca' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("tapioca", "tapioca")

data/docs/ShotgridApiRuby/Auth/Validator.html

@@ -0,0 +1,319 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1.0">
+<title>
+  Module: ShotgridApiRuby::Auth::Validator
+  
+    &mdash; Documentation by YARD 0.9.26
+  
+</title>
+
+  <link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+  <link rel="stylesheet" href="../../css/common.css" type="text/css" />
+
+<script type="text/javascript">
+  pathId = "ShotgridApiRuby::Auth::Validator";
+  relpath = '../../';
+</script>
+
+
+  <script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+  <script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+
+  </head>
+  <body>
+    <div class="nav_wrap">
+      <iframe id="nav" src="../../class_list.html?1"></iframe>
+      <div id="resizer"></div>
+    </div>
+
+    <div id="main" tabindex="-1">
+      <div id="header">
+        <div id="menu">
+  
+    <a href="../../_index.html">Index (V)</a> &raquo;
+    <span class='title'><span class='object_link'><a href="../../ShotgridApiRuby.html" title="ShotgridApiRuby (module)">ShotgridApiRuby</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Auth.html" title="ShotgridApiRuby::Auth (class)">Auth</a></span></span>
+     &raquo; 
+    <span class="title">Validator</span>
+  
+</div>
+
+        <div id="search">
+  
+    <a class="full_list_link" id="class_list_link"
+        href="../../class_list.html">
+
+        <svg width="24" height="24">
+          <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+        </svg>
+    </a>
+  
+</div>
+        <div class="clear"></div>
+      </div>
+
+      <div id="content"><h1>Module: ShotgridApiRuby::Auth::Validator
+  
+  
+  
+</h1>
+<div class="box_info">
+  
+
+  
+  
+  <dl>
+      <dt>Extended by:</dt>
+      <dd>T::Sig</dd>
+  </dl>
+  
+  
+  
+  
+
+  
+
+  
+  <dl>
+    <dt>Defined in:</dt>
+    <dd>lib/shotgrid_api_ruby/auth.rb</dd>
+  </dl>
+  
+</div>
+
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+    
+<p>Validate auth parameters format</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+
+</div>
+
+
+
+
+
+
+  
+    <h2>
+      Class Method Summary
+      <small><a href="#" class="summary_toggle">collapse</a></small>
+    </h2>
+
+    <ul class="summary">
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <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)  &#x21d2; Boolean </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'>
+<p>Validate auth parameters format.</p>
+</div></span>
+  
+</li>
+
+      
+    </ul>
+  
+
+
+  
+
+  <div id="class_method_details" class="method_details_list">
+    <h2>Class Method Details</h2>
+
+    
+      <div class="method_details first">
+  <h3 class="signature first" id="valid?-class_method">
+  
+    .<strong>valid?</strong>(client_id: nil, client_secret: nil, username: nil, password: nil, session_token: nil, refresh_token: nil)  &#x21d2; <tt>Boolean</tt> 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    
+<p>Validate auth parameters format</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+  
+    <li>
+      
+        <span class='name'>client_id</span>
+      
+      
+        <span class='type'>(<tt>String</tt>, <tt>nil</tt>)</span>
+      
+      
+        <em class="default">(defaults to: <tt>nil</tt>)</em>
+      
+      
+    </li>
+  
+    <li>
+      
+        <span class='name'>client_secret</span>
+      
+      
+        <span class='type'>(<tt>String</tt>, <tt>nil</tt>)</span>
+      
+      
+        <em class="default">(defaults to: <tt>nil</tt>)</em>
+      
+      
+    </li>
+  
+    <li>
+      
+        <span class='name'>username</span>
+      
+      
+        <span class='type'>(<tt>String</tt>, <tt>nil</tt>)</span>
+      
+      
+        <em class="default">(defaults to: <tt>nil</tt>)</em>
+      
+      
+    </li>
+  
+    <li>
+      
+        <span class='name'>password</span>
+      
+      
+        <span class='type'>(<tt>String</tt>, <tt>nil</tt>)</span>
+      
+      
+        <em class="default">(defaults to: <tt>nil</tt>)</em>
+      
+      
+    </li>
+  
+    <li>
+      
+        <span class='name'>session_token</span>
+      
+      
+        <span class='type'>(<tt>String</tt>, <tt>nil</tt>)</span>
+      
+      
+        <em class="default">(defaults to: <tt>nil</tt>)</em>
+      
+      
+    </li>
+  
+    <li>
+      
+        <span class='name'>refresh_token</span>
+      
+      
+        <span class='type'>(<tt>String</tt>, <tt>nil</tt>)</span>
+      
+      
+        <em class="default">(defaults to: <tt>nil</tt>)</em>
+      
+      
+    </li>
+  
+</ul>
+
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt>Boolean</tt>)</span>
+      
+      
+      
+    </li>
+  
+</ul>
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+26
+27
+28
+29
+30
+31
+32
+33
+34
+35
+36
+37
+38</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/shotgrid_api_ruby/auth.rb', line 26</span>
+
+<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>
+  <span class='label'>client_id:</span> <span class='kw'>nil</span><span class='comma'>,</span>
+  <span class='label'>client_secret:</span> <span class='kw'>nil</span><span class='comma'>,</span>
+  <span class='label'>username:</span> <span class='kw'>nil</span><span class='comma'>,</span>
+  <span class='label'>password:</span> <span class='kw'>nil</span><span class='comma'>,</span>
+  <span class='label'>session_token:</span> <span class='kw'>nil</span><span class='comma'>,</span>
+  <span class='label'>refresh_token:</span> <span class='kw'>nil</span>
+<span class='rparen'>)</span>
+  <span class='op'>!</span><span class='op'>!</span><span class='lparen'>(</span>
+    <span class='lparen'>(</span><span class='id identifier rubyid_client_id'>client_id</span> <span class='op'>&amp;&amp;</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'>&amp;&amp;</span> <span class='id identifier rubyid_username'>username</span><span class='rparen'>)</span> <span class='op'>||</span>
+      <span class='id identifier rubyid_session_token'>session_token</span> <span class='op'>||</span> <span class='id identifier rubyid_refresh_token'>refresh_token</span>
+  <span class='rparen'>)</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+  </div>
+
+</div>
+
+      <div id="footer">
+  Generated on Tue Oct 12 21:57:54 2021 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.9.26 (ruby-3.0.2).
+</div>
+
+    </div>
+  </body>
+</html>