crystal_sdk 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fd4e7ecf961055dfbc0bf3b455c2783b86a2eb67
-  data.tar.gz: e86384b92510c84344039a3e3c25d3eb21d55b2d
+  metadata.gz: 5bacb9a91dadcdcc60eb24dd15eedcd61d25c5f3
+  data.tar.gz: 33b610a788337ff076b128d651bf1a7150c8c2ef
 SHA512:
-  metadata.gz: c47c7d9b915132174469e933a0ff2a0cdff481293aa26a7845fc589bedaa9f79a10d9d2345fa2fb6c8d96fc87ae19bff5ddc02af06e77485408832e7172b1520
-  data.tar.gz: 737e642ecf5b811cde11a799af584c587bfd9af5fe515fcb89c05a1eadb23914393a09421720a6a10b834cfdf8e1dfa3347ea105753694fb42f1ac3684c19470
+  metadata.gz: 966cc07acc85cfd463c7f33b021294519c4d92f0d6cebe7bc1db209c036c1091c53b74cce502405c8e862295fe0db41385f822d7d1475373317227171f5d77e2
+  data.tar.gz: c75662264040de042eca6e8034e054eb2da837c5be5f948aa4c4727e59be4551a206b5c65240d7f2d3b2f49eb415fd9802c78ea62f29595c35239f461109c704

data/Gemfile.lock

@@ -1,8 +1,9 @@
 PATH
   remote: .
   specs:
-    crystal_sdk (0.0.2)
+    crystal_sdk (0.0.3)
       nestful (~> 1.1)
+      recursive-open-struct (~> 1.0)
 
 GEM
   remote: https://rubygems.org/
@@ -15,6 +16,7 @@ GEM
     hashdiff (0.3.2)
     nestful (1.1.1)
     public_suffix (2.0.5)
+    recursive-open-struct (1.0.2)
     rspec (3.5.0)
       rspec-core (~> 3.5.0)
       rspec-expectations (~> 3.5.0)

data/crystal_sdk.gemspec

@@ -19,6 +19,7 @@ Gem::Specification.new do |s|
   s.require_paths = ['lib']
 
   s.add_dependency 'nestful', '~> 1.1'
+  s.add_dependency 'recursive-open-struct', '~> 1.0'
   s.add_development_dependency 'rspec'
   s.add_development_dependency 'webmock'
 end

data/lib/crystal_sdk.rb

@@ -3,6 +3,7 @@ require 'crystal_sdk/version'
 
 module CrystalSDK
   autoload :Base, 'crystal_sdk/base'
+  autoload :Api, 'crystal_sdk/api'
   autoload :Profile, 'crystal_sdk/profile'
 
   crystal_env_key = ENV['CRYSTAL_KEY']

data/lib/crystal_sdk/profile.rb

@@ -1,11 +1,22 @@
+require 'timeout'
+require_relative 'profile/request'
+
 module CrystalSDK
   class Profile
     class NotFoundError < StandardError; end
-    class NotFoundYetError < StandardError; end
     class NotAuthedError < StandardError; end
     class RateLimitHitError < StandardError; end
     class UnexpectedError < StandardError; end
 
+    class NotFoundYetError < StandardError
+      attr_reader :request
+
+      def initialize(request, msg = 'Profile not found in time')
+        @request = request
+        super(msg)
+      end
+    end
+
     attr_reader :info, :recommendations
 
     def initialize(info, recommendations)
@@ -14,46 +25,40 @@ module CrystalSDK
     end
 
     class << self
-      def search(query)
+      def from_request(req)
+        return nil unless req.did_find_profile?
+
+        profile_info = req.profile_info
+        Profile.new(profile_info[:info], profile_info[:recommendations])
+      end
+
+      def search(query, timeout: 30)
+        request = nil
+
         begin
-          resp = make_request(:post, 'person_search', params: query)
-          body = resp.body ? JSON.parse(resp.body, symbolize_names: true) : nil
+          Timeout.timeout(timeout) do
+            request = Profile::Request.from_search(query)
+
+            loop do
+              sleep(2) && next unless request.did_finish?
+
+              raise NotFoundError unless request.did_find_profile?
+              return Profile.from_request(request)
+            end
+          end
+        rescue Timeout::Error
+          raise NotFoundYetError.new(request)
 
         rescue Nestful::ResponseError => e
           check_for_error(e.response)
           raise e
         end
-
-        check_for_error(resp)
-        new(body[:info], body[:recommendations])
       end
 
       def check_for_error(resp)
-        body = resp.body ? JSON.parse(resp.body, symbolize_names: true) : nil
-        not_found = body && body[:status] == 'profile_not_found'
-        not_found_yet = body && body[:status] == 'profile_not_found_yet'
-
         raise RateLimitHitError if resp.code == '429'
         raise NotAuthedError if resp.code == '401'
-        raise NotFoundError if resp.code == '404' || not_found
-        raise NotFoundYetError if resp.code == '202' || not_found_yet
-        raise UnexpectedError unless resp.code == '200'
-      end
-
-      def 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
+        raise NotFoundError if resp.code == '404'
       end
     end
   end

data/lib/crystal_sdk/version.rb

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

data/spec/crystal_sdk/profile_spec.rb

@@ -6,26 +6,27 @@ describe CrystalSDK::Profile do
   describe '.search' do
     subject { CrystalSDK::Profile.search(query) }
     let(:query) { { some_param: 'a_param' } }
-    let(:endpoint) { 'person_search' }
-    let(:request_type) { :post }
 
     it 'should use the correct request' do
-      expect(CrystalSDK::Profile).to receive(:make_request)
-        .with(request_type, endpoint, params: query)
-        .and_return(double(code: '200', body: {
-          info: 'info',
-          recommendations: 'recs'
-        }.to_json))
+      resp = double(
+        did_finish?: true,
+        did_find_profile?: true,
+        profile_info: { info: 'info', recommendations: 'recs' }
+      )
+
+      expect(CrystalSDK::Profile::Request).to receive(:from_search)
+        .with(query)
+        .and_return(resp)
 
       expect(subject.info).to eql('info')
       expect(subject.recommendations).to eql('recs')
     end
 
-    context 'make_request raised unexpected error' do
+    context 'request creation raised unexpected error' do
       before(:each) do
-        allow(CrystalSDK::Profile).to receive(:make_request)
-          .with(request_type, endpoint, params: query)
-          .and_raise("SomeRandomError")
+        expect(CrystalSDK::Profile::Request).to receive(:from_search)
+          .with(query)
+          .and_raise('SomeRandomError')
       end
 
       it 'should not suppress the error' do
@@ -33,10 +34,15 @@ describe CrystalSDK::Profile do
       end
     end
 
-    context 'make_request raised expected error' do
+    context 'request info raised expected error' do
+      let(:req) { double() }
+
       before(:each) do
-        allow(CrystalSDK::Profile).to receive(:make_request)
-          .with(request_type, endpoint, params: query)
+        allow(CrystalSDK::Profile::Request).to receive(:from_search)
+          .with(query)
+          .and_return(req)
+
+        allow(req).to receive(:did_finish?)
           .and_raise(Nestful::ResponseError.new(nil, double()))
       end
 
@@ -55,23 +61,37 @@ describe CrystalSDK::Profile do
       end
     end
 
-    context 'make_request raised no error' do
+    context 'request did not find profile' do
       before(:each) do
-        allow(CrystalSDK::Profile).to receive(:make_request)
-          .with(request_type, endpoint, params: query)
+        allow(CrystalSDK::Profile::Request).to receive(:from_search)
+          .with(query)
           .and_return(response)
       end
 
       let(:response) do
-        double(code: '200', body: { resp: 'some_resp' }.to_json)
+        double(did_finish?: true, did_find_profile?: false)
       end
 
-      it 'should still pass through check_for_error' do
-        expect(CrystalSDK::Profile).to receive(:check_for_error)
-          .with(response)
-          .and_raise('CheckForErrorCalled')
+      it 'should raise NotFoundError' do
+        expect { subject }.to raise_error(CrystalSDK::Profile::NotFoundError)
+      end
+    end
 
-        expect { subject }.to raise_error('CheckForErrorCalled')
+    context 'request did not finish before timeout expired' do
+      subject { CrystalSDK::Profile.search(query, timeout: 1) }
+
+      before(:each) do
+        allow(CrystalSDK::Profile::Request).to receive(:from_search)
+          .with(query)
+          .and_return(response)
+      end
+
+      let(:response) do
+        double(did_finish?: false)
+      end
+
+      it 'should raise NotFoundYetError' do
+        expect { subject }.to raise_error(CrystalSDK::Profile::NotFoundYetError)
       end
     end
   end
@@ -81,8 +101,7 @@ describe CrystalSDK::Profile do
 
     context '200' do
       let(:resp) do
-        body = { status: 'profile_found', info: nil, recommendations: nil }
-        double(body: body.to_json, code: '200')
+        double(code: '200')
       end
 
       it 'should raise no error' do
@@ -91,15 +110,15 @@ describe CrystalSDK::Profile do
     end
 
     context '202' do
-      let(:resp) { double(body: nil, code: '202') }
+      let(:resp) { double(code: '202') }
 
-      it 'should raise NotFoundYetError' do
-        expect { subject }.to raise_error(CrystalSDK::Profile::NotFoundYetError)
+      it 'should raise no error' do
+        expect { subject }.to_not raise_error
       end
     end
 
     context '401' do
-      let(:resp) { double(body: nil, code: '401') }
+      let(:resp) { double(code: '401') }
 
       it 'should raise NotAuthedError' do
         expect { subject }.to raise_error(CrystalSDK::Profile::NotAuthedError)
@@ -107,7 +126,7 @@ describe CrystalSDK::Profile do
     end
 
     context '404' do
-      let(:resp) { double(body: nil, code: '404') }
+      let(:resp) { double(code: '404') }
 
       it 'should raise NotFoundError' do
         expect { subject }.to raise_error(CrystalSDK::Profile::NotFoundError)
@@ -115,101 +134,11 @@ describe CrystalSDK::Profile do
     end
 
     context '429' do
-      let(:resp) { double(body: nil, code: '429') }
+      let(:resp) { double(code: '429') }
 
       it 'should raise RateLimitHitError' do
         expect { subject }.to raise_error(CrystalSDK::Profile::RateLimitHitError)
       end
     end
   end
-
-  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::Profile.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::Profile
-            .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::Profile
-            .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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: crystal_sdk
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Cory Finger
@@ -25,6 +25,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: recursive-open-struct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement