workable 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1918a3c5a23e3c42973eed949f0b0cc3ba83c613
-  data.tar.gz: 307220a59d69533df3446a11c216f72a8748be8a
+  metadata.gz: f79182d801ebc90eb4f72ff018f5963b67d6e619
+  data.tar.gz: 84d6252a9b5f2cbe24254b0bea3997908c77188e
 SHA512:
-  metadata.gz: 2fd937d0071f53b9c2df9735cd376d774abe397d2565ee0a12e13cb89c2b0fbeb77e7d2f802e83be0aa69d25bcc775ca964df002982f697b2e538ed99f8288f6
-  data.tar.gz: 80671b951b7f0a01bb0c00fd5bff54fa2e209358c4dbeb2b6ea06ea0946829ba63cdebc3319d56a1bf2daa2016133befdfc53b1d58d6caaae936e5dd0dad12e7
+  metadata.gz: bc72c0fbb34291527fd66ebdce1e02c53edd6af4f040989d9f0207e8b0a09b7582c728e8d4f5f904956930b50d279ade62cc97da3419b5219ccee3ace483cdb9
+  data.tar.gz: 599d72ac71fa533f05f4ad8d4ad041a50c5c413c923f84267a49d219e9c4e2364b4fe3a5ab94b872a7c74a8a8f983d32d13366031b85a9e790a6e2c7d7b444a8

data/.travis.yml

@@ -3,15 +3,17 @@ sudo: false
 cache: bundler
 
 rvm:
-  - 2.1
-  - 2.2
+  - 2.1.10
+  - 2.2.7
+  - 2.3.4
+  - 2.4.1
   - jruby-head
-  - rbx-2
   - ruby-head
 
+# https://github.com/travis-ci/travis-ci/issues/5861
+before_install:
+  - gem install bundler
+  - gem update bundler
+
 notifications:
   email: false
-
-matrix:
-  allow_failures:
-    - rvm: rbx-2

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 2.1.0
+
+Date: 2017-06-19
+
+- `application_form` endpoint handler [#11](https://github.com/emq/workable/pull/11) (@klaszcze)
+
 ## 2.0.0
 
 Date: 2015-11-14

data/README.md

@@ -40,6 +40,16 @@ client = Workable::Client.new(api_key: 'api_key', subdomain: 'your_subdomain')
 # takes optional phase argument (string): 'published' (default), 'draft', 'closed' or 'archived'
 client.jobs # => Workable::Collection
 
+# Workable::Collection example
+jobs = client.jobs
+loop do
+  jobs.each do |job|
+    # Do something with the job
+  end
+  break unless jobs.next_page?
+  jobs = jobs.fetch_next_page
+end
+
 shortcode = client.jobs.first["shortcode"]
 
 # API queries are not cached (at all) - it's up to you to cache results one way or another
@@ -48,6 +58,7 @@ client.stages     # => Array of hashes
 client.recruiters # => Array of hashes
 client.job_details(shortcode)    # => Hash
 client.job_questions(shortcode)  # => Array of hashes
+client.job_application_form(shortcode) # => Hash
 client.job_candidates(shortcode, :stage => stage_slug, :limit => 100) # => Array of hashes:
 #   if given stage limits to given stage
 #   if given limit lists the last `limit` added candidates
@@ -60,7 +71,7 @@ client.create_job_candidate(candidate, shortcode, stage_slug) # => Hash (stage_s
 # Possible errors (each one inherits from Workable::Errors::WorkableError)
 Workable::Errors::InvalidConfiguration # missing api_key / subdomain
 Workable::Errors::NotAuthorized   # wrong api key
-Workable::Errors::InvalidResponse # something when wrong during the request?
+Workable::Errors::InvalidResponse # something went wrong during the request?
 Workable::Errors::NotFound        # 404 from workable
 Workable::Errors::RequestToLong   # When the requested result takes to long to calculate, try limiting your query
 ```

data/lib/workable/client.rb

@@ -78,6 +78,12 @@ module Workable
       @transform_to.apply(:question, get_request("jobs/#{shortcode}/questions")['questions'])
     end
 
+    # application form questions for job
+    # @param shortcode [String] job short code
+    def job_application_form(shortcode)
+      @transform_to.apply(:question, get_request("jobs/#{shortcode}/application_form"))
+    end
+
     # return a collection of job's members
     # @param shortcode [String] job short code
     def job_members(shortcode)

data/lib/workable/version.rb

@@ -1,3 +1,3 @@
 module Workable
-  VERSION = '2.0.0'
+  VERSION = '2.1.0'
 end

data/spec/fixtures.rb

@@ -29,6 +29,10 @@ def job_questions_json_fixture
   read_fixture 'job_questions.json'
 end
 
+def job_application_form_fixture
+  read_fixture 'job_application_form.json'
+end
+
 def recruiters_json_fixture
   read_fixture 'recruiters.json'
 end

data/spec/fixtures/job_application_form.json

@@ -0,0 +1,98 @@
+{
+  "form_fields": [
+    {
+      "key": "phone",
+      "label": "Phone",
+      "type": "string",
+      "required": true
+    },
+    {
+      "key": "experience",
+      "label": "Experience",
+      "type": "complex",
+      "multiple": true,
+      "required": false,
+      "fields": [
+        {
+          "key": "title",
+          "label": "Title",
+          "type": "string",
+          "required": true
+        },
+        {
+          "key": "company",
+          "label": "Company",
+          "type": "string",
+          "required": false
+        },
+        {
+          "key": "summary",
+          "label": "Summary",
+          "type": "free_text",
+          "required": false
+        },
+        {
+          "key": "current",
+          "label": "I currently work here",
+          "type": "boolean",
+          "required": true
+        }
+      ]
+    },
+    {
+      "key": "summary",
+      "label": "Summary",
+      "type": "free_text",
+      "required": false
+    },
+    {
+      "key": "resume",
+      "label": "Resume",
+      "type": "file",
+      "supported_file_types": [
+        "pdf",
+        "doc",
+        "docx",
+        "odt",
+        "rtf",
+        "html",
+        "htm",
+        "txt"
+      ],
+      "max_file_size": 5242880,
+      "required": false
+    }
+  ],
+  "questions": [
+    {
+      "id": "2128d717",
+      "body": "Explain one aspect of this role you believe you will excel at.",
+      "type": "free_text"
+    },
+    {
+      "id": "3399e6cd",
+      "body": "How many years administrative experience do you have?",
+      "type": "multiple_choice",
+      "single_answer": true,
+      "choices": [
+        {
+          "id": "3049114a",
+          "body": "0-3 years"
+        },
+        {
+          "id": "29406296",
+          "body": "3-5 years"
+        },
+        {
+          "id": "1e477229",
+          "body": "Over 5 years"
+        }
+      ]
+    },
+    {
+      "id": "1d3f348f",
+      "body": "Intermediate or above proficiency with MS Office?",
+      "type": "boolean"
+    }
+  ]
+}

data/spec/lib/workable/client_spec.rb

@@ -139,6 +139,24 @@ describe Workable::Client do
     end
   end
 
+  describe '#job_application_form' do
+    it 'returns application form for given job' do
+      stub_request(:get, 'https://www.workable.com/spi/v3/accounts/subdomain/jobs/03FF356C8B/application_form')
+        .to_return(status: 200, body: job_application_form_fixture)
+
+      form = client.job_application_form('03FF356C8B')
+      expect(form).to be_kind_of(Hash)
+      expect(form.has_key?('questions')).to eq true
+      expect(form['form_fields'][0]).to eq({
+                                            'key' => 'phone',
+                                            'label' => 'Phone',
+                                            'type' => 'string',
+                                            'required' => true
+                                           })
+
+    end
+  end
+
   describe '#job_members' do
     it "returns array of job's members" do
       stub_request(:get, 'https://www.workable.com/spi/v3/accounts/subdomain/jobs/job_slug/members')

data/workable.gemspec

@@ -22,7 +22,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.1.0'
   spec.add_development_dependency 'webmock', '~> 1.20.4'
-  spec.add_development_dependency 'coveralls', '~> 0.8.9'
-  spec.add_development_dependency 'guard', '~> 2.12'
-  spec.add_development_dependency 'guard-rspec', '~> 4.5'
+  spec.add_development_dependency 'coveralls', '~> 0.8.21'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: workable
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Rafał Wojsznis
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-14 00:00:00.000000000 Z
+date: 2017-06-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -59,42 +59,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.9
+        version: 0.8.21
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.9
-- !ruby/object:Gem::Dependency
-  name: guard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.12'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.12'
-- !ruby/object:Gem::Dependency
-  name: guard-rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.5'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.5'
+        version: 0.8.21
 description: Dead-simple Ruby API client for workable.com
 email:
 - rafal.wojsznis@gmail.com
@@ -121,6 +93,7 @@ files:
 - spec/fixtures.rb
 - spec/fixtures/about.json
 - spec/fixtures/job.json
+- spec/fixtures/job_application_form.json
 - spec/fixtures/job_candidate.json
 - spec/fixtures/job_candidates.json
 - spec/fixtures/job_questions.json
@@ -155,7 +128,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: Dead-simple Ruby API client for workable.com
@@ -163,6 +136,7 @@ test_files:
 - spec/fixtures.rb
 - spec/fixtures/about.json
 - spec/fixtures/job.json
+- spec/fixtures/job_application_form.json
 - spec/fixtures/job_candidate.json
 - spec/fixtures/job_candidates.json
 - spec/fixtures/job_questions.json