signet 0.2.2 → 0.2.3

data/CHANGELOG

@@ -1,3 +1,8 @@
+== 0.2.3
+
+* Added support for JWT-formatted ID tokens.
+* Added :issued_at option to #update_token! method.
+
 == 0.2.2
 
 * Lowered requirements for json gem

data/lib/signet.rb

@@ -42,8 +42,7 @@ module Signet #:nodoc:
         raise ParseError,
           "Unexpected auth param format: '#{auth_param_string}'."
       end
-      pair = match.captures[0]
-      auth_param_pairs << pair
+      auth_param_pairs << match.captures[0] # Appending pair
       remainder = match.post_match
       last_match = match
     end

data/lib/signet/oauth_1/client.rb

@@ -557,7 +557,6 @@ module Signet
           )
         ]
         headers = [authorization_header]
-        headers << ['Cache-Control', 'no-store']
         if method == 'POST'
           headers << ['Content-Type', 'application/x-www-form-urlencoded']
         end

data/lib/signet/oauth_2/client.rb

@@ -17,6 +17,7 @@ require 'addressable/uri'
 require 'signet'
 require 'signet/errors'
 require 'signet/oauth_2'
+require 'jwt'
 
 module Signet
   module OAuth2
@@ -61,6 +62,8 @@ module Signet
       #     to be refreshed.
       #   - <code>:access_token</code> —
       #     The current access token for this client.
+      #   - <code>:id_token</code> —
+      #     The current ID token for this client.
       #
       # @example
       #   client = Signet::OAuth2::Client.new(
@@ -119,6 +122,8 @@ module Signet
       #     to be refreshed.
       #   - <code>:access_token</code> —
       #     The current access token for this client.
+      #   - <code>:id_token</code> —
+      #     The current ID token for this client.
       #   - <code>:expires_in</code> —
       #     The current access token for this client.
       #
@@ -163,8 +168,12 @@ module Signet
       #     to be refreshed.
       #   - <code>:access_token</code> —
       #     The current access token for this client.
+      #   - <code>:id_token</code> —
+      #     The current ID token for this client.
       #   - <code>:expires_in</code> —
       #     The current access token for this client.
+      #   - <code>:issued_at</code> —
+      #     The timestamp that the token was issued at.
       #
       # @example
       #   client.update!(
@@ -181,9 +190,26 @@ module Signet
           accu[key.to_s] = value
           accu
         end
-        self.refresh_token = options["refresh_token"]
-        self.access_token = options["access_token"]
-        self.expires_in = options["expires_in"]
+
+        self.access_token = options["access_token"] if options["access_token"]
+        self.expires_in = options["expires_in"] if options["expires_in"]
+
+        # The refresh token may not be returned in a token response.
+        # In which case, the old one should continue to be used.
+        if options["refresh_token"]
+          self.refresh_token = options["refresh_token"]
+        end
+        # The ID token may not be returned in a token response.
+        # In which case, the old one should continue to be used.
+        if options["id_token"]
+          self.id_token = options["id_token"]
+        end
+        # By default, the token is issued at `Time.now` when `expires_in` is
+        # set, but this can be used to supply a more precise time.
+        if options["issued_at"]
+          self.issued_at = options["issued_at"]
+        end
+
         return self
       end
 
@@ -473,7 +499,7 @@ module Signet
       #
       # @return [String] The refresh token.
       def refresh_token
-        return @refresh_token
+        return @refresh_token ||= nil
       end
 
       ##
@@ -490,7 +516,7 @@ module Signet
       #
       # @return [String] The access token.
       def access_token
-        return @access_token
+        return @access_token ||= nil
       end
 
       ##
@@ -502,6 +528,35 @@ module Signet
         @access_token = new_access_token
       end
 
+      ##
+      # Returns the ID token associated with this client.
+      #
+      # @return [String] The ID token.
+      def id_token
+        return @id_token ||= nil
+      end
+
+      ##
+      # Sets the ID token associated with this client.
+      #
+      # @param [String] new_id_token
+      #   The ID token.
+      def id_token=(new_id_token)
+        @id_token = new_id_token
+      end
+
+      ##
+      # Returns the decoded ID token associated with this client.
+      #
+      # @param [OpenSSL::PKey::RSA, Object] public_key
+      #   The public key to use to verify the ID token. Skips verification if
+      #   omitted.
+      #
+      # @return [String] The decoded ID token.
+      def decoded_id_token(public_key=nil)
+        JWT.decode(self.id_token, public_key, !!public_key)
+      end
+
       ##
       # Returns the lifetime of the access token in seconds.
       #
@@ -517,8 +572,12 @@ module Signet
       # @param [String] new_expires_in
       #   The access token lifetime.
       def expires_in=(new_expires_in)
-        @expires_in = new_expires_in.to_i
-        @issued_at = Time.now
+        if new_expires_in != nil
+          @expires_in = new_expires_in.to_i
+          @issued_at = Time.now
+        else
+          @expires_in, @issued_at = nil, nil
+        end
       end
 
       ##
@@ -556,7 +615,7 @@ module Signet
       # @return [TrueClass, FalseClass]
       #   The expiration state of the access token.
       def expired?
-        return Time.now >= self.expires_at
+        return self.expires_at == nil || Time.now >= self.expires_at
       end
 
       ##
@@ -601,11 +660,6 @@ module Signet
         if self.client_secret == nil
           raise ArgumentError, 'Missing client secret.'
         end
-        if self.redirect_uri && !self.code
-          # Grant type can be assumed to be `authorization_code` because of
-          # the presence of the redirect URI.
-          raise ArgumentError, 'Missing authorization code.'
-        end
         method = 'POST'
         parameters = {"grant_type" => self.grant_type}
         case self.grant_type
@@ -620,6 +674,12 @@ module Signet
           parameters['assertion'] = self.assertion
         when 'refresh_token'
           parameters['refresh_token'] = self.refresh_token
+        else
+          if self.redirect_uri
+            # Grant type was intended to be `authorization_code` because of
+            # the presence of the redirect URI.
+            raise ArgumentError, 'Missing authorization code.'
+          end
         end
         parameters['client_id'] = self.client_id
         parameters['client_secret'] = self.client_secret

data/lib/signet/version.rb

@@ -18,7 +18,7 @@ unless defined? Signet::VERSION
     module VERSION
       MAJOR = 0
       MINOR = 2
-      TINY  = 2
+      TINY  = 3
 
       STRING = [MAJOR, MINOR, TINY].join('.')
     end

data/tasks/gem.rake

@@ -25,6 +25,7 @@ namespace :gem do
     s.add_runtime_dependency("httpadapter", "~> 1.0.0")
     s.add_runtime_dependency("addressable", "~> 2.2.1")
     s.add_runtime_dependency("json", ">= 1.4.6")
+    s.add_runtime_dependency("jwt", ">= 0.1.4")
 
     s.add_development_dependency("rake", "~> 0.8.3")
     s.add_development_dependency("rspec", "~> 1.1.11")
@@ -41,6 +42,21 @@ namespace :gem do
     p.need_zip = true
   end
 
+  desc "Generates .gemspec file"
+  task :gemspec do
+    spec_string = GEM_SPEC.to_ruby
+
+    begin
+      Thread.new { eval("$SAFE = 3\n#{spec_string}", binding) }.join
+    rescue
+      abort "unsafe gemspec: #{$!}"
+    else
+      File.open("#{GEM_SPEC.name}.gemspec", 'w') do |file|
+        file.write spec_string
+      end
+    end
+  end
+
   desc "Show information about the gem"
   task :debug do
     puts GEM_SPEC.to_ruby

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: signet
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 17
   prerelease: 
   segments: 
   - 0
   - 2
-  - 2
-  version: 0.2.2
+  - 3
+  version: 0.2.3
 platform: ruby
 authors: 
 - Bob Aman
@@ -15,8 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-12 00:00:00 -07:00
-default_executable: 
+date: 2011-11-15 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: httpadapter
@@ -67,9 +66,25 @@ dependencies:
   type: :runtime
   version_requirements: *id003
 - !ruby/object:Gem::Dependency 
-  name: rake
+  name: jwt
   prerelease: false
   requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 19
+        segments: 
+        - 0
+        - 1
+        - 4
+        version: 0.1.4
+  type: :runtime
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -81,11 +96,11 @@ dependencies:
         - 3
         version: 0.8.3
   type: :development
-  version_requirements: *id004
+  version_requirements: *id005
 - !ruby/object:Gem::Dependency 
   name: rspec
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -97,11 +112,11 @@ dependencies:
         - 11
         version: 1.1.11
   type: :development
-  version_requirements: *id005
+  version_requirements: *id006
 - !ruby/object:Gem::Dependency 
   name: launchy
   prerelease: false
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  requirement: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -113,11 +128,11 @@ dependencies:
         - 2
         version: 0.3.2
   type: :development
-  version_requirements: *id006
+  version_requirements: *id007
 - !ruby/object:Gem::Dependency 
   name: diff-lcs
   prerelease: false
-  requirement: &id007 !ruby/object:Gem::Requirement 
+  requirement: &id008 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -129,11 +144,11 @@ dependencies:
         - 2
         version: 1.1.2
   type: :development
-  version_requirements: *id007
+  version_requirements: *id008
 - !ruby/object:Gem::Dependency 
   name: typhoeus
   prerelease: false
-  requirement: &id008 !ruby/object:Gem::Requirement 
+  requirement: &id009 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -145,7 +160,7 @@ dependencies:
         - 31
         version: 0.1.31
   type: :development
-  version_requirements: *id008
+  version_requirements: *id009
 description: |
   Signet is an OAuth 1.0 / OAuth 2.0 implementation.
 
@@ -193,7 +208,6 @@ files:
 - LICENSE
 - Rakefile
 - README.md
-has_rdoc: true
 homepage: http://signet.rubyforge.org/
 licenses: []
 
@@ -224,7 +238,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: signet
-rubygems_version: 1.4.1
+rubygems_version: 1.8.6
 signing_key: 
 specification_version: 3
 summary: Package Summary