apify 0.3.0

data/spec/app_root/config/boot.rb

@@ -0,0 +1,114 @@
+# Allow customization of the rails framework path
+RAILS_FRAMEWORK_ROOT = (ENV['RAILS_FRAMEWORK_ROOT'] || "#{File.dirname(__FILE__)}/../../../../../../vendor/rails") unless defined?(RAILS_FRAMEWORK_ROOT) 
+
+# Don't change this file!
+# Configure your app in config/environment.rb and config/environments/*.rb
+
+RAILS_ROOT = "#{File.dirname(__FILE__)}/.." unless defined?(RAILS_ROOT)
+
+module Rails
+  class << self
+    def boot!
+      unless booted?
+        preinitialize
+        pick_boot.run
+      end
+    end
+
+    def booted?
+      defined? Rails::Initializer
+    end
+
+    def pick_boot
+      (vendor_rails? ? VendorBoot : GemBoot).new
+    end
+
+    def vendor_rails?
+      File.exist?(RAILS_FRAMEWORK_ROOT)
+    end
+
+    def preinitialize
+      load(preinitializer_path) if File.exist?(preinitializer_path)
+    end
+
+    def preinitializer_path
+      "#{RAILS_ROOT}/config/preinitializer.rb"
+    end
+  end
+
+  class Boot
+    def run
+      load_initializer
+      Rails::Initializer.run(:set_load_path)
+    end
+  end
+
+  class VendorBoot < Boot
+    def load_initializer
+      require "#{RAILS_FRAMEWORK_ROOT}/railties/lib/initializer"
+      Rails::Initializer.run(:install_gem_spec_stubs)
+    end
+  end
+
+  class GemBoot < Boot
+    def load_initializer
+      self.class.load_rubygems
+      load_rails_gem
+      require 'initializer'
+    end
+
+    def load_rails_gem
+      if version = self.class.gem_version
+        gem 'rails', version
+      else
+        gem 'rails'
+      end
+    rescue Gem::LoadError => load_error
+      $stderr.puts %(Missing the Rails #{version} gem. Please `gem install -v=#{version} rails`, update your RAILS_GEM_VERSION setting in config/environment.rb for the Rails version you do have installed, or comment out RAILS_GEM_VERSION to use the latest version installed.)
+      exit 1
+    end
+
+    class << self
+      def rubygems_version
+        Gem::RubyGemsVersion rescue nil
+      end
+
+      def gem_version
+        if defined? RAILS_GEM_VERSION
+          RAILS_GEM_VERSION
+        elsif ENV.include?('RAILS_GEM_VERSION')
+          ENV['RAILS_GEM_VERSION']
+        else
+          parse_gem_version(read_environment_rb)
+        end
+      end
+
+      def load_rubygems
+        require 'rubygems'
+        min_version = '1.1.1'
+        unless rubygems_version >= min_version
+          $stderr.puts %Q(Rails requires RubyGems >= #{min_version} (you have #{rubygems_version}). Please `gem update --system` and try again.)
+          exit 1
+        end
+ 
+      rescue LoadError
+        $stderr.puts %Q(Rails requires RubyGems >= #{min_version}. Please install RubyGems and try again: http://rubygems.rubyforge.org)
+        exit 1
+      end
+
+      def parse_gem_version(text)
+        $1 if text =~ /^[^#]*RAILS_GEM_VERSION\s*=\s*["']([!~<>=]*\s*[\d.]+)["']/
+      end
+
+      private
+        def read_environment_rb
+          environment_rb = "#{RAILS_ROOT}/config/environment.rb"
+          environment_rb = "#{HELPER_RAILS_ROOT}/config/environment.rb" unless File.exists?(environment_rb)
+          File.read(environment_rb)
+        end
+    end
+  end
+end
+
+# All that for this:
+Rails.boot!

data/spec/app_root/config/database.yml

@@ -0,0 +1,21 @@
+in_memory:
+  adapter: sqlite3
+  database: ":memory:"
+  verbosity: quiet
+sqlite:
+  adapter: sqlite
+  dbfile: plugin_test.sqlite.db
+sqlite3:
+  adapter: sqlite3
+  dbfile: plugin_test.sqlite3.db
+postgresql:
+  adapter: postgresql
+  username: postgres
+  password: postgres
+  database: plugin_test
+mysql:
+  adapter: mysql
+  host: localhost
+  username: root
+  password:
+  database: plugin_test

data/spec/app_root/config/environment.rb

@@ -0,0 +1,14 @@
+require File.join(File.dirname(__FILE__), 'boot')
+
+Rails::Initializer.run do |config|
+  config.cache_classes = false
+  config.whiny_nils = true
+  config.action_controller.session = { :key => "_myapp_session", :secret => "gwirofjweroijger8924rt2zfwehfuiwehb1378rifowenfoqwphf23" }
+  config.plugin_locators.unshift(
+    Class.new(Rails::Plugin::Locator) do
+      def plugins
+        [Rails::Plugin.new(File.expand_path('.'))]
+      end
+    end
+  ) unless defined?(PluginTestHelper::PluginLocator)
+end

data/spec/app_root/config/routes.rb

@@ -0,0 +1,12 @@
+ActionController::Routing::Routes.draw do |map|
+
+  Api.draw_routes(map)
+
+  # map.connect 'api/hello', :controller => 'api', :action => 'hello', :conditions => { :method => :get }
+  # map.connect 'api/fail', :controller => 'api', :action => 'fail', :conditions => { :method => :get }
+  # map.connect 'api/echo_args', :controller => 'api', :action => 'echo_args', :conditions => { :method => :get }
+  # map.connect 'api/with_args_schema', :controller => 'api', :action => 'with_args_schema', :conditions => { :method => :get }
+  # map.connect 'api/with_value_schema', :controller => 'api', :action => 'with_value_schema', :conditions => { :method => :get }
+  # map.connect 'api/songs', :controller => 'api', :action => 'index_songs', :conditions => { :method => :get }
+
+end

data/spec/app_root/lib/console_with_fixtures.rb

@@ -0,0 +1,4 @@
+# Loads fixtures into the database when running the test app via the console
+(ENV['FIXTURES'] ? ENV['FIXTURES'].split(/,/) : Dir.glob(File.join(Rails.root, '../fixtures/*.{yml,csv}'))).each do |fixture_file|
+  Fixtures.create_fixtures(File.join(Rails.root, '../fixtures'), File.basename(fixture_file, '.*'))
+end

data/spec/app_root/script/console

@@ -0,0 +1,7 @@
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+libs =  " -r irb/completion"
+libs << " -r test/test_helper"
+libs << " -r console_app"
+libs << " -r console_with_helpers"
+libs << " -r console_with_fixtures"
+exec "#{irb} #{libs} --simple-prompt"

data/spec/controllers/api_controller_spec.rb

@@ -0,0 +1,155 @@
+require 'spec_helper'
+
+describe ApiController do
+
+  authenticate = lambda do |*args|
+    user = args[0] || 'user'
+    password = args[1] || 'password'
+    request.env['HTTP_AUTHORIZATION'] = ActionController::HttpAuthentication::Basic.encode_credentials(user, password)
+  end
+
+  describe 'authentication' do
+
+    it "should deny access with the wrong user" do
+      instance_exec('wrong-user', 'password', &authenticate)
+      post :ping
+      response.code.should == '401'      
+    end
+
+    it "should deny access with the wrong password" do
+      instance_exec('user', 'wrong-password', &authenticate)
+      post :ping
+      response.code.should == '401'
+    end
+
+    it "should grant access with the correct user and password" do
+      instance_exec('user', 'password', &authenticate)
+      post :ping
+      response.code.should == '200'
+    end
+
+    it "should allow an option to skip authentication" do
+      controller.skip_authentication = true
+      post :ping
+      response.code.should == '200'
+      controller.skip_authentication = false
+      post :ping
+      response.code.should == '401'
+    end
+
+  end
+
+  describe 'error handling' do
+
+    it 'should fill exception messages into the response body and return a 500 error code' do
+      instance_exec(&authenticate)
+      post :fail
+      response.code.should == '500'
+      response.body == 'error message'
+    end
+
+  end
+
+  describe 'args' do
+
+    it 'should have access to the args' do
+      instance_exec(&authenticate)
+      args = {'foo' => 'bar'}
+      post :echo_args, :args => args.to_json
+      response.code.should == '200'
+      JSON.parse(response.body).should == args
+    end
+
+  end
+
+  describe 'argument schemas' do
+
+    it "should validate the presence of a property" do
+      instance_exec(&authenticate)
+      post :with_args_schema, :args => {}.to_json
+      response.code.should == '500'
+      response.body.should include('Invalid request args')
+      response.body.should include('string_arg is missing')
+    end
+
+    it "should validate value types" do
+      instance_exec(&authenticate)
+      post :with_args_schema, :args => {'string_arg' => 123}.to_json
+      response.code.should == '500'
+      response.body.should include('Invalid request args')
+      response.body.should include('a string is required')
+    end
+
+    it "should allow requests that fit the schema" do
+      instance_exec(&authenticate)
+      post :with_args_schema, :args => {'string_arg' => 'a string'}.to_json
+      response.code.should == '200'
+    end
+
+    it "should render the schema if requested" do
+      instance_exec(&authenticate)
+      post :with_args_schema, :schema => 'args'
+      response.code.should == '200'
+      JSON.parse(response.body).should == {
+        "type" => "object",
+        "properties" => {
+          "string_arg" => { "type" => "string" }
+      }}
+    end
+
+  end
+
+  describe 'value schemas' do
+
+    it "should validate the presence of a property" do
+      instance_exec(&authenticate)
+      post :with_value_schema, :args => {}.to_json
+      response.code.should == '500'
+      response.body.should include('Invalid response value')
+      response.body.should include('string_value is missing')
+    end
+
+    it "should validate value types" do
+      instance_exec(&authenticate)
+      post :with_value_schema, :args => {'string_value' => 123}.to_json
+      response.code.should == '500'
+      response.body.should include('Invalid response value')
+      response.body.should include('a string is required')
+    end
+
+    it "should return responses that fit the schema" do
+      instance_exec(&authenticate)
+      post :with_value_schema, :args => {'string_value' => 'a string'}.to_json
+      response.code.should == '200'
+      JSON.parse(response.body).should == {'string_value' => 'a string'}
+    end    
+
+    it "should render the schema if requested" do
+      instance_exec(&authenticate)
+      post :with_value_schema, :schema => 'value'
+      response.code.should == '200'
+      JSON.parse(response.body).should == {
+        "type" => "object",
+        "properties" => {
+          "string_value" => { "type" => "string" }
+      }}
+    end
+
+  end
+
+  describe 'auto-generated documentation' do
+    integrate_views
+
+    it 'should render auto-generated API documentation' do
+      instance_exec(&authenticate)
+      get :docs
+      response.code.should == '200'
+      response.body.should include('ping')
+      response.body.should include('fail')
+      response.body.should include('echo_args')
+    end
+
+  end
+
+end
+

data/spec/rcov.opts

@@ -0,0 +1,2 @@
+--exclude "spec/*,gems/*"
+--rails

data/spec/spec.opts

@@ -0,0 +1,4 @@
+--colour
+--format progress
+--loadby mtime
+--reverse

data/spec/spec_helper.rb

@@ -0,0 +1,31 @@
+$: << File.join(File.dirname(__FILE__), "/../lib" )
+
+# Set the default environment to sqlite3's in_memory database
+ENV['RAILS_ENV'] ||= 'in_memory'
+
+# Load the Rails environment and testing framework
+require "#{File.dirname(__FILE__)}/app_root/config/environment"
+require "#{File.dirname(__FILE__)}/../lib/apify"
+
+require 'rubygems'
+
+gem 'jsonschema', '=2.0.0'
+gem 'webmock', '=1.3.4'
+gem 'rest-client', '=1.5.1'
+
+require 'spec/rails'
+require 'jsonschema'
+require 'webmock/rspec'
+require 'restclient'
+
+# Undo changes to RAILS_ENV
+silence_warnings {RAILS_ENV = ENV['RAILS_ENV']}
+
+# Run the migrations
+ActiveRecord::Migrator.migrate("#{Rails.root}/db/migrate")
+
+Spec::Runner.configure do |config|
+  config.use_transactional_fixtures = true
+  config.use_instantiated_fixtures  = false
+  config.include WebMock
+end

metadata

@@ -0,0 +1,151 @@
+--- !ruby/object:Gem::Specification 
+name: apify
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 3
+  - 0
+  version: 0.3.0
+platform: ruby
+authors: 
+- Henning Koch
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-08-28 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: jsonschema
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rest-client
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id003
+description: "Compact definition of JSON APIs for Rails applications. "
+email: github@makandra.de
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.md
+files: 
+- .gitignore
+- MIT-LICENSE
+- README.md
+- Rakefile
+- VERSION
+- apify.gemspec
+- app/helpers/apify_helper.rb
+- app/views/apify/api/_actions.html.erb
+- app/views/apify/api/_client.html.erb
+- app/views/apify/api/_overview.html.erb
+- app/views/apify/api/_protocol.html.erb
+- app/views/apify/api/docs.html.erb
+- lib/apify.rb
+- lib/apify/action.rb
+- lib/apify/api.rb
+- lib/apify/api_controller.rb
+- lib/apify/client.rb
+- lib/apify/errors.rb
+- lib/apify/exchange.rb
+- lib/apify/schema_helper.rb
+- spec/apify/action_spec.rb
+- spec/apify/client_spec.rb
+- spec/app_root/app/controllers/api_controller.rb
+- spec/app_root/app/controllers/application_controller.rb
+- spec/app_root/app/models/api.rb
+- spec/app_root/config/boot.rb
+- spec/app_root/config/database.yml
+- spec/app_root/config/environment.rb
+- spec/app_root/config/environments/in_memory.rb
+- spec/app_root/config/environments/mysql.rb
+- spec/app_root/config/environments/postgresql.rb
+- spec/app_root/config/environments/sqlite.rb
+- spec/app_root/config/environments/sqlite3.rb
+- spec/app_root/config/routes.rb
+- spec/app_root/lib/console_with_fixtures.rb
+- spec/app_root/script/console
+- spec/controllers/api_controller_spec.rb
+- spec/rcov.opts
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/makandra/apify
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Compact definition of JSON APIs for Rails applications.
+test_files: 
+- spec/apify/action_spec.rb
+- spec/apify/client_spec.rb
+- spec/spec_helper.rb
+- spec/app_root/app/controllers/api_controller.rb
+- spec/app_root/app/controllers/application_controller.rb
+- spec/app_root/app/models/api.rb
+- spec/app_root/lib/console_with_fixtures.rb
+- spec/app_root/config/environments/in_memory.rb
+- spec/app_root/config/environments/mysql.rb
+- spec/app_root/config/environments/postgresql.rb
+- spec/app_root/config/environments/sqlite.rb
+- spec/app_root/config/environments/sqlite3.rb
+- spec/app_root/config/boot.rb
+- spec/app_root/config/environment.rb
+- spec/app_root/config/routes.rb
+- spec/controllers/api_controller_spec.rb