stormpath-sdk 1.6.0 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9f08a60486a9c8f8163b91cacc5ed4190d5f3a81
-  data.tar.gz: 7ebc9d89ffc3a00137239866b8cb42be81617ac7
+  metadata.gz: 2303cf72840fbce8b88103201d799aea7cf1a8d5
+  data.tar.gz: 293bf07449a1835f9de1422232ca2404e15ca80b
 SHA512:
-  metadata.gz: 8f0f63caa6e142c84858aa23f92f24adc2b7d22802c38b4c472ff0e256b5a60c3328960a621b72dfaf1efd1f5fb446bbd64ab83fd825651a94b8b1e31996b96d
-  data.tar.gz: 229efc9202e3a12b95f0a2fa9322801c0948eb5678d300c04f3ec38b94d021649f28665707e822704772c150b19560f16e628780eea939b9be81faea536ffeb3
+  metadata.gz: f0ff64f44b058d924663658b144e226fc1da20a6432d2587745319bbb8819f563e21733b0b200d7a42a3abcf891b392cec7186b27f2918a05c28b000cae4be30
+  data.tar.gz: 1184fc539aef04c498ccf1b97c7afdcf2af0e9fc0b9f97a3d9a6bef763c29d3838ebfe8db57aa8b8c3cc059d722d4246621058d6d2117720ee60a8d8505982c0

data/.rubocop.yml

@@ -0,0 +1,21 @@
+LineLength:
+  Max: 100
+
+Documentation:
+  Enabled: False
+
+Style/FirstMethodArgumentLineBreak:
+  Description: >-
+                 Checks for a line break before the first argument in a
+                 multi-line method call.
+  Enabled: True
+
+WordArray:
+  Enabled: False
+
+AllCops:
+  Exclude:
+    - 'db/schema.rb'
+    - 'db/migrate/*.rb'
+Rails:
+  Enabled: true

data/CHANGES.md

@@ -1,6 +1,17 @@
 stormpath-sdk-ruby Changelog
 ============================
 
+Version 1.7.0
+-------------
+
+Released on February 09, 2017
+
+- Implemented SAML IdP
+- AttributeStatementMappingRules is now an association instead of a property
+- Added require_mfa attribute option to the JWT payload
+- Code cleanup and refactoring
+
+
 Version 1.6.0
 -------------
 

data/README.md

@@ -71,9 +71,9 @@ If you have not already done so, register as a developer on
     URLs you acquired above.
 
     ```ruby
-    application = client.applications.get application_url
+    application = client.applications.get(application_url)
 
-    directory = client.directories.get directory_url
+    directory = client.directories.get(directory_url)
     ```
 
 1.  **Create an account for a user** on the directory.
@@ -119,7 +119,7 @@ If you have not already done so, register as a developer on
 1.  **Create a group** in a directory
 
     ```ruby
-    directory.groups.create name: 'Admins'
+    directory.groups.create(name: 'Admins')
     ```
 
 1.  **Add the account to the group**
@@ -131,7 +131,7 @@ If you have not already done so, register as a developer on
 1. **Check for account inclusion in group** by reloading the account
 
     ```ruby
-    account = client.accounts.get account.href
+    account = client.accounts.get(account.href)
     is_admin = account.groups.any? { |group| group.name == 'Admins' }
     ```
 
@@ -219,9 +219,9 @@ and directories you have registered. You use the client to access them
 with their REST URL:
 
 ```ruby
-application = client.applications.get application_url
+application = client.applications.get(application_url)
 
-directory = client.directories.get directory_url
+directory = client.directories.get(directory_url)
 ```
 
 The <code>applications</code> and <code>directories</code> property on a
@@ -237,9 +237,9 @@ Additional resources are <code>accounts</code>, <code>groups</code>,
 Applications and directories can be created directly off the client.
 
 ```ruby
-application = client.applications.create name: 'foo', description: 'bar'
+application = client.applications.create(name: 'foo', description: 'bar')
 
-directory = client.directories.create name: 'foo', description: 'bar'
+directory = client.directories.create(name: 'foo', description: 'bar')
 ```
 
 ### Collections
@@ -283,7 +283,7 @@ A resource's children can be eager loaded by passing the entity expansion object
 
 ```ruby
 expansion = Stormpath::Resource::Expansion.new 'groups', 'group_memberships'
-client.accounts.get account.href, expansion
+client.accounts.get(account.href, expansion)
 ```
 
 <code>limit</code> and <code>offset</code> can be specified for each child resource by calling <code>add_property</code>.
@@ -292,7 +292,7 @@ client.accounts.get account.href, expansion
 expansion = Stormpath::Resource::Expansion.new
 expansion.add_property 'groups', offset: 5, limit: 10
 
-client.accounts.get account.href, expansion
+client.accounts.get(account.href, expansion)
 ```
 
 ### ID Site
@@ -681,7 +681,7 @@ dir_provider.encoded_x509_signing_cert
 dir_provider.request_signature_algorithm
 dir_provider.service_provider_metadata
 dir_provider.attribute_statement_mapping_rules
-dir_provider.creted_at
+dir_provider.created_at
 dir_provider.modified_at
 ```
 
@@ -692,13 +692,13 @@ Next you will have to configure your Stormpath-powered application as a Service
 In order to retrieve the required values, start by sending a GET to the Directory's Provider:
 
 ```ruby
-directory.provider_metadata
+directory.service_provider_metadata
 ```
 
-provider_metadata method returns instance of SamlProviderMetadata and you can access the following values
+service_provider_metadata method returns instance of SamlServiceProviderMetadata and you can access the following values
 
 ```ruby
-dir_provider_metadata = directory.provider_metadata
+dir_provider_metadata = directory.service_provider_metadata
 
 dir_provider_metadata.href
 dir_provider_metadata.entity_id
@@ -764,7 +764,6 @@ The Attribute Assertions (`<saml:AttributeStatement>`) are brought into Stormpat
 SAML Assertion mapping is defined in an **attributeStatementMappingRules** object found inside the Directory's Provider object, or directly: `/v1/attributeStatementMappingRules/$RULES_ID`.
 
 ##### Mapping Rules
-
 The rules have three different components:
 
 - **name**: The SAML Attribute name
@@ -774,14 +773,13 @@ The rules have three different components:
 In order to create the mapping rules, we simply send the following:
 
 ```ruby
-mappings = Stormpath::Provider::SamlMappingRules.new(items: [
-  {
-    name: "uid",
-    account_attributes: ["username"]
-  }
-])
+rule = {
+  'name' => 'uid',
+  'accountAttributes' => ['username']
+}
 
-dir.create_attribute_mappings(mappings)
+dir.attribute_statement_mapping_rules.items = [rule]
+dir.attribute_statement_mapping_rules.save
 ```
 
 ### Password Reset
@@ -849,7 +847,7 @@ You can create groups and assign them to accounts using the Stormpath
 web console, or programmatically. Groups are created on directories:
 
 ```ruby
-group = directory.groups.create name: 'administrators'
+group = directory.groups.create(name: 'administrators')
 ```
 
 Group membership can be created by:
@@ -857,7 +855,7 @@ Group membership can be created by:
 * Explicitly creating a group membership resource with your client:
 
   ```ruby
-  group_membership = client.group_memberships.create group: group, account: account
+  group_membership = client.group_memberships.create(group: group, account: account)
   ```
 
 * Using the <code>add_group</code> method on the account instance:
@@ -903,7 +901,7 @@ An `Organization` is a top-level container for Account Stores. You can think of
 * Adding an Organization to an Application as an Account Store
 
   ```ruby
-    client.account_store_mappings.create application: application, account_store: organization
+    client.account_store_mappings.create(application: application, account_store: organization)
   ```
 
 

data/lib/stormpath-sdk.rb

@@ -40,6 +40,15 @@ module Stormpath
     autoload :AccountLink, 'stormpath-sdk/resource/account_link'
     autoload :AccountLinkingPolicy, 'stormpath-sdk/resource/account_linking_policy'
     autoload :Application, 'stormpath-sdk/resource/application'
+    autoload :SamlServiceProviderMetadata, 'stormpath-sdk/resource/saml_service_provider_metadata'
+    autoload :SamlPolicy, 'stormpath-sdk/resource/saml_policy'
+    autoload :SamlServiceProvider, 'stormpath-sdk/resource/saml_service_provider'
+    autoload :SsoInitiationEndpoint, 'stormpath-sdk/resource/sso_initiation_endpoint'
+    autoload :SamlIdentityProvider, 'stormpath-sdk/resource/saml_identity_provider'
+    autoload :RegisteredSamlServiceProvider, 'stormpath-sdk/resource/registered_saml_service_provider'
+    autoload :SamlServiceProviderRegistration, 'stormpath-sdk/resource/saml_service_provider_registration'
+    autoload :SamlIdentityProviderMetadata, 'stormpath-sdk/resource/saml_identity_provider_metadata'
+    autoload :X509Certificate, 'stormpath-sdk/resource/x_509_certificate'
     autoload :Directory, 'stormpath-sdk/resource/directory'
     autoload :Account, 'stormpath-sdk/resource/account'
     autoload :AccountStore, 'stormpath-sdk/resource/account_store'
@@ -68,6 +77,7 @@ module Stormpath
     autoload :Schema, 'stormpath-sdk/resource/schema'
     autoload :Field, 'stormpath-sdk/resource/field'
     autoload :UserInfoMappingRules, 'stormpath-sdk/resource/user_info_mapping_rules'
+    autoload :AttributeStatementMappingRules, 'stormpath-sdk/resource/attribute_statement_mapping_rules'
   end
 
   module Cache
@@ -89,6 +99,7 @@ module Stormpath
     autoload :HttpBasicAuthentication, 'stormpath-sdk/auth/http_basic_authentication'
     autoload :HttpBearerAuthentication, 'stormpath-sdk/auth/http_bearer_authentication'
     autoload :CreateFactor, 'stormpath-sdk/auth/create_factor'
+    autoload :RegisterServiceProvider, 'stormpath-sdk/auth/register_service_provider'
   end
 
   module Provider
@@ -110,8 +121,6 @@ module Stormpath
     autoload :TwitterProviderData, 'stormpath-sdk/provider/twitter/twitter_provider_data'
     autoload :SamlProvider, 'stormpath-sdk/provider/saml/saml_provider'
     autoload :SamlProviderData, 'stormpath-sdk/provider/saml/saml_provider_data'
-    autoload :SamlProviderMetadata, 'stormpath-sdk/provider/saml/saml_provider_metadata'
-    autoload :SamlMappingRules, 'stormpath-sdk/provider/saml/saml_mapping_rules'
     autoload :StormpathProvider, 'stormpath-sdk/provider/stormpath/stormpath_provider'
     autoload :StormpathProviderData, 'stormpath-sdk/provider/stormpath/stormpath_provider_data'
   end

data/lib/stormpath-sdk/api_key.rb

@@ -23,4 +23,3 @@ module Stormpath
     end
   end
 end
-

data/lib/stormpath-sdk/auth/basic_authenticator.rb

@@ -18,16 +18,16 @@ module Stormpath
     class BasicAuthenticator
       include Stormpath::Util::Assert
 
-      def initialize data_store
+      def initialize(data_store)
         @data_store = data_store
       end
 
-      def authenticate parent_href, request
-        assert_not_nil parent_href, "parentHref argument must be specified"
-        assert_kind_of UsernamePasswordRequest, request, "Only UsernamePasswordRequest instances are supported."
+      def authenticate(parent_href, request)
+        assert_not_nil parent_href, 'parentHref argument must be specified'
+        assert_kind_of UsernamePasswordRequest, request, 'Only UsernamePasswordRequest instances are supported.'
 
         username = request.principals
-        username = username || ''
+        username ||= ''
 
         password = request.credentials
         pw_string = password.join
@@ -36,7 +36,7 @@ module Stormpath
 
         value = Base64.encode64(value).tr("\n", '')
 
-        attempt = @data_store.instantiate BasicLoginAttempt, nil
+        attempt = @data_store.instantiate(BasicLoginAttempt, nil)
         attempt.type = 'basic'
         attempt.value = value
 
@@ -44,7 +44,7 @@ module Stormpath
 
         href = parent_href + '/loginAttempts'
 
-        @data_store.create href, attempt, AuthenticationResult
+        @data_store.create(href, attempt, AuthenticationResult)
       end
     end
   end

data/lib/stormpath-sdk/auth/basic_login_attempt.rb

@@ -16,22 +16,21 @@
 module Stormpath
   module Authentication
     class BasicLoginAttempt < Stormpath::Resource::Base
-
-      TYPE = "type"
-      VALUE = "value"
-      ACCOUNT_STORE = "account_store"
+      TYPE = 'type'.freeze
+      VALUE = 'value'.freeze
+      ACCOUNT_STORE = 'account_store'.freeze
 
       def account_store
         get_property ACCOUNT_STORE
       end
 
       def account_store=(account_store)
-        if account_store.kind_of? Stormpath::Resource::Base
-          set_property ACCOUNT_STORE, {HREF_PROP_NAME => account_store.href}
-        elsif account_store.kind_of? Hash
+        if account_store.is_a? Stormpath::Resource::Base
+          set_property ACCOUNT_STORE, HREF_PROP_NAME => account_store.href
+        elsif account_store.is_a? Hash
           set_property ACCOUNT_STORE, sanitize(account_store)
         else
-          fail ArgumentError, 'account_store should be a Stormpath::Resource::Instance or a Hash'
+          raise ArgumentError, 'account_store should be a Stormpath::Resource::Instance or a Hash'
         end
       end
 
@@ -50,9 +49,6 @@ module Stormpath
       def value=(value)
         set_property VALUE, value
       end
-
     end
-
   end
-
 end

data/lib/stormpath-sdk/auth/create_factor.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.

data/lib/stormpath-sdk/auth/register_service_provider.rb

@@ -0,0 +1,41 @@
+module Stormpath
+  module Authentication
+    class RegisterServiceProvider
+      attr_reader :client, :identity_provider, :options
+
+      def initialize(identity_provider, options = {})
+        @client = identity_provider.client
+        @identity_provider = identity_provider
+        @options = options
+      end
+
+      def call
+        map_identity_provider_and_registered_service_provider
+        registered_service_provider
+      end
+
+      private
+
+      def map_identity_provider_and_registered_service_provider
+        identity_provider.saml_service_provider_registrations.create(
+          service_provider: { href: registered_service_provider.href }
+        )
+      end
+
+      def registered_service_provider
+        @registered_service_provider ||=
+          client.registered_saml_service_providers.create(registered_service_provider_params)
+      end
+
+      def registered_service_provider_params
+        {}.tap do |body|
+          body[:assertion_consumer_service_url] = options[:assertion_consumer_service_url]
+          body[:entity_id] = options[:entity_id]
+          body[:name] = options[:name]
+          body[:description] = options[:description]
+          body[:name_id_format] = options[:name_id_format]
+        end.compact
+      end
+    end
+  end
+end

data/lib/stormpath-sdk/auth/username_password_request.rb

@@ -16,12 +16,11 @@
 module Stormpath
   module Authentication
     class UsernamePasswordRequest
-
       attr_reader :host, :account_store
 
-      def initialize username, password, options = {}
+      def initialize(username, password, options = {})
         @username = username
-        @password = (password || "").chars.to_a
+        @password = (password || '').chars.to_a
         @host = options[:host]
         @account_store = options[:account_store]
       end
@@ -39,10 +38,9 @@ module Stormpath
         @host = nil
         @account_store = nil
 
-        @password.each { |pass_char| pass_char = 0x00 }
+        @password.each { |_pass_char| pass_char = 0x00 }
         @password = nil
       end
-
     end
   end
 end

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

@@ -11,7 +11,7 @@ module Stormpath
         @ttl_seconds = opts[:ttl_seconds] || DEFAULT_TTL_SECONDS
         @tti_seconds = opts[:tti_seconds] || DEFAULT_TTI_SECONDS
         store_opts = opts[:store_opts] || {}
-        @store = (opts[:store] || DEFAULT_STORE).new store_opts
+        @store = (opts[:store] || DEFAULT_STORE).new(store_opts)
         @stats = CacheStats.new
       end
 
@@ -19,7 +19,7 @@ module Stormpath
         if entry = @store.get(k)
           if entry.expired? @ttl_seconds, @tti_seconds
             @stats.miss true
-            @store.delete k
+            @store.delete(k)
             nil
           else
             @stats.hit
@@ -38,7 +38,7 @@ module Stormpath
       end
 
       def delete(k)
-        @store.delete k
+        @store.delete(k)
         @stats.delete
       end
 

data/lib/stormpath-sdk/cache/cache_entry.rb

@@ -3,7 +3,7 @@ module Stormpath
     class CacheEntry
       attr_accessor :value, :created_at, :last_accessed_at
 
-      def initialize value
+      def initialize(value)
         self.value            = value
         self.created_at       = Time.now
         self.last_accessed_at = created_at
@@ -13,7 +13,7 @@ module Stormpath
         self.last_accessed_at = Time.now
       end
 
-      def expired? ttl_seconds, tti_seconds
+      def expired?(ttl_seconds, tti_seconds)
         now = Time.now
         now > (created_at + ttl_seconds) || now > (last_accessed_at + tti_seconds)
       end