shotgun_api_ruby 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e2163b85f62993d2674a47792d3370ebcbf1a6c283e915c781bc27801868a172
-  data.tar.gz: e26ff2d7d7beae08aaa041f893bbb0f46eb44bd305313d576c2407a99a5e4123
+  metadata.gz: 010e99c46e52c21872edf3bb9c2a431a5382dc3129f087b2d362dac09bc9e644
+  data.tar.gz: fe83680e545108fb0e2687880801fc3b72316d6388d9af84e5015aa21abc9fdf
 SHA512:
-  metadata.gz: 5956601d851995c92204f03541b5c5e7e07a428df8170884d976b01388b1acfe4022d5781cea92510d6ef83e99ef25c5caa983b02a7d602267970afa3caf889f
-  data.tar.gz: 33c191b51f8ea193eedb15f5655b51d453173c41e86c0da1f8540e5d08c396e04522aa89fd8f66ea286ccf3d6df6bf3a28df4ddff6e5f77264cb1038bc6f1278
+  metadata.gz: 8c1f113a1fb94eed3b99bbfec633986f3e10208ae832b7756f825b2c3fce2163a255ab6747be704b8d2002dc980794028350c7d5176e34a30690be5d0f6596ef
+  data.tar.gz: 4cd377272e301f26ed52179bf6240ecdf74437d43c2461681053e67ee1f34899793ceef16adf029f2d4baad8490e4ef8ace9fcac8f379a4359fd29232bc7c560

data/Gemfile.lock

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

data/README.md

@@ -67,6 +67,48 @@ client = ShotgunApiRuby.new(shotgun_site: 'xxx', auth: {session_token: 'session_
 client = ShotgunApiRuby.new(shotgun_site: 'xxx', auth: {refresh_token: 'refresh_token'})
 ```
 
+### Server Infos
+
+Get general server infos:
+
+```ruby
+client.server_info.get
+
+#  #<OpenStruct
+      shotgun_version="v8.6.0.0-dev (build 12864de)",
+      api_version="v1",
+      shotgun_version_number="8.6.0.0-dev",
+      shotgun_build_number="12864de",
+      portfolio_version="UNKNOWN",
+      unified_login_flow_enabled=true,
+      user_authentication_method="default">
+```
+
+### Preferences
+
+Get some preferences infos:
+
+```ruby
+prefs = client.preferences.get
+prefs.to_h.keys
+
+# [:format_date_fields,
+# :date_component_order,
+# :format_time_hour_fields,
+# :format_currency_fields_display_dollar_sign,
+# :format_currency_fields_decimal_options,
+# :format_currency_fields_negative_options,
+# :format_number_fields,
+# :format_float_fields,
+# :format_float_fields_rounding,
+# :format_footage_fields,
+# :support_local_storage,
+# :view_master_settings,
+# :duration_units,
+# :hours_per_day,
+# :last_day_work_week]
+```
+
 ### Entities
 
 Querying entities is done by accessing the named method

data/lib/shotgun_api_ruby/client.rb

@@ -16,6 +16,14 @@ module ShotgunApiRuby
         end
     end
 
+    def preferences
+      @preferences = Preferences.new(connection)
+    end
+
+    def server_info
+      @server_info || ServerInfo.new(connection)
+    end
+
     def entities(type)
       public_send(type)
     end

data/lib/shotgun_api_ruby/preferences.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module ShotgunApiRuby
+  class Preferences
+    def initialize(connection)
+      @connection = connection.dup
+      @connection.url_prefix = "#{@connection.url_prefix}/preferences"
+    end
+
+    attr_reader :connection
+
+    def all
+      resp = @connection.get
+      resp_body = JSON.parse(resp.body)
+
+      if resp.status >= 300
+        raise "Error while getting server preferences: #{resp_body['errors']}"
+      end
+
+      data = resp_body["data"]
+      OpenStruct.new(data)
+    end
+  end
+end

data/lib/shotgun_api_ruby/server_info.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module ShotgunApiRuby
+  class ServerInfo
+    def initialize(connection)
+      @connection = connection
+    end
+
+    attr_reader :connection
+
+    def get
+      resp = @connection.get
+      resp_body = JSON.parse(resp.body)
+
+      if resp.status >= 300
+        raise "Error while getting server infos: #{resp_body['errors']}"
+      end
+
+      data = resp_body["data"]
+      OpenStruct.new(data)
+    end
+  end
+end

data/lib/shotgun_api_ruby/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: shotgun_api_ruby
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Denis <Zaratan> Pasin
@@ -191,6 +191,8 @@ files:
 - lib/shotgun_api_ruby/client.rb
 - lib/shotgun_api_ruby/entities.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
 - shotgun_api_ruby.gemspec
 homepage: https://github.com/shotgunsoftware/shotgun_api_ruby