stormpath-sdk 1.0.0.beta.2 → 1.0.0.beta.3.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    YjI3MzYxY2JjNDRjN2NiOTUwMjEyNjI1MjBmZjJlYzQxZDFhNGVlNw==
+  data.tar.gz: !binary |-
+    ODFkZWE1MTE3ZDAyMmI3ZWY0NTZjYThiNWJiOTNhODA5MzY5NzBjMw==
+SHA512:
+  metadata.gz: !binary |-
+    YjY1ZDMxYTcxMzBjZDNkZmU2NDczMmE5NDIzYWQxMjI0OGVkOGE4ZTFiZmZh
+    ODgxYzNhMDQ4MDE5Y2RmOWZlNGNkNTM5M2YxZTBiZmUwYWRhZjgwODVlZDBk
+    NTYxNTgwMTAyMTc3N2RmYmUyMzM5OWU3MjQ4OGZmOGRkOGUzMjI=
+  data.tar.gz: !binary |-
+    OTdiZmE1NGU0MjIwNWZlNDhjZWViYzQ0NDk5NjQ0NTcwYjhlZTNmZGIzMThk
+    ZjBmMDlhODQ2ZDhlNzM3ZDdjNGY0MzdmMTdjNWNmMzA0OGJlMGFjYWUyMTdm
+    NTg3MmVjMjA5ODJlYTE0YWM1MjFlMmFhOTMxNmNhNTIzY2RiOGY=

data/.gitignore

@@ -4,3 +4,9 @@ pkg/*
 Gemfile.lock
 coverage
 spec/fixtures/vcr_cassettes
+*.ipr
+*.iws
+*.iml
+.idea
+Guardfile
+tmp/*

data/CHANGES.md

@@ -1,6 +1,14 @@
 stormpath-sdk-ruby Changelog
 ============================
 
+Version 1.0.0.beta.3
+--------------------
+
+Released on September 25, 2013
+
+- Added support for using special characters in account resource fields (e.g., username, password, etc.) when creating or updating a resource
+- Added "createDirectory=true" option to the application.create method to allow automatic creation of a directory when creating an application. Refer to readme for more info.
+
 Version 1.0.0.beta.2
 --------------------
 

data/README.md

@@ -9,24 +9,38 @@ application.
 ## Install
 
 ```sh
-$ gem install stormpath-sdk
+$ gem install stormpath-sdk --pre
 ```
 
-## Quickstart Guide
+## Provision Your Stormpath Account
 
-1.  If you have not already done so, register as a developer on
-    [Stormpath][stormpath] and set up your API credentials and resources:
+If you have not already done so, register as a developer on
+[Stormpath][stormpath] and set up your API credentials and resources:
 
-    1.  Create a [Stormpath][stormpath] developer account and [create your API Keys][create-api-keys]
-        downloading the <code>apiKey.properties</code> file into a <code>.stormpath</code>
-        folder under your local home directory.
+1. Create a [Stormpath][stormpath] developer account and
+   [create your API Keys][create-api-keys] downloading the
+   <code>apiKey.properties</code> file into a <code>.stormpath</code>
+   folder under your local home directory.
 
-    1.  Create an application and a directory to store your users'
-        accounts. Make sure the directory is assigned as a login source
-        to the application.
+1. Through the [Stormpath Admin UI][stormpath-admin-login], create yourself
+   an [Application Resource][concepts]. On the Create New Application
+   screen, make sure the "Create a new directory with this application" box
+   is checked. This will provision a [Directory Resource][concepts] along
+   with your new Application Resource and link the Directory to the
+   Application as a [Login Source][concepts]. This will allow users
+   associated with that Directory Resource to authenticate and have access
+   to that Application Resource.
 
-    1.  Take note of the _REST URL_ of the application and of directory
-        you just created.
+   It is important to note that although your developer account comes with
+   a built-in Application Resource (called "Stormpath") - you will still
+   need to provision a separate Application Resource.
+
+1. Take note of the _REST URL_ of the Application you just created. Your
+   web application will communicate with the Stormpath API in the context
+   of this one Application Resource (operations such as: user-creation,
+   authentication, etc.)
+
+## Getting Started
 
 1.  **Require the Stormpath Ruby SDK**
 
@@ -116,7 +130,7 @@ $ gem install stormpath-sdk
 1. **Check for account inclusion in group** by reloading the account
 
     ```ruby
-    account = clients.accounts.get account.href
+    account = client.accounts.get account.href
     is_admin = account.groups.any? { |group| group.name == 'Admins' }
     ```
 
@@ -198,6 +212,69 @@ Additional resources are <code>accounts</code>, <code>groups</code>,
 <code>group_membership</code>, and the single reference to your
 <code>tenant</code>.
 
+### Creating Resources
+
+Applications and directories can be created directly off the client.
+
+```ruby
+application = client.applications.create name: 'foo', description: 'bar'
+
+directory = client.directories.create name: 'foo', description: 'bar'
+```
+
+### Collections
+#### Search
+
+Resource collections can be searched by a general query string or by attribute.
+
+Passing a string to the search method will filter by any attribute on the collection:
+
+```ruby
+client.applications.search 'foo'
+```
+
+To search a specific attribute or attributes, pass a hash:
+
+```ruby
+client.applications.search name: 'foo', description: 'bar'
+```
+
+#### Pagination
+
+Collections can be paginated using chainable Arel-like methods. <code>offset</code> is the zero-based starting index in the entire collection of the first item to return. Default is 0. <code>limit</code> is the maximum number of collection items to return for a single request. Minimum value is 1. Maximum value is 100. Default is 25.
+
+```ruby
+client.applications.offset(10).limit(100).each do |application|
+  # do something
+end
+```
+
+#### Order
+
+Collections can be ordered. In the following example, a paginated collection is ordered.
+
+```ruby
+client.applications.offset(10).limit(100).order('name asc,description desc')
+```
+
+#### Entity Expansion
+
+A resource's children can be eager loaded by passing the entity expansion object as the second argument to a call to <code>get</code>.
+
+```ruby
+expansion = Stormpath::Resource::Expansion.new 'groups', 'group_memberships'
+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>.
+
+```ruby
+expansion = Stormpath::Resource::Expansion.new
+expansion.add_property 'groups', offset: 5, limit: 10
+
+client.accounts.get account.href, expansion
+```
+
 ### Registering Accounts
 
 Accounts are created on a directory instance. They can be created in two
@@ -463,3 +540,7 @@ For additional information, please see the full [Project Documentation](https://
   [stormpath]: http://stormpath.com/
   [create-api-keys]: http://www.stormpath.com/docs/ruby/product-guide#AssignAPIkeys
   [stormpath_bootstrap]: https://github.com/stormpath/stormpath-sdk-ruby/wiki/Bootstrapping-Stormpath
+  [rubygems-installation-docs]: http://docs.rubygems.org/read/chapter/3
+  [stormpath-admin-login]: http://api.stormpath.com/login
+  [create-api-keys]: http://www.stormpath.com/docs/ruby/product-guide#AssignAPIkeys
+  [concepts]: http://www.stormpath.com/docs/stormpath-basics#keyConcepts

data/lib/stormpath-sdk/data_store.rb

@@ -58,7 +58,9 @@ class Stormpath::DataStore
     instantiate clazz, data.to_hash
   end
 
-  def create(parent_href, resource, return_type)
+  def create(parent_href, resource, return_type, options = {})
+    #TODO assuming there is no ? in url
+    parent_href = "#{parent_href}?#{URI.encode_www_form(options)}" unless options.empty?
     save_resource(parent_href, resource, return_type).tap do |returned_resource|
       if resource.kind_of? return_type
         resource.set_properties to_hash(returned_resource)

data/lib/stormpath-sdk/http/request.rb

@@ -55,7 +55,7 @@ module Stormpath
         @body = body
 
         if !body.nil?
-          @http_headers.store 'Content-Length', @body.length
+          @http_headers.store 'Content-Length', @body.bytesize
         end
 
       end

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

@@ -50,14 +50,14 @@ module Stormpath
 
               collection.class_eval do
                 if can.include? :create
-                  def create(properties_or_resource)
+                  def create(properties_or_resource, options = {})
                     resource = case properties_or_resource
                       when Stormpath::Resource::Base
                         properties_or_resource
                       else
                         item_class.new properties_or_resource, client
                       end
-                    data_store.create href, resource, item_class
+                    data_store.create href, resource, item_class, options
                   end
                 end
 

data/lib/stormpath-sdk/version.rb

@@ -14,6 +14,6 @@
 # limitations under the License.
 #
 module Stormpath
-  VERSION = '1.0.0.beta.2'
-  VERSION_DATE = '2013-06-25'
+  VERSION = '1.0.0.beta.3.1'
+  VERSION_DATE = '2013-09-25'
 end

data/spec/client_spec.rb

@@ -431,25 +431,121 @@ properties
     end
 
     describe '.create' do
+      let(:application_name) { 'Client Application Create Test' }
+
       let(:application_attributes) do
         {
-          name: 'Client Application Create Test',
+          name: application_name,
           description: 'A test description'
         }
       end
 
-      let(:application) do
-        test_api_client.applications.create application_attributes
-      end
+      context do
+        let(:application) do
+          test_api_client.applications.create application_attributes
+        end
 
-      it 'creates that application' do
-        expect(application).to be
-        expect(application.name).to eq(application_attributes[:name])
-        expect(application.description).to eq(application_attributes[:description])
+        it 'creates that application' do
+          expect(application).to be
+          expect(application.name).to eq(application_attributes[:name])
+          expect(application.description).to eq(application_attributes[:description])
+        end
+
+        after do
+          application.delete
+        end
       end
 
-      after do
-        application.delete
+      describe 'auto directory creation' do
+        let(:application) { test_api_client.applications.create application_attributes, options }
+
+        let(:directories) do
+          test_api_client.directories
+        end
+
+        context 'login source' do
+          let(:options) { { createDirectory: true } }
+
+          let!(:account) do
+            application.accounts.create(
+                given_name: 'John',
+                surname: 'Smith 2',
+                email: 'john.smith2@example.com',
+                username: 'johnsmith2',
+                password: '4P@$$w0rd!'
+            )
+          end
+
+          before { application }
+
+          it 'serves as the accounts store and login source' do
+            auth_request = Stormpath::Authentication::UsernamePasswordRequest.new 'johnsmith2', '4P@$$w0rd!'
+            auth_result = application.authenticate_account auth_request
+            expect(account).to eq(auth_result.account)
+          end
+        end
+
+        context 'with directory: true' do
+          let(:options) { { createDirectory: true } }
+
+          it 'creates directory named by appending "Directory" to app name' do
+            application
+            expect(directories.map(&:name)).to include("#{application_name} Directory")
+          end
+
+          context 'and existing directory' do
+            it 'resolves naming conflict by adding (n) to directory name' do
+              test_api_client.directories.each { |d| d.delete if "#{application_name} Directory" == d.name }
+              test_api_client.directories.create({name: "#{application_name} Directory"})
+              application
+              expect(directories.map(&:name)).to include("#{application_name} Directory (2)")
+            end
+          end
+        end
+
+        context 'with directory: "Client Application Create Test Directory"' do
+          let(:options) { { createDirectory: true } }
+
+          before { application }
+
+          #fails with Stormpath::Error: Authentication required.
+          it 'creates directory named "Client Application Create Test Directory"' do
+            expect(directories.map(&:name)).to include("#{application_name} Directory")
+          end
+
+          it 'resolves naming conflict with existing directory throwing Stormpath::Error with status 409 and code 5010'
+        end
+
+        context 'with directory: ""' do
+          let(:options) { { createDirectory: '' } }
+
+          it 'throws Stormpath::Error with status 400 and code 2000', skip_cleanup: true do
+            expect { application }.to raise_error { |error|
+              expect(error).to be_a(Stormpath::Error)
+              expect(error.status).to eq(400)
+              expect(error.code).to eq(2000)
+            }
+          end
+        end
+
+        context 'with directory: false' do
+          let(:options) { { createDirectory: false } }
+
+          before { application }
+
+          it 'creates no directory' do
+            expect(directories.map(&:name)).not_to include("#{application_name} Directory")
+          end
+        end
+
+        after(:each) do
+          unless example.metadata[:skip_cleanup]
+            application.delete
+            test_api_client.directories.each do |d|
+              d.delete if ["#{application_name} Directory", "#{application_name} Directory (2)", "#{application_name} Directory Custom"].include?(d.name)
+            end
+          end
+        end
       end
     end
   end

data/stormpath-sdk.gemspec

@@ -25,6 +25,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'rspec-core', '~> 2.14rc1'
   s.add_development_dependency 'rspec-expectations', '~> 2.14rc1'
   s.add_development_dependency 'rspec-mocks', '~> 2.14rc1'
+  s.add_development_dependency 'guard-rspec', '~> 3.0.3'
   s.add_development_dependency 'rack', '~> 1.4.1'
   s.add_development_dependency 'webmock', '~> 1.11.0'
   s.add_development_dependency 'simplecov', '~> 0.7.1'

metadata

@@ -1,20 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: stormpath-sdk
 version: !ruby/object:Gem::Version
-  version: 1.0.0.beta.2
-  prerelease: 6
+  version: 1.0.0.beta.3.1
 platform: ruby
 authors:
 - Elder Crisostomo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-25 00:00:00.000000000 Z
+date: 2013-09-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -22,7 +20,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -30,7 +27,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: httpclient
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -38,7 +34,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -46,7 +41,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: uuidtools
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -54,7 +48,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -62,7 +55,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -70,7 +62,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -78,7 +69,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: properties-ruby
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -86,7 +76,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -94,7 +83,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: java_properties
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -102,7 +90,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -110,7 +97,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -118,7 +104,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -126,7 +111,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec-core
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -134,7 +118,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -142,7 +125,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec-expectations
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -150,7 +132,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -158,7 +139,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec-mocks
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -166,15 +146,27 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: 2.14rc1
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.3
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -182,7 +174,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -190,7 +181,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -198,7 +188,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -206,7 +195,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -214,7 +202,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -222,7 +209,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -230,7 +216,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -238,7 +223,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: pry-debugger
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -246,7 +230,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -254,7 +237,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: pry-stack_explorer
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -262,7 +244,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -270,7 +251,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: vcr
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -278,7 +258,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -286,7 +265,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: timecop
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -294,7 +272,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -302,7 +279,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -310,7 +286,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -392,6 +367,7 @@ files:
 - support/api.rb
 homepage: https://github.com/stormpath/stormpath-sdk-ruby
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options:
 - --line-numbers
@@ -402,21 +378,19 @@ rdoc_options:
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>'
     - !ruby/object:Gem::Version
       version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 2.1.5
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Stormpath SDK
 test_files: []