usergrid_ironhorse 0.0.3 → 0.0.4

data/README.md

@@ -33,46 +33,24 @@ Or install it yourself as:
 
 * Add 'gem usergrid_ironhorse' to your Gemfile
 * Create a 'config/usergrid.yml' file that looks something like this (the
-auth_token is your application admin token):
-<pre>
+auth_token is your application token):
+
+```
 development:
   application_url: http://localhost:8080/my-organization/my-application
   auth_token: YWMtc4WjqhcbEeK6UhQQn9SVgQAAATpryjMnLy9oFaPbP-0qIxoUx_4vtaOmpmE
+  require_login: false
 
-development:
+test:
   application_url: http://localhost:8080/my-organization/my-application
   auth_token: YWMtc4WjqhcbEeK6UhQQn9SVgQAAATpryjMnLy9oFaPbP-0qIxoUx_4vtaOmpmE
+  require_login: false
 
 production:
   application_url: http://api.usergrid.com/my-organization/my-application
   auth_token: YWMtc4WjqhcbEeK6UhQQn9SVgQAAATpryjMnLy9oFaPbP-0qIxoUx_4vtaOmpmE
-</pre>
-* Your User model should subclass Usergrid::Ironhorse::Base and extend
-Usergrid::Ironhorse::UserContext like so:
-<pre>
-class User < Usergrid::Ironhorse::Base
-  extend Usergrid::Ironhorse::UserContext
-
-end
-</pre>
-* Set up your authentication
-	* Use `User.authenticate(username, password, session)` to login.
-	* Use `User.clear_authentication(session)` to log out.
-* Propogate the authentication in your ApplicationController:
-<pre>
-before_filter :set_thread_context
-def set_thread_context
-  User.set_thread_context session
-end
-</pre>
-* Optionally, if you need to access the User from your view, you may add something
-like the following to your ApplicationController:
-<pre>
-helper_method :current_user
-def current_user
-  User.current_user
-end
-</pre>
+  require_login: false
+```
 
 #### Get going!
 
@@ -81,14 +59,16 @@ Your models will automatically be stored in a collection according to the name o
 class as defined by Rails' ActiveModel::Naming module. (Which you may override by
 implementing model_name if desired.)
 
-<pre>
+```
 class Developer < Usergrid::Ironhorse::Base
   validates :name, :presence => true  # Yes, of course you can use validation
 
 end
-</pre>
+```
+
 * Now just use the Rails methods you're already familiar with:
-<pre>
+
+```
 
     dev = Developer.new language: 'Ruby'
     dev.valid? # nope!
@@ -100,15 +80,51 @@ end
     dev.favorite_color = 'green' # assign new attributes automatically
 
     dev = Developer.find_by_name 'Scott'
-</pre>
+```
+
 * BTW: If you need to do management tasks, wrapping the work in an as_admin block
 will use the auth_token from your settings:
 
-<pre>
+```
 User.as_admin do
   # do protected task
 end
-</pre>
+```
+
+
+#### (Optional) Need to have user-specific logins to UserGrid?
+
+* Create a User model and subclass `Usergrid::Ironhorse::Base` and `extend
+Usergrid::Ironhorse::UserContext` like so:
+
+```
+class User < Usergrid::Ironhorse::Base
+  extend Usergrid::Ironhorse::UserContext
+  ...
+end
+```
+
+* Set up your authentication
+	* Use `User.authenticate(username, password, session)` to login.
+	* Use `User.clear_authentication(session)` to log out.
+* Propogate the authentication in your ApplicationController:
+
+```
+before_filter :set_user_context
+def set_user_context
+  User.set_context session
+end
+```
+
+* Optionally, if you need to access the User from your view, you may add something
+like the following to your ApplicationController:
+
+```
+helper_method :current_user
+def current_user
+  User.current_user
+end
+```
 
 ## Contributing
 
@@ -133,6 +149,10 @@ usergrid_ironhorse/spec/spec_settings.yaml to match.)
 
 ## Release notes
 
+### 0.0.4
+* New Features
+  1. add require_login to config (with ability to skip individual logins)
+
 ### 0.0.3
 * Internal
   1. Improve authentication and user propagation

data/lib/extensions/resource.rb

@@ -3,7 +3,8 @@ module Usergrid
   class Resource
     def options
       options = @options.clone
-      auth_token = Thread.current[:usergrid_auth_token]
+      require_login = Usergrid::Ironhorse::Base.settings[:require_login] != false
+      auth_token = require_login ? Thread.current[:usergrid_auth_token] : Usergrid::Ironhorse::Base.settings[:auth_token]
       options[:headers].delete :Authorization
       options[:headers][:Authorization] = "Bearer #{auth_token}" if auth_token
       options

data/lib/usergrid_ironhorse/user_context.rb

@@ -47,6 +47,7 @@ module Usergrid
         Thread.current[:usergrid_auth_token] = session[:usergrid_auth_token]
         Thread.current[:usergrid_current_user] = nil
       end
+      alias_method :set_context, :set_thread_context
 
       # clears auth from current thread
       def clear_thread_context(session)
@@ -54,6 +55,7 @@ module Usergrid
         Thread.current[:usergrid_auth_token] = nil
         Thread.current[:usergrid_current_user] = nil
       end
+      alias_method :clear_context, :clear_thread_context
 
       # returns the auth token for the current thread
       def current_auth_token

data/lib/usergrid_ironhorse/version.rb

@@ -1,5 +1,5 @@
 module Usergrid
   module Ironhorse
-    VERSION = '0.0.3'
+    VERSION = '0.0.4'
   end
 end

data/spec/spec_helper.rb

@@ -26,6 +26,7 @@ SimpleCov.start
 
 
 SPEC_SETTINGS = YAML::load_file(File.join File.dirname(__FILE__), 'spec_settings.yaml')
+Usergrid::Ironhorse::Base.configure! nil, nil
 
 def login_management
   management = Usergrid::Resource.new(SPEC_SETTINGS[:api_url]).management

data/spec/usergrid_ironhorse/base_spec.rb

@@ -40,6 +40,19 @@ describe Usergrid::Ironhorse::Base do
       end
     end
 
+    it "do tasks as admin if require_login is false" do
+      organization = @foo.management.organization SPEC_SETTINGS[:organization][:name]
+
+      # should fail under current user's context
+      expect {
+        organization.create_application "_test_app_#{SecureRandom.hex}"
+      }.to raise_error RestClient::Unauthorized
+
+      # should succeed once require_login is false
+      User.settings[:require_login] = false
+      organization.create_application "_test_app_#{SecureRandom.hex}"
+    end
+
     it 'be created and destroyed' do
       foo = Foo.create name: 'foo2'
       foo.persisted?.should be_true

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: usergrid_ironhorse
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-19 00:00:00.000000000 Z
+date: 2012-11-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: usergrid_iron
@@ -161,18 +161,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 3863127888232892362
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 3863127888232892362
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24