auto_api 0.0.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 39b05ca8941181e3462bdb72162c5b9237ae711e
+  data.tar.gz: e32ccf3e35eca0db32cb0ea943369e93a442b6cb
+SHA512:
+  metadata.gz: b7b6a3a94eeda305243bb625d1062061d2cb6c5bd8e85c1b800447995324be36f7aeda250e46a52da52d45bf61527be571c6a6071dcc9c6269c4edaed00adabb
+  data.tar.gz: 8e3e7fa12d2a65b3016ef8d7a8965594e2a5ead1f88f7bac83e8a0b071154d633c599f556fbef07ea2fded3b60da4da588feba4201dc9e49ba5ad5cd74f7712d

data/.gitignore

@@ -0,0 +1,24 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+config.ru
+config/mongoid.yml

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in auto_api.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Phil Spitler
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,98 @@
+# AutoApi
+
+AutoApi generates a RESTful API on the fly.  If you call gets on items that do not exist, you get back what you'd expect if the object didn't exist.  If you POST to something, even if it doesn't exist, it will create it on the fly, which then can be retreived from the database.  It runs on Sinatra and MongoDB.
+
+## What this Provides
+You just start calling endpoints and it just works.  It’s pretty useless if you start off by making GET requests.  You just get back empty arrays or 404s.  However, start storing anything you want at all and then when making GET reqeusts, you will received the appropriate objects.
+
+AutoApi handles all the normal RESTful single level routes, for example:
+
+```
+GET /forums
+
+GET /forums/asdf1234
+
+POST /forums #forum created with reqeust.POST data
+
+PUT /forums/asdf1234 #forum asdf1234 updated with request.POST data
+
+DELETE /forums/asdf1234 #deletes forum asdf1234 (note: related data is not cleaned up at this point)
+
+DELETE /forums #deletes ALL forums (note: related data is not cleaned up at this point)
+
+```
+
+AutoApi will handle nested calls for GET (list), POST, and DELETE (list) for example:
+
+```
+GET /forums/asdf1234/topics
+
+POST /forums/asdf1234/topics #a new topic is created from request.POST and associated to forum asdf1234
+
+DELETE /forums/asdf1234/topics #deletes all the topics for the forum (note: data related to the deleted topics is not cleaned up at this point)
+```
+
+Note: forums and topics are used it this example, but topics could have posts.  Or you could use this for user data or really whatever else you want a RESTful interface for.  I can see this being great for rapid front-end prototyping.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'auto_api'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install auto_api
+
+## Requirements
+
+    - MongoDB
+
+## Usage
+
+### Config File
+
+    - Rename config/mongoid.yml.example to config/mongoid.yml
+    - Make whatever changes to the config file to work in your environment
+
+### Configure config.ru
+
+Add the following to your config.ru file:
+
+```ruby
+require 'auto_api'
+
+map '/api' do #can use whatever path or add version or anything since this is modular
+  run AutoApi::Base
+end
+```
+
+## Roadmap
+
+There are many things I see going into this in the future.  My first priorities are:
+
+    - Destroy orphaned data in the database
+    - Destroy objects that no longer contain data in the DB to free memory
+    - Enable the ability to run in a “mock” environment which cleans up after every call.
+    - Any other useful features that emerge as I developing and using it
+    - note: requests are always welcome (especially pull requests)
+
+## Warning
+
+This is currently in a prototype/alpha phase.
+
+## Tests / Specs (coming soon)
+
+In order to get this out in the wild as soon as possible, I am pusing the prototype.  Full tests/specs are to come in the very near future.
+
+## Contributing
+
+1. Fork it ( https://github.com/philspitler/auto_api/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/auto_api.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'auto_api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "auto_api"
+  spec.version       = AutoApi::VERSION
+  spec.authors       = ["Phillip R. Spitler (Phil)"]
+  spec.email         = ["prs@sproutkey.com"]
+  spec.summary       = "Automattic API Generator"
+  spec.description   = "AutoApi generates a RESTful API on the fly.  If you call gets on items that do not exist, you get back what you'd expect if the object didn't exist.  If you POST to something, even if it doesn't exist, it will create it on the fly, which then can be retreived from the database.  It runs on Sinatra and MongoDB."
+  spec.homepage      = "https://github.com/philspitler/auto_api"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'sinatra'
+  spec.add_dependency 'sinatra-contrib'
+  spec.add_dependency "mongoid", "~> 3.1.6"
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "bond" #auto completion when  running $ bundle exec irb
+
+end

data/config/mongoid.yml.example

@@ -0,0 +1,7 @@
+identity_map_enabled: true
+development:
+  sessions:
+    default:
+      database: mongoid
+      hosts:
+        - 127.0.0.1:27017

data/exec/htmldiff

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'htmldiff' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('diff-lcs', 'htmldiff')

data/exec/ldiff

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'ldiff' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('diff-lcs', 'ldiff')

data/exec/rackup

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rackup' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rack', 'rackup')

data/exec/rake

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rake', 'rake')

data/exec/rspec

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rspec-core', 'rspec')

data/exec/tilt

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'tilt' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('tilt', 'tilt')

data/lib/auto_api.rb

@@ -0,0 +1,2 @@
+require "auto_api/version"
+require "auto_api/base"

data/lib/auto_api/base.rb

@@ -0,0 +1,97 @@
+require 'sinatra'
+require "sinatra/reloader"
+require "sinatra/json"
+require 'mongoid'
+require 'active_support/inflector'
+require 'active_model'
+
+class AutoApi::Base < Sinatra::Base
+  configure :development do
+    register Sinatra::Reloader
+  end
+
+  Mongoid.load!('./config/mongoid.yml')
+
+  #WE ARE RETURNING JSON
+  before '/*' do
+    content_type 'application/json'
+  end
+
+  before '/:resource1/:id1/:resource2/?' do | resource1, id1, resource2 |
+    @resource1 = Object.const_set(resource1.classify, Class.new)
+    @resource1.include(Mongoid::Document)
+    @resource1.has_many resource2
+    @resource2 = Object.const_set(resource2.classify, Class.new)
+    @resource2.include(Mongoid::Document)
+    @resource2.belongs_to resource1.singularize
+  end
+
+  ['/:resource/?', '/:resource/:id/?'].each do |path|
+    before path do
+      @resource = Object.const_set(params['resource'].classify, Class.new)
+      @resource.include(Mongoid::Document)
+    end
+  end
+
+  get '/:resource/?' do | resource |
+    webtry(lambda { json @resource.all })
+  end
+
+  get '/:resource/:id/?' do | resource, id |
+    webtry(lambda { json @resource.find(id) })
+  end
+
+  post '/:resource/?' do | resource |
+    webtry(lambda {
+    resource = @resource.new(request.POST)
+    resource.save!
+    json resource
+  })
+  end
+
+  put '/:resource/:id/?' do | resource, id |
+    webtry(lambda {
+    resource =  @resource.find(id)
+    resource.update_attributes!(request.POST)
+  })
+  end
+
+  delete '/:resource/:id/?' do | resource, id |
+    webtry(lambda { json @resource.find(id).delete })
+  end
+
+  delete '/:resource/?' do
+    webtry(lambda { json @resource.all.delete })
+  end
+
+  #NESTED
+  get '/:resource1/:id1/:resource2/?' do | resource1, id1, resource2 |
+    webtry(lambda { json @resource1.find(id1).send(resource2) })
+  end
+
+  post '/:resource1/:id1/:resource2/?' do | resource1, id1, resource2 |
+    webtry(lambda {
+    parent_resource = @resource1.find(id1)
+    child_resource = @resource2.new(request.POST)
+    child_resource.save!
+    parent_resource.send(resource2) << child_resource
+    json child_resource
+  })
+  end
+
+  delete '/:resource1/:id1/:resource2/?' do | resource1, id1, resource2 |
+    webtry(lambda { json @resource1.find(id1).send(resource2).all.delete })
+  end
+
+  def webtry(block)
+    begin
+     status 200
+     block.call
+    rescue Mongoid::Errors::DocumentNotFound
+      status 404
+    rescue
+      status 500
+    end
+  end
+end
+

data/lib/auto_api/version.rb

@@ -0,0 +1,3 @@
+module AutoApi
+  VERSION = "0.0.4"
+end

metadata

@@ -0,0 +1,161 @@
+--- !ruby/object:Gem::Specification
+name: auto_api
+version: !ruby/object:Gem::Version
+  version: 0.0.4
+platform: ruby
+authors:
+- Phillip R. Spitler (Phil)
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  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: sinatra-contrib
+  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: mongoid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.6
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: rspec
+  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: bond
+  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: AutoApi generates a RESTful API on the fly.  If you call gets on items
+  that do not exist, you get back what you'd expect if the object didn't exist.  If
+  you POST to something, even if it doesn't exist, it will create it on the fly, which
+  then can be retreived from the database.  It runs on Sinatra and MongoDB.
+email:
+- prs@sproutkey.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- auto_api.gemspec
+- config/mongoid.yml.example
+- exec/htmldiff
+- exec/ldiff
+- exec/rackup
+- exec/rake
+- exec/rspec
+- exec/tilt
+- lib/auto_api.rb
+- lib/auto_api/base.rb
+- lib/auto_api/version.rb
+homepage: https://github.com/philspitler/auto_api
+licenses:
+- MIT
+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.4.2
+signing_key: 
+specification_version: 4
+summary: Automattic API Generator
+test_files: []