shotgun_api_ruby 0.0.7 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 331b2df4f527205c4803c47cb3a80373578aa740d56fe79c092930881afb9a01
-  data.tar.gz: '09a83792f0f2b93d3b877cb10501d27c0049ef23c928e34ec65b90b9db956900'
+  metadata.gz: 3ae703829a60a9216ec532dd7d90c627bc15cab08a766ba245a90f67f7bff696
+  data.tar.gz: b7dfe8b5ecfe096ea87986eb5c4e292919503133e8baea2d115405ae52d349bb
 SHA512:
-  metadata.gz: f47383023c6a67909c1eb1a54c8acc55880ba978bd20292633fb77362fdfd2e216d5b70869e1da88f1286a8640cec180fa12ef8b7d67351d8815b6b86d3d0e2e
-  data.tar.gz: db5f9915dd9d40558d627efc6ed1860d254ef0f324e40a30aaa4f2e1cf8d78ea10baab866572a82444e40f4b12c3d18da537474fecd7e1a3c839ce0faa4900e9
+  metadata.gz: 9b9463f3e579cd14c74036e25691ccb73a296268a2729b188dd52453f459287c5c212ed357a48c06b6e41376a018fe7a79c5f88e9ff8b577abaa1bcc1b9b852b
+  data.tar.gz: 972f60041a6f0025c3691d4ed44ae08991b1b544030a59cbba61bbcbadf55ff6061032826a483572d37e3e23a12deddf6005d78870de9b84429fbdcceb5fc550

data/CHANGELOG.md

@@ -0,0 +1,23 @@
+# 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] - 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

@@ -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.

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
 
@@ -220,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)
 
@@ -239,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.7"
+  VERSION = "0.0.8"
 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,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: shotgun_api_ruby
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
 platform: ruby
 authors:
 - Denis <Zaratan> Pasin
@@ -210,6 +210,7 @@ files:
 - ".ruby-gemset"
 - ".ruby-version"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -222,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
@@ -233,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: