backframe 0.0.49 → 1.0.0

data/Gemfile

@@ -2,16 +2,12 @@ source 'https://rubygems.org'
 
 gemspec
 
-gem 'activesupport'
-gem 'write_xlsx'
-gem 'active_model_serializers'
-gem 'activerecord'
-gem 'factory_girl'
-gem 'faker'
-gem 'kaminari'
-gem 'rails'
-gem 'rake'
-gem 'rspec-rails'
-gem 'sqlite3'
-gem 'liquid'
-gem 'phony'
+group :development, :test do
+  gem 'rake'
+  gem 'rspec', '>= 2.0'
+  gem 'rspec-benchmark'
+  gem "codeclimate-test-reporter", require: nil
+  gem 'rubocop'
+  gem 'sqlite3'
+  gem 'roo', '~> 2.4.0'
+end

data/README.md

@@ -1,10 +1,139 @@
 # Backframe
+Backframe introduces a collection of new core objects to help you write testable
+APIs for your Rails and Ruby Applications.
 
-Backframe is a library of server side bindings for building Rails backends for Reframe apps
+<table>
+  <tr>
+    <td>Build Status</td>
+    <td>
+      <a href="https://circleci.com/gh/thinktopography/backframe">
+        <img src="https://img.shields.io/circleci/project/thinktopography/backframe.svg?maxAge=600" alt="Build Status" >
+      </a>
+    </td>
+  </tr>
+  <tr>
+    <td>Code Quality</td>
+    <td>
+      <a href="https://codeclimate.com/github/thinktopography/backframe">
+        <img src="https://img.shields.io/codeclimate/github/thinktopography/backframe.svg?maxAge=600" alt="Code Climate" />
+      </a>
+      <a href="https://codeclimate.com/github/thinktopography/backframe/coverage">
+        <img src="https://img.shields.io/codeclimate/coverage/github/thinktopography/backframe.svg?maxAge=600" alt="Code Coverage" />
+      </a>
+    </td>
+  </tr>
+</table>
 
-## Development
+## API Controllers
+Backframe Controllers are just like regular controllers in Rails. Here's an
+example of how you might use Backframe objects to fulfill requests:
 
-    bundle install
-    bundle exec rake spec
+```Ruby
+class API::ContactsController < API::ApplicationController
 
+  def index
+    contacts = ContactQuery.perform(Contact, request.query_parameters)
+    render Backframe::Response.render(contacts, params)
+  end
 
+  def show
+    contact = Contact.find(params[:id])
+    render json: contact, status: 200
+  end
+
+  def create
+    result = CreateContactService.perform(params)
+    if result.success?
+      render json: result.contact, status: 201
+    else
+      render json: { message: result.message, errors: result.errors }, status: 422
+    end
+  end
+
+  def update
+    result = UpdateContactService.perform(params)
+    if result.success?
+      render json: result.contact, status: 201
+    else
+      render json: { message: result.message, errors: result.errors }, status: 422
+    end
+  end
+
+  def destroy
+    result = DestroyContactService.perform(params)
+    if result.success?
+      render json: result.contact, status: 201
+    else
+      render json: { message: result.message, errors: result.errors }, status: 422
+    end
+  end
+
+end
+```
+
+##Query Objects
+Backframe adds query objects to your application which can be placed in the
+`app/queries` directory. These objects extend from `Backframe::Query` and enable
+you to encapsulate and test your sorting and filtering logic.
+
+```Ruby
+class ContactQuery < Backframe::Query
+
+  def filter(records, filters)
+    records = records.where('LOWER(first_name) like ?', '%'+filters[:first_name].downcase+'%') if filters.key?(:first_name)
+    records = records.where('LOWER(last_name) like ?', '%'+filters[:last_name].downcase+'%') if filters.key?(:last_name)
+    records = records.where('LOWER(email) like ?', '%'+filters[:email].downcase+'%') if filters.key?(:email)
+    records
+  end
+
+  def sort(sorts)
+    records = records.order(sorts)
+    records
+  end
+
+end
+```
+
+##Service Objects
+Backframe adds service objects to your application which can be placed in the
+`app/services` directory. These objects extend from `Backframe::Service` and
+enable you to abandon callbacks in favor of the service pattern.
+
+```Ruby
+class CreateContactService < Backframe::Service
+
+  def initialize(params)
+    @params = params
+  end
+
+  def perform
+    create_contact
+    log_activity
+    send_email
+  end
+
+  def create_contact
+    ...
+  end
+
+  def log_activity
+    ...
+  end
+
+  def send_email
+    ...
+  end
+
+end
+```
+
+##Serialization
+Backframe lets you serialize your data in several formats - JSON, XML, XLS, CSV,
+and TSV. The library provides response adapters for each target serialization
+format
+
+## Author & Credits
+Backframe was originally written by [Greg Kops](https://github.com/mochini) and
+[Scott Nelson](https://github.com/scttnlsn) based upon their work at
+[Think Topography](http://thinktopography.com). Backframe has been used in
+production to support a handful of client applications.

data/Rakefile

@@ -1,14 +1,10 @@
 $LOAD_PATH.unshift File.expand_path("../lib", __FILE__)
-require 'rspec/core/rake_task'
 require 'bundler/version'
 require './lib/backframe'
 require './lib/backframe/version'
+require 'rspec/core/rake_task'
 
-RSpec::Core::RakeTask.new(:spec) do |t|
-  t.rspec_opts = ['--color']
-end
-
-task default: :spec
+RSpec::Core::RakeTask.new(:spec)
 
 desc "Build the gem"
 task :build do
@@ -23,4 +19,4 @@ end
 desc "Build and release the gem"
 task :release => :build do
   system "gem push backframe-#{Backframe::VERSION}.gem"
-end
+end

data/backframe.gemspec

@@ -5,21 +5,20 @@ require 'backframe/version'
 
 Gem::Specification.new do |gem|
   gem.name          = 'backframe'
-  gem.email         = 'hello@thinktopography.com'
-  gem.description   = 'Rails bindings for Reframe'
+  gem.email         = 'greg@thinktopography.com'
+  gem.description   = 'A collection of core objects for writing testable APIs'
+  gem.homepage      = 'https://github.com/thinktopography/backframe'
   gem.version       = Backframe::VERSION
-  gem.summary       = 'Backframe'
-  gem.authors       = ['Greg Kops', 'Scott Nelson']
-
+  gem.summary       = 'backframe'
+  gem.authors       = ['Greg Kops']
   gem.files         = `git ls-files`.split($/)
+  gem.license       = 'MIT'
   gem.executables   = gem.files.grep(%r{^bin/}).map { |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
-
-  gem.add_runtime_dependency 'write_xlsx', '~> 0.83.0'
-  gem.add_runtime_dependency 'phony', '~> 2.15.21'
-  gem.add_runtime_dependency 'activerecord', '~> 4.0'
+  gem.add_development_dependency 'rake'
   gem.add_runtime_dependency 'activesupport', '~> 4.0'
-  gem.add_runtime_dependency 'active_model_serializers', '>= 0.10.0.rc4'
-  gem.add_runtime_dependency 'kaminari', '~> 0.16'
+  gem.add_runtime_dependency 'activerecord', '~> 4.2'
+  gem.add_runtime_dependency 'active_model_serializers', '~> 0.10.0'
+  gem.add_runtime_dependency 'write_xlsx', '~> 0.83.0'
 end

data/circle.yml

@@ -1,8 +1,11 @@
 machine:
   ruby:
     version: 2.2.2
+database:
+  override:
+    - echo null
 deployment:
-  production:
+  release:
     branch: release
     commands:
-      - cd ~/backframe; bundle exec rake release
+      - cd ~/backframe; bundle exec rake release

data/lib/backframe.rb

@@ -1,46 +1,33 @@
 # encoding: utf-8
 
+require 'active_support'
+require 'active_support/core_ext'
 require 'active_record'
-require 'active_record/version'
-require 'active_support/core_ext/module'
-require 'liquid'
+require 'active_model_serializers'
+require 'write_xlsx'
 
-require 'backframe/actioncontroller/acts_as_activation'
-require 'backframe/actioncontroller/acts_as_api'
-require 'backframe/actioncontroller/acts_as_reset'
-require 'backframe/actioncontroller/acts_as_resource'
-require 'backframe/actioncontroller/acts_as_session'
-require 'backframe/activerecord/acts_as_activable'
-require 'backframe/activerecord/acts_as_distinct'
-require 'backframe/activerecord/acts_as_enum'
-require 'backframe/activerecord/acts_as_orderable'
-require 'backframe/activerecord/acts_as_percent'
-require 'backframe/activerecord/acts_as_phone'
-require 'backframe/activerecord/acts_as_user'
-require 'backframe/activerecord/default_values'
-require 'backframe/activerecord/filter_sort'
-require 'backframe/activerecord/migration'
-require 'backframe/models/activity'
-require 'backframe/models/activation'
-require 'backframe/models/reset'
-require 'backframe/models/story'
-require 'backframe/serializers/activity_serializer'
-require 'backframe/image_cache/image_cache'
+require 'backframe/query'
+require 'backframe/query/sort'
 
-module Backframe
-
-  extend ActiveSupport::Autoload
+require 'backframe/response'
+require 'backframe/response/adapter/csv'
+require 'backframe/response/adapter/json'
+require 'backframe/response/adapter/xlsx'
+require 'backframe/response/adapter/xml'
+require 'backframe/response/collection'
+require 'backframe/response/fields'
+require 'backframe/response/record'
 
-  autoload :Activity
-  autoload :Activation
-  autoload :Reset
+require 'backframe/service'
+require 'backframe/service/result/base'
+require 'backframe/service/result/failure'
+require 'backframe/service/result/success'
 
-  module Exceptions
-    class Unauthenticated < StandardError; end
-    class Unauthorized < StandardError; end
-  end
+ActiveModelSerializers.logger = nil
 
+module Backframe
 end
+
 if defined? Rails
   require 'backframe/mime'
   require 'backframe/railtie'

data/lib/backframe/mime.rb

@@ -1,12 +1,16 @@
 # encoding: utf-8
 
 module Backframe
+
   module Mime
+
     extend self
 
     def register_types
       ::Mime::Type.register('text/tab-separated-values', :tsv)
       ::Mime::Type.register('application/vnd.openxmlformats-officedocument.spreadsheetml.sheet', :xlsx)
     end
+
   end
+
 end

data/lib/backframe/query.rb

@@ -0,0 +1,48 @@
+# encoding: utf-8
+
+module Backframe
+
+  class Query
+
+    EXCLUDE_IDS_REGEX = /^[\d,]*$/
+    SORT_REGEX = /^[\w\_\-,]*$/
+
+    class << self
+
+      def perform(*args)
+        new.perform(*args)
+      end
+
+    end
+
+    def perform(records, params = {})
+      filters = params.except([:exclude_ids,:fields,:page,:per_page,:sort])
+      if filters.any?
+        records = filter(records, filters)
+      end
+      if params.key?(:exclude_ids) && params[:exclude_ids] =~ EXCLUDE_IDS_REGEX
+        table = records.arel_table.name
+        records = records.where('"'+table+'"."id" NOT IN (?)', params[:exclude_ids].split(","))
+      end
+      if params.key?(:sort) && params[:sort] =~ SORT_REGEX
+        sorts = Backframe::Query::Sort.parse(params[:sort])
+        records = sort(records, sorts)
+      end
+      records
+    end
+
+    def filter(records, _filters)
+      records
+    end
+
+    def sort(records, sorts)
+      order = []
+      sorts.each do |sort|
+        order << sort[:key] + " " + sort[:order]
+      end
+      records.order(order.join(", "))
+    end
+
+  end
+
+end

data/lib/backframe/query/sort.rb

@@ -0,0 +1,29 @@
+# encoding: utf-8
+
+module Backframe
+
+  class Query
+
+    class Sort
+
+      class << self
+
+        def parse(sort_string = nil)
+          sort = []
+          sort_string ||= '-created_at'
+          sort_string.split(',').each do |token|
+            token.strip!
+            key = (token[0] == '-') ? token[1..-1] : token
+            order = (token[0] == '-') ? 'DESC' : 'ASC'
+            sort << { key: key, order: order }
+          end
+          sort
+        end
+
+      end
+
+    end
+
+  end
+
+end

data/lib/backframe/railtie.rb

@@ -3,22 +3,7 @@
 module Backframe
   class Railtie < ::Rails::Railtie
     initializer 'backframe' do |_app|
-      ActionController::Base.send(:include, Backframe::ActsAsAPI)
-      ActionController::Base.send(:include, Backframe::ActsAsResource)
-      ActionController::Base.send(:include, Backframe::ActsAsActivation)
-      ActionController::Base.send(:include, Backframe::ActsAsReset)
-      ActionController::Base.send(:include, Backframe::ActsAsSession)
-      ActiveRecord::Base.send(:include, Backframe::ActsAsActivable)
-      ActiveRecord::Base.send(:include, Backframe::ActsAsDistinct)
-      ActiveRecord::Base.send(:include, Backframe::ActsAsEnum)
-      ActiveRecord::Base.send(:include, Backframe::ActsAsOrderable)
-      ActiveRecord::Base.send(:include, Backframe::ActsAsPercent)
-      ActiveRecord::Base.send(:include, Backframe::ActsAsPhone)
-      ActiveRecord::Base.send(:include, Backframe::ActsAsUser)
-      ActiveRecord::Base.send(:include, Backframe::DefaultValues)
-      ActiveRecord::Base.send(:include, Backframe::FilterSort)
-      ActiveRecord::Migration.send(:include, Backframe::Migration)
       Backframe::Mime.register_types
     end
   end
-end
+end

data/lib/backframe/response.rb

@@ -0,0 +1,60 @@
+# encoding: utf-8
+
+module Backframe
+
+  class Response
+
+    FIELDS_REGEX = /^[A-Za-z0-9\_,]*$/
+    PAGE_REGEX = /^[0-9]*$/
+
+    class << self
+
+      def render(records, params = {})
+        begin
+          fields = Backframe::Response::Fields.new(records, params[:fields])
+          collection = Backframe::Response::Collection.new(records, params[:page], params[:per_page])
+          if params[:format] == 'json'
+            data = Backframe::Response::Adapter::Json.render(collection, fields)
+            success(json: data, content_type: 'application/json')
+          elsif params[:format] == 'xml'
+            data = Backframe::Response::Adapter::Xml.render(collection, fields)
+            success(xml: data, content_type: 'application/xhtml+xml')
+          elsif params[:format] == 'csv'
+            data = Backframe::Response::Adapter::Csv.render(collection, fields, ",")
+            success(text: data, content_type: 'text/plain')
+          elsif params[:format] == 'tsv'
+            data = Backframe::Response::Adapter::Csv.render(collection, fields, "\t")
+            success(text: data, content_type: 'text/plain')
+          elsif params[:format] == 'xlsx'
+            data = Backframe::Response::Adapter::Xlsx.render(collection, fields)
+            success(text: data, content_type: 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet')
+          else
+            failure('Unknown Format', 404)
+          end
+        rescue Exception => e
+          failure('Application Error', 500)
+        end
+      end
+
+      def success(*response)
+        response[0].merge(status: 200)
+      end
+
+      def failure(message, status)
+        {
+          json: {
+            error: {
+              message: message,
+              status: status
+            }
+          },
+          content_type: 'application/json',
+          status: status
+        }
+      end
+
+    end
+
+  end
+
+end