apipie-rails 0.1.3 → 0.2.0

data/lib/apipie/param_description.rb

@@ -39,7 +39,8 @@ module Apipie
       @method_description = method_description
       @name = concern_subst(name)
       @as = options[:as] || @name
-      @desc = concern_subst(Apipie.markup_to_html(@options[:desc] || ''))
+      @desc = preformat_text(@options[:desc])
+
       @parent = @options[:parent]
       @metadata = @options[:meta]
 
@@ -99,10 +100,10 @@ module Apipie
       ret
     end
 
-    def to_json
+    def to_json(lang = nil)
       hash = { :name => name.to_s,
                :full_name => full_name,
-               :description => desc,
+               :description => preformat_text(Apipie.app.translate(@options[:desc], lang)),
                :required => required,
                :allow_nil => allow_nil,
                :validator => validator.to_s,
@@ -110,7 +111,7 @@ module Apipie
                :metadata => metadata,
                :show => show }
       if sub_params = validator.params_ordered
-        hash[:params] = sub_params.map(&:to_json)
+        hash[:params] = sub_params.map { |p| p.to_json(lang)}
       end
       hash
     end
@@ -198,6 +199,10 @@ module Apipie
       return replaced
     end
 
+    def preformat_text(text)
+      concern_subst(Apipie.markup_to_html(text || ''))
+    end
+
   end
 
 end

data/lib/apipie/resource_description.rb

@@ -81,20 +81,20 @@ module Apipie
 
     def api_url; "#{Apipie.api_base_url(_version)}#{@_path}"; end
 
-    def to_json(method_name = nil)
+    def to_json(method_name = nil, lang = nil)
 
       methods = if method_name.blank?
-        @_methods.collect { |key, method_description| method_description.to_json}
+        @_methods.collect { |key, method_description| method_description.to_json(lang) }
       else
-        [@_methods[method_name.to_sym].to_json]
+        [@_methods[method_name.to_sym].to_json(lang)]
       end
 
       {
         :doc_url => doc_url,
         :api_url => api_url,
         :name => @_name,
-        :short_description => @_short_description,
-        :full_description => @_full_description,
+        :short_description => Apipie.app.translate(@_short_description, lang),
+        :full_description => Apipie.app.translate(@_full_description, lang),
         :version => _version,
         :formats => @_formats,
         :metadata => @_metadata,

data/lib/apipie/routing.rb

@@ -4,7 +4,7 @@ module Apipie
       def apipie
         namespace "apipie", :path => Apipie.configuration.doc_base_url do
           get 'apipie_checksum', :to => "apipies#apipie_checksum", :format => "json"
-          constraints(:version => /[^\/]+/) do
+          constraints(:version => /[^\/]+/, :resource => /[^\/]+/, :method => /[^\/]+/) do
             get("(:version)/(:resource)/(:method)" => "apipies#index", :as => :apipie)
           end
         end

data/lib/apipie/version.rb

@@ -1,3 +1,3 @@
 module Apipie
-  VERSION = '0.1.3'
+  VERSION = '0.2.0'
 end

data/lib/generators/apipie/install/templates/initializer.rb.erb

@@ -2,6 +2,6 @@ Apipie.configure do |config|
   config.app_name                = "<%= Rails.application.class.name[/^\w+/] %>"
   config.api_base_url            = "<%= options.api_path %>"
   config.doc_base_url            = "<%= options.route %>"
-  # were is your API defined?
+  # where is your API defined?
   config.api_controllers_matcher = "#{Rails.root}/app/controllers/*.rb"
 end

data/lib/tasks/apipie.rake

@@ -23,16 +23,19 @@ namespace :apipie do
       subdir = File.basename(out)
       copy_jscss(out)
       Apipie.configuration.version_in_url = false
-      Apipie.url_prefix = "./#{subdir}"
-      doc = Apipie.to_json(args[:version])
-      doc[:docs][:link_extension] = '.html'
-      generate_one_page(out, doc)
-      generate_plain_page(out, doc)
-      generate_index_page(out, doc)
-      Apipie.url_prefix = "../#{subdir}"
-      generate_resource_pages(args[:version], out, doc)
-      Apipie.url_prefix = "../../#{subdir}"
-      generate_method_pages(args[:version], out, doc)
+      ([nil] + Apipie.configuration.languages).each do |lang|
+        I18n.locale = lang || Apipie.configuration.default_locale
+        Apipie.url_prefix = "./#{subdir}"
+        doc = Apipie.to_json(args[:version], nil, nil, lang)
+        doc[:docs][:link_extension] = "#{lang_ext(lang)}.html"
+        generate_one_page(out, doc, lang)
+        generate_plain_page(out, doc, lang)
+        generate_index_page(out, doc, false, false, lang)
+        Apipie.url_prefix = "../#{subdir}"
+        generate_resource_pages(args[:version], out, doc, false, lang)
+        Apipie.url_prefix = "../../#{subdir}"
+        generate_method_pages(args[:version], out, doc, false, lang)
+      end
     end
   end
 
@@ -41,32 +44,43 @@ namespace :apipie do
     with_loaded_documentation do
       args.with_defaults(:version => Apipie.configuration.default_version)
       out = ENV["OUT"] || File.join(::Rails.root, 'doc', 'apidoc')
-      doc = Apipie.to_json(args[:version])
-      generate_json_page(out, doc)
+      ([nil] + Apipie.configuration.languages).each do |lang|
+        doc = Apipie.to_json(args[:version], nil, nil, lang)
+        generate_json_page(out, doc, lang)
+      end
     end
   end
 
   desc "Generate cache to avoid production dependencies on markup languages"
   task :cache => :environment do
+    puts "#{Time.now} | Started"
     with_loaded_documentation do
-      cache_dir = Apipie.configuration.cache_dir
-      subdir = Apipie.configuration.doc_base_url.sub(/\A\//,"")
-
-      file_base = File.join(cache_dir, Apipie.configuration.doc_base_url)
-      Apipie.url_prefix = "./#{subdir}"
-      doc = Apipie.to_json(Apipie.configuration.default_version)
-      generate_index_page(file_base, doc, true)
-      Apipie.available_versions.each do |version|
-        file_base_version = File.join(file_base, version)
-        Apipie.url_prefix = "../#{subdir}"
-        doc = Apipie.to_json(version)
-        generate_index_page(file_base_version, doc, true, true)
-        Apipie.url_prefix = "../../#{subdir}"
-        generate_resource_pages(version, file_base_version, doc, true)
-        Apipie.url_prefix = "../../../#{subdir}"
-        generate_method_pages(version, file_base_version, doc, true)
+      puts "#{Time.now} | Documents loaded..."
+      ([nil] + Apipie.configuration.languages).each do |lang|
+        I18n.locale = lang || Apipie.configuration.default_locale
+        puts "#{Time.now} | Processing docs for #{lang}"
+        cache_dir = Apipie.configuration.cache_dir
+        subdir = Apipie.configuration.doc_base_url.sub(/\A\//,"")
+
+        file_base = File.join(cache_dir, Apipie.configuration.doc_base_url)
+        Apipie.url_prefix = "./#{subdir}"
+        doc = Apipie.to_json(Apipie.configuration.default_version, nil, nil, lang)
+        doc[:docs][:link_extension] = (lang ? ".#{lang}.html" : ".html")
+        generate_index_page(file_base, doc, true, false, lang)
+        Apipie.available_versions.each do |version|
+          file_base_version = File.join(file_base, version)
+          Apipie.url_prefix = "../#{subdir}"
+          doc = Apipie.to_json(version, nil, nil, lang)
+          doc[:docs][:link_extension] = (lang ? ".#{lang}.html" : ".html")
+          generate_index_page(file_base_version, doc, true, true, lang)
+          Apipie.url_prefix = "../../#{subdir}"
+          generate_resource_pages(version, file_base_version, doc, true, lang)
+          Apipie.url_prefix = "../../../#{subdir}"
+          generate_method_pages(version, file_base_version, doc, true, lang)
+        end
       end
     end
+    puts "#{Time.now} | Finished"
   end
 
   # Attempt to use the Rails application views, otherwise default to built in views
@@ -94,57 +108,64 @@ namespace :apipie do
     end
   end
 
-  def generate_json_page(file_base, doc)
+  def generate_json_page(file_base, doc, lang = nil)
     FileUtils.mkdir_p(file_base) unless File.exists?(file_base)
 
-    filename = 'schema_apipie.json'
+    filename = "schema_apipie#{lang_ext(lang)}.json"
     File.open("#{file_base}/#{filename}", 'w') { |file| file.write(JSON.pretty_generate(doc)) }
   end
 
-  def generate_one_page(file_base, doc)
+  def generate_one_page(file_base, doc, lang = nil)
     FileUtils.mkdir_p(File.dirname(file_base)) unless File.exists?(File.dirname(file_base))
 
-    render_page("#{file_base}-onepage.html", "static", {:doc => doc[:docs]})
+    render_page("#{file_base}-onepage#{lang_ext(lang)}.html", "static", {:doc => doc[:docs],
+      :language => lang, :languages => Apipie.configuration.languages})
   end
 
-  def generate_plain_page(file_base, doc)
+  def generate_plain_page(file_base, doc, lang = nil)
     FileUtils.mkdir_p(File.dirname(file_base)) unless File.exists?(File.dirname(file_base))
 
-    render_page("#{file_base}-plain.html", "plain", {:doc => doc[:docs]}, nil)
+    render_page("#{file_base}-plain#{lang_ext(lang)}.html", "plain", {:doc => doc[:docs],
+      :language => lang, :languages => Apipie.configuration.languages}, nil)
   end
 
-  def generate_index_page(file_base, doc, include_json = false, show_versions = false)
+  def generate_index_page(file_base, doc, include_json = false, show_versions = false, lang = nil)
     FileUtils.mkdir_p(File.dirname(file_base)) unless File.exists?(File.dirname(file_base))
     versions = show_versions && Apipie.available_versions
-    render_page("#{file_base}.html", "index", {:doc => doc[:docs], :versions => versions})
+    render_page("#{file_base}#{lang_ext(lang)}.html", "index", {:doc => doc[:docs],
+      :versions => versions, :language => lang, :languages => Apipie.configuration.languages})
 
-    File.open("#{file_base}.json", "w") { |f| f << doc.to_json } if include_json
+    File.open("#{file_base}#{lang_ext(lang)}.json", "w") { |f| f << doc.to_json } if include_json
   end
 
-  def generate_resource_pages(version, file_base, doc, include_json = false)
+  def generate_resource_pages(version, file_base, doc, include_json = false, lang = nil)
     doc[:docs][:resources].each do |resource_name, _|
       resource_file_base = File.join(file_base, resource_name.to_s)
       FileUtils.mkdir_p(File.dirname(resource_file_base)) unless File.exists?(File.dirname(resource_file_base))
 
-      doc = Apipie.to_json(version, resource_name)
-      render_page("#{resource_file_base}.html", "resource", {:doc => doc[:docs],
-                                                          :resource => doc[:docs][:resources].first})
-      File.open("#{resource_file_base}.json", "w") { |f| f << doc.to_json } if include_json
+      doc = Apipie.to_json(version, resource_name, nil, lang)
+      doc[:docs][:link_extension] = (lang ? ".#{lang}.html" : ".html")
+      render_page("#{resource_file_base}#{lang_ext(lang)}.html", "resource", {:doc => doc[:docs],
+        :resource => doc[:docs][:resources].first, :language => lang, :languages => Apipie.configuration.languages})
+      File.open("#{resource_file_base}#{lang_ext(lang)}.json", "w") { |f| f << doc.to_json } if include_json
     end
   end
 
-  def generate_method_pages(version, file_base, doc, include_json = false)
+  def generate_method_pages(version, file_base, doc, include_json = false, lang = nil)
     doc[:docs][:resources].each do |resource_name, resource_params|
       resource_params[:methods].each do |method|
         method_file_base = File.join(file_base, resource_name.to_s, method[:name].to_s)
         FileUtils.mkdir_p(File.dirname(method_file_base)) unless File.exists?(File.dirname(method_file_base))
 
-        doc = Apipie.to_json(version, resource_name, method[:name])
-        render_page("#{method_file_base}.html", "method", {:doc => doc[:docs],
+        doc = Apipie.to_json(version, resource_name, method[:name], lang)
+        doc[:docs][:link_extension] = (lang ? ".#{lang}.html" : ".html")
+        render_page("#{method_file_base}#{lang_ext(lang)}.html", "method", {:doc => doc[:docs],
                                                            :resource => doc[:docs][:resources].first,
-                                                           :method => doc[:docs][:resources].first[:methods].first})
+                                                           :method => doc[:docs][:resources].first[:methods].first,
+                                                           :language => lang,
+                                                           :languages => Apipie.configuration.languages})
 
-        File.open("#{method_file_base}.json", "w") { |f| f << doc.to_json } if include_json
+        File.open("#{method_file_base}#{lang_ext(lang)}.json", "w") { |f| f << doc.to_json } if include_json
       end
     end
   end
@@ -155,12 +176,17 @@ namespace :apipie do
     yield
   end
 
+
   def copy_jscss(dest)
     src = File.expand_path(File.join(File.dirname(__FILE__), '..', '..', 'app', 'public', 'apipie'))
     FileUtils.mkdir_p dest
     FileUtils.cp_r "#{src}/.", dest
   end
 
+  def lang_ext(lang = nil)
+    lang ? ".#{lang}" : ""
+  end
+
   desc "Generate CLI client for API documented with apipie gem. (deprecated)"
   task :client do
     puts <<MESSAGE
@@ -190,4 +216,20 @@ MESSAGE
     end
   end
 
+  desc "Convert your examples from the old yaml into the new json format"
+  task :convert_examples => :environment do
+    yaml_examples_file = File.join(Rails.root, "doc", "apipie_examples.yml")
+    if File.exists?(yaml_examples_file)
+      #if SafeYAML gem is enabled, it will load examples as an array of Hash, instead of hash
+      if defined? SafeYAML
+        examples = YAML.load_file(yaml_examples_file, :safe=>false)
+      else
+        examples = YAML.load_file(yaml_examples_file)
+      end
+    else
+      examples = {}
+    end
+    Apipie::Extractor::Writer.write_recorded_examples(examples)
+  end
+
 end

data/spec/dummy/doc/apipie_examples.json

@@ -0,0 +1 @@
+{"users#show":[{"verb":"GET","path":"/users/15","query":null,"request_data":null,"response_data":null,"code":"404","show_in_doc":2,"recorded":true},{"verb":"GET","path":"/users/14","query":"verbose=true","request_data":null,"response_data":"{\n  \"name\": \"Test User\"\n}","code":"200","show_in_doc":1,"recorded":true},{"verb":"GET","path":"/users/15","query":"verbose=true","request_data":null,"response_data":"{\n  \"name\": \"Test User\"\n}","code":"200","show_in_doc":0,"recorded":true}]}

data/spec/lib/extractor/middleware_spec.rb

@@ -0,0 +1,21 @@
+require "spec_helper"
+
+describe Apipie::Extractor::Recorder::Middleware do
+  let(:app) { ->(env) { [200, env, "app"] } }
+  let(:stack) { Apipie::Extractor::Recorder::Middleware.new(app) }
+  let(:request) { Rack::MockRequest.new(stack) }
+  let(:response) { request.get('/') }
+
+  it 'correctly process request without recording' do
+    expect(stack).not_to receive(:analyze)
+    response
+  end
+
+  it "analyze request if recording is set" do
+    Apipie.configuration.record = true
+    expect(Apipie::Extractor.call_recorder).to receive(:analyse_env)
+    expect(Apipie::Extractor.call_recorder).to receive(:analyse_response)
+    expect(Apipie::Extractor).to receive(:clean_call_recorder)
+    response
+  end
+end

data/spec/lib/extractor/writer_spec.rb

@@ -0,0 +1,76 @@
+require "spec_helper"
+
+describe Apipie::Extractor::Writer do
+
+  let(:collector) { double "collector" }
+  let(:writer_class) { Apipie::Extractor::Writer }
+  let(:writer) { writer_class.new(collector) }
+  let(:test_examples_file) { File.join(Rails.root, "doc", "apipie_examples_test.json") }
+  let(:records) { {
+    "concern_resources#show" =>
+      [{
+        :controller=>ConcernsController,
+        :action=>"show",
+        :verb=>:GET,
+        :path=>"/api/concerns/5",
+        :params=>{},
+        :query=>"session=secret_hash",
+        :request_data=>nil,
+        :response_data=>"OK {\"session\"=>\"secret_hash\", \"id\"=>\"5\", \"controller\"=>\"concerns\", \"action\"=>\"show\"}",
+        :code=>"200"
+      }, {
+        :controller=>ConcernsController,
+        :action=>"show",
+        :verb=>:GET,
+        :path=>"/api/concerns/5",
+        :params=>{},
+        :query=>"",
+        :request_data=>nil,
+        :response_data=>"OK {\"id\"=>\"5\", \"controller\"=>\"concerns\", \"action\"=>\"show\"}",
+        :code=>"200"
+      }]
+    }
+  }
+  let(:loaded_records) { {
+    "concern_resources#show" =>
+      [{
+        "verb"=>:GET,
+        "path"=>"/api/concerns/5",
+        "versions"=>["development"],
+        "query"=>"session=secret_hash",
+        "request_data"=>nil,
+        "response_data"=>"OK {\"session\"=>\"secret_hash\", \"id\"=>\"5\", \"controller\"=>\"concerns\", \"action\"=>\"show\"}",
+        "code"=>"200",
+        "show_in_doc"=>1,
+        "recorded"=>true
+      }, {
+        "verb"=>:GET,
+        "path"=>"/api/concerns/5",
+        "versions"=>["development"],
+        "query"=>"",
+        "request_data"=>nil,
+        "response_data"=>"OK {\"id\"=>\"5\", \"controller\"=>\"concerns\", \"action\"=>\"show\"}",
+        "code"=>"200",
+        "show_in_doc"=>0,
+        "recorded"=>true
+      }]
+    }
+  }
+
+
+  describe "storing of examples" do
+    before do
+      writer_class.stub(:examples_file) { test_examples_file }
+      collector.should_receive(:records).and_return(records)
+    end
+
+    it "should read and write examples" do
+      writer.write_examples
+      writer.send(:load_recorded_examples).should eq(loaded_records)
+    end
+
+    after do
+      File.unlink(test_examples_file) if File.exists?(test_examples_file)
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: apipie-rails
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-04 00:00:00.000000000 Z
+date: 2014-05-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -170,7 +170,6 @@ files:
 - APACHE-LICENSE-2.0
 - CHANGELOG.md
 - Gemfile
-- Gemfile.rails30
 - Gemfile.rails32
 - Gemfile.rails40
 - Gemfile.rails41
@@ -191,6 +190,7 @@ files:
 - app/public/apipie/stylesheets/bundled/bootstrap.min.css
 - app/public/apipie/stylesheets/bundled/prettify.css
 - app/views/apipie/apipies/_disqus.html.erb
+- app/views/apipie/apipies/_languages.erb
 - app/views/apipie/apipies/_metadata.erb
 - app/views/apipie/apipies/_method_detail.erb
 - app/views/apipie/apipies/_params.html.erb
@@ -204,6 +204,7 @@ files:
 - app/views/apipie/apipies/resource.html.erb
 - app/views/apipie/apipies/static.html.erb
 - app/views/layouts/apipie/apipie.html.erb
+- config/locales/en.yml
 - lib/apipie-rails.rb
 - lib/apipie/apipie_module.rb
 - lib/apipie/application.rb
@@ -273,7 +274,7 @@ files:
 - spec/dummy/config/locales/en.yml
 - spec/dummy/config/routes.rb
 - spec/dummy/db/.gitkeep
-- spec/dummy/doc/apipie_examples.yml
+- spec/dummy/doc/apipie_examples.json
 - spec/dummy/doc/users/desc_from_file.md
 - spec/dummy/public/404.html
 - spec/dummy/public/422.html
@@ -288,6 +289,8 @@ files:
 - spec/dummy/public/stylesheets/.gitkeep
 - spec/dummy/script/rails
 - spec/lib/application_spec.rb
+- spec/lib/extractor/middleware_spec.rb
+- spec/lib/extractor/writer_spec.rb
 - spec/lib/method_description_spec.rb
 - spec/lib/param_description_spec.rb
 - spec/lib/param_group_spec.rb
@@ -358,7 +361,7 @@ test_files:
 - spec/dummy/config/locales/en.yml
 - spec/dummy/config/routes.rb
 - spec/dummy/db/.gitkeep
-- spec/dummy/doc/apipie_examples.yml
+- spec/dummy/doc/apipie_examples.json
 - spec/dummy/doc/users/desc_from_file.md
 - spec/dummy/public/404.html
 - spec/dummy/public/422.html
@@ -373,6 +376,8 @@ test_files:
 - spec/dummy/public/stylesheets/.gitkeep
 - spec/dummy/script/rails
 - spec/lib/application_spec.rb
+- spec/lib/extractor/middleware_spec.rb
+- spec/lib/extractor/writer_spec.rb
 - spec/lib/method_description_spec.rb
 - spec/lib/param_description_spec.rb
 - spec/lib/param_group_spec.rb