jarvis-cli 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    OWI3NjY2OTRkOWIyZmYwZTA2ZGM5ZTc5MTZkNzc0OGNmM2MxOWVlZA==
+  data.tar.gz: !binary |-
+    ODc1MGM3OWRkYmM3ZDJlMWU3NzA4N2VhZDJhNDM5NTczY2Q1MWNhMA==
+SHA512:
+  metadata.gz: !binary |-
+    NDMzMjI2YzQ4YmMzM2I4YzAwYjU1Nzk3MWM2YTJlY2YxNTgxMGNhYmI0Yzdk
+    NTE5ZDgyNmI1OTM3NTAxY2FlNDgzMzlmMDg2M2RmMDViYzAxMjc2NmUyY2E3
+    YmZmNTM1YzM4Y2U3NjhmNTY3M2I2OTlmMWU5ODZmNjM5NjJlMTI=
+  data.tar.gz: !binary |-
+    ZTEwZWY2ZDM4NzE5MDVmOTNhMGNlOTYxZTBhODZkZDRhNzI5NGY4MjlkYjUy
+    YTU4NTk1Y2MzMDI4ZTM5ZTgyMTg1YTJkNWRmNGIwMThkZmUzODg2MDM0YTBj
+    YjIyN2YxNzBiMzcyM2M3ZDMzNjQwYTk0MTI5MDY4NTBkN2Y4YzE=

data/.gitignore

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

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 DVG
+
+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,61 @@
+# Jarvis CLI
+
+## Warning, these instructions are not true yet, but they will be!
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'jarvis-cli', require: 'jarvis'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install jarvis-cli
+
+## Usage
+
+Jarvis is an application framework for building Chat bots to integrate with your Slack chatroom. It ships with a number of useful and funny built-in services, but it also provides and easy DSL for creating your own services.
+
+### Generating a new chat bot
+
+Creating a chatbot is as easy as:
+
+```bash
+$ jarvis new my-bot
+```
+
+### Registering Services
+
+`/app/server.rb` is the main brain of your Jarvis bot. Here you can register which services you want to be available on your chatbot.
+
+```ruby
+class MyBot < Jarvis::Server
+  register_services Twitter, ImgFlip, UrbanDictionary, Weather
+end
+```
+
+These are the services that will be enabled when Jarvis interprets a message from Slack.
+
+### Required Environment Variables
+
+If a Service integrates with an authenticated, third party API, you may need to set up environment variables for API Tokens, Secrets, Usernames and Passwords, etc. To ensure that services are not run in environments that aren't set up to support them, services can require certain variables be set up.
+
+```ruby
+class MyService < Jarvis::Service
+  required_environment "SERVICE_TOKEN", "SERVICE_SECRET"
+end
+```
+
+If a service is Registered in `app/server.rb` but does not have it's expected environment, Jarvis will throw an exception and respond with a polite refusal to execute the service. This message can be set in your Jarvis configuration.
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/jarvis_server/fork )
+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 a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/bin/jarvis

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+
+require 'jarvis'

data/jarvis-cli.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'jarvis/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "jarvis-cli"
+  spec.version       = Jarvis::VERSION
+  spec.authors       = ["DVG"]
+  spec.email         = ["bradley.temple@gmail.com"]
+  spec.summary       = %q{Modular Slackbot Framework}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_dependency "sinatra"
+  spec.add_dependency "sinatra-contrib"
+  spec.add_dependency "httparty"
+end

data/lib/jarvis/exceptions.rb

@@ -0,0 +1,9 @@
+module Jarvis
+  class Exception < StandardError
+  end
+end
+
+module Jarvis
+  class UnfitEnvironmentException < Exception
+  end
+end

data/lib/jarvis/server.rb

@@ -0,0 +1,14 @@
+require 'sinatra'
+require "sinatra/json"
+require 'json'
+
+module Jarvis
+  class Server < Sinatra::Base
+
+    get "/" do
+      json text: "Hello, I'm Jarvis"
+    end
+
+    run! if app_file == $0
+  end
+end

data/lib/jarvis/service.rb

@@ -0,0 +1,16 @@
+module Jarvis
+  class Service
+    class << self
+      attr_accessor :required_environment_variables
+      def required_environment(*args)
+        @required_environment_variables = args
+      end
+    end
+
+    def validate_environment
+      self.class.required_environment_variables.each do |v|
+        raise UnfitEnvironmentException unless ENV[v]
+      end
+    end
+  end
+end

data/lib/jarvis/version.rb

@@ -0,0 +1,3 @@
+module Jarvis
+  VERSION = "0.0.1"
+end

data/lib/jarvis.rb

@@ -0,0 +1,19 @@
+require "jarvis/version"
+require 'jarvis/server'
+require 'jarvis/service'
+require 'jarvis/exceptions'
+
+module Jarvis
+  class << self
+
+    attr_accessor :services
+    def services
+      @services ||= []
+    end
+
+    def register(klass)
+      services << klass
+    end
+
+  end
+end

data/spec/jarvis/jarvis_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+
+RSpec.describe Jarvis do
+
+  describe "Service Registry" do
+    it "Allows you to register a Jarvis::Service subclass" do
+      class MyRegisteredService < Jarvis::Service
+      end
+      Jarvis.register(MyRegisteredService)
+      expect(Jarvis.services).to eq [MyRegisteredService]
+    end
+  end
+
+end

data/spec/jarvis/server_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+RSpec.describe Jarvis::Server do
+  let(:parsed_response) { JSON.parse(last_response.body) }
+
+  describe "get /" do
+    before { get "/" }
+    it { expect(last_response).to be_ok }
+    it { expect(parsed_response["text"]).to eq "Hello, I'm Jarvis" }
+  end
+end

data/spec/jarvis/service_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+RSpec.describe Jarvis::Service do
+
+  describe "Validate Environment Variables are Present" do
+
+    class MyService < Jarvis::Service
+      required_environment "SERVICE_TOKEN"
+    end
+
+    subject { MyService.new }
+
+    context "Required Environment not set up" do
+      it { expect { subject.validate_environment }.to raise_exception(Jarvis::UnfitEnvironmentException) }
+    end
+
+    context "Environment Correctly Set Up" do
+      before { ENV["SERVICE_TOKEN"] = "token" }
+      it { expect { subject.validate_environment }.to_not raise_exception }
+    end
+
+    context "Multiple Required Variables, Some not present" do
+      class MyOtherService < Jarvis::Service
+        required_environment "SERVICE_TOKEN", "SERVICE_SECRET"
+      end
+      subject { MyOtherService.new }
+      before { ENV["SERVICE_TOKEN"] = "token" }
+      it { expect { subject.validate_environment }.to raise_exception(Jarvis::UnfitEnvironmentException) }
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+ENV['RACK_ENV'] = 'test'
+require 'rspec'
+require 'rack/test'
+require 'json'
+require 'jarvis'
+
+include Rack::Test::Methods
+
+def app
+  Jarvis::Server
+end
+
+RSpec.configure do |config|
+  config.expose_dsl_globally = false
+end

metadata

@@ -0,0 +1,151 @@
+--- !ruby/object:Gem::Specification
+name: jarvis-cli
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- DVG
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: sinatra
+  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'
+- !ruby/object:Gem::Dependency
+  name: sinatra-contrib
+  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'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  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: 
+email:
+- bradley.temple@gmail.com
+executables:
+- jarvis
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/jarvis
+- jarvis-cli.gemspec
+- lib/jarvis.rb
+- lib/jarvis/exceptions.rb
+- lib/jarvis/server.rb
+- lib/jarvis/service.rb
+- lib/jarvis/version.rb
+- spec/jarvis/jarvis_spec.rb
+- spec/jarvis/server_spec.rb
+- spec/jarvis/service_spec.rb
+- spec/spec_helper.rb
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Modular Slackbot Framework
+test_files:
+- spec/jarvis/jarvis_spec.rb
+- spec/jarvis/server_spec.rb
+- spec/jarvis/service_spec.rb
+- spec/spec_helper.rb
+has_rdoc: