naptime 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: daca12f497823f90582b927cd603b428b83dfc05
+  data.tar.gz: d673fb622d6f10582f3bf0525a5be8f4e3bc7144
+SHA512:
+  metadata.gz: b2be92734b994ee990b75ce37b4edd64863392b2cf644dfa9923850f58307c3238b1331d1bf82a59b44364d840e8aef299effe7a6fd972e091c8d6decf2df74a
+  data.tar.gz: 8bbe2d9e4b73050a3465ddace57a6f4b9cfc2fa02b2395de0ec16ba6438e249a65bbf88c532ef2007edfe40cea9d0f9b94f0b625aba3f58fc6804967c12076ba

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Etienne de Bruin
+
+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,85 @@
+Naptime
+=======
+
+Describe your data model using JSON and have naptime spit out the RESTful API endpoints.
+
+*Why do this?*
+
+Often times when I start a project, I end up designing the API before thinking through the completeness of my data.  This way, I can imagine exactly what I want my data entity to look like using JSON and have `naptime` output all the relevant RESTful API endpoints.
+
+How to use
+==========
+Create a file that contains your JSON description, eg. example.json and run:
+
+```sh
+ruby naptime.rb example.json
+```
+
+Example
+=======
+Here we created a file `person.json` that contains the following description:
+
+```json
+{
+  "name": "Richard",
+  "gender": "male",
+  "siblings": {
+    "brother": {
+      "name": "John",
+      "birthdate" : "5/1/1972"
+    },
+    "sister": "Sarah"
+  },
+  "address": {
+    "street": "582 S Grade",
+    "city": "Alpine"
+  },
+  "employed": "yes"
+}
+```
+
+Then we ran `ruby naptime.rb person.json` and got the following output:
+
+```sh
+POST /person
+{"name":"Richard","gender":"male","employed":"yes"}
+
+GET /person/[id]
+
+POST /person/[id]
+{"name":"Richard","gender":"male","employed":"yes"}
+
+DELETE /person/[id]
+
+POST /person/[id]/siblings
+{"sister":"Sarah"}
+
+GET /person/[id]/siblings/[id]
+
+POST /person/[id]/siblings/[id]
+{"sister":"Sarah"}
+
+DELETE /person/[id]/siblings/[id]
+
+POST /person/[id]/siblings/[id]/brother
+{"name":"John","birthdate":"5/1/1972"}
+
+GET /person/[id]/siblings/[id]/brother/[id]
+
+POST /person/[id]/siblings/[id]/brother/[id]
+{"name":"John","birthdate":"5/1/1972"}
+
+DELETE /person/[id]/siblings/[id]/brother/[id]
+
+POST /person/[id]/address
+{"street":"582 S Grade","city":"Alpine"}
+
+GET /person/[id]/address/[id]
+
+POST /person/[id]/address/[id]
+{"street":"582 S Grade","city":"Alpine"}
+
+DELETE /person/[id]/address/[id]
+```
+This output describes the necessary API endpoints to do the CRUD for the described data entity.
+

data/Rakefile

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

data/lib/naptime/version.rb

@@ -0,0 +1,3 @@
+module Naptime
+  VERSION = "0.0.1"
+end

data/lib/naptime.rb

@@ -0,0 +1,80 @@
+require "naptime/version"
+require 'json'
+
+module Naptime
+  class REST
+
+    @@crud = {
+      'Create' => {
+        'http' => 'POST',
+        'return' => 'id',
+        'requires' => false,
+        'body' => true
+      },
+      'Read' => {
+        'http' => 'GET',
+        'return' => false,
+        'requires' => 'id',
+        'body' => false
+      },
+      'Update' => {
+        'http' => 'POST',
+        'return' => false,
+        'requires' => 'id',
+        'body' => true
+      },
+      'Delete' => {
+        'http' => 'DELETE',
+        'return' => false,
+        'requires' => 'id',
+        'body' => false
+      }
+    }
+
+    def initialize(fileName)
+
+      @rest = Hash.new
+      @restPath = Hash.new
+
+      file = File.open(fileName, "rb")
+
+      self.traverse(File.basename(fileName,".*"), JSON.parse(file.read), '/')
+
+    end
+
+    def traverse(noun, desc, path)
+
+      @rest[noun.to_sym] = Hash.new
+      @restPath[noun.to_sym] = Hash.new
+      @restPath[noun.to_sym]['path'] = path
+
+      desc.each do |x,y|
+        if y.respond_to?('each')
+          self.traverse(x, y, path + noun + '/[id]/')
+        else
+          @rest[noun.to_sym][x] ||= y
+        end
+      end
+
+    end
+
+    def output
+
+      @rest.each do |noun, payload|
+
+        @@crud.each do |action, info|
+          path = @restPath[noun]['path'] + noun.to_s
+          id = info['requires'] == 'id' ? '/[id]' : ''
+
+          apiUri = "#{info['http']} #{path}#{id}\n"
+          apiPayload = payload.to_json + "\n" if info['body']
+
+          print apiUri
+          print apiPayload
+          print "\n"
+
+        end
+      end
+    end
+  end
+end

data/naptime.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'naptime/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "naptime"
+  spec.version       = Naptime::VERSION
+  spec.authors       = ["Etienne de Bruin"]
+  spec.email         = ["etdebruin@gmail.com"]
+  spec.summary       = %q{Describe your data entity before designing your API}
+  spec.description   = %q{Describe your data entity using JSON and have naptime generate your RESTFul API endpoints}
+  spec.homepage      = ""
+  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_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: naptime
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Etienne de Bruin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: Describe your data entity using JSON and have naptime generate your RESTFul
+  API endpoints
+email:
+- etdebruin@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/naptime.rb
+- lib/naptime/version.rb
+- naptime.gemspec
+homepage: ''
+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.3.0
+signing_key: 
+specification_version: 4
+summary: Describe your data entity before designing your API
+test_files: []