apipie-bindings 0.0.11 → 0.0.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7c09e522a914498b0cc1edbefcbcfc9a31bdde5e
-  data.tar.gz: 64e1e5df75c1c34e48bacfbee89b918a82d4d67b
+  metadata.gz: 2c5360234676ffe74c406a3f1db1c9186121f38c
+  data.tar.gz: 2c494b2c5acaad567f49b21af4faa5a15d3425fc
 SHA512:
-  metadata.gz: 87f289b0d316e15d468abdf01bad936c9692dd9834ac0fc8e847225f26c54400778b1c8134cf800b1dad6c4e2cb66861ca44e935d537c7d3b641e2074ac9a434
-  data.tar.gz: ceeeab2bf484187e116bdcf72c3f32a148e282ec3234ed59c38211b85d0a55631ebb73648067a5923c0e97db23abe86a2c8b5657aa27e9b735c3dbd7c2643a71
+  metadata.gz: 3ebe8bed0ff3b51162576e26f9dd7b272592f3080b1781519cbdcfb9e14217eb9dc5b012bbf6ef195c5ef22da5578aacd9bb48f4dd0fe2bc7f8af7b36e622baf
+  data.tar.gz: c608be1dcb850cab02b6ddf28706775c96b0850fb343eda45be12b361fa9def08746711dc2bd8d9874012f208d63a2f2687714c1924ababc93c33b1980c0590b

data/doc/release_notes.md

@@ -1,6 +1,13 @@
 Release notes
 =============
 
+### 0.0.12 (2015-03-23)
+* Add readme to the dummy app
+* Fix ordering issue in tests
+* Dummy app for testing purposes
+* Declare 1.8 dependencies in Gemfile for tests
+* Allow non-friendly 1.8 gems (Newer libraries supports IPv6)
+
 ### 0.0.11 (2014-11-09)
 * Added lazy loading of credentials ([#7408](http://projects.theforeman.org/issues/7408))
 * Separate caches for different API versions ([#18](http://github.com/Apipie/apipie-bindings/issues/18))

data/lib/apipie_bindings/version.rb

@@ -1,5 +1,5 @@
 module ApipieBindings
   def self.version
-    @version ||= Gem::Version.new '0.0.11'
+    @version ||= Gem::Version.new '0.0.12'
   end
 end

data/test/dummy/.gitignore

@@ -0,0 +1,12 @@
+# See http://help.github.com/ignore-files/ for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile ~/.gitignore_global
+
+# Ignore bundler config
+/.bundle
+/public/apipie-cache
+Gemfile.lock
+/log/*.log
+/tmp

data/test/dummy/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gem 'rails', '4.2.0'
+
+gem 'rails-api'
+gem 'apipie-rails', '>= 0.3.1'

data/test/dummy/README.md

@@ -0,0 +1,33 @@
+A dummy app with apipie definition allows:
+
+1. easier adding of more complex cases of documentation (no need
+   to craft the json document manually: just change the dummy app
+   and regenerate the json
+
+1. easier hanlding of next versions of apipie-rails: every change in the json
+   API can be handled easier and issues spotted sooner as well
+
+1. easier integration testing: the dummy app is responding almost real data
+   that the bindings can be run against to see the results.
+
+To regenerate the `dummy.json`, from the apipie-bindings root dir, just
+delete the test/unit/data/dummy.json and it will be generated again on
+next rake test or explicitly with `rake test/unit/data/dummy.json`
+
+The dummy app can be used also for testing against real Rails app,
+as it serves some dummy data (that can be customized by editing the
+`data` folder:
+
+1. bundle install
+1. bundle exec rails s
+1. `curl http://localhost:3000/users`
+
+   `curl http://localhost:3000/users/1`
+
+   `curl http://localhost:3000/users/1/posts`
+
+   `curl http://localhost:3000/users/1/posts/1`
+
+   `curl http://localhost:3000/users/1/posts/1/comments`
+
+   `curl http://localhost:3000/users/1/posts/1/comments/1`

data/test/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Rails.application.load_tasks

data/test/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,2 @@
+class ApplicationController < ActionController::API
+end

data/test/dummy/app/controllers/comments_controller.rb

@@ -0,0 +1,9 @@
+class CommentsController < ApplicationController
+  include Concerns::DummyConcern
+
+  protected
+
+  def base_path
+    "/users/#{params[:user_id]}/posts/#{params[:post_id]}/comments"
+  end
+end

data/test/dummy/app/controllers/concerns/dummy_concern.rb

@@ -0,0 +1,38 @@
+module Concerns
+  module DummyConcern
+    extend Apipie::DSL::Concern
+    include ActiveSupport::Concern
+
+    api!
+    def index
+      render :json => Dummy::Store.index(base_path)
+    end
+
+    api!
+    def show
+      render :json => Dummy::Store.show("#{base_path}/#{params[:id]}")
+    end
+
+    api!
+    def create
+      render :json => params
+    end
+
+    api!
+    def update
+      render :json => Dummy::Store.show("#{base_path}/#{params[:id]}")
+    end
+
+    api!
+    def destroy
+      render :json => []
+    end
+
+    protected
+
+    def base_path
+      raise NotImplementedError
+    end
+
+  end
+end

data/test/dummy/app/controllers/posts_controller.rb

@@ -0,0 +1,9 @@
+class PostsController < ApplicationController
+  include Concerns::DummyConcern
+
+  protected
+
+  def base_path
+    "/users/#{params[:user_id]}/posts"
+  end
+end

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

@@ -0,0 +1,32 @@
+class UsersController < ApplicationController
+  include Concerns::DummyConcern
+
+  api!
+  example <<-EXAMPLE
+GET /users
+200
+[ {"user":{"name":"John Doe" }} ]
+EXAMPLE
+  def index
+    super
+  end
+
+  api!
+  param :user, Hash do
+    param :name, String, required: true
+  end
+  def create
+    super
+  end
+
+  api!
+  param :name, String, required: true
+  def create_unnested
+  end
+
+  protected
+
+  def base_path
+    '/users'
+  end
+end

data/test/dummy/app/lib/dummy/store.rb

@@ -0,0 +1,50 @@
+require 'forwardable'
+
+module Dummy
+  class Store
+
+    class << self
+      extend Forwardable
+      def_delegators :instance, :index, :show
+
+      def instance
+        @store ||= Store.new
+      end
+    end
+
+    def initialize(base_dir = File.join(Rails.root, '/data/example'))
+      @base_dir = base_dir
+    end
+
+    def index(path, data = {})
+      show_files(path).map { |file| load_json(file) }
+    end
+
+    def show(path, data = {})
+      file = real_path("#{path}/show.json")
+      if File.exists?(file)
+        load_json(file)
+      end
+    end
+
+    private
+
+    def show_files(resource_path)
+      Dir.glob(real_path("#{resource_path}/*/show.json"))
+    end
+
+    def load_from_path(abstract_path)
+      load_json(real_path(abstract_path))
+    end
+
+    def load_json(path)
+      JSON.load(File.read(path))
+    end
+
+    def real_path(path)
+      File.join(@base_dir, path)
+    end
+
+  end
+
+end

data/test/dummy/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/test/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../../config/application', __FILE__)
+require_relative '../config/boot'
+require 'rails/commands'

data/test/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/test/dummy/config.ru

@@ -0,0 +1,4 @@
+# This file is used by Rack-based servers to start the application.
+
+require ::File.expand_path('../config/environment', __FILE__)
+run Rails.application

data/test/dummy/config/application.rb

@@ -0,0 +1,37 @@
+require File.expand_path('../boot', __FILE__)
+
+# Pick the frameworks you want:
+require "action_controller/railtie"
+require "action_view/railtie"
+
+# Require the gems listed in Gemfile, including any gems
+# you've limited to :test, :development, or :production.
+Bundler.require(*Rails.groups)
+
+module Dummy
+
+  class ObserverMiddleware
+    def initialize(app)
+      @app = app
+    end
+
+    def log(msg)
+      puts msg
+    end
+
+    def call(env)
+      status, headers, body = @app.call(env)
+      if body.respond_to?(:map)
+        log "#{env['REQUEST_METHOD']} #{env['PATH_INFO']} #{status}"
+        log body.map { |l| "  #{l}"}.join("\n")
+      end
+      [status, headers, body]
+    end
+  end
+
+  class Application < Rails::Application
+    config.autoload_paths += %w[#{config.root}/app/lib]
+
+    config.middleware.insert_before(ActionDispatch::ShowExceptions, ObserverMiddleware)
+  end
+end

data/test/dummy/config/boot.rb

@@ -0,0 +1,3 @@
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+
+require 'bundler/setup' # Set up gems listed in the Gemfile.

data/test/dummy/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the Rails application.
+require File.expand_path('../application', __FILE__)
+
+# Initialize the Rails application.
+Rails.application.initialize!

data/test/dummy/config/environments/development.rb

@@ -0,0 +1,22 @@
+Rails.application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # In the development environment your application's code is reloaded on
+  # every request. This slows down response time but is perfect for development
+  # since you don't have to restart the web server when you make code changes.
+  config.cache_classes = false
+
+  # Do not eager load code on boot.
+  config.eager_load = false
+
+  # Show full error reports and disable caching.
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Print deprecation notices to the Rails logger.
+  config.active_support.deprecation = :log
+
+
+  # Raises error for missing translations
+  # config.action_view.raise_on_missing_translations = true
+end

data/test/dummy/config/environments/production.rb

@@ -0,0 +1,64 @@
+Rails.application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # Code is not reloaded between requests.
+  config.cache_classes = true
+
+  # Eager load code on boot. This eager loads most of Rails and
+  # your application in memory, allowing both threaded web servers
+  # and those relying on copy on write to perform better.
+  # Rake tasks automatically ignore this option for performance.
+  config.eager_load = true
+
+  # Full error reports are disabled and caching is turned on.
+  config.consider_all_requests_local       = false
+  config.action_controller.perform_caching = true
+
+  # Enable Rack::Cache to put a simple HTTP cache in front of your application
+  # Add `rack-cache` to your Gemfile before enabling this.
+  # For large-scale production use, consider using a caching reverse proxy like
+  # NGINX, varnish or squid.
+  # config.action_dispatch.rack_cache = true
+
+  # Disable serving static files from the `/public` folder by default since
+  # Apache or NGINX already handles this.
+  config.serve_static_files = ENV['RAILS_SERVE_STATIC_FILES'].present?
+
+
+  # Specifies the header that your server uses for sending files.
+  # config.action_dispatch.x_sendfile_header = 'X-Sendfile' # for Apache
+  # config.action_dispatch.x_sendfile_header = 'X-Accel-Redirect' # for NGINX
+
+  # Force all access to the app over SSL, use Strict-Transport-Security, and use secure cookies.
+  # config.force_ssl = true
+
+  # Use the lowest log level to ensure availability of diagnostic information
+  # when problems arise.
+  config.log_level = :debug
+
+  # Prepend all log lines with the following tags.
+  # config.log_tags = [ :subdomain, :uuid ]
+
+  # Use a different logger for distributed setups.
+  # config.logger = ActiveSupport::TaggedLogging.new(SyslogLogger.new)
+
+  # Use a different cache store in production.
+  # config.cache_store = :mem_cache_store
+
+  # Enable serving of images, stylesheets, and JavaScripts from an asset server.
+  # config.action_controller.asset_host = 'http://assets.example.com'
+
+  # Ignore bad email addresses and do not raise email delivery errors.
+  # Set this to true and configure the email server for immediate delivery to raise delivery errors.
+  # config.action_mailer.raise_delivery_errors = false
+
+  # Enable locale fallbacks for I18n (makes lookups for any locale fall back to
+  # the I18n.default_locale when a translation cannot be found).
+  config.i18n.fallbacks = true
+
+  # Send deprecation notices to registered listeners.
+  config.active_support.deprecation = :notify
+
+  # Use default logging formatter so that PID and timestamp are not suppressed.
+  config.log_formatter = ::Logger::Formatter.new
+end

data/test/dummy/config/environments/test.rb

@@ -0,0 +1,37 @@
+Rails.application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # The test environment is used exclusively to run your application's
+  # test suite. You never need to work with it otherwise. Remember that
+  # your test database is "scratch space" for the test suite and is wiped
+  # and recreated between test runs. Don't rely on the data there!
+  config.cache_classes = true
+
+  # Do not eager load code on boot. This avoids loading your whole application
+  # just for the purpose of running a single test. If you are using a tool that
+  # preloads Rails for running tests, you may have to set it to true.
+  config.eager_load = false
+
+  # Configure static file server for tests with Cache-Control for performance.
+  config.serve_static_files   = true
+  config.static_cache_control = 'public, max-age=3600'
+
+  # Show full error reports and disable caching.
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Raise exceptions instead of rendering exception templates.
+  config.action_dispatch.show_exceptions = false
+
+  # Disable request forgery protection in test environment.
+  config.action_controller.allow_forgery_protection = false
+
+  # Randomize the order test cases are executed.
+  config.active_support.test_order = :random
+
+  # Print deprecation notices to the stderr.
+  config.active_support.deprecation = :stderr
+
+  # Raises error for missing translations
+  # config.action_view.raise_on_missing_translations = true
+end

data/test/dummy/config/initializers/apipie.rb

@@ -0,0 +1,6 @@
+Apipie.configure do |config|
+  config.app_name                = "Dummy"
+  config.api_base_url            = "/"
+  config.doc_base_url            = "/apipie"
+  config.api_controllers_matcher = "#{Rails.root}/app/controllers/*.rb"
+end

data/test/dummy/config/initializers/session_store.rb

@@ -0,0 +1,2 @@
+# Be sure to restart your server when you modify this file.
+Dummy::Application.config.secret_token = 'how much security would you expect here?'

data/test/dummy/config/routes.rb

@@ -0,0 +1,9 @@
+Rails.application.routes.draw do
+  apipie
+  resources :users do
+    collection { post :create_unnested }
+    resources :posts do
+      resources :comments
+    end
+  end
+end

data/test/dummy/data/example/users/1/posts/1/comments/1/show.json

@@ -0,0 +1,7 @@
+{
+    "comment": {
+        "id": 1,
+        "title": "Nice article",
+        "body": "Little bit cliche though"
+    }
+}

data/test/dummy/data/example/users/1/posts/1/show.json

@@ -0,0 +1,7 @@
+{
+    "post": {
+        "id": 1,
+        "title": "Hello World",
+        "body": "This is the body of the post"
+    }
+}

data/test/dummy/data/example/users/1/show.json

@@ -0,0 +1,6 @@
+{
+    "user": {
+        "id": 1,
+        "name": "John Doe"
+    }
+}

data/test/dummy/public/index.html

@@ -0,0 +1,14 @@
+<html>
+  <head>
+    <title>Apipie-bindings demo app</title>
+  </head>
+  <body>
+    <pre><code>
+
+This is a demo app to test the apipie-bindings against. The main
+purpose is to generate up-to-date apipie.json that the apipie-bindings
+can consume.
+
+</code></pre>
+  </body>
+</html>

data/test/unit/action_test.rb

@@ -3,12 +3,12 @@ require File.join(File.dirname(__FILE__), 'test_helper')
 describe ApipieBindings::Action do
 
   let(:resource) { ApipieBindings::API.new({:apidoc_cache_dir => 'test/unit/data',
-    :apidoc_cache_name => 'architecture'}).resource(:architectures) }
+    :apidoc_cache_name => 'dummy'}).resource(:users) }
 
   it "should allow user to call the action" do
     params = { :a => 1 }
     headers = { :content_type => 'application/json' }
-    ApipieBindings::API.any_instance.expects(:call).with(:architectures, :index, params, headers, {})
+    ApipieBindings::API.any_instance.expects(:call).with(:users, :index, params, headers, {})
     resource.action(:index).call(params, headers)
   end
 
@@ -17,11 +17,11 @@ describe ApipieBindings::Action do
   end
 
   it "should find suitable route" do
-    resource.action(:index).find_route.path.must_equal "/api/architectures"
+    resource.action(:index).find_route.path.must_equal "/users"
   end
 
   it "should return params" do
-    resource.action(:create).params.map(&:name).must_equal ['architecture']
+    resource.action(:create).params.map(&:name).must_equal ['user']
   end
 
   # TODO add tests for more find_route cases
@@ -43,20 +43,20 @@ describe ApipieBindings::Action do
 
   it "should validate incorrect params" do
     e = proc do
-      resource.action(:create).validate!({ :architecture => { :foo => "foo" } })
+      resource.action(:create).validate!({ :user => { :foo => "foo" } })
     end.must_raise(ApipieBindings::MissingArgumentsError)
     e.message.must_match /: name$/
 
     e = proc do
       # completely different sub-hash; should still fail
-      resource.action(:create).validate!({ :organization => { :name => "acme" } })
+      resource.action(:create).validate!({ :apple => { :foo => "foo" } })
     end.must_raise(ApipieBindings::MissingArgumentsError)
     e.message.must_match /: name$/
   end
 
   it "should accept correct params" do
-    resource.action(:create).validate!({:architecture => { :name => 'i386' } })
-    resource.action(:create_unnested).validate!(:name => "i386")
+    resource.action(:create).validate!({:user => { :name => 'John Doe' } })
+    resource.action(:create_unnested).validate!(:name => "John Doe")
   end
 
   it "should have name visible in puts" do

data/test/unit/api_test.rb

@@ -2,64 +2,64 @@ require File.join(File.dirname(__FILE__), 'test_helper')
 
 describe ApipieBindings::API do
 
-  let(:api) { ApipieBindings::API.new({:apidoc_cache_dir => 'test/unit/data', :apidoc_cache_name => 'architecture'}) }
+  let(:api) { ApipieBindings::API.new({:apidoc_cache_dir => 'test/unit/data', :apidoc_cache_name => 'dummy'}) }
 
   it "should provide resource" do
-    result = api.resource(:architectures)
+    result = api.resource(:users)
     result.must_be_kind_of ApipieBindings::Resource
   end
 
   it "should test if resource is available" do
-    api.has_resource?(:architectures).must_equal true
+    api.has_resource?(:users).must_equal true
   end
 
   it "should list resources" do
-    api.resources.map(&:name).must_equal [:architectures]
+    api.resources.map(&:name).sort_by(&:to_s).must_equal [:comments, :posts, :users]
   end
 
   it "should call the method" do
     params = { :a => 1 }
     headers = { :content_type => 'application/json' }
-    ApipieBindings::API.any_instance.expects(:http_call).with('get', '/api/architectures', params, headers, {})
-    api.call(:architectures, :index, params, headers)
+    ApipieBindings::API.any_instance.expects(:http_call).with('get', '/users', params, headers, {})
+    api.call(:users, :index, params, headers)
   end
 
   it "should call the method and fill in the params" do
     params = { :id => 1 }
     headers = { :content_type => 'application/json' }
-    ApipieBindings::API.any_instance.expects(:http_call).with('get', '/api/architectures/1', {}, headers, {})
-    api.call(:architectures, :show, params, headers)
+    ApipieBindings::API.any_instance.expects(:http_call).with('get', '/users/1', {}, headers, {})
+    api.call(:users, :show, params, headers)
   end
 
   it "should return values from examples in dry_run mode" do
     api.dry_run = true
-    result = api.call(:architectures, :index)
+    result = api.call(:users, :index)
     result.must_be_kind_of Array
   end
 
   it "should allow to set dry_run mode in config params" do
     api = ApipieBindings::API.new({
       :apidoc_cache_dir => 'test/unit/data',
-      :apidoc_cache_name => 'architecture',
+      :apidoc_cache_name => 'dummy',
       :dry_run => true })
-    result = api.call(:architectures, :index)
+    result = api.call(:users, :index)
     result.must_be_kind_of Array
   end
 
   it "should allow to set fake response in config params" do
     api = ApipieBindings::API.new({
       :apidoc_cache_dir => 'test/unit/data',
-      :apidoc_cache_name => 'architecture',
+      :apidoc_cache_name => 'dummy',
       :dry_run => true,
-      :fake_params => { [:architectures, :index] => {:default => [] } }} )
-    result = api.call(:architectures, :index)
+      :fake_params => { [:users, :index] => {:default => [] } }} )
+    result = api.call(:users, :index)
     result.must_be_kind_of Array
   end
 
   it "should preserve file in args (#2)" do
     api = ApipieBindings::API.new({
       :apidoc_cache_dir => 'test/unit/data',
-      :apidoc_cache_name => 'architecture',
+      :apidoc_cache_name => 'dummy',
       :dry_run => true})
     s = StringIO.new; s << 'foo'
     headers = {:content_type => 'multipart/form-data', :multipart => true}
@@ -127,7 +127,7 @@ describe ApipieBindings::API do
 
     it "should load cache and its name from cache dir" do
       Dir["#{@dir}/*"].each { |f| File.delete(f) }
-      FileUtils.cp('test/unit/data/architecture.json', File.join(@dir, 'api_cache.json'))
+      FileUtils.cp('test/unit/data/dummy.json', File.join(@dir, 'api_cache.json'))
       api = ApipieBindings::API.new({:apidoc_cache_dir => @dir})
       api.apidoc_cache_name.must_equal 'api_cache'
     end

data/test/unit/data/dummy.json

@@ -0,0 +1 @@
+{"docs":{"name":"Dummy","info":"Another API description","copyright":null,"doc_url":"./apipie/1.0","api_url":"/","resources":{"users":{"doc_url":"./apipie/1.0/users","api_url":"/","name":"Users","short_description":null,"full_description":null,"version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"./apipie/1.0/users/index","name":"index","apis":[{"api_url":"/users","http_method":"GET","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"examples":["GET /users\n200\n[ {\"user\":{\"name\":\"John Doe\" }} ]\n"],"metadata":null,"see":[]},{"doc_url":"./apipie/1.0/users/show","name":"show","apis":[{"api_url":"/users/:id","http_method":"GET","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"metadata":null,"see":[]},{"doc_url":"./apipie/1.0/users/create","name":"create","apis":[{"api_url":"/users","http_method":"POST","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"user","full_name":"user","description":"","required":false,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"user[name]","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}]}],"examples":[],"metadata":null,"see":[]},{"doc_url":"./apipie/1.0/users/update","name":"update","apis":[{"api_url":"/users/:id","http_method":"PATCH","short_description":null,"deprecated":null},{"api_url":"/users/:id","http_method":"PUT","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"metadata":null,"see":[]},{"doc_url":"./apipie/1.0/users/destroy","name":"destroy","apis":[{"api_url":"/users/:id","http_method":"DELETE","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"metadata":null,"see":[]},{"doc_url":"./apipie/1.0/users/create_unnested","name":"create_unnested","apis":[{"api_url":"/users/create_unnested","http_method":"POST","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[]}]},"comments":{"doc_url":"./apipie/1.0/comments","api_url":"/","name":"Comments","short_description":null,"full_description":null,"version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"./apipie/1.0/comments/index","name":"index","apis":[{"api_url":"/users/:user_id/posts/:post_id/comments","http_method":"GET","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"metadata":null,"see":[]},{"doc_url":"./apipie/1.0/comments/show","name":"show","apis":[{"api_url":"/users/:user_id/posts/:post_id/comments/:id","http_method":"GET","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"metadata":null,"see":[]},{"doc_url":"./apipie/1.0/comments/create","name":"create","apis":[{"api_url":"/users/:user_id/posts/:post_id/comments","http_method":"POST","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"metadata":null,"see":[]},{"doc_url":"./apipie/1.0/comments/update","name":"update","apis":[{"api_url":"/users/:user_id/posts/:post_id/comments/:id","http_method":"PATCH","short_description":null,"deprecated":null},{"api_url":"/users/:user_id/posts/:post_id/comments/:id","http_method":"PUT","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"metadata":null,"see":[]},{"doc_url":"./apipie/1.0/comments/destroy","name":"destroy","apis":[{"api_url":"/users/:user_id/posts/:post_id/comments/:id","http_method":"DELETE","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"metadata":null,"see":[]}]},"posts":{"doc_url":"./apipie/1.0/posts","api_url":"/","name":"Posts","short_description":null,"full_description":null,"version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"./apipie/1.0/posts/index","name":"index","apis":[{"api_url":"/users/:user_id/posts","http_method":"GET","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"metadata":null,"see":[]},{"doc_url":"./apipie/1.0/posts/show","name":"show","apis":[{"api_url":"/users/:user_id/posts/:id","http_method":"GET","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"metadata":null,"see":[]},{"doc_url":"./apipie/1.0/posts/create","name":"create","apis":[{"api_url":"/users/:user_id/posts","http_method":"POST","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"metadata":null,"see":[]},{"doc_url":"./apipie/1.0/posts/update","name":"update","apis":[{"api_url":"/users/:user_id/posts/:id","http_method":"PATCH","short_description":null,"deprecated":null},{"api_url":"/users/:user_id/posts/:id","http_method":"PUT","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"metadata":null,"see":[]},{"doc_url":"./apipie/1.0/posts/destroy","name":"destroy","apis":[{"api_url":"/users/:user_id/posts/:id","http_method":"DELETE","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"metadata":null,"see":[]}]}},"link_extension":".html"}}

data/test/unit/resource_test.rb

@@ -3,10 +3,10 @@ require File.join(File.dirname(__FILE__), 'test_helper')
 describe ApipieBindings::Resource do
 
   let(:resource) { ApipieBindings::API.new({:apidoc_cache_dir => 'test/unit/data',
-    :apidoc_cache_name => 'architecture'}).resource(:architectures) }
+    :apidoc_cache_name => 'dummy'}).resource(:users) }
 
   it "should list actions" do
-    resource.actions.map(&:name).must_equal [:index, :show, :create, :create_unnested]
+    resource.actions.map(&:name).must_equal [:index, :show, :create, :update, :destroy, :create_unnested]
   end
 
   it "should test action existence" do
@@ -20,30 +20,30 @@ describe ApipieBindings::Resource do
   it "should allow user to call the action" do
     params = { :a => 1 }
     headers = { :content_type => 'application/json' }
-    ApipieBindings::API.any_instance.expects(:call).with(:architectures, :index, params, headers, {})
+    ApipieBindings::API.any_instance.expects(:call).with(:users, :index, params, headers, {})
     resource.call(:index, params, headers)
   end
 
   it "should allow user to call the action with minimal params" do
-    ApipieBindings::API.any_instance.expects(:call).with(:architectures, :index, {}, {}, {})
+    ApipieBindings::API.any_instance.expects(:call).with(:users, :index, {}, {}, {})
     resource.call(:index)
   end
 
   it "should print name in singular on demand" do
-    resource.singular_name.must_equal 'architecture'
+    resource.singular_name.must_equal 'user'
   end
 
   it "should have name visible in puts" do
     out, err = capture_io { puts resource }
-    out.must_equal "<Resource :architectures>\n"
+    out.must_equal "<Resource :users>\n"
   end
 
   it "should have name visible in inspect" do
-    resource.inspect.must_equal "<Resource :architectures>"
+    resource.inspect.must_equal "<Resource :users>"
   end
 
   it "should rise error when the resource does no exist" do
     assert_raises( NameError ){ ApipieBindings::API.new({:apidoc_cache_dir => 'test/unit/data',
-      :apidoc_cache_name => 'architecture'}).resource(:none) }
+      :apidoc_cache_name => 'dummy'}).resource(:none) }
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: apipie-bindings
 version: !ruby/object:Gem::Version
-  version: 0.0.11
+  version: 0.0.12
 platform: ruby
 authors:
 - Martin Bačovský
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-09 00:00:00.000000000 Z
+date: 2015-03-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -33,7 +33,7 @@ dependencies:
         version: 1.6.5
     - - <
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -43,7 +43,7 @@ dependencies:
         version: 1.6.5
     - - <
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: oauth
   requirement: !ruby/object:Gem::Requirement
@@ -72,20 +72,6 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: mime-types
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -217,9 +203,36 @@ files:
 - lib/apipie_bindings/route.rb
 - lib/apipie_bindings/utilities.rb
 - lib/apipie_bindings/version.rb
+- test/dummy/.gitignore
+- test/dummy/Gemfile
+- test/dummy/README.md
+- test/dummy/Rakefile
+- test/dummy/app/controllers/application_controller.rb
+- test/dummy/app/controllers/comments_controller.rb
+- test/dummy/app/controllers/concerns/dummy_concern.rb
+- test/dummy/app/controllers/posts_controller.rb
+- test/dummy/app/controllers/users_controller.rb
+- test/dummy/app/lib/dummy/store.rb
+- test/dummy/bin/bundle
+- test/dummy/bin/rails
+- test/dummy/bin/rake
+- test/dummy/config.ru
+- test/dummy/config/application.rb
+- test/dummy/config/boot.rb
+- test/dummy/config/environment.rb
+- test/dummy/config/environments/development.rb
+- test/dummy/config/environments/production.rb
+- test/dummy/config/environments/test.rb
+- test/dummy/config/initializers/apipie.rb
+- test/dummy/config/initializers/session_store.rb
+- test/dummy/config/routes.rb
+- test/dummy/data/example/users/1/posts/1/comments/1/show.json
+- test/dummy/data/example/users/1/posts/1/show.json
+- test/dummy/data/example/users/1/show.json
+- test/dummy/public/index.html
 - test/unit/action_test.rb
 - test/unit/api_test.rb
-- test/unit/data/architecture.json
+- test/unit/data/dummy.json
 - test/unit/example_test.rb
 - test/unit/indifferent_hash_test.rb
 - test/unit/inflector_test.rb
@@ -240,7 +253,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - '>='
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.8.7
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - '>='
@@ -248,14 +261,41 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.11
+rubygems_version: 2.4.4
 signing_key: 
 specification_version: 4
 summary: The Ruby bindings for Apipie documented APIs
 test_files:
+- test/dummy/.gitignore
+- test/dummy/Gemfile
+- test/dummy/README.md
+- test/dummy/Rakefile
+- test/dummy/app/controllers/application_controller.rb
+- test/dummy/app/controllers/comments_controller.rb
+- test/dummy/app/controllers/concerns/dummy_concern.rb
+- test/dummy/app/controllers/posts_controller.rb
+- test/dummy/app/controllers/users_controller.rb
+- test/dummy/app/lib/dummy/store.rb
+- test/dummy/bin/bundle
+- test/dummy/bin/rails
+- test/dummy/bin/rake
+- test/dummy/config.ru
+- test/dummy/config/application.rb
+- test/dummy/config/boot.rb
+- test/dummy/config/environment.rb
+- test/dummy/config/environments/development.rb
+- test/dummy/config/environments/production.rb
+- test/dummy/config/environments/test.rb
+- test/dummy/config/initializers/apipie.rb
+- test/dummy/config/initializers/session_store.rb
+- test/dummy/config/routes.rb
+- test/dummy/data/example/users/1/posts/1/comments/1/show.json
+- test/dummy/data/example/users/1/posts/1/show.json
+- test/dummy/data/example/users/1/show.json
+- test/dummy/public/index.html
 - test/unit/action_test.rb
 - test/unit/api_test.rb
-- test/unit/data/architecture.json
+- test/unit/data/dummy.json
 - test/unit/example_test.rb
 - test/unit/indifferent_hash_test.rb
 - test/unit/inflector_test.rb

data/test/unit/data/architecture.json

@@ -1,191 +0,0 @@
-{
-    "docs": {
-        "api_url": "/api",
-        "copyright": "",
-        "doc_url": "/apidoc/v2",
-        "info": "Another API description",
-        "name": "Foreman",
-        "resources": {
-            "architectures": {
-                "api_url": "/api",
-                "doc_url": "/apidoc/v2/architectures",
-                "formats": null,
-                "full_description": null,
-                "methods": [
-                    {
-                        "apis": [
-                            {
-                                "api_url": "/api/architectures",
-                                "http_method": "GET",
-                                "short_description": "List all architectures."
-                            }
-                        ],
-                        "doc_url": "/apidoc/v2/architectures/index",
-                        "errors": [],
-                        "examples": [
-                            "GET /api/architectures\n200\n[\n  {\n    \"architecture\": {\n      \"name\": \"s390\",\n      \"id\": 381564594,\n      \"updated_at\": \"2012-12-18T15:24:42Z\",\n      \"operatingsystem_ids\": [],\n      \"created_at\": \"2012-12-18T15:24:42Z\"\n    }\n  },\n  {\n    \"architecture\": {\n      \"name\": \"sparc\",\n      \"id\": 331892513,\n      \"updated_at\": \"2012-12-18T15:24:42Z\",\n      \"operatingsystem_ids\": [\n        442321401\n      ],\n      \"created_at\": \"2012-12-18T15:24:42Z\"\n    }\n  },\n  {\n    \"architecture\": {\n      \"name\": \"x86_64\",\n      \"id\": 501905019,\n      \"updated_at\": \"2012-12-18T15:24:42Z\",\n      \"operatingsystem_ids\": [\n        331303656,\n        309172073,\n        1073012828\n      ],\n      \"created_at\": \"2012-12-18T15:24:42Z\"\n    }\n  }\n]"
-                        ],
-                        "formats": null,
-                        "full_description": "",
-                        "name": "index",
-                        "params": [
-                            {
-                                "allow_nil": false,
-                                "description": "\n<p>filter results</p>\n",
-                                "expected_type": "string",
-                                "full_name": "search",
-                                "name": "search",
-                                "required": false,
-                                "validator": "Must be String"
-                            },
-                            {
-                                "allow_nil": false,
-                                "description": "\n<p>sort results</p>\n",
-                                "expected_type": "string",
-                                "full_name": "order",
-                                "name": "order",
-                                "required": false,
-                                "validator": "Must be String"
-                            },
-                            {
-                                "allow_nil": false,
-                                "description": "\n<p>paginate results</p>\n",
-                                "expected_type": "string",
-                                "full_name": "page",
-                                "name": "page",
-                                "required": false,
-                                "validator": "Must be String"
-                            },
-                            {
-                                "allow_nil": false,
-                                "description": "\n<p>number of entries per request</p>\n",
-                                "expected_type": "string",
-                                "full_name": "per_page",
-                                "name": "per_page",
-                                "required": false,
-                                "validator": "Must be String"
-                            }
-                        ],
-                        "see": []
-                    },
-                    {
-                        "apis": [
-                            {
-                                "api_url": "/api/architectures/:id",
-                                "http_method": "GET",
-                                "short_description": "Show an architecture."
-                            }
-                        ],
-                        "doc_url": "/apidoc/v2/architectures/show",
-                        "errors": [],
-                        "examples": [
-                            "GET /api/architectures/x86_64\n200\n{\n  \"architecture\": {\n    \"name\": \"x86_64\",\n    \"id\": 501905019,\n    \"updated_at\": \"2012-12-18T15:24:42Z\",\n    \"operatingsystem_ids\": [\n      309172073,\n      1073012828,\n      331303656\n    ],\n    \"created_at\": \"2012-12-18T15:24:42Z\"\n  }\n}"
-                        ],
-                        "formats": null,
-                        "full_description": "",
-                        "name": "show",
-                        "params": [
-                            {
-                                "allow_nil": false,
-                                "description": "",
-                                "expected_type": "string",
-                                "full_name": "id",
-                                "name": "id",
-                                "required": true,
-                                "validator": "Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space."
-                            }
-                        ],
-                        "see": []
-                    },
-                    {
-                        "apis": [
-                            {
-                                "api_url": "/api/architectures",
-                                "http_method": "POST",
-                                "short_description": "Create an architecture."
-                            }
-                        ],
-                        "doc_url": "/apidoc/v2/architectures/create",
-                        "errors": [],
-                        "examples": [
-                            "POST /api/architectures\n{\n  \"architecture\": {\n    \"name\": \"i386\"\n  }\n}\n200\n{\n  \"architecture\": {\n    \"name\": \"i386\",\n    \"id\": 501905020,\n    \"updated_at\": \"2012-12-18T15:24:43Z\",\n    \"operatingsystem_ids\": [],\n    \"created_at\": \"2012-12-18T15:24:43Z\"\n  }\n}"
-                        ],
-                        "formats": null,
-                        "full_description": "",
-                        "name": "create",
-                        "params": [
-                            {
-                                "allow_nil": false,
-                                "description": "",
-                                "expected_type": "hash",
-                                "full_name": "architecture",
-                                "name": "architecture",
-                                "params": [
-                                    {
-                                        "allow_nil": false,
-                                        "description": "",
-                                        "expected_type": "string",
-                                        "full_name": "architecture[name]",
-                                        "name": "name",
-                                        "required": true,
-                                        "validator": "Must be String"
-                                    },
-                                    {
-                                        "allow_nil": false,
-                                        "description": "\n<p>Operatingsystem ID\u2019s</p>\n",
-                                        "expected_type": "array",
-                                        "full_name": "architecture[operatingsystem_ids]",
-                                        "name": "operatingsystem_ids",
-                                        "required": false,
-                                        "validator": "Must be Array"
-                                    }
-                                ],
-                                "required": true,
-                                "validator": "Must be a Hash"
-                            }
-                        ],
-                        "see": []
-                    },
-                    {
-                        "apis": [
-                            {
-                                "api_url": "/api/architectures",
-                                "http_method": "POST",
-                                "short_description": "create an architecture."
-                            }
-                        ],
-                        "doc_url": "/apidoc/v2/architectures/create",
-                        "errors": [],
-                        "examples" : [
-                            "same as nested create"
-                        ],
-                        "formats": null,
-                        "full_description": "",
-                        "name": "create_unnested",
-                        "params":[
-                            {
-                                "allow_nil": false,
-                                "description": "",
-                                "expected_type": "string",
-                                "full_name": "architecture[name]",
-                                "name": "name",
-                                "required": true,
-                                "validator": "Must be String"
-                            },
-                            {
-                                "allow_nil": false,
-                                "description": "\n<p>Operatingsystem ID\u2019s</p>\n",
-                                "expected_type": "array",
-                                "full_name": "architecture[operatingsystem_ids]",
-                                "name": "operatingsystem_ids",
-                                "required": false,
-                                "validator": "Must be Array"
-                            }
-                        ],
-                        "see": []
-                    }
-                ]
-            }
-        }
-    }
-}