refocus 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8c9a284d38f4ea7b2511f08c99a9cbf3b523bd35
-  data.tar.gz: fafad4af4d8745213791e7106105148cd150e9a0
+  metadata.gz: c1f24dd0ab5dc2ecd74d97898186fe82e8707ed9
+  data.tar.gz: 1dd166204586a4c8a68128a63416bf103c340a15
 SHA512:
-  metadata.gz: 64a82a247bcdb07a279a0c22b176f4a7fcb069142309e215e60b9be36d22dbaa42da16788c8fa8e6612af2b40a249c9ce94aba2f0a5c32f5c103bf875985c77a
-  data.tar.gz: 9fcd0ada00e4ddae41be0d74b89ec3960b57f56cb3d7ca42fe48b2217fa0a0580dcaafbac085aa360b7592fd4757c10b0c1845087234540b247b33fdbd1e6a0c
+  metadata.gz: f0a90d7e8409ba274a6565640474560559c2dad1a3e3546b5faf7a8c87d81d13911873786b76203f1f0cbf386c456c9c9fc6fc3e961b1ac0d10e6d7cb7f7375f
+  data.tar.gz: 5e27257666076c2490379ca0ee1377413f90774ac96af4bab5bf9327122482600a2ed56fb319884eddb706fbd0e63dcda1c178fb924681e17a49bcfda8781632

data/.gitignore

@@ -6,6 +6,7 @@
 /pkg/
 /spec/reports/
 /tmp/
+/.idea/
 
 # rspec failure tracking
 .rspec_status

data/Gemfile.lock

@@ -1,14 +1,14 @@
 PATH
   remote: .
   specs:
-    refocus (0.1.5)
+    refocus (0.1.6)
       clamp (~> 1.1)
       excon (~> 0.60)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    clamp (1.1.2)
+    clamp (1.2.1)
     coderay (1.1.2)
     diff-lcs (1.3)
     excon (0.60.0)

data/README.md

@@ -2,9 +2,6 @@
 
 A ruby client library and CLI for [Refocus](https://github.com/salesforce/refocus).
 
-This client is not complete. If you notice any missing functionality, please feel free to submit a pull request!
-
-
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -86,6 +83,34 @@ refocus.aspects.get(name: "my-aspect")
 refocus.aspects.delete(name: "my-aspect")
 ```
 
+#### Samples
+
+You can manage samples like this:
+
+```ruby
+# Instantiate the samples client
+samples_client = refocus.samples   
+
+# Create or update a sample:
+samples_client.upsert(name: "my-subject.child-subject", aspect: "my-aspect", value: '100')
+
+# Create or update a sample with a custom request body
+request_body =  {name: "my-subject.child-subject|my-aspect", value: '100', messageCode: '100%', messageBody: "Great Results!", relatedLinks: [{name:'example_1', url:'https://www.example_1.com'}]}
+samples_client.upsert_custom_body(request_body)
+
+# Describe a sample:
+samples_client.get(subject: "my-subject", aspect: "my-aspect")
+
+# List samples:
+samples_client.list(limit: 50)
+
+# Create or update samples in bulk:
+samples_collector = samples_client.collector
+samples_collector.add(name: "my-subject.child-subject", aspect: "my-aspect-1", value: '100')
+samples_collector.add(name: "my-subject.child-subject", aspect: "my-aspect-2", messageCode: '100%')
+samples_collector.upsert_bulk
+```
+
 #### Lenses
 
 Lenses are not supported at this time.

data/lib/refocus/samples.rb

@@ -1,5 +1,6 @@
 require "refocus/http"
 require "refocus/json_helper"
+require "refocus/samples/collector"
 
 module Refocus
   class Samples
@@ -15,10 +16,15 @@ module Refocus
       Collector.new(http: http)
     end
 
-    def submit(name:, aspect:, value:)
-      c = collector
-      c.add(name: name, aspect: aspect, value: value)
-      c.submit
+    def upsert(name:, aspect:, value:"", messageBody:"", messageCode:"", relatedLinks:[])
+      sample = format_sample(name:name, aspect: aspect, value: value, messageBody: messageBody, messageCode: messageCode, relatedLinks: relatedLinks)
+      json(http.post("upsert", body: sample, expects: 200))
+    end
+    alias_method :submit, :upsert
+
+    def upsert_custom_body(custom_body)
+      endpoint = (custom_body.is_a? Array) ? "upsert/bulk" : "upsert"
+      json(http.post(endpoint, body: custom_body, expects: 200))
     end
 
     def list(limit: nil)
@@ -30,8 +36,11 @@ module Refocus
     def get(subject:, aspect:)
       json(http.get(URI.escape("#{subject}\|#{aspect}")))
     end
-  end
-end
 
-require "refocus/samples/collector"
+    private
+    def format_sample(name:, aspect:, value:"", messageBody:"", messageCode:"", relatedLinks:[])
+      {name: "#{name}|#{aspect}", value: value.to_s, messageBody: messageBody, messageCode: messageCode, relatedLinks: relatedLinks}
+    end
 
+  end
+end

data/lib/refocus/samples/collector.rb

@@ -1,6 +1,9 @@
+require "refocus/json_helper"
+
 module Refocus
   class Samples
     class Collector
+      include JsonHelper
 
       attr_reader :http, :samples
 
@@ -9,19 +12,17 @@ module Refocus
         @samples = []
       end
 
-      def add(name:, aspect:, value:)
-        samples << {name: "#{name}|#{aspect}", value: value.to_s}
+      def add(name:, aspect:, value:"", messageBody:"", messageCode:"", relatedLinks:[])
+        samples << {name: "#{name}|#{aspect}", value: value.to_s, messageBody: messageBody, messageCode: messageCode, relatedLinks: relatedLinks}
       end
 
-      def submit
+      def upsert_bulk
         result = json(http.post("upsert/bulk", body: samples, expects: 200))
         samples.clear
-        true
+        result
       end
+      alias_method :submit, :upsert_bulk
 
-      def json(response)
-        JSON.parse(response.body)
-      end
     end
   end
-end
+end

data/lib/refocus/version.rb

@@ -1,3 +1,3 @@
 module Refocus
-  VERSION = "0.1.5"
+  VERSION = "0.1.6"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: refocus
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - Michael Shea
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-22 00:00:00.000000000 Z
+date: 2018-05-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -151,7 +151,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2.1
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Refocus ruby client