grape-activerecord 0.0.8 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d2c6900e3c4121e02d0f6e4396c121b436de4130
-  data.tar.gz: be25edd2db43eededd72b925c5aa8ea4655a57f7
+  metadata.gz: e2c64bed54671c981f10740dd8c9aff825139ecd
+  data.tar.gz: 4767e1ec312989eca3fdf8402581953c34293ecb
 SHA512:
-  metadata.gz: c70989c0e2e7fc2be5113a9a6851e46af63d9f8dfb725b0a7e7ecf643532525b3ec7e6c416d6bf16a408d0a0f89b299c1d3ce8e4e3f24ddeac7cbaca6cdfd470
-  data.tar.gz: 861261075ed7ef9d3b417fb0678b36a9460df1a2c4f030ec579291e4f1685ac36939959a78a2937bcab6d13f1c2bd0d29f417b60326922a21562bdb6071e52cf
+  metadata.gz: 6f4408ff1a8c8a2509b8e3e9a4118be9c456d2b5b3ce7b2e625a25970054ad6218332b6e29a6c8223caeb41d7262cf982b06290460941e8384b21e502efe4782
+  data.tar.gz: 5c749482c3f5a820ae9f93b5f9cd614293bbe3ef3b9a8a052e6f12fd362b039b78f1d29eead8df8c25f84a50fb1f13ea35e72fc3ba2cec984e8854bcb773818d

data/README.md

@@ -0,0 +1,56 @@
+# grape-activerecord
+
+A simple way to use ActiveRecord with your Grape apps.
+
+## How to use
+
+### 1. Add it to your Gemfile
+
+    gem "grape-activerecord"
+
+### 2. Configure your database connection
+
+grape-activerecord looks for your database configuration in:
+
+* `config/database.yml` (see /examples for a sample file)
+* The `DATABASE_URL` environment variable (e.g. `postgres://user:pass@host/db`)
+
+But if your app has more particular needs, we've got you covered:
+
+    Grape::ActiveRecord.database_file = "db.yml"
+    Grape::ActiveRecord.database_url = "postgres://user:pass@host/db"
+    Grape::ActiveRecord.database = {adapter: "postgresql", host: "localhost", database: "db", username: "user", password: "pass", encoding: "utf8", pool: 10, timeout: 5000}
+
+### 3. Enable ActiveRecord connection management
+
+This ActiveRecord middleware cleans up your database connections after each request. Add it to your config.ru file:
+
+    use ActiveRecord::ConnectionAdapters::ConnectionManagement
+
+### 4. Import ActiveRecord tasks into your Rakefile
+
+This will give you most of the standard `db:` tasks you get in Rails. Run `bundle exec rake -T` to get a full list.
+
+    require "bundler/setup"
+    require "grape/activerecord/rake"
+
+    namespace :db do
+      # Some db tasks require your app code to be loaded
+      task :environment do
+        require_relative "app"
+      end
+    end
+
+Unlike in Rails, creating a new migration is also a rake task:
+
+    bundle exec rake db:create_migration NAME=create_widgets
+
+## Examples
+
+Look under /examples for some example apps.
+
+## License
+
+Licensed under the MIT License
+
+Copyright 2014 Jordan Hollinger

data/lib/grape/activerecord.rb

@@ -1,5 +1,6 @@
 require 'erb'
+require 'active_record'
 require 'hashie-forbidden_attributes'
 require 'grape/activerecord/version'
 require 'grape/activerecord/activerecord'
-require 'grape/activerecord/extension'
+require 'grape/activerecord/defaults'

data/lib/grape/activerecord/activerecord.rb

@@ -2,41 +2,27 @@
 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}
+    # Connect to database with a Hash. Example:
+    # {adapter: 'postgresql', host: 'localhost', database: 'db', username: 'user', password: 'pass', encoding: 'utf8', pool: 10, timeout: 5000}
+    def self.database=(spec)
+      ::ActiveRecord::Base.configurations = {RACK_ENV => spec}.stringify_keys
+      ::ActiveRecord::Base.establish_connection(RACK_ENV)
+    end
 
-      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)
+    # Connect to database with a DB URL. Example: "postgres://user:pass@localhost/db"
+    def self.database_url=(url)
+      ::ActiveRecord::Base.establish_connection(url)
+      ::ActiveRecord::Base.configurations = {RACK_ENV.to_s => ::ActiveRecord::Base.connection.pool.spec.config}
+    end
 
-      else
-        raise RuntimeError, 'You must configure a database connection!'
-      end
+    # Connect to database with a yml file. Example: "config/database.yml"
+    def self.database_file=(path)
+      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)
     end
   end
 end

data/lib/grape/activerecord/defaults.rb

@@ -0,0 +1,8 @@
+::ActiveRecord::Base.default_timezone = :utc
+::ActiveRecord::Base.logger = Logger.new(STDOUT)
+
+if ENV['DATABASE_URL']
+  Grape::ActiveRecord.database_url = ENV['DATABASE_URL']
+elsif File.file? 'config/database.yml'
+  Grape::ActiveRecord.database_file = 'config/database.yml'
+end

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

@@ -1,7 +1,6 @@
 Rake::Task['db:load_config'].clear
 Rake::Task.define_task('db:load_config') do
   require 'grape/activerecord'
-  Grape::ActiveRecord.setup!
   ActiveRecord::Base.logger = nil
 
   ActiveRecord::Tasks::DatabaseTasks.tap do |config|

data/lib/grape/activerecord/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grape-activerecord
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 1.0.0
 platform: ruby
 authors:
 - Jordan Hollinger
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-11 00:00:00.000000000 Z
+date: 2015-08-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grape
@@ -59,10 +59,10 @@ extensions: []
 extra_rdoc_files: []
 files:
 - LICENSE
-- README.rdoc
+- README.md
 - lib/grape/activerecord.rb
 - lib/grape/activerecord/activerecord.rb
-- lib/grape/activerecord/extension.rb
+- lib/grape/activerecord/defaults.rb
 - lib/grape/activerecord/rake.rb
 - lib/grape/activerecord/rake/activerecord_4.rb
 - lib/grape/activerecord/tasks.rake
@@ -87,9 +87,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: ActiveRecord integration for Grape
 test_files: []
-has_rdoc: 

data/README.rdoc

@@ -1,60 +0,0 @@
-== 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 (usually) 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.
-
-==== Important
-
-It's recommended that you manually include ActiveRecord::ConnectionAdapters::ConnectionManagement yourself BEFORE mounting your Grape app (https://github.com/intridea/grape/issues/517#issuecomment-60969722). The top of your config.ru file is a good place:
-
-  # config.ru
-  use ActiveRecord::ConnectionAdapters::ConnectionManagement
-  run MyGrapeApi
-
-=== Example Rakefile with ActiveRecord tasks
-
-  require 'bundler/setup'
-  require 'grape/activerecord/rake'
-
-  namespace :db do
-    # Some db tasks require your app code to be loaded
-    task :environment do
-      require_relative 'app'
-    end
-  end
-
-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
-
-=== Example app
-
-Look under /examples for some example apps.

data/lib/grape/activerecord/extension.rb

@@ -1,12 +0,0 @@
-module Grape
-  module ActiveRecord
-    # Including this module in your Grape app establishes the database connection and handles connection management
-    module Extension
-      # Establishes db connection and management
-      def self.included(app)
-        Grape::ActiveRecord.setup!
-        app.use ::ActiveRecord::ConnectionAdapters::ConnectionManagement
-      end
-    end
-  end
-end