shotgrid_api_ruby 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ae7b5145a6416248b3b8b1ae1f2fcd0692dffb84223aa4c6862f6f6126df71a4
-  data.tar.gz: ce67a7271446889740fa2524085b743a673b49acb8065b3bbc628799478f178d
+  metadata.gz: 774dd8aaf768a98b4be34e5f5c9d208605fd590aec94754273452f48130498a5
+  data.tar.gz: d3faf78fe7efcd12ecbbfed7c175597a547ecffbcb951586e51de1624e9a6d8a
 SHA512:
-  metadata.gz: 1673d552274cfd4eca41511b9cdf9dc7d95e38503cdc8275721e8feb0095226a36091f6b220648ddc1950966e648389e7837b0b585186363818037ed9623dead
-  data.tar.gz: 184f9af23a48672125112c10f3d28048e00daa94e22c254c27475a9d7a0e26f41f6ed0b8301e1f79d554ceaabf21c541729b596a88b08580136ec0aacacc89fb
+  metadata.gz: 4c9e6fd99e54df7499011a75de0884ea8f96bafe1dc6eba86013f1fc5381177467814e7b0590247f632f8ffee7d1a5e2d8f9be8495936235da3d3e238771c3e7
+  data.tar.gz: 698dbc0f7d77dad04d5ca3fad5acea4c1ea2d6429dfa587c0e1b4df096ce474bdb2343c658ad8081d154f4adda82baa732243ceebcc25cd89dddb1dbab1e8f2f

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,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [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

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'
 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/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
 platform: ruby
 authors:
 - Denis <Zaratan> Pasin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-06-17 00:00:00.000000000 Z
+date: 2021-08-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -357,6 +357,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
@@ -383,7 +384,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !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.