checkr-official 1.2.1 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ddf3564caa67a9d76f33081ebbe8a889c43aa911
-  data.tar.gz: ee4f0219b03a8f6d7e46e6e736c14637b8f3ad64
+  metadata.gz: b921aaa8e158abf8c33bf28f04d410c0d38b7186
+  data.tar.gz: 6ad0c7169770e3322ee4f11c2a54baa0a40f7bff
 SHA512:
-  metadata.gz: 46e1febb7312c67a30b568ea6dbc54378a180e531783eaa0f7891ef2294148534487c775e1af3c05cbc81b7d4f36fca25306ac43b007595bb894414fa86ea4e9
-  data.tar.gz: 9ab891fd506d0b456a6a5bf35589ff0544b951fb8222b256576662a52b1f07d1710c897c9747840e57c51d654ea281c27bf9a6b51e2b9cd09bb8042f8d666458
+  metadata.gz: 8b8cc2de5438b56719e28c8437434b068f8823e040496463e7c193f6a026272c948c0bd4904ef748a229c113fc70db7289d15d280713fea2305ef511e2da0520
+  data.tar.gz: b54f0c8f82617b4b46740ce330aefd0ac3144e48a9cb08bdb399c5d796c659b9b2adafa7ab1dd8db95758a72dd457ae702de4ac84eba4d18bf08a7283211d6c8

data/.rubocop.yml

@@ -10,6 +10,12 @@ AllCops:
     - 'vendor/**/*'
   DisplayCopNames: true
 
+Layout/EmptyLinesAroundClassBody:
+  EnforcedStyle: empty_lines
+
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
 Metrics/AbcSize:
   Max: 20
 
@@ -34,12 +40,6 @@ Style/Documentation:
 Style/SymbolArray:
   Enabled: false
 
-Style/EmptyLinesAroundClassBody:
-  EnforcedStyle: empty_lines
-
-Style/MultilineMethodCallIndentation:
-  EnforcedStyle: indented
-
 Style/PercentLiteralDelimiters:
   PreferredDelimiters:
     '%i': '[]'

data/.travis.yml

@@ -1,8 +1,7 @@
 language: ruby
 rvm:
-  - 1.9.3
-  - 2.0.0
-  - 2.1
   - 2.2
-  - 2.3.0
+  - 2.3
+  - 2.4
+  - 2.5
   - jruby

data/Changelog.md

@@ -1,3 +1,10 @@
+## 1.3.1 (2018-01-19)
+
+Features:
+
+ - Add Package
+ - Add Program
+
 ## 1.2.1 (2017-10-25)
 
 Fixes:

data/lib/checkr.rb

@@ -28,6 +28,8 @@ require 'checkr/global_watchlist_search'
 require 'checkr/invitation'
 require 'checkr/motor_vehicle_report'
 require 'checkr/national_criminal_search'
+require 'checkr/package'
+require 'checkr/program'
 require 'checkr/report'
 require 'checkr/report_list'
 require 'checkr/sex_offender_search'

data/lib/checkr/package.rb

@@ -0,0 +1,19 @@
+module Checkr
+  class Package < APIResource
+
+    attribute :name
+    attribute :slug
+    attribute :price
+    attribute :screenings
+
+    api_class_method :all, :get, :constructor => APIList.constructor(:Package)
+    api_class_method :retrieve, :get, ":path/:id", :arguments => [:id]
+    api_class_method :create, :post
+
+    def self.path
+      "/v1/packages"
+    end
+
+    APIClass.register_subclass(self, 'package')
+  end
+end

data/lib/checkr/program.rb

@@ -0,0 +1,21 @@
+module Checkr
+  class Program < APIResource
+
+    attribute :name
+    attribute :created_at
+    attribute :deleted_at
+    attribute :geos, APIList.constructor(:Geo)
+    attribute_writer_alias :geo_ids, :geos
+    attribute :packages, APIList.constructor(:Package)
+    attribute_writer_alias :package_ids, :packages
+
+    api_class_method :all, :get, :constructor => APIList.constructor(:Program)
+    api_class_method :retrieve, :get, ":path/:id", :arguments => [:id]
+
+    def self.path
+      "/v1/programs"
+    end
+
+    APIClass.register_subclass(self, 'program')
+  end
+end

data/lib/checkr/screening.rb

@@ -0,0 +1,9 @@
+module Checkr
+  class Screening < APIResource
+
+    attribute :type
+    attribute :subtype
+
+    APIClass.register_subclass(self, "screening")
+  end
+end

data/lib/checkr/version.rb

@@ -1,3 +1,3 @@
 module Checkr
-  VERSION = '1.2.1'.freeze
+  VERSION = '1.3.1'.freeze
 end

data/tasks/api_test.rb

@@ -186,7 +186,4 @@ class APITest
 
     motor_vehicle_report
   end
-
-
-
 end

data/test/checkr/package_test.rb

@@ -0,0 +1,90 @@
+require File.expand_path('../../test_helper', __FILE__)
+
+module Checkr
+  class PackageTest < Test::Unit::TestCase
+    setup do
+      @package_url = "#{Checkr.api_base}/v1/packages"
+    end
+
+    context 'Package class' do
+      should 'be retrieveable' do
+        id = 'package_id'
+        @mock.expects(:get).once.with("#{@package_url}/#{id}", anything, anything)
+          .returns(test_response(test_package))
+        package = Package.retrieve(id)
+        assert(package.is_a?(Package))
+      end
+
+      should 'be createable' do
+        @mock.expects(:post).once.with(@package_url, anything, test_package)
+          .returns(test_response(test_package))
+        package = Package.create(test_package)
+        assert(package.is_a?(Package))
+        assert_equal(test_package[:id], package.id)
+      end
+    end
+
+    context 'Package instance' do
+      should 'be refreshable' do
+        @mock.expects(:get).once.with("#{@package_url}/#{test_package[:id]}", anything, anything)
+          .returns(test_response(test_package))
+        package = Package.new(test_package[:id])
+        package.refresh
+        assert_equal(test_package[:name], package.name)
+      end
+    end
+
+    context 'Retrieved Package instance' do
+      setup do
+        @mock.expects(:get).once.returns(test_response(test_package))
+        @package = Package.retrieve('package_id')
+      end
+
+      should 'have the id attribute' do
+        assert_equal(test_package[:id], @package.id)
+      end
+
+      should 'have the object attribute' do
+        assert_equal(test_package[:object], @package.object)
+      end
+
+      should 'have the uri attribute' do
+        assert_equal(test_package[:uri], @package.uri)
+      end
+
+      should 'have the created_at attribute' do
+        assert_equal(test_package[:created_at], @package.created_at)
+      end
+
+      should 'have the name attribute' do
+        assert_equal(test_package[:name], @package.name)
+      end
+
+      should 'have the slug attribute' do
+        assert_equal(test_package[:slug], @package.slug)
+      end
+
+      should 'have the price attribute' do
+        assert_equal(test_package[:price], @package.price)
+      end
+
+      should 'have screenings attribute' do
+        assert_equal(test_package[:screenings], @package.screenings)
+      end
+    end
+
+    context '#all' do
+      should 'return instances of Package' do
+        @mock.expects(:get).once.with(@package_url, anything, anything)
+            .returns(test_response(test_package_list))
+        assert_equal(Package.all.first.class, Package)
+      end
+    end
+
+    should 'be registered' do
+      assert(APIClass.subclasses.include?(Package))
+      assert_equal(Package, APIClass.subclass_fetch('package'))
+    end
+
+  end
+end

data/test/checkr/program_test.rb

@@ -0,0 +1,89 @@
+require File.expand_path('../../test_helper', __FILE__)
+
+module Checkr
+  class ProgramTest < Test::Unit::TestCase
+    setup do
+      @program_url = "#{Checkr.api_base}/v1/programs"
+    end
+
+    context 'Program class' do
+      should 'be retrieveable' do
+        id = 'program_id'
+        @mock.expects(:get).once.with("#{@program_url}/#{id}", anything, anything)
+          .returns(test_response(test_program))
+        program = Program.retrieve(id)
+        assert(program.is_a?(Program))
+      end
+    end
+
+    context 'Program instance' do
+      should 'be refreshable' do
+        @mock.expects(:get).once.with("#{@program_url}/#{test_program[:id]}", anything, anything)
+          .returns(test_response(test_program))
+        program = Program.new(test_program[:id])
+        program.refresh
+        assert_equal(program.name, test_program[:name])
+      end
+    end
+
+    context 'Retrieved Program instance' do
+      setup do
+        @mock.expects(:get).once.returns(test_response(test_program))
+        @program = Program.retrieve('program_id')
+      end
+
+      should 'have the id attribute' do
+        assert_equal(@program.id, test_program[:id])
+      end
+
+      should 'have the object attribute' do
+        assert_equal(@program.object, test_program[:object])
+      end
+
+      should 'have the uri attribute' do
+        assert_equal(@program.uri, test_program[:uri])
+      end
+
+      should 'have the created_at attribute' do
+        assert_equal(@program.created_at, test_program[:created_at])
+      end
+
+      should 'have the deleted_at attribute' do
+        assert_equal(@program.deleted_at, test_program[:deleted_at])
+      end
+
+      should 'have the name attribute' do
+        assert_equal(@program.name, test_program[:name])
+      end
+
+      should 'have the geo_ids attribute' do
+        assert_equal(@program.geos.json, test_program[:geo_ids])
+        assert(@program.geos.is_a?(APIList))
+      end
+
+      # should 'have the packages attribute' do
+      #   assert(@candidate.packages.any?)
+      #   assert(@candidate.packages.is_a?(PackageList))
+      # end
+
+      should 'have the package_ids attribute' do
+        assert_equal(@program.packages.json, test_program[:package_ids])
+        assert(@program.packages.is_a?(APIList))
+      end
+    end
+
+    context '#all' do
+      should 'return instances of Program' do
+        @mock.expects(:get).once.with(@program_url, anything, anything)
+            .returns(test_response(test_program_list))
+        assert_equal(Program.all.first.class, Program)
+      end
+    end
+
+    should 'be registered' do
+      assert(APIClass.subclasses.include?(Program))
+      assert_equal(Program, APIClass.subclass_fetch('program'))
+    end
+
+  end
+end

data/test/test_data.rb

@@ -125,6 +125,45 @@ module Checkr
        :state=>"CA"}
     end
 
+    def test_package
+      {:id=>"e44aa283528e6fde7d542194",
+       :object=>"package",
+       :uri=>"/v1/packages/e44aa283528e6fde7d542194",
+       :created_at=>"2018-01-18T12:34:00Z",
+       :name=>"Criminal Pro",
+       :slug=>"criminal_pro",
+       :price=>"6500",
+       :screenings=>
+         [{:type=>"ssn_trace",
+           :subtype=>nil},
+          {:type=>"county_criminal_search",
+           :subtype=>"7years"}]}
+    end
+
+    def test_package_list
+      {
+        :object => 'list',
+        :data => [test_package, test_package, test_package],
+      }
+    end
+
+    def test_program
+      {:id=>"e44aa283528e6fde7d542194",
+       :object=>"program",
+       :uri=>"/v1/programs/e44aa283528e6fde7d542194",
+       :created_at=>"2018-01-18T12:34:00Z",
+       :deleted_at=>"2018-01-18T12:34:00Z",
+       :geo_ids=>["cbc37748bc6a45b41af5c3f5"],
+       :package_ids=>["a57a0cd15965a585ff7d5d35"]}
+    end
+
+    def test_program_list
+      {
+        :object => 'list',
+        :data => [test_program, test_program, test_program],
+      }
+    end
+
     def test_ssn_trace
       {:id=>"539fd88c101897f7cd000001",
        :object=>"ssn_trace",

metadata

@@ -1,83 +1,83 @@
 --- !ruby/object:Gem::Specification
 name: checkr-official
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.3.1
 platform: ruby
 authors:
 - Jon Calhoun
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-25 00:00:00.000000000 Z
+date: 2018-01-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '1.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '1.4'
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.8.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.8.1
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 0.13.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 0.13.2
 - !ruby/object:Gem::Dependency
   name: shoulda
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 3.4.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 3.4.0
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 4.2.6
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 4.2.6
 - !ruby/object:Gem::Dependency
@@ -112,14 +112,14 @@ dependencies:
   name: test-unit
   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: Checkr - Automated background screenings and driving records. See https://checkr.com/
@@ -131,10 +131,9 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".hound.yml"
-- ".rubocop.yml"
-- ".travis.yml"
+- .gitignore
+- .rubocop.yml
+- .travis.yml
 - Changelog.md
 - Gemfile
 - README.md
@@ -161,8 +160,11 @@ files:
 - lib/checkr/invitation.rb
 - lib/checkr/motor_vehicle_report.rb
 - lib/checkr/national_criminal_search.rb
+- lib/checkr/package.rb
+- lib/checkr/program.rb
 - lib/checkr/report.rb
 - lib/checkr/report_list.rb
+- lib/checkr/screening.rb
 - lib/checkr/sex_offender_search.rb
 - lib/checkr/ssn_trace.rb
 - lib/checkr/subscription.rb
@@ -197,6 +199,8 @@ files:
 - test/checkr/invitation_test.rb
 - test/checkr/motor_vehicle_report_test.rb
 - test/checkr/national_criminal_search_test.rb
+- test/checkr/package_test.rb
+- test/checkr/program_test.rb
 - test/checkr/report_test.rb
 - test/checkr/sex_offender_search_test.rb
 - test/checkr/ssn_trace_test.rb
@@ -215,17 +219,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.0.14.1
 signing_key: 
 specification_version: 4
 summary: Ruby bindings for Checkr API
@@ -245,6 +249,8 @@ test_files:
 - test/checkr/invitation_test.rb
 - test/checkr/motor_vehicle_report_test.rb
 - test/checkr/national_criminal_search_test.rb
+- test/checkr/package_test.rb
+- test/checkr/program_test.rb
 - test/checkr/report_test.rb
 - test/checkr/sex_offender_search_test.rb
 - test/checkr/ssn_trace_test.rb

data/.hound.yml

@@ -1,2 +0,0 @@
-ruby:
-  config_file: .rubocop.yml