grape-activerecord 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 40f258710a91aed710575edce515cbaf12b17c00
+  data.tar.gz: c91ac2913e6761842ffc60434c1f59894ce60ea3
+SHA512:
+  metadata.gz: 9d8f767fb5471c2cefedb1539105a1e970033b7aa8866484e37dfe1726ba469ab82b56ddb8614cca775e31208391564cd90f848e6f49cebfb0a7f8f24f1b7306
+  data.tar.gz: 28ce37f584d292cd9f01ad73b84079e28be9a4f633154d22d0c50809c82359f841e351a1cb7aea0212d5bed9de271851cee1bb63c3d202702735dd952bf963da

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2014 Jordan Hollinger
+
+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.rdoc

@@ -0,0 +1,54 @@
+== grape-activerecord
+
+Simple integration of ActiveRecord connections and Rake tasks with Grape. Supports ActiveRecord 4.x.
+Inspired by sinatra-activerecord (https://github.com/janko-m/sinatra-activerecord).
+
+=== Add to your Gemfile
+
+  gem 'grape-activerecord'
+
+=== Set database config
+
+  # Use a Hash
+  Grape::ActiveRecord.database = {adapter: 'postgresql', host: 'localhost', database: 'db', username: 'user', password: 'pass', encoding: 'utf8', pool: 10, timeout: 5000}
+
+  # or a URL
+  Grape::ActiveRecord.database_url = 'postgres://user:pass@localhost/db'
+
+  # or a YAML file
+  Grape::ActiveRecord.database_file = 'config/database.yml'
+
+If you don't specify any configuration, grape-activerecord will first look in DATABASE_URL, then in config/database.yml.
+
+=== Include Grape::ActiveRecord::Extension
+
+  class MyApi < Grape::API
+    include Grape::ActiveRecord::Extension
+    ...
+  end
+
+This will establish the database connections and correctly return used connections to the pool after each request.
+NOTE If you're mounting sub Grape apps, you need only include grape-activerecord in the root app.
+
+=== Add ActiveRecord tasks to your Rakefile
+
+   # Add at the bottom of your Rakefile
+   require 'grape/activerecord/rake'
+
+This will give you most of the standard "db:" tasks you get in Rails. Run "bundle exec rake -T" to get a full list.
+Note that unlike in Rails, creating a new migration is also a rake task:
+
+  bundle exec rake db:create_migration NAME=create_widgets
+
+=== Customize ActiveRecord rake tasks config
+
+  # The defaults are the same as Rails'
+  ActiveRecord::Tasks::DatabaseTasks.tap do |config|
+    config.db_dir = 'db'
+    config.migrations_paths = ['db/migrate']
+    config.fixtures_path = 'test/fixtures'
+  end
+
+=== Example app
+
+Look under /examples for some example apps.

data/lib/grape/activerecord/activerecord.rb

@@ -0,0 +1,42 @@
+# Grape and ActiveRecord integration
+module Grape
+  # Grape and ActiveRecord integration
+  module ActiveRecord
+    class << self
+      # A Hash representing the database connection
+      attr_accessor :database
+      # A database connection URL (default ENV['DATABASE_URL'])
+      attr_accessor :database_url
+      # YAML file where all database configurations are stored (default config/database.yml)
+      attr_accessor :database_file
+    end
+    self.database_url = ENV['DATABASE_URL']
+    self.database_file = 'config/database.yml'
+
+    # The current Rack environment
+    RACK_ENV = (ENV['RACK_ENV'] || 'development').to_sym
+
+    # Read configuration and connect to the database
+    def self.setup!
+      ::ActiveRecord::Base.default_timezone = :utc
+      ::ActiveRecord::Base.logger = Logger.new(STDOUT)
+
+      if spec = Grape::ActiveRecord.database
+        ::ActiveRecord::Base.configurations = {RACK_ENV => spec}.stringify_keys
+        ::ActiveRecord::Base.establish_connection(RACK_ENV)
+
+      elsif spec = Grape::ActiveRecord.database_url
+        ::ActiveRecord::Base.establish_connection(spec)
+        ::ActiveRecord::Base.configurations = {RACK_ENV.to_s => ::ActiveRecord::Base.connection.pool.spec.config}
+
+      elsif path = Grape::ActiveRecord::database_file
+        raise "#{path} does not exist!" unless File.file? path
+        ::ActiveRecord::Base.configurations = YAML.load(ERB.new(File.read(path)).result) || {}
+        ::ActiveRecord::Base.establish_connection(RACK_ENV)
+
+      else
+        raise RuntimeError, 'You must configure a database connection!'
+      end
+    end
+  end
+end

data/lib/grape/activerecord/extension.rb

@@ -0,0 +1,13 @@
+module Grape
+  module ActiveRecord
+    # Including this module in your Grape app establishes the database connection and connection management
+    module Extension
+      # Establishes db connection and management
+      def self.included(app)
+        Grape::ActiveRecord.setup!
+        app.before { ::ActiveRecord::Base.verify_active_connections! if ::ActiveRecord::Base.respond_to?(:verify_active_connections!) }
+        app.after { ::ActiveRecord::Base.clear_active_connections! }
+      end
+    end
+  end
+end

data/lib/grape/activerecord/rake/activerecord_4.rb

@@ -0,0 +1,18 @@
+ActiveRecord::Tasks::DatabaseTasks.tap do |config|
+  config.root = Rake.application.original_dir
+  config.env = Grape::ActiveRecord::RACK_ENV.to_s
+  config.db_dir = 'db'
+  config.migrations_paths = ['db/migrate']
+  config.fixtures_path = 'test/fixtures'
+  config.database_configuration = ActiveRecord::Base.configurations
+  config.seed_loader = Object.new
+  config.seed_loader.instance_eval do
+    def load_seed
+      load "#{ActiveRecord::Tasks::DatabaseTasks.db_dir}/seeds.rb"
+    end
+  end
+end
+
+Rake::Task['db:load_config'].clear
+Rake::Task.define_task('db:environment')
+Rake::Task['db:test:deprecated'].clear if Rake::Task.task_defined?('db:test:deprecated')

data/lib/grape/activerecord/rake.rb

@@ -0,0 +1,7 @@
+load "active_record/railties/databases.rake"
+
+Grape::ActiveRecord.setup!
+require "grape/activerecord/rake/activerecord_#{ActiveRecord::VERSION::MAJOR}"
+load "grape/activerecord/tasks.rake"
+
+ActiveRecord::Base.logger = nil

data/lib/grape/activerecord/tasks.rake

@@ -0,0 +1,39 @@
+require "pathname"
+require "fileutils"
+require "active_support/core_ext/string/strip"
+
+namespace :db do
+  desc "Create a migration (parameters: NAME, VERSION)"
+  task :create_migration do
+    unless ENV["NAME"]
+      puts "No NAME specified. Example usage: `rake db:create_migration NAME=create_widgets`"
+      exit 1
+    end
+
+    name = ENV["NAME"]
+    version = ENV["VERSION"] || Time.now.utc.strftime("%Y%m%d%H%M%S")
+
+    ActiveRecord::Migrator.migrations_paths.each do |directory|
+      next unless File.exists?(directory)
+      migration_files = Pathname(directory).children
+      if duplicate = migration_files.find { |path| path.basename.to_s.include?(name) }
+        puts "Another migration is already named \"#{name}\": #{duplicate}."
+        exit 1
+      end
+    end
+
+    filename = "#{version}_#{name}.rb"
+    dirname = ActiveRecord::Migrator.migrations_path
+    path = File.join(dirname, filename)
+
+    FileUtils.mkdir_p(dirname)
+    File.write path, <<-MIGRATION.strip_heredoc
+      class #{name.camelize} < ActiveRecord::Migration
+        def change
+        end
+      end
+    MIGRATION
+
+    puts path
+  end
+end

data/lib/grape/activerecord/version.rb

@@ -0,0 +1,6 @@
+module Grape
+  module ActiveRecord
+    # Gem version
+    VERSION = '0.0.1'
+  end
+end

data/lib/grape/activerecord.rb

@@ -0,0 +1,4 @@
+require 'erb'
+require 'grape/activerecord/version'
+require 'grape/activerecord/activerecord'
+require 'grape/activerecord/extension'

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: grape-activerecord
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jordan Hollinger
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: grape
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+description: Extends Grape with simple ActiveRecord integration
+email: jordan.hollinger@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.rdoc
+- lib/grape/activerecord.rb
+- lib/grape/activerecord/activerecord.rb
+- lib/grape/activerecord/extension.rb
+- lib/grape/activerecord/rake.rb
+- lib/grape/activerecord/rake/activerecord_4.rb
+- lib/grape/activerecord/tasks.rake
+- lib/grape/activerecord/version.rb
+homepage: https://github.com/jhollinger/grape-activerecord
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: ActiveRecord integration for Grape
+test_files: []