apipie-rails 0.0.8 → 0.0.9

data/.rvmrc

@@ -1 +1 @@
-rvm use 1.8.7@apipie
+rvm use 1.8.7@apipie --create

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    apipie-rails (0.0.7)
+    apipie-rails (0.0.8)
 
 GEM
   remote: http://rubygems.org/

data/README.rdoc

@@ -108,6 +108,7 @@ be checked in every request.
 [short] One line short description.
 [path] Relative URL path of this resource.
 [version] Version of this resource API, use arbitrary string.
+[formats] Resource level request / response formats.
 [param] The very same parameter description as you will use method
         description. Generally use this for parameters that apply
         to every method in the controller (such as :user hash).
@@ -125,6 +126,7 @@ Example:
         short 'Site members'
         path '/users'
         version '1.0 - 3.4.2012'
+        formats ['json', 'xml']
         param :id, Fixnum, :desc => "User ID", :required => false
         param :user, Hash, :desc => 'Param description for all methods' do
           param :username, String, :required => true,
@@ -151,6 +153,7 @@ Then describe methods available to your API.
       You can use this +api+ method more than once for one method. It could
       be useful when there are more routes mapped to it.
 [param] Look at Parameter description section for details.
+[formats] Method level request / response formats.
 [error] Describe each possible error that can happend what calling this
         method. HTTP response code and description can be provided.
 [description] Full method description which will be converted to HTML by
@@ -173,6 +176,7 @@ Example:
      val == "param value" ? true : "The only good value is 'param value'."
    }, :desc => "proc validator"
    description "method description"
+   formats ['json', 'jsonp', 'xml']
    example " 'user': {...} "
    see "users#showme"
    def show
@@ -300,7 +304,7 @@ So we create apipie_validators.rb initializer with this content:
 
       def validate(value)
         return false if value.nil?
-        !!(value.to_s =~ \/^[-+]?[0-9]+$/)
+        !!(value.to_s =~ /^[-+]?[0-9]+$/)
       end
 
       def self.build(param_description, argument, options, block)

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

@@ -33,11 +33,16 @@
     <% end %>
   <% end %>
 
+  <% unless @method[:formats].blank? %>
+    <h2>Supported Formats</h2>
+    <%= @method[:formats].join(', ') %>
+  <% end %>
+
   <% unless @method[:errors].blank? %>
     <h2>Errors</h2>
     <% @method[:errors].each do |err| %>
-      <%= err.code %>
-      <%= err.description %>
+      <%= err[:code] %>
+      <%= err[:description] %>
       <br>
     <% end %>
   <% end %>

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

@@ -54,8 +54,8 @@
         <% unless method[:errors].blank? %>
           <h4>Errors</h4>
           <% method[:errors].each do |err| %>
-            <%= err.code %>
-            <%= err.description %>
+            <%= err[:code] %>
+            <%= err[:description] %>
             <br>
           <% end %>
         <% end %>

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

@@ -10,11 +10,15 @@
   </h1>
 </div>
 
-
 <% unless @resource[:full_description].blank? %>
   <div><%= raw @resource[:full_description] %></div>
 <% end %>
 
+<% unless @resource[:formats].blank? %>
+  <h2>Supported Formats</h2>
+  <%= @resource[:formats].join(', ') %>
+<% end %>
+
 <div class='accordion' id='accordion'>
 
   <% @resource[:methods].each do |m| %>
@@ -41,13 +45,18 @@
     <% end %>
 
     <div id='description-<%= m[:name] %>' class='collapse accordion-body'>
-
       <%= raw m[:full_description] %>
+
+      <% unless m[:formats].blank? %>
+        <h3>Supported Formats</h3>
+        <%= m[:formats].join(', ') %>
+      <% end %>
+
       <% unless m[:errors].blank? %>
         <h3>Errors</h3>
         <% m[:errors].each do |err| %>
-          <%= err.code %>
-          <%= err.description %>
+          <%= err[:code] %>
+          <%= err[:description] %>
           <br>
         <% end %>
       <% end %>

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

@@ -71,8 +71,8 @@
         <% unless method[:errors].blank? %>
           <h2>Errors</h2>
           <% method[:errors].each do |err| %>
-            <%= err.code %>
-            <%= err.description %>
+            <%= err[:code] %>
+            <%= err[:description] %>
             <br>
           <% end %>
         <% end %>

data/lib/apipie/application.rb

@@ -12,7 +12,7 @@ module Apipie
       end
     end
 
-    attr_accessor :last_api_args, :last_errors, :last_params, :last_description, :last_examples, :last_see
+    attr_accessor :last_api_args, :last_errors, :last_params, :last_description, :last_examples, :last_see, :last_formats
     attr_reader :method_descriptions, :resource_descriptions
 
     def initialize
@@ -109,6 +109,7 @@ module Apipie
       @last_description = nil
       @last_examples = []
       @last_see = nil
+      @last_formats = []
     end
 
     # Return the current description, clearing it in the process.
@@ -136,6 +137,12 @@ module Apipie
       see
     end
 
+    def get_formats
+      formats = @last_formats
+      @last_formats = nil
+      formats
+    end
+
     def get_params
       params = @last_params.clone
       @last_params.clear

data/lib/apipie/client/generator.rb

@@ -68,12 +68,17 @@ module Apipie
 
       protected
 
+      def camelizer(string)
+        string = string.sub(/^[a-z\d]*/) { $&.capitalize }
+        string.gsub(/(?:_|(\/))([a-z\d]*)/i) { "#{$2.capitalize}" }
+      end
+
       def class_base
-        @class_base ||= name.camelize
+        @class_base ||= camelizer(name)
       end
 
       def class_suffix
-        @class_suffix ||= suffix.camelize
+        @class_suffix ||= camelizer(suffix)
       end
 
       def plaintext(text)

data/lib/apipie/client/template/base.rb.tt

@@ -17,8 +17,11 @@ module <%= class_base %><%= class_suffix %>
     end
 
     def call(method, path, payload = nil)
-      a, *_ = [method, payload ? payload.to_json : nil].compact
-      ret  = client[path].send(a)
+      if payload && (method == :post || method == :put)
+        # TODO: is this neccessary? RestClient converts it automaticaly for me.
+        payload = payload.to_json
+      end
+      ret  = client[path].send(*([method, payload].compact))
       data = begin
         JSON.parse(ret.body)
       rescue JSON::ParserError

data/lib/apipie/client/template/client.gemspec.tt

@@ -15,7 +15,7 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   gem.version       = <%= class_base %><%= class_suffix %>::VERSION
 
-  gem.add_dependency 'thor', '>= 0.15.4'
+  <% if all? %>gem.add_dependency 'thor', '>= 0.15.4'<% end %>
   gem.add_dependency 'json'
   gem.add_dependency 'rest-client', '>= 1.6.1'
   gem.add_dependency 'oauth'

data/lib/apipie/dsl_definition.rb

@@ -66,6 +66,14 @@ module Apipie
       Apipie.add_example(example)
     end
 
+    # Describe available request/response formats
+    #
+    #   formats ['json', 'jsonp', 'xml']
+    def formats(formats) #:doc:
+      return unless Apipie.active_dsl?
+      Apipie.last_formats = formats
+    end
+
     # Describe possible errors
     #
     # Example:

data/lib/apipie/error_description.rb

@@ -16,6 +16,10 @@ module Apipie
       @description = args[:desc] || args[:description] || args['desc'] || args['description']
     end
 
+    def to_json
+      {:code => code, :description => description}
+    end
+
   end
 
-end
+end

data/lib/apipie/method_description.rb

@@ -23,7 +23,7 @@ module Apipie
 
     end
 
-    attr_reader :errors, :full_description, :method, :resource, :apis, :examples, :see
+    attr_reader :full_description, :method, :resource, :apis, :examples, :see, :formats
 
     def initialize(method, resource, app)
       @method = method
@@ -31,6 +31,7 @@ module Apipie
 
       @apis = app.get_api_args
       @see = app.get_see
+      @formats = app.get_formats
 
       desc = app.get_description || ''
       @full_description = Apipie.markup_to_html(desc)
@@ -72,6 +73,19 @@ module Apipie
       all_params.find_all(&:validator)
     end
 
+    def errors
+      return @merged_errors if @merged_errors
+      @merged_errors = []
+      if @resource
+        # exclude overwritten parent errors
+        @merged_errors = @resource._errors_ordered.find_all do |err|
+          !@errors.any? { |e| e.code == err.code }
+        end
+      end
+      @merged_errors.concat(@errors)
+      return @merged_errors
+    end
+
     def doc_url
       Apipie.full_url("#{@resource._id}/#{@method}")
     end
@@ -100,13 +114,18 @@ module Apipie
       @see
     end
 
+    def formats
+      @formats || @resource._formats
+    end
+
     def to_json
       {
         :doc_url => doc_url,
         :name => @method,
         :apis => method_apis_to_json,
+        :formats => formats,
         :full_description => @full_description,
-        :errors => @errors,
+        :errors => errors.map(&:to_json),
         :params => params_ordered.map(&:to_json).flatten,
         :examples => @examples,
         :see => @see,

data/lib/apipie/resource_description.rb

@@ -8,14 +8,16 @@ module Apipie
   # methods - array of keys to Apipie.method_descriptions (array of Apipie::MethodDescription)
   # name - human readable alias of resource (Articles)
   # id - resouce name
+  # formats - acceptable request/response format types
   class ResourceDescription
 
     attr_reader :controller, :_short_description, :_full_description, :_methods, :_id,
-      :_path, :_version, :_name, :_params_ordered
+      :_path, :_version, :_name, :_params_ordered, :_errors_ordered, :_formats
 
     def initialize(controller, resource_name, &block)
       @_methods = []
       @_params_ordered = []
+      @_errors_ordered = []
 
       @controller = controller
       @_id = resource_name
@@ -24,6 +26,7 @@ module Apipie
       @_full_description = ""
       @_short_description = ""
       @_path = ""
+      @_formats = []
 
       block.arity < 1 ? instance_eval(&block) : block.call(self) if block_given?
     end
@@ -33,10 +36,18 @@ module Apipie
       @_params_ordered << param_description
     end
 
+    def error(*args)
+      error_description = Apipie::ErrorDescription.new(args)
+      @_errors_ordered << error_description
+    end
+
+
     def path(path); @_path = path; end
 
     def version(version); @_version = version; end
 
+    def formats(formats); @_formats = formats; end
+
     def name(name); @_name = name; end
 
     def short(short); @_short_description = short; end
@@ -76,6 +87,7 @@ module Apipie
         :short_description => @_short_description,
         :full_description => @_full_description,
         :version => @_version,
+        :formats => @_formats,
         :methods => _methods
       }
     end

data/lib/apipie/version.rb

@@ -1,3 +1,3 @@
 module Apipie
-  VERSION = '0.0.8'
+  VERSION = '0.0.9'
 end

data/rubygem-apipie-rails.spec

@@ -10,14 +10,16 @@
 
 Summary: Rails API documentation tool and client generator.
 Name: rubygem-%{gemname}
-Version: 0.0.7
-Release: 2%{?dist}
+Version: 0.0.9
+Release: 0%{?dist}
 Group: Development/Libraries
 License: MIT
 URL: http://github.com/Pajk/apipie-rails
 Source0: http://rubygems.org/downloads/%{gemname}-%{version}.gem
 Requires: ruby(abi) >= %{rubyabi}
+Requires: rubygems
 BuildRequires: ruby(abi) >= %{rubyabi}
+BuildRequires: rubygems
 BuildArch: noarch
 Provides: rubygem(%{gemname}) = %{version}
 
@@ -56,6 +58,7 @@ cp -a .%{gemdir}/* \
 %exclude %{geminstdir}/.rvmrc
 %exclude %{geminstdir}/.travis.yml
 %exclude %{geminstdir}/rubygem-apipie-rails.spec
+%exclude %{geminstdir}/.yardoc
 %exclude %{gemdir}/cache/%{gemname}-%{version}.gem
 %exclude %{gemdir}/doc/%{gemname}-%{version}
 
@@ -65,6 +68,13 @@ cp -a .%{gemdir}/* \
 %doc %{geminstdir}/NOTICE
 
 %changelog
+* Thu Jul 26 2012 Pavel Pokorný <pajkycz@gmail.com> 0.0.8-3
+- Require rubygems in spec file
+
+* Thu Jul 26 2012 Pavel Pokorný <pajkycz@gmail.com> 0.0.8-2
+- New version of apipie-rails gem
+- Generated client improvements
+
 * Thu Jul 26 2012 Pavel Pokorný <pajkycz@gmail.com> 0.0.7-2
 - removed doc files from rpm
 

data/spec/controllers/users_controller_spec.rb

@@ -1,15 +1,19 @@
 require 'spec_helper'
 
 def compare_hashes(h1, h2)
-  h1.each do |key, val|
-    if val.is_a? Hash
-      compare_hashes val, h2[key]
-    elsif val.is_a? Array
-      val.each_with_index do |v, i|
-        compare_hashes val[i], h2[key][i]
+  if h1.is_a? String
+    h1.should eq(h2)
+  else
+    h1.each do |key, val|
+      if val.is_a? Hash
+        compare_hashes val, h2[key]
+      elsif val.is_a? Array
+        val.each_with_index do |v, i|
+          compare_hashes val[i], h2[key][i]
+        end
+      else
+        val.should eq(h2[key])
       end
-    else
-      val.should eq(h2[key])
     end
   end
 end
@@ -34,6 +38,7 @@ describe UsersController do
       subject._path.should eq('/users')
       subject._version.should eq('1.0 - 3.4.2012')
       subject._name.should eq('Members')
+      subject._formats.should eq(['json'])
     end
 
     it "should contain params defined on resource level" do
@@ -202,6 +207,7 @@ describe UsersController do
     it "should contain basic info about method" do
       a = Apipie[UsersController, :create]
       a.apis.count.should == 1
+      a.formats.should eq(['json'])
       api = a.apis.first
       api.short_description.should eq("Create user")
       api.api_url.should eq("/api/users")
@@ -213,6 +219,7 @@ describe UsersController do
       b.resource._id.should eq('users')
 
       b.apis.count.should == 1
+      b.formats.should eq(['json', 'jsonp'])
       api = b.apis.first
       api.short_description.should eq("Show user profile")
       api.api_url.should eq("#{Apipie.configuration.api_base_url}/users/:id")
@@ -246,10 +253,12 @@ describe UsersController do
     it "should contain possible errors description" do
       a = Apipie.get_method_description(UsersController, :show)
 
-      a.errors[0].code.should eq(401)
-      a.errors[0].description.should eq("Unauthorized")
-      a.errors[1].code.should eq(404)
-      a.errors[1].description.should eq("Not Found")
+      a.errors[0].code.should eq(500)
+      a.errors[0].description.should include("crashed")
+      a.errors[1].code.should eq(401)
+      a.errors[1].description.should eq("Unauthorized")
+      a.errors[2].code.should eq(404)
+      a.errors[2].description.should eq("Not Found")
     end
 
     it "should contain all params description" do
@@ -276,9 +285,11 @@ describe UsersController do
     it "should be described by valid json" do
       json = Apipie[UsersController, :two_urls].to_json
       expected_hash = {
-        :errors => [],
+        :errors => [{:code=>404, :description=>"Missing"},
+                    {:code=>500, :description=>"Server crashed for some <%= reason %>"}],
         :examples => [],
         :doc_url => "#{Apipie.configuration.doc_base_url}/users/two_urls",
+        :formats=>["json"],
         :full_description => '',
         :params => [{:full_name=>"oauth",
                      :required=>false,

data/spec/dummy/app/controllers/users_controller.rb

@@ -5,11 +5,14 @@ class UsersController < ApplicationController
     short 'Site members'
     path '/users'
     version '1.0 - 3.4.2012'
+    formats ['json']
     param :id, Fixnum, :desc => "User ID", :required => false
     param :resource_param, Hash, :desc => 'Param description for all methods' do
       param :ausername, String, :desc => "Username for login", :required => true
       param :apassword, String, :desc => "Password for login", :required => true
     end
+    error 404, "Missing"
+    error 500, "Server crashed for some <%= reason %>"
     description <<-EOS
       == Long description
 
@@ -163,6 +166,7 @@ class UsersController < ApplicationController
     More builder documentation can be found at http://builder.rubyforge.org.
   eos
   api :GET, "/users/:id", "Show user profile"
+  formats ['json', 'jsonp']
   error 401, "Unauthorized"
   error :code => 404, :description => "Not Found"
   param :id, Integer, :desc => "user id", :required => true

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: apipie-rails
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.9
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-26 00:00:00.000000000 Z
+date: 2012-07-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec-rails
@@ -222,6 +222,7 @@ files:
 - spec/dummy/config/initializers/session_store.rb
 - spec/dummy/config/locales/en.yml
 - spec/dummy/config/routes.rb
+- spec/dummy/db/.gitkeep
 - spec/dummy/doc/apipie_examples.yml
 - spec/dummy/public/404.html
 - spec/dummy/public/422.html
@@ -284,6 +285,7 @@ test_files:
 - spec/dummy/config/initializers/session_store.rb
 - spec/dummy/config/locales/en.yml
 - spec/dummy/config/routes.rb
+- spec/dummy/db/.gitkeep
 - spec/dummy/doc/apipie_examples.yml
 - spec/dummy/public/404.html
 - spec/dummy/public/422.html
@@ -298,3 +300,4 @@ test_files:
 - spec/dummy/public/stylesheets/.gitkeep
 - spec/dummy/script/rails
 - spec/spec_helper.rb
+has_rdoc: