papercallio 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cab85d981e54ef26446eae7496a567501d989ef4
-  data.tar.gz: 9bc25c08598f02cb385f3b3c654a48c2cd224007
+  metadata.gz: 7d6f9bfeadd5437de30a160eb21f3cf452b1debd
+  data.tar.gz: e56e2c855793bb97c3cbc3142c857710d4a524b6
 SHA512:
-  metadata.gz: 0f098addbedc662b0a19e2345bfee8d441f3b5049f1b6050f5fdb10f83b0b8b34782db33d3387bdbb3bff92ad05547ded8562ef97714d838c9b304f4ba5d81b8
-  data.tar.gz: 2700b74d23164102813ff3640b0a4709393dc2c729875fcf94b452f5ca765f22cb6a658d526ce5640471ca4e77a6da2cc160b076b4a5d204430987ea37d28b3f
+  metadata.gz: 85dcc959243eacf5cc10e6a5fd4a8d42eaa73f9b95d6407babbd5009234724bb6ae0ae580b9ea4bae9540abce85432b73557d879f379dadbdd9978310c1c6387
+  data.tar.gz: fcccea69f1797f4077bb14b5d6a9730c4377feef16092df5cf2495b9382355c44fc2727278657c336be6b8483599d0116afdaf8351f71ab2c33759fa372adb0d

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    papercallio (0.0.1)
+    papercallio (0.1.0)
       gli (= 2.16.0)
       httparty (~> 0.15)
 

data/bin/papercallio

@@ -2,10 +2,20 @@
 require 'gli'
 require 'papercallio'
 require 'csv'
+require 'yaml'
 
 include GLI::App
 
-program_desc 'Command line interface for the papercall.io API'
+program_desc %(Command line interface for the papercall.io API
+             papercallio requires API access to download data.
+             API access is a paid feature, papercallio will not work with the free papercall plan.
+             To obtain your API token, go to the papercall website, click the events tab, choose your event,
+             then choose the Organisers link on the right hand side. On the list of organisers for your event your API
+             token will be listed under your name.
+
+             Once you have your API key export it in your shell
+
+                 export PAPERCALL_API_TOKEN=abcdefghijklmnopqrstuvwxyz1234567890)
 
 version Papercallio::VERSION
 
@@ -14,18 +24,20 @@ api_token = ENV['PAPERCALL_API_TOKEN']
 subcommand_option_handling :normal
 arguments :strict
 
-desc 'Describe some switch here'
-switch [:s,:switch]
-
 desc 'The file path for output'
-default_value 'the subcommand.csv, e.g. event.csv, submissions.csv'
+default_value 'submissions.csv'
 arg_name 'The file path (e.g. ./submissions.csv)'
-flag [:f,:file]
+flag [:f, :file]
 
-desc 'Return submissions in csv file'
-arg_name 'Describe arguments to submissions here'
+desc %(Return submissions in csv file.
+       Add your token as an environment variable for the API.
+
+               export PAPERCALL_API_TOKEN=abcdefghijklmnopqrstuvwxyz1234567890)
+arg_name 'Arguments to manipulate the submissions returned'
 command :submissions do |c|
   c.switch 'needs_rating', :desc => 'Filter results needs rating. Default (false).'
+  c.switch 'include_feedback', :desc => 'Include the feedback for all submissions in the csv (Not currently implemented).'
+  c.switch 'include_ratings', :desc => 'Include the ratings for all submissions in the csv'
 
   c.flag 'state', :default_value => nil,
                   :arg_name => 'state of submissions. ',
@@ -38,6 +50,7 @@ command :submissions do |c|
                   :desc => 'Sort results. Possible values are: state, rating, ratings_count, title, created_at, talk_format_id, audience_level, confidence'
 
   c.action do |global_options,options,args|
+    puts global_options
     pcc = PaperCallClient.new(api_token, options)
     response = pcc.submissions
 
@@ -46,6 +59,7 @@ command :submissions do |c|
     headerset = false
     response.each do |submission|
       line = {}
+      id = nil
       submission.each do |field, value|
         if value.is_a?(Hash)
           value.each do |subfield, subvalue|
@@ -55,49 +69,71 @@ command :submissions do |c|
           next
         end
         line[field] = value
+        id = value if field.eql? 'id'
         headers << field unless headerset
       end
+
+      if options[:include_feedback]
+        #puts "OK!"
+        #submission_feedback = pcc.feedback(id)
+        #puts submission_feedback
+      end
+      if options[:include_ratings]
+        submission_ratings = pcc.rating(id)
+        total_ratings = 0
+        individual_ratings = ''
+        raters = ''
+        submission_ratings.each do |rate|
+          rate.each do |rate_field, rate_value|
+            total_ratings += rate_value if rate_field == 'value'
+            individual_ratings << "#{rate_value}, " if rate_field == 'value'
+            raters << "#{rate_value['name']}, " if rate_field == 'user'
+          end
+        end
+        line[:total_ratings] = total_ratings
+        line[:individual_ratings] = individual_ratings
+        line[:raters] = raters
+        headers.concat([:total_ratings, :individual_ratings, :raters]) unless headerset
+      end
       headerset = true
       submissions << line
       line = {}
     end
-    File.open('submissions.csv', 'w') do |f|
+    File.open(global_options[:file], 'w') do |f|
       f.puts headers.to_csv
       submissions.each do |sub|
         f.puts headers.map { |h| sub[h] }.to_csv
       end
     end
 
-    puts "submissions have been output to submissions.csv"
+    puts "submissions have been output to #{global_options[:file]}"
   end
 end
 
-desc 'Return event as json'
+desc 'Return event as yaml'
 arg_name 'No arguments'
 command :event do |c|
   c.action do |global_options,options,args|
     pcc = PaperCallClient.new(api_token, {})
     response = pcc.event
-    puts response
-    puts "event command ran"
+    puts response.parsed_response.to_yaml
   end
 end
 
-desc 'Return submission as json'
+desc 'Return a single submission as yaml'
 arg_name "Arguments: 'id' identifier of the submission"
-command :rating do |c|
+command :submission do |c|
   c.flag 'id', :default_value => 1,
                :arg_name => 'papercall submission identifier',
                :desc => 'identifier of the submission'
   c.action do |global_options,options,args|
     pcc = PaperCallClient.new(api_token, {})
-    response = pcc.rating(options[:id])
-    puts response
-    puts "submission for id: #{options[:id]} as json"
+    response = pcc.submission(options[:id])
+    puts response.parsed_response.to_yaml
   end
 end
 
-desc 'Return ratings as json'
+desc 'Return ratings for a single submission as yaml'
 arg_name "Arguments: 'id' identifier of the submission"
 command :rating do |c|
   c.flag 'id', :default_value => 1,
@@ -106,12 +142,11 @@ command :rating do |c|
   c.action do |global_options,options,args|
     pcc = PaperCallClient.new(api_token, {})
     response = pcc.rating(options[:id])
-    puts response
-    puts "ratings for id: #{options[:id]} as json"
+    puts response.parsed_response.to_yaml
   end
 end
 
-desc 'Return feedback as json'
+desc 'Return feedback for a single submission as yaml'
 arg_name "Arguments: 'id' identifier of the submission"
 command :feedback do |c|
   c.flag 'id', :default_value => 1,
@@ -120,8 +155,7 @@ command :feedback do |c|
   c.action do |global_options,options,args|
     pcc = PaperCallClient.new(api_token, {})
     response = pcc.feedback(options[:id])
-    puts response
-    puts "feedback for id: #{options[:id]} as json"
+    puts response.parsed_response.to_yaml
   end
 end
 

data/lib/papercallio/version.rb

@@ -1,3 +1,3 @@
 module Papercallio
-  VERSION = '0.0.1'
+  VERSION = '0.1.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: papercallio
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - aaronblythe
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-23 00:00:00.000000000 Z
+date: 2017-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake