shotgun_api_ruby 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e2163b85f62993d2674a47792d3370ebcbf1a6c283e915c781bc27801868a172
+  data.tar.gz: e26ff2d7d7beae08aaa041f893bbb0f46eb44bd305313d576c2407a99a5e4123
+SHA512:
+  metadata.gz: 5956601d851995c92204f03541b5c5e7e07a428df8170884d976b01388b1acfe4022d5781cea92510d6ef83e99ef25c5caa983b02a7d602267970afa3caf889f
+  data.tar.gz: 33c191b51f8ea193eedb15f5655b51d453173c41e86c0da1f8540e5d08c396e04522aa89fd8f66ea286ccf3d6df6bf3a28df4ddff6e5f77264cb1038bc6f1278

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.overcommit.yml

@@ -0,0 +1,12 @@
+PreCommit:
+  RuboCop:
+    enabled: true
+    command: ['bundle', 'exec', 'rubocop'] # Invoke within Bundler context
+  BundleOutdated:
+    enabled: true
+  BundleAudit:
+    enabled: true
+PrePush:
+  RSpec:
+    enabled: true
+    command: ['bundle', 'exec', 'rspec', '-f', 'p'] # Invoke within Bundler context

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

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

@@ -0,0 +1,174 @@
+# Relaxed.Ruby.Style
+## Version 2.4
+
+Style/Alias:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#stylealias
+
+Style/AsciiComments:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#styleasciicomments
+
+Style/BeginBlock:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#stylebeginblock
+
+Style/BlockDelimiters:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#styleblockdelimiters
+
+Style/CommentAnnotation:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#stylecommentannotation
+
+Style/Documentation:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#styledocumentation
+
+Layout/DotPosition:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#layoutdotposition
+
+Style/DoubleNegation:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#styledoublenegation
+
+Style/EndBlock:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#styleendblock
+
+Style/FormatString:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#styleformatstring
+
+Style/IfUnlessModifier:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#styleifunlessmodifier
+
+Style/Lambda:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#stylelambda
+
+Style/ModuleFunction:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#stylemodulefunction
+
+Style/MultilineBlockChain:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#stylemultilineblockchain
+
+Style/NegatedIf:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#stylenegatedif
+
+Style/NegatedWhile:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#stylenegatedwhile
+
+Style/NumericPredicate:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#stylenumericpredicate
+
+Style/ParallelAssignment:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#styleparallelassignment
+
+Style/PercentLiteralDelimiters:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#stylepercentliteraldelimiters
+
+Style/PerlBackrefs:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#styleperlbackrefs
+
+Style/Semicolon:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#stylesemicolon
+
+Style/SignalException:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#stylesignalexception
+
+Style/SingleLineBlockParams:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#stylesinglelineblockparams
+
+Style/SingleLineMethods:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#stylesinglelinemethods
+
+Layout/SpaceBeforeBlockBraces:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#layoutspacebeforeblockbraces
+
+Layout/SpaceInsideParens:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#layoutspaceinsideparens
+
+Style/SpecialGlobalVars:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#stylespecialglobalvars
+
+Style/StringLiterals:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#stylestringliterals
+
+Style/TrailingCommaInArguments:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#styletrailingcommainarguments
+
+Style/TrailingCommaInArrayLiteral:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#styletrailingcommainarrayliteral
+
+Style/TrailingCommaInHashLiteral:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#styletrailingcommainhashliteral
+
+Style/SymbolArray:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylesymbolarray
+
+Style/WhileUntilModifier:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#stylewhileuntilmodifier
+
+Style/WordArray:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#stylewordarray
+
+Lint/AmbiguousRegexpLiteral:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#lintambiguousregexpliteral
+
+Lint/AssignmentInCondition:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#lintassignmentincondition
+
+Metrics/AbcSize:
+  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:
+  Enabled: false
+

data/.rubocop.yml

@@ -0,0 +1,64 @@
+inherit_from:
+  - http://relaxed.ruby.style/rubocop.yml
+
+require: 
+  - rubocop-performance
+
+AllCops:
+  DisplayStyleGuide: true
+  DisplayCopNames: true
+  Exclude:
+    - 'db/schema.rb'
+
+Style/GlobalVars:
+  Enabled: false
+
+Layout/DotPosition:
+  Enabled: true
+  EnforcedStyle: trailing
+
+Style/TrailingCommaInArrayLiteral:
+  Enabled: true
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInHashLiteral:
+  Enabled: true
+  EnforcedStyleForMultiline: comma
+
+Layout/MultilineArrayLineBreaks:
+  Enabled: true
+
+Layout/MultilineHashKeyLineBreaks:
+  Enabled: true
+
+Layout/MultilineMethodArgumentLineBreaks:
+  Enabled: true
+
+Layout/FirstArrayElementLineBreak:
+  Enabled: true
+
+Layout/FirstHashElementLineBreak:
+  Enabled: true
+
+Layout/FirstMethodArgumentLineBreak:
+  Enabled: true
+
+Layout/MultilineAssignmentLayout:
+  Enabled: true
+
+Metrics/LineLength:
+  Enabled: true
+  Max: 120
+  AutoCorrect: true
+  Exclude:
+    - Gemfile
+    - Guardfile
+    - spec/interactors/send_gdpr_response_spec.rb
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*.rb'
+    - 'Guardfile'
+    - 'config/environments/*.rb'
+    - 'lib/tasks/*.rake'
+    - 'shotgun_api_ruby.gemspec'

data/.ruby-gemset

@@ -0,0 +1 @@
+shotgun-ruby

data/.ruby-version

@@ -0,0 +1 @@
+2.6.5

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.3
+before_install: gem install bundler -v 2.0.2

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in shotgun_api_ruby.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,91 @@
+PATH
+  remote: .
+  specs:
+    shotgun_api_ruby (0.0.1)
+      activesupport
+      faraday (~> 0.17)
+      zeitwerk (~> 2.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (6.0.0)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.1, >= 2.1.8)
+    ast (2.4.0)
+    bundler-audit (0.6.1)
+      bundler (>= 1.2.0, < 3)
+      thor (~> 0.18)
+    childprocess (3.0.0)
+    coderay (1.1.2)
+    concurrent-ruby (1.1.5)
+    diff-lcs (1.3)
+    faraday (0.17.0)
+      multipart-post (>= 1.2, < 3)
+    i18n (1.7.0)
+      concurrent-ruby (~> 1.0)
+    iniparse (1.4.4)
+    jaro_winkler (1.5.3)
+    method_source (0.9.2)
+    minitest (5.12.2)
+    multipart-post (2.1.1)
+    overcommit (0.51.0)
+      childprocess (>= 0.6.3, < 4)
+      iniparse (~> 1.4)
+    parallel (1.18.0)
+    parser (2.6.5.0)
+      ast (~> 2.4.0)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    rspec (3.9.0)
+      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-expectations (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.0)
+    rubocop (0.75.1)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.6)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    rubocop-performance (1.5.0)
+      rubocop (>= 0.71.0)
+    ruby-progressbar (1.10.1)
+    thor (0.20.3)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.6.0)
+    zeitwerk (2.2.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  bundler-audit
+  overcommit
+  pry
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  rubocop (~> 0.75)
+  rubocop-performance (~> 1.5)
+  shotgun_api_ruby!
+
+BUNDLED WITH
+   2.0.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Denis <Zaratan> Pasin
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,233 @@
+# ShotgunApiRuby
+
+A gem to integrate with shotgun REST API easily.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'shotgun_api_ruby'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install shotgun_api_ruby
+
+## Usage
+
+### Client instantiation
+
+For creating a new client you need to provide two values.
+
+- One to identify the shotgun site:
+  - Can be `shotgun_site`: which is the `xxx` part in `https://xxx.shotgunstudio.com`
+  - Can be `site_url`: which is the full url to your site
+- One to `auth` you see _Authentication_ lower in this guide.
+
+Example:
+
+```ruby
+client = ShotgunApiRuby.new(shotgun_site: 'i-love-shotgun', auth: {client_id: 'my_nice_script', client_secret: 'CantTouchThis'})
+```
+
+### Authentication
+
+Any kind of authentication specified [here](https://developer.shotgunsoftware.com/rest-api/#authentication) is implemented
+
+#### Client Credentials
+
+```ruby
+client = ShotgunApiRuby.new(shotgun_site: 'xxx', auth: {client_id: 'script_name', client_secret: 'script_secret'})
+```
+
+#### Password Credentials
+
+```ruby
+client = ShotgunApiRuby.new(shotgun_site: 'xxx', auth: {username: 'login', password: 'password'})
+```
+
+#### Session Token
+
+**We highly advise not using this for a long term script as this won't be a stable value over time**
+
+```ruby
+client = ShotgunApiRuby.new(shotgun_site: 'xxx', auth: {session_token: 'session_token'})
+```
+
+#### Refresh Token
+
+**We highly advise not using this for a long term script as this won't be a stable value over time**
+
+```ruby
+client = ShotgunApiRuby.new(shotgun_site: 'xxx', auth: {refresh_token: 'refresh_token'})
+```
+
+### Entities
+
+Querying entities is done by accessing the named method
+
+```ruby
+client.assets # => ShotgunApiRuby::Entities …
+```
+
+As entities can be user defined the client will try to answer to any unknown type with an entity call so any of those calls will returns the same thing:
+
+```ruby
+client.assets
+client.asset
+client.entities("Asset")
+client.entities(:Assets)
+```
+
+Any not yet implemented call can be accessed through the connection: `client.assets.connection`
+
+#### Entity
+
+Returned entity will try to behave as nicely as possible.
+
+An entity will always answer to:
+
+- .type : the type of the entity
+- .id : the id of the entity
+- .relationships : a hash of relationships
+- .links : a hash of links to other entities
+- .attributes : An object answering to any available attributes
+
+It will also answer to any method that is present in the attributes:
+
+```ruby
+assets = client.assets.all(fields: 'code')
+assets.first.type # => "Asset"
+assets.first.id # => 726
+assets.first.attributes.code # => "Buck"
+assets.first.code # => "Buck"
+```
+
+#### Get
+
+##### all
+
+The all call will return all possible entities.
+
+```ruby
+client.assets.all
+```
+
+##### fields
+
+This attribute describe the wanted fields in the returned entity
+
+Can be a string describing wanted fields: `'code'` or `'code,description'`
+Or an array for better readability: `[:code, 'description']`
+
+Example:
+
+```ruby
+client.assets.all(fields: [:code, :description])
+```
+
+##### sort
+
+Describe how you want your entities to be sorted.
+
+Can be either:
+
+- A string: `'code'` or `'code,-description'` (the `-` asking for a descending order)
+- An array for better readability: `[:code, '-description']`
+- A hash for ease of use: `{code: 'asc', description: :desc}`
+
+Example:
+
+```ruby
+client.assets.all(fields: [:code, :description], sort: {code: :asc, description: :desc})
+```
+
+##### filter
+
+**Complex filters are not implemented yet**
+
+For simple filters, the filter field is waiting for a hash.
+
+Each value is:
+
+- A string: then a `is` filter will be used
+- An array: then a `in` filter will be used
+
+Example:
+
+```ruby
+client.assets.all(fields: [:code, :description], filter: {code: ['Buck', :Darcy], description: 'I LOVE SG'})
+```
+
+##### page
+
+You can ask for any page size or page number.
+
+- `page`: set the page number.
+- `page_size`: set the size of each page.
+
+Any of the two can be omited. Their type should be a number but it'll work with a string
+
+Example:
+
+```ruby
+client.assets.all(fields: [:code], page: 3, page_size: 10)
+client.assets.all(fields: [:code], page: '3')
+client.assets.all(fields: [:code], page_size: 10)
+```
+
+##### options
+
+Special options can be added:
+
+- retired: a flag telling if the returned entities should be retired or not
+- include_archived_projects: a flag telling if the archived projets should be included int the search
+
+Example:
+
+```ruby
+client.assets.all(fields: [:code], retired: true)
+client.assets.all(fields: [:code], include_archived_projects: true)
+```
+
+#### Create
+
+Not implemented yet
+
+#### Update
+
+Not implemented yet
+
+#### Delete
+
+Not implemented yet
+
+### Non implemented calls
+
+All calls which are not yet implemented can be done through the `connection` method. This method will still take care of the authentication for you.
+
+```ruby
+client = ShotgunApiRuby.new(…)
+client.connection.get('/entity/assets') # => #<Faraday::Response:xxx @on_complete_callbacks=[], @env=#<Faraday::Env @method=:get @body="{\"data\":[{\"type\":\"Asset\",\"attributes\":{},\"relationships\":{},\"id\":726 …
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+Every commit/push is checked by overcommit.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/shotgunsoftware/shotgun_api_ruby.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "shotgun_api_ruby"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "pry"
+Pry.start(__FILE__)

data/bin/setup

@@ -0,0 +1,7 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+overcommit --install

data/lib/shotgun_api_ruby/auth.rb

@@ -0,0 +1,103 @@
+# frozen_string_literal: true
+
+module ShotgunApiRuby
+  class Auth < Faraday::Middleware
+    module Validator
+      def self.valid?(auth)
+        (auth[:client_id] && auth[:client_secret]) ||
+          (auth[:password] && auth[:username]) ||
+          auth[:session_token] ||
+          auth[:refresh_token]
+      end
+    end
+
+    def initialize(app = nil, options = {})
+      raise "missing auth" unless options[:auth]
+      raise "missing site_url" unless options[:site_url]
+      raise "Auth not valid" unless Validator.valid?(options[:auth])
+
+      super(app)
+
+      @site_url = options[:site_url]
+      @client_id = options[:auth][:client_id]
+      @client_secret = options[:auth][:client_secret]
+      @username = options[:auth][:username]
+      @password = options[:auth][:password]
+      @session_token = options[:auth][:session_token]
+      @refresh_token = options[:auth][:refresh_token]
+    end
+
+    attr_reader :client_id, :client_secret, :site_url, :username, :password, :session_token, :refresh_token
+
+    def auth_type
+      @auth_type ||=
+        begin
+          if client_id
+            'client_credentials'
+          elsif username
+            'password'
+          elsif session_token
+            'session_token'
+          elsif refresh_token
+            'refresh_token'
+          end
+        end
+    end
+
+    def call(request_env)
+      request_env[:request_headers].merge!(std_headers)
+
+      @app.call(request_env)
+    end
+
+    private
+
+    def auth_params
+      @auth_params ||=
+        begin
+          case auth_type
+          when 'client_credentials'
+            "client_id=#{client_id}&client_secret=#{client_secret}&grant_type=client_credentials"
+          when 'password'
+            "username=#{username}&password=#{password}&grant_type=password"
+          when 'session_token'
+            "session_token=#{session_token}&grant_type=session_token"
+          when 'refresh_token'
+            "refresh_token=#{refresh_token}&grant_type=refresh_token"
+          else
+            raise "Not a valid/implemented auth type"
+          end
+        end
+    end
+
+    def auth_url
+      @auth_url ||= "#{site_url}/auth/access_token?#{auth_params}"
+    end
+
+    def access_token
+      ((@access_token && Time.now < @token_expiry) || sign_in) && @access_token
+    end
+
+    def sign_in
+      resp =
+        Faraday.post(auth_url) do |req|
+          req.headers["Content-Type"] = 'application/x-www-form-urlencoded'
+          req.headers["Accept"] = "application/json"
+        end
+      resp_body = JSON.parse(resp.body)
+
+      raise "Can't login: #{resp_body['errors']}" if resp.status >= 300
+
+      @access_token = resp_body['access_token']
+      @token_expiry = Time.now + resp_body['expires_in']
+      @refresh_token = resp_body['refresh_token']
+    end
+
+    def std_headers
+      {
+        "Accept" => "application/json",
+        "Authorization" => "Bearer #{access_token}",
+      }
+    end
+  end
+end

data/lib/shotgun_api_ruby/client.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module ShotgunApiRuby
+  class Client
+    attr_reader :connection
+
+    def initialize(auth:, site_url: nil, shotgun_site: nil)
+      raise "No site given" unless site_url || shotgun_site
+      raise "auth param not valid" unless auth && Auth::Validator.valid?(auth)
+
+      site_url ||= "https://#{shotgun_site}.shotgunstudio.com/api/v1"
+      @connection =
+        Faraday.new(url: site_url) do |faraday|
+          faraday.use(ShotgunApiRuby::Auth, auth: auth, site_url: site_url)
+          faraday.adapter Faraday.default_adapter
+        end
+    end
+
+    def entities(type)
+      public_send(type)
+    end
+
+    def respond_to_missing?(_name, _include_private = false)
+      true
+    end
+
+    def method_missing(name, *args, &block)
+      if args.empty?
+        name = formated_name(name)
+        define_singleton_method(name) do
+          if entities_client = instance_variable_get("@#{name}")
+            entities_client
+          else
+            entities_client = entities_aux(name)
+            instance_variable_set("@#{name}", entities_client)
+          end
+        end
+        send(name)
+      else
+        super
+      end
+    end
+
+    private
+
+    def formated_name(name)
+      name.to_s.camelize.singularize
+    end
+
+    def entities_aux(type)
+      type = formated_name(type)
+      @entity_caller = Entities.new(connection, type)
+    end
+  end
+end

data/lib/shotgun_api_ruby/entities.rb

@@ -0,0 +1,107 @@
+# frozen_string_literal: true
+
+module ShotgunApiRuby
+  class Entities
+    def initialize(connection, type)
+      @connection = connection.dup
+      @type = type
+      @connection.url_prefix = "#{@connection.url_prefix}/entity/#{type}"
+    end
+
+    attr_reader :connection, :type
+
+    def all(
+      fields: nil,
+      sort: nil,
+      filter: nil,
+      page: nil,
+      page_size: nil,
+      retired: nil,
+      include_archived_projects: nil
+    )
+      raise "Complex filters aren't supported yet" if filter && !filters_are_simple?(filter)
+
+      params = Params.new
+
+      params.add_fields(fields)
+      params.add_sort(sort)
+      params.add_filter(filter)
+      params.add_page(page, page_size)
+      params.add_options(retired, include_archived_projects)
+
+      resp = @connection.get('', params)
+      resp_body = JSON.parse(resp.body)
+
+      if resp.status >= 300
+        raise "Error while getting #{type}: #{resp_body['errors']}"
+      end
+
+      resp_body["data"].map do |entity|
+        Entity.new(
+          entity['type'],
+          OpenStruct.new(entity['attributes']),
+          entity['relationships'],
+          entity['id'],
+          entity['links']
+        )
+      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) })
+      end
+    end
+
+    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/entity.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module ShotgunApiRuby
+  Entity =
+    Struct.new(:type, :attributes, :relationships, :id, :links) do
+      def method_missing(name, *args, &block)
+        if attributes.respond_to?(name)
+          define_singleton_method(name) do
+            attributes.public_send(name)
+          end
+          public_send(name)
+        else
+          super
+        end
+      end
+
+      def respond_to_missing?(name, _private_methods = false)
+        attributes.respond_to?(name) || super
+      end
+    end
+end

data/lib/shotgun_api_ruby/version.rb

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

data/lib/shotgun_api_ruby.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+# zeitwerk will take care of auto loading files based on their name :)
+require "zeitwerk"
+require 'active_support/core_ext/string/inflections'
+require 'ostruct'
+require "faraday"
+require 'json'
+
+loader = Zeitwerk::Loader.for_gem
+loader.setup # ready!
+
+module ShotgunApiRuby
+  def self.new(**args)
+    Client.new(**args)
+  end
+end

data/shotgun_api_ruby.gemspec

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "shotgun_api_ruby/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "shotgun_api_ruby"
+  spec.version       = ShotgunApiRuby::VERSION
+  spec.authors       = ["Denis <Zaratan> Pasin"]
+  spec.email         = ["denis.pasin@autodesk.com"]
+
+  spec.summary       = 'Gem to interact easily with Shotgun REST api.'
+  spec.description   = "Gem to facilitate the interaction with Shotgun's REST API."
+  spec.homepage      = "https://github.com/shotgunsoftware/shotgun_api_ruby"
+  spec.license       = "MIT"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/shotgunsoftware/shotgun_api_ruby"
+  # spec.metadata["changelog_uri"] = "http://none.yet.com"
+
+  # 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.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activesupport"
+  spec.add_dependency "faraday", "~> 0.17"
+  spec.add_dependency "zeitwerk", "~> 2.2"
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "bundler-audit"
+  spec.add_development_dependency "overcommit"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rubocop", "~> 0.75"
+  spec.add_development_dependency "rubocop-performance", "~> 1.5"
+end

metadata

@@ -0,0 +1,221 @@
+--- !ruby/object:Gem::Specification
+name: shotgun_api_ruby
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Denis <Zaratan> Pasin
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-10-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.17'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.17'
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: bundler-audit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: overcommit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.75'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.75'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+description: Gem to facilitate the interaction with Shotgun's REST API.
+email:
+- denis.pasin@autodesk.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".overcommit.yml"
+- ".rspec"
+- ".rubocop-http---relaxed-ruby-style-rubocop-yml"
+- ".rubocop.yml"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/shotgun_api_ruby.rb
+- lib/shotgun_api_ruby/auth.rb
+- lib/shotgun_api_ruby/client.rb
+- lib/shotgun_api_ruby/entities.rb
+- lib/shotgun_api_ruby/entity.rb
+- lib/shotgun_api_ruby/version.rb
+- shotgun_api_ruby.gemspec
+homepage: https://github.com/shotgunsoftware/shotgun_api_ruby
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/shotgunsoftware/shotgun_api_ruby
+  source_code_uri: https://github.com/shotgunsoftware/shotgun_api_ruby
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Gem to interact easily with Shotgun REST api.
+test_files: []