hawatel_search_jobs 0.2.1 → 0.3.0

data/.travis.yml

@@ -1,7 +1,7 @@
-language: ruby
-rvm:
-  - 2.0.0
-  - 2.1.0
-  - 2.2.1
-  - 2.2.4
+language: ruby
+rvm:
+  - 2.2.2
+  - 2.2.5
+  - 2.3.0
+  - 2.3.1
 before_install: gem install bundler -v 1.10.6

data/CODE_OF_CONDUCT.md

@@ -1,13 +1,13 @@
-# Contributor Code of Conduct
-
-As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
-
-We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
-
-Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
-
-Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
-
-This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/CONTRIBUTING.md

@@ -1,70 +1,70 @@
-# Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/Hawatel/hawatel_search_jobs. This project is intended to be a safe, welcoming space for collaboration, and contributors.
-
-1. [Fork](https://help.github.com/articles/fork-a-repo/) the project, clone your fork,
-   and configure the remotes:
-
-   ```sh
-   # Clone your fork of the repo into the current directory
-   git clone https://github.com/<your-username>/hawatel_search_jobs
-   # Navigate to the newly cloned directory
-   cd hawatel_search_jobs
-   # Assign the original repo to a remote called "upstream"
-   git remote add upstream https://github.com/Hawatel/hawatel_search_jobs
-   ```
-
-2. If you cloned a while ago, get the latest changes from upstream:
-
-   ```bash
-   git checkout master
-   git pull upstream master
-   ```
-
-3. Create a new topic branch (off of `master`) to contain your feature, change,
-   or fix.
-
-   **IMPORTANT**: Making changes in `master` is discouraged. You should always
-   keep your local `master` in sync with upstream `master` and make your
-   changes in topic branches.
-
-   ```sh
-   git checkout -b <topic-branch-name>
-   ```
-
-4. Commit your changes in logical chunks. Keep your commit messages organized,
-   with a short description in the first line and more detailed information on
-   the following lines. Feel free to use Git's
-   [interactive rebase](https://help.github.com/articles/about-git-rebase/)
-   feature to tidy up your commits before making them public.
-
-5. Make sure all the tests are still passing.
-
-   ```sh
-   rake
-   ```
-
-6. Push your topic branch up to your fork:
-
-   ```sh
-   git push origin <topic-branch-name>
-   ```
-
-7. [Open a Pull Request](https://help.github.com/articles/using-pull-requests/)
-    with a clear title and description.
-
-8. If you haven't updated your pull request for a while, you should consider
-   rebasing on master and resolving any conflicts.
-
-   **IMPORTANT**: _Never ever_ merge upstream `master` into your branches. You
-   should always `git rebase` on `master` to bring your changes up to date when
-   necessary.
-
-   ```sh
-   git checkout master
-   git pull upstream master
-   git checkout <your-topic-branch>
-   git rebase master
-   ```
-
+# Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/Hawatel/hawatel_search_jobs. This project is intended to be a safe, welcoming space for collaboration, and contributors.
+
+1. [Fork](https://help.github.com/articles/fork-a-repo/) the project, clone your fork,
+   and configure the remotes:
+
+   ```sh
+   # Clone your fork of the repo into the current directory
+   git clone https://github.com/<your-username>/hawatel_search_jobs
+   # Navigate to the newly cloned directory
+   cd hawatel_search_jobs
+   # Assign the original repo to a remote called "upstream"
+   git remote add upstream https://github.com/Hawatel/hawatel_search_jobs
+   ```
+
+2. If you cloned a while ago, get the latest changes from upstream:
+
+   ```bash
+   git checkout master
+   git pull upstream master
+   ```
+
+3. Create a new topic branch (off of `master`) to contain your feature, change,
+   or fix.
+
+   **IMPORTANT**: Making changes in `master` is discouraged. You should always
+   keep your local `master` in sync with upstream `master` and make your
+   changes in topic branches.
+
+   ```sh
+   git checkout -b <topic-branch-name>
+   ```
+
+4. Commit your changes in logical chunks. Keep your commit messages organized,
+   with a short description in the first line and more detailed information on
+   the following lines. Feel free to use Git's
+   [interactive rebase](https://help.github.com/articles/about-git-rebase/)
+   feature to tidy up your commits before making them public.
+
+5. Make sure all the tests are still passing.
+
+   ```sh
+   rake
+   ```
+
+6. Push your topic branch up to your fork:
+
+   ```sh
+   git push origin <topic-branch-name>
+   ```
+
+7. [Open a Pull Request](https://help.github.com/articles/using-pull-requests/)
+    with a clear title and description.
+
+8. If you haven't updated your pull request for a while, you should consider
+   rebasing on master and resolving any conflicts.
+
+   **IMPORTANT**: _Never ever_ merge upstream `master` into your branches. You
+   should always `git rebase` on `master` to bring your changes up to date when
+   necessary.
+
+   ```sh
+   git checkout master
+   git pull upstream master
+   git checkout <your-topic-branch>
+   git rebase master
+   ```
+
 Thank you for your contributions!

data/Gemfile

@@ -1,4 +1,4 @@
-source 'https://rubygems.org'
-
-# Specify your gem's dependencies in hawatel_search_jobs.gemspec
-gemspec
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in hawatel_search_jobs.gemspec
+gemspec

data/LICENSE.txt

@@ -1,21 +1,21 @@
-The MIT License (MIT)
-
-Copyright (c) 2016 Daniel Iwaniuk
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.
+The MIT License (MIT)
+
+Copyright (c) 2016 Daniel Iwaniuk
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -6,7 +6,7 @@
 
 # Hawatel Search Jobs
 
-Hawatel_search_jobs, it is gem which provides ease access to API from popular job websites to get current job offers. At this moment, supported backends are indeed.com, careerjet.com, xing.com, careerbuilder.com and reed.co.uk.
+Hawatel_search_jobs, it is gem which provides ease access to API from popular job websites to get current job offers. At this moment, supported backends are indeed.com, careerjet.com, xing.com, careerbuilder.com, reed.co.uk, and upwork.com.
 
 Before you can start using the gem, you need have an accounts/tokens for each portal where is required by API.
 
@@ -59,6 +59,13 @@ HawatelSearchJobs.configure do |config|
   config.careerjet[:activated]   = true
   config.careerjet[:api]         = 'public.api.careerjet.net'
   config.careerjet[:page_size]   = 25 # allowed range <1,99>
+  
+  config.upwork[:activated]           = true
+  config.upwork[:consumer_key]        = 'secret-key'
+  config.upwork[:consumer_secret]     = 'secret-key'
+  config.upwork[:oauth_token]         = 'secret-key'
+  config.upwork[:oauth_token_secret]  = 'secret-key'
+  config.upwork[:page_size]           = 25 # allowed range <1,100>
 end
 ```
 
@@ -68,6 +75,7 @@ end
  3. Reed: https://www.reed.co.uk/developers/jobseeker
  4. Careerbuilder: http://developer.careerbuilder.com
  5. Careerjet: secret-key is no needed (http://www.careerjet.com/partners/api/)
+ 6. Upwork: https://developers.upwork.com
 
 #### Get first page of job offers
 There are two ways to read the returned job offers.
@@ -81,6 +89,7 @@ There are two ways to read the returned job offers.
     p result[:reed]
     p result[:careerbuilder]
     p result[:careerjet]
+    p result[:upwork]
 ```
 
 + Access to the instance variable jobs_table.

data/Rakefile

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

data/hawatel_search_jobs.gemspec

@@ -1,32 +1,33 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'hawatel_search_jobs/version'
-
-Gem::Specification.new do |spec|
-  spec.name          = "hawatel_search_jobs"
-  spec.version       = HawatelSearchJobs::VERSION
-  spec.authors       = ['Przemyslaw Mantaj','Daniel Iwaniuk']
-  spec.email         = ['przemyslaw.mantaj@hawatel.com', 'daniel.iwaniuk@hawatel.com']
-
-  spec.summary       = %q{Hawatel_search_jobs, it is gem which provides ease access to API from popular job websites to get current job offers.}
-  spec.description   = %q{Hawatel_search_jobs, it is gem which provides ease access to API from popular job websites
-                         to get current job offers.  At this moment, supported backends are indeed.com, careerjet.com,
-                         xing.com, careerbuilder.com and reed.co.uk.}
-  spec.homepage      = "http://github.com/Hawatel/hawatel_search_jobs"
-  spec.license       = "MIT"
-
-  spec.files         = `git ls-files`.split($/)
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
-
-  spec.required_ruby_version = '>= 2.0.0'
-
-  spec.add_runtime_dependency 'xing_api'
-  spec.add_runtime_dependency 'activesupport'
-
-  spec.add_development_dependency "bundler", "~> 1.10"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec"
-end
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'hawatel_search_jobs/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "hawatel_search_jobs"
+  spec.version       = HawatelSearchJobs::VERSION
+  spec.authors       = ['Przemyslaw Mantaj','Daniel Iwaniuk']
+  spec.email         = ['przemyslaw.mantaj@hawatel.com', 'daniel.iwaniuk@hawatel.com']
+
+  spec.summary       = %q{Hawatel_search_jobs, it is gem which provides ease access to API from popular job websites to get current job offers.}
+  spec.description   = %q{Hawatel_search_jobs, it is gem which provides ease access to API from popular job websites
+                         to get current job offers.  At this moment, supported backends are indeed.com, careerjet.com,
+                         xing.com, careerbuilder.com, reed.co.uk, and upwork.com.}
+  spec.homepage      = "http://github.com/Hawatel/hawatel_search_jobs"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = '>= 2.2.2'
+
+  spec.add_runtime_dependency 'xing_api'
+  spec.add_runtime_dependency 'upwork-api'
+  spec.add_runtime_dependency 'activesupport'
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+end

data/lib/hawatel_search_jobs.rb

@@ -7,7 +7,7 @@ module HawatelSearchJobs
   require 'hawatel_search_jobs/client'
 
   class << self
-    attr_accessor :indeed, :xing, :reed, :careerbuilder, :careerjet
+    attr_accessor :indeed, :xing, :reed, :careerbuilder, :careerjet, :upwork
 
     ##
     # How to configure APIs go to example {HawatelSearchJobs::Client#search_jobs}
@@ -17,6 +17,7 @@ module HawatelSearchJobs
       @reed           = default_reed(Hash.new)
       @careerbuilder  = default_careerbuilder(Hash.new)
       @careerjet      = default_careerjet(Hash.new)
+      @upwork         = default_upwork(Hash.new)
       yield self if block_given?
       true
     end
@@ -59,6 +60,16 @@ module HawatelSearchJobs
       settings[:version]    = 'v2'
       return settings
     end
+
+    def default_upwork(settings)
+      settings[:activated]          = false
+      settings[:consumer_key]       = ''
+      settings[:consumer_secret]    = ''
+      settings[:oauth_token]        = ''
+      settings[:oauth_token_secret] = ''
+      return settings
+    end
+
   end
 
 end

data/lib/hawatel_search_jobs/api.rb

@@ -1,9 +1,10 @@
-module HawatelSearchJobs
-  module Api
-    require 'hawatel_search_jobs/api/indeed'
-    require 'hawatel_search_jobs/api/reed'
-    require 'hawatel_search_jobs/api/xing'
-    require 'hawatel_search_jobs/api/careerbuilder'
-    require 'hawatel_search_jobs/api/careerjet'
-  end
-end
+module HawatelSearchJobs
+  module Api
+    require 'hawatel_search_jobs/api/indeed'
+    require 'hawatel_search_jobs/api/reed'
+    require 'hawatel_search_jobs/api/xing'
+    require 'hawatel_search_jobs/api/careerbuilder'
+    require 'hawatel_search_jobs/api/careerjet'
+    require 'hawatel_search_jobs/api/upwork'
+  end
+end

data/lib/hawatel_search_jobs/api/upwork.rb

@@ -0,0 +1,150 @@
+require 'upwork/api'
+require 'upwork/api/routers/jobs/search'
+
+module HawatelSearchJobs::Api
+  module Upwork
+    class << self
+      include HawatelSearchJobs::Helpers::Base
+
+      DEFAULT = {
+          :keywords => '',
+          :location => '',
+          :company  => ''
+      }
+
+      RESULT_LIMIT = 25
+
+      # @see https://github.com/upwork/ruby-upwork
+      # Search jobs based on specified keywords
+      #
+      # @param args [Hash]
+      # @option args :query [Hash] search criteria
+      #   - *:keywords* (String )
+      # @option args :setting [Hash] @see https://developers.upwork.com/?lang=python#authentication_oauth-10
+      #   - *:consumer_key* (String) - consumer key, required for authentication
+      #   - *:consumer_secret* (String) - consumer secret, required for authentication
+      #
+      # @example
+      #   search(:settings => HawatelSearchJobs.upwork,:query => {:keywords => 'ruby'})
+      #
+      # @return [Hash<OpenStruct>]
+      def search(args)
+        args[:query] = DEFAULT.merge(args[:query]) if args[:query]
+        keywords = args[:query][:keywords]
+        page_size = args[:settings][:page_size].to_s.empty? ? RESULT_LIMIT : args[:settings][:page_size].to_i
+        page_size = RESULT_LIMIT if page_size <= 0 || page_size > 100
+
+        result = send_request({:keywords => keywords, :offset => 0, :settings => args[:settings], :page_size => page_size})
+
+        if result['error']
+          error_handling(result)
+        else
+          set_attributes({:result => result, :page => 0, :keywords => keywords, :page_size => page_size})
+        end
+      end
+
+      # Show next page of results
+      #
+      # @param args [Hash]
+      # @option page [Integer] page numer (default 0)
+      # @option query_key [String] keywords from last query
+      #
+      # @example
+      #   page({:query_key => result.key, :page => 2}
+      #
+      # @return [Hash<OpenStruct>]
+      def page(args)
+        args[:page] = 0 if args[:page].nil?
+        page_size = args[:settings][:page_size].to_s.empty? ? RESULT_LIMIT : args[:settings][:page_size].to_i
+        page_size = RESULT_LIMIT if page_size <= 0 || page_size > 100
+
+        result = send_request({:keywords => args[:query_key], :offset => args[:page]*page_size, :settings => args[:settings], :page_size => page_size})
+
+        if result['error']
+          error_handling(result)
+        else
+          set_attributes({:result => result, :page => args[:page], :keywords => args[:query_key], :page_size => page_size})
+        end
+      end
+
+      private
+      # Call Upwork client request
+      #
+      # @param args [Hash]
+      # @option settings [Hash] authentication attributes
+      # @option keywords [String] keywords for query
+      #
+      # @return [Hash<OpenStruct>]
+      def send_request(args)
+        @client = ::Upwork::Api::Client.new(set_settings(args[:settings])) if @client.nil?
+        @jobs_client = ::Upwork::Api::Routers::Jobs::Search.new(@client) if @jobs_client.nil?
+
+        @jobs_client.find({'q' => args[:keywords], 'sort' => 'create_time desc', 'paging' => "#{args[:offset]};#{args[:page_size]}"})
+      rescue => e
+        {:code => "500", :msg => "Internal error #{e}" }
+      end
+
+      # Build final result - set required attributes and return openstruct object
+      #
+      def set_attributes(args)
+        total = args[:result]['paging']['total'] ? args[:result]['paging']['total'].to_i : 0
+        # "paging"=>{"offset"=>0, "count"=>100, "total"=>886}
+        attributes = Hash.new
+        attributes[:totalResults] = total
+        attributes[:code]  = '200'
+        attributes[:msg]   = "OK"
+        attributes[:page]  = args[:page]
+        attributes[:last]  = total / args[:page_size]
+        attributes[:key]   = args[:keywords]
+        attributes[:jobs]  = parse_raw_data(args[:result])
+        OpenStruct.new(attributes)
+      end
+
+      # Build jobs array with specified attributes
+      # @note Format of response:
+      #   {"server_time"=>1468313522, "auth_user"=>{"first_name"=>"xyz", "last_name"=>"xyz", "timezone"=>"Europe/Prague", "timezone_offset"=>"7200"},
+      #   "profile_access"=>"public,odesk", "jobs"=>[{"id"=>"~01dde83fce38b65f90", "title"=>"Node.js & Ruby on Rails developer needed", "snippet"=>"The app is build in RoR,
+      #   for chat we use Node.js and WebRTC for video\n\n1. Deploy to Digital Ocean with SSL", "category2"=>"Web, Mobile & Software Dev", "subcategory2"=>"Web Development",
+      #   "skills"=>["node.js", "redis", "ruby-on-rails"], "job_type"=>"Hourly", "budget"=>0, "duration"=>"Less than 1 week", "workload"=>"10-30 hrs/week",
+      #   "job_status"=>"Open", "date_created"=>"2016-06-30T15:14:03+0000", "url"=>"http://www.upwork.com/jobs/~01dde83fce38b65f90", "client"=>{"country"=>"Ireland", "feedback"=>5,
+      #   "reviews_count"=>16, "jobs_posted"=>62, "past_hires"=>53, "payment_verification_status"=>"VERIFIED"}}], paging"=>{"offset"=>0, "count"=>100, "total"=>886}
+      # @return [Array<OpenStruct>]
+      def parse_raw_data(result)
+        jobs = Array.new
+        return jobs if result['jobs'].to_s.empty?
+        result['jobs'].each do |offer|
+          job = Hash.new
+          job[:jobtitle] = offer['title']
+          job[:location] = (offer['client'] && offer['client']['country']) ? offer['client']['country'] : nil
+          job[:company]  = 'Upwork'
+          job[:date]     = convert_date_to_format(offer['date_created'], '%d/%m/%y')
+          job[:url]      = offer['url']
+          job = convert_empty_to_nil(job)
+          jobs << OpenStruct.new(job)
+        end
+        return jobs
+      end
+
+      # Set settings for UpworkApi client
+      #
+      # @param args [Hash]
+      def set_settings(args)
+        ::Upwork::Api::Config.new({
+          'consumer_key'    => args[:consumer_key],
+          'consumer_secret' => args[:consumer_secret],
+          'access_token'     => args[:oauth_token],
+          'access_secret' => args[:oauth_token_secret]
+        })
+      end
+
+      def error_handling(result)
+        if result['error']['status'] && result['error']['message']
+          OpenStruct.new({:code => result['error']['status'].to_i, :msg => result['error']['message']})
+        else
+          OpenStruct.new({:code => 501, :msg => 'incorrect settings'})
+        end
+      end
+
+    end
+  end
+end