enginn 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 69df7684cee8d69dc1323a4619fa36da07ca99c4971c2efd5e028b01d896587e
+  data.tar.gz: 27e16a94a761a330c3e0c0b036804de6518d190606a5a7889df5f2845c9f9832
+SHA512:
+  metadata.gz: 2a18523033fd9b7d102dde8cc5206b0d1e7709e7ca690db333282d940351b6a10c23f3ff95b8b064a88447a738539d579246036296e9af323256dc4c34bd0f26
+  data.tar.gz: f1a040d449fd07ce2dd70dab88b6458a7404fff498fcf77daf74b5afdbcfe50b05fa5f07d8f8a014a0179697902474af26f008b751a209ba25692e56e65aac43

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,44 @@
+# See list of defaults here: https://docs.rubocop.org/rubocop/index.html
+
+require:
+  - rubocop-performance
+  - rubocop-rspec
+  - rubocop-rake
+
+AllCops:
+  TargetRubyVersion: 2.6
+  NewCops: enable
+  Exclude:
+    - bin/**/*
+    - vendor/**/* # Fix missing gem in CI when using `bundler-cache: true`
+
+Gemspec/RequireMFA:
+  Enabled: false
+
+# ------------------------------------------------------------------------------
+# DEPARTMENT LAYOUT
+# ------------------------------------------------------------------------------
+
+Layout/FirstArrayElementIndentation:
+  EnforcedStyle: consistent # default: special_inside_parentheses
+
+Layout/FirstHashElementIndentation:
+  EnforcedStyle: consistent # default: special_inside_parentheses
+
+Layout/LineLength:
+  Max: 100 # default: 120
+
+# ------------------------------------------------------------------------------
+# DEPARTMENT METRICS
+# ------------------------------------------------------------------------------
+
+Metrics/BlockLength:
+  Exclude:
+  - spec/**/*
+
+# ------------------------------------------------------------------------------
+# DEPARTMENT STYLE
+# ------------------------------------------------------------------------------
+
+Style/Documentation:
+  Enabled: false # default: true

data/CHANGELOG.md

@@ -0,0 +1,16 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+# Unreleased
+(nothing yet!)
+
+## [0.1.1] - 2022-09-13
+### Added
+- Initial working set of functionalities.
+
+[Unreleased]: https://github.com/EnginnTechnologies/enginn-rb/compare/v0.1.1...HEAD
+[0.1.1]: https://github.com/EnginnTechnologies/enginn-rb/releases/tag/v0.1.1

data/Gemfile

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in enginn.gemspec
+gemspec
+
+group :development do
+  gem 'rake', '~> 13.0'
+  gem 'rubocop', '~> 1.21', require: false
+  gem 'rubocop-performance', '~> 1.13', require: false
+  gem 'rubocop-rake', '~> 0.6.0', require: false
+  gem 'rubocop-rspec', '~> 2.7', require: false
+  gem 'yard', '~> 0.9.27', require: false
+end
+
+group :test do
+  gem 'rspec', '~> 3.0'
+  gem 'simplecov', require: false
+end
+
+group :development, :test do
+  gem 'debug', '~> 1.4'
+end

data/Gemfile.lock

@@ -0,0 +1,94 @@
+PATH
+  remote: .
+  specs:
+    enginn (0.1.1)
+      faraday (~> 2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    debug (1.6.2)
+      irb (>= 1.3.6)
+      reline (>= 0.3.1)
+    diff-lcs (1.5.0)
+    docile (1.4.0)
+    faraday (2.5.2)
+      faraday-net_http (>= 2.0, < 3.1)
+      ruby2_keywords (>= 0.0.4)
+    faraday-net_http (3.0.0)
+    io-console (0.5.11)
+    irb (1.4.1)
+      reline (>= 0.3.0)
+    json (2.6.2)
+    parallel (1.22.1)
+    parser (3.1.2.1)
+      ast (~> 2.4.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.5.0)
+    reline (0.3.1)
+      io-console (~> 0.5)
+    rexml (3.2.5)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.1)
+    rubocop (1.36.0)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.1.2.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.20.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.21.0)
+      parser (>= 3.1.1.0)
+    rubocop-performance (1.15.0)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    rubocop-rspec (2.13.1)
+      rubocop (~> 1.33)
+    ruby-progressbar (1.11.0)
+    ruby2_keywords (0.0.5)
+    simplecov (0.21.2)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.4)
+    unicode-display_width (2.2.0)
+    webrick (1.7.0)
+    yard (0.9.28)
+      webrick (~> 1.7.0)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  debug (~> 1.4)
+  enginn!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.21)
+  rubocop-performance (~> 1.13)
+  rubocop-rake (~> 0.6.0)
+  rubocop-rspec (~> 2.7)
+  simplecov
+  yard (~> 0.9.27)
+
+BUNDLED WITH
+   2.3.18

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Enginn Technologies
+
+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,72 @@
+[![CI](https://github.com/EnginnTechnologies/enginn-rb/actions/workflows/ci.yml/badge.svg)](https://github.com/EnginnTechnologies/enginn-rb/actions/workflows/ci.yml)
+[![Release](https://github.com/EnginnTechnologies/enginn-rb/actions/workflows/release.yml/badge.svg)](https://github.com/EnginnTechnologies/enginn-rb/actions/workflows/release.yml)
+[![Gem Version](https://badge.fury.io/rb/enginn.svg)](https://badge.fury.io/rb/enginn)
+
+# Enginn
+
+The official gem to interact with the [Enginn API](https://app.enginn.tech/api/docs/index.html).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'enginn'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install enginn
+
+## Usage
+
+Visit the [API documentation](https://www.rubydoc.info/github/EnginnTechnologies/enginn-rb/)
+for more details.
+
+```rb
+# Create a client
+client = Enginn::Client.new(api_token: 'xxxxx')
+
+# Retrieve a project
+project = client.projects.where(id: 'xxxxx').first
+
+# Manipulate collections
+characters = project.characters.where(gender_eq: 'male')
+characters.each do |character|
+    # ...
+end
+
+# Update a character
+character = project.characters.first
+character.name = 'Pilou'
+character.save!
+
+# Create a new character
+character = Enginn::Character.new(project, name: 'Raph', gender: 'male', ...)
+character.save!
+
+# Destroy a character
+character.destroy!
+```
+
+## 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 the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/EnginnTechnologies/enginn-rb.
+
+## Changelog
+
+See [CHANGELOG.md](https://github.com/EnginnTechnologies/enginn-rb/blob/main/CHANGELOG.md).
+
+## 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,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+Bundler.require(:development)
+require 'enginn'
+require 'irb'
+
+@client = Enginn::Client.new(api_token: ENV['ENGINN_API_TOKEN'])
+@client.connection do |conn|
+  conn.url_prefix = ENV['ENGINN_BASE_URL'] || Enginn::Client::BASE_URL
+  conn.response :logger
+end
+
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/enginn/character.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Enginn
+  class Character < Resource
+    def self.path
+      'characters'
+    end
+
+    # Retrieve the takes of this character.
+    # @return [Enginn::TakesIndex]
+    def takes
+      TakesIndex.new(@project).where(character_id_eq: @attributes[:id])
+    end
+  end
+end

data/lib/enginn/characters_index.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Enginn
+  class CharactersIndex < ResourceIndex
+    def self.resource
+      Character
+    end
+  end
+end

data/lib/enginn/client.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require 'faraday'
+
+module Enginn
+  class Client
+    BASE_URL = 'https://app.enginn.tech/api/v1'
+
+    attr_reader :api_token, :adapter
+
+    # @param api_token [String] The API token to use
+    # @param adapter [Symbol] The Faraday adapter to use
+    def initialize(api_token:, adapter: Faraday.default_adapter)
+      @api_token = api_token
+      @adapter = adapter
+    end
+
+    # Get a connection to the API.
+    #
+    # @yieldparam connection [Faraday::Connection] if a block is given
+    # @return [Faraday::Connection]
+    def connection
+      @connection ||= Faraday.new(BASE_URL) do |conn|
+        conn.adapter @adapter
+        conn.request :authorization, 'Bearer', -> { @api_token }
+        conn.request :json
+        conn.response :json
+        conn.response :enginn_raise_error
+      end
+      yield(@connection) if block_given?
+      @connection
+    end
+
+    # Retrieve the projects the account have access to.
+    #
+    # @return [Enginn::ProjectsIndex]
+    def projects
+      ProjectsIndex.new(self)
+    end
+  end
+end

data/lib/enginn/dictionary_entries_index.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Enginn
+  class DictionaryEntriesIndex < ResourceIndex
+    def self.resource
+      DictionaryEntry
+    end
+  end
+end

data/lib/enginn/dictionary_entry.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Enginn
+  class DictionaryEntry < Resource
+    def self.path
+      'dictionary_entries'
+    end
+  end
+end

data/lib/enginn/error.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module Enginn
+  class Error < StandardError; end
+
+  # Map Enginn errors to Faraday's while keeping Enginn::Error inheriting from
+  # StandardError.
+  class HTTPError < Faraday::Error; end
+  class ClientError < HTTPError; end
+  class ServerError < HTTPError; end
+  class BadRequestError < ClientError; end
+  class UnauthorizedError < ClientError; end
+  class ForbiddenError < ClientError; end
+  class ResourceNotFound < ClientError; end
+  class ProxyAuthError < ClientError; end
+  class ConflictError < ClientError; end
+  class UnprocessableEntityError < ClientError; end
+  class NilStatusError < ServerError; end
+
+  # Override the Faraday::Response::RaiseError middleware to raise Enginn
+  # errors instead of Faraday's
+  # (see https://github.com/lostisland/faraday -> lib/faraday/error.rb)
+  #
+  # rubocop:disable Metrics/AbcSize
+  # rubocop:disable Metrics/CyclomaticComplexity
+  # rubocop:disable Metrics/MethodLength
+  class RaiseError < Faraday::Response::RaiseError
+    def on_complete(env)
+      case env[:status]
+      when 400
+        raise Enginn::BadRequestError, response_values(env)
+      when 401
+        raise Enginn::UnauthorizedError, response_values(env)
+      when 403
+        raise Enginn::ForbiddenError, response_values(env)
+      when 404
+        raise Enginn::ResourceNotFound, response_values(env)
+      when 407
+        # mimic the behavior that we get with proxy requests with HTTPS
+        msg = %(407 "Proxy Authentication Required")
+        raise Enginn::ProxyAuthError.new(msg, response_values(env))
+      when 409
+        raise Enginn::ConflictError, response_values(env)
+      when 422
+        raise Enginn::UnprocessableEntityError, response_values(env)
+      when ClientErrorStatuses
+        raise Enginn::ClientError, response_values(env)
+      when ServerErrorStatuses
+        raise Enginn::ServerError, response_values(env)
+      when nil
+        raise Enginn::NilStatusError, response_values(env)
+      end
+    end
+  end
+  # rubocop:enable Metrics/AbcSize
+  # rubocop:enable Metrics/CyclomaticComplexity
+  # rubocop:enable Metrics/MethodLength
+
+  Faraday::Response.register_middleware(enginn_raise_error: Enginn::RaiseError)
+end

data/lib/enginn/line.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Enginn
+  class Line < Resource
+    def self.path
+      'lines'
+    end
+
+    # Retrieve the takes of this line.
+    # @return [Enginn::TakesIndex]
+    def takes
+      TakesIndex.new(@project).where(line_id_eq: @attributes[:id])
+    end
+  end
+end

data/lib/enginn/line_tag.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Enginn
+  class LineTag < Resource
+    def self.path
+      'line_tags'
+    end
+
+    # Retrieve the lines of this line tag.
+    # @return [Enginn::LinesIndex]
+    def lines
+      LinesIndex.new(@project).where(line_tag_id_eq: @attributes[:id])
+    end
+  end
+end

data/lib/enginn/line_tags_index.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Enginn
+  class LineTagsIndex < ResourceIndex
+    def self.resource
+      LineTag
+    end
+  end
+end

data/lib/enginn/lines_index.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Enginn
+  class LinesIndex < ResourceIndex
+    def self.resource
+      Line
+    end
+  end
+end

data/lib/enginn/project.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+module Enginn
+  class Project < Resource
+    def self.path
+      'projects'
+    end
+
+    attr_reader :client
+
+    # @param client [Enginn::Client] The client to use with this project and its sub-resources
+    def initialize(client, attributes = {})
+      @client = client
+      super(self, attributes)
+    end
+
+    # Retrieve the characters present in this project.
+    # @return [Enginn::CharactersIndex]
+    def characters
+      CharactersIndex.new(self)
+    end
+
+    # Retrieve the dictionary entries present in this project.
+    # @return [Enginn::DictionaryEntriesIndex]
+    def dictionary_entries
+      DictionaryEntriesIndex.new(self)
+    end
+
+    alias dictionary dictionary_entries
+
+    # Retrieve the synthesis exports present in this project.
+    # @return [Enginn::SynthesisExportsIndex]
+    def synthesis_exports
+      SynthesisExportsIndex.new(self)
+    end
+
+    # Retrieve the scenes present in this project.
+    # @return [Enginn::ScenesIndex]
+    def scenes
+      ScenesIndex.new(self)
+    end
+
+    # Retrieve the lines present in this project.
+    # @return [Enginn::LinesIndex]
+    def lines
+      LinesIndex.new(self)
+    end
+
+    # Retrieve the line_tags present in this project.
+    # @return [Enginn::LineTagsIndex]
+    def line_tags
+      LineTagsIndex.new(self)
+    end
+
+    # Retrieve the takes present in this project.
+    # @return [Enginn::TakesIndex]
+    def takes
+      TakesIndex.new(self)
+    end
+
+    # Retrieve the take_batches present in this project.
+    # @return [Enginn::TakeBatchesIndex]
+    def take_batches
+      TakeBatchesIndex.new(self)
+    end
+
+    # @api private
+    def route
+      "#{self.class.path}/#{@attributes[:id]}"
+    end
+  end
+end

data/lib/enginn/projects_index.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Enginn
+  class ProjectsIndex < ResourceIndex
+    # @see ResourceIndex.resource
+    def self.resource
+      Project
+    end
+
+    attr_reader :client
+
+    # @param client [Enginn::Client] The client to use with this project and resources
+    def initialize(client)
+      @client = client
+      super(self)
+    end
+
+    # @see ResourceIndex#fetch!
+    def fetch!
+      response = request
+      @pagination = response[:pagination]
+      @collection = response[:result].map do |attributes|
+        self.class.resource.new(@client, attributes)
+      end
+      self
+    end
+
+    # @api private
+    def route
+      'projects'
+    end
+  end
+end

data/lib/enginn/resource.rb

@@ -0,0 +1,143 @@
+# frozen_string_literal: true
+
+require_relative 'string_utils'
+
+module Enginn
+  # A Resource can be a Character, a Take, or anything described in the
+  # Enginn API doc (https://app.enginn.tech/api/docs).
+  #
+  # A Resource depends on a Client that will be used for actual HTTP operations
+  # and is relative to a parent Project (see {#initialize} parameters). When a
+  # Resource is fetched through {#fetch} or {#save}, any received attributes
+  # from the API is synced with the object such as it is available as an
+  # instance method.
+  #
+  # @example
+  #   character = Enginn::Character(project, { id: "00000000-0000-0000-0000-000000000000" })
+  #   character.name # NoMethodError
+  #   character.fetch!
+  #   character.name # => 'Rocky'
+  #
+  # A Resource whose attributes include an ID will be considered as already
+  # existing and as such, subsequent calls to {#save} will issue a PATCH
+  # request. Otherwise, a POST request will be issued instead, allowing the
+  # creation of a new Resource.
+  #
+  # @example
+  #   scene = Enginn::Scene.new(project, { name: 'Grand Finale' })
+  #   scene.save # POST request (i.e. a new scene created)
+  #   scene.id # => "00000000-0000-0000-0000-000000000000"
+  #   scene.name = 'The End'
+  #   scene.save # PATCH request (i.e. the scene is updated)
+  #
+  # @abstract Override the {.path} method to implement.
+  class Resource
+    # Get the path to use for this kind of {Enginn::Resource}
+    #
+    # @api private
+    # @return [String]
+    def self.path
+      raise "path is not overriden for #{self}"
+    end
+
+    attr_reader :project, :errors
+    attr_accessor :attributes
+
+    # @param project [Enginn::Project] The parent project of this resource
+    # @param attributes [Hash] The attributes to initialize the resource with
+    def initialize(project, attributes = {})
+      @project = project
+      @attributes = {}
+      @errors = []
+      sync_attributes_with(attributes || {})
+    end
+
+    # @raise [Faraday::Error] if something goes wrong during the request
+    # @return [true] if the requested has succeeded
+    def fetch!
+      result = request(:get)[:result]
+      sync_attributes_with(result)
+      true
+    end
+
+    # Same as {#fetch!} but return false instead of raising an exception.
+    # Also fill in {#errors} with the server response.
+    # @see fetch!
+    # @return [Boolean]
+    def fetch
+      fetch!
+      true
+    rescue Faraday::Error => e
+      @errors << e.response
+      false
+    end
+
+    # @raise [Faraday::Error] if something goes wrong during the request
+    # @return [true] if the requested has succeeded
+    def save!
+      response = request(@attributes[:id].nil? ? :post : :patch)
+      sync_attributes_with(response[:result])
+      true
+    end
+
+    # Same as {#save!} but return false instead of raising an exception.
+    # Also fill in {#errors} with the server response.
+    # @see save!
+    # @return [Boolean]
+    def save
+      save!
+      true
+    rescue Faraday::Error => e
+      @errors << e.response
+      false
+    end
+
+    # @raise [Faraday::Error] if something goes wrong during the request
+    # @return [true] if the requested has succeeded
+    def destroy!
+      request(:delete)
+      true
+    end
+
+    # Same as {#destroy!} but return false instead of raising an exception.
+    # Also fill in {#errors} with the server response.
+    # @see destroy!
+    # @return [Boolean]
+    def destroy
+      destroy!
+      true
+    rescue Faraday::Error => e
+      @errors << e.response
+      false
+    end
+
+    # @return [String]
+    def inspect
+      "#<#{self.class} #{@attributes.map { |name, value| "@#{name}=#{value.inspect}" }.join(', ')}>"
+    end
+
+    # @api private
+    # @return [String]
+    def route
+      "#{@project.route}/#{self.class.path}/#{@attributes[:id]}"
+    end
+
+    private
+
+    def sync_attributes_with(hash)
+      @attributes.merge!(hash)
+      @attributes.each do |attribute, value|
+        instance_variable_set("@#{attribute}", value)
+        self.class.define_method(attribute) { @attributes[attribute] }
+        self.class.define_method("#{attribute}=") { |arg| @attributes[attribute] = arg }
+      end
+    end
+
+    def request(method)
+      resource_name = StringUtils.underscore(self.class.name.split('::').last)
+      params = %i[post patch].include?(method) ? { resource_name => @attributes } : {}
+      response = @project.client.connection.public_send(method, route, params)
+      JSON.parse(JSON[response.body], symbolize_names: true)
+    end
+  end
+end

data/lib/enginn/resource_index.rb

@@ -0,0 +1,140 @@
+# frozen_string_literal: true
+
+module Enginn
+  # A {ResourceIndex} is a collection of fetchable {Resource}.
+  #
+  # It can be filtered and paginated through the chainable methods {#per},
+  # {#page}, and {#where}. It also includes the Enumerable module so methods
+  # such as {#each}, #map or #to_a are available.
+  #
+  # Actual API requests are only issued when the {#each} method (or any method
+  # from Enumerable) is called. While {#each}-ing, new API request will be
+  # issued when the end of a page is reached. Note that when using {#page}, only
+  # the given page is reached for.
+  # One can also force fetching manually using {#fetch}.
+  #
+  # @example
+  #   takes = project.takes.where(synthesis_text_cont: 'hello')
+  #   takes.map(&:character_name)
+  #
+  # @abstract Override the {.resource} method to implement.
+  class ResourceIndex
+    # Define the type of {Enginn::Resource} to use with this kind of {Enginn::ResourceIndex}.
+    #
+    # @api private
+    # @return [Enginn::Resource]
+    def self.resource
+      raise "resource is not overriden for #{self}"
+    end
+
+    # @api private
+    # @return [String]
+    def self.path
+      resource.path
+    end
+
+    include Enumerable
+
+    attr_reader :project, :errors
+    attr_accessor :filters, :pagination
+
+    # @param project [Enginn::Project] The parent project of the indexed resource
+    def initialize(project)
+      @project = project
+      @filters = {}
+      @pagination = { current: 1 }
+      @errors = []
+    end
+
+    # @yieldparam item [Enginn::Resource]
+    # @return [self]
+    def each(&block)
+      fetch!
+      @collection.each(&block)
+      return self if @pagination[:locked]
+
+      while @pagination[:current] < @pagination[:last]
+        pagination[:current] += 1
+        fetch!
+        @collection.each(&block)
+      end
+
+      @pagination = { current: 1 }
+      self
+    end
+
+    # @param page [Integer] The page number
+    # @return [Enginn::ResourceIndex] A new index with updated pagination
+    def page(page)
+      new_index = clone
+      new_index.pagination = @pagination.merge(current: page, locked: true)
+      new_index
+    end
+
+    # @param per [Integer] The number of items per page
+    # @return [Enginn::ResourceIndex] A new index with updated pagination
+    def per(per)
+      new_index = clone
+      new_index.pagination = @pagination.merge(per: per)
+      new_index
+    end
+
+    # @param filters [Hash] Filters as you would use them in the `q` object with the API.
+    # @return [Enginn::ResourceIndex] A new filtered index
+    def where(filters)
+      new_index = clone
+      new_index.filters = @filters.merge(filters || {})
+      new_index
+    end
+
+    # Fetch the current page from the API. Resulting items of the collection are
+    # wrapped in the corresponding {Enginn::Resource} subclass.
+    #
+    # @return [true] if the request has been successfull
+    def fetch!
+      response = request
+      @pagination = response[:pagination]
+      @collection = response[:result].map do |attributes|
+        self.class.resource.new(@project, attributes)
+      end
+      true
+    end
+
+    # Same as {#fetch!} but return false instead of raising an exception.
+    # Also fill in {#errors} with the server response.
+    # @see fetch!
+    # @return [Boolean]
+    def fetch
+      fetch!
+      true
+    rescue Faraday::Error => e
+      @errors << e.response
+      false
+    end
+
+    # @return [String]
+    def inspect
+      attributes = instance_variables.map do |var|
+        "#{var}=#{instance_variable_get(var)}"
+      end
+      "#<#{self.class} #{attributes.join(', ')}>"
+    end
+
+    # @api private
+    # @return [String]
+    def route
+      "#{@project.route}/#{self.class.path}"
+    end
+
+    private
+
+    def request
+      response = @project.client.connection.get(route, {
+        per: @pagination[:per],
+        page: @pagination[:current],
+        q: @filters
+      }.reject { |_, value| value.nil? || (value.respond_to?(:empty?) && value.empty?) })
+      JSON.parse(JSON[response.body], symbolize_names: true)
+    end
+  end
+end

data/lib/enginn/scene.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Enginn
+  class Scene < Resource
+    def self.path
+      'scenes'
+    end
+
+    # Retrieve the lines of this scene.
+    # @return [Enginn::TakesIndex]
+    def lines
+      LinesIndex.new(@project).where(scene_id_eq: @attributes[:id])
+    end
+  end
+end

data/lib/enginn/scenes_index.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Enginn
+  class ScenesIndex < ResourceIndex
+    def self.resource
+      Scene
+    end
+  end
+end

data/lib/enginn/string_utils.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Enginn
+  module StringUtils
+    module_function
+
+    def underscore(str)
+      str.gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
+         .gsub(/([a-z\d])([A-Z])/, '\1_\2')
+         .tr('-', '_')
+         .downcase
+    end
+  end
+end

data/lib/enginn/synthesis_export.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Enginn
+  class SynthesisExport < Resource
+    def self.path
+      'synthesis_exports'
+    end
+  end
+end

data/lib/enginn/synthesis_exports_index.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Enginn
+  class SynthesisExportsIndex < ResourceIndex
+    def self.resource
+      SynthesisExport
+    end
+  end
+end

data/lib/enginn/take.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Enginn
+  class Take < Resource
+    def self.path
+      'takes'
+    end
+  end
+end

data/lib/enginn/take_batch.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Enginn
+  class TakeBatch < Resource
+    def self.path
+      'take_batches'
+    end
+
+    # Retrieve the takes of this take_batch.
+    # @return [Enginn::TakesIndex]
+    def takes
+      TakesIndex.new(@project).where(take_batch_id_eq: @attributes[:id])
+    end
+  end
+end

data/lib/enginn/take_batches_index.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Enginn
+  class TakeBatchesIndex < ResourceIndex
+    def self.resource
+      TakeBatch
+    end
+  end
+end

data/lib/enginn/takes_index.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Enginn
+  class TakesIndex < ResourceIndex
+    def self.resource
+      Take
+    end
+  end
+end

data/lib/enginn/test_synthesis.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Enginn
+  class TestSynthesis < Resource
+    def self.path
+      'test_syntheses'
+    end
+  end
+end

data/lib/enginn/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Enginn
+  VERSION = '0.1.1'
+end

data/lib/enginn.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require_relative 'enginn/version'
+require_relative 'enginn/client'
+require_relative 'enginn/error'
+
+require_relative 'enginn/resource'
+require_relative 'enginn/character'
+require_relative 'enginn/dictionary_entry'
+require_relative 'enginn/test_synthesis'
+require_relative 'enginn/take'
+require_relative 'enginn/take_batch'
+require_relative 'enginn/line'
+require_relative 'enginn/line_tag'
+require_relative 'enginn/synthesis_export'
+require_relative 'enginn/scene'
+require_relative 'enginn/project'
+
+require_relative 'enginn/resource_index'
+require_relative 'enginn/characters_index'
+require_relative 'enginn/dictionary_entries_index'
+require_relative 'enginn/takes_index'
+require_relative 'enginn/take_batches_index'
+require_relative 'enginn/lines_index'
+require_relative 'enginn/line_tags_index'
+require_relative 'enginn/synthesis_exports_index'
+require_relative 'enginn/scenes_index'
+require_relative 'enginn/projects_index'
+
+module Enginn
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: enginn
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Enginn Technologies
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2022-09-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: 
+email:
+- mail@enginn.tech
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/enginn.rb
+- lib/enginn/character.rb
+- lib/enginn/characters_index.rb
+- lib/enginn/client.rb
+- lib/enginn/dictionary_entries_index.rb
+- lib/enginn/dictionary_entry.rb
+- lib/enginn/error.rb
+- lib/enginn/line.rb
+- lib/enginn/line_tag.rb
+- lib/enginn/line_tags_index.rb
+- lib/enginn/lines_index.rb
+- lib/enginn/project.rb
+- lib/enginn/projects_index.rb
+- lib/enginn/resource.rb
+- lib/enginn/resource_index.rb
+- lib/enginn/scene.rb
+- lib/enginn/scenes_index.rb
+- lib/enginn/string_utils.rb
+- lib/enginn/synthesis_export.rb
+- lib/enginn/synthesis_exports_index.rb
+- lib/enginn/take.rb
+- lib/enginn/take_batch.rb
+- lib/enginn/take_batches_index.rb
+- lib/enginn/takes_index.rb
+- lib/enginn/test_synthesis.rb
+- lib/enginn/version.rb
+homepage: https://github.com/EnginnTechnologies/enginn-rb
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/EnginnTechnologies/enginn-rb
+  source_code_uri: https://github.com/EnginnTechnologies/enginn-rb
+  changelog_uri: https://github.com/EnginnTechnologies/enginn-rb/blob/v0.1.1/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3.1
+signing_key: 
+specification_version: 4
+summary: Official Enginn API wrapper for Ruby.
+test_files: []