chatbot 0.0.2

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in chatbot.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Rohit Kumar
+
+MIT License
+
+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,49 @@
+# Chatbot
+
+Chatbot lets you define chat commands easily. 
+
+## Installation
+
+Clone this repo and then run gem build and gem install, or
+
+Add this line to your application's Gemfile:
+
+    gem 'chatbot', :git => "git://github.com/ronandi/chatbot.git"
+
+And then execute:
+
+    $ bundle
+
+Remember to:
+
+    require('chatbot')
+
+## Usage
+
+Here's an example how to write an echo bot. It just repeats what its given:
+```ruby
+require 'sinatra'
+require 'chatbot'
+
+Chatbot.configure do |config|
+  config.bot_id = "your_bot_id"
+end
+
+post '/' do
+  Chatbot.processMessage(request.body.read)
+end
+
+Chatbot.command "!echo" do |message|
+  puts "im here"
+  message
+end
+
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/chatbot.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'chatbot/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "chatbot"
+  spec.version       = ChatBot::VERSION
+  spec.authors       = ["Rohit Kumar"]
+  spec.email         = ["rohit.kumar@rutgers.edu"]
+  spec.description   = "A simple gem to make writing groupme bots easier"
+  spec.summary       = "A simple gem to make writing groupme bots easier"
+  spec.homepage      = ""
+  spec.license       = "MIT"
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "factory_girl"
+end

data/lib/chatbot.rb

@@ -0,0 +1,9 @@
+require "chatbot/version"
+require "chatbot/main"
+require "chatbot/commandable"
+require "chatbot/groupme_message"
+require "chatbot/groupme_api"
+require "chatbot/groupme_parser"
+require "chatbot/configuration"
+
+Chatbot = ChatBot::Main.new

data/lib/chatbot/commandable.rb

@@ -0,0 +1,15 @@
+module ChatBot
+  module Commandable
+    def is_command?
+      return @message[0] == '!'
+    end
+
+    def command
+      return @message.split(' ').first
+    end
+
+    def body
+      return @message.split(' ').drop(1).join(' ')
+    end
+  end
+end

data/lib/chatbot/configuration.rb

@@ -0,0 +1,12 @@
+module ChatBot
+  class Configuration
+    API_URI = 'https://api.groupme.com/v3/bots/post'
+
+    attr_accessor :api_uri, :bot_id, :api_key
+
+    def initialize
+      @api_uri = API_URI
+    end
+
+  end
+end

data/lib/chatbot/groupme_api.rb

@@ -0,0 +1,12 @@
+require 'net/http'
+require 'json'
+require 'uri'
+
+module ChatBot
+  class GroupMeApi
+    def self.send_message(message, configuration)
+      puts "Sending message to #{configuration.api_uri} with id: #{configuration.bot_id} and message: #{message}"
+      Net::HTTP.post_form(URI.parse(configuration.api_uri), { 'bot_id' => configuration.bot_id, 'text' => message })
+    end
+  end
+end

data/lib/chatbot/groupme_message.rb

@@ -0,0 +1,17 @@
+module ChatBot
+  class GroupMeMessage
+    include Commandable
+
+    attr_reader :message, :sender
+
+    def initialize(message, sender)
+      begin
+        sender = sender.to_str
+      rescue NoMethodError
+        raise ArgumentError, "expected sender to be string"
+      end
+      @message = message || ""
+      @sender = sender
+    end
+  end
+end

data/lib/chatbot/groupme_parser.rb

@@ -0,0 +1,12 @@
+require 'json'
+module ChatBot
+  class GroupMeParser
+    def self.parse(raw_message)
+      gm_msg = JSON.parse(raw_message)
+      if (gm_msg["name"].nil?)
+        raise ArgumentError, "Invalid GroupMe message"
+      end
+      return GroupMeMessage.new(gm_msg["text"], gm_msg["name"])
+    end
+  end
+end

data/lib/chatbot/main.rb

@@ -0,0 +1,43 @@
+module ChatBot
+  class Main
+    def initialize
+      @rule = {}
+    end
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configure
+      yield(configuration) if block_given?
+    end
+
+    def processMessage(rawMessage)
+      message = GroupMeParser.parse(rawMessage)
+      if message.is_command?
+        rule = find_rule(message.command)
+        if rule.nil?
+          puts 'Message did not match a rule'
+        else
+          outmessage = rule.call(message)
+          unless outmessage.nil?
+            send_message(outmessage)
+          end
+        end
+      end
+    end
+
+    def command(command, &block)
+      @rule[command] = block
+    end
+
+    private
+
+    def find_rule(command)
+      return @rule[command]
+    end
+
+    def send_message(message)
+      GroupMeApi.send_message(message, configuration)
+    end
+  end
+end

data/lib/chatbot/version.rb

@@ -0,0 +1,3 @@
+module ChatBot
+  VERSION = "0.0.2"
+end

data/spec/factories.rb

@@ -0,0 +1,17 @@
+FactoryGirl.define do
+  factory :group_me_message, class: ChatBot::GroupMeMessage do
+    ignore do
+      message 'Sample message'
+      sender 'Sample user'
+    end
+    initialize_with { ChatBot::GroupMeMessage.new(message, sender) }
+  end
+
+  factory :group_me_message_with_command, class: ChatBot::GroupMeMessage do
+    ignore do
+      message '!command Sample message'
+      sender 'Sample user'
+    end
+    initialize_with { ChatBot::GroupMeMessage.new(message, sender) }
+  end
+end

data/spec/groupme_message.rb

@@ -0,0 +1,34 @@
+require './spec_helper'
+
+module ChatBot
+  describe GroupMeMessage do
+    describe '.initialize' do
+      context 'with a hash containing a text and name' do
+        it 'should assign text to message, and sender to name' do
+          message = GroupMeMessage.new('msg','user')
+          message.message.should == 'msg'
+          message.sender.should == 'user'
+        end
+      end
+      context 'without string arguments' do
+        it 'should raise an ArgumentError' do
+          expect { GroupMeMessage.new(2, 3) }.to raise_error(ArgumentError)
+        end
+      end
+    end
+    describe '.is_command' do
+      context 'when the message is a command' do
+        it 'should return true' do
+          message = FactoryGirl.build(:group_me_message_with_command)
+          message.is_command?.should == true
+        end
+      end
+      context 'when the message is not a command' do
+        it 'should return false' do
+          message = FactoryGirl.build(:group_me_message)
+          message.is_command?.should == false
+        end
+      end
+    end
+  end
+end

data/spec/groupme_parser.rb

@@ -0,0 +1,20 @@
+require './spec_helper'
+
+module ChatBot
+  describe GroupMeParser do
+    describe ".parse" do
+      context "with valid groupme message"
+      it "should return a GroupMeMessage" do
+        msg = GroupMeParser.parse('{"name":"user", "text":"sample"}')
+        msg.should be_an_instance_of(GroupMeMessage)
+        msg.message.should eq "sample"
+        msg.sender.should eq "user"
+      end
+    end
+    context "with invalid groupme message" do
+      it "should raise an exception" do
+        expect{GroupMeParser.parse('{"something":"user", "text":"sample"}')}.to raise_error(ArgumentError)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require '../lib/chatbot/commandable'
+require '../lib/chatbot/groupme_message'
+require '../lib/chatbot/groupme_parser'
+require 'factory_girl'
+
+FactoryGirl.find_definitions

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: chatbot
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- Rohit Kumar
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: factory_girl
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A simple gem to make writing groupme bots easier
+email:
+- rohit.kumar@rutgers.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- chatbot.gemspec
+- lib/chatbot.rb
+- lib/chatbot/commandable.rb
+- lib/chatbot/configuration.rb
+- lib/chatbot/groupme_api.rb
+- lib/chatbot/groupme_message.rb
+- lib/chatbot/groupme_parser.rb
+- lib/chatbot/main.rb
+- lib/chatbot/version.rb
+- spec/factories.rb
+- spec/groupme_message.rb
+- spec/groupme_parser.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: A simple gem to make writing groupme bots easier
+test_files:
+- spec/factories.rb
+- spec/groupme_message.rb
+- spec/groupme_parser.rb
+- spec/spec_helper.rb