proz 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8ed793d72687e277deb02dbf64b4e873ac7e88be
-  data.tar.gz: 86ba561b9085583f1abee5722d86f8eef7c6b370
+  metadata.gz: 17ebaa46f749ca43d271be89e94c6cd76d460317
+  data.tar.gz: 2df566c85c7b2edc8583d22885b10c4d91799a8d
 SHA512:
-  metadata.gz: 9c87e3088e2807a0bc6c85755fc11911ef27ea1a53ff9212c04514008327b0eb131668f10d89a9ca4a493d04b4bdf10a2a41bb7daaea4cac3fa2ac715c9b2ca2
-  data.tar.gz: a9487d9fba83d3855ce2de8b17292f9626410a75b0543aac61c7a1447b03a0de154da374fa524db1e670886d1b795015158241b98422ae2ed089e953b3cea85c
+  metadata.gz: 842518c039c3c15cc95641102305ddd14b122db648f5966e2bf16fcde045d96a2a9254b1958a8852eb37ffa6b6e7a501c68cc0e550e71b2d8689fb85f8d0a71f
+  data.tar.gz: 20e25a4fd5ec07c6821a317d40ad25fd2b1822428bc519d0b89815bc59a24b9affff3fb7c2020b405daf590c315a14bd664bebef483052a9615763552f628a7e

data/lib/proz/freelancer.rb

@@ -11,11 +11,32 @@ module Proz
     end
 
     def freelancer
-      @freelancer ||= self.class.get("/freelancer/#{uuid}", headers: { 'X-Proz-API-Key' => key})['data']
+      case
+      when freelancer_response.has_key?('error')
+        if freelancer_response['error'].eql?('invalid_api_key')
+          raise 'Invalid API Key'
+        else
+          raise 'Invalid Request'
+        end
+      when freelancer_response.has_key?('error_messages')
+        if freelancer_response['error_messages'][0].eql?('No freelancer was found with that UUID.')
+          raise 'No freelancer was found with that UUID'
+        else
+          raise 'Invalid Request'
+        end
+      else
+        freelancer_response['data']
+      end
     end
 
     def method_missing(name, *args, &block)
       freelancer.has_key?(name.to_s) ? freelancer[name.to_s] : super
     end
+
+    private
+
+    def freelancer_response
+      @freelancer_response ||= self.class.get("/freelancer/#{uuid}", headers: { 'X-Proz-API-Key' => key})
+    end
   end
 end

data/lib/proz/freelancer_matches.rb

@@ -12,8 +12,29 @@ module Proz
     end
 
     def freelancer_matches
+      case
+      when freelancer_matches_response.has_key?('error')
+        if freelancer_matches_response['error'].eql?('invalid_api_key')
+          raise 'Invalid API Key'
+        else
+          raise 'Invalid Request'
+        end
+      when freelancer_matches_response.has_key?('meta')
+        if freelancer_matches_response['meta']['num_results'].eql?(0)
+          {}
+        else
+          freelancer_matches_response['data']
+        end
+      else
+        freelancer_matches_response['data']
+      end
+    end
+
+    private
+
+    def freelancer_matches_response
       all_options = language_pair.merge!(options)
-      self.class.get("/freelancer-matches", query: all_options, headers: { 'X-Proz-API-Key' => key})['data']
+      @freelancer_matches_response ||= self.class.get("/freelancer-matches", query: all_options, headers: { 'X-Proz-API-Key' => key})
     end
   end
 end

data/lib/proz/oauth.rb

@@ -16,7 +16,15 @@ module Proz
     end
 
     def exchange_code_for_token(code)
-      @token ||= self.class.post('https://www.proz.com/oauth/token', :body => { :code => code, :redirect_uri => redirect_uri, :client_id => client_id, :scope => '', :client_secret => client_secret, :grant_type => 'authorization_code' })
+      if token(code).has_key?('error')
+        if token(code)['error'].eql?('invalid_grant')
+          raise "Authorization code doesn't exist or is invalid for the client"
+        else
+          raise 'Invalid Request'
+        end
+      else
+        token(code)
+      end
     end
 
     def request_new_token_with_refresh_token(refresh_token)
@@ -25,8 +33,12 @@ module Proz
 
     private
 
+    def token(code)
+      @token ||= self.class.post('https://www.proz.com/oauth/token', :body => { :code => code, :redirect_uri => redirect_uri, :client_id => client_id, :scope => '', :client_secret => client_secret, :grant_type => 'authorization_code' })
+    end
+
     def client
       @client ||= OAuth2::Client.new(client_id, client_secret, :site => 'https://www.proz.com')
     end
   end
-end
+end

data/lib/proz/profile.rb

@@ -10,11 +10,28 @@ module Proz
     end
 
     def profile
-      @profile ||= self.class.get("/freelancer/me", headers: { 'Authorization' => "Bearer #{token}" })['data']
+      case
+      when profile_response.has_key?('error')
+        if profile_response['error'].eql?('invalid_token')
+          raise 'Invalid Token'
+        elsif profile_response['error'].eql?('expired_token')
+          raise 'Access Token Expired'
+        else
+          raise 'Invalid Request'
+        end
+      else
+        profile_response['data']
+      end
     end
 
     def method_missing(name, *args, &block)
       profile.has_key?(name.to_s) ? profile[name.to_s] : super
     end
+
+    private
+
+    def profile_response
+      @profile ||= self.class.get("/freelancer/me", headers: { 'Authorization' => "Bearer #{token}" })
+    end
   end
-end
+end

data/lib/proz/version.rb

@@ -1,3 +1,3 @@
 module Proz
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/spec/fixtures/vcr_cassettes/exchange_code_for_token_invalid_code.yml

@@ -0,0 +1,48 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://www.proz.com/oauth/token
+    body:
+      encoding: UTF-8
+      string: code=xf505e6ac620cb51bb8dc99d4bddbef2f3122e70&redirect_uri=http%3A%2F%2Fwww.example.com&client_id=xxxxxxxxx&scope=&client_secret=yyyyyyyyy&grant_type=authorization_code
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 400
+      message: Bad Request
+    headers:
+      Date:
+      - Wed, 04 Feb 2015 08:27:48 GMT
+      Server:
+      - Apache
+      Set-Cookie:
+      - PHPSESSID=78683f88050679d8f1a0b981396b749c; expires=Fri, 03-Feb-2017 08:27:48
+        GMT; path=/; domain=.proz.com
+      Expires:
+      - Thu, 19 Nov 1981 08:52:00 GMT
+      Cache-Control:
+      - no-store
+      Pragma:
+      - no-cache
+      Vary:
+      - Accept-Encoding
+      Content-Length:
+      - '107'
+      Connection:
+      - close
+      Content-Type:
+      - application/json
+    body:
+      encoding: UTF-8
+      string: '{"error":"invalid_grant","error_description":"Authorization code doesn''t
+        exist or is invalid for the client"}'
+    http_version:
+  recorded_at: Wed, 04 Feb 2015 08:28:19 GMT
+recorded_with: VCR 2.9.3

data/spec/fixtures/vcr_cassettes/freelancer_matches_invalid_key.yml

@@ -0,0 +1,33 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.proz.com/v2/freelancer-matches?country_code=us&language_pair=eng_esl&min_yrs_proz=10
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      X-Proz-Api-Key:
+      - yyyyyyyyy
+  response:
+    status:
+      code: 401
+      message: Unauthorized
+    headers:
+      Date:
+      - Wed, 04 Feb 2015 07:43:47 GMT
+      Server:
+      - Apache
+      Cache-Control:
+      - no-store
+      Content-Length:
+      - '116'
+      Content-Type:
+      - application/json
+    body:
+      encoding: UTF-8
+      string: '{"error":"invalid_api_key","error_description":"Invalid API key.","error_messages":["Invalid
+        API key."],"success":0}'
+    http_version: 
+  recorded_at: Wed, 04 Feb 2015 07:44:18 GMT
+recorded_with: VCR 2.9.3

data/spec/fixtures/vcr_cassettes/freelancer_matches_no_results.yml

@@ -0,0 +1,32 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.proz.com/v2/freelancer-matches?country_code=us&language_pair=eng_esl&min_yrs_proz=50
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      X-Proz-Api-Key:
+      - xxxxxxxxx
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Wed, 04 Feb 2015 08:12:24 GMT
+      Server:
+      - Apache
+      Cache-Control:
+      - no-cache
+      Transfer-Encoding:
+      - chunked
+      Content-Type:
+      - application/json
+    body:
+      encoding: UTF-8
+      string: '{"success":1,"meta":{"num_results":0},"data":[]}'
+    http_version:
+  recorded_at: Wed, 04 Feb 2015 08:12:56 GMT
+recorded_with: VCR 2.9.3

data/spec/fixtures/vcr_cassettes/invalid_key.yml

@@ -0,0 +1,33 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.proz.com/v2/freelancer/663e4488-58a1-4713-992c-c6d90aafa3cb
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      X-Proz-Api-Key:
+      - yyyyyyyyy
+  response:
+    status:
+      code: 401
+      message: Unauthorized
+    headers:
+      Date:
+      - Wed, 04 Feb 2015 06:49:20 GMT
+      Server:
+      - Apache
+      Cache-Control:
+      - no-store
+      Content-Length:
+      - '116'
+      Content-Type:
+      - application/json
+    body:
+      encoding: UTF-8
+      string: '{"error":"invalid_api_key","error_description":"Invalid API key.","error_messages":["Invalid
+        API key."],"success":0}'
+    http_version:
+  recorded_at: Wed, 04 Feb 2015 06:49:51 GMT
+recorded_with: VCR 2.9.3

data/spec/fixtures/vcr_cassettes/invalid_uuid.yml

@@ -0,0 +1,34 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.proz.com/v2/freelancer/xxxxx
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      X-Proz-Api-Key:
+      - xxxxxxxxx
+  response:
+    status:
+      code: 400
+      message: Bad Request
+    headers:
+      Date:
+      - Wed, 04 Feb 2015 07:12:07 GMT
+      Server:
+      - Apache
+      Cache-Control:
+      - no-cache
+      Connection:
+      - close
+      Transfer-Encoding:
+      - chunked
+      Content-Type:
+      - application/json
+    body:
+      encoding: UTF-8
+      string: '{"success":0,"error_messages":["No freelancer was found with that UUID."]}'
+    http_version:
+  recorded_at: Wed, 04 Feb 2015 07:12:38 GMT
+recorded_with: VCR 2.9.3

data/spec/fixtures/vcr_cassettes/profile_query_access_token_expired.yml

@@ -0,0 +1,36 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.proz.com/v2/freelancer/me
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Authorization:
+      - Bearer 4b89e678e8670bca496c9bd80d8b09b87c10d605
+  response:
+    status:
+      code: 401
+      message: Unauthorized
+    headers:
+      Date:
+      - Wed, 04 Feb 2015 08:23:11 GMT
+      Server:
+      - Apache
+      Cache-Control:
+      - no-store
+      Www-Authenticate:
+      - Bearer realm="Service", error="expired_token", error_description="The access
+        token provided has expired"
+      Content-Length:
+      - '85'
+      Content-Type:
+      - application/json
+    body:
+      encoding: UTF-8
+      string: '{"error":"expired_token","error_description":"The access token provided
+        has expired"}'
+    http_version: 
+  recorded_at: Wed, 04 Feb 2015 08:23:42 GMT
+recorded_with: VCR 2.9.3

data/spec/fixtures/vcr_cassettes/profile_query_invalid_access_token.yml

@@ -0,0 +1,36 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.proz.com/v2/freelancer/me
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Authorization:
+      - Bearer q76470e1fb5e5c0347c3a7393f6312fd980096ae
+  response:
+    status:
+      code: 401
+      message: Unauthorized
+    headers:
+      Date:
+      - Wed, 04 Feb 2015 08:19:59 GMT
+      Server:
+      - Apache
+      Cache-Control:
+      - no-store
+      Www-Authenticate:
+      - Bearer realm="Service", error="invalid_token", error_description="The access
+        token provided is invalid"
+      Content-Length:
+      - '84'
+      Content-Type:
+      - application/json
+    body:
+      encoding: UTF-8
+      string: '{"error":"invalid_token","error_description":"The access token provided
+        is invalid"}'
+    http_version: 
+  recorded_at: Wed, 04 Feb 2015 08:20:30 GMT
+recorded_with: VCR 2.9.3

data/spec/proz/freelancer_matches_spec.rb

@@ -26,4 +26,18 @@ RSpec.describe Proz::FreelancerMatches do
       expect(fm.freelancer_matches[0]['freelancer']['uuid']).to eq('b9eade6d-33ac-4c7d-b6f1-42905375fc0b')
     end
   end
+
+  it 'returns an error if the key is invalid' do
+    VCR.use_cassette 'freelancer_matches_invalid_key' do
+      fm = Proz::FreelancerMatches.new(key: 'yyyyyyyyy', language_pair: 'eng_esl', min_yrs_proz: 10, country_code: 'us')
+      expect { fm.freelancer_matches }.to raise_error("Invalid API Key")
+    end
+  end
+
+  it 'returns an empty hash if the query has no results' do
+    VCR.use_cassette 'freelancer_matches_no_results' do
+      fm = Proz::FreelancerMatches.new(key: 'xxxxxxxxx', language_pair: 'eng_esl', min_yrs_proz: 50, country_code: 'us')
+      expect(fm.freelancer_matches).to eq({})
+    end
+  end
 end

data/spec/proz/freelancer_spec.rb

@@ -6,6 +6,13 @@ RSpec.describe Proz::Freelancer do
     expect(Proz::Freelancer.base_uri).to eq('https://api.proz.com/v2')
   end
 
+  it 'returns an error if the key is invalid' do
+    VCR.use_cassette 'invalid_key' do
+      freelancer = Proz::Freelancer.new(key: 'yyyyyyyyy', uuid: '663e4488-58a1-4713-992c-c6d90aafa3cb')
+      expect { freelancer.freelancer }.to raise_error('Invalid API Key')
+    end
+  end
+
   it 'returns a freelancer' do
     VCR.use_cassette 'freelancer' do
       freelancer = Proz::Freelancer.new(key: 'xxxxxxxxxx', uuid: '663e4488-58a1-4713-992c-c6d90aafa3cb')
@@ -13,6 +20,13 @@ RSpec.describe Proz::Freelancer do
     end
   end
 
+  it 'returns an error if the uuid is invalid' do
+    VCR.use_cassette 'invalid_uuid' do
+      freelancer = Proz::Freelancer.new(key: 'xxxxxxxxx', uuid: 'xxxxx')
+      expect { freelancer.site_name }.to raise_error("No freelancer was found with that UUID")
+    end
+  end
+
   it "returns a freelancer's uuid" do
     VCR.use_cassette 'freelancer' do
       freelancer = Proz::Freelancer.new(key: 'xxxxxxxxxx', uuid: '663e4488-58a1-4713-992c-c6d90aafa3cb')

data/spec/proz/oauth_spec.rb

@@ -37,4 +37,11 @@ RSpec.describe Proz::OAuth do
       expect(proz.request_new_token_with_refresh_token('x92701ac20cb02a5742f2a0288b7a9f6a6d0b265')['refresh_token']).to eq('x6ee311617f0f0520e99de13b07ee61c03777134')
     end
   end
+
+  it 'requests an error if the code is invalid' do
+    VCR.use_cassette 'exchange_code_for_token_invalid_code' do
+      proz = Proz::OAuth.new(client_id: 'xxxxxxxxx', client_secret: 'yyyyyyyyy', redirect_uri: 'http://www.example.com')
+      expect { proz.exchange_code_for_token('xf505e6ac620cb51bb8dc99d4bddbef2f3122e70') }.to raise_error("Authorization code doesn't exist or is invalid for the client")
+    end
+  end
 end

data/spec/proz/profile_spec.rb

@@ -29,4 +29,18 @@ RSpec.describe Proz::Profile do
       expect(profile.profile_url).to eq('http://www.proz.com/profile/1979687')
     end
   end
+
+  it 'should return an error is the access token is invalid' do
+    VCR.use_cassette 'profile_query_invalid_access_token' do
+      profile = Proz::Profile.new(token: 'q76470e1fb5e5c0347c3a7393f6312fd980096ae')
+      expect { profile.profile_url }.to raise_error('Invalid Token')
+    end
+  end
+
+  it 'should return an error is the access token is expired' do
+    VCR.use_cassette 'profile_query_access_token_expired' do
+      profile = Proz::Profile.new(token: '4b89e678e8670bca496c9bd80d8b09b87c10d605')
+      expect { profile.profile_url }.to raise_error('Access Token Expired')
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: proz
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Kevin S. Dias
@@ -131,10 +131,17 @@ files:
 - lib/proz/version.rb
 - proz.gemspec
 - spec/fixtures/vcr_cassettes/exchange_code_for_token.yml
+- spec/fixtures/vcr_cassettes/exchange_code_for_token_invalid_code.yml
 - spec/fixtures/vcr_cassettes/freelancer.yml
+- spec/fixtures/vcr_cassettes/freelancer_matches_invalid_key.yml
+- spec/fixtures/vcr_cassettes/freelancer_matches_no_results.yml
+- spec/fixtures/vcr_cassettes/invalid_key.yml
+- spec/fixtures/vcr_cassettes/invalid_uuid.yml
 - spec/fixtures/vcr_cassettes/match_query.yml
 - spec/fixtures/vcr_cassettes/match_query_options.yml
 - spec/fixtures/vcr_cassettes/profile_query.yml
+- spec/fixtures/vcr_cassettes/profile_query_access_token_expired.yml
+- spec/fixtures/vcr_cassettes/profile_query_invalid_access_token.yml
 - spec/fixtures/vcr_cassettes/refresh_token.yml
 - spec/proz/freelancer_matches_spec.rb
 - spec/proz/freelancer_spec.rb
@@ -167,10 +174,17 @@ specification_version: 4
 summary: Ruby wrapper for the ProZ.com API
 test_files:
 - spec/fixtures/vcr_cassettes/exchange_code_for_token.yml
+- spec/fixtures/vcr_cassettes/exchange_code_for_token_invalid_code.yml
 - spec/fixtures/vcr_cassettes/freelancer.yml
+- spec/fixtures/vcr_cassettes/freelancer_matches_invalid_key.yml
+- spec/fixtures/vcr_cassettes/freelancer_matches_no_results.yml
+- spec/fixtures/vcr_cassettes/invalid_key.yml
+- spec/fixtures/vcr_cassettes/invalid_uuid.yml
 - spec/fixtures/vcr_cassettes/match_query.yml
 - spec/fixtures/vcr_cassettes/match_query_options.yml
 - spec/fixtures/vcr_cassettes/profile_query.yml
+- spec/fixtures/vcr_cassettes/profile_query_access_token_expired.yml
+- spec/fixtures/vcr_cassettes/profile_query_invalid_access_token.yml
 - spec/fixtures/vcr_cassettes/refresh_token.yml
 - spec/proz/freelancer_matches_spec.rb
 - spec/proz/freelancer_spec.rb