apimaster 0.0.3 → 0.0.4

data/README.md

@@ -6,7 +6,28 @@ A simple restful api framework the provides a gem that...
 Developing
 ----------
 
-    % gem install apimaster
-    % mkdir your_app_name & cd your_app_name
-    % apimaster install your_app_name
-    % bundle install
+    gem install apimaster
+    mkdir your_app_name & cd your_app_name
+    apimaster new your_app_name
+    bundle install
+
+Generators
+----------
+
+    apimaster model example
+    apimaster controller example
+
+Testing
+-------
+
+    rake test:unit
+    rake test:functional
+
+    rake test:unit:file name=example
+    rake test:functional:file name=examples_controller
+
+Watchr
+------
+
+    watchr test.watchr
+

data/apimaster.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = 'apimaster'
-  s.version     = '0.0.3'
+  s.version     = '0.0.4'
   s.date        = '2012-07-12'
   s.summary     = "ApiMaster!"
   s.description = "A simple restful api framework."

data/lib/apimaster.rb

@@ -6,17 +6,19 @@ module Apimaster end
 module Apimaster::Helpers end
 module Apimaster::Controllers end
 module Apimaster::Models end
+module Apimaster::Mocks end
+module Apimaster::Test end
 
 require_relative './apimaster/setting'
 require_relative './apimaster/error'
 require_relative './apimaster/mapper'
 
-require_relative './apimaster/helpers/headers.rb'
-require_relative './apimaster/helpers/request.rb'
-require_relative './apimaster/helpers/session.rb'
+require_relative './apimaster/helpers/headers'
+require_relative './apimaster/helpers/request'
+require_relative './apimaster/helpers/session'
 
-require_relative './apimaster/models/user.rb'
-require_relative './apimaster/models/user_mock.rb'
+require_relative './apimaster/models/user'
 
-require_relative './apimaster/controllers/errors.rb'
+require_relative './apimaster/controllers/errors'
 require_relative './apimaster/application'
+

data/lib/apimaster/error.rb

@@ -36,7 +36,7 @@ module Apimaster
 
   class InvalidFieldError < NormalError
     def initialize(resource = nil, field = nil)
-      super("The formatting of the field '#{field}' on a resource '#{resource}' is invalid.", 422, :invalid, resource, field)
+      super("The formatting of the field '#{field}' on a resource '#{resource}' is invalid.", 422, :invalid_field, resource, field)
     end
   end
 

data/lib/apimaster/generators/app_generator.rb

@@ -40,8 +40,6 @@ module Apimaster::Generators
 
         # Test stubs
         m.template "test/test_helper.rb.erb", "test/test_helper.rb"
-        m.template "test/functional_test.rb.erb", "test/functional/index_controller_test.rb"
-        m.template "test/unit_test.rb.erb", "test/unit/#{app_name}_test.rb"
 
         %w(LICENSE Rakefile README.md Gemfile TODO test.watchr).each do |file|
           m.template file, file
@@ -96,6 +94,7 @@ module Apimaster::Generators
         test/unit
         test/functional
         test/factory
+        test/mock
         tmp
         public
       )

data/lib/apimaster/generators/templates/app/controllers/examples_controller.rb.erb

@@ -2,7 +2,7 @@ module <%= module_name %>
   class <%= pluralize camelize(name) %>Controller < Sinatra::Base
 
     get '/<%= pluralize name %>/:id' do
-      <%= name %> = <%= camelize name %>.find params[:id]
+      <%= name %> = <%= camelize name %>.get params[:id]
       json <%= name %>.to_hash(:get)
     end
 
@@ -11,5 +11,26 @@ module <%= module_name %>
       json <%= pluralize name %>.to_hashes(:list)
     end
 
+    post '/<%= pluralize name %>' do
+      <%= pluralize name %> = <%= camelize name %>.post(posts)
+
+      status 201
+      json <%= pluralize name %>.to_hash(:get)
+    end
+
+    patch '/<%= pluralize name %>/:id' do
+      <%= name %> = <%= camelize name %>.get params[:id]
+
+      <%= name %>.patch(posts)
+      json <%= name %>.to_hash(:get)
+    end
+
+    delete '/<%= pluralize name %>/:id' do
+      <%= name %> = <%= camelize name %>.get params[:id]
+      <%= name %>.delete
+      status 204
+      nil
+    end
+
   end
 end

data/lib/apimaster/generators/templates/app/models/example.rb.erb

@@ -9,7 +9,17 @@ module <%= module_name %>
     field :title, type: String
     field :content, type: String
 
-    attr_options :title, accessor: [:list], required: [:post]
-    attr_options :content, accessor: [:get], required: [:post]
+    attr_options :title, accessor: [:get, :list], required: [:post], optional: [:patch]
+    attr_options :content, accessor: [:get], required: [:post], optional: [:patch]
+
+    validates :title, length: { minimum: 2, maximum: 30 }
+
+    class << self
+
+      def get id
+        find id or raise MissingError.new(<%= name %>, :id)
+      end
+
+    end
   end
 end

data/lib/apimaster/generators/templates/config/application.rb.erb

@@ -10,7 +10,6 @@ module <%= module_name %>
     # controllers
     use BeforesController
     use IndexController
-    use ExamplesController
     # use YourCountroller
 
   end

data/lib/apimaster/generators/templates/config/settings/mongoid.yml.erb

@@ -3,7 +3,6 @@ production:
     default:
       database: <%= app_name %>
       username: user
-      username: user
       password: password
       hosts:
         - localhost:27017
@@ -12,7 +11,6 @@ development:
     default:
       database: <%= app_name %>_develop
       username: user
-      username: user
       password: password
       hosts:
         - localhost:27017

data/lib/apimaster/generators/templates/test/functional/examples_controller_test.rb.erb

@@ -17,4 +17,24 @@ class <%= pluralize camelize(name) %>ControllerTest < FunctionalTestCase
     assert_equal 200, last_response.status
   end
 
+  def test_post_<%= pluralize name %>
+    post "/<%= pluralize name %>", to_json(<%= camelize name %>Factory.attrs)
+    assert_equal 201, last_response.status
+  end
+
+  def test_patch_<%= name %>_by_id
+    <%= name %> = <%= camelize name %>Factory.post
+
+    hash = {content: 'my content'}
+    patch "/<%= pluralize name %>/#{<%= name %>._id}", to_json(hash)
+    assert_equal 200, last_response.status
+  end
+
+  def test_delete_<%= name %>_by_id
+    <%= name %> = <%= camelize name %>Factory.post
+
+    delete "/<%= pluralize name %>/#{<%= name %>._id}"
+    assert_equal 204, last_response.status
+  end
+
 end

data/lib/apimaster/generators/templates/test/test_helper.rb.erb

@@ -7,54 +7,33 @@ ENV['RACK_ENV'] ||= "test"
 require "minitest/autorun"
 require "rack/test"
 require "./config/boot"
+require "apimaster/test/factory"
+require "apimaster/test/methods"
+require "apimaster/mocks/user"
 
-class BaseFactory
-
-  def self.define name, value = nil
-    self.attrs[name] = value
-  end
-
-  def self.attrs
-    @attrs ||= {}
-  end
-
-  def self.attr key
-    @attrs ||= {}
-    @attrs[key]
-  end
-
-  def self.register name
-    @klass = name
-  end
-
-  def self.post data = {}
-    raise "Please register class first.`" unless @klass
-    @klass.post attrs.merge(data)
-  end
-
+class BaseFactory < Apimaster::Test::Factory
 end
 
 class TestCase < MiniTest::Unit::TestCase
-
 end
 
 class FunctionalTestCase < TestCase
 
   include Rack::Test::Methods
+  include Apimaster::Test::Methods
 
   def app
     @app ||= Sinatra.new(<%= module_name %>::Application) {}
   end
 
-  def body
-    last_response.body
-  end
+end
 
-  def patch(uri, params = {}, env = {}, &block)
-    env = env.merge(:method => "PATCH", :params => params)
-    request(uri, env, &block)
+module Apimaster::Helpers
+  module Session
+    def user_model
+      @user_model ||= Apimaster::Mocks::User
+    end
   end
-
 end
 
 Dir.glob "./test/factory/**/*_factory.rb" do |f| require f end

data/lib/apimaster/generators/templates/test/unit/example_test.rb.erb

@@ -5,7 +5,17 @@ class <%= camelize name %>Test < TestCase
 
   def test_title
     <%= name %> = <%= module_name %>::<%= camelize name %>.new
+
     <%= name %>.title = 'hello'
     assert_equal 'hello', <%= name %>.title
+    assert_equal true, <%= name %>.valid?
+
+    # title length
+    <%= name %>.title = 'x'
+    assert_equal false, <%= name %>.valid?
+
+    <%= name %>.title = 'x' * 50
+    assert_equal false, <%= name %>.valid?
+
   end
 end

data/lib/apimaster/helpers/session.rb

@@ -23,7 +23,11 @@ module Apimaster::Helpers
 
     def auth_user
       @access_token ||= params[:access_token] or header_token
-      (test? ? Apimaster::Models::UserMock : Apimaster::Models::User).auth @access_token
+      user_model.auth @access_token
+    end
+
+    def user_model
+      @user_model ||= Apimaster::Models::User
     end
 
     def header_token

data/lib/apimaster/mapper.rb

@@ -20,7 +20,11 @@ module Apimaster
 
     def save_with_hash hash, method
       from_hash hash, method
-      save
+      if valid?
+        save
+      else
+        raise InvalidFieldError.new(class_name, errors.keys.first)
+      end
       self
     end
 
@@ -65,6 +69,10 @@ module Apimaster
       record
     end
 
+    def class_name
+      @class_name ||= self.class.to_s.split("::").last
+    end
+
     class << self
 
       OPTION_TYPES = [:accessor, :required, :optional]

data/lib/apimaster/mocks/user.rb

@@ -0,0 +1,13 @@
+# encoding: utf-8
+#
+# Copyright (C) 2011-2012  AdMaster, Inc.
+
+module Apimaster::Mocks
+  class User
+
+    def self.auth access_token
+      Apimaster::Models::User.new id: 1, email: "hello@admaster.com.cn", username: "hello"
+    end
+
+  end
+end

data/lib/apimaster/test/factory.rb

@@ -0,0 +1,31 @@
+# encoding: utf-8
+#
+# Copyright (C) 2011-2012  AdMaster, Inc.
+
+module Apimaster::Test
+
+  class Factory
+    def self.define name, value = nil
+      self.attrs[name] = value
+    end
+
+    def self.attrs
+      @attrs ||= {}
+    end
+
+    def self.attr key
+      @attrs ||= {}
+      @attrs[key]
+    end
+
+    def self.register name
+      @klass = name
+    end
+
+    def self.post data = {}
+      raise "Please register class first." unless @klass
+      @klass.post attrs.merge(data)
+    end
+
+  end
+end

data/lib/apimaster/test/methods.rb

@@ -0,0 +1,26 @@
+# encoding: utf-8
+#
+# Copyright (C) 2011-2012  AdMaster, Inc.
+
+module Apimaster::Test
+  module Methods
+
+    def body
+      last_response.body
+    end
+
+    def patch(uri, params = {}, env = {}, &block)
+      env = env.merge(:method => "PATCH", :params => params)
+      request(uri, env, &block)
+    end
+
+    def from_json
+      @response_json ||= JSON.parse(last_response.body)
+    end
+
+    def to_json(hash)
+      JSON.generate(hash)
+    end
+
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: apimaster
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -55,10 +55,8 @@ files:
 - lib/apimaster/generators/templates/README.md
 - lib/apimaster/generators/templates/test/factory/example_factory.rb.erb
 - lib/apimaster/generators/templates/test/functional/examples_controller_test.rb.erb
-- lib/apimaster/generators/templates/test/functional_test.rb.erb
 - lib/apimaster/generators/templates/test/test_helper.rb.erb
 - lib/apimaster/generators/templates/test/unit/example_test.rb.erb
-- lib/apimaster/generators/templates/test/unit_test.rb.erb
 - lib/apimaster/generators/templates/test.watchr
 - lib/apimaster/generators/templates/TODO
 - lib/apimaster/generators/version.rb
@@ -66,9 +64,11 @@ files:
 - lib/apimaster/helpers/request.rb
 - lib/apimaster/helpers/session.rb
 - lib/apimaster/mapper.rb
+- lib/apimaster/mocks/user.rb
 - lib/apimaster/models/user.rb
-- lib/apimaster/models/user_mock.rb
 - lib/apimaster/setting.rb
+- lib/apimaster/test/factory.rb
+- lib/apimaster/test/methods.rb
 - lib/apimaster.rb
 - LICENSE
 - README.md

data/lib/apimaster/generators/templates/test/functional_test.rb.erb

@@ -1 +0,0 @@
-

data/lib/apimaster/generators/templates/test/unit_test.rb.erb

@@ -1,11 +0,0 @@
-# encoding: utf-8
-#
-# Copyright (C) 2011-2012  AdMaster, Inc.
-
-class <%= module_name %>Test < TestCase
-
-  def test_sample_method
-    assert 1, 1
-  end
-
-end

data/lib/apimaster/models/user_mock.rb

@@ -1,13 +0,0 @@
-# encoding: utf-8
-#
-# Copyright (C) 2011-2012  AdMaster, Inc.
-
-module Apimaster::Models
-  class UserMock
-
-    def self.auth access_token
-      User.new id: 1, email: "hello@admaster.com.cn", username: "hello"
-    end
-
-  end
-end