google-cloud-gemserver 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1c8bda7c5d0a26bc56b99d81b60ab98e87fc2977
+  data.tar.gz: 91cef6024bb375426a28ffe59f4c389d655ca382
+SHA512:
+  metadata.gz: d647ffd4d5611143907984ba56016e3ae53edf4c30412ebb5feb804f4c9caedef32b8c0968c4e8544a1b060bcb787b150f1f509551d2a316276be070eccccd34
+  data.tar.gz: 223baeb4f3bce4ff4d73917c2a6afd890a32d02ed286008234202d55a01c76d9951853bf00ae6d5ab8945f5a5ca76492359ba39ee0511ad348a3aedf1f608da0

data/.yardopts

@@ -0,0 +1,7 @@
+--no-private
+--title=Google Cloud Gemserver
+--markup markdown
+
+./lib/**/*.rb
+
+README.md

data/CONTRIBUTING.md

@@ -0,0 +1,49 @@
+# How to Contribute
+
+We'd love to accept your patches and contributions to this project. There are
+just a few small guidelines you need to follow.
+
+## Contributor License Agreement
+
+Contributions to this project must be accompanied by a Contributor License
+Agreement. You (or your employer) retain the copyright to your contribution,
+this simply gives us permission to use and redistribute your contributions as
+part of the project. Head over to <https://cla.developers.google.com/> to see
+your current agreements on file or to sign a new one.
+
+You generally only need to submit a CLA once, so if you've already submitted one
+(even if it was for a different project), you probably don't need to do it
+again.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+### Running tests
+
+Note: you will need gemstash installed from
+[source](https://github.com/bundler/gemstash) to run acceptance and integration
+tests.
+
+  1) Edit your app.yaml to use a separate database to run tests on otherwise
+    your existing private gems can get deleted.
+  2) Generate a test-key with both read/write permissions (my-test-key).
+  3) To run unit tests:
+    `bundle exec rake test`
+  3) To run acceptance and performance tests:
+    Ensure cloud_sql_proxy is running and connected to the CloudSQL instance of
+    your testing gemserver (dev prefix) in app.yaml.
+    `bundle exec rake test host=test-gemserver-url.com key=my-test-key`
+  4) To run integration tests:
+    Ensure cloud_sql_proxy is running and connected to the CloudSQL instance of
+    your testing gemserver (dev prefix) in app.yaml.
+    `bundle exec rake integration host=test-gemserver-url.com key=my-test-key`
+
+### Travis PR Builds
+
+By default, unit tests will always run for every update to a PR. Acceptance and
+integration tests will run after a PR is merged. If tests break, please submit a
+separate PR to fix the issues.
+

data/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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
+
+       http://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.

data/README.md

@@ -0,0 +1,179 @@
+# Google::Cloud::Gemserver
+
+[![Build Status](https://travis-ci.org/GoogleCloudPlatform/google-cloud-gemserver.svg?branch=master)](https://travis-ci.org/GoogleCloudPlatform/google-cloud-ruby)
+
+This gem is a tool that lets you manage, interact with, and deploy a [private gem
+server](https://github.com/bundler/gemstash) to a Google Cloud Platform project.
+The gemserver acts as a private gem repository for your gems similar
+to how rubygems.org works with the exception that pushing and installing gems
+are protected operations.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'google-cloud-gemserver'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install google-cloud-gemserver
+
+## Usage
+
+### Basic Prerequisites
+  1) Create a Google Cloud Platform (GCP) project.
+  2) Install and setup the [gcloud SDK](https://cloud.google.com/sdk/downloads). Currently, versions 161+ are supported.
+  3) Authenticate gcloud by using a [service account](https://cloud.google.com/docs/authentication/getting-started) or [application default credentials](https://developers.google.com/identity/protocols/application-default-credentials).
+  Using a service account is the recommended method for authentication; application default credentials should only be used for development purporses. Read this [authentication guide](docs/authentication.md) for more information.
+  4) Running acceptance or performance tests requires you to have the Cloud SQL proxy running with your Cloud SQL instance. Visit this [link](https://cloud.google.com/sql/docs/mysql/connect-admin-proxy) to learn how to install and run it (steps 3 and 5 can be skipped).
+
+### Typical Workflow
+  1) Deploy a gemserver by running: `google-cloud-gemserver create --use-proj YOUR_PROJECT_ID`. This deploys the gemserver in a Google App Engine project as the default service. It also creates a new Cloud SQL instance with machine type db-f1-micro. Note that this machine type is only recommended for development / testing and is not under the Cloud SQL SLA coverage.
+  2) Generate a key (referred to as my-key) by running `google-cloud-gemserver create-key --use-proj YOUR_PROJECT_ID` for your gemserver. By default, this generates a key with both read and write permissions. For more information about keys, read [this](docs/key.md).
+  3) Add this key to your bundle config by running `bundle config http://gemserver-url.com/private/ my-key` where gemserver-url is the same as your project's url, e.g. http://my-project.appspot.com/private/. This is necessary to download gems.
+  4) Add this key to your gem credentials as my-key (in ~/.gem/credentials): `:my-key: [KEY]` This is necessary to push gems (if the key has write permission).
+  5) Push private gems to the gemserver as described [below](#pushing-gems).
+  6) Download private gems by modifying your Gemfile as described
+  [below](#fetching-gems).
+
+### Pushing gems
+  Note: ensure `my-key` has the read permission and is added in your gem
+  credentials file (~/.gem/credentials)
+  `gem push my-gem --key my-key --host http://my-gemserver.com/private/`
+
+### Fetching gems
+  Note: ensure `my-key` has the read permission and is set in your bundle
+  config by running `bundle config http://my-gemserver.com/private/ my-key`
+
+  1) Add `source "http://my-gemserver.com"` to the top of your Gemfile
+  2) Add the following to your Gemfile:
+      ```
+      source "http://my-gemserver.com/private" do
+        gem "my-private-gem1"
+        (other private gems here)
+      end
+      ```
+  3) Run `bundle install`
+
+### Yanking gems
+  Note: ensure `my-key` has the write permission and is added in your gem
+  credentials file (~/.gem/credentials)
+  `gem push my-gem --key my-key --host http://my-gemserver.com/private/`
+
+  1) Run `gem yank --key my-key [GEM_NAME] --host
+  http://my-gemserver.com/private`
+
+  Gems can not be "unyanked" so once a gem has been yanked it cannot be pushed
+  to the gemserver again with the same name and version. It can be pushed if the
+  version number is changed, however.
+
+
+### Gemserver commands
+  * `google-cloud-gemserver config`
+
+    Usage:
+    google-cloud-gemserver config
+
+    Displays the config the current deployed gemserver is using (if one is running)
+
+  * `google-cloud-gemserver create`
+
+    Usage:
+    google-cloud-gemserver create
+
+    Options:
+    *  -g, [--use-proj=USE_PROJ]        # Existing project to deploy gemserver to
+    *  -i, [--use-inst=USE_INST]        # Existing project to deploy gemserver to
+
+    Creates and deploys the gem server then starts it
+
+  * `google-cloud-gemserver create-key`
+
+    Usage:
+      google-cloud-gemserver create-key
+
+    Options:
+    *  -r, [--remote=REMOTE]            # The gemserver URL, i.e. gemserver.com
+    *  -p, [--permissions=PERMISSIONS]  # Options: write, read, both. Default is
+      both.
+    *  -g, [--use-proj=USE_PROJ]        # The GCP project the gemserver was
+       deployed to.
+
+      Creates an authentication key
+
+  * `google-cloud-gemserver delete-key`
+
+    Usage:
+      google-cloud-gemserver delete-key
+
+    Options:
+    *  -r, [--remote=REMOTE]            # The gemserver URL, i.e. gemserver.com
+    *  -k, [--key=KEY]                  # The key to delete
+    *  -g, [--use-proj=USE_PROJ]        # The GCP project the gemserver was
+       deployed to.
+
+      Deletes a given key
+
+  * `google-cloud-gemserver delete`
+
+    Usage:
+      google-cloud-gemserver delete
+
+    Options:
+    *  -g, [--use-proj=USE_PROJ]        # Project id of GCP project the gemserver was deployed to. Warning: parent project and CloudSQL instance will also be deleted
+
+      Delete a given gemserver
+
+  * `google-cloud-gemserver start`
+
+      Usage:
+        google-cloud-gemserver start
+
+      Starts the gem server. This will be run automatically after a deploy.
+      Running this locally will start the gemserver locally
+
+  * `google-cloud-gemserver stats`
+
+    Usage:
+      google-cloud-gemserver stats
+
+    Options:
+    *  -r, [--remote=REMOTE]            # The gemserver URL, i.e. gemserver.com
+    *  -g, [--use-proj=USE_PROJ]        # The GCP project the gemserver was
+       deployed to.
+
+    Displays statistics on the given gemserver
+
+  * `google-cloud-gemserver update`
+
+    Usage:
+      google-cloud-gemserver update
+
+    Redeploys the gemserver with the current config file and google-cloud-gemserver gem version (a deploy must have succeeded for 'update' to work)
+
+  * `google-cloud-gemserver gen-config`
+
+    Usage:
+      google-cloud-gemserver gen-config
+
+    Generates configuration files with default values
+
+  * `google-cloud-gemserver help`
+
+    Usage:
+      google-cloud-gemserver help [COMMAND]
+
+    Describe available commands or one specific command
+
+More documentation can be found in the docs [directory](docs/).
+
+## Contributing
+
+Detailed information can be found in [CONTRIBUTING.md](CONTRIBUTING.md).
+

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "google/cloud/gemserver"
+
+require "irb"
+IRB.start(__FILE__)