ffcrm_authlogic_api 0.1.0

data/Gemfile

@@ -0,0 +1,5 @@
+source "http://rubygems.org"
+
+gem 'fat_free_crm'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,196 @@
+PATH
+  remote: .
+  specs:
+    ffcrm_authlogic_api (0.1.0)
+      authlogic
+      fat_free_crm
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    actionmailer (3.2.2)
+      actionpack (= 3.2.2)
+      mail (~> 2.4.0)
+    actionpack (3.2.2)
+      activemodel (= 3.2.2)
+      activesupport (= 3.2.2)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      journey (~> 1.0.1)
+      rack (~> 1.4.0)
+      rack-cache (~> 1.1)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.1.2)
+    activemodel (3.2.2)
+      activesupport (= 3.2.2)
+      builder (~> 3.0.0)
+    activerecord (3.2.2)
+      activemodel (= 3.2.2)
+      activesupport (= 3.2.2)
+      arel (~> 3.0.2)
+      tzinfo (~> 0.3.29)
+    activeresource (3.2.2)
+      activemodel (= 3.2.2)
+      activesupport (= 3.2.2)
+    activesupport (3.2.2)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    acts-as-taggable-on (2.2.2)
+      rails (~> 3.0)
+    acts_as_commentable (3.0.1)
+    acts_as_list (0.1.5)
+    ajax-chosen-rails (0.1.5)
+      chosen-rails
+      railties (~> 3.0)
+      thor (~> 0.14)
+    arel (3.0.2)
+    authlogic (3.1.0)
+      activerecord (>= 3.0.7)
+      activerecord (>= 3.0.7)
+    builder (3.0.0)
+    capybara (1.1.2)
+      mime-types (>= 1.16)
+      nokogiri (>= 1.3.3)
+      rack (>= 1.0.0)
+      rack-test (>= 0.5.4)
+      selenium-webdriver (~> 2.0)
+      xpath (~> 0.1.4)
+    childprocess (0.3.1)
+      ffi (~> 1.0.6)
+    chosen-rails (0.9.8)
+      railties (~> 3.0)
+      thor (~> 0.14)
+    cocaine (0.2.1)
+    combustion (0.3.2)
+      rails (>= 3.0.0)
+      thor (>= 0.14.6)
+    diff-lcs (1.1.3)
+    erubis (2.7.0)
+    execjs (1.3.0)
+      multi_json (~> 1.0)
+    fat_free_crm (0.11.0)
+      acts-as-taggable-on (~> 2.2.1)
+      acts_as_commentable (~> 3.0.1)
+      acts_as_list (~> 0.1.4)
+      ajax-chosen-rails (>= 0.1.5)
+      authlogic (~> 3.1.0)
+      chosen-rails
+      ffaker (>= 1.12.0)
+      haml (~> 3.1.3)
+      jquery-rails
+      paper_trail
+      paperclip (~> 2.5.2)
+      prototype-rails
+      rails (~> 3.2.2)
+      ransack
+      sass (~> 3.1.15)
+      simple_form (~> 1.5.2)
+      uglifier
+      will_paginate (~> 3.0.2)
+    ffaker (1.13.0)
+    ffi (1.0.11)
+    haml (3.1.4)
+    hike (1.2.1)
+    i18n (0.6.0)
+    journey (1.0.3)
+    jquery-rails (2.0.1)
+      railties (>= 3.2.0, < 5.0)
+      thor (~> 0.14)
+    json (1.6.5)
+    mail (2.4.4)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.18)
+    multi_json (1.1.0)
+    nokogiri (1.5.2)
+    paper_trail (2.6.2)
+      rails (~> 3)
+    paperclip (2.5.2)
+      activerecord (>= 2.3.0)
+      activesupport (>= 2.3.2)
+      cocaine (>= 0.0.2)
+      mime-types
+    polyamorous (0.5.0)
+      activerecord (~> 3.0)
+    polyglot (0.3.3)
+    prototype-rails (3.2.1)
+      rails (~> 3.2)
+    rack (1.4.1)
+    rack-cache (1.2)
+      rack (>= 0.4)
+    rack-ssl (1.3.2)
+      rack
+    rack-test (0.6.1)
+      rack (>= 1.0)
+    rails (3.2.2)
+      actionmailer (= 3.2.2)
+      actionpack (= 3.2.2)
+      activerecord (= 3.2.2)
+      activeresource (= 3.2.2)
+      activesupport (= 3.2.2)
+      bundler (~> 1.0)
+      railties (= 3.2.2)
+    railties (3.2.2)
+      actionpack (= 3.2.2)
+      activesupport (= 3.2.2)
+      rack-ssl (~> 1.3.2)
+      rake (>= 0.8.7)
+      rdoc (~> 3.4)
+      thor (~> 0.14.6)
+    rake (0.9.2.2)
+    ransack (0.6.0)
+      actionpack (~> 3.0)
+      activerecord (~> 3.0)
+      polyamorous (~> 0.5.0)
+    rdoc (3.12)
+      json (~> 1.4)
+    rspec (2.9.0)
+      rspec-core (~> 2.9.0)
+      rspec-expectations (~> 2.9.0)
+      rspec-mocks (~> 2.9.0)
+    rspec-core (2.9.0)
+    rspec-expectations (2.9.0)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.9.0)
+    rspec-rails (2.9.0)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      railties (>= 3.0)
+      rspec (~> 2.9.0)
+    rubyzip (0.9.6.1)
+    sass (3.1.15)
+    selenium-webdriver (2.20.0)
+      childprocess (>= 0.2.5)
+      ffi (~> 1.0)
+      multi_json (~> 1.0)
+      rubyzip
+    simple_form (1.5.2)
+      actionpack (~> 3.0)
+      activemodel (~> 3.0)
+    sprockets (2.1.2)
+      hike (~> 1.2)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    thor (0.14.6)
+    tilt (1.3.3)
+    treetop (1.4.10)
+      polyglot
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.32)
+    uglifier (1.2.3)
+      execjs (>= 0.3.0)
+      multi_json (>= 1.0.2)
+    will_paginate (3.0.3)
+    xpath (0.1.4)
+      nokogiri (~> 1.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  capybara
+  combustion
+  fat_free_crm
+  ffcrm_authlogic_api!
+  rspec-rails (~> 2.6)

data/README.md

@@ -0,0 +1,41 @@
+# CRM Authlogic API
+===================
+
+This plugin enables applications to authenticate with Fat Free CRM using 
+the Authlogic `single_access_token` method. Credit to http://blog.smsohan.com/2010/04/using-authlogic-and-single-access-token.html for reference information whilst building this.
+
+## Installation
+
+* Install this plugin into your Fat Free CRM vendor/plugins folder and run
+`rake db:migrate:plugins`. This will create the application_accounts table.
+* For your controller action, you need to remove the `require_user` authentication layer and add a `require_application` before_filter.
+
+````ruby
+skip_before_filter :require_user, :only => :my_action
+before_filter :require_application, :only => :my_action
+````
+* Pop the following method in your application_controller
+
+````ruby
+def require_application
+  @current_application_session ||= ApplicationSession.find
+  unless @current_application_session
+    redirect_to login_url
+    false
+  end
+end
+````
+
+* Start up Fat Free CRM and go to the "App API" tab in the Admin section.
+* Create an application account and give it a token.
+* Your external app may now connect using http://path.to/your/controller/action?app_key=your_app_token
+
+Where `your_app_token` is the token specified in the previous step.
+
+## TODO
+
+* Add `require_application` function to `ApplicationController` automagically
+* Improve formatting of *App API* screen.
+* Add more tests.
+
+Copyright (c) 2011 Global Hand, released under the MIT license

data/Rakefile

@@ -0,0 +1,34 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+Bundler.require :default, :development
+
+task :environment do
+  Combustion.initialize!
+end
+Combustion::Application.load_tasks
+
+class Combustion::Application
+  # Add migrations from all engines
+  Railties.engines.each do |engine|
+    config.paths['db/migrate'] += engine.paths['db/migrate'].existent
+  end
+end
+
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = Dir.glob(['spec/sitemap_generator/**/*'])
+  spec.rspec_opts = ['--backtrace']
+end
+
+desc 'Default: run spec tests.'
+task :default => :spec
+
+# Let Combustion handle database preparation
+Rake::Task["spec"].prerequisites.clear
+
+Bundler::GemHelper.install_tasks
+

data/app/controllers/admin/application_accounts_controller.rb

@@ -0,0 +1,56 @@
+class Admin::ApplicationAccountsController < Admin::ApplicationController
+  before_filter :require_user
+  before_filter "set_current_tab('admin/application_accounts')", :only => [ :index ]
+
+  # GET /admin/application_accounts
+  #----------------------------------------------------------------------------
+  def index
+    @application_accounts = ApplicationAccount.order(:created_at)
+    respond_to do |format|
+      format.html # index.html.haml
+    end
+  end
+
+  # POST /admin/application_accounts
+  #----------------------------------------------------------------------------
+  def create
+    @application_account = ApplicationAccount.new(params["application_account"])
+    respond_to do |format|
+      if @application_account.save
+        flash[:notice] = 'New application account created'
+      else
+        flash[:notice] = 'There was error creating the application account.'
+      end
+      format.html { redirect_to :action => :index } # go back to index.haml
+    end
+  end
+
+  # PUT /admin/application_accounts/1
+  #----------------------------------------------------------------------------
+  def update
+    @application_account = ApplicationAccount.find(params["id"])
+    @application_account.attributes = params["application_account"]
+    respond_to do |format|
+      if @application_account.save
+        flash[:notice] = 'New application account created'
+      else
+        flash[:notice] = 'Please fill out the name and token'
+      end
+      format.html { redirect_to :action => :index } # go back to index.haml
+    end
+  end
+
+  # DELETE /admin/application_accounts/1
+  #----------------------------------------------------------------------------
+  def destroy
+    @application_account = ApplicationAccount.find(params["id"])
+    respond_to do |format|
+      if @application_account.destroy
+        flash[:notice] = 'Application account deleted'
+      else
+        flash[:notice] = 'There was error deleting the application account.'
+      end
+      format.html { redirect_to :action => :index } # go back to index.haml
+    end
+  end
+end

data/app/models/application_account.rb

@@ -0,0 +1,3 @@
+class ApplicationAccount < ActiveRecord::Base
+  validates :name, :presence => true
+end

data/app/models/application_session.rb

@@ -0,0 +1,8 @@
+class ApplicationSession < Authlogic::Session::Base
+  authenticate_with ApplicationAccount
+
+  params_key :app_key
+  login_field false
+
+  single_access_allowed_request_types :any
+end

data/app/views/admin/application_accounts/index.html.haml

@@ -0,0 +1,25 @@
+.title
+  = t(:application_account_settings, :default => "Application Account Settings")
+
+.list
+  .remote
+    .section
+      - @application_accounts.each do |account|
+        = form_tag admin_application_account_path(account), :method => :put do
+          .label.top.req Application name:
+          = text_field_tag 'application_account[name]', account.name, :style => "width:100px"
+          .label.top.req Token:
+          = text_field_tag 'application_account[single_access_token]', account.single_access_token, :style => "width:150px"
+          = submit_tag 'Update', :name => :update, :style => "width:60px"
+        = button_to 'Delete', admin_application_account_path(account.id), :method => "delete", :style => "width:60px"
+        .spacer
+
+    .section
+      %div
+        = t('.create_new_application_key', :default => "Create a new application key")
+        = form_tag admin_application_accounts_path, :method => :post do
+          .label.top.req Application name:
+          = text_field_tag 'application_account[name]', '', :style => "width:100px"
+          .label.top.req Token:
+          = text_field_tag 'application_account[single_access_token]', '', :style => "width:150px"
+          = submit_tag t('.create', :default => 'Create'), :name => :create

data/config/routes.rb

@@ -0,0 +1,5 @@
+FatFreeCRM::Application.routes.draw do
+  namespace :admin do
+    resources :application_accounts
+  end
+end

data/db/migrate/20101111031046_create_application_accounts.rb

@@ -0,0 +1,14 @@
+class CreateApplicationAccounts < ActiveRecord::Migration
+  def self.up
+    create_table :application_accounts do |t|
+      t.string :name
+      t.string :single_access_token, :null => false
+
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :application_accounts
+  end
+end

data/ffcrm_authlogic_api.gemspec

@@ -0,0 +1,18 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path('../lib', __FILE__)
+require 'ffcrm_authlogic_api/version'
+
+Gem::Specification.new do |s|
+  s.name = 'ffcrm_authlogic_api'
+  s.authors = ['Ben Tillman', 'Nathan Broadbent', 'Stephen Kenworthy']
+  s.summary = 'Fat Free CRM - Authlogic Token API'
+  s.description = 'Allow authentication via an application token '
+  s.files = `git ls-files`.split("\n")
+  s.version = FatFreeCRM::AuthlogicAPI::VERSION
+
+  s.add_development_dependency 'rspec-rails', '~> 2.6'
+  s.add_development_dependency 'capybara'
+  s.add_development_dependency 'combustion'
+  s.add_dependency 'fat_free_crm'
+  s.add_dependency 'authlogic'
+end

data/lib/ffcrm_authlogic_api.rb

@@ -0,0 +1 @@
+require 'ffcrm_authlogic_api/engine'

data/lib/ffcrm_authlogic_api/engine.rb

@@ -0,0 +1,16 @@
+module FatFreeCRM
+  module AuthlogicAPI
+    class Engine < Rails::Engine
+      config.to_prepare do
+        begin
+          FatFreeCRM::Tabs.admin << {
+            :text => "Application Tokens",
+            :url => { :controller => "admin/application_accounts" }
+          }
+        rescue TypeError
+          puts "You must migrate your settings table."
+        end
+      end
+    end
+  end
+end

data/lib/ffcrm_authlogic_api/version.rb

@@ -0,0 +1,5 @@
+module FatFreeCRM
+  module AuthlogicAPI
+    VERSION = '0.1.0'
+  end
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: ffcrm_authlogic_api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Ben Tillman
+- Nathan Broadbent
+- Stephen Kenworthy
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-03-29 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: &84984190 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :development
+  prerelease: false
+  version_requirements: *84984190
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: &84983950 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *84983950
+- !ruby/object:Gem::Dependency
+  name: combustion
+  requirement: &84983610 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *84983610
+- !ruby/object:Gem::Dependency
+  name: fat_free_crm
+  requirement: &84983250 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *84983250
+- !ruby/object:Gem::Dependency
+  name: authlogic
+  requirement: &84982940 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *84982940
+description: ! 'Allow authentication via an application token '
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- app/controllers/admin/application_accounts_controller.rb
+- app/models/application_account.rb
+- app/models/application_session.rb
+- app/views/admin/application_accounts/index.html.haml
+- config/routes.rb
+- db/migrate/20101111031046_create_application_accounts.rb
+- ffcrm_authlogic_api.gemspec
+- lib/ffcrm_authlogic_api.rb
+- lib/ffcrm_authlogic_api/engine.rb
+- lib/ffcrm_authlogic_api/version.rb
+homepage: 
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -1058569375
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -1058569375
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.17
+signing_key: 
+specification_version: 3
+summary: Fat Free CRM - Authlogic Token API
+test_files: []