baseapi 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b07759ff04f4ef7076a6325f7e10e377d3725a55
-  data.tar.gz: 5da5a0e31fb7ddf700b8f8590d1ad55dc13bb81b
+  metadata.gz: 562c675140df0d7fc675e570b5b984a3eff8249b
+  data.tar.gz: aad3e7568ca8c0b3bac6b554f285066a2744f469
 SHA512:
-  metadata.gz: 35d5bdcab041a9b256a364009acd6c161a5b8fa410321e34ce786a5bb088df387b50cf0880ddf6f01ea670a3f98559314a4a60a0761cbe69af468abb05fc3780
-  data.tar.gz: 94fa1f09dd989912a66267be23f3a510cd51878cba59e1ccc39df7239de99395b74a818ae4b10da78ebf6d32fade633b55fa00ddc5d2a300ef89bc66ed15d425
+  metadata.gz: 38a522250027c0d2f6e696f4e15fbdea713f09c79bedd89fca55fc3b18779eae95b56fa360e2d8542f6de251411176ad4376cba607a3d48e3607b4f76bc1cdb0
+  data.tar.gz: ad8bf3e76b7d185b446b8760714af39a7839f7e9bf7eee716091e356cd99b0bbaaf375fc2d00940c81e733bdb4eba37842cd3e06b503e7bc814ce92e41b5cd49

data/README.md

@@ -1,8 +1,7 @@
 # Baseapi
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/baseapi`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+When you create a web application in the rails, If you want to CRUD operations in Ajax, might this gem is useful.
+We only define the empty Controller and Model for us to define the CRUD in.
 
 ## Installation
 
@@ -22,7 +21,205 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Introduction create a BaseApiController & JBuilder of view:
+
+    $ bundle exec baseapi setup
+
+Create a Model (app/models/user.rb):
+
+    class User < ActiveRecord::Base
+    end
+
+Extend the BaseApiController is when you create a Controller (app/controllers/users_controller.rb):
+
+    class CompaniesController < BaseApiController
+    end
+
+Routing configuration (config/routes.rb):
+
+    constraints(:format => /json/) do
+      get     "users"       => "users#index"
+      get     "users/:id"   => "users#show"
+      post    "users"       => "users#create"
+      patch   "users/:id"   => "users#update"
+      put     "users/:id"   => "users#update"
+      delete  "users/:id"   => "users#destroy"
+    end
+
+Corresponding API:
+
+    /users.json	      index	   GET
+    /users/{id}.json	show     GET
+    /users.json	      create   POST
+    /users/{id}.json	update   PUT
+    /users/{id}.json	destroy  DELETE
+
+
+### Examples
+
+Model
+
+    class User < ActiveRecord::Base
+      belongs_to :company
+    end
+
+    class Company < ActiveRecord::Base
+      has_many :users
+    end
+
+Users table data
+
+| id | name     | company_id |
+|----|----------|------------|
+| 1  | arakawa  | 1          |
+| 2  | moriyuki | 2          |
+
+Company table data
+
+| id | name     |
+|----|----------|
+| 1  | Google   |
+| 2  | Apple    |
+
+#### action index
+
+Get all
+
+    GET   /users.json
+
+Specify the name
+
+    GET   /users.json?name=arakawa
+
+Specify multiple possible
+
+    GET   /users.json?name[]=arakawa&name[]=moriyuki
+
+Specify the belongs to company name
+
+    GET   /users.json?company[name]=arakawa
+
+Specify the has many users name
+
+    GET   /companies.json?user[name]=hoge
+
+#### action show
+
+Get id 1
+
+    GET   /users/1.json
+
+#### action create
+
+Create a user name is 'hoge'
+
+    POST   /users.json?name=hoge
+
+#### action update
+
+Update the name to 'huga'
+
+    PATCH  /users/1.json?name=huga
+    PUT    /users/1.json?name=huga
+
+#### action delete
+
+Delete the id to 1
+
+    DELETE /users/1.json
+
+#### return json format
+
+    {
+      error: false,
+      message: "",
+      data: [
+        {
+          id: 1,
+          name: "hoge"
+        },
+        {
+          id: 2,
+          name: "huga"
+        }
+      ]
+    }
+
+### Override
+
+You can corresponding to the logical deletion, if you want to search condition to like and or, you will be able to override the processing in the Model
+
+
+Get all
+
+    class User < ActiveRecord::Base
+      def self._all
+      end
+    end
+
+delete
+
+    class User < ActiveRecord::Base
+      def _destroy
+      end
+    end
+
+column search
+
+    class User < ActiveRecord::Base
+      def self._where(models, column, values)
+      end
+    end
+
+name column search
+
+    class User < ActiveRecord::Base
+      def self._where_name(models, column, values)
+      end
+    end
+
+belongs_to search
+
+    class User < ActiveRecord::Base
+      def self._belongs_to(models, table, hash)
+      end
+    end
+
+company belongs_to search
+
+    class User < ActiveRecord::Base
+      def self._belongs_to_company(models, table, hash)
+      end
+    end
+
+has_many search
+
+    class Company < ActiveRecord::Base
+      def self._has_many(models, table, hash)
+      end
+    end
+
+users has_many search
+
+    class Company < ActiveRecord::Base
+      def self._has_many_users(models, table, hash)
+      end
+    end
+
+
+There is a useful function for the associated table Search
+By default, it looks like the following
+'Like' search and, you can change the 'and' and 'or'
+
+    class User < ActiveRecord::Base
+      def self._belongs_to(models, table, hash)
+        relation_match(models, table, hash, operator:'or') # default is match OR
+        # relation_like(models, table, hash, operator:'or') # LIKE OR
+        # relation_like(models, table, hash, operator:'and') # LIKE AND
+      end
+    end
+
+The short so please read the [code](https://github.com/arakawamoriyuki/baseapi/blob/master/lib/baseapi/active_record/base_extension.rb) for more information
 
 ## Development
 
@@ -32,7 +229,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/baseapi/fork )
+1. Fork it ( https://github.com/arakawamoriyuki/baseapi/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)

data/lib/baseapi/active_record/base_extension.rb

@@ -18,7 +18,7 @@ module ActiveRecordBaseExtension extend ActiveSupport::Concern
     # @param    String                column    column name
     # @param    Array                 values    search values
     def _where(models, column, values)
-      model.where!(column => values)
+      models.where!(column => values)
     end
 
     # override or create method '_belongs_to_{table}' if necessary

data/lib/baseapi/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: baseapi
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Moriyuki Arakawa