gnome-campfire-notifications 0.1.3 → 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ee6669e33d2234f27512e5ed8ef72371cbe126e6
+  data.tar.gz: 7a629596fa2ab474e4d258f5f8e5c51e757eedc4
+SHA512:
+  metadata.gz: 6fc11a16896c4b3668f4bee5fd38235e239f3df3df40fba5becb2257cee2bd90d55877926e54f3dbf9499737f891b8dcb0ed7421605c3cfb3896ec5cc46ffcc4
+  data.tar.gz: e8c0d0fc28443c1eeba9d075931f674d2a90d11b4806c686af1787d3ec1d98a4c23930ef931136a53afc4b92c13278507cbfc84e6f5ee40fabee1d8be2f0cbd2

data/.gitignore

@@ -0,0 +1,2 @@
+*.swp
+*.gem

data/LICENSE

@@ -0,0 +1,336 @@
+Copyright (C) 1989, 1991 Free Software Foundation, Inc., [http://fsf.org/]
+ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+                            Preamble
+
+  The licenses for most software are designed to take away your
+freedom to share and change it.  By contrast, the GNU General Public
+License is intended to guarantee your freedom to share and change free
+software--to make sure the software is free for all its users.  This
+General Public License applies to most of the Free Software
+Foundation's software and to any other program whose authors commit to
+using it.  (Some other Free Software Foundation software is covered by
+the GNU Lesser General Public License instead.)  You can apply it to
+your programs, too.
+
+  When we speak of free software, we are referring to freedom, not
+price.  Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+this service if you wish), that you receive source code or can get it
+if you want it, that you can change the software or use pieces of it
+in new free programs; and that you know you can do these things.
+
+  To protect your rights, we need to make restrictions that forbid
+anyone to deny you these rights or to ask you to surrender the rights.
+These restrictions translate to certain responsibilities for you if you
+distribute copies of the software, or if you modify it.
+
+  For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must give the recipients all the rights that
+you have.  You must make sure that they, too, receive or can get the
+source code.  And you must show them these terms so they know their
+rights.
+
+  We protect your rights with two steps: (1) copyright the software, and
+(2) offer you this license which gives you legal permission to copy,
+distribute and/or modify the software.
+
+  Also, for each author's protection and ours, we want to make certain
+that everyone understands that there is no warranty for this free
+software.  If the software is modified by someone else and passed on, we
+want its recipients to know that what they have is not the original, so
+that any problems introduced by others will not reflect on the original
+authors' reputations.
+
+  Finally, any free program is threatened constantly by software
+patents.  We wish to avoid the danger that redistributors of a free
+program will individually obtain patent licenses, in effect making the
+program proprietary.  To prevent this, we have made it clear that any
+patent must be licensed for everyone's free use or not licensed at all.
+
+  The precise terms and conditions for copying, distribution and
+modification follow.
+
+                    GNU GENERAL PUBLIC LICENSE
+   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+  0. This License applies to any program or other work which contains
+a notice placed by the copyright holder saying it may be distributed
+under the terms of this General Public License.  The "Program", below,
+refers to any such program or work, and a "work based on the Program"
+means either the Program or any derivative work under copyright law:
+that is to say, a work containing the Program or a portion of it,
+either verbatim or with modifications and/or translated into another
+language.  (Hereinafter, translation is included without limitation in
+the term "modification".)  Each licensee is addressed as "you".
+
+Activities other than copying, distribution and modification are not
+covered by this License; they are outside its scope.  The act of
+running the Program is not restricted, and the output from the Program
+is covered only if its contents constitute a work based on the
+Program (independent of having been made by running the Program).
+Whether that is true depends on what the Program does.
+
+  1. You may copy and distribute verbatim copies of the Program's
+source code as you receive it, in any medium, provided that you
+conspicuously and appropriately publish on each copy an appropriate
+copyright notice and disclaimer of warranty; keep intact all the
+notices that refer to this License and to the absence of any warranty;
+and give any other recipients of the Program a copy of this License
+along with the Program.
+
+You may charge a fee for the physical act of transferring a copy, and
+you may at your option offer warranty protection in exchange for a fee.
+
+  2. You may modify your copy or copies of the Program or any portion
+of it, thus forming a work based on the Program, and copy and
+distribute such modifications or work under the terms of Section 1
+above, provided that you also meet all of these conditions:
+
+    a) You must cause the modified files to carry prominent notices
+    stating that you changed the files and the date of any change.
+
+    b) You must cause any work that you distribute or publish, that in
+    whole or in part contains or is derived from the Program or any
+    part thereof, to be licensed as a whole at no charge to all third
+    parties under the terms of this License.
+
+    c) If the modified program normally reads commands interactively
+    when run, you must cause it, when started running for such
+    interactive use in the most ordinary way, to print or display an
+    announcement including an appropriate copyright notice and a
+    notice that there is no warranty (or else, saying that you provide
+    a warranty) and that users may redistribute the program under
+    these conditions, and telling the user how to view a copy of this
+    License.  (Exception: if the Program itself is interactive but
+    does not normally print such an announcement, your work based on
+    the Program is not required to print an announcement.)
+
+These requirements apply to the modified work as a whole.  If
+identifiable sections of that work are not derived from the Program,
+and can be reasonably considered independent and separate works in
+themselves, then this License, and its terms, do not apply to those
+sections when you distribute them as separate works.  But when you
+distribute the same sections as part of a whole which is a work based
+on the Program, the distribution of the whole must be on the terms of
+this License, whose permissions for other licensees extend to the
+entire whole, and thus to each and every part regardless of who wrote it.
+
+Thus, it is not the intent of this section to claim rights or contest
+your rights to work written entirely by you; rather, the intent is to
+exercise the right to control the distribution of derivative or
+collective works based on the Program.
+
+In addition, mere aggregation of another work not based on the Program
+with the Program (or with a work based on the Program) on a volume of
+a storage or distribution medium does not bring the other work under
+the scope of this License.
+
+  3. You may copy and distribute the Program (or a work based on it,
+under Section 2) in object code or executable form under the terms of
+Sections 1 and 2 above provided that you also do one of the following:
+
+    a) Accompany it with the complete corresponding machine-readable
+    source code, which must be distributed under the terms of Sections
+    1 and 2 above on a medium customarily used for software interchange; or,
+
+    b) Accompany it with a written offer, valid for at least three
+    years, to give any third party, for a charge no more than your
+    cost of physically performing source distribution, a complete
+    machine-readable copy of the corresponding source code, to be
+    distributed under the terms of Sections 1 and 2 above on a medium
+    customarily used for software interchange; or,
+
+    c) Accompany it with the information you received as to the offer
+    to distribute corresponding source code.  (This alternative is
+    allowed only for noncommercial distribution and only if you
+    received the program in object code or executable form with such
+    an offer, in accord with Subsection b above.)
+
+The source code for a work means the preferred form of the work for
+making modifications to it.  For an executable work, complete source
+code means all the source code for all modules it contains, plus any
+associated interface definition files, plus the scripts used to
+control compilation and installation of the executable.  However, as a
+special exception, the source code distributed need not include
+anything that is normally distributed (in either source or binary
+form) with the major components (compiler, kernel, and so on) of the
+operating system on which the executable runs, unless that component
+itself accompanies the executable.
+
+If distribution of executable or object code is made by offering
+access to copy from a designated place, then offering equivalent
+access to copy the source code from the same place counts as
+distribution of the source code, even though third parties are not
+compelled to copy the source along with the object code.
+
+  4. You may not copy, modify, sublicense, or distribute the Program
+except as expressly provided under this License.  Any attempt
+otherwise to copy, modify, sublicense or distribute the Program is
+void, and will automatically terminate your rights under this License.
+However, parties who have received copies, or rights, from you under
+this License will not have their licenses terminated so long as such
+parties remain in full compliance.
+
+  5. You are not required to accept this License, since you have not
+signed it.  However, nothing else grants you permission to modify or
+distribute the Program or its derivative works.  These actions are
+prohibited by law if you do not accept this License.  Therefore, by
+modifying or distributing the Program (or any work based on the
+Program), you indicate your acceptance of this License to do so, and
+all its terms and conditions for copying, distributing or modifying
+the Program or works based on it.
+
+  6. Each time you redistribute the Program (or any work based on the
+Program), the recipient automatically receives a license from the
+original licensor to copy, distribute or modify the Program subject to
+these terms and conditions.  You may not impose any further
+restrictions on the recipients' exercise of the rights granted herein.
+You are not responsible for enforcing compliance by third parties to
+this License.
+
+  7. If, as a consequence of a court judgment or allegation of patent
+infringement or for any other reason (not limited to patent issues),
+conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License.  If you cannot
+distribute so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you
+may not distribute the Program at all.  For example, if a patent
+license would not permit royalty-free redistribution of the Program by
+all those who receive copies directly or indirectly through you, then
+the only way you could satisfy both it and this License would be to
+refrain entirely from distribution of the Program.
+
+If any portion of this section is held invalid or unenforceable under
+any particular circumstance, the balance of the section is intended to
+apply and the section as a whole is intended to apply in other
+circumstances.
+
+It is not the purpose of this section to induce you to infringe any
+patents or other property right claims or to contest validity of any
+such claims; this section has the sole purpose of protecting the
+integrity of the free software distribution system, which is
+implemented by public license practices.  Many people have made
+generous contributions to the wide range of software distributed
+through that system in reliance on consistent application of that
+system; it is up to the author/donor to decide if he or she is willing
+to distribute software through any other system and a licensee cannot
+impose that choice.
+
+This section is intended to make thoroughly clear what is believed to
+be a consequence of the rest of this License.
+
+  8. If the distribution and/or use of the Program is restricted in
+certain countries either by patents or by copyrighted interfaces, the
+original copyright holder who places the Program under this License
+may add an explicit geographical distribution limitation excluding
+those countries, so that distribution is permitted only in or among
+countries not thus excluded.  In such case, this License incorporates
+the limitation as if written in the body of this License.
+
+  9. The Free Software Foundation may publish revised and/or new versions
+of the General Public License from time to time.  Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+Each version is given a distinguishing version number.  If the Program
+specifies a version number of this License which applies to it and "any
+later version", you have the option of following the terms and conditions
+either of that version or of any later version published by the Free
+Software Foundation.  If the Program does not specify a version number of
+this License, you may choose any version ever published by the Free Software
+Foundation.
+
+  10. If you wish to incorporate parts of the Program into other free
+programs whose distribution conditions are different, write to the author
+to ask for permission.  For software which is copyrighted by the Free
+Software Foundation, write to the Free Software Foundation; we sometimes
+make exceptions for this.  Our decision will be guided by the two goals
+of preserving the free status of all derivatives of our free software and
+of promoting the sharing and reuse of software generally.
+
+                            NO WARRANTY
+
+  11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
+FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW.  EXCEPT WHEN
+OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
+PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
+OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.  THE ENTIRE RISK AS
+TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU.  SHOULD THE
+PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
+REPAIR OR CORRECTION.
+
+  12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
+REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
+INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
+OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
+TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
+YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
+PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGES.
+
+                     END OF TERMS AND CONDITIONS
+
+            How to Apply These Terms to Your New Programs
+
+  If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+  To do so, attach the following notices to the program.  It is safest
+to attach them to the start of each source file to most effectively
+convey the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+    {description}
+    Copyright (C) {year}  {fullname}
+
+    This program is free software; you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation; either version 2 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License along
+    with this program; if not, write to the Free Software Foundation, Inc.,
+    51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+
+Also add information on how to contact you by electronic and paper mail.
+
+If the program is interactive, make it output a short notice like this
+when it starts in an interactive mode:
+
+    Gnomovision version 69, Copyright (C) year name of author
+    Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+    This is free software, and you are welcome to redistribute it
+    under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License.  Of course, the commands you use may
+be called something other than `show w' and `show c'; they could even be
+mouse-clicks or menu items--whatever suits your program.
+
+You should also get your employer (if you work as a programmer) or your
+school, if any, to sign a "copyright disclaimer" for the program, if
+necessary.  Here is a sample; alter the names:
+
+  Yoyodyne, Inc., hereby disclaims all copyright interest in the program
+  `Gnomovision' (which makes passes at compilers) written by James Hacker.
+
+  {signature of Ty Coon}, 1 April 1989
+  Ty Coon, President of Vice
+
+This General Public License does not permit incorporating your program into
+proprietary programs.  If your program is a subroutine library, you may
+consider it more useful to permit linking proprietary applications with the
+library.  If this is what you want to do, use the GNU Lesser General
+Public License instead of this License.

data/README.md

@@ -0,0 +1,22 @@
+# GNOME Campfire Notifications
+A Ruby script that issues GNOME desktop notifications when something is said in your Campfire chatroom.
+
+# Installation
+`gem install gnome-campfire-notifications`
+
+In your `~/.campfire.yml`:
+
+    token:     (API access token under My info in the chatroom web app)
+    subdomain: ("sample" as in "sample.campfirenow.com/room/123456")
+    roomid:    ("123456" as in "sample.campfirenow.com/room/123456")
+    self_user: 'Michael Nelson' (So that you don't get notified of your own messages)
+    filter:    !ruby/regexp '/Michael Nelson/' (Send only messages matching this regex. Omit to disable.)
+
+# Usage
+Execute `gnome-campfire-notifications`.
+
+# Help
+Please feel free to open an issue or PR. Or feel free to contact me via my info on my Github user page.
+
+# License
+[LICENSE](https://github.com/mcnelson/gnome-campfire-notifications/blob/master/LICENSE)

data/Rakefile

@@ -0,0 +1,2 @@
+require 'rake/testtask'
+Rake::TestTask.new(:test)

data/gnome-campfire-notifications.gemspec

@@ -0,0 +1,18 @@
+Gem::Specification.new do |s|
+  s.name        = "gnome-campfire-notifications"
+  s.version     = "0.2.0"
+  s.summary     = "GNOME desktop notifications for Campfire."
+  s.description = "A Ruby script that issues GNOME desktop notifications when something is said in your Campfire chatroom."
+  s.authors     = ["Michael Nelson"]
+  s.email       = "michael@nelsonware.com"
+  s.executables << "gnome-campfire-notifications"
+  s.files       = `git ls-files`.split
+  s.test_files  = `git ls-files -- test/*`.split
+  s.homepage    = "https://github.com/mcnelson/gnome-campfire-notifications"
+  s.license     = "LGPL-2.0"
+
+  s.add_dependency              'twitter-stream'
+  s.add_development_dependency  'minitest'
+  s.add_development_dependency  'vcr'
+  s.add_development_dependency  'webmock'
+end

data/lib/gnome-campfire-notifications.rb

@@ -1,34 +1,65 @@
 require "twitter/json_stream"
 require "net/http"
 require "json"
+require "yaml"
 
 class GnomeCampfireNotifications
   HOST = 'streaming.campfirenow.com'
   NOTIFICATION_GFX_FILENAME = 'campfire.png'
   NOTIFICATION_GFX_SYSPATH = "/usr/share/icons/gnome/32x32/apps"
 
-  ATTR_MAP = {
-    room_name:  'GNOME_CAMPFIRE_NOTIFICATIONS_ROOM_NAME',
-    room_id:    'GNOME_CAMPFIRE_NOTIFICATIONS_ROOM_ID',
-    token:      'GNOME_CAMPFIRE_NOTIFICATIONS_TOKEN'
-  }
+  CONFIG_SYSPATH = "#{ENV['HOME']}/.campfire.yml"
+  CONFIG_ATTRS = %i(token subdomain roomid self_user filter icon_path)
+  REQD_CONFIG_ATTRS = %i(token subdomain roomid)
 
-  def initialize
-    if (missing = ATTR_MAP.values.select { |env| ENV[env].empty? }).any?
-      raise "please set environment variable(s) #{missing.join(', ')}"
-    end
+  attr_reader :config
 
-    @options = ATTR_MAP.map.with_object({}) { |(key, env), opts| opts[key] = ENV[env] }
+  def initialize
     @username_cache = []
-    try_icon
+
+    load_config
+    try_icon unless @config[:icon_path]
   end
 
   def start
     on_message do |item|
-      username = get_username(item["user_id"].to_i)
-      message = "#{item["body"].to_s.gsub(/'/, "\'")}"
+      send_notification(item)
+    end
+  end
+
+  def send_notification(item)
+    username = get_username(item["user_id"].to_i)
+
+    if should_send?(username, item["body"])
+      system("notify-send --hint=int:transient:1 -u low#{icon} \"#{username}\" \"#{escape_double_quotes(item["body"])}\"")
+    end
+  end
+
+  def get_username(id)
+    return "Unknown" if id.nil?
+
+    unless @username_cache[id]
+      req = Net::HTTP::Get.new("https://#{room_url}/users/#{id}.json")
+      req.basic_auth(@config[:token], "x")
+      http = Net::HTTP.new(room_url, 443)
+      http.use_ssl = true
+      resp = http.start { |h| h.request(req) }
+
+      json = JSON.parse(resp.body)
+
+      # Get username
+      @username_cache[id] = json["user"]["name"]
+    end
+
+    @username_cache[id]
+  end
+
+  def load_config
+    raise "please create #{CONFIG_SYSPATH}, see Github page for details" unless File.exists?(CONFIG_SYSPATH)
+    @config = YAML.load_file(CONFIG_SYSPATH).each.with_object({}) { |(k, v), h| h[k.to_sym] = v }
 
-      system("notify-send --hint=int:transient:1 -u low#{icon} '#{username}' '#{message}'")
+    if !(missing = REQD_CONFIG_ATTRS.delete_if { |k| @config[k] }).empty?
+      raise "please set config option(s) in #{CONFIG_SYSPATH}: #{missing.join(', ')}"
     end
   end
 
@@ -38,8 +69,8 @@ class GnomeCampfireNotifications
     EventMachine::run do
       stream = Twitter::JSONStream.connect(
         host:  HOST,
-        path: "/room/#{room_id}/live.json",
-        auth: "#{token}:x",
+        path: "/room/#{@config[:roomid]}/live.json",
+        auth: "#{@config[:token]}:x",
       )
 
       stream.each_item do |item|
@@ -54,38 +85,26 @@ class GnomeCampfireNotifications
     end
   end
 
-  def get_username(id)
-    return "Unknown" if id.nil?
+  def should_send?(username, body)
+    return false if @config[:self_user] && username == @config[:self_user]
+    return !body.match(@config[:filter]).nil? if @config[:filter]
 
-    unless @username_cache[id]
-      req = Net::HTTP::Get.new("https://#{room_url}/users/#{id}.json")
-      req.basic_auth(@options[:token], "x")
-      http = Net::HTTP.new(room_url, 443)
-      http.use_ssl = true
-      resp = http.start { |h| h.request(req) }
-
-      json = JSON.parse(resp.body)
-
-      # Get username
-      @username_cache[id] = json["user"]["name"]
-    end
-
-    @username_cache[id]
+    true
   end
 
   def icon
-    " -i #{@options[:icon_path]}"
+    " -i #{@config[:icon_path]}"
   end
 
   def try_icon
     if path = notification_gfx_paths.detect { |p| File.exists?(p) }
-      @options[:icon_path] = path
+      @config[:icon_path] = path
     end
   end
 
   def notification_gfx_paths
     [[NOTIFICATION_GFX_SYSPATH, NOTIFICATION_GFX_FILENAME],
-     [gem_dir, "assets", NOTIFICATION_GFX_FILENAME]].join('/')
+     [gem_dir, "assets", NOTIFICATION_GFX_FILENAME]].map { |p| p.join('/') }
   end
 
   def gem_dir
@@ -93,14 +112,10 @@ class GnomeCampfireNotifications
   end
 
   def room_url
-    "#{@options[:room_name]}.campfirenow.com"
-  end
-
-  def room_id
-    @options[:room_id]
+    "#{@config[:subdomain]}.campfirenow.com"
   end
 
-  def token
-    @options[:token]
+  def escape_double_quotes(string)
+    string.gsub(/"/, '\"')
   end
 end

data/test/cassettes/get_username.yml

@@ -0,0 +1,27 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://abcdefg12345678:x@example.campfirenow.com/users/1.json
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - ! '*/*'
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - nginx
+    body:
+      encoding: US-ASCII
+      string: ! '{"user":{"type":"Member","avatar_url":"http://dge9rmgqjs8m1.cloudfront.net/global/64b5bd6e09f22260d1d2260466dfee98949813aa18d3513ba144086f4f1be319d90518e63e8f0f373ff065346132b66d158e40e4e19e8251f96d96f4326913992aaaaaf702b91432e5e1d250f4575725/avatar.gif?r=3","admin":false,"name":"Derp
+        Herpinson","created_at":"2012/06/14 20:04:54 +0000","id":1218200,"email_address":"derp@herpinson.com"}}'
+    http_version: 
+  recorded_at: Mon, 11 Nov 2013 04:20:13 GMT
+recorded_with: VCR 2.7.0

data/test/cassettes/get_username_alt.yml

@@ -0,0 +1,27 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://abcdefg12345678:x@example.campfirenow.com/users/1.json
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - ! '*/*'
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - nginx
+    body:
+      encoding: US-ASCII
+      string: ! '{"user":{"type":"Member","avatar_url":"http://dge9rmgqjs8m1.cloudfront.net/global/64b5bd6e09f22260d1d2260466dfee98949813aa18d3513ba144086f4f1be319d90518e63e8f0f373ff065346132b66d158e40e4e19e8251f96d96f4326913992aaaaaf702b91432e5e1d250f4575725/avatar.gif?r=3","admin":false,"name":"Jane
+        Doe","created_at":"2012/06/14 20:04:54 +0000","id":1218200,"email_address":"derp@herpinson.com"}}'
+    http_version: 
+  recorded_at: Mon, 11 Nov 2013 04:20:13 GMT
+recorded_with: VCR 2.7.0

data/test/helper.rb

@@ -0,0 +1,19 @@
+require "minitest/autorun"
+require "gnome-campfire-notifications"
+require "vcr"
+require "webmock"
+
+VCR.configure do |c|
+  c.cassette_library_dir = 'test/cassettes'
+  c.hook_into :webmock
+end
+
+GnomeCampfireNotifications.class_eval do
+  def load_dummy_config(hash = {})
+    @config = {
+      token:     'abcdefg12345678',
+      roomid:    1,
+      subdomain: 'example'
+    }.merge(hash)
+  end
+end

data/test/test_gnome_campfire_notifications.rb

@@ -0,0 +1,101 @@
+require_relative 'helper'
+
+describe GnomeCampfireNotifications do
+  describe "#load_config" do
+    it "loads correct values" do
+      gcn = GnomeCampfireNotifications.new
+      gcn.load_dummy_config({
+        token:     'foo',
+        roomid:    'bar',
+        room_name: 'baz'
+      })
+
+      assert_equal 'foo', gcn.config[:token]
+      assert_equal 'bar', gcn.config[:roomid]
+      assert_equal 'baz', gcn.config[:room_name]
+    end
+  end
+
+  describe "#send_notification" do
+    it "works" do
+      gcn = GnomeCampfireNotifications.new
+      gcn.load_dummy_config
+      input = {"user_id" => '1', "body" => 'hi'}
+
+      gcn.stub(:get_username, 'Fred') do
+        assert_equal true, gcn.send_notification(input)
+      end
+    end
+
+    describe "quote escaping" do
+      it "returns true" do
+        gcn = GnomeCampfireNotifications.new
+        gcn.load_dummy_config
+        input = {"user_id" => '1', "body" => 'quote"s quote\'s'}
+
+        gcn.stub(:get_username, 'Fred') do
+          assert_equal true, gcn.send_notification(input)
+        end
+      end
+    end
+
+    describe "when self_user is set & message sender is self_user" do
+      it "doesn't notify and returns nil" do
+        gcn = GnomeCampfireNotifications.new
+        gcn.load_dummy_config(self_user: 'Derp Herpinson')
+        input = {"user_id" => '1', "body" => 'I should never be sent'}
+
+        VCR.use_cassette('get_username') do
+          assert_equal nil, gcn.send_notification(input)
+        end
+      end
+    end
+
+    describe "when self_user & filter vars are set" do
+      before do
+        @gcn = GnomeCampfireNotifications.new
+        @gcn.load_dummy_config(
+          self_user: 'Derp Herpinson',
+          filter:    /Derp Herpinson/
+        )
+      end
+
+      describe "message matches filter" do
+        it "sends notification and returns true" do
+          input = {"user_id" => '1', "body" => 'Derp Herpinson: yo wassup'}
+
+          VCR.use_cassette('get_username_alt') do
+            assert_equal true, @gcn.send_notification(input)
+          end
+        end
+      end
+
+      describe "message doesn't match filter" do
+        it "doesn't notify and returns nil" do
+          input = {"user_id" => '1', "body" => 'I should never be sent'}
+
+          VCR.use_cassette('get_username_alt') do
+            assert_equal nil, @gcn.send_notification(input)
+          end
+        end
+      end
+    end
+  end
+
+  describe "#get_username" do
+    it "returns username in json hierarchy user -> name" do
+      gcn = GnomeCampfireNotifications.new
+      gcn.load_dummy_config
+
+      VCR.use_cassette('get_username') do
+        assert_equal "Derp Herpinson", gcn.get_username(1)
+      end
+    end
+
+    it "returns unknown if ID is nil" do
+      gcn = GnomeCampfireNotifications.new
+      gcn.load_dummy_config
+      assert_equal "Unknown", gcn.get_username(nil)
+    end
+  end
+end

metadata

@@ -1,33 +1,72 @@
 --- !ruby/object:Gem::Specification
 name: gnome-campfire-notifications
 version: !ruby/object:Gem::Version
-  version: 0.1.3
-  prerelease: 
+  version: 0.2.0
 platform: ruby
 authors:
 - Michael Nelson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-10 00:00:00.000000000 Z
+date: 2013-11-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: twitter-stream
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: A Ruby script that spawns GNOME desktop notifications when something
+- !ruby/object:Gem::Dependency
+  name: minitest
+  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: vcr
+  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: webmock
+  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: A Ruby script that issues GNOME desktop notifications when something
   is said in your Campfire chatroom.
 email: michael@nelsonware.com
 executables:
@@ -35,31 +74,44 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/gnome-campfire-notifications.rb
+- .gitignore
+- LICENSE
+- README.md
+- Rakefile
 - assets/campfire.png
 - bin/gnome-campfire-notifications
+- gnome-campfire-notifications.gemspec
+- lib/gnome-campfire-notifications.rb
+- test/cassettes/get_username.yml
+- test/cassettes/get_username_alt.yml
+- test/helper.rb
+- test/test_gnome_campfire_notifications.rb
 homepage: https://github.com/mcnelson/gnome-campfire-notifications
-licenses: []
+licenses:
+- LGPL-2.0
+metadata: {}
 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.24
+rubygems_version: 2.0.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: GNOME desktop notifications for Campfire.
-test_files: []
+test_files:
+- test/cassettes/get_username.yml
+- test/cassettes/get_username_alt.yml
+- test/helper.rb
+- test/test_gnome_campfire_notifications.rb