apipie-rails 0.0.13 → 0.0.14

data/lib/apipie/client/cli_command.rb

@@ -1,130 +0,0 @@
-module Apipie
-  module Client
-    class CliCommand < Thor
-      no_tasks do
-        def client
-          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 = { })
-          # 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]) }
-
-          inline_params.each { |p| transformed_options[p] = options[p] }
-
-          transform_hash.each do |sub_key, params|
-            transformed_options[sub_key] = { }
-            params.each { |p| transformed_options[sub_key][p] = options[p] if options.has_key?(p) }
-          end
-
-          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)
-          end
-        end
-
-        # unifies the data for further processing. e.g.
-        #
-        #     { "user" => {"username" => "test", "password" => "changeme" }
-        #
-        # becomes:
-        #
-        #     { "username" => "test", "password" => "changeme" }
-        def normalize_item_data(item)
-          if item.size == 1 && item.values.first.is_a?(Hash)
-            item.values.first
-          else
-            item
-          end
-        end
-
-        def table_from_array(data)
-          return [] if data.empty?
-          table   = []
-          items   = data.map { |item| normalize_item_data(item) }
-          columns = items.first.keys
-          table << columns
-          items.each do |item|
-            row = columns.map { |c| item[c] }
-            table << row.map(&:to_s)
-          end
-          return table
-        end
-
-        def table_from_hash(data)
-          return [] if data.empty?
-          table = []
-          normalize_item_data(data).each do |k, v|
-            table << ["#{k}:", v].map(&:to_s)
-          end
-          table
-        end
-
-        def print_unknown(data)
-          say data
-        end
-
-        def print_big_table(table, options={ })
-          return if table.empty?
-
-          formats, ident, colwidth = [], options[:ident].to_i, options[:colwidth]
-          options[:truncate] = terminal_width if options[:truncate] == true
-
-          formats << "%-#{colwidth + 2}s" if colwidth
-          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
-            formats << "%-#{maxima + 2}s"
-          end
-
-          formats << "%s"
-          formats[0] = formats[0].insert(0, " " * ident)
-
-          header_printed = false
-          table.each do |row|
-            sentence = ""
-
-            row.each_with_index do |column, i|
-              sentence << formats[i] % column.to_s
-            end
-
-            sentence = truncate(sentence, options[:truncate]) if options[:truncate]
-            $stdout.puts sentence
-            say(set_color("-" * sentence.size, :green)) unless header_printed
-            header_printed = true
-          end
-        end
-
-      end
-
-      class << self
-        def help(shell, subcommand = true)
-          list = self.printable_tasks(true, subcommand)
-          Thor::Util.thor_classes_in(self).each do |klass|
-            list += printable_tasks(false)
-          end
-          list.sort! { |a, b| a[0] <=> b[0] }
-
-          shell.say
-          shell.print_table(list, :indent => 2, :truncate => true)
-          shell.say
-          Thor.send(:class_options_help, shell)
-        end
-
-        def banner(task, namespace = nil, subcommand = false)
-          task.name
-        end
-      end
-    end
-  end
-end

data/lib/apipie/client/main.rb

@@ -1,101 +0,0 @@
-require "apipie/client/thor"
-require "apipie/client/cli_command"
-
-module Apipie
-  module Client
-    class Main < Thor
-
-      def help(meth = nil)
-        if meth && !self.respond_to?(meth)
-          initialize_thorfiles(meth)
-          klass, task = Thor::Util.find_class_and_task_by_namespace(meth)
-          self.class.handle_no_task_error(task, false) if klass.nil?
-          klass.start(["-h", task].compact, :shell => self.shell)
-        else
-          say "#{apipie_options[:name].capitalize} CLI"
-          say
-          invoke :commands
-        end
-      end
-
-      desc "commands [SEARCH]", "List the available commands"
-      def commands(search="")
-        initialize_thorfiles
-        klasses = Thor::Base.subclasses
-        display_klasses(false, false, klasses)
-      end
-
-      class << self
-        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)
-          if opts['auth']
-            username, password                 = opts['auth'].split(':')
-            apipie_options[:config][:username] = username
-            apipie_options[:config][:password] = password
-          end
-          remaining = parser.remaining
-
-          super(task, remaining, given_options, config)
-        end
-      end
-
-      private
-
-      def method_missing(meth, *args)
-        meth = meth.to_s
-        initialize_thorfiles(meth)
-        klass, task = Thor::Util.find_class_and_task_by_namespace(meth)
-        args.unshift(task) if task
-        klass.start(args, :shell => self.shell)
-      end
-
-      # Load the thorfiles. If relevant_to is supplied, looks for specific files
-      # in the thor_root instead of loading them all.
-      #
-      # By default, it also traverses the current path until find Thor files, as
-      # described in thorfiles. This look up can be skipped by suppliying
-      # skip_lookup true.
-      #
-      def initialize_thorfiles(relevant_to=nil, skip_lookup=false)
-        thorfiles.each do |f|
-          Thor::Util.load_thorfile(f, nil, options[:debug])
-        end
-      end
-
-      def thorfiles
-        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, ::Apipie::Client::CliCommand, ::Thor] unless show_internal
-
-        show_modules if with_modules && !thor_yaml.empty?
-
-        list   = Hash.new { |h, k| h[k] = [] }
-        groups = []
-
-        # Get classes which inherit from Thor
-        (klasses - groups).each { |k| list[k.namespace.split(":").first] += k.printable_tasks(false) }
-
-        # Get classes which inherit from Thor::Base
-        groups.map! { |k| k.printable_tasks(false).first }
-        list["root"] = groups
-
-        # Order namespaces with default coming first
-        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
-
-      def display_tasks(namespace, list) #:nodoc:
-        say namespace
-      end
-    end
-  end
-
-end
-

data/lib/apipie/client/rest_client_oauth.rb

@@ -1,19 +0,0 @@
-unless RestClient.const_defined? :OAUTH_EXTENSION
-  RestClient::OAUTH_EXTENSION = lambda do |request, args|
-    if args[:oauth]
-      uri             = URI.parse args[:url]
-      default_options = { :site               => "#{uri.scheme}://#{uri.host}:#{uri.port.to_s}",
-                          :request_token_path => "",
-                          :authorize_path     => "",
-                          :access_token_path  => "" }
-      options         = default_options.merge args[:oauth][:options] || { }
-      consumer        = OAuth::Consumer.new(args[:oauth][:consumer_key], args[:oauth][:consumer_secret], options)
-
-      consumer.sign!(request)
-    end
-  end
-end
-
-unless RestClient.before_execution_procs.include? RestClient::OAUTH_EXTENSION
-  RestClient.add_before_execution_proc &RestClient::OAUTH_EXTENSION
-end

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

@@ -1,3 +0,0 @@
-source :rubygems
-
-gemspec

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

@@ -1,3 +0,0 @@
-This is a readme file for this gem.
-
-Let the code be with you!

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

@@ -1,2 +0,0 @@
-#!/usr/bin/env rake
-require "bundler/gem_tasks"

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

@@ -1,23 +0,0 @@
-# -*- encoding: utf-8 -*-
-require File.expand_path('../lib/<%= name %><%= suffix %>/version', __FILE__)
-
-Gem::Specification.new do |gem|
-  gem.authors       = ["TODO"]
-  gem.email         = ["TODO"]
-  gem.description   = %q{TODO: Write a gem description}
-  gem.summary       = %q{TODO: Write a gem summary}
-  gem.homepage      = ""
-
-  gem.files         = `git ls-files`.split($\)
-  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
-  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
-  gem.name          = "<%= name %><%= suffix %>"
-  gem.require_paths = ["lib"]
-  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'
-end

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

@@ -1,30 +0,0 @@
-#!/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

@@ -1,27 +0,0 @@
-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/lib/a_name/commands/cli.rb.tt

@@ -1,22 +0,0 @@
-class <%= resource_name.camelize %> < Apipie::Client::CliCommand
-
-<% resource[:methods].each do |method| -%>
-  desc '<%= method[:name] %>', '<%= api(method)[:short_description] %>'
-<%   params_in_path(method).each do |param| -%>
-  method_option :<%= param %>, :required => 'true'
-<%   end
-     method[:params].map {|p| p[:expected_type] == "hash" ? (p[:params] || p) : p}.flatten.each do |param| -%>
-  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?
-       transform_options_params = [params_in_path(method).inspect]
-       transform_options_params << transformation_hash(method).inspect if transformation_hash(method).any? -%>
-    params = transform_options(<%= transform_options_params.join(", ").html_safe %>)
-<%   #end -%>
-    data, resp = client.<%= method[:name] %>(params)
-    print_data(data)
-  end
-
-<% end -%>
-end

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

@@ -1,6 +0,0 @@
----
-: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

@@ -1,22 +0,0 @@
-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/template/lib/a_name/version.rb.tt

@@ -1,3 +0,0 @@
-module <%= class_base %><%= class_suffix %>
-  VERSION = "0.0.1"
-end

data/lib/apipie/client/thor.rb

@@ -1,21 +0,0 @@
-module Apipie
-  module 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
-end

data/rubygem-apipie-rails.spec

@@ -1,122 +0,0 @@
-%global gem_name apipie-rails
-
-%if 0%{?rhel} == 6 || 0%{?fedora} < 17
-%define rubyabi 1.8
-%else
-%define rubyabi 1.9.1
-%endif
-%if 0%{?rhel} == 6
-%global gem_dir %(ruby -rubygems -e 'puts Gem::dir' 2>/dev/null)
-%global gem_docdir %{gem_dir}/doc/%{gem_name}-%{version}
-%global gem_cache %{gem_dir}/cache/%{gem_name}-%{version}.gem
-%global gem_spec %{gem_dir}/specifications/%{gem_name}-%{version}.gemspec
-%global gem_instdir %{gem_dir}/gems/%{gem_name}-%{version}
-%global gem_libdir %{gem_dir}/gems/%{gem_name}-%{version}/lib
-%endif
-
-Summary: Rails API documentation tool and client generator
-Name: rubygem-%{gem_name}
-Version: 0.0.11
-Release: 3%{?dist}
-Group: Development/Libraries
-License: MIT
-URL: http://github.com/Pajk/apipie-rails
-Source0: http://rubygems.org/downloads/%{gem_name}-%{version}.gem
-Requires: ruby(abi) >= %{rubyabi}
-Requires: rubygems
-%if 0%{?fedora}
-BuildRequires: rubygems-devel
-%endif
-BuildRequires: ruby(abi) >= %{rubyabi}
-BuildRequires: rubygems
-BuildArch: noarch
-Provides: rubygem(%{gem_name}) = %{version}
-
-%description
-This gem adds new methods to Rails controllers that can be used to describe
-resources exposed by API. Information entered with provided DSL are used
-to generate documentation, client or to validate incoming requests.
-
-%package doc
-BuildArch:  noarch
-Requires:   %{name} = %{version}-%{release}
-Summary:    Documentation for rubygem-%{gem_name}
-
-%description doc
-This package contains documentation for rubygem-%{gem_name}.
-
-%prep
-%setup -q -c -T
-mkdir -p .%{gem_dir}
-gem install --local --install-dir .%{gem_dir} \
-            --force %{SOURCE0} --no-rdoc --no-ri
-
-%build
-
-%install
-mkdir -p %{buildroot}%{gem_dir}
-cp -a .%{gem_dir}/* \
-        %{buildroot}%{gem_dir}/
-
-%files
-%dir %{gem_instdir}
-%{gem_instdir}/app
-%{gem_instdir}/lib
-%exclude %{gem_instdir}/Gemfile.lock
-%exclude %{gem_cache}
-%{gem_spec}
-%doc %{gem_instdir}/MIT-LICENSE
-%doc %{gem_instdir}/APACHE-LICENSE-2.0
-
-%exclude %{gem_instdir}/spec
-%exclude %{gem_instdir}/rel-eng
-%exclude %{gem_instdir}/.gitignore
-%exclude %{gem_instdir}/.rspec
-%exclude %{gem_instdir}/.rvmrc
-%exclude %{gem_instdir}/.travis.yml
-%exclude %{gem_instdir}/rubygem-apipie-rails.spec
-%exclude %{gem_dir}/cache/%{gem_name}-%{version}.gem
-
-%files doc
-%doc %{gem_instdir}/MIT-LICENSE
-%doc %{gem_instdir}/README.rdoc
-%doc %{gem_instdir}/NOTICE
-%{gem_instdir}/Rakefile
-%{gem_instdir}/Gemfile
-%{gem_instdir}/%{gem_name}.gemspec
-
-%changelog
-* Fri Sep 07 2012 Miroslav Suchý <msuchy@redhat.com> 0.0.11-3
-- summary should not end with dot (msuchy@redhat.com)
-- fix spelling (msuchy@redhat.com)
-- do not package Gemfile.lock (msuchy@redhat.com)
-
-* Fri Aug 17 2012 Ivan Necas <inecas@redhat.com> 0.0.11-2
-- fix building for F17 reusing the macros from rubygem- devel
-
-* Wed Aug 15 2012 Pavel Pokorný <pajkycz@gmail.com> 0.0.11-1
-- apipie-rails v0.0.11
-- cli client improvements
-
-* Tue Jul 31 2012 Pavel Pokorný <pajkycz@gmail.com> 0.0.9-2
-- exclude documentation from rpm
-
-* Tue Jul 31 2012 Pavel Pokorný <pajkycz@gmail.com> 0.0.9-1
-- New version of apipie-rails gem (pajkycz@gmail.com)
-- fixed client generator
-- resource level error descriptions
-- response supported formats
-
-* 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
-
-* Wed Jul 25 2012 Pavel Pokorný <pajkycz@gmail.com> 0.0.7-1
-- new package built with tito
-