google-cloud-talent 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6488d0c8f6d1634ac67bb571277696b7209034b8f525ae1445df0805052a91ef
-  data.tar.gz: 85370efceb8b540446b13b8872b10ab6211152426ea8c0970752e945d124a2c1
+  metadata.gz: '0816cd6dad955973fa9ec62204ed25ec11a391546dcb6483234ded40a7182d6d'
+  data.tar.gz: ba036e23b7ea2b7dc376c229defe16336c6a45c5ed3a13ee5fd9d106c4d566e7
 SHA512:
-  metadata.gz: 473195f16f6f2c537544a87712e63a9c87e6861844f54bd018f915f6a6eef3519670a5a106fd91507118866b51fb20999ff59726d9384b7c495fcb1b7ff1be1e
-  data.tar.gz: 6b91512ee14a42ca528e9d1868c34e9c8c516da5ee64695d946e39ae5c73823fd4ef58ba14677f250ee86c342c22a5deef233ec4717dd8c8140a064f4de97264
+  metadata.gz: 53613733ed8eabd7f7a7d22c9e02d9d988fa6370dff60277b9ba82d2463836a47fa6d15a51de79fa9ad9323a879e91b14dbd3a62c77af075a279b30e76837a7b
+  data.tar.gz: b37c34d3ab95b331a7c8a441f4c5f739ae83c09ccf7d9e11530016e60edf64203e699bfe78189b9b7fcaf9c7e101e03b793be4a24c8661868906d2944d27a397

data/.yardopts

@@ -7,3 +7,5 @@
 ./lib/**/*.rb
 -
 README.md
+AUTHENTICATION.md
+LICENSE

data/AUTHENTICATION.md

@@ -0,0 +1,199 @@
+# Authentication
+
+In general, the google-cloud-talent library uses [Service
+Account](https://cloud.google.com/iam/docs/creating-managing-service-accounts)
+credentials to connect to Google Cloud services. When running within [Google
+Cloud Platform environments](#google-cloud-platform-environments)
+the credentials will be discovered automatically. When running on other
+environments, the Service Account credentials can be specified by providing the
+path to the [JSON
+keyfile](https://cloud.google.com/iam/docs/managing-service-account-keys) for
+the account (or the JSON itself) in [environment
+variables](#environment-variables). Additionally, Cloud SDK credentials can also
+be discovered automatically, but this is only recommended during development.
+
+## Quickstart
+
+1. [Create a service account and credentials](#creating-a-service-account).
+2. Set the [environment variable](#environment-variables).
+
+```sh
+export TALENT_CREDENTIALS=/path/to/json`
+```
+
+3. Initialize the client.
+
+```ruby
+require "google/cloud/talent"
+
+client = Google::Cloud::Talent.new
+```
+
+## Project and Credential Lookup
+
+The google-cloud-talent library aims to make authentication
+as simple as possible, and provides several mechanisms to configure your system
+without providing **Project ID** and **Service Account Credentials** directly in
+code.
+
+**Project ID** is discovered in the following order:
+
+1. Specify project ID in method arguments
+2. Specify project ID in configuration
+3. Discover project ID in environment variables
+4. Discover GCE project ID
+5. Discover project ID in credentials JSON
+
+**Credentials** are discovered in the following order:
+
+1. Specify credentials in method arguments
+2. Specify credentials in configuration
+3. Discover credentials path in environment variables
+4. Discover credentials JSON in environment variables
+5. Discover credentials file in the Cloud SDK's path
+6. Discover GCE credentials
+
+### Google Cloud Platform environments
+
+While running on Google Cloud Platform environments such as Google Compute
+Engine, Google App Engine and Google Kubernetes Engine, no extra work is needed.
+The **Project ID** and **Credentials** and are discovered automatically. Code
+should be written as if already authenticated. Just be sure when you [set up the
+GCE instance][gce-how-to], you add the correct scopes for the APIs you want to
+access. For example:
+
+  * **All APIs**
+    * `https://www.googleapis.com/auth/cloud-platform`
+    * `https://www.googleapis.com/auth/cloud-platform.read-only`
+  * **BigQuery**
+    * `https://www.googleapis.com/auth/bigquery`
+    * `https://www.googleapis.com/auth/bigquery.insertdata`
+  * **Compute Engine**
+    * `https://www.googleapis.com/auth/compute`
+  * **Datastore**
+    * `https://www.googleapis.com/auth/datastore`
+    * `https://www.googleapis.com/auth/userinfo.email`
+  * **DNS**
+    * `https://www.googleapis.com/auth/ndev.clouddns.readwrite`
+  * **Pub/Sub**
+    * `https://www.googleapis.com/auth/pubsub`
+  * **Storage**
+    * `https://www.googleapis.com/auth/devstorage.full_control`
+    * `https://www.googleapis.com/auth/devstorage.read_only`
+    * `https://www.googleapis.com/auth/devstorage.read_write`
+
+### Environment Variables
+
+The **Project ID** and **Credentials JSON** can be placed in environment
+variables instead of declaring them directly in code. Each service has its own
+environment variable, allowing for different service accounts to be used for
+different services. (See the READMEs for the individual service gems for
+details.) The path to the **Credentials JSON** file can be stored in the
+environment variable, or the **Credentials JSON** itself can be stored for
+environments such as Docker containers where writing files is difficult or not
+encouraged.
+
+The environment variables that google-cloud-talent checks for project ID are:
+
+1. `TALENT_PROJECT`
+2. `GOOGLE_CLOUD_PROJECT`
+
+The environment variables that google-cloud-talent checks for credentials are configured on {Google::Cloud::Talent::V4beta1::Credentials}:
+
+1. `TALENT_CREDENTIALS` - Path to JSON file, or JSON contents
+2. `TALENT_KEYFILE` - Path to JSON file, or JSON contents
+3. `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
+4. `GOOGLE_CLOUD_KEYFILE` - Path to JSON file, or JSON contents
+5. `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
+
+```ruby
+require "google/cloud/talent"
+
+ENV["TALENT_PROJECT"]     = "my-project-id"
+ENV["TALENT_CREDENTIALS"] = "path/to/keyfile.json"
+
+client = Google::Cloud::Talent.new
+```
+
+### Configuration
+
+The **Project ID** and **Credentials JSON** can be configured instead of placing them in environment variables or providing them as arguments.
+
+```ruby
+require "google/cloud/talent"
+
+Google::Cloud::Talent.configure do |config|
+  config.project_id  = "my-project-id"
+  config.credentials = "path/to/keyfile.json"
+end
+
+client = Google::Cloud::Talent.new
+```
+
+### Cloud SDK
+
+This option allows for an easy way to authenticate during development. If
+credentials are not provided in code or in environment variables, then Cloud SDK
+credentials are discovered.
+
+To configure your system for this, simply:
+
+1. [Download and install the Cloud SDK](https://cloud.google.com/sdk)
+2. Authenticate using OAuth 2.0 `$ gcloud auth login`
+3. Write code as if already authenticated.
+
+**NOTE:** This is _not_ recommended for running in production. The Cloud SDK
+*should* only be used during development.
+
+[gce-how-to]: https://cloud.google.com/compute/docs/authentication#using
+[dev-console]: https://console.cloud.google.com/project
+
+[enable-apis]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/enable-apis.png
+
+[create-new-service-account]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/create-new-service-account.png
+[create-new-service-account-existing-keys]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/create-new-service-account-existing-keys.png
+[reuse-service-account]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/reuse-service-account.png
+
+## Creating a Service Account
+
+Google Cloud requires a **Project ID** and **Service Account Credentials** to
+connect to the APIs. You will use the **Project ID** and **JSON key file** to
+connect to most services with google-cloud-talent.
+
+If you are not running this client within [Google Cloud Platform
+environments](#google-cloud-platform-environments), you need a Google
+Developers service account.
+
+1. Visit the [Google Developers Console][dev-console].
+1. Create a new project or click on an existing project.
+1. Activate the slide-out navigation tray and select **API Manager**. From
+   here, you will enable the APIs that your application requires.
+
+   ![Enable the APIs that your application requires][enable-apis]
+
+   *Note: You may need to enable billing in order to use these services.*
+
+1. Select **Credentials** from the side navigation.
+
+   You should see a screen like one of the following.
+
+   ![Create a new service account][create-new-service-account]
+
+   ![Create a new service account With Existing Keys][create-new-service-account-existing-keys]
+
+   Find the "Add credentials" drop down and select "Service account" to be
+   guided through downloading a new JSON key file.
+
+   If you want to re-use an existing service account, you can easily generate a
+   new key file. Just select the account you wish to re-use, and click "Generate
+   new JSON key":
+
+   ![Re-use an existing service account][reuse-service-account]
+
+   The key file you download will be used by this library to authenticate API
+   requests and should be stored in a secure location.
+
+## Troubleshooting
+
+If you're having trouble authenticating you can ask for help by following the
+{file:TROUBLESHOOTING.md Troubleshooting Guide}.

data/lib/google/cloud/talent.rb

@@ -87,9 +87,10 @@ module Google
         .select { |dir| File.exist?(dir + ".rb") }
         .map { |dir| File.basename(dir) }
 
-      module CompanyService
+      module ApplicationService
         ##
-        # A service that handles company management, including CRUD and enumeration.
+        # A service that handles application management, including CRUD and
+        # enumeration.
         #
         # @param version [Symbol, String]
         #   The major version of the service to be used. By default :v4beta1
@@ -135,13 +136,13 @@ module Google
             .constants
             .select {|sym| sym.to_s.downcase == version.to_s.downcase}
             .first
-          Google::Cloud::Talent.const_get(version_module)::CompanyService.new(*args, **kwargs)
+          Google::Cloud::Talent.const_get(version_module)::ApplicationService.new(*args, **kwargs)
         end
       end
 
-      module Completion
+      module CompanyService
         ##
-        # A service handles auto completion.
+        # A service that handles company management, including CRUD and enumeration.
         #
         # @param version [Symbol, String]
         #   The major version of the service to be used. By default :v4beta1
@@ -187,13 +188,13 @@ module Google
             .constants
             .select {|sym| sym.to_s.downcase == version.to_s.downcase}
             .first
-          Google::Cloud::Talent.const_get(version_module)::Completion.new(*args, **kwargs)
+          Google::Cloud::Talent.const_get(version_module)::CompanyService.new(*args, **kwargs)
         end
       end
 
-      module Event
+      module Completion
         ##
-        # A service handles client event report.
+        # A service handles auto completion.
         #
         # @param version [Symbol, String]
         #   The major version of the service to be used. By default :v4beta1
@@ -239,13 +240,13 @@ module Google
             .constants
             .select {|sym| sym.to_s.downcase == version.to_s.downcase}
             .first
-          Google::Cloud::Talent.const_get(version_module)::Event.new(*args, **kwargs)
+          Google::Cloud::Talent.const_get(version_module)::Completion.new(*args, **kwargs)
         end
       end
 
-      module JobService
+      module Event
         ##
-        # A service handles job management, including job CRUD, enumeration and search.
+        # A service handles client event report.
         #
         # @param version [Symbol, String]
         #   The major version of the service to be used. By default :v4beta1
@@ -291,14 +292,13 @@ module Google
             .constants
             .select {|sym| sym.to_s.downcase == version.to_s.downcase}
             .first
-          Google::Cloud::Talent.const_get(version_module)::JobService.new(*args, **kwargs)
+          Google::Cloud::Talent.const_get(version_module)::Event.new(*args, **kwargs)
         end
       end
 
-      module ProfileService
+      module JobService
         ##
-        # A service that handles profile management, including profile CRUD,
-        # enumeration and search.
+        # A service handles job management, including job CRUD, enumeration and search.
         #
         # @param version [Symbol, String]
         #   The major version of the service to be used. By default :v4beta1
@@ -344,13 +344,14 @@ module Google
             .constants
             .select {|sym| sym.to_s.downcase == version.to_s.downcase}
             .first
-          Google::Cloud::Talent.const_get(version_module)::ProfileService.new(*args, **kwargs)
+          Google::Cloud::Talent.const_get(version_module)::JobService.new(*args, **kwargs)
         end
       end
 
-      module Resume
+      module ProfileService
         ##
-        # A service that handles resume parsing.
+        # A service that handles profile management, including profile CRUD,
+        # enumeration and search.
         #
         # @param version [Symbol, String]
         #   The major version of the service to be used. By default :v4beta1
@@ -396,7 +397,7 @@ module Google
             .constants
             .select {|sym| sym.to_s.downcase == version.to_s.downcase}
             .first
-          Google::Cloud::Talent.const_get(version_module)::Resume.new(*args, **kwargs)
+          Google::Cloud::Talent.const_get(version_module)::ProfileService.new(*args, **kwargs)
         end
       end
 

data/lib/google/cloud/talent/v4beta1.rb

@@ -13,13 +13,13 @@
 # limitations under the License.
 
 
+require "google/cloud/talent/v4beta1/application_service_client"
+require "google/cloud/talent/v4beta1/helpers"
 require "google/cloud/talent/v4beta1/company_service_client"
 require "google/cloud/talent/v4beta1/completion_client"
 require "google/cloud/talent/v4beta1/event_service_client"
 require "google/cloud/talent/v4beta1/job_service_client"
 require "google/cloud/talent/v4beta1/profile_service_client"
-require "google/cloud/talent/v4beta1/resume_service_client"
-require "google/cloud/talent/v4beta1/helpers"
 require "google/cloud/talent/v4beta1/tenant_service_client"
 
 module Google
@@ -86,9 +86,10 @@ module Google
       module V4beta1
         # rubocop:enable LineLength
 
-        module CompanyService
+        module ApplicationService
           ##
-          # A service that handles company management, including CRUD and enumeration.
+          # A service that handles application management, including CRUD and
+          # enumeration.
           #
           # @param credentials [Google::Auth::Credentials, String, Hash, GRPC::Core::Channel, GRPC::Core::ChannelCredentials, Proc]
           #   Provides the means for authenticating requests made by the client. This parameter can
@@ -138,13 +139,13 @@ module Google
               lib_name: lib_name,
               lib_version: lib_version
             }.select { |_, v| v != nil }
-            Google::Cloud::Talent::V4beta1::CompanyServiceClient.new(**kwargs)
+            Google::Cloud::Talent::V4beta1::ApplicationServiceClient.new(**kwargs)
           end
         end
 
-        module Completion
+        module CompanyService
           ##
-          # A service handles auto completion.
+          # A service that handles company management, including CRUD and enumeration.
           #
           # @param credentials [Google::Auth::Credentials, String, Hash, GRPC::Core::Channel, GRPC::Core::ChannelCredentials, Proc]
           #   Provides the means for authenticating requests made by the client. This parameter can
@@ -194,13 +195,13 @@ module Google
               lib_name: lib_name,
               lib_version: lib_version
             }.select { |_, v| v != nil }
-            Google::Cloud::Talent::V4beta1::CompletionClient.new(**kwargs)
+            Google::Cloud::Talent::V4beta1::CompanyServiceClient.new(**kwargs)
           end
         end
 
-        module Event
+        module Completion
           ##
-          # A service handles client event report.
+          # A service handles auto completion.
           #
           # @param credentials [Google::Auth::Credentials, String, Hash, GRPC::Core::Channel, GRPC::Core::ChannelCredentials, Proc]
           #   Provides the means for authenticating requests made by the client. This parameter can
@@ -250,13 +251,13 @@ module Google
               lib_name: lib_name,
               lib_version: lib_version
             }.select { |_, v| v != nil }
-            Google::Cloud::Talent::V4beta1::EventServiceClient.new(**kwargs)
+            Google::Cloud::Talent::V4beta1::CompletionClient.new(**kwargs)
           end
         end
 
-        module JobService
+        module Event
           ##
-          # A service handles job management, including job CRUD, enumeration and search.
+          # A service handles client event report.
           #
           # @param credentials [Google::Auth::Credentials, String, Hash, GRPC::Core::Channel, GRPC::Core::ChannelCredentials, Proc]
           #   Provides the means for authenticating requests made by the client. This parameter can
@@ -306,14 +307,13 @@ module Google
               lib_name: lib_name,
               lib_version: lib_version
             }.select { |_, v| v != nil }
-            Google::Cloud::Talent::V4beta1::JobServiceClient.new(**kwargs)
+            Google::Cloud::Talent::V4beta1::EventServiceClient.new(**kwargs)
           end
         end
 
-        module ProfileService
+        module JobService
           ##
-          # A service that handles profile management, including profile CRUD,
-          # enumeration and search.
+          # A service handles job management, including job CRUD, enumeration and search.
           #
           # @param credentials [Google::Auth::Credentials, String, Hash, GRPC::Core::Channel, GRPC::Core::ChannelCredentials, Proc]
           #   Provides the means for authenticating requests made by the client. This parameter can
@@ -363,13 +363,14 @@ module Google
               lib_name: lib_name,
               lib_version: lib_version
             }.select { |_, v| v != nil }
-            Google::Cloud::Talent::V4beta1::ProfileServiceClient.new(**kwargs)
+            Google::Cloud::Talent::V4beta1::JobServiceClient.new(**kwargs)
           end
         end
 
-        module Resume
+        module ProfileService
           ##
-          # A service that handles resume parsing.
+          # A service that handles profile management, including profile CRUD,
+          # enumeration and search.
           #
           # @param credentials [Google::Auth::Credentials, String, Hash, GRPC::Core::Channel, GRPC::Core::ChannelCredentials, Proc]
           #   Provides the means for authenticating requests made by the client. This parameter can
@@ -419,7 +420,7 @@ module Google
               lib_name: lib_name,
               lib_version: lib_version
             }.select { |_, v| v != nil }
-            Google::Cloud::Talent::V4beta1::ResumeServiceClient.new(**kwargs)
+            Google::Cloud::Talent::V4beta1::ProfileServiceClient.new(**kwargs)
           end
         end
 

data/lib/google/cloud/talent/v4beta1/application_pb.rb

@@ -0,0 +1,62 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: google/cloud/talent/v4beta1/application.proto
+
+
+require 'google/protobuf'
+
+require 'google/cloud/talent/v4beta1/common_pb'
+require 'google/cloud/talent/v4beta1/job_pb'
+require 'google/protobuf/timestamp_pb'
+require 'google/protobuf/wrappers_pb'
+require 'google/type/date_pb'
+require 'google/api/annotations_pb'
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_message "google.cloud.talent.v4beta1.Application" do
+    optional :name, :string, 1
+    optional :external_id, :string, 31
+    optional :profile, :string, 2
+    optional :job, :string, 4
+    optional :company, :string, 5
+    optional :application_date, :message, 7, "google.type.Date"
+    optional :stage, :enum, 11, "google.cloud.talent.v4beta1.Application.ApplicationStage"
+    optional :state, :enum, 13, "google.cloud.talent.v4beta1.Application.ApplicationState"
+    repeated :interviews, :message, 16, "google.cloud.talent.v4beta1.Interview"
+    optional :referral, :message, 18, "google.protobuf.BoolValue"
+    optional :create_time, :message, 19, "google.protobuf.Timestamp"
+    optional :update_time, :message, 20, "google.protobuf.Timestamp"
+    optional :outcome_notes, :string, 21
+    optional :outcome, :enum, 22, "google.cloud.talent.v4beta1.Outcome"
+    optional :is_match, :message, 28, "google.protobuf.BoolValue"
+    optional :job_title_snippet, :string, 29
+  end
+  add_enum "google.cloud.talent.v4beta1.Application.ApplicationState" do
+    value :APPLICATION_STATE_UNSPECIFIED, 0
+    value :IN_PROGRESS, 1
+    value :CANDIDATE_WITHDREW, 2
+    value :EMPLOYER_WITHDREW, 3
+    value :COMPLETED, 4
+    value :CLOSED, 5
+  end
+  add_enum "google.cloud.talent.v4beta1.Application.ApplicationStage" do
+    value :APPLICATION_STAGE_UNSPECIFIED, 0
+    value :NEW, 1
+    value :SCREEN, 2
+    value :HIRING_MANAGER_REVIEW, 3
+    value :INTERVIEW, 4
+    value :OFFER_EXTENDED, 5
+    value :OFFER_ACCEPTED, 6
+    value :STARTED, 7
+  end
+end
+
+module Google
+  module Cloud
+    module Talent
+      module V4beta1
+        Application = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.talent.v4beta1.Application").msgclass
+        Application::ApplicationState = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.talent.v4beta1.Application.ApplicationState").enummodule
+        Application::ApplicationStage = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.talent.v4beta1.Application.ApplicationStage").enummodule
+      end
+    end
+  end
+end