rubyred 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 035db004c6621f98bb4a6ab502c121338e04ac76
-  data.tar.gz: 46306600bdbc296e9cbfcc2d2061dff76685eb84
+  metadata.gz: f070aaf237be9370cf402ee804a84feccd3b9c21
+  data.tar.gz: 0b2ee87f7cb1e9ae4705d74d9940ec9e00edb9a9
 SHA512:
-  metadata.gz: 4948e04db5622621190c11faa384e5b2b5cbdb0d388294e84ae62a8e26d71263b998fb8c16ed52c12f843cb9cce2b474722907c16bd2289d82bc06efb02d5b15
-  data.tar.gz: 2c7afa6db1c47c0a203896be1d8350b29c34397ff974ad1f8ca134cef4955077ac0c7c0c5e09c19a7e519c9c19cb7ee6a154190b2f148f9086f2885244f6280e
+  metadata.gz: 8e35925905a693b1f1c0fc17ab0eece9ead7f68d2fe44ce2276662d034ef96511540555558191c2dc8717c0c463dff670ded3e4d3595292dcf932782cefa6497
+  data.tar.gz: 6eece359272b33d5772303f2fde73aecc4e01551b3e8bd7abd9248006156efecccac5c38ed86eafd402994c00534ddd14436e5b55016e8b28439d8e5bc9b3f3a

data/CHANGELOG.md

@@ -0,0 +1,29 @@
+### RubyRed uses Semantic Versioning (semver)
+Information on semver can be found [here](http://semver.org)  
+The Changelog file reads "Top to Bottom" in chronological order, newest
+versions are on top, oldest are towards the end of the file.
+
+#### Version 0.1.1
+* Added diagnostics command
+* Fixed an issue with Heroku
+* Added the first version of the drink command
+
+#### Version 0.1.0
+* Added heroku support
+
+#### Version 0.0.2
+* Refactored code to use module namespacing from earlier primitive setup
+* Completed ping command
+
+#### Version 0.0.1b
+* Fixed gemspec errors which should allow building of the gem
+
+#### Version 0.0.1a
+* Class-ify-ed RubyRed to encapsulate her programming and make it easier to add and contribute code
+* Added the gemspec templating
+* Known Issues
+  * Gem was not buildable due to a handful of errors
+
+#### Version 0.0.1
+* Created basic bot runtime using DiscordRB
+* Implemented Ping/Pong test to verify she is able to respond

data/CONTRIBUTING.md

@@ -0,0 +1,73 @@
+### Submitting bugs
+#### Due diligence
+
+Before submitting a bug, please do the following:
+
+* Perform basic troubleshooting steps:
+    - Make sure you’re on the latest version. If you’re not on the most recent version, your problem may have been solved already! Upgrading is always the best first step.
+    - Try older versions. If you’re already on the latest release, try rolling back a few minor versions (e.g. if on 1.7, try 1.5 or 1.6) and see if the problem goes away. This will help the devs narrow down when the problem first arose in the commit log.
+    - Try switching up dependency versions. If the software in question has dependencies (other libraries, etc) try upgrading/downgrading those as well.
+* Search the project’s bug/issue tracker to make sure it’s not a known issue.
+* If you don’t find a pre-existing issue, consider checking with the mailing list and/or IRC channel in case the problem is non-bug-related.
+
+#### What to put in your bug report
+
+Make sure your report gets the attention it deserves: bug reports with missing information may be ignored or punted back to you, delaying a fix. The below constitutes a bare minimum; more info is almost always better:
+
+* What version of the core programming language interpreter/compiler are you using? For example, if it’s a Python project, are you using Python 2.7.3? Python 3.3.1? PyPy 2.0?
+* What operating system are you on? Windows? (Vista? 7? 32-bit? 64-bit?) Mac OS X? (10.7.4? 10.9.0?) Linux? (Which distro? Which version of that distro? 32 or 64 bits?) Again, more detail is better.
+* Which version or versions of the software are you using? Ideally, you followed the advice above and have ruled out (or verified that the problem exists in) a few different versions.
+* How can the developers recreate the bug on their end? If possible, include a copy of your code, the command you used to invoke it, and the full output of your run (if applicable.)
+    - A common tactic is to pare down your code until a simple (but still bug-causing) “base case” remains. Not only can this help you identify problems which aren’t real bugs, but it means the developer can get to fixing the bug faster.
+
+### Contributing changes
+#### Version control branching
+
+* Always make a new branch for your work, no matter how small. This makes it easy for others to take just that one set of changes from your repository, in case you have multiple unrelated changes floating around.
+    - A corollary: don’t submit unrelated changes in the same branch/pull request! The maintainer shouldn’t have to reject your awesome bugfix because the feature you put in with it needs more review.
+* Base your new branch off of the appropriate branch on the main repository:
+    - Bug fixes should be based on the branch named after the oldest supported release line the bug affects.
+        * E.g. if a feature was introduced in 1.1, the latest release line is 1.3, and a bug is found in that feature - make your branch based on 1.1. The maintainer will then forward-port it to 1.3 and master.
+        * Bug fixes requiring large changes to the code or which have a chance of being otherwise disruptive, may need to base off of master instead. This is a judgement call – ask the devs!
+    - New features should branch off of the ‘master’ branch.
+        * Note that depending on how long it takes for the dev team to merge your patch, the copy of master you worked off of may get out of date! If you find yourself ‘bumping’ a pull request that’s been sidelined for a while, make sure you rebase or merge to latest master to ensure a speedier resolution.
+
+### Code formatting
+
+* Follow the style you see used in the primary repository! Consistency with the rest of the project always trumps other considerations. It doesn’t matter if you have your own style or if the rest of the code breaks with the greater community - just follow along.
+* Python projects usually follow the PEP-8 guidelines (though many have minor deviations depending on the lead maintainers’ preferences.)
+
+### Documentation isn’t optional
+
+It’s not! Patches without documentation will be returned to sender. By “documentation” we mean:
+
+* Docstrings (for Python; or API-doc-friendly comments for other languages) must be created or updated for public API functions/methods/etc. (This step is optional for some bugfixes.)
+    - Don’t forget to include versionadded/versionchanged ReST directives at the bottom of any new or changed Python docstrings!
+        * Use versionadded for truly new API members – new methods, functions, classes or modules.
+        * Use versionchanged when adding/removing new function/method arguments, or whenever behavior changes.
+* New features should ideally include updates to prose documentation, including useful example code snippets.
+* All submissions should have a changelog entry crediting the contributor and/or any individuals instrumental in identifying the problem.
+
+### Tests aren’t optional
+
+Any bugfix that doesn’t include a test proving the existence of the bug being fixed, may be suspect. Ditto for new features that can’t prove they actually work.
+
+We’ve found that test-first development really helps make features better architected and identifies potential edge cases earlier instead of later. Writing tests before the implementation is strongly encouraged.
+
+### Full example
+
+Here’s an example workflow for a project theproject hosted on Github, which is currently in version 1.3.x. Your username is yourname and you’re submitting a basic bugfix. (This workflow only changes slightly if the project is hosted at Bitbucket, self-hosted, or etc.)
+
+* Hit ‘fork’ on Github, creating e.g. yourname/theproject.
+* `git clone git@github.com:yourname/theproject`
+* `cd theproject`
+* `git checkout -b foo-the-bars 1.3`
+* Add changelog entry crediting yourself.
+* Write tests expecting the correct/fixed functionality; make sure they fail.
+* Hack, hack, hack.
+* Run tests again, making sure they pass.
+* `git commit -m "Foo the bars"`
+* `git push origin HEAD` to get it back up to your fork
+* Visit Github, click handy “Pull request” button that it will make upon noticing your new branch.
+* In the description field, write down issue number (if submitting code fixing an existing issue) or describe the issue + your fix (if submitting a wholly new bugfix).
+* Hit ‘submit’! And please be patient - the maintainers will get to you when they can.

data/LICENSE.md

@@ -0,0 +1,194 @@
+# Mozilla Public License  
+Version 2.0
+
+## 1\. Definitions
+
+### 1.1\. “Contributor”
+
+means each individual or legal entity that creates, contributes to the creation of, or owns Covered Software.
+
+### 1.2\. “Contributor Version”
+
+means the combination of the Contributions of others (if any) used by a Contributor and that particular Contributor’s Contribution.
+
+### 1.3\. “Contribution”
+
+means Covered Software of a particular Contributor.
+
+### 1.4\. “Covered Software”
+
+means Source Code Form to which the initial Contributor has attached the notice in Exhibit A, the Executable Form of such Source Code Form, and Modifications of such Source Code Form, in each case including portions thereof.
+
+### 1.5\. “Incompatible With Secondary Licenses”
+
+means
+
+1.  that the initial Contributor has attached the notice described in Exhibit B to the Covered Software; or
+
+2.  that the Covered Software was made available under the terms of version 1.1 or earlier of the License, but not also under the terms of a Secondary License.
+
+### 1.6\. “Executable Form”
+
+means any form of the work other than Source Code Form.
+
+### 1.7\. “Larger Work”
+
+means a work that combines Covered Software with other material, in a separate file or files, that is not Covered Software.
+
+### 1.8\. “License”
+
+means this document.
+
+### 1.9\. “Licensable”
+
+means having the right to grant, to the maximum extent possible, whether at the time of the initial grant or subsequently, any and all of the rights conveyed by this License.
+
+### 1.10\. “Modifications”
+
+means any of the following:
+
+1.  any file in Source Code Form that results from an addition to, deletion from, or modification of the contents of Covered Software; or
+
+2.  any new file in Source Code Form that contains any Covered Software.
+
+### 1.11\. “Patent Claims” of a Contributor
+
+means any patent claim(s), including without limitation, method, process, and apparatus claims, in any patent Licensable by such Contributor that would be infringed, but for the grant of the License, by the making, using, selling, offering for sale, having made, import, or transfer of either its Contributions or its Contributor Version.
+
+### 1.12\. “Secondary License”
+
+means either the GNU General Public License, Version 2.0, the GNU Lesser General Public License, Version 2.1, the GNU Affero General Public License, Version 3.0, or any later versions of those licenses.
+
+### 1.13\. “Source Code Form”
+
+means the form of the work preferred for making modifications.
+
+### 1.14\. “You” (or “Your”)
+
+means an individual or a legal entity exercising rights under this License. For legal entities, “You” includes any entity that controls, is controlled by, or is under common control with You. For purposes of this definition, “control” means (a) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (b) ownership of more than fifty percent (50%) of the outstanding shares or beneficial ownership of such entity.
+
+## 2\. License Grants and Conditions
+
+### 2.1\. Grants
+
+Each Contributor hereby grants You a world-wide, royalty-free, non-exclusive license:
+
+1.  under intellectual property rights (other than patent or trademark) Licensable by such Contributor to use, reproduce, make available, modify, display, perform, distribute, and otherwise exploit its Contributions, either on an unmodified basis, with Modifications, or as part of a Larger Work; and
+
+2.  under Patent Claims of such Contributor to make, use, sell, offer for sale, have made, import, and otherwise transfer either its Contributions or its Contributor Version.
+
+### 2.2\. Effective Date
+
+The licenses granted in Section 2.1 with respect to any Contribution become effective for each Contribution on the date the Contributor first distributes such Contribution.
+
+### 2.3\. Limitations on Grant Scope
+
+The licenses granted in this Section 2 are the only rights granted under this License. No additional rights or licenses will be implied from the distribution or licensing of Covered Software under this License. Notwithstanding Section 2.1(b) above, no patent license is granted by a Contributor:
+
+1.  for any code that a Contributor has removed from Covered Software; or
+
+2.  for infringements caused by: (i) Your and any other third party’s modifications of Covered Software, or (ii) the combination of its Contributions with other software (except as part of its Contributor Version); or
+
+3.  under Patent Claims infringed by Covered Software in the absence of its Contributions.
+
+This License does not grant any rights in the trademarks, service marks, or logos of any Contributor (except as may be necessary to comply with the notice requirements in Section 3.4).
+
+### 2.4\. Subsequent Licenses
+
+No Contributor makes additional grants as a result of Your choice to distribute the Covered Software under a subsequent version of this License (see Section 10.2) or under the terms of a Secondary License (if permitted under the terms of Section 3.3).
+
+### 2.5\. Representation
+
+Each Contributor represents that the Contributor believes its Contributions are its original creation(s) or it has sufficient rights to grant the rights to its Contributions conveyed by this License.
+
+### 2.6\. Fair Use
+
+This License is not intended to limit any rights You have under applicable copyright doctrines of fair use, fair dealing, or other equivalents.
+
+### 2.7\. Conditions
+
+Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted in Section 2.1.
+
+## 3\. Responsibilities
+
+### 3.1\. Distribution of Source Form
+
+All distribution of Covered Software in Source Code Form, including any Modifications that You create or to which You contribute, must be under the terms of this License. You must inform recipients that the Source Code Form of the Covered Software is governed by the terms of this License, and how they can obtain a copy of this License. You may not attempt to alter or restrict the recipients’ rights in the Source Code Form.
+
+### 3.2\. Distribution of Executable Form
+
+If You distribute Covered Software in Executable Form then:
+
+1.  such Covered Software must also be made available in Source Code Form, as described in Section 3.1, and You must inform recipients of the Executable Form how they can obtain a copy of such Source Code Form by reasonable means in a timely manner, at a charge no more than the cost of distribution to the recipient; and
+
+2.  You may distribute such Executable Form under the terms of this License, or sublicense it under different terms, provided that the license for the Executable Form does not attempt to limit or alter the recipients’ rights in the Source Code Form under this License.
+
+### 3.3\. Distribution of a Larger Work
+
+You may create and distribute a Larger Work under terms of Your choice, provided that You also comply with the requirements of this License for the Covered Software. If the Larger Work is a combination of Covered Software with a work governed by one or more Secondary Licenses, and the Covered Software is not Incompatible With Secondary Licenses, this License permits You to additionally distribute such Covered Software under the terms of such Secondary License(s), so that the recipient of the Larger Work may, at their option, further distribute the Covered Software under the terms of either this License or such Secondary License(s).
+
+### 3.4\. Notices
+
+You may not remove or alter the substance of any license notices (including copyright notices, patent notices, disclaimers of warranty, or limitations of liability) contained within the Source Code Form of the Covered Software, except that You may alter any license notices to the extent required to remedy known factual inaccuracies.
+
+### 3.5\. Application of Additional Terms
+
+You may choose to offer, and to charge a fee for, warranty, support, indemnity or liability obligations to one or more recipients of Covered Software. However, You may do so only on Your own behalf, and not on behalf of any Contributor. You must make it absolutely clear that any such warranty, support, indemnity, or liability obligation is offered by You alone, and You hereby agree to indemnify every Contributor for any liability incurred by such Contributor as a result of warranty, support, indemnity or liability terms You offer. You may include additional disclaimers of warranty and limitations of liability specific to any jurisdiction.
+
+## 4\. Inability to Comply Due to Statute or Regulation
+
+If it is impossible for You to comply with any of the terms of this License with respect to some or all of the Covered Software due to statute, judicial order, or regulation then You must: (a) comply with the terms of this License to the maximum extent possible; and (b) describe the limitations and the code they affect. Such description must be placed in a text file included with all distributions of the Covered Software under this License. Except to the extent prohibited by statute or regulation, such description must be sufficiently detailed for a recipient of ordinary skill to be able to understand it.
+
+## 5\. Termination
+
+<h3>5.1\.</h3> The rights granted under this License will terminate automatically if You fail to comply with any of its terms. However, if You become compliant, then the rights granted under this License from a particular Contributor are reinstated (a) provisionally, unless and until such Contributor explicitly and finally terminates Your grants, and (b) on an ongoing basis, if such Contributor fails to notify You of the non-compliance by some reasonable means prior to 60 days after You have come back into compliance. Moreover, Your grants from a particular Contributor are reinstated on an ongoing basis if such Contributor notifies You of the non-compliance by some reasonable means, this is the first time You have received notice of non-compliance with this License from such Contributor, and You become compliant prior to 30 days after Your receipt of the notice.
+
+<h3>5.2\.</h3> If You initiate litigation against any entity by asserting a patent infringement claim (excluding declaratory judgment actions, counter-claims, and cross-claims) alleging that a Contributor Version directly or indirectly infringes any patent, then the rights granted to You by any and all Contributors for the Covered Software under Section 2.1 of this License shall terminate.
+
+<h3>5.3\.</h3> In the event of termination under Sections 5.1 or 5.2 above, all end user license agreements (excluding distributors and resellers) which have been validly granted by You or Your distributors under this License prior to termination shall survive termination.
+
+## 6\. Disclaimer of Warranty
+
+_Covered Software is provided under this License on an “as is” basis, without warranty of any kind, either expressed, implied, or statutory, including, without limitation, warranties that the Covered Software is free of defects, merchantable, fit for a particular purpose or non-infringing. The entire risk as to the quality and performance of the Covered Software is with You. Should any Covered Software prove defective in any respect, You (not any Contributor) assume the cost of any necessary servicing, repair, or correction. This disclaimer of warranty constitutes an essential part of this License. No use of any Covered Software is authorized under this License except under this disclaimer._
+
+## 7\. Limitation of Liability
+
+_Under no circumstances and under no legal theory, whether tort (including negligence), contract, or otherwise, shall any Contributor, or anyone who distributes Covered Software as permitted above, be liable to You for any direct, indirect, special, incidental, or consequential damages of any character including, without limitation, damages for lost profits, loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses, even if such party shall have been informed of the possibility of such damages. This limitation of liability shall not apply to liability for death or personal injury resulting from such party’s negligence to the extent applicable law prohibits such limitation. Some jurisdictions do not allow the exclusion or limitation of incidental or consequential damages, so this exclusion and limitation may not apply to You._
+
+## 8\. Litigation
+
+Any litigation relating to this License may be brought only in the courts of a jurisdiction where the defendant maintains its principal place of business and such litigation shall be governed by laws of that jurisdiction, without reference to its conflict-of-law provisions. Nothing in this Section shall prevent a party’s ability to bring cross-claims or counter-claims.
+
+## 9\. Miscellaneous
+
+This License represents the complete agreement concerning the subject matter hereof. If any provision of this License is held to be unenforceable, such provision shall be reformed only to the extent necessary to make it enforceable. Any law or regulation which provides that the language of a contract shall be construed against the drafter shall not be used to construe this License against a Contributor.
+
+## 10\. Versions of the License
+
+### 10.1\. New Versions
+
+Mozilla Foundation is the license steward. Except as provided in Section 10.3, no one other than the license steward has the right to modify or publish new versions of this License. Each version will be given a distinguishing version number.
+
+### 10.2\. Effect of New Versions
+
+You may distribute the Covered Software under the terms of the version of the License under which You originally received the Covered Software, or under the terms of any subsequent version published by the license steward.
+
+### 10.3\. Modified Versions
+
+If you create software not governed by this License, and you want to create a new license for such software, you may create and use a modified version of this License if you rename the license and remove any references to the name of the license steward (except to note that such modified license differs from this License).
+
+### 10.4\. Distributing Source Code Form that is Incompatible With Secondary Licenses
+
+If You choose to distribute Source Code Form that is Incompatible With Secondary Licenses under the terms of this version of the License, the notice described in Exhibit B of this License must be attached.
+
+## Exhibit A - Source Code Form License Notice
+
+> This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0\. If a copy of the MPL was not distributed with this file, You can obtain one at https://mozilla.org/MPL/2.0/.
+
+If it is not possible or desirable to put the notice in a particular file, then You may include the notice in a location (such as a LICENSE file in a relevant directory) where a recipient would be likely to look for such a notice.
+
+You may add additional accurate notices of copyright ownership.
+
+## Exhibit B - “Incompatible With Secondary Licenses” Notice
+
+> This Source Code Form is “Incompatible With Secondary Licenses”, as defined by the Mozilla Public License, v. 2.0.

data/README.md

@@ -0,0 +1,9 @@
+### RUBY RED
+Ruby Red is a Ruby based Discord Bot using DiscordRB as the API access toolkit
+
+#### Requirements
+* Ruby ~v2.1
+* DiscordRB
+
+#### Available Utilities
+* Ping! (responds with Pong!)

data/lib/rubyred/commands.rb

@@ -7,6 +7,8 @@ module RubyRed
     Dir["#{File.dirname(__FILE__)}/commands/*.rb"].each {|file| require file}
 
     @commands = [
+        Diag,
+        Drink,
         Ping
     ]
 

data/lib/rubyred/commands/diag.rb

@@ -0,0 +1,16 @@
+module RubyRed
+  module Commands
+    module Diag
+      # Displays a diagnostic message from the bot
+      #
+      # Examples:
+      #   '!diag'
+      #   RubyRed:'23ms to respond'
+
+      extend Discordrb::Commands::CommandContainer
+      command(:diag, description: 'Displays a diagnostic message from the bot') do |event|
+        event << "#{((Time.now - event.timestamp) * 1000).to_i}ms to respond" # This is a literal ping time test
+      end
+    end
+  end
+end

data/lib/rubyred/commands/drink.rb

@@ -0,0 +1,26 @@
+module RubyRed
+  module Commands
+    module Drink
+      require 'yaml'
+      require_relative 'drink/drink_helper'
+      # Serves up a refreshing beverage
+      #
+      # Examples:
+      #
+      DRINK_YAML_FILE = 'lib/rubyred/commands/drink/drink.yaml'
+      drink_data = YAML.load(File.open(DRINK_YAML_FILE))
+      srand Time.now.to_i # Reseeds the randomizer on load
+
+      extend Discordrb::Commands::CommandContainer
+      command(:drink, description: 'Provides a refreshing beverage at random') do |event|
+        drink_served = drink_data[rand(1..2)] #TODO: Figure out some way to make this dynamic with the YAML size
+        event << "Here's a freshly made #{drink_served[0]["name"]}, #{event.user.name}!"
+        event << "#{drink_served[0]["name"]}s are made using the finest ingredients below:"
+        drink_served[0]["ingredients"].each do |ing|
+          event << "* #{ing}"
+        end
+        event << "To make your own #{drink_served[0]["name"]}s, just follow these instructions:\n #{drink_served[0]["description"]}"
+      end
+    end
+  end
+end

data/lib/rubyred/commands/drink/drink.yaml

@@ -0,0 +1,15 @@
+1:
+  - name: Godfather
+    ingredients:
+      - 3.5cL Scotch whisky
+      - 3.5cL Amaretto
+      - Served *On the Rocks*; poured over ice.
+    description: Pour all ingredients directly into old fashioned glass filled with ice cubes. Stir gently.
+2:
+  - name: Rum & Coke
+    ingredients:
+      - 12cL Cola
+      - 5cL Light rum
+      - 1cL Fresh lime juice
+      - Served *On the Rocks*; poured over ice.
+    description: Build all ingredients in a Collins glass filled with ice. Garnish with lime wedge.

data/lib/rubyred/commands/drink/drink_helper.rb

@@ -0,0 +1,12 @@
+module RubyRed
+  module Commands
+    module Drink
+      class DrinkData
+        def initialize (name, ingredients)
+          @name = name
+          @ingredients = ingredients
+        end
+      end
+    end
+  end
+end

data/lib/rubyred/commands/ping.rb

@@ -9,7 +9,6 @@ module RubyRed
 
       extend Discordrb::Commands::CommandContainer
       command(:ping, description: 'Displays a Pong! after receiving a Ping!') do |event|
-        #"#{((Time.now - event.timestamp) * 1000).to_i}ms" # This is a literal ping time test
         'Pong!'
       end
       #def self.ping    # This is the old method, replaced with the one above.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubyred
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - George Spiceland
@@ -38,9 +38,17 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
+- CONTRIBUTING.md
+- LICENSE.md
+- README.md
 - bin/rubyred
 - lib/rubyred.rb
 - lib/rubyred/commands.rb
+- lib/rubyred/commands/diag.rb
+- lib/rubyred/commands/drink.rb
+- lib/rubyred/commands/drink/drink.yaml
+- lib/rubyred/commands/drink/drink_helper.rb
 - lib/rubyred/commands/ping.rb
 - lib/rubyred/console.rb
 homepage: http://rubygems.org/gems/rubyred