koko-ai-ruby 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bbab8eb849d6a88baf77197a3626975c3376238d
-  data.tar.gz: 87c099458959d5efe6f655b7a1cd622ca2d6fbc2
+  metadata.gz: c6c9f7847f52c86060024c1a7bec1db9f8b39a49
+  data.tar.gz: fad4787b80d50b0f36732fd71a71b4f7d4cc2f7c
 SHA512:
-  metadata.gz: fb14079af0a2669d54eab7e731b0f52ed664f37f02dfde0e440d4fc9599126eddc13c487a3eb419fa7717d1447af93539b2e30c3b6c000d22de730982f4ede4d
-  data.tar.gz: 3d9196f33b107d62d89e4806be3da1ea70fc08902483d2020cbc9098d33cd8202bbdc9797579fc4a9c2b463cb31e3ab7a60899efd0623c503b9a5f2102bc6b73
+  metadata.gz: 56e286ac11ca9a577d53ad7db99993449208e49e3a6829b6a80f8f8a899fc71e5fb2e70e8f33795e0123c563d47d7a923e412be6f8e886e75842afad5a8be089
+  data.tar.gz: 6ec716712c6c44c5699fe89b867529d909bfb9a320ddf9ee766c5200c54b45e03b2d958416a24ca2498cf5d02b2847ab39a89b5c0c2493c12518f8497b7d1877

data/History.md

@@ -14,7 +14,12 @@
 
   * Remove unnecessary dependency
 
-0.0.4 / 2017-06-28
+0.0.4 / 2017-07-10
 ==================
 
   * Use Json default serialization for created_at time
+
+0.0.5 / 2017-07-10
+==================
+
+  * Return body directly instead of using block

data/README.md

@@ -22,7 +22,7 @@ Create an instance of the client:
 koko = Koko::Tracker.new(auth: 'YOUR_AUTH_KEY')
 ```
 
-Track content, see more [here](https://docs.koko.ai/#track-endpoints).
+Track content, flags and moderations, see more [here](https://docs.koko.ai/#track-endpoints).
 ```ruby
 koko.track_content(id: "123",
                    created_at: Time.now,
@@ -36,28 +36,27 @@ koko.track_flag(id: "123",
                 flagger_id: "123",
                 type: "spam",
                 created_at: Time.now,
-                content: {"id":"123"})
+                targets: [{content_id: "123"}])
 
 koko.track_moderation(id: "123",
                       type: "user_warned",
                       created_at: Time.now,
-                      content: { id:"123" })
+                      targets: [{content_id: "123" }])
 
 ```
 
-To get behavorial classifications when tracking content, pass a block with a
-single parameter which will be populated with the results. This block will be
-called synchronously.
+To get behavorial classifications when tracking content, pass the classifiers
+you want run as an options param
 ```ruby
-koko.track_content(id: "123",
-                   created_at: "2016-08-29T09:12:33.001Z",
-                   user_id: "123",
-                   type: "post",
-                   context_id: "123",
-                   content_type: "text",
-                   content: { text: "Some content" }) do |classification|
-  crisis_confidence = classification.find { |c| c['label'] == 'crisis' }['confidence']
-end
+classifications = koko.track_content(id: "123",
+                                     created_at: Time.now,
+                                     user_id: "123",
+                                     type: "post",
+                                     context_id: "123",
+                                     content_type: "text",
+                                     content: { text: "Some content" },
+                                     options: { classifiers: ['crisis'] })
+
 ```
 
 ## Testing

data/lib/koko/tracker/client.rb

@@ -25,20 +25,14 @@ module Koko
       # public: Track content
       #
       # attrs - Hash (see https://docs.koko.ai/#track-endpoints)
-      def track_content attrs, &block
+      def track_content attrs
         symbolize_keys! attrs
 
         timestamp = attrs[:created_at] || Time.now
         check_timestamp! timestamp
         attrs[:created_at] = timestamp
 
-        response = handle_response(Request.new(path: '/track/content').post(@auth, attrs))
-
-        if block
-          block.call(response.body)
-        end
-
-        true
+        handle_response(Request.new(path: '/track/content').post(@auth, attrs)).body
       end
 
       # public: Track flag
@@ -51,9 +45,7 @@ module Koko
         check_timestamp! timestamp
         attrs[:created_at] = timestamp
 
-        handle_response(Request.new(path: '/track/flag').post(@auth, attrs))
-
-        true
+        handle_response(Request.new(path: '/track/flag').post(@auth, attrs)).body
       end
 
       # public: Track moderation
@@ -66,9 +58,7 @@ module Koko
         check_timestamp! timestamp
         attrs[:created_at] = timestamp
 
-        handle_response(Request.new(path: '/track/moderation').post(@auth, attrs))
-
-        true
+        handle_response(Request.new(path: '/track/moderation').post(@auth, attrs)).body
       end
 
       private

data/lib/koko/tracker/version.rb

@@ -1,5 +1,5 @@
 module Koko
   class Tracker
-    VERSION = '0.0.4'
+    VERSION = '0.0.5'
   end
 end

data/spec/koko/tracking/client_spec.rb

@@ -63,11 +63,9 @@ module Koko
           expect(WebMock).to have_requested(:post, "https://#{Defaults::Request.host}/track/content").with(body: expected_body)
         end
 
-        it 'returns the parsed body if a block is passed' do
-          response_body = nil
-          client.track_content(Factory.content) do |response|
-            response_body = response
-          end
+        it 'returns the parsed body' do
+          response_body = client.track_content(Factory.content)
+
           expect(response_body).to eq(JSON.load(body))
         end
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: koko-ai-ruby
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Koko