async_request 0.0.7 → 1.0.0

data/spec/factories/async_request_job.rb

@@ -19,5 +19,11 @@ module AsyncRequest
     trait :processed do
       status Job.statuses[:processed]
     end
+
+    trait :failed do
+      status Job.statuses[:failed]
+      status_code 500
+      response { {} }
+    end
   end
 end

data/spec/models/async_request/job_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+
+describe AsyncRequest::Job do
+  describe '.create_and_enqueue' do
+    let(:worker) { WorkerWithoutErrors }
+
+    context 'when no worker class is passed' do
+      it 'fails with ArgumentError' do
+        expect { described_class.create_and_enqueue(nil, []) }.to raise_error(ArgumentError)
+      end
+    end
+
+    context 'when called with valid params' do
+      it 'creates a new job object' do
+        expect { described_class.create_and_enqueue(worker, 'a') }
+          .to change { described_class.count }.by(1)
+      end
+
+      it 'creates a new job object with WorkerWithoutErrors as worker' do
+        job = described_class.create_and_enqueue(worker, 'a')
+        expect(job.worker).to eq worker.to_s
+      end
+
+      it "creates a new job object with ['a'] as params" do
+        job = described_class.create_and_enqueue(worker, 'a')
+        expect(job.params).to eq ['a']
+      end
+
+      it 'creates a new job object with waiting status' do
+        job = described_class.create_and_enqueue(worker, 'a')
+        expect(job.waiting?).to be_truthy
+      end
+
+      it 'serializes complex params' do
+        job = described_class.create_and_enqueue(worker, { a: 'a' }, 3, 'a')
+        expect(job.params).to eq [{ a: 'a' }, 3, 'a']
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -45,6 +45,7 @@ RSpec.configure do |config|
   end
 
   config.include Response::JSONParser, type: :controller
+  config.include Helpers
 
   # Remove this line if you're not using ActiveRecord or ActiveRecord fixtures
   config.fixture_path = "#{::Rails.root}/spec/fixtures"

data/spec/support/helpers.rb

@@ -0,0 +1,5 @@
+module Helpers
+  def job_id_from_token(token)
+    AsyncRequest::JsonWebToken.decode(token)['job_id']
+  end
+end

data/spec/workers/async_request/job_processor_spec.rb

@@ -2,29 +2,59 @@ require 'spec_helper'
 
 module AsyncRequest
   describe JobProcessor do
-    include AsyncRequest::Engine.helpers
-    describe '.perform' do
-      let(:uid) { execute_async(Test, { a: 'a' }, 3, 'a') }
+    describe '#perform' do
+      let(:job) { AsyncRequest::Job.create_and_enqueue(worker, { a: 'a' }, 3, 'a') }
 
-      before(:each) do
-        Test.any_instance.stub(:execute).and_return([200, { status: 'success' }])
-      end
+      context 'when executing the worker' do
+        context 'when it finishes without errors' do
+          let(:worker) { WorkerWithoutErrors }
+
+          it 'calls Test class' do
+            expect_any_instance_of(worker).to receive(:execute).with({ a: 'a' }, 3, 'a')
+            described_class.new.perform(job.id)
+          end
+
+          it 'saves the worker status code' do
+            described_class.new.perform(job.id)
+            expect(job.reload.status_code).to eq 200
+          end
 
-      context 'When executing the worker' do
-        it 'calls Test class' do
-          expect_any_instance_of(Test).to receive(:execute).with({ a: 'a' }, 3, 'a')
-          JobProcessor.new.perform(Job.find_by(uid: uid).id)
+          it 'saves the worker response' do
+            described_class.new.perform(job.id)
+            expect(job.reload.response).to eq({ 'message' => 'success' }.to_json)
+          end
         end
 
-        it 'saves the worker status code' do
-          JobProcessor.new.perform(Job.find_by(uid: uid).id)
-          expect(Job.find_by(uid: uid).status_code).to eq 200
+        context 'when the worker returns a symbol as status code' do
+          let(:worker) { WorkerWithSymbol }
+
+          it 'saves the worker status code' do
+            described_class.new.perform(job.id)
+            expect(job.reload.status_code).to eq 200
+          end
         end
 
-        it 'saves the worker response' do
-          JobProcessor.new.perform(Job.find_by(uid: uid).id)
-          response = Job.find_by(uid: uid).response
-          expect(response).to eq({ status: 'success' }.to_json)
+        context 'when the worker returns nil as the response' do
+          let(:worker) { WorkerReturningNil }
+
+          it 'saves the worker status code' do
+            described_class.new.perform(job.id)
+            expect(job.reload.response).to eq ''
+          end
+        end
+
+        context 'when it raises an error' do
+          let(:worker) { WorkerWithErrors }
+
+          it 'updates the job with the right status' do
+            described_class.new.perform(job.id)
+            expect(job.reload.failed?).to be_truthy
+          end
+
+          it 'saves the job with a 500 as status code' do
+            described_class.new.perform(job.id)
+            expect(job.reload.status_code).to eq 500
+          end
         end
       end
     end

metadata

@@ -1,14 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: async_request
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 1.0.0
 platform: ruby
 authors:
 - Matias De Santi
+- Alejandro Bezdjian
+- Alan Halatian
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-15 00:00:00.000000000 Z
+date: 2018-04-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -28,16 +30,36 @@ dependencies:
   name: sidekiq
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+- !ruby/object:Gem::Dependency
+  name: jwt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: pg
   requirement: !ruby/object:Gem::Requirement
@@ -140,34 +162,30 @@ dependencies:
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.52'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-description: At [Wolox](http://www.wolox.com.ar) we build Rails Apps. Some of them
-  need heavy computing when a request is received. In order to make the App scalable,
-  we perform those heavy actions in background. We return a job-id and the client
-  asks for it's state a few seconds after. `async_request` gives us the possibility
-  of handling these type of requests in a simple way.
+        version: '0.52'
+description: Perform background jobs and ask for the result in a simple way.
 email:
 - matias.desanti@wolox.com.ar
+- alejandro.bezdjian@wolox.com.ar
+- alan.halatian@wolox.com.ar
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - Rakefile
-- app/assets/javascripts/async_request/application.js
-- app/assets/stylesheets/async_request/application.css
 - app/controllers/async_request/application_controller.rb
 - app/controllers/async_request/jobs_controller.rb
-- app/helpers/async_request/application_helper.rb
 - app/models/async_request/job.rb
+- app/poros/async_request/json_web_token.rb
 - app/views/layouts/async_request/application.html.erb
 - app/workers/async_request/job_processor.rb
 - config/routes.rb
@@ -175,17 +193,22 @@ files:
 - lib/async_request/engine.rb
 - lib/async_request/version.rb
 - lib/generators/async_request_generator.rb
-- lib/tasks/async_request_tasks.rake
+- lib/templates/async_request.rb
 - lib/templates/create_async_request_jobs.rb
 - spec/controllers/async_request/jobs_controller_spec.rb
+- spec/controllers/dummy_controller_spec.rb
 - spec/dummy/README.rdoc
 - spec/dummy/Rakefile
 - spec/dummy/app/assets/javascripts/application.js
 - spec/dummy/app/assets/stylesheets/application.css
 - spec/dummy/app/controllers/application_controller.rb
+- spec/dummy/app/controllers/dummy_controller.rb
 - spec/dummy/app/helpers/application_helper.rb
 - spec/dummy/app/views/layouts/application.html.erb
-- spec/dummy/app/workers/test.rb
+- spec/dummy/app/workers/worker_returning_nil.rb
+- spec/dummy/app/workers/worker_with_errors.rb
+- spec/dummy/app/workers/worker_with_symbol.rb
+- spec/dummy/app/workers/worker_without_errors.rb
 - spec/dummy/bin/bundle
 - spec/dummy/bin/rails
 - spec/dummy/bin/rake
@@ -199,6 +222,7 @@ files:
 - spec/dummy/config/environments/production.rb
 - spec/dummy/config/environments/test.rb
 - spec/dummy/config/initializers/assets.rb
+- spec/dummy/config/initializers/async_request.rb
 - spec/dummy/config/initializers/backtrace_silencers.rb
 - spec/dummy/config/initializers/cookies_serializer.rb
 - spec/dummy/config/initializers/filter_parameter_logging.rb
@@ -209,16 +233,17 @@ files:
 - spec/dummy/config/locales/en.yml
 - spec/dummy/config/routes.rb
 - spec/dummy/config/secrets.yml
+- spec/dummy/db/migrate/20170815023204_create_async_request_jobs.rb
 - spec/dummy/db/schema.rb
-- spec/dummy/log/development.log
 - spec/dummy/log/test.log
 - spec/dummy/public/404.html
 - spec/dummy/public/422.html
 - spec/dummy/public/500.html
 - spec/dummy/public/favicon.ico
 - spec/factories/async_request_job.rb
-- spec/helpers/async_request/application_helper_spec.rb
+- spec/models/async_request/job_spec.rb
 - spec/spec_helper.rb
+- spec/support/helpers.rb
 - spec/support/parsed_response_helper.rb
 - spec/workers/async_request/job_processor_spec.rb
 homepage: https://github.com/Wolox/async-requests
@@ -244,50 +269,56 @@ rubyforge_project:
 rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
-summary: async_request gives us the possibility of handling these type of requests
-  in a simple way.
+summary: Perform background jobs and ask for the result in a simple way.
 test_files:
-- spec/dummy/README.rdoc
-- spec/dummy/Rakefile
-- spec/dummy/config/application.rb
-- spec/dummy/config/environment.rb
-- spec/dummy/config/environments/test.rb
-- spec/dummy/config/environments/development.rb
-- spec/dummy/config/environments/production.rb
-- spec/dummy/config/locales/en.yml
+- spec/spec_helper.rb
+- spec/dummy/app/workers/worker_without_errors.rb
+- spec/dummy/app/workers/worker_with_symbol.rb
+- spec/dummy/app/workers/worker_returning_nil.rb
+- spec/dummy/app/workers/worker_with_errors.rb
+- spec/dummy/app/controllers/application_controller.rb
+- spec/dummy/app/controllers/dummy_controller.rb
+- spec/dummy/app/views/layouts/application.html.erb
+- spec/dummy/app/assets/javascripts/application.js
+- spec/dummy/app/assets/stylesheets/application.css
+- spec/dummy/app/helpers/application_helper.rb
+- spec/dummy/bin/rake
+- spec/dummy/bin/setup
+- spec/dummy/bin/bundle
+- spec/dummy/bin/rails
+- spec/dummy/config/secrets.yml
 - spec/dummy/config/routes.rb
+- spec/dummy/config/locales/en.yml
+- spec/dummy/config/environments/production.rb
+- spec/dummy/config/environments/development.rb
+- spec/dummy/config/environments/test.rb
+- spec/dummy/config/environment.rb
+- spec/dummy/config/application.rb
 - spec/dummy/config/database.yml
 - spec/dummy/config/boot.rb
-- spec/dummy/config/secrets.yml
 - spec/dummy/config/initializers/backtrace_silencers.rb
+- spec/dummy/config/initializers/mime_types.rb
+- spec/dummy/config/initializers/filter_parameter_logging.rb
 - spec/dummy/config/initializers/session_store.rb
 - spec/dummy/config/initializers/wrap_parameters.rb
-- spec/dummy/config/initializers/inflections.rb
-- spec/dummy/config/initializers/filter_parameter_logging.rb
-- spec/dummy/config/initializers/mime_types.rb
-- spec/dummy/config/initializers/cookies_serializer.rb
 - spec/dummy/config/initializers/assets.rb
-- spec/dummy/db/schema.rb
+- spec/dummy/config/initializers/async_request.rb
+- spec/dummy/config/initializers/cookies_serializer.rb
+- spec/dummy/config/initializers/inflections.rb
 - spec/dummy/config.ru
-- spec/dummy/log/test.log
-- spec/dummy/log/development.log
-- spec/dummy/app/views/layouts/application.html.erb
-- spec/dummy/app/assets/stylesheets/application.css
-- spec/dummy/app/assets/javascripts/application.js
-- spec/dummy/app/workers/test.rb
-- spec/dummy/app/controllers/application_controller.rb
-- spec/dummy/app/helpers/application_helper.rb
-- spec/dummy/public/500.html
+- spec/dummy/Rakefile
+- spec/dummy/public/favicon.ico
 - spec/dummy/public/422.html
+- spec/dummy/public/500.html
 - spec/dummy/public/404.html
-- spec/dummy/public/favicon.ico
-- spec/dummy/bin/bundle
-- spec/dummy/bin/setup
-- spec/dummy/bin/rails
-- spec/dummy/bin/rake
-- spec/spec_helper.rb
-- spec/workers/async_request/job_processor_spec.rb
-- spec/factories/async_request_job.rb
+- spec/dummy/db/schema.rb
+- spec/dummy/db/migrate/20170815023204_create_async_request_jobs.rb
+- spec/dummy/log/test.log
+- spec/dummy/README.rdoc
+- spec/models/async_request/job_spec.rb
+- spec/support/helpers.rb
 - spec/support/parsed_response_helper.rb
+- spec/factories/async_request_job.rb
+- spec/workers/async_request/job_processor_spec.rb
 - spec/controllers/async_request/jobs_controller_spec.rb
-- spec/helpers/async_request/application_helper_spec.rb
+- spec/controllers/dummy_controller_spec.rb

data/app/assets/javascripts/async_request/application.js

@@ -1,13 +0,0 @@
-// This is a manifest file that'll be compiled into application.js, which will include all the files
-// listed below.
-//
-// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
-// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
-//
-// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
-// compiled file.
-//
-// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
-// about supported directives.
-//
-//= require_tree .

data/app/assets/stylesheets/async_request/application.css

@@ -1,15 +0,0 @@
-/*
- * This is a manifest file that'll be compiled into application.css, which will include all the files
- * listed below.
- *
- * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
- * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
- *
- * You're free to add application-wide styles to this file and they'll appear at the bottom of the
- * compiled file so the styles you add here take precedence over styles defined in any styles
- * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
- * file per style scope.
- *
- *= require_tree .
- *= require_self
- */

data/app/helpers/async_request/application_helper.rb

@@ -1,15 +0,0 @@
-module AsyncRequest
-  module ApplicationHelper
-    def execute_async(worker_class, *params)
-      raise ArgumentError if worker_class.nil?
-      job = Job.create(
-        worker: worker_class,
-        params: params,
-        status: Job.statuses[:waiting],
-        uid: SecureRandom.uuid
-      )
-      JobProcessor.perform_async(job.id)
-      job.uid
-    end
-  end
-end

data/lib/tasks/async_request_tasks.rake

@@ -1,4 +0,0 @@
-# desc "Explaining what the task does"
-# task :async_request do
-#   # Task goes here
-# end

data/spec/dummy/app/workers/test.rb

@@ -1,7 +0,0 @@
-class Test
-
-  def execute(params)
-    puts params
-    [200, { message: 'you did it!' }]
-  end
-end