rails_api_model 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c67cac2d784871eb3d45ca5f59ea515d1b10c99c
+  data.tar.gz: 64b9ba8fe2f15ccd1c493330fa894c926dcd6c8c
+SHA512:
+  metadata.gz: 5566017449c8af453b7105cf1b93c63bf4785a31794c50fb8db6afbe0552d60e1124cb08dc1df277ba95b2b149534b663c337681987cb400b2a9be1b3f9818ff
+  data.tar.gz: c3f68e911ca3ca26035ac95e391f9d2566ad165d3508f014fc55c4c486cfd230ae1b4a12d85671712ee6d38d230cd85de3610314ca85dc4d23e9a50408f0b726

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.10.6

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rails_api_model.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Georgy Angelov
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,41 @@
+# RailsApiModel
+
+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/rails_api_model`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rails_api_model'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rails_api_model
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/rails_api_model.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,19 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+task :environment do
+  $LOAD_PATH.unshift File.expand_path('../lib', __FILE__)
+  require 'rails_api_model'
+
+  include RailsApiModel
+end
+
+task console: :environment do
+  require 'pry'
+
+  Pry.start
+end

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/rails_api_model.rb

@@ -0,0 +1,19 @@
+require 'active_support/concern'
+require 'active_support/core_ext/class/attribute'
+require 'active_support/core_ext/array/wrap'
+require 'active_support/time_with_zone'
+require 'active_support/lazy_load_hooks'
+
+require 'active_record'
+
+require 'rails_api_model/version'
+require 'rails_api_model/error'
+require 'rails_api_model/filter_error'
+require 'rails_api_model/filters'
+require 'rails_api_model/builders/filters/active_record_model'
+require 'rails_api_model/builders/filters/allow_fields'
+require 'rails_api_model/base'
+
+module RailsApiModel
+
+end

data/lib/rails_api_model/base.rb

@@ -0,0 +1,11 @@
+module RailsApiModel
+  class Base
+    class_attribute :ar_model
+
+    include Filters
+    include Builders::Filters::AllowFields
+    include Builders::Filters::ActiveRecordModel
+
+    ActiveSupport.run_load_hooks(:rails_api_model, self)
+  end
+end

data/lib/rails_api_model/builders/filters/active_record_model.rb

@@ -0,0 +1,19 @@
+module RailsApiModel
+  module Builders
+    module Filters
+      module ActiveRecordModel
+        extend ActiveSupport::Concern
+
+        module ClassMethods
+          def active_record_model(model)
+            unless model < ActiveRecord::Base
+              raise ArgumentError, 'The specified class is not an ActiveRecord model'
+            end
+
+            self.ar_model = model
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rails_api_model/builders/filters/allow_fields.rb

@@ -0,0 +1,19 @@
+module RailsApiModel
+  module Builders
+    module Filters
+      module AllowFields
+        extend ActiveSupport::Concern
+
+        module ClassMethods
+          def allow_fields(*field_names)
+            raise ArgumentError, 'You need to specify at least one field name' if field_names.empty?
+
+            filters = field_names.map { |field_name| ::Filters::Field.new(self, field_name) }
+
+            ::Filters.add_filters(self, filters)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rails_api_model/error.rb

@@ -0,0 +1,4 @@
+module RailsApiModel
+  class Error < StandardError
+  end
+end

data/lib/rails_api_model/filter_error.rb

@@ -0,0 +1,4 @@
+module RailsApiModel
+  class FilterError < Error
+  end
+end

data/lib/rails_api_model/filters.rb

@@ -0,0 +1,17 @@
+require 'rails_api_model/filters/base_filter'
+require 'rails_api_model/filters/field'
+
+module RailsApiModel
+  module Filters
+    extend ActiveSupport::Concern
+
+    included do
+      class_attribute :filters
+      self.filters = []
+    end
+
+    def self.add_filters(model, filters)
+      model.filters += Array.wrap(filters)
+    end
+  end
+end

data/lib/rails_api_model/filters/base_filter.rb

@@ -0,0 +1,27 @@
+module RailsApiModel
+  module Filters
+    class BaseFilter
+      attr_reader :api_model, :filter_key
+
+      def initialize(api_model, filter_key)
+        @api_model = api_model
+        @filter_key = filter_key
+      end
+
+      def apply_scope(relation, key, value)
+        raise 'Not implemented in the base class'
+      end
+
+      def ==(other)
+        api_model  == other.api_model  &&
+        filter_key == other.filter_key
+      end
+
+      alias_method :eql?, :==
+
+      def ar_model
+        api_model.ar_model
+      end
+    end
+  end
+end

data/lib/rails_api_model/filters/field.rb

@@ -0,0 +1,55 @@
+module RailsApiModel
+  module Filters
+    # TODO: Check whether the ActiveRecord model has the specified field
+    class Field < BaseFilter
+      def apply_scope(relation, key, value)
+        key, modifier = key.split(':'.freeze, 2)
+        value = transform_type(value)
+        column = activerecord_model.arel_table[key]
+
+        relation.where case modifier
+                       when nil          then column.eq(value)
+                       when 'not'.freeze then column.not_eq(value)
+                       when 'lt'.freeze  then column.lt(value)
+                       when 'lte'.freeze then column.lteq(value)
+                       when 'gt'.freeze  then column.gt(value)
+                       when 'gte'.freeze then column.gteq(value)
+                       # TODO: Handle this error via Rails and send 400
+                       else raise FilterError.new("Invalid modifier #{modifier}")
+                       end
+      end
+
+      private
+
+      def transform_type(value)
+        column_type = activerecord_model.columns_hash[filter_key].type
+
+        # TODO: Verify all of these types actually exist
+        # TODO: Support range queries with some syntax.
+        #       Maybe `start_time:gt=2015-11-03&start_time:lt=2015-12-19`
+        # TODO: Support enum values as strings
+        # TODO: Support `LIKE` queries?
+        case column_type
+        when :string, :text then value
+        # TODO: Add validation and raise error instead of silently discarding non-numbers
+        when :primary_key, :integer then value.to_i
+        when :float, :decimal then value.to_f
+        # TODO: Smarter date parsing. Passing the date `2015-11-03` should actually
+        #       make a range query `column >= 2015-11-03 and column < 2015-11-04`.
+        # TODO: Catch ArgumentError for invalid dates and reraise as Rails error
+        when :datetime then Time.zone.parse(value)
+        when :boolean then to_boolean(value)
+        else raise "Unsupported filter on column type #{column_type}"
+        end
+      end
+
+      def to_boolean(value)
+        case value
+        # `true` is supported for arguments passed during testing
+        when true, 'true'.freeze, 't'.freeze, '1'.freeze then true
+        else false
+        end
+      end
+    end
+  end
+end

data/lib/rails_api_model/version.rb

@@ -0,0 +1,3 @@
+module RailsApiModel
+  VERSION = '0.0.1'
+end

data/rails_api_model.gemspec

@@ -0,0 +1,28 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'rails_api_model/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'rails_api_model'
+  spec.version       = RailsApiModel::VERSION
+  spec.authors       = ['Georgy Angelov']
+  spec.email         = ['georgyangelov@gmail.com']
+
+  spec.summary       = 'A better way to do RESTful APIs in Rails'
+  spec.homepage      = 'https://github.com/stormbreakerbg/rails_api_model'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'pry'
+
+  spec.add_dependency 'activerecord'
+  spec.add_dependency 'activesupport'
+end

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification
+name: rails_api_model
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Georgy Angelov
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-12-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- georgyangelov@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/setup
+- lib/rails_api_model.rb
+- lib/rails_api_model/base.rb
+- lib/rails_api_model/builders/filters/active_record_model.rb
+- lib/rails_api_model/builders/filters/allow_fields.rb
+- lib/rails_api_model/error.rb
+- lib/rails_api_model/filter_error.rb
+- lib/rails_api_model/filters.rb
+- lib/rails_api_model/filters/base_filter.rb
+- lib/rails_api_model/filters/field.rb
+- lib/rails_api_model/version.rb
+- rails_api_model.gemspec
+homepage: https://github.com/stormbreakerbg/rails_api_model
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: A better way to do RESTful APIs in Rails
+test_files: []