textualize 0.1.0

data/lib/textualize/tasks/request_specs.rb

@@ -0,0 +1,48 @@
+require 'erb'
+
+module Textualize
+  class RequestSpecs < Thor::Group
+    include Thor::Actions
+
+    RS_DIRECTORY = 'dist/spec/requests/'
+
+    desc(
+      'Creates request specs for an api using airborne, a ruby gem'
+    )
+
+    def create_airborne_specs
+      FileUtils.mkdir_p(RS_DIRECTORY)
+
+      add_airborne_specs
+    end
+
+    private
+
+    def add_airborne_specs
+      RouteHashes.hashes.each do |route_hash|
+        File.open(
+          "#{RS_DIRECTORY}#{route_hash.verb}_#{route_hash.name}_spec.rb", 'w'
+        ) do |file|
+          file.write(request_spec_template(route_hash))
+        end
+      end
+    end
+
+    def request_spec_template(route_hash)
+      ERB.new(
+        File.read(
+          "#{template_directory}#{route_hash.verb}"\
+          "_#{non_ro_type(route_hash)}.rb.erb"
+        )
+      ).result(route_hash.instance_eval { binding })
+    end
+
+    def template_directory
+      @_directory ||= __dir__.chomp('tasks') + 'templates/request_specs/'
+    end
+
+    def non_ro_type(route_hash)
+      route_hash.type.gsub(/-ro$/, '')
+    end
+  end
+end

data/lib/textualize/tasks/server.rb

@@ -0,0 +1,35 @@
+require 'json'
+
+module Textualize
+  class Server < Thor::Group
+    include Thor::Actions
+
+    desc(
+      'Creates a server directory with json files corresponding to the '\
+      "'happy path' responses to a url and http-verb"
+    )
+
+    def create_method_files
+      RouteHashes.hashes.each do |route_hash|
+        next unless route_hash.verb == 'get'
+        next if route_hash.body.empty?
+
+        route_directory = "#{dist_dir}#{route_hash.url}"
+
+        FileUtils.mkdir_p(route_directory)
+
+        File.open("#{route_directory}/#{route_hash.verb}.json", 'w') do |file|
+          file.write route_hash.body.to_json
+        end
+      end
+    end
+
+    private
+
+    def dist_dir
+      FileUtils.mkdir_p('dist/server')
+
+      'dist/server'
+    end
+  end
+end

data/lib/textualize/templates/http_backend/delete.js.erb

@@ -0,0 +1,10 @@
+angular.module('textualize_http_backend').run([
+  '$httpBackend',
+  function($httpBackend) {
+    $httpBackend.whenDELETE('<%= url %>').respond(
+      function(method, url, data, headers) {
+        return [<%= response_code %>, {}, {}]
+      }
+    );
+  }
+])

data/lib/textualize/templates/http_backend/get.js.erb

@@ -0,0 +1,10 @@
+angular.module('textualize_http_backend').run([
+  '$httpBackend',
+  function($httpBackend) {
+    $httpBackend.whenGET('<%= url %>').respond(
+      function(method, url, data, headers) {
+        return [<%= response_code %>, <%= body.to_json %>, {}]
+      }
+    );
+  }
+])

data/lib/textualize/templates/http_backend/module.js

@@ -0,0 +1 @@
+angular.module('textualize_http_backend', ['ngMockE2E'])

data/lib/textualize/templates/http_backend/patch.js.erb

@@ -0,0 +1,10 @@
+angular.module('textualize_http_backend').run([
+  '$httpBackend',
+  function($httpBackend) {
+    $httpBackend.whenPATCH('<%= url %>').respond(
+      function(method, url, data, headers) {
+        return [<%= response_code %>, {}, {}]
+      }
+    );
+  }
+])

data/lib/textualize/templates/http_backend/post.js.erb

@@ -0,0 +1,10 @@
+angular.module('textualize_http_backend').run([
+  '$httpBackend',
+  function($httpBackend) {
+    $httpBackend.whenPOST('<%= url %>').respond(
+      function(method, url, data, headers) {
+        return [<%= response_code %>, <%= body.to_json %>, {}]
+      }
+    );
+  }
+])

data/lib/textualize/templates/new/.gitignore

@@ -0,0 +1,3 @@
+node_modules
+.tmp
+dist

data/lib/textualize/templates/new/.ruby-version

@@ -0,0 +1 @@
+2.2.1

data/lib/textualize/templates/new/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+ruby File.read("#{__dir__}/.ruby-version").chomp
+
+gem 'textualize', git: 'git@github.com:currica/textualize.git', branch: 'request_specs'

data/lib/textualize/templates/new/Gemfile.lock

@@ -0,0 +1,28 @@
+GIT
+  remote: git@github.com:currica/textualize.git
+  revision: 5d6a9915dcd5c62e88d12b8b298b58b8ab22d1a9
+  branch: request_specs
+  specs:
+    textualize (0.1.0)
+      attr_extras (~> 4)
+      hashie (~> 3)
+      thor (~> 0)
+      uglifier (~> 2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    attr_extras (4.4.0)
+    execjs (2.5.2)
+    hashie (3.4.1)
+    json (1.8.2)
+    thor (0.19.1)
+    uglifier (2.7.1)
+      execjs (>= 0.3.0)
+      json (>= 1.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  textualize!

data/lib/textualize/templates/new/Readme.md

@@ -0,0 +1,10 @@
+## Docs
+
+```bash
+npm install
+gulp
+bundle install
+bundle exec textualize server
+bundle exec textualize http_backend
+```
+

data/lib/textualize/templates/new/apis/base.raml

@@ -0,0 +1,26 @@
+#%RAML 0.8
+---
+title: Menu API
+version: v1
+baseUri: https://app.my-awesome-restaurant.com/api/{version}
+mediaType: application/json
+
+documentation:
+  - title: HTTP Status Codes
+    content: !include ./documentation/http_statuses.md
+
+securitySchemes:
+  - oauth_2_0: !include ./documentation/authentication.yaml
+
+schemas:
+  - items: !include ./base/schemas/item.json
+  - orders: !include ./base/schemas/order.json
+
+resourceTypes:
+  - !include ./resourceTypes/collection.yaml
+  - !include ./resourceTypes/collection-ro.yaml
+  - !include ./resourceTypes/collection-item.yaml
+  - !include ./resourceTypes/collection-item-ro.yaml
+
+/items: !include ./base/routes/items.yaml
+/orders: !include ./base/routes/orders.yaml

data/lib/textualize/templates/new/apis/base/routes/items.yaml

@@ -0,0 +1,8 @@
+type:
+  collection-ro:
+    exampleCollection: !include ../samples/items.json
+    exampleItem:       !include ../samples/item.json
+/{item_id}:
+  type:
+    collection-item-ro:
+      exampleItem: !include ../samples/item.json

data/lib/textualize/templates/new/apis/base/routes/orders.yaml

@@ -0,0 +1,8 @@
+type:
+  collection:
+    exampleCollection: !include ../samples/orders.json
+    exampleItem:       !include ../samples/order.json
+/{order_id}:
+  type:
+    collection-item-ro:
+      exampleItem: !include ../samples/order.json

data/lib/textualize/templates/new/apis/base/samples/item.json

@@ -0,0 +1,12 @@
+{
+  "data": {
+    "id": "1",
+    "type": "item",
+    "name": "Hamburger",
+    "created_at": "1430407103",
+    "updated_at": "1430407180",
+    "links": {
+      "self": "https://app.my-awesome-restaurant.com/api/v1/hamburger/1"
+    }
+  }
+}

data/lib/textualize/templates/new/apis/base/samples/items.json

@@ -0,0 +1,34 @@
+{
+  "data": [
+    {
+      "id": "1",
+      "type": "item",
+      "created_at": "1430407103",
+      "updated_at": "1430407180",
+      "name": "Hamburger",
+      "links": {
+        "self": "https://app.my-awesome-restaurant.com/api/v1/items/1"
+      }
+    },
+    {
+      "id": "2",
+      "type": "item",
+      "created_at": "1430407103",
+      "updated_at": "1430407180",
+      "name": "Cheese burger",
+      "links": {
+        "self": "https://app.my-awesome-restaurant.com/api/v1/items/2"
+      }
+    },
+    {
+      "id": "3",
+      "type": "item",
+      "created_at": "1430407103",
+      "updated_at": "1430407180",
+      "name": "French Fries",
+      "links": {
+        "self": "https://app.my-awesome-restaurant.com/api/v1/items/3"
+      }
+    }
+  ]
+}

data/lib/textualize/templates/new/apis/base/samples/order.json

@@ -0,0 +1,43 @@
+{
+  "data": {
+    "id": "1",
+    "type": "order",
+    "created_at": "1430407203",
+    "updated_at": "1430407280",
+    "links": {
+      "self": "https://app.my-awesome-restaurant.com/api/v1/orders/1",
+      "items": {
+        "related": "https://app.my-awesome-restaurant.com/api/v1/orders/1/items",
+        "linkage": [
+          { "type": "items", "id": "1" },
+          { "type": "items", "id": "3" }
+        ]
+      }
+    }
+  },
+  "included": {
+    "items": {
+      "1": {
+        "id": 1,
+        "type": "item",
+        "created_at": "1430407103",
+        "updated_at": "1430407180",
+        "name": "Hamburger",
+        "links": {
+          "self": "https://app.my-awesome-restaurant.com/api/v1/items/1"
+        }
+      },
+      "3": {
+        "id": 3,
+        "type": "item",
+        "created_at": "1430407103",
+        "updated_at": "1430407180",
+        "name": "French Fries",
+        "links": {
+          "self": "https://app.my-awesome-restaurant.com/api/v1/items/3"
+        }
+      }
+    }
+  }
+}
+

data/lib/textualize/templates/new/apis/base/samples/orders.json

@@ -0,0 +1,70 @@
+{
+  "data": [
+    {
+      "id": "1",
+      "type": "order",
+      "created_at": "1430407203",
+      "updated_at": "1430407280",
+      "links": {
+        "self": "https://app.my-awesome-restaurant.com/api/v1/orders/1",
+        "items": {
+          "related": "https://app.my-awesome-restaurant.com/api/v1/orders/1/items",
+          "linkage": [
+            { "type": "items", "id": "1" },
+            { "type": "items", "id": "3" }
+          ]
+        }
+      }
+    },
+    {
+      "id": "2",
+      "type": "order",
+      "created_at": "1430407203",
+      "updated_at": "1430407280",
+      "links": {
+        "self": "https://app.my-awesome-restaurant.com/api/v1/orders/1",
+        "items": {
+          "related": "https://app.my-awesome-restaurant.com/api/v1/orders/2/items",
+          "linkage": [
+            { "type": "items", "id": "2" },
+            { "type": "items", "id": "3" }
+          ]
+        }
+      }
+    }
+  ],
+  "included": {
+    "items": {
+      "1": {
+        "id": 1,
+        "type": "item",
+        "created_at": "1430407103",
+        "updated_at": "1430407180",
+        "name": "Hamburger",
+        "links": {
+          "self": "https://app.my-awesome-restaurant.com/api/v1/items/1"
+        }
+      },
+      "2": {
+        "id": 2,
+        "type": "item",
+        "created_at": "1430407103",
+        "updated_at": "1430407180",
+        "name": "Cheese burger",
+        "links": {
+          "self": "https://app.my-awesome-restaurant.com/api/v1/items/2"
+        }
+      },
+      "3": {
+        "id": 3,
+        "type": "item",
+        "created_at": "1430407103",
+        "updated_at": "1430407180",
+        "name": "French Fries",
+        "links": {
+          "self": "https://app.my-awesome-restaurant.com/api/v1/items/3"
+        }
+      }
+    }
+  }
+}

data/lib/textualize/templates/new/apis/base/schemas/item.json

@@ -0,0 +1,17 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "id": "http://jsonschema.net",
+  "type": "object",
+  "properties": {
+    "id": {
+      "type": "string"
+    },
+    "name": {
+      "type": "string",
+      "description": "The name of the item for sale"
+    },
+    "required": [
+      "name"
+    ]
+  }
+}

data/lib/textualize/templates/new/apis/base/schemas/order.json

@@ -0,0 +1,25 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "id": "http://jsonschema.net",
+  "type": "object",
+  "properties": {
+    "id": {
+      "type": "string"
+    },
+    "user_id": {
+      "type": "string",
+      "description": "Person who placed the order"
+    },
+    "order_ids": {
+      "type": "array",
+      "orders_id": {
+        "type": "string"
+      },
+      "minItems": 1,
+      "uniqueItems": true
+    },
+    "required": [
+      "user_id"
+    ]
+  }
+}