stormpath-sdk 0.1.0

data/Gemfile

@@ -0,0 +1,4 @@
+source :rubygems
+
+gemspec
+

data/README.md

@@ -0,0 +1,24 @@
+Stormpath SDK For Ruby
+Copyright (c) 2012 Stormpath, Inc. and contributors.
+
+This project is licensed under the Apache 2.0 Open Source License:
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Project Documentation is here:
+
+https://github.com/stormpath/stormpath-sdk-ruby/wiki
+
+# Build Instructions
+
+Via rubygems.org:
+
+$ gem install stormpath-sdk
+To build and install the development branch yourself from the latest source:
+
+```
+$ git clone git@github.com:stormpath/stormpath-sdk-ruby.git
+$ cd stormpath-sdk-ruby
+$ rake gem
+$ gem install pkg/stormpath-sdk-{version}
+```

data/Rakefile

@@ -0,0 +1,16 @@
+require 'rubygems'
+require 'rubygems/package_task'
+require 'rspec/core/rake_task'
+
+spec = eval(File.read('stormpath-sdk.gemspec'))
+
+Gem::PackageTask.new(spec) do |p|
+  p.gem_spec = spec
+end
+
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = '**/*_spec.rb'
+  t.rspec_opts = ['-c']
+end
+
+task :default => :spec

data/lib/stormpath-sdk.rb

@@ -0,0 +1,49 @@
+require "base64"
+require "httpclient"
+require "multi_json"
+require "openssl"
+require "open-uri"
+require "uri"
+require "uuidtools"
+require "yaml"
+
+require "stormpath-sdk/version" unless defined? Stormpath::VERSION
+require "stormpath-sdk/util/assert"
+require "stormpath-sdk/client/api_key"
+require "stormpath-sdk/client/client"
+require "stormpath-sdk/util/hash"
+require "stormpath-sdk/client/client_builder"
+require "stormpath-sdk/auth/username_password_request"
+require "stormpath-sdk/resource/status"
+require "stormpath-sdk/resource/utils"
+require "stormpath-sdk/util/request_utils"
+require "stormpath-sdk/resource/resource"
+require "stormpath-sdk/resource/collection_resource"
+require "stormpath-sdk/resource/instance_resource"
+require "stormpath-sdk/resource/resource"
+require "stormpath-sdk/resource/error"
+require "stormpath-sdk/resource/resource_error"
+require "stormpath-sdk/resource/error"
+require "stormpath-sdk/resource/tenant"
+require "stormpath-sdk/resource/directory"
+require "stormpath-sdk/resource/tenant"
+require "stormpath-sdk/resource/email_verification_token"
+require "stormpath-sdk/resource/group_list"
+require "stormpath-sdk/resource/account"
+require "stormpath-sdk/resource/account_list"
+require "stormpath-sdk/resource/password_reset_token"
+require "stormpath-sdk/resource/application"
+require "stormpath-sdk/resource/group"
+require "stormpath-sdk/resource/application_list"
+require "stormpath-sdk/resource/directory_list"
+require "stormpath-sdk/resource/group_membership"
+require "stormpath-sdk/resource/group_membership_list"
+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"
+require "stormpath-sdk/ds/resource_factory"
+require "stormpath-sdk/ds/data_store"

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

@@ -0,0 +1,17 @@
+module Stormpath
+
+  module Authentication
+
+    class AuthenticationResult < Stormpath::Resource::Resource
+
+      ACCOUNT = "account"
+
+      def get_account
+        get_resource_property ACCOUNT, Account
+      end
+
+    end
+
+  end
+
+end

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

@@ -0,0 +1,42 @@
+module Stormpath
+
+  module Authentication
+
+    class BasicAuthenticator
+
+      include Stormpath::Util::Assert
+
+      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."
+
+        username = request.get_principals
+        username = (username != nil) ? username : ''
+
+        password = request.get_credentials
+        pw_string = password.to_s
+
+        value = username + ':' + pw_string
+
+        value = Base64.encode64(value).tr("\n", '')
+
+        attempt = @data_store.instantiate BasicLoginAttempt, nil
+        attempt.set_type 'basic'
+        attempt.set_value value
+
+        href = parent_href + '/loginAttempts'
+        result = @data_store.create href, attempt, AuthenticationResult
+        result.get_account
+
+      end
+
+    end
+
+  end
+
+end

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

@@ -0,0 +1,30 @@
+module Stormpath
+
+  module Authentication
+
+    class BasicLoginAttempt < Stormpath::Resource::Resource
+
+      TYPE = "type"
+      VALUE = "value"
+
+      def get_type
+        get_property TYPE
+      end
+
+      def set_type type
+        set_property TYPE, type
+      end
+
+      def get_value
+        get_property VALUE
+      end
+
+      def set_value value
+        set_property VALUE, value
+      end
+
+    end
+
+  end
+
+end

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

@@ -0,0 +1,43 @@
+module Stormpath
+
+  module Authentication
+
+    class UsernamePasswordRequest
+
+      attr_reader :host
+
+      def initialize username, password, host
+        @username = username
+        @password = (password != nil and password.length > 0) ? password.chars.to_a : "".chars.to_a
+        @host = host
+      end
+
+      def get_principals
+        @username
+      end
+
+      def get_credentials
+        @password
+      end
+
+      ##
+      # Clears out (nulls) the username, password, and host.  The password bytes are explicitly set to
+      # <tt>0x00</tt> to eliminate the possibility of memory access at a later time.
+      def clear
+        @username = nil
+        @host = nil
+
+        @password.each { |pass_char|
+
+          pass_char = 0x00
+        }
+
+        @password = nil
+      end
+
+    end
+
+  end
+
+end
+

data/lib/stormpath-sdk/client/api_key.rb

@@ -0,0 +1,18 @@
+module Stormpath
+
+  module Client
+
+    class ApiKey
+
+      attr_accessor :id, :secret
+
+      def initialize(id, secret)
+        @id = id
+        @secret = secret
+      end
+    end
+
+  end
+
+end
+

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

@@ -0,0 +1,23 @@
+module Stormpath
+
+  module Client
+
+    class Client
+
+      attr_reader :data_store
+
+      def initialize(api_key, *base_url)
+        request_executor = Stormpath::Http::HttpClientRequestExecutor.new(api_key)
+        @data_store = Stormpath::DataStore::DataStore.new(request_executor, *base_url)
+      end
+
+
+      def current_tenant
+        @data_store.get_resource("/tenants/current", Stormpath::Resource::Tenant)
+      end
+    end
+  end
+
+
+end
+

data/lib/stormpath-sdk/client/client_builder.rb

@@ -0,0 +1,291 @@
+module Stormpath
+
+  module Client
+
+    # A <a href="http://en.wikipedia.org/wiki/Builder_pattern">Builder design pattern</a> implementation used to
+    # construct {@link Client} instances.
+    # <p/>
+    # The {@code ClientBuilder} is especially useful for constructing Client instances with Stormpath API Key
+    # information loaded from an external {@code .yml} file (or YAML instance) to ensure the API Key secret
+    # (password) does not reside in plaintext in code.
+    # <p/>
+    # Example usage:
+    # <pre>
+    # String location = "/home/jsmith/.stormpath/apiKey.yml";
+    #
+    # client = ClientBuilder.new.set_api_key_file_location(location).build()
+    # </pre>
+    # <p/>
+    # You may load files from the filesystem or URLs by specifying the file location.
+    #  See {@link #set_api_key_file_location(location)} for more information.
+    #
+    # @see #set_api_key_file_location(location)
+    class ClientBuilder
+
+      include Stormpath::Client
+      include Stormpath::Util::Assert
+
+      def initialize
+        @api_key_id_property_name = "apiKey.id"
+        @api_key_secret_property_name = "apiKey.secret"
+      end
+
+      # Allows usage of a YAML loadable object (IO object or the result of invoking Object.to_yaml)
+      # instead of loading a YAML file via {@link #set_api_key_file_location apiKeyFileLocation} configuration.
+      # <p/>
+      # The YAML contents and property name overrides function the same as described in the
+      # {@link #set_api_key_file_location setApiKeyFileLocation} RDoc.
+      #
+      # @param properties the YAML object to use to load the API Key ID and Secret.
+      # @return the ClientBuilder instance for method chaining.
+      def set_api_key_properties properties
+
+        @api_key_properties = properties
+        self
+
+      end
+
+      # Creates an API Key YAML object based on the specified File instead of loading a YAML
+      # file via  {@link #set_api_key_file_location apiKeyFileLocation} configuration. This file argument
+      # needs to be an IO instance.
+      # <p/>
+      # The constructed YAML contents and property name overrides function the same as described in the
+      # {@link #set_api_key_file_location setApiKeyFileLocation} RDoc.
+      # @param file the file to use to construct a YAML object.
+      # @return the ClientBuilder instance for method chaining.
+      def set_api_key_file file
+        assert_kind_of IO, file, 'file must be kind of IO'
+        @api_key_file = file
+        self
+      end
+
+
+      # Sets the location of the YAML file to load containing the API Key (Id and secret) used by the
+      # Client to communicate with the Stormpath REST API.
+      # <p/>
+      # You may load files from the filesystem, or URLs just specifying the file location.
+      # <h3>File Contents</h3>
+      # <p/>
+      # When the file is loaded, the following name/value pairs are expected to be present by default:
+      # <table>
+      #     <tr>
+      #         <th>Key</th>
+      #         <th>Value</th>
+      #     </tr>
+      #     <tr>
+      #         <td>apiKey.id</td>
+      #         <td>An individual account's API Key ID</td>
+      #     </tr>
+      #     <tr>
+      #         <td>apiKey.secret</td>
+      #         <td>The API Key Secret (password) that verifies the paired API Key ID.</td>
+      #     </tr>
+      # </table>
+      # <p/>
+      # Assuming you were using these default property names, your {@code ClientBuilder} usage might look like the
+      # following:
+      # <pre>
+      # String location = "/home/jsmith/.stormpath/apiKey.yml";
+      #
+      # client = ClientBuilder.new.set_api_key_file_location(location).build()
+      # </pre>
+      # <h3>Custom Property Names</h3>
+      # If you want to control the property names used in the file, you may configure them via
+      # {@link #set_api_key_id_property_name(String) set_api_key_id_property_name} and
+      # {@link #set_api_key_secret_property_name(String) set_api_key_secret_property_name}.
+      # <p/>
+      # For example, if you had a {@code /home/jsmith/.stormpath/apiKey.properties} file with the following
+      # name/value pairs:
+      # <pre>
+      # myStormpathApiKeyId = 'foo'
+      # myStormpathApiKeySecret = 'mySuperSecretValue'
+      # </pre>
+      # Your {@code ClientBuilder} usage would look like the following:
+      # <pre>
+      # location = "/home/jsmith/.stormpath/apiKey.yml";
+      #
+      # client =
+      #     ClientBuilder.new.
+      #     set_api_key_file_location(location).
+      #     set_api_key_id_property_name("myStormpathApiKeyId").
+      #     set_api_key_secret_property_name("myStormpathApiKeySecret").
+      #     build
+      # </pre>
+      #
+      # @param location the file or url location of the API Key {@code .yml} file to load when
+      #                 constructing the API Key to use for communicating with the Stormpath REST API.
+      #
+      # @return the ClientBuilder instance for method chaining.
+      #/
+      def set_api_key_file_location location
+        assert_kind_of String, location, 'location must be kind of String'
+        @api_key_file_location = location
+        self
+      end
+
+
+      # Sets the name used to query for the API Key ID from a YAML instance.  That is:
+      # <pre>
+      # apiKeyId = yml.access(<b>api_key_id_property_name</b>)
+      # </pre>
+      #
+      # The Hash#access method searches through the provided path and returns the found value.
+      #
+      # The <b>api_key_id_property_name</b> key can be as deep as needed, as long as it comes
+      # in the exact path order.
+      # Example: Having the file 'apiKey.yml' with the following content:
+      #
+      #           stormpath:
+      #             apiKey:
+      #             id: myStormpathApiKeyId
+      #
+      # The method should be called as follows:
+      #
+      #           ClientBuilder#set_api_key_id_property_name('stormpath', 'apiKey', 'id')
+      #
+      # @param api_key_id_property_name the name used to query for the API Key ID from a YAML instance.
+      # @return the ClientBuilder instance for method chaining.
+      def set_api_key_id_property_name *api_key_id_property_name
+
+        @api_key_id_property_name = *api_key_id_property_name
+        self
+
+      end
+
+
+      # Sets the name used to query for the API Key Secret from a YAML instance.  That is:
+      # <pre>
+      # apiKeyId = yml.access(<b>api_key_secret_property_name</b>)
+      # </pre>
+      #
+      # The Hash#access method searches through the provided path and returns the found value.
+      #
+      # The <b>api_key_secret_property_name</b> key can be as deep as needed, as long as it comes
+      # in the exact path order.
+      # Example: Having the file 'apiKey.yml' with the following content:
+      #
+      #           stormpath:
+      #             apiKey:
+      #             secret: myStormpathApiKeyId
+      #
+      # The method should be called as follows:
+      #
+      #           ClientBuilder#set_api_key_id_property_name('stormpath', 'apiKey', 'secret')
+      #
+      # @param api_key_secret_property_name the name used to query for the API Key Secret from a YAML instance.
+      # @return the ClientBuilder instance for method chaining.
+      def set_api_key_secret_property_name *api_key_secret_property_name
+
+        @api_key_secret_property_name = *api_key_secret_property_name
+        self
+
+      end
+
+      # Constructs a new {@link Client} instance based on the ClientBuilder's current configuration state.
+      #
+      # @return a new {@link Client} instance based on the ClientBuilder's current configuration state.
+      #
+      def build
+
+        if @api_key_properties.nil? or (@api_key_properties.respond_to? 'empty?' and @api_key_properties.empty?)
+
+
+          #need to load the properties file
+
+          file = get_available_file
+
+          if file.nil?
+            raise ArgumentError, "No API Key file could be found or loaded from a file location.  Please " +
+                "configure the 'apiKeyFileLocation' property or alternatively configure a " +
+                "YAML loadable instance."
+          end
+
+          yaml_obj = YAML::load(file)
+
+        else
+
+          yaml_obj = YAML::load(@api_key_properties)
+
+        end
+
+        api_key_id = get_required_property_value yaml_obj, 'api_key_id', @api_key_id_property_name
+
+        api_key_secret = get_required_property_value yaml_obj, 'api_key_secret', @api_key_secret_property_name
+
+        assert_not_nil api_key_id, 'api_key_id must not be nil when acquiring it from the YAML object'
+        assert_not_nil api_key_secret, 'api_key_secret must not be nil when acquiring it from the YAML object'
+
+        api_key = ApiKey.new api_key_id, api_key_secret
+
+        Client.new api_key, @base_url
+
+      end
+
+      def set_base_url base_url
+        @base_url = base_url
+        self
+      end
+
+      private
+
+
+      def get_property_value yml, prop_name, separator
+
+        value = yml.access(prop_name, separator)
+
+        if !value.nil?
+
+          if value.kind_of? String
+
+            value = value.strip
+
+          end
+
+          if value.empty?
+            value = nil
+          end
+
+        end
+
+        value
+
+      end
+
+      def get_required_property_value yml, masterName, *prop_name
+
+
+        prop_name_value = prop_name[0]
+
+        separator = '--YAMLKeysSeparator--'
+        value = get_property_value(yml, prop_name_value.respond_to?('join') ?
+            prop_name[0].join(separator) :
+            prop_name_value,
+                                   separator)
+
+        if value.nil?
+
+          raise ArgumentError, "There is no '" + prop_name.join(':') + "' property in the " +
+              "configured apiKey YAML.  You can either specify that property or " +
+              "configure the " + masterName + "PropertyName value on the ClientBuilder to specify a " +
+              "custom property name."
+        end
+
+        value
+
+      end
+
+      def get_available_file
+
+        if @api_key_file
+          return @api_key_file
+        end
+
+        open(@api_key_file_location) { |f| f.read }
+
+      end
+
+    end
+
+  end
+
+end