shotgun_api_ruby 0.0.4.1 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2df57cc4c367e23b089c897b18dacf2232b3650d7acbfae545c248b6559be9a4
-  data.tar.gz: 3429d8d5c2e12b84b9434d76a25420f134ecca300c6836dea001a45df2539547
+  metadata.gz: 6e8f35c879d4875bb2fd7aaf64717735ef915ca5dd4229097eb9a9d3eb8265b1
+  data.tar.gz: 0576b201159e2dcf3cfdcf7805e26e70f6796475153b0c7712c634aa4bb7fd48
 SHA512:
-  metadata.gz: 6411ed8b2d37c6b8968ebc360eeb52c48331effeaa1d9c7e9c04826270e3ab553660ba72bb0f59fb91da8219a5b15d6bc614c42f117f1c3ce2cfa8e0d7c41497
-  data.tar.gz: b8ab75e066f1314028c3a7d1191f83291bbe475050b1327bb99f6411abe7d0a2d1af908a649e70ae92a94fc7f95792909ea7c33352596f6c36c3e861b23b3126
+  metadata.gz: 193682e3bbd32fdac36a9bebd5bd6c48d2e2e1652e6d6f1149a2bd103ef8028bcaae91f85320c322468e37bdbfb8e8667134a32dbe4c31c98b62799fa6551b70
+  data.tar.gz: e782ea8785bb79dbed938e966bfb80fddafcc4b058f62a65342451be01b4587fff6f67461ab3648c54bbfb01196b0121cbf92fb3067b98ed1b85ab3dcc596d1f

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    shotgun_api_ruby (0.0.4.1)
+    shotgun_api_ruby (0.0.5)
       activesupport
       faraday (~> 1)
       zeitwerk (~> 2.2)
@@ -51,7 +51,7 @@ GEM
       method_source (~> 1.0)
     rainbow (3.0.0)
     rake (13.0.1)
-    regexp_parser (1.7.1)
+    regexp_parser (1.8.0)
     reverse_markdown (2.0.0)
       nokogiri
     rexml (3.2.4)
@@ -77,10 +77,11 @@ GEM
       rubocop-ast (>= 0.4.0, < 1.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 2.0)
-    rubocop-ast (0.4.1)
+    rubocop-ast (0.4.2)
       parser (>= 2.7.1.4)
-    rubocop-performance (1.8.0)
+    rubocop-performance (1.8.1)
       rubocop (>= 0.87.0)
+      rubocop-ast (>= 0.4.0)
     ruby-progressbar (1.10.1)
     solargraph (0.39.15)
       backport (~> 1.1)

data/README.md

@@ -166,7 +166,7 @@ Does the same thing as `all`
 
 #### first
 
-Will return only the first entity found (same thing as setting the page_size to 1)
+Will return only the first entity found (same thing as setting the page_size to 1 and then getting the first result)
 
 ```
 client.assets.first
@@ -203,6 +203,14 @@ Example:
 client.assets.all(fields: [:code, :description], sort: {code: :asc, description: :desc})
 ```
 
+##### logical_operator
+
+Default: "and"
+
+This will be only used on complex queries. This is how we treat multiple first level conditions.
+
+Accepted values: 'and', 'or'
+
 ##### filter
 
 For simple filters, the filter field is waiting for a hash.
@@ -218,7 +226,33 @@ Example:
 client.assets.all(fields: [:code, :description], filter: {code: ['Buck', :Darcy], description: 'I LOVE SG'})
 ```
 
-For complex filters, see the documentation [here](https://developer.shotgunsoftware.com/rest-api/#searching)
+For complex filters, see the documentation [here](https://developer.shotgunsoftware.com/rest-api/#searching).
+
+If the filters are complex there's many cases:
+
+* If they are a hash containing logical_operator and conditions => we will use them
+* If the filter is **not** a hash => we will use it without translation
+* If the filter is a hash not containing "conditions". We will try to translate this to SG compatible query.
+
+Example:
+```ruby
+client.assets.all(
+  filter: {
+    project: { id: 2 },
+    sg_status_list: ["act", "hld", "omt"]
+  }, 
+)
+# Will be translated to:
+{
+  "filters"=>{
+    "conditions"=> [
+      ["project.Project.id", "is", 2], 
+      ["sg_status_list", "in", ["act", "hld", "omt"]]
+     ], 
+     "logical_operator"=>"and"
+   }
+}
+```
 
 The complexity of calling a different route and passing different headers/body/params will be taken care of automatically.
 

data/lib/shotgun_api_ruby/entities.rb

@@ -15,16 +15,18 @@ module ShotgunApiRuby
       sort: nil,
       filter: nil,
       retired: nil,
-      include_archived_projects: nil
+      include_archived_projects: nil,
+      logical_operator: 'and'
     )
       all(
         fields: fields,
         sort: sort,
         filter: filter,
         retired: retired,
+        logical_operator: logical_operator,
         include_archived_projects: include_archived_projects,
         page_size: 1
-      )
+      ).first
     end
 
     def find(id, fields: nil, retired: nil, include_archived_projects: nil)
@@ -52,6 +54,7 @@ module ShotgunApiRuby
 
     def all(
       fields: nil,
+      logical_operator: 'and',
       sort: nil,
       filter: nil,
       page: nil,
@@ -62,6 +65,7 @@ module ShotgunApiRuby
       if filter && !filters_are_simple?(filter)
         return search(
           fields: fields,
+          logical_operator: logical_operator,
           sort: sort,
           filter: filter,
           page: page,
@@ -99,6 +103,7 @@ module ShotgunApiRuby
 
     def search(
       fields: nil,
+      logical_operator: 'and',
       sort: nil,
       filter: nil,
       page: nil,
@@ -109,6 +114,7 @@ module ShotgunApiRuby
       if filter.nil? || filters_are_simple?(filter)
         return all(
           fields: fields,
+          logical_operator: logical_operator,
           sort: sort,
           filter: filter,
           page: page,
@@ -123,6 +129,16 @@ module ShotgunApiRuby
       params.add_sort(sort)
       params.add_page(page, page_size)
       params.add_options(retired, include_archived_projects)
+      new_filter = {}
+      if filter.is_a?(Hash)
+        new_filter[:conditions] =
+          (filter[:conditions] || translate_complex_to_sg_filters(filter))
+        new_filter[:logical_operator] = filter[:logical_operator] || filter['logical_operator'] || logical_operator
+      else
+        new_filter[:conditions] = filter
+        new_filter[:logical_operator] = logical_operator
+      end
+      filter = new_filter
 
       resp =
         @connection.post('_search', params) do |req|
@@ -132,6 +148,7 @@ 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)
 
@@ -156,8 +173,39 @@ module ShotgunApiRuby
       return false if filters.is_a? Array
 
       filters.values.all? do |filter_val|
-        (filter_val.is_a?(String) || filter_val.is_a?(Symbol)) ||
-          (filter_val.is_a?(Array) && filter_val.all?{ |val| val.is_a?(String) || val.is_a?(Symbol) })
+        (filter_val.is_a?(Integer) || filter_val.is_a?(String) || filter_val.is_a?(Symbol)) ||
+          (filter_val.is_a?(Array) && filter_val.all?{ |val|
+             val.is_a?(String) || val.is_a?(Symbol) || val.is_a?(Integer)
+           } )
+      end
+    end
+
+    def translate_complex_to_sg_filters(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, "is", value]
+        when Hash
+          value.each do |subfield, subvalue|
+            sanitized_subfield = "#{field.capitalize}.#{subfield}" unless subfield.to_s.include?(".")
+            case subvalue
+            when String, Symbol, Integer, Float
+              result << ["#{field}.#{sanitized_subfield}", "is", subvalue]
+            when Array
+              result << ["#{field}.#{sanitized_subfield}", "in", subvalue]
+            else
+              raise "This case is too complex to auto-translate. Please use shotgun query syntax."
+            end
+          end
+        when Array
+          result << [field, "in", value]
+        else
+          raise "This case is too complex to auto-translate. Please use shotgun query syntax."
+        end
       end
     end
   end

data/lib/shotgun_api_ruby/entities/params.rb

@@ -25,7 +25,12 @@ module ShotgunApiRuby
       end
 
       def add_fields(fields)
-        self[:fields] = [fields].flatten.join(',') if fields
+        self[:fields] =
+          if fields
+            [fields].flatten.join(',')
+          else
+            "*"
+          end
       end
 
       def add_options(return_only, include_archived_projects)
@@ -41,7 +46,13 @@ module ShotgunApiRuby
         return unless filters
 
         # filter
-        self['filter'] = filters.map do |field, value|
+        self['filter'] = translate_simple_filter_to_sg(filters)
+      end
+
+      private
+
+      def translate_simple_filter_to_sg(filters)
+        filters.map do |field, value|
           [
             field.to_s,
             value.is_a?(Array) ? value.map(&:to_s).join(',') : value.to_s,

data/lib/shotgun_api_ruby/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ShotgunApiRuby
-  VERSION = "0.0.4.1"
+  VERSION = "0.0.5"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shotgun_api_ruby
 version: !ruby/object:Gem::Version
-  version: 0.0.4.1
+  version: 0.0.5
 platform: ruby
 authors:
 - Denis <Zaratan> Pasin
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-09-18 00:00:00.000000000 Z
+date: 2020-09-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport