shotgrid_api_ruby 0.1.3 → 0.2.0.1

data/lib/shotgrid_api_ruby/entities.rb

@@ -1,16 +1,39 @@
+# typed: strict
 # frozen_string_literal: true
 
 module ShotgridApiRuby
   class Entities
+    extend T::Sig
+
+    sig do
+      params(connection: Faraday::Connection, type: T.any(String, Symbol)).void
+    end
     def initialize(connection, type)
-      @connection = connection.dup
-      @type = type
-      @base_url_prefix = @connection.url_prefix
+      @connection = T.let(connection.dup, Faraday::Connection)
+      @type = T.let(type.to_s, String)
+      @base_url_prefix = T.let(@connection.url_prefix, URI)
       @connection.url_prefix = "#{@connection.url_prefix}/entity/#{type}"
+      @schema_client = T.let(nil, T.nilable(Schema))
+      @summary_client = T.let(nil, T.nilable(Summarize))
     end
 
-    attr_reader :connection, :type
+    sig { returns(Faraday::Connection) }
+    attr_reader :connection
+
+    sig { returns(String) }
+    attr_reader :type
 
+    sig do
+      params(
+          fields: Params::FIELDS_TYPE,
+          sort: Params::SORT_TYPE,
+          filter: Params::FILTERS_FIELD_TYPE,
+          retired: T.nilable(T::Boolean),
+          include_archived_projects: T.nilable(T::Boolean),
+          logical_operator: Params::LOGICAL_OPERATOR_TYPE,
+        )
+        .returns(T.nilable(Entity))
+    end
     def first(
       fields: nil,
       sort: nil,
@@ -30,6 +53,15 @@ module ShotgridApiRuby
       ).first
     end
 
+    sig do
+      params(
+          id: Integer,
+          fields: Params::FIELDS_TYPE,
+          retired: T.nilable(T::Boolean),
+          include_archived_projects: T.nilable(T::Boolean),
+        )
+        .returns(ShotgridApiRuby::Entity)
+    end
     def find(id, fields: nil, retired: nil, include_archived_projects: nil)
       params = Params.new
 
@@ -48,14 +80,18 @@ module ShotgridApiRuby
 
       entity = resp_body['data']
       Entity.new(
-        entity['type'],
-        OpenStruct.new(entity['attributes']),
-        entity['relationships'],
-        entity['id'],
-        entity['links'],
+        type: entity['type'],
+        attributes: OpenStruct.new(entity['attributes']),
+        relationships: entity['relationships'],
+        id: entity['id'],
+        links: entity['links'],
       )
     end
 
+    sig do
+      params(attributes: T::Hash[T.any(String, Symbol), T.untyped])
+        .returns(ShotgridApiRuby::Entity)
+    end
     def create(attributes)
       resp =
         @connection.post('', attributes.to_json) do |req|
@@ -76,14 +112,18 @@ module ShotgridApiRuby
 
       entity = resp_body['data']
       Entity.new(
-        entity['type'],
-        OpenStruct.new(entity['attributes']),
-        entity['relationships'],
-        entity['id'],
-        entity['links'],
+        type: entity['type'],
+        attributes: OpenStruct.new(entity['attributes']),
+        relationships: entity['relationships'],
+        id: entity['id'],
+        links: entity['links'],
       )
     end
 
+    sig do
+      params(id: Integer, changes: T::Hash[T.any(String, Symbol), T.untyped])
+        .returns(ShotgridApiRuby::Entity)
+    end
     def update(id, changes)
       return find(id) if changes.empty?
 
@@ -106,14 +146,15 @@ module ShotgridApiRuby
 
       entity = resp_body['data']
       Entity.new(
-        entity['type'],
-        OpenStruct.new(entity['attributes']),
-        entity['relationships'],
-        entity['id'],
-        entity['links'],
+        type: entity['type'],
+        attributes: OpenStruct.new(entity['attributes']),
+        relationships: entity['relationships'],
+        id: entity['id'],
+        links: entity['links'],
       )
     end
 
+    sig { params(id: Integer).returns(TrueClass) }
     def delete(id)
       resp =
         @connection.delete(id.to_s) do |req|
@@ -132,6 +173,7 @@ module ShotgridApiRuby
       true
     end
 
+    sig { params(id: Integer).returns(TrueClass) }
     def revive(id)
       resp = @connection.post("#{id}?revive=true")
 
@@ -147,6 +189,19 @@ module ShotgridApiRuby
       true
     end
 
+    sig do
+      params(
+          fields: Params::FIELDS_TYPE,
+          logical_operator: Params::LOGICAL_OPERATOR_TYPE,
+          sort: Params::SORT_TYPE,
+          filter: Params::FILTERS_FIELD_TYPE,
+          page: Params::PAGE_TYPE,
+          page_size: Params::PAGE_SIZE_TYPE,
+          retired: T.nilable(T::Boolean),
+          include_archived_projects: T.nilable(T::Boolean),
+        )
+        .returns(T::Array[Entity])
+    end
     def all(
       fields: nil,
       logical_operator: 'and',
@@ -192,15 +247,28 @@ module ShotgridApiRuby
 
       resp_body['data'].map do |entity|
         Entity.new(
-          entity['type'],
-          OpenStruct.new(entity['attributes']),
-          entity['relationships'],
-          entity['id'],
-          entity['links'],
+          type: entity['type'],
+          attributes: OpenStruct.new(entity['attributes']),
+          relationships: entity['relationships'],
+          id: entity['id'],
+          links: entity['links'],
         )
       end
     end
 
+    sig do
+      params(
+          fields: Params::FIELDS_TYPE,
+          logical_operator: Params::LOGICAL_OPERATOR_TYPE,
+          sort: Params::SORT_TYPE,
+          filter: Params::FILTERS_FIELD_TYPE,
+          page: Params::PAGE_TYPE,
+          page_size: Params::PAGE_SIZE_TYPE,
+          retired: T.nilable(T::Boolean),
+          include_archived_projects: T.nilable(T::Boolean),
+        )
+        .returns(T::Array[Entity])
+    end
     def search(
       fields: nil,
       logical_operator: 'and',
@@ -258,35 +326,56 @@ module ShotgridApiRuby
 
       resp_body['data'].map do |entity|
         Entity.new(
-          entity['type'],
-          OpenStruct.new(entity['attributes']),
-          entity['relationships'],
-          entity['id'],
-          entity['links'],
+          type: entity['type'],
+          attributes: OpenStruct.new(entity['attributes']),
+          relationships: entity['relationships'],
+          id: entity['id'],
+          links: entity['links'],
         )
       end
     end
 
+    sig { returns(Schema) }
     def schema_client
       @schema_client ||= Schema.new(connection, type, @base_url_prefix)
     end
 
+    sig { returns(OpenStruct) }
     def schema
       schema_client.read
     end
 
+    sig { returns(OpenStruct) }
     def fields
       schema_client.fields
     end
 
+    sig { returns(Summarize) }
     def summary_client
       @summary_client ||= Summarize.new(connection, type, @base_url_prefix)
     end
 
+    sig do
+      params(
+          filter: Params::FILTERS_FIELD_TYPE,
+          logical_operator: Params::LOGICAL_OPERATOR_TYPE,
+        )
+        .returns(T.untyped)
+    end
     def count(filter: nil, logical_operator: 'and')
       summary_client.count(filter: filter, logical_operator: logical_operator)
     end
 
+    sig do
+      params(
+          filter: Params::FILTERS_FIELD_TYPE,
+          grouping: Params::GROUPING_FIELD_TYPE,
+          summary_fields: Params::SUMMARY_FILEDS_TYPE,
+          logical_operator: Params::LOGICAL_OPERATOR_TYPE,
+          include_archived_projects: T.nilable(T::Boolean),
+        )
+        .returns(Summarize::Summary)
+    end
     def summarize(
       filter: nil,
       grouping: nil,

data/lib/shotgrid_api_ruby/entity.rb

@@ -1,20 +1,37 @@
+# typed: strict
 # frozen_string_literal: true
 
 module ShotgridApiRuby
   # Represent each entity returned by Shotgrid
-  Entity =
-    Struct.new(:type, :attributes, :relationships, :id, :links) do
-      def method_missing(name, *args, &block)
-        if attributes.respond_to?(name)
-          define_singleton_method(name) { attributes.public_send(name) }
-          public_send(name)
-        else
-          super
-        end
-      end
+  class Entity < T::Struct
+    extend T::Sig
+
+    # .new(:type, :attributes, :relationships, :id, :links) do
+    const :type, String
+    const :attributes, OpenStruct
+    const :relationships, T::Hash[T.untyped, T.untyped]
+    const :id, Integer
+    const :links, T::Hash[String, String]
 
-      def respond_to_missing?(name, _private_methods = false)
-        attributes.respond_to?(name) || super
+    sig do
+      params(name: T.any(String, Symbol), args: T.untyped, block: T.untyped)
+        .returns(T.untyped)
+    end
+    def method_missing(name, *args, &block)
+      if attributes.respond_to?(name)
+        define_singleton_method(name) { attributes.public_send(name) }
+        public_send(name)
+      else
+        super
       end
     end
+
+    sig do
+      params(name: T.any(String, Symbol), _private_methods: T.untyped)
+        .returns(T::Boolean)
+    end
+    def respond_to_missing?(name, _private_methods = false)
+      attributes.respond_to?(name) || super
+    end
+  end
 end

data/lib/shotgrid_api_ruby/preferences.rb

@@ -1,14 +1,20 @@
+# typed: strict
 # frozen_string_literal: true
 
 module ShotgridApiRuby
   class Preferences
+    extend T::Sig
+
+    sig { params(connection: Faraday::Connection).void }
     def initialize(connection)
-      @connection = connection.dup
+      @connection = T.let(connection.dup, Faraday::Connection)
       @connection.url_prefix = "#{@connection.url_prefix}/preferences"
     end
 
+    sig { returns(Faraday::Connection) }
     attr_reader :connection
 
+    sig { returns(OpenStruct) }
     def all
       resp = @connection.get
       resp_body = JSON.parse(resp.body)

data/lib/shotgrid_api_ruby/server_info.rb

@@ -1,13 +1,19 @@
+# typed: strict
 # frozen_string_literal: true
 
 module ShotgridApiRuby
   class ServerInfo
+    extend T::Sig
+
+    sig { params(connection: Faraday::Connection).void }
     def initialize(connection)
-      @connection = connection
+      @connection = T.let(connection, Faraday::Connection)
     end
 
+    sig { returns(Faraday::Connection) }
     attr_reader :connection
 
+    sig { returns(OpenStruct) }
     def get
       resp = @connection.get
       resp_body = JSON.parse(resp.body)

data/lib/shotgrid_api_ruby/shotgrid_call_error.rb

@@ -1,14 +1,18 @@
+# typed: strict
 require 'forwardable'
 
 module ShotgridApiRuby
   class ShotgridCallError < StandardError
+    extend T::Sig
     extend Forwardable
 
+    sig { params(response: T.untyped, message: String).void }
     def initialize(response:, message:)
-      @response = response
+      @response = T.let(response, T.untyped)
       super(message)
     end
 
+    sig { returns(T.untyped) }
     attr_reader :response
     def_delegators :response, :status
   end

data/lib/shotgrid_api_ruby/types/auth_type.rb

@@ -0,0 +1,23 @@
+# typed: strict
+
+module ShotgridApiRuby
+  module Types
+    AuthType =
+      T.type_alias do
+        T.any(
+          { client_id: String, client_secret: String },
+          { 'client_id' => String, :client_secret => String },
+          { :client_id => String, 'client_secret' => String },
+          { 'client_id' => String, 'client_secret' => String },
+          { username: String, password: String },
+          { 'username' => String, :password => String },
+          { :username => String, 'password' => String },
+          { 'username' => String, 'password' => String },
+          { refresh_token: String },
+          { 'refresh_token' => String },
+          { session_token: String },
+          { 'session_token' => String },
+        )
+      end
+  end
+end

data/lib/shotgrid_api_ruby/version.rb

@@ -1,5 +1,6 @@
+# typed: strict
 # frozen_string_literal: true
 
 module ShotgridApiRuby
-  VERSION = '0.1.3'
+  VERSION = '0.2.0.1'
 end

data/lib/shotgrid_api_ruby.rb

@@ -1,3 +1,4 @@
+# typed: strict
 # frozen_string_literal: true
 
 # zeitwerk will take care of auto loading files based on their name :)
@@ -5,14 +6,31 @@ require 'zeitwerk'
 require 'active_support/core_ext/string/inflections'
 require 'ostruct'
 require 'faraday'
+require 'sorbet-runtime'
 require 'json'
 
 loader = Zeitwerk::Loader.for_gem
 loader.setup # ready!
 
 module ShotgridApiRuby
-  def self.new(**args)
-    Client.new(**args)
+  extend T::Sig
+
+  sig do
+    params(
+        auth: ShotgridApiRuby::Types::AuthType,
+        site_url: T.nilable(String),
+        shotgun_site: T.nilable(String),
+        shotgrid_site: T.nilable(String),
+      )
+      .returns(Client)
+  end
+  def self.new(auth:, site_url: nil, shotgun_site: nil, shotgrid_site: nil)
+    Client.new(
+      auth: auth,
+      site_url: site_url,
+      shotgun_site: shotgun_site,
+      shotgrid_site: shotgrid_site,
+    )
   end
 end
 

data/shotgrid_api_ruby.gemspec

@@ -15,7 +15,7 @@ Gem::Specification.new do |spec|
     "Gem to facilitate the interaction with Shotgrid's REST API."
   spec.homepage = 'https://github.com/shotgunsoftware/shotgrid_api_ruby'
   spec.license = 'MIT'
-  spec.required_ruby_version = Gem::Requirement.new('>= 2.5.0')
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.6.0')
 
   spec.metadata['homepage_uri'] = spec.homepage
   spec.metadata['source_code_uri'] =
@@ -35,25 +35,17 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'activesupport'
   spec.add_dependency 'faraday', '~> 1'
+  spec.add_dependency 'sorbet-runtime'
   spec.add_dependency 'zeitwerk', '~> 2.2'
 
   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 'pry-byebug'
   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/sorbet/config

@@ -0,0 +1,6 @@
+--dir
+.
+--ignore=node_modules
+--ignore=sorbet/rbi/gems/tapioca@0.4.25.rbi
+--ignore=tmp
+--ignore=vendor

data/sorbet/rbi/faraday.rbi

@@ -0,0 +1,20 @@
+# This RBI is here for patching generated method from Faraday.
+# From: https://github.com/sorbet/sorbet-typed/tree/master/lib/faraday/all
+# typed: true
+module Faraday
+  sig do
+    params(
+        url: String,
+        body: T.any(String, T.nilable(T::Hash[Object, Object])),
+        headers: T.nilable(T::Hash[Object, String]),
+        block: T.nilable(T.proc.params(req: Request).void),
+      )
+      .returns(Response)
+  end
+  def self.post(url, body = nil, headers = nil, &block); end
+
+  class Request
+    def headers; end
+    def headers=(hash); end
+  end
+end