crystal_sdk 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0a041d19a7796ed4a2dc06aa2798af49c2d94ef6
-  data.tar.gz: bdd26fd9c95f06931ad272b382dd0ab2c2ad3ab0
+  metadata.gz: de9532edb29d75171cadeca8e294db49601372e1
+  data.tar.gz: 31b742edfd168bec378d38a770c5b4609a6ba0ab
 SHA512:
-  metadata.gz: 18dd7df0bf745dc6131d99d6dc389586b8957df1c65987c57fa171e696acd2de66f6f4aca9806ae1b784f180aaeb28fff695cda25b85a5748e4c7a3196384f27
-  data.tar.gz: b6d3f998e694207ad8b156708ab6de998f73c5bee1ab99e816ee6db5a225c04582b0d05a4a67e715d4f6e77838fd190d25cacb6a538db963fc7b4ff2c9e571d3
+  metadata.gz: 158c383df20c0ccfff8704ec8ae353bc0a502c1b0dec7c113e22ac56f4bbd5ec4af52d236898ba3c65c7f3e16ca3f69da75dacd71136800daab7b822fe0f71c1
+  data.tar.gz: 4963b7be68b80060582d32857112909f1180443b7b652cef7ab0d333af37c1f0692f38f807a12f5287b6e12facc7e5f806d718027eda3326a1cd4bcb28c4e12d

data/.gitignore

@@ -0,0 +1,50 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/Gemfile

@@ -0,0 +1,2 @@
+source "https://rubygems.org"
+gemspec

data/Gemfile.lock

@@ -0,0 +1,46 @@
+PATH
+  remote: .
+  specs:
+    crystal_sdk (0.0.1)
+      nestful (~> 1.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.5.0)
+      public_suffix (~> 2.0, >= 2.0.2)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.3)
+    hashdiff (0.3.2)
+    nestful (1.1.1)
+    public_suffix (2.0.5)
+    rspec (3.5.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+    rspec-core (3.5.4)
+      rspec-support (~> 3.5.0)
+    rspec-expectations (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-mocks (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
+    safe_yaml (1.0.4)
+    webmock (2.3.2)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  crystal_sdk!
+  rspec
+  webmock
+
+BUNDLED WITH
+   1.13.6

data/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,48 @@
+# Crystal Ruby SDK
+
+This gem provides access to Crystal, the world's largest and most accurate personality database!
+
+Here's how to install it:
+```bash
+$ gem install crystal_sdk
+```
+
+Here's how you use it:
+
+```ruby
+require 'crystal_sdk'
+
+CrystalSDK.key = "OrgKey"
+
+begin
+  profile = CrystalSDK::Profile.search({
+    first_name: "Drew",
+    last_name: "D'Agostino"
+  })
+
+  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 "Recommendations: #{profile.recommendations}"
+
+rescue CrystalSDK::Profile::NotFoundError
+  print "No profile was found"
+
+rescue CrystalSDK::Profile::NotFoundYetError
+  print "Profile search exceeded time limit"
+
+rescue CrystalSDK::Profile::RateLimitHitError
+  print "The organization's API rate limit was hit"
+
+rescue CrystalSDK::Profile::NotAuthedError
+  print "Org key was invalid"
+
+rescue StandardError => e
+  print "Unexpected error occurred: #{e}"
+
+end
+```

data/Rakefile

@@ -0,0 +1,3 @@
+task :console do
+  exec "irb -r crystal_sdk -I ./lib"
+end

data/crystal_sdk.gemspec

@@ -0,0 +1,24 @@
+require_relative 'lib/crystal_sdk/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'crystal_sdk'
+  s.version     = CrystalSDK::VERSION
+  s.date        = '2017-02-22'
+  s.summary     = 'Access the largest and most accurate personality database!'
+  s.description = 'The Enterprise SDK for https://www.crystalknows.com/ - the largest and most accurate personality database!'
+  s.authors     = ['Cory Finger', 'Nicholas Picciuto']
+  s.email       = 'hello@crystalknows.com'
+  s.files       = ['lib/crystal_sdk.rb']
+  s.homepage    =
+    'https://github.com/crystal-project-inc/ruby_sdk'
+  s.license     = 'Apache-2.0'
+
+  s.files         = `git ls-files`.split($/)
+  s.executables   = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+  s.require_paths = ['lib']
+
+  s.add_dependency 'nestful', '~> 1.1'
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'webmock'
+end

data/lib/crystal_sdk/base.rb

@@ -0,0 +1,15 @@
+module CrystalSDK
+  class Base
+    class ApiKeyNotSet < StandardError; end
+    API_URL = 'http://enterprise-api.crystalknows.com/v1'.freeze
+
+    class << self
+      attr_accessor :key
+
+      def key!
+        raise ApiKeyNotSet unless key
+        key
+      end
+    end
+  end
+end

data/lib/crystal_sdk/profile.rb

@@ -0,0 +1,60 @@
+module CrystalSDK
+  class Profile
+    class NotFoundError < StandardError; end
+    class NotFoundYetError < StandardError; end
+    class NotAuthedError < StandardError; end
+    class RateLimitHitError < StandardError; end
+    class UnexpectedError < StandardError; end
+
+    attr_reader :info, :recommendations
+
+    def initialize(info, recommendations)
+      @info = info
+      @recommendations = recommendations
+    end
+
+    class << self
+      def search(query)
+        begin
+          resp = make_request(:post, 'person_search', params: query)
+          body = resp.body ? JSON.parse(resp.body, symbolize_names: true) : nil
+
+        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
+      end
+    end
+  end
+end

data/lib/crystal_sdk/version.rb

@@ -0,0 +1,3 @@
+module CrystalSDK
+  VERSION = '0.0.2'.freeze
+end

data/spec/crystal_sdk/base_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+
+describe CrystalSDK::Base do
+  subject { CrystalSDK::Base }
+
+  it { is_expected.not_to be_nil }
+  it { is_expected.to respond_to(:key) }
+  it { is_expected.to respond_to(:key=) }
+
+  describe 'API_URL' do
+    subject { CrystalSDK::Base::API_URL }
+
+    it { is_expected.to include '.crystalknows.com' }
+    it { is_expected.to start_with 'https://' }
+    it { is_expected.to_not end_with '/' }
+  end
+
+  describe '.key!' do
+    subject { CrystalSDK::Base.key! }
+
+    context 'no key is set' do
+      before(:each) do
+        allow(CrystalSDK::Base).to receive(:key).and_return(nil)
+      end
+
+      it 'should raise ApiKeyNotSet' do
+        expect { subject }.to raise_error(CrystalSDK::Base::ApiKeyNotSet)
+      end
+    end
+
+    context 'key is set' do
+      before(:each) do
+        allow(CrystalSDK::Base).to receive(:key).and_return('SomeKey')
+      end
+
+      it { is_expected.to eql(CrystalSDK::Base.key) }
+    end
+  end
+end

data/spec/crystal_sdk/profile_spec.rb

@@ -0,0 +1,215 @@
+require 'spec_helper'
+
+describe CrystalSDK::Profile do
+  subject { CrystalSDK::Profile }
+
+  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))
+
+      expect(subject.info).to eql('info')
+      expect(subject.recommendations).to eql('recs')
+    end
+
+    context 'make_request raised unexpected error' do
+      before(:each) do
+        allow(CrystalSDK::Profile).to receive(:make_request)
+          .with(request_type, endpoint, params: query)
+          .and_raise("SomeRandomError")
+      end
+
+      it 'should not suppress the error' do
+        expect { subject }.to raise_error('SomeRandomError')
+      end
+    end
+
+    context 'make_request raised expected error' do
+      before(:each) do
+        allow(CrystalSDK::Profile).to receive(:make_request)
+          .with(request_type, endpoint, params: query)
+          .and_raise(Nestful::ResponseError.new(nil, double()))
+      end
+
+      it 'should pass it off to check_for_error' do
+        expect(CrystalSDK::Profile).to receive(:check_for_error)
+          .and_raise('CheckForErrorCalled')
+
+        expect { subject }.to raise_error('CheckForErrorCalled')
+      end
+
+      it 'should still raise exception if passed check_for_error' do
+        expect(CrystalSDK::Profile).to receive(:check_for_error)
+          .and_return(nil)
+
+        expect { subject }.to raise_error
+      end
+    end
+
+    context 'make_request raised no error' do
+      before(:each) do
+        allow(CrystalSDK::Profile).to receive(:make_request)
+          .with(request_type, endpoint, params: query)
+          .and_return(response)
+      end
+
+      let(:response) do
+        double(code: '200', body: { resp: 'some_resp' }.to_json)
+      end
+
+      it 'should still pass through check_for_error' do
+        expect(CrystalSDK::Profile).to receive(:check_for_error)
+          .with(response)
+          .and_raise('CheckForErrorCalled')
+
+        expect { subject }.to raise_error('CheckForErrorCalled')
+      end
+    end
+  end
+
+  describe '.check_for_error' do
+    subject { CrystalSDK::Profile.check_for_error(resp) }
+
+    context '200' do
+      let(:resp) do
+        body = { status: 'profile_found', info: nil, recommendations: nil }
+        double(body: body.to_json, code: '200')
+      end
+
+      it 'should raise no error' do
+        expect { subject }.to_not raise_error
+      end
+    end
+
+    context '202' do
+      let(:resp) { double(body: nil, code: '202') }
+
+      it 'should raise NotFoundYetError' do
+        expect { subject }.to raise_error(CrystalSDK::Profile::NotFoundYetError)
+      end
+    end
+
+    context '401' do
+      let(:resp) { double(body: nil, code: '401') }
+
+      it 'should raise NotAuthedError' do
+        expect { subject }.to raise_error(CrystalSDK::Profile::NotAuthedError)
+      end
+    end
+
+    context '404' do
+      let(:resp) { double(body: nil, code: '404') }
+
+      it 'should raise NotFoundError' do
+        expect { subject }.to raise_error(CrystalSDK::Profile::NotFoundError)
+      end
+    end
+
+    context '429' do
+      let(:resp) { double(body: nil, 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

data/spec/crystal_sdk/version_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+describe 'CrystalSDK::VERSION' do
+  subject { CrystalSDK::VERSION }
+
+  it 'should contain 2 dots' do
+    expect(subject.count('.')).to eql(2)
+  end
+
+  it 'should contain only numbers' do
+    numbers = subject.split('.')
+
+    expect { Float(numbers[0]) }.to_not raise_error
+    expect { Float(numbers[1]) }.to_not raise_error
+    expect { Float(numbers[2]) }.to_not raise_error
+  end
+end

data/spec/crystal_sdk_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+
+describe CrystalSDK do
+  it { is_expected.not_to be_nil }
+  it { is_expected.to respond_to(:key) }
+  it { is_expected.to respond_to(:key=) }
+  it { is_expected.to respond_to(:api_key) }
+  it { is_expected.to respond_to(:api_key=) }
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require 'bundler/setup'
+Bundler.setup
+
+require 'webmock/rspec'
+require 'crystal_sdk'
+
+WebMock.disable_net_connect!(allow_localhost: true)
+
+RSpec.configure do |config|
+  # some (optional) config here
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: crystal_sdk
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Cory Finger
@@ -25,6 +25,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: The Enterprise SDK for https://www.crystalknows.com/ - the largest and
   most accurate personality database!
 email: hello@crystalknows.com
@@ -32,7 +60,23 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- crystal_sdk.gemspec
 - lib/crystal_sdk.rb
+- lib/crystal_sdk/base.rb
+- lib/crystal_sdk/profile.rb
+- lib/crystal_sdk/version.rb
+- spec/crystal_sdk/base_spec.rb
+- spec/crystal_sdk/profile_spec.rb
+- spec/crystal_sdk/version_spec.rb
+- spec/crystal_sdk_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/crystal-project-inc/ruby_sdk
 licenses:
 - Apache-2.0
@@ -57,4 +101,9 @@ rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: Access the largest and most accurate personality database!
-test_files: []
+test_files:
+- spec/crystal_sdk/base_spec.rb
+- spec/crystal_sdk/profile_spec.rb
+- spec/crystal_sdk/version_spec.rb
+- spec/crystal_sdk_spec.rb
+- spec/spec_helper.rb