Merge pull request #34 from checkr/add-support-packages-programs

Add support for Packages and Programs

Author: capripot

Changelog.md

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

lib/checkr.rb

@@ -28,6 +28,8 @@
 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'

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(:Geo)
+    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

lib/checkr/program.rb

@@ -0,0 +1,22 @@
+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]
+    api_class_method :create, :post
+
+    def self.path
+      "/v1/programs"
+    end
+
+    APIClass.register_subclass(self, 'program')
+  end
+end

lib/checkr/screening.rb

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

lib/checkr/version.rb

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

tasks/api_test.rb

@@ -186,7 +186,4 @@ def run_motor_vehicle_report_tests(consider, clear)
 
     motor_vehicle_report
   end
-
-
-
 end

test/checkr/package_test.rb

@@ -0,0 +1,82 @@
+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
+
+    should 'be registered' do
+      assert(APIClass.subclasses.include?(Package))
+      assert_equal(Package, APIClass.subclass_fetch('package'))
+    end
+
+  end
+end

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
+
+      should 'be createable' do
+        @mock.expects(:post).once.with(@program_url, anything, test_program)
+          .returns(test_response(test_program))
+        program = Program.create(test_program)
+        assert(program.is_a?(Program))
+        assert_equal(program.id, test_program[:id])
+      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
+
+    should 'be registered' do
+      assert(APIClass.subclasses.include?(Program))
+      assert_equal(Program, APIClass.subclass_fetch('program'))
+    end
+
+  end
+end

test/test_data.rb

@@ -125,6 +125,31 @@ def test_geo
        :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_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_ssn_trace
       {:id=>"539fd88c101897f7cd000001",
        :object=>"ssn_trace",