api_sketch 0.1.1 → 0.1.2

data/lib/api_sketch/model.rb

@@ -1,244 +1,2 @@
 module ApiSketch::Model
-
-  class Base
-
-    attr_accessor :name, :description
-
-    def initialize(attributes = {})
-      attributes = default_values_hash.merge(attributes)
-      attributes.each do |attribute, value|
-        self.send("#{attribute}=", value)
-      end
-    end
-
-    private
-      def default_values_hash
-        {}
-      end
-
-  end
-
-
-  class Attribute < ApiSketch::Model::Base
-    attr_accessor :data_type, :value, :example, :required, :default, :content
-
-    def example_value(defaults_allowed=false)
-      value = self.example
-      value ||= example_value_default if defaults_allowed
-
-      value.respond_to?(:call) ? value.call : value
-    end
-
-    # TODO: These default values should be configurable via DSL
-    #       Some logic to defer value example from key name, - email from key with email part inside, etc.
-    def example_value_default
-      {
-        integer:   lambda { rand(1000) + 1 },
-        string:    lambda { "random_string_#{('A'..'Z').to_a.shuffle.first(8).join}" },
-        float:     lambda { rand(100) + rand(100) * 0.01 },
-        boolean:   lambda { [true, false].sample },
-        datetime:  lambda { Time.now.strftime("%d-%m-%Y %H:%M:%S") },
-        timestamp: lambda { Time.now.to_i }
-      }[data_type]
-    end
-
-    def to_hash
-      {
-        data_type: self.data_type,
-        example_value: self.example_value,
-        required: !!self.required,
-        default: self.default,
-        content: self.content_to_hash
-      }
-    end
-
-    def content_to_hash
-      if self.content
-        self.content.map do |item|
-          item.to_hash
-        end
-      end
-    end
-
-  end
-
-
-  class Header < ApiSketch::Model::Base
-    attr_accessor :value, :example, :required
-
-    def example_value
-      self.example.respond_to?(:call) ? self.example.call : self.example
-    end
-  end
-
-
-  class Parameters < ApiSketch::Model::Base
-    attr_accessor :query, :body, :query_container_type, :body_container_type
-
-    def initialize(attributes = {})
-      super(attributes)
-      self.query ||= []
-      self.body ||= []
-    end
-
-    def as_full_names
-      fullname_params = self.class.new
-      [:query, :body].each do |param_location|
-        new_params = []
-        self.send(param_location).each do |param|
-          if param.data_type == :document
-            full_names_for(param, param.name, new_params)
-          else
-            new_params << param
-          end
-        end
-        fullname_params.send("#{param_location}=", new_params)
-      end
-      fullname_params
-    end
-
-    private
-      def full_names_for(param, name = "", new_params)
-        name = name.to_s # ensure that this value is always a string
-        if param.content.kind_of?(Array)
-          param.content.each do |attribute|
-            renamed_attribute = attribute.clone
-            renamed_attribute.name = name.empty? ? attribute.name.to_s : "#{name}[#{attribute.name}]"
-            if renamed_attribute.data_type == :document
-              full_names_for(renamed_attribute, renamed_attribute.name, new_params)
-            else
-              new_params << renamed_attribute
-            end
-          end
-        end
-      end
-  end
-
-
-  class Resource < ApiSketch::Model::Base
-
-    attr_accessor :namespace, :action, :path, :http_method, :format, :headers, :parameters, :responses
-
-    # TODO: update this method to provide better id that is used as part of filename
-    def id
-      [self.namespace, self.action].reject { |v| v.nil? || v == "" }.join("/")
-    end
-
-    class << self
-
-      def create(attributes)
-        res = self.new(attributes)
-        res.send(:run_validations!)
-        self.add(res)
-        res
-      end
-
-      def add(resource)
-        @resources ||= []
-        @resources << resource
-      end
-
-      def reset!
-        @resources = []
-      end
-
-      def reload!(definitions_dir)
-        self.reset!
-        ApiSketch::DSL.new(definitions_dir).init!
-      end
-
-      def all
-        @resources ||= []
-      end
-
-      def find(id)
-        self.all.find { |res| res.id == id }
-      end
-
-      def find_by_http_method_and_path(http_method, path)
-        self.all.find { |res| res.http_method == http_method && res.path == path }
-      end
-
-      def first
-        self.all.first
-      end
-
-      def last
-        self.all.last
-      end
-
-      def count
-        self.all.count
-      end
-
-    end
-
-    private
-      def default_values_hash
-        {
-          http_method: "GET",
-          format: "json",
-          headers: [],
-          parameters: ::ApiSketch::Model::Parameters.new,
-          responses: []
-        }
-      end
-
-      def error_message(message)
-        # puts_error(message)
-        raise ::ApiSketch::Error, message
-      end
-
-      def run_validations!
-        unless self.action =~ /\A\w*\z/
-          error_message("'#{self.action}' is invalid action value")
-        end
-
-        if self.class.find(self.id)
-          error_message("'#{self.id}' is not unique id. Change values of 'namespace' and/or 'action' attributes")
-        end
-
-        if self.http_method.nil? || self.http_method.empty?
-          error_message("request http_method can't be blank")
-        end
-
-        if self.path.nil? || self.path.empty?
-          error_message("request path can't be blank")
-        end
-
-        if self.class.find_by_http_method_and_path(self.http_method, self.path)
-          error_message("Route '#{self.http_method} #{self.path}' should be unique")
-        end
-      end
-
-  end
-
-
-  class Response < ApiSketch::Model::Base
-    attr_accessor :http_status, :parameters, :format, :headers
-
-    private
-      def default_values_hash
-        {
-          format: "json",
-          headers: [],
-          parameters: ::ApiSketch::Model::Parameters.new
-        }
-      end
-  end
-
-  module SharedBlock
-    @list_hash = {}
-
-    class << self
-      def add(name, block)
-        @list_hash[name] = block
-      end
-
-      def find(name)
-        @list_hash[name] || raise(::ApiSketch::Error, "Shared block '#{name}' is not defined")
-      end
-    end
-  end
-
 end

data/lib/api_sketch/version.rb

@@ -1,3 +1,3 @@
 module ApiSketch
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/lib/api_sketch.rb

@@ -8,12 +8,29 @@ require 'fileutils'
 
 module ApiSketch
   require "api_sketch/dsl"
+  require "api_sketch/dsl/base"
+  require "api_sketch/dsl/attribute_parser"
+  require "api_sketch/dsl/attributes"
+  require "api_sketch/dsl/complex_attribute_parser"
+  require "api_sketch/dsl/headers"
+  require "api_sketch/dsl/parameters"
+  require "api_sketch/dsl/responses"
+
   require "api_sketch/model"
+  require "api_sketch/model/base"
+  require "api_sketch/model/attribute"
+  require "api_sketch/model/header"
+  require "api_sketch/model/parameters"
+  require "api_sketch/model/resource"
+  require "api_sketch/model/response"
+  require "api_sketch/model/shared_block"
+
   require "api_sketch/error"
-  require "api_sketch/generators"
+  require "api_sketch/generators/base"
+  require "api_sketch/generators/bootstrap"
   require "api_sketch/helpers"
   require "api_sketch/config"
-  require "api_sketch/renderers"
+  require "api_sketch/response_renderer"
   require "api_sketch/examples_server"
   require "api_sketch/runner"
-end
+end

data/spec/lib/api_sketch/dsl/attribute_parser_spec.rb

@@ -0,0 +1,14 @@
+require "spec_helper"
+
+describe ApiSketch::DSL::AttributeParser do
+
+  let(:simple_instance) {
+    described_class.new(:document, &(Proc.new {}) )
+  }
+
+  context "instance methods" do
+    subject { simple_instance }
+    it_should_behave_like "supports shared blocks"
+  end
+
+end

data/spec/lib/api_sketch/dsl/attributes_spec.rb

@@ -0,0 +1,14 @@
+require "spec_helper"
+
+describe ApiSketch::DSL::Attributes do
+
+  let(:simple_instance) {
+    described_class.new(:document, &(Proc.new {}) )
+  }
+
+  context "instance methods" do
+    subject { simple_instance }
+    it_should_behave_like "supports shared blocks"
+  end
+
+end

data/spec/lib/api_sketch/dsl/complex_attribute_parser_spec.rb

@@ -0,0 +1,14 @@
+require "spec_helper"
+
+describe ApiSketch::DSL::ComplexAttributeParser do
+
+  let(:simple_instance) {
+    described_class.new(:document, &(Proc.new {}) )
+  }
+
+  context "instance methods" do
+    subject { simple_instance }
+    it_should_behave_like "supports shared blocks"
+  end
+
+end

data/spec/lib/api_sketch/dsl/headers_spec.rb

@@ -0,0 +1,14 @@
+require "spec_helper"
+
+describe ApiSketch::DSL::Headers do
+
+  let(:simple_instance) {
+    described_class.new( &(Proc.new {}) )
+  }
+
+  context "instance methods" do
+    subject { simple_instance }
+    it_should_behave_like "supports shared blocks"
+  end
+
+end

data/spec/lib/api_sketch/dsl/parameters_spec.rb

@@ -0,0 +1,14 @@
+require "spec_helper"
+
+describe ApiSketch::DSL::Parameters do
+
+  let(:simple_instance) {
+    described_class.new( &(Proc.new {}) )
+  }
+
+  context "instance methods" do
+    subject { simple_instance }
+    it_should_behave_like "supports shared blocks"
+  end
+
+end

data/spec/lib/api_sketch/dsl/responses_spec.rb

@@ -0,0 +1,14 @@
+require "spec_helper"
+
+describe ApiSketch::DSL::Responses do
+
+  let(:simple_instance) {
+    described_class.new( &(Proc.new {}) )
+  }
+
+  context "instance methods" do
+    subject { simple_instance }
+    it_should_behave_like "supports shared blocks"
+  end
+
+end

data/spec/lib/api_sketch/dsl_spec.rb

@@ -1,6 +1,7 @@
 require "spec_helper"
 
 describe ApiSketch::DSL do
+
   context "document" do
     context "when all data has key names" do
       before do
@@ -483,7 +484,7 @@ describe ApiSketch::DSL do
         @definition_block = definition
 
         @shared_block = Proc.new do
-          shared_block("short user data", definition)
+          shared_block("short user data", &definition)
         end
       end
 
@@ -501,7 +502,7 @@ describe ApiSketch::DSL do
                 string "test_key" do
                 end
 
-                shared "short user data"
+                use_shared_block "short user data"
               end
             end
           end
@@ -530,7 +531,7 @@ describe ApiSketch::DSL do
                 string "test_key" do
                 end
 
-                shared "non existing shared data"
+                use_shared_block "non existing shared data"
               end
             end
           end
@@ -543,4 +544,5 @@ describe ApiSketch::DSL do
 
     end
   end
+
 end

data/spec/lib/api_sketch/model/parameters_spec.rb

@@ -0,0 +1,28 @@
+require "spec_helper"
+
+describe ApiSketch::Model::Parameters do
+
+  context "instance methods" do
+    let(:instance) {
+      element_1 = ApiSketch::Model::Attribute.new(data_type: "string", value: "Test")
+      ApiSketch::Model::Parameters.new({query: [], body: [element_1], body_container_type: "array", query_container_type: "document"})
+    }
+
+    describe "#wrapped_body" do
+      it "should return ApiSketch::Model::Attribute object" do
+        attribute = instance.wrapped_body
+        expect(attribute.content).to eql instance.body
+        expect(attribute.data_type).to eql "array"
+      end
+    end
+
+    describe "#wrapped_query" do
+      it "should return ApiSketch::Model::Attribute object" do
+        attribute = instance.wrapped_query
+        expect(attribute.content).to eql instance.query
+        expect(attribute.data_type).to eql "document"
+      end
+    end
+  end
+
+end

data/spec/lib/api_sketch/{renderers_spec.rb → response_renderer_spec.rb}

@@ -33,6 +33,41 @@ describe ApiSketch::ResponseRenderer do
     end
   }
 
+
+  let(:array_response) {
+    Proc.new do
+      resource "Array of documents" do
+        action "index"
+        namespace "simple_data"
+        path "/api/test_datas.json"
+        http_method "GET"
+        format "json"
+
+        responses do
+          context "Success" do
+            http_status :ok
+
+            parameters do
+              body :array do
+                document do
+                  description "some data"
+                  content do
+                    string "name" do
+                      example { "Test User #{rand(100)}" }
+                    end
+                    integer "id" do
+                      example { rand(100) + 1 }
+                    end
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  }
+
   let(:resource_example_definition) {
     Proc.new do
       resource "Get test data" do
@@ -120,6 +155,21 @@ describe ApiSketch::ResponseRenderer do
 
         expect(result).to eql expected_hash
       end
+
+      context "array root response" do
+        it "should return proper elements amount at response array" do
+          ApiSketch::DSL.new.instance_eval(&array_response)
+          response = ApiSketch::Model::Resource.find("simple_data/index").responses.find { |rsp| rsp.name == "Success" }
+          size = 7
+          result = ApiSketch::ResponseRenderer.new([response.parameters.wrapped_body], response.parameters.body_container_type, size).to_h
+
+          expect(result.size).to eql size
+          result.each do |element|
+            expect(element["name"]).to be_instance_of(String)
+            expect(element["id"]).to be_kind_of(Numeric)
+          end
+        end
+      end
     end
 
 
@@ -135,4 +185,4 @@ describe ApiSketch::ResponseRenderer do
     end
   end
 
-end
+end

data/spec/spec_helper.rb

@@ -1 +1,3 @@
-require "api_sketch"
+require "api_sketch"
+
+Dir["./spec/support/**/*.rb"].sort.each { |f| require f }

data/spec/support/shared_examples.rb

@@ -0,0 +1,9 @@
+shared_examples_for "supports shared blocks" do
+  it "should support shared blocks" do
+    ApiSketch::DSL.new.shared_block "test data" do
+      "test shared block data"
+    end
+
+    expect(subject.use_shared_block("test data")).to eql "test shared block data"
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: api_sketch
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Alexey Suhoviy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-03 00:00:00.000000000 Z
+date: 2015-05-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mixlib-cli
@@ -118,8 +118,6 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
-- ".ruby-gemset"
-- ".ruby-version"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
@@ -127,15 +125,35 @@ files:
 - Rakefile
 - api_sketch.gemspec
 - bin/api_sketch
+- examples/api_project/config/initializers/shared_blocks.rb
+- examples/api_project/resources/places.rb
+- examples/api_project/resources/users.rb
+- examples/api_project/resources/users/points.rb
+- examples/api_project/resources/users/points/stats.rb
 - lib/api_sketch.rb
 - lib/api_sketch/config.rb
 - lib/api_sketch/dsl.rb
+- lib/api_sketch/dsl/attribute_parser.rb
+- lib/api_sketch/dsl/attributes.rb
+- lib/api_sketch/dsl/base.rb
+- lib/api_sketch/dsl/complex_attribute_parser.rb
+- lib/api_sketch/dsl/headers.rb
+- lib/api_sketch/dsl/parameters.rb
+- lib/api_sketch/dsl/responses.rb
 - lib/api_sketch/error.rb
 - lib/api_sketch/examples_server.rb
-- lib/api_sketch/generators.rb
+- lib/api_sketch/generators/base.rb
+- lib/api_sketch/generators/bootstrap.rb
 - lib/api_sketch/helpers.rb
 - lib/api_sketch/model.rb
-- lib/api_sketch/renderers.rb
+- lib/api_sketch/model/attribute.rb
+- lib/api_sketch/model/base.rb
+- lib/api_sketch/model/header.rb
+- lib/api_sketch/model/parameters.rb
+- lib/api_sketch/model/resource.rb
+- lib/api_sketch/model/response.rb
+- lib/api_sketch/model/shared_block.rb
+- lib/api_sketch/response_renderer.rb
 - lib/api_sketch/runner.rb
 - lib/api_sketch/templates/bootstrap/assets/fonts/glyphicons-halflings-regular.eot
 - lib/api_sketch/templates/bootstrap/assets/fonts/glyphicons-halflings-regular.svg
@@ -156,14 +174,22 @@ files:
 - lib/api_sketch/templates/bootstrap/assets/stylesheets/dashboard.css
 - lib/api_sketch/templates/bootstrap/resource.html.erb
 - lib/api_sketch/version.rb
+- spec/lib/api_sketch/dsl/attribute_parser_spec.rb
+- spec/lib/api_sketch/dsl/attributes_spec.rb
+- spec/lib/api_sketch/dsl/complex_attribute_parser_spec.rb
+- spec/lib/api_sketch/dsl/headers_spec.rb
+- spec/lib/api_sketch/dsl/parameters_spec.rb
+- spec/lib/api_sketch/dsl/responses_spec.rb
 - spec/lib/api_sketch/dsl_spec.rb
-- spec/lib/api_sketch/renderers_spec.rb
+- spec/lib/api_sketch/model/parameters_spec.rb
+- spec/lib/api_sketch/response_renderer_spec.rb
 - spec/spec_helper.rb
+- spec/support/shared_examples.rb
 homepage: https://github.com/suhovius/api_sketch
 licenses:
 - MIT
 metadata: {}
-post_install_message: Thanks for installing!
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -184,6 +210,14 @@ signing_key:
 specification_version: 4
 summary: API Prototyping and API Documentation Tool
 test_files:
+- spec/lib/api_sketch/dsl/attribute_parser_spec.rb
+- spec/lib/api_sketch/dsl/attributes_spec.rb
+- spec/lib/api_sketch/dsl/complex_attribute_parser_spec.rb
+- spec/lib/api_sketch/dsl/headers_spec.rb
+- spec/lib/api_sketch/dsl/parameters_spec.rb
+- spec/lib/api_sketch/dsl/responses_spec.rb
 - spec/lib/api_sketch/dsl_spec.rb
-- spec/lib/api_sketch/renderers_spec.rb
+- spec/lib/api_sketch/model/parameters_spec.rb
+- spec/lib/api_sketch/response_renderer_spec.rb
 - spec/spec_helper.rb
+- spec/support/shared_examples.rb

data/.ruby-gemset

@@ -1 +0,0 @@
-api_sketch

data/.ruby-version

@@ -1 +0,0 @@
-ruby-2.1.2