shotgrid_api_ruby 0.1.2 → 0.1.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ae7b5145a6416248b3b8b1ae1f2fcd0692dffb84223aa4c6862f6f6126df71a4
-  data.tar.gz: ce67a7271446889740fa2524085b743a673b49acb8065b3bbc628799478f178d
+  metadata.gz: b3d22a3f63c6e1fcccbce5467741ccea7df6d21c596beceadb41d97a728b23ee
+  data.tar.gz: cb1b8029e0da53a7c134101f8a2ec50ec64d898f63a106a8c7d1f063d58ab00e
 SHA512:
-  metadata.gz: 1673d552274cfd4eca41511b9cdf9dc7d95e38503cdc8275721e8feb0095226a36091f6b220648ddc1950966e648389e7837b0b585186363818037ed9623dead
-  data.tar.gz: 184f9af23a48672125112c10f3d28048e00daa94e22c254c27475a9d7a0e26f41f6ed0b8301e1f79d554ceaabf21c541729b596a88b08580136ec0aacacc89fb
+  metadata.gz: 1a21da51ac645ddfd6e047554ee2539252f3b57c933a347a837b610b444c206cfec494d835159fa569243caffb9d08395bd1abd29821705183e060c12e0e54a1
+  data.tar.gz: a16b118eab23a178c324a3bae810965de85c4beb6c0dcb3e1486cd93bb410daa358a2990ccfc73eb835eca5834e2d427d436892df3426014b9cb22d208d29f25

data/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,38 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. iOS]
+ - Browser [e.g. chrome, safari]
+ - Version [e.g. 22]
+
+**Smartphone (please complete the following information):**
+ - Device: [e.g. iPhone6]
+ - OS: [e.g. iOS8.1]
+ - Browser [e.g. stock browser, safari]
+ - Version [e.g. 22]
+
+**Additional context**
+Add any other context about the problem here.

data/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

data/.rubocop.yml

@@ -4,7 +4,7 @@ inherit_from:
 inherit_gem:
   prettier: rubocop.yml
 
-require: 
+require:
   - rubocop-performance
 
 AllCops:
@@ -12,6 +12,7 @@ AllCops:
   DisplayStyleGuide: true
   DisplayCopNames: true
   SuggestExtensions: false
+  TargetRubyVersion: 2.6
   Exclude:
     - 'bin/*'
     - 'vendor/**/*'
@@ -24,7 +25,7 @@ Metrics/BlockLength:
     - 'config/environments/*.rb'
     - 'lib/tasks/*.rake'
     - 'shotgun_api_ruby.gemspec'
-      
+
 ### Prettier
 Style:
   Enabled: false

data/.ruby-version

@@ -1 +1 @@
-2.7.2
+3.0.2

data/CHANGELOG.md

@@ -6,6 +6,23 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.1.3.3] - 2021-08-28
+### Added
+- Issue default format
+
+## [0.1.3.2] - 2021-08-24
+### Added
+- Code Of Conduct
+
+## [0.1.3.1] - 2021-08-24
+### Changed
+- Correctly advertising the minimum ruby version to 2.6
+
+## [0.1.3] - 2021-08-24
+### Changed
+- Updated tooling
+- Adding `ShotgridCallError` to capture call errors and give access to the raw Faraday response
+
 ## [0.1.2] - 2021-06-16
 ### Changed
 - Renamed to Shotgrid
@@ -50,7 +67,11 @@ 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.2...HEAD
+[Unreleased]: https://github.com/shotgunsoftware/shotgrid_api_ruby/compare/v0.1.3.3...HEAD
+[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
+[0.1.3]: https://github.com/shotgunsoftware/shotgrid_api_ruby/releases/tag/v0.1.3
 [0.1.2]: https://github.com/shotgunsoftware/shotgrid_api_ruby/releases/tag/v0.1.2
 [0.1.1]: https://github.com/shotgunsoftware/shotgrid_api_ruby/releases/tag/v0.1.1
 [0.1.0]: https://github.com/shotgunsoftware/shotgrid_api_ruby/releases/tag/v0.1.0

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,128 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+denis.pasin@autodesk.com.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.

data/README.md

@@ -71,6 +71,23 @@ client = ShotgridApiRuby.new(shotgrid_site: 'xxx', auth: {session_token: 'sessio
 client = ShotgridApiRuby.new(shotgrid_site: 'xxx', auth: {refresh_token: 'refresh_token'})
 ```
 
+### ShotgridCallError
+
+Every ShotGrid call resulting in an error will throw a ShotgridCallError. This error class derive from StandardError and will implement 2 extra methods:
+- `#response` => Will returns the original HTTP response (a Faraday::Response).
+- `#status` => This method is a shortcut to get the status from the response.
+
+exemple
+```ruby
+begin
+  # A ShotGrid call resulting in a error
+rescue StandardError => e
+  p e.message, e.backtrace # Will behave as a normal StandardError
+  p e.response.body # Original unparsed body from ShotGrid response
+  p e.status # Status code from ShotGrid answer
+end
+```
+
 ### Server Infos
 
 Get general server infos:

data/lib/shotgrid_api_ruby/auth.rb

@@ -107,7 +107,12 @@ module ShotgridApiRuby
         end
       resp_body = JSON.parse(resp.body)
 
-      raise "Can't login: #{resp_body['errors']}" if resp.status >= 300
+      if resp.status >= 300
+        raise ShotgridCallError.new(
+                response: resp,
+                message: "Can't login: #{resp_body['errors']}",
+              )
+      end
 
       @access_token = resp_body['access_token']
       @token_expiry = Time.now + resp_body['expires_in']

data/lib/shotgrid_api_ruby/entities/params.rb

@@ -11,9 +11,11 @@ module ShotgridApiRuby
 
         self[:sort] =
           if sort.is_a?(Hash)
-            sort.map do |field, direction|
-              "#{direction.to_s.start_with?('desc') ? '-' : ''}#{field}"
-            end.join(',')
+            sort
+              .map do |field, direction|
+                "#{direction.to_s.start_with?('desc') ? '-' : ''}#{field}"
+              end
+              .join(',')
           else
             [sort].flatten.join(',')
           end
@@ -122,9 +124,10 @@ module ShotgridApiRuby
               filter_val.is_a?(Symbol)
           ) ||
             (
-              filter_val.is_a?(Array) && filter_val.all? do |val|
-                val.is_a?(String) || val.is_a?(Symbol) || val.is_a?(Integer)
-              end
+              filter_val.is_a?(Array) &&
+                filter_val.all? do |val|
+                  val.is_a?(String) || val.is_a?(Symbol) || val.is_a?(Integer)
+                end
             )
         end
       end

data/lib/shotgrid_api_ruby/entities/schema.rb

@@ -14,7 +14,10 @@ module ShotgridApiRuby
         resp = @connection.get('')
 
         if resp.status >= 300
-          raise "Error while read schema for #{type}: #{resp.body}"
+          raise ShotgridCallError.new(
+                  response: resp,
+                  message: "Error while read schema for #{type}: #{resp.body}",
+                )
         end
 
         resp_body = JSON.parse(resp.body)
@@ -27,20 +30,26 @@ module ShotgridApiRuby
         resp_body = JSON.parse(resp.body)
 
         if resp.status >= 300
-          raise "Error while read schema fields for #{type}: #{resp.body}"
+          raise ShotgridCallError.new(
+                  response: resp,
+                  message:
+                    "Error while read schema fields for #{type}: #{resp.body}",
+                )
         end
 
         OpenStruct.new(
           resp_body['data'].transform_values do |value|
             OpenStruct.new(
-              value.transform_values { |attribute| attribute['value'] }.merge(
-                properties:
-                  OpenStruct.new(
-                    value['properties'].transform_values do |prop|
-                      prop['value']
-                    end,
-                  ),
-              ),
+              value
+                .transform_values { |attribute| attribute['value'] }
+                .merge(
+                  properties:
+                    OpenStruct.new(
+                      value['properties'].transform_values do |prop|
+                        prop['value']
+                      end,
+                    ),
+                ),
             )
           end,
         )

data/lib/shotgrid_api_ruby/entities/summarize.rb

@@ -51,7 +51,11 @@ module ShotgridApiRuby
         resp_body = JSON.parse(resp.body)
 
         if resp.status >= 300
-          raise "Error while getting summarize for #{type}: #{resp_body['errors']}"
+          raise ShotgridCallError.new(
+                  response: resp,
+                  message:
+                    "Error while getting summarize for #{type}: #{resp_body['errors']}",
+                )
         end
 
         Summary.new(

data/lib/shotgrid_api_ruby/entities.rb

@@ -40,7 +40,10 @@ module ShotgridApiRuby
       resp_body = JSON.parse(resp.body)
 
       if resp.status >= 300
-        raise "Error while getting #{type}: #{resp_body['errors']}"
+        raise ShotgridCallError.new(
+                message: "Error while getting #{type}: #{resp_body['errors']}",
+                response: resp,
+              )
       end
 
       entity = resp_body['data']
@@ -62,9 +65,13 @@ module ShotgridApiRuby
       resp_body = JSON.parse(resp.body)
 
       if resp.status >= 300
-        raise "Error while creating #{type} with #{attributes}: #{
-                resp_body['errors']
-              }"
+        raise ShotgridCallError.new(
+                response: resp,
+                message:
+                  "Error while creating #{type} with #{attributes}: #{
+                    resp_body['errors']
+                  }",
+              )
       end
 
       entity = resp_body['data']
@@ -88,9 +95,13 @@ module ShotgridApiRuby
       resp_body = JSON.parse(resp.body)
 
       if resp.status >= 300
-        raise "Error while updating #{type}##{id} with #{changes}: #{
-                resp_body['errors']
-              }"
+        raise ShotgridCallError.new(
+                response: resp,
+                message:
+                  "Error while updating #{type}##{id} with #{changes}: #{
+                    resp_body['errors']
+                  }",
+              )
       end
 
       entity = resp_body['data']
@@ -111,7 +122,11 @@ module ShotgridApiRuby
 
       if resp.status >= 300
         resp_body = JSON.parse(resp.body)
-        raise "Error while deleting #{type}##{id}: #{resp_body['errors']}"
+        raise ShotgridCallError.new(
+                response: resp,
+                message:
+                  "Error while deleting #{type}##{id}: #{resp_body['errors']}",
+              )
       end
 
       true
@@ -122,7 +137,11 @@ module ShotgridApiRuby
 
       if resp.status >= 300
         resp_body = JSON.parse(resp.body)
-        raise "Error while reviving #{type}##{id}: #{resp_body['errors']}"
+        raise ShotgridCallError.new(
+                response: resp,
+                message:
+                  "Error while reviving #{type}##{id}: #{resp_body['errors']}",
+              )
       end
 
       true
@@ -165,7 +184,10 @@ module ShotgridApiRuby
       resp_body = JSON.parse(resp.body)
 
       if resp.status >= 300
-        raise "Error while getting #{type}: #{resp_body['errors']}"
+        raise ShotgridCallError.new(
+                response: resp,
+                message: "Error while getting #{type}: #{resp_body['errors']}",
+              )
       end
 
       resp_body['data'].map do |entity|
@@ -228,7 +250,10 @@ module ShotgridApiRuby
       resp_body = JSON.parse(resp.body)
 
       if resp.status >= 300
-        raise "Error while getting #{type}: #{resp_body['errors']}"
+        raise ShotgridCallError.new(
+                response: resp,
+                message: "Error while getting #{type}: #{resp_body['errors']}",
+              )
       end
 
       resp_body['data'].map do |entity|

data/lib/shotgrid_api_ruby/preferences.rb

@@ -14,7 +14,11 @@ module ShotgridApiRuby
       resp_body = JSON.parse(resp.body)
 
       if resp.status >= 300
-        raise "Error while getting server preferences: #{resp_body['errors']}"
+        raise ShotgridCallError.new(
+                response: resp,
+                message:
+                  "Error while getting server preferences: #{resp_body['errors']}",
+              )
       end
 
       data = resp_body['data']

data/lib/shotgrid_api_ruby/server_info.rb

@@ -13,7 +13,11 @@ module ShotgridApiRuby
       resp_body = JSON.parse(resp.body)
 
       if resp.status >= 300
-        raise "Error while getting server infos: #{resp_body['errors']}"
+        raise ShotgridCallError.new(
+                response: resp,
+                message:
+                  "Error while getting server infos: #{resp_body['errors']}",
+              )
       end
 
       data = resp_body['data']

data/lib/shotgrid_api_ruby/shotgrid_call_error.rb

@@ -0,0 +1,15 @@
+require 'forwardable'
+
+module ShotgridApiRuby
+  class ShotgridCallError < StandardError
+    extend Forwardable
+
+    def initialize(response:, message:)
+      @response = response
+      super(message)
+    end
+
+    attr_reader :response
+    def_delegators :response, :status
+  end
+end

data/lib/shotgrid_api_ruby/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ShotgridApiRuby
-  VERSION = '0.1.2'
+  VERSION = '0.1.3.3'
 end

data/package.json

@@ -5,6 +5,9 @@
   "repository": "git@github.com:shotgunsoftware/shotgrid_api_ruby.git",
   "author": "Denis <Zaratan> Pasin <zaratan@hey.com>",
   "license": "MIT",
+  "scripts": {
+    "lint": "prettier -w '**/*.rb'"
+  },
   "devDependencies": {
     "@prettier/plugin-ruby": "^1.3.0",
     "prettier": "^2.2.1"

data/shotgrid_api_ruby.gemspec

@@ -15,7 +15,7 @@ Gem::Specification.new do |spec|
     "Gem to facilitate the interaction with Shotgrid's REST API."
   spec.homepage = 'https://github.com/shotgunsoftware/shotgrid_api_ruby'
   spec.license = 'MIT'
-  spec.required_ruby_version = Gem::Requirement.new('>= 2.5.0')
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.6.0')
 
   spec.metadata['homepage_uri'] = spec.homepage
   spec.metadata['source_code_uri'] =

data/yarn.lock

@@ -3,13 +3,13 @@
 
 
 "@prettier/plugin-ruby@^1.3.0":
-  version "1.5.5"
-  resolved "https://registry.yarnpkg.com/@prettier/plugin-ruby/-/plugin-ruby-1.5.5.tgz#9e206fc856a182a292fcfab9043f53c7a3d0af97"
-  integrity sha512-b387GdXU+LrnY+oaKWRUI5EnsUvrQ0G1jUSVPkvUTGzp/w+BB9/n4SICVPY3V9/wYsvWpAZq4LkE4FdBufXUtA==
+  version "1.6.1"
+  resolved "https://registry.yarnpkg.com/@prettier/plugin-ruby/-/plugin-ruby-1.6.1.tgz#14489985513a72e052b57c1cf9beae288880faa8"
+  integrity sha512-PGDCATgVTQz0s/NB9nStiXVCIr+hG/XnKeAO/kguaHrNf8VwCpP5Ul+/KQao0z0QFBy2PDY8kWptfDQCa7WMXg==
   dependencies:
     prettier ">=1.10"
 
 prettier@>=1.10, prettier@^2.2.1:
-  version "2.3.1"
-  resolved "https://registry.yarnpkg.com/prettier/-/prettier-2.3.1.tgz#76903c3f8c4449bc9ac597acefa24dc5ad4cbea6"
-  integrity sha512-p+vNbgpLjif/+D+DwAZAbndtRrR0md0MwfmOVN9N+2RgyACMT+7tfaRnT+WDPkqnuVwleyuBIG2XBxKDme3hPA==
+  version "2.3.2"
+  resolved "https://registry.yarnpkg.com/prettier/-/prettier-2.3.2.tgz#ef280a05ec253712e486233db5c6f23441e7342d"
+  integrity sha512-lnJzDfJ66zkMy58OL5/NY5zp70S7Nz6KqcKkXYzn2tMVrNxvbqaBpg7H3qHaLxCJ5lNMsGuM8+ohS7cZrthdLQ==

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shotgrid_api_ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3.3
 platform: ruby
 authors:
 - Denis <Zaratan> Pasin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-06-17 00:00:00.000000000 Z
+date: 2021-08-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -325,6 +325,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/ISSUE_TEMPLATE/bug_report.md"
+- ".github/ISSUE_TEMPLATE/feature_request.md"
 - ".github/workflows/test_and_publish.yml"
 - ".github/workflows/test_only.yml"
 - ".github/workflows/verify_version_change.yml"
@@ -338,6 +340,7 @@ files:
 - ".ruby-version"
 - ".travis.yml"
 - CHANGELOG.md
+- CODE_OF_CONDUCT.md
 - Gemfile
 - Guardfile
 - LICENSE.txt
@@ -357,6 +360,7 @@ files:
 - lib/shotgrid_api_ruby/entity.rb
 - lib/shotgrid_api_ruby/preferences.rb
 - lib/shotgrid_api_ruby/server_info.rb
+- lib/shotgrid_api_ruby/shotgrid_call_error.rb
 - lib/shotgrid_api_ruby/version.rb
 - package.json
 - shotgrid_api_ruby.gemspec
@@ -376,14 +380,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.15
+rubygems_version: 3.2.22
 signing_key: 
 specification_version: 4
 summary: Gem to interact easily with Shotgrid REST api.