apipie-rails 0.0.11 → 0.0.12

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

@@ -1,14 +1,7 @@
-#!/usr/bin/env ruby
-require "rubygems" # ruby1.9 doesn't "require" it though
-require "pathname"
-require "thor"
-require 'thor/core_ext/file_binary_read'
+require "apipie/client/thor"
+require "apipie/client/cli_command"
 
-$: << File.expand_path("../../lib", __FILE__)
-require "<%= name %><%= suffix %>"
-require "<%= name %><%= suffix %>/cli_command"
-
-module <%= class_base %>Cli
+module Apipie::Client
   class Main < Thor
 
     def help(meth = nil)
@@ -18,7 +11,7 @@ module <%= class_base %>Cli
         self.class.handle_no_task_error(task, false) if klass.nil?
         klass.start(["-h", task].compact, :shell => self.shell)
       else
-        say "<%= name.capitalize %> CLI"
+        say "#{apipie_options[:name].capitalize} CLI"
         say
         invoke :commands
       end
@@ -35,14 +28,14 @@ module <%= class_base %>Cli
       private
       def dispatch(task, given_args, given_options, config)
         parser = Thor::Options.new :auth => Thor::Option.parse(%w[auth -a], :string)
-        opts = parser.parse(given_args)
+        opts   = parser.parse(given_args)
         if opts['auth']
-          username, password = opts['auth'].split(':')
-          <%= class_base %><%= class_suffix %>.client_config[:username] = username
-          <%= class_base %><%= class_suffix %>.client_config[:password] = password
+          username, password                 = opts['auth'].split(':')
+          apipie_options[:config][:username] = username
+          apipie_options[:config][:password] = password
         end
-        #remaining =  parser.instance_variable_get("@unknown") # TODO: this is an ugly hack :(
         remaining = parser.remaining
+
         super(task, remaining, given_options, config)
       end
     end
@@ -71,18 +64,18 @@ module <%= class_base %>Cli
     end
 
     def thorfiles
-      Dir[File.expand_path("../../lib/<%= name %><%= suffix %>/commands/*.thor", __FILE__)]
+      Dir[File.expand_path("*/commands/*.thor", apipie_options[:root])]
     end
 
     # Display information about the given klasses. If with_module is given,
     # it shows a table with information extracted from the yaml file.
     #
     def display_klasses(with_modules=false, show_internal=false, klasses=Thor::Base.subclasses)
-      klasses -= [Thor, Main, ::<%= class_base %><%= class_suffix %>::CliCommand] unless show_internal
+      klasses -= [Thor, Main, ::Apipie::Client::CliCommand, ::Thor] unless show_internal
 
       show_modules if with_modules && !thor_yaml.empty?
 
-      list = Hash.new { |h,k| h[k] = [] }
+      list   = Hash.new { |h, k| h[k] = [] }
       groups = []
 
       # Get classes which inherit from Thor
@@ -93,7 +86,7 @@ module <%= class_base %>Cli
       list["root"] = groups
 
       # Order namespaces with default coming first
-      list = list.sort{ |a,b| a[0].sub(/^default/, '') <=> b[0].sub(/^default/, '') }
+      list         = list.sort { |a, b| a[0].sub(/^default/, '') <=> b[0].sub(/^default/, '') }
       list.each { |n, tasks| display_tasks(n, tasks) unless tasks.empty? }
     end
 
@@ -104,13 +97,3 @@ module <%= class_base %>Cli
 
 end
 
-begin
-  <%= class_base %>Cli::Main.start
-rescue RestClient::Exception => e
-  $stderr.puts e.message
-  exit 1
-rescue Errno::ECONNREFUSED => e
-  $stderr.puts "Server #{<%= class_base %><%= class_suffix %>.client_config[:base_url]} not available"
-  $stderr.puts e.message
-  exit 1
-end

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

@@ -9,17 +9,7 @@ unless RestClient.const_defined? :OAUTH_EXTENSION
       options         = default_options.merge args[:oauth][:options] || { }
       consumer        = OAuth::Consumer.new(args[:oauth][:consumer_key], args[:oauth][:consumer_secret], options)
 
-
-      method_to_http_request = { :get    => Net::HTTP::Get,
-                                 :post   => Net::HTTP::Post,
-                                 :put    => Net::HTTP::Put,
-                                 :delete => Net::HTTP::Delete }
-
-      http_request = method_to_http_request[args[:method]].
-          new(args[:url]) # create Net::HTTPRequest to get oauth header,
-                          # because RestClient::Request is not supported by Oauth
-      consumer.sign!(http_request)
-      request['Authorization'] = http_request['Authorization'] # add oauth header to rest_client request
+      consumer.sign!(request)
     end
   end
 end

data/lib/apipie/client/template/{client.gemspec.tt → a_name.gemspec.tt}

@@ -16,6 +16,7 @@ Gem::Specification.new do |gem|
   gem.version       = <%= class_base %><%= class_suffix %>::VERSION
 
   <% if all? %>gem.add_dependency 'thor', '>= 0.15.4'<% end %>
+  gem.add_dependency 'apipie-rails', '~> <%= Apipie::VERSION %>'
   gem.add_dependency 'json'
   gem.add_dependency 'rest-client', '>= 1.6.1'
   gem.add_dependency 'oauth'

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

@@ -0,0 +1,30 @@
+#!/usr/bin/env ruby
+require "rubygems" # ruby1.9 doesn't "require" it though
+require "pathname"
+require "thor"
+require 'thor/core_ext/file_binary_read'
+
+load_path = File.expand_path("../../lib", __FILE__)
+$: << load_path unless $:.include?(load_path)
+
+name, suffix = "<%= name %>", "<%= suffix %>"
+
+require name + suffix
+require 'apipie/client/main'
+
+client_module = Object.const_get "<%= class_base %><%= class_suffix %>"
+
+begin
+  Apipie::Client::Main.apipie_options = { :name          => name,
+                                          :config        => client_module.client_config,
+                                          :client_module => client_module,
+                                          :root          => client_module.root }
+  Apipie::Client::Main.start
+rescue RestClient::Exception => e
+  $stderr.puts e.message
+  exit 1
+rescue Errno::ECONNREFUSED => e
+  $stderr.puts "Server #{client_module.client_config[:base_url]} not available"
+  $stderr.puts e.message
+  exit 1
+end

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

@@ -0,0 +1,27 @@
+require 'apipie/client/base'
+require 'json'
+require 'yaml'
+
+Object.const_set("<%= class_base + class_suffix %>", client_module = Module.new do
+  def self.client_config
+    @client_config ||= YAML.load_file("#{root}/#{name}/config.yml")
+  end
+
+  def self.root
+    @root ||= File.expand_path(File.dirname(__FILE__))
+  end
+
+  def self.name
+    "<%= name %><%= suffix %>"
+  end
+
+  def self.doc
+    @doc ||= File.open("#{root}/#{name}/documentation.json", 'r') do |f|
+      JSON.load(f.read)['docs']
+    end
+  end
+end)
+
+require '<%= name %><%= suffix %>/version'
+resource_files = Dir[File.expand_path("#{client_module.root}/#{client_module.name}/resources/*.rb", __FILE__)]
+resource_files.each { |f| require f }

data/lib/apipie/client/template/{cli.rb.tt → lib/a_name/commands/cli.rb.tt}

@@ -1,4 +1,4 @@
-class <%= resource_name.camelize %> < <%= class_base %><%= class_suffix %>::CliCommand
+class <%= resource_name.camelize %> < Apipie::Client::CliCommand
 
 <% resource[:methods].each do |method| -%>
   desc '<%= method[:name] %>', '<%= api(method)[:short_description] %>'
@@ -9,15 +9,12 @@ class <%= resource_name.camelize %> < <%= class_base %><%= class_suffix %>::CliC
   method_option :<%= param[:name] %>, :required => <%= param[:required] ? 'true' : 'false' %>, :desc => '<%= plaintext(param[:description]) %>', :type => :<%= param[:expected_type] %>
 <%   end -%>
   def <%= method[:name] %>
-<%   if params_in_path(method).any? || transformation_hash(method).any?
+<%   #if params_in_path(method).any? || transformation_hash(method).any?
        transform_options_params = [params_in_path(method).inspect]
        transform_options_params << transformation_hash(method).inspect if transformation_hash(method).any? -%>
-    <%= (params_in_path(method) + ["options"]).join(", ") %>, *_ = transform_options(<%= transform_options_params.join(", ").html_safe %>)
-<%   end
-
-  client_args = params_in_path(method).dup
-  client_args << "options" if method[:params].any? -%>
-    data, resp = client.<%= method[:name] %><%= "(#{client_args.join(", ")})" if client_args.any? %>
+    params = transform_options(<%= transform_options_params.join(", ").html_safe %>)
+<%   #end -%>
+    data, resp = client.<%= method[:name] %>(params)
     print_data(data)
   end
 

data/lib/apipie/client/template/lib/a_name/config.yml

@@ -0,0 +1,6 @@
+---
+:base_url: http://localhost:3000
+:enable_validations: false
+:oauth:
+  :consumer_key: consumer
+  :consumer_secret: shhhh

data/lib/apipie/client/template/lib/a_name/resources/resource.rb.tt

@@ -0,0 +1,22 @@
+module <%= class_base %><%= class_suffix %>
+  module Resources
+    class <%= resource_name.camelize %> < Apipie::Client::Base
+      def self.doc
+        @doc ||= <%= class_base %><%= class_suffix %>.doc['resources']["<%= resource_key %>"]
+      end
+<% resource[:methods].each do |method| -%>
+
+      # @param [Hash] params a hash of params to be passed to the service
+      # allowed keys are: <%= validation(method).inspect %>
+      #
+      # @param [Hash] headers additional http headers
+      def <%= method[:name] %>(params = { }, headers = { })
+        check_params params, :allowed => <%= method[:params].any? %>, :method => __method__
+        url, params = fill_params_in_url "<%= api(method)[:api_url] %>", params
+        call(:"<%= api(method)[:http_method].downcase %>", url, params, headers)
+      end
+<% end -%>
+
+    end
+  end
+end

data/lib/apipie/client/thor.rb

@@ -0,0 +1,19 @@
+module Apipie::Client
+  class Thor < ::Thor
+
+    def self.apipie_options
+      Apipie::Client::Thor.instance_variable_get :@apipie_options
+    end
+
+    no_tasks do
+      def apipie_options
+        self.class.apipie_options
+      end
+    end
+
+    def self.apipie_options=(options)
+      Apipie::Client::Thor.instance_variable_set :@apipie_options, options
+    end
+
+  end
+end

data/lib/apipie/dsl_definition.rb

@@ -97,9 +97,9 @@ module Apipie
     #     puts greeting
     #   end
     #
-    def param(param_name, *args, &block) #:doc:
+    def param(param_name, validator, desc_or_options = nil, options = {}, &block) #:doc:
       return unless Apipie.active_dsl?
-      Apipie.last_params << Apipie::ParamDescription.new(param_name, *args, &block)
+      Apipie.last_params << Apipie::ParamDescription.new(param_name, validator, desc_or_options, options, &block)
     end
 
     # create method api and redefine newly added method
@@ -125,7 +125,7 @@ module Apipie
 
               # check if required parameters are present
               if param.required && !params.has_key?(param.name)
-                raise ArgumentError.new("Expecting #{param.name} parameter.")
+                raise ParamMissing.new(param.name)
               end
 
               # params validations

data/lib/apipie/errors.rb

@@ -0,0 +1,38 @@
+module Apipie
+
+  class Error < StandardError
+  end
+
+  class ParamError < Error
+  end
+
+  # abstract
+  class DefinedParamError < ParamError
+    attr_accessor :param
+
+    def initialize(param)
+      @param = param
+    end
+  end
+
+  class ParamMissing < DefinedParamError
+    def to_s
+      "Missing parameter #{@param}"
+    end
+  end
+
+  class ParamInvalid < DefinedParamError
+    attr_accessor :value, :error
+
+    def initialize(param, value, error)
+      super param
+      @value = value
+      @error = error
+    end
+
+    def to_s
+      "Invalid parameter '#{@param}' value #{@value.inspect}: #{@error}"
+    end
+  end
+
+end

data/lib/apipie/helpers.rb

@@ -20,5 +20,22 @@ module Apipie
       ret.sub!(/\/*\Z/,"")
       ret
     end
+
+    def include_javascripts
+      %w[ bundled/jquery-1.7.2.js
+          bundled/bootstrap-collapse.js
+          bundled/prettify.js
+          apipie.js ].map do |file|
+        "<script type='text/javascript' src='#{Apipie.full_url("javascripts/#{file}")}'></script>"
+      end.join("\n").html_safe
+    end
+
+    def include_stylesheets
+      %w[ bundled/bootstrap.min.css
+          bundled/prettify.css
+          bundled/bootstrap-responsive.min.css ].map do |file|
+        "<link type='text/css' rel='stylesheet' href='#{Apipie.full_url("stylesheets/#{file}")}'/>"
+      end.join("\n").html_safe
+    end
   end
 end

data/lib/apipie/param_description.rb

@@ -12,24 +12,31 @@ module Apipie
 
     attr_accessor :parent
 
-    def initialize(name, *args, &block)
+    def initialize(name, validator, desc_or_options = nil, options = {}, &block)
 
-      if args.size > 1 || !args.first.is_a?(Hash)
-        validator_type = args.shift || nil
-      else
-        validator_type = nil
+      if desc_or_options.is_a?(Hash) && options.empty?
+        options = desc_or_options
+      elsif desc_or_options.is_a?(String)
+        options[:desc] = desc_or_options
+      elsif !desc_or_options.nil?
+        raise ArgumentError.new("param description: expected description or options as 3rd parameter")
       end
-      options = args.pop || {}
+
+      options.symbolize_keys!
 
       @name = name
       @desc = Apipie.markup_to_html(options[:desc] || '')
-      @required = options[:required] || false
+      @required = if options.has_key? :required
+        options[:required]
+      else
+        Apipie.configuration.required_by_default?
+      end
       @allow_nil = options[:allow_nil] || false
 
       @validator = nil
-      unless validator_type.nil?
+      unless validator.nil?
         @validator =
-          Validator::BaseValidator.find(self, validator_type, options, block)
+          Validator::BaseValidator.find(self, validator, options, block)
         raise "Validator not found." unless validator
       end
     end
@@ -37,7 +44,9 @@ module Apipie
     def validate(value)
       return true if @allow_nil && value.nil?
       unless @validator.valid?(value)
-        raise ArgumentError.new(@validator.error)
+        error = @validator.error
+        error = ParamError.new(error) unless error.is_a? Exception
+        raise error
       end
     end
 

data/lib/apipie/resource_description.rb

@@ -31,8 +31,8 @@ module Apipie
       block.arity < 1 ? instance_eval(&block) : block.call(self) if block_given?
     end
 
-    def param(param_name, *args, &block)
-      param_description = Apipie::ParamDescription.new(param_name, *args, &block)
+    def param(param_name, validator, desc_or_options = nil, options = {}, &block)
+      param_description = Apipie::ParamDescription.new(param_name, validator, desc_or_options, options, &block)
       @_params_ordered << param_description
     end
 

data/lib/apipie/validator.rb

@@ -47,6 +47,10 @@ module Apipie
         "TODO: validator description"
       end
 
+      def error
+        ParamInvalid.new(param_name, @error_value, description)
+      end
+
       def to_s
         self.description
       end
@@ -83,12 +87,8 @@ module Apipie
         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
 
       def expected_type
@@ -118,12 +118,8 @@ module Apipie
         self.new(param_description, argument) if argument.is_a? Regexp
       end
 
-      def error
-        "Parameter #{param_name} expecting to match /#{@regexp.source}/, got '#{@error_value}'"
-      end
-
       def description
-        "Parameter has to match regular expression /#{@regexp.source}/."
+        "Must match regular expression /#{@regexp.source}/."
       end
     end
 
@@ -143,12 +139,8 @@ module Apipie
         self.new(param_description, argument) if argument.is_a?(Array)
       end
 
-      def error
-        "Parameter #{param_name} has bad value (#{@error_value.inspect}). Expecting one of: #{@array.join(',')}."
-      end
-
       def description
-        "Parameter has to be one of: #{@array.join(', ')}."
+        "Must be one of: #{@array.join(', ')}."
       end
     end
 
@@ -168,7 +160,7 @@ module Apipie
       end
 
       def error
-        "Parameter #{param_name} has bad value (\"#{@error_value}\"). #{@help}"
+        ParamInvalid.new(param_name, @error_value, @help)
       end
 
       def description
@@ -202,16 +194,12 @@ module Apipie
         return true
       end
 
-      def error
-        "Has to be hash."
-      end
-
       def description
-        "Has to be hash."
+        "Must be a Hash"
       end
 
-      def param(param_name, *args, &block)
-        param_description = Apipie::ParamDescription.new(param_name, *args, &block)
+      def param(param_name, validator, desc_or_options = nil, options = {}, &block)
+        param_description = Apipie::ParamDescription.new(param_name, validator, desc_or_options, options, &block)
         param_description.parent = self.param_description
         @hash_params_ordered << param_description
         @hash_params[param_name.to_sym] = param_description
@@ -253,12 +241,8 @@ module Apipie
         end
       end
 
-      def error
-        "Parameter #{param_name} expecting to be a number, got: #{@error_value}"
-      end
-
       def description
-        "Has to be a number."
+        "Must be a number."
       end
 
       def self.validate(value)
@@ -278,12 +262,8 @@ module Apipie
         end
       end
 
-      def error
-        "Parameter #{param_name} expecting to be a boolean value, got: #{@error_value}"
-      end
-
       def description
-        "Has to be a boolean"
+        "Must be 'true' or 'false'"
       end
     end