teamtailor 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ca640f45eb147f4845e8f8416728ca7037d827c1e4bcb297cb7f02e15182805a
-  data.tar.gz: 89dacf02df2d3e7030ae54a700a7f85e5394930d5e773cc586ba639d4ab176fa
+  metadata.gz: 07c8094ceb5a49683e396b20080452dd127c39a0b611d4ec0f14ccaa6e53dbda
+  data.tar.gz: b6776e3f2b7d1b4d2fd6080517c1c935dbbf15f9a7d296da91a30b317f7a9270
 SHA512:
-  metadata.gz: ff38baf2344ed08916fc5f8e46f3a58ba19a7fceb335d8abd73ab8a155a769c36a8ee18ec9d94044ffe0e64a61d357680e5a933791743d4831e5b960e61f1070
-  data.tar.gz: b1cf2365d600ea53d6998faef1ef9d4ac884c63f109b16d91af58b2166e6fce817f316d53c7e026179f0ff16ef14c5695b32f9982548b8464bcc1988c6cf89e3
+  metadata.gz: 65953f45d5f008041ffb094a0584d618952dce03308b5901dfcd620679c757e287b17c516de8e142fdcb4cb01cea15effed86f996f5f12f818e485df42a900f3
+  data.tar.gz: 2cb1457ea0d20a62c6dec291ce109bea9ae0910c1335508e6b831d8fe90c148e9663b3a31c9b7fbf221eb9ca186f292af3628484683cabe65179e40b3676e1be

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## Unreleased
 
+## 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`)

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    teamtailor (0.2.0)
+    teamtailor (0.2.1)
       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

@@ -38,6 +38,20 @@ module Teamtailor
       ).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, include: [])
       Teamtailor::Request.new(
         base_url: base_url,

data/lib/teamtailor/parser.rb

@@ -4,6 +4,7 @@ require 'teamtailor/relationship'
 require 'teamtailor/parser/candidate'
 require 'teamtailor/parser/job'
 require 'teamtailor/parser/user'
+require 'teamtailor/parser/job_application'
 
 module Teamtailor
   class Parser
@@ -17,6 +18,7 @@ module Teamtailor
         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)
 
         else
           raise Teamtailor::UnknownResponseTypeError, record&.dig('type')

data/lib/teamtailor/parser/job_application.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'teamtailor/record'
+
+module Teamtailor
+  class JobApplication < Record
+    def self.deserialize(value)
+      new(value)
+    end
+
+    def serialize
+      data
+    end
+
+    def id
+      data.dig('id').to_i
+    end
+  end
+end

data/lib/teamtailor/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: teamtailor
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - André Ligné
@@ -63,6 +63,7 @@ files:
 - lib/teamtailor/parser.rb
 - lib/teamtailor/parser/candidate.rb
 - lib/teamtailor/parser/job.rb
+- lib/teamtailor/parser/job_application.rb
 - lib/teamtailor/parser/user.rb
 - lib/teamtailor/record.rb
 - lib/teamtailor/relationship.rb