httpsql 0.0.1 → 0.1.0

data/README.md

@@ -1,6 +1,20 @@
 # Httpsql
 
-TODO: Write a gem description
+Httpsql is a module, designed to be included in [Active Record](http://api.rubyonrails.org/classes/ActiveRecord/Base.html) 
+models exposed by [grape](https://github.com/intridea/grape). Once the module is
+included, a given model can respond directly to query params passed to it, using
+`where_params_eq`. You can also constrain the fields returned by the model,
+using the `fields` query parameter.
+
+Httpsql uses [ARel](http://www.slideshare.net/flah00/activerecord-arel) to
+generate queries and exposes ARel's methods via query params. The supported ARel 
+methods are eq, not_eq, matches, does_not_match, gt, gteq, lt, lteq.
+
+Httpsql also generates documentaion for endpoints, which can be easily merged
+into your existing documentation (`#route_params`).
+
+Httpsql reserves one parameter, access_token. If your model has a field called
+access_token, you'll need to rename it.
 
 ## Installation
 
@@ -18,12 +32,81 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Assume you have a model, widget, whose fields are id, int_field, string_field, created_at, updated_at.
+
+    create_table "widgets", :force => true do |t|
+      t.integer  "int_field"
+      t.string   "string_field"
+      t.datetime "created_at", :null => false
+      t.datetime "updated_at", :null => false
+    end
+
+### model.rb
+
+    class Widget < ActiveRecord::Base
+      include Httpsql
+      attr_accessible :int_field, :string_field
+    end
+
+### api.rb
+
+    class Api < Grape::API
+      version 'v1'
+      logger Rails.logger
+      default_format :json
+
+      resource :widgets do
+        desc 'Get all widgets', {
+          optional_params: Widget.route_params
+        }
+        get '/' do
+          present Widget.where_params_eq(params)
+        end
+      end
+    end
+
+### config.ru
+
+    api = Rack::Builder.new do
+      run Api
+    end
+    run Rack::URLMap.new \
+      '/' => YourApp::Application,
+      '/api' => api
+
+Now you're able to run your app
+
+    rails s
+
+Query your new API
+
+    curl 'http://localhost:3000/api/v1/widgets'
+    SELECT * FROM widgets
+
+    curl 'http://localhost:3000/api/v1/widgets?id=1'
+    SELECT * FROM widgets WHERE id = 1
+
+    curl 'http://localhost:3000/api/v1/widgets?id[]=1&id[]=2'
+    SELECT * FROM widgets WHERE id IN (1,2)
+
+    curl 'http://localhost:3000/api/v1/widgets?id.gt=10&id.lt=100'
+    SELECT * FROM widgets WHERE id > 10 AND id < 100
+
+    curl 'http://localhost:3000/api/v1/widgets?id[]=1&id[]=2&created_at.gt=2013-06-01'
+    SELECT * FROM widgets WHERE id IN (1,2) AND created_at > '2013-06-01'
+
+    curl 'http://localhost:3000/api/v1/widgets?id[]=1&id[]=2&created_at.gt=2013-06-01&fields[]=id&fields[]=int_field'
+    SELECT id, int_field FROM widgets WHERE id IN (1,2) AND created_at > '2013-06-01'
+
+    curl 'http://localhost:3000/api/v1/describe_api'
+    Returns JSON describing the API
 
 ## Contributing
 
 1. Fork it
 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`)
-5. Create new Pull Request
+  * write some god damned tests
+4. Run your god damned tests (`rake test`)
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create new Pull Request

data/Rakefile

@@ -1 +1,8 @@
 require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs.push "lib"
+  t.test_files = FileList["test/*_test.rb"]
+  t.verbose = true
+end

data/httpsql.gemspec

@@ -6,11 +6,11 @@ require 'httpsql/version'
 Gem::Specification.new do |spec|
   spec.name          = "httpsql"
   spec.version       = Httpsql::VERSION
-  spec.authors       = ["Sean Shillo", "Alejandro Ciniglio"]
-  spec.email         = ["sean@adaptly.com", "alejandro@adaptly.com"]
-  spec.description   = %q{Do sql over http}
-  spec.summary       = %q{httpsql}
-  spec.homepage      = ""
+  spec.authors       = [ "Philip Champon", "Alejandro Ciniglio", "Sean Shillo" ]
+  spec.email         = [ "philip@adaptly.com", "alejandro@adaptly.com", "sean@adaptly.com" ]
+  spec.description   = %q{Expose model columns and ARel methods through query parameters in grape end points}
+  spec.summary       = %q{Select model specified fields, create arbitrary queries, all using CGI query parameters}
+  spec.homepage      = "https://github.com/Adaptly/httpsql"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files`.split($/)
@@ -20,5 +20,7 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
-  spec.add_dependency "activesupport"
+  spec.add_dependency "activerecord", ">= 3.0"
+  spec.add_dependency "grape"
+  spec.add_development_dependency "sqlite3"
 end

data/lib/httpsql.rb

@@ -1,42 +1,47 @@
 require "httpsql/version"
 
 module Httpsql
-  extend ActiveSupport::Concern
-  included do
-    class << self
-      def valid_params(params)
-        params.select{|k,v| column_names.include?(k.to_s.split('.').first)}
-      end
-
-      def where_params_eq(params={})
-
-        cond = valid_params(params).map do |k,v|
-          next if k.to_s == 'access_token' 
-          (k, m) = k.to_s.split('.')
-          if m
-            arel_table[k.to_sym].send(m.to_sym, v)
-          elsif v.respond_to?(:any?)
-            arel_table[k.to_sym].in(v)
-          else
-            arel_table[k.to_sym].eq(v)
-          end
-        end.inject{|x,y| x.and(y)}
-
-        where(cond)
-      end
+  def self.included(base)
+    base.send :extend, ClassMethods
+  end
 
-      def route_params
-        columns.inject({}) do |m,c| 
-          m[c.name] = {
-            type: c.sql_type,
-            desc: c.name,
-            primary: c.primary
-          }
-          m
+  module ClassMethods
+    def where_params_eq(params={})
+      cond = valid_params(params).map do |k,v|
+        (k, m) = k.to_s.split('.')
+        next if k.to_s == 'access_token' 
+        if m
+          arel_table[k.to_sym].send(m.to_sym, v)
+        elsif v.respond_to?(:any?)
+          arel_table[k.to_sym].in(v)
+        else
+          arel_table[k.to_sym].eq(v)
         end
-      end
+      end.inject{|x,y| x.and(y)}
 
+      ar_rel = where(cond)
+      ar_rel = ar_rel.select(params[:field]) if params[:field]
+      ar_rel
+    end
+
+    def route_params
+      columns.inject({}) do |m,c| 
+        m[c.name] = {
+          type: c.sql_type,
+          desc: c.name,
+          primary: c.primary
+        }
+        m
+      end.merge "field" => {
+        type: 'array',
+        desc: 'select fields',
+        primary: false
+      }
+    end
 
+    private
+    def valid_params(params)
+      params.select{|k,v| column_names.include?(k.to_s.split('.').first)}
     end
   end
 end

data/lib/httpsql/version.rb

@@ -1,3 +1,3 @@
 module Httpsql
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/test/httpsql_test.rb

@@ -0,0 +1,126 @@
+require 'minitest/spec'
+require 'minitest/autorun'
+require 'active_record'
+require 'httpsql'
+
+ActiveRecord::Base.configurations[:test] = {adapter:  'sqlite3', database: 'tmp/httpsql_test'}
+ActiveRecord::Base.establish_connection(ActiveRecord::Base.configurations[:test])
+ActiveRecord::Base.connection.execute %Q{ DROP TABLE IF EXISTS foo_models }
+ActiveRecord::Base.connection.execute %Q{ 
+  CREATE TABLE foo_models (
+    id integer,
+    int_field integer,
+    string_field text,
+    access_token text,
+    created_at text default CURRENT_TIMESTAMP,
+    updated_at text default CURRENT_TIMESTAMP,
+    primary key(id)
+  );
+}
+class FooModel < ActiveRecord::Base
+  include Httpsql
+  attr_accessible :int_field, :string_field, :access_token
+end
+
+def generate_models
+  FooModel.create!([
+    {int_field: 0, string_field: "zero",  access_token: "000"},
+    {int_field: 1, string_field: "one",   access_token: "111"},
+    {int_field: 2, string_field: "two",   access_token: "222"},
+    {int_field: 3, string_field: "three", access_token: "333"},
+    {int_field: 4, string_field: "four",  access_token: "444"},
+  ])
+end
+
+describe Httpsql do
+  before :each do
+    FooModel.connection.execute %Q{DELETE FROM foo_models}
+  end
+
+  it 'selects a model\'s columns from a given hash' do
+    ret = FooModel.send(:valid_params, id: 1, int_field: 2, string_field: "foo", access_token: "a", created_at: '2013-01-01T00:00:00', created_at: '2013-01-01T00:00:00', foo: :bar)
+    ret.must_equal(id: 1, int_field: 2, string_field: "foo", access_token: "a", created_at: '2013-01-01T00:00:00', created_at: '2013-01-01T00:00:00')
+  end
+
+  it 'selects all models' do
+    models = generate_models
+    FooModel.where_params_eq({}).must_equal models
+  end
+
+  it 'selects a specified array of models' do
+    models = generate_models
+    FooModel.where_params_eq("int_field" => [0, 1]).must_equal models[0..1]
+  end
+
+  it 'selects a model, using eq' do
+    models = generate_models
+    FooModel.where_params_eq("int_field.eq" => 0).must_equal [models[0]]
+  end
+
+  it 'selects models, using not_eq' do
+    models = generate_models
+    FooModel.where_params_eq("int_field.not_eq" => 0).must_equal models[1..-1]
+  end
+
+  it 'selects a model, using matches' do
+    models = generate_models
+    FooModel.where_params_eq("string_field.matches" => "%hre%").must_equal [models[3]]
+  end
+
+  it 'selects models, using does_not_match' do
+    models = generate_models
+    FooModel.where_params_eq("string_field.does_not_match" => "%ero").must_equal models[1..-1]
+  end
+  it 'selects models, using gt' do
+    models = generate_models
+    FooModel.where_params_eq("int_field.gt" => 1).must_equal models[2..-1]
+  end
+
+  it 'selects models, using gteq' do
+    models = generate_models
+    FooModel.where_params_eq("int_field.gteq" => 2).must_equal models[2..-1]
+  end
+
+  it 'select models, using lt' do
+    models = generate_models
+    FooModel.where_params_eq("int_field.lt" => 1).must_equal [models[0]]
+  end
+
+  it 'selects models, using lteq' do
+    models = generate_models
+    FooModel.where_params_eq("int_field.lteq" => 2).must_equal models[0..2]
+  end
+
+  it 'selects models, using two ARel methods' do
+    models = generate_models
+    FooModel.where_params_eq("int_field.gteq" => 1, "id.gt" => 4).must_equal [models[4]]
+  end
+
+  it 'ignores access_token' do
+    models = generate_models
+    FooModel.where_params_eq("access_token" => "111").must_equal models
+  end
+
+  it 'ignores access_token dot notation' do
+    models = generate_models
+    FooModel.where_params_eq("access_token.eq" => "111").must_equal models
+  end
+
+  it 'selects a model with specified fields' do
+    generate_models
+    model = FooModel.select([:int_field, :id]).where(int_field: 0)
+    FooModel.where_params_eq("int_field.eq" => 0, field: [:int_field, :id]).must_equal model
+  end
+
+  it 'generates the correct documentation' do
+    FooModel.route_params.must_equal({
+      "id"           => {:type => "integer", :desc => "id",            :primary => true},
+      "int_field"    => {:type => "integer", :desc => "int_field",     :primary => false},
+      "string_field" => {:type => "text",    :desc => "string_field",  :primary => false},
+      "access_token" => {:type => "text",    :desc => "access_token",  :primary => false},
+      "created_at"   => {:type => "text",    :desc => "created_at",    :primary => false},
+      "updated_at"   => {:type => "text",    :desc => "updated_at",    :primary => false},
+      "field"        => {:type => "array",   :desc => "select fields", :primary => false}}
+    )
+  end
+end

metadata

@@ -1,19 +1,22 @@
 --- !ruby/object:Gem::Specification
 name: httpsql
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
+  prerelease: 
 platform: ruby
 authors:
-- Sean Shillo
+- Philip Champon
 - Alejandro Ciniglio
+- Sean Shillo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-27 00:00:00.000000000 Z
+date: 2013-07-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -21,6 +24,7 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -28,35 +32,73 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: grape
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: Do sql over http
+description: Expose model columns and ARel methods through query parameters in grape
+  end points
 email:
-- sean@adaptly.com
+- philip@adaptly.com
 - alejandro@adaptly.com
+- sean@adaptly.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -69,28 +111,32 @@ files:
 - httpsql.gemspec
 - lib/httpsql.rb
 - lib/httpsql/version.rb
-homepage: ''
+- test/httpsql_test.rb
+homepage: https://github.com/Adaptly/httpsql
 licenses:
 - MIT
-metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.0.rc.2
+rubygems_version: 1.8.23
 signing_key: 
-specification_version: 4
-summary: httpsql
-test_files: []
+specification_version: 3
+summary: Select model specified fields, create arbitrary queries, all using CGI query
+  parameters
+test_files:
+- test/httpsql_test.rb

checksums.yaml

@@ -1,7 +0,0 @@
----
-SHA1:
-  metadata.gz: 9fd889994ae94496fde8767ceb1aeedb6bf7b580
-  data.tar.gz: 9d54f043cfac281572b16ba80d02379d142824a4
-SHA512:
-  metadata.gz: 47fd7364530a7db44688280d83c3c8f23a5f72379b9b2948abf3beb1a9f6f87b21bff82cd5fc7757362886db53ce79150ddef029b360a1268d7a8358a6c7590c
-  data.tar.gz: b7ca268a828be986d6b1186c411af54af0e4bd4b1f997a563c0abb487b827168ef1d9387d8ddc2d9072d9be4b311eb2096951887c6233ee36d6eadd2f3aba8f7