rails-cloud-tasks 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2b46bc62d822e6eb44925df67eb91ce37e862c48b3c2e7a7543f9ae14a7e6caa
-  data.tar.gz: 26455a3286ab916efca56b6947bf867a877976fa0215229927454b166fdf90bc
+  metadata.gz: 924a936920255b90f05426a1a02d8fcb7c0b688f05ecf23f47d5574cfd830100
+  data.tar.gz: dac09c6a8c32a41ce9b8849b57892cac630f54b9592faf88400d248ac32d4661
 SHA512:
-  metadata.gz: 3eef0b2920d83f6fea101e10eb1386cfab2300fc06f9c89f85ba3279496d7897d223c69227dd10d770ce42ec5f726443e7e785de6567cea353c0657f8400e4f8
-  data.tar.gz: ca08441f14690818fa2203f73de2c22c6cd5ab98f25b264c67291cad76094d8a378bb69aa91246fba293cc08f3d609d13a0451a8b21ec4fd9366b1a9d781ff65
+  metadata.gz: b4bb22ec37af949357f944d2e5dc5f80c955fd65426aadc35f1ac4d7bc53cfdc8d5703813553f824e2024c137087a3d891f16d2a7859eb6a26fef771da7a894f
+  data.tar.gz: 4ca848172ca6473f08348f0b5ff6d9f9ddad8ff2a9b95ab9b2f8e77d933c5d6a1ebd4c29b1eac6afa43ecd3e665913fb9864d22bc8b451a1ee946b1279be6cb4

data/.github/workflows/release.yml

@@ -1,13 +1,55 @@
-name: Release CI
+name: Tag & Release Package
 
 on:
   push:
-    tags:
-      - v*
+    branches:
+      - main
 
 jobs:
+  checks:
+    runs-on: ubuntu-latest
+    outputs:
+      pre_release: ${{ steps.versioning.outputs.pre_release }}
+      upgraded: ${{ steps.versioning.outputs.upgraded }}
+      package_version: ${{ steps.versioning.outputs.package_version }}
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Set up Ruby 2.7
+        uses: actions/setup-ruby@v1
+        with:
+          ruby-version: 2.7
+
+      - name: Install bundler
+        run: gem install bundler
+
+      - name: Cache dependencies
+        uses: actions/cache@v1
+        with:
+          path: vendor/bundle
+          key: ${{ runner.os }}-gem-${{ hashFiles('**/rails-cloud-tasks.gemspec') }}-2.7
+
+      - name: Install dependencies
+        run: bundle install
+
+      - name: Fetching Tags
+        run: git fetch -t
+
+      - name: Detect version upgrade
+        id: versioning
+        run: |
+          pkg='rails-cloud-tasks'
+          package_version=$(bundle info $pkg | grep -o "$pkg \(.*\)" | sed "s/$pkg (\(.*\))/\1/")
+          echo "::set-output name=package_version::"$package_version
+          upgraded=$(git tag --list | grep -q "${package_version}$" && echo "false" || echo "true")
+          echo "::set-output name=upgraded::"$upgraded
+          pre_release=$([[ $package_version =~ ^[0-9]+\.[0-9]+\.[0-9]+$ ]] && echo "false" || echo "true")
+          echo "::set-output name=pre_release::"$pre_release
+
   release:
     runs-on: ubuntu-latest
+    needs: checks
+    if: needs.checks.outputs.upgraded == 'true'
     steps:
       - uses: actions/checkout@v2
 
@@ -28,6 +70,19 @@ jobs:
       - name: Install dependencies
         run: bundle install
 
+      - name: Create Release
+        uses: actions/create-release@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          tag_name: ${{ needs.checks.outputs.package_version }}
+          release_name: Release ${{ needs.checks.outputs.package_version }}
+          body: |
+            Auto-released by bot.
+            See commit changes.
+          draft: false
+          prerelease: ${{ needs.checks.outputs.pre_release }}
+
       - name: Build package
         run: bundle exec gem build -o rails-cloud-tasks.gem
 

data/README.md

@@ -36,8 +36,11 @@ gem 'rails-cloud-tasks'
 require 'rails-cloud-tasks'
 
 RailsCloudTasks.configure do |config|
+  config.service_account_email = 'test-account@test-project.iam.gserviceaccount.com'
   config.project_id = 'my-gcp-project' # This is not needed if running on GCE
   config.location_id = 'us-central1'
+  config.scheduler_file_path = './custom_path/scheduler_jobs.yml'
+  config.scheduler_prefix_name = 'my-app-name'
 
   # Base url used by Cloud Tasks to reach your application and run the tasks
   config.host = 'https://myapplication.host.com'
@@ -48,6 +51,19 @@ RailsCloudTasks.configure do |config|
 end
 ```
 
+Check out the available configs and its usage description:
+
+| attribute             	| description                                                                                                 	| env support         	| app engine fallback 	| default value            	|
+|-----------------------	|-------------------------------------------------------------------------------------------------------------	|---------------------	|--------------------	|--------------------------	|
+| service_account_email 	| The app service account email. It''s used to impersonate an user on schedule job                            	| GCP_SERVICE_ACCOUNT 	| ✓                  	|                          	|
+| project_id            	| The Project ID                                                                                              	| GCP_PROJECT         	| ✓                  	|                          	|
+| location_id           	| The region where you app is running (eg: us-central1, us-east1...)                                          	| GCP_LOCATION        	| ✓                  	|                          	|
+| host                  	| The app endpoint which the app is running. *Do not use custom domain* Use the generated domain by Cloud Run 	| GCP_APP_ENDPOINT    	|                    	|                          	|
+| scheduler_file_path   	| Path which the scheduler file is located                                                                    	| 𐄂                   	|                    	| './config/scheduler.yml' 	|
+| scheduler_prefix_name 	| The prefix to be set into scheduler job name                                                                	| 𐄂                   	|                    	| 'rails-cloud'            	|
+| tasks_path            	| The path to run tasks                                                                                       	| 𐄂                   	|                    	| '/tasks'                 	|
+
+
 - Add a Job class:
 ```ruby
 # ./app/jobs/application_job.rb
@@ -73,6 +89,34 @@ end
 ```ruby
 MyJob.perform_later(attrs)
 ```
+
+### Scheduled Jobs
+
+We have support to Google Cloud Schedule. It's based on Cloud tasks, the jobs are scheduled with HTTP Target. We do not support Pub/Sub or App Engine HTTP for now.
+
+Check out the follow sample of config file:
+```yaml
+# config/scheduler.yml
+- name: Users::SyncJob
+  schedule: 0 8 * * *
+  description: Sync user data
+  time_zone: "America/Los_Angeles"
+  args:
+    arg1: 100
+    arg2: 200
+```
+
+| attribute   	| description                                                    	| required 	|
+|-------------	|----------------------------------------------------------------	|----------	|
+| name        	| The Job class namespace                                        	| ✓        	|
+| schedule    	| The frequency to run your job. It should be a unix-cron format 	| ✓        	|
+| description 	| What this job does                                             	| ✓        	|
+| time_zone   	| Choose which one timezone your job must run                    	| ✓        	|
+| args        	| What are the job's arguments                                   	| ✓        	|
+
+
+
+
 ## Tests
 
 To run tests:

data/Rakefile

@@ -0,0 +1,4 @@
+require 'rails-cloud-tasks'
+
+path = File.expand_path(__dir__)
+Dir.glob("#{path}/lib/tasks/*.rake").each { |f| load f }

data/lib/rails-cloud-tasks.rb

@@ -1,9 +1,13 @@
+require_relative './railtie'
+
 require 'active_support'
 require 'rails_cloud_tasks/rack/errors'
 
 module RailsCloudTasks
   extend ActiveSupport::Autoload
 
+  autoload :Scheduler
+  autoload :Credentials
   autoload :Adapter
   autoload :AppEngine
   autoload :Configuration
@@ -25,4 +29,14 @@ module RailsCloudTasks
   def self.config
     @config ||= Configuration.new
   end
+
+  def self.logger
+    return @logger if @logger
+
+    @logger ||= (Rails.logger || Logger.new($stdout)).tap do |logger|
+      logger.formatter = proc do |severity, datetime, _progname, msg|
+        "[#{datetime}] #{severity} [rails-cloud-tasks]: #{msg}\n"
+      end
+    end
+  end
 end

data/lib/rails_cloud_tasks/adapter.rb

@@ -39,7 +39,7 @@ module RailsCloudTasks
         http_request:  {
           http_method: :POST,
           url:         url,
-          body:        { job: job.serialize }.to_json
+          body:        { job: job.serialize }.to_json.force_encoding('ASCII-8BIT')
         }.merge(auth),
         schedule_time: timestamp && Google::Protobuf::Timestamp.new.tap do |ts|
           ts.seconds = timestamp

data/lib/rails_cloud_tasks/configuration.rb

@@ -1,12 +1,22 @@
 module RailsCloudTasks
   class Configuration
-    attr_accessor :project_id, :location_id, :host, :tasks_path, :jobs, :auth
+    attr_accessor :location_id, :host, :tasks_path, :service_account_email, :scheduler_file_path,
+                  :scheduler_prefix_name
 
-    def initialize
-      @jobs = Set.new
-      @project_id = AppEngine.project_id
+    attr_writer :project_id
+    attr_reader :app_engine, :google_auth
+
+    def initialize(app_engine = AppEngine, google_auth = Google::Auth)
+      @service_account_email = ENV['GCP_SERVICE_ACCOUNT']
+      @location_id = ENV['GCP_LOCATION']
+      @project_id = ENV['GCP_PROJECT']
+      @host = ENV['GCP_APP_ENDPOINT']
       @tasks_path = '/tasks'
-      @auth = authenticate
+      @scheduler_file_path = './config/scheduler.yml'
+      @scheduler_prefix_name = 'rails-cloud'
+
+      @app_engine = app_engine
+      @google_auth = google_auth
     end
 
     def inject_routes
@@ -18,20 +28,26 @@ module RailsCloudTasks
       end
     end
 
+    def project_id
+      @project_id ||= app_engine.project_id
+    end
+
+    def auth
+      @auth ||= authenticate
+    end
+
     private
 
     def authenticate
-      email = AppEngine.service_account_email || Google::Auth.get_application_default.issuer
+      email = service_account_email ||
+              app_engine.service_account_email ||
+              google_auth.get_application_default.issuer
 
       {
         oidc_token: {
           service_account_email: email
         }
       }
-    rescue RuntimeError, Errno::EHOSTDOWN
-      # EHOSTDOWN occurs sporadically when trying to resolve the metadata endpoint
-      # locally. It is unlikely to occur when running on GCE.
-      {}
     end
   end
 end

data/lib/rails_cloud_tasks/credentials.rb

@@ -0,0 +1,38 @@
+module RailsCloudTasks
+  class Credentials
+    require 'googleauth'
+    require 'google/apis/cloudscheduler_v1'
+    require 'google/apis/iamcredentials_v1'
+
+    DEFAULT_SCOPES = ['https://www.googleapis.com/auth/cloud-platform'].freeze
+    attr_reader :request_options, :iam_credential, :token_request, :auth
+
+    def initialize(
+      request_options: Google::Apis::RequestOptions.new,
+      iam_credential: Google::Apis::IamcredentialsV1::IAMCredentialsService.new,
+      token_request: Google::Apis::IamcredentialsV1::GenerateAccessTokenRequest,
+      auth: Google::Auth
+    )
+      @auth = auth
+      @request_options = request_options
+      @iam_credential = iam_credential
+      @token_request = token_request
+    end
+
+    def generate(impersonate_account = nil, scopes = [])
+      current_scopes = DEFAULT_SCOPES + scopes
+      authorization = auth.get_application_default(current_scopes).dup
+      request_options.authorization = authorization
+
+      if impersonate_account
+        iam_credential.generate_service_account_access_token(
+          "projects/-/serviceAccounts/#{impersonate_account}",
+          token_request.new(scope: current_scopes, lifetime: '3600s'),
+          options: request_options
+        )
+      end
+
+      request_options.authorization
+    end
+  end
+end

data/lib/rails_cloud_tasks/rack/jobs.rb

@@ -12,7 +12,7 @@ module RailsCloudTasks
           job_args = extract_args(request)
           job_class.perform_now(job_args)
 
-          response(200, { error: nil })
+          response(200, {})
         rescue Rack::InvalidPayloadError => e
           response(422, { error: e.message })
         rescue StandardError => e

data/lib/rails_cloud_tasks/rack/tasks.rb

@@ -11,7 +11,7 @@ module RailsCloudTasks
 
           ActiveJob::Base.execute(job)
 
-          response(200, { error: nil })
+          response(200, {})
         rescue Rack::InvalidPayloadError => e
           response(400, { error: e.cause.message })
         rescue StandardError => e

data/lib/rails_cloud_tasks/scheduler.rb

@@ -0,0 +1,62 @@
+module RailsCloudTasks
+  class Scheduler
+    delegate :project_id, :location_id, :host, :auth, :tasks_path,
+             :scheduler_file_path, :scheduler_prefix_name,
+             :service_account_email, to: 'RailsCloudTasks.config'
+
+    attr_reader :client, :credentials
+
+    def initialize(
+      client: Google::Cloud::Scheduler.cloud_scheduler,
+      credentials: RailsCloudTasks::Credentials.new
+    )
+      client.configure do |config|
+        config.credentials = credentials.generate(service_account_email)
+      end
+      @client = client
+    end
+
+    # Create & Update scheduler job on Google Cloud
+    # TODO: Support to delete scheduled jobs
+    def upsert
+      scheduler_jobs.each do |job|
+        begin
+          client.create_job parent: location_path, job: job
+        rescue Google::Cloud::AlreadyExistsError
+          client.update_job job: job
+        end
+      end
+    end
+
+    protected
+
+    def location_path
+      @location_path ||= client.location_path project: project_id, location: location_id
+    end
+
+    def scheduler_jobs
+      parse_jobs_from_file.map(&method(:build_job))
+    end
+
+    def build_job(job)
+      {
+        name:        "#{location_path}/jobs/#{scheduler_prefix_name}--#{job[:name]}",
+        schedule:    job[:schedule],
+        description: job[:description],
+        time_zone:   job[:time_zone],
+        http_target: {
+          uri:         "#{host}#{tasks_path}/#{job[:name]}",
+          http_method: 'POST',
+          body:        job[:args].to_json
+        }.merge(auth)
+      }
+    end
+
+    def parse_jobs_from_file
+      settings = File.read(File.expand_path(scheduler_file_path))
+      YAML.safe_load(ERB.new(settings).result).map(&:deep_symbolize_keys)
+    rescue Errno::ENOENT
+      []
+    end
+  end
+end

data/lib/rails_cloud_tasks/version.rb

@@ -1,3 +1,3 @@
 module RailsCloudTasks
-  VERSION = '0.0.1'.freeze
+  VERSION = '0.0.2'.freeze
 end

data/lib/railtie.rb

@@ -0,0 +1,15 @@
+require 'rails-cloud-tasks'
+require 'rails'
+
+module RailsCloudTasks
+  class Railtie < Rails::Railtie
+    railtie_name :rails_cloud_tasks
+
+    rake_tasks do
+      namespace :rails_cloud_tasks do
+        path = File.expand_path(__dir__)
+        Dir.glob("#{path}/tasks/**/*.rake").each { |f| load f }
+      end
+    end
+  end
+end

data/lib/tasks/scheduler.rake

@@ -0,0 +1,6 @@
+namespace :scheduler do
+  desc 'Sync all scheduled jobs to Google Cloud'
+  task sync: :environment do
+    RailsCloudTasks::Scheduler.new.upsert
+  end
+end

data/rails-cloud-tasks.gemspec

@@ -23,6 +23,9 @@ Gem::Specification.new do |spec|
   end
 
   spec.add_dependency 'activesupport', '>= 4'
+  spec.add_dependency 'google-apis-cloudscheduler_v1'
+  spec.add_dependency 'google-apis-iamcredentials_v1'
+  spec.add_dependency 'google-cloud-scheduler', '>= 2'
   spec.add_dependency 'google-cloud-tasks', '>= 2'
   spec.add_development_dependency 'rails', '>= 4'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails-cloud-tasks
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Guilherme Araújo
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-01-29 00:00:00.000000000 Z
+date: 2021-02-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -24,6 +24,48 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '4'
+- !ruby/object:Gem::Dependency
+  name: google-apis-cloudscheduler_v1
+  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: google-apis-iamcredentials_v1
+  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: google-cloud-scheduler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2'
 - !ruby/object:Gem::Dependency
   name: google-cloud-tasks
   requirement: !ruby/object:Gem::Requirement
@@ -236,14 +278,19 @@ files:
 - Gemfile
 - LICENSE
 - README.md
+- Rakefile
 - lib/rails-cloud-tasks.rb
 - lib/rails_cloud_tasks/adapter.rb
 - lib/rails_cloud_tasks/app_engine.rb
 - lib/rails_cloud_tasks/configuration.rb
+- lib/rails_cloud_tasks/credentials.rb
 - lib/rails_cloud_tasks/rack/errors.rb
 - lib/rails_cloud_tasks/rack/jobs.rb
 - lib/rails_cloud_tasks/rack/tasks.rb
+- lib/rails_cloud_tasks/scheduler.rb
 - lib/rails_cloud_tasks/version.rb
+- lib/railtie.rb
+- lib/tasks/scheduler.rake
 - rails-cloud-tasks.gemspec
 homepage: http://github.com/flamingo-run/rails-cloud-tasks
 licenses: