rubyql 0.0.2 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2e001320b038e8c6316fe99ed61f706fd89027f9
-  data.tar.gz: 0024b94ff7ed2c24f1519de8458c703d0858087b
+  metadata.gz: 26b1e539c01c2707d553beb0c1fd10bfc271a49b
+  data.tar.gz: 47c5dac8de78ad8c455db1e40ae627165f321ab3
 SHA512:
-  metadata.gz: 3274005fde19a0dbcd06b3c99d4c5d8665a195772864a1ae2015178ada2c447676c6dc110f0488c9483c5bf9e737cecccde4823e7289ef587b032d7531c6dd05
-  data.tar.gz: 57ba32c92e096e0aba05fd27f60b1f1a0ae668ed4610575822f994d6f083902a4a35c708eacca2aa18eac03a03b9b3f4edb3ec5faf4e86f9f2fed0cad9dc5166
+  metadata.gz: d2945940779830138b04183096903ae176ac8cd6aad33b11a2d6e5430a6aa434f74fedc1641c7ddace655202418cf598d653cbf530b097528bd59e72c76bc44e
+  data.tar.gz: ce16ed31a0e1c905103a0e74fa7da714bdfa01a41205e6fa02c1178c9f6c56ab060f4e47b1027b25a3ba99f4a6d51e7f51835f3104f7298259097608e0472b2c

data/README.md

@@ -9,13 +9,14 @@ RubyQL loves it when its used together with ActiveRecord 🤤
 
 Example:
 ``` ruby
-  require 'rubyql'
-  
-  class UserQuery < RubyQL
-    def query
-      User.find_by(query_params).attributes
-    end
+require 'rubyql'
+
+class UserQuery < RubyQL
+  def query
+    result = User.find_by(query_params)
+    result.attributes unless result.nil?
   end
+end
 ```
 
 The class we created overwrites the query method, to provide a custom mechanism which should return a hash. `query_params` is 
@@ -23,16 +24,16 @@ the hash which holds the provided parameter, like `WHERE` in SQL.
  
 **IMPORTANT**: `.attributes` is necessary for ActiveRecord, only returning the actual hash, not the ActiveModel object.
 
-Usage:
-```
-  UserQuery.new({"firstname"=>"", "lastname"=>"", "email"=>"niklas.hanft@outlook.com"}).execute
-  => {"firstname"=>"Niklas", "lastname"=>"Hanft", "email"=>"niklas.hanft@outlook.com"}
-  
-  UserQuery.new({"lastname"=>"", "email"=>"niklas.hanft@outlook.com"}).execute
-  => {"lastname"=>"Hanft", "email"=>"niklas.hanft@outlook.com"}
-  
-  UserQuery.new({"lastname"=>"", "email"=>"", "id"=>1}).execute
-  => {"lastname"=>"Hanft", "email"=>"niklas.hanft@outlook.com", "id"=>1}
+## Usage:
+``` ruby
+UserQuery.new({"firstname"=>"", "lastname"=>"", "email"=>"niklas.hanft@outlook.com"}).execute
+=> {"firstname"=>"Niklas", "lastname"=>"Hanft", "email"=>"niklas.hanft@outlook.com"}
+
+UserQuery.new({"lastname"=>"", "email"=>"niklas.hanft@outlook.com"}).execute
+=> {"lastname"=>"Hanft", "email"=>"niklas.hanft@outlook.com"}
+
+UserQuery.new({"lastname"=>"", "email"=>"", "id"=>1}).execute
+=> {"lastname"=>"Hanft", "email"=>"niklas.hanft@outlook.com", "id"=>1}
 ```
 
 As you can see we left the wanted attributes blank, so rubyql will fill them out, if they exist.
@@ -40,59 +41,118 @@ As you can see we left the wanted attributes blank, so rubyql will fill them out
 For a better understanding another plain ruby example:
 
 ``` ruby
-  require 'rubyql
-  
-  class PlainQuery < RubyQL
-    def query
-      {"firstname"=>"Niklas", "lastname"=>"Hanft", "email"=>"niklas.hanft@outlook.com", "id"=>1337, "another_attribute"=>"Hello World"}
-    end
+require 'rubyql
+
+class PlainQuery < RubyQL
+  def query
+    {"firstname"=>"Niklas", "lastname"=>"Hanft", "email"=>"niklas.hanft@outlook.com", "id"=>1337, "another_attribute"=>"Hello World"}
   end
+end
 ```
 
 The method is only returning a simple hash. Now we can execute queries:
 
-```
-  PlainQuery.new({"firstname"=>"", "lastname"=>"", "email"=>"niklas.hanft@outlook.com", "id"=>""}).execute
-  => {"firstname"=>"Hanft", "lastname"=>"Niklas", "email"=>"niklas.hanft@outlook.com", "id"=>1337}
-  
-  PlainQuery.new({"email"=>"niklas.hanft@outlook.com", "id"=>"", "another_attribute"=>""}).execute
-  => {"email"=>"niklas.hanft@outlook.com", "id"=>1337, "another_attribute"=>"Hello World"}
+``` ruby
+PlainQuery.new({"firstname"=>"", "lastname"=>"", "email"=>"niklas.hanft@outlook.com", "id"=>""}).execute
+=> {"firstname"=>"Hanft", "lastname"=>"Niklas", "email"=>"niklas.hanft@outlook.com", "id"=>1337}
+
+PlainQuery.new({"email"=>"niklas.hanft@outlook.com", "id"=>"", "another_attribute"=>""}).execute
+=> {"email"=>"niklas.hanft@outlook.com", "id"=>1337, "another_attribute"=>"Hello World"}
 ```
 
 As this is static, it doesn't really make sense, but for understanding it might be ok to use it this way. But mainly it
 should be used with a database orm or some dynamic functions which return hashes.
 
-Advanced usage: In a Rails Project:
+## Advanced usage:
+
+A typical API in Rails
+
+``` ruby
+module Api
+  module V1
+    class UserQueryController < ApiController
+      before_action :user_params
+
+      def execute
+        render json: UserQuery.new(user_params).execute.to_json
+      end
+
+      private
 
+      def user_params
+        params.permit(:username, :firstname, :email, :id, :lastname, :posts, :created_at).to_h
+      end
+
+    end
+  end
+end
 ```
+
+The Query class
+
+``` ruby
 require 'rubyql'
 
 class UserQuery < RubyQL
   def query
-    User.find_by(query_params).attributes
+    result = User.find_by(query_params)
+    result.attributes unless result.nil?
   end
 end
 ```
 
+Routing:
+
+``` ruby
+namespace :api, defaults: { format: :json } do
+  namespace :v1 do
+    post '/user-query', to: 'user_query#execute'
+  end
+end
 ```
-irb(main):007:0> UserQuery.new({ "firstname"=>"", "id"=>1}).execute
-  User Load (0.9ms)  SELECT  "users".* FROM "users" WHERE "users"."id" = $1 LIMIT $2  [["id", 1], ["LIMIT", 1]]
-=> {"firstname"=>"Niklas", "id"=>1}
-irb(main):008:0> UserQuery.new({ "lastname"=>"", "id"=>1}).execute     
-  User Load (1.2ms)  SELECT  "users".* FROM "users" WHERE "users"."id" = $1 LIMIT $2  [["id", 1], ["LIMIT", 1]]
-=> {"lastname"=>"Hanft", "id"=>1}
-irb(main):009:0> UserQuery.new({ "lastname"=>"", "id"=>1, "email"=>""}).execute 
-  User Load (1.1ms)  SELECT  "users".* FROM "users" WHERE "users"."id" = $1 LIMIT $2  [["id", 1], ["LIMIT", 1]]
-=> {"lastname"=>"Hanft", "email"=>"niklas.hanft@outlook.com", "id"=>1}
-irb(main):010:0> UserQuery.new({ "lastname"=>"", "id"=>1, "email"=>"", "firstname"=>""}).execute
-  User Load (1.2ms)  SELECT  "users".* FROM "users" WHERE "users"."id" = $1 LIMIT $2  [["id", 1], ["LIMIT", 1]]
-=> {"firstname"=>"Niklas", "lastname"=>"Hanft", "email"=>"niklas.hanft@outlook.com", "id"=>1}
 
+A request:
+
+``` json
+POST /api/v1/user-query
+{
+	"email": "niklas.hanft@outlook.com",
+	"firstname":"",
+	"id":"",
+	"created_at":"",
+	"lastname":""
+}
 ```
-*Coming soon*
 
+The response:
 
+``` json
+{
+    "id": 1,
+    "firstname": "Niklas",
+    "lastname": "Hanft",
+    "created_at": "2017-11-21T07:10:46.953Z",
+    "email": "niklas.hanft@outlook.com"
+}
+```
+
+A second request:
 
+``` json
+POST /api/v1/user-query
+{
+	"email": "niklas.hanft@outlook.com",
+	"firstname":""
+}
+```
 
+The response:
+
+``` json
+{
+	"email": "niklas.hanft@outlook.com",
+    "firstname": "Niklas"
+}
+```
 
 

data/lib/init_error.rb

@@ -0,0 +1,2 @@
+class InitError < StandardError
+end

data/lib/rubyql.rb

@@ -1,4 +1,5 @@
 require 'json'
+require_relative './init_error'
 
 class RubyQL
   attr_accessor :params
@@ -9,30 +10,28 @@ class RubyQL
     elsif params.is_a?(Hash)
       @params = params
     else
-      raise
+      raise InitError, "Cant initialize with a #{params.class} please provide a valid JSON or Hash"
     end
   end
 
   def execute
     return {} if query.nil?
-    query.select do |key, value|
+    query.select do |key, _value|
       response_attr.key? key
     end.merge query_params
   end
 
   def query_params
-    @params.reject do |key, value|
+    @params.reject do |_key, value|
       value == '' || value.nil?
     end
   end
 
   def response_attr
-    @params.select do |key, value|
+    @params.select do |_key, value|
       value == '' || value.nil?
     end
   end
 
   def query; end
-
 end
-

data/test/user_query_spectr.rb

@@ -1,27 +1,52 @@
 require 'spectr'
 require_relative '../lib/rubyql'
+require_relative '../lib/init_error'
 
-Spectr.new.test 'Test the queryable class' do |test|
+class UserQuery < RubyQL
+  def query
+    { 'username' => 'paradoxxger',
+      'firstname' => 'Niklas',
+      'lastname' => 'Hanft',
+      'email' => 'niklas.hanft@outlook.com' }
+  end
+end
 
-  class UserQuery < RubyQL
-    def query
-      {"username"=>"paradoxxger", "firstname"=>"Niklas", "lastname"=>"Hanft", "email"=>"niklas.hanft@outlook.com"}
-    end
+Spectr.new.test 'Test the UserQuery class' do |test|
+  test.assume('The response is a hash', Hash) do
+    UserQuery.new('lastname' => '', 'email' => 'niklas.hanft@outlook.com').execute.class
+  end
+
+  assumed_result = { 'firstname' => 'Niklas', 'lastname' => 'Hanft', 'email' => 'niklas.hanft@outlook.com' }
+
+  test.assume('The response equals the given hash', assumed_result) do
+    UserQuery.new('firstname' => '', 'lastname' => '', 'email' => 'niklas.hanft@outlook.com').execute
   end
 
-  test.assume('The response is a hash', true) do
-    UserQuery.new({"firstname"=>"", "lastname"=>"", "email"=>"niklas.hanft@outlook.com"}).execute.is_a?(Hash)
+  assumed_result = { 'lastname' => 'Hanft', 'email' => 'niklas.hanft@outlook.com' }
+
+  test.assume('The response equals the given hash', assumed_result) do
+    UserQuery.new('lastname' => '', 'email' => 'niklas.hanft@outlook.com').execute
   end
 
-  test.assume('The response equals the given hash', {"firstname"=>"Niklas", "lastname"=>"Hanft", "email"=>"niklas.hanft@outlook.com"}) do
-    UserQuery.new({"firstname"=>"", "lastname"=>"", "email"=>"niklas.hanft@outlook.com"}).execute
+  test.assume('The query_params are only the email', 'email' => 'niklas.hanft@outlook.com') do
+    UserQuery.new('lastname' => '', 'email' => 'niklas.hanft@outlook.com').query_params
   end
+end
 
-  test.assume('The response equals the given hash, removing some attributes', {"lastname"=>"Hanft", "email"=>"niklas.hanft@outlook.com"}) do
-    UserQuery.new({"lastname"=>"", "email"=>"niklas.hanft@outlook.com"}).execute
+Spectr.new.test 'Test the wrong initialization of the UserQuery class' do |test|
+  test.assume('The initialization should fail with a String', InitError) do
+    begin
+      UserQuery.new('WrongAttribute')
+    rescue InitError => e
+      e.class
+    end
   end
 
-  test.assume('The query_params are only the email', {"email" => "niklas.hanft@outlook.com"}) do
-    UserQuery.new({"lastname"=>"", "email"=>"niklas.hanft@outlook.com"}).query_params
+  test.assume('The initialization should fail with an Integer', InitError) do
+    begin
+      UserQuery.new(1337)
+    rescue InitError => e
+      e.class
+    end
   end
-end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubyql
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.4
 platform: ruby
 authors:
 - Niklas Hanft
@@ -17,6 +17,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - README.md
+- lib/init_error.rb
 - lib/rubyql.rb
 - test/user_query_spectr.rb
 homepage: https://github.com/ParadoXxGER/rubyql