apipie-rails 0.3.6 → 0.9.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +5 -5
- data/.github/workflows/build.yml +67 -0
- data/.github/workflows/rubocop-challenger.yml +28 -0
- data/.gitignore +2 -0
- data/.rubocop.yml +37 -0
- data/.rubocop_todo.yml +1991 -0
- data/CHANGELOG.md +246 -2
- data/PROPOSAL_FOR_RESPONSE_DESCRIPTIONS.md +244 -0
- data/README.rst +646 -25
- data/Rakefile +0 -5
- data/apipie-rails.gemspec +14 -9
- data/app/controllers/apipie/apipies_controller.rb +51 -20
- data/app/public/apipie/javascripts/bundled/bootstrap-collapse.js +70 -41
- data/app/public/apipie/javascripts/bundled/bootstrap.js +1033 -479
- data/app/public/apipie/javascripts/bundled/jquery.js +5 -5
- data/app/public/apipie/stylesheets/bundled/bootstrap-responsive.min.css +9 -12
- data/app/public/apipie/stylesheets/bundled/bootstrap.min.css +9 -689
- data/app/views/apipie/apipies/_method_detail.erb +21 -0
- data/app/views/apipie/apipies/_params.html.erb +4 -2
- data/app/views/apipie/apipies/index.html.erb +5 -1
- data/app/views/apipie/apipies/resource.html.erb +3 -0
- data/app/views/layouts/apipie/apipie.html.erb +1 -1
- data/config/locales/en.yml +1 -0
- data/config/locales/fr.yml +31 -0
- data/config/locales/it.yml +31 -0
- data/config/locales/ja.yml +31 -0
- data/config/locales/ko.yml +31 -0
- data/config/locales/pt-BR.yml +1 -1
- data/gemfiles/Gemfile.rails50 +10 -0
- data/gemfiles/Gemfile.rails51 +10 -0
- data/gemfiles/Gemfile.rails52 +10 -0
- data/gemfiles/Gemfile.rails60 +17 -0
- data/gemfiles/Gemfile.rails61 +17 -0
- data/gemfiles/Gemfile.rails70 +17 -0
- data/lib/apipie/apipie_module.rb +22 -4
- data/lib/apipie/application.rb +54 -25
- data/lib/apipie/configuration.rb +26 -4
- data/lib/apipie/core_ext/route.rb +9 -0
- data/lib/apipie/dsl_definition.rb +168 -16
- data/lib/apipie/error_description.rb +9 -2
- data/lib/apipie/errors.rb +34 -0
- data/lib/apipie/extractor/collector.rb +4 -0
- data/lib/apipie/extractor/recorder.rb +14 -12
- data/lib/apipie/extractor/writer.rb +86 -58
- data/lib/apipie/extractor.rb +5 -5
- data/lib/apipie/generator/generator.rb +2 -0
- data/lib/apipie/generator/swagger/swagger.rb +2 -0
- data/lib/apipie/generator/swagger/type.rb +16 -0
- data/lib/apipie/generator/swagger/type_extractor.rb +70 -0
- data/lib/apipie/generator/swagger/warning.rb +77 -0
- data/lib/apipie/generator/swagger/warning_writer.rb +48 -0
- data/lib/apipie/markup.rb +14 -11
- data/lib/apipie/method_description/api.rb +12 -0
- data/lib/apipie/method_description/apis_service.rb +82 -0
- data/lib/apipie/method_description.rb +51 -49
- data/lib/apipie/param_description.rb +63 -5
- data/lib/apipie/resource_description.rb +11 -4
- data/lib/apipie/response_description.rb +131 -0
- data/lib/apipie/response_description_adapter.rb +200 -0
- data/lib/apipie/routes_formatter.rb +1 -1
- data/lib/apipie/rspec/response_validation_helper.rb +194 -0
- data/lib/apipie/static_dispatcher.rb +5 -2
- data/lib/apipie/swagger_generator.rb +717 -0
- data/lib/apipie/tag_list_description.rb +11 -0
- data/lib/apipie/validator.rb +83 -9
- data/lib/apipie/version.rb +1 -1
- data/lib/apipie-rails.rb +15 -4
- data/lib/generators/apipie/install/install_generator.rb +1 -1
- data/lib/generators/apipie/views_generator.rb +1 -1
- data/lib/tasks/apipie.rake +115 -15
- data/rel-eng/gem_release.ipynb +398 -0
- data/spec/controllers/apipies_controller_spec.rb +79 -14
- data/spec/controllers/concerns_controller_spec.rb +2 -2
- data/spec/controllers/extended_controller_spec.rb +14 -0
- data/spec/controllers/included_param_group_controller_spec.rb +13 -0
- data/spec/controllers/memes_controller_spec.rb +10 -0
- data/spec/controllers/users_controller_spec.rb +139 -76
- data/spec/dummy/Rakefile +1 -1
- data/spec/dummy/app/controllers/application_controller.rb +5 -1
- data/spec/dummy/app/controllers/concerns_controller.rb +1 -1
- data/spec/dummy/app/controllers/extended_controller.rb +14 -0
- data/spec/dummy/app/controllers/extending_concern.rb +10 -0
- data/spec/dummy/app/controllers/included_param_group_controller.rb +19 -0
- data/spec/dummy/app/controllers/overridden_concerns_controller.rb +2 -2
- data/spec/dummy/app/controllers/pets_controller.rb +408 -0
- data/spec/dummy/app/controllers/pets_using_auto_views_controller.rb +73 -0
- data/spec/dummy/app/controllers/pets_using_self_describing_classes_controller.rb +95 -0
- data/spec/dummy/app/controllers/{concerns/sample_controller.rb → sample_controller.rb} +5 -7
- data/spec/dummy/app/controllers/tagged_cats_controller.rb +32 -0
- data/spec/dummy/app/controllers/tagged_dogs_controller.rb +15 -0
- data/spec/dummy/app/controllers/twitter_example_controller.rb +5 -0
- data/spec/dummy/app/controllers/users_controller.rb +26 -12
- data/spec/dummy/app/helpers/random_param_group.rb +8 -0
- data/spec/dummy/components/test_engine/Gemfile +6 -0
- data/spec/dummy/components/test_engine/app/controllers/test_engine/application_controller.rb +4 -0
- data/spec/dummy/components/test_engine/app/controllers/test_engine/memes_controller.rb +37 -0
- data/spec/dummy/components/test_engine/config/routes.rb +3 -0
- data/spec/dummy/components/test_engine/db/.gitkeep +0 -0
- data/spec/dummy/components/test_engine/lib/test_engine.rb +7 -0
- data/spec/dummy/components/test_engine/test_engine.gemspec +11 -0
- data/spec/dummy/config/application.rb +6 -4
- data/spec/dummy/config/boot.rb +2 -2
- data/spec/dummy/config/environment.rb +1 -1
- data/spec/dummy/config/environments/development.rb +3 -3
- data/spec/dummy/config/environments/production.rb +3 -3
- data/spec/dummy/config/environments/test.rb +3 -5
- data/spec/dummy/config/initializers/apipie.rb +5 -3
- data/spec/dummy/config/routes.rb +25 -1
- data/spec/dummy/config.ru +1 -1
- data/spec/dummy/script/rails +2 -2
- data/spec/lib/application_spec.rb +1 -1
- data/spec/lib/extractor/writer_spec.rb +37 -7
- data/spec/lib/file_handler_spec.rb +25 -0
- data/spec/lib/generator/swagger/type_extractor_spec.rb +61 -0
- data/spec/lib/generator/swagger/warning_spec.rb +51 -0
- data/spec/lib/generator/swagger/warning_writer_spec.rb +59 -0
- data/spec/lib/method_description/apis_service_spec.rb +60 -0
- data/spec/lib/method_description_spec.rb +34 -0
- data/spec/lib/param_description_spec.rb +90 -4
- data/spec/lib/rake_spec.rb +2 -4
- data/spec/lib/swagger/openapi_2_0_schema.json +1607 -0
- data/spec/lib/swagger/rake_swagger_spec.rb +154 -0
- data/spec/lib/swagger/response_validation_spec.rb +104 -0
- data/spec/lib/swagger/swagger_dsl_spec.rb +658 -0
- data/spec/lib/validator_spec.rb +59 -1
- data/spec/lib/validators/array_validator_spec.rb +28 -8
- data/spec/spec_helper.rb +49 -3
- data/spec/support/custom_bool_validator.rb +17 -0
- metadata +104 -99
- data/.travis.yml +0 -12
- data/Gemfile +0 -7
- data/Gemfile.rails32 +0 -6
- data/Gemfile.rails40 +0 -5
- data/Gemfile.rails41 +0 -5
- data/Gemfile.rails42 +0 -5
- data/lib/apipie/client/generator.rb +0 -135
@@ -1,135 +0,0 @@
|
|
1
|
-
#!/bin/env ruby
|
2
|
-
# -*- coding: utf-8 -*-
|
3
|
-
require 'rubygems'
|
4
|
-
require 'thor'
|
5
|
-
require 'thor/group'
|
6
|
-
require 'fileutils'
|
7
|
-
require 'active_support/inflector'
|
8
|
-
require 'apipie/client/base'
|
9
|
-
|
10
|
-
module Apipie
|
11
|
-
module Client
|
12
|
-
|
13
|
-
class Generator < Thor::Group
|
14
|
-
include Thor::Actions
|
15
|
-
|
16
|
-
# Define arguments and options
|
17
|
-
argument :name
|
18
|
-
argument :subject
|
19
|
-
argument :suffix
|
20
|
-
argument :version
|
21
|
-
|
22
|
-
attr_reader :doc, :resource, :resource_key
|
23
|
-
|
24
|
-
def initialize(*args)
|
25
|
-
super
|
26
|
-
@doc = Apipie.to_json(version)[:docs]
|
27
|
-
end
|
28
|
-
|
29
|
-
def self.source_root
|
30
|
-
File.expand_path("../template", __FILE__)
|
31
|
-
end
|
32
|
-
|
33
|
-
def self.destination_root(name, suffix)
|
34
|
-
File.join(FileUtils.pwd, "#{name}#{suffix}")
|
35
|
-
end
|
36
|
-
|
37
|
-
def self.start(client_name, subject = :all, suffix = '_client', version = nil)
|
38
|
-
name = client_name.parameterize.underscore
|
39
|
-
suffix = suffix.parameterize.underscore
|
40
|
-
super([name, subject, suffix, version], :destination_root => destination_root(name, suffix))
|
41
|
-
end
|
42
|
-
|
43
|
-
def all?
|
44
|
-
subject == :all
|
45
|
-
end
|
46
|
-
|
47
|
-
def generate_cli
|
48
|
-
full_name = "#{name}#{suffix}"
|
49
|
-
template("README.tt", "README")
|
50
|
-
template("Gemfile.tt", "Gemfile")
|
51
|
-
template("Rakefile.tt", "Rakefile")
|
52
|
-
template("a_name.gemspec.tt", "#{full_name}.gemspec")
|
53
|
-
template("lib/a_name.rb.tt", "lib/#{full_name}.rb")
|
54
|
-
template("lib/a_name/version.rb.tt", "lib/#{full_name}/version.rb")
|
55
|
-
create_file "lib/#{full_name}/documentation.json", JSON.dump(Apipie.to_json)
|
56
|
-
copy_file "lib/a_name/config.yml", "lib/#{full_name}/config.yml"
|
57
|
-
if all?
|
58
|
-
template("bin/bin.rb.tt", "bin/#{full_name}")
|
59
|
-
chmod("bin/#{full_name}", 0755)
|
60
|
-
end
|
61
|
-
doc[:resources].each do |key, resource|
|
62
|
-
@resource_key, @resource = key, resource
|
63
|
-
if all?
|
64
|
-
template("lib/a_name/commands/cli.rb.tt", "lib/#{full_name}/commands/#{resource_name}.thor")
|
65
|
-
end
|
66
|
-
template("lib/a_name/resources/resource.rb.tt", "lib/#{full_name}/resources/#{resource_name}.rb")
|
67
|
-
end
|
68
|
-
end
|
69
|
-
|
70
|
-
protected
|
71
|
-
|
72
|
-
def camelizer(string)
|
73
|
-
string = string.sub(/^[a-z\d]*/) { $&.capitalize }
|
74
|
-
string.gsub(/(?:_|(\/))([a-z\d]*)/i) { "#{$2.capitalize}" }
|
75
|
-
end
|
76
|
-
|
77
|
-
def class_base
|
78
|
-
@class_base ||= camelizer(name)
|
79
|
-
end
|
80
|
-
|
81
|
-
def class_suffix
|
82
|
-
@class_suffix ||= camelizer(suffix)
|
83
|
-
end
|
84
|
-
|
85
|
-
def plaintext(text)
|
86
|
-
text.gsub(/<.*?>/, '').gsub("\n", ' ').strip
|
87
|
-
end
|
88
|
-
|
89
|
-
# Resource related helper methods:
|
90
|
-
|
91
|
-
def resource_name
|
92
|
-
resource[:name].gsub(/\s/, "_").downcase.singularize
|
93
|
-
end
|
94
|
-
|
95
|
-
def api(method)
|
96
|
-
method[:apis].first
|
97
|
-
end
|
98
|
-
|
99
|
-
def params_in_path(method)
|
100
|
-
api(method)[:api_url].scan(/:([^\/]*)/).map(&:first)
|
101
|
-
end
|
102
|
-
|
103
|
-
def client_args(method)
|
104
|
-
params_in_path(method).dup
|
105
|
-
end
|
106
|
-
|
107
|
-
def substituted_url(method)
|
108
|
-
params_in_path(method).reduce(api(method)[:api_url]) { |u, p| u.sub(":#{p}", "\#{#{p}}") }
|
109
|
-
end
|
110
|
-
|
111
|
-
def transformation_hash(method)
|
112
|
-
method[:params].find_all { |p| p[:expected_type] == "hash" && !p[:params].nil? }.reduce({ }) do |h, p|
|
113
|
-
h.update(p[:name] => p[:params].map { |pp| pp[:name] })
|
114
|
-
end
|
115
|
-
end
|
116
|
-
|
117
|
-
def validation(method)
|
118
|
-
stringify = lambda do |object|
|
119
|
-
case object
|
120
|
-
when Hash
|
121
|
-
clone = object.dup
|
122
|
-
object.keys.each { |key| clone[key.to_s] = stringify[clone.delete(key)] }
|
123
|
-
clone
|
124
|
-
when Array
|
125
|
-
object.map { |value| stringify[value] }
|
126
|
-
else
|
127
|
-
object
|
128
|
-
end
|
129
|
-
end
|
130
|
-
Apipie::Client::Base.construct_validation_hash(stringify[method])
|
131
|
-
end
|
132
|
-
end
|
133
|
-
|
134
|
-
end
|
135
|
-
end
|