backframe 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b82eb2645a15741b2dfda3c0fea9ae60c1d90ed8
-  data.tar.gz: 32f108b39fe6a99f90b936e4d47964cf9b25f2b2
+  metadata.gz: c790128270ae83c43af08ac36a24e55aa5241b8b
+  data.tar.gz: 221387ef8f5007debad90f610d3dd2567019995f
 SHA512:
-  metadata.gz: e6176bfbbef7a17bdf19d1cefb6bd55f7b015a7b8dba667b2d89a85677612795c99c63503443f7a9874a2a2a3bc141990fa199d5d7a5db49e4623d47527142aa
-  data.tar.gz: 02130ecd29e535126f3714f75d43b78bf6ccd204399fd80c928b56a874f072c793b06bb1a854cdae6e12065cfb5467b22daf393f5dcc4cf14d5944b6243106ef
+  metadata.gz: b712a396fbf157b3b0fb6b3bd796d0711044e3d4c1814709577c9357c7bd04cf3763507b056f6e8937095d4a8e7e4370f626a6519b5b4523f29cb95b05e40afd
+  data.tar.gz: 966fe448084e3ea8841b444680f6aaa08639587ca4f6af1a87e3a6a2898750a2b6b2adc3dfa0d877e19f7305fac04b79381f33248522b0014bec85be1ba79dbe

data/README.md

@@ -1,6 +1,10 @@
 # Backframe
 
+Backframe is a library of server side bindings for building Rails backends for Reframe apps
+
 ## Development
 
     bundle install
     bundle exec rake spec
+
+

data/lib/backframe/{api → acts_as_api}/adapter.rb

@@ -1,6 +1,7 @@
 module Backframe
-  module API
+  module ActsAsAPI
     class Adapter < ActiveModel::Serializer::Adapter::Attributes
+
       attr_reader :fields, :links
 
       def initialize(serializer, options = {})
@@ -23,27 +24,28 @@ module Backframe
 
       private
 
-      def with_pagination_metadata(records)
-        {
-          records: records.map(&method(:select_fields)),
-          total_records: paginated.total_count,
-          total_pages: paginated.total_pages,
-          current_page: paginated.current_page,
-          links: links
-        }
-      end
+        def with_pagination_metadata(records)
+          {
+            records: records.map(&method(:select_fields)),
+            total_records: paginated.total_count,
+            total_pages: paginated.total_pages,
+            current_page: paginated.current_page,
+            links: links
+          }
+        end
 
-      def paginated
-        serializer.object
-      end
+        def paginated
+          serializer.object
+        end
 
-      def select_fields(object)
-        if fields.present?
-          object.select { |key, val| fields.include?(key) }
-        else
-          object
+        def select_fields(object)
+          if fields.present?
+            object.select { |key, val| fields.include?(key) }
+          else
+            object
+          end
         end
-      end
+
     end
   end
 end

data/lib/backframe/{api → acts_as_api}/errors.rb

@@ -1,5 +1,5 @@
 module Backframe
-  module API
+  module ActsAsAPI
     module Errors
       def unauthenticated_request
         error_response(:unauthenticated, 401)
@@ -24,7 +24,7 @@ module Backframe
 
         result = {
           error: {
-            message: I18n.t("backframe.api.#{code}", method: request.method),
+            message: I18n.t("backframe.acts_as_api.#{code}", method: request.method),
             status: status
           }
         }
@@ -34,7 +34,7 @@ module Backframe
 
       def resource_error_response(resource, status = 500)
         result = {
-          message: I18n.t('backframe.api.resource_error', request: request),
+          message: I18n.t('backframe.acts_as_api.resource_error', request: request),
           errors: resource.errors,
           status: status
         }

data/lib/backframe/{api → acts_as_api}/headers.rb

@@ -1,5 +1,5 @@
 module Backframe
-  module API
+  module ActsAsAPI
     module Headers
       def set_expiration_header
         headers['Last-Modified'] = Time.now.httpdate

data/lib/backframe/{api → acts_as_api}/page.rb

@@ -1,5 +1,5 @@
 module Backframe
-  module API
+  module ActsAsAPI
     module Page
       DEFAULT_PAGE = 1
       DEFAULT_PER_PAGE = 100
@@ -35,85 +35,67 @@ module Backframe
         args[:page] ||= DEFAULT_PAGE
         args[:per_page] ||= DEFAULT_PER_PAGE
 
-
-        collection = collection.page(args[:page]).per(args[:per_page])
-        fields = (args.key?(:fields)) ? args[:fields].split(',').map(&:to_sym) : serializer._attributes
+        collection = (params[:format] == 'json') ? collection.page(args[:page]).per(args[:per_page]) : collection.all
 
         respond_to do |format|
           format.json {
+            fields = (args.key?(:fields)) ? args[:fields].split(',').map(&:to_sym) : serializer._attributes
             render json: collection,
                    content_type: 'application/json',
-                   adapter: Backframe::API::Adapter,
+                   adapter: Backframe::ActsAsAPI::Adapter,
                    fields: fields,
-                   links: pagination_links(collection, args[:per_page], args[:page])
+                   links: pagination_links(collection, args[:per_page], args[:page]),
+                   status: 200
           }
           format.csv {
-            content_type = (args.key?(:plain)) ? 'text/plain' : 'text/csv'
+            fields = expand_fields(collection, serializer, fields)
+            content_type = (args.key?(:download) && args[:download] == 'false') ? 'text/plain' : 'text/csv'
             render :text => collection_to_csv(collection, serializer, fields, ","), :content_type => content_type, :status => 200
           }
           format.tsv {
-            content_type = (args.key?(:plain)) ? 'text/plain' : 'text/tab-separated-values'
+            fields = expand_fields(collection, serializer, fields)
+            content_type = (args.key?(:download) && args[:download] == 'false') ? 'text/plain' : 'text/tab-separated-values'
             render :text => collection_to_csv(collection, serializer, fields, "\t"), :content_type => content_type, :status => 200
           }
-          format.xls {
-            content_type = (args.key?(:plain)) ? 'text/xml' : 'application/xls'
-            render :text => collection_to_xls(collection, serializer, fields), :content_type => content_type, :status => 200
-          }
           format.xlsx {
-            content_type = (args.key?(:plain)) ? 'text/xml' : 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'
-            render :text => collection_to_xls(collection, serializer, fields), :content_type => content_type, :status => 200
+            fields = expand_fields(collection, serializer, fields)
+            render :text => collection_to_xls(collection, serializer, fields), :content_type => 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet', :status => 200
           }
         end
       end
 
-      def collection_to_csv(collection, serializer, fields, separator)
-        rows = []
-        line = []
-        headers = []
-        collection.each do |record|
-          headers = []
-          line = []
-          serialized = OpenStruct.new(ActiveModel::SerializableResource.new(record).as_json)
-          fields.each do |fullkey|
-            value = serialized
-            fullkey.to_s.split(".").each do |key|
-              if value.respond_to?(key)
-                value = value.send(key)
-                if value.is_a?(Time)
-                  value = value.strftime("%F %T")
-                elsif value.is_a?(Date)
-                  value = value.strftime("%F")
-                elsif value.is_a?(Hash)
-                  value = OpenStruct.new(value)
-                else
-                  value = value.to_s
-                end
-              else
-                value = nil
-              end
-            end
-            if !value.is_a?(OpenStruct)
-              headers << fullkey
-              line << value
-            end
+      def expand_fields(collection, serializer, fields)
+        if fields.present?
+          fields.split(',').map(&:to_s)
+        else
+          serialized = serializer.new(collection.first).attributes
+          flatten_hash_keys(serialized)
+        end
+      end
+
+      def flatten_hash_keys(hash, prefix = '')
+        keys = []
+        hash.each do |key, value|
+          fullkey =  (!prefix.empty?) ? "#{prefix}.#{key}" : key
+          if value.is_a?(Hash)
+            keys.concat(flatten_hash_keys(value, fullkey))
+          else
+            keys << fullkey.to_s
           end
-          rows << line.join(separator)
         end
-        rows.unshift(headers.join(separator))
-        rows.join("\n")
+        keys
       end
 
-      def collection_to_xls(collection, serializer, fields)
-        filename = SecureRandom.hex(32).to_s.upcase[0,16]
-        workbook = WriteXLSX.new(filename)
-        worksheet = workbook.add_worksheet
-        row = 0
-        col = 0
-        fields.each_with_index do |key, col|
-          worksheet.write(row, col, key)
+      def collection_to_array(collection, serializer, fields)
+        rows = []
+        cols = []
+        row = []
+        fields.each do |key|
+          row << key
         end
-        collection.all.each_with_index do |record, index|
-          row = index + 1
+        rows << row
+        collection.all.each do |record|
+          row = []
           serialized = serializer.new(record).attributes
           fields.each_with_index do |fullkey, col|
             value = serialized
@@ -133,9 +115,33 @@ module Backframe
               value = 'true'
             elsif value.is_a?(FalseClass)
               value = 'false'
+            elsif value.is_a?(NilClass)
+              value = ''
             end
-            value = (!value.is_a?(String)) ? '' : value
-            worksheet.write(row, col, value)
+            row << "#{value}"
+          end
+          rows << row
+        end
+        rows
+      end
+
+      def collection_to_csv(collection, serializer, fields, separator)
+        output = []
+        rows = collection_to_array(collection, serializer, fields)
+        rows.each do |row|
+          output << row.join(separator)
+        end
+        output.join("\n")
+      end
+
+      def collection_to_xls(collection, serializer, fields)
+        filename = SecureRandom.hex(32).to_s.upcase[0,16]
+        workbook = WriteXLSX.new(filename)
+        worksheet = workbook.add_worksheet
+        rows = collection_to_array(collection, serializer, fields)
+        rows.each_with_index do |row, i|
+          row.each_with_index do |col, j|
+            worksheet.write(i, j, col)
           end
         end
         workbook.close

data/lib/backframe/{api.rb → acts_as_api.rb}

@@ -2,13 +2,13 @@ require 'active_support'
 require 'active_support/inflector'
 require 'active_model_serializers'
 
-require 'backframe/api/adapter'
-require 'backframe/api/errors'
-require 'backframe/api/headers'
-require 'backframe/api/page'
+require 'backframe/acts_as_api/adapter'
+require 'backframe/acts_as_api/errors'
+require 'backframe/acts_as_api/headers'
+require 'backframe/acts_as_api/page'
 
 module Backframe
-  module API
+  module ActsAsAPI
     extend ActiveSupport::Concern
 
     class_methods do

data/lib/backframe/{resource → acts_as_resource}/actions.rb

@@ -1,5 +1,5 @@
 module Backframe
-  module Resource
+  module ActsAsResource
     module Actions
       module Index
         def index
@@ -15,7 +15,7 @@ module Backframe
               Activity.create!(subject: current_user, text: 'created {object1}', object1: @item)
             end
 
-            render json: @item, status: 201, adapter: Backframe::API::Adapter
+            render json: @item, status: 201, adapter: Backframe::ActsAsAPI::Adapter
           else
             resource_error_response(@item, 422)
           end
@@ -24,7 +24,7 @@ module Backframe
 
       module Show
         def show
-          render json: @item, adapter: Backframe::API::Adapter
+          render json: @item, adapter: Backframe::ActsAsAPI::Adapter
         end
       end
 
@@ -51,7 +51,7 @@ module Backframe
               Activity.create!(subject: current_user, text: 'updated {object1}', object1: @item)
             end
 
-            render json: @item, adapter: Backframe::API::Adapter
+            render json: @item, adapter: Backframe::ActsAsAPI::Adapter
           else
             resource_error_response(@item, 422)
           end
@@ -66,7 +66,7 @@ module Backframe
             records = update_all_params.map(&method(:update_record))
           end
 
-          render json: records, adapter: Backframe::API::Adapter
+          render json: records, adapter: Backframe::ActsAsAPI::Adapter
         end
 
         private

data/lib/backframe/{resource.rb → acts_as_resource.rb}

@@ -1,9 +1,9 @@
 require 'active_support'
 
-require 'backframe/resource/actions'
+require 'backframe/acts_as_resource/actions'
 
 module Backframe
-  module Resource
+  module ActsAsResource
     extend ActiveSupport::Concern
 
     class_methods do

data/lib/backframe/acts_as_status.rb

@@ -13,19 +13,29 @@ module Backframe
         field = args[0]
         arguments = args[1]
 
-        if arguments.key?(:default)
-          after_initialize :init_status, :if => Proc.new { |d| d.new_record? }
-        end
 
         if arguments.key?(:required)
+
           validates_presence_of field
+
         end
 
-        if arguments.key?(:in)
-          validates_inclusion_of field, :in => arguments[:in]
+        if arguments.key?(:default)
+
+          after_initialize "init_#{field}_status".to_sym, :if => Proc.new { |d| d.new_record? }
+
+          class_eval <<-EOV
+            def init_#{field}_status
+              self.#{field} ||= '#{arguments[:default]}'
+            end
+          EOV
+
         end
 
         if arguments.key?(:in)
+
+          validates_inclusion_of field, :in => arguments[:in]
+
           arguments[:in].each do |status|
             class_eval <<-EOV
               scope :#{status}, -> { where(:status => '#{status}') }
@@ -35,14 +45,7 @@ module Backframe
               end
             EOV
           end
-        end
 
-        if arguments.key?(:default)
-          class_eval <<-EOV
-            def init_status
-              self.#{field} ||= '#{arguments[:default]}'
-            end
-          EOV
         end
 
       end

data/lib/backframe/filter_sort.rb

@@ -8,7 +8,7 @@ module Backframe
           conditions = []
           params = []
           fields.each do |field|
-            conditions << "LOWER(#{field}::VARCHAR) LIKE ?"
+            conditions << "LOWER(\"#{self.table_name}\".\"#{field}\"::VARCHAR) LIKE ?"
             params << '%'+filters[:q].downcase+'%'
           end
           args = params.unshift(conditions.join(' OR '))
@@ -20,15 +20,23 @@ module Backframe
       def filter_range(relation, filters, start_date, end_date = nil)
         end_date ||= start_date
         if filters.key?(:start_date) && filters.key?(:end_date)
-          relation = relation.where("#{self.table_name}.#{start_date} <= ? AND #{self.table_name}.#{end_date} >= ?", filters[:end_date], filters[:start_date])
+          relation = relation.where("\"#{self.table_name}\".\"#{start_date}\" <= ? AND \"#{self.table_name}\".\"#{end_date}\" >= ?", filters[:end_date], filters[:start_date])
         end
         relation
       end
 
       def filter_boolean(relation, filters, field)
         if filters.key?(field)
-          relation = relation.where(:field => true) if filters[field] == 1
-          relation = relation.where(:field => false) if filters[field] == 0
+          relation = relation.where("\"#{self.table_name}\".\"#{field}\" = ?", true) if ["1","true"].include?(filters[field].to_s)
+          relation = relation.where("\"#{self.table_name}\".\"#{field}\" = ?", false) if ["0","false"].include?(filters[field].to_s)
+        end
+        relation
+      end
+
+      def filter_status(relation, filters, field, value)
+        if filters.key?(value)
+          relation = relation.where("\"#{self.table_name}\".\"#{field}\" = ?", value) if ["1","true"].include?(filters[value].to_s)
+          relation = relation.where("\"#{self.table_name}\".\"#{field}\" = ?", value) if ["0","false"].include?(filters[value].to_s)
         end
         relation
       end

data/lib/backframe/mime.rb

@@ -4,7 +4,6 @@ module Backframe
 
     def register_types
       ::Mime::Type.register('text/tab-separated-values', :tsv)
-      ::Mime::Type.register('application/vnd.ms-excel', :xls)
       ::Mime::Type.register('application/vnd.openxmlformats-officedocument.spreadsheetml.sheet', :xlsx)
     end
   end

data/lib/backframe/railtie.rb

@@ -1,12 +1,12 @@
 module Backframe
   class Railtie < ::Rails::Railtie
     initializer 'backframe' do |_app|
-      ActionController::Base.send(:include, Backframe::API)
-      ActionController::Base.send(:include, Backframe::Resource)
-      ActiveRecord::Base.send(:include, Backframe::FilterSort)
+      ActionController::Base.send(:include, Backframe::ActsAsAPI)
+      ActionController::Base.send(:include, Backframe::ActsAsResource)
       ActiveRecord::Base.send(:include, Backframe::ActsAsOrderable)
-      ActiveRecord::Base.send(:include, Backframe::ActsAsUser)
       ActiveRecord::Base.send(:include, Backframe::ActsAsStatus)
+      ActiveRecord::Base.send(:include, Backframe::ActsAsUser)
+      ActiveRecord::Base.send(:include, Backframe::FilterSort)
       ActiveRecord::Migration.send(:include, Backframe::Migration)
       Backframe::Mime.register_types
     end

data/lib/backframe/version.rb

@@ -1,3 +1,3 @@
 module Backframe
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

data/lib/backframe.rb

@@ -1,8 +1,9 @@
-require 'backframe/api'
 require 'backframe/mime'
-require 'backframe/resource'
+require 'backframe/acts_as_resource'
 require 'backframe/filter_sort'
 require 'backframe/acts_as_orderable'
+require 'backframe/acts_as_api'
+require 'backframe/acts_as_resource'
 require 'backframe/acts_as_status'
 require 'backframe/acts_as_user'
 require 'backframe/migration'

data/spec/backframe/{api_spec.rb → acts_as_api_spec.rb}

@@ -1,8 +1,8 @@
 require 'spec_helper'
 
-describe 'Backframe::API', type: :controller do
+describe 'Backframe::ActsAsAPI', type: :controller do
   controller do
-    include Backframe::API
+    include Backframe::ActsAsAPI
     acts_as_api
 
     def base_api_url
@@ -13,7 +13,7 @@ describe 'Backframe::API', type: :controller do
   describe 'error handlng' do
     before { get :index }
 
-    context 'resource not found' do
+    context 'acts_as_resource not found' do
       controller do
         def index
           raise ActiveRecord::RecordNotFound

data/spec/backframe/{resource_spec.rb → acts_as_resource_spec.rb}

@@ -1,9 +1,9 @@
 require 'spec_helper'
 
-describe 'Backframe::Resource', type: :controller do
+describe 'Backframe::ActsAsResource', type: :controller do
   controller do
-    include Backframe::API
-    include Backframe::Resource
+    include Backframe::ActsAsAPI
+    include Backframe::ActsAsResource
 
     acts_as_api
     acts_as_resource 'Example', allowed: [:a, :b, :c]

data/spec/spec_helper.rb

@@ -45,7 +45,7 @@ module Helpers
   end
 
   def serialize(value, opts = {})
-    opts[:adapter] ||= Backframe::API::Adapter
+    opts[:adapter] ||= Backframe::ActsAsAPI::Adapter
     ActiveModel::SerializableResource.new(value, opts).as_json
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: backframe
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Greg Kops
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-28 00:00:00.000000000 Z
+date: 2016-05-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: write_xlsx
@@ -94,23 +94,23 @@ files:
 - Rakefile
 - backframe.gemspec
 - lib/backframe.rb
+- lib/backframe/acts_as_api.rb
+- lib/backframe/acts_as_api/adapter.rb
+- lib/backframe/acts_as_api/errors.rb
+- lib/backframe/acts_as_api/headers.rb
+- lib/backframe/acts_as_api/page.rb
 - lib/backframe/acts_as_orderable.rb
+- lib/backframe/acts_as_resource.rb
+- lib/backframe/acts_as_resource/actions.rb
 - lib/backframe/acts_as_status.rb
 - lib/backframe/acts_as_user.rb
-- lib/backframe/api.rb
-- lib/backframe/api/adapter.rb
-- lib/backframe/api/errors.rb
-- lib/backframe/api/headers.rb
-- lib/backframe/api/page.rb
 - lib/backframe/filter_sort.rb
 - lib/backframe/migration.rb
 - lib/backframe/mime.rb
 - lib/backframe/railtie.rb
-- lib/backframe/resource.rb
-- lib/backframe/resource/actions.rb
 - lib/backframe/version.rb
-- spec/backframe/api_spec.rb
-- spec/backframe/resource_spec.rb
+- spec/backframe/acts_as_api_spec.rb
+- spec/backframe/acts_as_resource_spec.rb
 - spec/spec_helper.rb
 - spec/support/example.rb
 - spec/support/example_factory.rb
@@ -140,8 +140,8 @@ signing_key:
 specification_version: 4
 summary: Backframe
 test_files:
-- spec/backframe/api_spec.rb
-- spec/backframe/resource_spec.rb
+- spec/backframe/acts_as_api_spec.rb
+- spec/backframe/acts_as_resource_spec.rb
 - spec/spec_helper.rb
 - spec/support/example.rb
 - spec/support/example_factory.rb