grape-apiary 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0c535957d744ce50ef0823e96f87088da6bdb8af
-  data.tar.gz: 2f22cc9d1d0cab9c76ecaca3e89d5bc1eefc72c4
+  metadata.gz: d2c1b3556b4fefbfcfbb7ea54fee65c68b37f64e
+  data.tar.gz: 1707ad4ad0b7bab8b79b702e934744a697033459
 SHA512:
-  metadata.gz: d655a2ce3bbeca4e03e723ccd76953976bdc0737f999e6f83d03964d9aa6d5ff11875b52006fd126531f09b5c5aa7d50c68a60bb2a1205adc836147ce541d8be
-  data.tar.gz: 2d43246e7094620591d2d7c7465a54200f75792baeab538a670e8e113f9327f027db59ee6297b90760bbb568e5b91746f536d1fb2b506f77378170c4b4145c10
+  metadata.gz: c2681493022439dd8bddacaa3ac6e5cd7528fa8022eae5edbc91d1a25f54006037713fc9c71eeb38053fd4adbe4581318dc1122d5d53bc71d612d6f72972c8ad
+  data.tar.gz: 5a34bc8a197ff3a124bf4ec4623a19e796928548cc304e1ff2f5e238edf3a4f6fa3ce0e719f35d02faddc144434ec96d9fa153ad505174585cce347e035537f8

data/.rubocop.yml

@@ -37,7 +37,7 @@ Style/ElseAlignment:
   Enabled: false
 
 Lint/EndAlignment:
-  AlignWith: variable
+  EnforcedStyleAlignWith: variable
 
 ClassAndModuleChildren:
   # ok to use compact style when modules are predefined.
@@ -46,3 +46,9 @@ ClassAndModuleChildren:
   #
   # class Foo::Bar; end
   Enabled: false
+
+Metrics/BlockLength:
+  # Certain DSL use blocks and can be lengthy
+  Exclude:
+    - 'grape-apiary.gemspec'
+    - 'spec/**/*'

data/.travis.yml

@@ -1,9 +1,11 @@
 language: ruby
+before_install:
+  - gem update --system
 cache: bundler
 rvm:
-  - 2.3.0
-  - 2.2.4
-  - 2.1.8
-  - jruby
+  - 2.4.0
+  - 2.3.3
+  - 2.2.6
+  - jruby-9.1.2.0
 env:
   - CODECLIMATE_REPO_TOKEN=7522ea83858a08d70747c1f5fb0593502ca0e43c18b6a124dbeb72a0b0e78262

data/CHANGELOG.md

@@ -2,16 +2,29 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
-## 0.1.1 (2016-01-25)
+## Recent updates
+
+## 0.2.0 (2017-02-21)
+
+#### Maintenance
+
+- [PR #14](https://github.com/technekes/grape-apiary/pull/14) - Update supported Ruby versions and dependencies [@jallen3d](https://github.com/johnallen3d).
+- [PR #13](https://github.com/technekes/grape-apiary/pull/13) - Update grape gem requirement to at least 0.16 [@rubensmabueno](https://github.com/rubensmabueno).
+
+## 0.1.2 (2016-01-25)
+
 #### Hotfix
+
 - Lock down grape dependency to prior to 0.16 because of internal change [@jallen3d](https://github.com/johnallen3d).
 
-## 0.1.1 (2016-01-25)
 #### Fixes
+
 - [PR #8](https://github.com/technekes/grape-apiary/pull/8) - Handle mixed keys (symbol/string) in params [@jallen3d](https://github.com/johnallen3d).
 
 ## 0.1.0 (2016-01-25)
+
 #### Features
+
 - [PR #5](https://github.com/technekes/grape-apiary/pull/5) - Rake task persists docs to disk from [@bigfleet](https://github.com/bigfleet).
 
 ## 0.0.1 - 0.0.4 (2014-02-10)

data/README.md

@@ -3,10 +3,10 @@
 [![Code Climate](https://codeclimate.com/github/technekes/grape-apiary/badges/gpa.svg)](https://codeclimate.com/github/technekes/grape-apiary)
 [![Build Status](https://travis-ci.org/technekes/grape-apiary.svg?branch=master)](https://travis-ci.org/technekes/grape-apiary)
 [![Test Coverage](https://codeclimate.com/github/technekes/grape-apiary/badges/coverage.svg)](https://codeclimate.com/github/technekes/grape-apiary/coverage)
-[![Dependency Status](https://gemnasium.com/technekes/grape-apiary.png)](https://gemnasium.com/connexio-labs/grape-apiary)
+[![Dependency Status](https://gemnasium.com/technekes/grape-apiary.png)](https://gemnasium.com/technekes/grape-apiary)
 [![Gem Version](https://badge.fury.io/rb/grape-apiary.png)](http://badge.fury.io/rb/grape-apiary)
 
-Auto generates an [Apiary Blueprint](http://apiary.io) from the docuementation that is created by your [Grape](https://github.com/ruby-grape/grape) API.
+Auto generates an [Apiary Blueprint](http://apiary.io) from the documentation that is created by your [Grape](https://github.com/ruby-grape/grape) API.
 
 ## Installation
 

data/grape-apiary.gemspec

@@ -25,7 +25,7 @@ Gem::Specification.new do |spec|
     docuementation that is created by your Grape API
   DESCRIPTION
 
-  spec.add_runtime_dependency 'grape', '>= 0.14', '< 0.16'
+  spec.add_runtime_dependency 'grape', '>= 0.16.0', '<= 0.19.1'
   spec.add_runtime_dependency 'activesupport'
 
   spec.add_development_dependency 'codeclimate-test-reporter', '~> 0.4'

data/lib/grape-apiary/blueprint.rb

@@ -47,7 +47,7 @@ module GrapeApiary
     end
 
     def show_request_sample?(route)
-      %w(PUT POST).include?(route.route_method)
+      %w(PUT POST).include?(route.request_method)
     end
 
     private

data/lib/grape-apiary/parameter.rb

@@ -2,7 +2,7 @@ module GrapeApiary
   class Parameter
     attr_reader :route, :full_name, :name, :settings
 
-    delegate :route_model, :route_namespace, to: :route
+    delegate :route_model, :namespace, to: :route
     delegate :requirement, :type, :documentation, :desc, to: :settings
     delegate :example, to: :documentation, allow_nil: true
 

data/lib/grape-apiary/resource.rb

@@ -14,13 +14,13 @@ module GrapeApiary
     end
 
     def namespaced
-      @namespaced ||= routes.group_by(&:route_namespace).map do |_, routes|
+      @namespaced ||= routes.group_by(&:namespace).map do |_, routes|
         Resource.new(name, routes)
       end
     end
 
     def paths
-      @paths ||= routes.group_by(&:route_path_without_format).map do |_, routes|
+      @paths ||= routes.group_by(&:path_without_format).map do |_, routes|
         Resource.new(name, routes)
       end
     end
@@ -29,7 +29,7 @@ module GrapeApiary
       # TODO: ???
       route = routes.first
 
-      "#{title} #{route.route_type} [#{route.route_path_without_format}]"
+      "#{title} #{route.route_type} [#{route.path_without_format}]"
     end
 
     def sample_request
@@ -46,11 +46,11 @@ module GrapeApiary
       methods = %w(POST PUT)
 
       potential = routes.select do |route|
-        methods.include?(route.route_method) && route.route_params.present?
+        methods.include?(route.request_method) && route.params.present?
       end
 
       if potential.present?
-        potential.first.route_params
+        potential.first.params
       else
         []
       end

data/lib/grape-apiary/route.rb

@@ -2,31 +2,31 @@ module GrapeApiary
   class Route < SimpleDelegator
     # would like to rely on SimpleDelegator but Grape::Route uses
     # method_missing for these methods :'(
-    delegate :route_namespace, :route_path, :route_method, to: '__getobj__'
+    delegate :namespace, :path, :request_method, to: '__getobj__'
 
-    def route_params
-      @route_params ||= begin
-        __getobj__.route_params.stringify_keys.sort.map do |param|
+    def params
+      @params ||= begin
+        __getobj__.params.stringify_keys.sort.map do |param|
           Parameter.new(self, *param)
         end
       end
     end
 
     def route_name
-      route_namespace.split('/').last ||
-        route_path.match('\/(\w*?)[\.\/\(]').captures.first
+      namespace.split('/').last ||
+        path.match('\/(\w*?)[\.\/\(]').captures.first
     end
 
-    def route_description
-      "#{__getobj__.route_description} [#{route_method.upcase}]"
+    def description
+      "#{__getobj__.description} [#{request_method.upcase}]"
     end
 
-    def route_path_without_format
-      route_path.gsub(/\((.*?)\)/, '')
+    def path_without_format
+      path.gsub(/\((.*?)\)/, '')
     end
 
     def route_model
-      route_namespace.split('/').last.singularize
+      namespace.split('/').last.singularize
     end
 
     def route_type
@@ -38,19 +38,19 @@ module GrapeApiary
     end
 
     def response_description
-      code = route_method == 'POST' ? 201 : 200
+      code = request_method == 'POST' ? 201 : 200
 
       "+ Response #{code} (application/json)"
     end
 
     def list?
-      %w(GET POST).include?(route_method) && !route_path.include?(':id')
+      %w(GET POST).include?(request_method) && !path.include?(':id')
     end
 
     private
 
     def request_body?
-      !%w(GET DELETE).include?(route_method)
+      !%w(GET DELETE).include?(request_method)
     end
   end
 end

data/lib/grape-apiary/templates/blueprint.md.erb

@@ -11,14 +11,14 @@ HOST: <%= host %>
     <% grouped_resource.paths.each do |resource_by_path| %>
 ## <%= resource_by_path.header %>
 Actions on the <%= resource.name %> resource
-      <% if resource_by_path.routes.first.route_params.present? %>
+      <% if resource_by_path.routes.first.params.present? %>
 + Parameters
-        <% resource_by_path.routes.first.route_params.each do |param| %>
+        <% resource_by_path.routes.first.params.each do |param| %>
     + <%= param.description %>
         <% end %>
       <% end %>
       <% resource_by_path.routes.each do |route| %>
-### <%= route.route_description %>
+### <%= route.description %>
 <% if show_request_sample?(route) %>
 <%= route.request_description %>
 <%= formatted_request_headers %>

data/lib/grape-apiary/version.rb

@@ -1,5 +1,5 @@
 # Needed until support for v2.3+ https://goo.gl/DyKn74
 # frozen_string_literal: true
 module GrapeApiary
-  VERSION = '0.1.2'.freeze
+  VERSION = '0.2.0'.freeze
 end

data/spec/grape-apiary/resource_spec.rb

@@ -15,7 +15,7 @@ describe GrapeApiary::Resource do
     it 'response generation is delegated to a generator' do
       expect(subject.sample_generator).to receive(:response)
 
-      subject.sample_response(GrapeApiary::Route.new(Grape::Route.new))
+      subject.sample_response(GrapeApiary::Route.new(SampleApi.routes.first))
     end
   end
 end

data/spec/grape-apiary/route_spec.rb

@@ -12,7 +12,7 @@ describe GrapeApiary::Route do
   end
 
   it 'adds a path helper without format' do
-    expect(subject.route_path_without_format).to eq('/widgets')
+    expect(subject.path_without_format).to eq('/widgets')
   end
 
   it 'adds a type helper' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grape-apiary
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - John Allen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-26 00:00:00.000000000 Z
+date: 2017-02-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grape
@@ -16,20 +16,20 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.14'
-    - - "<"
+        version: 0.16.0
+    - - "<="
       - !ruby/object:Gem::Version
-        version: '0.16'
+        version: 0.19.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.14'
-    - - "<"
+        version: 0.16.0
+    - - "<="
       - !ruby/object:Gem::Version
-        version: '0.16'
+        version: 0.19.1
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -238,7 +238,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.3
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: Allows for generating an Apiary Blueprint for you Grape API