asyncapi-client 0.5.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 64a8ce03807506f44f69762c6665bf12e84a51eb
-  data.tar.gz: f5eca9fca67c3f7572bdea685c31e14ac7ceb2ee
+  metadata.gz: 2c4aa942b90ab8794c0eaeb572810d4277581df5
+  data.tar.gz: 186bd9cf4144c883d8f532e18caa8bd5143c2755
 SHA512:
-  metadata.gz: 74f00f266d50fec02b36bc0445ad46e43dcefd57e0ee4d578ef1ba2691fb327ec542eac54e6b035e59599625c25edcf12ab579ffde6fbf17cd82085b96878b40
-  data.tar.gz: db2eb606379785bb662c2ebba473afb625a16c1ce24d79f46625d07864443e338c79d432cd88a28788dbdc4b84512183c2430f5b88d9c90ba51e26a0ad42a0f6
+  metadata.gz: 6553230b72635076b4fee02bb0a47fd04b50821c6ddae57f3819bc353f33289c151eadbfe5fbcd8be0a58cb8e36f07d28209e7684ffee3aef7c6c82876c5e1a1
+  data.tar.gz: a4358536d0282459c8830a2009b761d60d008ea5dfdfa6c7be598edd75c5effa8629b18ccfd583c18f323b24974c2beedbeab90caf94c4a6c28f065e0e66ed0a

data/README.md

@@ -2,7 +2,11 @@
 
 Asyncapi::Client is a Rails engine that easily allows asynchronous communication with a [Asyncapi::Server](https://github.com/G5/asyncapi-server)-based API server.
 
-This avoids tying up your web servers executing long running processes. Scaling typically requires more workers.
+The common pattern that this gem saves you from implementing for the service callback pattern. [soapatterns.org](http://soapatterns.org/design_patterns/service_callback) describes it well, and [this image they provide](http://soapatterns.org/static/images/figures/service_callback/fig1.png) summarizes it:
+
+![Service Callback Pattern](docs/service-callback-pattern.png)
+
+Implementing this typically requires a bunch of code that looks the same: HTTP posts, receive hooks - all while the data that's passed around different.
 
 # Usage
 
@@ -23,14 +27,19 @@ Asyncapi::Client::Job.post(
 )
 ```
 
-*Jobs that should be timed out are marked as `timed_out` approximately every minute.*
+Here is a breakdown of what these parameters mean:
 
-Each of the `on_*` classes will get executed. For example, when the job is queued on the server, `DoOnQueue#call` will get called with the `Asyncapi::Client::Job` instance passed in. Example:
+- `http://server.com/long/running/process`: this is an endpoint that you will create using [Asyncapi::Server](https://github.com/G5/asyncapi-server)
+- `body`: any data you want to send to the server that's needed for it to do its work
+- `headers`: if needed, headers for authorization, for example
+- `on_success`, `on_error`, `on_*`: service objects that will get executed whenever these events occur. More on this below.
+- `time_out`: when this job should be considered timed out. This is helpful when you want to know if the server ever got to working on the job. Jobs that should be timed out are marked as `timed_out` approximately every minute.
+
+## `on_*` Callbacks
 
 ```ruby
 class DoOnQueue < Asyncapi::Client::CallbackRunner
   def call
-    # you have access to: job, callback_params
     Rails.logger.info "Job##{job.id} successfully queued with body: #{job.body}"
   end
 end
@@ -43,13 +52,12 @@ end
 
 class DoOnError < Asyncapi::Client::CallbackRunner
   def call
-    # you have access to: job and its fields: callback_params, :body, :headers, :message, :response_code
     Rails.logger.info "Job##{job.id} failed. The server's response: #{job.message}"
   end
 end
 ```
 
-In the callback classes, you have access to the `job` and its fields (directly):
+In the callback service objects, you have access to the `job` and its fields (directly):
 
 - `callback_params`
 - `body`
@@ -57,7 +65,7 @@ In the callback classes, you have access to the `job` and its fields (directly):
 - `message`
 - `response_code`
 
-Currently, this Engine only works with [Sidekiq](http://sidekiq.org), [typhoeus](https://github.com/typhoeus/typhoeus), and [kaminari](https://github.com/amatsuda/kaminari). Customizing these can be introduced as needed.
+Currently, this Engine only works with [Sidekiq](http://sidekiq.org), [typhoeus](https://github.com/typhoeus/typhoeus), and [kaminari](https://github.com/amatsuda/kaminari). Customizing these can be introduced to this gem as needed.
 
 To run the application, you need to have the Sidekiq workers running as well.
 
@@ -73,7 +81,13 @@ By default, jobs 10 days old and older will be deleted. You can change this sett
 Asyncapi::Client.expiry_threshold = 5.days
 ```
 
-If you don't ever want the jobs to get delete, set the threshold to `nil`.
+If you don't want the jobs to get deleted, set the threshold to `nil`.
+
+The cleaner job is run every day at "0 0 * * *". If you want to change the frequency that this runs, then:
+
+```ruby
+Asyncapi::Client.clean_job_cron = "30 2 * * *"
+```
 
 # Installation
 

data/app/models/asyncapi/client/job.rb

@@ -71,7 +71,6 @@ module Asyncapi::Client
       args[:time_out_at] = time_out.from_now if time_out
       job = create(args)
       JobPostWorker.perform_async(job.id, url)
-      CleanerWorker.perform_async
     end
 
     def url

data/app/workers/asyncapi/client/cleaner_worker.rb

@@ -14,3 +14,11 @@ module Asyncapi
     end
   end
 end
+
+if Sidekiq.server?
+  Sidekiq::Cron::Job.create({
+    name: "Delete old jobs",
+    cron: Asyncapi::Client.clean_job_cron,
+    klass: Asyncapi::Client::CleanerWorker.name,
+  })
+end

data/lib/asyncapi/client.rb

@@ -9,9 +9,10 @@ require "securerandom"
 module Asyncapi
   module Client
 
-    CONFIG_ATTRS = [:parent_controller, :expiry_threshold]
+    CONFIG_ATTRS = %i[parent_controller expiry_threshold clean_job_cron]
     mattr_accessor(*CONFIG_ATTRS)
     self.expiry_threshold = 10.days
+    self.clean_job_cron = "0 0 * * *"
 
     def self.configure
       yield self

data/lib/asyncapi/client/version.rb

@@ -1,5 +1,5 @@
 module Asyncapi
   module Client
-    VERSION = "0.5.1"
+    VERSION = "0.6.0"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: asyncapi-client
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.6.0
 platform: ruby
 authors:
 - G5
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-17 00:00:00.000000000 Z
+date: 2016-05-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -280,7 +280,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Asynchronous API communication