crystal_sdk 1.0.3 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6ba27b0a6417d08fd9880ceebb13a9c948687a1c
-  data.tar.gz: 319692fbacdf2346768bac7820da9b4f5f4eeb4a
+  metadata.gz: 68c4c5f394f828a302f0f797109388526e207b29
+  data.tar.gz: 4df29ed5014ca2ff51a434d368221c8ad99ca904
 SHA512:
-  metadata.gz: c9e85319e38fcbf762b87eecee617ae03a0adf3bb2a241292e24abc90a98fa052cc759165219a64d641ef78ac1f4a0ecff67acda949c36b0d565cfe8bc487e5f
-  data.tar.gz: b801219d333da34f0bc7425d456d781d027295f8d49ce7e875c902809d888a96eb718d7de0547d491e9af4222201cd03daadd558fba6f84d07b16ccb53c89fba
+  metadata.gz: 4078fdca58cef87cd1ca92d9a6575206d12a6699c33d7126e473fc24d004c0eae1cd576481055b4d73bc8f906c8adb2277f9d0a178618d0befc1416a37047c8b
+  data.tar.gz: dedf3a02fa00ca650aded1cbea28aaf79f0f8d028bc591894b699007809a9df5103c2ec7cfeee838568e86c61c23014f02af93ccf2bd918da0a61fa4188c11b3

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    crystal_sdk (1.0.2)
+    crystal_sdk (1.0.3)
       nestful (~> 1.1)
       recursive-open-struct (~> 1.0)
 

data/README.md

@@ -1,8 +1,29 @@
 # Crystal Ruby SDK
 
+[![CircleCI](https://circleci.com/gh/crystal-project-inc/ruby_sdk.svg?style=shield)](https://circleci.com/gh/crystal-project-inc/ruby_sdk)
+[![Gem Version](https://badge.fury.io/rb/crystal_sdk.svg)](https://badge.fury.io/rb/crystal_sdk)
+
 This gem provides access to Crystal, the world's largest and most accurate personality database!
 
-![Recommendations Demo](docs/recommendations.png)
+![API Summary](docs/api_summary.gif)
+
+## FAQ
+
+#### Want to use our raw API?
+
+Find the docs here:
+https://developers.crystalknows.com
+
+#### Want to learn more about us?
+
+Visit our website: https://www.crystalknows.com
+
+#### Need an Organization Access Token?
+
+Get in touch with us at hello@crystalknows.com
+
+
+# Usage
 
 Here's how to install it:
 ```bash
@@ -16,8 +37,10 @@ Here's how you use it:
 ```ruby
 require 'crystal_sdk'
 
-CrystalSDK.key = "OrgKey"
+# Set your Organization Access Token
+CrystalSDK.key = "OrgToken"
 
+# Fetch the profile
 begin
   profile = CrystalSDK::Profile.search({
     first_name: "Drew",
@@ -32,11 +55,21 @@ begin
   print "Profile found!"
   print "First Name: #{profile.info.first_name}"
   print "Last Name: #{profile.info.last_name}"
-  print "Predicted DISC Type: #{profile.info.disc_type}"
-  print "Prediction Confidence: #{profile.info.confidence}"
-  print "Personality Overview: #{profile.info.overview}"
+  print "Predicted DISC Type: #{profile.info.disc_scores.type}"
+  print "Prediction Confidence: #{profile.info.disc_scores.confidence}"
+  print "DISC Image: #{profile.info.disc_image}"
+
+  print "Personality Overview: #{profile.recommendations.overview}"
+  print "Personality Qualities: #{profile.recommendations.qualities}"
+
+  print "Likely motivations: #{profile.recommendations.motivations}"
+  print "Likely behaviors: #{profile.recommendations.behavior}"
 
-  print "Recommendations: #{profile.recommendations}"
+  print "Tips on emailing: #{profile.recommendations.emailing}"
+  print "Tips on communication: #{profile.recommendations.communication}"
+  print "Tips on building trust: #{profile.recommendations.building_trust}"
+  print "Tips on selling: #{profile.recommendations.selling}"
+  print "Tips on working together: #{profile.recommendations.working_together}"
 
 rescue CrystalSDK::Profile::NotFoundError
   print "No profile was found"
@@ -48,7 +81,7 @@ rescue CrystalSDK::Profile::RateLimitHitError
   print "The organization's API rate limit was hit"
 
 rescue CrystalSDK::Profile::NotAuthedError => e
-  print "Org key was invalid: #{e.token}"
+  print "Org token was invalid: #{e.token}"
 
 rescue StandardError => e
   print "Unexpected error occurred: #{e}"
@@ -60,7 +93,36 @@ end
 
 When requesting large amounts of profiles, or when wanting to have more fine-grained control over performance, we recommend using our asynchronous flow. It allows us to process your requests in parallel and get the information back to you more quickly. There are a couple options for using this capability.
 
-### Option 1: Polling (Small Lists + Realtime Enrichment)
+
+### Option 1: Background Processing (Large Lists + Passive Enrichment)
+
+Sometimes, it isn't important to have the profile information immediately. Especially when dealing with larger jobs or passive data enrichment. In that case, we allow you to save the Request ID and pull information from the request at a later time via this ID.
+
+```ruby
+query = { first_name: "Drew", ... }
+
+# Send the request to Crystal
+profile_request = CrystalSDK::Profile::Request.from_search(query)
+
+# Pull out the Profile Request ID (string)
+profile_request_id = profile_request.id
+
+# Save the Request ID somewhere (DB, Queue, Hard Drive..)
+...
+
+# Later, pull up the Request ID and pull information about it
+saved_req = CrystalSDK::Profile::Request.new(profile_request_id)
+
+if saved_req.did_finish? && saved_req.did_find_profile?
+  profile = CrystalSDK::Profile.from_request(saved_req)
+  ...
+end
+```
+
+We try and store your request for a few days after the request has been started. Your Request ID should work when you try to pull information from it for at least that period of time!
+
+
+### Option 2: Polling (Small Lists + Realtime Enrichment)
 The option we use internally in the SDK, is to poll for request information periodically until a set timeout has been reached:
 
 ```ruby
@@ -69,22 +131,22 @@ PAUSE_IN_SECONDS = 3
 
 # Start the request
 query = { first_name: "Drew", ... }
-request = CrystalSDK::Profile::Request.from_search(query)
+profile_request = CrystalSDK::Profile::Request.from_search(query)
 
 # Poll server until request finishes
 MAX_RETRIES.times do
-  
+
   # If the request hasn't finished, wait and loop again
-  unless request.did_finish?
+  unless profile_request.did_finish?
     sleep(PAUSE_IN_SECONDS)
     next
   end
 
   # Get profile information
-  if request.did_find_profile?
-    profile = Profile.from_request(request)
+  if profile_request.did_find_profile?
+    profile = CrystalSDK::Profile.from_request(profile_request)
   end
-  
+
   break
 end
 
@@ -97,33 +159,6 @@ Polling can be extended to poll for multiple profiles. It gives the efficiency o
 This option is great if you want information as fast as possible while keeping open network connections and code complexity to a minimum. It is especially useful if you are requesting multiple profiles and can process the profiles one at a time, as each individual profile comes in (as opposed to waiting for all of them to come in before processing anything).
 
 
-### Option 2: Background Processing (Large Lists + Passive Enrichment)
-
-Sometimes, it isn't important to have the profile information immediately. Especially when dealing with larger jobs or passive data enrichment. In that case, we allow you to save the Request ID and pull information from the request at a later time via this ID.
-
-```ruby
-
-# Send the request to Crystal
-profile_request = CrystalSDK::Profile::Request.from_search(query)
-
-# Pull out the Profile Request ID (string)
-profile_request_id = profile_request.id
-
-# Save the Request ID somewhere (to a database or background job, for example)
-...
-
-# Later, pull up the Request ID and pull information about it
-backgrounded_request = CrystalSDK::Profile::Request.new(profile_request_id)
-
-if backgrounded_request.did_finish? && backgrounded_request.did_find_profile?
-  profile = backgrounded_request.profile
-  ...
-end
-```
-
-We try and store your request for a few days after the request has been started. Your Request ID should work when you try to pull information from it for at least that period of time!
-
-
 ## Contributing
 
 - Clone the repository:

data/lib/crystal_sdk/profile/request.rb

@@ -13,7 +13,7 @@ module CrystalSDK
       class << self
         def from_search(query)
           begin
-            resp = Api.make_request(:post, 'profile_search/async', params: query)
+            resp = Api.make_request(:post, 'profiles/async', params: query)
           rescue Nestful::ResponseError => e
             check_for_error(e.response)
             raise e
@@ -34,7 +34,7 @@ module CrystalSDK
         return @cached_data if @cached_data
 
         begin
-          resp = Api.make_request(:get, "results/#{@id}")
+          resp = Api.make_request(:get, "profiles/results/#{@id}")
         rescue Nestful::ResponseError => e
           Request.check_for_error(e.response)
           raise e
@@ -66,7 +66,8 @@ module CrystalSDK
         return false unless did_finish? && fetch_status == 'complete'
 
         info = fetch_request_info
-        !info[:data][:info][:error]
+        print info
+        !info[:info][:error]
       rescue Profile::NotFoundError
         false
       end
@@ -75,8 +76,8 @@ module CrystalSDK
         return nil unless did_find_profile?
 
         req_info = fetch_request_info
-        profile_info = RecursiveOpenStruct.new(req_info[:data][:info])
-        recommendations = RecursiveOpenStruct.new(req_info[:data][:recommendations])
+        profile_info = RecursiveOpenStruct.new(req_info[:info])
+        recommendations = RecursiveOpenStruct.new(req_info[:recommendations])
 
         { info: profile_info, recommendations: recommendations }
       end

data/lib/crystal_sdk/version.rb

@@ -1,3 +1,3 @@
 module CrystalSDK
-  VERSION = '1.0.3'.freeze
+  VERSION = '1.1.0'.freeze
 end

data/spec/crystal_sdk/profile/request_spec.rb

@@ -12,7 +12,7 @@ describe CrystalSDK::Profile::Request do
     subject { CrystalSDK::Profile::Request.from_search(query) }
     let(:query) { { first_name: 'Test', last_name: 'Test' } }
     let(:request_type) { :post }
-    let(:endpoint) { 'profile_search/async' }
+    let(:endpoint) { 'profiles/async' }
 
     context 'CrystalSDK::Api raises exception' do
       it 'should not suppress it' do
@@ -59,7 +59,7 @@ describe CrystalSDK::Profile::Request do
   describe '#fetch_request_info' do
     subject { CrystalSDK::Profile::Request.new('my_id').fetch_request_info() }
     let(:request_type) { :get }
-    let(:endpoint) { 'results/my_id' }
+    let(:endpoint) { 'profiles/results/my_id' }
 
     context 'CrystalSDK::Api raises exception' do
       it 'should not suppress it' do
@@ -247,7 +247,7 @@ describe CrystalSDK::Profile::Request do
         context '#fetch_request_info error is not nil' do
           before(:each) do
             allow(request).to receive(:fetch_request_info).and_return({
-              data: { info: { error: 'error' } }
+              info: { error: 'error' }
             })
           end
 
@@ -257,7 +257,7 @@ describe CrystalSDK::Profile::Request do
         context '#fetch_request_info error is nil' do
           before(:each) do
             allow(request).to receive(:fetch_request_info).and_return({
-              data: { info: { error: nil } }
+              info: { error: nil }
             })
           end
 
@@ -283,19 +283,17 @@ describe CrystalSDK::Profile::Request do
       before(:each) do
         allow(request).to receive(:did_find_profile?).and_return(true)
         allow(request).to receive(:fetch_request_info).and_return({
-          data: {
             info: {
-              some_info: 'some_info',
-              deep_info: {
-                info: 'deep_info'
-              }
-            },
-
-            recommendations: {
-              some_recs: 'some_recs',
-              deep_recs: {
-                recs: 'deep_recs'
-              }
+            some_info: 'some_info',
+            deep_info: {
+              info: 'deep_info'
+            }
+          },
+
+          recommendations: {
+            some_recs: 'some_recs',
+            deep_recs: {
+              recs: 'deep_recs'
             }
           }
         })

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: crystal_sdk
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.1.0
 platform: ruby
 authors:
 - Cory Finger
@@ -82,7 +82,7 @@ files:
 - README.md
 - Rakefile
 - crystal_sdk.gemspec
-- docs/recommendations.png
+- docs/api_summary.gif
 - lib/crystal_sdk.rb
 - lib/crystal_sdk/api.rb
 - lib/crystal_sdk/base.rb