ruby-swagger 0.0.1

data/lib/ruby-swagger/io/paths.rb

@@ -0,0 +1,55 @@
+require 'ruby-swagger/io/file_system'
+
+module Swagger::IO
+  class Paths
+
+    def self.read_paths
+      paths = {}
+
+      l = (Swagger::IO::FileSystem.default_path + '/paths').length
+
+      Swagger::IO::FileSystem.all_files('paths/**/*.yml').each do |file|
+        content = YAML::load_file(file)
+        paths[File.dirname(file[l..file.length])] ||= {}
+        paths[File.dirname(file[l..file.length])][File.basename(file, ".yml")] = content
+      end
+
+      paths
+    end
+
+    def self.write_paths(paths)
+      return if paths.nil?
+
+      l = (Swagger::IO::FileSystem.default_path + '/paths').length
+
+      #Remove dead endpoints
+      Swagger::IO::FileSystem.all_files("paths/**/*.yml").each do |file|
+        def_name = file[l..file.length]
+
+        if paths[File.dirname(file[l..file.length])].nil? || paths[File.dirname(file[l..file.length])][File.basename(file, ".yml")].nil?
+          STDERR.puts "#{def_name} is not present anymore, removing #{file}"
+          Swagger::IO::FileSystem.delete_file(file)
+        end
+
+      end
+
+      paths.each do |path, path_obj|
+        path_obj.each do |action, action_obj|
+
+          file = "paths/#{path}/#{action}.yml"
+
+          # If an old definition exists, we copy over the documentation to the generated definition
+          if Swagger::IO::FileSystem.file_exists?(file)
+            old_action = Swagger::IO::FileSystem.read_file(file)
+
+            Swagger::IO::Comparable.copy_description_old_definition(action_obj, old_action)
+          end
+
+
+          Swagger::IO::FileSystem.write_file(action_obj.to_yaml, file, true)
+        end
+      end
+    end
+
+  end
+end

data/lib/ruby-swagger/io/security.rb

@@ -0,0 +1,45 @@
+require 'ruby-swagger/io/file_system'
+
+module Swagger::IO
+  class Security
+
+    SECURITY_FILE_NAME = 'securityDefinitions.yml'
+
+    def self.write_security_definitions(security_definitions)
+      return if security_definitions.nil? || security_definitions.empty?
+
+      security_definitions.each do |definition_name, definition|
+        Swagger::IO::Security.write_scopes(definition_name, definition)
+      end
+
+      Swagger::IO::FileSystem.write_file(security_definitions.to_yaml, SECURITY_FILE_NAME)
+    end
+
+    def self.read_security_definitions
+      return nil unless Swagger::IO::FileSystem.file_exists?(SECURITY_FILE_NAME)
+      definitions = Swagger::IO::FileSystem.read_file(SECURITY_FILE_NAME)
+
+      Swagger::IO::FileSystem.all_files("/scopes/*.yml").each do |file|
+        definitions[File.basename(file, ".yml")]['scopes'] = YAML::load_file(file)
+      end
+
+      definitions
+    end
+
+    def self.write_scopes(definition_name, definition)
+      return unless definition && definition['scopes']
+
+      scopes = definition.delete('scopes') || {}
+      scope_file = "scopes/#{definition_name}.yml"
+
+      return Swagger::IO::FileSystem.write_file(scopes.to_yaml, scope_file) unless Swagger::IO::FileSystem.file_exists?(scope_file)
+
+      #Merging old scopes into new scope
+      old_scopes = Swagger::IO::FileSystem.read_file(scope_file)
+
+      Swagger::IO::FileSystem.write_file(scopes.merge(old_scopes).to_yaml, scope_file, true)
+    end
+
+  end
+
+end

data/lib/ruby-swagger/object.rb

@@ -0,0 +1,67 @@
+module Swagger
+  class Object
+
+    @@swagger_attribs = {}
+
+    def self.attr_swagger(*attributes)
+      attr_accessor(*attributes)
+      @@swagger_attribs[self.to_s] = *attributes
+    end
+
+    def swagger_attributes
+      @@swagger_attribs[self.class.to_s]
+    end
+
+    def to_json(options = nil)
+      to_swagger.to_json(options)
+    end
+
+    def to_yaml
+      to_swagger.to_yaml
+    end
+
+    def to_swagger
+      as_swagger
+    end
+
+    def bulk_set(object)
+      swagger_attributes.each do |attribute|
+        self.send("#{attribute}=", object[attribute.to_s])
+      end
+
+      self
+    end
+
+    protected
+
+    def as_swagger
+      swagger = {}
+
+      return swagger unless swagger_attributes
+
+      swagger_attributes.each do |property|
+        obj = self.send(property)
+        obj = swaggerify(obj)
+
+        swagger[property.to_s] = obj if !obj.nil?
+      end
+
+      swagger
+    end
+
+    def swaggerify(object)
+      return nil if object.nil?
+
+      return object.to_swagger if object.respond_to?(:to_swagger)
+
+      if object.is_a?(Array)
+        object.map! do |element|
+          swaggerify(element)
+        end
+      end
+
+      object
+    end
+
+  end
+end

data/lib/ruby-swagger/railtie.rb

@@ -0,0 +1,7 @@
+module Swagger
+  class Railtie < Rails::Railtie
+    rake_tasks do
+      load "#{File.dirname(__FILE__)}/../tasks/swagger.rake"
+    end
+  end
+end

data/lib/ruby-swagger/template.rb

@@ -0,0 +1,29 @@
+require 'ruby-swagger/data/document'
+
+module Swagger
+  class Template
+
+    def self.generate
+      swagger_doc = Swagger::Data::Document.new
+
+      if defined?(Rails)
+        swagger_doc.info.title = Rails.application.class.name.split('::').first.underscore
+        swagger_doc.info.description = Rails.application.class.name.split('::').first.underscore
+      end
+
+      swagger_doc.host = 'localhost:80'
+      swagger_doc.basePath = '/api/v1'
+
+      swagger_doc.schemes = ['https', 'http']
+      swagger_doc.produces = ['application/json']
+      swagger_doc.consumes = ['application/json']
+
+      swagger_doc.info.contact = Swagger::Data::Contact.new
+      swagger_doc.info.license = Swagger::Data::License.new
+      swagger_doc.info.termsOfService = 'https://localhost/tos.html'
+
+      swagger_doc
+    end
+
+  end
+end

data/lib/tasks/swagger.rake

@@ -0,0 +1,125 @@
+require 'ruby-swagger/io/file_system'
+require 'ruby-swagger/grape/grape_template'
+
+namespace :swagger do
+
+  namespace :grape do
+
+    unless defined?(Rails)
+      task :environment do
+        # for non-rails environment, we do not load the env
+      end
+    end
+
+    desc 'Generate a swagger meta documentation from Grape API definition and store it under doc/swagger'
+    task :generate_doc, [:base_class] => :environment do |t, args|
+      if args[:base_class].nil?
+        STDERR.puts "You need to pass a base class for your API"
+        STDERR.puts "For example: rake 'swagger:grape:generate_doc[ApiBase]'"
+        exit -1
+      end
+
+      puts "Exporting from Grape - base class #{args[:base_class]}"
+
+      swagger_doc = Swagger::Grape::Template.generate(Module.const_get(args[:base_class]))
+
+      # Get path data from Grape
+
+      Swagger::IO::FileSystem.new(swagger_doc).write!
+      puts "You should check your swagger meta documentation under #{Swagger::IO::FileSystem.default_path}"
+    end
+
+  end
+
+  desc 'Generate a swagger 2.0-compatible documentation from the metadata stored into doc/swagger'
+  task :compile_doc do
+    puts "Compiling documentation"
+
+    Swagger::IO::FileSystem.new(Swagger::IO::FileSystem.read).compile!
+
+    puts "Done. Your documentation file is #{Swagger::IO::FileSystem.default_path}/swagger.json"
+  end
+
+  desc 'Build an API client given the swagger definition in doc/swagger/swagger.json'
+  namespace :generate_client do
+
+    def build_client(language)
+      unless File.exists?('./doc/swagger/swagger.json')
+        STDERR.puts "File ./doc/swagger/swagger.json does not exist"
+        exit -1
+      end
+
+      unless File.exists?('vendor/swagger-codegen-cli.jar')
+        STDERR.puts "Swagger codegen does not exist, downloading it now..."
+        Dir.mkdir('./vendor') unless Dir.exists?('./vendor')
+
+        `wget -O ./vendor/swagger-codegen-cli.jar https://s3-us-west-2.amazonaws.com/tunamelt-production/swagger-codegen/swagger-codegen-cli.jar`
+      end
+
+      puts "Generating #{language} client (output in api_client/#{language})"
+
+      FileUtils.rm_rf("./api_client/#{language}") if Dir.exists?("./api_client/#{language}")
+
+      `java -jar ./vendor/swagger-codegen-cli.jar generate \
+            -i ./doc/swagger/swagger.json \
+            -l #{language} \
+            -o api_client/#{language}`
+    end
+
+    desc 'Build the Ruby API client given the swagger definition in doc/swagger/swagger.json'
+    task :ruby do
+      build_client 'ruby'
+    end
+
+    desc 'Build the Java API client given the swagger definition in doc/swagger/swagger.json'
+    task :java do
+      build_client 'java'
+    end
+
+    desc 'Build the Scala API client given the swagger definition in doc/swagger/swagger.json'
+    task :scala do
+      build_client 'scala'
+    end
+
+    desc 'Build the Python API client given the swagger definition in doc/swagger/swagger.json'
+    task :python do
+      build_client 'python'
+    end
+
+    desc 'Build the Python 3 API client given the swagger definition in doc/swagger/swagger.json'
+    task :python_3 do
+      build_client 'python'
+    end
+
+    desc 'Build the PHP API client given the swagger definition in doc/swagger/swagger.json'
+    task :php do
+      build_client 'php'
+    end
+
+    desc 'Build the Perl API client given the swagger definition in doc/swagger/swagger.json'
+    task :perl do
+      build_client 'perl'
+    end
+
+    desc 'Build the ObjectiveC API client given the swagger definition in doc/swagger/swagger.json'
+    task :objective_c do
+      build_client 'objc'
+    end
+
+    desc 'Build the C# API client given the swagger definition in doc/swagger/swagger.json'
+    task :c_sharp do
+      build_client 'csharp'
+    end
+
+    desc 'Build the Android API client given the swagger definition in doc/swagger/swagger.json'
+    task :android do
+      build_client 'android'
+    end
+
+    desc 'Build all the API clients'
+    task :all => [:ruby, :java, :python, :python_3, :php, :perl, :objective_c, :c_sharp, :android]
+
+    task :default => [:all]
+
+  end
+end

metadata

@@ -0,0 +1,176 @@
+--- !ruby/object:Gem::Specification
+name: ruby-swagger
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Luca Bonmassar
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-07-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: addressable
+  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.9.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+- !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'
+- !ruby/object:Gem::Dependency
+  name: grape
+  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'
+- !ruby/object:Gem::Dependency
+  name: grape-entity
+  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'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  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: |-
+  A super simple library to read or create (Swagger)[http://swagger.io/] API documents.
+  This is the engine used in other gems to translate API definitions (grape, rails) into Swagger definitions.
+email:
+- luca@gild.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/ruby-swagger.rb
+- lib/ruby-swagger/data/contact.rb
+- lib/ruby-swagger/data/definitions.rb
+- lib/ruby-swagger/data/document.rb
+- lib/ruby-swagger/data/example.rb
+- lib/ruby-swagger/data/external_documentation.rb
+- lib/ruby-swagger/data/header.rb
+- lib/ruby-swagger/data/headers.rb
+- lib/ruby-swagger/data/info.rb
+- lib/ruby-swagger/data/items.rb
+- lib/ruby-swagger/data/license.rb
+- lib/ruby-swagger/data/mime.rb
+- lib/ruby-swagger/data/operation.rb
+- lib/ruby-swagger/data/parameter.rb
+- lib/ruby-swagger/data/parameters.rb
+- lib/ruby-swagger/data/path.rb
+- lib/ruby-swagger/data/paths.rb
+- lib/ruby-swagger/data/reference.rb
+- lib/ruby-swagger/data/response.rb
+- lib/ruby-swagger/data/responses.rb
+- lib/ruby-swagger/data/schema.rb
+- lib/ruby-swagger/data/scopes.rb
+- lib/ruby-swagger/data/security_definitions.rb
+- lib/ruby-swagger/data/security_requirement.rb
+- lib/ruby-swagger/data/security_scheme.rb
+- lib/ruby-swagger/data/tag.rb
+- lib/ruby-swagger/data/url.rb
+- lib/ruby-swagger/data/xml_object.rb
+- lib/ruby-swagger/grape/grape.rb
+- lib/ruby-swagger/grape/grape_config.rb
+- lib/ruby-swagger/grape/grape_presenter.rb
+- lib/ruby-swagger/grape/grape_template.rb
+- lib/ruby-swagger/grape/method.rb
+- lib/ruby-swagger/grape/param.rb
+- lib/ruby-swagger/grape/route_path.rb
+- lib/ruby-swagger/grape/routes.rb
+- lib/ruby-swagger/grape/type.rb
+- lib/ruby-swagger/io/comparable.rb
+- lib/ruby-swagger/io/definitions.rb
+- lib/ruby-swagger/io/file_system.rb
+- lib/ruby-swagger/io/paths.rb
+- lib/ruby-swagger/io/security.rb
+- lib/ruby-swagger/object.rb
+- lib/ruby-swagger/railtie.rb
+- lib/ruby-swagger/template.rb
+- lib/tasks/swagger.rake
+homepage: https://github.com/gild/ruby-swagger
+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: A ruby DSL to read/write Swagger API documents
+test_files: []