openapply 0.2.6 → 0.2.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4b93c4f55575610cef31739e94b05342210d4b84ab3a83aab348731dd972610b
-  data.tar.gz: 6bd9b5abecfd5fe56da2c840ddee1de81b177a89b2dc24eed9c415a4e75b85b1
+  metadata.gz: 7b0c0c8d58f1cd650e0ce2d45e87fb8f66a5e25cc8796214838a9b2bda42b52d
+  data.tar.gz: d7405bd5b47e826348cbfd2d39d8f16cd0f5fb2ca7b7c9186ffb4a4c7231e2d2
 SHA512:
-  metadata.gz: ee824ba665e7e30e061443bfa4a464e2549390b332dff591ca4b1c9f58ac68b7aff89ef7f1e554fe90fee57be1ddcd79c767e6618e842a971d76aace88304530
-  data.tar.gz: ea96157ed83ba97ae242adcf6c73592d515bf37b4c73b2ef9b061e2642c633e915d40e959736bb554e9225685bdea6fcba64cd219c74f0c1e0ea3b9330593874
+  metadata.gz: 344ce55394f520ed227b31d3e0e78d747b7b3a1001f605502df853951e4cec6f9d70fc9b945c76dca45aa3dc3588fb449676e3d874a93dad27ad70d7789bac14
+  data.tar.gz: a500846657c599050a2b6f72e8581e794c85822bc207a2f87c652ce6b6f4d256645dd049e3bbc23d8f90b3865ce6909314a7aa5d15c5510362984c1f4438ea9d

data/Gemfile

@@ -2,5 +2,12 @@ source "https://rubygems.org"
 
 git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
 
+# # https://github.com/straydogstudio/axlsx_rails/issues/77
+# gem 'axlsx',  git: 'https://github.com/randym/axlsx.git',
+#               ref: '776037c0fc799bb09da8c9ea47980bd3bf296874'
+
+# https://github.com/randym/axlsx/issues/501
+gem 'axlsx',  git: 'https://github.com/randym/axlsx', branch: 'master'
+
 # Specify your gem's dependencies in openapply.gemspec
 gemspec

data/Gemfile.lock

@@ -1,11 +1,24 @@
+GIT
+  remote: https://github.com/randym/axlsx
+  revision: c8ac844572b25fda358cc01d2104720c4c42f450
+  branch: master
+  specs:
+    axlsx (2.1.0.pre)
+      htmlentities (~> 4.3.4)
+      mimemagic (~> 0.3)
+      nokogiri (>= 1.6.6)
+      rubyzip (>= 1.2.1)
+
 PATH
   remote: .
   specs:
-    openapply (0.2.6)
+    openapply (0.2.7)
+      axlsx
       httparty (~> 0.15)
       json (~> 2.1)
       net-scp (~> 1.2)
       net-ssh (~> 4.2)
+      rubyzip (>= 1.2.1)
 
 GEM
   remote: https://rubygems.org/
@@ -18,19 +31,27 @@ GEM
     diff-lcs (1.3)
     docile (1.1.5)
     hashdiff (0.3.7)
+    htmlentities (4.3.4)
     httparty (0.15.6)
       multi_xml (>= 0.5.2)
     json (2.1.0)
     method_source (0.9.0)
+    mimemagic (0.3.2)
+    mini_portile2 (2.3.0)
     multi_xml (0.6.0)
     net-scp (1.2.1)
       net-ssh (>= 2.6.5)
     net-ssh (4.2.0)
+    nokogiri (1.8.1)
+      mini_portile2 (~> 2.3.0)
     pry (0.11.3)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
     public_suffix (3.0.1)
     rake (10.5.0)
+    roo (2.7.1)
+      nokogiri (~> 1)
+      rubyzip (~> 1.1, < 2.0.0)
     rspec (3.7.0)
       rspec-core (~> 3.7.0)
       rspec-expectations (~> 3.7.0)
@@ -44,6 +65,7 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.7.0)
     rspec-support (3.7.0)
+    rubyzip (1.2.1)
     safe_yaml (1.0.4)
     simplecov (0.15.1)
       docile (~> 1.1.0)
@@ -59,10 +81,12 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  axlsx!
   bundler (~> 1.15)
   openapply!
   pry (~> 0.11)
   rake (~> 10.0)
+  roo (~> 2.7)
   rspec (~> 3.7)
   simplecov (~> 0.15)
   webmock (~> 3.1)

data/README.md

@@ -6,7 +6,6 @@ This gem allows ruby access to the OpenApply API v1 - and supports the GET featu
 ### Still TODO
 
 * **add google sheets to convert**
-* **update axlsx with rubyzip 1.2.1**
 * make tests for scp / ssh (at least data type conversions)
 * allow csv and xlsx reports with default summary info only?
 * write PUTS methods - *currently api only allows status update*
@@ -17,11 +16,14 @@ This gem allows ruby access to the OpenApply API v1 - and supports the GET featu
 
 ### CHANGE LOG
 
-* **v0.2.7** - compatible with 0.2.x - 2017-12-xx
+* **v0.2.8** - compatible with 0.2.x - 2017-12-?? *(https://github.com/straydogstudio/axlsx_rails/issues/77)*
   - allow flattening to work with arrays
   - allow flattening and reject to work at 2 levels of depth
   - allow flattening and reject to work at any depth (with recursion?)
 
+* **v0.2.7** - compatible with 0.2.x - 2017-12-10
+  - safely re-enabled axlsx by using the master branch and upgradeing rubyzip
+
 * **v0.2.6** - compatible with 0.2.x - 2017-12-08
   - allow ssh/scp options to be passed
 
@@ -176,13 +178,12 @@ csv_string=@oa.students_as_csv_by_statuses(['applied','enrolled'],[:custom_field
 @oa.send_data_to_remote_server(csv_string, 'hostname.domain.name', 'myusername', '/home/myusername/xfer/myexport.csv', '0750')
 
 # Create XLSX file
-# XLSX features DISABLED UNTIL AXLSX can work with RubyZip 1.2.1
-# @oa.students_as_xlsx_by_status('applied',[:custom_fields], [:parent_guardian], [:id, :name], {type: :guardians, count: 1, keys: [:id, :name, :address]}, {type: :payments, count: 2, order: :newest, keys: [:date, :amount]} )
+@oa.students_as_xlsx_by_status('applied',[:custom_fields], [:parent_guardian], [:id, :name], {type: :guardians, count: 1, keys: [:id, :name, :address]}, {type: :payments, count: 2, order: :newest, keys: [:date, :amount]} )
 # # multiple status into
-# xlsx_obj=@oa.students_as_xlsx_by_statuses(['applied','enrolled'],[:custom_fields], [:parent_guardian], [:id, :name], {type: :guardians, count: 1, keys: [:id, :name, :address]}, {type: :payments, count: 2, order: :newest, keys: [:date, :amount]} )
+xlsx_obj=@oa.students_as_xlsx_by_statuses(['applied','enrolled'],[:custom_fields], [:parent_guardian], [:id, :name], {type: :guardians, count: 1, keys: [:id, :name, :address]}, {type: :payments, count: 2, order: :newest, keys: [:date, :amount]} )
 # #
 # # send XLSX to a remote server as a file - using ssh-keys
-# @oa.send_data_to_remote_server(xlsx, 'hostname.domain.name', 'myusername', '/home/myusername/xfer/myexport.xlsx', '0750')
+@oa.send_data_to_remote_server(xlsx_obj, 'hostname.domain.name', 'myusername', '/home/myusername/xfer/myexport.xlsx', '0750')
 ```
 
 #### INDIVIDUAL STUDENT QUERIES
@@ -259,15 +260,13 @@ csv=@oa.students_as_csv_by_status('applied',[:custom_fields], [:parent_guardian]
 @oa.send_data_to_remote_server(csv, 'hostname.domain.name', 'myusername', '/home/myusername/xfer/myexport.csv', '0750')
 #
 # # Create a XLSX package
-# disabled until axlsx works with rubyzip 1.2.1
-#
-# @oa.students_as_xlsx_by_status('applied', nil, nil, [:id, :name], nil, {count: 2, order: :newest, keys: [:date, :amount]} )
+@oa.students_as_xlsx_by_status('applied', nil, nil, [:id, :name], nil, {count: 2, order: :newest, keys: [:date, :amount]} )
 # # all options
-# xlsx=@oa.students_as_xlsx_by_status('applied',[:custom_fields], [:parent_guardian], [:id, :name], {count: 1, keys: [:id, :name, :address]}, {count: 2, order: :newest, keys: [:date, :amount]} )
+xlsx_obj=@oa.students_as_xlsx_by_status('applied',[:custom_fields], [:parent_guardian], [:id, :name], {count: 1, keys: [:id, :name, :address]}, {count: 2, order: :newest, keys: [:date, :amount]} )
 # #
 # # send CSV to a remote server as a file - using ssh-keys
 # # attributes: csv_string, srv_hostname, srv_username, srv_path_file, file_permissions(0750 - default if not specified)
-# @oa.send_data_to_remote_server(xlsx, 'hostname.domain.name', 'myusername', '/home/myusername/xfer/myexport.csv', '0750')
+@oa.send_data_to_remote_server(xlsx_obj, 'hostname.domain.name', 'myusername', '/home/myusername/xfer/myexport.csv', '0750')
 ```
 
 #### CUSTOM GROUP QUERIES - summary data

data/lib/openapply/convert.rb

@@ -1,5 +1,5 @@
 require 'csv'
-# require 'axlsx'
+require 'axlsx'
 require 'net/scp'
 require 'net/ssh'
 
@@ -99,66 +99,66 @@ module Convert
   end
 
 
-  # # XLSX CODE
-  # ###########
-  #
-  #
-  # # Queries by status to get a list of students details of a given status
-  # # and converts the result to a XLSX Object (Axlsx::Package) with headers
-  # # (based on keys sent)
-  # #
-  # # ==== Attributes
-  # # * +status+ - hash to convert to an array
-  # # * +flatten_keys+ - an array of keys to bring to the top level
-  # # (with this key prepened) -- default (blank does nothing)
-  # # * +reject_keys+ - an array of keys to remove from the data -- default (blank does nothing)
-  # # * +student_keys+ - [:id, :name] - include student record keys
-  # # * +guardian_info+ - include guardian record info {count: 2, keys: [:id, :name]}
-  # # * +payment_info+ - include payment info {count: 2, order: :newest, keys: [:date, :amount]}
-  # # * guardian & payment info options:
-  # #  count: 2 -- how many parent or payment records to return)
-  # #  keys: [:id, :date] -- an array of keys of data to return
-  # #  order: :newest -- the order to return payments :newest (most recent first - default) or :oldest
-  # def students_as_xlsx_by_status( status,
-  #                                 flatten_keys=[], reject_keys=[],
-  #                                 student_keys=[],
-  #                                 guardian_info={}, payment_info={})
-  #   #
-  #   check = check_details_keys_validity(flatten_keys, reject_keys)
-  #   return check           unless check.nil? # or check[:error].nil?
-  #   # check = check_header_keys_validity(student_keys, guardian_info, payment_info)
-  #   # return check    unless check.nil?
-  #   #
-  #   students_array  = students_as_array_by_status(  status,
-  #                                 flatten_keys, reject_keys,
-  #                                 student_keys, guardian_info, payment_info )
-  #   #
-  #   return students_array      if students_array.is_a? Hash
-  #   #
-  #   students_xlsx    = students_array_to_xlsx( students_array )
-  #
-  #   # example how to save the xlsx object as a file
-  #   # students_xlsx.serialize("spec/data/xlsx/students_from_oa.xlsx")
-  #
-  #   return students_xlsx
-  # end
-  # alias_method :students_as_xlsx_by_statuses, :students_as_xlsx_by_status
+  # XLSX CODE
+  ###########
+
+
+  # Queries by status to get a list of students details of a given status
+  # and converts the result to a XLSX Object (Axlsx::Package) with headers
+  # (based on keys sent)
   #
+  # ==== Attributes
+  # * +status+ - hash to convert to an array
+  # * +flatten_keys+ - an array of keys to bring to the top level
+  # (with this key prepened) -- default (blank does nothing)
+  # * +reject_keys+ - an array of keys to remove from the data -- default (blank does nothing)
+  # * +student_keys+ - [:id, :name] - include student record keys
+  # * +guardian_info+ - include guardian record info {count: 2, keys: [:id, :name]}
+  # * +payment_info+ - include payment info {count: 2, order: :newest, keys: [:date, :amount]}
+  # * guardian & payment info options:
+  #  count: 2 -- how many parent or payment records to return)
+  #  keys: [:id, :date] -- an array of keys of data to return
+  #  order: :newest -- the order to return payments :newest (most recent first - default) or :oldest
+  def students_as_xlsx_by_status( status,
+                                  flatten_keys=[], reject_keys=[],
+                                  student_keys=[],
+                                  guardian_info={}, payment_info={})
+    #
+    check = check_details_keys_validity(flatten_keys, reject_keys)
+    return check           unless check.nil? # or check[:error].nil?
+    # check = check_header_keys_validity(student_keys, guardian_info, payment_info)
+    # return check    unless check.nil?
+    #
+    students_array  = students_as_array_by_status(  status,
+                                  flatten_keys, reject_keys,
+                                  student_keys, guardian_info, payment_info )
+    #
+    return students_array      if students_array.is_a? Hash
+    #
+    students_xlsx    = students_array_to_xlsx( students_array )
+
+    # example how to save the xlsx object as a file
+    # students_xlsx.serialize("spec/data/xlsx/students_from_oa.xlsx")
+
+    return students_xlsx
+  end
+  alias_method :students_as_xlsx_by_statuses, :students_as_xlsx_by_status
+
+
+  # Given an array convert to XLSX Object (Axlsx::Package)
   #
-  # # Given an array convert to XLSX Object (Axlsx::Package)
-  # #
-  # # ==== Attributes
-  # # +array+ - expects a hash of students_details (should be flattened to use custom fields)
-  # def students_array_to_xlsx(student_array)
-  #   xlsx_obj = Axlsx::Package.new do |p|
-  #     p.workbook.add_worksheet(:name => "Students from OpenApply") do |sheet|
-  #       student_array.each{ |r| sheet.add_row r }
-  #     end
-  #     # to save the xlsx object as a file
-  #     # p.serialize("spec/data/xlsx/students_from_oa.xlsx")
-  #   end
-  #   return xlsx_obj
-  # end
+  # ==== Attributes
+  # +array+ - expects a hash of students_details (should be flattened to use custom fields)
+  def students_array_to_xlsx(student_array)
+    xlsx_obj = Axlsx::Package.new do |p|
+      p.workbook.add_worksheet(:name => "Students from OpenApply") do |sheet|
+        student_array.each{ |r| sheet.add_row r }
+      end
+      # to save the xlsx object as a file
+      # p.serialize("spec/data/xlsx/students_from_oa.xlsx")
+    end
+    return xlsx_obj
+  end
 
 
   # ARRAY CODE
@@ -301,24 +301,16 @@ module Convert
                                   srv_path_file, srv_file_permissions="0750",
                                   ssl_options={}
                                 )
+    # be sure its a file type that can be sent
+    return "Unrecognized Object"  unless known_transfer_object?(data)
+
+    # Prep data as necessary for scp
     # https://www.safaribooksonline.com/library/view/ruby-cookbook/0596523696/ch06s15.html
     # convert the string to a stringio object (which can act as a file)
-
-    # just move the file via SCP
-    xfer = data                       if data.is_a? File
-    # convert string into a SteamIO - "FILE" like object
+    xfer = data.to_stream()           if data.is_a? Axlsx::Package
     xfer = data                       if data.is_a? StringIO
-    # convert string into a SteamIO - "FILE" like object
     xfer = StringIO.new( data )       if data.is_a? String
-    # disabled until AXLSX can use rubyzip 1.2.1
-    # # convert Axlsx object into a SteamIO - "FILE" like object
-    # xfer = data.to_stream()           if data.is_a? Axlsx::Package
-
-    # be sure its a file type that can be sent
-    return "Unrecognized Object"  unless known_transfer_object?(data)
-
-    # verify_host_key   = {verify_host_key: false} if options[:verify_host_key].eql? false
-    # verify_host_key ||= {verify_host_key: true}
+    xfer = data                       if data.is_a? File
 
     # http://www.rubydoc.info/github/delano/net-scp/Net/SCP
     # send the stringio object to the remote host via scp
@@ -340,8 +332,10 @@ module Convert
   # === Attributes
   # * +data+ - is it an Axlsx::Package, Sting, StringIO or a File class?
   def known_transfer_object?( data )
-    return true  if data.is_a? String or data.is_a? Axlsx::Package or
-                    data.is_a? File   or data.is_a? StringIO
+    return true  if data.is_a? Axlsx::Package
+    return true  if data.is_a? StringIO
+    return true  if data.is_a? String
+    return true  if data.is_a? File
     return false
   end
 

data/lib/openapply/version.rb

@@ -1,3 +1,3 @@
 module Openapply
-  VERSION = "0.2.6"
+  VERSION = "0.2.7"
 end

data/openapply.gemspec

@@ -38,9 +38,19 @@ Gem::Specification.new do |spec|
   # # need this version of axlsx to match roo's rubyzip needs
   # # axlsx 2.1.0.pre uses rubyzip 1.1.7 - which has a security flaw
   # # using the newest version of rubyzip 1.2.1 or larger
+  # # https://github.com/randym/axlsx/issues/501
+  # gem 'axlsx', git: 'https://github.com/randym/axlsx',
+  #              branch: 'master'
+  # https://github.com/straydogstudio/axlsx_rails/issues/77
+  # gem 'axlsx', git: 'https://github.com/randym/axlsx.git',
+  #              ref: '776037c0fc799bb09da8c9ea47980bd3bf296874'
+  spec.add_dependency 'axlsx'
+
+  # # Rubyzip before 1.2.1 has a directory traversal vulnerability: CVE-2017-5946
+  spec.add_dependency  'rubyzip', '>= 1.2.1'
+  # don't use official release - use above
   # spec.add_dependency "axlsx", "2.1.0.pre"
   # spec.add_dependency "rubyzip", "~> 1.2"
-  # spec.add_development_dependency "roo", "~> 2.7"
 
   spec.add_development_dependency "simplecov", "~> 0.15"
   spec.add_development_dependency "webmock" , "~> 3.1"
@@ -48,4 +58,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.7"
   spec.add_development_dependency "pry", "~> 0.11"
+  spec.add_development_dependency "roo", "~> 2.7"
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openapply
 version: !ruby/object:Gem::Version
-  version: 0.2.6
+  version: 0.2.7
 platform: ruby
 authors:
 - Bill Tihen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-12-08 00:00:00.000000000 Z
+date: 2017-12-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -66,6 +66,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.2'
+- !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: rubyzip
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.1
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -150,6 +178,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.11'
+- !ruby/object:Gem::Dependency
+  name: roo
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
 description: 
 email:
 - btihen@gmail.com