google-cloud-gemserver 0.1.0

data/lib/google/cloud/gemserver/cli/cloud_sql.rb

@@ -0,0 +1,196 @@
+# Copyright 2017 Google Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#  https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require "google/cloud/gemserver"
+require "securerandom"
+require "google/apis/sqladmin_v1beta4"
+require "googleauth"
+require "yaml"
+
+module Google
+  module Cloud
+    module Gemserver
+      class CLI
+        ##
+        # # CloudSQL
+        #
+        # CloudSQL manages the creation of a Cloud SQL instance as well as
+        # the necessary database and user creation.
+        #
+        class CloudSQL
+          ##
+          # Permits SQL admin operations with the Cloud SQL API.
+          SCOPES = ["https://www.googleapis.com/auth/sqlservice.admin"]
+                   .freeze
+
+          ##
+          # An alias for the SqladminV1beta4 module.
+          SQL = Google::Apis::SqladminV1beta4
+
+          ##
+          # The name of the database used to store gemserver data.
+          # @return [String]
+          attr_reader :db
+
+          ##
+          # The name of the default user created to access the database.
+          # @return [String]
+          attr_reader :user
+
+          ##
+          # The password of the default user created to access the database.
+          # @return [String]
+          attr_reader :pwd
+
+          ##
+          # The project ID of the project the gemserver will be deployed to.
+          # @return [String]
+          attr_reader :proj_id
+
+          ##
+          # The name of the Cloud SQL instance.
+          # @return [String]
+          attr_reader :inst
+
+          ##
+          # The Cloud SQL API used to manage Cloud SQL instances.
+          # @return [Google::Apis::SqladminV1beta4::SQLAdminService]
+          attr_reader :service
+
+          ##
+          # Creates a CloudSQL object and loads the necessary configuration
+          # settings.
+          #
+          # @param inst [String] Name of the instance to be used. Optional.
+          def initialize inst = nil
+            auth = Google::Auth.get_application_default SCOPES
+            Google::Apis::RequestOptions.default.authorization = auth
+            @config = Configuration.new
+            @service     = SQL::SQLAdminService.new
+            @inst        = inst || "instance-#{SecureRandom.uuid}".freeze
+            @custom      = inst ? true : false
+            load_config
+          end
+
+          ##
+          # Prepares a Cloud SQL instance with a database and user. Also saves
+          # the database settings in the appropriate configuration file.
+          def run
+            create_instance do |instance_op|
+              run_sql_task instance_op if instance_op.class == SQL::Operation
+              update_root_user
+              create_db do |db_op|
+                run_sql_task db_op
+                create_user
+              end
+            end
+            update_config
+          end
+
+          private
+
+          ##
+          # @private Creates a Cloud SQL instance.
+          def create_instance &block
+            if @custom
+              puts "Using existing Cloud SQL instance: #{@inst}"
+              yield
+              return instance
+            end
+            puts "Creating Cloud SQL instance #{@inst} (this takes a few "\
+              "minutes to complete)"
+            settings = SQL::Settings.new(tier: "db-f1-micro")
+            payload = SQL::DatabaseInstance.new(
+              name: @inst,
+              project: @proj_id,
+              settings: settings
+            )
+            @service.insert_instance(@proj_id, payload, &block)
+          end
+
+          ##
+          # @private Creates a database for a Cloud SQL instance.
+          def create_db &block
+            puts "Creating database #{@db}"
+            db = SQL::Database.new name: @db
+            @service.insert_database(@proj_id, @inst, db, &block)
+          end
+
+          ##
+          # @private Creates a user for a Cloud SQL instance.
+          def create_user
+            puts "Creating user #{@user}"
+            user = SQL::User.new(name: @user, password: @pwd)
+            run_sql_task @service.insert_user(@proj_id, @inst, user)
+          end
+
+          ##
+          # @private Updates the password of the root user if a new Cloud SQL
+          # instance was created.
+          def update_root_user
+            return if @custom
+            cmd = "gcloud sql users set-password root % --password #{@pwd} "\
+              "-i #{@inst} --project #{@proj_id}"
+            `#{cmd}`
+          end
+
+          ##
+          # @private Fetches a Cloud SQL instance.
+          #
+          # @return [Google::Apis::SqladminV1beta4::DatabaseInstance
+          def instance
+            @service.get_instance @proj_id, @inst
+          end
+
+          ##
+          # Deletes the Cloud SQL instance for a gemserver.
+          def del_instance
+            puts "Deleting instance: #{@inst}"
+            @service.delete_instance @proj_id, @inst
+          end
+
+          ##
+          # Sets various Cloud SQL settings used to create a Cloud SQL
+          # instance.
+          def load_config
+            @db      = @config[:db_connection_options][:database]
+            @user    = @config[:db_connection_options][:username]
+            @pwd     = @config[:db_connection_options][:password]
+            @proj_id = @config[:proj_id]
+          end
+
+          ##
+          # Saves the Cloud SQL configuration in the appropriate configuration
+          # file and app configuration file.
+          def update_config
+            puts "Updating configurations: app.yaml and config.yml "
+            conn_name = instance.connection_name
+            @config.update_config "/cloudsql/#{conn_name}",
+                                  :db_connection_options,
+                                  :socket
+            @config.update_app conn_name, "beta_settings", "cloud_sql_instances"
+          end
+
+          ##
+          # Runs a Cloud SQL task and polls for its completion.
+          def run_sql_task op
+            while @service.get_operation(@proj_id, op.name).status != "DONE"
+              sleep 2
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/google/cloud/gemserver/cli/project.rb

@@ -0,0 +1,143 @@
+# Copyright 2017 Google Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#  https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require "google/cloud/gemserver"
+require "google/cloud/resource_manager"
+require "securerandom"
+
+module Google
+  module Cloud
+    module Gemserver
+      class CLI
+        ##
+        # # Project
+        #
+        # Holds a reference to a project on Google Cloud Platform.
+        #
+        class Project
+
+          ##
+          # The name of the project on Google Cloud platform; same as ID.
+          # @return [String]
+          attr_accessor :proj_name
+
+          ##
+          # The Configuration object storing the settings used by the Project
+          # object.
+          # @return [Configuration]
+          attr_accessor :config
+
+          ##
+          # Initializes the project name and Configuration object.
+          def initialize name = nil
+            @proj_name = name
+            @config = Configuration.new
+          end
+
+          ##
+          # Fetches a reference to the given project on Google Cloud Platform
+          # and prompts the user to configure it correctly.
+          def create
+            raise "Project name was not provided!" unless @proj_name
+            begin
+              @config.update_config @proj_name, :proj_id
+              create_gae_project
+              enable_api
+              enable_billing
+              project
+            rescue Google::Cloud::PermissionDeniedError, RuntimeError => e
+              puts "Permission denied. You might not be authorized with " \
+                "gcloud. Read github.com/GoogleCloudPlatform/google-cloud`." \
+                "-ruby/google-cloud-gemserver/docs/authentication.md for " \
+                "more information on how to get authenticated."
+              puts "If you still get this error the Cloud Resource Manager " \
+                "API might not be enabled."
+              abort "More details: #{e.message}"
+            end
+          end
+
+          private
+
+          ##
+          # @private Checks if the current Google Cloud Platform project
+          # contains a Google App Engine project. If not, one is created.
+          def create_gae_project
+            return if project_exists?
+            puts "Required Google App Engine project does not exist."
+            system "gcloud app create --project #{@proj_name}"
+          end
+
+          ##
+          # @private Checks if a Google App Engine project exists.
+          #
+          # @return [Boolean]
+          def project_exists?
+            system "gcloud app describe --project #{@proj_name} >/dev/null 2>&1"
+          end
+
+          ##
+          # @private Prompts the user to press enter.
+          #
+          # @return [String]
+          def prompt_user
+            puts "\nPress enter to continue..."
+            STDIN.gets
+          end
+
+          ##
+          # @private Fetches a given project on Google Cloud Platform.
+          #
+          # @return [Google::Cloud::ResourceManager::Project]
+          def project
+            resource_manager = Google::Cloud::ResourceManager.new
+            resource_manager.project @proj_name
+          end
+
+          ##
+          # @private Prompts the user to enable necessary APIs for the
+          # gemserver to work as intended.
+          #
+          # @return [String]
+          def enable_api
+            puts "\nEnable the Google Cloud SQL API if it is not already "\
+              "enabled by visiting:\n https://console.developers.google.com"\
+              "/apis/api/sqladmin.googleapis.com/overview?"\
+              "project=#{@proj_name} and clicking \"Enable\""
+            puts "\nEnable the Google Cloud Resource manager API if it is not"\
+              "already enabled by visiting:\nhttps://console.developers.google"\
+              ".com/apis/api/cloudresourcemanager.googleapis.com/overview?"\
+              "project=#{@proj_name} and clicking \"Enable\""
+            puts "\nEnable the Google App Engine Admin API if it is not "\
+              "already enabled by visiting:\nhttps://console.developers.google"\
+              ".com/apis/api/appengine.googleapis.com/overview?"\
+              "project=#{@proj_name} and clicking \"Enable\""
+            prompt_user
+          end
+
+          ##
+          # @private Prompts the user to enable billing such that the gemserver
+          # work as intended.
+          #
+          # @return [String]
+          def enable_billing
+            puts "\nEnable billing for the project you just created by "\
+              "visiting: \nconsole.cloud.google.com/billing?project="\
+              "#{@proj_name}\nand setting up a billing account."
+            prompt_user
+          end
+        end
+      end
+    end
+  end
+end

data/lib/google/cloud/gemserver/cli/request.rb

@@ -0,0 +1,130 @@
+# Copyright 2017 Google Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#  @https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require "google/cloud/gemserver"
+require "net/http"
+require "yaml"
+
+module Google
+  module Cloud
+    module Gemserver
+      class CLI
+        ##
+        #
+        # # Request
+        #
+        # Responsible for sending requests to the gemserver for operations that
+        # involve the database. Gem operations are done with the 'gem' command
+        # and are not in the scope of Request.
+        class Request
+
+          ##
+          # The HTTP object used to connect to and send requests to the
+          # gemserver.
+          # @return [Net::HTTP]
+          attr_accessor :http
+
+          ##
+          # Initialize the Backend object by constructing an HTTP object for the
+          # gemserver.
+          #
+          # @param [String] url The URL of the gemserver. Optional.
+          #
+          # @param [String] proj_name The name of the Google Cloud Platform the
+          # gemserver was deployed to. Optional.
+          def initialize url = nil, proj_name = nil
+            gemserver_url = url.nil? == true ? remote(proj_name) : url
+            @http = Net::HTTP.new gemserver_url
+          end
+
+          ##
+          # Send a request to the gemserver to create a key with certain
+          # permissions.
+          #
+          # @param [String] permissions The permissions the generated key will
+          # have (read, write, or both). Optional.
+          #
+          # @return [Net::HTTPResponse]
+          def create_key permissions = nil
+            send_req Net::HTTP::Post, "/api/v1/key", {permissions: permissions}
+          end
+
+          ##
+          # Send a request to the gemserver to delete a key.
+          #
+          # @param [String] key The key to delete.
+          #
+          # @return [Net::HTTPResponse]
+          def delete_key key
+            send_req Net::HTTP::Put, "/api/v1/key", {key: key}
+          end
+
+          ##
+          # Send a request to the gemserver to fetch information about stored
+          # private gems and cached gem dependencies.
+          #
+          # @return [Net::HTTPResponse]
+          def stats
+            send_req Net::HTTP::Post, "/api/v1/stats"
+          end
+
+          ##
+          # Sends a request to the gemserver to ensure it is accessible.
+          #
+          # @return [Net::HTTPResponse]
+          def health
+            send_req Net::HTTP::Get, "/health"
+          end
+
+          private
+
+          ##
+          # @private The URL of the gemserver.
+          #
+          # @param [String] proj_name The Google Cloud Platform project the
+          # gemserver was deployed to.
+          #
+          # @return [String]
+          def remote proj_name
+            descrip = YAML.load(`gcloud app describe --project #{proj_name}`)
+            descrip["defaultHostname"]
+          end
+
+          ##
+          # @private Makes a request to the gemserver and returns the response.
+          #
+          # @param [Net::HTTP] type The type of HTTP request.
+          #
+          # @param [String] endpoint The endpoint the request is made to on the
+          # gemserver.
+          #
+          # @param [Object] params The data passed to the gemserver to be
+          # processed. Optional.
+          #
+          # @return [String]
+          def send_req type, endpoint, params = nil
+            auth = Google::Cloud::Gemserver::Authentication.new
+            t = auth.access_token["access_token"]
+            req = type.new endpoint
+            req["Authorization"] = Signet::OAuth2.generate_bearer_authorization_header t
+            if type != Net::HTTP::Get
+              req.set_form_data(params) if params
+            end
+            @http.request req
+          end
+        end
+      end
+    end
+  end
+end