teamtailor 0.1.0 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c9464bec7bd58b5a5b47dc4cd5fd2aa91710f82602f658d4a1981cff33d42bc1
-  data.tar.gz: f1e218de0ce3dd7ebb78ebdd29c44ad2bfb49680b226186a18b5f18e23d2c654
+  metadata.gz: 65d5517a7804ca23cfab37e186ce9a3a8e6fd834d19142f1639bd43a713f0cad
+  data.tar.gz: 1ce95b3c0f5734a5a75d7e735a2938396e66b1c6a66ecb636f11951e99cb16b4
 SHA512:
-  metadata.gz: db6d877077e001925903a29694918110f02c85bdb3e3c10bc80df415bf5f9b0e463e2f606380f9c26f391e49ea0f6cb86416989afe00df4883df335fac947794
-  data.tar.gz: a27532d72dd0cfd872392af29ff3e81665a1fd61ff27f065801f815fc14b2928d72950e5cef3b14e27fd058308faaba2afd5ed1285c4c67ada6826599a841e39
+  metadata.gz: befca1d520b6e38edde324a89a5ed7e2e45df37a08037c2ea466703e558d3a88c4401878c33e3021b38408ea5567616c5d67cc5ebeaac60eeaff289b29b6954c
+  data.tar.gz: c03ff827ea515229c96f4380a3aea14e5989060ffa1bf9c8146149135475040591179aad9444aee343bb81903a0f119dba9b5302589dde5dded132865c981654

data/CHANGELOG.md

@@ -0,0 +1,27 @@
+## Unreleased
+
+## v0.2.4 - 2020-04-07
+
+- Add `Teamtailor::Location` and `Client#locations`
+- Add `Teamtailor::Department` and `Client#departments`
+- Add `Teamtailor::RejectReason` and `Client#reject_reasons`
+- Add `Teamtailor::Stage` and `Client#stages` for fetching it (`2179b1`)
+
+## v0.2.3 - 2020-04-06
+
+- Add `Teamtailor::Company` and `Client#company` for fetching it (`05dde0`)
+
+## v0.2.2 - 2020-03-31
+
+- Move serialization logic in the `Teamtailor::Record` base class (`9ec63a0`)
+- Fix serializing/deserializing loaded relationships for
+  `Teamtailor::JobApplication` (`428e2d`) 
+
+## v0.2.1 - 2020-03-31
+
+- Add `Teamtailor::JobApplication` and `Client#job_applications` (`062fa7`)
+
+## v0.2.0 - 2020-03-31
+
+- Add support for accessing relationships on records (`1218aa`)
+- Add support for including relationships when querying the API (`90f25d`)

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    teamtailor (0.1.0)
+    teamtailor (0.2.4)
       typhoeus (~> 1.3.1)
 
 GEM

data/README.md

@@ -65,6 +65,41 @@ irb(main):041:0> jobs.map &:title
 => ["EmberJS Developer", "Ruby on Rails developer"]
 ```
 
+### Relationships
+
+The API allows you to include associated data when requesting data to help
+you load associations without having to make any additional requests.
+To do this, you can pass what you want to include when making the request.
+
+To fetch jobs with all associated `user`s loaded, you can call `Client#jobs`
+like this:
+
+```ruby
+irb(main):006:0> page_result = @client.jobs(page: 1, include: [:user])
+irb(main):007:0> page_result.records.first.user.record.login_email
+=> "admin@teamtailor.localhost"
+```
+
+If you try to access a relationship, without having included it when loading it
+from the server, it'll raise a `Teamtailor::UnloadedRelationError`:
+
+```ruby
+irb(main):010:0> page_result = @client.jobs(page: 1, include: [])
+irb(main):011:0> page_result.records.first.user.record
+Traceback (most recent call last):
+        ...
+        1: from ~/teamtailor/lib/teamtailor/relationship.rb:16:in `record'
+Teamtailor::UnloadedRelationError (Teamtailor::UnloadedRelationError)
+```
+
+To check if a relation has been loaded or not you can use the
+`Relationship#loaded?` method to check before calling it:
+
+```ruby
+irb(main):012:0> page_result = @client.jobs(page: 1, include: [:user])
+irb(main):013:0> page_result.records.first.user.loaded?
+=> true
+```
 
 ## Development
 

data/lib/teamtailor/client.rb

@@ -10,7 +10,19 @@ module Teamtailor
       @api_version = api_version
     end
 
-    def candidates(page: 1)
+    def company(include: [])
+      Teamtailor::Request.new(
+        base_url: base_url,
+        api_token: api_token,
+        api_version: api_version,
+        path: '/v1/company',
+        params: {
+          'include' => include.join(',')
+        }
+      ).call
+    end
+
+    def candidates(page: 1, include: [])
       Teamtailor::Request.new(
         base_url: base_url,
         api_token: api_token,
@@ -18,12 +30,13 @@ module Teamtailor
         path: '/v1/candidates',
         params: {
           'page[number]' => page,
-          'page[size]' => 30
+          'page[size]' => 30,
+          'include' => include.join(',')
         }
       ).call
     end
 
-    def jobs(page: 1)
+    def jobs(page: 1, include: [])
       Teamtailor::Request.new(
         base_url: base_url,
         api_token: api_token,
@@ -31,12 +44,27 @@ module Teamtailor
         path: '/v1/jobs',
         params: {
           'page[number]' => page,
-          'page[size]' => 30
+          'page[size]' => 30,
+          'include' => include.join(',')
+        }
+      ).call
+    end
+
+    def job_applications(page: 1, include: [])
+      Teamtailor::Request.new(
+        base_url: base_url,
+        api_token: api_token,
+        api_version: api_version,
+        path: '/v1/job-applications',
+        params: {
+          'page[number]' => page,
+          'page[size]' => 30,
+          'include' => include.join(',')
         }
       ).call
     end
 
-    def users(page: 1)
+    def users(page: 1, include: [])
       Teamtailor::Request.new(
         base_url: base_url,
         api_token: api_token,
@@ -44,7 +72,64 @@ module Teamtailor
         path: '/v1/users',
         params: {
           'page[number]' => page,
-          'page[size]' => 30
+          'page[size]' => 30,
+          'include' => include.join(',')
+        }
+      ).call
+    end
+
+    def stages(page: 1, include: [])
+      Teamtailor::Request.new(
+        base_url: base_url,
+        api_token: api_token,
+        api_version: api_version,
+        path: '/v1/stages',
+        params: {
+          'page[number]' => page,
+          'page[size]' => 30,
+          'include' => include.join(',')
+        }
+      ).call
+    end
+
+    def reject_reasons(page: 1, include: [])
+      Teamtailor::Request.new(
+        base_url: base_url,
+        api_token: api_token,
+        api_version: api_version,
+        path: '/v1/reject-reasons',
+        params: {
+          'page[number]' => page,
+          'page[size]' => 30,
+          'include' => include.join(',')
+        }
+      ).call
+    end
+
+    def departments(page: 1, include: [])
+      Teamtailor::Request.new(
+        base_url: base_url,
+        api_token: api_token,
+        api_version: api_version,
+        path: '/v1/departments',
+        params: {
+          'page[number]' => page,
+          'page[size]' => 30,
+          'include' => include.join(',')
+        }
+      ).call
+    end
+
+    def locations(page: 1, include: [])
+      Teamtailor::Request.new(
+        base_url: base_url,
+        api_token: api_token,
+        api_version: api_version,
+        path: '/v1/locations',
+        params: {
+          'page[number]' => page,
+          'page[size]' => 30,
+          'include' => include.join(',')
         }
       ).call
     end

data/lib/teamtailor/error.rb

@@ -24,4 +24,6 @@ module Teamtailor
   class JSONError < ClientError; end
 
   class UnknownResponseTypeError < ClientError; end
+
+  class UnloadedRelationError < ClientError; end
 end

data/lib/teamtailor/parser.rb

@@ -3,6 +3,12 @@
 require 'teamtailor/parser/candidate'
 require 'teamtailor/parser/job'
 require 'teamtailor/parser/user'
+require 'teamtailor/parser/job_application'
+require 'teamtailor/parser/company'
+require 'teamtailor/parser/stage'
+require 'teamtailor/parser/reject_reason'
+require 'teamtailor/parser/department'
+require 'teamtailor/parser/location'
 
 module Teamtailor
   class Parser
@@ -13,12 +19,18 @@ module Teamtailor
     def parse
       data.map do |record|
         case record&.dig('type')
-        when 'candidates' then Teamtailor::Candidate.new(record)
-        when 'jobs' then Teamtailor::Job.new(record)
-        when 'users' then Teamtailor::User.new(record)
+        when 'candidates' then Teamtailor::Candidate.new(record, included)
+        when 'jobs' then Teamtailor::Job.new(record, included)
+        when 'users' then Teamtailor::User.new(record, included)
+        when 'job-applications' then Teamtailor::JobApplication.new(record, included)
+        when 'companies' then Teamtailor::Company.new(record, included)
+        when 'stages' then Teamtailor::Stage.new(record, included)
+        when 'reject-reasons' then Teamtailor::RejectReason.new(record, included)
+        when 'departments' then Teamtailor::Department.new(record, included)
+        when 'locations' then Teamtailor::Location.new(record, included)
 
         else
-          raise Teamtailor::UnknownResponseTypeError.new(record&.dig('type'))
+          raise Teamtailor::UnknownResponseTypeError, record&.dig('type')
         end
       end
     end
@@ -34,5 +46,9 @@ module Teamtailor
     def data
       [payload&.dig('data')].flatten
     end
+
+    def included
+      payload&.dig('included')
+    end
   end
 end

data/lib/teamtailor/parser/candidate.rb

@@ -1,31 +1,11 @@
-module Teamtailor
-  class Candidate
-    def initialize(payload)
-      @payload = payload
-    end
-
-    def self.deserialize(value)
-      new(value)
-    end
-
-    def serialize
-      payload
-    end
+# frozen_string_literal: true
 
-    def id
-      payload.dig('id').to_i
-    end
+require 'teamtailor/record'
 
+module Teamtailor
+  class Candidate < Record
     def connected?
-      payload.dig('attributes', 'connected')
-    end
-
-    def method_missing(m)
-      payload.dig('attributes', m.to_s.gsub('_', '-'))
+      data.dig('attributes', 'connected')
     end
-
-    private
-
-    attr_reader :payload
   end
 end

data/lib/teamtailor/parser/company.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'teamtailor/record'
+
+module Teamtailor
+  class Company < Record
+    def id
+      data.dig('id')
+    end
+  end
+end

data/lib/teamtailor/parser/department.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'teamtailor/record'
+
+module Teamtailor
+  class Department < Record
+  end
+end

data/lib/teamtailor/parser/job.rb

@@ -1,31 +1,11 @@
-module Teamtailor
-  class Job
-    def initialize(payload)
-      @payload = payload
-    end
-
-    def self.deserialize(value)
-      new(value)
-    end
-
-    def serialize
-      payload
-    end
+# frozen_string_literal: true
 
-    def id
-      payload.dig('id').to_i
-    end
+require 'teamtailor/record'
 
+module Teamtailor
+  class Job < Record
     def careersite_job_url
-      payload.dig('links', 'careersite-job-url')
-    end
-
-    def method_missing(m)
-      payload.dig('attributes', m.to_s.gsub('_', '-'))
+      data.dig('links', 'careersite-job-url')
     end
-
-    private
-
-    attr_reader :payload
   end
 end

data/lib/teamtailor/parser/job_application.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'teamtailor/record'
+
+module Teamtailor
+  class JobApplication < Record
+  end
+end

data/lib/teamtailor/parser/location.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'teamtailor/record'
+
+module Teamtailor
+  class Location < Record
+  end
+end

data/lib/teamtailor/parser/reject_reason.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'teamtailor/record'
+
+module Teamtailor
+  class RejectReason < Record
+  end
+end

data/lib/teamtailor/parser/stage.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'teamtailor/record'
+
+module Teamtailor
+  class Stage < Record
+  end
+end

data/lib/teamtailor/parser/user.rb

@@ -1,27 +1,8 @@
-module Teamtailor
-  class User
-    def initialize(payload)
-      @payload = payload
-    end
-
-    def self.deserialize(value)
-      new(value)
-    end
-
-    def serialize
-      payload
-    end
+# frozen_string_literal: true
 
-    def id
-      payload.dig('id').to_i
-    end
+require 'teamtailor/record'
 
-    def method_missing(m)
-      payload.dig('attributes', m.to_s.gsub('_', '-'))
-    end
-
-    private
-
-    attr_reader :payload
+module Teamtailor
+  class User < Record
   end
 end

data/lib/teamtailor/record.rb

@@ -0,0 +1,44 @@
+require 'teamtailor/relationship'
+
+module Teamtailor
+  class Record
+    def initialize(data, included = {})
+      @data = data
+      @included = included
+    end
+
+    def self.deserialize(value)
+      payload = JSON.parse value
+      new(payload['data'], payload['included'])
+    end
+
+    def serialize
+      {
+        data: data,
+        included: included
+      }.to_json
+    end
+
+    def method_missing(m)
+      if m == :id
+        data.dig('id').to_i
+      elsif relationship_keys.include?(m.to_s.gsub('_', '-'))
+        build_relationship(m.to_s.gsub('_', '-'))
+      else
+        data.dig('attributes', m.to_s.gsub('_', '-'))
+      end
+    end
+
+    private
+
+    attr_reader :data, :included
+
+    def build_relationship(name)
+      Teamtailor::Relationship.new(name, data.dig('relationships'), included)
+    end
+
+    def relationship_keys
+      data.dig('relationships')&.keys || {}
+    end
+  end
+end

data/lib/teamtailor/relationship.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Teamtailor
+  class Relationship
+    def initialize(relation_name, relationships = {}, included = {})
+      @relation_name = relation_name
+      @relationships = relationships
+      @included = included
+    end
+
+    def loaded?
+      !record_id.nil?
+    end
+
+    def record
+      raise Teamtailor::UnloadedRelationError unless loaded?
+
+      record_json = included.find do |k|
+        k['id'] == record_id && k['type'] == record_type
+      end
+
+      Teamtailor::Parser.parse({ 'data' => record_json }).first
+    end
+
+    private
+
+    def record_id
+      relationships&.dig(relation_name, 'data', 'id')
+    end
+
+    def record_type
+      relationships&.dig(relation_name, 'data', 'type')
+    end
+
+    attr_reader :relation_name, :relationships, :included
+  end
+end

data/lib/teamtailor/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Teamtailor
-  VERSION = '0.1.0'
+  VERSION = '0.2.4'
 end

data/teamtailor.gemspec

@@ -14,8 +14,8 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
 
   spec.metadata['homepage_uri'] = spec.homepage
-  spec.metadata['source_code_uri'] = 'https://github.com/bzf/teamtailor-gem'
-  spec.metadata['changelog_uri'] = 'https://github.com/bzf/teamtailor-gem/master/CHANGELOG.md'
+  spec.metadata['source_code_uri'] = 'https://github.com/bzf/teamtailor-rb'
+  spec.metadata['changelog_uri'] = 'https://github.com/bzf/teamtailor-rb/master/CHANGELOG.md'
 
   spec.add_development_dependency 'rspec', '~> 3.2'
   spec.add_dependency 'typhoeus', '~> 1.3.1'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: teamtailor
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.4
 platform: ruby
 authors:
 - André Ligné
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-03-27 00:00:00.000000000 Z
+date: 2020-04-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -48,6 +48,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -61,8 +62,16 @@ files:
 - lib/teamtailor/page_result.rb
 - lib/teamtailor/parser.rb
 - lib/teamtailor/parser/candidate.rb
+- lib/teamtailor/parser/company.rb
+- lib/teamtailor/parser/department.rb
 - lib/teamtailor/parser/job.rb
+- lib/teamtailor/parser/job_application.rb
+- lib/teamtailor/parser/location.rb
+- lib/teamtailor/parser/reject_reason.rb
+- lib/teamtailor/parser/stage.rb
 - lib/teamtailor/parser/user.rb
+- lib/teamtailor/record.rb
+- lib/teamtailor/relationship.rb
 - lib/teamtailor/request.rb
 - lib/teamtailor/version.rb
 - teamtailor.gemspec
@@ -71,8 +80,8 @@ licenses:
 - MIT
 metadata:
   homepage_uri: https://github.com/bzf/teamtailor-gem
-  source_code_uri: https://github.com/bzf/teamtailor-gem
-  changelog_uri: https://github.com/bzf/teamtailor-gem/master/CHANGELOG.md
+  source_code_uri: https://github.com/bzf/teamtailor-rb
+  changelog_uri: https://github.com/bzf/teamtailor-rb/master/CHANGELOG.md
 post_install_message: 
 rdoc_options: []
 require_paths: