ruby-swagger 0.0.3 → 0.1.0

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

@@ -1,30 +1,27 @@
 module Swagger::IO
   class Comparable
-
     def self.copy_description_old_definition(definition, old_definition)
       return if definition.nil? || old_definition.nil? || definition.class != old_definition.class
 
       case definition
-        when Hash
-
-          definition.keys.each do |key|
-            old_v = definition[key]
+      when Hash
 
-            if (key == 'description' || key == 'summary') && old_definition[key]
-              definition[key] = old_definition[key]
-            end
+        definition.keys.each do |key|
+          old_v = definition[key]
 
-            if old_v.is_a?(Hash) || old_v.is_a?(Array)
-              copy_description_old_definition(definition[key], old_definition[key])
-            end
+          if (key == 'description' || key == 'summary') && old_definition[key]
+            definition[key] = old_definition[key]
           end
-        when Array
-          definition.each_with_index do |item, index|
-            copy_description_old_definition(definition[index], old_definition[index])
+
+          if old_v.is_a?(Hash) || old_v.is_a?(Array)
+            copy_description_old_definition(definition[key], old_definition[key])
           end
+        end
+      when Array
+        definition.each_with_index do |_item, index|
+          copy_description_old_definition(definition[index], old_definition[index])
+        end
       end
     end
-
   end
-
 end

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

@@ -3,12 +3,11 @@ require 'ruby-swagger/io/comparable'
 
 module Swagger::IO
   class Definitions
-
     def self.read_definitions
       definitions = {}
 
-      Swagger::IO::FileSystem.all_files("definitions/**/*.yml").each do |file|
-        definitions[File.basename(file, ".yml")] = YAML::load_file(file)
+      Swagger::IO::FileSystem.all_files('definitions/**/*.yml').each do |file|
+        definitions[File.basename(file, '.yml')] = YAML.load_file(file)
       end
 
       definitions
@@ -17,20 +16,18 @@ module Swagger::IO
     def self.write_definitions(definitions)
       return if definitions.nil?
 
-      #Remove dead definitions
-      Swagger::IO::FileSystem.all_files("definitions/**/*.yml").each do |file|
-        def_name = File.basename(file, ".yml")
+      # Remove dead definitions
+      Swagger::IO::FileSystem.all_files('definitions/**/*.yml').each do |file|
+        def_name = File.basename(file, '.yml')
 
         unless definitions[def_name]
           STDERR.puts "#{def_name} is not present anymore, removing #{file}"
           Swagger::IO::FileSystem.delete_file(file)
         end
-
       end
 
       # Write new definitions
       definitions.each do |definition_name, definition|
-
         # If an old definition exists, we copy over the documentation to the generated definition
         if Swagger::IO::FileSystem.file_exists?("definitions/#{definition_name}.yml")
           old_definition = Swagger::IO::FileSystem.read_file("definitions/#{definition_name}.yml")
@@ -41,8 +38,5 @@ module Swagger::IO
         Swagger::IO::FileSystem.write_file(definition.to_yaml, "definitions/#{definition_name}.yml", true)
       end
     end
-
-
   end
-
 end

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

@@ -3,10 +3,10 @@ require 'ruby-swagger/data/document'
 require 'ruby-swagger/io/security'
 require 'ruby-swagger/io/definitions'
 require 'ruby-swagger/io/paths'
+require 'erb'
 
 module Swagger::IO
   class FileSystem
-
     DOC_SUBPARTS = %w(responses security tags)
 
     @@default_path = './doc/swagger'
@@ -20,7 +20,7 @@ module Swagger::IO
     end
 
     def self.init_fs_structure
-      FileUtils.mkdir_p(@@default_path) unless Dir.exists?(@@default_path)
+      FileUtils.mkdir_p(@@default_path) unless Dir.exist?(@@default_path)
     end
 
     def self.read_file(name)
@@ -30,16 +30,16 @@ module Swagger::IO
     def self.write_file(content, location, overwrite = false)
       file_path = @@default_path + '/' + location
 
-      return if !overwrite && File.exists?(file_path)
+      return if !overwrite && File.exist?(file_path)
 
       dir_path = File.dirname(file_path)
 
-      FileUtils.mkdir_p(dir_path) unless Dir.exists?(dir_path)
-      File.open(file_path, 'w') {|f| f.write(content) }
+      FileUtils.mkdir_p(dir_path) unless Dir.exist?(dir_path)
+      File.open(file_path, 'w') { |f| f.write(content) }
     end
 
     def self.file_exists?(name)
-      File.exists?(@@default_path + '/' + name)
+      File.exist?(@@default_path + '/' + name)
     end
 
     def self.all_files(pattern)
@@ -61,7 +61,7 @@ module Swagger::IO
 
       Swagger::IO::Paths.write_paths(swagger.delete('paths'))
 
-      DOC_SUBPARTS.each {|doc_part| write_subpart(doc_part, swagger.delete(doc_part))}
+      DOC_SUBPARTS.each { |doc_part| write_subpart(doc_part, swagger.delete(doc_part)) }
       Swagger::IO::Definitions.write_definitions(swagger.delete('definitions'))
       Swagger::IO::Security.write_security_definitions(swagger.delete('securityDefinitions'))
       Swagger::IO::FileSystem.write_file(swagger.to_yaml, 'base_doc.yml')
@@ -78,7 +78,7 @@ module Swagger::IO
       doc['paths'] = Swagger::IO::Paths.read_paths
       doc['definitions'] = Swagger::IO::Definitions.read_definitions
       doc['securityDefinitions'] = Swagger::IO::Security.read_security_definitions
- 
+
       Swagger::Data::Document.parse(doc)
     end
 
@@ -92,6 +92,5 @@ module Swagger::IO
       return unless content
       write_file(content.to_yaml, "#{subpart}.yml")
     end
-
   end
 end

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

@@ -2,16 +2,15 @@ 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)
+        content = YAML.load_file(file)
         paths[File.dirname(file[l..file.length])] ||= {}
-        paths[File.dirname(file[l..file.length])][File.basename(file, ".yml")] = content
+        paths[File.dirname(file[l..file.length])][File.basename(file, '.yml')] = content
       end
 
       paths
@@ -22,20 +21,18 @@ module Swagger::IO
 
       l = (Swagger::IO::FileSystem.default_path + '/paths').length
 
-      #Remove dead endpoints
-      Swagger::IO::FileSystem.all_files("paths/**/*.yml").each do |file|
+      # 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?
+        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
@@ -45,11 +42,9 @@ module Swagger::IO
             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
+end

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

@@ -2,7 +2,6 @@ require 'ruby-swagger/io/file_system'
 
 module Swagger::IO
   class Security
-
     SECURITY_FILE_NAME = 'securityDefinitions.yml'
 
     def self.write_security_definitions(security_definitions)
@@ -19,8 +18,8 @@ module Swagger::IO
       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)
+      Swagger::IO::FileSystem.all_files('/scopes/*.yml').each do |file|
+        definitions[File.basename(file, '.yml')]['scopes'] = YAML.load_file(file)
       end
 
       definitions
@@ -34,12 +33,10 @@ module Swagger::IO
 
       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
+      # 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

@@ -1,11 +1,10 @@
 module Swagger
   class Object
-
     @@swagger_attribs = {}
 
     def self.attr_swagger(*attributes)
       attr_accessor(*attributes)
-      @@swagger_attribs[self.to_s] = *attributes
+      @@swagger_attribs[to_s] = *attributes
     end
 
     def swagger_attributes
@@ -26,7 +25,7 @@ module Swagger
 
     def bulk_set(object)
       swagger_attributes.each do |attribute|
-        self.send("#{attribute}=", object[attribute.to_s])
+        send("#{attribute}=", object[attribute.to_s])
       end
 
       self
@@ -40,10 +39,10 @@ module Swagger
       return swagger unless swagger_attributes
 
       swagger_attributes.each do |property|
-        obj = self.send(property)
+        obj = send(property)
         obj = swaggerify(obj)
 
-        swagger[property.to_s] = obj if !obj.nil?
+        swagger[property.to_s] = obj unless obj.nil?
       end
 
       swagger
@@ -62,6 +61,5 @@ module Swagger
 
       object
     end
-
   end
-end
+end

data/lib/ruby-swagger/railtie.rb

@@ -4,4 +4,4 @@ module Swagger
       load "#{File.dirname(__FILE__)}/../tasks/swagger.rake"
     end
   end
-end
+end

data/lib/ruby-swagger/template.rb

@@ -2,7 +2,6 @@ require 'ruby-swagger/data/document'
 
 module Swagger
   class Template
-
     def self.generate
       swagger_doc = Swagger::Data::Document.new
 
@@ -14,7 +13,7 @@ module Swagger
       swagger_doc.host = 'localhost:80'
       swagger_doc.basePath = '/api/v1'
 
-      swagger_doc.schemes = ['https', 'http']
+      swagger_doc.schemes = %w(https http)
       swagger_doc.produces = ['application/json']
       swagger_doc.consumes = ['application/json']
 
@@ -24,6 +23,5 @@ module Swagger
 
       swagger_doc
     end
-
   end
-end
+end

data/lib/tasks/swagger.rake

@@ -2,9 +2,7 @@ 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
@@ -12,11 +10,11 @@ namespace :swagger do
     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|
+    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 'You need to pass a base class for your API'
         STDERR.puts "For example: rake 'swagger:grape:generate_doc[ApiBase]'"
-        exit -1
+        exit(-1)
       end
 
       puts "Exporting from Grape - base class #{args[:base_class]}"
@@ -28,12 +26,11 @@ namespace :swagger do
       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"
+    puts 'Compiling documentation'
 
     Swagger::IO::FileSystem.new(Swagger::IO::FileSystem.read).compile!
 
@@ -42,23 +39,22 @@ namespace :swagger do
 
   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
+      unless File.exist?('./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')
+      unless File.exist?('vendor/swagger-codegen-cli.jar')
+        STDERR.puts 'Swagger codegen does not exist, downloading it now...'
+        Dir.mkdir('./vendor') unless Dir.exist?('./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}")
+      FileUtils.rm_rf("./api_client/#{language}") if Dir.exist?("./api_client/#{language}")
 
       `java -jar ./vendor/swagger-codegen-cli.jar generate \
             -i ./doc/swagger/swagger.json \
@@ -117,9 +113,8 @@ namespace :swagger do
     end
 
     desc 'Build all the API clients'
-    task :all => [:ruby, :java, :python, :python_3, :php, :perl, :objective_c, :c_sharp, :android]
-
-    task :default => [:all]
+    task all: [:ruby, :java, :python, :python_3, :php, :perl, :objective_c, :c_sharp, :android]
 
+    task default: [:all]
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-swagger
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
 platform: ruby
 authors:
 - Luca Bonmassar
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-14 00:00:00.000000000 Z
+date: 2016-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -70,16 +70,16 @@ dependencies:
   name: grape-entity
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.5'
 - !ruby/object:Gem::Dependency
   name: rack-test
   requirement: !ruby/object:Gem::Requirement
@@ -131,6 +131,9 @@ files:
 - lib/ruby-swagger/data/tag.rb
 - lib/ruby-swagger/data/url.rb
 - lib/ruby-swagger/data/xml_object.rb
+- lib/ruby-swagger/grape/entity.rb
+- lib/ruby-swagger/grape/entity_exposure.rb
+- lib/ruby-swagger/grape/entity_nesting_exposure.rb
 - lib/ruby-swagger/grape/grape.rb
 - lib/ruby-swagger/grape/grape_config.rb
 - lib/ruby-swagger/grape/grape_presenter.rb
@@ -169,7 +172,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: A ruby DSL to read/write Swagger API documents