stormpath-sdk 0.4.0 → 1.0.0.beta

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

@@ -1,327 +0,0 @@
-#
-# Copyright 2012 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.
-#
-module Stormpath
-
-  module Resource
-
-    class Resource
-
-      include Utils
-
-      HREF_PROP_NAME = "href"
-
-      def initialize data_store, properties = {}
-
-        @data_store = data_store
-        @read_lock = Mutex.new
-        @write_lock = Mutex.new
-        @properties = Hash.new
-        @dirty_properties = Hash.new
-        set_properties properties
-
-      end
-
-      def set_properties properties
-
-        @write_lock.lock
-
-        begin
-
-          @properties.clear
-          @dirty_properties.clear
-          @dirty = false
-
-          if !properties.nil? and properties.is_a? Hash
-            @properties.replace properties
-
-            # Don't consider this resource materialized if it is only a reference.  A reference is any object that
-            # has only one 'href' property.
-            href_only = (@properties.size == 1 and @properties.has_key? HREF_PROP_NAME)
-            @materialized = !href_only
-
-          else
-            @materialized = false
-          end
-
-        ensure
-          @write_lock.unlock
-        end
-      end
-
-      def get_property name
-
-        if !HREF_PROP_NAME.eql? name
-          #not the href/id, must be a property that requires materialization:
-          if !is_new and !materialized
-
-            # only materialize if the property hasn't been set previously (no need to execute a server
-            # request since we have the most recent value already):
-            present = false
-            @read_lock.lock
-
-            begin
-
-              present = @dirty_properties.has_key? name
-
-            ensure
-
-              @read_lock.unlock
-
-            end
-
-            if !present
-              # exhausted present properties - we require a server call:
-              materialize
-            end
-
-          end
-
-        end
-
-        read_property name
-      end
-
-      def get_property_names
-        @read_lock.lock
-
-        begin
-          @properties.keys
-        ensure
-          @read_lock.unlock
-        end
-
-      end
-
-      def get_href
-        get_property HREF_PROP_NAME
-      end
-
-      def inspect
-
-        @read_lock.lock
-
-        str = ''
-
-        begin
-
-          counter = 2
-          @properties.each do |key, value|
-
-            if str.empty?
-
-              str = '#<' + class_name_with_id + ' @properties={'
-
-            else
-
-              if printable_property? key
-
-                str << "\"#{key}\"=>"
-
-                if value.kind_of? Hash and value.has_key? HREF_PROP_NAME
-
-                  str << '{"' << HREF_PROP_NAME + '"=>"' + value[HREF_PROP_NAME] + '"}'
-
-                else
-
-                  str << "\"#{value}\""
-
-                end
-
-                if counter < @properties.length
-
-                  str << ', '
-
-                end
-
-              end
-
-              counter+= 1
-
-            end
-
-          end
-
-        ensure
-
-          @read_lock.unlock
-
-        end
-
-        if !str.empty?
-          str << '}>'
-        end
-
-        str
-
-      end
-
-      def to_s
-        '#<' + class_name_with_id + '>'
-      end
-
-      def to_yaml
-
-        yaml = '--- !ruby/object:' << self.class.name << "\n"
-
-        @read_lock.lock
-
-        begin
-
-          first_property = true
-          @properties.each do |key, value|
-
-            if printable_property? key
-
-              if first_property
-
-                yaml << " properties\n "
-
-              end
-
-              yaml << ' ' << key << ': ' << value << "\n"
-
-              first_property = false
-
-            end
-
-          end
-
-        ensure
-
-          @read_lock.unlock
-
-        end
-
-        yaml << "\n"
-
-      end
-
-      protected
-
-      attr_reader :data_store, :materialized
-
-      def get_resource_property key, clazz
-
-        value = get_property key
-
-        if value.is_a? Hash
-          href = get_href_from_hash value
-        end
-
-        if !href.nil?
-          @data_store.instantiate clazz, value
-        end
-      end
-
-      ##
-      # Returns {@code true} if the resource doesn't yet have an assigned 'href' property, {@code false} otherwise.
-      #
-      # @return {@code true} if the resource doesn't yet have an assigned 'href' property, {@code false} otherwise.
-      def is_new
-
-        #we can't call get_href in here, otherwise we'll have an infinite loop:
-
-        prop = read_property HREF_PROP_NAME
-
-        if prop.nil?
-          true
-
-        else
-          prop.respond_to? 'empty' and prop.empty?
-        end
-
-      end
-
-      def set_property name, value
-
-        @write_lock.lock
-
-        begin
-          @properties.store name, value
-          @dirty_properties.store name, value
-          @dirty = true
-        ensure
-          @write_lock.unlock
-        end
-
-      end
-
-      def materialize
-        clazz = to_class_from_instance self
-
-        @write_lock.lock
-
-        begin
-
-          resource = @data_store.get_resource get_href, clazz
-          @properties.replace resource.properties
-
-          #retain dirty properties:
-          @properties.merge! @dirty_properties
-
-          @materialized = true
-
-        ensure
-
-          @write_lock.unlock
-        end
-
-      end
-
-      def properties
-        @properties
-      end
-
-      ##
-      # Returns {@code true} if the internal property is safe to print in to_s or inspect, {@code false} otherwise.
-      #
-      # @param property_name The name of the property to check for safe printing
-      # @return {@code true} if the internal property is safe to print in to_s, {@code false} otherwise.
-      def printable_property? property_name
-
-        return true
-
-      end
-
-      private
-
-      def get_href_from_hash(props)
-
-        if !props.nil? and props.is_a? Hash
-          value = props[HREF_PROP_NAME]
-        end
-
-        value
-      end
-
-      def read_property name
-        @read_lock.lock
-
-        begin
-          @properties[name]
-        ensure
-          @read_lock.unlock
-        end
-
-      end
-
-      def class_name_with_id
-        self.class.name + ':0x' + ('%x' % (self.object_id << 1)).to_s
-      end
-    end
-  end
-
-end

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

@@ -1,47 +0,0 @@
-#
-# Copyright 2012 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.
-#
-module Stormpath
-
-  module Resource
-
-    class ResourceError < RuntimeError
-
-      def initialize error
-        super !error.nil? ? error.get_message : ''
-        @error = error
-      end
-
-      def get_status
-        !@error.nil? ? @error.get_status : -1
-      end
-
-      def get_code
-        !@error.nil? ? @error.get_code : -1
-      end
-
-      def get_developer_message
-        !@error.nil? ? @error.get_developer_message : nil
-      end
-
-      def get_more_info
-        !@error.nil? ? @error.get_more_info : nil
-      end
-
-    end
-
-  end
-end
-

data/test/client/client.yml

@@ -1,16 +0,0 @@
-apiKey.id: myApiKeyId
-apiKey.secret: myApkiKeySecret
-
-different.apiKey.id: myApiKeyId
-different.apiKey.secret: myApkiKeySecret
-
-
-stormpath:
-  apiKey:
-    id: myApiKeyId
-    secret: myApkiKeySecret
-
-different.stormpath:
-  different.apiKey:
-    different.id: myApiKeyId
-    different.secret: myApkiKeySecret

data/test/client/client_application_builder_spec.rb

@@ -1,114 +0,0 @@
-require "stormpath-sdk"
-
-include Stormpath::Client
-
-describe "Client Application Builder Tests" do
-
-  before(:all) do
-    @client_file = 'test/client/client.yml'
-    @client_remote_file = 'http://localhost:8081/client.yml'
-    @application_href = 'http://localhost:8080/v1/applications/uGBNDZ7TRhm_tahanqvn9A'
-    @http_prefix = 'http://'
-    @app_href_without_http = '@localhost:8080/v1/applications/uGBNDZ7TRhm_tahanqvn9A'
-    @client_builder = ClientBuilder.new.set_base_url 'http://localhost:8080/v1'
-    @test_remote_file = false
-  end
-
-
-  it 'Builder should read default properties from YAML file location with application href' do
-
-    result = ClientApplicationBuilder.new(@client_builder).
-        set_api_key_file_location(@client_file).
-        set_application_href(@application_href).
-        build
-
-    result.should be_kind_of ClientApplication
-
-  end
-
-  it 'Builder should create ClientApplication with data from application href with credentials' do
-
-    # getting the properties from file...just to avoid writing them directly
-    # in the 'properties' Hash
-    yml_obj = YAML::load(File.open @client_file)
-    api_key_id_keyword = 'apiKey.id'
-    api_key_secret_keyword = 'apiKey.secret'
-
-    # we create the client from this Hash instead of from a file
-    properties = {api_key_id_keyword => yml_obj[api_key_id_keyword],
-                  api_key_secret_keyword => yml_obj[api_key_secret_keyword]}
-
-    application_href = @http_prefix +
-        properties[api_key_id_keyword] +
-        ':' +
-        properties[api_key_secret_keyword] +
-        @app_href_without_http
-
-    result = ClientApplicationBuilder.new(@client_builder).
-        set_application_href(application_href).
-        build
-
-    result.should be_kind_of ClientApplication
-
-  end
-
-  it 'Builder should read custom complex properties from YAML file locatio with application href' do
-
-    @client_builder = ClientBuilder.new.set_base_url 'http://localhost:8080/v1'
-    result = ClientApplicationBuilder.new(@client_builder).
-        set_api_key_file_location(@client_file).
-        set_api_key_id_property_name('stormpath', 'apiKey', 'id').
-        set_api_key_secret_property_name('stormpath', 'apiKey', 'secret').
-        set_application_href(@application_href).
-        build
-
-    result.should be_kind_of ClientApplication
-
-  end
-
-  it 'Builder should read custom simple properties from YAML file locatio with application href' do
-
-    # getting the properties from file...just to avoid writing them directly
-    # in the 'properties' Hash
-    yml_obj = YAML::load(File.open @client_file)
-    api_key_id_keyword = 'different.apiKey.id'
-    api_key_secret_keyword = 'different.apiKey.secret'
-
-    # we create the client from this Hash instead of from a file
-    properties = {api_key_id_keyword => yml_obj[api_key_id_keyword],
-                  api_key_secret_keyword => yml_obj[api_key_secret_keyword]}
-
-    result = ClientApplicationBuilder.new(@client_builder).
-        set_api_key_properties(properties.to_yaml).
-        set_api_key_id_property_name(api_key_id_keyword).
-        set_api_key_secret_property_name(api_key_secret_keyword).
-        set_application_href(@application_href).
-        build
-
-    result.should be_kind_of ClientApplication
-
-  end
-
-  it 'Builder should throw exception when creating it with wrong argument' do
-
-    expect { ClientApplicationBuilder.new 'WRONG' }.to raise_error ArgumentError
-
-  end
-
-  it 'Builder should throw exception when trying to build without application href' do
-
-    expect { ClientApplicationBuilder.new(@client_builder).build }.to raise_error ArgumentError
-
-  end
-
-  it 'Builder should throw exception when trying to build with an invalid application href' do
-
-    expect { ClientApplicationBuilder.new(@client_builder).
-        set_api_key_file_location(@client_file).
-        set_application_href('id:secret@stormpath.com/v1').
-        build }.
-        to raise_error ArgumentError
-
-  end
-
-end