api_bluerails 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 59fec8440a48e7345215a750d69e2231d2a8e118
+  data.tar.gz: 2422a7fd4876a3b2b2b4ca1bf692799f5f2831ca
+SHA512:
+  metadata.gz: a21a6678fa24d0ae66a7edfaf90c116a8cfe3ed1ce991979c69dacc89384a86a558f5c925010a8738efeefbf2bb1f2c2d87b6c00859d6bc9fe9a073798520667
+  data.tar.gz: 0b35f3990cac2e6a74d3acee8871727307903d7f65060c18017602490bec378b795266277b577057ce2c2711799fe11ad49eb64a1e1b338a3a1fd612a6dd8153

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Manuel Dudda
+
+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,61 @@
+# Api Bluerails
+
+This project uses MIT-LICENSE.
+
+Tools for developing an API written in Rails with api blueprint documentation
+
+## Usage
+
+### Overview of provided Rake Tasks
+
+```shell
+rake -T
+
+rake doc:coverage      # Print Coverage of the api blueprint with rails routes
+```
+
+
+### doc:coverage
+
+```shell
+>>>
+available Routes
+-----------------------------------------------------------------------------------------------------------------
+                                                                         /assets |         GET, POST, PUT, DELETE
+                                                     /oauth/authorize/:code.json |                            GET
+                                                           /oauth/authorize.json |         GET, POST, PUT, DELETE
+                                                               /oauth/token.json |                           POST
+                                                              /oauth/revoke.json |                           POST
+                                                                             ...
+                                                                /api/status.json |                            GET
+                                                     /rails/info/properties.json |         GET, POST, PUT, DELETE
+=                                                                             96 | =                          153
+
+<<<
+
+
+>>>
+documneted routes
+-----------------------------------------------------------------------------------------------------------------
+                                                                /api/status.json |                            GET
+                                                               /oauth/token.json |               POST, POST, POST
+                                                              /api/v2/users.json |                   POST, DELETE
+                                                      /api/v2/users/sign_in.json |                            GET         
+=                                                                              4 | =                           7
+
+<<<
+
+
+>>>
+not documented routes
+-----------------------------------------------------------------------------------------------------------------
+                          /api/v2/partner/{namespace}/{foreign_token}/store.json |                            GET
+                   /api/v2/partner/{namespace}/{foreign_token}/transactions.json |                           POST
+                      /api/v2/user/payment_identities/{payment_identity_id}.json |                    PUT, DELETE
+=                                                                              3 | =                           4
+
+<<<
+echo $?
+4
+
+```

data/api_bluerails.gemspec

@@ -0,0 +1,22 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'api_bluerails/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'api_bluerails'
+  spec.version = ApiBluerails::VERSION
+  spec.authors = ['Manuel Dudda']
+  spec.email = ['manueldudda@redpeppix.de']
+  spec.summary = 'Tools for developing an API written in Rails with api blueprint documentation'
+  spec.description = 'Tools for developing an API written in Rails with api blueprint documentation'
+  spec.homepage = 'https://github.com/manuel84/api_bluerails'
+  spec.license = 'MIT'
+
+  spec.files = `git ls-files -z`.split("\x0")
+  spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+  spec.add_runtime_dependency 'rails'
+
+end

data/lib/api_bluerails.rb

@@ -0,0 +1,16 @@
+%w(version coverage railtie).each { |f| require "api_bluerails/#{f}" }
+
+module ApiBluerails
+  def self.coverage
+    app_urls_hash, covered_urls_hash, uncovered_urls_hash = ApiBluerails::Coverage.coverage
+    {'verfügbare Routes' => app_urls_hash, 'dokumentierte Routes' => covered_urls_hash, 'nicht dokumentierte Routes' => uncovered_urls_hash}.each do |title, hash|
+      puts "\n\n>>>"
+      puts title
+      puts "-"*113
+      hash.each { |url, verbs| puts sprintf("%80s | %30s", url, verbs.join(', ')) }
+      puts sprintf("=%79s | =%29s", hash.keys.count, hash.values.sum { |v| v.count })
+      puts "\n<<<"
+    end
+    exit [uncovered_urls_hash.size, 255].min
+  end
+end

data/lib/api_bluerails/coverage.rb

@@ -0,0 +1,75 @@
+module ApiBluerails
+  class Coverage
+    def self.coverage
+      routes = Rails.application.routes.routes
+      app_urls_hash = Hash.new([])
+      app_urls = routes.collect { |r| [r.path.spec.to_s, r.constraints] }
+      app_urls.each do |app_url, constraint|
+        app_url.gsub!('(/:locale)', '/locale') # (/:locale)/users/sign_in(.:format) => /locale/users/sign_in(.:format)
+        app_url.gsub!('(.:format)', '.json') # /api/v2/devices/:device_id/transactions/:id/assume(.:format) => /api/v2/devices/:device_id/transactions/:id/assume.json
+        app_url.gsub!(/\:([a-zA-Z_]+)\//, '{\1}/') # /api/v2/devices/:device_id/transactions/:id/assume.json => /api/v2/devices/{device_id}/transactions/:id/assume.json
+
+        if app_url.ends_with?(':id.json')
+          resource = app_url.split('/')[-2].ends_with?('}') ? app_url.split('/')[-3] : app_url.split('/')[-2]
+          app_url.gsub!(':id.json', "{#{resource.singularize}_id}.json") # /api/v2/user/transactions/:id.json => /api/v2/user/transactions/{transaction_id}.json
+        end
+
+        if app_url.include?('{id}')
+          namespaces = app_url.split('/')
+          app_url.gsub!('{id}', "{#{namespaces[namespaces.index('{id}')-1].singularize}_id}") # /api/v2/user/transactions/{id}/receipt.json => /api/v2/user/transactions/{transaction_id}/receipt.json
+        end
+        app_urls_hash[app_url] += constraint.has_key?(:request_method) ? constraint[:request_method].source.gsub('^', '').gsub('$', '').split('|') : %w(GET POST PUT DELETE)
+      end
+
+      #puts app_urls_hash
+
+      apib_file = File.read api_doc_location(determine_latest_api_version)
+      url_holder_pattern = /^##\s.+\[(\/.+)(json|{format})(\{\?.+\})?\]$/
+      # Regex for:
+      ## User Transaction [/api/v2/user/transactions/{transaction_id}.{format}{?user_key,device_id}]
+      # =>
+      #1.	/api/v2/user/transactions/{transaction_id}.
+      #2.	{format}
+      #3.	{?user_key,device_id}
+
+      http_verb_pattern = /^###\s.+\[(GET|POST|PUT|DELETE)\]$/
+      covered_urls_hash = {}
+      current_url = ""
+      apib_file.each_line do |line|
+        matchdata = line.match(url_holder_pattern)
+        matchdata2 = line.match(http_verb_pattern)
+        if matchdata
+          current_url = matchdata[1] + matchdata[2]
+          current_url.gsub!('{format}', 'json')
+          covered_urls_hash[current_url] = []
+        end
+        covered_urls_hash[current_url] << matchdata2[1] if matchdata2
+      end
+
+
+      # ignore the following routes
+      exceptions = {
+          # Rails routes
+          '/assets' => %w(GET POST PUT DELETE),
+          '/rails/info/properties.json' => %w(GET POST PUT DELETE)
+      }
+      config_file = Rails.root.join('config', 'api_bluerails.yml')
+      if File.exists?(config_file)
+        config = YAML.load(File.open(config_file)).freeze
+        exceptions.merge! config['exceptions'] if config['exceptions']
+      end
+
+      uncovered_urls_hash = {}
+      app_urls_hash.each do |url, verbs|
+        uncovered_urls_hash[url] = verbs
+        uncovered_urls_hash[url] = verbs - covered_urls_hash[url] if covered_urls_hash.has_key?(url)
+        uncovered_urls_hash[url] -= exceptions[url] if exceptions.has_key?(url)
+      end
+
+
+      uncovered_urls_hash.delete_if { |k, v| v.empty? }
+      return app_urls_hash, covered_urls_hash, uncovered_urls_hash
+    end
+  end
+
+end

data/lib/api_bluerails/railtie.rb

@@ -0,0 +1,11 @@
+require 'api_bluerails'
+require 'rails'
+module ApiBluerails
+  class Railtie < Rails::Railtie
+    rake_tasks do
+      f = File.join(File.dirname(__FILE__), '..', '..', 'tasks', 'coverage.rake')
+      load f
+      # load 'tasks/uml.rake'
+    end
+  end
+end

data/lib/api_bluerails/version.rb

@@ -0,0 +1,3 @@
+module ApiBluerails
+  VERSION = '0.0.1'
+end

data/tasks/coverage.rake

@@ -0,0 +1,8 @@
+namespace :doc do
+
+  desc 'Print Coverage of the api blueprint with rails routes'
+  task :coverage => :environment do
+    ApiBluerails.coverage
+  end
+
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification
+name: api_bluerails
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Manuel Dudda
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  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'
+description: Tools for developing an API written in Rails with api blueprint documentation
+email:
+- manueldudda@redpeppix.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- api_bluerails.gemspec
+- lib/api_bluerails.rb
+- lib/api_bluerails/coverage.rb
+- lib/api_bluerails/railtie.rb
+- lib/api_bluerails/version.rb
+- tasks/coverage.rake
+homepage: https://github.com/manuel84/api_bluerails
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Tools for developing an API written in Rails with api blueprint documentation
+test_files: []