google_refresh 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 84d21dfb907674eb01dc2563889e5e2062617d52
+  data.tar.gz: 1526189e9874a6f354f6aa1cbaa550f77f1fdcc5
+SHA512:
+  metadata.gz: 3164a025548f5cfee2adcb13ea1e68ea5aae9b99e1cef6cb787092acaa0c94d31a39688861292c4f560b94a961957ae1e481d26e3a6996e6b3558bfec6bbfa05
+  data.tar.gz: 279352235af5edccc5f005719f92389c8e27f46d5cf177047ba2a010e9d6a5ec5c2e3822feac21be6d81a931ed16851c0a57ade78d1300d2c34cbf299e615736

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Rich Rines
+
+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,35 @@
+# GoogleRefresh
+
+I got tired of writing the boiler plate code to retrieve a new access or oauth2
+token projects using Google APIs so I threw it into a gem. It requires that your
+app has offline access permissions.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'google_refresh'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install google_refresh
+
+## Usage
+
+    # string token
+    token = GoogleRefresh::Token.new(client_id, client_secret, refresh_token, scope).retrieve_string_token
+
+    # oauth2 token
+    token = GoogleRefresh::Token.new(client_id, client_secret, refresh_token, scope).retrieve_oauth2_token
+
+## Contributing
+
+1. Fork it
+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/google_refresh.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'google_refresh/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "google_refresh"
+  spec.version       = GoogleRefresh::VERSION
+  spec.authors       = ["Rich Rines"]
+  spec.email         = ["rich.rines@me.com"]
+  spec.description   = %q{Manage Google Refresh Tokens with Ease}
+  spec.summary       = %q{A simple way to retrieve oauth and string tokens via refresh tokens for use with Google apis.}
+  spec.homepage      = "http://github.com/richrines/google_refresh"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.post_install_message = "So Refresh"
+
+  spec.required_ruby_version     = '>= 1.9.3'
+
+  spec.add_dependency 'httparty', '>= 0.13.1'
+  spec.add_dependency 'oauth2', '>= 1.0.0'
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'pry'
+end

data/lib/google_refresh.rb

@@ -0,0 +1,105 @@
+require "google_refresh/version"
+require "google_refresh/errors"
+require "httparty"
+require "oauth2"
+
+module GoogleRefresh
+  class Token
+    ACCESS_TOKEN_FAILURE_MESSAGE = 'Failed to Retrieve Access Token'
+    ACCESS_TYPE = 'offline'
+    CONTENT_TYPE = 'application/x-www-form-urlencoded'
+    DEFAULT_SCOPE = %w[profile email]
+    GOOGLE_AUTHORIZE_URL = 'https://accounts.google.com/o/oauth2/auth'
+    GOOGLE_TOKEN_URL = 'https://accounts.google.com/o/oauth2/token'
+    GRANT_TYPE = 'refresh_token'
+    MISSING_CLIENT_ID_ERROR_MESSAGE = 'Missing Client Id'
+    MISSING_CLIENT_SECRET_ERROR_MESSAGE = 'Missing Client Secret'
+    MISSING_REFRESH_TOKEN_ERROR_MESSAGE = 'Missing Refresh Token'
+    OAUTH_TOKEN_FAILURE_MESSAGE = 'Failed to Retrieve Oauth Token'
+
+    def initialize(client_id, client_secret, redirect_uri, refresh_token, scope=nil)
+      @client_id = client_id
+      @client_secret = client_secret
+      @redirect_uri = redirect_uri
+      @refresh_token = refresh_token
+      @scope = scope || DEFAULT_SCOPE
+    end
+
+    def retrieve_string_token
+      ensure_credentials_are_present
+      get_access_token
+    end
+
+    def retrieve_oauth2_token
+      ensure_credentials_are_present
+      get_access_token
+      create_outh2_client
+      return_oauth2_token
+    end
+
+    private
+
+    def ensure_credentials_are_present
+      if !@client_id
+        raise InvalidCredentialsError, MISSING_CLIENT_ID_ERROR_MESSAGE
+      elsif !@client_secret
+        raise InvalidCredentialsError, MISSING_CLIENT_SECRET_ERROR_MESSAGE
+      elsif !@refresh_token
+        raise InvalidCredentialsError, MISSING_REFRESH_TOKEN_ERROR_MESSAGE
+      else
+        true
+      end
+    end
+
+    def options
+      {
+        body: {
+          client_id: @client_id,
+          client_secret: @client_secret,
+          refresh_token: @refresh_token,
+          grant_type: GRANT_TYPE
+        },
+        headers: {
+          'Content-Type': CONTENT_TYPE
+
+        }
+      }
+    end
+
+    def get_access_token
+      refresh = HTTParty.post(GOOGLE_TOKEN_URL, options)
+      if refresh.code == 200
+        @token = refresh.parsed_response['access_token']
+      else
+        raise AccessTokenRetrievalError, ACCESS_TOKEN_FAILURE_MESSAGE
+      end
+    end
+
+    def create_outh2_client
+      @client = OAuth2::Client.new(
+        @client_id,
+        @client_secret, {
+          authorize_url: GOOGLE_AUTHORIZE_URL,
+          token_url: GOOGLE_TOKEN_URL
+        }
+      )
+
+      @client.auth_code.authorize_url(
+        {
+          scope: @scope,
+          redirect_uri: @redirect_uri,
+          access_type: ACCESS_TYPE
+        }
+      )
+    end
+
+    def return_oauth2_token
+      oauth = OAuth2::AccessToken.from_hash @client, { access_token: @token }
+      if oauth
+        oauth
+      else
+        raise OauthTokenRetrievalError, OAUTH_TOKEN_FAILURE_MESSAGE
+      end
+    end
+  end
+end

data/lib/google_refresh/errors.rb

@@ -0,0 +1,5 @@
+module GoogleRefresh
+  class InvalidCredentialsError < StandardError; end
+  class AccessTokenRetrievalError < StandardError; end
+  class OauthTokenRetrievalError < StandardError; end
+end

data/lib/google_refresh/version.rb

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

metadata

@@ -0,0 +1,139 @@
+--- !ruby/object:Gem::Specification
+name: google_refresh
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Rich Rines
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.13.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.13.1
+- !ruby/object:Gem::Dependency
+  name: oauth2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: Manage Google Refresh Tokens with Ease
+email:
+- rich.rines@me.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- google_refresh.gemspec
+- lib/google_refresh.rb
+- lib/google_refresh/errors.rb
+- lib/google_refresh/version.rb
+homepage: http://github.com/richrines/google_refresh
+licenses:
+- MIT
+metadata: {}
+post_install_message: So Refresh
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: A simple way to retrieve oauth and string tokens via refresh tokens for use
+  with Google apis.
+test_files: []
+has_rdoc: