shotgun_api_ruby 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 81e63f04a043edf0f4e28d98959cde8ca3b28d758b899f13f2a6f0888d7e2c79
-  data.tar.gz: bc6c97071892f5f236d95e1f47d59ccff5e53c2b4cb0c370951f9823d243c9d3
+  metadata.gz: b6d880dc29b34107ab40d5a654154bdfdfdc1c952ddebe0064c6c75f19c3be66
+  data.tar.gz: 4ee1c00b595e5160abf204ec89eba23e166fa84e67f8b3b7c012e41cb4dcd3d9
 SHA512:
-  metadata.gz: 20fe88744936a2fce96771ca1abdb1310536d94547ecb276a6a28b052bb11794338dc49dde98e6a2846f9eba8a86cdbbd677b628ca2b9697d67679858827b1d9
-  data.tar.gz: 1fc22594f7144215eeed1b5895e3891ba5dab62ce9ccfa8b93181fa7268bf22f92420121bad44822d1fc9d67cc06361182bab0828cd0506f7f205c3933d4b98d
+  metadata.gz: 04b8b6b04c605b88ffd1b0368a1155b49473a2f8b2cc8d9e251bb9e5602b18c4ee0d83b91d99c60167064b8146d3afae15860e0db852cc5219b8e7dfee8c71fa
+  data.tar.gz: 9fc472cf42c00379eda01f84eecf39407ace44ff1f1f59622793a464e263cc8a611036151f8a030fce772dbebf5318735c2d026718f6fc6ab20ce739adf601e7

data/.rubocop-http---relaxed-ruby-style-rubocop-yml

@@ -1,5 +1,5 @@
 # Relaxed.Ruby.Style
-## Version 2.4
+## Version 2.5
 
 Style/Alias:
   Enabled: false
@@ -145,30 +145,9 @@ Lint/AssignmentInCondition:
   Enabled: false
   StyleGuide: https://relaxed.ruby.style/#lintassignmentincondition
 
-Metrics/AbcSize:
+Layout/LineLength:
   Enabled: false
 
-Metrics/BlockNesting:
-  Enabled: false
-
-Metrics/ClassLength:
-  Enabled: false
-
-Metrics/ModuleLength:
-  Enabled: false
-
-Metrics/CyclomaticComplexity:
-  Enabled: false
-
-Metrics/LineLength:
-  Enabled: false
-
-Metrics/MethodLength:
-  Enabled: false
-
-Metrics/ParameterLists:
-  Enabled: false
-
-Metrics/PerceivedComplexity:
+Metrics:
   Enabled: false
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    shotgun_api_ruby (0.0.3)
+    shotgun_api_ruby (0.0.4)
       activesupport
       faraday (~> 0.17)
       zeitwerk (~> 2.2)
@@ -9,12 +9,12 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.0.0)
+    activesupport (6.0.2.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
-      zeitwerk (~> 2.1, >= 2.1.8)
+      zeitwerk (~> 2.2)
     ast (2.4.0)
     bundler-audit (0.6.1)
       bundler (>= 1.2.0, < 3)
@@ -23,20 +23,20 @@ GEM
     coderay (1.1.2)
     concurrent-ruby (1.1.5)
     diff-lcs (1.3)
-    faraday (0.17.0)
+    faraday (0.17.3)
       multipart-post (>= 1.2, < 3)
-    i18n (1.7.0)
+    i18n (1.8.2)
       concurrent-ruby (~> 1.0)
     iniparse (1.4.4)
-    jaro_winkler (1.5.3)
+    jaro_winkler (1.5.4)
     method_source (0.9.2)
-    minitest (5.12.2)
+    minitest (5.14.0)
     multipart-post (2.1.1)
-    overcommit (0.51.0)
+    overcommit (0.52.1)
       childprocess (>= 0.6.3, < 4)
       iniparse (~> 1.4)
-    parallel (1.18.0)
-    parser (2.6.5.0)
+    parallel (1.19.1)
+    parser (2.7.0.2)
       ast (~> 2.4.0)
     pry (0.12.2)
       coderay (~> 1.1.0)
@@ -47,31 +47,31 @@ GEM
       rspec-core (~> 3.9.0)
       rspec-expectations (~> 3.9.0)
       rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.0)
-      rspec-support (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
     rspec-expectations (3.9.0)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
-    rspec-mocks (3.9.0)
+    rspec-mocks (3.9.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
-    rspec-support (3.9.0)
-    rubocop (0.75.1)
+    rspec-support (3.9.2)
+    rubocop (0.79.0)
       jaro_winkler (~> 1.5.1)
       parallel (~> 1.10)
-      parser (>= 2.6)
+      parser (>= 2.7.0.1)
       rainbow (>= 2.2.2, < 4.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 1.7)
-    rubocop-performance (1.5.0)
+    rubocop-performance (1.5.2)
       rubocop (>= 0.71.0)
     ruby-progressbar (1.10.1)
     thor (0.20.3)
     thread_safe (0.3.6)
-    tzinfo (1.2.5)
+    tzinfo (1.2.6)
       thread_safe (~> 0.1)
-    unicode-display_width (1.6.0)
-    zeitwerk (2.2.0)
+    unicode-display_width (1.6.1)
+    zeitwerk (2.2.2)
 
 PLATFORMS
   ruby

data/README.md

@@ -150,9 +150,9 @@ assets.first.attributes.code # => "Buck"
 assets.first.code # => "Buck"
 ```
 
-#### Get
+### Search
 
-##### all
+#### all
 
 The all call will return all possible entities.
 
@@ -160,11 +160,11 @@ The all call will return all possible entities.
 client.assets.all
 ```
 
-##### search
+#### search
 
 Does the same thing as `all`
 
-##### first
+#### first
 
 Will return only the first entity found (same thing as setting the page_size to 1)
 
@@ -172,6 +172,8 @@ Will return only the first entity found (same thing as setting the page_size to
 client.assets.first
 ```
 
+#### arguments
+
 ##### fields
 
 This attribute describe the wanted fields in the returned entity
@@ -251,6 +253,22 @@ client.assets.all(fields: [:code], retired: true)
 client.assets.all(fields: [:code], include_archived_projects: true)
 ```
 
+### Finding one element
+
+`find` function on `entities` allow you to get one element in particular.
+
+It accepts (all arguments are optional):
+
+- fields: string, symbol or array of fields
+- retired: boolean specifying if the record is retired
+- include_archived_projects: boolean specifying if the entity is part of an archived project
+
+Example:
+
+```ruby
+client.assets.find(724, fields: [:code, 'description'], retired: false)
+```
+
 #### Create
 
 Not implemented yet

data/lib/shotgun_api_ruby/entities.rb

@@ -27,6 +27,29 @@ module ShotgunApiRuby
       )
     end
 
+    def find(id, fields: nil, retired: nil, include_archived_projects: nil)
+      params = Params.new
+
+      params.add_fields(fields)
+      params.add_options(retired, include_archived_projects)
+
+      resp = @connection.get(id.to_s, params)
+      resp_body = JSON.parse(resp.body)
+
+      if resp.status >= 300
+        raise "Error while getting #{type}: #{resp_body['errors']}"
+      end
+
+      entity = resp_body["data"]
+      Entity.new(
+        entity['type'],
+        OpenStruct.new(entity['attributes']),
+        entity['relationships'],
+        entity['id'],
+        entity['links']
+      )
+    end
+
     def all(
       fields: nil,
       sort: nil,

data/lib/shotgun_api_ruby/version.rb

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

data/shotgun_api_ruby.gemspec

@@ -21,9 +21,10 @@ Gem::Specification.new do |spec|
 
   # 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.
-  spec.files = Dir.chdir(File.expand_path(__dir__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  end
+  spec.files =
+    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"]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shotgun_api_ruby
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Denis <Zaratan> Pasin
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-10-28 00:00:00.000000000 Z
+date: 2020-01-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport