chatx 0.0.0.pre.pre3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9cc5eac4b2cb23bd725fc867b2f9fca4ac7376c1bc6c9e9ac282d0914d0e0192
+  data.tar.gz: bee11dafb91d70ab00a3ac536da183289941cd8e69a823e7b53a060fd25e91a6
+SHA512:
+  metadata.gz: a9b73297e51bf6bced36b85be3863d7939f53389e5ec49d2a76a1c684d4f80800d94a11f380ac45a51141af8871626c46b4f3be637d180a150636a7cf782e77d
+  data.tar.gz: db034d9d9525a8d2da916924f793cf1f2ad1ff1aff92ea66fa6c685b212e27a9d1c38bdbbeaef11c1380b35c11fadee374addd05fd9102d3746e1a3c05f98324

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.ruby-version
+.idea/
+*.log

data/.gitlab-ci.yml

@@ -0,0 +1,27 @@
+before_script:
+  - gem install bundler --no-ri --no-rdoc
+  - bin/setup
+
+test:2.1:
+  image: ruby:2.1
+  script:
+    - bundle exec rake test
+
+test:2.2:
+  image: ruby:2.2
+  script:
+    - bundle exec rake test
+
+test:2.3:
+  image: ruby:2.3
+  script:
+    - bundle exec rake test
+
+test:2.4:
+  image: ruby:2.4
+  script:
+    - bundle exec rake test
+
+rubocop:
+  script:
+    - rubocop -D

data/.rubocop.yml

@@ -0,0 +1,38 @@
+AllCops:
+  DisplayCopNames: true
+  ExtraDetails: true
+  Exclude:
+    - "chatx.gemspec"
+    - "Rakefile"
+    - "test/*"
+
+Style/StringLiterals:
+  Enabled: false
+
+Metrics/LineLength:
+  Max: 145
+  Enabled: false
+
+Metrics/MethodLength:
+  Max: 35
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Layout/SpaceInsideHashLiteralBraces:
+  Enabled: false
+
+Style/NumericLiterals:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false

data/.yardopts

@@ -0,0 +1 @@
+--type-name-tag keyword:"Keyword Arguments"

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at isaiah@developingtechnician.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,42 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec features) \
+#  .select{|d| Dir.exists?(d) ? d : UI.warning("Directory #{d} does not exist")}
+
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+guard :minitest do
+  # with Minitest::Unit
+  watch(%r{^test/(.*)\/?test_(.*)\.rb$})
+  watch(%r{^lib/(.*/)?([^/]+)\.rb$})     { |m| "test/#{m[1]}test_#{m[2]}.rb" }
+  watch(%r{^test/test_helper\.rb$})      { 'test' }
+
+  # with Minitest::Spec
+  # watch(%r{^spec/(.*)_spec\.rb$})
+  # watch(%r{^lib/(.+)\.rb$})         { |m| "spec/#{m[1]}_spec.rb" }
+  # watch(%r{^spec/spec_helper\.rb$}) { 'spec' }
+
+  # Rails 4
+  # watch(%r{^app/(.+)\.rb$})                               { |m| "test/#{m[1]}_test.rb" }
+  # watch(%r{^app/controllers/application_controller\.rb$}) { 'test/controllers' }
+  # watch(%r{^app/controllers/(.+)_controller\.rb$})        { |m| "test/integration/#{m[1]}_test.rb" }
+  # watch(%r{^app/views/(.+)_mailer/.+})                    { |m| "test/mailers/#{m[1]}_mailer_test.rb" }
+  # watch(%r{^lib/(.+)\.rb$})                               { |m| "test/lib/#{m[1]}_test.rb" }
+  # watch(%r{^test/.+_test\.rb$})
+  # watch(%r{^test/test_helper\.rb$}) { 'test' }
+
+  # Rails < 4
+  # watch(%r{^app/controllers/(.*)\.rb$}) { |m| "test/functional/#{m[1]}_test.rb" }
+  # watch(%r{^app/helpers/(.*)\.rb$})     { |m| "test/helpers/#{m[1]}_test.rb" }
+  # watch(%r{^app/models/(.*)\.rb$})      { |m| "test/unit/#{m[1]}_test.rb" }
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 izwick-schachter
+
+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,141 @@
+# ChatX
+
+ChatX is a shorter and better and more ruby version of the ChatExchange python library for interacting with
+Stack Exchange Chat, Stack Overflow Chat, and Meta Stack Exchange Chat.
+
+The first thing to do is to go and make a chat account on the servers you want to use. Then, you can start with this
+gem.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'chatx'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install chatx
+
+## Usage
+
+The first thing you need is to create a new `ChatBot` and tell it what username you used, the password you used. If you
+want it to operate on a site besides chat.stackexchange.com, you'll have to specify it:
+
+```ruby
+my_chatbot = ChatBot.new("smartbot@example.com", "correct horse battery staple")
+```
+
+If you want to improve your security a bit further, you could also get the username and password from environment
+variables:
+
+```bash
+$ export CXUsername=smartbot@example.com
+$ export CXPassword="correct horse battery staple"
+```
+```ruby
+my_chatbot = ChatBot.new(ENV["CXUsername"], ENV["CXPassword"])
+```
+If you wanted to run it on a different server, you'd pass that server as the third argument to `ChatBot.new`. The
+servers are given as either "stackexchange", "meta.stackexchange" or "stackoverflow".
+
+To speak, the bot has a `say` method. For example, to have your chatbot say "Hello World" in the room with ID 1, you
+would run `my_chatbot.say 1, "Hello World"`.
+
+The recommended way to interact with chat is through "hooks". Hooks are a way of responding to actions in chat. For
+example, if you wanted to have it reply to the message "!!/alive" in room 1 with "Yup, I'm here" you could create a
+hook for the "message" event:
+
+```ruby
+my_chatbot.add_hook 1, "message" do
+  say "Yup, I'm here"
+end
+```
+
+Or, if you wanted to make that a reply to the "!!/alive" message, you could do:
+
+```ruby
+my_chatbot.add_hook 1, "message" do |msg|
+  msg.reply "Yup, I'm here"
+end
+```
+
+Here's a complete list of events that you can add a hook to:
+
+```
+"message"
+"edit"
+"entrance"
+"exit"
+"rename"
+"star"
+"debug"
+"mention"
+"flag"
+"delete"
+"file"
+"mod-flag"
+"settings"
+"gnotif"
+"level"
+"lnotif"
+"invite"
+"reply"
+"move-out"
+"move-in"
+"time"
+"feed"
+"suspended"
+"merged"
+```
+
+The recommended way to add hooks is though the `gen_hooks` method, together with the room method:
+
+```ruby
+my_chatbot.gen_hooks do
+  room 63296 do
+    on "mention" do |e|
+      e.reply "Right!" if e.body.downcase.end_with?("right?")
+    end
+
+    on "message" do |e|
+      if e.body.downcase.start_with?("@smelly good")
+        tod = e.body.split(" ")[2].gsub(/[^a-zA-Z]/, "")
+        e.reply "Good #{tod} to you as well!"
+      end
+    end
+  end
+end
+```
+
+Also, your hooks won't be active until you manually join the relevant rooms with `my_chatbot.join_room(1)`, and they'll
+stop being active when you leave the room with `my_chatbot.leave_room(1)`.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can
+also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the
+version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version,
+push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitLab at https://gitlab.com/izwick-schachter/ChatX. This project is
+intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the
+[Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the ChatX project’s codebases, issue trackers, chat rooms and mailing lists is expected to
+follow the [code of conduct](https://github.com/[USERNAME]/chatx/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "chatx"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/chatx.gemspec

@@ -0,0 +1,52 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "chatx/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "chatx"
+  spec.version       = ChatBot::VERSION
+  spec.authors       = ["izwick-schachter"]
+  spec.email         = ["isaiah@developingtechnician.com"]
+
+  spec.summary       = %q{A bot. For the chat. This bot is a ruby way to chat with other
+    people on chat.stackexchange.com, chat.meta.stackexchange.com, or chat.stackoverflow.com}
+  spec.description   = %q{A chatbot! For SE! In ruby!}
+  spec.homepage      = "https://gitlab.com/izwick-schachter/chatx"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "rubocop", "~> 0.49"
+  spec.add_development_dependency "yard", "~> 0.9"
+  spec.add_development_dependency 'byebug', '~> 9.0'
+  spec.add_development_dependency 'guard', '~> 2.14'
+  spec.add_development_dependency 'guard-minitest', '~> 2.4'
+
+  [
+    ["mechanize",          "~> 2.7"],
+    ["nokogiri",           "~> 1.8"],
+    ["permessage_deflate", "~> 0.1"],
+    ["websocket-driver",   "~> 0.6"],
+    ["htmlentities",       "~> 4.3"]
+  ].each do |g, v|
+    spec.add_runtime_dependency g, v
+  end
+end