stormpath-sdk 1.5.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 39b0f751a08c13d32addaf304b2b82edeaa4c0bf
-  data.tar.gz: 03136baf262d23ca52d8580c809500a53c95be39
+  metadata.gz: 9f08a60486a9c8f8163b91cacc5ed4190d5f3a81
+  data.tar.gz: 7ebc9d89ffc3a00137239866b8cb42be81617ac7
 SHA512:
-  metadata.gz: be90405ab987f48232ac9bb0cfd55272de9baff5f3e4ae04cb019f92a4ebf740a42181a20b14f63215def4ec1fd2fa1e541a2a560b6887b485c91399358cbb8b
-  data.tar.gz: d48ed19deab4469407c6337fdaea4f87eea74fb8f10e943055a95fdc486988da443e17f45b334d00defe860f519635d60928804793aacf498b6a9c8062fe8852
+  metadata.gz: 8f0f63caa6e142c84858aa23f92f24adc2b7d22802c38b4c472ff0e256b5a60c3328960a621b72dfaf1efd1f5fb446bbd64ab83fd825651a94b8b1e31996b96d
+  data.tar.gz: 229efc9202e3a12b95f0a2fa9322801c0948eb5678d300c04f3ec38b94d021649f28665707e822704772c150b19560f16e628780eea939b9be81faea536ffeb3

data/CHANGES.md

@@ -1,6 +1,14 @@
 stormpath-sdk-ruby Changelog
 ============================
 
+Version 1.6.0
+-------------
+
+Released on January 26, 2017
+
+- Implement Social login V2 - user info mapping rules on a directory, custom attributes for Google(hd, display, access_type), provider scope, redirect_uri on social grant requests
+
+
 Version 1.5.0
 -------------
 

data/lib/stormpath-sdk.rb

@@ -67,6 +67,7 @@ module Stormpath
     autoload :Challenge, 'stormpath-sdk/resource/challenge'
     autoload :Schema, 'stormpath-sdk/resource/schema'
     autoload :Field, 'stormpath-sdk/resource/field'
+    autoload :UserInfoMappingRules, 'stormpath-sdk/resource/user_info_mapping_rules'
   end
 
   module Cache

data/lib/stormpath-sdk/data_store.rb

@@ -158,7 +158,7 @@ class Stormpath::DataStore
 
     return if http_method == 'delete'
 
-    if result[HREF_PROP_NAME] and !resource_is_saml_mapping_rules? resource
+    if result[HREF_PROP_NAME] && !resource_is_saml_mapping_rules?(resource) && !user_info_mapping_rules?(resource)
       cache_walk result
     else
       result
@@ -348,6 +348,10 @@ class Stormpath::DataStore
       Stormpath::Resource::ApplicationWebConfig::ENDPOINTS.include?(name.underscore.to_sym)
   end
 
+  def user_info_mapping_rules?(resource)
+    resource.is_a?(Stormpath::Resource::UserInfoMappingRules)
+  end
+
   def resource_is_saml_mapping_rules?(resource)
     resource.is_a?(Stormpath::Provider::SamlMappingRules)
   end

data/lib/stormpath-sdk/oauth/social_grant.rb

@@ -1,14 +1,15 @@
 module Stormpath
   module Oauth
     class SocialGrant < Stormpath::Resource::Base
-      prop_accessor :grant_type, :provider_id, :code, :access_token
+      prop_accessor :grant_type, :provider_id, :code, :access_token, :redirect_uri
 
       def form_properties
         {
           grant_type: grant_type,
           providerId: provider_id,
           code: code,
-          accessToken: access_token
+          accessToken: access_token,
+          redirectUri: redirect_uri
         }
       end
 
@@ -16,6 +17,7 @@ module Stormpath
         set_property :provider_id, request.provider_id
         set_property :code, request.code if request.code
         set_property :access_token, request.access_token if request.access_token
+        set_property :redirect_uri, request.redirect_uri if request.redirect_uri
         set_property :grant_type, request.grant_type
       end
 

data/lib/stormpath-sdk/oauth/social_grant_request.rb

@@ -1,12 +1,13 @@
 module Stormpath
   module Oauth
     class SocialGrantRequest
-      attr_accessor :grant_type, :provider_id, :code, :access_token
+      attr_accessor :grant_type, :provider_id, :code, :access_token, :redirect_uri
 
       def initialize(provider_id, options = {})
         @provider_id = provider_id.to_s
         @code = options[:code]
         @access_token = options[:access_token]
+        @redirect_uri = options[:redirect_uri]
         @grant_type = 'stormpath_social'
       end
     end

data/lib/stormpath-sdk/provider/account_resolver.rb

@@ -1,5 +1,5 @@
 #
-# Copyright 2014 Stormpath, Inc.
+# Copyright 2016 Stormpath, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -33,6 +33,8 @@ module Stormpath
       end
 
       def provider_data
+        # TODO: need to add an options hash and pass all attributes from the providers?
+        # https://stormpath.atlassian.net/wiki/display/AM/Social+Login+V2/#SocialLoginV2-ClientAPIChanges
         @provider_data ||= {}.tap do |body|
           body[request.token_type.to_s.camelize(:lower)] = request.token_value
           body['providerId'] = request.provider

data/lib/stormpath-sdk/provider/facebook/facebook_provider.rb

@@ -15,4 +15,4 @@
 #
 class Stormpath::Provider::FacebookProvider < Stormpath::Provider::Provider
   prop_reader :client_id, :client_secret
-end
+end

data/lib/stormpath-sdk/provider/google/google_provider.rb

@@ -14,5 +14,6 @@
 # limitations under the License.
 #
 class Stormpath::Provider::GoogleProvider < Stormpath::Provider::Provider
+  prop_accessor :hd, :display, :access_type
   prop_reader :client_id, :client_secret, :redirect_uri
-end
+end

data/lib/stormpath-sdk/provider/provider.rb

@@ -1,5 +1,5 @@
 #
-# Copyright 2014 Stormpath, Inc.
+# Copyright 2016 Stormpath, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -13,6 +13,9 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-class Stormpath::Provider::Provider < Stormpath::Resource::Base
+class Stormpath::Provider::Provider < Stormpath::Resource::Instance
+  prop_accessor :scope
   prop_reader :provider_id, :created_at, :modified_at
-end
+
+  has_one :user_info_mapping_rules
+end

data/lib/stormpath-sdk/provider/provider_data.rb

@@ -1,5 +1,5 @@
 #
-# Copyright 2014 Stormpath, Inc.
+# Copyright 2016 Stormpath, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -14,5 +14,5 @@
 # limitations under the License.
 #
 class Stormpath::Provider::ProviderData < Stormpath::Resource::Base
-  prop_reader :provider_id, :created_at, :modified_at
-end
+  prop_reader :provider_id, :created_at, :modified_at, :user_info
+end

data/lib/stormpath-sdk/resource/application.rb

@@ -59,19 +59,17 @@ class Stormpath::Resource::Application < Stormpath::Resource::Instance
   end
 
   def create_id_site_url(options = {})
-    base = client.data_store.base_url.sub("v" + Stormpath::DataStore::DEFAULT_API_VERSION.to_s, "sso")
+    base = client.data_store.base_url.sub("v#{Stormpath::DataStore::DEFAULT_API_VERSION}", 'sso')
     base += '/logout' if options[:logout]
 
-    if options[:callback_uri].empty?
-      raise Stormpath::Oauth::Error.new(:jwt_cb_uri_incorrect)
-    end
+    raise Stormpath::Oauth::Error.new(:jwt_cb_uri_incorrect) if options[:callback_uri].empty?
 
     token = JWT.encode(jwt_token_payload(options), client.data_store.api_key.secret, 'HS256')
     base + '?jwtRequest=' + token
   end
 
   def handle_id_site_callback(response_url)
-    assert_not_nil response_url, "No response provided. Please provide response object."
+    assert_not_nil response_url, 'No response provided. Please provide response object.'
 
     uri = URI(response_url)
     params = CGI::parse(uri.query)
@@ -99,11 +97,11 @@ class Stormpath::Resource::Application < Stormpath::Resource::Instance
     password_reset_token.account
   end
 
-  def verify_password_reset_token token
+  def verify_password_reset_token(token)
     password_reset_tokens.get(token).account
   end
 
-  def authenticate_account request
+  def authenticate_account(request)
     Stormpath::Authentication::BasicAuthenticator.new(data_store).authenticate(href, request)
   end
 
@@ -118,20 +116,18 @@ class Stormpath::Resource::Application < Stormpath::Resource::Instance
   private
 
   def jwt_token_payload(options)
-    payload = {
-      'iat' => Time.now.to_i,
-      'jti' => UUID.method(:random_create).call.to_s,
-      'iss' => client.data_store.api_key.id,
-      'sub' => href,
-      'cb_uri' => options[:callback_uri],
-      'path' => options[:path] || '',
-      'state' => options[:state] || '',
-    }
-
-    payload["sof"] = options[:show_organization_field] if options[:show_organization_field]
-    payload["onk"] = options[:organization_name_key] if options[:organization_name_key]
-    payload["usd"] = options[:use_subdomain] if options[:use_subdomain]
-    payload
+    {}.tap do |payload|
+      payload['iat'] = Time.now.to_i
+      payload['jti'] = UUID.method(:random_create).call.to_s
+      payload['iss'] = client.data_store.api_key.id
+      payload['sub'] = href
+      payload['cb_uri'] = options[:callback_uri]
+      payload['path'] = options[:path] || ''
+      payload['state'] = options[:state] || ''
+      payload['sof'] = options[:show_organization_field]
+      payload['onk'] = options[:organization_name_key]
+      payload['usd'] = options[:use_subdomain]
+    end.compact
   end
 
   def api_key_id

data/lib/stormpath-sdk/resource/directory.rb

@@ -29,6 +29,7 @@ class Stormpath::Resource::Directory < Stormpath::Resource::Instance
   has_one :password_policy
   has_one :account_creation_policy
   has_one :account_schema, class_name: :schema
+  delegate :user_info_mapping_rules, to: :provider
 
   def provider
     internal_instance = instance_variable_get "@_provider"
@@ -46,17 +47,17 @@ class Stormpath::Resource::Directory < Stormpath::Resource::Instance
   end
 
   def provider_metadata
-    metadata_href = provider.service_provider_metadata["href"]
+    metadata_href = provider.service_provider_metadata['href']
     data_store.get_resource metadata_href, Stormpath::Provider::SamlProviderMetadata
   end
 
   def statement_mapping_rules
-    metadata_href = provider.attribute_statement_mapping_rules["href"]
+    metadata_href = provider.attribute_statement_mapping_rules['href']
     data_store.get_resource metadata_href, Stormpath::Provider::SamlMappingRules
   end
 
   def create_attribute_mappings(mappings)
-    mappings.set_options(href: provider.attribute_statement_mapping_rules["href"])
+    mappings.set_options(href: provider.attribute_statement_mapping_rules['href'])
     data_store.create mappings.href, mappings, Stormpath::Provider::SamlMappingRules
   end
 end

data/lib/stormpath-sdk/resource/instance.rb

@@ -1,5 +1,5 @@
 #
-# Copyright 2012 Stormpath, Inc.
+# Copyright 2016 Stormpath, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -15,12 +15,10 @@
 #
 class Stormpath::Resource::Instance < Stormpath::Resource::Base
   def save
-    data_store.save self
+    data_store.save(self)
   end
 
   def delete
-    unless new?
-      data_store.delete self
-    end
+    data_store.delete(self) unless new?
   end
 end

data/lib/stormpath-sdk/resource/user_info_mapping_rules.rb

@@ -0,0 +1,19 @@
+#
+# Copyright 2016 Stormpath, Inc.
+#
+# 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.
+#
+class Stormpath::Resource::UserInfoMappingRules < Stormpath::Resource::Instance
+  prop_accessor :items
+  prop_reader :href, :created_at, :modified_at
+end

data/lib/stormpath-sdk/version.rb

@@ -14,6 +14,6 @@
 # limitations under the License.
 #
 module Stormpath
-  VERSION = '1.5.0'
-  VERSION_DATE = '2017-01-24'
+  VERSION = '1.6.0'
+  VERSION_DATE = '2017-01-26'
 end

data/spec/client_spec.rb

@@ -290,7 +290,7 @@ properties
     context 'pagination' do
       let!(:applications) do
         (0..2).to_a.map do |index|
-          test_api_client.applications.create(application_attrs(name: "ruby-sdk-test-#{index}"))
+          test_api_client.applications.create(application_attrs(name: "ruby-sdk-test-#{index}-#{random_number}"))
         end
       end
 
@@ -537,14 +537,13 @@ properties
 
   describe '#organization' do
     context 'search' do
+      let(:random_org_name) { "ruby-org-#{random_number}" }
       let!(:organization) do
-        test_api_client.organizations.create(organization_attrs(name: 'ruby-org'))
+        test_api_client.organizations.create(organization_attrs(name: random_org_name))
       end
 
       context 'by any attribute' do
-        let(:search_results) do
-          test_api_client.organizations.search('ruby-org')
-        end
+        let(:search_results) { test_api_client.organizations.search(random_org_name) }
 
         it 'returns the application' do
           expect(search_results.count).to eq 1
@@ -552,7 +551,7 @@ properties
       end
 
       context 'by an explicit attribute' do
-        let(:search_results) { test_api_client.organizations.search(name: 'ruby-org') }
+        let(:search_results) { test_api_client.organizations.search(name: random_org_name) }
 
         it 'returns the application' do
           expect(search_results.count).to eq 1

data/spec/provider/provider_spec.rb

@@ -17,6 +17,10 @@ describe Stormpath::Provider::Provider, :vcr do
     directory.provider
   end
 
+  def social_directory?
+    provider_id != 'stormpath'
+  end
+
   after do
     directory.delete
     application.delete
@@ -41,13 +45,41 @@ describe Stormpath::Provider::Provider, :vcr do
       provider_clazz = "Stormpath::Provider::#{provider_id.capitalize}Provider".constantize
       expect(provider).to be_instance_of(provider_clazz)
 
-      if %w(google facebook twitter).include?(provider_id)
+      if social_directory?
         expect(provider.client_id).to eq(client_id)
         expect(provider.client_secret).to eq(client_secret)
       end
 
       if provider_id == 'google'
         expect(provider.redirect_uri).to eq(redirect_uri)
+        expect(provider.hd).to eq(hd)
+        expect(provider.display).to eq(display)
+        expect(provider.access_type).to eq(access_type)
+      end
+    end
+
+    it 'should be able to update the scope' do
+      if social_directory?
+        provider.scope = ['email']
+        provider.save
+        expect(provider.scope).to include 'email'
+      end
+    end
+
+    context 'user info mapping rules for social directories' do
+      let(:rule) { { 'name' => 'email', 'accountAttributes' => ['email'] } }
+      before do
+        if social_directory?
+          directory.user_info_mapping_rules.items = [rule]
+          directory.user_info_mapping_rules.save
+        end
+      end
+
+      it 'should be able to create and fetch user info mapping rules' do
+        if social_directory?
+          expect(directory.user_info_mapping_rules).to be_kind_of(Stormpath::Resource::UserInfoMappingRules)
+          expect(directory.user_info_mapping_rules.items).to include(rule)
+        end
       end
     end
   end
@@ -129,12 +161,18 @@ describe Stormpath::Provider::Provider, :vcr do
     let(:client_id) { 'GOOGLE_CLIENT_ID' }
     let(:client_secret) { 'GOOGLE_CLIENT_SECRET' }
     let(:redirect_uri) { 'GOOGLE_REDIRECT_URI' }
+    let(:hd) { 'www.example.com' }
+    let(:display) { 'page' }
+    let(:access_type) { 'online' }
     let(:provider_info) do
       {
         provider_id: provider_id,
         client_id: client_id,
         client_secret: client_secret,
-        redirect_uri: redirect_uri
+        redirect_uri: redirect_uri,
+        hd: hd,
+        display: display,
+        access_type: access_type
       }
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stormpath-sdk
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.6.0
 platform: ruby
 authors:
 - Stormpath, Inc
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-24 00:00:00.000000000 Z
+date: 2017-01-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -428,6 +428,7 @@ files:
 - lib/stormpath-sdk/resource/refresh_token.rb
 - lib/stormpath-sdk/resource/schema.rb
 - lib/stormpath-sdk/resource/tenant.rb
+- lib/stormpath-sdk/resource/user_info_mapping_rules.rb
 - lib/stormpath-sdk/resource/utils.rb
 - lib/stormpath-sdk/resource/verification_email.rb
 - lib/stormpath-sdk/util/assert.rb