grape_routes 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 27a0638e7f29ecfc8c551136283b4926ee2cc0da
+  data.tar.gz: 1031e17e301362be706c612cf311a1438a265e0d
+SHA512:
+  metadata.gz: 8fbc4ca8aaa4d199617e6bce4d4158688092358d7565885d5899eb084016804b9b51e0627f2aadddc187547d8959337e3d441b49e990b00aabf8d44eb24fd1e1
+  data.tar.gz: a3909a36c9e7f33122ec95cc59ed2a095c14986a4b48fe8a5886e37185a3875e4f11b0c5f4daf5e5ee154396b04bc2f7bfed79974904d764c1cd3ba908b6148e

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+*.swp
+*.swo
+*.swn
+*.gem

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.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+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. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Adam Pahlevi
+
+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,60 @@
+# Grape::Routes
+
+Allow you to refer to your Grape API routes as a function call.
+
+```ruby
+class UseAPI < Grape::API
+  prefix 'v1'
+  format :json
+  version 'v1', using: :header, vendor: 'myapi'
+
+  resources :user do
+    desc "create user"
+    params do
+      optional :fullname, type: String
+    end
+    post :create do
+      # your code
+    end
+  end
+end
+```
+
+You can refer to your API path as follow:
+
+```ruby
+Grape::Routes.v1_user_create_post_path
+```
+
+You can refer to list of all available routes:
+
+```ruby
+Grape::Routes.all_routes.keys
+```
+
+You can re-parse, only if you add routes on the fly, probably?
+
+```ruby
+Grape::Routes.parse!
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'grape_routes'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install grape_routes
+
+## License
+
+The gem is proudly 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/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "grape_routes"
+
+# 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

data/bin/setup

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

data/grape_routes.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'grape_routes/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "grape_routes"
+  spec.version       = GrapeRoutes::VERSION
+  spec.authors       = ["Adam Pahlevi"]
+  spec.email         = ["adam.pahlevi@gmail.com"]
+
+  spec.summary       = %q{Provide referable routing mechanism for your Grape API}
+  spec.description   = %q{Provide referable routing mechanism for your Grape API}
+  spec.homepage      = 'https://github.com/saveav/grape_routes'
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+end

data/lib/grape_routes.rb

@@ -0,0 +1,72 @@
+require "grape_routes/version"
+require "singleton"
+
+module GrapeRoutes
+end
+
+module Grape::Routes
+  class << self
+    attr_accessor :all_routes
+    attr_accessor :endpoints
+
+    def all_routes
+      parse!
+      @all_routes
+    end
+  end
+
+  # reparse everything
+  def self.parse!
+    self.endpoints = []
+    Grape::API.descendants.each { |endpoint| self.endpoints << endpoint }
+    self.endpoints.each { |endpoint| parse_endpoint(endpoint) }
+  end
+
+  def self.parse_endpoint(grape_api_class)
+    parsable_routes = {}
+    grape_api_class.routes.each do |route|
+      route_path_name = route.route_path
+      route_path_name = route_path_name.gsub(%r{^\/}, '')
+      route_path_name = route_path_name.tr('/', '_')
+      route_path_name = route_path_name.gsub(/(\(.+\))+/, '')
+      route_path_name = 'index' if route_path_name.empty?
+      route_path_name << '_' + route.route_method.to_s.downcase
+      route_path_name << '_path'
+      parsable_routes[route_path_name] = route
+    end
+
+    @all_routes = {} if @all_routes.nil?
+
+    self.class_eval do
+      parsable_routes.each do |route_path_name, route_object|
+        next if @all_routes[route_path_name]
+
+        route_path = route_object.route_path.gsub(/(\(.+\))+/, '')
+        if route_path_name =~ /:version_/i
+          route_path_name = route_path_name.gsub(/:version_/i, '')
+          @all_routes[route_path_name] = route_object
+          define_singleton_method route_path_name do |*args|
+            fail 'Pass in version' if args.length != 1
+            version = args[0]
+            route_path.gsub(':version', version)
+          end # define_singleton_method
+        else
+          @all_routes[route_path_name] = route_object
+          define_singleton_method route_path_name do
+            route_path
+          end
+        end # if check
+      end # each parsable_routes
+    end # class_eval
+  end # parse_endpoint
+
+  def self.method_missing(method_name, *args, &block) 
+    self.parse!
+    if self.respond_to?(method_name)
+      self.send(method_name)
+    else
+      super.method_missing(method_name, *args, &block)
+    end
+  end
+
+end

data/lib/grape_routes/version.rb

@@ -0,0 +1,3 @@
+module GrapeRoutes
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: grape_routes
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Adam Pahlevi
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-10-18 00:00:00.000000000 Z
+dependencies:
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Provide referable routing mechanism for your Grape API
+email:
+- adam.pahlevi@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".README.md.swp"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- grape_routes.gemspec
+- lib/.grape_routes.rb.swp
+- lib/grape_routes.rb
+- lib/grape_routes/grape_routes.rb
+- lib/grape_routes/version.rb
+homepage: https://github.com/saveav/grape_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.5
+signing_key: 
+specification_version: 4
+summary: Provide referable routing mechanism for your Grape API
+test_files: []
+has_rdoc: