sushi_counter 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c887dfdb40f6bcc9f4365e6db790c79c187d7d62
-  data.tar.gz: 9887a751bf58b979c0857facff0a2522c54fb296
+  metadata.gz: 0d6e5e173e88c45200a3f4966060ce1153f93d6a
+  data.tar.gz: 30817939966490cbcd1667cdeed0778b722cb555
 SHA512:
-  metadata.gz: e84b56c117927189ed262586818a051110bc5733c671100a4c9b713a6cd1f519386743f50591dfa050408ca1d64d7bc0498a2f0dca208ea91e659f65b5792c5a
-  data.tar.gz: b5f1fa348245c03d2ba85dfdfb071162d14110acfbd8f54eced1ba2dc733d4fb249f4859964a2a22a365db06cc3b2ed73cbddbf4f14917f76a18938c4c6492f2
+  metadata.gz: 5c7fa75cf5156ffb4b97f6cf065cea398874007eecd57ca20519dc584707ceaf7a128a48f01af5626465acdc4a495c7573c12ed27994a3428eadb9875eca4996
+  data.tar.gz: 6f0366b9ea9c058a58a5e5ddccf54ac1528b8778ef0b5914fc39ceb04dd0ce7a8ab98e844103d2aa33ee41e498c01d7b8cced2b7c4c35311380de7f6767f6886

data/sushi_counter.rb

@@ -4,6 +4,7 @@ require 'Savon'
 require 'csv'
 require 'nokogiri'
 require 'date'
+require 'rainbow'
 
 #Creating options, flags and switches for CLI app.
 options = {}
@@ -15,15 +16,16 @@ option_parser = OptionParser.new do |opts|
   Usage: #{executable_name} [options] output_file.csv
 
   "
-  opts.on("-u [URL]",
-  "URL is the url to the WSDL file specified by the vendor. It will always end in ?wsdl. If you are passing an endpoint, leave this blank."
-  ) do |url|
-    options[:url] = url
+  #All URLs seem to work if endpoint is combined with default WSDL URL. Leave commented for now.
+  #opts.on("-u [URL]",
+  #{}"URL is the url to the WSDL file specified by the vendor. It will always end in ?wsdl. If you are passing an endpoint, leave this blank."
+  #) do |url|
+  #  options[:url] = url
       #Check if a WSDL was passed, if not, put in generic WSDL.
-      if options[:url].nil?
-        options[:url] = "http://www.niso.org/schemas/sushi/counter_sushi4_0.wsdl"
-      end
-    end
+  #    if options[:url].nil?
+  #      options[:url] = "http://www.niso.org/schemas/sushi/counter_sushi4_0.wsdl"
+  #    end
+  #  end
   opts.on("-E ENDPOINT",
   "Endpoint is the url to the service specified by the vendor. It will end with anything but ?wsdl."
   ) do |endpoint|
@@ -41,26 +43,25 @@ option_parser = OptionParser.new do |opts|
     end
   opts.on("-s REPORT_START",
   "Start date of report in YYYY-MM-DD format.",
-  #RegEx to validate date not working. Need to fix.
-  #/^\d{4}\-(0?[1-9]|1[012])\-(0?[1-9]|[12][0-9]|3[01])$/
+  /^\d{4}-\d{2}-\d{2}$/
   ) do |report_start|
     options[:report_start] = report_start
     end
   opts.on("-e REPORT_END",
   "End date of report in YYYY-MM-DD format. DD must be the end of the month (e.g. 31)",
-  #RegEx to validate date not working. Need to fix
-  #/^\d{4}\-(0?[1-9]|1[012])\-(0?[1-9]|[12][0-9]|3[01])$/
+  /^\d{4}-\d{2}-\d{2}$/
   ) do |report_end|
     options[:report_end] = report_end
     end
-  opts.on("-t TYPE",
-  "Specify which type of COUNTER report you want. If left empty, the default is JR1."
-  ) do |type|
-    options[:type] = type
-    if options[:type].nil?
-      options[:type] = "JR1"
-    end
-    end
+    #Can only fetch one report type at the moment. Add back in later.
+  #opts.on("-t [TYPE]",
+  #{}"Specify which type of COUNTER report you want. If left empty, the default is JR1."
+  #) do |type|
+  #  options[:type] = type
+  #  if options[:type].nil?
+  #    options[:type] = "JR1"
+  #  end
+  #  end
   opts.on("-p [PASSWORD]",
   "Specify your requestor email/password if required by the vendor."
   ) do |password|
@@ -69,43 +70,48 @@ option_parser = OptionParser.new do |opts|
       options[:password] = "Blank"
     end
     end
-#Add switch for logging on/off?
+
+    #Add switch for logging on/off?
+    options[:log] = false
+    opts.on("-l","--log") do options[:log] = true
+    end
+
 end
 begin
   option_parser.parse!
   if ARGV.empty?
-    puts "error: you must supply an output_file in format 'output_file.csv'"
+    puts Rainbow("error: you must supply an output_file in format 'output_file.csv'").bright.red
     puts
     puts option_parser.help
-    exit 1
+    exit 2
   else
     output_file = ARGV[0]
   end
-rescue OptionParser::InvalidArgument => ex
-  STDERR.puts ex.message
-  STDERR.puts option_parser
-end
 if ARGV.include? 'DEBUG'
   puts "The parameters you are passing to each option are:"
-  puts "url: #{options[:url]}"
+  #puts "url: #{options[:url]}"
   puts "endpoint: #{options[:endpoint]}"
   puts "requestor: #{options[:requestor]}"
   puts "customer: #{options[:customer]}"
   puts "report_start: #{options[:report_start]}"
   puts "report_end: #{options[:report_end]}"
+  #puts "type: #{options[:type]}"
   puts "password: #{options[:password]}"
+  puts "log level: #{options[:log]}"
+end
+rescue OptionParser::InvalidArgument => ex
+  STDERR.puts Rainbow("#{ex.message}").bright.red
+  STDERR.puts option_parser
+  exit 3
 end
-
 
 define_method :sushi_call do
   #Set up client for connection
   client = Savon.client(
-  #This needs to be passed as a variable. Store all WSDLs as an array and allow
-  #users to select from array?
-  wsdl: "#{options[:url]}",
+  #Possible to set up options below with YAML or CSV import?
+  wsdl: "http://www.niso.org/schemas/sushi/counter_sushi4_0.wsdl",
   endpoint: "#{options[:endpoint]}",
-  #I think these can stay static, need to validate against a different WSDL. May
-  #need to add additional namespaces?
+  #Keep namespaces static
   namespaces:{
     "xmlns:tns" => "SushiService",
     "xmlns:sc" => "http://www.niso.org/schemas/sushi/counter",
@@ -115,17 +121,15 @@ define_method :sushi_call do
     "xmlns:soap" => "http://schemas.xmlsoap.org/wsdl/soap",
     "xmlns:soap12" => "http://schemas.xmlsoap.org/wsdl/soap12/"
     },
-    #Probably keep this static so users don't have to mess with their keys. But need to check
-    #if all keys are the same in each WSDL.
+    #Keep keys static
     convert_request_keys_to: :none,
-    #Logging info. Allow users to set this as a flag to output more/less info. Default should
-    #be minimal.
-    log: true,
+    #Logging info. Always keep to debug. Default is false, unless specified by user
+    log: options[:log],
     log_level: :debug,
     #Allow users to control if they desire - outputs XML to terminal. Default should be FALSE.
     #Pretty Print is dependent on logging being on
     pretty_print_xml: true,
-    #Mandatory? I think so. Keep static.
+    #Keep static.
     env_namespace: :soapenv
   )
     #Send out call for data, passing all parameters for login/data
@@ -152,10 +156,12 @@ define_method :sushi_call do
       :attributes! => {
         "sus:ReportDefinition" => {
           "Release" => "4",
-          "Name" => "#{options[:type]}"
+          "Name" => "JR1"
         },
       },
     } )
+    puts "Fetching report..."
+    begin
 
     xml = response.doc
     #Need to replace below xml file with a dynamically generated name based on vendor/year.
@@ -173,8 +179,6 @@ define_method :sushi_call do
 
     month_array = []
     #Math to get number of months and print out to headers
-    r_start = options[:report_start]
-    r_end = options[:report_end]
     define_method(:months_math) do |date1, date2|
       m = (date2.year * 12 + date2.month) - (date1.year * 12 + date1.month) + 1
       m.times do |n|
@@ -182,20 +186,24 @@ define_method :sushi_call do
         month_array << iterator.to_s
       end
     end
+
     #Turn report_start and report_end into something readable.
+    r_start = options[:report_start]
+    r_end = options[:report_end]
     date_start = Date.parse(r_start)
     date_end = Date.parse(r_end)
+    #Call months_math method
     months_var = months_math(date_start, date_end)
     count_var = months_var - 1
 
-    #Basic info about report.
+    #Grabbing basic info about report.
     doc_requestor = noko_doc.xpath('//Requestor/ID').text
     doc_customer_ref = noko_doc.xpath('//CustomerReference/ID').text
     doc_release = noko_doc.xpath('//ReportDefinition').attr('Release').text
     doc_version = noko_doc.xpath('//ReportDefinition').attr('Name').text
 
 
-    #Setting empty arrays and variables to manage scope
+    #Setting empty arrays, hashes and variables to manage scope
     pdf_stats = []
     pdf_holder = []
     html_stats = []
@@ -213,7 +221,12 @@ define_method :sushi_call do
     html_iterator = nil
     iterator = nil
     total_pdf = nil
+    total_html = nil
+    total_all = nil
     i = 0
+    platform = nil
+    total_integer = nil
+    #total_months = []
 
 
     noko_doc.xpath('//ReportItems').each do |item|
@@ -225,9 +238,6 @@ define_method :sushi_call do
       publisher = item.xpath("./ItemPublisher").text
       name = item.xpath("./ItemName").text
 
-      #Probably don't need the line below
-      datatype = item.xpath("./ItemDataType").text
-
       #Store all months from XML data into an array
       month_match = item.xpath("./ItemPerformance/Period").each do |match|
         matches = match.xpath("./Begin").text
@@ -243,6 +253,7 @@ define_method :sushi_call do
         count_hash[month.to_sym] = counts
       end
 
+
       n = 0
       m = 0
 
@@ -253,7 +264,6 @@ define_method :sushi_call do
         if month_holder.include? month_array[n]
           month_key = month_array[n]
           count = count_hash[month_key.to_sym]
-          #i += 1
           m += 1
           total_stats << count
           if n < count_var
@@ -261,28 +271,27 @@ define_method :sushi_call do
           else n = 0
           end
         else
-          fallback_count = "test"
+          fallback_count = "0"
           total_stats << fallback_count
           if n < count_var
             n += 1
           else n = 0
           end
         end
-        stats = item.xpath("./ItemPerformance").each do |month|
-          count_html = month.xpath("./Instance[MetricType = 'ft_html']/Count").text
-          count_pdf = month.xpath("./Instance[MetricType = 'ft_pdf']/Count").text
-          pdf_stats << count_pdf
-          html_stats << count_html
+      end
 
-          #Add total columns here. Need more (html, all, each month, etc...)
-          total_pdf = pdf_stats.map(&:to_i).reduce(:+)
-        end
+      stats = item.xpath("./ItemPerformance").each do |month|
+        count_html = month.xpath("./Instance[MetricType = 'ft_html']/Count").text
+        count_pdf = month.xpath("./Instance[MetricType = 'ft_pdf']/Count").text
+        pdf_stats << count_pdf
+        html_stats << count_html
       end
 
       #Make code below DRYer
       #Refine code below? Currently working, but could probably be DRYer
       total_stats.each_slice(months_var).each do |slice|
         iterator = slice.join(",")
+        total_integer = slice.map(&:to_i).inject(0, :+)
       end
       #Could probably just add up html_stats array and output in CSV row below.
       html_stats.each_slice(months_var).each do |slice|
@@ -302,6 +311,11 @@ define_method :sushi_call do
       report_data << [name, publisher, platform, doi, value, print_issn, online_issn, total_iterator, html_iterator, pdf_iterator, iterator]
     end
 
+    #Add total columns here. Need more (html, all, each month, etc...)
+    total_pdf = pdf_stats.map(&:to_i).reduce(:+)
+    total_html = html_stats.map(&:to_i).reduce(:+)
+    total_all = total_html + total_pdf
+
     ##Output Nokogiri Doc into csv
     CSV.open(output_file, 'wb') do |row|
       row << ["#{doc_version}", "Release: #{doc_release}"]
@@ -311,17 +325,25 @@ define_method :sushi_call do
       row << ["Date run:"]
       row << ["#{Time.now.strftime("%d/%m/%Y")}"]
 
-      #This row needs to include month/year for each month. So need to get number
-      # of months from above (slice parentheses value) and year from input. Also, commas aren't automatically spacing out to new column when opened in CSV.
+      #Prints all headers
       row << ["Journal", "Publisher", "Platform", "Journal DOI", "Proprietary Identifier", "Print ISSN", "Online ISSN", "Reporting Period Total", "Reporting Period HTML", "Reporting Period PDF", month_array]
-      row << [total_pdf]
-      #Add line that totals all data?
-      # row <<
+      #Prints totals of all data - need to add more totals.
+      row << ["Total for all Journals", "", platform, "","","","", total_all, total_html, total_pdf, total_integer]
 
       #Code below iterates through array, printing each item to a row
       report_data.each do |data|
         row << data
       end
     end
+    rescue
+      puts Rainbow("There was an error running the script. Double check the values you are passing to the script and try adding '--log' to your command
+      to see what went wrong.").bright.red
+    else
+    #Rewrite XML filename to something more useful (e.g. vendor name)?
+    #Add statements to check if files actually created.
+    puts "The XML file is in the" + Rainbow(" 'raw_xml/'").green.bright + " folder and the filename is" + Rainbow(" '#{options[:customer]}-#{Time.now.strftime("%Y%m%d")}.xml'").green.bright
+    puts "Your COUNTER report is in the file" + Rainbow(" '#{ARGV[0]}'").green.bright
+    end
 end
+
 sushi_call()

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sushi_counter
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Max King
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-19 00:00:00.000000000 Z
+date: 2017-10-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: savon
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rainbow
+  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: aruba
   requirement: !ruby/object:Gem::Requirement
@@ -54,7 +68,8 @@ dependencies:
         version: 0.5.3
 description: |-
   Sushi fetches the raw XML from a number of vendors, then
-                      converts that data into a human readable CSV
+                      converts that data into a human readable CSV. For more info please visit
+                      https://github.com/maxdavidking/CLIapp
 email:
 - maxdavidking at gmail.com
 executables: