Class: Eco::API::Custom::UseCase

Inherits:

Eco::API::Common::Loaders::UseCase

• Object
• Loaders::Base
• Eco::API::Common::Loaders::CaseBase
• Eco::API::Common::Loaders::UseCase
• Eco::API::Custom::UseCase

Defined in:

lib/eco/api/custom/use_case.rb

Overview

Helper class to create a custom UseCase

Examples:

Example of usage:

class Custom::UseCase::Sync < Eco::API::Custom::UseCase
  name "custom-case"
  type :sync

  def main(entries, people, session, options, usecase)
    update   = session.new_job("main", "update", :update, usecase)
    session.micro.with_each(entries, people, options) do |entry, person|
      # update some data in person using data from entry
    end
  end

end

Direct Known Subclasses

UseCases::Default::Utils::AddPageId, UseCases::Default::Utils::GroupCsv, UseCases::Default::Utils::MergeCsv, UseCases::Default::Utils::SortCsv, UseCases::Default::Utils::TrackFiles, UseCases::Samples::People::Filters::RequireId, UseCases::Samples::People::Filters::RequireMinEntries

Method Summary

Methods inherited from Eco::API::Common::Loaders::UseCase

#cli_apply!, #initialize, #main

Methods included from Eco::API::Common::Loaders::UseCase::CliIdentify

#cli, #cli!

Methods included from Eco::API::Common::Loaders::UseCase::TargetModel

#target_model

Methods included from Eco::API::Common::Loaders::UseCase::Type

#type

Methods inherited from Eco::API::Common::Loaders::CaseBase

#name, name_only_once!, original_name

Constructor Details

This class inherits a constructor from Eco::API::Common::Loaders::UseCase