synthetic 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: df6b95d2c2b85ab76e23ea2837633066ca4f9d4b
+  data.tar.gz: 5ec543d4af20f3ccd38f5cd45b1644a41e88bd5f
+SHA512:
+  metadata.gz: 1c031184d81ab4d2a5a3de399c71b1f1bbc177a9796994af77ac9ecdc40e4de90b27e9019dc1ec37ac9963cd25e8b22d9e78ceedd18981fdc072ca482ac1ab58
+  data.tar.gz: 15b99274c69570c41f921c6690b96f3bde3b2dbcd4fbb96478fbbc0df911fd93a1ea8265f0151361167af10e96a74557001711bc5752b968a9a8b94e3d9aee1a

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/CHANGES.md

@@ -0,0 +1,6 @@
+Synthetic Bot Framework Changes
+===============================
+
+## v0.1.0 - *2013-11-10*
+
+- First development prototype.

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Justin Workman
+
+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,22 @@
+Synthetic Bot Framework
+=======================
+
+Synthetic is an IRC bot framework based on Cinch and Wit. It is in the early
+development stages.
+
+Installation and usage examples will be provided before the first stable
+release, but for now you're on your own.
+
+## 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
+
+## License
+
+Copyright © 2013 [Justin Workman](mailto:xtagon@gmail.com)
+
+MIT License, see LICENSE.txt

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/bin/synthetic

@@ -0,0 +1,35 @@
+#!/usr/bin/env ruby
+
+require 'slop'
+
+Slop.parse help: true do
+	# Version
+	# -------
+	on :v, :version, 'Print the version.' do
+		require 'synthetic/version'
+		puts "Synthetic v#{Synthetic::VERSION}"
+	end
+
+	# Start
+	# -----
+	command 'start' do
+		on :w=, :wit_token=, 'Wit access token (required)'
+		on :r=, :root=,      "Your bot's root directory (default current directory)", default: ENV['PWD']
+		on :s=, :server=,    'IRC server (default localhost)', default: 'localhost'
+		on :p=, :port=,      'Server port (default 6667)', default: 6667, as: Integer
+		on :c=, :channels=,  'List of channels to join', as: Array, default: []
+		on :n=, :nicks=,     'Bot nick(s)', as: Array, default: ['SynthBot']
+		on :u=, :user=,      'Bot User Name', default: 'SynthBot'
+		on :R=, :realname=,  'Bot Real Name', default: 'SynthBot'
+		on :P=, :password=,  'Bot Password', default: nil
+		on :m=, :modes=,     'Modes', as: Array, default: []
+		on :i=, :ping=,      'Ping interval (in seconds)', as: Integer, default: 120
+
+		run do |options, args|
+			abort options.help if options[:wit_token].nil?
+
+			require 'synthetic'
+			Synthetic::Bot.new(options.to_hash).start
+		end
+	end
+end

data/lib/synthetic/bot.rb

@@ -0,0 +1,68 @@
+module Synthetic
+	require 'cinch'
+	require 'cinch/wit'
+
+	require 'synthetic/configuration/bot'
+	require 'synthetic/controller'
+
+	require 'yaml'
+
+	class Bot < Cinch::Bot
+		def initialize(options={})
+			super()
+
+			# Override Cinch's bot configuration with our own extended one
+			@config = Synthetic::Configuration::Bot.new
+
+			# Configure any known bot options that were passed, ignoring unknown keys
+			options.select do |key, value|
+				Cinch::Configuration::Bot::KnownOptions.include?(key)
+			end.each do |key, value|
+				@config[key] = value
+			end
+
+			# Enable Wit for Cinch
+			@config.plugins.plugins << Cinch::Plugins::Wit
+			@config.plugins.options[Cinch::Plugins::Wit][:access_token] = options[:wit_token]
+
+			# Load bot app
+			load_root!
+
+			# Catch intent events and route to their designated controller
+			on :intent do |msg, wit|
+				if msg.bot.routes.has_key?(wit['intent'])
+					controller = msg.bot.routes[wit['intent']].new
+					controller.send(wit['intent'], msg, wit)
+				end
+			end
+		end
+
+		attr_accessor :routes
+
+		private
+
+		def load_root!
+			# Add the bot root directory to load path
+			if File.directory?(@config[:root]) && !$LOAD_PATH.include?(@config[:root])
+				$LOAD_PATH.unshift(@config[:root])
+			end
+
+			# Require source files in the bot root directory
+			matcher = /\A#{Regexp.escape(@config[:root])}\/(.*)\.rb\Z/
+			Dir.glob("#{@config[:root]}/app/**/*.rb").sort.each do |file|
+				debug "Requiring '#{file.sub(matcher, '\1')}'"
+				require file.sub(matcher, '\1')
+			end
+
+			# Load routes config file
+			@routes = Hash.new
+			routes_config = YAML.load_file "#{@config[:root]}/config/routes.yml"
+			routes_config.each do |route|
+				intents = (route['intent'] || []) + (route['intents'] || [])
+				intents.each do |intent|
+					@routes[intent] = Object.const_get(route['to'].capitalize + 'Controller')
+				end
+			end
+		end
+	end
+end

data/lib/synthetic/configuration/bot.rb

@@ -0,0 +1,11 @@
+module Synthetic
+	module Configuration
+		class Bot < Cinch::Configuration::Bot
+			KnownOptions << :root
+
+			def self.default_config
+				super.merge root: $0
+			end
+		end
+	end
+end

data/lib/synthetic/controller.rb

@@ -0,0 +1,4 @@
+module Synthetic
+	class Controller
+	end
+end

data/lib/synthetic/version.rb

@@ -0,0 +1,4 @@
+module Synthetic
+	# The currently loaded version of Synthetic.
+	VERSION = '0.1.0'
+end

data/lib/synthetic.rb

@@ -0,0 +1,2 @@
+require 'synthetic/version'
+require 'synthetic/bot'

data/synthetic.gemspec

@@ -0,0 +1,26 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'synthetic/version'
+
+Gem::Specification.new do |spec|
+	spec.name          = 'synthetic'
+	spec.version       = Synthetic::VERSION
+	spec.authors       = ['Justin Workman']
+	spec.email         = ['xtagon@gmail.com']
+	spec.summary       = "Synthetic is an IRC bot framework based on Cinch and Wit."
+	spec.description   = spec.summary
+	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_runtime_dependency 'cinch', '~> 2.0'
+	spec.add_runtime_dependency 'cinch-wit', '~> 0.0.2'
+	spec.add_runtime_dependency 'slop', '~> 3.4'
+
+	spec.add_development_dependency 'bundler', '~> 1.3'
+	spec.add_development_dependency 'pry-debugger'
+	spec.add_development_dependency 'rake'
+end

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: synthetic
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Justin Workman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: cinch
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: cinch-wit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.2
+- !ruby/object:Gem::Dependency
+  name: slop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: pry-debugger
+  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: rake
+  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'
+description: Synthetic is an IRC bot framework based on Cinch and Wit.
+email:
+- xtagon@gmail.com
+executables:
+- synthetic
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- CHANGES.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/synthetic
+- lib/synthetic.rb
+- lib/synthetic/bot.rb
+- lib/synthetic/configuration/bot.rb
+- lib/synthetic/controller.rb
+- lib/synthetic/version.rb
+- synthetic.gemspec
+homepage: 
+licenses:
+- MIT
+metadata: {}
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Synthetic is an IRC bot framework based on Cinch and Wit.
+test_files: []
+has_rdoc: