grape_on_rails 1.0.1

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.15.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at topcbl@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,41 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in grape_on_rails.gemspec
+gemspec
+
+gem 'rack', github: 'rack/rack'
+gem 'arel', github: 'rails/arel'
+gem 'rails', github: 'rails/rails'
+git 'https://github.com/rails/rails.git' do
+  gem 'railties'
+  gem 'activesupport'
+  gem 'actionpack'
+  gem 'activerecord', group: :test
+end
+
+# https://github.com/bundler/bundler/blob/89a8778c19269561926cea172acdcda241d26d23/lib/bundler/dependency.rb#L30-L54
+@windows_platforms = [:mswin, :mingw, :x64_mingw]
+
+# Windows does not include zoneinfo files, so bundle the tzinfo-data gem
+gem 'tzinfo-data', platforms: (@windows_platforms + [:jruby])
+
+group :test do
+  gem 'pry', '>= 0.10'
+  gem 'byebug', '~> 8.2' if RUBY_VERSION < '2.2'
+  gem 'pry-byebug', platform: :ruby
+end
+
+group :development, :test do
+  gem "pry"
+  gem "pry-rails"
+  gem "pry-byebug"
+  gem "byebug", platforms: [:mri, :mingw, :x64_mingw]
+  gem "rspec"
+  gem "rspec-rails"
+  gem "rspec-its"
+  gem "rspec-collection_matchers"
+  gem "rubocop", "~> 0.49.0", require: false
+  gem "rubocop-checkstyle_formatter", require: false
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 topcbl
+
+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.md

@@ -0,0 +1,45 @@
+# GrapeOnRails
+
+* Want to get rid of boilerplate code
+* Want to keep using Rails api-only mode without mess with Grape
+* Have an easy life
+
+Introduce gem GrapeOnRails - which brings Grape DSL to Rails-API and help writing APIs easier than ever
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'grape_on_rails'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install grape_on_rails
+
+## Usage
+
+TODO: 
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/grape_on_rails. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the GrapeOnRails project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/grape_on_rails/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "grape_on_rails"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/grape_on_rails.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "grape_on_rails/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "grape_on_rails"
+  spec.version       = GrapeOnRails::VERSION
+  spec.authors       = ["topcbl"]
+  spec.email         = ["topcbl@gmail.com"]
+
+  spec.summary       = %q(Bring Grape DSL to Rails-api. Make it easier for writing api.)
+  spec.description   = %q(Bring Grape DSL to Rails-api. Make it easier for writing api.)
+  spec.homepage      = "https://github.com/chau-bao-long/grape-on-rails"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}){|f| File.basename(f)}
+  spec.require_paths = ["lib"]
+
+  rails_versions = [">= 4.1", "< 6"]
+
+  spec.add_runtime_dependency "actionpack", rails_versions
+  spec.add_runtime_dependency "activerecord", rails_versions
+  spec.add_runtime_dependency "activesupport", rails_versions
+  spec.add_runtime_dependency "railties", rails_versions
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/grape_on_rails.rb

@@ -0,0 +1,78 @@
+require "grape_on_rails/version"
+require "active_support/dependencies/autoload"
+require "active_support/core_ext/array/extract_options"
+require 'active_support/core_ext/module/attribute_accessors'
+require "active_support/concern"
+require "grape_on_rails/sources/yaml_source"
+require "grape_on_rails/structural_hash"
+require "grape_on_rails/support"
+require "grape_on_rails/types/boolean"
+
+# rubocop:disable ModuleFunction, ClassVars
+module GrapeOnRails
+  extend ActiveSupport::Autoload
+  extend self
+
+  autoload :API
+  autoload :APIError
+  autoload :Authenticator
+  autoload :Models
+  autoload :SecuredGenerator
+
+  mattr_accessor :config_file, :short_name
+
+  @@_ran_once = false
+  @@config_file = "grape_on_rails.yml"
+  @@short_name = "GoR"
+
+  def setup
+    return if @@_ran_once
+    @@_ran_once = true
+    block_given? ? yield(self) : hook_rails_layers
+  end
+
+  def load
+    config = load_file
+    Kernel.send(:remove_const, short_name) if Kernel.const_defined?(short_name)
+    Kernel.const_set short_name, config
+    Models.set_default_model_actors config
+    create_error_class config
+  end
+
+  alias :reload :load
+
+  private
+  def load_file
+    file = Rails.root.join("config", config_file)
+    source = Sources::YAMLSource.new(file.to_s).load
+    StructuralHash.new.from_hash source
+  end
+
+  def create_error_class config
+    config.errors.each do |error|
+      next if error.second.skip_create_error
+      error_name = error.first.to_s.classify
+      APIError.const_set error_name, Class.new(APIError::Base) unless APIError.const_defined?(error_name)
+    end
+  end
+
+  def hook_rails_layers
+    hook_controller GrapeOnRails::API, GrapeOnRails::Authenticator
+    hook_model GrapeOnRails::Models
+  end
+
+  def hook_controller *modules
+    modules.each do |mod|
+      ActionController::Metal.include mod unless ActionController::Metal < mod
+    end
+  end
+
+  def hook_model *modules
+    modules.each do |mod|
+      ActiveRecord::Base.extend mod unless ActiveRecord::Base.singleton_class < mod
+    end
+  end
+end
+# rubocop:enable ModuleFunction, ClassVars
+
+require("grape_on_rails/integrations/railtie") if defined?(::Rails)

data/lib/grape_on_rails/api.rb

@@ -0,0 +1,36 @@
+require "grape_on_rails/error_formatter"
+require "grape_on_rails/validator"
+
+module GrapeOnRails
+  module API
+    extend ActiveSupport::Concern
+
+    include ActiveSupport::Rescuable
+    include Validator
+    include ErrorFormatter
+    include Support
+
+    included do
+      rescue_from APIError::Base do |e|
+        render_error class_name(e), e.message, e.status
+      end
+
+      rescue_from ActiveRecord::UnknownAttributeError, ActiveRecord::StatementInvalid, JSON::ParserError do |e|
+        render_error :data_operation, e.message, :internal_server_error
+      end
+
+      rescue_from ActiveRecord::RecordNotFound do
+        render_error :record_not_found, gor_t("record_not_found"), :bad_request
+      end
+
+      rescue_from ActiveRecord::RecordInvalid do |e|
+        render_error :record_invalid, e.message, :bad_request
+      end
+
+      private
+      def r resources, extra_params = {}
+        render extra_params.merge json: resources
+      end
+    end
+  end
+end

data/lib/grape_on_rails/api_error.rb

@@ -0,0 +1,19 @@
+module GrapeOnRails
+  module APIError
+    class Base < StandardError
+      include Support
+
+      attr_reader :status
+
+      def initialize message = nil, status = nil
+        super message || localize_message
+        @status = status || :bad_request
+      end
+
+      private
+      def localize_message
+        gor_translate class_name(self)
+      end
+    end
+  end
+end

data/lib/grape_on_rails/attributes.rb

@@ -0,0 +1,52 @@
+module GrapeOnRails
+  module Attributes
+    TYPE = {BigDecimal: "to_d", DateTime: "to_datetime", Date: "to_date", Time: "to_time"}.freeze
+
+    def declared_attrs attrs
+      @declared_attrs ||= []
+      @declared_attrs |= attrs
+    end
+
+    def declared_params
+      params.permit @declared_attrs
+    end
+
+    def undeclare_params *params
+      @declared_attrs -= params
+    end
+
+    private
+    def verify method, attrs, value
+      attrs.each do |attr|
+        is_valid = send "verify_#{method}", attr, value
+        raise APIError::ValidationError, "#{attr} #{I18n.t "errors.messages.#{method}"}" unless is_valid
+        instance_variable_set "@#{attr}".to_sym, params[attr]
+        self.class.class_eval{attr_reader attr}
+      end
+    end
+
+    def verify_type attr, type, param = nil
+      return verify_type_in_array attr, type if type.is_a? Array
+      return true if type == File
+      param ||= params[attr]
+      param.class.include GrapeOnRails::Types::Boolean if type == GrapeOnRails::Types::Boolean
+      convert_method = TYPE[type.name.to_sym] || "to_#{type.name[0].downcase}"
+      params[attr] = param.public_send convert_method
+      true
+    rescue StandardError
+      false
+    end
+
+    def verify_type_in_array attr, type
+      params[attr].all?{|p| verify_type(attr, type.to_a.first, param: p)}
+    end
+
+    def verify_allow_blank attr, is_allow
+      params[attr].present? || is_allow
+    end
+
+    def verify_regexp attr, regex
+      params[attr] =~ regex
+    end
+  end
+end