stormpath-sdk 1.0.0.beta.5 → 1.0.0.beta.6

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e9e44a0599b007cd69c76fd3ab6be4ed95685f5e
+  data.tar.gz: 6a627f9090aa67d81df6d94aa659a3c8697207cd
+SHA512:
+  metadata.gz: 25e4af1d59e94e4c460f0a59d27a3bcad4d09516e8430a28e76ee7248d8077bfd1c2383a847a4eb266a8b9ace48073e74968296c9cf906ba0cfdfffdff55ea96
+  data.tar.gz: e538bee906bf915d706ccfb99d32a2dfd86c4bbf1c0dd51485690001964ebbc0dda8f4d9e5f94bc2e3959f5f0e11dfc27eedc4dd991d8fd6cf6a0ee43dc61462

data/.gitignore

@@ -11,4 +11,6 @@ spec/fixtures/vcr_cassettes
 Guardfile
 tmp/*
 *.gem
-.bundle/
+.bundle/
+dump.rdb
+.ruby-version

data/.travis.yml

@@ -26,5 +26,8 @@ env:
       yvaGCsPr2h6rwtiMb8QHA4tMqHsoay0e9s7jyBtn6amgUaLsV2vdhQTWDuIU
       cksOE3PMIovYl9ANLb6KrhDWt7ue/fOxEALh0a5rAu50C/tNvgo=
 
+language: ruby
+rvm:
+- 1.9.3
 services:
   - redis-server

data/CHANGES.md

@@ -1,6 +1,16 @@
 stormpath-sdk-ruby Changelog
 ============================
 
+Version 1.0.0.beta.6
+--------------------
+
+Released on July 7, 2014
+
+- Fixed custom data deletion issue.
+- Added resource pagination functionality.
+- Fixed issue when searching by email.
+
+
 Version 1.0.0.beta.5
 --------------------
 

data/README.md

@@ -495,8 +495,8 @@ The following environment variables need will then need to be set:
 
 ### Running
 
-Once properly configured, the tests can be run as the default
-<code>Rake<code> task:
+Once properly configured, start the redis server with <code>redis-server</code> and the tests can be run as the default
+<code>Rake</code> task:
 
 ```sh
 $ rake

data/lib/stormpath-sdk.rb

@@ -6,6 +6,7 @@ require "open-uri"
 require "uri"
 require "uuidtools"
 require "yaml"
+require 'active_support'
 require "active_support/core_ext"
 require 'active_support/core_ext/module/delegation'
 require 'active_support/core_ext/kernel/singleton_class'
@@ -55,18 +56,24 @@ module Stormpath
     autoload :CacheStats, 'stormpath-sdk/cache/cache_stats'
     autoload :MemoryStore, 'stormpath-sdk/cache/memory_store'
     autoload :RedisStore, 'stormpath-sdk/cache/redis_store'
+    autoload :DisabledCacheStore, 'stormpath-sdk/cache/disabled_cache_store'
   end
 
   module Authentication
+    autoload :UsernamePasswordRequest, "stormpath-sdk/auth/username_password_request"
+    autoload :BasicLoginAttempt, "stormpath-sdk/auth/basic_login_attempt"
+    autoload :AuthenticationResult, "stormpath-sdk/auth/authentication_result"
+    autoload :BasicAuthenticator, "stormpath-sdk/auth/basic_authenticator"
   end
-end
 
-require "stormpath-sdk/auth/username_password_request"
-require 'stormpath-sdk/http/utils'
-require "stormpath-sdk/http/request"
-require "stormpath-sdk/http/response"
-require "stormpath-sdk/http/authc/sauthc1_signer"
-require "stormpath-sdk/http/http_client_request_executor"
-require "stormpath-sdk/auth/basic_login_attempt"
-require "stormpath-sdk/auth/authentication_result"
-require "stormpath-sdk/auth/basic_authenticator"
+  module Http
+    autoload :Utils, "stormpath-sdk/http/utils"
+    autoload :Request, "stormpath-sdk/http/request"
+    autoload :Response, "stormpath-sdk/http/response"
+    autoload :HttpClientRequestExecutor, "stormpath-sdk/http/http_client_request_executor"
+
+    module Authc
+      autoload :Sauthc1Signer, "stormpath-sdk/http/authc/sauthc1_signer"
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+module Stormpath
+  module Cache
+    class DisabledCacheStore
+      def initialize(opts = nil)
+      end
+
+      def get(key)
+      end
+
+      def put(key, entry)
+        entry
+      end
+
+      def delete(key)
+      end
+
+      def clear
+        {}
+      end
+
+      def size
+        0
+      end
+    end
+  end
+end

data/lib/stormpath-sdk/client.rb

@@ -16,9 +16,9 @@
 require 'java_properties'
 
 module Stormpath
-
   class Client
     include Stormpath::Util::Assert
+    include Stormpath::Resource::Associations
 
     attr_reader :data_store, :application
 
@@ -38,9 +38,8 @@ module Stormpath
           options[:api_key_secret_property_name]
       end
 
-      assert_not_nil api_key, "No API key has been provided.  Please " +
-          "pass an 'api_key' or 'api_key_file_location' to the " +
-          "Stormpath::Client constructor."
+      assert_not_nil api_key, "No API key has been provided. Please pass an 'api_key' or " +
+                              "'api_key_file_location' to the Stormpath::Client constructor."
 
       request_executor = Stormpath::Http::HttpClientRequestExecutor.new(api_key, proxy: options[:proxy])
       @data_store = Stormpath::DataStore.new(request_executor, cache_opts, self, base_url)
@@ -58,18 +57,13 @@ module Stormpath
       @data_source.cache_stats
     end
 
-    include Stormpath::Resource::Associations
-
     has_many :tenants, href: '/tenants', can: :get
     has_many :applications, href: '/applications', can: [:get, :create], delegate: true
     has_many :directories, href: '/directories', can: [:get, :create], delegate: true
-    has_many(:accounts, href: '/accounts', can: :get) do
+    has_many :accounts, href: '/accounts', can: :get do
       def verify_email_token(token)
         token_href = "#{href}/emailVerificationTokens/#{token}"
-        token = Stormpath::Resource::EmailVerificationToken.new(
-          token_href,
-          client
-        )
+        token = Stormpath::Resource::EmailVerificationToken.new token_href, client
         data_store.save token, Stormpath::Resource::Account
       end
     end
@@ -77,38 +71,32 @@ module Stormpath
     has_many :group_memberships, href: '/groupMemberships', can: [:get, :create]
     has_many :account_store_mappings, href: '/accountStoreMappings', can: [:get, :create]
 
-    
     private
 
-    def load_api_key_file(api_key_file_location, id_property_name, secret_property_name)
-      begin
-        api_key_properties = JavaProperties::Properties.new api_key_file_location
-      rescue
-        raise ArgumentError,
-          "No API Key file could be found or loaded from '" +
-          api_key_file_location +
-          "'."
-      end
+      def load_api_key_file api_key_file_location, id_property_name, secret_property_name
+        begin
+          api_key_properties = JavaProperties::Properties.new api_key_file_location
+        rescue
+          raise ArgumentError, "No API Key file could be found or loaded from '#{api_key_file_location}'."
+        end
 
-      id_property_name ||= 'apiKey.id'
-      secret_property_name ||= 'apiKey.secret'
+        id_property_name ||= 'apiKey.id'
+        secret_property_name ||= 'apiKey.secret'
 
-      api_key_id = api_key_properties[id_property_name]
-      assert_not_nil api_key_id,
-        "No API id in properties. Please provide a 'apiKey.id' property in '" +
-        api_key_file_location +
-        "' or pass in an 'api_key_id_property_name' to the Stormpath::Client " +
-        "constructor to specify an alternative property."
+        api_key_id = api_key_properties[id_property_name]
+        assert_not_nil api_key_id, api_key_warning_message(:id, api_key_file_location)
 
-      api_key_secret = api_key_properties[secret_property_name]
-      assert_not_nil api_key_secret,
-        "No API secret in properties. Please provide a 'apiKey.secret' property in '" +
-        api_key_file_location +
-        "' or pass in an 'api_key_secret_property_name' to the Stormpath::Client " +
-        "constructor to specify an alternative property."
+        api_key_secret = api_key_properties[secret_property_name]
+        assert_not_nil api_key_secret, api_key_warning_message(:secret, api_key_file_location)
 
-      ApiKey.new api_key_id, api_key_secret
-    end
+        ApiKey.new api_key_id, api_key_secret
+      end
+
+      def api_key_warning_message id_or_secret, api_key_file_location
+        "No API #{id_or_secret} in properties. Please provide a 'apiKey.#{id_or_secret}' property " +
+        "in '#{api_key_file_location}' or pass in an 'api_key_#{id_or_secret}_property_name' " +
+        "to the Stormpath::Client constructor to specify an alternative property."
+      end
 
   end
 end

data/lib/stormpath-sdk/data_store.rb

@@ -19,6 +19,7 @@ class Stormpath::DataStore
 
   DEFAULT_SERVER_HOST = "api.stormpath.com"
   DEFAULT_API_VERSION = 1
+  DEFAULT_BASE_URL = "https://" + DEFAULT_SERVER_HOST + "/v" + DEFAULT_API_VERSION.to_s
   HREF_PROP_NAME = Stormpath::Resource::Base::HREF_PROP_NAME
 
   CACHE_REGIONS = %w( applications directories accounts groups groupMemberships accountMemberships tenants customData )
@@ -29,7 +30,7 @@ class Stormpath::DataStore
     assert_not_nil request_executor, "RequestExecutor cannot be null."
 
     @client = client
-    @base_url = get_base_url(base_url)
+    @base_url = base_url || DEFAULT_BASE_URL
     @request_executor = request_executor
     initialize_cache cache_opts
   end
@@ -68,7 +69,6 @@ class Stormpath::DataStore
   def save(resource, clazz = nil)
     assert_not_nil resource, "resource argument cannot be null."
     assert_kind_of Stormpath::Resource::Base, resource, "resource argument must be instance of Stormpath::Resource::Base"
-
     href = resource.href
     assert_not_nil href, "href or resource.href cannot be null."
     assert_true href.length > 0, "save may only be called on objects that have already been persisted (i.e. they have an existing href)."
@@ -100,12 +100,7 @@ class Stormpath::DataStore
     end
 
     def qualify(href)
-      if needs_to_be_fully_qualified(href)
-        slash_added = href.start_with?('/') ? '' : '/'
-        @base_url + slash_added + href
-      else
-        href
-      end
+      needs_to_be_fully_qualified(href) ? @base_url + href : href
     end
 
     def execute_request(http_method, href, body=nil, query=nil)
@@ -121,37 +116,51 @@ class Stormpath::DataStore
 
       if response.error?
         error = Stormpath::Resource::Error.new result
-        #puts "Error with request: #{http_method.upcase}: #{href}"
         raise Stormpath::Error.new error
       end
 
       if http_method == 'delete'
-        cache = cache_for href
-        cache.delete href if cache
+        clear_cache_on_delete(href)
         return nil
       end
 
-      if result['href']
+      if result[HREF_PROP_NAME]
         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
+    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 cache_walk(resource)
-      assert_not_nil resource['href'], "resource must have 'href' property"
+      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' => item['href'] }
+          { HREF_PROP_NAME => item[HREF_PROP_NAME] }
         end
       else     # single resource
         resource.each do |attr, value|
-          if value.is_a? Hash and value['href']
+          if value.is_a? Hash and value[HREF_PROP_NAME]
             walked = cache_walk value
-            resource[attr] = { 'href' => value['href'] } if value["href"]
+            resource[attr] = { HREF_PROP_NAME => value[HREF_PROP_NAME] }
             resource[attr]['items'] = walked['items'] if walked['items']
           end
         end
@@ -161,8 +170,8 @@ class Stormpath::DataStore
     end
 
     def cache(resource)
-      cache = cache_for resource['href']
-      cache.put resource['href'], resource if cache
+      cache = cache_for resource[HREF_PROP_NAME]
+      cache.put resource[HREF_PROP_NAME], resource if cache
     end
 
     def cache_for(href)
@@ -170,7 +179,7 @@ class Stormpath::DataStore
     end
 
     def region_for(href)
-      return nil unless href
+      return nil if href.nil?
       if href.include? "/customData"
         region = href.split('/')[-1]
       else
@@ -183,7 +192,7 @@ class Stormpath::DataStore
       request.http_headers.store 'Accept', 'application/json'
       request.http_headers.store 'User-Agent', 'Stormpath-RubySDK/' + Stormpath::VERSION
 
-      if !request.body.nil? and request.body.length > 0
+      if request.body and request.body.length > 0
         request.http_headers.store 'Content-Type', 'application/json'
       end
     end
@@ -195,19 +204,46 @@ class Stormpath::DataStore
 
       q_href = qualify href
 
-      response = execute_request('post', q_href, MultiJson.dump(to_hash(resource)))
+      clear_cache_on_save(resource)
+
+      response = execute_request 'post', q_href, MultiJson.dump(to_hash(resource))
 
       instantiate return_type, response.to_hash
     end
 
-    def get_base_url(base_url)
-        base_url || "https://" + DEFAULT_SERVER_HOST + "/v" + DEFAULT_API_VERSION.to_s
+    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
+    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
+      end
     end
 
     def to_hash(resource)
       Hash.new.tap do |properties|
         resource.get_dirty_property_names.each do |name|
-          property = resource.get_property name
+          ignore_camelcasing = resource_not_custom_data(resource, name) ? false : true
+          property = resource.get_property name, ignore_camelcasing: ignore_camelcasing
 
           # Special use case is with Custom Data, it's hashes should not be simplified
           if property.kind_of?(Hash) and resource_not_custom_data resource, name

data/lib/stormpath-sdk/http/authc/sauthc1_signer.rb

@@ -14,13 +14,9 @@
 # limitations under the License.
 #
 module Stormpath
-
   module Http
-
     module Authc
-
       class Sauthc1Signer
-
         include OpenSSL
         include UUIDTools
         include Stormpath::Http::Utils
@@ -45,7 +41,6 @@ module Stormpath
         end
 
         def sign_request request, api_key
-
           request.http_headers.delete(Sauthc1Signer::AUTHORIZATION_HEADER)
           request.http_headers.delete(Sauthc1Signer::STORMPATH_DATE_HEADER)
 
@@ -60,8 +55,8 @@ module Stormpath
           # SAuthc1 requires that we sign the Host header so we
           # have to have it in the request by the time we sign.
           host_header = uri.host
-          if !default_port?(uri)
 
+          if !default_port?(uri)
             host_header << ":" << uri.port.to_s
           end
 
@@ -112,128 +107,96 @@ module Stormpath
 
 
         def to_hex data
-
           result = ''
-          data.each_byte { |val|
 
+          data.each_byte do |val|
             hex = val.to_s(16)
 
             if hex.length == 1
-
               result << '0'
-
             elsif hex.length == 8
-
               hex = hex[0..6]
             end
 
             result << hex
-
-          }
-
+          end
           result
-
         end
 
         protected
 
-        def canonicalize_query_string request
-          request.to_s_query_string true
-        end
-
-        def hash_text text
-          Digest.digest DEFAULT_ALGORITHM, to_utf8(text)
-        end
-
-        def sign data, key, algorithm
-
-          digest_data = to_utf8 data
-
-          digest = Digest::Digest.new(algorithm)
-
-          HMAC.digest(digest, key, digest_data)
-
-        end
-
-        def to_utf8 str
-          #we ask for multi line UTF-8 text
-          str.scan(/./mu).join
-        end
-
-        def get_request_payload request
-          get_request_payload_without_query_params request
-        end
-
-        def get_request_payload_without_query_params request
-
-          result = ''
-
-          if !request.body.nil?
-            result = request.body
+          def canonicalize_query_string request
+            request.to_s_query_string true
           end
 
-          result
-
-        end
-
-        private
-
-        def create_name_value_pair name, value
-          name + '=' + value
-        end
-
-        def canonicalize_resource_path resource_path
-
-          if resource_path.nil? or resource_path.empty?
-            '/'
-          else
-            encode_url resource_path, true, true
+          def hash_text text
+            Digest.digest DEFAULT_ALGORITHM, to_utf8(text)
           end
-        end
 
-
-        def canonicalize_headers request
-
-          sorted_headers = request.http_headers.keys.sort!
-
-          result = ''
-
-          sorted_headers.each do |header|
-
-            result << header.downcase << ':' << request.http_headers[header].to_s
-
-            result << NL
+          def sign data, key, algorithm
+            digest_data = to_utf8 data
+            digest = Digest.new(algorithm)
+            HMAC.digest(digest, key, digest_data)
           end
 
-          result
+          def to_utf8 str
+            #we ask for multi line UTF-8 text
+            str.scan(/./mu).join
+          end
 
-        end
+          def get_request_payload request
+            get_request_payload_without_query_params request
+          end
 
-        def get_signed_headers request
+          def get_request_payload_without_query_params request
+            result = ''
+            if !request.body.nil?
+              result = request.body
+            end
+            result
+          end
 
-          sorted_headers = request.http_headers.keys.sort!
+        private
 
-          result = ''
-          sorted_headers.each do |header|
+          def create_name_value_pair name, value
+            name + '=' + value
+          end
 
-            if !result.empty?
-              result << ';' << header
+          def canonicalize_resource_path resource_path
+            if resource_path.nil? or resource_path.empty?
+              '/'
             else
-              result << header
+              encode_url resource_path, true, true
             end
-
-
           end
 
-          result.downcase
-
-        end
 
+          def canonicalize_headers request
+            sorted_headers = request.http_headers.keys.sort!
+            result = ''
 
-      end
+            sorted_headers.each do |header|
+              result << header.downcase << ':' << request.http_headers[header].to_s
+              result << NL
+            end
+            result
+          end
 
-    end
+          def get_signed_headers request
+            sorted_headers = request.http_headers.keys.sort!
+            result = ''
+            sorted_headers.each do |header|
+              if !result.empty?
+                result << ';' << header
+              else
+                result << header
+              end
+            end
+            result.downcase
+          end
 
-  end
 
-end
+      end#Sauthc1Signer
+    end#Authc
+  end#Http
+end#Stormpath