calamum 1.0.2 → 1.1.0

data/lib/calamum/calamum_helper.rb

@@ -1,10 +0,0 @@
-
-
-def puts_info(msg)
-  $stdout.puts "\e[32m[INFO] #{msg}\e[0m" if Calamum::Config[:debug]
-end
-
-def puts_error(msg)
-  $stderr.puts "\e[31m[ERROR] #{msg}\e[0m" if Calamum::Config[:debug]
-  exit(1)
-end

data/lib/calamum/definition_parser.rb

@@ -1,75 +0,0 @@
-
-class Calamum::DefinitionParser
-  attr_accessor :definition, :resources
-
-  def initialize(definition_yaml)
-    @definition = definition_yaml
-    @resources = Hash.new
-  end
-
-  def get_resources
-    Calamum::Config[:sort]? @definition['resources'].sort : @definition['resources']
-  end
-
-  def get_name
-    @definition['name']
-  end
-
-  def get_url
-    @definition['url']
-  end
-
-  def get_description
-    @definition['description']
-  end
-
-  def get_resources_names
-    @definition['resources'].inject([]){|resources, (key, content)| resources << key}
-  end
-
-  def load_requests
-    self.get_resources.each do |resource, requests|
-      @resources[resource] = []
-      index = 0
-      requests.each do |request|
-        req = initialize_request(request)
-        unless req.nil?
-          @resources[resource][index]= req
-          index += 1
-        end
-      end
-    end
-    @resources
-  end
-
-  def initialize_request(request)
-    req = Calamum::Request.new({
-                                 :uri =>  request['uri'],
-                                 :action => request['action'],
-                                 :params => request['params'],
-                                 :description => request['description'],
-                                 :headers => request['headers'],
-                                 :response => request['response'],
-                               })
-    if req.errors.empty?
-      puts_info "Request #{request['action']}: #{request['uri']} loading success"
-      req
-    else
-      puts_error "Request #{request['action']}: #{request['uri']} not valid: #{req.errors}"
-      nil
-    end
-  end
-
-  def get_resource_uris(name)
-    @resources[name]
-  end
-
-  def find_resource_uri_by_label(resource, label)
-    @resources.select{|r| r['label']==label}.first['uri']
-  end
-
-  def find_resource_action_by_label(resource, label)
-    @resources.select{|r| r['label']==label}.first['action']
-  end
-
-end

data/lib/calamum/request.rb

@@ -1,40 +0,0 @@
-class Calamum::Request
-  include ActiveModel::Validations
-
-  attr_reader :errors
-  attr_accessor :uri, :action, :params, :description, :headers, :response
-  ACTIONS= %{GET POST PUT DELETE}
-
-  validates :uri, :action, :presence => true
-  # validates :uri, :uniqueness => true
-  validates :action, :inclusion => { :in => ACTIONS, :message => "is not included in [#{ACTIONS}]"}
-
-  def initialize(attrs)
-    @uri= attrs[:uri]
-    @action= attrs[:action].upcase
-    @params= attrs[:params] || {}
-    @headers = attrs[:headers] || {}
-    @response = attrs[:response] || ''
-    @description = attrs[:description]
-    @errors = ActiveModel::Errors.new(self)
-    self.valid?
-  end
-
-  def action_label
-    case @action
-    when 'GET'
-      'label-info'
-    when 'POST'
-      'label-success'
-    when 'PUT'
-      'label-warning'
-    when 'DELETE'
-      'label-important'
-    end
-  end
-
-  def to_s
-    "#{action}: #{uri}"
-  end
-
-end

data/sample/sample.yml

@@ -1,83 +0,0 @@
-name: 'Calamum'
-url: 'http://calamum-sample:3000/api'
-description: 'Calamum is a simple ruby build program to generate a REST API documentation from a YAML file definition'
-resources:
-    user:   
-     -
-      uri: '/users'
-      action: 'get'
-      headers:
-        content_type: 'application/json'
-      description: 'Get the users list'
-      response: '{"users":[{"id":"12354","name":"test", "mail":"test@test.com"}, {"id":"123789","name":"test2", "mail":"test@test.com"}}'
-     -
-      uri: '/users/:id'
-      action: 'get'
-      headers:
-        content_type: 'application/json'
-        content_language: 'en-US'
-      params:
-        id: 
-          type: 'String'
-          description: 'User id'
-          required: true
-      response: '{"user":{"name":"test", "mail":"test@test.com"}}'
-
-     -
-      uri: '/users'
-      action: 'post'
-      description: 'Create a new user'
-      headers:
-        content_type: 'application/json'
-        content_language: 'en-US'
-      params:
-        id: 
-          type: 'String'
-          description: 'User id'
-          required: true
-        name:
-          type: 'String'
-          description: 'User name'
-          required: false
-        email:
-          type: 'String'
-          description: 'User email'
-          required: true
-     -
-      uri: '/users/:id'
-      action: 'put'
-      description: 'Update the user'
-      headers:
-        content_type: 'application/json'
-        content_language: 'en-US'
-      params:
-        id: 
-          type: 'String'
-          description: 'User id'
-          required: true
-        name:
-          type: 'String'
-          description: 'User name'
-          required: false
-        email:
-          type: 'String'
-          description: 'User email'
-          required: true
-     -
-      uri: '/users/:id'
-      action: 'delete'
-      description: 'Delete the user'
-      headers:
-        content_type: 'application/json'
-        content_language: 'en-US'
-      params:
-        id: 
-          type: 'String'
-          description: 'User id'
-          required: true
-    group:
-     -
-      uri: '/groups'
-      action: 'get'
-      content_type: 'application/json'
-      description: 'Get the list og groups'

data/spec/data/my_definition.yml

@@ -1,41 +0,0 @@
-name: 'Drive'
-url: 'http://localhost:3000/api'
-resources:
-    user:   
-     -
-      uri: '/users'
-      action: 'get'
-      description: 'Get the list of the users'
-     -
-      uri: '/users/:id'
-      action: 'get'
-      headers:
-        content_type: 'application/json'
-        content_language: 'en-US'
-      params:
-        id: 
-          type: 'String'
-     -
-      uri: '/users/:id'
-      action: 'put'
-      headers:
-        content_type: 'application/json'
-        content_language: 'en-US'
-      params:
-        id: 
-          type: 'String'
-          description: 'User id'
-          required: true
-        name:
-          type: 'String'
-          description: 'User name'
-          required: false
-        email:
-          type: 'String'
-          description: 'User email'
-          required: true
-    group:
-     -
-      uri: '/groups'
-      action: 'get'
-      description: 'Get the list og groups'

data/spec/definition_parser_spec.rb

@@ -1,17 +0,0 @@
-require 'spec_helper'
-
-describe Calamum::DefinitionParser do
-  before do
-    definition = YAML.load(File.open("spec/data/my_definition.yml"))
-    @api_definition = Calamum::DefinitionParser.new(definition)
-    @api_definition.load_requests
-  end
-
-  specify{@api_definition.get_resources_names.should == ['user', 'group']}
-  specify{@api_definition.get_resource_uris('user').size.should == 3}
-  specify{@api_definition.resources['user'].size.should == 3}
-  specify{@api_definition.resources['user'][0].errors.should be_empty}
-  specify{@api_definition.resources['user'][0].action.should == 'GET'}
-  specify{@api_definition.resources['user'][0].uri.should == '/users'}
-  specify{@api_definition.resources['user'][1].headers.should_not be_empty}
-end

data/spec/request_spec.rb

@@ -1,13 +0,0 @@
-require 'spec_helper'
-
-describe Calamum::Request do
-  before do
-    @attrs = {uri: '/users', action: 'get', params: {id:{type: 'String'}}, content_type: 'application/json'} 
-  end
-
-  specify{Calamum::Request.new(@attrs).should be_true}
-  specify{Calamum::Request.new(@attrs.merge(uri:'')).errors[:uri].should == ["can't be blank"]}
-  specify{Calamum::Request.new(@attrs.merge(action:'')).errors[:action].should == ["can't be blank"]}
-  specify{Calamum::Request.new(@attrs.merge(action:'foo')).errors[:action].should == ["is not included in [GET POST PUT DELETE]"]}
-  
-end

data/spec/spec_helper.rb

@@ -1,3 +0,0 @@
-require_relative '../lib/calamum'
-
-require 'active_support/hash_with_indifferent_access'