google-idtoken-verifier 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: acdf11410e06bf2bd19f729bc35f2398916ee109
-  data.tar.gz: f0cbbe93cb70ef45109f04220ed1cc415cddb0c3
+  metadata.gz: 334f749f8649883a8a3471d3d811cd8e8682de4e
+  data.tar.gz: 0e7fe4c598f1880753ee3d3a176f0ae2cf361fe3
 SHA512:
-  metadata.gz: 9ec9ac7dd777c8e7fc120f2d021d6a55b6b296d1a03aa236abe43bff44a3ddbcd958491902f4cd60cd4e5ca558f62655d435a6bbc41b8aeda6c6e75dd0cf6707
-  data.tar.gz: 91c5bf5eb2373e20de9f2cd056a350676b2a75db1bc510bcfb9d0821d0c72c6b225ccebe3671a7088d0829b72777f99d9e33466c97fffa126b6be238f32e97e2
+  metadata.gz: 8dab75fa9e097327dc8d802e8637eebeb8153ec7b2f08337d8fc657b50292f2a770ba0e1cabe466545ff28cc7cb8249d423224de6c6c9cf54fc782beaa2a0d7f
+  data.tar.gz: 936e0206546b2ae20324d1f2fabfed234e5fba5f20ed9345fac229b5ddfd3deeadf2d93cfe4450d6a207b7f090728a49ba6a5560d6432a3ca74dcf8918d275bb

data/.rubocop.yml

@@ -0,0 +1,10 @@
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/Documentation:
+  Enabled: false
+
+Metrics/MethodLength:
+  Exclude:
+    - "test/**/*"
+    - "lib/google/idtoken/verifier/cli/**/*"

data/Gemfile

@@ -1,4 +1,4 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
 # Specify your gem's dependencies in google-idtoken-verifier.gemspec
 gemspec

data/README.md

@@ -1,5 +1,12 @@
 # Google::Idtoken::Verifier
 
+[![Gem Version](https://badge.fury.io/rb/google-idtoken-verifier.svg)](http://badge.fury.io/rb/google-idtoken-verifier)
+[![Build Status](https://travis-ci.org/jnbt/google-idtoken-verifier.svg?branch=master)](https://travis-ci.org/jnbt/google-idtoken-verifier)
+[![Coverage Status](https://coveralls.io/repos/jnbt/google-idtoken-verifier/badge.svg?branch=master&service=github)](https://coveralls.io/r/jnbt/google-idtoken-verifier?branch=master)
+[![Code Climate](https://codeclimate.com/github/jnbt/google-idtoken-verifier/badges/gpa.svg)](https://codeclimate.com/github/jnbt/google-idtoken-verifier)
+[![Dependency Status](https://gemnasium.com/jnbt/google-idtoken-verifier.svg)](https://gemnasium.com/jnbt/google-idtoken-verifier)
+[![Inline docs](https://inch-ci.org/github/jnbt/google-idtoken-verifier.svg?branch=master)](https://inch-ci.org/github/jnbt/google-idtoken-verifier)
+
 Ruby interface to Google's API to verify ID tokens
 
 ## Installation
@@ -20,7 +27,16 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+```ruby
+result = Verifier.verify("an_id_token")
+if result.valid?
+  puts "ID: #{result.data["sub"]}"
+  puts "Audience: #{result.data["aud"]}"
+  # here you should check the 'aud' value against your apps
+else
+  puts "Invalid ID token"
+end
+```
 
 ## Development
 

data/Rakefile

@@ -1,10 +1,13 @@
 require "bundler/gem_tasks"
 require "rake/testtask"
+require "rubocop/rake_task"
 
 Rake::TestTask.new(:test) do |t|
   t.libs << "test"
   t.libs << "lib"
-  t.test_files = FileList['test/**/*_test.rb']
+  t.test_files = FileList["test/**/*_test.rb"]
 end
 
-task :default => :test
+RuboCop::RakeTask.new
+
+task default: [:test, :rubocop]

data/bin/google_idtoken_verifier

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "google/idtoken/verifier"
+require "google/idtoken/verifier/cli"
+
+Google::Idtoken::Verifier::CLI::App.start

data/google-idtoken-verifier.gemspec

@@ -1,7 +1,7 @@
 # coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'google/idtoken/verifier/version'
+require "google/idtoken/verifier/version"
 
 Gem::Specification.new do |spec|
   spec.name          = "google-idtoken-verifier"
@@ -9,15 +9,26 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Jonas Thiel"]
   spec.email         = ["jt@neopoly.de"]
 
-  spec.summary       = %q{Ruby interface to Google's API to verify ID tokens}
-  spec.description   = %q{Ruby interface to Google's API to verify ID tokens}
+  spec.summary       = "Ruby interface to Google's API to verify ID tokens"
+  spec.description   = "Ruby interface to Google's API to verify ID tokens"
   spec.homepage      = "https://github.com/jnbt/google-idtoken-verifier"
   spec.license       = "MIT"
 
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+
+  spec.executables   = spec.files.grep(%r{^bin\/}) { |f| File.basename(f) }
+
   spec.require_paths = ["lib"]
 
+  spec.add_dependency "json", "~> 1.8"
+
   spec.add_development_dependency "bundler", "~> 1.10"
   spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "coveralls", "~> 0.8"
   spec.add_development_dependency "minitest"
+  spec.add_development_dependency "webmock", "~> 1.21"
+  spec.add_development_dependency "inch", "~> 0.6"
+  spec.add_development_dependency "rubocop", "~> 0.33"
 end

data/lib/google/idtoken/verifier.rb

@@ -1,9 +1,30 @@
+require "google/idtoken/verifier/client"
+require "google/idtoken/verifier/error"
+require "google/idtoken/verifier/result"
 require "google/idtoken/verifier/version"
 
 module Google
   module Idtoken
+    # Ruby interface to Google's API to verify ID tokens
+    # @usage
+    #
+    #   result = Verifier.verify("an_id_token")
+    #   if result.valid?
+    #     puts "ID: #{result.data["sub"]}"
+    #     puts "Audience: #{result.data["aud"]}"
+    #     # here you should check the 'aud' value against your apps
+    #   else
+    #    puts "Invalid ID token"
+    #   end
+    #
     module Verifier
-      # Your code goes here...
+      # Checks an ID token
+      # @param id_token [String] ID token to verify
+      # @return [Result] API result
+      def self.verify(id_token)
+        response = Client.new(id_token).call
+        Result.new(response)
+      end
     end
   end
 end

data/lib/google/idtoken/verifier/cli.rb

@@ -0,0 +1,13 @@
+require "google/idtoken/verifier/cli/app"
+require "google/idtoken/verifier/cli/out"
+require "google/idtoken/verifier/cli/commands"
+
+module Google
+  module Idtoken
+    module Verifier
+      # Namespace holding the implementation of the CLI
+      module CLI
+      end
+    end
+  end
+end

data/lib/google/idtoken/verifier/cli/app.rb

@@ -0,0 +1,68 @@
+require "optparse"
+
+module Google
+  module Idtoken
+    module Verifier
+      module CLI
+        # Main class for the executable 'google_idtoken_verifier'
+        # @example
+        #   $ google_idtoken_verifier -h
+        class App
+          def self.start
+            App.new(ARGV).run
+          end
+
+          # Arguments the application was called with
+          attr_reader :args
+          # Output buffer
+          attr_reader :out
+
+          def initialize(args, out = Out.new)
+            @args = args
+            @out  = out
+          end
+
+          def run
+            if args.empty?
+              out.print opt_parser
+            else
+              opt_parser.parse!(args)
+            end
+          end
+
+          def check(id_token)
+            Commands::Check.run(id_token)
+          end
+
+          def version
+            Commands::Version.run
+          end
+
+          private
+
+          def opt_parser
+            OptionParser.new do |opts|
+              opts.banner = "Usage: google_idtoken_verifier [options]"
+
+              opts.separator ""
+              opts.separator "Options:"
+
+              opts.on("-c", "--verify ID_TOKEN",
+                      "Verify an Google Signin ID token") do |token|
+                check(token)
+              end
+
+              opts.on_tail("-h", "--help", "Show this message") do
+                out.print opts
+              end
+
+              opts.on_tail("-v", "--version", "Show version") do
+                version
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/google/idtoken/verifier/cli/commands.rb

@@ -0,0 +1,30 @@
+module Google
+  module Idtoken
+    module Verifier
+      module CLI
+        # Module for actual commands which can be invoked from the terminal
+        module Commands
+          # Base for all commands providing simple support for running a single
+          # command and printing to an {Out} instance
+          class Base
+            # Run a single instance of a command
+            # @param args [Array] arguments for the command
+            # @return [Base] the command after the run
+            def self.run(*args)
+              new(*args).tap(&:run)
+            end
+
+            protected
+
+            def out
+              @out ||= Out.new
+            end
+          end
+        end
+      end
+    end
+  end
+end
+
+require "google/idtoken/verifier/cli/commands/check"
+require "google/idtoken/verifier/cli/commands/version"

data/lib/google/idtoken/verifier/cli/commands/check.rb

@@ -0,0 +1,42 @@
+module Google
+  module Idtoken
+    module Verifier
+      module CLI
+        module Commands
+          # Command to check an ID token
+          class Check < Base
+            # Prepare a verification run from the terminal
+            # @param id_token [String]
+            def initialize(id_token)
+              @id_token = id_token
+            end
+
+            # Prints the verification result of an ID token
+            def run
+              result = Verifier.verify(@id_token)
+              if result.valid?
+                print_valid
+              else
+                print_invalid
+              end
+              out.print "Data:"
+              out.pretty result.data
+            end
+
+            private
+
+            def print_valid
+              out.print "Valid ID token!"
+              out.print
+            end
+
+            def print_invalid
+              out.print "INVALID ID token!"
+              out.print
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/google/idtoken/verifier/cli/commands/version.rb

@@ -0,0 +1,17 @@
+module Google
+  module Idtoken
+    module Verifier
+      module CLI
+        module Commands
+          # Command to show the gem's version
+          class Version < Base
+            # Prints the current gem's version to the command line
+            def run
+              out.print Verifier::VERSION
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/google/idtoken/verifier/cli/out.rb

@@ -0,0 +1,36 @@
+require "pp"
+
+module Google
+  module Idtoken
+    module Verifier
+      module CLI
+        # A wrapper to output text information to any kind of buffer
+        # @example
+        #   out = Out.new(std_buffer)
+        #   out.print('something') # => appends 'something' to std_buffer
+        class Out
+          # @return [Object] buffer used as default outlet
+          attr_reader :out
+
+          # Bind a new out instance to two buffers
+          # @param out [Object] STDOUT is default
+          def initialize(out = $stdout)
+            @out = out
+          end
+
+          # Prints to +out+
+          # @param text [String]
+          def print(text = "")
+            out.puts text
+          end
+
+          # Pretty print an object to +out+
+          # @param object [Object]
+          def pretty(object)
+            PP.pp(object, out)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/google/idtoken/verifier/client.rb

@@ -0,0 +1,41 @@
+require "json"
+
+module Google
+  module Idtoken
+    module Verifier
+      # API client for requesting the state of an ID token
+      class Client
+        # Global REST endpoint to use
+        ENDPOINT = "https://www.googleapis.com/oauth2/v3/tokeninfo?id_token=%s"
+
+        # ID token to verify
+        attr_reader :id_token
+
+        # Initializes a new client bound to an ID token
+        # @param id_token [String] to verify
+        def initialize(id_token)
+          @id_token = id_token
+        end
+
+        # Interacts with the Google API
+        # @return [Hash] the parsed JSON response
+        # @raise [Error] if any error occures
+        def call
+          JSON.parse(verify_call)
+        rescue StandardError => e
+          raise Error, e.message
+        end
+
+        private
+
+        def verify_call
+          Net::HTTP.get(api_endpoint_uri)
+        end
+
+        def api_endpoint_uri
+          URI(ENDPOINT % id_token)
+        end
+      end
+    end
+  end
+end

data/lib/google/idtoken/verifier/error.rb

@@ -0,0 +1,10 @@
+require "json"
+
+module Google
+  module Idtoken
+    module Verifier
+      # Custom error class for rescuing from all Verifier errors
+      class Error < StandardError; end
+    end
+  end
+end

data/lib/google/idtoken/verifier/result.rb

@@ -0,0 +1,23 @@
+module Google
+  module Idtoken
+    module Verifier
+      # Wraps the API response
+      class Result
+        # Parsed API response
+        attr_reader :data
+
+        # Wraps a parsed API response
+        # @param data [Hash] from Google's API
+        def initialize(data)
+          @data = data
+        end
+
+        # Checks if the API recognized the ID token as valid
+        # @return [Boolean]
+        def valid?
+          data && !data["sub"].nil?
+        end
+      end
+    end
+  end
+end

data/lib/google/idtoken/verifier/version.rb

@@ -1,7 +1,8 @@
 module Google
   module Idtoken
     module Verifier
-      VERSION = "0.0.1"
+      # The current gem's version
+      VERSION = "0.1.0"
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: google-idtoken-verifier
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Jonas Thiel
@@ -10,6 +10,20 @@ bindir: bin
 cert_chain: []
 date: 2015-09-01 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -38,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -52,14 +80,58 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+- !ruby/object:Gem::Dependency
+  name: inch
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.33'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.33'
 description: Ruby interface to Google's API to verify ID tokens
 email:
 - jt@neopoly.de
-executables: []
+executables:
+- google_idtoken_verifier
 extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rubocop.yml"
 - ".ruby-gemset"
 - ".ruby-version"
 - ".travis.yml"
@@ -67,8 +139,18 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- bin/google_idtoken_verifier
 - google-idtoken-verifier.gemspec
 - lib/google/idtoken/verifier.rb
+- lib/google/idtoken/verifier/cli.rb
+- lib/google/idtoken/verifier/cli/app.rb
+- lib/google/idtoken/verifier/cli/commands.rb
+- lib/google/idtoken/verifier/cli/commands/check.rb
+- lib/google/idtoken/verifier/cli/commands/version.rb
+- lib/google/idtoken/verifier/cli/out.rb
+- lib/google/idtoken/verifier/client.rb
+- lib/google/idtoken/verifier/error.rb
+- lib/google/idtoken/verifier/result.rb
 - lib/google/idtoken/verifier/version.rb
 homepage: https://github.com/jnbt/google-idtoken-verifier
 licenses:
@@ -95,3 +177,4 @@ signing_key:
 specification_version: 4
 summary: Ruby interface to Google's API to verify ID tokens
 test_files: []
+has_rdoc: