shotgun_api_ruby 0.0.5 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6e8f35c879d4875bb2fd7aaf64717735ef915ca5dd4229097eb9a9d3eb8265b1
-  data.tar.gz: 0576b201159e2dcf3cfdcf7805e26e70f6796475153b0c7712c634aa4bb7fd48
+  metadata.gz: 3ae703829a60a9216ec532dd7d90c627bc15cab08a766ba245a90f67f7bff696
+  data.tar.gz: b7dfe8b5ecfe096ea87986eb5c4e292919503133e8baea2d115405ae52d349bb
 SHA512:
-  metadata.gz: 193682e3bbd32fdac36a9bebd5bd6c48d2e2e1652e6d6f1149a2bd103ef8028bcaae91f85320c322468e37bdbfb8e8667134a32dbe4c31c98b62799fa6551b70
-  data.tar.gz: e782ea8785bb79dbed938e966bfb80fddafcc4b058f62a65342451be01b4587fff6f67461ab3648c54bbfb01196b0121cbf92fb3067b98ed1b85ab3dcc596d1f
+  metadata.gz: 9b9463f3e579cd14c74036e25691ccb73a296268a2729b188dd52453f459287c5c212ed357a48c06b6e41376a018fe7a79c5f88e9ff8b577abaa1bcc1b9b852b
+  data.tar.gz: 972f60041a6f0025c3691d4ed44ae08991b1b544030a59cbba61bbcbadf55ff6061032826a483572d37e3e23a12deddf6005d78870de9b84429fbdcceb5fc550

data/.github/workflows/test_and_publish.yml

@@ -0,0 +1,73 @@
+name: Test and Release
+
+on:
+  push:
+    branches: 
+      - main
+
+jobs:
+  test-2_5:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 2.5
+    - name: Install dependencies
+      run: bundle install
+    - name: Run linter
+      run: bundle exec rubocop
+    - name: Run tests
+      run: bundle exec rspec
+  test-2_6:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 2.6
+    - name: Install dependencies
+      run: bundle install
+    - name: Run linter
+      run: bundle exec rubocop
+    - name: Run tests
+      run: bundle exec rspec
+  test-2_7:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 2.7
+    - name: Install dependencies
+      run: bundle install
+    - name: Run linter
+      run: bundle exec rubocop
+    - name: Run tests
+      run: bundle exec rspec
+  release:
+    needs: [test-2_5, test-2_6, test-2_7]
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 2.7
+    - name: Install dependencies
+      run: bundle install
+    - name: Prepare credentials
+      env:
+        RUBYGEM_KEY: ${{ secrets.RUBYGEM_KEY }}
+      run: "echo -e \"---\\r\\n:rubygems_api_key: $RUBYGEM_KEY\" > ~/.gem/credentials && chmod 0600 ~/.gem/credentials"
+    - name: Setup username/email
+      run: "git config --global user.email zaratan@hey.com && git config --global user.name \"Denis <Zaratan> Pasin\""
+    - name: Publish
+      run: rake release

data/.github/workflows/test_only.yml

@@ -0,0 +1,53 @@
+name: Tests
+
+on:
+  push:
+    branches-ignore: 
+      - main
+
+jobs:
+  test-2_5:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 2.5
+    - name: Install dependencies
+      run: bundle install
+    - name: Run linter
+      run: bundle exec rubocop
+    - name: Run tests
+      run: bundle exec rspec
+  test-2_6:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 2.6
+    - name: Install dependencies
+      run: bundle install
+    - name: Run linter
+      run: bundle exec rubocop
+    - name: Run tests
+      run: bundle exec rspec
+  test-2_7:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 2.7
+    - name: Install dependencies
+      run: bundle install
+    - name: Run linter
+      run: bundle exec rubocop
+    - name: Run tests
+      run: bundle exec rspec

data/.github/workflows/verify_version_change.yml

@@ -0,0 +1,21 @@
+name: Verify version change
+
+on:
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  version_change:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Fetch main branch
+        run: git fetch origin main:main
+      - name: Verify if there's a change in version
+        run: "git diff main lib/shotgun_api_ruby/version.rb | grep VERSION"
+      - name: Print new 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]+)?"'
+      - 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]+)?") ]]'

data/.gitignore

@@ -10,3 +10,4 @@
 # rspec failure tracking
 .rspec_status
 .env
+Gemfile.lock

data/.rubocop.yml

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

data/.ruby-version

@@ -1 +1 @@
-2.6.5
+2.7.2

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/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    shotgun_api_ruby (0.0.5)
+    shotgun_api_ruby (0.0.8)
       activesupport
       faraday (~> 1)
       zeitwerk (~> 2.2)
@@ -9,12 +9,12 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.0.3.3)
+    activesupport (6.1.0)
       concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-      zeitwerk (~> 2.2, >= 2.2.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
     ast (2.4.1)
     backport (1.1.2)
     benchmark (0.1.0)
@@ -27,84 +27,88 @@ GEM
     diff-lcs (1.4.4)
     dotenv (2.7.6)
     e2mmap (0.1.0)
-    faraday (1.0.1)
+    faraday (1.1.0)
       multipart-post (>= 1.2, < 3)
+      ruby2_keywords
     i18n (1.8.5)
       concurrent-ruby (~> 1.0)
     iniparse (1.5.0)
     jaro_winkler (1.5.4)
-    maruku (0.7.3)
+    kramdown (2.3.0)
+      rexml
+    kramdown-parser-gfm (1.1.0)
+      kramdown (~> 2.0)
     method_source (1.0.0)
     mini_portile2 (2.4.0)
     minitest (5.14.2)
     multipart-post (2.1.1)
     nokogiri (1.10.10)
       mini_portile2 (~> 2.4.0)
-    overcommit (0.55.0)
+    overcommit (0.57.0)
       childprocess (>= 0.6.3, < 5)
       iniparse (~> 1.4)
-    parallel (1.19.2)
-    parser (2.7.1.4)
+    parallel (1.20.1)
+    parser (2.7.2.0)
       ast (~> 2.4.1)
     pry (0.13.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
     rainbow (3.0.0)
     rake (13.0.1)
-    regexp_parser (1.8.0)
+    regexp_parser (2.0.0)
     reverse_markdown (2.0.0)
       nokogiri
     rexml (3.2.4)
-    rspec (3.9.0)
-      rspec-core (~> 3.9.0)
-      rspec-expectations (~> 3.9.0)
-      rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.2)
-      rspec-support (~> 3.9.3)
-    rspec-expectations (3.9.2)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.0)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-mocks (3.9.1)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-support (3.9.3)
-    rubocop (0.91.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.0)
+    rubocop (1.6.1)
       parallel (~> 1.10)
-      parser (>= 2.7.1.1)
+      parser (>= 2.7.1.5)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.7)
+      regexp_parser (>= 1.8, < 3.0)
       rexml
-      rubocop-ast (>= 0.4.0, < 1.0)
+      rubocop-ast (>= 1.2.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 2.0)
-    rubocop-ast (0.4.2)
-      parser (>= 2.7.1.4)
-    rubocop-performance (1.8.1)
-      rubocop (>= 0.87.0)
+    rubocop-ast (1.3.0)
+      parser (>= 2.7.1.5)
+    rubocop-performance (1.9.1)
+      rubocop (>= 0.90.0, < 2.0)
       rubocop-ast (>= 0.4.0)
     ruby-progressbar (1.10.1)
-    solargraph (0.39.15)
+    ruby2_keywords (0.0.2)
+    solargraph (0.40.0)
       backport (~> 1.1)
       benchmark
       bundler (>= 1.17.2)
       e2mmap
       jaro_winkler (~> 1.5)
-      maruku (~> 0.7, >= 0.7.3)
-      nokogiri (~> 1.9, >= 1.9.1)
+      kramdown (~> 2.3)
+      kramdown-parser-gfm (~> 1.1)
       parser (~> 2.3)
       reverse_markdown (>= 1.0.5, < 3)
-      rubocop (~> 0.52)
+      rubocop (>= 0.52)
       thor (~> 1.0)
       tilt (~> 2.0)
       yard (~> 0.9, >= 0.9.24)
     thor (1.0.1)
-    thread_safe (0.3.6)
     tilt (2.0.10)
-    tzinfo (1.2.7)
-      thread_safe (~> 0.1)
+    tzinfo (2.0.3)
+      concurrent-ruby (~> 1.0)
     unicode-display_width (1.7.0)
     yard (0.9.25)
-    zeitwerk (2.4.0)
+    zeitwerk (2.4.2)
 
 PLATFORMS
   ruby

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/client.rb

@@ -28,7 +28,7 @@ module ShotgunApiRuby
       public_send(type)
     end
 
-    def respond_to_missing?(_name, _include_private = false) # rubocop:disable Lint/MissingSuper,Style/OptionalBooleanParameter
+    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/entity.rb

@@ -14,7 +14,7 @@ module ShotgunApiRuby
         end
       end
 
-      def respond_to_missing?(name, _private_methods = false) # rubocop:disable Style/OptionalBooleanParameter
+      def respond_to_missing?(name, _private_methods = false)
         attributes.respond_to?(name) || super
       end
     end

data/lib/shotgun_api_ruby/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ShotgunApiRuby
-  VERSION = "0.0.5"
+  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,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shotgun_api_ruby
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.8
 platform: ruby
 authors:
 - Denis <Zaratan> Pasin
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-09-23 00:00:00.000000000 Z
+date: 2020-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -199,6 +199,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/test_and_publish.yml"
+- ".github/workflows/test_only.yml"
+- ".github/workflows/verify_version_change.yml"
 - ".gitignore"
 - ".overcommit.yml"
 - ".rspec"
@@ -207,6 +210,7 @@ files:
 - ".ruby-gemset"
 - ".ruby-version"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -219,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
@@ -230,7 +235,8 @@ licenses:
 metadata:
   homepage_uri: https://github.com/shotgunsoftware/shotgun_api_ruby
   source_code_uri: https://github.com/shotgunsoftware/shotgun_api_ruby
-post_install_message:
+  changelog_uri: https://github.com/shotgunsoftware/shotgun_api_ruby/blob/main/CHANGELOG.md
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -245,8 +251,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.8
-signing_key:
+rubygems_version: 3.1.4
+signing_key: 
 specification_version: 4
 summary: Gem to interact easily with Shotgun REST api.
 test_files: []