active_shotgun 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 89cab512ffc72e7abd251c9d871e6164db9fb8ee00b4976e2e7766586e63505c
-  data.tar.gz: 3945e4c1b0ea88ebacafdb9465c1c177652bcc686401ee4d6ac8864e5a2b966a
+  metadata.gz: e2c263bcd899abc5f20b86c31586b9c973ff9620dd742f923c15f74285083585
+  data.tar.gz: 5ed4741b318d9d9ea168341bd52b5995a2a209762a4155323bcb516d4c326246
 SHA512:
-  metadata.gz: 7c058b1a1a57e6203ae52bec0e9a7dfbe975ab7a4f69915c064d35b7a74c182a2d897bb8d1d1368bca019075b2d9535ae8cda31ec6b43604757fa0c035d40d82
-  data.tar.gz: b7c194c33223601a1e81b588825c3d746598d06ae76d438a5e97c359886635c6261b8a39e5a7490276fc5af564407c8784daf44e8e206aae7993f11788a3b186
+  metadata.gz: 1e7a8d64f3b69ab20da321cca18ccb5c4016144a5cd8c60cc2b88b8ac8a4febc7620bc69a2d80c5a8eb47a88bf2c8c8babb63d5883587c38b76751f22ef4ffe7
+  data.tar.gz: dbe156034f91918614f051ed81a5e222fadde079f7c1c73e89a3761929ca07029d74bd395c6c94b73fe4d9ddf2cc23cfd79d1f2c6eeb86cfe61ff0b772c6c8eb

data/.github/workflows/verify_version_change.yml

@@ -14,8 +14,10 @@ jobs:
       - name: Fetch main branch
         run: git fetch origin main:main
       - name: Verify if there's a change in version
-        run: "git diff main lib/shotgun_api_ruby/version.rb | grep VERSION"
+        run: "git diff main lib/active_shotgun/version.rb | grep VERSION"
       - name: Print new version
-        run: 'git diff main lib/shotgun_api_ruby/version.rb | grep -E "^\+.*VERSION" | grep -E -o "[0-9]+\.[0-9]+\.[0-9]+(\.[0-9]+)?"'
+        run: 'git diff main lib/active_shotgun/version.rb | grep -E "^\+.*VERSION" | grep -E -o "[0-9]+\.[0-9]+\.[0-9]+(\.[0-9]+)?"'
       - name: Verify if higher version
-        run: '[[ $(git diff main lib/shotgun_api_ruby/version.rb | grep -E "^\+.*VERSION" | grep -E -o "[0-9]+\.[0-9]+\.[0-9]+(\.[0-9]+)?") > $(git diff main lib/shotgun_api_ruby/version.rb | grep -E "^-.*VERSION" | grep -E -o "[0-9]+\.[0-9]+\.[0-9]+(\.[0-9]+)?") ]]'
+        run: '[[ $(git diff main lib/active_shotgun/version.rb | grep -E "^\+.*VERSION" | grep -E -o "[0-9]+\.[0-9]+\.[0-9]+(\.[0-9]+)?") > $(git diff main lib/active_shotgun/version.rb | grep -E "^-.*VERSION" | grep -E -o "[0-9]+\.[0-9]+\.[0-9]+(\.[0-9]+)?") ]]'
+      - name: Verify if version is updated in Gemfile.lock
+        run: '[[ $(cat Gemfile.lock | grep "$(git diff main lib/active_shotgun/version.rb | grep -E "^\+.*VERSION" | grep -E -o "[0-9]+\.[0-9]+\.[0-9]+(\.[0-9]+)?")") ]]'

data/.gitignore

@@ -9,3 +9,5 @@
 
 # rspec failure tracking
 .rspec_status
+.env
+tmp

data/CHANGELOG.md

@@ -6,9 +6,20 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.0.2] - 2020-12-16
+### Added
+- save, create, update, find, delete, revive (and friends)
+- Validations support
+- Callbacks support
+- AM::Dirty and many helpers
+### Missing
+- Query interface (where, find_by, first, all, order, offset)
+- Support Entity and Multi-Entity
+
 ## [0.0.1] - 2020-12-16
 ### Added
 - Gem init
 
-[Unreleased]: https://github.com/zaratan/active_shotgun/compare/v0.0.1...HEAD
-[0.0.1]: https://github.com/zaratan/active_shotgun/releases/tag/v0.1.1
+[Unreleased]: https://github.com/zaratan/active_shotgun/compare/v0.0.2...HEAD
+[0.0.2]: https://github.com/zaratan/active_shotgun/releases/tag/v0.0.2
+[0.0.1]: https://github.com/zaratan/active_shotgun/releases/tag/v0.0.1

data/Gemfile.lock

@@ -1,12 +1,22 @@
 PATH
   remote: .
   specs:
-    active_shotgun (0.0.1)
+    active_shotgun (0.0.2)
+      activemodel (>= 5.2)
+      shotgun_api_ruby (>= 0.0.8.2)
       zeitwerk (~> 2)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    activemodel (6.1.0)
+      activesupport (= 6.1.0)
+    activesupport (6.1.0)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
     ast (2.4.1)
     bundler-audit (0.7.0.1)
       bundler (>= 1.2.0, < 3)
@@ -17,12 +27,18 @@ GEM
     concurrent-ruby (1.1.7)
     diff-lcs (1.4.4)
     docile (1.3.2)
+    dotenv (2.7.6)
     faker (2.15.1)
       i18n (>= 1.6, < 2)
+    faraday (1.1.0)
+      multipart-post (>= 1.2, < 3)
+      ruby2_keywords
     i18n (1.8.5)
       concurrent-ruby (~> 1.0)
     iniparse (1.5.0)
     method_source (1.0.0)
+    minitest (5.14.2)
+    multipart-post (2.1.1)
     overcommit (0.57.0)
       childprocess (>= 0.6.3, < 5)
       iniparse (~> 1.4)
@@ -70,6 +86,11 @@ GEM
       rubocop (>= 0.90.0, < 2.0)
       rubocop-ast (>= 0.4.0)
     ruby-progressbar (1.10.1)
+    ruby2_keywords (0.0.2)
+    shotgun_api_ruby (0.0.8.2)
+      activesupport
+      faraday (~> 1)
+      zeitwerk (~> 2.2)
     simplecov (0.20.0)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
@@ -79,6 +100,8 @@ GEM
       simplecov (>= 0.4.1)
     simplecov_json_formatter (0.1.2)
     thor (1.0.1)
+    tzinfo (2.0.3)
+      concurrent-ruby (~> 1.0)
     unicode-display_width (1.7.0)
     yard (0.9.25)
     zeitwerk (2.4.2)
@@ -90,6 +113,7 @@ DEPENDENCIES
   active_shotgun!
   bundler
   bundler-audit
+  dotenv
   overcommit
   pry-byebug
   rake (~> 12.0)

data/active_shotgun.gemspec

@@ -28,10 +28,13 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.add_dependency 'activemodel', '>= 5.2'
+  spec.add_dependency 'shotgun_api_ruby', '>= 0.0.8.2'
   spec.add_dependency 'zeitwerk', '~> 2'
 
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'bundler-audit'
+  spec.add_development_dependency "dotenv"
   spec.add_development_dependency 'overcommit'
   spec.add_development_dependency 'pry-byebug'
   spec.add_development_dependency 'rake'

data/bin/console

@@ -10,5 +10,5 @@ require "active_shotgun"
 # require "pry"
 # Pry.start
 
-require "irb"
-IRB.start(__FILE__)
+require "pry"
+Pry.start(__FILE__)

data/lib/active_shotgun/client.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require 'singleton'
+require 'forwardable'
+
+require 'shotgun_api_ruby'
+
+module ActiveShotgun
+  class Client
+    include Singleton
+    CONNECTION_TYPES = ["multi_entity", "entity"].freeze
+    READ_ONLY_TYPES = ["image", "summary"].freeze
+
+    def initialize
+      @shotgun = ShotgunApiRuby.new(
+        shotgun_site: Config.shotgun_site_name || Config.shotgun_site_url,
+        auth: { client_id: Config.shotgun_client_id, client_secret: Config.shotgun_client_secret }
+      )
+    end
+    attr_reader :shotgun
+
+    class << self
+      extend Forwardable
+      # Remove the need to call .instance everywhere
+      def_delegators(
+        :instance,
+        :shotgun,
+        :fetch_field_names_for_an_entity_type
+      )
+    end
+
+    def fetch_field_names_for_an_entity_type(type)
+      result = shotgun.entities(type).fields.to_h
+      {
+        writable: result.reject do |_, v|
+          (CONNECTION_TYPES + READ_ONLY_TYPES).include?(v.data_type) ||
+            !v.editable
+        end.keys,
+        readable: result.reject{ |_, v| CONNECTION_TYPES.include?(v.data_type) }.keys,
+      }
+    end
+  end
+end

data/lib/active_shotgun/config.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require 'singleton'
+require 'forwardable'
+
+module ActiveShotgun
+  class Config
+    DEFAULT_CONFIG = {
+      shotgun_site_name: 'pasind3-prod',
+      shotgun_site_url: nil,
+      shotgun_client_id: nil,
+      shotgun_client_secret: nil,
+    }.freeze
+
+    include Singleton
+
+    def initialize
+      @config = Struct.new(*DEFAULT_CONFIG.keys).new(*DEFAULT_CONFIG.values)
+    end
+    attr_reader :config
+
+    class << self
+      extend Forwardable
+      # Remove the need to call .instance everywhere
+      def_delegators(
+        :instance,
+        :configure,
+        *DEFAULT_CONFIG.keys.flat_map{ |key| [key, "#{key}="] }
+      )
+    end
+
+    extend Forwardable
+    def_delegators(
+      :config,
+      *DEFAULT_CONFIG.keys.flat_map{ |key| [key, "#{key}="] }
+    )
+
+    def configure(&block)
+      return unless block
+
+      yield(@config)
+    end
+  end
+end

data/lib/active_shotgun/model.rb

@@ -0,0 +1,214 @@
+# frozen_string_literal: true
+
+require 'active_model'
+
+module ActiveShotgun
+  module Model
+    def self.included(base_class)
+      base_class.include(ActiveModel::Validations)
+      base_class.extend(ActiveModel::Callbacks)
+      base_class.include(ActiveModel::Dirty)
+      base_class.include(ActiveModel::Serialization)
+      base_class.include(ActiveModel::Serializers::JSON)
+      base_class.extend(ActiveModel::Naming)
+
+      name = base_class.name
+      fetched_attributes = Client.fetch_field_names_for_an_entity_type(name)
+
+      writable_fetched_attributes = fetched_attributes[:writable]
+      readable_fetched_attributes = fetched_attributes[:readable]
+
+      base_class.instance_eval do
+        define_attribute_methods(*writable_fetched_attributes)
+        attr_reader(*readable_fetched_attributes, *writable_fetched_attributes)
+
+        define_singleton_method(:shotgun_type) do
+          name
+        end
+
+        define_singleton_method(:shotgun_readable_fetched_attributes) do
+          readable_fetched_attributes
+        end
+
+        define_singleton_method(:shotgun_writable_fetched_attributes) do
+          writable_fetched_attributes
+        end
+
+        define_singleton_method(:shotgun_client) do
+          Client.shotgun.entities(shotgun_type)
+        end
+
+        define_method(:shotgun_client) do
+          self.class.shotgun_client
+        end
+
+        writable_fetched_attributes.each do |attribute|
+          define_method("#{attribute}=") do |value|
+            send("#{attribute}_will_change!")
+            instance_variable_set("@#{attribute}", value)
+          end
+        end
+      end
+
+      base_class.include(Read)
+      base_class.extend(Read::ClassMethods)
+      base_class.include(Write)
+      base_class.extend(Write::ClassMethods)
+      base_class.include(Delete)
+      base_class.extend(Delete::ClassMethods)
+      base_class.prepend(Validations)
+      base_class.prepend(Callbacks)
+    end
+
+    module Write
+      def persisted?
+        !!id
+      end
+
+      def save
+        return false unless changed?
+
+        sg_result =
+          if persisted?
+            shotgun_client.update(id, changes.transform_values(&:last))
+          else
+            shotgun_client.create(changes.transform_values(&:last))
+          end
+        override_attributes!(sg_result.attributes.to_h.merge(id: sg_result.id))
+        changes_applied
+        true
+      end
+      alias_method :save!, :save
+
+      def mass_assign(assigned_attributes)
+        assigned_attributes.
+          transform_keys(&:to_sym).
+          slice(*self.class.shotgun_writable_fetched_attributes).
+          each do |k, v|
+            public_send("#{k}=", v)
+          end
+      end
+
+      def update(updated_attributes)
+        mass_assign(updated_attributes)
+        save
+      end
+
+      def update!(updated_attributes)
+        mass_assign(updated_attributes)
+        save!
+      end
+
+      module ClassMethods
+        def create(create_attributes)
+          new_entity = new
+          new_entity.mass_assign(create_attributes)
+          new_entity.save
+        end
+
+        def create!(create_attributes)
+          new_entity = new
+          new_entity.mass_assign(create_attributes)
+          new_entity.save!
+        end
+      end
+
+      private
+
+      def override_attributes!(new_attributes)
+        new_attributes.
+          transform_keys(&:to_sym).
+          slice(*self.class.shotgun_readable_fetched_attributes).
+          each do |k, v|
+            instance_variable_set("@#{k}", v)
+          end
+      end
+    end
+
+    module Validations
+      def save
+        validate && super
+      end
+
+      def save!
+        validate!
+        super
+      end
+    end
+
+    module Callbacks
+      def self.prepended(base)
+        base.define_model_callbacks :destroy
+        base.define_model_callbacks :update
+        base.define_model_callbacks :save
+        base.define_model_callbacks :create
+        base.define_model_callbacks :validation
+      end
+
+      def destroy
+        run_callbacks(:destroy) do
+          super
+        end
+      end
+
+      def save
+        run_callbacks(:save) do
+          run_callbacks(persisted? ? :update : :create) do
+            super
+          end
+        end
+      end
+
+      def validate
+        run_callbacks(:validation) do
+          super
+        end
+      end
+    end
+
+    module Delete
+      def delete
+        shotgun_client.delete(id)
+      end
+      alias_method :destroy, :delete
+
+      module ClassMethods
+        def revive(id)
+          shotgun_client.revive(id)
+        end
+      end
+    end
+
+    module Read
+      def attributes
+        self.class.shotgun_readable_fetched_attributes.map do |attribute|
+          [attribute, instance_variable_get("@#{attribute}")]
+        end.to_h
+      end
+
+      def writable_attributes
+        self.class.shotgun_writable_fetched_attributes.map do |attribute|
+          [attribute, instance_variable_get("@#{attribute}")]
+        end.to_h
+      end
+
+      def initialize(new_attributes = {})
+        new_attributes.slice(*self.class.shotgun_readable_fetched_attributes).each do |attribute, value|
+          instance_variable_set("@#{attribute}", value)
+        end
+      end
+
+      module ClassMethods
+        def first
+          sg_result = shotgun_client.first
+          new(sg_result.attributes.to_h.merge(id: sg_result.id))
+        end
+
+        def find(id)
+          sg_result = shotgun_client.find(id)
+          new(sg_result.attributes.to_h.merge(id: sg_result.id))
+        end
+      end
+    end
+  end
+end

data/lib/active_shotgun/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: active_shotgun
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Denis <Zaratan> Pasin
@@ -10,6 +10,34 @@ bindir: exe
 cert_chain: []
 date: 2020-12-16 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: shotgun_api_ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.8.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.8.2
 - !ruby/object:Gem::Dependency
   name: zeitwerk
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  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
@@ -221,6 +263,9 @@ files:
 - bin/console
 - bin/setup
 - lib/active_shotgun.rb
+- lib/active_shotgun/client.rb
+- lib/active_shotgun/config.rb
+- lib/active_shotgun/model.rb
 - lib/active_shotgun/version.rb
 homepage: https://github.com/zaratan/active_shotgun
 licenses: