shotgrid_api_ruby 0.1.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (38) hide show
  1. checksums.yaml +7 -0
  2. data/.github/workflows/test_and_publish.yml +58 -0
  3. data/.github/workflows/test_only.yml +37 -0
  4. data/.github/workflows/verify_version_change.yml +21 -0
  5. data/.gitignore +14 -0
  6. data/.overcommit.yml +21 -0
  7. data/.prettierrc.js +4 -0
  8. data/.rspec +3 -0
  9. data/.rubocop-http---relaxed-ruby-style-rubocop-yml +153 -0
  10. data/.rubocop.yml +33 -0
  11. data/.ruby-gemset +1 -0
  12. data/.ruby-version +1 -0
  13. data/.travis.yml +7 -0
  14. data/CHANGELOG.md +61 -0
  15. data/Gemfile +6 -0
  16. data/Guardfile +47 -0
  17. data/LICENSE.txt +21 -0
  18. data/README.md +470 -0
  19. data/Rakefile +3 -0
  20. data/bin/console +48 -0
  21. data/bin/prettirun +1 -0
  22. data/bin/ruborun +1 -0
  23. data/bin/setup +7 -0
  24. data/lib/shotgrid_api_ruby.rb +19 -0
  25. data/lib/shotgrid_api_ruby/auth.rb +124 -0
  26. data/lib/shotgrid_api_ruby/client.rb +79 -0
  27. data/lib/shotgrid_api_ruby/entities.rb +281 -0
  28. data/lib/shotgrid_api_ruby/entities/params.rb +182 -0
  29. data/lib/shotgrid_api_ruby/entities/schema.rb +50 -0
  30. data/lib/shotgrid_api_ruby/entities/summarize.rb +64 -0
  31. data/lib/shotgrid_api_ruby/entity.rb +20 -0
  32. data/lib/shotgrid_api_ruby/preferences.rb +24 -0
  33. data/lib/shotgrid_api_ruby/server_info.rb +23 -0
  34. data/lib/shotgrid_api_ruby/version.rb +5 -0
  35. data/package.json +12 -0
  36. data/shotgrid_api_ruby.gemspec +59 -0
  37. data/yarn.lock +15 -0
  38. metadata +390 -0
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: ae7b5145a6416248b3b8b1ae1f2fcd0692dffb84223aa4c6862f6f6126df71a4
4
+ data.tar.gz: ce67a7271446889740fa2524085b743a673b49acb8065b3bbc628799478f178d
5
+ SHA512:
6
+ metadata.gz: 1673d552274cfd4eca41511b9cdf9dc7d95e38503cdc8275721e8feb0095226a36091f6b220648ddc1950966e648389e7837b0b585186363818037ed9623dead
7
+ data.tar.gz: 184f9af23a48672125112c10f3d28048e00daa94e22c254c27475a9d7a0e26f41f6ed0b8301e1f79d554ceaabf21c541729b596a88b08580136ec0aacacc89fb
data/.github/workflows/test_and_publish.yml ADDED
@@ -0,0 +1,58 @@
1
+ name: Test and Release
2
+
3
+ on:
4
+ push:
5
+ branches:
6
+ - main
7
+
8
+ jobs:
9
+ tests:
10
+ strategy:
11
+ matrix:
12
+ ruby: [2.6, 2.7, 3.0]
13
+ runs-on: ubuntu-latest
14
+
15
+ steps:
16
+ - uses: actions/checkout@v2
17
+ - name: Set up Ruby
18
+ uses: ruby/setup-ruby@v1
19
+ with:
20
+ ruby-version: ${{ matrix.ruby }}
21
+ bundler-cache: true
22
+ - name: Run linter
23
+ run: bundle exec rubocop
24
+ - name: Run tests
25
+ run: bundle exec rspec
26
+ prettier:
27
+ runs-on: ubuntu-latest
28
+ steps:
29
+ - uses: actions/checkout@v2
30
+ - name: Set up Node
31
+ uses: actions/setup-node@v2
32
+ with:
33
+ node-version: '14'
34
+ - name: Install yarn dep
35
+ run: yarn install
36
+ - name: Check prettier
37
+ run: yarn prettier -c '**/*.rb'
38
+ release:
39
+ needs: [tests, prettier]
40
+ runs-on: ubuntu-latest
41
+
42
+ steps:
43
+ - uses: actions/checkout@v2
44
+ - name: Set up Ruby
45
+ uses: ruby/setup-ruby@v1
46
+ with:
47
+ ruby-version: 3.0
48
+ bundler-cache: true
49
+ - name: Prepare credentials
50
+ env:
51
+ RUBYGEM_KEY: ${{ secrets.RUBYGEM_KEY }}
52
+ run: "mkdir -p ~/.gem && echo -e \"---\\r\\n:rubygems_api_key: $RUBYGEM_KEY\" > ~/.gem/credentials && chmod 0600 ~/.gem/credentials"
53
+ - name: Setup username/email
54
+ run: 'git config --global user.email zaratan@hey.com && git config --global user.name "Denis <Zaratan> Pasin"'
55
+ - name: Fetch tags from remote
56
+ run: 'git fetch -t'
57
+ - name: Publish if version change
58
+ run: 'git diff `git tag | tail -1` -- lib/shotgrid_api_ruby/version.rb | grep -E "^\+.*VERSION" && rake release || echo "No release for now"'
data/.github/workflows/test_only.yml ADDED
@@ -0,0 +1,37 @@
1
+ name: Tests
2
+
3
+ on:
4
+ push:
5
+ branches-ignore:
6
+ - main
7
+
8
+ jobs:
9
+ tests:
10
+ strategy:
11
+ matrix:
12
+ ruby: [2.6, 2.7, 3.0]
13
+ runs-on: ubuntu-latest
14
+
15
+ steps:
16
+ - uses: actions/checkout@v2
17
+ - name: Set up Ruby
18
+ uses: ruby/setup-ruby@v1
19
+ with:
20
+ ruby-version: ${{ matrix.ruby }}
21
+ bundler-cache: true
22
+ - name: Run linter
23
+ run: bundle exec rubocop
24
+ - name: Run tests
25
+ run: bundle exec rspec
26
+ prettier:
27
+ runs-on: ubuntu-latest
28
+ steps:
29
+ - uses: actions/checkout@v2
30
+ - name: Set up Node
31
+ uses: actions/setup-node@v2
32
+ with:
33
+ node-version: '14'
34
+ - name: Install yarn dep
35
+ run: yarn install
36
+ - name: Check prettier
37
+ run: yarn prettier -c '**/*.rb'
data/.github/workflows/verify_version_change.yml ADDED
@@ -0,0 +1,21 @@
1
+ name: Verify version change
2
+
3
+ on:
4
+ pull_request:
5
+ branches:
6
+ - main
7
+
8
+ jobs:
9
+ version_change:
10
+ runs-on: ubuntu-latest
11
+
12
+ steps:
13
+ - uses: actions/checkout@v2
14
+ - name: Fetch main branch
15
+ run: git fetch origin main:main
16
+ - name: Verify if there's a change in version
17
+ run: 'git diff main -- lib/shotgrid_api_ruby/version.rb | grep VERSION'
18
+ - name: Print new version
19
+ run: 'git diff main -- lib/shotgrid_api_ruby/version.rb | grep -E "^\+.*VERSION" | grep -E -o "[0-9]+\.[0-9]+\.[0-9]+(\.[0-9]+)?"'
20
+ - name: Verify if higher version
21
+ run: '[[ $(git diff main -- lib/shotgrid_api_ruby/version.rb | grep -E "^\+.*VERSION" | grep -E -o "[0-9]+\.[0-9]+\.[0-9]+(\.[0-9]+)?") > $(git diff main -- lib/shotgrid_api_ruby/version.rb | grep -E "^-.*VERSION" | grep -E -o "[0-9]+\.[0-9]+\.[0-9]+(\.[0-9]+)?") ]]'
data/.gitignore ADDED
@@ -0,0 +1,14 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /_yardoc/
4
+ /coverage/
5
+ /doc/
6
+ /pkg/
7
+ /spec/reports/
8
+ /tmp/
9
+
10
+ # rspec failure tracking
11
+ .rspec_status
12
+ .env
13
+ Gemfile.lock
14
+ Gemfile.lock
data/.overcommit.yml ADDED
@@ -0,0 +1,21 @@
1
+ PreCommit:
2
+ RuboCop:
3
+ enabled: true
4
+ command: ['bundle', 'exec', 'rubocop'] # Invoke within Bundler context
5
+ BundleOutdated:
6
+ enabled: true
7
+ BundleAudit:
8
+ enabled: true
9
+ Prettier:
10
+ enabled: true
11
+ required_executable: './bin/prettirun'
12
+ PrePush:
13
+ RSpec:
14
+ enabled: true
15
+ command: ['bundle', 'exec', 'rspec', '-f', 'p'] # Invoke within Bundler context
16
+ Prettier:
17
+ enabled: true
18
+ required_executable: './bin/prettirun'
19
+ Rubocop:
20
+ enabled: true
21
+ required_executable: './bin/ruborun'
data/.prettierrc.js ADDED
@@ -0,0 +1,4 @@
1
+ module.exports = {
2
+ trailingComma: "es5",
3
+ singleQuote: true,
4
+ };
data/.rspec ADDED
@@ -0,0 +1,3 @@
1
+ --format documentation
2
+ --color
3
+ --require spec_helper
data/.rubocop-http---relaxed-ruby-style-rubocop-yml ADDED
@@ -0,0 +1,153 @@
1
+ # Relaxed.Ruby.Style
2
+ ## Version 2.5
3
+
4
+ Style/Alias:
5
+ Enabled: false
6
+ StyleGuide: https://relaxed.ruby.style/#stylealias
7
+
8
+ Style/AsciiComments:
9
+ Enabled: false
10
+ StyleGuide: https://relaxed.ruby.style/#styleasciicomments
11
+
12
+ Style/BeginBlock:
13
+ Enabled: false
14
+ StyleGuide: https://relaxed.ruby.style/#stylebeginblock
15
+
16
+ Style/BlockDelimiters:
17
+ Enabled: false
18
+ StyleGuide: https://relaxed.ruby.style/#styleblockdelimiters
19
+
20
+ Style/CommentAnnotation:
21
+ Enabled: false
22
+ StyleGuide: https://relaxed.ruby.style/#stylecommentannotation
23
+
24
+ Style/Documentation:
25
+ Enabled: false
26
+ StyleGuide: https://relaxed.ruby.style/#styledocumentation
27
+
28
+ Layout/DotPosition:
29
+ Enabled: false
30
+ StyleGuide: https://relaxed.ruby.style/#layoutdotposition
31
+
32
+ Style/DoubleNegation:
33
+ Enabled: false
34
+ StyleGuide: https://relaxed.ruby.style/#styledoublenegation
35
+
36
+ Style/EndBlock:
37
+ Enabled: false
38
+ StyleGuide: https://relaxed.ruby.style/#styleendblock
39
+
40
+ Style/FormatString:
41
+ Enabled: false
42
+ StyleGuide: https://relaxed.ruby.style/#styleformatstring
43
+
44
+ Style/IfUnlessModifier:
45
+ Enabled: false
46
+ StyleGuide: https://relaxed.ruby.style/#styleifunlessmodifier
47
+
48
+ Style/Lambda:
49
+ Enabled: false
50
+ StyleGuide: https://relaxed.ruby.style/#stylelambda
51
+
52
+ Style/ModuleFunction:
53
+ Enabled: false
54
+ StyleGuide: https://relaxed.ruby.style/#stylemodulefunction
55
+
56
+ Style/MultilineBlockChain:
57
+ Enabled: false
58
+ StyleGuide: https://relaxed.ruby.style/#stylemultilineblockchain
59
+
60
+ Style/NegatedIf:
61
+ Enabled: false
62
+ StyleGuide: https://relaxed.ruby.style/#stylenegatedif
63
+
64
+ Style/NegatedWhile:
65
+ Enabled: false
66
+ StyleGuide: https://relaxed.ruby.style/#stylenegatedwhile
67
+
68
+ Style/NumericPredicate:
69
+ Enabled: false
70
+ StyleGuide: https://relaxed.ruby.style/#stylenumericpredicate
71
+
72
+ Style/ParallelAssignment:
73
+ Enabled: false
74
+ StyleGuide: https://relaxed.ruby.style/#styleparallelassignment
75
+
76
+ Style/PercentLiteralDelimiters:
77
+ Enabled: false
78
+ StyleGuide: https://relaxed.ruby.style/#stylepercentliteraldelimiters
79
+
80
+ Style/PerlBackrefs:
81
+ Enabled: false
82
+ StyleGuide: https://relaxed.ruby.style/#styleperlbackrefs
83
+
84
+ Style/Semicolon:
85
+ Enabled: false
86
+ StyleGuide: https://relaxed.ruby.style/#stylesemicolon
87
+
88
+ Style/SignalException:
89
+ Enabled: false
90
+ StyleGuide: https://relaxed.ruby.style/#stylesignalexception
91
+
92
+ Style/SingleLineBlockParams:
93
+ Enabled: false
94
+ StyleGuide: https://relaxed.ruby.style/#stylesinglelineblockparams
95
+
96
+ Style/SingleLineMethods:
97
+ Enabled: false
98
+ StyleGuide: https://relaxed.ruby.style/#stylesinglelinemethods
99
+
100
+ Layout/SpaceBeforeBlockBraces:
101
+ Enabled: false
102
+ StyleGuide: https://relaxed.ruby.style/#layoutspacebeforeblockbraces
103
+
104
+ Layout/SpaceInsideParens:
105
+ Enabled: false
106
+ StyleGuide: https://relaxed.ruby.style/#layoutspaceinsideparens
107
+
108
+ Style/SpecialGlobalVars:
109
+ Enabled: false
110
+ StyleGuide: https://relaxed.ruby.style/#stylespecialglobalvars
111
+
112
+ Style/StringLiterals:
113
+ Enabled: false
114
+ StyleGuide: https://relaxed.ruby.style/#stylestringliterals
115
+
116
+ Style/TrailingCommaInArguments:
117
+ Enabled: false
118
+ StyleGuide: https://relaxed.ruby.style/#styletrailingcommainarguments
119
+
120
+ Style/TrailingCommaInArrayLiteral:
121
+ Enabled: false
122
+ StyleGuide: https://relaxed.ruby.style/#styletrailingcommainarrayliteral
123
+
124
+ Style/TrailingCommaInHashLiteral:
125
+ Enabled: false
126
+ StyleGuide: https://relaxed.ruby.style/#styletrailingcommainhashliteral
127
+
128
+ Style/SymbolArray:
129
+ Enabled: false
130
+ StyleGuide: http://relaxed.ruby.style/#stylesymbolarray
131
+
132
+ Style/WhileUntilModifier:
133
+ Enabled: false
134
+ StyleGuide: https://relaxed.ruby.style/#stylewhileuntilmodifier
135
+
136
+ Style/WordArray:
137
+ Enabled: false
138
+ StyleGuide: https://relaxed.ruby.style/#stylewordarray
139
+
140
+ Lint/AmbiguousRegexpLiteral:
141
+ Enabled: false
142
+ StyleGuide: https://relaxed.ruby.style/#lintambiguousregexpliteral
143
+
144
+ Lint/AssignmentInCondition:
145
+ Enabled: false
146
+ StyleGuide: https://relaxed.ruby.style/#lintassignmentincondition
147
+
148
+ Layout/LineLength:
149
+ Enabled: false
150
+
151
+ Metrics:
152
+ Enabled: false
153
+
data/.rubocop.yml ADDED
@@ -0,0 +1,33 @@
1
+ inherit_from:
2
+ - http://relaxed.ruby.style/rubocop.yml
3
+
4
+ inherit_gem:
5
+ prettier: rubocop.yml
6
+
7
+ require:
8
+ - rubocop-performance
9
+
10
+ AllCops:
11
+ NewCops: enable
12
+ DisplayStyleGuide: true
13
+ DisplayCopNames: true
14
+ SuggestExtensions: false
15
+ Exclude:
16
+ - 'bin/*'
17
+ - 'vendor/**/*'
18
+ - 'node_modules/**/*'
19
+
20
+ Metrics/BlockLength:
21
+ Exclude:
22
+ - 'spec/**/*.rb'
23
+ - 'Guardfile'
24
+ - 'config/environments/*.rb'
25
+ - 'lib/tasks/*.rake'
26
+ - 'shotgun_api_ruby.gemspec'
27
+
28
+ ### Prettier
29
+ Style:
30
+ Enabled: false
31
+
32
+ Gemspec/RequiredRubyVersion:
33
+ Enabled: false
data/.ruby-gemset ADDED
@@ -0,0 +1 @@
1
+ shotgun-ruby
data/.ruby-version ADDED
@@ -0,0 +1 @@
1
+ 2.7.2
data/.travis.yml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ sudo: false
3
+ language: ruby
4
+ cache: bundler
5
+ rvm:
6
+ - 2.6.3
7
+ before_install: gem install bundler -v 2.0.2
data/CHANGELOG.md ADDED
@@ -0,0 +1,61 @@
1
+ # Changelog
2
+ All notable changes to this project will be documented in this file.
3
+
4
+ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
5
+ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
6
+
7
+ ## [Unreleased]
8
+
9
+ ## [0.1.2] - 2021-06-16
10
+ ### Changed
11
+ - Renamed to Shotgrid
12
+
13
+ ## [0.1.1] - 2021-06-15
14
+ ### Added
15
+ - summarize and count support
16
+
17
+ ## [0.1.0] - 2021-06-14
18
+ ### Added
19
+ - Complete test coverage (Unit + Integration tests)
20
+ - Adding minimum coverage for tests
21
+ - Adding Guard
22
+
23
+ ### Changed
24
+ - Fixed many edge-case bugs
25
+
26
+ ### Removed
27
+ - Removed the `Gemfile.lock` since it shouldn't be commited in gems
28
+
29
+ ## [0.0.8.5] - 2021-01-15
30
+ ### Added
31
+ - Added prettier for ruby style
32
+
33
+ ## [0.0.8.4] - 2021-01-07
34
+ ### Changed
35
+ - Safer eager_load
36
+
37
+ ## [0.0.8.3] - 2021-01-07
38
+ ### Added
39
+ - eager_load files to fix weird bugs in rspec
40
+
41
+ ## [0.0.8] - 2020-12-16
42
+ ### Added
43
+ - Schema: read
44
+ - Schema: read fields
45
+
46
+ ## [0.0.7] - 2020-12-16
47
+ ### Added
48
+ - Entities: update
49
+ - Entities: create
50
+ - Entities: delete
51
+ - Entities: revive
52
+
53
+ [Unreleased]: https://github.com/shotgunsoftware/shotgrid_api_ruby/compare/v0.1.2...HEAD
54
+ [0.1.2]: https://github.com/shotgunsoftware/shotgrid_api_ruby/releases/tag/v0.1.2
55
+ [0.1.1]: https://github.com/shotgunsoftware/shotgrid_api_ruby/releases/tag/v0.1.1
56
+ [0.1.0]: https://github.com/shotgunsoftware/shotgrid_api_ruby/releases/tag/v0.1.0
57
+ [0.0.8.5]: https://github.com/shotgunsoftware/shotgrid_api_ruby/releases/tag/v0.0.8.5
58
+ [0.0.8.4]: https://github.com/shotgunsoftware/shotgrid_api_ruby/releases/tag/v0.0.8.4
59
+ [0.0.8.3]: https://github.com/shotgunsoftware/shotgrid_api_ruby/releases/tag/v0.0.8.3
60
+ [0.0.8]: https://github.com/shotgunsoftware/shotgrid_api_ruby/releases/tag/v0.0.8
61
+ [0.0.7]: https://github.com/shotgunsoftware/shotgrid_api_ruby/releases/tag/v0.0.7