grape-raketasks 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 54f52266aea4d335c644a785522633a0c1f67de3
+  data.tar.gz: 35edad40355fc1e36d4051bbdd5c1ee7cfbe4180
+SHA512:
+  metadata.gz: 1cb39671ddf1853690fe2c3aeeb9c90791438558ee6e79122ec00c9e7a717a0f699fbdeef98dbf9ffd331ece12d47e0f594393c5322eea119ea64a1f1f42686e
+  data.tar.gz: 8e6a2769fdf071b3185dc3557bc6367273fb327c40b643631d8a50ba606c85047447182752b9e6ed11870f0414867a42d82d05aa0e9db96b963218086781d973

data/.gitignore

@@ -0,0 +1,6 @@
+# Ruby
+Gemfile.lock
+*.gem
+
+# Vim
+*.sw[a-z]

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2014 H. Henn
+
+MIT License
+
+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,69 @@
+# grape-raketasks
+
+Rake tasks to ease the development and debugging of Grape APIs.
+
+## Available Tasks
+
+### Routes
+
+`rake grape_raketasks:routes` is like `rake routes` for your Grape APIs. All routes within every Grape API in your web application will be printed to the terminal, along with parameter requiremements, HTTP verb, the API it belongs to, etc.
+
+#### Filtering
+
+If you want to see routes belonging to only one API, pass an environment variable set to your API name in snake-case after writing the task. For example, if I wanted to view only routes belonging to my Grape API named CatPictures, I'd execute `rake grape_raketasks:routes GRAPE_API=cat_pictures`.
+
+## Installation
+
+1.) grape-raketasks isn't served on Rubygems yet. Reference this repository, or your own fork, from a Gemfile:
+
+```ruby
+# Gemfile
+gem 'grape-raketasks', git: 'git://github.com/reprah/grape-raketasks'
+```
+
+2.) Install the gem via Bundler:
+
+```shell
+$ bundle install
+```
+If you don't want to use Bundler, follow the [instructions here](http://ruby.about.com/od/advancedruby/a/gitgem.htm).
+
+3.) If your Grape APIs are defined in a Sinatra or Rack web application, you need to 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-raketasks'
+require 'grape-raketasks/tasks'
+
+desc 'load the Sinatra environment.'
+task :environment do
+  require File.expand_path('your_app_file', File.dirname(__FILE__))
+end
+```
+Rails applications with mounted Grape APIs don't require an extra step here.
+
+4.) Run `rake -T` to see all available rake tasks. Tasks with a `grape_raketasks` namespace should appear somewhere.
+
+5.) Use the tasks! Find bugs or ideas for improvement! Report them here!
+
+## 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/grape-raketasks.gemspec

@@ -0,0 +1,22 @@
+require File.dirname(__FILE__) + '/lib/grape-raketasks/version'
+
+Gem::Specification.new do |gem|
+  gem.name        = 'grape-raketasks'
+  gem.version     = GrapeRakeTasks::VERSION 
+
+  gem.homepage    = 'https://github.com/reprah/grape-raketasks'
+  gem.license     = 'MIT'
+  gem.summary     = 'Rake tasks for web applications using Grape APIs.'
+  gem.description = 'Provides rake tasks to ease the development and debugging of Grape APIs.'
+  gem.author      = 'H. Henn'
+
+  gem.files = `git ls-files`.split($\)
+  gem.test_files = gem.files.grep(/^spec/)
+
+  gem.add_runtime_dependency     'grape'
+  gem.add_runtime_dependency     'rake'
+  gem.add_runtime_dependency     'activesupport'
+
+  gem.add_development_dependency 'rspec'
+end
+

data/lib/grape-raketasks/console_formatter.rb

@@ -0,0 +1,54 @@
+require 'active_support/core_ext/string'
+
+module GrapeRakeTasks
+  class ConsoleFormatter
+    attr_reader :buffer
+
+    def initialize
+      @buffer = []
+    end
+
+    def result
+      buffer.join << "\n\n"
+    end
+
+    def construct_output(routes)
+      if routes.any?
+        buffer << routes.map { |r| format_route(r) }.join("\n\n")
+      else
+        buffer << no_routes_message
+      end
+    end
+
+    def format_route(route)
+      opts = route.options
+      # two characters (colon + space) after the title
+      longest_key_length = opts.keys.map(&:length).max + 2
+
+      opts.sort.map do |key, value|
+        title = key_to_title(key)
+        title << build_padding(longest_key_length, key.length)
+        title << value.inspect
+      end.join("\n")
+    end
+
+    private
+
+    def build_padding(max_len, title_len)
+      # whitespace padding used to align output
+      ' ' * (max_len - title_len)
+    end
+
+    def key_to_title(key)
+      key.to_s.upcase.concat(': ')
+    end
+
+    def no_routes_message
+      <<-MSG.strip_heredoc
+        You don't have any Grape routes defined!
+        Visit https://github.com/intridea/grape for help.
+      MSG
+    end
+  end
+end
+

data/lib/grape-raketasks/processor.rb

@@ -0,0 +1,24 @@
+require 'active_support/core_ext/string'
+
+module GrapeRakeTasks
+  class Processor
+    attr_reader :routes
+
+    def initialize(routes)
+      @routes = routes
+    end
+
+    def format(formatter, filter = nil)
+      routes_to_display = filter_by_api(filter)
+      formatter.construct_output(routes_to_display)
+      formatter.result
+    end
+
+    def filter_by_api(filter = nil)
+      return routes unless filter
+      filter_as_class = "#{filter.camelcase}::API"
+      routes.select { |r| r.route_api.to_s == filter_as_class }
+    end
+  end
+end
+

data/lib/grape-raketasks/railtie.rb

@@ -0,0 +1,7 @@
+module GrapeRakeTasks
+  class Railtie < Rails::Railtie
+    rake_tasks do
+      Dir[File.join(File.dirname(__FILE__), '../tasks/*.rake')].each { |f| load f }
+    end
+  end
+end

data/lib/grape-raketasks/route.rb

@@ -0,0 +1,29 @@
+require 'active_support/core_ext/class'
+
+# enable adding the API name to a route's options
+class Grape::Route
+  attr_accessor :options
+end
+
+module GrapeRakeTasks
+  class Route
+    def self.all_routes(api)
+      api.subclasses.flat_map do |klass|
+        api_routes(klass)
+      end
+    end
+
+    def self.api_routes(api)
+      api.routes.map do |grape_route|
+        route_with_api_name(grape_route, api)
+      end
+    end
+
+    def self.route_with_api_name(grape_route, api_name)
+      new_opts = grape_route.options.merge(api: api_name)
+      grape_route.options = new_opts
+      grape_route
+    end
+  end
+end
+

data/lib/grape-raketasks/tasks.rb

@@ -0,0 +1,2 @@
+load File.expand_path('../../tasks/grape-raketasks.rake', __FILE__)
+

data/lib/grape-raketasks/version.rb

@@ -0,0 +1,4 @@
+module GrapeRakeTasks
+  VERSION = '0.0.1'
+end
+

data/lib/grape-raketasks.rb

@@ -0,0 +1,9 @@
+require 'grape'
+require 'grape-raketasks/route'
+require 'grape-raketasks/processor'
+require 'grape-raketasks/console_formatter'
+
+module GrapeTasks
+  require 'grape-raketasks/railtie' if defined?(Rails)
+end
+

data/lib/tasks/grape-raketasks.rake

@@ -0,0 +1,9 @@
+namespace :grape_raketasks do
+  desc 'Print routes provided by Grape APIs to the terminal. Target a specific API with GRAPE_API=x.'
+  task routes: :environment do
+    all_routes = GrapeRakeTasks::Route.all_routes(Grape::API)
+    inspector = GrapeRakeTasks::Processor.new(all_routes)
+    puts inspector.format(GrapeRakeTasks::ConsoleFormatter.new, ENV['GRAPE_API'])
+  end
+end
+

data/spec/grape-raketasks/console_formatter_spec.rb

@@ -0,0 +1,52 @@
+require 'spec_helper'
+
+describe GrapeRakeTasks::ConsoleFormatter do
+  let(:formatter) { described_class.new }
+
+  describe '#construct_output' do
+    before do
+      formatter.stub(format_route: 'formatted route') 
+    end
+
+    context 'when routes exist' do
+      before do
+        formatter.construct_output(['a route']) 
+      end
+
+      it 'adds formatted routes to the buffer' do
+        expect(formatter.buffer).to include('formatted route')
+      end
+    end
+    
+    context 'when no routes exist' do
+      before do
+        formatter.construct_output([])
+      end
+
+      it 'adds a message to the buffer' do
+        msg = formatter.buffer.first
+        expect(msg).to include("You don't have any Grape routes defined!") 
+      end
+    end
+  end
+
+  describe '#format_route' do
+    let(:route_object) { grape_route_object }
+
+    it 'returns a text representation of a route object' do
+      result = formatter.format_route(route_object)
+      expect(result).to match(/METHOD:\s+"GET"/) 
+    end
+  end
+
+  describe '#result' do
+    before do
+      formatter.construct_output([])
+    end
+
+    it 'returns the contents of the buffer as a string' do
+      expect(formatter.result).to be_a(String)
+    end
+  end
+end
+

data/spec/grape-raketasks/processor_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+describe GrapeRakeTasks::Processor do
+  describe '#filter_by_api' do
+    let(:routes) do
+      GrapeRakeTasks::Route.all_routes(Grape::API)
+    end
+
+    let(:processor) { described_class.new(routes) }
+
+    context 'when given a Grape API to filter by' do
+      let(:filter) { 'sample_api_one' }
+
+      it 'returns only routes belonging to that API' do
+        filtered = processor.filter_by_api(filter)
+        filtered_apis = filtered.map(&:route_api)
+        expect(filtered_apis).to eq [SampleApiOne::API]
+      end
+    end
+
+    context 'when no filter is given' do
+      it 'returns routes from every Grape API' do
+        unfiltered = processor.filter_by_api
+        unfiltered_apis = unfiltered.map(&:route_api)
+        expect(unfiltered_apis.length).to eq routes.length
+      end
+    end
+  end
+end
+

data/spec/grape-raketasks/route_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+describe GrapeRakeTasks::Route do
+  describe '.route_with_api_name' do
+    let(:route) { grape_route_object }
+
+    it 'adds an API name to a route\'s options hash' do
+      altered_route = described_class.route_with_api_name(route, SampleApiOne::API)
+      expect(altered_route.options).to have_key(:api)
+    end
+  end
+
+  describe '.api_routes' do
+    let(:api_class) { SampleApiOne::API }
+
+    it 'returns a collection of routes that know their parent API' do
+      routes = described_class.api_routes(SampleApiOne::API)
+      every_route_has_api = routes.all? { |r| r.options.has_key?(:api) }
+      expect(every_route_has_api).to be_true
+    end
+  end
+
+  describe '.all_routes' do
+    it 'returns routes belonging to every subclass' do
+      routes = described_class.all_routes(Grape::API)
+      api_names = routes.map(&:route_api)
+      expect(api_names).to include(SampleApiOne::API)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require 'grape-raketasks'
+
+# load support files
+Dir.glob(ENV['PWD'] + '/spec/support/*.rb').each { |f| require f }
+

data/spec/support/test_objects.rb

@@ -0,0 +1,22 @@
+# test objects
+
+def grape_route_object
+  g = Grape::Route.new
+  g.options = { path: '/', method: 'GET' }
+  g
+end
+
+class SampleApiOne
+  class API < Grape::API
+  end
+end
+
+class SampleApiTwo < Grape::API
+  class API < Grape::API
+  end
+end
+
+[SampleApiOne::API, SampleApiTwo::API].each do |api|
+  api.routes << grape_route_object
+end
+

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: grape-raketasks
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- H. Henn
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: grape
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '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: Provides rake tasks to ease the development and debugging of Grape APIs.
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- grape-raketasks.gemspec
+- lib/grape-raketasks.rb
+- lib/grape-raketasks/console_formatter.rb
+- lib/grape-raketasks/processor.rb
+- lib/grape-raketasks/railtie.rb
+- lib/grape-raketasks/route.rb
+- lib/grape-raketasks/tasks.rb
+- lib/grape-raketasks/version.rb
+- lib/tasks/grape-raketasks.rake
+- spec/grape-raketasks/console_formatter_spec.rb
+- spec/grape-raketasks/processor_spec.rb
+- spec/grape-raketasks/route_spec.rb
+- spec/spec_helper.rb
+- spec/support/test_objects.rb
+homepage: https://github.com/reprah/grape-raketasks
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Rake tasks for web applications using Grape APIs.
+test_files:
+- spec/grape-raketasks/console_formatter_spec.rb
+- spec/grape-raketasks/processor_spec.rb
+- spec/grape-raketasks/route_spec.rb
+- spec/spec_helper.rb
+- spec/support/test_objects.rb