shotgun_api_ruby 0.0.5.2 → 0.0.8.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7bbe794f988991a22c4625aae5c8075585f4fc49e50c532f681ee63614c9352e
-  data.tar.gz: e5875a67ae26b682ece8865e08c650b239ea057112c1922700b3a1826b05f82a
+  metadata.gz: 06c5375e4155418ae69004dd39b03339072744f2e6d95150c78356d5bf0c16cf
+  data.tar.gz: 887e4c5b773fb2e20dd24d70a91268db0a67b872bd105d5259dbfe3f7ff1ebcf
 SHA512:
-  metadata.gz: be31578709bd8ee4b5816d8a6c5ec87772efe709505d9df4679c10811f90da408319b51f28038a7dcd00ff20a8057aebc2a072523efa0794c681486eccae949c
-  data.tar.gz: 199806ba4ee6d1228474b8f486bbd2955da15d08a614b51371b8e142adcc163deddaca5825a2df51858b43f7957b8a2a164f8454e9c5ee6c188a36aa83df605f
+  metadata.gz: 187e5c60a1dd8a9d2b3e06abc908a085c43f939a90d9312ac78a5d72069fb4456cd3c1ad0aaf9797154b66b48b82ef4064318ee75e31162fdb3bec4361f5b7fb
+  data.tar.gz: 53b1f6d9f3cccb07f79b83ac257959c586c66f3fcc49859dfcae9bcb9099df76f3ba5b8d8929625a4e44aab9db984395cc160a403b565cd36b4996b0de6a31ff

data/.github/workflows/verify_version_change.yml

@@ -14,8 +14,10 @@ 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/rspec_in_context/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/rspec_in_context/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/rspec_in_context/version.rb | grep -E "^\+.*VERSION" | grep -E -o "[0-9]+\.[0-9]+\.[0-9]+(\.[0-9]+)?") > $(git diff main lib/rspec_in_context/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]+)?") ]]'
+      - 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,27 @@
+# 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.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...HEAD
+[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

@@ -1,5 +1,8 @@
 # ShotgunApiRuby
 
+[![Gem Version](https://badge.fury.io/rb/shotgun_api_ruby.svg)](https://badge.fury.io/rb/shotgun_api_ruby)
+![Test and Release badge](https://github.com/shotgunsoftware/shotgun_api_ruby/workflows/Test%20and%20Release/badge.svg)
+
 A gem to integrate with shotgun REST API easily.
 
 ## Installation
@@ -305,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

@@ -9,6 +9,7 @@ require 'json'
 
 loader = Zeitwerk::Loader.for_gem
 loader.setup # ready!
+loader.eager_load
 
 module ShotgunApiRuby
   def self.new(**args)

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.2"
+  VERSION = "0.0.8.3"
 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.2
+  version: 0.0.8.3
 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.