grape-named_routes 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: dd79227aa5be172ce4591596d7cdd43674db8fca
+  data.tar.gz: 9be5189b0b78d9aa4b09766a4b53d28692d29654
+SHA512:
+  metadata.gz: b6701ee8075eebf50cd8ea3ec6f116124d1977ed47f93c69521c91288d4718ce9faf9c4f25991c804e266df80d6f0b9457901a92ccf6d96f63ba10a1b727c276
+  data.tar.gz: e2a19a8b6873f872cbf7d13a090fa780fd2359b2dc90c74eb1c0f50f003d810f9364f06e84d1a37ef2c6c729b8a4145e640a95c35c690c1ff209f26e6e2d6182

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.10.4

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in grape-named_routes.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Anton Chuchkalov
+
+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,77 @@
+# Grape::NamedRoutes
+
+It is an extenstion for API creating framework [Grape](https://github.com/intridea/grape).
+With this gem you can create named routes to call them later without hardcoding pathes.
+
+## Installation
+
+Add these lines to your application's Gemfile:
+
+```ruby
+gem 'grape'
+gem 'grape-named_routes'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install grape
+    $ gem install grape-named_routes
+
+## Usage
+
+These endpoints simply return their URLs.
+
+```ruby
+module Twitter
+  class API < Grape::API
+    resource :statuses do
+      desc 'Endpoint without params'
+      get :home_timeline, as: :home_timeline do
+        Twitter::API.home_timeline_path
+      end
+
+      desc 'Endpoint with route param'
+      params do
+        requires :id, type: Integer
+      end
+      route_param :id do
+        get as: :status do
+          Twitter::API.status_path(id: params[:id])
+        end
+      end
+
+      desc 'Endpoint with inline param'
+      params do
+        requires :param, type: String
+      end
+      get '/custom_route/:param', as: :inline do
+        Twitter::API.inline_path(param: params[:param])
+      end
+    end
+  end
+end
+```
+
+If you somewhy need to get `endpoint` object instead of compiled path, you can use following:
+
+```ruby
+  Twitter::API.find_endpoint(:home_timeline) # returns Grape::Endpoint instance
+
+  # also supports "dangerous" version (raises an error if route is not declared)
+  Twitter::API.find_endpoint!(:home_timeline)
+```
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/hedgesky/grape-named_routes.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

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

data/grape-named_routes.gemspec

@@ -0,0 +1,25 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'grape/named_routes/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'grape-named_routes'
+  spec.version       = Grape::NamedRoutes::VERSION
+  spec.authors       = ['Anton Chuchkalov']
+  spec.email         = ['a2new@yandex.ru']
+
+  spec.summary       = %q{Add support for named routes in grape.}
+  spec.description   = %q{This implementation is really simple and not very dynamic, but may be handy.}
+  spec.homepage      = 'https://github.com/hedgesky/grape-named_routes'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'grape', '>= 0.11'
+
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

data/lib/grape/named_routes.rb

@@ -0,0 +1,4 @@
+require 'grape/named_routes/version'
+require 'grape/named_routes/reopened_classes/grape'
+require 'grape/named_routes/reopened_classes/api'
+

data/lib/grape/named_routes/missed_required_param.rb

@@ -0,0 +1,11 @@
+module Grape
+  module NamedRoutes
+    class MissedRequiredParam < StandardError
+      attr_reader :missed_param
+
+      def initialize(param)
+        @missed_param = param
+      end
+    end
+  end
+end

data/lib/grape/named_routes/named_path_helper.rb

@@ -0,0 +1,45 @@
+module Grape
+  module NamedRoutes
+    module NamedPathHelper
+      def get_named_path(route_name, route_params = {})
+        endpoint = named_route_seeker.find_endpoint!(route_name)
+        NamedRoutes::PathCompiler.compile_path(endpoint.routes.first, route_params)
+      end
+
+      def find_endpoint(route_name)
+        named_route_seeker.find_endpoint(route_name)
+      end
+
+      def find_endpoint!(route_name)
+        named_route_seeker.find_endpoint!(route_name)
+      end
+
+      def method_missing(method_name, *arguments)
+        if method_is_named_path?(method_name)
+          route_name = method_name.to_s.sub(/_path$/, '')
+          get_named_path(route_name, arguments.first || {})
+        else
+          super
+        end
+      end
+
+      def respond_to_missing?(method_name, include_private = false)
+        method_is_named_path?(method_name) || super
+      end
+
+      private
+
+      def named_route_seeker
+        @named_route_seeker ||= NamedRoutes::NamedRouteSeeker.new(self)
+      end
+
+      def method_is_named_path?(method_name)
+        if method_name.to_s.end_with?('_path')
+          route_name = method_name.to_s.sub(/_path$/, '')
+          return true if named_route_seeker.named_endpoint_present?(route_name)
+        end
+        false
+      end
+    end
+  end
+end

data/lib/grape/named_routes/named_route_not_found.rb

@@ -0,0 +1,11 @@
+module Grape
+  module NamedRoutes
+    class NamedRouteNotFound < StandardError
+      attr_reader :missed_route
+
+      def initialize(route_name)
+        @missed_route = route_name
+      end
+    end
+  end
+end

data/lib/grape/named_routes/named_route_seeker.rb

@@ -0,0 +1,39 @@
+module Grape
+  module NamedRoutes
+    class NamedRouteSeeker
+      def initialize(app)
+        @app = app
+      end
+
+      def find_endpoint(name)
+        name_to_endpoint_hash[name.to_sym]
+      end
+
+      def find_endpoint!(name)
+        fail NamedRouteNotFound.new(name), "Named route '#{name}' is missed." unless named_endpoint_present?(name)
+        find_endpoint(name)
+      end
+
+
+      def named_endpoint_present?(name)
+        name_to_endpoint_hash.key?(name.to_sym)
+      end
+
+      private
+
+      def named_endpoints
+        @named_endpoints ||= @app.endpoints.select do |endpoint|
+          endpoint.options[:route_options].key?(:as)
+        end
+      end
+
+      def name_to_endpoint_hash
+        @name_to_endpoint_hash ||= named_endpoints.inject({}) do |hash, endpoint|
+          endpoint_name = endpoint.options[:route_options][:as].to_sym
+          hash[endpoint_name] = endpoint
+          hash
+        end
+      end
+    end
+  end
+end

data/lib/grape/named_routes/path_compiler.rb

@@ -0,0 +1,49 @@
+module Grape
+  module NamedRoutes
+    module PathCompiler
+      class << self
+        # this method substitutes given params to route path
+        def compile_path(route, params = {})
+          path_with_optional_params = substitute_optional_params(route.route_path, params)
+          substitute_required_params(path_with_optional_params, params)
+        end
+
+        private
+
+        def substitute_optional_params(path, params)
+          # explanation for regexp below: we seek parenthesis
+          # with string like :string in them (possibly appended and/or prepended with smth)
+          #
+          # for example, for string '/api/statuses/:id/(.:format)'
+          #   match[1] will be '.'
+          #   match[2] will be param_value(params, format)
+          #   match[3] will be nil
+          #
+          # It could be rewrote with $1,$2,$3, but Rubocop doesn't like these variables
+          optional_params_regexp = /\((.*):(\w+)(.*)\)/
+
+          path.gsub(optional_params_regexp) do
+            match = Regexp.last_match
+            value = param_value(params, match[2])
+            [match[1], value, match[3]].join if value
+          end
+        end
+
+        def substitute_required_params(path, params)
+          path.gsub(/:(\w+)/) do
+            param = Regexp.last_match[1]
+            value = param_value(params, param)
+            unless value
+              fail Grape::NamedRoutes::MissedRequiredParam.new(param), "Required param '#{param}' is missed."
+            end
+            value
+          end
+        end
+
+        def param_value(params, param)
+          params[param] || params[param.to_sym]
+        end
+      end
+    end
+  end
+end

data/lib/grape/named_routes/reopened_classes/api.rb

@@ -0,0 +1,13 @@
+module Grape
+  class API
+    extend NamedRoutes::NamedPathHelper
+
+    class << self
+      alias_method :original_reset!, :reset!
+      def reset!
+        original_reset!
+        @named_route_seeker = nil
+      end
+    end
+  end
+end

data/lib/grape/named_routes/reopened_classes/grape.rb

@@ -0,0 +1,11 @@
+require 'active_support/dependencies/autoload'
+module Grape
+  module NamedRoutes
+    extend ActiveSupport::Autoload
+    autoload :NamedRouteNotFound
+    autoload :NamedRouteSeeker
+    autoload :PathCompiler
+    autoload :MissedRequiredParam
+    autoload :NamedPathHelper
+  end
+end

data/lib/grape/named_routes/version.rb

@@ -0,0 +1,5 @@
+module Grape
+  module NamedRoutes
+    VERSION = '0.1.0'
+  end
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: grape-named_routes
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Anton Chuchkalov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-06-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: grape
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.11'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: This implementation is really simple and not very dynamic, but may be
+  handy.
+email:
+- a2new@yandex.ru
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- grape-named_routes.gemspec
+- lib/grape/named_routes.rb
+- lib/grape/named_routes/missed_required_param.rb
+- lib/grape/named_routes/named_path_helper.rb
+- lib/grape/named_routes/named_route_not_found.rb
+- lib/grape/named_routes/named_route_seeker.rb
+- lib/grape/named_routes/path_compiler.rb
+- lib/grape/named_routes/reopened_classes/api.rb
+- lib/grape/named_routes/reopened_classes/grape.rb
+- lib/grape/named_routes/version.rb
+homepage: https://github.com/hedgesky/grape-named_routes
+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.4.8
+signing_key: 
+specification_version: 4
+summary: Add support for named routes in grape.
+test_files: []
+has_rdoc: