perilune 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fb116ba6c86f1c24f6981261f9c69335e2b152c1167708c411c41a408dd43893
-  data.tar.gz: ad39ec022a048edde5c3e18df3e3e62dd5eb75a117ce8a5103dab4c4516876ae
+  metadata.gz: 2667aa181ff8f8d006a2bb84243f6d187cf1ce489f610e0a2f95cb2799556c84
+  data.tar.gz: f745164223c3bd6a7ce9bab71932f3ca8e0d4b014386f4eedb914bb1ee929df0
 SHA512:
-  metadata.gz: 70f2a6f2fcf043f114818939c498fd85a14e183dd78bd3bdb91a2a32608ad94a5fea982c193b912e82530b9f66c95005ca662ca493370265e822d70146d65851
-  data.tar.gz: c271e506ffd1642a4de1f11e2e81c7abcdbe7566d285e3b67bcee169b52491e67a9c48514b4c1ae8170440c4404faa41bd4af7decd3db48c44727f48c2ebc9a9
+  metadata.gz: 6dcf35402e3fafbd90f6a52f2cfc810889de1761e91b485fa3c0cefa5ea4a2416c9bf918f1a4778067d4e55c239b25f3516dd646741a209a27d38a8e7a41a0c9
+  data.tar.gz: 47181255a66a80ce2d4f8cdeddb72ee08dd15b5bb4a83a5aad6a7613e858bb791d5427acb9bb2cdff33168e45e9eb2abc8ce85f7e07aaa5fecbfaebf10382aa8

data/README.md

@@ -21,6 +21,31 @@ Or install it yourself as:
 $ gem install perilune
 ```
 
+## Configuration
+You can use diffrent queue name for cron job:
+
+```ruby
+# frozen_string_literal: true
+
+Perilune.configure do |config|
+  config.queue_name = 'test'
+end
+
+```
+
+> Note - Perilune is using *default* as queue name.
+
+Perilune using Redis as defualt driver for Trifle Stats. You can configure the driver for Trifle::Stats:
+
+```ruby
+Perilune.configure do |config|
+  config.stat_driver = Trifle::Stats::Driver::Postgres.new(
+    ActiveRecord::Base.connection.instance_variable_get('@connection')
+  )
+end
+```
+You can find more driver [here](https://trifle.io/docs/stats/drivers/)
+
 ## Contributing
 Contribution directions go here.
 

data/app/jobs/perilune/tasks/executor_job.rb

@@ -3,13 +3,14 @@
 module Perilune
   module Tasks
     class ExecutorJob < ApplicationJob
-      queue_as :default
+      queue_as Perilune.default.queue_name
 
       class UndefinedTaskKlass < StandardError; end
 
       def perform(task_id)
         @task_id = task_id
         executor.execute
+        track_stats(event: task.task_type, success: executor.success?)
         executor.success? ? success : failure
       end
 
@@ -32,6 +33,16 @@ module Perilune
 
         @executor ||= task.task_klass.constantize.new(file: task.file.download, task: task)
       end
+
+      def track_stats(event:, success:)
+        count_hash = success ? { count: 1, success: 1 } : { count: 1, failure: 1 }
+        inner_hash = { event.downcase.intern => count_hash }
+        Trifle::Stats.track(
+          key: "perilune::#{event.downcase}", at: Time.zone.now,
+          config: Perilune.default.stats_driver_config,
+          values: count_hash.merge(inner_hash)
+        )
+      end
     end
   end
 end

data/app/models/perilune/task.rb

@@ -4,10 +4,13 @@ module Perilune
   class Task < ApplicationRecord
     self.table_name = 'perilune_tasks'
     validates :state, inclusion: {
-      in: %w[draft uploaded processed failed],
+      in: %w[draft started processing processed failed],
       message: '%<value>s is not a valid state'
     }
     validates :task_klass, presence: true
+
+    before_save :update_state_timestamp, if: :state_change_to_be_saved
+
     has_one_attached :file
 
     def file_name
@@ -19,5 +22,11 @@ module Perilune
     rescue StandardError
       nil
     end
+
+    private
+
+    def update_state_timestamp
+      send("#{state}_at=", Time.now) if respond_to?("#{state}_at")
+    end
   end
 end

data/app/operations/perilune/tasks/exports/create_operation.rb

@@ -29,6 +29,7 @@ module Perilune
           @task ||= Perilune::Task.new(
             state: 'draft',
             task_klass: params[:task_klass],
+            task_type: 'Export',
             attrs: params[:attrs],
             tags: params[:tags]
           )

data/app/operations/perilune/tasks/find_operation.rb

@@ -2,6 +2,10 @@
 
 module Perilune
   module Tasks
-    class FindOperation < LedgerSync::Domains::Operation::Find; end
+    class FindOperation < LedgerSync::Domains::Operation::Find
+      def serializer_for(*)
+        Perilune::Tasks::Serializer.new
+      end
+    end
   end
 end

data/app/operations/perilune/tasks/imports/create_operation.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module Perilune
+  module Tasks
+    module Imports
+      class CreateOperation
+        include LedgerSync::Domains::Operation::Mixin
+
+        class Contract < LedgerSync::Ledgers::Contract
+          params do
+            required(:file).maybe(type?: File)
+            required(:file).maybe(type?: Tempfile)
+            required(:task_klass).filled(:string)
+            optional(:tags).filled(:array)
+          end
+        end
+
+        private
+
+        def operate
+          attach!
+          if task.save
+            Perilune::Tasks::ExecutorJob.perform_later(task.id)
+            success(true)
+          else
+            failure(task.errors.full_messages)
+          end
+        end
+
+        def task
+          @task ||= Perilune::Task.new(
+            state: 'draft',
+            task_klass: params[:task_klass],
+            task_type: 'Import',
+            tags: params[:tags]
+          )
+        end
+
+        def attach!
+          task.file.attach(
+            io: params[:file],
+            key: "perilune/#{ActiveStorage::Blob.generate_unique_secure_token}",
+            filename: "#{params[:task_klass]}_#{Time.zone.now.to_i}"
+          )
+        end
+
+        # override to use common serializer for all domain
+        def serializer_for(*)
+          Perilune::Tasks::Serializer.new
+        end
+      end
+    end
+  end
+end

data/app/operations/perilune/tasks/search_by_tag_operation.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Perilune
+  module Tasks
+    class SearchByTagOperation < Perilune::Tasks::SearchOperation
+      class Contract < LedgerSync::Ledgers::Contract
+        params do
+          required(:tag).value(:string)
+          required(:query).value(:hash)
+          required(:limit).value(:hash)
+          required(:includes).value(:array)
+          required(:order).value(:string)
+          required(:page).value(:integer)
+          required(:per).value(:integer)
+        end
+      end
+
+      def resources
+        @resources ||= super.where('? = ANY (tags)', params[:tag])
+      end
+
+      def serializer_for(*)
+        Perilune::Tasks::Serializer.new
+      end
+    end
+  end
+end

data/app/operations/perilune/tasks/search_operation.rb

@@ -3,6 +3,9 @@
 module Perilune
   module Tasks
     class SearchOperation < LedgerSync::Domains::Operation::Search
+      def serializer_for(*)
+        Perilune::Tasks::Serializer.new
+      end
     end
   end
 end

data/app/serializers/perilune/tasks/serializer.rb

@@ -5,6 +5,7 @@ module Perilune
     class Serializer < LedgerSync::Domains::Serializer
       attribute :id
       attribute :task_klass
+      attribute :task_type
       attribute :attrs
       attribute :state
       attribute :tags
@@ -13,6 +14,9 @@ module Perilune
       attribute :updated_at
       attribute :file_name
       attribute :file_url
+      attribute :file_size do |attr|
+        attr[:resource].file.try(:byte_size)
+      end
     end
   end
 end

data/app/views/perilune/tasks/index.html.haml

@@ -21,7 +21,7 @@
                   .rounded-sm.font-mono.text-sm.px-2.w-auto.max-w-max.break-normal.text-purple-500.bg-blue-100= resource.task_klass
                 %td.px-6.py-4.whitespace-nowrap.text-sm.text-gray-500= task_state(resource)
                 %td.px-6.py-4.whitespace-nowrap.text-sm.text-gray-500
-                  - resource.tags.each do |tag|
+                  - resource.tags&.each do |tag|
                     %span.inline-flex.items-center.px-3.py-0.5.rounded-full.text-sm.font-medium.bg-blue-100.text-blue-800= tag
                 %td.px-6.py-4.whitespace-nowrap.text-sm.text-gray-500= resource.created_at.to_s
                 %td.px-6.py-4.whitespace-nowrap.text-right.text-sm.font-medium

data/app/views/perilune/tasks/show.html.haml

@@ -36,9 +36,9 @@
           %ul.border.border-gray-200.rounded-md.divide-y.divide-gray-200{:role => "list"}
             %li.pl-3.pr-4.py-3.flex.items-center.justify-between.text-sm
               .w-0.flex-1.flex.items-center
-                / Heroicon name: solid/paper-clip
                 %svg.flex-shrink-0.h-5.w-5.text-gray-400{"aria-hidden" => "true", :fill => "currentColor", :viewbox => "0 0 20 20", :xmlns => "http://www.w3.org/2000/svg"}
                   %path{"clip-rule" => "evenodd", :d => "M8 4a3 3 0 00-3 3v4a5 5 0 0010 0V7a1 1 0 112 0v4a7 7 0 11-14 0V7a5 5 0 0110 0v4a3 3 0 11-6 0V7a1 1 0 012 0v4a1 1 0 102 0V7a3 3 0 00-3-3z", "fill-rule" => "evenodd"}
                 %span.ml-2.flex-1.w-0.truncate #{@resource.file_name}
+                %span.text-sm.text-gray-500 #{number_to_human_size(@resource.file_size)}
               .ml-4.flex-shrink-0
                 = link_to 'Download', @resource.file_url, class: 'font-medium text-indigo-400 hover:text-indigo-900'

data/config/github_database.yml

@@ -0,0 +1,11 @@
+default: &default
+  adapter: postgresql
+  encoding: unicode
+  username: <%= ENV['POSTGRES_USER'] %>
+  password: <%= ENV['POSTGRES_PASSWORD'] %>
+  host: <%= ENV['POSTGRES_HOST'] %>
+  pool: 5
+  database: <%= ENV['POSTGRES_DB'] %>
+
+test:
+  <<: *default

data/lib/generators/perilune/install/install_generator.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'rails/generators/migration'
+
+module Perilune
+  module Generators
+    class InstallGenerator < ::Rails::Generators::Base
+      include Rails::Generators::Migration
+      source_root File.expand_path('templates', __dir__)
+      desc 'add the migrations'
+
+      def self.next_migration_number(*)
+        if @prev_migration_nr
+          @prev_migration_nr += 1
+        else
+          @prev_migration_nr = Time.zone.now.utc.strftime('%Y%m%d%H%M%S').to_i
+        end
+        @prev_migration_nr.to_s
+      end
+
+      def copy_migrations
+        migration_template 'create_periline_tasks.rb', 'db/migrate/create_periline_tasks.rb'
+      end
+    end
+  end
+end

data/lib/generators/perilune/install/templates/create_periline_tasks.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+class CreatePeriluneTask < ActiveRecord::Migration[7.0]
+  def change # rubocop:disable Metrics/MethodLength
+    create_table :perilune_tasks do |t|
+      t.string :task_klass
+      t.jsonb :attrs
+      t.string :state
+      t.text :tags, array: true, default: []
+      t.jsonb :error_data
+      t.string :task_type
+      t.datetime :processing_at
+      t.datetime :processed_at
+      t.datetime :failed_at
+      t.timestamps
+    end
+    add_index :perilune_tasks, :tags, using: :gin
+  end
+end

data/lib/perilune/configuration.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Perilune
+  class Configuration
+    attr_accessor :queue_name, :stat_driver
+
+    def initialize
+      @queue_name = :default
+      @stat_driver = ::Trifle::Stats::Driver::Redis.new
+    end
+
+    def stats_driver_config
+      config = ::Trifle::Stats::Configuration.new
+      config.driver = @stat_driver
+      config.time_zone = 'GMT'
+      config.beginning_of_week = :monday
+      config.track_ranges = %i[hour day week month quarter year]
+      config
+    end
+  end
+end

data/lib/perilune/tasks/mixin.rb

@@ -18,6 +18,7 @@ module Perilune
         end
 
         def execute
+          task.update(state: 'processing')
           operate
         rescue StandardError => e
           failure(e.message)
@@ -58,6 +59,18 @@ module Perilune
             key: task.id, reference: task.id, config: tracer_config
           )
         end
+
+        def track_stats(event:, success:)
+          Trifle::Stats.track(
+            key: "perilune::#{event.downcase}", at: Time.zone.now,
+            config: Perilune.default.stats_driver_config,
+            values: {
+              count: 1,
+              success: success ? 1 : 0,
+              failure: success ? 0 : 1
+            }
+          )
+        end
       end
     end
   end

data/lib/perilune/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Perilune
-  VERSION = '0.1.0'
+  VERSION = '0.1.2'
 end

data/lib/perilune.rb

@@ -2,7 +2,18 @@
 
 require 'perilune/engine'
 require 'perilune/tasks/mixin'
+require 'perilune/configuration'
 
 module Perilune
-  # Your code goes here...
+  FACTORY_PATH = File.expand_path('../spec/factories', __dir__)
+
+  def self.default
+    @default ||= Configuration.new
+  end
+
+  def self.configure
+    yield(default)
+
+    default
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: perilune
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Kartavya Pareek
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-03-17 00:00:00.000000000 Z
+date: 2022-07-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ledger_sync-domains
@@ -17,21 +17,21 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.1
+        version: '1.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.1
+        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 7.0.0
+        version: '7.0'
     - - ">="
       - !ruby/object:Gem::Version
         version: 7.0.0.0
@@ -41,7 +41,7 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 7.0.0
+        version: '7.0'
     - - ">="
       - !ruby/object:Gem::Version
         version: 7.0.0.0
@@ -59,6 +59,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: trifle-stats
+  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: database_cleaner-active_record
+  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: dotenv-rails
   requirement: !ruby/object:Gem::Requirement
@@ -101,6 +129,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.1
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
@@ -115,7 +157,22 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Description of Perilune.
+- !ruby/object:Gem::Dependency
+  name: timecop
+  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'
+description: Perilune is a Rails Engine that allows you to define Task classes for
+  procesing files and handles their processing on the background for you.
 email:
 - hi@dropbot.sh
 executables: []
@@ -135,9 +192,10 @@ files:
 - app/mailers/perilune/application_mailer.rb
 - app/models/perilune/application_record.rb
 - app/models/perilune/task.rb
-- app/operations/perilune/tasks/create_operation.rb
 - app/operations/perilune/tasks/exports/create_operation.rb
 - app/operations/perilune/tasks/find_operation.rb
+- app/operations/perilune/tasks/imports/create_operation.rb
+- app/operations/perilune/tasks/search_by_tag_operation.rb
 - app/operations/perilune/tasks/search_operation.rb
 - app/serializers/perilune/tasks/serializer.rb
 - app/views/kaminari/_first_page.html.haml
@@ -151,17 +209,21 @@ files:
 - app/views/perilune/home/index.html.haml
 - app/views/perilune/tasks/index.html.haml
 - app/views/perilune/tasks/show.html.haml
+- config/github_database.yml
 - config/routes.rb
+- lib/generators/perilune/install/install_generator.rb
+- lib/generators/perilune/install/templates/create_periline_tasks.rb
 - lib/perilune.rb
+- lib/perilune/configuration.rb
 - lib/perilune/engine.rb
 - lib/perilune/tasks/mixin.rb
 - lib/perilune/version.rb
 - lib/tasks/perilune_tasks.rake
-homepage: https://engineering.dropbot.sh
+homepage: https://dropbot.sh
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://engineering.dropbot.sh
+  homepage_uri: https://dropbot.sh
   source_code_uri: https://github.com/sandbite/perilune
   changelog_uri: https://github.com/sandbite/perilune/blob/main/CHANGELOG.md
 post_install_message: 
@@ -182,5 +244,5 @@ requirements: []
 rubygems_version: 3.2.9
 signing_key: 
 specification_version: 4
-summary: Summary of Perilune.
+summary: Add Imports and Exports to your app with ease.
 test_files: []

data/app/operations/perilune/tasks/create_operation.rb

@@ -1,51 +0,0 @@
-# frozen_string_literal: true
-
-module Perilune
-  module Tasks
-    class CreateOperation
-      include LedgerSync::Domains::Operation::Mixin
-
-      class Contract < LedgerSync::Ledgers::Contract
-        params do
-          required(:file).maybe(type?: File)
-          required(:file).maybe(type?: Tempfile)
-          required(:task_klass).filled(:string)
-          optional(:tags).filled(:array)
-        end
-      end
-
-      private
-
-      def operate
-        attach!
-        if task.save
-          Perilune::Tasks::ExecutorJob.perform_later(task.id)
-          success(true)
-        else
-          failure(task.errors.full_messages)
-        end
-      end
-
-      def task
-        @task ||= Perilune::Task.new(
-          state: 'draft',
-          task_klass: params[:task_klass],
-          tags: params[:tags]
-        )
-      end
-
-      def attach!
-        task.file.attach(
-          io: params[:file],
-          key: "perilune/#{ActiveStorage::Blob.generate_unique_secure_token}",
-          filename: "#{params[:task_klass]}_#{Time.zone.now.to_i}"
-        )
-      end
-
-      # override to use common serializer for all domain
-      def serializer_for(*)
-        Perilune::Tasks::Serializer.new
-      end
-    end
-  end
-end