teamtailor 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ebfcfeb03d901b4ce684049c447631262ce8b45a8934adf5546c02e13116e933
-  data.tar.gz: 9de739e137ac1a687fac69fecb7d5c9a9ac6c76aaea518965a02f14bbe53fc1d
+  metadata.gz: c9464bec7bd58b5a5b47dc4cd5fd2aa91710f82602f658d4a1981cff33d42bc1
+  data.tar.gz: f1e218de0ce3dd7ebb78ebdd29c44ad2bfb49680b226186a18b5f18e23d2c654
 SHA512:
-  metadata.gz: 98958cee29aa6ab5372bb36b16f4b9ab8184974b9937c62115eac8911a02003b8fa5310ed87e2f8b6db138d072f01905db528234b9066f1a247733c34068bb7f
-  data.tar.gz: d2c550d684dc760746cf318b834736883471a82f085bb9b8b13417ce35db57ac03ab3a856d49110b17c6866eb9cbb470ef5678c635d536f368ddb4edc0f2ec12
+  metadata.gz: db6d877077e001925903a29694918110f02c85bdb3e3c10bc80df415bf5f9b0e463e2f606380f9c26f391e49ea0f6cb86416989afe00df4883df335fac947794
+  data.tar.gz: a27532d72dd0cfd872392af29ff3e81665a1fd61ff27f065801f815fc14b2928d72950e5cef3b14e27fd058308faaba2afd5ed1285c4c67ada6826599a841e39

data/Gemfile

@@ -1,7 +1,15 @@
-source "https://rubygems.org"
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
 
 # Specify your gem's dependencies in teamtailor.gemspec
 gemspec
 
-gem "rake", "~> 12.0"
-gem "rspec", "~> 3.0"
+gem 'rake', '~> 12.0'
+
+group :test do
+  gem 'rspec', '~> 3.0'
+  gem 'rubocop'
+  gem 'webmock', '~> 3.4', '>= 3.4.2'
+  gem 'simplecov', require: false
+end

data/Gemfile.lock

@@ -2,12 +2,30 @@ PATH
   remote: .
   specs:
     teamtailor (0.1.0)
+      typhoeus (~> 1.3.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    ast (2.4.0)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
     diff-lcs (1.3)
+    docile (1.3.2)
+    ethon (0.12.0)
+      ffi (>= 1.3.0)
+    ffi (1.12.2)
+    hashdiff (1.0.1)
+    jaro_winkler (1.5.4)
+    parallel (1.19.1)
+    parser (2.7.0.5)
+      ast (~> 2.4.0)
+    public_suffix (4.0.3)
+    rainbow (3.0.0)
     rake (12.3.3)
+    rexml (3.2.4)
     rspec (3.9.0)
       rspec-core (~> 3.9.0)
       rspec-expectations (~> 3.9.0)
@@ -21,6 +39,27 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
     rspec-support (3.9.2)
+    rubocop (0.80.1)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      rexml
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    ruby-progressbar (1.10.1)
+    safe_yaml (1.0.5)
+    simplecov (0.18.5)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+    simplecov-html (0.12.2)
+    typhoeus (1.3.1)
+      ethon (>= 0.9.0)
+    unicode-display_width (1.6.1)
+    webmock (3.8.3)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
 
 PLATFORMS
   ruby
@@ -28,7 +67,10 @@ PLATFORMS
 DEPENDENCIES
   rake (~> 12.0)
   rspec (~> 3.0)
+  rubocop
+  simplecov
   teamtailor!
+  webmock (~> 3.4, >= 3.4.2)
 
 BUNDLED WITH
    2.1.2

data/README.md

@@ -1,8 +1,12 @@
 # Teamtailor
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/teamtailor`. To experiment with that code, run `bin/console` for an interactive prompt.
+[![Gem Version](https://badge.fury.io/rb/teamtailor.svg)](https://badge.fury.io/rb/teamtailor)
+
+The `teamtailor` gem helps Ruby developers interact with their Teamtailor
+account, using classes that wrap the [Teamtailor API][teamtailor-api].
+
+[teamtailor-api]: https://docs.teamtailor.com/
 
-TODO: Delete this and the text above, and describe your gem
 
 ## Installation
 
@@ -20,21 +24,68 @@ Or install it yourself as:
 
     $ gem install teamtailor
 
+
 ## Usage
 
-TODO: Write usage instructions here
+To use the library, you need an API key for a specific Teamtailor account, which
+you can create by signing in as an Admin in Teamtailor and generating a new
+key under _Settings_.
+
+```ruby
+@client = Teamtailor::Client.new(
+  base_url: 'https://api.teamtailor.com',
+  api_token: '<PRIVATE API KEY>',
+  api_version: 20161108
+)
+```
+
+### Pagination
+
+The gem does not automatically paginate through all the pages of an API
+endpoint is something you can do. The `#has_next_page?` method is
+helpful when knowing if there's more to fetch.
+
+To fetch all jobs, you could do something like this:
+
+```ruby
+current_page = 1
+jobs = []
+
+while (page_result = @client.jobs(page: current_page))
+  jobs.append *page_result.records
+  break unless page_result.has_next_page?
+  current_page += 1
+end
+```
+
+You can get all the titles through the `#title` method.
+
+```ruby
+irb(main):041:0> jobs.map &:title
+=> ["EmberJS Developer", "Ruby on Rails developer"]
+```
+
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run
+`rake spec` to run the tests. You can also run `bin/console` for an interactive
+prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To
+release a new version, update the version number in `version.rb`, and then run
+`bundle exec rake release`, which will create a git tag for the version, push
+git commits and tags, and push the `.gem` file to
+[rubygems.org](https://rubygems.org).
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/teamtailor.
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/bzf/teamtailor-rb.
 
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+The gem is available as open source under the terms of the [MIT
+License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -1,6 +1,8 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/bin/console

@@ -1,7 +1,8 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-require "bundler/setup"
-require "teamtailor"
+require 'bundler/setup'
+require 'teamtailor'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
@@ -10,5 +11,5 @@ require "teamtailor"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start(__FILE__)

data/lib/teamtailor/client.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require 'teamtailor/request'
+
+module Teamtailor
+  class Client
+    def initialize(base_url:, api_token:, api_version:)
+      @base_url = base_url
+      @api_token = api_token
+      @api_version = api_version
+    end
+
+    def candidates(page: 1)
+      Teamtailor::Request.new(
+        base_url: base_url,
+        api_token: api_token,
+        api_version: api_version,
+        path: '/v1/candidates',
+        params: {
+          'page[number]' => page,
+          'page[size]' => 30
+        }
+      ).call
+    end
+
+    def jobs(page: 1)
+      Teamtailor::Request.new(
+        base_url: base_url,
+        api_token: api_token,
+        api_version: api_version,
+        path: '/v1/jobs',
+        params: {
+          'page[number]' => page,
+          'page[size]' => 30
+        }
+      ).call
+    end
+
+    def users(page: 1)
+      Teamtailor::Request.new(
+        base_url: base_url,
+        api_token: api_token,
+        api_version: api_version,
+        path: '/v1/users',
+        params: {
+          'page[number]' => page,
+          'page[size]' => 30
+        }
+      ).call
+    end
+
+    private
+
+    attr_reader :base_url, :api_token, :api_version
+
+    def response_error(response)
+      Teamtailor::Error.from_response body: response.body, status: response.code
+    end
+  end
+end

data/lib/teamtailor/error.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Teamtailor
+  class Error < StandardError
+    def self.from_response(body:, status:)
+      case status
+      when 401
+        Teamtailor::UnauthorizedRequestError.new
+      when 406
+        json_response = JSON.parse(body)
+        Teamtailor::InvalidApiVersionError.new(
+          json_response.dig('errors', 'detail')
+        )
+      end
+    end
+  end
+
+  class ClientError < Error; end
+
+  class UnauthorizedRequestError < ClientError; end
+
+  class InvalidApiVersionError < ClientError; end
+
+  class JSONError < ClientError; end
+
+  class UnknownResponseTypeError < ClientError; end
+end

data/lib/teamtailor/page_result.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require 'teamtailor/parser'
+
+module Teamtailor
+  class PageResult
+    def initialize(response_body)
+      @json_response = JSON.parse(response_body)
+    end
+
+    def records
+      Teamtailor::Parser.parse json_response
+    end
+
+    def data
+      json_response.dig('data')
+    end
+
+    def page_count
+      json_response.dig('meta', 'page-count')
+    end
+
+    def record_count
+      json_response.dig('meta', 'record-count')
+    end
+
+    def next_page_url
+      json_response.dig('links', 'next')
+    end
+
+    def first_page_url
+      json_response.dig('links', 'first')
+    end
+
+    def last_page_url
+      json_response.dig('links', 'last')
+    end
+
+    def has_next_page?
+      !next_page_url.nil?
+    end
+
+    private
+
+    attr_reader :json_response
+  end
+end

data/lib/teamtailor/parser/candidate.rb

@@ -0,0 +1,31 @@
+module Teamtailor
+  class Candidate
+    def initialize(payload)
+      @payload = payload
+    end
+
+    def self.deserialize(value)
+      new(value)
+    end
+
+    def serialize
+      payload
+    end
+
+    def id
+      payload.dig('id').to_i
+    end
+
+    def connected?
+      payload.dig('attributes', 'connected')
+    end
+
+    def method_missing(m)
+      payload.dig('attributes', m.to_s.gsub('_', '-'))
+    end
+
+    private
+
+    attr_reader :payload
+  end
+end

data/lib/teamtailor/parser/job.rb

@@ -0,0 +1,31 @@
+module Teamtailor
+  class Job
+    def initialize(payload)
+      @payload = payload
+    end
+
+    def self.deserialize(value)
+      new(value)
+    end
+
+    def serialize
+      payload
+    end
+
+    def id
+      payload.dig('id').to_i
+    end
+
+    def careersite_job_url
+      payload.dig('links', 'careersite-job-url')
+    end
+
+    def method_missing(m)
+      payload.dig('attributes', m.to_s.gsub('_', '-'))
+    end
+
+    private
+
+    attr_reader :payload
+  end
+end

data/lib/teamtailor/parser/user.rb

@@ -0,0 +1,27 @@
+module Teamtailor
+  class User
+    def initialize(payload)
+      @payload = payload
+    end
+
+    def self.deserialize(value)
+      new(value)
+    end
+
+    def serialize
+      payload
+    end
+
+    def id
+      payload.dig('id').to_i
+    end
+
+    def method_missing(m)
+      payload.dig('attributes', m.to_s.gsub('_', '-'))
+    end
+
+    private
+
+    attr_reader :payload
+  end
+end

data/lib/teamtailor/parser.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require 'teamtailor/parser/candidate'
+require 'teamtailor/parser/job'
+require 'teamtailor/parser/user'
+
+module Teamtailor
+  class Parser
+    def self.parse(payload)
+      new(payload).parse
+    end
+
+    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)
+
+        else
+          raise Teamtailor::UnknownResponseTypeError.new(record&.dig('type'))
+        end
+      end
+    end
+
+    private
+
+    attr_reader :payload
+
+    def initialize(payload)
+      @payload = payload
+    end
+
+    def data
+      [payload&.dig('data')].flatten
+    end
+  end
+end

data/lib/teamtailor/request.rb

@@ -0,0 +1,48 @@
+require 'typhoeus'
+require 'json'
+
+require 'teamtailor/page_result'
+
+module Teamtailor
+  class Request
+    def initialize(base_url:, api_token:, api_version:, path:, params: {})
+      @base_url = base_url
+      @api_token = api_token
+      @api_version = api_version
+      @path = path
+      @params = params
+    end
+
+    def call
+      request = Typhoeus::Request.new(
+        "#{base_url}#{path}",
+        method: :get,
+        params: params,
+        headers: request_headers
+      )
+      response = request.run
+
+      if response.code == 200
+        Teamtailor::PageResult.new response.body
+      else
+        raise Teamtailor::Error.from_response(
+          body: response.body,
+          status: response.code
+        )
+      end
+    end
+
+    private
+
+    attr_reader :base_url, :path, :api_token, :api_version, :params
+
+    def request_headers
+      {
+        "Authorization": "Token token=#{api_token}",
+        'X-Api-Version' => api_version,
+        'User-Agent' => "teamtailor-rb v#{Teamtailor::VERSION}",
+        'Content-Type' => 'application/vnd.api+json; charset=utf-8'
+      }
+    end
+  end
+end

data/lib/teamtailor/version.rb

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

data/lib/teamtailor.rb

@@ -1,6 +1,8 @@
-require "teamtailor/version"
+# frozen_string_literal: true
+
+require 'teamtailor/error'
+require 'teamtailor/client'
+require 'teamtailor/version'
 
 module Teamtailor
-  class Error < StandardError; end
-  # Your code goes here...
 end

data/teamtailor.gemspec

@@ -1,28 +1,34 @@
+# frozen_string_literal: true
+
 require_relative 'lib/teamtailor/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "teamtailor"
+  spec.name          = 'teamtailor'
   spec.version       = Teamtailor::VERSION
-  spec.authors       = ["André Ligné"]
-  spec.email         = ["hi@andreligne.se"]
+  spec.authors       = ['André Ligné']
+  spec.email         = ['hi@andreligne.se']
 
-  spec.summary       = %q{Library for interacting with the Teamtailor API}
-  spec.homepage      = "https://github.com/bzf/teamtailor-gem"
-  spec.license       = "MIT"
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+  spec.summary       = 'Library for interacting with the Teamtailor API'
+  spec.homepage      = 'https://github.com/bzf/teamtailor-gem'
+  spec.license       = 'MIT'
+  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['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.add_development_dependency "rspec", "~> 3.2"
+  spec.add_development_dependency 'rspec', '~> 3.2'
+  spec.add_dependency 'typhoeus', '~> 1.3.1'
 
   # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  # The `git ls-files -z` loads the files in the RubyGem that have been added
+  # into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      f.match(%r{^(test|spec|features)/})
+    end
   end
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: teamtailor
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - André Ligné
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-03-24 00:00:00.000000000 Z
+date: 2020-03-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.1
 description: 
 email:
 - hi@andreligne.se
@@ -42,6 +56,14 @@ files:
 - bin/console
 - bin/setup
 - lib/teamtailor.rb
+- lib/teamtailor/client.rb
+- lib/teamtailor/error.rb
+- lib/teamtailor/page_result.rb
+- lib/teamtailor/parser.rb
+- lib/teamtailor/parser/candidate.rb
+- lib/teamtailor/parser/job.rb
+- lib/teamtailor/parser/user.rb
+- lib/teamtailor/request.rb
 - lib/teamtailor/version.rb
 - teamtailor.gemspec
 homepage: https://github.com/bzf/teamtailor-gem