grape-route-helpers 1.0.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7faecd03e24a18fca8562818d59b4013fd20e7a0
-  data.tar.gz: 59813a8cd72952eed995fe2b4e5111a64ad7312e
+  metadata.gz: 6c89b2de6b727ea2d4e1953bca91338051e68e86
+  data.tar.gz: e2706efbbd654e9b1e19cb9f43fa2dee2e03bd5d
 SHA512:
-  metadata.gz: d2412a7a01687166ba0730618233df42c34efb7f90500183543acd4fe09195879421e4029c34610e8cb64448e2bf338fe54fc73c6728571aede71fa0f46f8909
-  data.tar.gz: 13d916287f03d1a7b3656c3e669786cda7ef8dd28fd827681d3ae3c71b97aeb11b37aef85c70d11ec5b0ab68ae956636b1c054039f571f42c2ca660036de6f88
+  metadata.gz: 55a16e85e81fb667b224884f7d54a2e9c833728d62b37862769123e90f2caa4cbd5b123329efe83235c0de6e2b010bea93e8ceba7d6a2152a36b84ad2bb2fb10
+  data.tar.gz: 50d1900fb057a31219f2fe58b7f2aaf683f5ed717391e6bd4428fd766f69925e2433feb1e221a5dc2ff3909a34b381e214a7243f316ce644af2b5c83bd23c6cc

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Changelog
 
+## 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

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    grape-route-helpers (1.0.1)
+    grape-route-helpers (1.2.0)
       activesupport
       grape
       rake
@@ -46,7 +46,7 @@ GEM
     json (1.8.3)
     method_source (0.8.2)
     minitest (5.7.0)
-    multi_json (1.11.1)
+    multi_json (1.11.2)
     multi_xml (0.5.5)
     parser (2.3.0.pre.2)
       ast (>= 1.1, < 3.0)
@@ -100,3 +100,6 @@ DEPENDENCIES
   pry
   rspec
   rubocop
+
+BUNDLED WITH
+   1.10.6

data/README.md

@@ -45,14 +45,19 @@ task :environment do
 end
 ```
 
-### Usage examples
+### 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 Your API
+
 Use the methods inside your Grape API actions. Given this example API:
 
 ```ruby
@@ -92,6 +97,9 @@ 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'
 
@@ -99,6 +107,39 @@ api_v1_cats_path(id: 1) # => '/api/v1/cats/1.json'
 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 you the route helpers in our 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

data/lib/grape-route-helpers/all_routes.rb

@@ -9,7 +9,12 @@ module GrapeRouteHelpers
     end
 
     def all_routes
-      subclasses.flat_map { |s| s.send(:prepare_routes) }
+      routes = subclasses.flat_map { |s| s.send(:prepare_routes) }
+      # delete duplicate routes
+      routes.delete_if do |route|
+        all_options = routes.map { |r| r.instance_variable_get(:@options) }
+        all_options.count(route.instance_variable_get(:@options)) > 1
+      end
     end
   end
 end

data/lib/grape-route-helpers/decorated_route.rb

@@ -1,10 +1,12 @@
 module GrapeRouteHelpers
   # wrapper around Grape::Route that adds a helper method
   class DecoratedRoute
-    attr_reader :route, :helper_names, :helper_arguments, :extension
+    attr_reader :route, :helper_names, :helper_arguments,
+                :extension, :route_options
 
     def initialize(route)
       @route = route
+      @route_options = route.instance_variable_get(:@options)
       @helper_names = []
       @helper_arguments = required_helper_segments
       @extension = default_extension
@@ -39,15 +41,24 @@ module GrapeRouteHelpers
             #{route_attributes}.merge(attributes)
           )
 
+          query_params = attrs.delete(:params)
           content_type = attrs.delete(:format)
           path = '/' + path_segments_with_values(attrs).join('/')
 
-          path + content_type
+          path + content_type + query_string(query_params)
         end
       RUBY
       instance_eval method_body
     end
 
+    def query_string(params)
+      if params.nil?
+        ''
+      else
+        '?' + params.to_param
+      end
+    end
+
     def route_versions
       if route_version
         route_version.split('|')
@@ -57,13 +68,18 @@ module GrapeRouteHelpers
     end
 
     def path_helper_name(opts = {})
-      segments = path_segments_with_values(opts)
+      if route.route_as
+        name = route.route_as.to_s
+      else
+        segments = path_segments_with_values(opts)
+
+        name = if segments.empty?
+                 'root'
+               else
+                 segments.join('_')
+               end
+      end
 
-      name = if segments.empty?
-               'root'
-             else
-               segments.join('_')
-             end
       name + '_path'
     end
 
@@ -108,39 +124,34 @@ module GrapeRouteHelpers
       dynamic_path_segments - segments_in_options
     end
 
-    def optional_segments
-      ['format']
+    def special_keys
+      %w(format params)
     end
 
     def uses_segments_in_path_helper?(segments)
-      requested = segments - optional_segments
-      required = required_helper_segments
+      segments = segments.reject { |x| special_keys.include?(x) }
 
-      if requested.empty? && required.empty?
-        true
+      if required_helper_segments.empty? && segments.any?
+        false
       else
-        requested.all? do |segment|
-          required.include?(segment)
-        end
+        required_helper_segments.all? { |x| segments.include?(x) }
       end
     end
 
-    # accessing underlying Grape::Route
-
     def route_path
-      route.route_path
-    end
-
-    def route_options
-      route.instance_variable_get(:@options)
+      route_options[:path]
     end
 
     def route_version
-      route.route_version
+      route_options[:version]
     end
 
     def route_namespace
-      route.route_namespace
+      route_options[:namespace]
+    end
+
+    def route_method
+      route_options[:method]
     end
   end
 end

data/lib/grape-route-helpers/route_displayer.rb

@@ -6,6 +6,7 @@ module GrapeRouteHelpers
       Grape::API.decorated_routes.map do |route|
         {
           route_path: route.route_path,
+          route_method: route.route_method,
           helper_names: route.helper_names,
           helper_arguments: route.helper_arguments
         }
@@ -15,6 +16,7 @@ module GrapeRouteHelpers
     def display
       puts("== GRAPE ROUTE HELPERS ==\n\n")
       route_attributes.each do |attributes|
+        printf("%s: %s\n", 'Verb', attributes[:route_method])
         printf("%s: %s\n", 'Path', attributes[:route_path])
         printf("%s: %s\n",
                'Helper Method',

data/lib/grape-route-helpers/version.rb

@@ -1,4 +1,4 @@
 # Gem version
 module GrapeRouteHelpers
-  VERSION = '1.0.1'
+  VERSION = '1.2.0'
 end

data/spec/grape_route_helpers/all_routes.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+describe GrapeRouteHelpers::AllRoutes do
+  Grape::API.extend described_class
+
+  describe '#all_routes' do
+    context 'when API is mounted within another API' do
+      let(:mounting_api) { Spec::Support::RouteMatcherHelpers.mounting_api }
+
+      it 'does not include the same route twice' do
+        mounting_api
+
+        # A route is unique if no other route shares the same set of options
+        all_route_options = Grape::API.all_routes.map do |r|
+          r.instance_variable_get(:@options)
+        end
+
+        duplicates = all_route_options.select do |o|
+          all_route_options.count(o) > 1
+        end
+
+        expect(duplicates).to be_empty
+        expect(all_route_options.size).to eq(5)
+      end
+    end
+  end
+end

data/spec/grape_route_helpers/decorated_route_spec.rb

@@ -21,7 +21,24 @@ describe GrapeRouteHelpers::DecoratedRoute do
     routes.detect { |route| route.route_path =~ /\*/ }
   end
 
+  let(:custom_route) do
+    routes.detect { |route| route.route_path =~ /custom_name/ }
+  end
+
   describe '#helper_names' do
+    context 'when a route is given a custom helper name' do
+      it 'uses the custom name instead of the dynamically generated one' do
+        expect(custom_route.helper_names.first)
+          .to eq('my_custom_route_name_path')
+      end
+
+      it 'returns the correct path' do
+        expect(
+          custom_route.my_custom_route_name_path
+        ).to eq('/api/v1/custom_name.json')
+      end
+    end
+
     context 'when an API has multiple versions' do
       let(:api_versions) { %w(beta alpha v1) }
 
@@ -132,6 +149,23 @@ describe GrapeRouteHelpers::DecoratedRoute do
   end
 
   describe 'path helper method' do
+    context 'when given a "params" key' do
+      context 'when value under "params" key is a hash' do
+        it 'creates a query string' do
+          query = { foo: :bar, baz: :zot }
+          path = index_route.api_v1_cats_path(params:  query)
+          expect(path).to eq('/api/v1/cats.json?' + query.to_param)
+        end
+      end
+
+      context 'when value under "params" is not a hash' do
+        it 'coerces the value into a string' do
+          path = index_route.api_v1_cats_path(params:  1)
+          expect(path).to eq('/api/v1/cats.json?1')
+        end
+      end
+    end
+
     # handle different Grape::Route#route_path formats in Grape 0.12.0
     context 'when route_path contains a specific format' do
       it 'returns the correct path with the correct format' do

data/spec/grape_route_helpers/named_route_matcher_spec.rb

@@ -160,5 +160,17 @@ describe GrapeRouteHelpers::NamedRouteMatcher do
         expect(index_path).to eq('/api/v1/cats.json')
       end
     end
+
+    context 'when query params are passed in' do
+      it 'uses arguments to infer which route to use' do
+        api
+
+        show_path = api_v1_cats_path('id' => 1, params: { 'foo' => 'bar' })
+        expect(show_path).to eq('/api/v1/cats/1.json?foo=bar')
+
+        index_path = api_v1_cats_path(params: { 'foo' => 'bar' })
+        expect(index_path).to eq('/api/v1/cats.json?foo=bar')
+      end
+    end
   end
 end

data/spec/support/route_matcher_helpers.rb

@@ -8,6 +8,10 @@ module Spec
           prefix 'api'
           format 'json'
 
+          get 'custom_name', as: :my_custom_route_name do
+            'hello'
+          end
+
           get 'ping' do
             'pong'
           end
@@ -29,6 +33,12 @@ module Spec
           end
         end
       end
+
+      def self.mounting_api
+        Class.new(Grape::API) do
+          mount Spec::Support::RouteMatcherHelpers.api
+        end
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grape-route-helpers
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Harper Henn
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-29 00:00:00.000000000 Z
+date: 2015-09-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grape
@@ -118,6 +118,7 @@ files:
 - lib/grape-route-helpers/version.rb
 - lib/grape/route_helpers.rb
 - lib/tasks/grape_route_helpers.rake
+- spec/grape_route_helpers/all_routes.rb
 - spec/grape_route_helpers/decorated_route_spec.rb
 - spec/grape_route_helpers/named_route_matcher_spec.rb
 - spec/spec_helper.rb