tofulcrum 0.0.8 → 0.0.9

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    MGFiOTNkNTQ2YmJmYzQ4OTQ4YzI4NDdkNWRiM2EwNTk0ZDgyZjFlOA==
-  data.tar.gz: !binary |-
-    Y2E2NjE2MmZhNjM4NTM0OTgyMDZlYzYzODU4ZjZjMTdjM2M1OThhYg==
+SHA1:
+  metadata.gz: a68e8c5c982398ee78373d7dd468a82beaf4a895
+  data.tar.gz: 2c14b9b22084c4c8b13e62f5999040d18fa3c742
 SHA512:
-  metadata.gz: !binary |-
-    NzZkNjlkOTJiYWIxYThhNTVlZGVkMDkwZDg0ZjFmMGIyNjQzMmE2ZWMxMmY1
-    OWUxNjI1ZTkxYWI0NWM2NGEyNzU1MzM0ZGNhZGJkYTJjOGQwYzUyZTNjMmJl
-    MTMwOTg3NmViYWU3NmM2ZDEyZGJkYTBjMTIyMDYxN2E4ZWU2NzQ=
-  data.tar.gz: !binary |-
-    MDU3ZGZlMjNmMDg5NDJkMzZlNGVjZjdkOTcyMGZjMmMxYWNiNzkzZTc4NDVl
-    MjJhNGYyMWRiMTIyM2QyMDBjMjc4MDQ2MGI5MTRmMGZiNmY3N2QzZjU2NWU4
-    MzBkYjZlYTVjMmM2NDg5MThjMmU4M2QwNWU2Yjk2MTAxMDI0MDg=
+  metadata.gz: cddb2b6b3d5950c8892f2ac2cf6ff9a44aa7325a98bc253954110eb18bc0d93a49c9b214c19e5259a285afdd271896b95c3aba4205e39ba495d29a647ce0ea69
+  data.tar.gz: f4e77446631aae67b4130fe920a720dddad74bd54e70ca66cd8787db01a2abd22cce43e8ba77eed42b8644d7d8eefa72a8a934df7ab37b2e8cbd37e80087fc69

data/lib/tofulcrum.rb

@@ -1,15 +1,31 @@
+require 'bundler/setup'
+require 'rubygems'
 require "tofulcrum/version"
 require 'csv'
 require 'fulcrum'
 require 'thor'
+require 'json'
+require 'roo'
+require 'axlsx'
+require 'securerandom'
+
+API_URL = 'https://api.fulcrumapp.com'
+
+require 'tofulcrum/fulcrum-xls-form/xls_reader'
+require 'tofulcrum/fulcrum-xls-form/xls_writer'
 
 module Tofulcrum
   class CLI < Thor
+    desc "xls", "Convert an Excel spreadsheet to a Fulcrum form"
+    def xls(file)
+      Fulcrum::XlsReader.read(file)
+    end
+
     desc "import", "Import a CSV into a Fulcrum app"
     def import(file, form_id, api_key, mapping=nil)
 
       Fulcrum::Api.configure do |config|
-        config.uri = 'https://api.fulcrumapp.com/api/v2'
+        config.uri = API_URL
         config.key = api_key
       end
 

data/lib/tofulcrum/fulcrum-xls-form/xls_reader.rb

@@ -0,0 +1,228 @@
+module Fulcrum
+  class XlsReader
+    VALID_ROW_TYPES = [
+      'section begin',
+      'section end',
+      'text',
+      'choice',
+      'numeric',
+      'repeatable begin',
+      'repeatable end',
+      'date',
+      'address',
+      'signature',
+      'photos'
+    ]
+
+    def self.read(file)
+      spreadsheet = Roo::Spreadsheet.open(file)
+
+      parse_metadata(spreadsheet)
+      parse_status_field(spreadsheet)
+      parse_choices(spreadsheet)
+      parse_schema(spreadsheet)
+    end
+
+    def self.parse_schema(spreadsheet)
+      form = { form: { name: @metadata['name'],
+                       description: @metadata['description'],
+                       status_field: @status_field,
+                       elements: make_elements(make_hash(spreadsheet.sheet('form'))) } }
+
+      puts form.to_json
+    end
+
+    def self.make_elements(rows)
+      root = { elements: [] }
+
+      containers = [ root ]
+
+      current_container = root
+
+      rows.each do |row|
+        row = row.with_indifferent_access
+
+        row_type = row['type'].to_s.downcase.strip
+
+        raise "Invalid row type #{row_type}." unless VALID_ROW_TYPES.include?(row_type)
+
+        if !['repeatable end', 'section end'].include?(row_type)
+          element = make_element(row, current_container)
+          current_container[:elements] << element
+        end
+
+        case row_type
+        when 'section begin'
+          containers << element
+          current_container = element
+
+        when 'section end'
+          raise "section end found without matching begin" if containers.count == 1
+
+          containers = containers[0..-2]
+          current_container = containers.last
+
+        when 'repeatable begin'
+          containers << element
+          current_container = element
+
+        when 'repeatable end'
+          raise "repeatable end found without matching begin" if containers.count == 1
+
+          containers = containers[0..-2]
+          current_container = containers.last
+
+        end
+      end
+
+      raise "Unmatched sections or repeatables found. The open fields are: #{containers.map {|c| c[:label]}.join(', ')}" if containers.count != 1
+
+      root[:elements]
+    end
+
+    def self.make_element(row, container)
+      {}.tap do |hash|
+        hash[:type] = element_type_for_type(row[:type])
+        hash[:label] = row[:label]
+        hash[:data_name] = make_data_name(row, container)
+        hash[:description] = row[:description]
+        hash[:required] = boolean_value(row[:required])
+        hash[:hidden] = boolean_value(row[:hidden])
+        hash[:disabled] = boolean_value(row[:disabled])
+        hash[:numeric] = true if row[:type] == 'numeric'
+        hash[:elements] = [] if %w(Section Repeatable).include?(hash[:type])
+        hash[:key] = SecureRandom.hex(2)
+
+        if hash[:type] == 'ChoiceField'
+          hash[:choices] = @choices[row['choices']] if hash[:type] == 'ChoiceField'
+          hash[:allow_other] = boolean_value(row[:allow_other])
+        end
+      end
+    end
+
+    def self.make_data_name(row, container)
+      return row[:data_name] if row[:data_name]
+
+      if container[:data_name].present?
+        "#{container[:data_name]}_#{row[:label].to_s.downcase.parameterize.underscore}"
+      else
+        row[:label].to_s.downcase.parameterize.underscore
+      end
+    end
+
+    def self.element_type_for_type(type)
+      case type
+      when 'section begin'    then 'Section'
+      when 'text'             then 'TextField'
+      when 'choice'           then 'ChoiceField'
+      when 'numeric'          then 'TextField'
+      when 'repeatable begin' then 'Repeatable'
+      when 'date'             then 'DateTimeField'
+      when 'address'          then 'AddressField'
+      when 'signature'        then 'SignatureField'
+      when 'photos'           then 'PhotoField'
+      else nil
+      end
+    end
+
+    def self.parse_metadata(spreadsheet)
+      sheet = spreadsheet.sheet('metadata')
+
+      raise "Can't find metadata sheet." unless sheet
+
+      metadata = make_hash(sheet)
+
+      @metadata = {}
+
+      metadata.each do |row|
+        @metadata[row['key']] = row['value']
+      end
+    end
+
+    def self.parse_choices(spreadsheet)
+      sheet = spreadsheet.sheet('choices')
+
+      return unless sheet
+
+      all_choices = make_hash(sheet)
+
+      @choices = {}
+
+      all_choices.each do |choice|
+        @choices[choice['list']] ||= []
+        @choices[choice['list']] << choice.slice('label', 'value')
+      end
+    end
+
+    def self.parse_status_field(spreadsheet)
+      sheet = spreadsheet.sheet('status')
+
+      return unless sheet
+
+      statuses = make_hash(sheet)
+
+      @status_field = {}
+      @status_field[:label] = @metadata['status_label']
+      @status_field[:description] = @metadata['status_description']
+      @status_field[:data_name] = @metadata['status_data_name']
+      @status_field[:default_value] = @metadata['status_default_value']
+      @status_field[:hidden] = boolean_value(@metadata['status_hidden'])
+      @status_field[:read_only] = boolean_value(@metadata['status_read_only'])
+      @status_field[:enabled] = boolean_value(@metadata['status_enabled'])
+
+      statuses.each do |status|
+        @status_field[:choices] ||= []
+        @status_field[:choices] << { label: status['label'] || '',
+                                     value: status['value'] || status['label'] || '',
+                                     color: status_color(status['color']) }
+      end
+    end
+
+    def self.boolean_value(value, default=false)
+      return default if value.nil?
+      return %(true yes 1).include?(value.to_s.downcase.strip)
+    end
+
+    def self.status_color(human_name)
+      case human_name.to_s.strip.downcase
+      when 'black'      then '#242424'
+      when 'gray'       then '#B3B3B3'
+      when 'white'      then '#FFFFFF'
+      when 'brown'      then '#704B10'
+      when 'pink'       then '#DA0796'
+      when 'red'        then '#CB0D0C'
+      when 'orange'     then '#FF8819'
+      when 'yellow'     then '#FFD300'
+      when 'green'      then '#87D30F'
+      when 'dark green' then '#2D5D00'
+      when 'dark blue'  then '#294184'
+      when 'blue'       then '#1891C9'
+      else '#CB0D0C'
+      end
+    end
+
+    def self.make_hash(sheet)
+      column_names = []
+
+      sheet.row(1).to_a.each_with_index do |column_name, index|
+        column_names << {name: column_name, index: index} if column_name.present?
+      end
+
+      rows = []
+
+      sheet.each_with_index do |item, index|
+        next if index == 0
+
+        hash = {}
+
+        column_names.each do |column|
+          hash[column[:name]] = item[column[:index]]
+        end
+
+        rows << hash
+      end
+
+      rows
+    end
+  end
+end

data/lib/tofulcrum/version.rb

@@ -1,3 +1,3 @@
 module Tofulcrum
-  VERSION = "0.0.8"
+  VERSION = "0.0.9"
 end

data/tofulcrum.gemspec

@@ -18,8 +18,11 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
+  spec.add_dependency "faraday", "~> 0.7.6"
   spec.add_dependency "thor"
   spec.add_dependency "fulcrum"
+  spec.add_dependency "axlsx"
+  spec.add_dependency "roo"
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"

metadata

@@ -1,69 +1,111 @@
 --- !ruby/object:Gem::Specification
 name: tofulcrum
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.9
 platform: ruby
 authors:
 - Zac McCormick
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-25 00:00:00.000000000 Z
+date: 2014-02-05 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.6
 - !ruby/object:Gem::Dependency
   name: thor
   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: fulcrum
   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: axlsx
+  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: roo
+  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: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
   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'
 description: Convert data to Fulcrum
@@ -74,13 +116,15 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/tofulcrum
 - lib/tofulcrum.rb
+- lib/tofulcrum/fulcrum-xls-form/xls_reader.rb
+- lib/tofulcrum/fulcrum-xls-form/xls_writer.rb
 - lib/tofulcrum/version.rb
 - tofulcrum.gemspec
 homepage: https://github.com/zhm/tofulcrum
@@ -93,19 +137,18 @@ 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.1.5
+rubygems_version: 2.2.1
 signing_key: 
 specification_version: 4
 summary: Import data into Fulcrum from a CSV
 test_files: []
-has_rdoc: