lita-service 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 74840cf12e701b8563b21eaa8f5d1591927b3240
+  data.tar.gz: d063cf8f4dd14ec643076ef2f3b114dfaf0ecdb4
+SHA512:
+  metadata.gz: afb34ca45f217a64655d63c2db9fe0e03f1496e249fce39bdda900986e2b8bdc17602a1abb972d36e3e1a7aa06187e57a7566395caf952c7135b078a175ee470
+  data.tar.gz: 7ae656a384fceb9a4e3e6880c327ee71f83ab18c1608a1b8a28fe233939d7b48af50d5cccfb1e732d450f0100a8ef984a032f5a7a4e441c814bb658c7aab6c50

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+.byebug_history
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rubocop.yml

@@ -0,0 +1,5 @@
+Style/FileName:
+   Exclude: [ 'lib/lita-service.rb' ]
+   
+Metrics/LineLength:
+   Max: 90

data/.ruby-version

@@ -0,0 +1 @@
+2.3.0

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+cache: bundler
+rvm:
+  - 2.3.0
+script: bundle exec rake
+before_install:
+  - gem update --system
+services:
+  - redis-server

data/Gemfile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+source 'https://rubygems.org'
+
+gemspec

data/README.md

@@ -0,0 +1,55 @@
+# lita-service
+
+[![Build Status](https://travis-ci.org/equintana/lita-service.png?branch=master)](https://travis-ci.org/equintana/lita-service)
+[![Coverage Status](https://coveralls.io/builds/8637437/badge)](https://coveralls.io/builds/8637437)
+
+Plugin to create a service with value or custom value per client and to manage how many times a customer use or consume this service.
+
+## Installation
+
+Add lita-service to your Lita instance's Gemfile:
+
+``` ruby
+gem "lita-service"
+```
+
+## Usage
+
+``` sh
+ lita service list
+ lita service create        <NAME> <*VALUE>                 # Value will be set to 0 if empty.
+ lita service show          <NAME>
+ lita service delete|remove <NAME>
+
+ lita service <NAME> inscribe      <CUSTOMER> <*VALUE>      # Value will be set to service's value if empty.
+ lita service <NAME> delete|remove <CUSTOMER>
+ lita service <NAME> add|sum       <CUSTOMER> <*QUANTITY>   # Quantity will be set to 1 if empty.
+ lita service <NAME> add|sum all   <*QUANTITY>              # Quantity will be set to 1 if empty.
+ lita service <NAME> value         <CUSTOMER> <VALUE>
+ lita service <NAME> reset         <CUSTOMER>
+```
+
+To show the available commands
+```
+ lito help service
+```
+
+## Example
+
+``` sh
+ lita service list
+ lita service create awesome-service 200
+ lita service show awesome-service
+ lita service delete awesome-service
+ lita service remove awesome-service
+
+ lita service awesome-service inscribe erlinis
+ lita service awesome-service add erlinis 2
+ lita service awesome-service sum erlinis 2
+ lita service awesome-service add all 3
+ lita service awesome-service sum all 3
+ lita service awesome-service delete erlinis
+ lita service awesome-service remove erlinis
+ lita service awesome-service value erlinis 300
+ lita service awesome-service reset erlinis
+```

data/Rakefile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new
+
+task default: [:spec, :rubocop]

data/lib/lita-service.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+require 'lita'
+
+Lita.load_locales Dir[File.expand_path(
+  File.join('..', '..', 'locales', '*.yml'), __FILE__
+)]
+
+require 'lita/handlers/service'
+require 'lita/handlers/customer'
+require 'lita/interactors/base_interactor'
+require 'lita/interactors/list_services'
+require 'lita/interactors/create_service'
+require 'lita/interactors/show_service'
+require 'lita/interactors/delete_service'
+require 'lita/interactors/inscribe_customer'
+require 'lita/interactors/change_value'
+require 'lita/interactors/add_quantity'
+require 'lita/interactors/reset_quantity'
+require 'lita/interactors/add_all'
+require 'lita/interactors/delete_customer'
+require 'lita/helpers/messages_helper'
+
+Lita::Handlers::Service.template_root File.expand_path(
+  File.join('..', '..', 'templates'),
+  __FILE__
+)

data/lib/lita/handlers/customer.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+module Lita
+  module Handlers
+    # Handles all commands related to the customer
+    class Customer < Handler
+      namespace :service
+
+      def self.template_root
+        File.expand_path('../../../templates', __dir__)
+      end
+
+      # Routes
+      route(/service ([\w-]+) inscribe ([\@\w-]+)( [0-9]*)?/, :inscribe,
+            command: true,
+            help: { 'service _<name>_ inscribe _<user> <*value>_' =>
+                    'Registers to _<user>_ with value _<*value>_ on service _<name>_' })
+
+      route(/service ([\w-]+) (add|sum) ((?!(?:all))[\@\w-]+)( [0-9-]*)?/, :add,
+            command: true,
+            help: { 'service _<name>_ add|sum  _<user> <*quantity>_' =>
+                    'Adds _<*quantity>_ or 1 to a _<user>_ ' })
+
+      route(/service ([\w-]+) (add|sum) all( [0-9-]*)?$/, :add_all,
+            command: true,
+            help: { 'service _<name>_ add|sum all _<*quantity>_' =>
+                    'Adds _<*quantity>_ or 1 to all users on service' })
+
+      route(/service ([\w-]+) reset ([\@\w-]+)/, :reset,
+            command: true,
+            help: { 'service _<name>_ reset _<user>_' =>
+                    'Sets the quantity of the _<user>_ to zero' })
+
+      route(/service ([\w-]+) value ([\@\w-]+) ([0-9-]*)$/, :change_value,
+            command: true,
+            help: { 'service _<name>_ value _<user> <value>_' =>
+                    'Sets the value _<value>_ to the _<user>_ on service' })
+
+      route(/service ([\w-]+) (delete|remove) ([\@\w-]+)/, :delete_customer,
+            command: true,
+            help: { 'service _<name>_ delete|remove _<user>_' =>
+                    'Deletes a _<user>_ from a service called _<name>_' })
+
+      # Callbacks
+      def inscribe(response)
+        interactor = Interactors::InscribeCustomer.new(self, response.match_data).perform
+        template = :message
+        message = { message: interactor.message }
+        reply(template, message, response, interactor)
+      end
+
+      def change_value(response)
+        interactor = Interactors::ChangeValue.new(self, response.match_data).perform
+        template = :message
+        message = { message: interactor.message }
+        reply(template, message, response, interactor)
+      end
+
+      def add(response)
+        interactor = Interactors::AddQuantity.new(self, response.match_data).perform
+        template = :message
+        message = { message: interactor.message }
+        reply(template, message, response, interactor)
+      end
+
+      def add_all(response)
+        interactor = Interactors::AddAll.new(self, response.match_data).perform
+        template = :message
+        message = { message: interactor.message }
+        reply(template, message, response, interactor)
+      end
+
+      def reset(response)
+        interactor = Interactors::ResetQuantity.new(self, response.match_data).perform
+        template = :message
+        message = { message: interactor.message }
+        reply(template, message, response, interactor)
+      end
+
+      def delete_customer(response)
+        interactor = Interactors::DeleteCustomer.new(self, response.match_data).perform
+        template = :message
+        message = { message: interactor.message }
+        reply(template, message, response, interactor)
+      end
+
+      def reply(template, message, response, interactor)
+        unless interactor.success?
+          template = :error
+          message = { error: interactor.error }
+        end
+        response.reply(render_template(template, message))
+      end
+
+      Lita.register_handler(self)
+    end
+  end
+end

data/lib/lita/handlers/service.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+module Lita
+  module Handlers
+    # Handles all commands relative to the service
+    class Service < Handler
+      namespace :service
+
+      # Routes
+      route(/service ping/, :pong,
+            command: true,
+            help: { 'service ping' =>
+                    'Replys _pong_ if the plugin is running' })
+
+      route(/service list/, :list,
+            command: true,
+            help: { 'service list' =>
+                    'List all services' })
+
+      route(/service create ([\w-]+)( [0-9]*)?/, :create,
+            command: true,
+            help: { 'service create _<name> <*value>_' =>
+                    'Create a new service called _<name>_ with value _<*value>_' })
+
+      route(/service show ([\w-]+)/, :show,
+            command: true,
+            help: { 'service show _<name>_' =>
+                    'Shows information on service called _<name>_' })
+
+      route(/service (delete|remove) ([\w-]+)/, :delete,
+            command: true,
+            help: { 'service delete|remove _<name>_' =>
+                    'Deletes a service called _<name>_' })
+
+      # Callbacks
+      def pong(response)
+        response.reply 'pong!'
+      end
+
+      def list(response)
+        interactor = Interactors::ListServices.new(self, response.match_data).perform
+        template = :list_services
+        message = { services: interactor.message }
+        reply(template, message, response, interactor)
+      end
+
+      def create(response)
+        interactor = Interactors::CreateService.new(self, response.match_data).perform
+        template = :service_created
+        message = { service: interactor.message }
+        reply(template, message, response, interactor)
+      end
+
+      def show(response)
+        interactor = Interactors::ShowService.new(self, response.match_data).perform
+        template = :service_show
+        message = { service: interactor.message }
+        reply(template, message, response, interactor)
+      end
+
+      def delete(response)
+        interactor = Interactors::DeleteService.new(self, response.match_data).perform
+        template = :message
+        message = { message: interactor.message }
+        reply(template, message, response, interactor)
+      end
+
+      def reply(template, message, response, interactor)
+        unless interactor.success?
+          template = :error
+          message = { error: interactor.error }
+        end
+        response.reply(render_template(template, message))
+      end
+
+      Lita.register_handler(self)
+    end
+  end
+end

data/lib/lita/helpers/messages_helper.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+module Lita
+  module Helpers
+    # Message Helper
+    module MessagesHelper
+      def msg_duplicated(service_name:)
+        I18n.t('lita.handlers.service.errors.duplicated',
+               service_name: service_name)
+      end
+
+      def msg_not_found(service_name:)
+        I18n.t('lita.handlers.service.errors.not_found',
+               service_name: service_name)
+      end
+
+      def msg_customer_not_found(service_name:, customer_name:)
+        I18n.t('lita.handlers.service.customer.not_found',
+               service_name: service_name, customer_name: customer_name)
+      end
+
+      def msg_customer_duplicated(service_name:, customer_name:)
+        I18n.t('lita.handlers.service.customer.duplicated',
+               service_name: service_name,
+               customer_name: customer_name)
+      end
+    end
+  end
+end

data/lib/lita/interactors/add_all.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+require 'lita/helpers/messages_helper'
+
+module Lita
+  module Interactors
+    # Increases all customers' quantity with the given value
+    # or with 1 if nothing is specified.
+    class AddAll < BaseInteractor
+      include Lita::Helpers::MessagesHelper
+
+      attr_reader :data
+      DEFAULT_QUANTITY = 1
+
+      def initialize(handler, data)
+        @handler = handler
+        @data = data
+      end
+
+      def perform
+        if service_exists?
+          update_all_quantities
+        else
+          @error = msg_not_found(service_name: name)
+        end
+        self
+      end
+
+      private
+
+      def name
+        @name ||= data[1]
+      end
+
+      def given_quantity
+        @customer_quantity ||= data[3].to_s
+      end
+
+      def service
+        @service ||= repository.find(name)
+      end
+
+      def service_exists?
+        repository.exists?(name)
+      end
+
+      def update_all_quantities
+        increment_quantities
+        repository.update(service)
+        @message = I18n.t('lita.handlers.service.add_all.success',
+                          quantity: quantity_calculated)
+      end
+
+      def increment_quantities
+        quantity = quantity_calculated
+        service[:customers].map do |_key, customer_data|
+          customer_data[:quantity] += quantity
+        end
+      end
+
+      def quantity_calculated
+        return given_quantity.to_i unless given_quantity.empty?
+        DEFAULT_QUANTITY
+      end
+    end
+  end
+end

data/lib/lita/interactors/add_quantity.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+require 'lita/helpers/messages_helper'
+
+module Lita
+  module Interactors
+    # Adds the given quantity to the customer's balance
+    class AddQuantity < BaseInteractor
+      include Lita::Helpers::MessagesHelper
+
+      attr_reader :data
+      DEFAULT_QUANTITY = 1
+
+      def initialize(handler, data)
+        @handler = handler
+        @data = data
+      end
+
+      def perform
+        if service_exists?
+          update_costumer_if_exist
+        else
+          @error = msg_not_found(service_name: name)
+        end
+        self
+      end
+
+      private
+
+      def name
+        @name ||= data[1]
+      end
+
+      def customer_name
+        @customer_name ||= data[3].delete('@')
+      end
+
+      def customer_quantity
+        @customer_quantity ||= data[4].to_s
+      end
+
+      def service
+        @service ||= repository.find(name)
+      end
+
+      def service_exists?
+        repository.exists?(name)
+      end
+
+      def customer_exists?
+        service[:customers].keys.include?(customer_name.to_sym)
+      end
+
+      def update_costumer_if_exist
+        if customer_exists?
+          update_customer_quantity
+        else
+          @error = msg_customer_not_found(service_name: name,
+                                          customer_name: customer_name)
+        end
+      end
+
+      def update_customer_quantity
+        new_quantity = increment_quantity
+        repository.update(service)
+        @message = I18n.t('lita.handlers.service.add.success',
+                          quantity: quantity_calculated,
+                          customer_name: customer_name,
+                          customer_quantity: new_quantity)
+      end
+
+      def increment_quantity
+        service[:customers][customer_name.to_sym][:quantity] += quantity_calculated
+      end
+
+      def quantity_calculated
+        return customer_quantity.to_i unless customer_quantity.empty?
+        DEFAULT_QUANTITY
+      end
+    end
+  end
+end