arthropod 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 402aefa5ebb2883aa9660285c850995454a8a5dd87dc5cf4b1fc3131c66a25cc
-  data.tar.gz: fb12c70b9088b22e81cac21de40edd01e23fb50b668b8f775010ed80cfdff31b
+  metadata.gz: 7b049a78069051c3d4a0f8f52e9d25b047c884a46e452ff24e57de6882f1b638
+  data.tar.gz: 225660b18ac24915428b66bf85ece0ed5f8d21894befbbb0279f317047304151
 SHA512:
-  metadata.gz: 2bf3436d18735c33198c163fc950aaca20f663828c6e5cdc918000df26bcf109a1c6abac885c1a96dec22fc42c8a4d0ea64c745165974d3b0a75d4738ed81364
-  data.tar.gz: 52a1c6f6b0455633e97414eae5eeadf359b4436aae49653714031f9aba8f023538845c77fc9c9536426a5c749073c99aae67db1225345ee793b3916eb23467d1
+  metadata.gz: 9cbec6ec5b5dcd4a84868e0b8e0df73341fb289b21efbaea230237d033d1dce50abcce60c14ce3de3342435abcd6685d77114b35bc34d33986debe0fbe01d233
+  data.tar.gz: 0037a32c4ab1015430fd8fe2fad2d981ffa2ae8d399f3ad17cdb0007f3455de32e37dc341ef4eda78505c37dd9b71b81e7875209202d19b70351507119a2f5ff

data/.gitignore

@@ -1 +1,2 @@
 .env
+*.gem

data/README.md

@@ -4,6 +4,22 @@ Arthropod is a easy way to run remote ruby code synchronously, using Amazon SQS.
 
 *Do not use it yet, the API isn't stable at all and it wasn't tested enough on production*
 
+## Installation
+
+```
+gem install arthropod
+```
+
+Or in your Gemfile
+
+```
+gem 'arthropod', '~> 0.0.1'
+```
+
+## Configuration
+
+You will need the following environment variables `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY` and `AWS_REGION`. Optionally the `Arthropod::Client.push` and `Arthropod::Server.pull`  methods can take a `client` argument with your own instance of `Aws::SQS::Client`, see https://docs.aws.amazon.com/en_en/sdk-for-ruby/v3/developer-guide/sqs-examples.html for more information.
+
 ## Usage
 
 A simple use case first, let's say you want to push a video encoding task to another server:
@@ -20,7 +36,7 @@ On the "server" side:
 
 ```ruby
 Arthropod::Server.pull(queue_name: "video_encoding") do |request|
-  video_url = request.body.url
+  video_url = request.body["url"]
 
   # Do the encoding stuff
   encoded_video_url = VideoEncoder.encode(video_url)
@@ -58,6 +74,10 @@ puts response.body
 # => "https://my_storage.my_service.com/my_reencoded_video_file.mp4"
 ```
 
+## Errors
+
+Any exception raised on server side will cause the client side to close immediately and raise a `Arthropod::Client::ServerError` exception.
+
 ## API
 
 ```ruby
@@ -89,4 +109,4 @@ Of course you can also achieve that by simply using SQS or any kind of message s
 
 ## Example: the poor man's video encoding service
 
-If you're not concerned about latency, you can for example push some heavy video encoding task from and ActiveJob job in your Rails task and run a little cron job every minute on your uber-CUDA-powered computer at home to pull those jobs and reencode your videos. It should be reliable enough and it may be even be way faster than doing it with the CPU off a regular server.
+If you're not concerned about latency, you can for example push some heavy video encoding task from and ActiveJob job in your Rails task and run a little cron job every minute on your uber-CUDA-powered computer at home to pull those jobs and reencode your videos. It should be reliable enough and it may be even be way faster than doing it with the CPU of a regular server.

data/lib/arthropod/client.rb

@@ -3,6 +3,8 @@ require 'securerandom'
 
 module Arthropod
   module Client
+    class ServerError < StandardError; end
+
     def self.push(queue_name:, body:, client: nil)
       client ||= Aws::SQS::Client.new
 
@@ -19,6 +21,8 @@ module Arthropod
           begin
             if response.state == "close"
               return response
+            elsif response.state == "error"
+              raise Arthropod::Client::ServerError
             else
               yield response if block_given?
             end

data/lib/arthropod/request.rb

@@ -23,10 +23,14 @@ module Arthropod
       send_message({ state: "open", body: body })
     end
 
-    def close(body = nil)
+    def close!(body = nil)
       send_message({ state: "close", body: body })
     end
 
+    def error!(body = nil)
+      send_message({ state: "error", body: body })
+    end
+
     private
 
     def send_message(message_body)

data/lib/arthropod/server.rb

@@ -10,7 +10,10 @@ module Arthropod
       response.messages.each do |message|
         request = Arthropod::Request.new(client: client, message: message)
         begin
-          request.close(yield request)
+          request.close!(yield request)
+        rescue => error
+          request.error!
+          raise error
         ensure
           client.delete_message(queue_url: sender_queue.queue_url, receipt_handle: message.receipt_handle)
         end

data/lib/arthropod/version.rb

@@ -1,3 +1,3 @@
 module Arthropod
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/spec/client_spec.rb

@@ -41,6 +41,13 @@ RSpec.describe(Arthropod::Client) do
         receive(:send_message)
         .with({ queue_url: sender_queue_url, message_body: JSON.dump({ return_queue_url: return_queue_url, body: body }) })
       )
+      expect(client).to(
+        receive(:delete_queue)
+        .with({ queue_url: return_queue_url })
+      )
+    end
+
+    it "works" do
       expect(client).to(
         receive(:receive_message)
         .with({ queue_url: return_queue_url, max_number_of_messages: 1, wait_time_seconds: 1 })
@@ -51,17 +58,21 @@ RSpec.describe(Arthropod::Client) do
         .with({ queue_url: return_queue_url, max_number_of_messages: 1, wait_time_seconds: 1 })
         .and_return(OpenStruct.new(messages: [ OpenStruct.new({ "body" => JSON.dump({ "state" => "close", "body" => "payload" }), receipt_handle: "receipt_handle" }) ]))
       )
-      expect(client).to(
-        receive(:delete_queue)
-        .with({ queue_url: return_queue_url })
-      )
-    end
-
-    it "works" do
       response = Arthropod::Client.push(client: client, queue_name: "test", body: body) do |response|
         expect(response.body).to eq("update")
       end
       expect(response.body).to eq("payload")
     end
+
+    it "should raise on error" do
+      expect(client).to(
+        receive(:receive_message)
+        .with({ queue_url: return_queue_url, max_number_of_messages: 1, wait_time_seconds: 1 })
+        .and_return(OpenStruct.new(messages: [ OpenStruct.new({ "body" => JSON.dump({ "state" => "error" }), receipt_handle: "receipt_handle" }) ]))
+      )
+      expect do
+        Arthropod::Client.push(client: client, queue_name: "test", body: body)
+      end.to raise_error(Arthropod::Client::ServerError)
+    end
   end
 end

data/spec/server_spec.rb

@@ -29,6 +29,9 @@ RSpec.describe(Arthropod::Server) do
         .with({ queue_url: sender_queue_url, max_number_of_messages: 1, wait_time_seconds: 1 })
         .and_return(OpenStruct.new(messages: [ OpenStruct.new({ "body" => JSON.dump({ "body" => "request", "return_queue_url" => return_queue_url }), receipt_handle: "receipt_handle" }) ]))
       )
+    end
+
+    it "works" do
       expect(client).to(
         receive(:send_message)
         .with({ queue_url: return_queue_url, message_body: JSON.dump({ state: "open", body: "response" }) })
@@ -37,9 +40,7 @@ RSpec.describe(Arthropod::Server) do
         receive(:send_message)
         .with({ queue_url: return_queue_url, message_body: JSON.dump({ state: "close", body: "final_response" }) })
       )
-    end
 
-    it "works" do
       Arthropod::Server.pull(client: client, queue_name: "test") do |request|
         expect(request.body).to eq("request")
         request.respond "response"
@@ -47,5 +48,18 @@ RSpec.describe(Arthropod::Server) do
         "final_response"
       end
     end
+
+    it "send error on exception" do
+      expect(client).to(
+        receive(:send_message)
+        .with({ queue_url: return_queue_url, message_body: JSON.dump({ state: "error", body: nil }) })
+      )
+
+      expect do
+        Arthropod::Server.pull(client: client, queue_name: "test") do |request|
+          raise "error"
+        end
+      end.to raise_error(Exception)
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: arthropod
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Victor Goya
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-07 00:00:00.000000000 Z
+date: 2019-12-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-sqs