grape-path-helpers 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0cce4a208f0d1e34b8a35da84f34d2ffa02bc7e4
+  data.tar.gz: c7363febba8def48120a68779cf9d097fec7b8e2
+SHA512:
+  metadata.gz: e8e1650bc433de578ef57e8d91fcdf31e94542545a12fccb69040d6094b9b1188404b9b6ed8956d59f4f6b26274434b71795176024d4bf99b82c1cf3f155bd03
+  data.tar.gz: 1b65db4108966fee07ccaf91931672e1c6fb01ae918a8a52c3057e2f34da3d25725408ad97376f9b268fd7e7c46c5e4551dadf44239902df79f5245bacf6979e

data/.gitignore

@@ -0,0 +1,3 @@
+*.swp
+*.gem
+.ruby-version

data/.gitlab-ci.yml

@@ -0,0 +1,18 @@
+image: "ruby:2.4-alpine"
+
+cache:
+  paths:
+    - vendor/ruby
+
+before_script:
+  - apk add --update git
+  - gem install bundler
+  - bundle install
+
+rubocop:
+  script:
+    - rubocop
+
+rspec:
+  script:
+    - bundle exec rspec spec

data/.rubocop.yml

@@ -0,0 +1,10 @@
+Metrics/ClassLength:
+  Max: 104
+  Enabled: false
+
+Metrics/MethodLength:
+  Max: 21
+  Enabled: false
+
+Style/FileName:
+ Enabled: false

data/.travis.yml

@@ -0,0 +1,18 @@
+language: ruby
+
+cache: bundler
+
+rvm:
+  - ruby-head
+  - 2.3.0
+  - 2.2.0
+  - 2.1.0
+  - 2.0.0
+  - 1.9.3
+  - jruby-19mode
+  - jruby-head
+
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+    - rvm: jruby-head

data/CHANGELOG.md

@@ -0,0 +1,42 @@
+# Changelog
+
+## December 17 2016
+
+* Bump to 2.1.0
+* Fix bug that caused POST routes to be ignored if more than one was defined
+* Many thanks to @njd5475 for the bug report and pull request that helped me write this
+
+## April 28 2016
+
+* Release 2.0.0
+* Fix incompatibility between grape-route-helpers and grape 0.16.0
+
+## April 11 2016
+
+* Release 1.2.2
+* Fixed incompatibility between grape-route-helpers and Ruby 2.3 by merging PR #8 from phallguy
+
+## October 11 2015
+
+* Release 1.2.1
+* Fixed issue #4
+
+## September 27 2015
+
+* Release 1.2.0
+
+* You can now assign custom helper names to Grape routes
+* Fixed a bug where routes would be listed more than once in the rake task if they are mounted to another API
+* Added the HTTP verb to rake task output
+
+## July 5 2015
+
+* You can now pass query parameters to helper functions in order to generate your own query string (Issue #1)
+
+## June 28 2015
+
+Release 1.0.1
+
+* Rename rake task from `grape:routes` to `grape:route_helpers`
+
+* If a Grape::Route has a specific format (json, etc.) in its route_path attribute, the helper will return a path with this extension at the end

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,99 @@
+PATH
+  remote: .
+  specs:
+    grape-path-helpers (1.0.0)
+      activesupport
+      grape (~> 1.0)
+      rake
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (5.2.0)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    ast (2.4.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.3)
+    coderay (1.1.2)
+    coercible (1.0.0)
+      descendants_tracker (~> 0.0.1)
+    concurrent-ruby (1.0.5)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
+    diff-lcs (1.3)
+    equalizer (0.0.11)
+    grape (1.0.2)
+      activesupport
+      builder
+      mustermann-grape (~> 1.0.0)
+      rack (>= 1.3.0)
+      rack-accept
+      virtus (>= 1.0.0)
+    i18n (1.0.1)
+      concurrent-ruby (~> 1.0)
+    ice_nine (0.11.2)
+    method_source (0.9.0)
+    minitest (5.11.3)
+    mustermann (1.0.2)
+    mustermann-grape (1.0.0)
+      mustermann (~> 1.0.0)
+    parallel (1.12.1)
+    parser (2.5.1.0)
+      ast (~> 2.4.0)
+    powerpack (0.1.1)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rack (2.0.5)
+    rack-accept (0.4.5)
+      rack (>= 0.4)
+    rainbow (3.0.0)
+    rake (12.3.1)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    rubocop (0.55.0)
+      parallel (~> 1.10)
+      parser (>= 2.5)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.9.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.3.2)
+    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
+  grape-path-helpers!
+  pry
+  rspec
+  rubocop
+
+BUNDLED WITH
+   1.16.2

data/LICENSE.txt

@@ -0,0 +1,22 @@
+MIT License (MIT)
+
+Copyright (c) 2015 Harper Henn
+
+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,172 @@
+# grape-route-helpers
+
+[![Build Status](https://travis-ci.org/reprah/grape-route-helpers.svg)](https://travis-ci.org/reprah/grape-route-helpers)
+
+Provides named route helpers for Grape APIs, similar to [Rails' route helpers](http://edgeguides.rubyonrails.org/routing.html#path-and-url-helpers).
+
+### Installation
+
+#### Compatibility with Grape
+
+If you're using grape 0.16.0 or higher, you'll need version 2.0.0 or higher of grape-route-helpers.
+
+#### Rails
+
+ 1.) Add the gem to your Gemfile.
+
+```bash
+$ bundle install grape-route-helpers
+```
+
+#### Sinatra/Rack
+
+1.) Add the gem to your Gemfile if you're using Bundler.
+
+If you're not using Bundler to install/manage dependencies:
+
+```bash
+$ gem install grape-route-helpers
+```
+
+```ruby
+# environment setup file
+require 'grape'
+require 'grape/route_helpers'
+```
+
+2.) Write a rake task called `:environment` that loads the application's environment first. This gem's tasks are dependent on it. You could put this in the root of your project directory:
+
+```ruby
+# Rakefile
+
+require 'rake'
+require 'bundler'
+Bundler.setup
+require 'grape-route-helpers'
+require 'grape-route-helpers/tasks'
+
+desc 'load the Sinatra environment.'
+task :environment do
+  require File.expand_path('your_app_file', File.dirname(__FILE__))
+end
+```
+
+### Usage
+
+#### List All Helper Names
+
+To see which methods correspond to which paths, and which options you can pass them:
+
+```bash
+# In your API root directory, at the command line
+$ rake grape:route_helpers
+```
+
+#### Use Helpers in IRB/Pry
+
+You can use helper methods in your REPL session by including a module:
+
+```ruby
+[1] pry(main)> include GrapeRouteHelpers::NamedRouteMatcher
+```
+#### Use Helpers in Your API
+
+Use the methods inside your Grape API actions. Given this example API:
+
+```ruby
+class ExampleAPI < Grape::API
+  version 'v1'
+  prefix 'api'
+  format 'json'
+
+  get 'ping' do
+    'pong'
+  end
+
+  resource :cats do
+    get '/' do
+      %w(cats cats cats)
+    end
+
+    route_param :id do
+      get do
+        'cat'
+      end
+    end
+  end
+
+  route :any, '*anything' do
+    redirect api_v1_cats_path
+  end
+end
+```
+
+You'd have the following methods available inside your Grape API actions:
+
+```ruby
+# specifying the version when using Grape's "path" versioning strategy
+api_v1_ping_path # => '/api/v1/ping.json'
+
+# specifying the format
+api_v1_cats_path(format: '.xml') # => '/api/v1/cats.xml'
+
+# adding a query string
+api_v1_cats_path(params: { sort_by: :age }) # => '/api/v1/cats?sort_by=age'
+
+# passing in values required to build a path
+api_v1_cats_path(id: 1) # => '/api/v1/cats/1.json'
+
+# catch-all paths have helpers
+api_v1_anything_path # => '/api/v1/*anything'
+```
+
+#### Custom Helper Names
+
+If you want to assign a custom helper name to a route, pass the `:as` option when creating your route in your API:
+
+```ruby
+class Base < Grape::API
+  get 'ping', as: 'is_the_server_running'
+    'pong'
+  end
+end
+```
+
+This results in creating a helper called `is_the_server_running_path`.
+
+#### Testing
+
+You can use route helpers in your API tests by including the `GrapeRouteHelpers::NamedRouteMatcher` module inside your specs. Here's an example:
+
+```ruby
+require 'spec_helper'
+
+describe Api::Base do
+  include GrapeRouteHelpers::NamedRouteMatcher
+
+  describe 'GET /ping' do
+    it 'returns a 200 OK' do
+      get api_v2_ping_path
+      expect(response.status).to be(200)
+    end
+  end
+end
+```
+
+### Contributing
+
+1.) Fork it
+
+2.) Create your feature branch `(git checkout -b my-new-feature)`
+
+3.) Write specs for your feature
+
+4.) Commit your changes `(git commit -am 'Add some feature')`
+
+5.) Push to the branch `(git push origin my-new-feature)`
+
+6.) Create a new pull request
+
+### License
+
+See LICENSE

data/Rakefile

@@ -0,0 +1,17 @@
+require 'rubygems'
+require 'bundler'
+
+Bundler.setup :default, :test, :development
+
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+end
+
+task :spec
+
+require 'rainbow/ext/string' unless String.respond_to?(:color)
+
+task default: [:spec]

data/grape-path-helpers.gemspec

@@ -0,0 +1,21 @@
+require File.join(Dir.pwd, 'lib', 'grape-path-helpers', 'version')
+
+Gem::Specification.new do |gem|
+  gem.name        = 'grape-path-helpers'
+  gem.version     = GrapePathHelpers::VERSION
+  gem.licenses    = ['MIT']
+  gem.summary     = 'Route path helpers for Grape'
+  gem.description = 'Route path helpers for Grape'
+  gem.authors     = ['Drew Blessing', 'Harper Henn']
+  gem.email       = ''
+  gem.files       = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  gem.homepage    = 'https://github.com/gitlab/grape-path-helpers'
+
+  gem.add_runtime_dependency 'activesupport'
+  gem.add_runtime_dependency 'grape', '~> 1.0'
+  gem.add_runtime_dependency 'rake'
+
+  gem.add_development_dependency 'pry'
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'rubocop'
+end