lita-link-library 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5f3499aa974e3120831ea886f7f2d85f55aee13b
+  data.tar.gz: 8cdcdb9d4436a59d255074e87727a7e797eb7971
+SHA512:
+  metadata.gz: faf67df806d43563492f80e678a2e46b5a5dd12e42aa9ca45703e93150e09d16673f659c934e86bea421b3f2b187f55d10c2f0032df5c13109f97100d30b80d0
+  data.tar.gz: 4ae4bd573c62c934ed3caedad761828e6ec92d2709b094e62ee6bdb51d61d3a1d5ebd895663834e866eb95fa0d2e773b5a998eddcd957291224c6be539ec01c5

data/Gemfile

@@ -0,0 +1 @@
+source "https://rubygems.org"

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2016 Tudor Munteanu
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,34 @@
+###A Lita handler that allows you manage a JSON link library.
+
+[![Gem Version](https://badge.fury.io/rb/lita-link-library.svg)](https://badge.fury.io/rb/lita-link-library)
+
+####List of commands:
+
+- `random read` => Returns a random entry from the lita link library.
+
+- `give me a gooder` => Returns top 3 entries from the lita link library.
+
+- `list library` => Returns the entire lita link library.
+
+- `want to read TITLE` => Returns the entry with that TITLE from the lita link library.
+
+
+######The link library itself can be managed by an authorized group of admins. This group is managed by a user defined via the `config.robot.admins` configuration attribute.
+
+- `Lita auth add USER link_library_admins` => Adds USER as a link library admin.
+
+- `Lita auth remove USER link_library_admins` => Removes USER from the link library admins group.
+
+- `Lita auth list` => Displays all the current authorization groups and their members.
+
+
+####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.
+
+- `remove read TITLE` => Removes the entry with that TITLE from the lita link library.
+
+
+#### License
+
+[MIT](http://opensource.org/licenses/MIT)

data/lib/lita/handlers/librarian.rb

@@ -0,0 +1,13 @@
+# this class represents the Model for the entries available in the librarian.json
+
+class Librarian
+
+  attr_accessor :username, :permissions
+
+  def initialize(*args)
+    #@id = args[0]
+    @username = args[0]
+    @permissions = args[1]
+  end
+
+end

data/lib/lita/handlers/librarians.json

@@ -0,0 +1 @@
+[{"username":"cam","permissions":"master"},{"username":"tudormi","permissions":"admin"}]

data/lib/lita/handlers/library.json

@@ -0,0 +1 @@
+[{"link":"www.google.com","title":"google","description":"search engine","number_of_downloads":0}]

data/lib/lita/handlers/library_entry.rb

@@ -0,0 +1,14 @@
+# this class represents the Model for the entries available in the library.json
+
+class LibraryEntry
+
+  attr_accessor :link, :title, :description, :number_of_downloads
+  
+  def initialize(*args)
+    @link = args[0]
+    @title = args[1]
+    @description = args[2]
+    @number_of_downloads = args[3]
+  end
+
+end

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

@@ -0,0 +1,179 @@
+#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.'}
+      )
+      
+      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.'}
+      )
+      
+      route(
+        /^(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.'}
+      ) 
+        
+      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 '+ 
+        '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.'}
+      ) 
+    
+      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)
+      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)
+        entry_exists = false
+        hash_array.each do |entry|
+          if entry.has_value?(title)
+            entry_exists = true
+          end
+        end
+        if entry_exists
+          return "That title already exists in the DB. Please choose another one"
+        else
+          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!"
+        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)
+        entries_counter = 0
+        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
+          else
+            entries_counter +=1
+          end
+        end
+        if entries_counter==hash_array.length
+          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
+          else
+            entries_counter += 1
+          end
+        end
+        if entries_counter==hash_array.length
+          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
+        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']}
+        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"
+        end
+      end
+    
+      def list_library # returns the entire library
+        file = File.read 'library.json'
+        hash_array = JSON.parse(file)
+        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"
+        end
+      end
+      
+    end
+    
+    Lita.register_handler(LinkLibrary)
+  end
+end

data/lib/lita-link-library.rb

@@ -0,0 +1 @@
+require "lita/handlers/link-library"

data/lita-link-library.gemspec

@@ -0,0 +1,21 @@
+Gem::Specification.new do |spec|
+  spec.name          = "lita-link-library"
+  spec.version       = "0.0.3"
+  spec.authors       = ["Tudor Munteanu"]
+  spec.email         = ["the.tudor.munteanu@gmail.com"]
+  spec.description   = %q{A Lita handler that allows you manage a link library.}
+  spec.summary       = %q{A Lita handler that allows you manage a link library.}
+  spec.homepage      = "https://github.com/sijiton/lita-link-library"
+  spec.license       = "[MIT]"
+  spec.metadata      = { "lita_plugin_type" => "handler" }
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "lita", ">= 2.7"
+
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "coveralls"
+  spec.add_dependency "json"
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: lita-link-library
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+platform: ruby
+authors:
+- Tudor Munteanu
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-02-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: lita
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.7'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  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'
+description: A Lita handler that allows you manage a link library.
+email:
+- the.tudor.munteanu@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE
+- README.md
+- lib/lita-link-library.rb
+- lib/lita/handlers/librarian.rb
+- lib/lita/handlers/librarians.json
+- 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:
+- "[MIT]"
+metadata:
+  lita_plugin_type: handler
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.3
+signing_key: 
+specification_version: 4
+summary: A Lita handler that allows you manage a link library.
+test_files: []