grape_on_rails 1.0.1

data/lib/grape_on_rails/authenticator.rb

@@ -0,0 +1,24 @@
+module GrapeOnRails
+  module Authenticator
+    include Support
+
+    attr_accessor :current_user
+
+    def authenticate!
+      @current_user = GoR.models.user_token.constantize
+        .find_token!(token_on_header)&.public_send(GoR.models.user.downcase)
+      raise APIError::Unauthenticated unless current_user
+    end
+
+    def refresh_token!
+      token = GoR.models.user_token.constantize.find_by refresh_token: token_on_header
+      token ? token.renew! : raise(APIError::Unauthenticated)
+      token
+    end
+
+    def token_on_header
+      auth_header = request.headers[GoR.access_token_header]
+      auth_header&.scan(/^#{GoR.access_token_value_prefix} (.+)$/i)&.flatten&.[]0
+    end
+  end
+end

data/lib/grape_on_rails/error_formatter.rb

@@ -0,0 +1,10 @@
+module GrapeOnRails
+  module ErrorFormatter
+    def render_error error_name, message, http_status
+      render json: {
+        GoR.error_code_key => GoR.errors.public_send(error_name).code,
+        GoR.error_message_key => message
+      }, status: http_status
+    end
+  end
+end

data/lib/grape_on_rails/integrations/railtie.rb

@@ -0,0 +1,38 @@
+module GrapeOnRails
+  module Integrations
+    class Railtie < Rails::Railtie
+      def auto_reload_in_development
+        return unless ::Rails.env.development? && ::Rails::VERSION::MAJOR >= 4
+        reload_on_api_only_mode
+        reload_on_normal_mode
+      end
+
+      def reload_on_api_only_mode
+        ActionController::Base.class_eval(&reload_on_each_request)
+      end
+
+      def reload_on_normal_mode
+        ActionController::API.class_eval(&reload_on_each_request)
+      end
+
+      def reload_on_each_request
+        proc do
+          prepend_before_action{::GrapeOnRails.reload}
+        end
+      end
+
+      config.before_configuration{GrapeOnRails.load}
+
+      config.after_initialize do
+        ActiveSupport.on_load(:active_record) do
+          extend GrapeOnRails::Models
+        end
+        ActiveSupport.on_load(:action_controller) do
+          include GrapeOnRails::API
+          include GrapeOnRails::Authenticator
+        end
+        auto_reload_in_development
+      end
+    end
+  end
+end

data/lib/grape_on_rails/macros.rb

@@ -0,0 +1,21 @@
+require "grape_on_rails/attributes"
+
+module GrapeOnRails
+  module Macros
+    include GrapeOnRails::Attributes
+
+    def requires *attrs
+      options = attrs.extract_options!
+      raise APIError::ValidationError if attrs.any?{|a| params[a].nil?}
+      options.each{|k, v| verify k, attrs, v}
+      declared_attrs attrs
+    end
+
+    def optional *attrs
+      options = attrs.extract_options!
+      return if attrs.any?{|a| params[a].nil?}
+      options.each{|k, v| verify k, attrs, v}
+      declared_attrs attrs
+    end
+  end
+end

data/lib/grape_on_rails/models.rb

@@ -0,0 +1,28 @@
+require "grape_on_rails/models/user_actor"
+require "grape_on_rails/models/user_token_actor"
+
+module GrapeOnRails
+  module Models
+    DEFAULT_USER_ACTOR = "User"
+    DEFAULT_USER_TOKEN_ACTOR = "UserToken"
+
+    def acts_as model
+      include GrapeOnRails::Models.const_get "#{model}_actor".classify
+      missing_columns = check_missing_columns
+      raise "You need to add columns: #{missing_columns} to #{name} model" unless missing_columns.empty?
+    end
+
+    class << self
+      def set_default_model_actors config
+        config.models = StructuralHash.new.from_hash default_model_actors unless config.models
+      end
+
+      def default_model_actors
+        {
+          user: DEFAULT_USER_ACTOR,
+          user_token: DEFAULT_USER_TOKEN_ACTOR
+        }
+      end
+    end
+  end
+end

data/lib/grape_on_rails/models/user_actor.rb

@@ -0,0 +1,23 @@
+module GrapeOnRails
+  module Models
+    module UserActor
+      extend ActiveSupport::Concern
+
+      included do
+        has_secure_password
+      end
+
+      class_methods do
+        def authenticate! email, password
+          find_by(email: email).tap do |user|
+            raise APIError::WrongEmailPassword unless user&.authenticate password
+          end
+        end
+
+        def check_missing_columns
+          %w(email password_digest) - column_names
+        end
+      end
+    end
+  end
+end

data/lib/grape_on_rails/models/user_token_actor.rb

@@ -0,0 +1,45 @@
+module GrapeOnRails
+  module Models
+    module UserTokenActor
+      extend ActiveSupport::Concern
+      include Support
+      include SecuredGenerator
+
+      included do
+        has_secure_token
+        has_secure_token :refresh_token
+
+        def renew! remember = false
+          update! expires_at: GoR.token_configs.public_send(remember ? :expires_in : :short_expires_in).second.from_now,
+            token: unique_random(:token), refresh_token: unique_random(:refresh_token)
+          self
+        end
+
+        def expired?
+          expires_at <= Time.zone.now
+        end
+
+        def expires!
+          update_attributes! expired_at: Time.zone.now
+        end
+      end
+
+      class_methods do
+        def generate! user
+          token = find_or_initialize_by GoR.models.user.downcase => user
+          token.renew!
+        end
+
+        def find_token! token
+          find_by(token: token).tap do |user_token|
+            raise APIError::TokenExpired if user_token&.expired?
+          end
+        end
+
+        def check_missing_columns
+          %w(token refresh_token expires_at) - column_names
+        end
+      end
+    end
+  end
+end

data/lib/grape_on_rails/secured_generator.rb

@@ -0,0 +1,13 @@
+module GrapeOnRails
+  module SecuredGenerator
+    def unique_random attr
+      str_len = GoR.token_configs
+        .public_send(attr)
+        .public_send(:secure_length).to_i / 2
+      loop do
+        str = SecureRandom.hex str_len
+        break str unless self.class.exists?(attr => str)
+      end
+    end
+  end
+end

data/lib/grape_on_rails/sources/yaml_source.rb

@@ -0,0 +1,21 @@
+require "yaml"
+require "erb"
+
+module GrapeOnRails
+  module Sources
+    class YAMLSource
+      attr_accessor :path
+
+      def initialize path
+        @path = path
+      end
+
+      def load
+        @path && File.exist?(@path.to_s) ? YAML.safe_load(ERB.new(IO.read(@path.to_s)).result) : {}
+      rescue Psych::SyntaxError => e
+        raise "YAML syntax error occurred while parsing #{@path}. " \
+          "Error: #{e.message}"
+      end
+    end
+  end
+end

data/lib/grape_on_rails/structural_hash.rb

@@ -0,0 +1,48 @@
+require "ostruct"
+
+class GrapeOnRails::StructuralHash < OpenStruct
+  include Enumerable
+
+  def from_hash hash
+    marshal_load __convert(hash)
+  end
+
+  def to_hash
+    {}.tap do |result|
+      marshal_dump.each{|k, v| result[k] = hash_value v}
+    end
+  end
+
+  def each *args, &block
+    marshal_dump.each(*args, &block)
+  end
+
+  private
+  # Recursively converts Hashes to Options (including Hashes inside Arrays)
+  # rubocop:disable PerceivedComplexity
+  def __convert hash #:nodoc:
+    instance = self.class.new
+    hash.each do |k, v|
+      k = k.to_s if !k.respond_to?(:to_sym) && k.respond_to?(:to_s)
+      instance.new_ostruct_member k
+      if v.is_a?(Hash)
+        v = v["type"] == "hash" ? v["contents"] : __convert(v)
+      elsif v.is_a?(Array)
+        v = v.map{|e| e.instance_of?(Hash) ? __convert(e) : e}
+      end
+      instance.send "#{k}=".to_sym, v
+    end
+    instance
+  end
+  # rubocop:enable PerceivedComplexity
+
+  def hash_value value
+    if value.instance_of? GrapeOnRails::StructuralHash
+      value.to_hash
+    elsif v.instance_of? Array
+      descend_array(value)
+    else
+      value
+    end
+  end
+end

data/lib/grape_on_rails/support.rb

@@ -0,0 +1,14 @@
+require "i18n"
+
+module GrapeOnRails
+  module Support
+    def gor_translate error
+      GoR.errors.public_send(error).public_send(I18n.locale)
+    end
+    alias_method :gor_t, :gor_translate
+
+    def class_name instance
+      instance.class.name.demodulize.underscore
+    end
+  end
+end

data/lib/grape_on_rails/types/boolean.rb

@@ -0,0 +1,21 @@
+module GrapeOnRails
+  module Types
+    module Boolean
+      def to_b
+        case self
+        when "true"
+          true
+        when "false"
+          false
+        end
+      end
+    end
+  end
+end
+
+class TrueClass
+  include GrapeOnRails::Types::Boolean
+end
+class FalseClass
+  include GrapeOnRails::Types::Boolean
+end

data/lib/grape_on_rails/validator.rb

@@ -0,0 +1,37 @@
+require "grape_on_rails/macros"
+
+module GrapeOnRails
+  module Validator
+    extend ActiveSupport::Concern
+
+    include GrapeOnRails::Macros
+
+    ALLOW_ACTIONS = /(create|update|destroy|index|show)/
+
+    class_methods do
+      def validate_actions *actions
+        actions.each do |action|
+          meta_method = "before_action :validate_#{action}, only: :#{action}"
+          class_eval meta_method
+        end
+      end
+
+      def method_missing method, *args, &block
+        action = extract_action method
+        super unless action&.match? ALLOW_ACTIONS
+        define_method "hook_#{action}", block
+        class_eval <<-RUBY, __FILE__, __LINE__ + 1
+          before_action :hook_#{action}, only: :#{action}
+        RUBY
+      end
+
+      def respond_to_missing? method_name, include_private = false
+        extract_action(method_name)&.match?(ALLOW_ACTIONS) || super(method_name, include_private)
+      end
+
+      def extract_action method_name
+        method_name[/.+?(?=_params)/]
+      end
+    end
+  end
+end

data/lib/grape_on_rails/version.rb

@@ -0,0 +1,3 @@
+module GrapeOnRails
+  VERSION = "1.0.1"
+end

data/spec/grape_on_rails_spec.rb

@@ -0,0 +1,11 @@
+require "spec_helper"
+
+RSpec.describe GrapeOnRails do
+  it "has a version number" do
+    expect(GrapeOnRails::VERSION).not_to be nil
+  end
+
+  it "does something useful" do
+    expect(false).to eq(true)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+require "bundler/setup"
+require "grape_on_rails"
+
+RSpec.configure do |config|
+  # Enable flags like --only-failures and --next-failure
+  config.example_status_persistence_file_path = ".rspec_status"
+
+  # Disable RSpec exposing methods globally on `Module` and `main`
+  config.disable_monkey_patching!
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end

metadata

@@ -0,0 +1,200 @@
+--- !ruby/object:Gem::Specification
+name: grape_on_rails
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- topcbl
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-01-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Bring Grape DSL to Rails-api. Make it easier for writing api.
+email:
+- topcbl@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".rubocop_disabled.yml"
+- ".rubocop_enabled.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- grape_on_rails.gemspec
+- lib/grape_on_rails.rb
+- lib/grape_on_rails/api.rb
+- lib/grape_on_rails/api_error.rb
+- lib/grape_on_rails/attributes.rb
+- lib/grape_on_rails/authenticator.rb
+- lib/grape_on_rails/error_formatter.rb
+- lib/grape_on_rails/integrations/railtie.rb
+- lib/grape_on_rails/macros.rb
+- lib/grape_on_rails/models.rb
+- lib/grape_on_rails/models/user_actor.rb
+- lib/grape_on_rails/models/user_token_actor.rb
+- lib/grape_on_rails/secured_generator.rb
+- lib/grape_on_rails/sources/yaml_source.rb
+- lib/grape_on_rails/structural_hash.rb
+- lib/grape_on_rails/support.rb
+- lib/grape_on_rails/types/boolean.rb
+- lib/grape_on_rails/validator.rb
+- lib/grape_on_rails/version.rb
+- spec/grape_on_rails_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/chau-bao-long/grape-on-rails
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: Bring Grape DSL to Rails-api. Make it easier for writing api.
+test_files: []