crystal_sdk 0.0.4 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5bacb9a91dadcdcc60eb24dd15eedcd61d25c5f3
-  data.tar.gz: 33b610a788337ff076b128d651bf1a7150c8c2ef
+  metadata.gz: ed49b547a11579d80d9aa3c96dab61019d0dd47b
+  data.tar.gz: 49afdf1d21487a6d4def81f564feb3eec54dfc54
 SHA512:
-  metadata.gz: 966cc07acc85cfd463c7f33b021294519c4d92f0d6cebe7bc1db209c036c1091c53b74cce502405c8e862295fe0db41385f822d7d1475373317227171f5d77e2
-  data.tar.gz: c75662264040de042eca6e8034e054eb2da837c5be5f948aa4c4727e59be4551a206b5c65240d7f2d3b2f49eb415fd9802c78ea62f29595c35239f461109c704
+  metadata.gz: 55a5a0ca2e44a4df1cf4b3455703da564ffc32a39fd22e2d020c5c2a05ab9ef8b7f89e0f0559c371e64ae84bb2b5f5270ac5043efed0ea92ec7a05703519e68d
+  data.tar.gz: 13a84fc643b862bde2f5f3a7f7cf8cd3cf292379233d23e13324ba1a05c76ec00f919fe0b4d01a94e57bd4d8914abf1ce745b226de9d5652be19bcc5c4e2a8e7

data/Gemfile.lock

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

data/lib/crystal_sdk/api.rb

@@ -0,0 +1,19 @@
+module CrystalSDK
+  class Api
+    def self.make_request(type, endpoint, params: {}, headers: {})
+      headers = headers.merge(
+        'X-Org-Token' => Base.key!,
+        'X-Sdk-Version' => VERSION
+      )
+
+      opts = {
+        method: type,
+        headers: headers,
+        params: params,
+        format: :json
+      }
+
+      Nestful::Request.new("#{Base::API_URL}/#{endpoint}", opts).execute
+    end
+  end
+end

data/lib/crystal_sdk/base.rb

@@ -1,7 +1,7 @@
 module CrystalSDK
   class Base
     class ApiKeyNotSet < StandardError; end
-    API_URL = 'http://enterprise-api.crystalknows.com/v1'.freeze
+    API_URL = 'https://connect.crystalknows.com/v1'.freeze
 
     class << self
       attr_accessor :key

data/lib/crystal_sdk/profile/request.rb

@@ -0,0 +1,60 @@
+require 'recursive-open-struct'
+require 'crystal_sdk/api'
+
+module CrystalSDK
+  class Profile
+    class Request
+      attr_reader :id
+
+      def initialize(id)
+        @id = id
+      end
+
+      def self.from_search(query)
+        resp = Api.make_request(:post, 'profile_search/async', params: query)
+        body = JSON.parse(resp.body || '{}', symbolize_names: true)
+
+        Profile::Request.new(body[:request_id])
+      end
+
+      def fetch_request_info
+        return @cached_data if @cached_data
+
+        resp = Api.make_request(:get, "results/#{@id}")
+        body = resp.body ? JSON.parse(resp.body, symbolize_names: true) : nil
+
+        if body[:status] == 'complete' || body[:status] == 'error'
+          @cached_data = body
+        end
+
+        body
+      end
+
+      def fetch_status
+        fetch_request_info[:status]
+      end
+
+      def did_finish?
+        status = fetch_status
+        status == 'complete' || status == 'error'
+      end
+
+      def did_find_profile?
+        return false unless did_finish? && fetch_status == 'complete'
+
+        info = fetch_request_info
+        !info[:data][:info][:error]
+      end
+
+      def profile_info
+        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])
+
+        { info: profile_info, recommendations: recommendations }
+      end
+    end
+  end
+end

data/lib/crystal_sdk/version.rb

@@ -1,3 +1,3 @@
 module CrystalSDK
-  VERSION = '0.0.4'.freeze
+  VERSION = '1.0.0'.freeze
 end

data/spec/crystal_sdk/api_spec.rb

@@ -0,0 +1,95 @@
+require 'spec_helper'
+
+describe CrystalSDK::Api do
+  subject { CrystalSDK::Api }
+
+  describe '.make_request' do
+    context 'without api key' do
+      it 'should raise an error' do
+        expect { subject.make_request(:post, 'test') }
+          .to raise_error(CrystalSDK::Base::ApiKeyNotSet)
+      end
+    end
+
+    context 'with api key' do
+      subject { CrystalSDK::Api.make_request(:post, 'test_endpoint') }
+
+      let(:headers) do
+        {
+          'X-Org-Token' => 'SomeToken',
+          'X-Sdk-Version' => CrystalSDK::VERSION
+        }
+      end
+
+      let(:stubbed_req) do
+        stub_request(:post, "#{CrystalSDK::Base::API_URL}/test_endpoint")
+          .with(headers: headers)
+      end
+
+      before(:each) do
+        allow(CrystalSDK::Base).to receive(:key).and_return('SomeToken')
+      end
+
+      context 'got 4xx response code' do
+        it 'should raise an error' do
+          stubbed_req
+            .to_return(status: 404, body: '{}', headers: {})
+
+          expect { subject }.to raise_error
+        end
+      end
+
+      context 'got 5xx response code' do
+        it 'should raise error on 5xx responses' do
+          stubbed_req
+            .to_return(status: 500, body: '{}', headers: {})
+
+          expect { subject }.to raise_error
+        end
+      end
+
+      context 'got 2xx response code' do
+        it 'should return correct response' do
+          stubbed_req
+            .to_return(status: 200, body: 'stubbed', headers: {})
+
+          expect(subject.code).to eql(200)
+          expect(subject.body).to eql('stubbed')
+        end
+      end
+
+      context 'given params' do
+        subject do
+          CrystalSDK::Api
+            .make_request(:post, 'test_endpoint', params: params)
+        end
+        let(:params) { { some_param: '123'} }
+
+        it 'should turn params into json body' do
+          stubbed_req
+            .with(body: params.to_json)
+            .to_return(status: 200, body: 'stubbed', headers: {})
+
+          expect { subject }.to_not raise_error
+        end
+      end
+
+
+      context 'given headers' do
+        subject do
+          CrystalSDK::Api
+            .make_request(:post, 'test_endpoint', headers: headers)
+        end
+        let(:headers) { { 'X-Some-Header' => '123' } }
+
+        it 'should turn params into json body' do
+          stubbed_req
+            .with(headers: headers)
+            .to_return(status: 200, body: 'stubbed', headers: {})
+
+          expect { subject }.to_not raise_error
+        end
+      end
+    end
+  end
+end

data/spec/crystal_sdk/base_spec.rb

@@ -11,7 +11,7 @@ describe CrystalSDK::Base do
     subject { CrystalSDK::Base::API_URL }
 
     it { is_expected.to include '.crystalknows.com' }
-    # it { is_expected.to start_with 'https://' }
+    it { is_expected.to start_with 'https://' }
     it { is_expected.to_not end_with '/' }
   end
 

data/spec/crystal_sdk/profile/request_spec.rb

@@ -0,0 +1,252 @@
+require 'spec_helper'
+
+describe CrystalSDK::Profile::Request do
+  subject { CrystalSDK::Profile::Request }
+
+  it 'should initialize properly' do
+    req = subject.new("an_id")
+    expect(req.id).to eql("an_id")
+  end
+
+  describe '.from_search' 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' }
+
+    context 'CrystalSDK::Api raises exception' do
+      it 'should not suppress it' do
+        allow(CrystalSDK::Api).to receive(:make_request)
+          .with(request_type, endpoint, params: query)
+          .and_raise('SomeRandomError')
+
+        expect { subject }.to raise_error('SomeRandomError')
+      end
+    end
+
+    context 'CrystalSDK::Api returns invalid json body' do
+      it 'should raise error' do
+        allow(CrystalSDK::Api).to receive(:make_request)
+          .with(request_type, endpoint, params: query)
+          .and_return(double(body: 'pie'))
+
+        expect { subject }.to raise_error
+      end
+    end
+
+    context 'CrystalSDK::Api returns valid json body' do
+      it 'should return request object' do
+        allow(CrystalSDK::Api).to receive(:make_request)
+          .with(request_type, endpoint, params: query)
+          .and_return(double(body: '{}'))
+
+        expect(subject).to be_kind_of(CrystalSDK::Profile::Request)
+      end
+    end
+  end
+
+  describe '#fetch_request_info' do
+    subject { CrystalSDK::Profile::Request.new('my_id').fetch_request_info() }
+    let(:request_type) { :get }
+    let(:endpoint) { 'results/my_id' }
+
+    context 'CrystalSDK::Api raises exception' do
+      it 'should not suppress it' do
+        allow(CrystalSDK::Api).to receive(:make_request)
+          .with(request_type, endpoint)
+          .and_raise('SomeRandomError')
+
+        expect { subject }.to raise_error('SomeRandomError')
+      end
+    end
+
+    context 'CrystalSDK::Api returns invalid json body' do
+      it 'should raise error' do
+        allow(CrystalSDK::Api).to receive(:make_request)
+          .with(request_type, endpoint)
+          .and_return(double(body: 'pie'))
+
+        expect { subject }.to raise_error
+      end
+    end
+
+    context 'CrystalSDK::Api returns valid json body' do
+      it 'should return request object' do
+        allow(CrystalSDK::Api).to receive(:make_request)
+          .with(request_type, endpoint)
+          .and_return(double(body: '{"something": true}'))
+
+        expect(subject).to eql({ something: true })
+      end
+
+      context 'status is "complete"' do
+        it 'should cache' do
+          allow(CrystalSDK::Api).to receive(:make_request)
+            .with(request_type, endpoint)
+            .and_return(double(body: '{"status": "complete"}'))
+
+          expect(subject).to eql({ status: 'complete' })
+
+          allow(CrystalSDK::Api).to receive(:make_request)
+            .with(request_type, endpoint)
+            .and_return(double(body: '{"status": "failure"}'))
+
+          expect(subject).to eql({ status: 'complete' })
+        end
+      end
+
+      context 'status is "error"' do
+        it 'should cache' do
+          allow(CrystalSDK::Api).to receive(:make_request)
+            .with(request_type, endpoint)
+            .and_return(double(body: '{"status": "error"}'))
+
+          expect(subject).to eql({ status: 'error' })
+
+          allow(CrystalSDK::Api).to receive(:make_request)
+            .with(request_type, endpoint)
+            .and_return(double(body: '{"status": "failure"}'))
+
+          expect(subject).to eql({ status: 'error' })
+        end
+      end
+    end
+  end
+
+  describe '#fetch_status' do
+    let(:request) { CrystalSDK::Profile::Request.new('my_id') }
+    subject { request.fetch_status }
+
+    it 'should pull :status from #fetch_request_info' do
+      allow(request).to receive(:fetch_request_info)
+        .and_return({status: 'testing'})
+
+      expect(subject).to eql('testing')
+    end
+  end
+
+  describe '#did_finish?' do
+    let(:request) { CrystalSDK::Profile::Request.new('my_id') }
+    subject { request.did_finish? }
+
+    context '#fetch_status returns "complete"' do
+      before(:each) do
+        allow(request).to receive(:fetch_status).and_return('complete')
+      end
+
+      it { is_expected.to eql(true) }
+    end
+
+    context '#fetch_status returns "error"' do
+      before(:each) do
+        allow(request).to receive(:fetch_status).and_return('error')
+      end
+
+      it { is_expected.to eql(true) }
+    end
+
+    context '#fetch_status returns something else' do
+      before(:each) do
+        allow(request).to receive(:fetch_status).and_return('something')
+      end
+
+      it { is_expected.to eql(false) }
+    end
+  end
+
+  describe '#did_find_profile?' do
+    let(:request) { CrystalSDK::Profile::Request.new('my_id') }
+    subject { request.did_find_profile? }
+
+    context '#did_finish? is false' do
+      it 'should return false' do
+        allow(request).to receive(:did_finish?).and_return(false)
+
+        expect(subject).to eql(false)
+      end
+    end
+
+    context '#did_finish? is true' do
+      before(:each) do
+        allow(request).to receive(:did_finish?).and_return(true)
+      end
+
+      context '#fetch_status is not "complete"' do
+        before(:each) do
+          allow(request).to receive(:fetch_status).and_return('something')
+        end
+
+        it { is_expected.to eql(false) }
+      end
+
+      context '#fetch_status is "complete"' do
+        before(:each) do
+          allow(request).to receive(:fetch_status).and_return('complete')
+        end
+
+        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' } }
+            })
+          end
+
+          it { is_expected.to eql(false) }
+        end
+
+        context '#fetch_request_info error is nil' do
+          before(:each) do
+            allow(request).to receive(:fetch_request_info).and_return({
+              data: { info: { error: nil } }
+            })
+          end
+
+          it { is_expected.to eql(true) }
+        end
+      end
+    end
+  end
+
+  describe '#profile_info' do
+    let(:request) { CrystalSDK::Profile::Request.new('my_id') }
+    subject { request.profile_info }
+
+    context '#did_find_profile? is false' do
+      before(:each) do
+        allow(request).to receive(:did_find_profile?).and_return(false)
+      end
+
+      it { is_expected.to eql(nil) }
+    end
+
+    context '#did_find_profile? is true' 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'
+              }
+            }
+          }
+        })
+      end
+
+      it 'should return hash with deep openstruct values' do
+        expect(subject[:info].some_info).to eql('some_info')
+        expect(subject[:info].deep_info.info).to eql('deep_info')
+        expect(subject[:recommendations].some_recs).to eql('some_recs')
+        expect(subject[:recommendations].deep_recs.recs).to eql('deep_recs')
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: crystal_sdk
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 1.0.0
 platform: ruby
 authors:
 - Cory Finger
@@ -83,10 +83,14 @@ files:
 - Rakefile
 - crystal_sdk.gemspec
 - lib/crystal_sdk.rb
+- lib/crystal_sdk/api.rb
 - lib/crystal_sdk/base.rb
 - lib/crystal_sdk/profile.rb
+- lib/crystal_sdk/profile/request.rb
 - lib/crystal_sdk/version.rb
+- spec/crystal_sdk/api_spec.rb
 - spec/crystal_sdk/base_spec.rb
+- spec/crystal_sdk/profile/request_spec.rb
 - spec/crystal_sdk/profile_spec.rb
 - spec/crystal_sdk/version_spec.rb
 - spec/crystal_sdk_spec.rb
@@ -116,7 +120,9 @@ signing_key:
 specification_version: 4
 summary: Access the largest and most accurate personality database!
 test_files:
+- spec/crystal_sdk/api_spec.rb
 - spec/crystal_sdk/base_spec.rb
+- spec/crystal_sdk/profile/request_spec.rb
 - spec/crystal_sdk/profile_spec.rb
 - spec/crystal_sdk/version_spec.rb
 - spec/crystal_sdk_spec.rb