RubyGems - api_engine - Versions diffs - 0.0.1 - Mend

api_engine 0.0.1

Files changed (58) hide show

checksums.yaml +7 -0
data/LICENSE.md +20 -0
data/README.md +33 -0
data/Rakefile +16 -0
data/app/assets/javascripts/api_engine/application.js +15 -0
data/app/assets/stylesheets/api_engine/application.css +13 -0
data/app/controllers/api_engine/application_controller.rb +90 -0
data/app/helpers/api_engine/application_helper.rb +4 -0
data/app/views/layouts/api_engine/application.html.erb +14 -0
data/config/routes.rb +11 -0
data/lib/api_engine.rb +6 -0
data/lib/api_engine/config.rb +24 -0
data/lib/api_engine/engine.rb +13 -0
data/lib/api_engine/version.rb +3 -0
data/lib/generators/api_engine/config_generator.rb +16 -0
data/lib/generators/api_engine/templates/api_engine_config.rb +9 -0
data/lib/tasks/api_engine_tasks.rake +4 -0
data/spec/dummy/README.rdoc +261 -0
data/spec/dummy/Rakefile +7 -0
data/spec/dummy/app/assets/javascripts/application.js +15 -0
data/spec/dummy/app/assets/stylesheets/application.css +13 -0
data/spec/dummy/app/controllers/application_controller.rb +3 -0
data/spec/dummy/app/controllers/posts_controller.rb +3 -0
data/spec/dummy/app/helpers/application_helper.rb +2 -0
data/spec/dummy/app/models/post.rb +3 -0
data/spec/dummy/app/serializers/post_serializer.rb +3 -0
data/spec/dummy/app/views/layouts/application.html.erb +14 -0
data/spec/dummy/config.ru +4 -0
data/spec/dummy/config/application.rb +65 -0
data/spec/dummy/config/boot.rb +10 -0
data/spec/dummy/config/database.yml +24 -0
data/spec/dummy/config/environment.rb +5 -0
data/spec/dummy/config/environments/development.rb +37 -0
data/spec/dummy/config/environments/production.rb +67 -0
data/spec/dummy/config/environments/test.rb +37 -0
data/spec/dummy/config/initializers/backtrace_silencers.rb +7 -0
data/spec/dummy/config/initializers/inflections.rb +15 -0
data/spec/dummy/config/initializers/mime_types.rb +5 -0
data/spec/dummy/config/initializers/secret_token.rb +7 -0
data/spec/dummy/config/initializers/session_store.rb +8 -0
data/spec/dummy/config/initializers/wrap_parameters.rb +14 -0
data/spec/dummy/config/locales/en.yml +5 -0
data/spec/dummy/config/routes.rb +3 -0
data/spec/dummy/db/development.sqlite3 +0 -0
data/spec/dummy/db/migrate/20130408032158_create_posts.rb +9 -0
data/spec/dummy/db/schema.rb +22 -0
data/spec/dummy/db/test.sqlite3 +0 -0
data/spec/dummy/log/development.log +1557 -0
data/spec/dummy/log/test.log +14900 -0
data/spec/dummy/public/404.html +26 -0
data/spec/dummy/public/422.html +26 -0
data/spec/dummy/public/500.html +25 -0
data/spec/dummy/public/favicon.ico +0 -0
data/spec/dummy/script/rails +6 -0
data/spec/requests/configuration_spec.rb +42 -0
data/spec/requests/default_api_spec.rb +138 -0
data/spec/spec_helper.rb +27 -0
metadata +238 -0

data/spec/dummy/public/404.html ADDED Viewed

@@ -0,0 +1,26 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>The page you were looking for doesn't exist (404)</title>
+  <style type="text/css">
+    body { background-color: #fff; color: #666; text-align: center; font-family: arial, sans-serif; }
+    div.dialog {
+      width: 25em;
+      padding: 0 4em;
+      margin: 4em auto 0 auto;
+      border: 1px solid #ccc;
+      border-right-color: #999;
+      border-bottom-color: #999;
+    }
+    h1 { font-size: 100%; color: #f00; line-height: 1.5em; }
+  </style>
+</head>
+<body>
+  <!-- This file lives in public/404.html -->
+  <div class="dialog">
+    <h1>The page you were looking for doesn't exist.</h1>
+    <p>You may have mistyped the address or the page may have moved.</p>
+  </div>
+</body>
+</html>

data/spec/dummy/public/422.html ADDED Viewed

@@ -0,0 +1,26 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>The change you wanted was rejected (422)</title>
+  <style type="text/css">
+    body { background-color: #fff; color: #666; text-align: center; font-family: arial, sans-serif; }
+    div.dialog {
+      width: 25em;
+      padding: 0 4em;
+      margin: 4em auto 0 auto;
+      border: 1px solid #ccc;
+      border-right-color: #999;
+      border-bottom-color: #999;
+    }
+    h1 { font-size: 100%; color: #f00; line-height: 1.5em; }
+  </style>
+</head>
+<body>
+  <!-- This file lives in public/422.html -->
+  <div class="dialog">
+    <h1>The change you wanted was rejected.</h1>
+    <p>Maybe you tried to change something you didn't have access to.</p>
+  </div>
+</body>
+</html>

data/spec/dummy/public/500.html ADDED Viewed

@@ -0,0 +1,25 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>We're sorry, but something went wrong (500)</title>
+  <style type="text/css">
+    body { background-color: #fff; color: #666; text-align: center; font-family: arial, sans-serif; }
+    div.dialog {
+      width: 25em;
+      padding: 0 4em;
+      margin: 4em auto 0 auto;
+      border: 1px solid #ccc;
+      border-right-color: #999;
+      border-bottom-color: #999;
+    }
+    h1 { font-size: 100%; color: #f00; line-height: 1.5em; }
+  </style>
+</head>
+<body>
+  <!-- This file lives in public/500.html -->
+  <div class="dialog">
+    <h1>We're sorry, but something went wrong.</h1>
+  </div>
+</body>
+</html>

data/spec/dummy/public/favicon.ico ADDED Viewed

File without changes

data/spec/dummy/script/rails ADDED Viewed

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails 3 gems installed from the root of your application.
+APP_PATH = File.expand_path('../../config/application',  __FILE__)
+require File.expand_path('../../config/boot',  __FILE__)
+require 'rails/commands'

data/spec/requests/configuration_spec.rb ADDED Viewed

@@ -0,0 +1,42 @@
+require 'spec_helper'
+describe 'Configuration Spec' do
+  describe 'config.whitelist' do
+    before { Post.create(title: "Test") }
+    after do
+      ApiEngine.configure do |config|
+        config.whitelist = false
+      end
+    end
+    context 'Post is not on the whitelist' do
+      before do
+        ApiEngine.configure do |config|
+          config.whitelist = [:comment]
+        end
+      end
+      it "allows access to the model's API" do
+        get '/api/posts'
+        response.status.should eq(404)
+      end
+    end
+    context 'Post is on the whitelist' do
+      before do
+        ApiEngine.configure do |config|
+          config.whitelist = [:post]
+        end
+      end
+      it "allows access to the model's API" do
+        get '/api/posts'
+        response.status.should eq(200)
+      end
+    end
+  end
+end

data/spec/requests/default_api_spec.rb ADDED Viewed

@@ -0,0 +1,138 @@
+require 'spec_helper'
+describe 'Default API' do
+  describe '#index' do
+    before do
+      Post.create(title: "Test")
+      get '/api/posts'
+    end
+    it "uses a plural json root" do
+      JSON.parse(response.body).should have_key('posts')
+    end
+    it "returns all the posts" do
+      JSON.parse(response.body).keys.should have(1).item
+    end
+  end
+  describe '#show' do
+    before do
+      Post.create(title: "Test")
+      get '/api/posts/1'
+    end
+    it "uses a singular json root" do
+      JSON.parse(response.body).should have_key('post')
+    end
+    it "returns the post" do
+      JSON.parse(response.body)['post']['title'].should eq('Test')
+    end
+  end
+  describe '#create' do
+    context "singular create" do
+      before do
+        post '/api/posts', post: { title: 'Created post'}
+      end
+      it "returns a correct response code" do
+        response.status.should eq(201)
+      end
+      it "creates a post" do
+        Post.first.title.should eq("Created post")
+      end
+      it "returns a post with an id" do
+        JSON.parse(response.body)['post']['id'].should_not be_nil
+      end
+    end
+    context "bulk create" do
+      before do
+        post '/api/posts', posts: [{ title: 'First new post' },{ title: 'Second new post' }]
+      end
+      it "returns a correct response code" do
+        response.status.should eq(201)
+      end
+      it "creates multiple posts" do
+        Post.count.should eq(2)
+      end
+    end
+  end
+  describe '#update' do
+    before do
+      Post.create(title: "Test")
+      put '/api/posts/1', post: { title: 'Changed' }
+    end
+    it "returns a correct response code" do
+      response.status.should eq(200)
+    end
+    it "returns the saved post" do
+      JSON.parse(response.body)['post'].should eq({'id' => 1, 'title' => 'Changed'})
+    end
+    it "updates a post" do
+      Post.find(1).title.should eq("Changed")
+    end
+  end
+  describe "#bulk_update" do
+    before do
+      Post.create(title: "Test")
+      Post.create(title: "Test 2")
+      put '/api/posts/bulk', posts: [{ id: 1, title: 'Changed' }, { id: 2, title: 'Changed 2'}]
+    end
+    it "returns a correct response code" do
+      response.status.should eq(200)
+    end
+    it "returns the saved posts" do
+      JSON.parse(response.body)['posts'].should =~ [{ 'id' => 1, 'title' => 'Changed' }, { 'id' => 2, 'title' => 'Changed 2'}]
+    end
+    it "updates the posts" do
+      Post.find(1).title.should eq("Changed")
+      Post.find(2).title.should eq("Changed 2")
+    end
+  end
+  describe '#destroy' do
+    before do
+      Post.create(title: "Test")
+      delete '/api/posts/1'
+    end
+    it "returns a correct response code" do
+      response.status.should eq(204)
+    end
+    it "deletes the record" do
+      Post.count.should eq(0)
+    end
+  end
+  describe '#bulk_destroy' do
+    before do
+      Post.create(title: "Test")
+      Post.create(title: "Test 2")
+      delete '/api/posts/bulk', posts: [{ id: 1, title: 'Test' }, { id: 2, title: 'Test 2'}]
+    end
+    it "returns a correct response code" do
+      response.status.should eq(204)
+    end
+    it "deletes the sent records" do
+      Post.count.should eq(0)
+    end
+  end
+end

data/spec/spec_helper.rb ADDED Viewed

@@ -0,0 +1,27 @@
+ENV['RAILS_ENV'] ||= 'test'
+require File.expand_path("../dummy/config/environment.rb",  __FILE__)
+require 'rspec/rails'
+require 'factory_girl_rails'
+require 'database_cleaner'
+require 'pry'
+Rails.backtrace_cleaner.remove_silencers!
+# Load support files
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
+RSpec.configure do |config|
+  config.mock_with :rspec
+  config.order = "random"
+  config.use_transactional_fixtures = false
+  DatabaseCleaner.strategy = :truncation
+  config.before(:each) do
+    DatabaseCleaner.start
+  end
+  config.after(:each) do
+    DatabaseCleaner.clean
+  end
+end

metadata ADDED Viewed

@@ -0,0 +1,238 @@
+--- !ruby/object:Gem::Specification
+name: api_engine
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Steven Faulkner
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2013-04-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.13
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.13
+- !ruby/object:Gem::Dependency
+  name: active_model_serializers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: factory_girl_rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: An API engine for Rails. Structure of the API is opinionated and designed
+  to directly interface with ember-data.
+email:
+- southpolesteve@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- app/assets/javascripts/api_engine/application.js
+- app/assets/stylesheets/api_engine/application.css
+- app/controllers/api_engine/application_controller.rb
+- app/helpers/api_engine/application_helper.rb
+- app/views/layouts/api_engine/application.html.erb
+- config/routes.rb
+- lib/api_engine/config.rb
+- lib/api_engine/engine.rb
+- lib/api_engine/version.rb
+- lib/api_engine.rb
+- lib/generators/api_engine/config_generator.rb
+- lib/generators/api_engine/templates/api_engine_config.rb
+- lib/tasks/api_engine_tasks.rake
+- LICENSE.md
+- Rakefile
+- README.md
+- spec/dummy/app/assets/javascripts/application.js
+- spec/dummy/app/assets/stylesheets/application.css
+- spec/dummy/app/controllers/application_controller.rb
+- spec/dummy/app/controllers/posts_controller.rb
+- spec/dummy/app/helpers/application_helper.rb
+- spec/dummy/app/models/post.rb
+- spec/dummy/app/serializers/post_serializer.rb
+- spec/dummy/app/views/layouts/application.html.erb
+- spec/dummy/config/application.rb
+- spec/dummy/config/boot.rb
+- spec/dummy/config/database.yml
+- spec/dummy/config/environment.rb
+- spec/dummy/config/environments/development.rb
+- spec/dummy/config/environments/production.rb
+- spec/dummy/config/environments/test.rb
+- spec/dummy/config/initializers/backtrace_silencers.rb
+- spec/dummy/config/initializers/inflections.rb
+- spec/dummy/config/initializers/mime_types.rb
+- spec/dummy/config/initializers/secret_token.rb
+- spec/dummy/config/initializers/session_store.rb
+- spec/dummy/config/initializers/wrap_parameters.rb
+- spec/dummy/config/locales/en.yml
+- spec/dummy/config/routes.rb
+- spec/dummy/config.ru
+- spec/dummy/db/development.sqlite3
+- spec/dummy/db/migrate/20130408032158_create_posts.rb
+- spec/dummy/db/schema.rb
+- spec/dummy/db/test.sqlite3
+- spec/dummy/log/development.log
+- spec/dummy/log/test.log
+- spec/dummy/public/404.html
+- spec/dummy/public/422.html
+- spec/dummy/public/500.html
+- spec/dummy/public/favicon.ico
+- spec/dummy/Rakefile
+- spec/dummy/README.rdoc
+- spec/dummy/script/rails
+- spec/requests/configuration_spec.rb
+- spec/requests/default_api_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/southpolesteve/api_engine
+licenses: []
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project:
+rubygems_version: 2.0.3
+signing_key:
+specification_version: 4
+summary: An API engine for Rails
+test_files:
+- spec/dummy/app/assets/javascripts/application.js
+- spec/dummy/app/assets/stylesheets/application.css
+- spec/dummy/app/controllers/application_controller.rb
+- spec/dummy/app/controllers/posts_controller.rb
+- spec/dummy/app/helpers/application_helper.rb
+- spec/dummy/app/models/post.rb
+- spec/dummy/app/serializers/post_serializer.rb
+- spec/dummy/app/views/layouts/application.html.erb
+- spec/dummy/config/application.rb
+- spec/dummy/config/boot.rb
+- spec/dummy/config/database.yml
+- spec/dummy/config/environment.rb
+- spec/dummy/config/environments/development.rb
+- spec/dummy/config/environments/production.rb
+- spec/dummy/config/environments/test.rb
+- spec/dummy/config/initializers/backtrace_silencers.rb
+- spec/dummy/config/initializers/inflections.rb
+- spec/dummy/config/initializers/mime_types.rb
+- spec/dummy/config/initializers/secret_token.rb
+- spec/dummy/config/initializers/session_store.rb
+- spec/dummy/config/initializers/wrap_parameters.rb
+- spec/dummy/config/locales/en.yml
+- spec/dummy/config/routes.rb
+- spec/dummy/config.ru
+- spec/dummy/db/development.sqlite3
+- spec/dummy/db/migrate/20130408032158_create_posts.rb
+- spec/dummy/db/schema.rb
+- spec/dummy/db/test.sqlite3
+- spec/dummy/log/development.log
+- spec/dummy/log/test.log
+- spec/dummy/public/404.html
+- spec/dummy/public/422.html
+- spec/dummy/public/500.html
+- spec/dummy/public/favicon.ico
+- spec/dummy/Rakefile
+- spec/dummy/README.rdoc
+- spec/dummy/script/rails
+- spec/requests/configuration_spec.rb
+- spec/requests/default_api_spec.rb
+- spec/spec_helper.rb