Class: LENSE

Inherits:
Object
  • Object
show all
Defined in:
lib/lense.rb

Constant Summary collapse

VERSION = 
'0.3.6'
LENSE_DIR = 
File.join(ENV['HOME'],'.lense')
COURSES_DIR = 
File.join(LENSE_DIR,'courses')
CURRENT_COURSE_FILE = 
File.join(LENSE_DIR,'current_course')
LOCAL_LENSE_DIR = 
File.join(ENV['PWD'],'.lense')
DEPS_DIR = 
File.join(LOCAL_LENSE_DIR,'deps')
REFS_DIR = 
File.join(LOCAL_LENSE_DIR,'refs')
CURRENT_REF_FILE = 
File.join(REFS_DIR,'current')
LENSE_FILE = 
File.join(ENV['PWD'],'LENSEfile')
API_BASE = 
'http://lightweightnetsec.com'
TARFLAGS = 
'z'

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ LENSE

Returns a new instance of LENSE.



23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
 
# File 'lib/lense.rb', line 23

def initialize()
  Dir.mkdir(LENSE_DIR) unless File.directory?(LENSE_DIR)
  Dir.mkdir(COURSES_DIR) unless File.directory?(COURSES_DIR)
  File.open(CURRENT_COURSE_FILE, 'w') {} unless File.file?(CURRENT_COURSE_FILE)

  config_file = File.join(LENSE_DIR,'config')
  config_str = File.file?(config_file) ? File.read(config_file) : ''

  @config = Psych.load(config_str) || {}

  @current_course = File.read(CURRENT_COURSE_FILE).strip()
  @current_course = '> NOT SET <' if @current_course.empty?
  @lense_file_hash = hash_file(LENSE_FILE) if File.file?(LENSE_FILE)
  @DB = SQLite3::Database.new File.join(LOCAL_LENSE_DIR,'db') if File.file? File.join(LOCAL_LENSE_DIR,'db')
end

Instance Attribute Details

#config ⇒ Object (readonly)

Returns the value of attribute config.



9
10
11
 
# File 'lib/lense.rb', line 9

def config
  @config
end

#current_course ⇒ Object (readonly)

Returns the value of attribute current_course.



9
10
11
 
# File 'lib/lense.rb', line 9

def current_course
  @current_course
end

#lense_file_hash ⇒ Object (readonly)

Returns the value of attribute lense_file_hash.



9
10
11
 
# File 'lib/lense.rb', line 9

def lense_file_hash
  @lense_file_hash
end

Instance Method Details

#clone(repo) ⇒ Object 



329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
 
# File 'lib/lense.rb', line 329

def clone(repo)
  exit_now!("Invalid repo name.") unless repo =~ /\A\w+\/\w+\Z/
  username, project_name = repo.split '/'

  say "making dirs ..."
  # make repo dir in current directory
  Dir.mkdir project_name unless File.directory? project_name

  # cd into project dir
  Dir.chdir project_name

  # make .lense dir and .lense/temp
  proj_lense_dir = '.lense'
  Dir.mkdir proj_lense_dir unless File.directory? proj_lense_dir

  temp_dir = File.join proj_lense_dir, 'temp'
  Dir.mkdir temp_dir unless File.directory? temp_dir

  # write repository name
  repo_file = File.join proj_lense_dir, 'repository'
  File.open(repo_file, 'w') { |f| f.write repo } unless File.file? repo_file

  install_repo repo, 'clone'
end

#commit(msg) ⇒ Object 



173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
 
# File 'lib/lense.rb', line 173

def commit(msg)
  # check that we have items in staging
  rows = @DB.execute 'select path from staging;'
  rows.map! do |r|
    path = r[0]
    {
      path: path,
      hash: hash_file(path)
    }
  end

  # only select new or modified files
  files = rows.select do |file|
    dependency = get_dependency(file[:path])
    dependency.nil? || dependency[:file_hash] != file[:hash]
  end

  # generate commit hash
  combined_hash = files.map {|f| f[:hash]}.join ''
  commit_hash = hash_contents "#{DateTime.now.to_s}#{combined_hash}"

  # save to db
  @DB.execute 'insert into commits (hash,message,created_at) values (?,?,?);',[commit_hash,msg,DateTime.now.to_s]
  commit_id = @DB.last_insert_row_id

  # add file revisions for all new/modified dependencies
  files.each do |file|
    @DB.transaction
    dependency = get_dependency(file[:path])
    if dependency.nil?
      @DB.execute 'insert into dependencies (path,added_at) values (?,?);',[file[:path],DateTime.now.to_s]
      dependency_id = @DB.last_insert_row_id
    else
      dependency_id = dependency[:id]
    end
    @DB.execute 'insert into revisions (commit_id,dependency_id,hash,created_at) values (?,?,?,?);',[commit_id,dependency_id,file[:hash],DateTime.now.to_s]
    @DB.commit
  end

  # empty staging
  @DB.transaction
  @DB.execute 'delete from staging;'
  @DB.commit
end

#down ⇒ Object 



275
276
277
278
279
280
281
282
 
# File 'lib/lense.rb', line 275

def down
  lense = read_lensefile
  lense['down'].each do |cmd|
    say "<%= color('running: ',:green) %> #{cmd}"
    output = `#{cmd}`
    say "<%= color(' => ',:blue) %> #{output}"
  end if lense['down']
end

#get_commit_log ⇒ Object 



256
257
258
259
260
261
262
 
# File 'lib/lense.rb', line 256

def get_commit_log()
  rows = @DB.execute 'select id, message, hash, created_at from commits order by created_at desc;'
  rows.each do |row|
    id, message, hash, created_at = row
    say "<%= color('#{id}',:blue) %> | #{created_at} | <%= color('#{hash}',:green) %> | #{message}"
  end
end

#init ⇒ Object 



116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/lense.rb', line 116

def init()
  Dir.mkdir(LOCAL_LENSE_DIR) unless File.directory?(LOCAL_LENSE_DIR)
  Dir.mkdir(DEPS_DIR) unless File.directory?(DEPS_DIR)
  Dir.mkdir(REFS_DIR) unless File.directory?(REFS_DIR)
  File.open(CURRENT_REF_FILE, 'w') {} unless File.file?(CURRENT_REF_FILE)
  unless File.file?(LENSE_FILE)
    File.open(LENSE_FILE,'w') do |file|
      file.puts "---"
      file.puts "title: Uninitialized Project"
      file.puts "difficulty:"
      file.puts "authors: []"
      file.puts "dependencies: []"
      file.puts "up:"
      file.puts " - echo 'Hello'"
      file.puts "down:"
      file.puts " - echo 'Goodbye!'"
      file.puts "lesson_plan: []"
    end
    say "Created template LENSEfile"
  end
  setup_db()
end

#install_repo(repo, action) ⇒ Object 



354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
 
# File 'lib/lense.rb', line 354

def install_repo(repo,action)
  say "making rest call"
  response = RestClient.get "#{API_BASE}/#{repo}/#{action.to_s}", { params: { format: 'json' } }
  repository = JSON.parse(response)

  # reading and checking tar file
  tar_str = Base64::decode64 repository["tar_file_base64"]
  tar_hash = repository["tar_file_fingerprint"]
  say "tar hash #{tar_hash}"

  exit_now!("Failed download. Hash does not match.") unless hash_contents(tar_str) == tar_hash

  tar_fname = "#{tar_hash}.tar"
  say "writing tar file ... #{tar_fname}"

  rel_tar_path = File.join '.lense', 'temp', tar_fname
  File.open(rel_tar_path, 'w') { |f| f.write tar_str }

  # untar
  say "untaring to ... #{rel_tar_path}"
  `tar -x#{TARFLAGS}f #{rel_tar_path}`

  say "done"
  lense = read_lensefile
  lense['dependencies'].each do |dep|
    next unless dep['url']

    # check if file already exists
    if File.file? dep['path']
      # skip if same hash
      if dep['hash'] == hash_file(dep['path'])
        say "Skipping #{dep['path']}"
        next
      # error if different
      else
        exit_now!("File already exists and has been modified: #{dep['path']}")
      end
    end

    dirs, path = File.split dep['path']
    FileUtils.mkdir_p dirs unless File.directory? dirs
    begin
      say "fetching #{dep['path']} from #{dep['url']}"
      file_str = RestClient.get dep['url']
      exit_now!("Problem downloading file: #{dep['path']}") unless dep['hash'] == hash_contents(file_str)
      File.open(path,'w') { |f| f.write file_str }
    rescue
      exit_now!("Unable to fetch dependency: #{dep['url']}")
    end
  end
end

#list_courses ⇒ Object 



53
54
55
56
57
58
59
60
 
# File 'lib/lense.rb', line 53

def list_courses()
  puts "Installed courses ..."
  Dir.entries(COURSES_DIR).each do |c|
    prefix = c == @current_course ? " > " : "   "
    puts "#{prefix}#{c}" unless ['.','..'].include? c
  end
  puts "> Indicates current course"
end

#pull ⇒ Object 



324
325
326
327
 
# File 'lib/lense.rb', line 324

def pull()
  repo = validate_in_repo
  install_repo repo, 'pull'
end

#push ⇒ Object 



284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
 
# File 'lib/lense.rb', line 284

def push()
  repo = validate_in_repo
  user, project = repo.split '/'
  rows = @DB.execute "select path from dependencies where not deleted;"
  rows.map! { |r| r[0] }

  # only include files < 10 megabytes
  max_size_10megs = 10485760
  deps = rows.select do |path|
    File.size(path) <= max_size_10megs
  end

  Dir.mkdir '.lense/temp' unless File.directory? '.lense/temp'
  db_hash = hash_file '.lense/db'
  tar_fname = "#{user}_#{project}_#{db_hash}.tar"
  tar_path = ".lense/temp/#{tar_fname}"

  cmd = "tar -c#{TARFLAGS}f #{tar_path} .lense/db #{deps.join ' '}"
  say "taring up with: #{cmd}"
  `#{cmd}`

  lense = read_lensefile
  post_body =  {
    format: 'json',
    user_token: 'z5kqZTsKU_oXvC3d5j96',
    tar_file_base64: {
      data: Base64::encode64(File.read(tar_path)),
      filename: tar_fname,
      content_type: "application/x-tar",
    },
    lesson: {
      title: lense['title'],
      difficulty: lense['difficulty'],
      description: lense['description'],
    }
  }
  response = RestClient.post "#{API_BASE}/#{repo}/push", post_body
  say "response: #{response}"
end

#remove(file) ⇒ Object 



253
254
 
# File 'lib/lense.rb', line 253

def remove(file)
end

#run ⇒ Object 



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
 
# File 'lib/lense.rb', line 76

def run()
  q_prefix = '<%= color("Q? ",:red) %>'
  hint_prefix = '<%= color("Hint: ",:yellow) %>'
  say_prefix = '<%= color("% ",:blue) %>'
  answer_prefix = '<%= color("Ans: ",:red) %>'
  question_separator = '<%= color("---",:green) %>'

  lense = read_lensefile

  lense ['lesson_plan'].each do |lesson|
    say question_separator
    say "#{say_prefix} #{lesson['say']}" if lesson['say']

    if lesson['question'] && lesson['question']['ask']
      asked, hint_limit, max_asked, correct  = 0, 3, 5, false

      until correct || asked >= max_asked do
        asked += 1
        question = lesson['question']['ask']
        hint = lesson['question'] && lesson['question']['hint']

        show_hint = ''
        if hint && asked > hint_limit
          show_hint = "\n#{hint_prefix} #{hint}"
        end

        attempt = "(Attempt #{asked} of #{max_asked})"
        response = ask "#{q_prefix} #{question} #{attempt}#{show_hint}"
        correct = response == lesson['question']['expect']
      end

      if correct
        say "<%= color('Correct!',:green) %>"
      else
        say "#{answer_prefix} #{lesson['question']['expect']}"
      end
    end
  end
end

#search(term) ⇒ Object 



62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/lense.rb', line 62

def search(term)
  puts "Searching course repository ..."
  response = RestClient.get "#{API_BASE}/lessons", { params: { format: 'json', text: term } }
  courses = JSON.parse(response)
  courses.each do |c|
    say "<%= color('---',:green) %>"
    say "Repository: #{c['repo_name']}"
    say "Title: #{c['title']}"
    print "Difficulty: "
    c['difficulty'].times { print '*' }
    puts ""
  end
end

#select_course(course) ⇒ Object 



39
40
41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/lense.rb', line 39

def select_course(course)
  courses = Dir.entries(COURSES_DIR)
  course_available = courses.include? course

  if course_available && course != @current_course
    File.open(CURRENT_COURSE_FILE, 'w') { |f| f.write course }
    course
  elsif course == @current_course
    nil
  else
    raise "Cannot find course (#{course})"
  end
end

#stage(file) ⇒ Object 



218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
 
# File 'lib/lense.rb', line 218

def stage(file)
  if File.file?(file)
    dependency = get_dependency(file)
    if dependency.nil?
      should_stage = true
    else
      current_hash = hash_file(file)

      # is it modified?
      if dependency[:file_hash] == current_hash
        should_stage = false
      else
        should_stage = true
      end
    end

    if should_stage
      begin
        @DB.transaction
        @DB.execute "insert into staging (path) values (?);", file
        @DB.commit
      rescue
      end
    end
  end
end

#status ⇒ Object 



139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
 
# File 'lib/lense.rb', line 139

def status()
  exit_now!("Not a LENSE project: .lense") unless File.directory?(LOCAL_LENSE_DIR)

  rows = @DB.execute("select path from staging;")
  say "Staged Files:\n" if rows.length > 0
  rows.each do |row|
    path = row[0]
    dependency = get_dependency(path)
    action = dependency.nil? ? 'New File' : 'Modified'
    say "\t<%= color('#{action}: #{path}',:green) %>"
  end

  rows = @DB.execute 'select path from dependencies where not deleted;'
  rows.map! do |row|
    path = row[0]
    {
      path: path,
      hash: hash_file(path),
    }
  end
  files = rows.select do |file|
    dependency = get_dependency(file[:path])
    hash = hash_file(file[:path])
    hash != dependency[:file_hash]
  end

  if files.length > 0
    say "\nUnstaged Modified Files:\n"
  end
  files.each do |file|
    say "\t<%= color('Modified: #{file[:path]}',:red) %>"
  end
end

#unstage(file) ⇒ Object 



245
246
247
248
249
250
251
 
# File 'lib/lense.rb', line 245

def unstage(file)
  if File.file?(file)
    @DB.transaction
    @DB.execute "delete from staging where path = ?;", file
    @DB.commit
  end
end

#up ⇒ Object 



264
265
266
267
268
269
270
271
272
273
 
# File 'lib/lense.rb', line 264

def up
  lense = read_lensefile
  lense['up'].each do |cmd|
    say "<%= color('running: ',:green) %> #{cmd}"
    output = `#{cmd}`
    say "<%= color(' => ',:blue) %> #{output}"
  end if lense['up']

  run
end