apipie-rails 0.0.11 → 0.0.12

data/README.rdoc

@@ -73,6 +73,7 @@ of full descriptions.
          need RedCloth. Add those to your gemfile and run bundle if you
          want to use them. You can also add any other markup language
          processor.
+[layout] Name of a layout template to use instead of Apipie's layout. You can use Apipie.include_stylesheets and Apipie.include_javascripts helpers to include Apipie's stylesheets and javascripts.
 
 Example:
 
@@ -313,13 +314,8 @@ So we create apipie_validators.rb initializer with this content:
         end
       end
 
-      def error
-        "Parameter \#{@param_name} expecting to be \#{@type.name},
-        got: \#{@error_value.class.name}"
-      end
-
       def description
-        "Parameter has to be #{@type}."
+        "Must be #{@type}."
       end
     end
 
@@ -362,8 +358,10 @@ or delete it if you want to use 'normal' dynamic version again.
 
 == {Extractor}[https://github.com/Pajk/apipie-rails/wiki/Extractor]
 
-== Future features
+== Authors
+
+{Pajk}[https://github.com/Pajk] and {iNecas}[https://github.com/iNecas]
+
+== Contributors
 
-* Dynamic CLI client (read info from documentation API)
-* Add documentation json API description to readme
-* Possibility to create requests from web documentation and check responses
+See {Contributors page}[https://github.com/Pajk/apipie-rails/graphs/contributors]. Special thanks to all of them!

data/app/controllers/apipie/apipies_controller.rb

@@ -1,6 +1,6 @@
 module Apipie
   class ApipiesController < ActionController::Base
-    layout 'apipie/apipie'
+    layout Apipie.configuration.layout
 
     def index
       respond_to do |format|
@@ -44,11 +44,19 @@ module Apipie
           @doc = @doc[:docs]
           if params[:resource].present? && params[:method].present?
             @resource = @doc[:resources].first
-            @method = @resource[:methods].first
-            render 'method'
+            @method = @resource[:methods].first unless @resource == 'null'
+            if @resource == 'null' || @method == 'null'
+              render 'apipie_404', :status => 404
+            else
+              render 'method'
+            end
           elsif params[:resource].present?
             @resource = @doc[:resources].first
-            render 'resource'
+            if @resource == 'null'
+              render 'apipie_404', :status => 404
+            else
+              render 'resource'
+            end
           else
             render 'index'
           end

data/app/views/apipie/apipies/_disqus.html.erb

@@ -0,0 +1,11 @@
+<div id="disqus_thread"></div>
+<script type="text/javascript">
+    var disqus_shortname = "<%= Apipie.configuration.disqus_shortname %>";
+    (function() {
+        var dsq = document.createElement('script'); dsq.type = 'text/javascript'; dsq.async = true;
+        dsq.src = 'http://' + disqus_shortname + '.disqus.com/embed.js';
+        (document.getElementsByTagName('head')[0] || document.getElementsByTagName('body')[0]).appendChild(dsq);
+    })();
+</script>
+<noscript>Please enable JavaScript to view the <a href="http://disqus.com/?ref_noscript">comments powered by Disqus.</a></noscript>
+<a href="http://disqus.com" class="dsq-brlink">comments powered by <span class="logo-disqus">Disqus</span></a>

data/app/views/apipie/apipies/apipie_404.html.erb

@@ -0,0 +1,12 @@
+<h1 class='page-header'>
+  Oops!
+  <small>
+  <% if @resource == 'null' %>
+    Resource <code><%= params[:resource] %></code> not found.
+  <% else %>
+    Method <code><%= params[:method] %></code> not found for resource <code><%= params[:resource] %></code>.
+  <% end %>
+  </small>
+</h1>
+
+Try going to <a href='<%= @doc[:doc_url] %>.html'><%= @doc[:name] %> API documentation homepage</a>

data/app/views/apipie/apipies/method.html.erb

@@ -29,7 +29,7 @@
   <% unless @method[:examples].blank? %>
     <h2>Examples</h2>
     <% @method[:examples].each do |example| %>
-      <pre><%= example %></pre>
+      <pre class="prettyprint"><%= example %></pre>
     <% end %>
   <% end %>
 

data/app/views/apipie/apipies/resource.html.erb

@@ -64,7 +64,7 @@
       <% unless m[:examples].blank? %>
         <h3>Examples</h3>
         <% m[:examples].each do |example| %>
-          <pre><%= example %></pre>
+          <pre class="prettyprint"><%= example %></pre>
         <% end %>
       <% end %>
 

data/app/views/layouts/apipie/apipie.html.erb

@@ -3,13 +3,8 @@
 <head>
   <title>API documentation</title>
   <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
-  <% %w[bundled/bootstrap.min.css
-        application.css
-        bundled/prettify.css
-        bundled/bootstrap-responsive.min.css ].each do |file| %>
-    <link type="text/css" rel="stylesheet"
-          href="<%= Apipie.full_url("stylesheets/#{file}") %>"/>
-  <% end %>
+  <%= Apipie.include_stylesheets %>
+  <link type='text/css' rel='stylesheet' href='<%= Apipie.full_url("stylesheets/application.css")%>'/>
   <!-- IE6-8 support of HTML5 elements -->
   <!--[if lt IE 9]>
     <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script>
@@ -20,18 +15,12 @@
     <div class="row">
       <div id='container'>
         <%= yield %>
+        <%= render 'disqus' if Apipie.configuration.use_disqus? %>
       </div>
     </div>
     <hr>
     <footer><%= yield :apipie_footer %></footer>
   </div>
-  <% %w[
-    bundled/jquery-1.7.2.js
-    bundled/bootstrap-collapse.js
-    bundled/prettify.js
-    apipie.js ].each do |file| %>
-    <script type="text/javascript"
-            src="<%= Apipie.full_url("javascripts/#{file}") %>"></script>
-  <% end %>
+  <%= Apipie.include_javascripts %>
 </body>
 </html>

data/lib/apipie-rails.rb

@@ -4,6 +4,7 @@ require "apipie/apipie_module"
 require "apipie/method_description"
 require "apipie/resource_description"
 require "apipie/param_description"
+require "apipie/errors"
 require "apipie/error_description"
 require "apipie/validator"
 require "apipie/dsl_definition"

data/lib/apipie/apipie_module.rb

@@ -26,10 +26,11 @@ module Apipie
   end
 
   class Configuration
-    attr_accessor :app_name, :app_info, :copyright, :markup,
-      :validate, :api_base_url, :doc_base_url
+    attr_accessor :app_name, :app_info, :copyright, :markup, :disqus_shortname,
+      :validate, :api_base_url, :doc_base_url, :required_by_default, :layout
 
     alias_method :validate?, :validate
+    alias_method :required_by_default?, :required_by_default
 
     # matcher to be used in Dir.glob to find controllers to be reloaded e.g.
     #
@@ -87,6 +88,10 @@ module Apipie
       @generated_doc_disclaimer ||= "# DOC GENERATED AUTOMATICALLY: REMOVE THIS LINE TO PREVENT REGENARATING NEXT TIME"
     end
 
+    def use_disqus?
+      !@disqus_shortname.blank?
+    end
+
     def app_info
       Apipie.markup_to_html(@app_info)
     end
@@ -97,8 +102,11 @@ module Apipie
       @app_info = "Another API description"
       @copyright = nil
       @validate = true
+      @required_by_default = false
       @api_base_url = ""
       @doc_base_url = "/apipie"
+      @layout = "apipie/apipie"
+      @disqus_shortname = nil
     end
   end
 

data/lib/apipie/client/base.rb

@@ -0,0 +1,131 @@
+require 'rest_client'
+require 'oauth'
+require 'json'
+require 'apipie/client/rest_client_oauth'
+
+module Apipie::Client
+
+  class Base
+    attr_reader :client, :config
+
+    def initialize(config, options = { })
+      @client = RestClient::Resource.new config[:base_url],
+                                         :user     => config[:username],
+                                         :password => config[:password],
+                                         :oauth    => config[:oauth],
+                                         :headers  => { :content_type => 'application/json',
+                                                        :accept       => 'application/json' }
+      @config = config
+    end
+
+    def call(method, path, params = { }, headers = { })
+      headers ||= { }
+
+      args = [method]
+      if [:post, :put].include?(method)
+        args << params.to_json
+      else
+        headers[:params] = params if params
+      end
+
+      args << headers if headers
+      process_data client[path].send(*args)
+    end
+
+    def self.doc
+      raise NotImplementedError
+    end
+
+    def self.validation_hash(method)
+      validation_hashes[method.to_s]
+    end
+
+    def self.method_doc(method)
+      method_docs[method.to_s]
+    end
+
+    def validate_params!(params, rules)
+      return unless params.is_a?(Hash)
+
+      invalid_keys = params.keys.map(&:to_s) - (rules.is_a?(Hash) ? rules.keys : rules)
+      raise ArgumentError, "Invalid keys: #{invalid_keys.join(", ")}" unless invalid_keys.empty?
+
+      if rules.is_a? Hash
+        rules.each do |key, sub_keys|
+          validate_params!(params[key], sub_keys) if params[key]
+        end
+      end
+    end
+
+    protected
+
+    def process_data(response)
+      data = begin
+        JSON.parse(response.body)
+      rescue JSON::ParserError
+        response.body
+      end
+      return data, response
+    end
+
+    def check_params(params, options = { })
+      raise ArgumentError unless (method = options[:method])
+      return unless config[:enable_validations]
+
+      case options[:allowed]
+        when true
+          validate_params!(params, self.class.validation_hash(method))
+        when false
+          raise ArgumentError, "this method '#{method}' does not support params" if params && !params.empty?
+        else
+          raise ArgumentError, "options :allowed should be true or false, it was #{options[:allowed]}"
+      end
+    end
+
+    # @return url and rest of the params
+    def fill_params_in_url(url, params)
+      params          ||= { }
+      # insert param values
+      url_param_names = params_in_path(url)
+      url             = params_in_path(url).inject(url) do |url, param_name|
+        param_value = params[param_name] or
+            raise ArgumentError, "missing param '#{param_name}' in parameters"
+        url.sub(":#{param_name}", param_value.to_s)
+      end
+
+      return url, params.reject { |param_name, _| url_param_names.include? param_name }
+    end
+
+    private
+
+    def self.method_docs
+      @method_docs ||= doc['methods'].inject({ }) do |hash, method|
+        hash[method['name']] = method
+        hash
+      end
+    end
+
+    def self.validation_hashes
+      @validation_hashes ||= method_docs.inject({ }) do |hash, pair|
+        name, method_doc = pair
+        hash[name]       = construct_validation_hash method_doc
+        hash
+      end
+    end
+
+    def self.construct_validation_hash(method)
+      if method['params'].any? { |p| p['params'] }
+        method['params'].reduce({ }) do |h, p|
+          h.update(p['name'] => (p['params'] ? p['params'].map { |pp| pp['name'] } : nil))
+        end
+      else
+        method['params'].map { |p| p['name'] }
+      end
+    end
+
+    def params_in_path(url)
+      url.scan(/:([^\/]*)/).map { |m| m.first }
+    end
+
+  end
+end

data/lib/apipie/client/{template/cli_command.rb.tt → cli_command.rb}

@@ -1,34 +1,33 @@
-module <%= class_base %><%= class_suffix %>
+module Apipie::Client
   class CliCommand < Thor
     no_tasks do
       def client
-        resource_class = <%= class_base %><%= class_suffix %>::Resources.const_get(self.class.name[/[^:]*$/])
-        @client ||= resource_class.new(<%= class_base %><%= class_suffix %>.client_config)
+        resource_class = apipie_options[:client_module]::Resources.const_get(self.class.name[/[^:]*$/])
+        @client        ||= resource_class.new(apipie_options[:config])
       end
 
-      def transform_options(inline_params, transform_hash = {})
-        ret = inline_params.map { |p| options[p] }
-
+      def transform_options(inline_params, transform_hash = { })
         # we use not mentioned params without change
-        transformed_options = (options.keys - transform_hash.values.flatten - inline_params).reduce({}) { |h, k| h.update(k => options[k]) }
+        transformed_options = (options.keys - transform_hash.values.flatten - inline_params).reduce({ }) { |h, k| h.update(k => options[k]) }
+
+        inline_params.each { |p| transformed_options[p] = options[p] }
 
         transform_hash.each do |sub_key, params|
-          transformed_options[sub_key] = {}
+          transformed_options[sub_key] = { }
           params.each { |p| transformed_options[sub_key][p] = options[p] if options.has_key?(p) }
         end
 
-        ret << transformed_options
-        return *ret
+        return transformed_options
       end
 
       def print_data(data)
         case data
-        when Array
-          print_big_table(table_from_array(data))
-        when Hash
-          print_table(table_from_hash(data))
-        else
-          print_unknown(data)
+          when Array
+            print_big_table(table_from_array(data))
+          when Hash
+            print_table(table_from_hash(data))
+          else
+            print_unknown(data)
         end
       end
 
@@ -49,8 +48,8 @@ module <%= class_base %><%= class_suffix %>
 
       def table_from_array(data)
         return [] if data.empty?
-        table = []
-        items = data.map { |item| normalize_item_data(item) }
+        table   = []
+        items   = data.map { |item| normalize_item_data(item) }
         columns = items.first.keys
         table << columns
         items.each do |item|
@@ -64,7 +63,7 @@ module <%= class_base %><%= class_suffix %>
         return [] if data.empty?
         table = []
         normalize_item_data(data).each do |k, v|
-          table << ["#{k}:",v].map(&:to_s)
+          table << ["#{k}:", v].map(&:to_s)
         end
         table
       end
@@ -73,7 +72,7 @@ module <%= class_base %><%= class_suffix %>
         say data
       end
 
-      def print_big_table(table, options={})
+      def print_big_table(table, options={ })
         return if table.empty?
 
         formats, ident, colwidth = [], options[:ident].to_i, options[:colwidth]
@@ -83,7 +82,7 @@ module <%= class_base %><%= class_suffix %>
         start = colwidth ? 1 : 0
 
         start.upto(table.first.length - 2) do |i|
-          maxima ||= table.max{|a,b| a[i].size <=> b[i].size }[i].size
+          maxima ||= table.max { |a, b| a[i].size <=> b[i].size }[i].size
           formats << "%-#{maxima + 2}s"
         end
 
@@ -113,7 +112,7 @@ module <%= class_base %><%= class_suffix %>
         Thor::Util.thor_classes_in(self).each do |klass|
           list += printable_tasks(false)
         end
-        list.sort!{ |a,b| a[0] <=> b[0] }
+        list.sort! { |a, b| a[0] <=> b[0] }
 
         shell.say
         shell.print_table(list, :indent => 2, :truncate => true)

data/lib/apipie/client/generator.rb

@@ -5,6 +5,7 @@ require 'thor'
 require 'thor/group'
 require 'fileutils'
 require 'active_support/inflector'
+require 'apipie/client/base'
 
 module Apipie
   module Client
@@ -17,7 +18,7 @@ module Apipie
       argument :subject
       argument :suffix
 
-      attr_reader :doc, :resource
+      attr_reader :doc, :resource, :resource_key
 
       def initialize(*args)
         super
@@ -33,7 +34,7 @@ module Apipie
       end
 
       def self.start(client_name, subject = :all, suffix = '_client')
-        name = client_name.parameterize.underscore
+        name   = client_name.parameterize.underscore
         suffix = suffix.parameterize.underscore
         super([name, subject, suffix], :destination_root => destination_root(name, suffix))
       end
@@ -47,22 +48,21 @@ module Apipie
         template("README.tt", "README")
         template("Gemfile.tt", "Gemfile")
         template("Rakefile.tt", "Rakefile")
-        template("client.gemspec.tt", "#{full_name}.gemspec")
-        template("client.rb.tt", "lib/#{full_name}.rb")
-        template("base.rb.tt", "lib/#{full_name}/base.rb")
-        template("rest_client_oauth.rb.tt", "lib/#{full_name}/rest_client_oauth.rb")
-        template("version.rb.tt", "lib/#{full_name}/version.rb")
+        template("a_name.gemspec.tt", "#{full_name}.gemspec")
+        template("lib/a_name.rb.tt", "lib/#{full_name}.rb")
+        template("lib/a_name/version.rb.tt", "lib/#{full_name}/version.rb")
+        create_file "lib/#{full_name}/documentation.json", JSON.dump(Apipie.to_json)
+        copy_file "lib/a_name/config.yml", "lib/#{full_name}/config.yml"
         if all?
-          template("bin.rb.tt", "bin/#{full_name}")
+          template("bin/bin.rb.tt", "bin/#{full_name}")
           chmod("bin/#{full_name}", 0755)
-          template("cli_command.rb.tt", "lib/#{full_name}/cli_command.rb")
         end
         doc[:resources].each do |key, resource|
-          @resource = resource
+          @resource_key, @resource = key, resource
           if all?
-            template("cli.rb.tt", "lib/#{full_name}/commands/#{resource_name}.thor")
+            template("lib/a_name/commands/cli.rb.tt", "lib/#{full_name}/commands/#{resource_name}.thor")
           end
-          template("resource.rb.tt", "lib/#{full_name}/resources/#{resource_name}.rb")
+          template("lib/a_name/resources/resource.rb.tt", "lib/#{full_name}/resources/#{resource_name}.rb")
         end
       end
 
@@ -82,13 +82,13 @@ module Apipie
       end
 
       def plaintext(text)
-        text.gsub(/<.*?>/, '').gsub("\n",' ').strip
+        text.gsub(/<.*?>/, '').gsub("\n", ' ').strip
       end
 
       # Resource related helper methods:
 
       def resource_name
-        resource[:name].gsub(/\s/,"_").downcase.singularize
+        resource[:name].gsub(/\s/, "_").downcase.singularize
       end
 
       def api(method)
@@ -100,31 +100,34 @@ module Apipie
       end
 
       def client_args(method)
-        client_args = params_in_path(method).dup
-        client_args << "params = {}"
-        client_args << 'headers = {}'
-        client_args
-      end
-
-      def validation_hash(method)
-        if method[:params].any? { |p| p[:params] }
-          method[:params].reduce({}) do |h, p|
-            h.update(p[:name] => (p[:params] ? p[:params].map { |pp| pp[:name] } : nil))
-          end
-        else
-          method[:params].map { |p| p[:name] }
-        end
+        params_in_path(method).dup
       end
 
       def substituted_url(method)
-        params_in_path(method).reduce(api(method)[:api_url]) { |u, p| u.sub(":#{p}","\#{#{p}}")}
+        params_in_path(method).reduce(api(method)[:api_url]) { |u, p| u.sub(":#{p}", "\#{#{p}}") }
       end
 
       def transformation_hash(method)
-        method[:params].find_all { |p| p[:expected_type] == "hash" && !p[:params].nil? }.reduce({}) do |h, p|
+        method[:params].find_all { |p| p[:expected_type] == "hash" && !p[:params].nil? }.reduce({ }) do |h, p|
           h.update(p[:name] => p[:params].map { |pp| pp[:name] })
         end
       end
+
+      def validation(method)
+        stringify = lambda do |object|
+          case object
+            when Hash
+              clone = object.dup
+              object.keys.each { |key| clone[key.to_s] = stringify[clone.delete(key)] }
+              clone
+            when Array
+              object.map { |value| stringify[value] }
+            else
+              object
+          end
+        end
+        Apipie::Client::Base.construct_validation_hash(stringify[method])
+      end
     end
 
   end