phobos_db_checkpoint 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4b29e206cb7135f08b91717795503156869f4b7f
-  data.tar.gz: e5e38ea02d946d15df776e139de72943e85cbefc
+  metadata.gz: f2b492fa71a95e8304f837094421494f8a441a1a
+  data.tar.gz: 6470c1c13a9ab979cac8f228a725d5782e50f027
 SHA512:
-  metadata.gz: a01c09788822ac5ecf0f11d412777b9a29274645ad46805ebb972da9e6469afec76402ea364d03bd61011ccab1d35912d4986dfa83550133eee757adc88c3125
-  data.tar.gz: f76968bd632cd8a0a5f98a39458d9d07af98a0cbba1c6596b9a015c7fb37e8821ac407cba2d6ec8e70b8f42f0f31c27d2095376f71a472772b4203b5bf05507c
+  metadata.gz: f2327f3693b35fb330f9af48a878dd7e825e24eadb7f43627ad348c0c48f0f9df2c72c10933bf95298faf99e02a18220348647126073db1add6e3f8705b0b1cb
+  data.tar.gz: 5cf8e5153d09340f01aab345b55ad07891ea055a8946648f503b382dd8b67adaed0ad8ff6a626ee32d8056ab5047bf55909fbcb154a4982702741bcf20924651

data/CHANGELOG.md

@@ -4,6 +4,10 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
+## 1.1.0 (2017-02-28)
+
+- [feature] Add end point for fetching individual failures
+
 ## 1.0.0 (2017-02-24)
 
 - [feature] Introduce failures and failure handling in Handler. Add failures to the events API

data/README.md

@@ -141,7 +141,7 @@ The control is based on `payload` and `exception`:
 class MyHandler
   include PhobosDBCheckpoint::Handler
 
-  def retry_consume?(event, event_metadata, exception)
+  def self.retry_consume?(event, event_metadata, exception)
     event_metadata[:retry_count] <= MyApp.config.max_retries
   end
 end
@@ -196,6 +196,32 @@ $ phobos_db_checkpoint init_events_api
    Start the API with: `rackup config.ru`
 ```
 
+The available routes are:
+
+* GET `/ping`
+* GET `/v1/events/:id`
+* GET `/v1/events` This route accepts the following params:
+  * `limit`, default: 20
+  * `offset`, default: 0
+  * `entity_id`
+  * `topic`
+  * `group_id`
+  * `event_type`
+* POST `/v1/events/:id/retry`
+* GET `/v1/failures/:id`
+* GET `/v1/failures` This route accepts the following params:
+  * `limit`, default: 20
+  * `offset`, default: 0
+  * `entity_id`
+  * `topic`
+  * `group_id`
+  * `event_type`
+* POST `/v1/failures/:id/retry`
+
+#### Events endpoint
+
+Sample output for event:
+
 ```sh
 $ curl "http://localhost:9292/v1/events/1"
 # {
@@ -207,22 +233,43 @@ $ curl "http://localhost:9292/v1/events/1"
 #   "event_type": "create",
 #   "event_version": "v1",
 #   "checksum": "188773471ec0f898fd81d272760a027f",
-#   "payload": "{\"a\":\"b\"}"
+#   "payload": {
+#     "a": "b"
+#   }
 # }
 ```
 
-The available routes are:
+#### Failures endpoint
 
-* GET `/ping`
-* GET `/v1/events/:id`
-* GET `/v1/events` This route accepts the following params:
-  * `limit`, default: 20
-  * `offset`, default: 0
-  * `entity_id`
-  * `topic`
-  * `group_id`
-  * `event_type`
-* POST `/v1/events/:id/retry`
+Sample output for failure:
+
+```sh
+$ curl "http://localhost:9292/v1/failures/1"
+# {
+#   "id": 1,
+#   "created_at": "2017-02-28T07:53:21.790Z",
+#   "topic": "test-partitions",
+#   "group_id": "test-checkpoint-1",
+#   "entity_id": "32de6e8e-4317-4ff7-bbce-aa4a6d41294a",
+#   "event_time": "2016-08-10T07:07:58.907Z",
+#   "event_type": "test-event-type",
+#   "event_version": "v1",
+#   "checksum": "12c9e42bca2728fc8193c87979bfe510",
+#   "payload": {
+#     "a": "b"
+#   },
+#   "metadata": {
+#     "c": "d"
+#   },
+#   "error_class": "Faraday::ConnectionFailed",
+#   "error_message": "Failed to open TCP connection to localhost:9200 (Connection refused - connect(2) for \"localhost\" port 9200)",
+#   "error_backtrace": [
+#     "/Users/mathias.klippinge/.rvm/rubies/ruby-2.3.3/lib/ruby/2.3.0/net/http.rb:882:in `rescue in block in connect'",
+#     "/Users/mathias.klippinge/.rvm/rubies/ruby-2.3.3/lib/ruby/2.3.0/net/http.rb:879:in `block in connect'",
+#     "..."
+#   ]
+# }
+```
 
 ### <a name="instrumentation"></a> Instrumentation
 

data/lib/phobos_db_checkpoint/events_api.rb

@@ -18,7 +18,8 @@ module PhobosDBCheckpoint
     error ActiveRecord::RecordNotFound do
       content_type :json
       status 404
-      { error: true, message: 'event not found' }.to_json
+      type = env['sinatra.route'].match(/\/.+\/(.+)\/:/)[1].chop
+      { error: true, message: "#{type} not found" }.to_json
     end
 
     error StandardError do
@@ -99,6 +100,13 @@ module PhobosDBCheckpoint
         .to_json
     end
 
+    get "/#{VERSION}/failures/:id" do
+      content_type :json
+      PhobosDBCheckpoint::Failure
+        .find(params['id'])
+        .to_json
+    end
+
     post "/#{VERSION}/failures/:id/retry" do
       content_type :json
       failure = PhobosDBCheckpoint::Failure.find(params['id'])

data/lib/phobos_db_checkpoint/version.rb

@@ -1,3 +1,3 @@
 module PhobosDBCheckpoint
-  VERSION = '1.0.0'
+  VERSION = '1.1.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: phobos_db_checkpoint
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Túlio Ornelas
@@ -13,7 +13,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-24 00:00:00.000000000 Z
+date: 2017-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler