stormpath-rails 0.4.3 → 0.4.4

data/.gitignore

@@ -16,4 +16,4 @@ rdoc
 spec/reports
 test/tmp
 test/version_tmp
-tmp
+tmp/

data/README.md

@@ -1,30 +1,44 @@
-# Stormpath::Rails
-
 [![Build Status](https://secure.travis-ci.org/stormpath/stormpath-rails.png)](http://travis-ci.org/stormpath/stormpath-rails)
+[![Code Climate](https://codeclimate.com/github/stormpath/stormpath-rails.png)](https://codeclimate.com/github/stormpath/stormpath-rails)
+
+# Ruby on Rails support for Stormpath
 
-Ruby on Rails support for Stormpath
+## Gem Setup
 
-## Usage
+Reference gem from Gemfile.
 
+```ruby
 add gem 'stormpath-rails' to Gemfile
+```
+
+Generate configuration file, then create directory per environment at stormpath and update stormpath.yml with corresponding directory hrefs.
+
+```sh
+rails g stormpath:rails:install
+```
 
-run rails g stormpath:rails:install
 
-edit config/stormpath.yml
+Generate and run migration, if you're on ActiveRecord. Skip this step for Mongoid.
 
-export stormpath connection string to STORMPATH_URL (optional)
+```sh
+rails g stormpath:rails:migration user
+rake db:migrate
+```
+
+Update your model file.
 
 ```ruby
 class User < ActiveRecord:Base
-    include Stormpath::Rails::Account
+  include Stormpath::Rails::Account
 end
 ```
 
-add stormpath_url column to store stormpath UID.
-
 ## TODO
 
-Preventive validation to not send invalid data to stormpath.
++ Automatic directory layout (test, development, production) creation
++ Preventive validation to not send invalid data to stormpath.
++ Preventive validation to not send invalid data to stormpath.
++ Solve n+1 request problem when requesting account collection.
 
 ## Contributing
 

data/lib/generators/stormpath/rails/install/install_generator.rb

@@ -2,20 +2,10 @@ module Stormpath
   module Rails
     module Generators
       class InstallGenerator < ::Rails::Generators::Base
-        def create_initializer_file
-          create_file "config/stormpath.yml", "common:
-  href: <%= ENV['STORMPATH_URL'] %>
-  application: https://api.stormpath.com/v1/applications/<application id>
-
-development:
-  root: https://api.stormpath.com/v1/directories/<root directory id>
+        source_root File.expand_path('../../templates', __FILE__)
 
-test:
-  root: https://api.stormpath.com/v1/directories/<root directory id>
-
-production:
-  root: https://api.stormpath.com/v1/directories/<root directory id>
-"
+        def create_initializer_file
+          template "stormpath.yml", "config/stormpath.yml"
         end
       end
     end

data/lib/generators/stormpath/rails/migration/migration_generator.rb

@@ -0,0 +1,17 @@
+require "active_support/core_ext/string/inflections"
+
+module Stormpath
+  module Rails
+    module Generators
+      class MigrationGenerator < ::Rails::Generators::Base
+        argument :model_name, type: :string, default: "user", banner: "Account model name"
+        source_root File.expand_path('../../templates', __FILE__)
+
+        def create_migration_file
+          template "update_account_model.rb",
+                   "db/migrate/#{Time.now.utc.strftime("%Y%m%d%H%M%S")}_add_stormpath_url_to_#{model_name.pluralize}.rb"
+        end
+      end
+    end
+  end
+end

data/lib/generators/stormpath/rails/templates/stormpath.yml

@@ -0,0 +1,11 @@
+common:
+  stormpath_url: <%%= ENV['STORMPATH_URL'] %>
+
+development:
+  root: https://api.stormpath.com/v1/directories/<root directory id>
+
+test:
+  root: https://api.stormpath.com/v1/directories/<root directory id>
+
+production:
+  root: https://api.stormpath.com/v1/directories/<root directory id>

data/lib/generators/stormpath/rails/templates/update_account_model.rb

@@ -0,0 +1,10 @@
+class AddStormpathUrlTo<%= model_name.pluralize.camelize %> < ActiveRecord::Migration
+  def up
+    add_column :<%= model_name.pluralize %>, :stormpath_url, :string
+    add_index :<%= model_name.pluralize %>, :stormpath_url
+  end
+
+  def down
+    remove_column :<%= model_name.pluralize %>, :stormpath_url
+  end
+end

data/lib/stormpath/rails/account.rb

@@ -15,8 +15,8 @@ module Stormpath
         self.partial_updates = false if self.respond_to?(:partial_updates)
 
         #Mongoid specific declaration
-        #TODO index?
         field(:stormpath_url, type: String) if self.respond_to?(:field)
+        index({ stormpath_url: 1 }, { unique: true }) if self.respond_to?(:index)
 
         attr_accessor *STORMPATH_FIELDS
         attr_accessible  *STORMPATH_FIELDS

data/lib/stormpath/rails/client.rb

@@ -11,18 +11,18 @@ module Stormpath
       end
 
       def self.authenticate_account(login, password)
-        application = self.ds.get_resource Config[:application], ::Application
+        application = self.ds.get_resource Config[:stormpath_url], ::Application
         auth_result = application.authenticate_account ::UsernamePasswordRequest.new(login, password)
         auth_result.get_account
       end
 
       def self.send_password_reset_email(login_or_email)
-        application = self.ds.get_resource Config[:application], ::Application
+        application = self.ds.get_resource Config[:stormpath_url], ::Application
         application.send_password_reset_email login_or_email
       end
 
       def self.verify_password_reset_token(token)
-        application = self.ds.get_resource Config[:application], ::Application
+        application = self.ds.get_resource Config[:stormpath_url], ::Application
         application.verify_password_reset_token token
       end
 
@@ -63,7 +63,7 @@ module Stormpath
       end
 
       def self.client
-        self.connection ||= ::ClientApplicationBuilder.new.set_application_href(Config[:href]).build
+        self.connection ||= ::ClientApplicationBuilder.new.set_application_href(Config[:stormpath_url] || Config[:href]).build
         self.connection.client
       end
     end

data/lib/stormpath/rails/version.rb

@@ -1,5 +1,5 @@
 module Stormpath
   module Rails
-    VERSION = "0.4.3"
+    VERSION = "0.4.4"
   end
 end

data/spec/generators/install_generator_spec.rb

@@ -0,0 +1,17 @@
+require "active_support/core_ext/class/attribute_accessors"
+require "generator_spec/test_case"
+require "generators/stormpath/rails/install/install_generator"
+
+describe Stormpath::Rails::Generators::InstallGenerator do
+  include GeneratorSpec::TestCase
+  destination File.expand_path("../tmp", __FILE__)
+
+  before(:all) do
+    prepare_destination
+    run_generator
+  end
+
+  it "creates configuration file" do
+    assert_file "config/stormpath.yml", "common:\n  stormpath_url: <%= ENV['STORMPATH_URL'] %>\n\ndevelopment:\n  root: https://api.stormpath.com/v1/directories/<root directory id>\n\ntest:\n  root: https://api.stormpath.com/v1/directories/<root directory id>\n\nproduction:\n  root: https://api.stormpath.com/v1/directories/<root directory id>\n"
+  end
+end

data/spec/generators/migration_generator_spec.rb

@@ -0,0 +1,19 @@
+require "active_support/core_ext/class/attribute_accessors"
+require "generator_spec/test_case"
+require "generators/stormpath/rails/migration/migration_generator"
+
+describe Stormpath::Rails::Generators::MigrationGenerator do
+  include GeneratorSpec::TestCase
+  destination File.expand_path("../tmp", __FILE__)
+  arguments %w(person)
+
+  before(:all) do
+    Time.stub_chain(:now, :utc, :strftime).and_return("0")
+    prepare_destination
+    run_generator
+  end
+
+  it "creates configuration file" do
+    assert_file "db/migrate/0_add_stormpath_url_to_people.rb", "class AddStormpathUrlToPeople < ActiveRecord::Migration\n  def up\n    add_column :people, :stormpath_url, :string\n    add_index :people, :stormpath_url\n  end\n\n  def down\n    remove_column :people, :stormpath_url\n  end\nend"
+  end
+end

data/stormpath-rails.gemspec

@@ -20,6 +20,7 @@ Gem::Specification.new do |gem|
 
   gem.add_development_dependency('rake', '~> 10.0.2')
   gem.add_development_dependency('rspec', '~> 2.12.0')
+  gem.add_development_dependency('generator_spec')
   gem.add_development_dependency('activerecord')
   gem.add_development_dependency('sqlite3')
   gem.add_development_dependency('mongoid')

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stormpath-rails
 version: !ruby/object:Gem::Version
-  version: 0.4.3
+  version: 0.4.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-11 00:00:00.000000000 Z
+date: 2013-02-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -75,6 +75,22 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 2.12.0
+- !ruby/object:Gem::Dependency
+  name: generator_spec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
@@ -187,13 +203,17 @@ files:
 - README.md
 - Rakefile
 - lib/generators/stormpath/rails/install/install_generator.rb
+- lib/generators/stormpath/rails/migration/migration_generator.rb
+- lib/generators/stormpath/rails/templates/stormpath.yml
+- lib/generators/stormpath/rails/templates/update_account_model.rb
 - lib/stormpath-rails.rb
 - lib/stormpath/rails/account.rb
 - lib/stormpath/rails/client.rb
 - lib/stormpath/rails/config.rb
 - lib/stormpath/rails/version.rb
 - spec/fixtures/config/stormpath.yml
-- spec/generators/stormpath/rails/install/install_generator_spec.rb
+- spec/generators/install_generator_spec.rb
+- spec/generators/migration_generator_spec.rb
 - spec/integration/active_record_spec.rb
 - spec/integration/mongoid_spec.rb
 - spec/spec_helper.rb
@@ -227,7 +247,8 @@ specification_version: 3
 summary: Stormpath SDK API Wrapper
 test_files:
 - spec/fixtures/config/stormpath.yml
-- spec/generators/stormpath/rails/install/install_generator_spec.rb
+- spec/generators/install_generator_spec.rb
+- spec/generators/migration_generator_spec.rb
 - spec/integration/active_record_spec.rb
 - spec/integration/mongoid_spec.rb
 - spec/spec_helper.rb

data/spec/generators/stormpath/rails/install/install_generator_spec.rb

@@ -1,9 +0,0 @@
-require "spec_helper"
-require "generators/stormpath/rails/install/install_generator"
-
-describe Stormpath::Rails::Generators::InstallGenerator do
-  it "creates a configuration file" do
-    subject.should_receive(:create_file).with("config/stormpath.yml", kind_of(String))
-    subject.create_initializer_file
-  end
-end