google-oauth2-installed 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0fd293d3c682b7b881f874742c2a866c40a21e56
+  data.tar.gz: a29090bee93e2d663e6fe1b23c5433dd8d5fa08d
+SHA512:
+  metadata.gz: b8b51126e7116c1fbee34be163791e811dc618e1f94e3f742661a6fec37fe3c3cb51fbd7e091b0465a9f3b969720e9a8894bde8a691fbe9dcb8b6926875aed70
+  data.tar.gz: 39cf7d252c91b22894158b3d7967c3c75006ee3317a78312b2e884193a3f8f6457cc67c5bc30a7cd9a4b421adc3b3637f5f640ca876bb23ca64c1e5cde8f9794

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in google-oauth2-installed.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,32 @@
+PATH
+  remote: .
+  specs:
+    google-oauth2-installed (0.0.1)
+      oauth2
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    faraday (0.9.0)
+      multipart-post (>= 1.2, < 3)
+    jwt (0.1.11)
+      multi_json (>= 1.5)
+    multi_json (1.9.0)
+    multi_xml (0.5.5)
+    multipart-post (2.0.0)
+    oauth2 (0.9.3)
+      faraday (>= 0.8, < 0.10)
+      jwt (~> 0.1.8)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (~> 1.2)
+    rack (1.5.2)
+    rake (10.1.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.5)
+  google-oauth2-installed!
+  rake

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Amiel Martin
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,155 @@
+# Google Oauth2 Installed
+
+Configure and authenticate to Google with OAuth2 as an installed application.
+
+This is for when your application needs to authenticate to Google services, as
+opposed to your application's users.
+
+Extracted from applications that use the DFP and Analytics APIs,
+`google-oauth2-installed` helps with configuration (from `ENV`).
+It also helps with setup by providing an easy command to generate your OAuth tokens.
+
+For more information about Installed Apps: [https://developers.google.com/accounts/docs/OAuth2InstalledApp](https://developers.google.com/accounts/docs/OAuth2InstalledApp)
+
+
+## Why
+
+Google provides three ways to authenticate with OAuth2:
+
+1. **Web application**. This is what you use when your application needs access
+   as the user of your application.
+2. **Service account**. This is really what you want, but can only be used by
+   applications authenticating with a google apps account. If you have a google
+   apps account, do not use GoogleOAuth2Installed, use service accounts instead.
+3. **Installed application**. This allows you to authenticate as an application,
+   but still requires an `access_token`, which requires user interaction through
+   a browser. `google-oauth2-installed` tries to make this process as simple as
+   possible. The bad news is that `access_token`s expire. The good news is that
+   the `access_token` comes with a `refresh_token` that does not expire. So,
+   once you've aquired your tokens, you can store them for later use and forget
+   about it.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'google-oauth2-installed'
+
+Or install it yourself as:
+
+    $ gem install google-oauth2-installed
+
+## Setup
+
+### Create an application in Google Cloud Console
+
+First, you need to create an application identifier in Google Cloud Console. Please follow
+[these instructions](https://github.com/googleads/google-api-ads-ruby/wiki/OAuth2#creating-an-application-identifier)
+lovingly copied (and only slightly altered) from the
+[google-api-ads-ruby library](https://github.com/googleads/google-api-ads-ruby).
+
+> Visit [Google Cloud Console](https://cloud.google.com/console) and:
+>
+> 1. Click **CREATE PROJECT** to create a new project.
+> 1. Enter the Project Name (and optionally, choose your own Project ID), and click **Create**.
+> 1. The newly created project should automatically open. Click **APIs & auth** to expand the menu, and then click **Credentials**.
+> 1. Click **CREATE NEW CLIENT ID** to create a new client identifier and client secret.
+> 1. Choose **Installed application**, and **Other* for the "Installed application type".
+> 1. Click **CREATE CLIENT ID** to complete the registration. Client ID and client secret will be created and displayed.
+>
+> ![API Access Page](https://developers.google.com/adwords/api/images/oauth2-client-id-secret.png)
+>
+> The Client ID and secret values are the parameters you will need in the next step.
+
+### Set up your credentials in order to retrieve an access token
+
+Define the following environment variables. I recommend using the
+[`dotenv`](https://github.com/bkeepers/dotenv) gem (`dotenv-rails` in rails projects)
+and adding these variables to a `.env` file.
+
+```
+OAUTH2_CLIENT_ID="..."
+OAUTH2_CLIENT_SECRET="..."
+OAUTH2_SCOPE="..."
+```
+
+`OAUTH2_SCOPE` is a space delimited list of the scopes your application will
+need access to. For example, for readonly access to analytics, and write access to
+DFP, use:
+
+```
+OAUTH2_SCOPE="https://www.googleapis.com/auth/analytics.readonly https://www.google.com/apis/ads/publisher"
+```
+
+### Get your access token
+
+Once you have these environment variables defined, run this rake task and
+authenticate to google with the user you need access as.
+
+```
+rake googleoauthinstalled:get_access_token
+```
+
+This rake task will give you a url to load up in the browser. You will need to log in
+to Google, allow access to the requested scopes, and copy the provided code. Paste
+this code back in to the rake task that is waiting for you. It will then output the
+rest of the environment variables you need to authenticate.
+
+If you are using `.env`, it should now look something like:
+
+```shell
+OAUTH2_CLIENT_ID="..."
+OAUTH2_CLIENT_SECRET="..."
+OAUTH2_SCOPE="..."
+
+OAUTH2_ACCESS_TOKEN="..."
+OAUTH2_REFRESH_TOKEN="..."
+OAUTH2_EXPIRES_AT="..."
+```
+
+### Not in Rails?
+
+You might need to reference our rake task from your `Rakefile`. Try something like this:
+
+```ruby
+require 'rubygems'
+require 'bundler/setup'
+load 'tasks/get_access_token.rake'
+```
+
+## Usage
+
+Once you have all of your environment variables set up, just ask `GoogleOauth2Installed`
+for an access token. `GoogleOauth2Installed` will handle refreshing it if needed.
+
+Example usage with `Legato` for Analytics:
+
+```ruby
+Legato::User.new GoogleOauth2Installed.access_token
+```
+
+If you just need the details (and not a refreshed access token), use
+`GoogleOauth2Installed.credentials`.
+
+Example usage with `DfpApi`:
+
+```ruby
+dfp_authentication = GoogleOauth2Installed.credentials.merge(
+  application_name: ENV['DFP_APPLICATION_NAME'],
+  network_code: ENV['DFP_NETWORK_CODE'],
+)
+
+::DfpApi::Api.new({
+  authentication: dfp_authentication,
+  service: { environment: 'PRODUCTION' },
+})
+```
+
+## Contributing
+
+1. Fork it ([http://github.com/carnesmedia/google-oauth2-installed/fork](http://github.com/carnesmedia/google-oauth2-installed/fork))
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/google-oauth2-installed/access_token.rb

@@ -0,0 +1,27 @@
+require 'oauth2'
+
+module GoogleOauth2Installed
+  class AccessToken < Struct.new(:credentials)
+
+    def access_token
+      OAuth2::AccessToken.from_hash(client, token_hash).tap do |token|
+        token.refresh! if token.expired?
+      end
+    end
+
+    private
+
+    def client
+      @_client ||= OAuth2::Client.new(*oauth2_info)
+    end
+
+    def oauth2_info
+      credentials.values_at(:oauth2_client_id, :oauth2_client_secret, :oauth2_urls)
+    end
+
+    def token_hash
+      credentials[:oauth2_token]
+    end
+
+  end
+end

data/lib/google-oauth2-installed/checks.rb

@@ -0,0 +1,12 @@
+module GoogleOauth2Installed
+  class Checks < Struct.new(:credentials)
+
+    def check_for_environment!
+
+    end
+
+    def check_for_access_token
+
+    end
+  end
+end

data/lib/google-oauth2-installed/railtie.rb

@@ -0,0 +1,5 @@
+class GoogleOauth2Installed::Railtie < ::Rails::Railtie
+  rake_tasks do
+    load "tasks/get_access_token.rake"
+  end
+end

data/lib/google-oauth2-installed/setup.rb

@@ -0,0 +1,71 @@
+module GoogleOauth2Installed
+  # To be used interactively.
+  # See `GoogleOauth2Installed.get_access_token`
+  class Setup < Struct.new(:credentials)
+
+    def get_access_token
+      checks.check_for_environment!
+
+      auth_url = get_auth_url
+      auth_code = ask_for_code auth_url
+
+      token = get_token auth_code
+
+      print_token token
+    end
+
+    private
+
+    def checks
+      Checks.new credentials
+    end
+
+    def client
+      oauth2_info = credentials.values_at :oauth2_client_id, :oauth2_client_secret, :oauth2_urls
+      @_client ||= OAuth2::Client.new(*oauth2_info)
+    end
+
+    def get_auth_url
+      client.auth_code.authorize_url({
+        scope: scope, redirect_uri: redirect_uri,
+        access_type: 'offline', approval_prompt: 'force',
+      })
+    end
+
+    def ask_for_code(auth_url)
+      puts "Please navigate to URL:\n\n\t%s\n\n" % auth_url
+      print 'Then log in and paste the verification code: '
+
+      gets.chomp
+    end
+
+    def get_token(auth_code)
+      client.auth_code.get_token auth_code, redirect_uri: redirect_uri
+    end
+
+    def print_token(token)
+      env_vars = env_vars_for_token(token).map { |a| a.join('=') }.join("\n")
+      puts "\nRetrieved token from google. Put this in .env\n\n%s" % env_vars
+    end
+
+    def env_vars_for_token(token)
+      names = ["OAUTH2_ACCESS_TOKEN", "OAUTH2_REFRESH_TOKEN", "OAUTH2_EXPIRES_AT"]
+      values = [token.token, token.refresh_token, token.expires_at].map { |v| "\"#{v}\"" }
+
+      names.zip(values)
+    end
+
+    def redirect_uri
+      credentials[:oauth2_redirect_uri]
+    end
+
+    def scope
+      credentials[:oauth2_scope]
+    end
+
+    extend Forwardable
+    def_delegator '$stdin', :gets
+    def_delegator '$stdout', :puts
+  end
+end
+

data/lib/google-oauth2-installed/version.rb

@@ -0,0 +1,3 @@
+module GoogleOauth2Installed
+  VERSION = "0.0.1"
+end

data/lib/google-oauth2-installed.rb

@@ -0,0 +1,48 @@
+require 'google-oauth2-installed/version'
+require 'google-oauth2-installed/setup'
+require 'google-oauth2-installed/checks'
+require 'google-oauth2-installed/access_token'
+
+module GoogleOauth2Installed
+
+  # A centralized place to access all loaded configuration and defaults.
+  def self.credentials
+    {
+      method: 'OAuth2',
+      oauth2_client_id: ENV["OAUTH2_CLIENT_ID"],
+      oauth2_client_secret: ENV["OAUTH2_CLIENT_SECRET"],
+      oauth2_token: oauth2_token,
+      oauth2_scope: ENV['OAUTH2_SCOPE'],
+      oauth2_redirect_uri: 'urn:ietf:wg:oauth:2.0:oob',
+      oauth2_urls: {
+        authorize_url: 'https://accounts.google.com/o/oauth2/auth',
+        token_url: 'https://accounts.google.com/o/oauth2/token',
+      },
+    }
+  end
+
+  def self.access_token
+    AccessToken.new(credentials).access_token
+  end
+
+  # To be used interactively
+  def self.get_access_token
+    Setup.new(credentials).get_access_token
+  end
+
+  private
+
+  def self.oauth2_token
+    if ENV["OAUTH2_ACCESS_TOKEN"]
+      {
+        access_token: ENV["OAUTH2_ACCESS_TOKEN"],
+        refresh_token: ENV["OAUTH2_REFRESH_TOKEN"],
+        expires_at: ENV["OAUTH2_EXPIRES_AT"].to_i,
+      }
+    end
+  end
+
+end
+
+
+require 'google-oauth2-installed/railtie' if defined?(Rails::Railtie)

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: google-oauth2-installed
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Amiel Martin
+- Kristian Freeman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: oauth2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: "\n    Extracted from applications that use the DFP and Analytics apis,\n
+  \   google-oauth2-installed helps with configuration (from ENV).\n    It also helps
+  with setup by providing an easy command to generate your OAuth tokens.\n  "
+email:
+- amiel@carnesmedia.com
+- kristian@carnesmedia.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/google-oauth2-installed.rb
+- lib/google-oauth2-installed/access_token.rb
+- lib/google-oauth2-installed/checks.rb
+- lib/google-oauth2-installed/railtie.rb
+- lib/google-oauth2-installed/setup.rb
+- lib/google-oauth2-installed/version.rb
+homepage: https://github.com/carnesmedia/google-oauth2-installed
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.0
+signing_key: 
+specification_version: 4
+summary: Configure and authenticate to google with OAuth2 as an installed application
+test_files: []