reel_template 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c0a78cf770740cd41f90afa8b6b533cbb211c863
-  data.tar.gz: 42e365017954bc5c12ca36d1e0d98e459358d92d
+  metadata.gz: a1517f28622ae1969ecbe03740539f63a200a606
+  data.tar.gz: f17540bd89a3f2e4d6619c1b63e5ffd6db97994e
 SHA512:
-  metadata.gz: 8d7ff9ce77e8e894e70b4a4f7ae53eefcc74b138f39535cfbefffc2935d7368293e0b2f621513d86ef58c781452059b1a07f6d7cacb67a0ef566f00b28c5aebc
-  data.tar.gz: 7c8948d04bf080b4855c00158ad90cc366272b4d7829fe3c90fe649608ea285372733a5079ec2d9bd024214cbfa7403d8ca719f35a0863b6fc85b27eabdf71f2
+  metadata.gz: 24c8db48181528af449d39ddfde1aea8c36982dbae6c087c7c12e4e2553d46c40ae81ae52d90e416673ee5baa165c84387ae4e70a5bd24c8c48b4acbaa39a9f1
+  data.tar.gz: 47371943250a4bc8b0282dde762001c72ed3fe9ffb1d01528d6c3234c1d6617174491b8e53d1b65b93012af5987090c6a7fa93039416647e6b4e43baa4e16f8d

data/lib/reel_template/version.rb

@@ -1,3 +1,3 @@
 module ReelTemplate
-  VERSION = %w(0 0 5).join('.')
+  VERSION = %w(0 0 6).join('.')
 end

data/template/lib/appname/commands.rb.erb

@@ -7,8 +7,8 @@ module <%= @app_module %>
 
     require '<%= @app_name %>/commands/base'
 
-    # REQUIRE YOUR COMMMANDS HERE
-    require '<%= @app_name %>/commands/test'
+    # Require all files from the 'commands' directory
+    <%= @app_module %>.require_dir 'commands'
 
   end
 end

data/template/lib/appname/commands/create.rb.erb

@@ -0,0 +1,19 @@
+<%
+@file_name = "lib/#{@app_name}/commands/create.rb"
+%>
+module <%= @app_module %>::Commands
+  class Create < Command
+    
+    def execute
+      record = <%= @app_module %>::Models::Test.new(params)
+
+      if record.save
+        success record
+      else
+        failure record, t(:invalid, model: "ModelName") # Returns failure code with an invalid message (from locale/en.yml file)
+      end
+
+    end
+
+  end
+end

data/template/lib/appname/commands/{test.rb.erb → get_all.rb.erb}

@@ -5,10 +5,12 @@
 module <%= @app_module %>
   module Commands
 
-    class Test < Command
+    class GetAll < Command
 
       def execute
-        success nil, "Test Command completed successfully"
+        database_records = <%= @app_module %>::Models::Test.all
+
+        success database_records
       end
 
     end

data/template/lib/appname/core.rb.erb

@@ -17,6 +17,14 @@ module <%= @app_module %>
         <%= @app_const %>_ROOT
       end
 
+      # Requires all .rb files in the named directory
+      # Useful for loading all commands / endpoints / models / etc...
+      # @param [String] directory The directory to load files from
+      def require_dir(directory)
+        directory = File.expand_path("../#{directory}", __FILE__)
+        Dir["#{directory}/**/*.rb"].each { |f| require f }
+      end
+
       # Determines the current environment from the system ENV variable. Defaults to development
       # @return [String] The current application environment
       def env

data/template/lib/appname/endpoints.rb.erb

@@ -11,8 +11,8 @@ module <%= @app_module %>
     require '<%= @app_name %>/endpoints/base'
     require '<%= @app_name %>/support/authentication'
 
-    # REQUIRE YOUR ENDPOINTS HERE
-    require '<%= @app_name %>/endpoints/test_endpoint'
+    # Require all files from the 'endpoints' directory
+    <%= @app_module %>.require_dir 'endpoints'
 
   end
 end

data/template/lib/appname/endpoints/base.rb.erb

@@ -45,10 +45,22 @@ module <%= @app_module %>::Endpoints
       @params ||= Hashie::Mash.new( combined_params )
     end
 
+    # Returns the current user
+    # @current_user could be set from inside the `basic_auth` block located in support/authentication.rb
     def current_user
       @current_user || nil
     end
 
+    # Returns an array of allowed HTTP methods (GET, POST, etc...)
+    def self.allowed_methods
+      raise NotImplementedError
+    end
+
+    # @private
+    def allowed_methods
+      self.class.allowed_methods
+    end
+
     private
 
     # Retrieves all parameters from request body, URL segments and URL query string

data/template/lib/appname/endpoints/test_endpoint.rb.erb

@@ -5,20 +5,43 @@
 module <%= @app_module %>
   module Endpoints
 
+    # Endpoint allows for the use of Webmachine resource callbacks
     class TestEndpoint < Endpoint
       
-      def allowed_methods
-        %w(GET)
+      # Only allow GET and POST requests to this endpoint
+      def self.allowed_methods
+        %w(GET POST)
       end
 
+      # All URLs route to this endpoint
       def self.path
-        ["test"]
+        ["*"]
       end
 
+      # POST requests create a resource
+      def post_is_create?
+        true
+      end
+
+      # Webmachine callback for POST requests
+      def create_path
+        create_command = <%= @app_module %>::Commands::Create.new(params)
+        @create_response = create_command.execute
+
+        "/#{@create_response.id}" # Returns the path to the created resource
+      end
+
+      # Called during POST and PUT requests
+      def from_json
+        send_response! @create_response
+      end
+
+      # Called for GET requests
       def to_json
-        test = <%= @app_module %>::Commands::Test.new(params)
-        send_response! test.execute
+        get_all = <%= @app_module %>::Commands::GetAll.new(params)
+        send_response! get_all.execute
       end
+
     end
 
   end

data/template/lib/appname/models.rb.erb

@@ -9,8 +9,8 @@ module <%= @app_module %>
     
     require '<%= @app_name %>/support/serializable_attributes'
 
-    # REQUIRE YOUR MODELS HERE
-    # require '<%= @app_name %>/models/user'
+    # Require all files from the 'models' directory
+    <%= @app_module %>.require_dir 'models' 
 
   end
 end

data/template/lib/appname/models/test.rb.erb

@@ -12,8 +12,9 @@ module <%= @app_module %>
       set_collection_name 'test'
 
       key :test_field, String
+      validates_presence_of :test_field
 
-      serialize_attributes :id, :test_field
+      serialize_attrs :id, :test_field # Only these fields are included in the response JSON output
     end
 
   end

data/template/lib/appname/server.rb.erb

@@ -35,7 +35,7 @@ module <%= @app_module %>
       app.routes do
         # Add each registered endpoint to router
         <%= @app_module %>::Endpoints.all.each do |ep|
-          add ep.path, ep
+          add ep.path, ->(request) { ep.allowed_methods.include? request.method }, ep
         end
       end
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: reel_template
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Kyle Dayton
@@ -50,7 +50,8 @@ files:
 - template/lib/app.rb.erb
 - template/lib/appname/commands.rb.erb
 - template/lib/appname/commands/base.rb.erb
-- template/lib/appname/commands/test.rb.erb
+- template/lib/appname/commands/create.rb.erb
+- template/lib/appname/commands/get_all.rb.erb
 - template/lib/appname/config.rb.erb
 - template/lib/appname/core.rb.erb
 - template/lib/appname/endpoints.rb.erb