shotgun_api_ruby 0.0.7 → 0.1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 331b2df4f527205c4803c47cb3a80373578aa740d56fe79c092930881afb9a01
-  data.tar.gz: '09a83792f0f2b93d3b877cb10501d27c0049ef23c928e34ec65b90b9db956900'
+  metadata.gz: ebb179d1404b03fd02a47b587b48e8a3cbbdfa69aa56141f2c4b3a9d73819eaf
+  data.tar.gz: ce95e7a5d7e7567ada62ac2604a6fc6f639cdacc3c61804fdd171a04de8309f1
 SHA512:
-  metadata.gz: f47383023c6a67909c1eb1a54c8acc55880ba978bd20292633fb77362fdfd2e216d5b70869e1da88f1286a8640cec180fa12ef8b7d67351d8815b6b86d3d0e2e
-  data.tar.gz: db5f9915dd9d40558d627efc6ed1860d254ef0f324e40a30aaa4f2e1cf8d78ea10baab866572a82444e40f4b12c3d18da537474fecd7e1a3c839ce0faa4900e9
+  metadata.gz: 03fb2158143962471d55adc758434ed2817e6d04989d00694025bb2f876d6d7f2bc44525c5eb16832fe55f6dd87e9bb9335a7bbf55d9af5be011bcf9ffb29b55
+  data.tar.gz: 9d7d48612614d7db28ad1c10342dc604a6bd19638c019fcc6c5599da93623c65414be561c8855ff63e8bd97de3ed745c81f39f9fe8666914e1d6e0eab438917a

data/.github/workflows/test_and_publish.yml

@@ -2,72 +2,57 @@ name: Test and Release
 
 on:
   push:
-    branches: 
+    branches:
       - main
 
 jobs:
-  test-2_5:
+  tests:
+    strategy:
+      matrix:
+        ruby: [2.6, 2.7, 3.0]
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v2
-    - name: Set up Ruby
-      uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: 2.5
-    - name: Install dependencies
-      run: bundle install
-    - name: Run linter
-      run: bundle exec rubocop
-    - name: Run tests
-      run: bundle exec rspec
-  test-2_6:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - name: Run linter
+        run: bundle exec rubocop
+      - name: Run tests
+        run: bundle exec rspec
+  prettier:
     runs-on: ubuntu-latest
-
-    steps:
-    - uses: actions/checkout@v2
-    - name: Set up Ruby
-      uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: 2.6
-    - name: Install dependencies
-      run: bundle install
-    - name: Run linter
-      run: bundle exec rubocop
-    - name: Run tests
-      run: bundle exec rspec
-  test-2_7:
-    runs-on: ubuntu-latest
-
     steps:
-    - uses: actions/checkout@v2
-    - name: Set up Ruby
-      uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: 2.7
-    - name: Install dependencies
-      run: bundle install
-    - name: Run linter
-      run: bundle exec rubocop
-    - name: Run tests
-      run: bundle exec rspec
+      - uses: actions/checkout@v2
+      - name: Set up Node
+        uses: actions/setup-node@v2
+        with:
+          node-version: '14'
+      - name: Install yarn dep
+        run: yarn install
+      - name: Check prettier
+        run: yarn prettier -c '**/*.rb'
   release:
-    needs: [test-2_5, test-2_6, test-2_7]
+    needs: [tests, prettier]
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v2
-    - name: Set up Ruby
-      uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: 2.7
-    - name: Install dependencies
-      run: bundle install
-    - name: Prepare credentials
-      env:
-        RUBYGEM_KEY: ${{ secrets.RUBYGEM_KEY }}
-      run: "echo -e \"---\\r\\n:rubygems_api_key: $RUBYGEM_KEY\" > ~/.gem/credentials && chmod 0600 ~/.gem/credentials"
-    - name: Setup username/email
-      run: "git config --global user.email zaratan@hey.com && git config --global user.name \"Denis <Zaratan> Pasin\""
-    - name: Publish
-      run: rake release
+      - uses: actions/checkout@v2
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.0
+          bundler-cache: true
+      - name: Prepare credentials
+        env:
+          RUBYGEM_KEY: ${{ secrets.RUBYGEM_KEY }}
+        run: "mkdir -p ~/.gem && echo -e \"---\\r\\n:rubygems_api_key: $RUBYGEM_KEY\" > ~/.gem/credentials && chmod 0600 ~/.gem/credentials"
+      - name: Setup username/email
+        run: 'git config --global user.email zaratan@hey.com && git config --global user.name "Denis <Zaratan> Pasin"'
+      - name: Fetch tags from remote
+        run: 'git fetch -t'
+      - name: Publish if version change
+        run: 'git diff `git tag | tail -1` -- lib/shotgun_api_ruby/version.rb | grep -E "^\+.*VERSION" && rake release || echo "No release for now"'

data/.github/workflows/test_only.yml

@@ -2,52 +2,36 @@ name: Tests
 
 on:
   push:
-    branches-ignore: 
+    branches-ignore:
       - main
 
 jobs:
-  test-2_5:
+  tests:
+    strategy:
+      matrix:
+        ruby: [2.6, 2.7, 3.0]
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v2
-    - name: Set up Ruby
-      uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: 2.5
-    - name: Install dependencies
-      run: bundle install
-    - name: Run linter
-      run: bundle exec rubocop
-    - name: Run tests
-      run: bundle exec rspec
-  test-2_6:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - name: Run linter
+        run: bundle exec rubocop
+      - name: Run tests
+        run: bundle exec rspec
+  prettier:
     runs-on: ubuntu-latest
-
-    steps:
-    - uses: actions/checkout@v2
-    - name: Set up Ruby
-      uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: 2.6
-    - name: Install dependencies
-      run: bundle install
-    - name: Run linter
-      run: bundle exec rubocop
-    - name: Run tests
-      run: bundle exec rspec
-  test-2_7:
-    runs-on: ubuntu-latest
-
     steps:
-    - uses: actions/checkout@v2
-    - name: Set up Ruby
-      uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: 2.7
-    - name: Install dependencies
-      run: bundle install
-    - name: Run linter
-      run: bundle exec rubocop
-    - name: Run tests
-      run: bundle exec rspec
+      - uses: actions/checkout@v2
+      - name: Set up Node
+        uses: actions/setup-node@v2
+        with:
+          node-version: '14'
+      - name: Install yarn dep
+        run: yarn install
+      - name: Check prettier
+        run: yarn prettier -c '**/*.rb'

data/.github/workflows/verify_version_change.yml

@@ -14,8 +14,8 @@ jobs:
       - name: Fetch main branch
         run: git fetch origin main:main
       - name: Verify if there's a change in version
-        run: "git diff main lib/shotgun_api_ruby/version.rb | grep VERSION"
+        run: "git diff main -- lib/shotgun_api_ruby/version.rb | grep VERSION"
       - name: Print new version
-        run: 'git diff main lib/shotgun_api_ruby/version.rb | grep -E "^\+.*VERSION" | grep -E -o "[0-9]+\.[0-9]+\.[0-9]+(\.[0-9]+)?"'
+        run: 'git diff main -- lib/shotgun_api_ruby/version.rb | grep -E "^\+.*VERSION" | grep -E -o "[0-9]+\.[0-9]+\.[0-9]+(\.[0-9]+)?"'
       - name: Verify if higher version
-        run: '[[ $(git diff main lib/shotgun_api_ruby/version.rb | grep -E "^\+.*VERSION" | grep -E -o "[0-9]+\.[0-9]+\.[0-9]+(\.[0-9]+)?") > $(git diff main lib/shotgun_api_ruby/version.rb | grep -E "^-.*VERSION" | grep -E -o "[0-9]+\.[0-9]+\.[0-9]+(\.[0-9]+)?") ]]'
+        run: '[[ $(git diff main -- lib/shotgun_api_ruby/version.rb | grep -E "^\+.*VERSION" | grep -E -o "[0-9]+\.[0-9]+\.[0-9]+(\.[0-9]+)?") > $(git diff main -- lib/shotgun_api_ruby/version.rb | grep -E "^-.*VERSION" | grep -E -o "[0-9]+\.[0-9]+\.[0-9]+(\.[0-9]+)?") ]]'

data/.gitignore

@@ -11,3 +11,4 @@
 .rspec_status
 .env
 Gemfile.lock
+Gemfile.lock

data/.overcommit.yml

@@ -6,7 +6,16 @@ PreCommit:
     enabled: true
   BundleAudit:
     enabled: true
+  Prettier:
+    enabled: true
+    required_executable: './bin/prettirun'
 PrePush:
   RSpec:
     enabled: true
     command: ['bundle', 'exec', 'rspec', '-f', 'p'] # Invoke within Bundler context
+  Prettier:
+    enabled: true
+    required_executable: './bin/prettirun'
+  Rubocop:
+    enabled: true
+    required_executable: './bin/ruborun'

data/.prettierrc.js

@@ -0,0 +1,4 @@
+module.exports = {
+  trailingComma: "es5",
+  singleQuote: true,
+};

data/.rubocop.yml

@@ -1,6 +1,9 @@
 inherit_from:
   - http://relaxed.ruby.style/rubocop.yml
 
+inherit_gem:
+  prettier: rubocop.yml
+
 require: 
   - rubocop-performance
 
@@ -8,56 +11,11 @@ AllCops:
   NewCops: enable
   DisplayStyleGuide: true
   DisplayCopNames: true
+  SuggestExtensions: false
   Exclude:
-    - 'db/schema.rb'
-
-Style/GlobalVars:
-  Enabled: false
-
-Gemspec/RequiredRubyVersion:
-  Enabled: false
-
-Layout/DotPosition:
-  Enabled: true
-  EnforcedStyle: trailing
-
-Style/TrailingCommaInArrayLiteral:
-  Enabled: true
-  EnforcedStyleForMultiline: comma
-
-Style/TrailingCommaInHashLiteral:
-  Enabled: true
-  EnforcedStyleForMultiline: comma
-
-Layout/MultilineArrayLineBreaks:
-  Enabled: true
-
-Layout/MultilineHashKeyLineBreaks:
-  Enabled: true
-
-Layout/MultilineMethodArgumentLineBreaks:
-  Enabled: true
-
-Layout/FirstArrayElementLineBreak:
-  Enabled: true
-
-Layout/FirstHashElementLineBreak:
-  Enabled: true
-
-Layout/FirstMethodArgumentLineBreak:
-  Enabled: true
-
-Layout/MultilineAssignmentLayout:
-  Enabled: true
-
-Layout/LineLength:
-  Enabled: true
-  Max: 120
-  AutoCorrect: true
-  Exclude:
-    - Gemfile
-    - Guardfile
-    - spec/interactors/send_gdpr_response_spec.rb
+    - 'bin/*'
+    - 'vendor/**/*'
+    - 'node_modules/**/*'
 
 Metrics/BlockLength:
   Exclude:
@@ -66,3 +24,10 @@ Metrics/BlockLength:
     - 'config/environments/*.rb'
     - 'lib/tasks/*.rake'
     - 'shotgun_api_ruby.gemspec'
+      
+### Prettier
+Style:
+  Enabled: false
+
+Gemspec/RequiredRubyVersion:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,51 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.1.0] - 2021-06-14
+### Added
+- Complete test coverage (Unit + Integration tests)
+- Adding minimum coverage for tests
+- Adding Guard
+
+### Changed
+- Fixed many edge-case bugs
+
+### Removed
+- Removed the `Gemfile.lock` since it shouldn't be commited in gems
+
+## [0.0.8.5] - 2021-01-15
+### Added
+- Added prettier for ruby style
+
+## [0.0.8.4] - 2021-01-07
+### Changed
+- Safer eager_load
+
+## [0.0.8.3] - 2021-01-07
+### Added
+- eager_load files to fix weird bugs in rspec
+
+## [0.0.8] - 2020-12-16
+### Added
+- Schema: read
+- Schema: read fields
+
+## [0.0.7] - 2020-12-16
+### Added
+- Entities: update
+- Entities: create
+- Entities: delete
+- Entities: revive
+
+[Unreleased]: https://github.com/shotgunsoftware/shotgun_api_ruby/compare/v0.1.0...HEAD
+[0.1.0]: https://github.com/shotgunsoftware/shotgun_api_ruby/releases/tag/v0.1.0
+[0.0.8.5]: https://github.com/shotgunsoftware/shotgun_api_ruby/releases/tag/v0.0.8.5
+[0.0.8.4]: https://github.com/shotgunsoftware/shotgun_api_ruby/releases/tag/v0.0.8.4
+[0.0.8.3]: https://github.com/shotgunsoftware/shotgun_api_ruby/releases/tag/v0.0.8.3
+[0.0.8]: https://github.com/shotgunsoftware/shotgun_api_ruby/releases/tag/v0.0.8
+[0.0.7]: https://github.com/shotgunsoftware/shotgun_api_ruby/releases/tag/v0.0.7

data/Guardfile

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec features) \
+#  .select{|d| Dir.exists?(d) ? d : UI.warning("Directory #{d} does not exist")}
+
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+# Note: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separately)
+#  * 'just' rspec: 'rspec'
+
+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
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # map lib files to corresponding file
+  watch(%r{lib/(.*)/([^/]*).rb}) { |m| rspec.spec.call("#{m[1]}/#{m[2]}") }
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end

data/README.md

@@ -340,6 +340,26 @@ Will try to revive the entity referenced by the id. Will return true if successf
 client.assets.revive(1226)
 ```
 
+### Schema
+
+Those calls allow to inspect the schema for a shotgun site.
+
+#### Entity
+
+```ruby
+client.assets.schema
+```
+
+#### Entity fields
+
+Fetch the different fields available on an entity type and their definition.
+
+```ruby
+fields = client.assets.fields
+fields.code.name # => "Asset Name"
+fields.code.properties.summary_default # => "none"
+```
+
 ### Non implemented calls
 
 All calls which are not yet implemented can be done through the `connection` method. This method will still take care of the authentication for you.