shotgun_api_ruby 0.0.8 → 0.1.1

data/lib/shotgun_api_ruby/entities/params.rb

@@ -3,12 +3,17 @@
 module ShotgunApiRuby
   class Entities
     class Params < Hash
+      class TooComplexFiltersError < StandardError
+      end
+
       def add_sort(sort)
         return unless sort
 
         self[:sort] =
           if sort.is_a?(Hash)
-            sort.map{ |field, direction| "#{direction.to_s.start_with?('desc') ? '-' : ''}#{field}" }.join(',')
+            sort.map do |field, direction|
+              "#{direction.to_s.start_with?('desc') ? '-' : ''}#{field}"
+            end.join(',')
           else
             [sort].flatten.join(',')
           end
@@ -26,11 +31,7 @@ module ShotgunApiRuby
 
       def add_fields(fields)
         self[:fields] =
-          if fields
-            [fields].flatten.join(',')
-          else
-            "*"
-          end
+          fields && !fields.empty? ? [fields].flatten.join(',') : '*'
       end
 
       def add_options(return_only, include_archived_projects)
@@ -42,16 +43,95 @@ module ShotgunApiRuby
         }
       end
 
-      def add_filter(filters)
+      def add_filter(filters, logical_operator = 'and')
         return unless filters
 
-        # filter
-        self['filter'] = translate_simple_filter_to_sg(filters)
+        self[:filter] =
+          if (self.class.filters_are_simple?(filters))
+            translate_simple_filters_to_sg(filters)
+          elsif filters.is_a? Hash
+            {
+              conditions:
+                filters[:conditions] || filters['conditions'] ||
+                  translate_complex_filters_to_sg(filters),
+              logical_operator:
+                filters[:logical_operator] || filters['logical_operator'] ||
+                  logical_operator,
+            }
+          else
+            { conditions: filters, logical_operator: logical_operator }
+          end
+      end
+
+      def add_grouping(grouping)
+        return unless grouping
+
+        if grouping.is_a? Array
+          self[:grouping] = grouping
+          return
+        end
+
+        self[:grouping] =
+          grouping
+            .each
+            .with_object([]) do |(key, options), result|
+              if options.is_a? Hash
+                result << {
+                  field: key.to_s,
+                  type:
+                    options[:type]&.to_s || options['type']&.to_s || 'exact',
+                  direction:
+                    options[:direction]&.to_s || options['direction']&.to_s ||
+                      'asc',
+                }
+              else
+                result << {
+                  field: key.to_s,
+                  type: 'exact',
+                  direction: options.to_s,
+                }
+              end
+            end
+      end
+
+      def add_summary_fields(summary_fields)
+        return unless summary_fields
+
+        if summary_fields.is_a? Array
+          self[:summary_fields] = summary_fields
+          return
+        end
+
+        if summary_fields.is_a? Hash
+          self[:summary_fields] =
+            summary_fields.map { |k, v| { field: k.to_s, type: v.to_s } }
+        end
+      end
+
+      def self.filters_are_simple?(filters)
+        return false if filters.is_a? Array
+
+        if filters.is_a?(Hash) &&
+             (filters[:conditions] || filters['conditions'])
+          return false
+        end
+
+        filters.values.all? do |filter_val|
+          (
+            filter_val.is_a?(Integer) || filter_val.is_a?(String) ||
+              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
+            )
+        end
       end
 
       private
 
-      def translate_simple_filter_to_sg(filters)
+      def translate_simple_filters_to_sg(filters)
         filters.map do |field, value|
           [
             field.to_s,
@@ -59,6 +139,44 @@ module ShotgunApiRuby
           ]
         end.to_h
       end
+
+      def translate_complex_filters_to_sg(filters)
+        # We don't know how to translate anything but hashes
+        return filters if !filters.is_a?(Hash)
+
+        filters
+          .each
+          .with_object([]) do |item, result|
+            field, value = item
+            case value
+            when String, Symbol, Integer, Float
+              result << [field.to_s, 'is', value]
+            when Hash
+              value.each do |subfield, subvalue|
+                sanitized_subfield =
+                  if !subfield.to_s.include?('.')
+                    "#{field.capitalize}.#{subfield}"
+                  else
+                    subfield
+                  end
+                case subvalue
+                when String, Symbol, Integer, Float
+                  result << ["#{field}.#{sanitized_subfield}", 'is', subvalue]
+                when Array
+                  result << ["#{field}.#{sanitized_subfield}", 'in', subvalue]
+                else
+                  raise TooComplexFiltersError,
+                        'This case is too complex to auto-translate. Please use shotgun query syntax.'
+                end
+              end
+            when Array
+              result << [field.to_s, 'in', value]
+            else
+              raise TooComplexFiltersError,
+                    'This case is too complex to auto-translate. Please use shotgun query syntax.'
+            end
+          end
+      end
     end
   end
 end

data/lib/shotgun_api_ruby/entities/schema.rb

@@ -19,9 +19,7 @@ module ShotgunApiRuby
 
         resp_body = JSON.parse(resp.body)
 
-        OpenStruct.new(
-          resp_body["data"].transform_values{ |v| v["value"] }
-        )
+        OpenStruct.new(resp_body['data'].transform_values { |v| v['value'] })
       end
 
       def fields
@@ -33,15 +31,18 @@ module ShotgunApiRuby
         end
 
         OpenStruct.new(
-          resp_body["data"].transform_values do |value|
+          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"] })
-              )
+              value.transform_values { |attribute| attribute['value'] }.merge(
+                properties:
+                  OpenStruct.new(
+                    value['properties'].transform_values do |prop|
+                      prop['value']
+                    end,
+                  ),
+              ),
             )
-          end
+          end,
         )
       end
     end

data/lib/shotgun_api_ruby/entities/summarize.rb

@@ -0,0 +1,64 @@
+module ShotgunApiRuby
+  class Entities
+    class Summarize
+      Summary = Struct.new(:summaries, :groups)
+
+      def initialize(connection, type, base_url_prefix)
+        @connection = connection.dup
+        @type = type
+        @connection.url_prefix = "#{base_url_prefix}/entity/#{type}/_summarize"
+      end
+      attr_reader :type, :connection
+
+      def count(filter: nil, logical_operator: 'and')
+        result =
+          summarize(
+            filter: filter,
+            logical_operator: logical_operator,
+            summary_fields: [{ type: :record_count, field: 'id' }],
+          )
+        result.summaries&.[]('id') || 0
+      end
+
+      def summarize(
+        filter: nil,
+        grouping: nil,
+        summary_fields: nil,
+        logical_operator: 'and',
+        include_archived_projects: nil
+      )
+        params = Params.new
+
+        params.add_filter(filter, logical_operator)
+
+        params[:filters] = params[:filter] if params[:filter]
+        params.delete(:filter)
+
+        params.add_grouping(grouping)
+        params.add_summary_fields(summary_fields)
+        params.add_options(nil, include_archived_projects)
+
+        resp =
+          @connection.post('', params) do |req|
+            req.headers['Content-Type'] =
+              if params[:filters].is_a? Array
+                'application/vnd+shotgun.api3_array+json'
+              else
+                'application/vnd+shotgun.api3_hash+json'
+              end
+            req.body = params.to_h.to_json
+          end
+        resp_body = JSON.parse(resp.body)
+
+        if resp.status >= 300
+          raise "Error while getting summarize for #{type}: #{resp_body['errors']}"
+        end
+
+        Summary.new(
+          resp_body['data']['summaries'],
+          resp_body['data']&.[]('groups'),
+        )
+      end
+    end
+  end
+end

data/lib/shotgun_api_ruby/entity.rb

@@ -1,13 +1,12 @@
 # frozen_string_literal: true
 
 module ShotgunApiRuby
+  # Represent each entity returned by Shotgun
   Entity =
     Struct.new(:type, :attributes, :relationships, :id, :links) do
       def method_missing(name, *args, &block)
         if attributes.respond_to?(name)
-          define_singleton_method(name) do
-            attributes.public_send(name)
-          end
+          define_singleton_method(name) { attributes.public_send(name) }
           public_send(name)
         else
           super

data/lib/shotgun_api_ruby/preferences.rb

@@ -17,7 +17,7 @@ module ShotgunApiRuby
         raise "Error while getting server preferences: #{resp_body['errors']}"
       end
 
-      data = resp_body["data"]
+      data = resp_body['data']
       OpenStruct.new(data)
     end
   end

data/lib/shotgun_api_ruby/server_info.rb

@@ -16,7 +16,7 @@ module ShotgunApiRuby
         raise "Error while getting server infos: #{resp_body['errors']}"
       end
 
-      data = resp_body["data"]
+      data = resp_body['data']
       OpenStruct.new(data)
     end
   end

data/lib/shotgun_api_ruby/version.rb

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

data/package.json

@@ -0,0 +1,12 @@
+{
+  "name": "shotgun_api_ruby",
+  "version": "1.0.0",
+  "main": "index.js",
+  "repository": "git@github.com:shotgunsoftware/shotgun_api_ruby.git",
+  "author": "Denis <Zaratan> Pasin <zaratan@hey.com>",
+  "license": "MIT",
+  "devDependencies": {
+    "@prettier/plugin-ruby": "^1.3.0",
+    "prettier": "^2.2.1"
+  }
+}

data/shotgun_api_ruby.gemspec

@@ -26,8 +26,6 @@ Gem::Specification.new do |spec|
     Dir.chdir(File.expand_path(__dir__)) do
       `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
     end
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
   spec.add_dependency "activesupport"
@@ -37,11 +35,20 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "bundler-audit"
   spec.add_development_dependency "dotenv"
+  spec.add_development_dependency 'faker', '> 1.8'
+  spec.add_development_dependency 'guard-rspec', '> 4.7'
   spec.add_development_dependency "overcommit"
+  spec.add_development_dependency "prettier"
   spec.add_development_dependency "pry"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency 'rspec_in_context', '> 1'
   spec.add_development_dependency "rubocop"
+  spec.add_development_dependency 'rubocop-faker'
   spec.add_development_dependency "rubocop-performance"
+  spec.add_development_dependency 'simplecov', '> 0.16'
   spec.add_development_dependency "solargraph"
+  spec.add_development_dependency 'timecop'
+  spec.add_development_dependency 'vcr'
+  spec.add_development_dependency 'yard'
 end

data/yarn.lock

@@ -0,0 +1,15 @@
+# THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
+# yarn lockfile v1
+
+
+"@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==
+  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==

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shotgun_api_ruby
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.1.1
 platform: ruby
 authors:
 - Denis <Zaratan> Pasin
 autorequire: 
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2020-12-16 00:00:00.000000000 Z
+date: 2021-06-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -94,6 +94,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: faker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '4.7'
 - !ruby/object:Gem::Dependency
   name: overcommit
   requirement: !ruby/object:Gem::Requirement
@@ -108,6 +136,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: prettier
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -150,6 +192,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec_in_context
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '1'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -164,6 +220,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-faker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
@@ -178,6 +248,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '0.16'
 - !ruby/object:Gem::Dependency
   name: solargraph
   requirement: !ruby/object:Gem::Requirement
@@ -192,6 +276,48 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Gem to facilitate the interaction with Shotgun's REST API.
 email:
 - denis.pasin@autodesk.com
@@ -204,6 +330,7 @@ files:
 - ".github/workflows/verify_version_change.yml"
 - ".gitignore"
 - ".overcommit.yml"
+- ".prettierrc.js"
 - ".rspec"
 - ".rubocop-http---relaxed-ruby-style-rubocop-yml"
 - ".rubocop.yml"
@@ -212,11 +339,13 @@ files:
 - ".travis.yml"
 - CHANGELOG.md
 - Gemfile
-- Gemfile.lock
+- Guardfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/console
+- bin/prettirun
+- bin/ruborun
 - bin/setup
 - lib/shotgun_api_ruby.rb
 - lib/shotgun_api_ruby/auth.rb
@@ -224,11 +353,14 @@ files:
 - lib/shotgun_api_ruby/entities.rb
 - lib/shotgun_api_ruby/entities/params.rb
 - lib/shotgun_api_ruby/entities/schema.rb
+- lib/shotgun_api_ruby/entities/summarize.rb
 - lib/shotgun_api_ruby/entity.rb
 - lib/shotgun_api_ruby/preferences.rb
 - lib/shotgun_api_ruby/server_info.rb
 - lib/shotgun_api_ruby/version.rb
+- package.json
 - shotgun_api_ruby.gemspec
+- yarn.lock
 homepage: https://github.com/shotgunsoftware/shotgun_api_ruby
 licenses:
 - MIT
@@ -251,7 +383,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.2.15
 signing_key: 
 specification_version: 4
 summary: Gem to interact easily with Shotgun REST api.