stormpath-sdk 1.4.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f4ee6a6b7b3e99f340ad7056d571cc497cc47163
-  data.tar.gz: b4191c5270f3d690590d288553609fdef02a4174
+  metadata.gz: 39b0f751a08c13d32addaf304b2b82edeaa4c0bf
+  data.tar.gz: 03136baf262d23ca52d8580c809500a53c95be39
 SHA512:
-  metadata.gz: f7600ac17e42f60a5b62df5d396a5534fa9907b19cbd1ce77115846c7df88dbfe0409e9cba0781f5e9261743cd36d4e3de8844aa7d91a03a84213c4a93f42f6c
-  data.tar.gz: 8762d8e4df8a3f557a4f2c48505593d89fd27050a5dd9dc6c2a3e6b3d058c1c18bdf69353412b8608dd90cc55f276b4bae6d4e6c11148cac98aec892b507af68
+  metadata.gz: be90405ab987f48232ac9bb0cfd55272de9baff5f3e4ae04cb019f92a4ebf740a42181a20b14f63215def4ec1fd2fa1e541a2a560b6887b485c91399358cbb8b
+  data.tar.gz: d48ed19deab4469407c6337fdaea4f87eea74fb8f10e943055a95fdc486988da443e17f45b334d00defe860f519635d60928804793aacf498b6a9c8062fe8852

data/CHANGES.md

@@ -1,6 +1,18 @@
 stormpath-sdk-ruby Changelog
 ============================
 
+Version 1.5.0
+-------------
+
+Released on January 24, 2017
+
+- Create AccountLinkingPolicy resource and associate it to Application and Organization
+- Create Twitter provider
+- Implement ApplicationWebConfig on the Application resource
+- Added more specs for basic authentication
+- Refactor codebase
+
+
 Version 1.4.0
 -------------
 

data/lib/stormpath-sdk.rb

@@ -38,6 +38,7 @@ module Stormpath
     autoload :Tenant, 'stormpath-sdk/resource/tenant'
     autoload :LinkedAccount, 'stormpath-sdk/resource/linked_account'
     autoload :AccountLink, 'stormpath-sdk/resource/account_link'
+    autoload :AccountLinkingPolicy, 'stormpath-sdk/resource/account_linking_policy'
     autoload :Application, 'stormpath-sdk/resource/application'
     autoload :Directory, 'stormpath-sdk/resource/directory'
     autoload :Account, 'stormpath-sdk/resource/account'
@@ -52,6 +53,7 @@ module Stormpath
     autoload :PasswordResetToken, 'stormpath-sdk/resource/password_reset_token'
     autoload :VerificationEmail, 'stormpath-sdk/resource/verification_email'
     autoload :OauthPolicy, 'stormpath-sdk/resource/oauth_policy'
+    autoload :ApplicationWebConfig, 'stormpath-sdk/resource/application_web_config'
     autoload :AccessToken, 'stormpath-sdk/resource/access_token'
     autoload :RefreshToken, 'stormpath-sdk/resource/refresh_token'
     autoload :Organization, 'stormpath-sdk/resource/organization'
@@ -103,6 +105,8 @@ module Stormpath
     autoload :LinkedinProviderData, 'stormpath-sdk/provider/linkedin/linkedin_provider_data'
     autoload :GithubProvider, 'stormpath-sdk/provider/github/github_provider'
     autoload :GithubProviderData, 'stormpath-sdk/provider/github/github_provider_data'
+    autoload :TwitterProvider, 'stormpath-sdk/provider/twitter/twitter_provider'
+    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'

data/lib/stormpath-sdk/data_store.rb

@@ -118,231 +118,237 @@ class Stormpath::DataStore
 
   private
 
-    def needs_to_be_fully_qualified?(href)
-      !href.downcase.start_with? 'http'
-    end
+  def needs_to_be_fully_qualified?(href)
+    !href.downcase.start_with? 'http'
+  end
 
-    def qualify(href)
-      needs_to_be_fully_qualified?(href) ? @base_url + href : href
-    end
+  def qualify(href)
+    needs_to_be_fully_qualified?(href) ? @base_url + href : href
+  end
 
-    def execute_request(http_method, href, resource=nil, query=nil)
-      if http_method == 'get' && (cache = cache_for href)
-        cached_result = cache.get href
-        return cached_result if cached_result
-      end
+  def execute_request(http_method, href, resource=nil, query=nil)
+    if http_method == 'get' && (cache = cache_for href)
+      cached_result = cache.get href
+      return cached_result if cached_result
+    end
 
-      body = extract_body_from_resource(resource)
+    body = extract_body_from_resource(resource)
 
-      request = Request.new(http_method, href, query, Hash.new, body, @api_key)
+    request = Request.new(http_method, href, query, Hash.new, body, @api_key)
 
-      if resource.try(:form_data?)
-        apply_form_data_request_headers request
-      else
-        apply_default_request_headers request
-      end
+    if resource.try(:form_data?)
+      apply_form_data_request_headers request
+    else
+      apply_default_request_headers request
+    end
 
-      response = @request_executor.execute_request request
+    response = @request_executor.execute_request request
 
-      result = response.body.length > 0 ? MultiJson.load(response.body) : ''
+    result = response.body.length > 0 ? MultiJson.load(response.body) : ''
 
-      if response.error?
-        error = Stormpath::Resource::Error.new result
-        raise Stormpath::Error.new error
-      end
+    if response.error?
+      error = Stormpath::Resource::Error.new result
+      raise Stormpath::Error.new error
+    end
 
-      if resource.is_a? Stormpath::Provider::AccountAccess
-        is_new_account = response.http_status == 201
-        result = {is_new_account: is_new_account, account: result }
-      end
+    if resource.is_a? Stormpath::Provider::AccountAccess
+      is_new_account = response.http_status == 201
+      result = {is_new_account: is_new_account, account: result }
+    end
 
-      return if http_method == 'delete'
+    return if http_method == 'delete'
 
-      if result[HREF_PROP_NAME] and !resource_is_saml_mapping_rules? resource
-        cache_walk result
-      else
-        result
-      end
+    if result[HREF_PROP_NAME] and !resource_is_saml_mapping_rules? resource
+      cache_walk result
+    else
+      result
     end
+  end
 
-    def clear_cache_on_delete href
-      if href =~ custom_data_delete_field_url_regex
-        href = href.split('/')[0..-2].join('/')
-      end
-      clear_cache href
+  def clear_cache_on_delete href
+    if href =~ custom_data_delete_field_url_regex
+      href = href.split('/')[0..-2].join('/')
     end
+    clear_cache href
+  end
 
-    def custom_data_delete_field_url_regex
-      /#{@base_url}\/(accounts|groups)\/\w+\/customData\/\w+[\/]{0,1}$/
-    end
+  def custom_data_delete_field_url_regex
+    /#{@base_url}\/(accounts|groups)\/\w+\/customData\/\w+[\/]{0,1}$/
+  end
 
-    def clear_cache(href)
-      cache = cache_for href
-      cache.delete href if cache
-    end
+  def clear_cache(href)
+    cache = cache_for href
+    cache.delete href if cache
+  end
 
-    def cache_walk(resource)
-      assert_not_nil resource[HREF_PROP_NAME], "resource must have 'href' property"
-      items = resource['items']
+  def cache_walk(resource)
+    assert_not_nil resource[HREF_PROP_NAME], "resource must have 'href' property"
+    items = resource['items']
 
-      if items # collection resource
-        resource['items'] = items.map do |item|
-          cache_walk item
-          { HREF_PROP_NAME => item[HREF_PROP_NAME] }
-        end
-      else     # single resource
-        resource.each do |attr, value|
-          if value.is_a? Hash and value[HREF_PROP_NAME]
-            walked = cache_walk value
-            resource[attr] = { HREF_PROP_NAME => value[HREF_PROP_NAME] }
-            resource[attr]['items'] = walked['items'] if walked['items']
-          end
+    if items # collection resource
+      resource['items'] = items.map do |item|
+        cache_walk item
+        { HREF_PROP_NAME => item[HREF_PROP_NAME] }
+      end
+    else     # single resource
+      resource.each do |attr, value|
+        if value.is_a? Hash and value[HREF_PROP_NAME]
+          walked = cache_walk value
+          resource[attr] = { HREF_PROP_NAME => value[HREF_PROP_NAME] }
+          resource[attr]['items'] = walked['items'] if walked['items']
         end
-        cache resource if resource.length > 1
       end
-      resource
+      cache resource if resource.length > 1
     end
+    resource
+  end
 
-    def cache(resource)
-      cache = cache_for resource[HREF_PROP_NAME]
-      cache.put resource[HREF_PROP_NAME], resource if cache
-    end
+  def cache(resource)
+    cache = cache_for resource[HREF_PROP_NAME]
+    cache.put resource[HREF_PROP_NAME], resource if cache
+  end
 
-    def cache_for(href)
-      @cache_manager.get_cache(region_for href)
-    end
+  def cache_for(href)
+    @cache_manager.get_cache(region_for href)
+  end
 
-    def region_for(href)
-      return nil if href.nil?
-      if href.include? "/customData"
-        region = href.split('/')[-1]
-      else
-        region = href.split('/')[-2]
-      end
-      CACHE_REGIONS.include?(region) ? region : nil
+  def region_for(href)
+    return nil if href.nil?
+    if href.include? "/customData"
+      region = href.split('/')[-1]
+    else
+      region = href.split('/')[-2]
     end
+    CACHE_REGIONS.include?(region) ? region : nil
+  end
 
-    def apply_default_request_headers(request)
-      request.http_headers.store 'Accept', 'application/json'
-      apply_default_user_agent(request)
+  def apply_default_request_headers(request)
+    request.http_headers.store 'Accept', 'application/json'
+    apply_default_user_agent(request)
 
-      if request.body and request.body.length > 0
-        request.http_headers.store 'Content-Type', 'application/json'
-      end
+    if request.body and request.body.length > 0
+      request.http_headers.store 'Content-Type', 'application/json'
     end
+  end
 
-    def apply_form_data_request_headers(request)
-      request.http_headers.store 'Content-Type', 'application/x-www-form-urlencoded'
-      apply_default_user_agent(request)
-    end
+  def apply_form_data_request_headers(request)
+    request.http_headers.store 'Content-Type', 'application/x-www-form-urlencoded'
+    apply_default_user_agent(request)
+  end
 
-    def apply_default_user_agent(request)
-      request.http_headers.store 'User-Agent', 'stormpath-sdk-ruby/' + Stormpath::VERSION +
-      " ruby/#{RUBY_VERSION}-p#{RUBY_PATCHLEVEL}" +
-      " " + Gem::Platform.local.os.to_s + "/" + Gem::Platform.local.version.to_s
-    end
+  def apply_default_user_agent(request)
+    request.http_headers.store 'User-Agent', 'stormpath-sdk-ruby/' + Stormpath::VERSION +
+    " ruby/#{RUBY_VERSION}-p#{RUBY_PATCHLEVEL}" +
+    " " + Gem::Platform.local.os.to_s + "/" + Gem::Platform.local.version.to_s
+  end
 
-    def save_resource(href, resource, return_type)
-      assert_not_nil resource, "resource argument cannot be null."
-      assert_not_nil return_type, "returnType class cannot be null."
-      assert_kind_of Stormpath::Resource::Base, resource, "resource argument must be instance of Stormpath::Resource::Base"
+  def save_resource(href, resource, return_type)
+    assert_not_nil resource, "resource argument cannot be null."
+    assert_not_nil return_type, "returnType class cannot be null."
+    assert_kind_of Stormpath::Resource::Base, resource, "resource argument must be instance of Stormpath::Resource::Base"
 
-      q_href = qualify href
+    q_href = qualify href
 
-      clear_cache_on_save(resource)
+    clear_cache_on_save(resource)
 
-      response = execute_request 'post', q_href, resource
+    response = execute_request 'post', q_href, resource
 
-      instantiate return_type, parse_response(response)
-    end
+    instantiate return_type, parse_response(response)
+  end
 
-    def parse_response(response)
-      return {} if response.is_a? String and response.blank?
-      response.to_hash
-    end
+  def parse_response(response)
+    return {} if response.is_a? String and response.blank?
+    response.to_hash
+  end
 
-    def clear_cache_on_save(resource)
-      if resource.is_a? Stormpath::Resource::CustomDataStorage
-        clear_custom_data_cache_on_custom_data_storage_save(resource)
-      elsif resource.is_a? Stormpath::Resource::AccountStoreMapping
-        clear_application_cache_on_account_store_save(resource)
-      end
+  def clear_cache_on_save(resource)
+    if resource.is_a? Stormpath::Resource::CustomDataStorage
+      clear_custom_data_cache_on_custom_data_storage_save(resource)
+    elsif resource.is_a? Stormpath::Resource::AccountStoreMapping
+      clear_application_cache_on_account_store_save(resource)
     end
+  end
 
 
-    def clear_custom_data_cache_on_custom_data_storage_save resource
-      if resource.dirty_properties.has_key? "customData" and resource.new? == false
-        cached_href = resource.href + "/customData"
-        clear_cache cached_href
-      end
+  def clear_custom_data_cache_on_custom_data_storage_save resource
+    if resource.dirty_properties.has_key? "customData" and resource.new? == false
+      cached_href = resource.href + "/customData"
+      clear_cache cached_href
     end
+  end
 
-    def clear_application_cache_on_account_store_save resource
-      if resource.new?
-        if resource.default_account_store? == true || resource.default_group_store? == true
-          clear_cache resource.application.href
-        end
-      else
-        if resource.dirty_properties["isDefaultAccountStore"] != nil || resource.dirty_properties["isDefaultGroupStore"] != nil
-          clear_cache resource.application.href
-        end
+  def clear_application_cache_on_account_store_save resource
+    if resource.new?
+      if resource.default_account_store? == true || resource.default_group_store? == true
+        clear_cache resource.application.href
       end
-    end
-
-    def extract_body_from_resource(resource)
-      return if resource.nil?
-      form_data = resource.try(:form_data?)
-
-      if form_data
-        form_request_parse(resource)
-      else
-        MultiJson.dump(to_hash(resource))
+    else
+      if resource.dirty_properties["isDefaultAccountStore"] != nil || resource.dirty_properties["isDefaultGroupStore"] != nil
+        clear_cache resource.application.href
       end
     end
+  end
+
+  def extract_body_from_resource(resource)
+    return if resource.nil?
+    form_data = resource.try(:form_data?)
 
-    def form_request_parse(resource)
-      URI.encode_www_form(resource.form_properties.to_a)
+    if form_data
+      form_request_parse(resource)
+    else
+      MultiJson.dump(to_hash(resource))
     end
+  end
 
-    def to_hash(resource)
-      Hash.new.tap do |properties|
-        resource.get_dirty_property_names.each do |name|
-          ignore_camelcasing = resource_is_custom_data(resource, name)
-          property = resource.get_property name, ignore_camelcasing: ignore_camelcasing
+  def form_request_parse(resource)
+    URI.encode_www_form(resource.form_properties.to_a)
+  end
 
-          # Special use cases are with Custom Data, Provider and ProviderData, their hashes should not be simplified
-          # As of the implementation for MFA, Phone resource is added too
-          if property.kind_of?(Hash) and !resource_nested_submittable(resource, name) and name != "items" and name != 'phone'
-            property = to_simple_reference name, property
-          end
+  def to_hash(resource)
+    {}.tap do |properties|
+      resource.get_dirty_property_names.each do |name|
+        ignore_camelcasing = resource_is_custom_data(resource, name)
+        property = resource.get_property name, ignore_camelcasing: ignore_camelcasing
 
-          if name == "items" and resource_is_saml_mapping_rules? resource
-            property = property.map { |item| item.transform_keys { |key| key.to_s.camelize(:lower).to_sym }  }
-          end
+        # Special use cases are with Custom Data, Provider and ProviderData, their hashes should not be simplified
+        # As of the implementation for MFA, Phone resource is added too
+        if property.is_a?(Hash) && !resource_nested_submittable(resource, name) && name != 'items' && name != 'phone'
+          property = to_simple_reference name, property
+        end
 
-          properties.store name, property
+        if name == 'items' && resource_is_saml_mapping_rules?(resource)
+          property = property.map { |item| item.transform_keys { |key| key.to_s.camelize(:lower).to_sym }  }
         end
+
+        properties.store name, property
       end
     end
+  end
 
-    def to_simple_reference(property_name, hash)
-      assert_true hash.key?(HREF_PROP_NAME), "Nested resource '#{property_name}' must have an 'href' property."
+  def to_simple_reference(property_name, hash)
+    assert_true hash.key?(HREF_PROP_NAME), "Nested resource '#{property_name}' must have an 'href' property."
 
-      href = hash[HREF_PROP_NAME]
+    href = hash[HREF_PROP_NAME]
 
-      { HREF_PROP_NAME => href }
-    end
+    { HREF_PROP_NAME => href }
+  end
 
-    def resource_nested_submittable resource, name
-      ['provider', 'providerData', 'accountStore'].include?(name) or resource_is_custom_data(resource, name)
-    end
+  def resource_nested_submittable(resource, name)
+    ['provider', 'providerData', 'accountStore'].include?(name) ||
+      resource_is_custom_data(resource, name) ||
+      resource_is_application_web_config(resource, name)
+  end
 
-    def resource_is_custom_data resource, name
-      resource.is_a? Stormpath::Resource::CustomData or name == 'customData'
-    end
+  def resource_is_custom_data(resource, name)
+    resource.is_a?(Stormpath::Resource::CustomData) || name == 'customData'
+  end
 
-    def resource_is_saml_mapping_rules? resource
-      resource.is_a? Stormpath::Provider::SamlMappingRules
-    end
+  def resource_is_application_web_config(resource, name)
+    resource.is_a?(Stormpath::Resource::ApplicationWebConfig) &&
+      Stormpath::Resource::ApplicationWebConfig::ENDPOINTS.include?(name.underscore.to_sym)
+  end
 
+  def resource_is_saml_mapping_rules?(resource)
+    resource.is_a?(Stormpath::Provider::SamlMappingRules)
+  end
 end