shotgun_api_ruby 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 010e99c46e52c21872edf3bb9c2a431a5382dc3129f087b2d362dac09bc9e644
-  data.tar.gz: fe83680e545108fb0e2687880801fc3b72316d6388d9af84e5015aa21abc9fdf
+  metadata.gz: 81e63f04a043edf0f4e28d98959cde8ca3b28d758b899f13f2a6f0888d7e2c79
+  data.tar.gz: bc6c97071892f5f236d95e1f47d59ccff5e53c2b4cb0c370951f9823d243c9d3
 SHA512:
-  metadata.gz: 8c1f113a1fb94eed3b99bbfec633986f3e10208ae832b7756f825b2c3fce2163a255ab6747be704b8d2002dc980794028350c7d5176e34a30690be5d0f6596ef
-  data.tar.gz: 4cd377272e301f26ed52179bf6240ecdf74437d43c2461681053e67ee1f34899793ceef16adf029f2d4baad8490e4ef8ace9fcac8f379a4359fd29232bc7c560
+  metadata.gz: 20fe88744936a2fce96771ca1abdb1310536d94547ecb276a6a28b052bb11794338dc49dde98e6a2846f9eba8a86cdbbd677b628ca2b9697d67679858827b1d9
+  data.tar.gz: 1fc22594f7144215eeed1b5895e3891ba5dab62ce9ccfa8b93181fa7268bf22f92420121bad44822d1fc9d67cc06361182bab0828cd0506f7f205c3933d4b98d

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    shotgun_api_ruby (0.0.2)
+    shotgun_api_ruby (0.0.3)
       activesupport
       faraday (~> 0.17)
       zeitwerk (~> 2.2)

data/README.md

@@ -160,6 +160,18 @@ The all call will return all possible entities.
 client.assets.all
 ```
 
+##### search
+
+Does the same thing as `all`
+
+##### first
+
+Will return only the first entity found (same thing as setting the page_size to 1)
+
+```
+client.assets.first
+```
+
 ##### fields
 
 This attribute describe the wanted fields in the returned entity
@@ -191,8 +203,6 @@ client.assets.all(fields: [:code, :description], sort: {code: :asc, description:
 
 ##### filter
 
-**Complex filters are not implemented yet**
-
 For simple filters, the filter field is waiting for a hash.
 
 Each value is:
@@ -206,6 +216,10 @@ 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)
+
+The complexity of calling a different route and passing different headers/body/params will be taken care of automatically.
+
 ##### page
 
 You can ask for any page size or page number.

data/lib/shotgun_api_ruby/entities.rb

@@ -10,6 +10,23 @@ module ShotgunApiRuby
 
     attr_reader :connection, :type
 
+    def first(
+      fields: nil,
+      sort: nil,
+      filter: nil,
+      retired: nil,
+      include_archived_projects: nil
+    )
+      all(
+        fields: fields,
+        sort: sort,
+        filter: filter,
+        retired: retired,
+        include_archived_projects: include_archived_projects,
+        page_size: 1
+      )
+    end
+
     def all(
       fields: nil,
       sort: nil,
@@ -19,7 +36,17 @@ module ShotgunApiRuby
       retired: nil,
       include_archived_projects: nil
     )
-      raise "Complex filters aren't supported yet" if filter && !filters_are_simple?(filter)
+      if filter && !filters_are_simple?(filter)
+        return search(
+          fields: fields,
+          sort: sort,
+          filter: filter,
+          page: page,
+          page_size: page_size,
+          retired: retired,
+          include_archived_projects: include_archived_projects
+        )
+      end
 
       params = Params.new
 
@@ -47,60 +74,67 @@ module ShotgunApiRuby
       end
     end
 
-    private
-
-    def filters_are_simple?(filters)
-      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) })
+    def search(
+      fields: nil,
+      sort: nil,
+      filter: nil,
+      page: nil,
+      page_size: nil,
+      retired: nil,
+      include_archived_projects: nil
+    )
+      if filter.nil? || filters_are_simple?(filter)
+        return all(
+          fields: fields,
+          sort: sort,
+          filter: filter,
+          page: page,
+          page_size: page_size,
+          retired: retired,
+          include_archived_projects: include_archived_projects
+        )
       end
-    end
+      params = Params.new
 
-    class Params < Hash
-      def add_sort(sort)
-        return unless sort
+      params.add_fields(fields)
+      params.add_sort(sort)
+      params.add_page(page, page_size)
+      params.add_options(retired, include_archived_projects)
 
-        self[:sort] =
-          if sort.is_a?(Hash)
-            sort.map{ |field, direction| "#{direction.to_s.start_with?('desc') ? '-' : ''}#{field}" }.join(',')
+      resp =
+        @connection.post('_search', params) do |req|
+          if filter.is_a? Array
+            req.headers["Content-Type"] = 'application/vnd+shotgun.api3_array+json'
           else
-            [sort].flatten.join(',')
+            req.headers['Content-Type'] = 'application/vnd+shotgun.api3_hash+json'
           end
-      end
-
-      def add_page(page, page_size)
-        return unless page || page_size
-
-        page = page.to_i if page
-        page_size = page_size.to_i if page_size
+          req.body = params.to_h.merge(filters: filter).to_json
+        end
+      resp_body = JSON.parse(resp.body)
 
-        page = 1 if page && page < 1
-        self[:page] = { size: page_size || 20, number: page || 1 }
+      if resp.status >= 300
+        raise "Error while getting #{type}: #{resp_body['errors']}"
       end
 
-      def add_fields(fields)
-        self[:fields] = [fields].flatten.join(',') if fields
+      resp_body["data"].map do |entity|
+        Entity.new(
+          entity['type'],
+          OpenStruct.new(entity['attributes']),
+          entity['relationships'],
+          entity['id'],
+          entity['links']
+        )
       end
+    end
 
-      def add_options(return_only, include_archived_projects)
-        return if return_only.nil? && include_archived_projects.nil?
-
-        self[:options] = {
-          return_only: return_only ? 'retired' : 'active',
-          include_archived_projects: !!include_archived_projects,
-        }
-      end
+    private
 
-      def add_filter(filters)
-        return unless filters
+    def filters_are_simple?(filters)
+      return false if filters.is_a? Array
 
-        # filter
-        self['filter'] = filters.map do |field, value|
-          [
-            field.to_s,
-            value.is_a?(Array) ? value.map(&:to_s).join(',') : value.to_s,
-          ]
-        end.to_h
+      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) })
       end
     end
   end

data/lib/shotgun_api_ruby/entities/params.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module ShotgunApiRuby
+  class Entities
+    class Params < Hash
+      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(',')
+          else
+            [sort].flatten.join(',')
+          end
+      end
+
+      def add_page(page, page_size)
+        return unless page || page_size
+
+        page = page.to_i if page
+        page_size = page_size.to_i if page_size
+
+        page = 1 if page && page < 1
+        self[:page] = { size: page_size || 20, number: page || 1 }
+      end
+
+      def add_fields(fields)
+        self[:fields] = [fields].flatten.join(',') if fields
+      end
+
+      def add_options(return_only, include_archived_projects)
+        return if return_only.nil? && include_archived_projects.nil?
+
+        self[:options] = {
+          return_only: return_only ? 'retired' : 'active',
+          include_archived_projects: !!include_archived_projects,
+        }
+      end
+
+      def add_filter(filters)
+        return unless filters
+
+        # filter
+        self['filter'] = filters.map do |field, value|
+          [
+            field.to_s,
+            value.is_a?(Array) ? value.map(&:to_s).join(',') : value.to_s,
+          ]
+        end.to_h
+      end
+    end
+  end
+end

data/lib/shotgun_api_ruby/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: shotgun_api_ruby
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Denis <Zaratan> Pasin
@@ -190,6 +190,7 @@ files:
 - lib/shotgun_api_ruby/auth.rb
 - lib/shotgun_api_ruby/client.rb
 - lib/shotgun_api_ruby/entities.rb
+- lib/shotgun_api_ruby/entities/params.rb
 - lib/shotgun_api_ruby/entity.rb
 - lib/shotgun_api_ruby/preferences.rb
 - lib/shotgun_api_ruby/server_info.rb