WatersOfOblivion-activeresourceinstanceauthentication 0.0.2

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 [name of plugin creator]
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README

@@ -0,0 +1,15 @@
+=ActiveResourceInstanceAuthentication
+
+This is just a little plugin to allow individual instances of ActiveResource
+to use their own HTTP Basic Authenticated connection.
+
+See ActiveResourceInstanceAuthentication::ActiveResourceExtensions for
+documentation.
+
+This is packaged as a Gem based plugin, so it can be installed by adding the
+following line to <tt>config/environment.rb</tt> and running
+<tt>rake gems:install</tt>.
+
+  config.gem "WatersOfOblivion-activeresourceinstanceauthentication", :lib => "activeresourceinstanceauthentication", :source => "http://gems.github.com/"
+
+Copyright (c) 2009 Jonathan Bryant, released under the MIT license

data/Rakefile

@@ -0,0 +1,22 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the active_resource_instance_authentication plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the active_resource_instance_authentication plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ActiveResourceInstanceAuthentication'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/init.rb

@@ -0,0 +1 @@
+require File.join(File.dirname(__FILE__), 'rails', 'init')

data/install.rb

@@ -0,0 +1 @@
+# Install hook code here

data/lib/active_resource_instance_authentication.rb

@@ -0,0 +1,99 @@
+module ActiveResourceInstanceAuthentication
+  # This alters ActiveResource::Base to use authentication for each instance
+  # instead of the class.  Each instance uses the class settings as defaults.
+  #
+  #   class SomeModel < ActiveResource::Base
+  #      self.user = "user"
+  #      self.password = "password"
+  #   end
+  #
+  #   # Uses "user":"password"
+  #   model_one = SomeModel.new
+  #
+  #   # Uses "admin":"secret"
+  #   model_two = SomeModel.new
+  #   model_two.user = "admin"
+  #   model_two.password = "secret"
+  # 
+  # It also adds a simpler way of performing authenticated actions: the
+  # +authenticate+ method.
+  # 
+  #   # Get an authenticated instance
+  #   SomeModel.authenticate "user", "password"
+  #   
+  #   # Yield an authenticated instance
+  #   SomeModel.authenticate "user", "password" do |m|
+  #     # Call authenticated methods on m
+  #   end
+  module ActiveResourceExtensions
+    def self.included(base)
+      base.send :extend, ClassMethods
+      
+      base.class_eval do
+        def site
+          self.class.site
+        end
+        
+        def timeout
+          @timeout ||= self.class.timeout
+        end
+        
+        def timeout=(timeout)
+          @connection = nil
+          @timeout = timeout
+        end
+        
+        def user
+          @user ||= self.class.user
+        end
+        
+        def user=(user)
+          @connection = nil
+          @user = user
+        end
+        
+        def password
+          @password ||= self.class.password
+        end
+        
+        def password=(password)
+          @connection = nil
+          @password = password
+        end
+        
+        def format
+          @format ||= self.class.format
+        end
+        
+        def format=(format)
+          @connection = nil
+          @format = format
+        end
+
+        def connection(refresh = false)
+          if refresh || @connection.nil?
+            @connection = ActiveResource::Connection.new(site, format)
+            @connection.user = user if user
+            @connection.password = password if user
+            @connection.timeout = timeout if timeout
+          end
+          @connection
+        end
+      end
+    end
+    
+    module ClassMethods
+      def authenticate(username, password)
+        obj = self.new
+        obj.user = username
+        obj.password = password
+        
+        if block_given?
+          yield obj
+        else
+          obj
+        end
+      end
+    end
+  end
+end

data/rails/init.rb

@@ -0,0 +1,4 @@
+# Include hook code here
+
+require File.join(File.dirname(__FILE__), '..', 'lib', 'active_resource_instance_authentication')
+ActiveResource::Base.send :include, ActiveResourceInstanceAuthentication::ActiveResourceExtensions

data/test/active_resource_instance_authentication_test.rb

@@ -0,0 +1,122 @@
+require 'test/unit'
+require 'rubygems'
+require 'active_resource'
+require 'active_resource_instance_authentication'
+
+class ActiveResourceInstanceAuthenticationTest < Test::Unit::TestCase
+  def setup
+    ActiveResource::Base.send :include, ActiveResourceInstanceAuthentication::ActiveResourceExtensions
+  end
+
+  def test_site
+    assert_respond_to ActiveResource::Base.new, :site
+  end
+  
+  def test_site_inherits_from_class
+    ar = ActiveResource::Base.new
+    assert_nil ar.site
+    ActiveResource::Base.site = "http://localhost/"
+    assert_equal URI.parse("http://localhost/"), ar.site
+  end
+  
+  def test_site=
+    ar = ActiveResource::Base.new
+    assert_respond_to ar, :site=
+    ar.site = "http://localhost/"
+    assert_equal URI.parse("http://localhost/"), ar.site
+    assert_nil ar.instance_variable_get("@connection")
+  end
+  
+  def test_timeout
+    assert_respond_to ActiveResource::Base.new, :timeout
+  end
+  
+  def test_timeout_inherits_from_class
+    ar = ActiveResource::Base.new
+    assert_nil ar.timeout
+    ActiveResource::Base.timeout = 30
+    assert_equal 30, ar.timeout
+  end
+  
+  def test_timeout=
+    ar = ActiveResource::Base.new
+    assert_respond_to ar, :timeout=
+    ar.timeout = 30
+    assert_equal 30, ar.timeout
+    assert_nil ar.instance_variable_get("@connection")
+  end
+  
+  def test_user
+    assert_respond_to ActiveResource::Base.new, :user
+  end
+  
+  def test_user_inherits_from_class
+    ar = ActiveResource::Base.new
+    assert_nil ar.user
+    ActiveResource::Base.user = "jdoe"
+    assert_equal "jdoe", ar.user
+  end
+  
+  def test_user=
+    ar = ActiveResource::Base.new
+    assert_respond_to ar, :user=
+    ar.user = "jdoe"
+    assert_equal "jdoe", ar.user
+    assert_nil ar.instance_variable_get("@connection")
+  end
+  
+  def test_password
+    assert_respond_to ActiveResource::Base.new, :password
+  end
+  
+  def test_password_inherits_from_class
+    ar = ActiveResource::Base.new
+    assert_nil ar.password
+    ActiveResource::Base.password = "password"
+    assert_equal "password", ar.password
+  end
+  
+  def test_password=
+    ar = ActiveResource::Base.new
+    assert_respond_to ar, :password=
+    ar.password = "password"
+    assert_equal "password", ar.password
+    assert_nil ar.instance_variable_get("@connection")
+  end
+  
+  def test_format
+    assert_respond_to ActiveResource::Base.new, :format
+  end
+  
+  def test_format_inherits_from_class
+    ar = ActiveResource::Base.new
+    assert_equal ActiveResource::Formats::XmlFormat, ar.format
+  end
+  
+  def test_format=
+    ar = ActiveResource::Base.new
+    ar.format = :xml
+    assert_equal :xml, ar.format
+    assert_nil ar.instance_variable_get("@connection")
+  end
+  
+  def test_connection
+    ar = ActiveResource::Base.new
+    assert_respond_to ar, :connection
+  end
+  
+  def test_authenticate
+    assert_respond_to ActiveResource::Base, :authenticate
+    ar = ActiveResource::Base.authenticate("foo", "bar")
+    assert ar.is_a? ActiveResource::Base
+    assert_equal "foo", ar.user
+    assert_equal "bar", ar.password
+    ar = ActiveResource::Base.authenticate("foo", "bar", "http://www.site.com/")
+    assert_equal URI.parse("http://www.site.com/"), ar.site
+    assert_raises RuntimeError do
+      ActiveResource::Base.authenticate "foo", "bar" do
+        raise "I yield to the block"
+      end
+    end
+  end
+end

data/uninstall.rb

@@ -0,0 +1 @@
+# Uninstall hook code here

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification 
+name: WatersOfOblivion-activeresourceinstanceauthentication
+version: !ruby/object:Gem::Version 
+  version: 0.0.2
+platform: ruby
+authors: 
+- Jonathan Bryant
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-02-05 00:00:00 -08:00
+default_executable: 
+dependencies: []
+
+description: ""
+email: watersofmemory@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- init.rb
+- install.rb
+- MIT-LICENSE
+- Rakefile
+- README
+- uninstall.rb
+- rails/init.rb
+- test/active_resource_instance_authentication_test.rb
+- lib/active_resource_instance_authentication.rb
+has_rdoc: true
+homepage: http://watersofoblivion.github.com/activeresourceinstanceauthentication/
+post_install_message: 
+rdoc_options: 
+- --title
+- ActiveResource Instance Authentication
+- --line-numbers
+- --inline-source
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: A Rails plugin ActiveResource extension for instance-level (instead of class-level) HTTP Basic Authentication
+test_files: 
+- test/active_resource_instance_authentication_test.rb