rubyql 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7ebe793cb41788c0005aea403a8163ee8e1a3d5e
-  data.tar.gz: 6c055b0202a59cb35f06db26d906dc3ac37f631d
+  metadata.gz: 2e001320b038e8c6316fe99ed61f706fd89027f9
+  data.tar.gz: 0024b94ff7ed2c24f1519de8458c703d0858087b
 SHA512:
-  metadata.gz: a97cc880a462bbb7474d01d6279b51c198af8e1aa9bb2f2c904ccfa0034f961c6bf61c637bc9ae93d7c9175dafa5dc6581ec2e880340e5f54c29d0d12ca85f84
-  data.tar.gz: 9a3c8cf06369b801006ca7601546b7575bcc67281e7a6c068893964296353cc8d677a8cf4f5cb9dda2c867458e9ead26c94e435f568286eadd4b0c3bf54b9905
+  metadata.gz: 3274005fde19a0dbcd06b3c99d4c5d8665a195772864a1ae2015178ada2c447676c6dc110f0488c9483c5bf9e737cecccde4823e7289ef587b032d7531c6dd05
+  data.tar.gz: 57ba32c92e096e0aba05fd27f60b1f1a0ae668ed4610575822f994d6f083902a4a35c708eacca2aa18eac03a03b9b3f4edb3ec5faf4e86f9f2fed0cad9dc5166

data/README.md

@@ -1,6 +1,8 @@
 # RubyQL
 ## A query language for ruby hashes
 
+[![Gem Version](https://badge.fury.io/rb/rubyql.svg)](https://badge.fury.io/rb/rubyql)
+
 RubyQL is a query language designed for very flexible rest apis or plain ruby hashes.
 
 RubyQL loves it when its used together with ActiveRecord 🤤
@@ -60,8 +62,33 @@ The method is only returning a simple hash. Now we can execute queries:
 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:
+Advanced usage: In a Rails Project:
+
+```
+require 'rubyql'
 
+class UserQuery < RubyQL
+  def query
+    User.find_by(query_params).attributes
+  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}
+
+```
 *Coming soon*
 
 

data/lib/rubyql.rb

@@ -1,15 +1,20 @@
+require 'json'
+
 class RubyQL
   attr_accessor :params
 
-  def initialize(params, json = false)
-    if json
+  def initialize(params)
+    if params.is_a?(JSON)
       @params = JSON.parse(params)
-    else
+    elsif params.is_a?(Hash)
       @params = params
+    else
+      raise
     end
   end
 
   def execute
+    return {} if query.nil?
     query.select do |key, value|
       response_attr.key? key
     end.merge query_params

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubyql
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Niklas Hanft