mappd_rest 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 54ee288597cfd12f98eedb6fcc20ec30491688e7303f979071c4b57111d3faf6
+  data.tar.gz: fcb1dddabd63d63d890bf52262383ad808d653f2301ce56d7000895ad9343495
+SHA512:
+  metadata.gz: 79b40d18e4f6d0a8ed7f31a4956b4d1cfbd662e17df26d274fb94cfd232212fc96d0648103bb1babae367e680a8e3120e9312dc50d2880f00e541cb23fbd3ade
+  data.tar.gz: b88f37604579a9b7eaa5f5c78388113f35946c8c1590a35fb30a64728ffa7e282b80c91c07298f5e456f16fbab688eacd6137771f98822138ff8ed32da567b84

data/.gitignore

@@ -0,0 +1,3 @@
+tmp/
+.byebug_history
+db/*.db

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,15 @@
+AllCops:
+  TargetRubyVersion: 2.5
+  Exclude:
+      - 'Guardfile'
+Style/Documentation:
+  Enabled: false
+Style/FrozenStringLiteralComment:
+  Enabled: false
+Metrics/ModuleLength:
+  Exclude:
+    - "**/*_spec.rb"
+Metrics/BlockLength:
+  Exclude:
+    - "**/*_spec.rb"
+    - "lib/mappd/rest.rb"

data/Dockerfile

@@ -0,0 +1,31 @@
+FROM ruby:2.5-slim
+MAINTAINER dan@paz.am
+ENV REFRESHED_AT 2018-05-14
+
+# Install packages
+RUN apt-get update && apt-get install -y --no-install-recommends \
+    build-essential \
+    git \
+    ruby-dev \
+    libgdbm-dev \
+    libncurses5-dev \
+    libffi-dev \
+    libyaml-dev \
+    libreadline-dev \
+    sqlite3 \
+    libsqlite3-dev \
+    curl \
+    libpq-dev \
+    default-libmysqlclient-dev \
+    && rm -rf /var/lib/apt/lists/*
+
+# Setup app location
+RUN mkdir -p /app
+WORKDIR /app
+
+# Install gems
+ADD mappd_rest.gemspec /app/mappd_rest.gemspec
+ADD Gemfile /app/Gemfile
+ADD Gemfile.lock /app/Gemfile.lock
+ADD lib/ /app/lib
+RUN bundle install --jobs 4

data/Gemfile

@@ -0,0 +1,21 @@
+source 'http://rubygems.org'
+
+gem 'activerecord', '>=5.2.0'
+gem 'grape', '>=1.0.3'
+gem 'mappd'
+gem 'rake'
+gem 'sqlite3'
+
+group :development do
+  gem 'byebug'
+  gem 'guard-rspec', require: false
+  gem 'guard-rubocop', require: false
+  gem 'rubocop', require: false
+end
+
+group :test do
+  gem 'rack-test'
+  gem 'rspec'
+end
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,153 @@
+PATH
+  remote: .
+  specs:
+    mappd_rest (0.0.1)
+      activerecord (>= 5.2.0)
+      grape (>= 1.0.3)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activemodel (5.2.0)
+      activesupport (= 5.2.0)
+    activerecord (5.2.0)
+      activemodel (= 5.2.0)
+      activesupport (= 5.2.0)
+      arel (>= 9.0)
+    activesupport (5.2.0)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    arel (9.0.0)
+    ast (2.4.0)
+    axiom-types (0.1.1)
+      descendants_tracker (~> 0.0.4)
+      ice_nine (~> 0.11.0)
+      thread_safe (~> 0.3, >= 0.3.1)
+    builder (3.2.3)
+    byebug (10.0.2)
+    coderay (1.1.2)
+    coercible (1.0.0)
+      descendants_tracker (~> 0.0.1)
+    concurrent-ruby (1.0.5)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
+    diff-lcs (1.3)
+    equalizer (0.0.11)
+    ffi (1.9.23)
+    formatador (0.2.5)
+    grape (1.0.3)
+      activesupport
+      builder
+      mustermann-grape (~> 1.0.0)
+      rack (>= 1.3.0)
+      rack-accept
+      virtus (>= 1.0.0)
+    guard (2.14.2)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (>= 1.0.12, < 2.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.9.12)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-rspec (4.7.3)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
+    guard-rubocop (1.3.0)
+      guard (~> 2.0)
+      rubocop (~> 0.20)
+    i18n (1.0.1)
+      concurrent-ruby (~> 1.0)
+    ice_nine (0.11.2)
+    listen (3.1.5)
+      rb-fsevent (~> 0.9, >= 0.9.4)
+      rb-inotify (~> 0.9, >= 0.9.7)
+      ruby_dep (~> 1.2)
+    lumberjack (1.0.13)
+    mappd (0.0.3)
+      activerecord (>= 5.2.0)
+    method_source (0.9.0)
+    minitest (5.11.3)
+    mustermann (1.0.2)
+    mustermann-grape (1.0.0)
+      mustermann (~> 1.0.0)
+    nenv (0.3.0)
+    notiffany (0.1.1)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    parallel (1.12.1)
+    parser (2.5.1.0)
+      ast (~> 2.4.0)
+    powerpack (0.1.1)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rack (2.0.5)
+    rack-accept (0.4.5)
+      rack (>= 0.4)
+    rack-test (1.0.0)
+      rack (>= 1.0, < 3)
+    rainbow (3.0.0)
+    rake (12.3.1)
+    rb-fsevent (0.10.3)
+    rb-inotify (0.9.10)
+      ffi (>= 0.5.0, < 2)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    rubocop (0.56.0)
+      parallel (~> 1.10)
+      parser (>= 2.5)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.9.0)
+    ruby_dep (1.5.0)
+    shellany (0.0.1)
+    sqlite3 (1.3.13)
+    thor (0.20.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.3.2)
+    virtus (1.0.5)
+      axiom-types (~> 0.1)
+      coercible (~> 1.0)
+      descendants_tracker (~> 0.0, >= 0.0.3)
+      equalizer (~> 0.0, >= 0.0.9)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (>= 5.2.0)
+  byebug
+  grape (>= 1.0.3)
+  guard-rspec
+  guard-rubocop
+  mappd
+  mappd_rest!
+  rack-test
+  rake
+  rspec
+  rubocop
+  sqlite3
+
+BUNDLED WITH
+   1.16.1

data/Guardfile

@@ -0,0 +1,10 @@
+guard :rubocop do
+  watch(%r{.+\.rb$})
+  watch(%r{(?:.+/)?\.rubocop(?:_todo)?\.yml$}) { |m| File.dirname(m[0]) }
+end
+
+guard :rspec, cmd: 'rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end

data/Makefile

@@ -0,0 +1,12 @@
+build:
+	docker-compose build
+guard:
+	docker-compose run ruby guard
+rspec:
+	docker-compose run ruby rspec
+lint:
+	docker-compose run ruby rubocop
+bash:
+	docker-compose run ruby bash
+release:
+

data/README.md

@@ -0,0 +1,94 @@
+# MappdRest
+
+Note: Work in progress.
+
+A gem that dynamically exposes REST endpoints for ActiveRecord models.
+
+## Development
+
+### Prerequisites
+
+* Docker Community Edition - https://www.docker.com/community-edition
+* Make - https://www.gnu.org/software/make/
+
+### Setup
+
+* `make` will build the application ready for use.
+
+### Guard
+
+* `make guard` run both linting and testing whilst watching files
+
+## Setup
+
+```
+  gem install mappd-rest
+```
+
+Or add to your `Gemfile`:
+
+```
+  gem 'mappd-rest'
+```
+
+## How it works
+
+### Simple Endpoints
+
+Lets say you have two ActiveRecord models. Person and Post. By either mounting the `Mappd::Rest` class inside rails or running a `config.ru` file like below the following endpoints will be created.
+
+| METHOD | ENDPOINT |
+| --- | --- |
+| GET | /people/schema |
+| GET | /people/ |
+| GET | /people/:id |
+| POST | /people |
+| DELETE | /people/:id |
+| PUT | /people/:id |
+| GET | /post/schema |
+| GET | /post/ |
+| GET | /post/:id |
+| POST | /post |
+| DELETE | /post/:id |
+| PUT | /post/:id |
+
+### Nested Endpoints
+
+Also you can drive down into nested data. In this example lets say a Post has a Person and a Person has many Posts. It would create the following endpoints.
+
+
+| METHOD | ENDPOINT |
+| --- | --- |
+| GET | /posts/:id/person |
+| GET | /posts/:id/person/:id |
+| GET | /posts/:id/person/:id/posts |
+
+It does this by dynamically interpreting routes passed to the endpoint and calling the appropriate models and methods.
+
+### Limiting & Offsetting (Pagination)
+You can also limit and offset any call that returns a collection.
+
+`/posts?limit=10&offset=10`  
+`/person/1/posts?limit=5&offset=5`
+
+### Authorisation
+
+Before every request the API will check for a header `X-Access-Token` 
+it will then use that access token as a parameter to the authorization method you have set.
+
+```ruby
+  # config.ru
+  Mappd::Rest.auth_method = lambda { |token|
+    # Will look for a truth - You can use any method you like
+    User.find_by_token(token).active?
+    # For example - if you didnt want to do any kind of auth
+    # just return true
+  }
+  run Mappd::Rest
+```
+## Running
+
+```ruby
+  # config.ru
+  run Mappd::Rest
+```

data/docker-compose.yml

@@ -0,0 +1,11 @@
+version: '2'
+services:
+  ruby:
+    build:
+      context: .
+      dockerfile: Dockerfile
+    ports:
+      - '3000:3000'
+    volumes:
+      - .:/app
+    command: 'rackup --host 0.0.0.0 -p 3000'

data/lib/mappd/rest.rb

@@ -0,0 +1,105 @@
+module Mappd
+  class Rest < Grape::API
+    format :json
+
+    cattr_accessor :auth_method
+
+    before do
+      unless Rest.auth_method.call(request.headers['X-Access-Token'])
+        error!('Access Denied', 401)
+      end
+    end
+
+    rescue_from ActiveRecord::RecordNotFound do |e|
+      error!(e, 404)
+    end
+
+    rescue_from ActiveRecord::RecordInvalid do |e|
+      error!(e, 422)
+    end
+
+    helpers do
+      def resource
+        params[:resource].singularize.titlecase.constantize
+      end
+
+      def all
+        resource.all
+      end
+
+      def limiter(relation)
+        return relation unless relation.is_a?(ActiveRecord::Relation)
+        relation = relation.offset(params[:offset]) if params[:offset]
+        relation = relation.limit(params[:limit]) if params[:limit]
+        relation
+      end
+
+      def find
+        resource.find(params[:id])
+      end
+
+      def create!(attributes)
+        resource.create!(attributes)
+      end
+
+      def update!(attributes)
+        find.update!(attributes)
+      end
+
+      def destroy!
+        find&.destroy
+      end
+
+      def method?(param)
+        param.to_i.to_s != param
+      end
+    end
+
+    get '/:resource/schema' do
+      resource.columns.map do |column|
+        {
+          name: column.name,
+          type: column.type.to_s
+        }
+      end
+    end
+
+    params do
+      requires :resource, type: String
+      optional :id, type: Integer
+    end
+
+    get '/:resource' do
+      limiter(all)
+    end
+
+    get '/:resource/:id' do
+      find
+    end
+
+    get '/:resource/:id/*' do
+      args = params[:splat][0].split('/')
+      relation = find
+      args.each_with_index do |param, index|
+        relation = if index.even? || method?(param)
+                     relation.send(param.to_sym)
+                   else
+                     relation.find(param.to_i)
+                   end
+      end
+      limiter(relation)
+    end
+
+    post '/:resource' do
+      create!(JSON.parse(params.first[0]))
+    end
+
+    put '/:resource/:id' do
+      update!(JSON.parse(params.first[0]))
+    end
+
+    delete '/:resource/:id' do
+      destroy!
+    end
+  end
+end

data/lib/mappd/version.rb

@@ -0,0 +1,3 @@
+module MappdRest
+  VERSION = '0.0.1'.freeze
+end

data/lib/mappd_rest.rb

@@ -0,0 +1,4 @@
+require 'rubygems' unless defined?(Gem)
+require 'bundler'
+Bundler.require
+require 'mappd/rest'

data/mappd_rest.gemspec

@@ -0,0 +1,25 @@
+$LOAD_PATH.push File.expand_path('lib', __dir__)
+require 'mappd/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'mappd_rest'
+  s.version     = MappdRest::VERSION
+  s.authors     = ['Dan Watson']
+  s.email       = ['dan@paz.am']
+  s.homepage    = 'https://github.com/dan-watson/mappd-rest'
+  s.summary     = 'Mappd Rest is a microframework for exposing ActiveRecord
+  models over rest'
+  s.description = 'You can expose ActiveRecord objects over REST.'
+                  .gsub(/^ {4}/, '')
+
+  s.rubyforge_project = 'mappd_rest'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`
+                    .split("\n").map { |f| File.basename(f) }
+  s.require_paths = ['lib']
+
+  s.add_dependency 'activerecord', '>=5.2.0'
+  s.add_dependency 'grape', '>=1.0.3'
+end

data/spec/boot.rb

@@ -0,0 +1,9 @@
+require 'rubygems' unless defined?(Gem)
+require 'bundler/setup'
+Bundler.require
+require 'mappd_rest'
+
+ActiveRecord::Base.establish_connection(adapter: 'sqlite3',
+                                        database: 'db/test.db')
+
+require File.expand_path('data/data.rb', __dir__)

data/spec/crud_spec.rb

@@ -0,0 +1,114 @@
+ENV['RACK_ENV'] = 'test'
+require File.expand_path('spec_helper.rb', __dir__)
+
+require 'rack/test'
+require 'byebug'
+
+describe 'Rack Test' do
+  include Rack::Test::Methods
+
+  def app
+    Mappd::Rest.auth_method = lambda { |token|
+      # User.find_by_token(token)
+      token == 'TOKEN'
+    }
+    Mappd::Rest
+  end
+
+  context 'endpoints' do
+    before(:all) do
+      current_session.header 'X-Access-Token', 'TOKEN'
+    end
+
+    it 'returns schema for an entity' do
+      schema = JSON.parse(File.read('spec/data/book_schema.json'))
+      get '/books/schema'
+      expect(last_response).to be_ok
+      expect(JSON.parse(last_response.body)).to eq(schema)
+    end
+
+    it 'returns all for an entity' do
+      get '/books'
+      expect(last_response).to be_ok
+      expect(JSON.parse(last_response.body).length).to eq(3)
+    end
+
+    it 'returns two offset by one for an entity' do
+      get '/books?limit=2&offset=1'
+      expect(last_response).to be_ok
+      result = JSON.parse(last_response.body)
+      expect(result.length).to eq(2)
+      expect(result.map { |i| i['id'] }).to eq([2, 3])
+    end
+
+    it 'returns all from a relationship' do
+      get '/authors/1/books'
+      expect(last_response).to be_ok
+      expect(JSON.parse(last_response.body).length).to eq(2)
+    end
+
+    it 'returns all from a relationship with limits' do
+      get '/authors/1/books?limit=2&offset=1'
+      expect(last_response).to be_ok
+      expect(JSON.parse(last_response.body).length).to eq(1)
+    end
+
+    it 'returns one from relationship' do
+      get '/authors/1/books/1'
+      expect(last_response).to be_ok
+      expect(JSON.parse(last_response.body)['title'])
+        .to eq('Wind in the willows')
+    end
+
+    it 'returns one from a deeply nested relationship' do
+      get '/authors/1/books/1/author'
+      expect(last_response).to be_ok
+      expect(JSON.parse(last_response.body)['name'])
+        .to eq('Dan')
+    end
+
+    it 'returns one' do
+      get '/books/1'
+      expect(JSON.parse(last_response.body)['title'])
+        .to eq('Wind in the willows')
+    end
+
+    it 'does not return one' do
+      get '/books/600'
+      expect(last_response.status).to eq(404)
+    end
+
+    it 'creates one' do
+      post '/books', { title: 'New Book', year: 2012 }.to_json
+      expect(last_response.status).to eq(201)
+      expect(Book.find(3)).to be_present
+    end
+
+    it 'does not create one' do
+      post '/books', { title: 'New Book' }.to_json
+      expect(last_response.status).to eq(422)
+    end
+
+    it 'updates one' do
+      put '/books/1', { title: 'Updated Book', year: 2012 }.to_json
+      expect(last_response.status).to eq(200)
+      expect(Book.find(1).title).to eq('Updated Book')
+    end
+
+    it 'does not update one' do
+      put '/books/1', { title: 'Updated Book', year: nil }.to_json
+      expect(last_response.status).to eq(422)
+    end
+
+    it 'deletes one' do
+      delete '/books/1'
+      expect(last_response).to be_ok
+      expect { Book.find(1) }.to raise_error(ActiveRecord::RecordNotFound)
+    end
+
+    it 'does not delete one' do
+      delete '/books/600'
+      expect(last_response.status).to eq(404)
+    end
+  end
+end

data/spec/data/author.rb

@@ -0,0 +1,6 @@
+require 'active_record'
+
+class Author < ActiveRecord::Base
+  field :name, :string
+  has_many :books
+end

data/spec/data/book.rb

@@ -0,0 +1,9 @@
+require 'active_record'
+
+class Book < ActiveRecord::Base
+  field :title, :string
+  field :year, :integer, length: 4
+  belongs_to :author
+
+  validates :year, presence: true
+end

data/spec/data/book_schema.json

@@ -0,0 +1,18 @@
+[
+  {
+    "name":"id",
+    "type":"integer"
+  },
+  {
+    "name":"title",
+    "type":"string"
+  },
+  {
+    "name":"year",
+    "type":"integer"
+  },
+  {
+    "name":"author_id",
+    "type":"integer"
+  }
+]

data/spec/data/data.rb

@@ -0,0 +1,16 @@
+require File.expand_path('book.rb', __dir__)
+require File.expand_path('author.rb', __dir__)
+
+# Book
+
+Book.migrate!
+Author.migrate!
+Book.delete_all
+Author.delete_all
+
+author = Author.create!(name: 'Dan')
+author2 = Author.create!(name: 'James')
+
+Book.create!(title: 'Wind in the willows', year: 1911, author: author)
+Book.create!(title: 'Once upon a time', year: 1911, author: author)
+Book.create!(title: 'Not another one', year: 2012, author: author2)

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+require File.expand_path('boot.rb', __dir__)
+
+RSpec.configure do |config|
+  config.full_backtrace = false
+  config.backtrace_exclusion_patterns = [
+    /bundle/
+  ]
+
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: mappd_rest
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Dan Watson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-05-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.0
+- !ruby/object:Gem::Dependency
+  name: grape
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.3
+description: You can expose ActiveRecord objects over REST.
+email:
+- dan@paz.am
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- Dockerfile
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- Makefile
+- README.md
+- db/.gitkeep
+- docker-compose.yml
+- lib/mappd/rest.rb
+- lib/mappd/version.rb
+- lib/mappd_rest.rb
+- mappd_rest.gemspec
+- spec/boot.rb
+- spec/crud_spec.rb
+- spec/data/author.rb
+- spec/data/book.rb
+- spec/data/book_schema.json
+- spec/data/data.rb
+- spec/spec_helper.rb
+homepage: https://github.com/dan-watson/mappd-rest
+licenses: []
+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: mappd_rest
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Mappd Rest is a microframework for exposing ActiveRecord models over rest
+test_files: []