sinatra_resource 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,7 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg
+doc/*
+.yardoc

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 David James
+
+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.mdown

@@ -0,0 +1,28 @@
+## About
+
+Want to build Web services in the Resource Oriented Architecture style? With resource_sinatra, success is all but guaranteed, provided that you are using a [Sinatra](http://sinatrarb.com) + [MongoMapper](http://github.com/djsun/mongomapper) stack.
+
+## Installation
+
+It might not be a bad idea to make sure you are running the latest RubyGems:
+
+    sudo gem update --system
+
+You will need gemcutter if you don't have it already:
+
+    gem install gemcutter
+    gem tumble
+
+I recommend a user-level install:
+
+    gem install djsun-resource_sinatra
+    
+Note: in general, beware of `sudo gem install <project_name>` -- it gives elevated privileges. Do you trust `<project name>`? Better to be safe and use a local install to `~/.gem`.
+
+## Usage
+
+For a basic example of what this looks like when integrated into a real-world Sinatra app, see `/examples/datacatalog`.
+
+## History
+
+This code was extracted from the [National Data Catalog](http://groups.google.com/group/datacatalog), a project of the [Sunlight Labs](http://sunlightlabs.com).

data/Rakefile

@@ -0,0 +1,34 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "sinatra_resource"
+    gem.summary = %Q{RESTful actions with Sinatra and MongoMapper}
+    gem.description = %Q{A DSL for creating RESTful actions with Sinatra and MongoMapper. It embraces the Resource Oriented Architecture as explained by Leonard Richardson and Sam Ruby.}
+    gem.email = "djames@sunlightfoundation.com"
+    gem.homepage = "http://github.com/djsun/sinatra_resource"
+    gem.authors = ["David James"]
+
+    gem.add_dependency 'djsun-mongo_mapper', '= 0.5.5.3'
+    gem.add_dependency 'mongo', '>= 0.15.1'
+    gem.add_dependency 'sinatra', '>= 0.9.4'
+
+    gem.add_development_dependency 'crack', '>= 0.1.4'
+    gem.add_development_dependency 'djsun-context', '>= 0.5.6'
+    gem.add_development_dependency 'jeremymcanally-pending', '>= 0.1'
+    gem.add_development_dependency 'rspec'
+    gem.add_development_dependency 'yard'
+
+    # gem is a Gem::Specification ...
+    # ... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install with: gem install jeweler"
+end
+
+task :default => :spec
+
+Dir.glob(File.dirname(__FILE__) + '/tasks/*.rake').each { |f| load f }

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/examples/datacatalog/Rakefile

@@ -0,0 +1,23 @@
+require 'rake/testtask'
+require 'rake/rdoctask'
+require 'rcov/rcovtask'
+
+require File.dirname(__FILE__) + '/config/config'
+Dir.glob(File.dirname(__FILE__) + '/tasks/*.rake').each { |f| load f }
+
+desc "Default: run all tests"
+task :default => :test
+
+namespace :environment do
+  task :application do
+    puts "Loading application environment..."
+    require File.dirname(__FILE__) + '/app'
+  end
+  
+  task :models do
+    puts "Loading models..."
+    Config.setup_mongomapper
+    base = File.dirname(__FILE__)
+    Dir.glob(base + '/models/*.rb'       ).each { |f| require f }
+  end
+end

data/examples/datacatalog/app.rb

@@ -0,0 +1,15 @@
+require 'rubygems'
+
+gem 'sinatra', '>= 0.9.4'
+require 'sinatra/base'
+
+require File.dirname(__FILE__) + '/config/config'
+
+Sinatra::Base.set(:config, Config.environment_config)
+Config.setup
+
+base = File.dirname(__FILE__)
+Dir.glob(base + '/lib/*.rb'             ).each { |f| require f }
+Dir.glob(base + '/models/*.rb'          ).each { |f| require f }
+Dir.glob(base + '/resource_helpers/*.rb').each { |f| require f }
+Dir.glob(base + '/resources/*.rb'       ).each { |f| require f }

data/examples/datacatalog/config/config.rb

@@ -0,0 +1,66 @@
+require 'rubygems'
+
+module Config
+  
+  def self.setup
+    setup_mongomapper
+    # More application setup can go here...
+  end
+  
+  def self.setup_mongomapper
+    gem 'djsun-mongo_mapper', '= 0.5.5.3'
+    require 'mongo_mapper'
+    MongoMapper.connection = new_mongo_connection
+    MongoMapper.database = environment_config['mongo_database']
+  end
+  
+  def self.new_mongo_connection
+    gem 'mongo', "= 0.15.1"
+    require 'mongo'
+    Mongo::Connection.new(environment_config["mongo_hostname"])
+  end
+
+  def self.drop_database
+    database_name = environment_config["mongo_database"]
+    new_mongo_connection.drop_database(database_name)
+    database_name
+  end
+
+  def self.environment_config
+    env_config = config[environment]
+    unless env_config
+      raise "Environment config not found for #{environment.inspect}"
+    end
+    env_config
+  end
+
+  def self.environment
+    if @environment
+      @environment
+    else
+      @environment = if Object.const_defined?("Sinatra")
+        Sinatra::Base.environment.to_s
+      else
+        ENV['RACK_ENV'] || 'development'
+      end
+    end
+  end
+  
+  def self.environment=(env)
+    @environment = env
+  end
+
+  def self.environments
+    config.keys
+  end
+  
+  def self.config
+    if @config
+      @config
+    else
+      file = File.join(File.dirname(__FILE__), "config.yml")
+      @config = YAML.load_file(file)
+    end
+  end
+
+end

data/examples/datacatalog/config/config.yml

@@ -0,0 +1,11 @@
+development:
+  base_uri: http://localhost:3000/
+  mongo_hostname: localhost
+  mongo_database: s_r_example_1_dev
+  api_key_salt: 51a920cc75eb105934df9be349be68cfdd6acf1c
+
+test:
+  base_uri: http://localhost:4567/
+  mongo_hostname: localhost
+  mongo_database: s_r_example_1_test
+  api_key_salt: 51a920cc75eb105934df9be349be68cfdd6acf1c

data/examples/datacatalog/config.ru

@@ -0,0 +1,6 @@
+ENV['RACK_ENV'] = "development"
+require 'app'
+
+map("/categories") { run DataCatalog::Categories }
+map("/sources")    { run DataCatalog::Sources }
+map("/users")      { run DataCatalog::Users }

data/examples/datacatalog/lib/base.rb

@@ -0,0 +1,9 @@
+module DataCatalog
+  
+  class Base < Sinatra::Base
+    before do
+      content_type :json
+    end
+  end
+  
+end

data/examples/datacatalog/lib/resource.rb

@@ -0,0 +1,73 @@
+require 'uri'
+
+module DataCatalog
+    
+  module Resource
+    
+    def self.included(includee)
+      includee.instance_eval do
+        include SinatraResource::Resource
+      end
+      includee.helpers do
+        def before_authorization(action, role)
+          unless role
+            error 401, convert(body_for(:errors, ["invalid_api_key"]))
+          end
+          if role == :anonymous && minimum_role(action) != :anonymous
+            error 401, convert(body_for(:errors, ["missing_api_key"]))
+          end
+        end
+
+        def convert(object)
+          object == "" ? "" : object.to_json
+        end
+        
+        def full_uri(path)
+          base_uri = Config.environment_config["base_uri"]
+          URI.join(base_uri, path).to_s
+        end
+
+        def lookup_role(document=nil)
+          api_key = lookup_api_key
+          return :anonymous unless api_key
+          user = user_for(api_key)
+          return nil unless user
+          return :owner if document && owner?(user, document)
+          user.role.intern
+        end
+
+        protected
+
+        def lookup_api_key
+          @api_key ||= params.delete("api_key")
+        end
+
+        # Is +user+ the owner of +document+?
+        #
+        # First, checks to see if +user+ and +document+ are the same. After
+        # that, try to follow the +document.user+ relationship, if present, to
+        # see if that points to +user+.
+        #
+        # @param [DataCatalog::User] user
+        #
+        # @param [MongoMapper::Document] user
+        #
+        # @return [Boolean]
+        def owner?(user, document)
+          return true if user == document
+          return false unless document.respond_to?(:user)
+          document.user == user
+        end
+
+        def user_for(api_key)
+          user = User.first(:conditions => { :_api_key => api_key })
+          return nil unless user
+          raise "API key found, but user has no role" unless user.role
+          user
+        end
+      end
+    end
+
+  end
+  
+end

data/examples/datacatalog/lib/roles.rb

@@ -0,0 +1,15 @@
+require File.dirname(__FILE__) + '/../../../lib/sinatra_resource'
+
+module DataCatalog
+  
+  module Roles
+    include SinatraResource::Roles
+  
+    role :anonymous
+    role :basic   => :anonymous
+    role :owner   => :basic
+    role :curator => :basic
+    role :admin   => [:owner, :curator]
+  end
+
+end

data/examples/datacatalog/models/categorization.rb

@@ -0,0 +1,31 @@
+module DataCatalog
+
+  class Categorization
+
+    include MongoMapper::Document
+
+    # == Attributes
+
+    key :source_id,   String
+    key :category_id, String
+    timestamps!
+
+    # == Indices
+
+    # == Associations
+
+    belongs_to :source
+    belongs_to :category
+
+    # == Validations
+    
+    validate :validate_associations
+
+    def validate_associations
+      errors.add(:source_id, "must be valid") if source.nil?
+      errors.add(:category_id, "must be valid") if category.nil?
+    end
+
+  end
+
+end

data/examples/datacatalog/models/category.rb

@@ -0,0 +1,28 @@
+module DataCatalog
+
+  class Category
+
+    include MongoMapper::Document
+
+    # == Attributes
+
+    key :name,        String
+    timestamps!
+
+    # == Indices
+
+    # == Associations
+
+    many :categorizations
+
+    def sources
+      categorizations.map(&:source)
+    end
+
+    # == Validations
+
+    validates_presence_of :name
+
+  end
+
+end

data/examples/datacatalog/models/source.rb

@@ -0,0 +1,33 @@
+module DataCatalog
+  
+  class Source
+
+    include MongoMapper::Document
+
+    # == Attributes
+
+    key :title, String
+    key :url,   String
+    key :raw,   Hash
+    timestamps!
+
+    # == Indices
+
+    ensure_index :url
+
+    # == Associations
+
+    many :categorizations
+
+    def categories
+      categorizations.map(&:category)
+    end
+
+    # == Validations
+
+    validates_presence_of :title
+    validates_presence_of :url
+
+  end
+
+end

data/examples/datacatalog/models/user.rb

@@ -0,0 +1,51 @@
+require 'digest/sha1'
+
+module DataCatalog
+  
+  class User
+  
+    include MongoMapper::Document
+
+    # == Attributes
+
+    key :name,     String
+    key :email,    String
+    key :role,     String
+    key :_api_key, String
+    timestamps!
+
+    # == Indices
+
+    ensure_index :email
+
+    # == Validations
+    
+    validates_presence_of :name
+    validates_presence_of :role
+    validate :validate_role
+
+    VALID_ROLES = %w(basic curator admin)
+
+    def validate_role
+      unless VALID_ROLES.include?(role)
+        errors.add(:role, "must be in #{VALID_ROLES.inspect}")
+      end
+    end
+    
+    # == Callbacks
+    
+    def before_create
+      unless _api_key
+        self._api_key = generate_api_key
+      end
+    end
+
+    def generate_api_key
+      salt = Config.environment_config["api_key_salt"]
+      s = "#{Time.now.to_f}#{salt}#{rand(100_000_000)}#{name}#{email}"
+      Digest::SHA1.hexdigest(s)
+    end
+
+  end
+
+end

data/examples/datacatalog/resources/categories.rb

@@ -0,0 +1,32 @@
+module DataCatalog
+
+  class Categories < Base
+    include Resource
+
+    model Category
+
+    # == Permissions
+
+    roles Roles
+    permission :read   => :basic
+    permission :modify => :curator
+
+    # == Properties
+    
+    property :name
+
+    property :sources do |category|
+      category.sources.map do |source|
+        {
+          "id"    => source.id,
+          "href"  => "/sources/#{source.id}",
+          "title" => source.title,
+          "url"   => source.url,
+        }
+      end
+    end
+  end
+  
+  Categories.build
+
+end

data/examples/datacatalog/resources/sources.rb

@@ -0,0 +1,35 @@
+module DataCatalog
+
+  class Sources < Base
+    include Resource
+
+    model Source
+
+    # == Permissions
+
+    roles Roles
+    permission :read   => :basic
+    permission :modify => :curator
+    
+    # == Properties
+
+    property :title
+    property :url
+    property :raw, :w => :admin
+    
+    property :categories do |source|
+      source.categorizations.map do |categorization|
+        {
+          "id"   => categorization.category.id,
+          "href" => "/categories/#{categorization.category.id}",
+          "name" => categorization.category.name,
+        }
+      end
+    end
+
+    # == Callbacks
+  end
+  
+  Sources.build
+
+end

data/examples/datacatalog/resources/users.rb

@@ -0,0 +1,26 @@
+module DataCatalog
+
+  class Users < Base
+    include Resource
+
+    model User
+
+    # == Permissions
+
+    roles Roles
+    permission :read   => :basic
+    permission :modify => :owner
+
+    # == Properties
+  
+    property :name,       :r => :basic
+    property :email,      :r => :owner
+    property :role,       :r => :owner, :w => :admin
+    property :_api_key,   :r => :owner, :w => :admin
+
+    # == Callbacks
+  end
+  
+  Users.build
+
+end

data/examples/datacatalog/tasks/db.rake

@@ -0,0 +1,29 @@
+namespace :db do
+  
+  def verbosely_drop_database
+    db_name = Config.drop_database
+    puts "Dropped database: #{db_name}."
+  end
+
+  desc 'Drop database for current environment (development unless RACK_ENV is set)'
+  task :reset do
+    verbosely_drop_database
+  end
+
+  namespace :reset do
+    desc 'Drop databases defined in config/config.yml'
+    task :all do
+      Config.environments.each do |env_name|
+        Config.environment = env_name
+        verbosely_drop_database
+      end
+    end
+
+    desc 'Drop test database'
+    task :test do
+      Config.environment = 'test'
+      verbosely_drop_database
+    end
+  end
+  
+end

data/examples/datacatalog/tasks/test.rake

@@ -0,0 +1,16 @@
+desc "Run tests"
+task :test => %w(db:reset:test test:models test:resources)
+
+namespace :test do
+  
+  desc "Run model tests"
+  Rake::TestTask.new(:models) do |t|
+    t.test_files = FileList["test/models/*_test.rb"]
+  end
+
+  desc "Run other tests"
+  Rake::TestTask.new(:resources) do |t|
+    t.test_files = FileList["test/resources/**/*_test.rb"]
+  end
+
+end

data/examples/datacatalog/test/helpers/assertions/assert_include.rb

@@ -0,0 +1,17 @@
+module Test
+  module Unit
+    module Assertions
+
+      def assert_include(expected, actual, message = nil)
+        _wrap_assertion do
+          full_message = build_message(message,
+            "<?> expected to include\n<?>.\n", actual, expected)
+          assert_block(full_message) do
+            actual.include?(expected)
+          end
+        end
+      end
+      
+    end
+  end
+end

data/examples/datacatalog/test/helpers/assertions/assert_not_include.rb

@@ -0,0 +1,17 @@
+module Test
+  module Unit
+    module Assertions
+
+      def assert_not_include(expected, actual, message = nil)
+        _wrap_assertion do
+          full_message = build_message(message,
+            "<?> expected to not include\n<?>.\n", actual, expected)
+          assert_block(full_message) do
+            not actual.include?(expected)
+          end
+        end
+      end
+      
+    end
+  end
+end