fulcrum 0.1.2

data/lib/fulcrum/member.rb

@@ -0,0 +1,16 @@
+module Fulcrum
+  class Member < Api
+
+    class << self
+
+      def all(opts = {})
+        params = parse_opts([:page], opts)
+        call(:get, 'members.json', params)
+      end
+
+      def find(id)
+        call(:get, "members/#{id}.json")
+      end
+    end
+  end
+end

data/lib/fulcrum/photo.rb

@@ -0,0 +1,36 @@
+module Fulcrum
+  class Photo < Api
+
+    ALLOWED_FORMATS = %w(json image)
+
+    class << self
+
+      def find(id, opts = {})
+        format = image_opts(opts)
+        call(:get, "photos/#{id}.#{format}")
+      end
+
+      def thumbnail(id, opts = {})
+        format = image_opts(opts)
+        call(:get, "photos/#{id}/thumbnail.#{format}")
+      end
+
+      def create(file, content_type, id, label = '')
+        photo = Faraday::UploadIO.new(file, content_type)
+        call(:post, 'photos.json', { photo: { file: photo, access_key: id, label: label}})
+      end
+
+      def delete(id)
+        call(:delete, "photos/#{id}.json")
+      end
+
+      def image_opts(opts = {})
+        opts = opts.with_indifferent_access
+        format = opts.delete(:format) || 'json'
+        raise ArgumentError, "#{format} is not an allowed format, use either 'json' or 'image'" unless ALLOWED_FORMATS.include?(format)
+        format = "jpg" if format == 'image'
+        format
+      end
+    end
+  end
+end

data/lib/fulcrum/record.rb

@@ -0,0 +1,38 @@
+module Fulcrum
+  class Record < Api
+
+    class << self
+
+      def all(opts = {})
+        params = parse_opts([:page, :form_id, :bounding_box, :updated_since], opts)
+        call(:get, 'records.json', params)
+      end
+
+      def find(id)
+        call(:get, "records/#{id}.json")
+      end
+
+      def create(record)
+        validation = RecordValidator.new(record)
+        if validation.valid?
+          call(:post, 'records.json', record)
+        else
+          { error: { validation: validation.errors } }
+        end
+      end
+
+      def update(id, record)
+        validation = RecordValidator.new(record)
+        if validation.valid?
+          call(:put, "records/#{id}.json", record)
+        else
+          { error: { validation: validation.errors } }
+        end
+      end
+
+      def delete(id)
+        call(:delete, "records/#{id}.json")
+      end
+    end
+  end
+end

data/lib/fulcrum/validators/base_validator.rb

@@ -0,0 +1,31 @@
+require 'active_support/core_ext/hash'
+
+module Fulcrum
+  class BaseValidator
+    attr_accessor :data
+    attr_accessor :errors
+
+    def initialize(data)
+      @data = (data.is_a?(Hash) ? data : JSON.parse(data)).with_indifferent_access
+      @errors = {}
+      validate!
+    end
+
+    def valid?
+      errors.empty?
+    end
+
+    def add_error(key, data_name, error)
+      if errors.has_key?(key)
+        if errors[key].has_key?(data_name)
+          errors[key][data_name].push(error)
+        else
+          errors[key][data_name] = [error]
+        end
+      else
+        errors[key] = {}
+        errors[key][data_name] = [error]
+      end
+    end
+  end
+end

data/lib/fulcrum/validators/choice_list_validator.rb

@@ -0,0 +1,30 @@
+module Fulcrum
+  class ChoiceListValidator < BaseValidator
+
+    def validate!
+      if data['choice_list'].kind_of?(Hash) && !data['choice_list'].blank?
+        add_error('choice_list', 'name', 'must not be blank') if data['choice_list']['name'].blank?
+        choices(data['choice_list']['choices'])
+      else
+        @errors['choice_list'] = ['must be a non-empty hash']
+      end
+      return valid?
+    end
+    
+    def choices(elements)
+      if elements.kind_of?(Array) && !elements.empty?
+        elements.each do |choice|
+          if choice.blank?
+            add_error('choices', 'choice', 'cannot be empty')
+          else
+            if choice['label'].blank?
+              add_error('choice', 'label', 'is required')
+            end
+          end
+        end
+      else
+        add_error('choice_list', 'choices', 'must be a non-empty array')
+      end
+    end
+  end
+end

data/lib/fulcrum/validators/classification_set_validator.rb

@@ -0,0 +1,38 @@
+module Fulcrum
+  class ClassificationSetValidator < BaseValidator
+
+    def validate!
+      if data['classification_set']
+        add_error('classification_set', 'name', 'cannot be blank') if data['classification_set']['name'].blank?
+
+        if data['classification_set']['items'].blank? || !data['classification_set']['items'].kind_of?(Array)
+          add_error('classification_set', 'items', 'must be a non-empty array')
+        else
+          items(data['classification_set']['items'])
+        end
+      else
+        @errors['classification_set'] = ['must exist and not be blank']
+      end
+      return valid?
+    end
+    
+    def items(elements, child = false)
+      parent, child = child ? ['child_classification', 'item'] : ['items', 'item']
+      if elements.kind_of?(Array) && !elements.empty?
+        elements.each do |element|
+          if element.blank?
+            add_error(parent, child, 'cannot be empty')
+          else
+            if element['label'].blank?
+              add_error(child, 'label', 'is required')
+            end
+          end
+          items(element['child_classifications'], true) if element.has_key?('child_classifications')
+        end
+      else
+        add_error(parent, child, 'must be a non-empty array')
+      end
+    end
+  end
+end
+

data/lib/fulcrum/validators/form_validator.rb

@@ -0,0 +1,150 @@
+module Fulcrum
+  class FormValidator < BaseValidator
+
+    TYPES = %w(
+      TextField
+      ChoiceField
+      ClassificationField
+      PhotoField
+      DateTimeField
+      Section
+    )
+
+    def form_elements
+      data['form']['elements']
+    end
+
+    def form_name
+      data['form']['name']
+    end
+
+    def validate!
+      @items  = {}
+      if data[:form]
+        if form_elements && !form_elements.empty?
+          add_error('form', 'name', 'cannot be blank') if data[:form][:name].blank?
+          fields(form_elements)
+          conditionals(form_elements)
+        else
+          add_error('form', 'elements', 'must be a non-empty array')
+        end
+      else
+        @errors['form'] = ['must exist and not be empty']
+      end
+      return valid?
+    end
+
+    def fields(elements)
+      if elements.kind_of?(Array) && !elements.empty?
+        elements.each { |element| field(element) }
+      else
+        add_error('form', 'elements', 'must be a non-empty array')
+      end
+    end
+
+    def field(element)
+      if element.blank?
+        add_error('elements', 'element', 'must not be empty')
+      else
+        if !element[:key]
+          add_error('element', 'key', 'must exist and not be nil')
+          return false
+        end
+
+        if @items.include?(element[:key])
+          add_error(element[:key], :key, 'must be unique')
+          return false
+        end
+
+        key = element[:key]
+        @items[key] = element[:type]
+
+        add_error(key, 'label', 'is required') if element[:label].blank?
+        add_error(key, 'data_name', 'is required') if element[:data_name].blank?
+        add_error(key, 'type', 'is not one of the valid types') unless TYPES.include?(element[:type])
+
+        %w(disabled hidden required).each do |attrib|
+          add_error(key, attrib, 'must be true or false') unless [true, false].include?(element[attrib])
+        end
+
+        case element[:type]
+
+        when 'ClassificationField'
+          if element[:classification_set_id]
+            add_error(key, 'classification_set_id', 'is required') if element[:classification_set_id].blank?
+          end
+
+        when 'Section'
+          if element['elements'].is_a?(Array)
+            if element['elements'].any?
+              fields(element['elements'])
+            else
+              add_error(key, 'elements', 'must contain additional elements')
+            end
+          else
+            add_error(key, 'elements', 'must be an array object')
+          end
+
+        when 'ChoiceField'
+          if element['choice_list_id']
+            add_error(key, 'choice_list_id', 'is required') if element[:choice_list_id].blank?
+          else
+            if element['choices'].is_a?(Array) && !element['choices'].blank?
+              element['choices'].each do |choice|
+                unless choice.has_key?('label') && choice['label'].present?
+                  add_error('choices', 'label', 'contains an invalid label')
+                end
+              end
+            else
+              add_error(key, 'choices', 'must be a non-empty array')
+            end
+          end
+        end
+      end
+    end
+
+    def conditionals(elements)
+      elements.each { |element| conditional(element) }
+    end
+
+    def conditional(element)
+
+      operators = case element[:type]
+      when 'ChoiceField', 'ClassificationField'
+        %w(equal_to not_equal_to is_empty is_not_empty)
+      else
+        %w(equal_to not_equal_to contains starts_with greater_than less_than is_empty is_not_empty)
+      end
+
+      %w(required_conditions visible_conditions).each do |field|
+
+        if type = element["#{field}_type"]
+          add_error(key, "#{field}_type", 'is not valid') unless %(any all).include?(type)
+        end
+
+        if element[field]
+          if element[field].is_a?(Array)
+            element[field].each do |condition|
+
+              if key = condition[:field_key]
+                add_error(key, field, "key #{key} does not exist on the form") unless @items.keys.include?(key)
+                add_error(key, field, "operator for #{key} is invalid") unless operators.include?(condition[:operator])
+
+                if %w(is_empty is_not_empty).include?(condition[:operator]) && condition[:value].present?
+                  add_error(key, field, 'value cannot be blank')
+                end
+              else
+                add_error(key, field, 'field key must exist for condition')
+              end
+
+            end
+          else
+            add_error(key, field, 'must be an array object')
+          end
+        end
+      end
+
+      conditionals(element[:elements]) if element[:type] == 'Section'
+    end
+  end
+end

data/lib/fulcrum/validators/record_validator.rb

@@ -0,0 +1,18 @@
+module Fulcrum
+  class RecordValidator < BaseValidator
+    def validate!
+      if data['record'].kind_of?(Hash) && !data['record'].empty?
+        add_error('record', 'form_id', 'cannot be blank') if data['record']['form_id'].blank?
+        if data['record']['latitude'].to_f == 0.0 || data['record']['longitude'] == 0.0
+          add_error('record', 'coordinates', 'must be in WGS84 format')
+        end
+        if !data['record']['form_values'].kind_of?(Hash) || data['record']['form_values'].blank?
+          add_error('record', 'form_values', 'must be a non-empty hash')
+        end
+      else
+        @errors['record'] = ['must be a non-empty hash']
+      end
+      return valid?
+    end
+  end
+end

data/lib/fulcrum/version.rb

@@ -0,0 +1,3 @@
+module Fulcrum
+  VERSION = "0.1.2"
+end

data/spec/data/form_data.json

@@ -0,0 +1,175 @@
+{
+  "form": {
+      "name": "Park Maintinence",
+      "description": "Form for inspection of park's state of maintenance.",
+      "created_at": "2012-04-27T10:48:31-04:00",
+      "updated_at": "2012-04-27T10:58:39-04:00",
+      "elements": [
+         {
+            "disabled":false,
+            "hidden":false,
+            "key":"b8fbca33-cad6-1eb5-b4ec-d78cf8aa9323",
+            "type":"Section",
+            "data_name":"park_report",
+            "required":false,
+            "label":"Park Report",
+            "elements":[
+               {
+                  "disabled":false,
+                  "hidden":false,
+                  "multiple":false,
+                  "allow_other":true,
+                  "key":"42277b35-92a0-2fe5-15df-baf4a2c11d69",
+                  "type":"ChoiceField",
+                  "data_name":"amenity_type",
+                  "required":false,
+                  "label":"Amenity Type",
+                  "choices":[
+                     {
+                        "value":"Boardwalk",
+                        "label":"Boardwalk"
+                     },
+                     {
+                        "value":"Pavilion",
+                        "label":"Pavilion"
+                     },
+                     {
+                        "value":"Bench",
+                        "label":"Bench"
+                     },
+                     {
+                        "value":"Path",
+                        "label":"Path"
+                     },
+                     {
+                        "value":"Playground Equipment",
+                        "label":"Playground Equipment"
+                     },
+                     {
+                        "value":"Land",
+                        "label":"Land"
+                     },
+                     {
+                        "value":"Restroom",
+                        "label":"Restroom"
+                     },
+                     {
+                        "value":"Athletic Field",
+                        "label":"Athletic Field"
+                     },
+                     {
+                        "value":"Boat Ramp",
+                        "label":"Boat Ramp"
+                     },
+                     {
+                        "value":"Picnic Table",
+                        "label":"Picnic Table"
+                     },
+                     {
+                        "value":"Dog Park",
+                        "label":"Dog Park"
+                     }
+                  ]
+               },
+               {
+                  "disabled":false,
+                  "hidden":false,
+                  "multiple":false,
+                  "allow_other":true,
+                  "key":"dec7d431-981e-55fe-ce27-fa0ce588b7b3",
+                  "type":"ChoiceField",
+                  "data_name":"type_of_problem",
+                  "required":false,
+                  "label":"Type of Problem",
+                  "choices":[
+                     {
+                        "value":"Vandalism",
+                        "label":"Vandalism"
+                     },
+                     {
+                        "value":"Invasive Plant Species",
+                        "label":"Invasive Plant Species"
+                     },
+                     {
+                        "value":"Pests",
+                        "label":"Pests"
+                     },
+                     {
+                        "value":"Damage",
+                        "label":"Damage"
+                     },
+                     {
+                        "value":"None",
+                        "label":"None"
+                     }
+                  ]
+               },
+               {
+                  "disabled":false,
+                  "hidden":false,
+                  "key":"bbd86b27-4792-1ba3-6bf3-65b7bb5ee124",
+                  "type":"TextField",
+                  "data_name":"problem_notes",
+                  "required":false,
+                  "label":"Problem Notes"
+               },
+               {
+                  "disabled":false,
+                  "hidden":false,
+                  "multiple":false,
+                  "allow_other":true,
+                  "key":"36d58746-2b5c-a545-3009-5744de326e69",
+                  "type":"ChoiceField",
+                  "data_name":"urgency_",
+                  "required":false,
+                  "label":"Urgency ",
+                  "choices":[
+                     {
+                        "value":"High",
+                        "label":"High"
+                     },
+                     {
+                        "value":"Medium",
+                        "label":"Medium"
+                     },
+                     {
+                        "value":"Low",
+                        "label":"Low"
+                     },
+                     {
+                        "value":"None",
+                        "label":"None"
+                     }
+                  ]
+               },
+               {
+                  "disabled":false,
+                  "hidden":false,
+                  "key":"4194cc93-99ff-fb2c-ec1f-ad4e394e6731",
+                  "type":"TextField",
+                  "data_name":"name_of_park",
+                  "required":false,
+                  "label":"Name of Park"
+               },
+               {
+                  "disabled":false,
+                  "hidden":false,
+                  "key":"21f0b6d5-4154-030e-d552-13819dfb3a0a",
+                  "type":"PhotoField",
+                  "required":false,
+                  "label":"Photos"
+               }
+            ]
+         },
+         {
+            "disabled":false,
+            "hidden":false,
+            "key":"1797370a-06c3-a263-6c8f-17dcf7186b11",
+            "type":"DateTimeField",
+            "data_name":"date_of_report",
+            "required":false,
+            "label":"Date of Report"
+         }
+      ]
+   }
+}