grape-app 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9786d097c5c829ddf0628b46d4205fbbb82dd3ac
+  data.tar.gz: 8d9b2b6524336370ea0944cf836ab55f83a187d9
+SHA512:
+  metadata.gz: 4d4ff67a6ed976dd8d1e4e18e7de26f12e6da49873a7c339412adfe3456ed5a3f1ca3ae4f624e53d61a75479fe72c46a6e2d85f7883d4d2adc4b725cdb63d0d0
+  data.tar.gz: 58c318856bbe67e1a96dea8e4a873e2a0aef478c9833cf76a7dd4336b804a2502e64ce864a87810616a3058485498e6e29d82dfea7392e00ca83d3d4753e3d0e

data/.gitignore

@@ -0,0 +1 @@
+*.gem

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/Gemfile.lock

@@ -0,0 +1,92 @@
+PATH
+  remote: .
+  specs:
+    grape-app (0.3.0)
+      activesupport
+      activesupport-json_encoder
+      grape
+      grape-entity
+      hashie-forbidden_attributes
+      rack-cors
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (4.2.1)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    activesupport-json_encoder (1.1.0)
+      activesupport (>= 4.1.0, < 5.0)
+    axiom-types (0.1.1)
+      descendants_tracker (~> 0.0.4)
+      ice_nine (~> 0.11.0)
+      thread_safe (~> 0.3, >= 0.3.1)
+    builder (3.2.2)
+    coercible (1.0.0)
+      descendants_tracker (~> 0.0.1)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
+    diff-lcs (1.2.5)
+    equalizer (0.0.11)
+    grape (0.11.0)
+      activesupport
+      builder
+      hashie (>= 2.1.0)
+      multi_json (>= 1.3.2)
+      multi_xml (>= 0.5.2)
+      rack (>= 1.3.0)
+      rack-accept
+      rack-mount
+      virtus (>= 1.0.0)
+    grape-entity (0.4.5)
+      activesupport
+      multi_json (>= 1.3.2)
+    hashie (3.4.2)
+    hashie-forbidden_attributes (0.1.1)
+      hashie (>= 3.0)
+    i18n (0.7.0)
+    ice_nine (0.11.1)
+    json (1.8.3)
+    minitest (5.7.0)
+    multi_json (1.11.1)
+    multi_xml (0.5.5)
+    rack (1.6.1)
+    rack-accept (0.4.5)
+      rack (>= 0.4)
+    rack-cors (0.3.1)
+    rack-mount (0.8.3)
+      rack (>= 1.0.0)
+    rake (10.4.2)
+    rspec (3.3.0)
+      rspec-core (~> 3.3.0)
+      rspec-expectations (~> 3.3.0)
+      rspec-mocks (~> 3.3.0)
+    rspec-core (3.3.0)
+      rspec-support (~> 3.3.0)
+    rspec-expectations (3.3.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-mocks (3.3.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-support (3.3.0)
+    thread_safe (0.3.5)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+    virtus (1.0.5)
+      axiom-types (~> 0.1)
+      coercible (~> 1.0)
+      descendants_tracker (~> 0.0, >= 0.0.3)
+      equalizer (~> 0.0, >= 0.0.9)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  grape-app!
+  rake
+  rspec

data/README.md

@@ -0,0 +1,32 @@
+# Grape::App
+
+Grape::App is an attempt to 'railsify' the process of developing standalone grape apps.
+
+## TODO
+
+* Write app generator
+
+## Licence
+
+```
+Copyright (c) 2015 Black Square Media
+
+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/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/setup'
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+task default: :spec

data/grape-app.gemspec

@@ -0,0 +1,29 @@
+# encoding: utf-8
+
+Gem::Specification.new do |s|
+  s.name          = 'grape-app'
+  s.version       = '0.3.0'
+  s.authors       = ['Black Square Media Ltd']
+  s.email         = ['info@blacksquaremedia.com']
+  s.summary       = %{Stanalone Grape API apps}
+  s.description   = %{}
+  s.homepage      = 'https://github.com/bsm/grape-app'
+  s.license       = 'MIT'
+
+  s.files         = `git ls-files`.lines.map(&:chomp)
+  s.test_files    = `git ls-files -- test/*`.lines.map(&:chomp)
+  s.require_paths = ['lib']
+  s.required_ruby_version = '>= 1.9.3'
+
+  s.add_dependency 'grape'
+  s.add_dependency 'grape-entity'
+  s.add_dependency 'activesupport'
+  s.add_dependency 'activesupport-json_encoder'
+  s.add_dependency 'hashie-forbidden_attributes'
+  s.add_dependency 'rack-cors'
+
+  s.add_development_dependency 'bundler'
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'rspec'
+end
+

data/lib/grape-app.rb

@@ -0,0 +1 @@
+require 'grape/app'

data/lib/grape/app.rb

@@ -0,0 +1,84 @@
+require 'bundler/setup'
+require 'pathname'
+require 'grape'
+require 'active_support/string_inquirer'
+require 'active_support/configurable'
+require 'active_support/inflector/methods'
+require 'activesupport/json_encoder'
+require 'hashie-forbidden_attributes'
+require 'rack/cors'
+
+class Grape::App < Grape::API
+  include ActiveSupport::Configurable
+
+  class << self
+
+    # Run initializers
+    def init!(root = nil)
+      @root = Pathname.new(root) if root
+
+      # Require bundle
+      Bundler.require :default, env.to_sym
+
+      # Load initializers
+      require 'grape/app/initializers/pre'
+      require_one 'config', 'environments', env
+      require_all 'config', 'initializers'
+      require 'grape/app/initializers/post'
+
+      # Load app
+      $LOAD_PATH.push @root.join('lib')
+      $LOAD_PATH.push @root.join('app')
+      $LOAD_PATH.push @root.join('app', 'models')
+
+      require_one 'app', 'models'
+      require_one 'app', 'api'
+    end
+
+    # @return [Pathname] root path
+    def root
+      @root ||= Bundler.root.dup
+    end
+
+    # @return [ActiveSupport::StringInquirer] env name
+    def env
+      @env ||= ActiveSupport::StringInquirer.new(ENV['GRAPE_ENV'] || ENV['RACK_ENV'] || 'development')
+    end
+
+    def autoload(paths)
+      paths.each do |path|
+        Object.autoload ActiveSupport::Inflector.classify(path), path
+      end
+    end
+
+    def middleware
+      config = self.config
+      @middleware ||= Rack::Builder.new do
+        use Rack::SslEnforcer if config.force_ssl
+        use Rack::Cors do
+          allow do
+            origins   *Array.wrap(config.cors_allow_origins)
+            resource  '*', headers: :any, methods: [:get, :post, :options, :delete, :put]
+          end
+        end if config.cors_allow_origins
+
+        run Grape::App
+      end
+    end
+
+    private
+
+    def require_all(*args)
+      args = args + ['**', '*.rb']
+      Dir[root.join(*args).to_s].each {|f| require f }
+    end
+
+    def require_one(*args)
+      path = root.join(*args).to_s
+      require path if File.exists?("#{path}.rb")
+    end
+
+  end
+end
+
+require 'grape/app/helpers'

data/lib/grape/app/helpers.rb

@@ -0,0 +1,6 @@
+module Grape::App::Helpers
+  extend ActiveSupport::Autoload
+
+  autoload :Params
+  autoload :RespondWith
+end

data/lib/grape/app/helpers/params.rb

@@ -0,0 +1,9 @@
+module Grape::App::Helpers::Params
+
+  # Scope declared params
+  # @return [Hashie::Mash] decalred params only
+  def declared_params
+    declared(params, include_missing: false)
+  end
+
+end

data/lib/grape/app/helpers/respond_with.rb

@@ -0,0 +1,18 @@
+require 'grape_entity'
+
+module Grape::App::Helpers::RespondWith
+
+  class Errors < Grape::Entity
+    expose :errors
+  end
+
+  # @param [ActiveRecord::Base] record validated record
+  def respond_with(record, opts = {})
+    unless record.errors.empty?
+      opts[:with] = Errors
+      status 400
+    end
+    present record, opts
+  end
+
+end

data/lib/grape/app/initializers/post.rb

@@ -0,0 +1,17 @@
+if Grape::App.config.raise_on_missing_translations
+  handler = -> (exception, *) { exception = exception.to_exception if exception.respond_to?(:to_exception); raise exception }
+  I18n.exception_handler = handler
+end
+
+if defined?(ActiveRecord)
+  require 'yaml'
+
+  configurations = YAML.load(Grape::App.root.join('config', 'database.yml').read)
+  configurations[Grape::App.env.to_s]['url'] = ENV['DATABASE_URL'] if ENV['DATABASE_URL']
+
+  ActiveRecord::Base.configurations = configurations
+  ActiveRecord::Base.default_timezone = :utc
+  ActiveRecord::Base.establish_connection(Grape::App.env.to_sym)
+
+  Grape::App.middleware.use ActiveRecord::ConnectionAdapters::ConnectionManagement
+end

data/lib/grape/app/initializers/pre.rb

@@ -0,0 +1,9 @@
+# Set default time-zone
+Time.zone = 'UTC'
+
+# Configure big-decimal encoding
+ActiveSupport.encode_big_decimal_as_string = false
+
+# Add default I18n paths and set default locale
+I18n.load_path += Dir[Grape::App.root.join('config', 'locales', '*.{rb,yml}').to_s]
+I18n.default_locale = :en

data/lib/grape/app/tasks.rake

@@ -0,0 +1,3 @@
+if defined?(ActiveRecord)
+  load 'grape/app/tasks/databases.rake'
+end

data/lib/grape/app/tasks/databases.rake

@@ -0,0 +1,47 @@
+load 'active_record/railties/databases.rake'
+
+ActiveRecord::Tasks::DatabaseTasks.tap do |config|
+  config.db_dir = 'db'
+  config.migrations_paths = ['db/migrate']
+  config.seed_loader = Class.new do
+    def self.load_seed
+      load Grape::App.root.join('db', 'seeds.rb').to_s
+    end
+  end
+end
+
+namespace :db do
+
+  Rake::Task['load_config'].clear
+
+  task load_config: :environment do
+    ActiveRecord::Tasks::DatabaseTasks.tap do |config|
+      config.root   = Grape::App.root
+      config.env    = Grape::App.env
+      config.database_configuration = ActiveRecord::Base.configurations
+    end
+  end
+
+  desc "Create a new migration using NAME"
+  task migration: :environment do
+    abort "No NAME specified. Example usage: `rake db:migration NAME=create_widgets`" unless ENV["NAME"]
+
+    name = ENV["NAME"]
+    path = File.join(ActiveRecord::Migrator.migrations_path, "#{Time.now.utc.strftime('%Y%m%d%H%M%S')}_#{name}.rb")
+
+    FileUtils.mkdir_p(ActiveRecord::Migrator.migrations_path)
+    File.write path, <<-MIGRATION.strip_heredoc
+      class #{name.camelize} < ActiveRecord::Migration
+        def change
+        end
+      end
+    MIGRATION
+    puts path
+  end
+
+  namespace :test do
+    desc "Prepare test DB"
+    task :prepare
+  end
+
+end

data/lib/grape_app.rb

@@ -0,0 +1 @@
+require 'grape/app'

data/spec/grape/app_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+
+RSpec.describe Grape::App do
+
+  subject { described_class }
+  before  { subject.init! File.expand_path('../../scenario', __FILE__) }
+
+  it 'should have an env' do
+    expect(subject.env).to be_instance_of(ActiveSupport::StringInquirer)
+    expect(subject.env).to eq("development")
+  end
+
+  it 'should have an root' do
+    expect(subject.root).to be_instance_of(Pathname)
+  end
+
+  it 'should be an API' do
+    expect(subject).to be < Grape::API
+  end
+
+  it 'should init with default time zone' do
+    expect(Time.zone.name).to eq("UTC")
+  end
+
+  it 'should configure i18n' do
+    expect(I18n.load_path).to include(subject.root.join("config", "locales", "en.yml").to_s)
+    expect(I18n.default_locale).to eq(:en)
+    expect(I18n.exception_handler).to be_instance_of(Proc)
+  end
+
+  it 'should read env specific initializers' do
+    expect(subject.config).to eq(
+      dev_specific: true,
+      raise_on_missing_translations: true,
+      cors_allow_origins: ["example.com"],
+    )
+  end
+
+  it 'should prepare middleware' do
+    expect(subject.middleware).to be_instance_of(Rack::Builder)
+    expect(subject.middleware.send(:instance_variable_get, :@use).size).to eq(1)
+    expect(subject.middleware.send(:instance_variable_get, :@run)).to eq(subject)
+  end
+
+end

data/spec/scenario/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gem 'grape-app', path: '../../'

data/spec/scenario/config/environments/development.rb

@@ -0,0 +1,5 @@
+Grape::App.configure do |c|
+  c.dev_specific = true
+  c.raise_on_missing_translations = true
+  c.cors_allow_origins = ['example.com']
+end

data/spec/scenario/config/locales/en.yml

@@ -0,0 +1,2 @@
+en:
+  hi: hello

data/spec/scenario/lib/my_lib.rb

@@ -0,0 +1,2 @@
+class MyLib
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require 'grape-app'

metadata

@@ -0,0 +1,192 @@
+--- !ruby/object:Gem::Specification
+name: grape-app
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+platform: ruby
+authors:
+- Black Square Media Ltd
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-06-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: grape
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: grape-entity
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport-json_encoder
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: hashie-forbidden_attributes
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack-cors
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ''
+email:
+- info@blacksquaremedia.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- grape-app.gemspec
+- lib/grape-app.rb
+- lib/grape/app.rb
+- lib/grape/app/helpers.rb
+- lib/grape/app/helpers/params.rb
+- lib/grape/app/helpers/respond_with.rb
+- lib/grape/app/initializers/post.rb
+- lib/grape/app/initializers/pre.rb
+- lib/grape/app/tasks.rake
+- lib/grape/app/tasks/databases.rake
+- lib/grape_app.rb
+- spec/grape/app_spec.rb
+- spec/scenario/Gemfile
+- spec/scenario/config/environments/development.rb
+- spec/scenario/config/locales/en.yml
+- spec/scenario/lib/my_lib.rb
+- spec/spec_helper.rb
+homepage: https://github.com/bsm/grape-app
+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.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.7
+signing_key: 
+specification_version: 4
+summary: Stanalone Grape API apps
+test_files: []