lita-link-library 0.0.3 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5f3499aa974e3120831ea886f7f2d85f55aee13b
-  data.tar.gz: 8cdcdb9d4436a59d255074e87727a7e797eb7971
+  metadata.gz: 68a302ffa5361b5da3a1144f5f083484946e1b81
+  data.tar.gz: c00595c6446af5fd19f443df8c67865a03cca65d
 SHA512:
-  metadata.gz: faf67df806d43563492f80e678a2e46b5a5dd12e42aa9ca45703e93150e09d16673f659c934e86bea421b3f2b187f55d10c2f0032df5c13109f97100d30b80d0
-  data.tar.gz: 4ae4bd573c62c934ed3caedad761828e6ec92d2709b094e62ee6bdb51d61d3a1d5ebd895663834e866eb95fa0d2e773b5a998eddcd957291224c6be539ec01c5
+  metadata.gz: 88d954267138cea0c4a2260b59a80b4a29704920ba91de321ac5579c52148922d7891ccb7f2f0c34c3fbd7415477b8e80d9a5b9067b93d858583b658fcf5f98e
+  data.tar.gz: e319cc49ef5beb964748a738a1202ac55151ee9ecd756164418108ecf3fafdded79c43af605f483b39e5158663d1e4985e206f482bf4b5e59c34b59c2da65526

data/README.md

@@ -24,7 +24,7 @@
 
 ####Commands restricted to library admins:
 
-- `add read LINK TITLE DESCRIPTION` => Adds a new entry with that LINK, TITLE and DESCRIPTION attributes in the lita link library.
+- `add read LINK|TITLE|DESCRIPTION` => Adds a new entry with that LINK, TITLE and DESCRIPTION attributes in the lita link library. Please use the <|>pipe<|> character as a delimiter! 
 
 - `remove read TITLE` => Removes the entry with that TITLE from the lita link library.
 

data/lib/lita/handlers/link-library.rb

@@ -1,97 +1,102 @@
 #this class performs CRUD operations on the library file
 require 'json'
 require 'lita'
+
 require_relative 'library_entry'
 
 module Lita
   module Handlers
     class LinkLibrary < Handler
-      
+
       TITLE = /[\w\s\,\.\-\/:–]+/
       LINK = /(https?:\/\/)?([\da-z\.-]+)\.([a-z\.]{2,6})([\/\w \.-]*)*\/?/
       DESCRIPTION = /[\w\s\,\.\-\/:–]+/
-      
+
       route(
-        /^(random read)$/i, 
-        :random_read_command, 
-        command: true, 
-        help: {'random read' => 'Returns a random entry from the lita link library.'}
+      /^(random read)$/i,
+      :random_read_command,
+      command: true,
+      help: {'random read' => 'Returns a random entry from the lita link library.'}
       )
-      
+
       route(
-        /^(give me a gooder)$/i, 
-        :read_best_entries_command, 
-        command: true, 
-        help: {'give me a gooder' => 'Returns top 3 entries from the lita link library.'}
+      /^(give me a gooder)$/i,
+      :read_best_entries_command,
+      command: true,
+      help: {'give me a gooder' => 'Returns top 3 entries from the lita link library.'}
       )
-      
+
       route(
-        /^(list library)$/i, 
-        :list_library_command, 
-        command: true, 
-        help: {'list library' => 'Returns entire lita link library.'}
+      /^(list library)$/i,
+      :list_library_command,
+      command: true,
+      help: {'list library' => 'Returns entire lita link library.'}
       )
-      
+
       route(
-        /^(?:want to read)\s(#{TITLE.source})$/i, 
-        :want_to_read_command, 
-        command: true, 
-        help: {'want to read TITLE' => 'Returns the entry from lita link library with that TITLE.'}
-      ) 
-        
+      /^(?:want to read)\s(#{TITLE.source})$/i,
+      :want_to_read_command,
+      command: true,
+      help: {'want to read TITLE' => 'Returns the entry from lita link library, with that TITLE.'}
+      )
+
       route(
-        /^(?:add read)\s(#{LINK.source})\s(#{TITLE.source})\s(#{DESCRIPTION.source})$/i, 
-        :add_read_command, 
-        command: true,
-        restrict_to: :link_library_admins, 
-        help: {'add read LINK TITLE DESCRIPTION' => 'Adds a new entry in thelita link library '+ 
+      /^(?:add read)\s(#{LINK.source})(\|)(#{TITLE.source})(\|)(#{DESCRIPTION.source})$/i,
+      :add_read_command,
+      command: true,
+      restrict_to: :link_library_admins,
+      help: {'add read LINK|TITLE|DESCRIPTION' => 'Adds a new entry in the lita link library, '+
         'with that LINK, TITLE and DESCRIPTION attributes.'}
       )
       route(
-        /^(remove read)\s(#{TITLE.source})$/i, 
-        :remove_read_command, 
-        command: true, 
-        restrict_to: :link_library_admins,
-        help: {
-        'remove read TITLE' => 'Removes the entry from lita link library with that TITLE.'}
-      ) 
-    
+      /^(?:remove read)\s(#{TITLE.source})$/i,
+      :remove_read_command,
+      command: true,
+      restrict_to: :link_library_admins,
+      help: {
+        'remove read TITLE' => 'Removes the entry from lita link library, with that TITLE.'}
+      )
+
       def random_read_command(response)
         response.reply random_read_entry
       end
-      
+
       def read_best_entries_command(response)
         response.reply read_best_entries
       end
-      
+
       def list_library_command(response)
         response.reply list_library
       end
-      
+
       def want_to_read_command(response)
         title = response.matches.first[0]
         response.reply read_entry(title)
       end
-      
+
       def add_read_command(response)
-        link = response.matches.first[0]
-        title = response.matches.first[5]
-        description = response.matches.first[6]
-        response.reply save_new_entry(link, title, description)
+        if (response.matches.first[5]!='|' or response.matches.first[7]!='|')
+          response.reply('Please use a valid format using the <|>pipe<|> character. <<add read LINK|TITLE|DESCRIPTION>>')
+        else
+          link = response.matches.first[0]
+          title = response.matches.first[6]
+          description = response.matches.first[8]
+          response.reply save_new_entry(link, title, description)
+        end
       end
-      
+
       def remove_read_command(response)
         title = response.matches.first[0]
         response.reply delete_entry(title)
       end
-      
+
       def file_writer (filename, entries)
         open(filename, 'w') do |file|
           file.truncate(0)
           file.write entries.to_json
         end
       end
-    
+
       def save_new_entry (link, title, description) # allows a librarian to save a new entry in the library
         file = File.read 'library.json'
         hash_array = JSON.parse(file)
@@ -107,10 +112,10 @@ module Lita
           new_entry = {"link" => link, "title" => title, "description" => description, "number_of_downloads" => 0}
           hash_array.push new_entry
           file_writer 'library.json', hash_array
-          return "The entry #{title} wass added in the library!"
+          return "The entry #{title} was added in the library!"
         end
       end
-    
+
       def delete_entry (title) # allows a librarian to delete an entry from the library
         file = File.read 'library.json'
         hash_array = JSON.parse(file)
@@ -118,8 +123,8 @@ module Lita
         hash_array.each do |entry|
           if entry.has_value?(title)
             hash_array.reject! {|entry| entry.has_value?(title)}
-            return "The entry with the title: #{title} was deleted"
             file_writer 'library.json', hash_array
+            return "The entry with the title #{title} was deleted"
           else
             entries_counter +=1
           end
@@ -128,16 +133,16 @@ module Lita
           response = "No entry with the title #{title} can be found in the library"
         end
       end
-    
+
       def read_entry (entry_title) # returns an entry with the specified title from the library
         file = File.read 'library.json'
         hash_array = JSON.parse(file)
         entries_counter = 0
         hash_array.each do |entry|
           if entry.has_value?(entry_title)
-            return "#{entry_title} | #{entry['link']} | #{entry['number_of_downloads']} reads | #{entry['description']}"
             entry['number_of_downloads']+=1
             file_writer 'library.json', hash_array
+            return "#{entry_title} | #{entry['link']} | #{entry['number_of_downloads']} reads | #{entry['description']}"
           else
             entries_counter += 1
           end
@@ -146,34 +151,40 @@ module Lita
           return "No entry entitled #{entry_title} can be found in the library DB!"
         end
       end
-    
+
       def random_read_entry # returns a random entry from the library
         file = File.read 'library.json'
         hash_array = JSON.parse(file)
         entry = hash_array.sample
+        entry['number_of_downloads']+=1
+        file_writer 'library.json', hash_array
         return "Random read: #{entry['title']} | #{entry['link']} | #{entry['number_of_downloads']} reads | #{entry['description']}"
       end
-    
+
       def read_best_entries # returns the top 3 downloaded entries from the library
         file = File.read 'library.json'
         hash_array = JSON.parse(file)
-        hash_array.sort! {|a1, a2| a1['number_of_downloads'] <=> a2['number_of_downloads']}
+        return_array=[]
+        hash_array.sort! {|a1, a2| a2['number_of_downloads'] <=> a1['number_of_downloads']}
         for i in 0..2
-          "#{hash_array[i]['title']} | #{hash_array[i]['link']} | #{hash_array[i]['number_of_downloads']} reads | #{hash_array[i]['description']}\n"
+          return_array << "#{hash_array[i]['title']} | #{hash_array[i]['link']} | #{hash_array[i]['number_of_downloads']} reads | #{hash_array[i]['description']}\n"
         end
+        return return_array
       end
-    
+
       def list_library # returns the entire library
         file = File.read 'library.json'
         hash_array = JSON.parse(file)
+        return_array=[]
         hash_array.each do |entry|
           library_entry = LibraryEntry.new entry['link'], entry['title'], entry['description'], entry['number_of_downloads']
-          return "#{library_entry['title']} | #{library_entry['link']} | #{library_entry['number_of_downloads']} reads | #{library_entry['description']}\n"
+          return_array << "#{library_entry.title} | #{library_entry.link} | #{library_entry.number_of_downloads} reads | #{library_entry.description}\n"
         end
+        return return_array
       end
-      
+
     end
-    
+
     Lita.register_handler(LinkLibrary)
   end
 end

data/lita-link-library.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name          = "lita-link-library"
-  spec.version       = "0.0.3"
+  spec.version       = "0.1.0"
   spec.authors       = ["Tudor Munteanu"]
   spec.email         = ["the.tudor.munteanu@gmail.com"]
   spec.description   = %q{A Lita handler that allows you manage a link library.}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lita-link-library
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
 platform: ruby
 authors:
 - Tudor Munteanu
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-25 00:00:00.000000000 Z
+date: 2016-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lita
@@ -82,7 +82,6 @@ files:
 - lib/lita/handlers/library.json
 - lib/lita/handlers/library_entry.rb
 - lib/lita/handlers/link-library.rb
-- lita-link-library-0.0.1.gem
 - lita-link-library.gemspec
 homepage: https://github.com/sijiton/lita-link-library
 licenses:
@@ -105,7 +104,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.3
+rubygems_version: 2.6.0
 signing_key: 
 specification_version: 4
 summary: A Lita handler that allows you manage a link library.