glassdoor-api 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 2991d9e4fcf741922cb359f95d56ce1ab24e44a4
-  data.tar.gz: 895b858793a7b2769a02cbda7a7d0e95bfb75408
+SHA256:
+  metadata.gz: a7ba69f8d5c8dff21f0e236a38ebaa0e7a33151e5b2add6f3dc94137788b50cb
+  data.tar.gz: 1d0fdf47b82c83de624ea6d2398f23ed011c6ee1c79ddcfff71a27464e32fb25
 SHA512:
-  metadata.gz: a55935b00063d47b33287d9fb36b6afd493ca6ddd5f6642ec3a0c204147f030b756e71541cc5b3c8fcf0e4c9f5921f056ec30854fa39d2b8f576785e5dd88294
-  data.tar.gz: 96923436400c55cc052b7d8f642943c605e575965ad70adaed0f1c324b6743c8255b64901fd11ec2b469426c2b8eaf74bcebcfaa6bfec993b2f1325d81fd5ed2
+  metadata.gz: d4fa2de84ee0af5b7d334cbd5f74c2dcfdd56e59d6e7133e117ea6159502f6d5f9420ee78e80e1b6431a27d7419323f0954ba512843e6e0296b291f40a0c522a
+  data.tar.gz: 8c60f5316e5d9e7d0ade834c2f39f86083dfb480db903b75f29d2ecbb59b7769d566f2215ac356f43aa00ca6b646c4f755e1b7deb0f3f0da9746fee98a4034da

data/README.md

@@ -1,8 +1,6 @@
 # Glassdoor::Api
 
-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/glassdoor/api`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+This is an unofficial gem to utilize Glassdoor's API.
 
 ## Installation
 
@@ -20,9 +18,27 @@ Or install it yourself as:
 
     $ gem install glassdoor-api
 
-## Usage
+## Setup
 
-TODO: Write usage instructions here
+1. Require the gem with
+```ruby
+require 'glassdoor'
+```
+2. Visit the [Glassdoor API page](https://www.glassdoor.com/developer/register_input.htm) and register for an API key.
+3. You will receive an email with your partner id and partner key
+4. Setup configuration with:
+```ruby
+config = Glassdoor.configuration
+config.partner_id = "your-partner-id"
+config.partner_key = "your-partner-key"
+```
+
+## Searching for a Company
+
+1. Search using title
+```ruby
+Glassdoor::Clients::Company.find_by_title("apple")
+```
 
 ## Development
 

data/lib/glassdoor/clients/company.rb

@@ -1,6 +1,15 @@
 module Glassdoor
   module Clients
     module Company
+      def self.search_by_title(title, page = 1, per_page = 20)
+        api = Glassdoor::Utils::Api.instance
+        hash  = api.gd_get(action: 'employers', q: title, pn: page, ps: per_page)
+
+        hash['employers'].map do |company|
+          Models::Company.new(company)
+        end
+      end
+
       def self.find_by_title(title)
         api = Glassdoor::Utils::Api.instance
         hash  = api.gd_get(action: 'employers', q: title)

data/lib/glassdoor/config.rb

@@ -1,6 +1,6 @@
 module Glassdoor
   class Config
-    attr_accessor :partner_id, :partner_key, :base_uri, :time_out, :format, :version_api
+    attr_accessor :partner_id, :partner_key, :base_url, :time_out, :format, :version_api
 
     def initialize
       set_defaults
@@ -22,7 +22,7 @@ module Glassdoor
     def set_defaults
       @partner_id           = 'ruby-glassdoor-api'  # Get a developer key at https://www.glassdoor.com/api/index.htm
       @partner_key          = 'ruby-glassdoor-api'
-      @base_uri             = 'http://api.glassdoor.com/api/api.htm'
+      @base_url             = 'https://api.glassdoor.com/api/api.htm'
       @time_out             = 5
       @format               = 'json'
       @version_api          = '1'

data/lib/glassdoor/models/company.rb

@@ -1,7 +1,7 @@
 module Glassdoor
   module Models
     class Company
-      attr_accessor :id, :name, :url,  :industry, :logo,
+      attr_reader :id, :name, :url, :industry, :sector_name, :logo,
                     :overall_rating, :culture_and_values_rating, :senior_leadership_rating,
                     :compensation_and_benefits_rating, :career_opportunities_rating,
                     :work_life_balance_rating, :recommend_to_friend_rating, :review
@@ -12,6 +12,7 @@ module Glassdoor
         @name                             = args['name'] || ''
         @url                              = args['website'] || ''
         @industry                         = args['industry'] || ''
+        @sector_name                      = args['sectorName'] || ''
         @overall_rating                   = args['overallRating'].to_f
         @culture_and_values_rating        = args['cultureAndValuesRating'].to_f
         @senior_leadership_rating         = args['seniorLeadershipRating'].to_f

data/lib/glassdoor/models/review.rb

@@ -1,7 +1,7 @@
 module Glassdoor
   module Models
     class Review
-      attr_accessor :id, :date, :job_title,  :location, :logo,
+      attr_reader :id, :date, :job_title,  :location, :logo,
 
                     :headline, :pros, :cons, :overall
 

data/lib/glassdoor/utils/api.rb

@@ -1,50 +1,43 @@
-require 'httparty'
+require 'rest-client'
+require 'addressable'
 
 module Glassdoor
   module Utils
-    class RequestError < Exception; end
-    class ResponseUnsuccessError < Exception; end
+    class RequestError < StandardError; end
+    class ResponseUnsuccessError < StandardError; end
 
     class Api
-      include HTTParty
-
-      base_uri 'http://api.glassdoor.com/api/api.htm'
-
       def self.instance
-        api = Glassdoor::Utils::Api.new
-        api
+        Glassdoor::Utils::Api.new
       end
 
       def initialize
-        self.class.default_params 't.p' => Glassdoor.configuration.partner_id,
-                                  't.k' => Glassdoor.configuration.partner_key,
-                                  userip: '0.0.0.0',
-                                  useragent: '',
-                                  v: Glassdoor.configuration.version_api,
-                                  format: 'json',
-                                  page: ''
-
-
-        self.class.default_timeout Glassdoor.configuration.time_out
+        @default_params  =  {
+          't.p' => Glassdoor.configuration.partner_id,
+          't.k' => Glassdoor.configuration.partner_key,
+          userip: '0.0.0.0',
+          useragent: '',
+          v: Glassdoor.configuration.version_api,
+          format: 'json',
+          page: ''
+        }
       end
 
       def gd_get(options={})
-        self.class.base_uri Glassdoor.configuration.base_uri
-        options = options.merge(self.class.default_params)
-        response = self.class.get('', query: options)
-        validate_response(response)
+        uri = Addressable::URI.parse(Glassdoor.configuration.base_url)
+        uri.query_values = options.merge(@default_params)
+
+        response = RestClient::Request.execute(method: :get, url: uri.to_s, timeout: Glassdoor.configuration.time_out)
+        response_hash = MultiJson.load(response)
+        validate_response(response_hash)
       end
 
-      def validate_response(response)
-        if response.code == 200
-          hash = JSON.parse(response.body)
-          unless hash['success']
-            raise ResponseUnsuccessError.new hash['status']
-          end
-          hash['response']
-        else
-          raise RequestError.new response.message
+      def validate_response(response_hash)
+        unless response_hash['success']
+          raise ResponseUnsuccessError.new response_hash['status']
         end
+
+        response_hash['response']
       end
     end
   end

data/lib/glassdoor/version.rb

@@ -1,3 +1,3 @@
 module Glassdoor
-  VERSION = "0.1.3"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: glassdoor-api
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Ilya Bazylchuk
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-11 00:00:00.000000000 Z
+date: 2020-05-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.9'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.9'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -81,39 +81,47 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: httparty
+  name: rest-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.11'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.11'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: json
+  name: addressable
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.7'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.7.7
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.7.7
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Wrapper for Glassdoor API
 email:
 - ilya.bazylchuk@gmail.com
@@ -151,8 +159,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Wrapper for Glassdoor API