shotgun_api_ruby 0.0.5.3 → 0.0.8.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cab4b7bb6b46bc730be51e3d0f690685751b30ed901aa66fd4ede97e2b4526e0
-  data.tar.gz: ead76e9dca731cb80ab15302195d23ccdfafdc26c61003a26080aa7a2d7ed8e7
+  metadata.gz: 40d52da8cf4bb1e972a1a4dd4cd0ec8aa8b572c356dbfa47e6b84ff466a1eb33
+  data.tar.gz: 64ee5ecaa4ed9b50fbf1b811ebca28dddf5b3150e99d61824ee327b5913da209
 SHA512:
-  metadata.gz: 3aa5b7b697fc482c5a461fc0f851880c0b784d69be3cc515b5d14d0f785c501f7bae26d63a44423e0f14e57314b88c08b711fdfd693146ef36757fd1ed7e5c1d
-  data.tar.gz: 35704ade665195515fb32d906c2091b3fd4a8cecbb6e4a79f04e1b7831205469659a2d69edac25a6a83f626adef357cb1e3a647f824056f85869de88f718cbaa
+  metadata.gz: 1caeabca35f814c45e40a477c4130cddc48d15ced65c1854e8db4d56d0574f4cb20ade9e028ccb8c05256c42bb5dcbfb82b30ec3086837ec5f11ea96423fcdd6
+  data.tar.gz: b9b6ba452f09ad70cae2a0c961c7a1712dbf21fba4f985ca2ae467c2bee2aa911cab213eecf6dbc73e671367ea8e0204e25b6e039c3ce61d81d0a04d49f43e8f

data/.github/workflows/verify_version_change.yml

@@ -19,3 +19,5 @@ jobs:
         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]+)?") ]]'
+      - name: Verify if version is updated in Gemfile.lock
+        run: '[[ $(cat Gemfile.lock | grep "$(git diff main lib/shotgun_api_ruby/version.rb | grep -E "^\+.*VERSION" | grep -E -o "[0-9]+\.[0-9]+\.[0-9]+(\.[0-9]+)?")") ]]'

data/.rubocop.yml

@@ -14,6 +14,9 @@ AllCops:
 Style/GlobalVars:
   Enabled: false
 
+Gemspec/RequiredRubyVersion:
+  Enabled: false
+
 Layout/DotPosition:
   Enabled: true
   EnforcedStyle: trailing

data/CHANGELOG.md

@@ -0,0 +1,33 @@
+# 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.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.0.8.4...HEAD
+[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/README.md

@@ -308,15 +308,57 @@ client.assets.find(724, fields: [:code, 'description'], retired: false)
 
 #### Create
 
-Not implemented yet
+Will create the entity referenced by the id with the following fields. 
+If successful, it will return the newly created entity.
+
+```ruby
+client.assets.create(code: 'New Asset', project: {type: 'Project', id: 63})
+```
 
 #### Update
 
-Not implemented yet
+Will update the entity referenced by the id with the following fields. 
+If successful, it will return the modified entity.
+
+```ruby
+client.assets.update(1226, code: 'Updated Asset', sg_status_list: 'fin')
+```
 
 #### Delete
 
-Not implemented yet
+Will destroys the entity referenced by the id. Will return true if successful.
+
+```ruby
+client.assets.delete(1226)
+```
+
+#### Revive
+
+Will try to revive the entity referenced by the id. Will return true if successful.
+
+```ruby
+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
 

data/lib/shotgun_api_ruby.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
 # zeitwerk will take care of auto loading files based on their name :)
-require "zeitwerk"
+require 'zeitwerk'
 require 'active_support/core_ext/string/inflections'
 require 'ostruct'
-require "faraday"
+require 'faraday'
 require 'json'
 
 loader = Zeitwerk::Loader.for_gem
@@ -15,3 +15,5 @@ module ShotgunApiRuby
     Client.new(**args)
   end
 end
+
+loader.eager_load

data/lib/shotgun_api_ruby/client.rb

@@ -28,7 +28,7 @@ module ShotgunApiRuby
       public_send(type)
     end
 
-    def respond_to_missing?(_name, _include_private = false) # rubocop:disable Lint/MissingSuper
+    def respond_to_missing?(_name, _include_private = false)
       true
     end
 

data/lib/shotgun_api_ruby/entities.rb

@@ -5,6 +5,7 @@ module ShotgunApiRuby
     def initialize(connection, type)
       @connection = connection.dup
       @type = type
+      @base_url_prefix = @connection.url_prefix
       @connection.url_prefix = "#{@connection.url_prefix}/entity/#{type}"
     end
 
@@ -52,6 +53,78 @@ module ShotgunApiRuby
       )
     end
 
+    def create(attributes)
+      resp =
+        @connection.post('', attributes.to_json) do |req|
+          req.headers['Content-Type'] = 'application/json'
+        end
+
+      resp_body = JSON.parse(resp.body)
+
+      if resp.status >= 300
+        raise "Error while creating #{type}# with #{attributes}: #{resp_body['errors']}"
+      end
+
+      entity = resp_body["data"]
+      Entity.new(
+        entity['type'],
+        OpenStruct.new(entity['attributes']),
+        entity['relationships'],
+        entity['id'],
+        entity['links']
+      )
+    end
+
+    def update(id, changes)
+      return find(id) if changes.empty?
+
+      resp =
+        @connection.put(id.to_s, changes.to_json) do |req|
+          req.headers['Content-Type'] = 'application/json'
+        end
+
+      resp_body = JSON.parse(resp.body)
+
+      if resp.status >= 300
+        raise "Error while updating #{type}##{id} with #{changes}: #{resp_body['errors']}"
+      end
+
+      entity = resp_body["data"]
+      Entity.new(
+        entity['type'],
+        OpenStruct.new(entity['attributes']),
+        entity['relationships'],
+        entity['id'],
+        entity['links']
+      )
+    end
+
+    def delete(id)
+      resp =
+        @connection.delete(id.to_s) do |req|
+          req.headers['Content-Type'] = 'application/json'
+        end
+
+      if resp.status >= 300
+        resp_body = JSON.parse(resp.body)
+        raise "Error while deleting #{type}##{id}: #{resp_body['errors']}"
+      end
+
+      true
+    end
+
+    def revive(id)
+      resp =
+        @connection.post("#{id}?revive=true")
+
+      if resp.status >= 300
+        resp_body = JSON.parse(resp.body)
+        raise "Error while reviving #{type}##{id}: #{resp_body['errors']}"
+      end
+
+      true
+    end
+
     def all(
       fields: nil,
       logical_operator: 'and',
@@ -148,7 +221,6 @@ module ShotgunApiRuby
             req.headers['Content-Type'] = 'application/vnd+shotgun.api3_hash+json'
           end
           req.body = params.to_h.merge(filters: filter).to_json
-          pp JSON.parse(req.body)
         end
       resp_body = JSON.parse(resp.body)
 
@@ -167,6 +239,18 @@ module ShotgunApiRuby
       end
     end
 
+    def schema_client
+      @schema_client ||= Schema.new(connection, type, @base_url_prefix)
+    end
+
+    def schema
+      schema_client.read
+    end
+
+    def fields
+      schema_client.fields
+    end
+
     private
 
     def filters_are_simple?(filters)

data/lib/shotgun_api_ruby/entities/schema.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module ShotgunApiRuby
+  class Entities
+    class Schema
+      def initialize(connection, type, base_url_prefix)
+        @connection = connection.dup
+        @type = type
+        @connection.url_prefix = "#{base_url_prefix}/schema/#{type}"
+      end
+      attr_reader :type, :connection
+
+      def read
+        resp = @connection.get('')
+
+        if resp.status >= 300
+          raise "Error while read schema for #{type}: #{resp.body}"
+        end
+
+        resp_body = JSON.parse(resp.body)
+
+        OpenStruct.new(
+          resp_body["data"].transform_values{ |v| v["value"] }
+        )
+      end
+
+      def fields
+        resp = @connection.get('fields')
+        resp_body = JSON.parse(resp.body)
+
+        if resp.status >= 300
+          raise "Error while read schema fields for #{type}: #{resp.body}"
+        end
+
+        OpenStruct.new(
+          resp_body["data"].transform_values do |value|
+            OpenStruct.new(
+              value.transform_values do |attribute|
+                attribute["value"]
+              end.merge(
+                properties: OpenStruct.new(value["properties"].transform_values{ |prop| prop["value"] })
+              )
+            )
+          end
+        )
+      end
+    end
+  end
+end

data/lib/shotgun_api_ruby/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ShotgunApiRuby
-  VERSION = "0.0.5.3"
+  VERSION = '0.0.8.4'
 end

data/shotgun_api_ruby.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
 
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = "https://github.com/shotgunsoftware/shotgun_api_ruby"
-  # spec.metadata["changelog_uri"] = "http://none.yet.com"
+  spec.metadata['changelog_uri'] = "https://github.com/shotgunsoftware/shotgun_api_ruby/blob/main/CHANGELOG.md"
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shotgun_api_ruby
 version: !ruby/object:Gem::Version
-  version: 0.0.5.3
+  version: 0.0.8.4
 platform: ruby
 authors:
 - Denis <Zaratan> Pasin
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-10-06 00:00:00.000000000 Z
+date: 2021-01-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -210,7 +210,9 @@ files:
 - ".ruby-gemset"
 - ".ruby-version"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -221,6 +223,7 @@ files:
 - lib/shotgun_api_ruby/client.rb
 - lib/shotgun_api_ruby/entities.rb
 - lib/shotgun_api_ruby/entities/params.rb
+- lib/shotgun_api_ruby/entities/schema.rb
 - lib/shotgun_api_ruby/entity.rb
 - lib/shotgun_api_ruby/preferences.rb
 - lib/shotgun_api_ruby/server_info.rb
@@ -232,6 +235,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/shotgunsoftware/shotgun_api_ruby
   source_code_uri: https://github.com/shotgunsoftware/shotgun_api_ruby
+  changelog_uri: https://github.com/shotgunsoftware/shotgun_api_ruby/blob/main/CHANGELOG.md
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -247,7 +251,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Gem to interact easily with Shotgun REST api.