rails_to_postman 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rails_to_postman.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013 vachman
+
+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,25 @@
+# RailsToPostman
+
+TODO: Convert Ruby on Rails application routes to Postman REST Client format end export to json file.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rails_to_postman'
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+    $ rake export_routes
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/rails_to_postman.rb

@@ -0,0 +1,8 @@
+require "rails_to_postman/version"
+require "rails_to_postman/main"
+require 'erb'
+
+
+module RailsToPostman
+  require 'rails_to_postman/railtie' if defined?(Rails)
+end

data/lib/rails_to_postman/main.rb

@@ -0,0 +1,95 @@
+module RailsToPostman
+  
+  def self.export_routes
+    load Rails.application.root.join('config/routes.rb') 
+    resources = get_routes
+    doc = render_postman_json_from(resources)
+    save_to_file(doc)
+  end
+  
+  def self.normalise_route(route, path_prefix = nil)
+    route.verb.source.split('|').map do |verb|
+      {
+         :id   => @_route_counter+=1,
+         :name => route.name,
+         :verb => verb.gsub(/[$^]/, ''),
+         :path => path_prefix.to_s + route.path.spec.to_s.sub('(.:format)', ''),
+         :reqs => route.requirements
+      }
+    end
+  end
+
+  def self.get_routes
+    @_route_counter = 0
+    routes = []
+    Rails.application.routes.routes.each do |route|
+      next if route.app.is_a?(ActionDispatch::Routing::Mapper::Constraints)
+      routes << normalise_route(route)[0] 
+    end
+    grouped_routes(routes.compact)
+  end
+     
+  def self.grouped_routes(routes)
+    routes.group_by { |r| r[:reqs][:controller] }
+  end
+  
+  def self.render_postman_json_from(resources)
+    collection_id = Rails.application.class.parent.to_s.downcase
+    collection_name = Rails.application.class.parent.to_s 
+    
+
+
+    postman_json = {
+      id: collection_id,
+      name: collection_name,
+      timestamp: '1360664941208',
+      order: [],
+      requests: []
+    }
+    
+    resources.each do |resource, routes|
+      postman_json[:order] << "resource##{resource}"
+      postman_json[:requests] << {
+        collectionId: collection_id,
+        id: "resource##{resource}",
+        name: resource.upcase,
+        description: "#{resource.capitalize} resources",
+        url: "/#{resource}",
+        method: "RESOURCES",
+        headers: "",
+        data: [],
+        dataMode: "params",
+        timestamp: 0,
+        responses: [],
+        version: 2
+      }
+      
+      routes.each do |route|
+        postman_json[:order] << "#{resource}##{route[:reqs][:action]}"
+        postman_json[:requests] << {
+          collectionId: collection_id,
+          id: "#{resource}##{route[:reqs][:action]}",
+          name: "#{route[:reqs][:action]}",
+          description: "#{resource.capitalize} '#{route[:reqs][:action]}' method",
+          url: "{{url}}#{route[:path]}?token={{token}}",
+          method: route[:verb],
+          headers: "",
+          data: [],
+          dataMode: "params",
+          timestamp: 0,
+          responses: [],
+          version: 2
+        }
+      end
+    end 
+    postman_json
+  end  
+
+  def self.save_to_file(doc)
+    file_path = "tmp/#{Rails.application.class.parent.to_s.downcase}_routes_for_postman.json"
+    output_file = File.open( file_path, 'w') 
+    output_file << doc.to_json
+    output_file.close
+    puts "Rails to Postman - routes exported to: '#{file_path}'" 
+  end
+end

data/lib/rails_to_postman/railtie.rb

@@ -0,0 +1,11 @@
+require 'rails_to_postman'
+require 'rails'
+module RailsToPostman
+  class Railtie < Rails::Railtie
+    railtie_name :rails_to_postman
+
+    rake_tasks do
+      load "tasks/rails_to_postman.rake"
+    end
+  end
+end

data/lib/rails_to_postman/version.rb

@@ -0,0 +1,3 @@
+module RailsToPostman
+  VERSION = "0.0.1"
+end

data/lib/tasks/rails_to_postman.rake

@@ -0,0 +1,4 @@
+desc 'Rails to Postman'
+task :export_routes do
+  RailsToPostman.export_routes
+end

data/rails_to_postman.gemspec

@@ -0,0 +1,17 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/rails_to_postman/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Gevorgyan Vachagan"]
+  gem.email         = ["va4@me.com"]
+  gem.description   = %q{Export rails routes to json for Postman REST Client}
+  gem.summary       = %q{Convert Ruby on Rails application routes to Postman REST Client format end export to json file.}
+  gem.homepage      = "https://github.com/Vachman/rails_to_postman"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "rails_to_postman"
+  gem.require_paths = ["lib"]
+  gem.version       = RailsToPostman::VERSION 
+end

data/rails_to_postman.tmproj

@@ -0,0 +1,27 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>documents</key>
+	<array>
+		<dict>
+			<key>expanded</key>
+			<true/>
+			<key>name</key>
+			<string>rails_to_postman</string>
+			<key>regexFolderFilter</key>
+			<string>!.*/(\.[^/]*|CVS|_darcs|_MTN|\{arch\}|blib|.*~\.nib|.*\.(framework|app|pbproj|pbxproj|xcode(proj)?|bundle))$</string>
+			<key>sourceDirectory</key>
+			<string></string>
+		</dict>
+	</array>
+	<key>fileHierarchyDrawerWidth</key>
+	<integer>292</integer>
+	<key>metaData</key>
+	<dict/>
+	<key>showFileHierarchyDrawer</key>
+	<true/>
+	<key>windowFrame</key>
+	<string>{{295, 0}, {981, 778}}</string>
+</dict>
+</plist>

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification
+name: rails_to_postman
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Gevorgyan Vachagan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-20 00:00:00.000000000 Z
+dependencies: []
+description: Export rails routes to json for Postman REST Client
+email:
+- va4@me.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/rails_to_postman.rb
+- lib/rails_to_postman/main.rb
+- lib/rails_to_postman/railtie.rb
+- lib/rails_to_postman/version.rb
+- lib/tasks/rails_to_postman.rake
+- rails_to_postman.gemspec
+- rails_to_postman.tmproj
+homepage: https://github.com/Vachman/rails_to_postman
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Convert Ruby on Rails application routes to Postman REST Client format end
+  export to json file.
+test_files: []
+has_rdoc: